siege.component

AxisType

class AxisType
AXIS_BACKWALL = siege.component.AxisType.AXIS_BACKWALL
AXIS_CEILING = siege.component.AxisType.AXIS_CEILING
AXIS_FLOOR = siege.component.AxisType.AXIS_FLOOR
AXIS_LEFT = siege.component.AxisType.AXIS_LEFT
AXIS_NONE = siege.component.AxisType.AXIS_NONE
AXIS_RIGHT = siege.component.AxisType.AXIS_RIGHT
AXIS_WALL = siege.component.AxisType.AXIS_WALL

CombatStatus

class CombatStatus
Attacking = siege.component.CombatStatus.Attacking
Casting = siege.component.CombatStatus.Casting
Dead = siege.component.CombatStatus.Dead
Defending = siege.component.CombatStatus.Defending
Dodging = siege.component.CombatStatus.Dodging
Idle = siege.component.CombatStatus.Idle
Using = siege.component.CombatStatus.Using

CombatTeam

class CombatTeam
ALPHA = siege.component.CombatTeam.ALPHA
DELTA = siege.component.CombatTeam.DELTA
GAMMA = siege.component.CombatTeam.GAMMA
NONE = siege.component.CombatTeam.NONE
OMEGA = siege.component.CombatTeam.OMEGA
ZETA = siege.component.CombatTeam.ZETA

Direction

class Direction
ALL = siege.component.Direction.ALL
BOTTOM = siege.component.Direction.BOTTOM
HORIZONTAL = siege.component.Direction.HORIZONTAL
LEFT = siege.component.Direction.LEFT
NONE = siege.component.Direction.NONE
RIGHT = siege.component.Direction.RIGHT
TOP = siege.component.Direction.TOP
VERTICAL = siege.component.Direction.VERTICAL

FoliagePriority

class FoliagePriority
High = siege.component.FoliagePriority.High
Low = siege.component.FoliagePriority.Low
Medium = siege.component.FoliagePriority.Medium
VeryHigh = siege.component.FoliagePriority.VeryHigh
VeryLow = siege.component.FoliagePriority.VeryLow

FoliageType

class FoliageType
Overlay = siege.component.FoliageType.Overlay
Tile = siege.component.FoliageType.Tile

GrowDepth

class GrowDepth
Any = siege.component.GrowDepth.Any
Surface = siege.component.GrowDepth.Surface
Underground = siege.component.GrowDepth.Underground

GrowthType

class GrowthType
Grass = siege.component.GrowthType.Grass
Plant = siege.component.GrowthType.Plant
Vine = siege.component.GrowthType.Vine

MapMode

class MapMode
Fullscreen = siege.component.MapMode.Fullscreen
Hidden = siege.component.MapMode.Hidden
Minimap = siege.component.MapMode.Minimap
Overlay = siege.component.MapMode.Overlay

MonsterPlacementType

class MonsterPlacementType
Custom = siege.component.MonsterPlacementType.Custom
InAir = siege.component.MonsterPlacementType.InAir
InGround = siege.component.MonsterPlacementType.InGround
InWater = siege.component.MonsterPlacementType.InWater
OnGround = siege.component.MonsterPlacementType.OnGround

PlayerMode

class PlayerMode
Aggressive = siege.component.PlayerMode.Aggressive
Passive = siege.component.PlayerMode.Passive

Slope

class Slope
LEFT = siege.component.Slope.LEFT
NONE = siege.component.Slope.NONE
RIGHT = siege.component.Slope.RIGHT

SupportType

class SupportType
SUPPORT_BOTTOM = siege.component.SupportType.SUPPORT_BOTTOM
SUPPORT_LEFT = siege.component.SupportType.SUPPORT_LEFT
SUPPORT_RIGHT = siege.component.SupportType.SUPPORT_RIGHT
SUPPORT_TOP = siege.component.SupportType.SUPPORT_TOP

ActiveEffect

class ActiveEffect
effect
level
name
sourceContent
sourceId
timer
(Timer)

ActiveEffectMap

class ActiveEffectMap
__contains__(arg2)
Parameters:arg2 (object) –
Return type:bool
__delitem__(arg2)
Parameters:arg2 (object) –
__getitem__(arg2)
Parameters:arg2 (object) –
Return type:object
__iter__()
Return type:object
__len__()
Return type:int
__setitem__(arg2, arg3)
Parameters:
  • arg2 (object) –
  • arg3 (object) –

AnimationDetails

class AnimationDetails
animating
currentAnimation
forced
frameScale
frameTime
group
hold
index
isVisible
playTime

AnimationDetailsMap

class AnimationDetailsMap
__contains__(arg2)
Parameters:arg2 (object) –
Return type:bool
__delitem__(arg2)
Parameters:arg2 (object) –
__getitem__(arg2)
Parameters:arg2 (object) –
Return type:object
__iter__()
Return type:object
__len__()
Return type:int
__setitem__(arg2, arg3)
Parameters:
  • arg2 (object) –
  • arg3 (object) –

BodyCustomization

class BodyCustomization
__init__(group, mapping[, supportsColor=True[, isOptional=False]])
Parameters:
  • group (str) –
  • mapping (str) –
  • supportsColor (bool) –
  • isOptional (bool) –
colors
group
isOptional
mapping
supportsColor

Component

class Component
clean()

Resets the dirty flag. Override when additional data needs to be cleaned.

create(entity)

Called whenever a new entity with this component has finished being created.

Parameters:entity (Entity) – The newly created entity.
destroy()

Called whenever the entity this component belongs to is being destroyed.

dirty()

Marks this Component as dirty. This should be called anytime data synced in pack() is changed.

freeze()

Freezes this component disallowing any further attributes to be added.

fullDirty()

Called whenever this Component should be marked as fully dirty.Override when data is conditionally synced in pack().

getCid()

Retrieves the unique Component ID given to this component type.

Return type:int
getParent()

Returns the parent Entity this component belongs to.

Returns:The parent entity.
Return type:Entity
getType()

Retrieves the type of this component.

Return type:str
getVersion()

Retrieves the current version for this component.

Return type:int
isDirty()

Returns if this Component has been marked as dirty since the last multiplayer data sync.

Returns:Whether this Component is dirty or not.
Return type:bool
pack(stream)

Called whenever this component needs to be synced over the network.

Parameters:stream (DataStream) – The stream that the Component data should be written to.
read(stream, version)

Called whenever this component is being read from the network.

Parameters:
  • stream (DataStream) – The stream that the Component data should be read from.
  • version (int) – The version of the Component that the data was saved with.
readEntities(stream, version)

Called when loading a player. Override for components that stores entities and read the entities from the stream.This ensures that the entities exist before attempting to access them elsewhere.

Parameters:
  • stream (DataStream) – The stream that the Component data should be read from.
  • version (int) – The version of the Component that the data was saved with.
unpack(stream)

Called whenever this component is being read from the network.

Parameters:stream (DataStream) – The stream that the Component data should be read from.
update(frameTime)

Called every frame allowing the component to update itself.

Parameters:frameTime (int) – The amount of time (ms) elapsed since the last frame.
validate()

Returns if this Component data is valid - used for testing.

Returns:Whether this Component is valid or not.
Return type:bool
write(stream)

Called whenever this component is being written to disk (saving).

Parameters:stream (DataStream) – The stream that the Component data should be written to.
writeEntities(stream)

