ACES

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

Initialisation

  • Actions

    Associate {0} with name {1}

    Associate an object with its Spriter name.

  • Conditions

    On initialised

    Triggered when .SCML file has loaded and is ready to be associated with objects.

Animations

  • Actions

    Set animation to {0} and {1} with a {2}ms blend

    Set the current animation

    Set playback speed ratio to {0}

    Set the ratio of playback speed

    Set current animation to {0}

    Set whether or not an animation loops

    Set current time in animation to {1} {0}

    Set current time in animation

    Pause animation playback

    Pause animation playback

    Resume animation playback

    Resume animation playback

    Play current animation {0}: {1}

    Play animation from current time to...

  • Conditions

    On animation {0} finished

    Triggered when the animation has finished.

    On any animation finished

    Triggered when any animation has finished.

    Current Key Frame is {0} {1}

    Compare the current key frame number.

    Current Time is {0} {1} {2}

    Compare the current time.

    Is current animation {0}

    Compare the name of the current animation.

    If animation is paused

    Is animation paused?

    If animation is looping

    Is animation set to loop?

  • Expressions

    time

    Returns the current time in the animation between 0 and animation length.

    key

    Returns the index of the current keyframe in the animation between 0 and the number of keys.

    PlayTo

    Returns the target time in the animation between 0 and animation length for the current 'Play animation to...' action, or -1 if there is no current 'Play animation to...' action

    PlayToTimeLeft

    Returns the remaining number of milliseconds(at normal playback speed) left to complete the current 'Play animation to...' action

    animationName

    Returns the name of the current animation

    timeRatio

    Returns the current time as a ratio of the entire animation length between 0.0 and 1.0

    animationLength

    Returns the of the current animation in milliseconds (at normal playback speed)

    speedRatio

    Returns the current playback speed ratio (1.0 is full speed. 0.5 is half speed, 2.0 is double speed)

Size & Position

  • Actions

    Set object scale to {0} - {1} - {2}

    Set the ratio of object scale

    {0}

    Set whether the object is mirrored on the x axis

    {0}

    Set whether the object is flipped on the y axis

  • Conditions

    Mirrored on x axis

    True when the object is mirrored on the x axis

    Flipped on y axis

    True when the object is mirrored on the y axis

  • Expressions

    ScaleRatio

    Returns the scale ratio of the object

    BBoxLeft

    Get the left edge of the object's bounding box, in pixels.

    BBoxRight

    Get the right edge of the object's bounding box, in pixels.

    BBoxTop

    Get the top edge of the object's bounding box, in pixels.

    BBoxBottom

    Get the bottom edge of the object's bounding box, in pixels.

Entities

  • Actions

    Set entity to {0} : {1}

    Set the current entity

  • Conditions

    Is current entity {0}

    Compare the name of the current entity.

  • Expressions

    entityName

    Returns the name of the current entity

Character Maps

  • Actions

    Remove all character maps

    Remove all character maps from the character

    Append character map {0}

    Append character map to this character

Advanced : Animation Blending

  • Actions

    Set second(blended) animation to {0}

    Set the current second(blended) animation

    Set animation blend ratio to {0}

    Set the blend ratio of the current animations

    Stop blending second(blended) animation

    Stops blending the second(blended) animation, and resumes normal playback of the current animation

  • Expressions

    blendRatio

    returns the current blend ratio of animations 0(current animation) to 1(next animation)

    secondAnimationName

    returns the name of the second(blended) animation

Appearance

  • Actions

    Set {0}

    Choose whether the object is hidden or shown

    Set Opacity to {0}

    Set how transparent the object appears.

  • Expressions

    GetOpacity

    Get the object's current opacity, from 0 (transparent) to 100 (opaque).

Advanced : Optimization

  • Actions

    Set to {0}. Padding Left:{1} Right:{2} Top:{3} Bottom{4}

    Set when to automatically pause an animation for efficiency

  • Conditions

    Position is outside padded viewport

    True when this object's x,y coordinate is outside the padded display box set through Set Automatic Pausing action.

