_{Official ZPE/YASS documentation}GraphicsSprite

Represents a mutable sprite created by Graphics::create_sprite() or Graphics::Sprite::create(). The object is passed to drawing and collision functions and its public properties can be changed between frames.

Availability: The GraphicsSprite object is available as new Graphics::GraphicsSprite() and is also returned by the Graphics sprite creation functions.

Properties

The object exposes the following public properties:

• source — image or sprite-sheet source.
• x and y — sprite centre position.
• width and height — displayed dimensions.
• frame — current sprite-sheet frame.
• columns and rows — sprite-sheet dimensions.
• visible — whether drawing should render the sprite.
• colour — sprite colour metadata.

Example

$sprite = new Graphics::GraphicsSprite()
$sprite->source = "player.png"
$sprite->visible = true
Graphics::draw_sprite($window, $sprite)