Called when saving a player. Override for components that stores entities and write the entities to the stream.

Parameters:stream (DataStream) – The stream that the Component data should be read from.

AnimationComponent

class AnimationComponent
backupAnimations()
Return type:AnimationDetailsMap
clearQueue([group=''])
Parameters:group (str) –
getAnimationLength([group=''])
Parameters:group (str) –
Return type:int
getAnimationName([group=''])
Parameters:group (str) –
Return type:str
getFrame([group=''])
Parameters:group (str) –
Return type:int
getFrameTime([group=''])
Parameters:group (str) –
Return type:int
getPlayTime([group=''])
Parameters:group (str) –
Return type:int
has(name[, group=''])
Parameters:
  • name (str) –
  • group (str) –
Return type:

bool
hide([group=''[, bypassLock=False]])
Parameters:
  • group (str) –
  • bypassLock (bool) –
hold([group=''])
Parameters:group (str) –
isLocked()
Return type:bool
isPlaying(name[, group=''])
Parameters:
  • name (str) –
  • group (str) –
Return type:

bool
isPlayingGroup([group=''])
Parameters:group (str) –
Return type:bool
lock()
pause([group=''[, bypassLock=False]])
Parameters:
  • group (str) –
  • bypassLock (bool) –
play([name=''[, group=''[, forceRestart=False[, bypassLock=False]]]])
Parameters:
  • name (str) –
  • group (str) –
  • forceRestart (bool) –
  • bypassLock (bool) –
queue(name[, group=''])
Parameters:
  • name (str) –
  • group (str) –
restoreAnimations(arg2)
Parameters:arg2 (AnimationDetailsMap) –
scale(totalDelay[, group=''[, downOnly=True]])
Parameters:
  • totalDelay (int) –
  • group (str) –
  • downOnly (bool) –
stop([group=''[, bypassLock=False]])
Parameters:
  • group (str) –
  • bypassLock (bool) –
unlock()
wasForced([group=''])
Parameters:group (str) –
Return type:bool
wasPlaying(name[, group=''])
Parameters:
  • name (str) –
  • group (str) –
Return type:

bool
defaultAnimation
onFinished

AttachmentComponent

class AttachmentComponent
attach(arg2, arg3)
Parameters:
  • arg2 (str) –
  • arg3 (Entity) –
attach(arg2, arg3)
Parameters:
detach(arg2)
Parameters:arg2 (str) –
detach(arg2)
Parameters:arg2 (Entity) –
getAttached(arg2)
Parameters:arg2 (str) –
Return type:Entity
hasAttached(arg2)
Parameters:arg2 (str) –
Return type:bool
hasAttached(arg2)
Parameters:arg2 (Entity) –
Return type:bool

BagComponent

class BagComponent
canCarry
capacity

BodyComponent

class BodyComponent
colors
components
customizations
identifier
initialize
substitutions

CombatComponent

class CombatComponent
__init__(definition)
Parameters:definition (Combat) –
adjustExperience(amount)
Parameters:amount (int) –
clearCooldown(cooldown)
Parameters:cooldown (str) –
Return type:bool
finishAttack(attackId)
Parameters:attackId (int) –
getExperienceToLevel([level=0])
Parameters:level (int) –
Return type:int
getLevelCap()
Return type:int
hasAlreadyHit(attackId, entity)
Parameters:
  • attackId (int) –
  • entity (Entity) –
Return type:

bool
hasCooldown(cooldown)
Parameters:cooldown (Cooldown) –
Return type:bool
hasCooldownTolerant(cooldown)
Parameters:cooldown (Cooldown) –
Return type:bool
hit(attackId, entity)
Parameters:
  • attackId (int) –
  • entity (Entity) –
isMaxLevel()
Return type:bool
setAlive(alive)
Parameters:alive (bool) –
setCanRecover(canRecover)
Parameters:canRecover (bool) –
setCooldown(cooldown)
Parameters:cooldown (Cooldown) –
setFatigued(fatigued)
Parameters:fatigued (bool) –
setInvincible(invincible)
Parameters:invincible (bool) –
setLevel(level)
Parameters:level (int) –
setTargetable(targetable)
Parameters:targetable (bool) –
startAttack()
Return type:int
update(frameTime)
Parameters:frameTime (int) –
blockStaminaCost
blockThreshold
canRecover
cooldowns
experience
experienceYield
isAlive
isFatigued
isHitStunned
isInvincible
isTargetable
knockback
knockbackModifier
level
levels
magicalReduction
numberOffset
onDamageSound
onDeathSound
onExpiredCooldown
onHit
onSetCooldown
onStatusChange
physicalReduction
status
team
timeSinceCombat

CraftComponent

class CraftComponent
usesMaterial(arg2)
Parameters:arg2 (int) –
Return type:bool
category
experience
isResearchable
level
materials
onCraft
requiresDiscoveryMaterials
results
servicesRequired
subcategory

CustomizationComponent

class CustomizationComponent
bodies
group
substitutions
supportsColor

DroppedComponent

class DroppedComponent
expired
ignorePlayer
quantity

EffectsComponent

class EffectsComponent
add(effect, level, duration[, source=None])
Parameters:
  • effect (str) –
  • level (int) –
  • duration (int) –
  • source (Entity) –
get(effect)
Parameters:effect (str) –
Return type:ActiveEffect
getEffects()
Return type:ActiveEffectMap
has(effect)
Parameters:effect (str) –
Return type:bool
level(effect, level, duration)
Parameters:
  • effect (str) –
  • level (int) –
  • duration (int) –
Return type:

int
remove(effect[, duration=0])
Parameters:
  • effect (str) –
  • duration (int) –
removeAll()
onAddEffect
onRemoveEffect
onUpdateEffect

EquipmentComponent

class EquipmentComponent
addAttribute(attribute)
Parameters:attribute (object) –
getAttributes()
Return type:EquipmentAttributes
getContentAttributes()
Return type:list
getModifiedName()
Return type:str
getPotentialRange()
Return type:RangeUint
getSlots()
Return type:StringList
getSubstitutions()
Return type:SubstitutionMap
hasAttribute(type)
Parameters:type (str) –
Return type:bool
hasSlot(arg2)
Parameters:arg2 (str) –
Return type:bool
isAttached()
Return type:bool
removeAttribute(attribute)
Parameters:attribute (object) –
levelRequired
potentials
quality

EventComponent

class EventComponent
__getitem__(name)
Parameters:name (str) –
Return type:GameEvent
has(name)
Parameters:name (str) –
Return type:bool
reset()

FoliageComponent

class FoliageComponent
getCompatibleTiles()
Return type:StringList
getOnPhysicsEntityContact()
Return type:object
getTimeToUpdate()
Return type:int
foliageType
growthType
id
particlePath
priority

GearComponent

class GearComponent
__eq__(arg2)
Parameters:arg2 (Component) –
Return type:bool
__getattr__(arg2)
Parameters:arg2 (str) –
Return type:object
__iter__()
Return type:object
add(arg2, arg3)
Parameters:
  • arg2 (Entity) –
  • arg3 (int) –
Return type:

int
canEquip(item[, slotName=''])
Parameters:
Return type:

bool
consume(slotName[, quantity=1])
Parameters:
  • slotName (str) –
  • quantity (int) –
Return type:

