Skip to content

RUSTICDOCS Search documentation

Docs v0.1

Documentation

Welcome to Rustic

Engine Open Source Development

Getting Started

Introduction to Rustic Engine Requirements and installation Create and reopen a project

Editor Manual

Editor workflow

Editor overview

Overview Scene hierarchy Explorer and assets Inspector Viewport tools Cameras, lighting and environment Playtesting and debugging

Gameplay and Scripting

Scopes, lifecycle and execution Lifecycle callbacks Edit scene objects

Gameplay programming

Overview Project layout and ownership Lifecycle, execution order, and API 1.0 JavaScript lifecycle and API 1.0

External process languages

Overview Selecting the game camera External language runtime integration Native callback setup C++ API Install external language toolchains

HTML/CSS content Validation, diagnostics, and reload Sandbox and play safety Troubleshooting

Lua 5.4

Overview Attach and choose a scope Module and callbacks Script API Finding and creating objects Input Isolation and failures

JavaScript

Overview Behavior lifecycle API reference

Scene, instances, cameras, and input

Overview JavaScript scene lookup JavaScript instance creation Select the JavaScript game camera JavaScript keyboard input

Sandbox, values, and diagnostics

Luau

Overview Setup and attachment Complete behavior Built-in functions Callbacks and values Current limits and diagnosis

Python

Overview Setup and attachment Complete behavior Built-in functions Callbacks and values Current limits and diagnosis

C

Overview Setup and attachment Complete behavior Built-in functions Callbacks and values Current limits and diagnosis

C++

Overview Complete behavior Typed API Scene and object operations Lifetime, safety, and compatibility

C#

Overview Setup and attachment Complete behavior Built-in functions Callbacks and values Current limits and diagnosis

Java

Overview Setup and attachment Complete behavior Built-in functions Callbacks and values Current limits and diagnosis

PHP

Overview Setup and attachment Complete behavior Built-in functions Callbacks and values Current limits and diagnosis

HTML/CSS

Overview HTML behavior Available inline JavaScript API Security and limitations

Engine Systems

Systems overview APIs in every language Gameplay API architecture Use entity foundations Scripting expansion status Call APIs through paths

Sky & atmosphere

Overview Diagnose environment script changes Environment calls in other languages Change the environment from scripts Set up a sky Lighting and haze Diagnose problems

AI agents & app data

Overview Connect an agent Read and edit agent information Storage and migration Limits and troubleshooting

Cameras & lights

Overview Camera Light Move and scale handles Scene selection outline Verification

API Reference

Entity & time

Overview rustic.entity_id()rustic.delta_time()rustic.fixed_delta_time()

Transforms

Overview rustic.get_translation()rustic.set_translation()

Public properties

Overview rustic.get_property()rustic.set_property()

Built-in attributes

Overview rustic.get_attribute()rustic.edit_attribute()rustic.get_object_attribute()rustic.edit_object_attribute()rustic.game.Scene.Root.Child.EditAttribute()

Input

Overview rustic.input()rustic.key()rustic.key_events()rustic.any_key_pressed()

Logging

Overview rustic.log()print()warn()

Enabled state

Overview rustic.set_enabled()

Gameplay actions

Entity foundations

Overview Tags.add()Tags.remove()Tags.find_all()Groups.create()Groups.add()Groups.get_members()Hierarchy.set_parent()Hierarchy.get_children()Hierarchy.detach()Entity.destroy()Entity.destroy_after()Entity.is_valid()Components.has()Components.get_all()Components.find_in_children()World.find_by_tag()World.find_in_radius()

Tween

Overview Tween.to()Tween.move()Tween.rotate()Tween.scale()Tween.value()

Ease

Overview Ease.Linear Ease.InSine Ease.OutSine Ease.InOutSine Ease.InQuad Ease.OutQuad Ease.InOutQuad Ease.InCubic Ease.OutCubic Ease.InOutCubic Ease.InQuart Ease.OutQuart Ease.InOutQuart Ease.InQuint Ease.OutQuint Ease.InOutQuint Ease.InExpo Ease.OutExpo Ease.InOutExpo Ease.InCirc Ease.OutCirc Ease.InOutCirc Ease.InBack Ease.OutBack Ease.InOutBack Ease.InElastic Ease.OutElastic Ease.InOutElastic Ease.InBounce Ease.OutBounce Ease.InOutBounce

