Playing Animations

Getting Animations

set {_animation} to animation tagged "myanimation" from local storage

Creating a Display Animator

A DisplayAnimator is used to play and stop animations on a group.

#Create a linear animator
set {_animator} to linear animator using {_animation}

#Create a looping animator (Must manually be stopped)
set {_animator} to looping animator using {_animation}

Play Animations

#Play an animation on an active group
play animation on {_activegroup} using {_animator}

#Play an animation on an active group starting at a frame
play animation on {_activegroup} using {_animator} starting at frame 3

#Play an animation on an active group for a player
play animation on {_activegroup} using {_animator} for {_player}

#Play an animation on an active group for a player starting at a frame
play animation on {_activegroup} using {_animator} starting at frame 7 for {_player}

Stop Animations

#Stop all animations playing on a group
stop all animations on {_activegroup}

#Stop an animation played by a specific animator
stop animation on {_activegroup} from {_animator}

#Stop an animation that was played for a specific player
stop packet animation on {_activegroup} from {_animator} for {_player}

#Stop an animation that was played for a specific player, and exit their animation camera
stop packet animation on {_activegroup} from {_animator} for {_player} and stop camera

Show Animation Frame on Group

#Show an animation frame on an active group
show frame with id 2 on {_activegroup} from {_animation}

#Show an animation frame on an active group for a specific player
show frame with id 12 on {_activegroup} with {_animation} for {_player}

#Show an animation frame on an active group (With manually changed duration and delay)
show frame with id 5 on {_activegroup} from {_animation} with duration 5 seconds and delay 0 ticks

Play Animation Camera

Put a player in the perspective of an animations camera. The camera path must have been created in BDEngine to use this.

#Start an animation camera for a player
play camera on {_activegroup} with {_animator} for {_player}

#Start an animation camera for a player at a given frame
play camera on {_activegroup} using {_animation} for {_player} starting at frame 3

#Start an animation cameras with delays
#Start transition is how long it takes to go from the player's position to first camera position
#End delay is how long to stay in the last camera position
play camera on {_activegroup} using {_animation} for {_player} with a start transition of 3 ticks and end delay of 2 seconds

Stop/Exit Animation Camera

stop animation camera for {_player}