int
disable(slot)
Parameters:slot (str) –
disableAll(category)
Parameters:category (str) –
enable(slot)
Parameters:slot (str) –
enableAll(category)
Parameters:category (str) –
equip(item[, slotName=''])
Parameters:
Return type:

InventoryItem
get(slot)
Parameters:slot (str) –
Return type:GearSlot
getCategorySlots(category)
Parameters:category (str) –
Return type:StringList
getContentQuantity(arg2)
Parameters:arg2 (Content) –
Return type:int
getSlot(arg2)
Parameters:arg2 (Entity) –
Return type:str
hasSlot(slotName)
Parameters:slotName (str) –
Return type:bool
hasUniqueItem(arg2)
Parameters:arg2 (Entity) –
Return type:bool
isEnabled(slot)
Parameters:slot (str) –
Return type:bool
isOpen(slot)
Parameters:slot (str) –
Return type:bool
next()
Return type:object
remove(content[, quantity=1])
Parameters:
  • content (Content) –
  • quantity (int) –
Return type:

int
remove(content[, quantity=1])
Parameters:
  • content (Entity) –
  • quantity (int) –
Return type:

int
resetGraphics()
stack(item)
Parameters:item (InventoryItem) –
Return type:InventoryItem
unequip(slotName)
Parameters:slotName (str) –
Return type:InventoryItem
onChange
ordered

InventoryComponent

class InventoryComponent
__eq__(arg2)
Parameters:arg2 (Component) –
Return type:bool
__iter__()
Return type:object
add(entity[, quantity=1])
Parameters:
  • entity (Entity) –
  • quantity (int) –
Return type:

int
addBag(bagIndex, bagEntity)
Parameters:
  • bagIndex (int) –
  • bagEntity (Entity) –
Return type:

ItemBag
addBag(bagIndex, size)
Parameters:
  • bagIndex (int) –
  • size (int) –
Return type:

ItemBag
canAdd(entity)
Parameters:entity (Entity) –
Return type:bool
canAdd(bagIndex, item)
Parameters:
  • bagIndex (int) –
  • item (Entity) –
Return type:

bool
clear(bagIndex, index)
Parameters:
  • bagIndex (int) –
  • index (int) –
decrement(bagIndex, index, quantity)
Parameters:
  • bagIndex (int) –
  • index (int) –
  • quantity (int) –
exists(bagIndex)
Parameters:bagIndex (int) –
Return type:bool
get(bagIndex, index)
Parameters:
  • bagIndex (int) –
  • index (int) –
Return type:

InventoryItem
getBag(index)
Parameters:index (int) –
Return type:ItemBag
getBagCount()
Return type:int
getBagIndexForContent(content)
Parameters:content (Content) –
Return type:int
getBagIndexForUniqueItem(entity)
Parameters:entity (Entity) –
Return type:int
getBags()
Return type:ItemBags
getContentQuantity(content)
Parameters:content (Content) –
Return type:int
getSlot(arg2)
Parameters:arg2 (Entity) –
Return type:str
handleChange(bagIndex, index, previous, item)
Parameters:
hasContentQuantity(content, quantity)
Parameters:
  • content (Content) –
  • quantity (int) –
Return type:

bool
hasUniqueItem(entity)
Parameters:entity (Entity) –
Return type:bool
isEmpty(index)
Parameters:index (int) –
Return type:bool
isEmpty(arg2, bagIndex)
Parameters:
  • arg2 (int) –
  • bagIndex (int) –
Return type:

bool
isFull()
Return type:bool
isFull(bagIndex)
Parameters:bagIndex (int) –
Return type:bool
next()
Return type:object
remove(content[, quantity=1])
Parameters:
  • content (Content) –
  • quantity (int) –
Return type:

int
remove(content[, quantity=1])
Parameters:
  • content (Entity) –
  • quantity (int) –
Return type:

int
removeBag(bagIndex)
Parameters:bagIndex (int) –
set(bagIndex, index, item)
Parameters:
capacity
onBagChange
onCapacityChange
onChange

ItemComponent

class ItemComponent
hasTag(arg2)
Parameters:arg2 (str) –
Return type:bool
buyPrice
canRepeatUse
classification
cooldown
description
features
flavor
genus
hold
holdExterior
isUnique
isUsable
quality
requiresResearch
Item requires to be research through research system otherwise item is automatically researched when first discovered.
scraps
sellPrice
stack
tags
use
useAnimation
useTime

LegendComponent

class LegendComponent
disableMarker(arg2)
Parameters:arg2 (str) –
enableMarker(arg2)
Parameters:arg2 (str) –
getMarkerCount()
Return type:int
hasMarker(arg2)
Parameters:arg2 (str) –
Return type:bool
isMarkerEnabled(arg2)
Parameters:arg2 (str) –
Return type:bool
loseMarker(arg2)
Parameters:arg2 (str) –
obtainMarker(arg2)
Parameters:arg2 (str) –
onMarkerChange

LightComponent

class LightComponent
addSource(arg2)
Parameters:arg2 (LightSourceData) –
Return type:LightSource
getSource(arg2)
Parameters:arg2 (str) –
Return type:LightSource
hasSource(arg2)
Parameters:arg2 (str) –
Return type:bool
removeSource(arg2)
Parameters:arg2 (LightSource) –
removeSource(arg2)
Parameters:arg2 (str) –
sources

MapMarkerComponent

class MapMarkerComponent
icon
markerType
updatePosition

MonsterComponent

class MonsterComponent
create(arg2)
Parameters:arg2 (Entity) –
biomes
core
hostile
isParagon
layer
levels
placementCallback
placementType
spawnOffset
spawner
weight

OrganicComponent

class OrganicComponent
onConstruct(arg2)
Parameters:arg2 (list) –
axis
habitables
organic
size

ParticleComponent

class ParticleComponent

PhysicsComponent

class PhysicsComponent
addPassingThrough(physics)
Parameters:physics (PhysicsComponent) –
addTouching(direction)
Parameters:direction (Direction) –
applyForce(arg2)
Parameters:arg2 (Vector) –
calculateJumpHeight(speed, height)
Parameters:
  • speed (float) –
  • height (float) –
Return type:

float
clearPassingThrough()
factorSurfaceFriction(surfaceFriction)
Parameters:surfaceFriction (Vector) –
flipX(flip)
Parameters:flip (bool) –
getBody()
Return type:Rect
getCenter()
Return type:Vector
getCollision()
Return type:int
getFriction()
Return type:Vector
getGravity()
Return type:Vector
getGroundFriction()
Return type:Vector
getPassingThrough()
Return type:PhysicsComponentList
getPassthrough()
Return type:int
getPreviousPosition()
Return type:Vector
getRestitution()
Return type:Vector
getTouching()
Return type:int
getVelocity()
Return type:Vector
getWorldBody()
Return type:Rect
isTouching(direction)
Parameters:direction (Direction) –
Return type:bool
isTouchingTile(position)
Parameters:position (TileVector) –
Return type:bool
resetGroundFriction()
setBody(arg2)
Parameters:arg2 (Rect) –
setFriction(friction)
Parameters:friction (Vector) –
setGravity(gravity)
Parameters:gravity (Vector) –
setGroundFriction(friction)
Parameters:friction (Vector) –
setRestitution(restitution)
Parameters:restitution (Vector) –
setVelocity(velocity)
Parameters:velocity (Vector) –
wake()
active
applyGravityOnGround
hasGroundCollision
immovable
isUnderwater
jumpTimer
onTimeStep
sleeping

