@relu-interactives/spatial-ecs

---

@relu-interactives/spatial-ecs / components / SpriteComponent

Class: SpriteComponent

Defined in: components/Sprite.ts:11

Camera-facing 2D sprite. Unlike ImageComponent, sprites use THREE.Sprite and always render as billboards.

Extends

• Component

Constructors

Constructor

new SpriteComponent(
   path, 
   width?, 
   height?): SpriteComponent;

Defined in: components/Sprite.ts:23

Parameters

Parameter	Type	Default value
path	string	undefined
width	number	1
height	number	1

Returns

SpriteComponent

Overrides

Component.constructor

Properties

Property	Type	Description	Defined in
path	string	Source URL or localasset:// path of the sprite image.	components/Sprite.ts:13
width	number	Width of the sprite in world units.	components/Sprite.ts:15
height	number	Height of the sprite in world units.	components/Sprite.ts:17
texture	Texture | null	Loaded texture, populated asynchronously. null until loaded.	components/Sprite.ts:19
object	Sprite<Object3DEventMap> | null	Live THREE.Sprite placed in the scene. null until built.	components/Sprite.ts:21