Overview
The Play Timeline Animation and Stop Timeline Animation actions control animation sequences that you create in the Creator App’s Timeline editor. Unlike Play Object Animation (which triggers pre-baked model animations), Timeline animations are authored in the Creator App and can combine movements, visibility changes, timing, and other effects across multiple objects and properties.Play Timeline Animation
When to Use
- Custom animation sequences: play an animation you created in the Timeline editor
- Synchronized multi-object animations: coordinate movements across several objects
- Procedural effects: fade objects in/out, move camera, or rotate multiple objects together
- Scripted demonstrations: show step-by-step visual walkthroughs
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| Timeline ID | string | Yes | Select the timeline animation you created in the Timeline editor. This is the ID/name of the timeline you want to play. |
| Play Mode | enum | No | How the animation plays: once (play once) or loop (repeat continuously). Default is once. |
| Speed | number | No | Playback speed multiplier. Default is 1.0. Set to 0.5 for slower, 2.0 for faster. |
Key Behavior
- Authored in Timeline: The timeline must exist in your Creator App project. Design it in the Timeline editor first.
- Fire and forget: The action starts playback; subsequent actions don’t wait unless you add a Delay.
- No blocking: Other interactions or transitions can occur while the timeline plays.
Stop Timeline Animation
When to Use
- Interrupt animations: stop a looping timeline animation when exiting a state
- Clean up: ensure timelines don’t continue playing unexpectedly
- Multi-animation management: stop a specific timeline while others continue
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| Timeline ID | string | No | (Optional) Specify the timeline to stop. If omitted, all playing timeline animations stop. |
Key Behavior
- Selective or omnibus: Stop a specific timeline by ID, or stop all timelines if you leave Timeline ID empty.
- Safe to call: Calling Stop Timeline Animation when no timeline is playing has no effect.
Practical Examples
Animated Tutorial Walkthrough
Scenario: A state shows a multi-step assembly task. A timeline demonstrates each step in sequence: move component A, rotate it, attach component B, then highlight the result.In the Timeline editor, create a timeline called
assembly_demo:- 0–2s: move component_a to position
- 2–3s: rotate component_a
- 3–4s: move component_b into place
- 4–5s: highlight both components
In your training state’s
onEntry:- Play Timeline Animation: Timeline ID:
assembly_demo - Delay:
5000(let the timeline complete) - Show Prompt: display instructions for learner to replicate the steps
Looping Environment Animation
Scenario: A factory state has a continuously running conveyor belt animation.In the FactoryFloor state’s
onEntry:- Play Timeline Animation: Timeline ID:
conveyor_loop, Play Mode:loop
Speed-Controlled Demonstration
Scenario: Show a process animation at different speeds. Instructors can choose “normal speed” or “slow motion” for detailed learning.In a transition action list (triggered by a button):
- Set Variable:
demoSpeed = 0.5(slow motion flag) - Play Timeline Animation: Timeline ID:
process_demo, Speed:0.5
Conditional Animation Cleanup
Scenario: Multiple timelines might be playing. Stop only specific ones based on learner actions.When the learner clicks “focus on object”, execute:
- Stop Timeline Animation: Timeline ID:
background_loop(keep object animation running)
Timeline animations and Object Animations can play simultaneously. For example, you could play an object’s embedded animation (e.g.,
valve_open) while a timeline animation (e.g., camera_pan) runs at the same time. Both will execute in parallel.