Fraymakers API Docs

Appearance

Instance Variables ​

allowFastFall ​

Type ​

Bool

Initial Value ​

false

Description ​

When true the character will accept fast fall inputs while in the air during the animation.

allowJump ​

Type ​

Bool

Initial Value ​

false

Description ​

When true the character will be able to jump cancel the animation.

allowMovement ​

Type ​

Bool

Initial Value ​

false

Description ​

When true, the player can influence the character's movement during this animation.

allowTurn ​

Type ​

Bool

Initial Value ​

false

Description ​

When true the character will be capable of flipping their direction faced on the first frame of the animation when the opposite direction is tapped prior to the animation.

allowTurnOnFirstFrame ​

Type ​

Bool

Initial Value ​

false

Description ​

When true the character will be capable of flipping their direction faced by tapping a left or right direction for the duration of the animation.

autocancel ​

Type ​

Bool

Initial Value ​

false

Description ​

When true, landing during this animation will ignore the value of landAnimation and send the character to the default landing animation.

bodyStatusShaderColor ​

Type ​

Int

Initial Value ​

null

Description ​

The color filter used when a body status is active. Can set to 0x000000 to disable.

chargeGlow ​

Type ​

Bool

Initial Value ​

false

Description ​

When true, the engine will apply its built-in charge glow animation to the character sprites.

chargeShake ​

Type ​

Bool

Initial Value ​

false

Description ​

When true, the engine will apply its built-in charge shake animation to the character sprites.

doubleJumpCancel ​

Type ​

Bool

Initial Value ​

false

Description ​

Set to true to make upward momentum from a double jump cancel when this move is used.

grabLedgeBehind ​

Type ​

Bool

Initial Value ​

true

Description ​

If set to true the entity will be able to grab ledges from behind them if the type of object allows.

grabLedgeRising ​

Type ​

Bool

Initial Value ​

false

Description ​

If set to true the entity will be able to grab ledges while rising.

leaveGroundAnimation ​

Type ​

String

Initial Value ​

null

Description ​

leaveGroundType ​

Type ​

LeaveGroundType

Initial Value ​

LeaveGroundType.TO_FALL

Description ​

Determines the behaviour of the Character when becoming airborne. @see LeaveGroundType

singleUse ​

Type ​

Bool

Initial Value ​

false

Description ​

Set to true for attack animations that can only be used once when initiated in mid-air.