Realot StudioDocs
API reference

API reference

Browse all engine components, every supported script module member, global runtime objects and option shapes.

View as Markdownllms.txt
Start with prerequisitesThe API requirements & complete usage map shows which components or scene systems must exist before an API can be used.

#Components

The editor's component system contains 25 documented component types. Each component page lists its public scene fields, defaults, field descriptions, and the script API members exposed when that component is attached.

TransformPosition, rotation and scale. SpriteRendererTexture, color, flips and opacity. ShapeRendererProcedural square, circle, capsule and triangle shapes. TextRendererWorld-space and screen-space text. StrokePathEditable variable-width lines and textured paths. SpeechBubbleEntity-attached dialogue bubble. ChatLogScrollable message history. TextInputInteractive text entry. JoystickVirtual touch joystick. Rigidbody2DStatic, Dynamic and Kinematic physics body. Collider2DCollision shape, triggers and layer filters. Joint2DFixed, Revolute, Prismatic, Rope and Spring joints. CharacterControllerCharacter, Platformer, Top-Down, Car, Follow, Patrol and Free movement modes. SpriteAnimationSprite-sheet clips and animation state. CameraReference resolution, scaling, follow, shake and pseudo-3D. AudioSourcePlayback, pitch, volume and spatial attenuation. AudioListenerHearing radius and audio detection. LightSix 2D light modes. ShadowCasterShadow occlusion geometry and softness. LightingSettingsScene-wide ambient and shadow quality settings. NavAgent2DPathfinding, area filters, avoidance and vehicle tuning. NavWorld2DShared painted or baked navigation grid. TilesetReusable 16-role autotile setup. TilemapPainted tile grid linked to a Tileset. ScriptScript name, source and enabled state.

#Complete script-module index

The Script module member index is generated from the engine's supported-member sets. It covers every member exposed by the this.* component modules, plus this.state, this.myTouch, scene.lighting and the global save API. Each entry includes its access type, context and source file.

#Global runtime API

Scripts also receive global functions and objects such as findFirst(), scene, physics, nav, input, mouse, touch, time, random, mathx, save, debug and pool. See Runtime modules and the practical Global API guide.

#Option shapes and requirements

Optional arguments for raycasts, spawning, navigation, camera follow and other script calls are documented in Option schemas (opts). The requirements map identifies component prerequisites and always-available APIs.

#Machine-readable catalog

For code tools and AI assistants, fetch api/index.json. It contains component field/default metadata, lifecycle callbacks, enum values, global API groups, all 24 script API modules and their supported member lists. The full manual is available from llms-full.txt; the search index is search-index.json.