SpriteController

Description

Controller for a sprite object.

Remarks

Inherited from Controller

Properties

---

Name	Type	Description
active	ValueChannel	value 1 means object is enabled, 0 means object is disabled
translationX	ValueChannel	The sprite's position
translationY	ValueChannel	The sprite's position
translationZ	ValueChannel	The sprite's position
rotationX	ValueChannel	The sprite's rotation
rotationY	ValueChannel	The sprite's rotation
rotationZ	ValueChannel	The sprite's rotation
scaleX	ValueChannel	The sprite's scaling
scaleY	ValueChannel	The sprite's scaling
scaleZ	ValueChannel	The sprite's scaling
colorR	ValueChannel	The sprite's color
colorG	ValueChannel	The sprite's color
colorB	ValueChannel	The sprite's color
colorA	ValueChannel	The sprite's color
colorH	ValueChannel	Hue shift modification of the color
colorS	ValueChannel	Saturation modification of the color
colorV	ValueChannel	Brightness modification of the color
layer	StringChannel	The sprite's sorting layer name
sort	ValueChannel	The sprite's sorting order within a layer
alpha	ValueChannel	The sprite's alpha
textureOffsetX	ValueChannel	The sprite's texture offset
textureOffsetY	ValueChannel	The sprite's texture offset
textureScaleX	ValueChannel	The sprite's texture scaling
textureScaleY	ValueChannel	The sprite's texture scaling

Methods

---

copy()

Description

Create a copy of this controller, along with all of its chilren.

Parameters

_

Return types

SpriteController

Remarks

A copied controller will never be persistent.

Example

local sprite = Scene.createSprite("test.png")
local copy = sprite.copy()

---

getChildren()

Description

Return all controllers parented to this controller.

Parameters

_

Return types

Table of Controller

Remarks

_

Example

local children = sprite.getChildren()

---

setParent(controller)

Description

Set the parent to another controller.

Parameters

Name	Type	Description
controller	Controller	The controller to parent to

Return types

nil

Remarks

_

Example

local sprite = Scene.createSprite("test.png")
sprite.setParent(Scene.worldCanvas)