TilePhysicsComponent

class TilePhysicsComponent
tilePosition

PlacementComponent

class PlacementComponent
getArea()
Return type:Rect
getDropped()
Return type:InventoryItem
getRect()
Return type:PixelRect
getSupports()
Return type:object
setAxisAnimation()
setPlacement(placement)
Parameters:placement (PlacementComponent) –
shouldDropItem()
Return type:bool
allowCollection
allowSupportRemoval
axes
axis
destroyOnSupportRemoved
onCreate
onHit
supportEntity
supportTiles

PlayerStateComponent

class PlayerStateComponent
addGrappler(id, support)
Parameters:
clearGrapplers()
hasGrapplers()
Return type:bool
removeGrappler(index)
Parameters:index (int) –
activeItem
canAttack
canCast
canMove
channel
grapplerId
grapplers
mapMode
mode
perseveranceTime
perseveranceTimerJob
toolState

RecipeSetComponent

class RecipeSetComponent
recipes

RenderComponent

class RenderComponent
faceDirection(arg2, arg3)
Parameters:
  • arg2 (Vector) –
  • arg3 (int) –
flipX(arg2)
Parameters:arg2 (bool) –
flipY(arg2)
Parameters:arg2 (bool) –
getCenter()
Return type:Vector
getColor()
Return type:Color
getFlipX()
Return type:bool
getFlipY()
Return type:bool
getFrame([group=''])
Parameters:group (str) –
Return type:Frame
getIconPath()
Return type:str
getImagePath()
Return type:str
getOrigin()
Return type:Vector
getPreviousPosition()
Return type:Vector
getRect()
Return type:Rect
getRotation()
Return type:float
getScale()
Return type:Vector
getSize()
Return type:PixelVector
getWorldIconPath()
Return type:str
hasMoved()
Return type:bool
render(target[, loopWidth=0])
Parameters:
setColor(arg2)
Parameters:arg2 (Color) –
setFrame(frame[, group=''])
Parameters:
  • frame (Frame) –
  • group (str) –
setOrigin(arg2, arg3)
Parameters:
  • arg2 (float) –
  • arg3 (float) –
setOriginToCenter()
setRotation(arg2)
Parameters:arg2 (float) –
setScale(arg2)
Parameters:arg2 (Vector) –
setTexture(arg2)
Parameters:arg2 (Texture) –
setTextureRect(arg2)
Parameters:arg2 (PixelRect) –
setTrail(arg2, arg3)
Parameters:
  • arg2 (int) –
  • arg3 (int) –
setVolatilePosition(arg2, arg3)
Parameters:
  • arg2 (Vector) –
  • arg3 (int) –
updateSprite(position)
Parameters:position (Vector) –
useIconTexture()
useTexture()
useWorldIconTexture()
alpha
brightness
onMove
rotation
sprite
states

ExtendableRenderComponent

class ExtendableRenderComponent
getTransform()
Return type:Transform
length

ModularRenderComponent

class ModularRenderComponent
addTexture(spriteId, texturePath)
Parameters:
  • spriteId (int) –
  • texturePath (str) –
addTexture(spriteId, texturePath, textureRect)
Parameters:
  • spriteId (int) –
  • texturePath (str) –
  • textureRect (PixelRect) –
changeSprite(arg2)
Parameters:arg2 (Substitution) –
changeSpriteColor(arg2, arg3)
Parameters:
  • arg2 (str) –
  • arg3 (Vector3) –
changeSpriteVisibility(arg2, arg3)
Parameters:
  • arg2 (str) –
  • arg3 (bool) –
changeSprites(arg2)
Parameters:arg2 (SubstitutionMap) –
getColor()
Return type:Color
getRect()
Return type:Rect
getScale()
Return type:Vector
getSprites()
Return type:ModularRenderSpriteList
getSprites(arg2)
Parameters:arg2 (StringList) –
Return type:ModularRenderSpriteList
getSprites(arg2)
Parameters:arg2 (str) –
Return type:ModularRenderSpriteList
getTopSprite(arg2)
Parameters:arg2 (Vector) –
Return type:ModularRenderSprite
hideSprite(arg2)
Parameters:arg2 (str) –
render(target[, loopWidth=0])
Parameters:
renderLooped( target, position, >[, loopWidth=0]])
Parameters:
resetTextures()
setColor(arg2)
Parameters:arg2 (Color) –
setPosition(arg2, arg3)
Parameters:
  • arg2 (Vector) –
  • arg3 (int) –
setScale(arg2)
Parameters:arg2 (Vector) –
showSprite(arg2)
Parameters:arg2 (str) –
update(arg2)
Parameters:arg2 (int) –
updateForced()
alpha
brightness
modularSprites
onUpdate
shouldIgnorePosition
spriteIds

ReservesComponent

class ReservesComponent
__contains__(arg2)
Parameters:arg2 (str) –
Return type:bool
__getitem__(arg2)
Parameters:arg2 (str) –
Return type:ItemBag
clear(reserveName)
Parameters:reserveName (str) –
observe(reserveName, droppedHandler)
Parameters:
  • reserveName (str) –
  • droppedHandler (object) –
resize(reserveName, size)
Parameters:
  • reserveName (str) –
  • size (int) –
restore(reserveName, droppedHandler[, remove=True])
Parameters:
  • reserveName (str) –
  • droppedHandler (DroppedHandler) –
  • remove (bool) –
restoreAll(droppedHandler, blacklist)
Parameters:

ShieldComponent

class ShieldComponent
blockSound
magicalReduction
onUse
physicalReduction
staminaCost
threshold

StatisticsComponent

class StatisticsComponent
adjust(arg2, arg3)
Parameters:
  • arg2 (str) –
  • arg3 (int) –
Return type:

int
get(arg2)
Parameters:arg2 (str) –
Return type:int
has(arg2)
Parameters:arg2 (str) –
Return type:bool
remove(arg2)
Parameters:arg2 (str) –
set(arg2, arg3)
Parameters:
  • arg2 (str) –
  • arg3 (int) –
unwatch(arg2, arg3)
Parameters:
  • arg2 (str) –
  • arg3 (object) –
watch(arg2, arg3)
Parameters:
  • arg2 (str) –
  • arg3 (object) –

StatsComponent

class StatsComponent
__getattr__(arg2)
Parameters:arg2 (str) –
Return type:object
get(stat)
Parameters:stat (str) –
Return type:DynamicStat
has(stat)
Parameters:stat (str) –
Return type:bool
stats

SurfaceComponent

class SurfaceComponent
addService(service)
Parameters:service (str) –
getServices()
Return type:StringSet
has(service)
Parameters:service (str) –
Return type:bool
removeService(service)
Parameters:service (str) –
onServiceAdded
onServiceRemoved

TalentsComponent

class TalentsComponent
__getattr__(arg2)
Parameters:arg2 (str) –
Return type:object
get(talent)
Parameters:talent (str) –
Return type:ActiveTalent
has(talent)
Parameters:talent (str) –
Return type:bool
ordered

TileComponent