Override Animation

  • Actions

    Override object {0}'s {1} with {2}

    Override an object's animation data.

    Override bones {0} and {1} with IK to ({2},{3}) with child bone extended by {4}

    Use IK to override bones' animation data.

Attach C3 Object

  • Actions

    Set {0}'s {1} to {2}

    Set C3 Object's angle and/or position to Spriter Object.

    Pin {0}'s {1} to {2}

    Pin C3 Object's angle and/or position to Spriter Object.

    Unpin {0} from {1}

    Unpin C3 Object's angle and/or position from Spriter Object.

    Unpin all from {0}

    Unpin all C3 Objects from Spriter Object.

Misc

  • Actions

    Set {0}

    Set whether or not to ignore the global time scale of the current layout.

    {0} setting sprite layers

    Stop or resume setting layer to allow you to override them

Objects

  • Actions

    Find Spriter Object for {0}

    Find Spriter Object that corresponds with the C3 Object (retrieve with expression 'foundObject'.

  • Conditions

    Object {0} exists on current frame

    True when the action object exists on the current frame

  • Expressions

    objectX

    returns the current x position of an object

    objectY

    returns the current y position of an object

    objectAngle

    returns the current angle of an object

    foundObject

    returns the name of the last found object (Find Spriter Object action)

Sounds

  • Conditions

    On sound triggered

    Triggered when a sound should begin playback.

    On sound volume change triggered

    Triggered when a sound's volume should change.

    On sound panning change triggered

    Triggered when a sound's volume should change.

  • Expressions

    triggeredSound

    returns the name of the last triggered sound

    triggeredSoundTag

    returns the name of the last triggered sound's tag

    soundVolume

    returns the volume of the sound

    soundPanning

    returns the panning of the sound

Action Points

  • Conditions

    Action Point {0} exists on current frame

    True when the action point exists on the current frame

  • Expressions

    pointX

    returns the current x position of an action point

    pointY

    returns the current y position of an action point

    pointAngle

    returns the current angle of an action point

Events

  • Conditions

    On event {0} triggered

    Triggered upon Spriter events in animation.

Variables and Tags

  • Conditions

    Tag {0} is active on current frame({1})

    True when the tag is active

Tags and Variables

  • Expressions

    val

    returns the currentValue of the Spriter variable (variable name, object name) (the object's name in Spriter, not the name of the C3 object)

Z Order

  • Actions

    Set Z elevation to {0}

    Sets the object's Z elevation.

  • Conditions

    {0} {1} {2}

    Compare the Z elevation to a value.

  • Expressions

    ZElevation

    Get the Z elevation relative to its layer

    TotalZElevation

    Get the total Z elevation taking into account the layer Z elevation

Download

10-12-2019 Stable (170.83 KB)

Info

Statistics

  • Download count 1,366 total downloads
  • Latest download count 4 downloads of latest version
  • Average download count 4 downloads per day average

Owners

  • 11 Comments

  • Order by
Want to leave a comment? Login or Register an account!
  • Can we expect Spriter for C3 runtime within few weeks?

  • Nice, thank you!

  • Thank you so much Lucid!!! not tested yet, but just happy for the effort.

  • Is anyone having trouble with changing the layer of the spriter object? Just the main object changes but the sprites it contains (container) wont. This feature was wroking fine in old version (1.0.0)

  • Perfect =D

  • lucid latest beta version always failed to download

  • ludic What to do if I want to reimport zip folder?

    It doesn't replace new files with old but creating everything new.

  • luckyrawatlucky - it looks like we need to update the documentation. For C3 (C2 runtime) both import methods work, but for either one, you must first zip the Spriter project and drag and drop the zip into C3.

  • When we save Spriter project as .scon

    In Construct 2 we just drag and drop and all images, events imported by itself within C2 project but in C3 drag and drop didn't worked then how to import scon into C3 (C2 runtime) with events and all images

  • Lucid, I am working with C3 runtime and the pluging doeas appear in the addon manager but not in the new object type creation windows...so so far i cannot use it. Am i using it well?

    • Bertconstanty - It doesn't work with the C3 runtime yet. Unfortunately, I don't have an ETA for when I can work on the C3 runtime version yet.