Addon ID

  • Spriter

Info

Statistics

  • Download count17,897 total downloads
  • Latest download count 39 downloads of latest version
  • Average download count7 downloads per day average

Owners

lucid's avatar
lucid

A list of all Actions, Conditions and Expressions supported in this addon.

Initialisation

  • Actions

    Associate {0} with Spriter object {1}

    Associate a Construct object type with a named Spriter object (use in On Ready).

    Associate {0} with Spriter object {1} (legacy)

    Legacy alias for Associate type with name.

  • Conditions

    On ready

    Triggered when the Spriter project file has finished loading.

    On ready (legacy)

    Legacy alias for On ready.

Animations

  • Actions

    Set animation to {0} ({1}, blend {2})

    Switch to a different animation.

    Set animation to {0} ({1}, blend {2}) (legacy)

    Legacy alias for Set animation.

    Set playback speed ratio to {0}

    Set the playback speed multiplier.

    Set playback speed ratio to {0} (legacy)

    Legacy alias for Set playback speed ratio.

    Set animation loop to {0}

    Set whether the current animation loops.

    Set animation loop to {0} (legacy)

    Legacy alias for Set animation loop.

    Set animation time ({0}) to {1}

    Set playback time for the current animation.

    Set animation time ({0}) to {1} (legacy)

    Legacy alias for Set animation time.

    Pause animation

    Pause animation playback.

    Pause animation (legacy)

    Legacy alias for Pause animation.

    Resume animation

    Resume animation playback.

    Resume animation (legacy)

    Legacy alias for Resume animation.

    Play animation {0} {1}

    Play towards a target key/time/ratio and stop there.

    Play animation {0} {1} (legacy)

    Legacy alias for Play animation to.

    Set second animation to {0}

    Set a secondary animation for blending.

    Set second animation to {0} (legacy)

    Legacy alias for Set second animation.

    Set animation blend ratio to {0}

    Set blend ratio between primary and secondary animations.

    Set animation blend ratio to {0} (legacy)

    Legacy alias for Set animation blend ratio.

    Stop second animation

    Clear the secondary blending animation.

    Stop second animation (legacy)

    Legacy alias for Stop second animation.

  • Conditions

    On animation {0} finished

    Triggered when the named animation finishes.

    On animation {0} finished (legacy)

    Legacy alias for On animation finished.

    On any animation finished

    Triggered when any animation finishes.

    On any animation finished (legacy)

    Legacy alias for On any animation finished.

    Current key is {0} {1}

    Compare the current mainline key index.

    Current key is {0} {1} (legacy)

    Legacy alias for Compare current key.

    Current time is {0} {1} ({2})

    Compare the current animation time.

    Current time is {0} {1} ({2}) (legacy)

    Legacy alias for Compare current time.

    Current animation is {0}

    Check if the current animation matches the given name.

    Current animation is {0} (legacy)

    Legacy alias for Compare animation.

    Animation is paused

    Check if playback is currently paused.

    Animation is paused (legacy)

    Legacy alias for Animation paused.

    Animation is looping

    Check if the current animation is set to loop.

    Animation is looping (legacy)

    Legacy alias for Animation looping.

    Second animation is {0}

    Compare the secondary animation used for blending.

    Second animation is {0} (legacy)

    Legacy alias for Compare second animation.

  • Expressions

    Key

    Get the current mainline key index.

    TimeRatio

    Get the current playback time as a ratio of animation length.

    PlayTo

    Get the active play-to target time in milliseconds, or -1 if none.

    PlayToTimeLeft

    Get milliseconds remaining until the play-to target is reached.

    AnimationLength

    Get the current animation length in milliseconds.

    SpeedRatio

    Get the current playback speed ratio.

    BlendRatio

    Get the current animation blend ratio (0-1).

    SecondAnimationName

    Get the current secondary animation name (if any).

Entities

  • Actions

    Set entity to {0}, animation {1}

    Switch to a different entity and optionally an animation.

    Set entity to {0}, animation {1} (legacy)

    Legacy alias for Set entity.

  • Conditions

    Current entity is {0}

    Check if the current entity matches the given name.

    Current entity is {0} (legacy)

    Legacy alias for Compare entity.

