Animation

A Blockbench animation

Animation.priority

figura.docs.animation.priority
overload 1:
Animation:priority(priority)
Method Property Fluent Description Representation
priority accepts an Integer
Return Value an Animation

Animation.length

figura.docs.animation.length
overload 1:
Animation:length(length)
Method Property Fluent Description Representation
length accepts a Number
Return Value an Animation

Animation.getLength

Gets the animation's length
overload 1:
Animation:getLength()
Method Property Fluent Description Representation
Return Value a Number

Animation.blend

figura.docs.animation.blend
overload 1:
Animation:blend(blend)
Method Property Fluent Description Representation
blend accepts a Number
Return Value an Animation

Animation.offset

figura.docs.animation.offset
overload 1:
Animation:offset(offset)
Method Property Fluent Description Representation
offset accepts a Number
Return Value an Animation

Animation.getPriority

Gets the animation's priority
overload 1:
Animation:getPriority()
Method Property Fluent Description Representation
Return Value an Integer

Animation.stop

Stop the animation
overload 1:
Animation:stop()
Method Property Fluent Description Representation
Return Value nil

Animation.override

figura.docs.animation.override
overload 1:
Animation:override(override)
Method Property Fluent Description Representation
override accepts a Boolean
Return Value an Animation

Animation.loop

figura.docs.animation.loop
overload 1:
Animation:loop(loop)
Method Property Fluent Description Representation
loop accepts a String
Return Value an Animation

Animation.getOffset

Gets the animation's offset time
overload 1:
Animation:getOffset()
Method Property Fluent Description Representation
Return Value a Number

Animation.getTime

Get the animation's playback current time
overload 1:
Animation:getTime()
Method Property Fluent Description Representation
Return Value a Number

Animation.setTime

Sets the animation's playback current time
overload 1:
Animation:setTime(time)
Method Property Fluent Description Representation
time accepts a Number
Return Value nil

Animation.pause

Pause the animation's playback
overload 1:
Animation:pause()
Method Property Fluent Description Representation
Return Value nil

Animation.restart

Restarts the animation
Plays the animation if it was stopped
This behavior can also be reproduced by stopping then playing the animation
overload 1:
Animation:restart()
Method Property Fluent Description Representation
Return Value nil

Animation.startDelay

figura.docs.animation.start_delay
overload 1:
Animation:startDelay(delay)
Method Property Fluent Description Representation
delay accepts a Number
Return Value an Animation

Animation.loopDelay

figura.docs.animation.loop_delay
overload 1:
Animation:loopDelay(delay)
Method Property Fluent Description Representation
delay accepts a Number
Return Value an Animation

Animation.getPlayState

Get the animation's playback state
overload 1:
Animation:getPlayState()
Method Property Fluent Description Representation
Return Value a String

Animation.getBlend

Gets the animation's keyframe blend factor
overload 1:
Animation:getBlend()
Method Property Fluent Description Representation
Return Value a Number

Animation.getSpeed

Gets the animation's speed
overload 1:
Animation:getSpeed()
Method Property Fluent Description Representation
Return Value a Number

Animation.getOverrideRot

Gets if this animation should override its parts vanilla rotation
overload 1:
Animation:getOverrideRot()
Method Property Fluent Description Representation
Return Value a Boolean

Animation.getOverridePos

Gets if this animation should override its parts vanilla position
overload 1:
Animation:getOverridePos()
Method Property Fluent Description Representation
Return Value a Boolean

Animation.overrideRot

figura.docs.animation.override_rot
overload 1:
Animation:overrideRot(override)
Method Property Fluent Description Representation
override accepts a Boolean
Return Value an Animation

Animation.overrideScale

figura.docs.animation.override_scale
overload 1:
Animation:overrideScale(override)
Method Property Fluent Description Representation
override accepts a Boolean
Return Value an Animation

Animation.getLoopDelay

Gets the animation's loop delay
overload 1:
Animation:getLoopDelay()
Method Property Fluent Description Representation
Return Value a Number

Animation.getOverrideScale

Gets if this animation should override its parts vanilla scale
overload 1:
Animation:getOverrideScale()
Method Property Fluent Description Representation
Return Value a Boolean

Animation.addCode

figura.docs.animation.add_code
overload 1:
Animation:addCode(time, code)
Method Property Fluent Description Representation
time accepts a Number
code accepts a String
Return Value an Animation

Animation.getStartDelay

Gets the animation's start delay
overload 1:
Animation:getStartDelay()
Method Property Fluent Description Representation
Return Value a Number

Animation.overridePos

figura.docs.animation.override_pos
overload 1:
Animation:overridePos(override)
Method Property Fluent Description Representation
override accepts a Boolean
Return Value an Animation

Animation.getLoop

Gets the animation's loop mode
overload 1:
Animation:getLoop()
Method Property Fluent Description Representation
Return Value a String

Animation.play

Example by JimmyHelp:
animations.bbmodelName.animationName:play()
Initializes the animation
Resume the animation if it was paused
overload 1:
Animation:play()
Method Property Fluent Description Representation
Return Value nil

Animation.speed

figura.docs.animation.speed
overload 1:
Animation:speed(speed)
Method Property Fluent Description Representation
speed accepts a Number
Return Value an Animation

Animation.name

This animation's name
field signature:
name
Method Property Fluent Description Representation
Field Type a String
a a