class TileComponent
getDropped()
Return type:str
getGroups()
Return type:list
getLayer()
Return type:Layer
getName()
Return type:str
getOnBreakSound()
Return type:str
getOnHitSound()
Return type:str
getRenderLayer()
Return type:TileRenderLayer
getTileId()
Return type:int
getUpdateTime()
Return type:RangeUint
isCompatible(compatibles)
Parameters:compatibles (StringList) –
Return type:bool
canPlace
consumeOnUse
durability
isFoliage
isFragile
isReplaceable
isSolid
isUpdateVisual
level
lightSource
onCreated
onDamaged
onDestroyed
onFoliageChange
onLoad
onNeighborChange
onPhysicsEntityContact
onUpdate
particleColor
providesSupport

ToolComponent

class ToolComponent
checkUsability(arg2, arg3, arg4)
Parameters:
Return type:

ToolUsabilityResult
getHitTiles(arg2, arg3, arg4, arg5)
Parameters:
Return type:

TileVectorList
compatibles
harvestPower
power
reach

ToolbarComponent

class ToolbarComponent
bagChanged(arg2, arg3)
Parameters:
  • arg2 (int) –
  • arg3 (ItemBag) –
changeToolbar()
clearQuick(arg2)
Parameters:arg2 (int) –
clearQuick(arg2, arg3)
Parameters:
  • arg2 (int) –
  • arg3 (int) –
get(arg2)
Parameters:arg2 (int) –
Return type:ToolItem
get(arg2, arg3)
Parameters:
  • arg2 (int) –
  • arg3 (int) –
Return type:

ToolItem
getQuick(arg2)
Parameters:arg2 (int) –
Return type:ToolItem
getQuick(arg2, arg3)
Parameters:
  • arg2 (int) –
  • arg3 (int) –
Return type:

ToolItem
isEmpty(arg2)
Parameters:arg2 (int) –
Return type:bool
isEmpty(arg2, arg3)
Parameters:
  • arg2 (int) –
  • arg3 (int) –
Return type:

bool
isQuickEmpty(arg2)
Parameters:arg2 (int) –
Return type:bool
isQuickEmpty(arg2, arg3)
Parameters:
  • arg2 (int) –
  • arg3 (int) –
Return type:

bool
set(arg2, arg3)
Parameters:
set(arg2, arg3, arg4)
Parameters:
  • arg2 (int) –
  • arg3 (int) –
  • arg4 (ToolItem) –
setQuick(arg2, arg3)
Parameters:
setQuick(arg2, arg3, arg4)
Parameters:
  • arg2 (int) –
  • arg3 (int) –
  • arg4 (ToolItem) –
setQuickBar(arg2)
Parameters:arg2 (int) –
setToolbar(arg2)
Parameters:arg2 (int) –
items
onChange
onQuickBarChange
onQuickChange
onSelectedChange
onToolbarChange
quickSize
quickbarIndex
quickbarSize
selected
size
toolbarIndex
toolbarSize

TriggerComponent

class TriggerComponent
actions
checkExpired
data
trigger

WeaponComponent

class WeaponComponent
attackType
category
currentAttack
damageType
onUse
power
swapBackOnAnimationFinish
weaponAttacks

ComponentDefinition

class ComponentDefinition
freeze()

Freezes this disallowing any further attributes to be added.

getType()

Retrieves the type of this component.

Returns:The given type of this component.
Return type:str
getType()
read(stream)

Called when this is being read from the network. This is only needed when this ComponentDefinition is dynamically added to entities.

Parameters:stream (DataStream) – The stream that the ComponentDefinition data should be read from.
set(attr, kwargs)

Uses the given attribute name to set the attribute on this object from the provided dictionary.

Parameters:
  • attr (str) – The name of the attribute to set.
  • kwargs (dict) – The dictionary from which to retrieve the attribute value.
set(attrs, kwargs)

Uses the given attribute names to set the attributes on this object from the provided dictionary.

Parameters:
  • attrs (list of str) – The names of the attribute to set.
  • kwargs (dict) – The dictionary from which to retrieve the attribute value.
write(stream)

Called when this needs to be synced over the network. This is only needed when this ComponentDefinition is dynamically added to entities.

Parameters:stream (DataStream) – The stream that the Component data should be written to.
isFrozen
The current frozen state of this ComponentDefinition.

Animation

class Animation
__init__([start=''])
Parameters:start (str) –
base(base)
Parameters:base (str) –
bind(key, animation[, base=''])
Parameters:
  • key (str) –
  • animation (str) –
  • base (str) –
setLooping(animation, looping)
Parameters:
  • animation (str) –
  • looping (bool) –
looping
start

Attachment

class Attachment

Bag

class Bag
__init__([capacity=1[, canCarry=False]])
Parameters:
  • capacity (int) –
  • canCarry (bool) –
canCarry
capacity

Combat

class Combat
__init__( [team=siege.component.CombatTeam.ALPHA, numberOffset, >]])
Parameters:
blockStaminaCost
blockThreshold
experienceYield
knockbackModifier
levels
magicalReduction
numberOffset
onDamageSound
onDeath
onDeathSound
onLevelUp
physicalReduction
team

Craft

class Craft
__init__([category=''[, subcategory=''[, level=1[, experience=0]]]])
Parameters:
  • category (str) –
  • subcategory (str) –
  • level (int) –
  • experience (int) –
genus(item, quantity)
Parameters:
  • item (str) –
  • quantity (int) –
material(itemPath, quantity, requiresDiscovery)
Parameters:
  • itemPath (str) –
  • quantity (int) –
  • requiresDiscovery (bool) –
result(quantity, quality)
Parameters:
  • quantity (int) –
  • quality (int) –
result(itemPath, quantity, quality)
Parameters:
  • itemPath (str) –
  • quantity (int) –
  • quality (int) –
result(items, quality)
Parameters:
  • items (list) –
  • quality (int) –
category
experience
isResearchable
level
materials
onCraft
requiresDiscoveryMaterials
results
servicesRequired
subcategory

Dropped

class Dropped
__init__(arg2, arg3)
Parameters:
  • arg2 (int) –
  • arg3 (int) –
delay
quantity

Effects

class Effects

Event

class Event
__getitem__(name)
Parameters:name (str) –
Return type:GameEvent
events

Foliage

class Foliage
compatibleTiles
drops
foliageNeighbors
foliageType
growChance
growDepth
growthDirections
growthType
hasAutotiling
maxLength
onPhysicsEntityContact
onlyAutotileWithSelf
particlePath
priority
reactivateOnNeighborChange
requiresEmptyNeighbor
simple
spreadRange
spreadRate
The frequency this foliage is considered a spreader. 0 being very rarely and 100 is all of the time.
spreadTimeRange
standard
supportDirection
updateTimeRange
variants

Gear

class Gear
slots

Hull

class Hull
__init__([opacity=0])
Parameters:opacity (int) –
enabled
opacity

Inventory

class Inventory
__init__( bags])
Parameters:bags] (list) –
bags

Item