Size & Position

  • Actions

    Set scale ratio to {0}, X: {1}, Y: {2}

    Set global Spriter scale and optional X/Y flip state.

    Set scale ratio to {0}, X: {1}, Y: {2} (legacy)

    Legacy alias for Set object scale ratio.

    Set X mirror to {0}

    Set X-axis mirror state.

    Set X mirror to {0} (legacy)

    Legacy alias for Set object X flip.

    Set Y flip to {0}

    Set Y-axis flip state.

    Set Y flip to {0} (legacy)

    Legacy alias for Set object Y flip.

  • Conditions

    Object is mirrored on X axis

    Check if the object is currently mirrored on the X axis.

    Object is mirrored on X axis (legacy)

    Legacy alias for Is mirrored.

    Object is flipped on Y axis

    Check if the object is currently flipped on the Y axis.

    Object is flipped on Y axis (legacy)

    Legacy alias for Is flipped.

  • Expressions

    ScaleRatio

    Get the global Spriter scale ratio.

    BBoxLeft

    Get the current bounding-box left edge.

    BBoxRight

    Get the current bounding-box right edge.

    BBoxTop

    Get the current bounding-box top edge.

    BBoxBottom

    Get the current bounding-box bottom edge.

Custom

  • Conditions

    On load failed

    Triggered when the Spriter project file fails to load.

    Is ready

    Check if the Spriter project file has finished loading successfully.

  • Expressions

    LastError

    Get the last Spriter load error message (empty string if none).

    Time

    Get the current playback time in milliseconds for the selected animation.

    ObjectCount

    Get the number of sprite objects in the currently evaluated pose.

    EntityName

    Get the name of the currently selected entity.

    AnimationName

    Get the name of the currently selected animation.

    val

    Get the current Spriter variable value by name (optionally scoped to an object timeline).

Sounds

  • Conditions

    On sound triggered

    Triggered when the current animation triggers a sound key.

    On sound triggered (legacy)

    Legacy alias for On sound triggered.

    On sound volume change

    Triggered when a soundline's volume changes.

    On sound volume change (legacy)

    Legacy alias for On sound volume change.

    On sound panning change

    Triggered when a soundline's panning changes.

    On sound panning change (legacy)

    Legacy alias for On sound panning change.

  • Expressions

    TriggeredSound

    Get the most recently triggered sound name.

    TriggeredSoundTag

    Get the soundline tag/name associated with the latest sound trigger or change.

    SoundVolume

    Get the current volume value for a soundline tag.

    SoundPanning

    Get the current panning value for a soundline tag.

Attach C3 Object

  • Actions

    Pin {0} to Spriter object {2} ({1})

    Persistently attach a Construct instance to a Spriter object each tick.

    Pin {0} to Spriter object {2} ({1}) (legacy)

    Legacy alias for pinning an object to a Spriter object.

    Set {0} to Spriter object {2} ({1})

    One-shot: set a Construct instance to a Spriter object's position/angle this tick only.

    Set {0} to Spriter object {2} ({1}) (legacy)

    Legacy alias for one-shot object sync.

    Unpin {0} from Spriter object {1}

    Remove a pinned Construct object from a Spriter object.

    Unpin {0} from Spriter object {1} (legacy)

    Legacy alias for unpinning an object.

    Unpin all from Spriter object {0}

    Remove all pinned objects from a Spriter object.

    Unpin all from Spriter object {0} (legacy)

    Legacy alias for unpin all.

Action points

  • Conditions

    Action point {0} exists

    Check if an action point/object timeline exists in the current pose.

    Action point {0} exists (legacy)

    Legacy alias for Action point exists.

  • Expressions

    PointX

    Get the current X position for an action point timeline.

    PointY

    Get the current Y position for an action point timeline.

    PointAngle

    Get the current angle (degrees) for an action point timeline.

