Component UISprite

UISprite

The UISprite component controls textured UI rendering for interface elements.

---

Properties

isValid

uiSprite.isValid

Returns whether the UISprite component is valid.

Returns

boolean

---

textureIndex

uiSprite.textureIndex

Gets or sets the texture used by the UI sprite.

Type

number

Example

uiSprite.textureIndex = 3

---

Example Usage

local sprite = entity.uiSprite

sprite.textureIndex = 1