class Item
__init__( [stack=1[, useTime=100[, usable=True[, unique=False[, use=<siege.graphic.Substitution[, hold=<siege.graphic.Substitution)
Parameters:
setUseAnimation(animation[, group=''])
Parameters:
  • animation (str) –
  • group (str) –
buyPrice
canRepeatUse
classification
cooldown
features
genus
hold
holdExterior
quality
requiresResearch
scraps
sellPrice
stack
tags
unique
usable
use
useAnimation
useGroup
useTime

Legend

class Legend

Light

class Light
sources

MapMarker

class MapMarker
__init__(arg2, arg3, arg4)
Parameters:
  • arg2 (str) –
  • arg3 (str) –
  • arg4 (bool) –
icon
markerType
updatePosition

ModularRender

class ModularRender
__init__([dataFile=''[, icon=''[, contentPath='']]])
Parameters:
  • dataFile (str) –
  • icon (str) –
  • contentPath (object) –
addMapping(arg2, arg3)
Parameters:
  • arg2 (str) –
  • arg3 (str) –
setOrder(arg2)
Parameters:arg2 (list) –
attachmentAnimationBlacklists
dataFile
icon
origin
sheets
wicon

Monster

class Monster
__init__( [onCreate=None, spawnOffset, >]])
Parameters:
  • onCreate (object) –
  • spawnOffset (Vector) –
  • >]] (=0) –
biomes
hostile
isParagon
layer
levels
onCreate
placementCallback
placementType
spawnOffset
weight

Organic

class Organic
__init__( arg2, arg3, arg4])
Parameters:
  • arg2 (object) –
  • arg3 (PixelVector) –
  • arg4] (list) –
axis
habitables
onCreate
size

Particle

class Particle
alpha
amount
color
lifetime
lightSource
particleArea
particleLife
particlePositions
position
rate
rotation
scale
textureCoords
texturePath
x
y

Physics

class Physics
active
applyGravityOnGround
body
collision
fallCap
friction
gravity
groundFriction
hasGroundCollision
immovable
passthrough
restitution
simulated
slope

Placement

class Placement
__init__([axis=<siege.component.PlacementAxis[, allowCollection=True[, allowSupportRemoval=False]]])
Parameters:
  • axis (PlacementAxis) –
  • allowCollection (bool) –
  • allowSupportRemoval (bool) –
addAxis(data)
Parameters:data (PlacementAxis) –
allowCollection
allowSupportRemoval
axes
destroyOnSupportRemoved
dropped
onCreate
onHit
shouldDropItem

PlayerState

class PlayerState

RecipeSet

class RecipeSet
__init__(arg2)
Parameters:arg2 (list) –

Render

class Render
__init__( arg2, arg3])
Parameters:
  • arg2 (str) –
  • arg3] (object) –
color
data
flipX
flipY
icon
image
mask
position
resetStates
rotation
scale
states
wicon

ExtendableRender

class ExtendableRender
__init__(image[, contentPath=''])
Parameters:
  • image (str) –
  • contentPath (object) –
endWidth
middleWidth
startWidth

Reserves

class Reserves

Shield

class Shield
__init__([physicalReduction=0[, magicalReduction=0[, onUse=None]]])
Parameters:
  • physicalReduction (int) –
  • magicalReduction (int) –
  • onUse (object) –
blockSound
magicalReduction
onUse
physicalReduction
staminaCost
threshold

Statistics

class Statistics

Stats

class Stats
stats

SubstitutionDefinition

class SubstitutionDefinition
addSub( base, replacement, origin, >])
Parameters:
  • base (str) –
  • replacement (str) –
  • origin (Vector) –
  • >] (=0) –
hide(arg2)
Parameters:arg2 (str) –
substitutions

Body

class Body
__init__([identifier=''])
Parameters:identifier (str) –
addComponent(component)
Parameters:component (object) –
addCustom(custom)
Parameters:custom (BodyCustomization) –
animation
colors
customizations
identifier
initialize

Customization

class Customization
__init__( arg2, arg3])
Parameters:
  • arg2 (str) –
  • arg3] (bool) –
bodies
group
supportsColor

Equipment

class Equipment
__init__([slots=[][, levelRequired=0]])
Parameters:
  • slots (list) –
  • levelRequired (int) –
attributes
canEquip
isAttached
levelRequired
onCreate
onEquip
onUnequip
paths
potentialRange
potentials
slots

Surface

class Surface
__init__([services=[]])
Parameters:services (list) –
services

Talents

class Talents
talents

Tile

class Tile
__init__([layer=siege.world.realm.Layer.WallAndGround[, level=1[, durability=1[, priority=500[, variants=3]]]]])
Parameters:
  • layer (Layer) –
  • level (int) –
  • durability (int) –
  • priority (int) –
  • variants (int) –
addVariant(variant)
Parameters:variant (list) –
allowLightThrough
canPlace
collisions
consume
dropped
durability
foliage
fragile
groups
layer
level
lightSource
mapGroundColor
mapWallColor
onBreakSound
onCreated
onDamaged
onDestroyed
onFoliageChange
onHitSound
onLoad
onNeighborChange
onPhysicsEntityContact
onUpdate
onlyAutotileWithSelf
opacity
particleColor
passthrough
priority
renderLayer
replaceable
simple
solid
stable
standard
support
surfaceFriction
updateTime
updateVisual
variants
wallOpacity

Tool

class Tool
__init__([power=0[, harvestPower=0[, reach=0[, compatible=[]]]]])
Parameters:
  • power (int) –
  • harvestPower (int) –
  • reach (int) –
  • compatible (list) –
compatible
harvestPower
power
reach

Toolbar

class Toolbar

Trigger

class Trigger
__init__(arg2, arg3, arg4, arg5)
Parameters:
  • arg2 (object) –
  • arg3 (list) –
  • arg4 (object) –
  • arg5 (dict) –
actions
checkExpired
data
trigger

Weapon

class Weapon
__init__([category=''[, power=0[, attackType=0[, damageType=0[, onUse=None]]]]])
Parameters:
  • category (str) –
  • power (int) –
  • attackType (int) –
  • damageType (int) –
  • onUse (object) –
attackType
category
damageType
onUse
power
swapBackOnAnimationFinish
weaponAttacks

ComponentFactory

class ComponentFactory
__call__(arg2, arg3, arg4)
Parameters:
  • arg2 (Entity) –
  • arg3 (str) –
  • arg4 (object) –
Return type:

Component
static create([func=None])
Parameters:func (object) –
Return type:ComponentFactory

ComponentMap

class ComponentMap
__contains__(arg2)
Parameters:arg2 (object) –
Return type:bool
__delitem__(arg2)
Parameters:arg2 (object) –
__getitem__(arg2)
Parameters:arg2 (object) –
Return type:object
__iter__()
Return type:object
__len__()
Return type:int
__setitem__(arg2, arg3)
Parameters:
  • arg2 (object) –
  • arg3 (object) –

CooldownMap

class CooldownMap
__contains__(arg2)
Parameters:arg2 (object) –
Return type:bool
__delitem__(arg2)
Parameters:arg2 (object) –
__getitem__(arg2)
Parameters:arg2 (object) –
Return type:object
__iter__()
Return type:object
__len__()
Return type:int
__setitem__(arg2, arg3)
Parameters:
  • arg2 (object) –
  • arg3 (object) –

CraftResult

class CraftResult
__init__(quality)
Parameters:quality (int) –
__init__(craftResult)
Parameters:craftResult (CraftResult) –
items
quality

CraftResultList

class CraftResultList
__contains__(arg2)
Parameters:arg2 (object) –
Return type:bool
__delitem__(arg2)
Parameters:arg2 (object) –
__getitem__(arg2)
Parameters:arg2 (object) –
Return type:object
__iter__()
Return type:object
__len__()
Return type:int
__setitem__(arg2, arg3)
Parameters:
  • arg2 (object) –
  • arg3 (object) –