Movement

Overview Movement.move()Movement.moveTo()Movement.rotateTo()Movement.lookAt()Movement.follow()Movement.orbit()

Animation

Overview Animation.clips()Animation.load()Animation.register()Animation.addMarker()Animation.play()Animation.blend()Animation.transition()Animation.stop()Animation.pause()Animation.speed()Animation.loop()handle.stop()handle.speed()handle.loop()handle.onMarker()Animation.value()Animation.ik()Animation.footPlacement()Animation.lookAt()Animation.headTracking()Animation.recoil()

Sequence and Timeline

Overview Sequence.new()Timeline.new()builder.move()builder.to()builder.animation()builder.wait()builder.call()builder.parallel()builder.play()

Timer

Overview Timer.after()Timer.every()

Smooth and Interpolation

Overview Smooth.lerp()Smooth.slerp()Smooth.inverseLerp()Smooth.remap()Smooth.smoothDamp()

Path

Overview Path.create()Path.follow()

Camera actions

Overview Camera.current()Camera.moveTo()Camera.zoom()Camera.fov()Camera.lookAt()Camera.follow()Camera.orbit()Camera.shake()Camera.transition()

Physics queries and forces

Physics queries

Overview Physics.raycast()Physics.sphereCast()Physics.overlap()

Physics forces

Overview Physics.force()Physics.impulse()Physics.knockback()Physics.launch()Physics.explosion()

Effects

Overview Effects.fade()Effects.flash()Effects.shake()Effects.pulse()

Audio

Overview Audio.get_output_devices()Audio.get_input_devices()Audio.set_output_device()Audio.set_input_device()Audio.load()audio.load()audio.play()audio.stop()audio.pause()audio.resume()audio.unload()audio.Unload()Audio.play()Audio.playAt()voice.pause()voice.resume()voice.stop()Audio.volume()Audio.pitch()Audio.fadeIn()Audio.fadeOut()Audio.crossfade()rustic.game:startRecording()rustic.game:stopRecording()rustic.game:startHotMic()rustic.game:stopHotMic()rec:stopRecording()mic:stopHotMic()capture:read()capture:stop()capture:unload()Game.startRecording()Game.stopRecording()Game.startHotMic()Game.stopHotMic()

Events and signals

Overview Events.on()Events.once()Events.connect()Events.emit()connection.disconnect()Events.disconnect()

Clock

Overview Clock.timeScale()Clock.pause()Clock.resume()Clock.state()

Operation handles

Overview handle.state()handle.pause()handle.resume()handle.cancel()handle.reverse()handle.onFinished()

Scene environment

Overview Game.scene.getEnvironment()Game.scene.setEnvironment()Game.scene.setSkyTexture()

Scene lookup

Overview Game.scene.Find()Game.scene.List()rustic.find_entity()

Add & clone instances

Overview instance.add()instance.clone()

Current camera

Overview Game.setCurrentCamera()

Building and Publishing

Playtesting and publishing

Tutorials and Examples

Your first playable scene First playable scene

Use gameplay actions

Overview Set up gameplay actions Gameplay language bindings Choose easing curves Set action duration or speed Animate entity properties Tween script values Follow a path Schedule timers Control operation handles Compose sequences Animate a camera Follow and orbit objects Apply visual effects Send events and object signals Control the scene clock Understand action cleanup Diagnose gameplay actions Play imported animation clips Layer animation clips Register animation tracks Animate script value keyframes Use procedural animation Evaluate interpolation Query physics colliders Apply physics forces Play and fade audio Validate gameplay services Extend gameplay services

Troubleshooting and Releases

Troubleshooting Feature status and compatibility Versions and changes

DOCS ENGINEGAMEPLAY AND SCRIPTINGJAVASCRIPTSCENE, INSTANCES, CAMERAS, AND INPUT

Scene, instances, cameras, and input

Choose a focused topic below.

Topics

JavaScript scene lookup
JavaScript instance creation
Select the JavaScript game camera
JavaScript keyboard input

PREVIOUSAPI reference NEXTJavaScript scene lookup

ON THIS PAGE