Built-in Components

Component that stores position and rotation for an entity

Creates a new Transform at the given position with zero rotation

Gets the position as a Vec2

Sets the position

Gets the rotation in radians

Sets the rotation in radians

Component that provides size and velocity for physics-based movement

Creates a new Body with the given size and velocity

Gets the size of the body

Gets the velocity as a Vec2

Sets the size of the body

Sets the velocity

Updates the position based on velocity and delta time

Base class for all renderable components with layer-based sorting

Creates a new Renderable with default layer 0

Override this method in subclasses to implement rendering

Comparison operator for sorting by layer

Gets the rendering layer (higher values render on top)

Sets the rendering layer

Renders all Renderable components in all entities

Renders a sprite from an image or texture atlas

Creates a sprite from a full image (path or image ID)

Creates a sprite from a section of an image using normalized texture coordinates

Creates a sprite from a spritesheet file (.xssprite) by sprite name

The spritesheet file contains Json with an "image" path and "sprites" definitions

Each sprite has x, y, width, and height in pixels

Initializes by caching reference to Transform component

Renders the sprite at the Transform's position and rotation

Gets the additive color (0xRRGGBBAA format)

Sets the additive color

Gets the multiply color (0xRRGGBBAA format)

Sets the multiply color

Gets the sprite flags (flipping, centering, etc.)

Sets the sprite flags

Gets the sprite scale

Sets the sprite scale

Sets the sprite ID

Gets the sprite ID

Renders a shape (SVG or custom mesh)

Creates a Shape component with the given shape ID

Renders the shape at the Transform's position and rotation

Gets the additive color (0xRRGGBBAA format)

Sets the additive color

Gets the multiply color (0xRRGGBBAA format)

Sets the multiply color

Gets the shape flags

Sets the shape flags

Gets the shape scale

Sets the shape scale

Sets the shape ID

Gets the shape ID

Renders text using a loaded font

Creates a Label with the given font (path or font ID), text content, and size

Renders the text at the Transform's position

Gets the text content

Sets the text content

Sprite that can display frames from a sprite sheet grid

Creates a GridSprite from an image divided into columns and rows

Sets the current frame index

Gets the current frame index

Gets the sprite ID at the given frame index

Sprite with animation support for playing frame sequences from a sprite sheet

Use addAnimation() to define named animations, then playAnimation() to start them

Call update(dt) each frame to advance the animation

Creates an AnimatedSprite with the given frame rate (frames per second)

fps determines how fast animations play - higher values = faster animations

Creates an AnimatedSprite from an animation sheet file (.xsanim)

The file contains image path, columns, rows, fps, and animation definitions

Updates the animation frame based on delta time

Adds a named animation with a list of frame indices

Frame indices correspond to positions in the sprite sheet (0-indexed, left to right, top to bottom)

Example: addAnimation("walk", [0, 1, 2, 3])

Plays the animation with the given name, restarting from the first frame

Does nothing if the animation name doesn't exist

Randomizes the current frame within the current animation

Gets the animation mode

Sets the animation mode (once, loop, or destroy)

Checks if animation has finished (for non-looping animations)

Play animation once and stop on the last frame

Loop animation continuously (default behavior)

Delete the owning entity when animation completes (useful for effects)

Makes an entity follow its parent's position with an offset

Creates a Relation that follows the given parent entity

Updates position to follow parent (with rotation support)

Gets the offset from parent position

Sets the offset from parent position

Gets the parent entity

Deletes this entity when its parent is deleted

Creates an Ownership component tied to the given parent entity

Checks if parent is deleted and deletes this entity if so

Gets the parent entity