Skip to content

Sprite

Component.addSprite

Component.addSprite(entity, path, offsetX?, offsetY?, scaleX?, scaleY?) -> bool

Ensures a Position (with rotation) and loads the texture via AssetManager. Logs on failure.

Component.setSpriteRect

Component.setSpriteRect(entity, x, y, width, height) -> bool

Component.getSprite

Component.getSprite(entity) -> "sprite" | nil

Returns the literal string "sprite" if a sprite exists, else nil.

Component.getSpriteInfo

Component.getSpriteInfo(entity) -> {path, offsetX, offsetY, scaleX, scaleY, flipX, flipY} | nil

Component.getSpriteFlip

Component.getSpriteFlip(entity) -> {flipX, flipY} | nil

Component.setSpriteFlip

Component.setSpriteFlip(entity, flipX, flipY?) -> bool

If flipY is omitted, only flipX changes.

Component.getSpriteScale

Component.getSpriteScale(entity) -> {x, y} | nil

Component.getSpriteOffset

Component.getSpriteOffset(entity) -> {x, y} | nil

Component.getSpritePath

Component.getSpritePath(entity) -> string | nil

Component.setSpriteScale

Component.setSpriteScale(entity, scaleX, scaleY) -> bool

Component.setSpriteOffset

Component.setSpriteOffset(entity, offsetX, offsetY) -> bool

Component.setSpritePath

Component.setSpritePath(entity, path) -> bool

Component.findEntityByName

Component.findEntityByName(name) -> Entity | nil