RUSTICDOCSSearch documentation

Gameplay API reference

Choose the module you need. Every module includes a function-by-function example in each of the ten supported script types, with native syntax and binding limits. For focused tutorials, see Use gameplay actions.

  • Tween — Animate an entity property or script value without writing an Update loop.
  • Ease — Choose one of 31 shared easing curves for actions and synchronous interpolation.
  • Movement — Move, turn, follow and orbit objects with finite engine-scheduled actions.
  • Animation — Play imported skeletal clips, register property tracks, animate script values and run procedural poses.
  • Sequence and Timeline — Compose sequential and parallel actions without nesting timer callbacks.
  • Timer — Schedule one-shot or repeating scene-clock callbacks.
  • Smooth and Interpolation — Evaluate interpolation and damping immediately without scheduling an action.
  • Path — Traverse linear, Bezier and spline paths with global and per-segment easing.
  • Camera actions — Move, aim, zoom, follow and shake a game camera using shared actions.
  • Physics queries and forces — Query live primitive colliders and change simulated body velocity.
  • Effects — Fade, flash, shake and pulse entity properties with shared easing.
  • Audio — Play engine-decoded WAV/OGG voices, adjust parameters and schedule fades.
  • Events and signals — Communicate through queued global events and object-scoped signals across scripting languages.
  • Clock — Scale or pause the shared scene clock for actions, animation, physics and audio.
  • Operation handles — Inspect, pause, resume, cancel and observe engine-scheduled actions.