Objects

  • Actions

    Find Spriter object for {0}

    Set FoundObject to the matching Spriter timeline name for the picked object.

    Find Spriter object for {0} (legacy)

    Legacy alias for Find Spriter object.

  • Conditions

    Object {0} exists

    Check if a Spriter object timeline exists in the current pose.

    Object {0} exists (legacy)

    Legacy alias for Object exists.

  • Expressions

    ObjectX

    Get the current X position for a Spriter object timeline.

    ObjectY

    Get the current Y position for a Spriter object timeline.

    ObjectAngle

    Get the current angle (degrees) for a Spriter object timeline.

    FoundObject

    Get the Spriter object name found by FindSpriterObject.

Appearance

  • Actions

    Set visible to {0} (legacy)

    Legacy visibility action used by older projects.

    Set opacity to {0} (legacy)

    Legacy opacity action used by older projects.

  • Expressions

    GetOpacity

    Get this Spriter instance opacity in percent (0-100).

Misc

  • Actions

    Set ignore global time scale to {0}

    Control whether animation playback ignores layout time scale.

    Set ignore global time scale to {0} (legacy)

    Legacy alias for Set ignore global time scale.

    Sprite layer updates: {0}

    Stop or resume automatic layer syncing for associated objects.

    Sprite layer updates: {0} (legacy)

    Legacy alias for sprite layer update mode.

    Sprite visibility updates: {0}

    Stop or resume automatic visibility syncing for associated objects.

    Sprite visibility updates: {0} (legacy)

    Legacy alias for sprite visibility update mode.

    Sprite collision updates: {0}

    Stop or resume automatic collision syncing for associated objects.

    Sprite collision updates: {0} (legacy)

    Legacy alias for sprite collision update mode.

    Set automatic pausing to {0} (L:{1} R:{2} T:{3} B:{4})

    Configure automatic pausing based on the object position relative to the viewport.

    Set automatic pausing to {0} (L:{1} R:{2} T:{3} B:{4}) (legacy)

    Legacy alias for Set automatic pausing.

    Append character map {0}

    Apply a character map by name.

    Append character map {0} (legacy)

    Legacy alias for Append character map.

    Remove character map {0}

    Remove a previously applied character map.

    Remove character map {0} (legacy)

    Legacy alias for Remove character map.

    Remove all character maps

    Clear all applied character maps.

    Remove all character maps (legacy)

    Legacy alias for Remove all character maps.

    Override {0} component {1} to {2}

    Override a timeline object component value.

    Override {0} component {1} to {2} (legacy)

    Legacy alias for Override object component.

    Override IK parent {0}, child {1}, target ({2}, {3}), extra {4}

    Set a persistent IK override for a parent/child bone pair.

    Override IK parent {0}, child {1}, target ({2}, {3}), extra {4} (legacy)

    Legacy alias for Override bones with IK.

    Load from URL {0} (cross-origin: {1}, scon: {2})

    Load Spriter project data from URL or from the supplied SCON text.

  • Conditions

    Object is outside padded viewport

    True when the Spriter object position is outside the configured padded viewport.

    Object is outside padded viewport (legacy)

    Legacy alias for Outside padded viewport.

    On URL loaded

    Triggered when loadFromURL finishes successfully.

    On URL failed

    Triggered when loadFromURL fails.

    On event {0} triggered

    Triggered when a Spriter eventline with the given name is fired.

    On event {0} triggered (legacy)

    Legacy alias for On event triggered.

    Tag {0} is active ({1})

    Check if a tag is active on the current animation or on a specific timeline/soundline/eventline.

    Tag {0} is active ({1}) (legacy)

    Legacy alias for Tag active.

Z order

  • Actions

    Set Z elevation to {0}

    Set the object Z elevation.

    Set Z elevation to {0} (legacy)

    Legacy alias for Set Z elevation.

  • Conditions

    Compare {0} {1} {2}

    Compare this instance's Z elevation value.

  • Expressions

    ZElevation

    Get this instance's Z elevation.

    TotalZElevation

    Get this instance's total Z elevation.