append(arg2)
Parameters:arg2 (object) –
extend(arg2)
Parameters:arg2 (object) –

Customizations

class Customizations
__contains__(arg2)
Parameters:arg2 (object) –
Return type:bool
__delitem__(arg2)
Parameters:arg2 (object) –
__getitem__(arg2)
Parameters:arg2 (object) –
Return type:object
__iter__()
Return type:object
__len__()
Return type:int
__setitem__(arg2, arg3)
Parameters:
  • arg2 (object) –
  • arg3 (object) –
append(arg2)
Parameters:arg2 (object) –
extend(arg2)
Parameters:arg2 (object) –

EventMap

class EventMap
__contains__(arg2)
Parameters:arg2 (object) –
Return type:bool
__delitem__(arg2)
Parameters:arg2 (object) –
__getitem__(arg2)
Parameters:arg2 (object) –
Return type:object
__iter__()
Return type:object
__len__()
Return type:int
__setitem__(arg2, arg3)
Parameters:
  • arg2 (object) –
  • arg3 (object) –

EventResult

class EventResult
result

FoliageNeighbor

class FoliageNeighbor
__init__(arg2, arg3, arg4, arg5)
Parameters:
chance
delay
direction
foliage

FoliageNeighborList

class FoliageNeighborList
__contains__(arg2)
Parameters:arg2 (object) –
Return type:bool
__delitem__(arg2)
Parameters:arg2 (object) –
__getitem__(arg2)
Parameters:arg2 (object) –
Return type:object
__iter__()
Return type:object
__len__()
Return type:int
__setitem__(arg2, arg3)
Parameters:
  • arg2 (object) –
  • arg3 (object) –
append(arg2)
Parameters:arg2 (object) –
extend(arg2)
Parameters:arg2 (object) –

GearSlot

class GearSlot
__init__(name, category, icon[, attachment=''[, active=True[, showInUi=False]]])
Parameters:
  • name (str) –
  • category (str) –
  • icon (object) –
  • attachment (str) –
  • active (bool) –
  • showInUi (bool) –
active
attachment
category
enabled
icon
item
name
showInUi

GearSlots

class GearSlots
__contains__(arg2)
Parameters:arg2 (object) –
Return type:bool
__delitem__(arg2)
Parameters:arg2 (object) –
__getitem__(arg2)
Parameters:arg2 (object) –
Return type:object
__iter__()
Return type:object
__len__()
Return type:int
__setitem__(arg2, arg3)
Parameters:
  • arg2 (object) –
  • arg3 (object) –
append(arg2)
Parameters:arg2 (object) –
extend(arg2)
Parameters:arg2 (object) –

GrapplerData

class GrapplerData
__init__(id, support)
Parameters:
id
support

GrapplerDataList

class GrapplerDataList
__contains__(arg2)
Parameters:arg2 (object) –
Return type:bool
__delitem__(arg2)
Parameters:arg2 (object) –
__getitem__(arg2)
Parameters:arg2 (object) –
Return type:object
__iter__()
Return type:object
__len__()
Return type:int
__setitem__(arg2, arg3)
Parameters:
  • arg2 (object) –
  • arg3 (object) –
append(arg2)
Parameters:arg2 (object) –
extend(arg2)
Parameters:arg2 (object) –

ItemBags

class ItemBags
__contains__(arg2)
Parameters:arg2 (object) –
Return type:bool
__delitem__(arg2)
Parameters:arg2 (object) –
__getitem__(arg2)
Parameters:arg2 (object) –
Return type:object
__iter__()
Return type:object
__len__()
Return type:int
__setitem__(arg2, arg3)
Parameters:
  • arg2 (object) –
  • arg3 (object) –
append(arg2)
Parameters:arg2 (object) –
extend(arg2)
Parameters:arg2 (object) –

LoopingMap

class LoopingMap
__contains__(arg2)
Parameters:arg2 (object) –
Return type:bool
__delitem__(arg2)
Parameters:arg2 (object) –
__getitem__(arg2)
Parameters:arg2 (object) –
Return type:object
__iter__()
Return type:object
__len__()
Return type:int
__setitem__(arg2, arg3)
Parameters:
  • arg2 (object) –
  • arg3 (object) –

MaterialList

class MaterialList
__contains__(arg2)
Parameters:arg2 (object) –
Return type:bool
__delitem__(arg2)
Parameters:arg2 (object) –
__getitem__(arg2)
Parameters:arg2 (object) –
Return type:object
__iter__()
Return type:object
__len__()
Return type:int
__setitem__(arg2, arg3)
Parameters:
  • arg2 (object) –
  • arg3 (object) –
append(arg2)
Parameters:arg2 (object) –
extend(arg2)
Parameters:arg2 (object) –

ModularRenderSprite

class ModularRenderSprite
id
modular
sprite
texture

ModularRenderSpriteList

class ModularRenderSpriteList
__contains__(arg2)
Parameters:arg2 (object) –
Return type:bool
__delitem__(arg2)
Parameters:arg2 (object) –
__getitem__(arg2)
Parameters:arg2 (object) –
Return type:object
__iter__()
Return type:object
__len__()
Return type:int
__setitem__(arg2, arg3)
Parameters:
  • arg2 (object) –
  • arg3 (object) –
append(arg2)
Parameters:arg2 (object) –
extend(arg2)
Parameters:arg2 (object) –

ModularSprite

class ModularSprite
flipX
hsl
id
isVisible
position
scale
spriteId
states

ModularSpriteList

class ModularSpriteList
__contains__(arg2)
Parameters:arg2 (object) –
Return type:bool
__delitem__(arg2)
Parameters:arg2 (object) –
__getitem__(arg2)
Parameters:arg2 (object) –
Return type:object
__iter__()
Return type:object
__len__()
Return type:int
__setitem__(arg2, arg3)
Parameters:
  • arg2 (object) –
  • arg3 (object) –
append(arg2)
Parameters:arg2 (object) –
extend(arg2)
Parameters:arg2 (object) –

ModularSpriteListMap

class ModularSpriteListMap
__contains__(arg2)
Parameters:arg2 (object) –
Return type:bool
__delitem__(arg2)
Parameters:arg2 (object) –
__getitem__(arg2)
Parameters:arg2 (object) –
Return type:object
__iter__()
Return type:object
__len__()
Return type:int
__setitem__(arg2, arg3)
Parameters:
  • arg2 (object) –
  • arg3 (object) –

PlacementAxes

class PlacementAxes
__contains__(arg2)
Parameters:arg2 (object) –
Return type:bool
__delitem__(arg2)
Parameters:arg2 (object) –
__getitem__(arg2)
Parameters:arg2 (object) –
Return type:object
__iter__()
Return type:object
__len__()
Return type:int
__setitem__(arg2, arg3)
Parameters:
  • arg2 (object) –
  • arg3 (object) –
append(arg2)
Parameters:arg2 (object) –
extend(arg2)
Parameters:arg2 (object) –

PlacementAxis

class PlacementAxis
__init__( axis, area, >[, layer=siege.world.realm.Layer.None]])
Parameters:
addSupport(data)
Parameters:data (PlacementSupport) –
animation
area
layer
range
type

PlacementSupport

class PlacementSupport
__init__( type, range])
Parameters:
range
support

PotentialAttribute

