Instance Variables
animationId
Type
String
Initial Value
null
Description
The id of the animation to use for this structure
disableShadows
Type
Bool
Initial Value
false
Description
When true, shadows should be disabled from rendering on this structure. This is not implemented by the game engine, so you are expected to use it to your needs.
disabled
Type
Bool
Initial Value
false
Description
When true, this CollisionArea instance should become inactive and all hitTests should return false.
dropThrough
Type
Bool
Initial Value
false
Description
When false, the player should be disallowed from falling through the structure via any means. Set to true to permit structure drop-through capability for objects that utilize it.
foregroundAnimationId
Type
String
Initial Value
null
Description
The id of the foreground sprite to use for this structure
foregroundSpriteContent
Type
String
Initial Value
null
Description
Content id path of the foreground sprite to load for this structure
land
Type
Bool
Initial Value
true
Description
When true, objects can land on the structure. When false, the structure will still prevent objects from passing through however their structureCollision component will never register an object as "landed". (StructureType.FLOOR only).
leftLedge
Type
Bool
Initial Value
true
Description
When enabled, left ledge grabs will be enabled on this structure (StructureType.FLOOR only).
leftLedgeSize
Type
Float
Initial Value
null
Description
Determines the length of this structure's left ledges (StructureType.FLOOR only).
ricochet
Type
Bool
Initial Value
true
Description
When false, it will not be possible for game objects to bounce off this object
rightLedge
Type
Bool
Initial Value
true
Description
When enabled, right ledge grabs will be enabled on this structure (StructureType.FLOOR only).
rightLedgeSize
Type
Float
Initial Value
null
Description
Determines the length of this structure's right ledges (StructureType.FLOOR only).
spriteContent
Type
String
Initial Value
null
Description
The content id path of the sprite to load for this structure
startX
Type
Float
Initial Value
0
Description
Starting X position of the structure
startY
Type
Float
Initial Value
0
Description
Starting Y position of the structure
structureType
Type
Int
Initial Value
null
Description
The type of collision behavior to use on this structure