class PotentialAttribute
__init__( type, onCreate, weight, quality])
Parameters:
  • type (str) –
  • onCreate (object) –
  • weight (int) –
  • quality] (int) –
onCreate
quality
type
weight

PotentialAttributeList

class PotentialAttributeList
__contains__(arg2)
Parameters:arg2 (object) –
Return type:bool
__delitem__(arg2)
Parameters:arg2 (object) –
__getitem__(arg2)
Parameters:arg2 (object) –
Return type:object
__iter__()
Return type:object
__len__()
Return type:int
__setitem__(arg2, arg3)
Parameters:
  • arg2 (object) –
  • arg3 (object) –
append(arg2)
Parameters:arg2 (object) –
extend(arg2)
Parameters:arg2 (object) –

SheetEntry

class SheetEntry
__eq__(arg2)
Parameters:arg2 (SheetEntry) –
Return type:bool
__init__( arg2, arg3, arg4])
Parameters:
image
origin
textureRect

SkillDefinitionList

class SkillDefinitionList
__contains__(arg2)
Parameters:arg2 (object) –
Return type:bool
__delitem__(arg2)
Parameters:arg2 (object) –
__getitem__(arg2)
Parameters:arg2 (object) –
Return type:object
__iter__()
Return type:object
__len__()
Return type:int
__setitem__(arg2, arg3)
Parameters:
  • arg2 (object) –
  • arg3 (object) –
append(arg2)
Parameters:arg2 (object) –
extend(arg2)
Parameters:arg2 (object) –

SkillList

class SkillList
__contains__(arg2)
Parameters:arg2 (object) –
Return type:bool
__delitem__(arg2)
Parameters:arg2 (object) –
__getitem__(arg2)
Parameters:arg2 (object) –
Return type:object
__iter__()
Return type:object
__len__()
Return type:int
__setitem__(arg2, arg3)
Parameters:
  • arg2 (object) –
  • arg3 (object) –
append(arg2)
Parameters:arg2 (object) –
extend(arg2)
Parameters:arg2 (object) –

SpriteNameIdsMap

class SpriteNameIdsMap
__contains__(arg2)
Parameters:arg2 (object) –
Return type:bool
__delitem__(arg2)
Parameters:arg2 (object) –
__getitem__(arg2)
Parameters:arg2 (object) –
Return type:object
__iter__()
Return type:object
__len__()
Return type:int
__setitem__(arg2, arg3)
Parameters:
  • arg2 (object) –
  • arg3 (object) –

SpriteSheet

class SpriteSheet
__contains__(arg2)
Parameters:arg2 (object) –
Return type:bool
__delitem__(arg2)
Parameters:arg2 (object) –
__getitem__(arg2)
Parameters:arg2 (object) –
Return type:object
__iter__()
Return type:object
__len__()
Return type:int
__setitem__(arg2, arg3)
Parameters:
  • arg2 (object) –
  • arg3 (object) –
append(arg2)
Parameters:arg2 (object) –
extend(arg2)
Parameters:arg2 (object) –

SpriteSheetsMap

class SpriteSheetsMap
__contains__(arg2)
Parameters:arg2 (object) –
Return type:bool
__delitem__(arg2)
Parameters:arg2 (object) –
__getitem__(arg2)
Parameters:arg2 (object) –
Return type:object
__iter__()
Return type:object
__len__()
Return type:int
__setitem__(arg2, arg3)
Parameters:
  • arg2 (object) –
  • arg3 (object) –

Stat

class Stat
__init__(name, fullName, start, cap, hasMax, visible)
Parameters:
  • name (str) –
  • fullName (str) –
  • start (float) –
  • cap (float) –
  • hasMax (bool) –
  • visible (bool) –
cap
fullName
hasMax
isVisible
name
start

StatDefinitionList

class StatDefinitionList
__contains__(arg2)
Parameters:arg2 (object) –
Return type:bool
__delitem__(arg2)
Parameters:arg2 (object) –
__getitem__(arg2)
Parameters:arg2 (object) –
Return type:object
__iter__()
Return type:object
__len__()
Return type:int
__setitem__(arg2, arg3)
Parameters:
  • arg2 (object) –
  • arg3 (object) –
append(arg2)
Parameters:arg2 (object) –
extend(arg2)
Parameters:arg2 (object) –

TalentDefinitionList

class TalentDefinitionList
__contains__(arg2)
Parameters:arg2 (object) –
Return type:bool
__delitem__(arg2)
Parameters:arg2 (object) –
__getitem__(arg2)
Parameters:arg2 (object) –
Return type:object
__iter__()
Return type:object
__len__()
Return type:int
__setitem__(arg2, arg3)
Parameters:
  • arg2 (object) –
  • arg3 (object) –
append(arg2)
Parameters:arg2 (object) –
extend(arg2)
Parameters:arg2 (object) –

TalentList

class TalentList
__contains__(arg2)
Parameters:arg2 (object) –
Return type:bool
__delitem__(arg2)
Parameters:arg2 (object) –
__getitem__(arg2)
Parameters:arg2 (object) –
Return type:object
__iter__()
Return type:object
__len__()
Return type:int
__setitem__(arg2, arg3)
Parameters:
  • arg2 (object) –
  • arg3 (object) –
append(arg2)
Parameters:arg2 (object) –
extend(arg2)
Parameters:arg2 (object) –

TalentMap

class TalentMap
__contains__(arg2)
Parameters:arg2 (object) –
Return type:bool
__delitem__(arg2)
Parameters:arg2 (object) –
__getitem__(arg2)
Parameters:arg2 (object) –
Return type:object
__iter__()
Return type:object
__len__()
Return type:int
__setitem__(arg2, arg3)
Parameters:
  • arg2 (object) –
  • arg3 (object) –

ToolItemList

class ToolItemList
__contains__(arg2)
Parameters:arg2 (object) –
Return type:bool
__delitem__(arg2)
Parameters:arg2 (object) –
__getitem__(arg2)
Parameters:arg2 (object) –
Return type:object
__iter__()
Return type:object
__len__()
Return type:int
__setitem__(arg2, arg3)
Parameters:
  • arg2 (object) –
  • arg3 (object) –
append(arg2)
Parameters:arg2 (object) –
extend(arg2)
Parameters:arg2 (object) –

ToolUsabilityResult

class ToolUsabilityResult
entity
harvestCompatible
isUsable
layer
position
useTile

WeaponAttack

class WeaponAttack
__init__(power, animation[, hitFrames=[][, attackTime=0[, comboTime=0[, cost=0[, sound='']]]]])
Parameters:
  • power (int) –
  • animation (str) –
  • hitFrames (list) –
  • attackTime (int) –
  • comboTime (int) –
  • cost (int) –
  • sound (str) –
animation
attackTime
comboTime
hitFrames
power
sound
staminaCost

WeaponAttackList

class WeaponAttackList
__contains__(arg2)
Parameters:arg2 (object) –
Return type:bool
__delitem__(arg2)
Parameters:arg2 (object) –
__getitem__(arg2)
Parameters:arg2 (object) –
Return type:object
__iter__()
Return type:object
__len__()
Return type:int
__setitem__(arg2, arg3)
Parameters:
  • arg2 (object) –
  • arg3 (object) –
append(arg2)
Parameters:arg2 (object) –
extend(arg2)
Parameters:arg2 (object) –