Entity

The base Entity class provides a wrapper around a PIXI.Container or other PIXI.DisplayObject. It implements a scene graph structure by allowing attachments (child entities) and providing common transformation methods like position, scale, rotation, and alpha.

Entity

Properties

Property	Type	Default	Description
node	PIXI.Container \| PIXI.DisplayObject	PIXI.Container	The underlying PIXI display object.
attachments	Entity[]	[]	Array of child entities attached to this entity.
parent	Entity \| null	null	The parent entity that this entity is attached to.
isVisible	boolean	true	Whether the entity is marked as visible.
shouldCull	boolean	false	Whether to cull (hide) the entity when outside the camera viewport.

Methods

isInViewport()

function isInViewport(): boolean

Returns whether the entity's bounding box intersects with the current camera viewport.

update()

function update(dt: number, user: object): void

Updates the entity. Applies view culling if shouldCull is true, and calls update on all attachments.

Getters and Setters

getNode()

function getNode(): PIXI.Container | PIXI.DisplayObject

Returns the underlying PIXI node.

setNode()

function setNode(node: PIXI.Container | PIXI.DisplayObject): void

Sets the underlying PIXI node.

getParent()

function getParent(): Entity | null

Returns the parent entity.

setParent()

function setParent(parent: Entity | null): void

Sets the parent entity.

getAttachments()

function getAttachments(): Entity[]

Returns the array of attached child entities.

addAttachment()

function addAttachment(attachment: Entity, zIndex?: number): void

Adds a child entity and its PIXI node. Optionally sets a zHack property for z-index sorting.

removeAttachment()

function removeAttachment(attachment: Entity): void

Removes a child entity and its PIXI node.

getRotation()

function getRotation(): number

Returns the rotation of the entity in degrees.

setRotation()

function setRotation(degrees: number): void

Sets the rotation of the entity in degrees.

getAlpha()

function getAlpha(): number

Returns the alpha transparency of the entity.

setAlpha()

function setAlpha(alpha: number): void

Sets the alpha transparency of the entity.

getScale()

function getScale(): PIXI.ObservablePoint

Returns the scale of the entity.

setScale()

function setScale(scale: number): void

Sets the x and y scale of the entity uniformly.

getScaleX()

function getScaleX(): number

Gets the x-axis scale of the entity.

setScaleX()

function setScaleX(scale: number): void

Sets the x-axis scale of the entity.

getScaleY()

function getScaleY(): number

Gets the y-axis scale of the entity.

setScaleY()

function setScaleY(scale: number): void

Sets the y-axis scale of the entity.

getFilters()

function getFilters(): PIXI.Filter[] | null

Gets the PIXI filters applied to the entity.

setFilters()

function setFilters(filters: PIXI.Filter[] | null): void

Sets the PIXI filters applied to the entity.

getPosition()

function getPosition(): PIXI.Point | PIXI.ObservablePoint

Returns the position of the entity.

setPosition()

function setPosition(x: number, y: number): void

Sets the position of the entity.

getPositionX()

function getPositionX(): number

Gets the x-axis position of the entity.

setPositionX()

function setPositionX(x: number): void

Sets the x-axis position of the entity.

getPositionY()

function getPositionY(): number

Gets the y-axis position of the entity.

setPositionY()

function setPositionY(y: number): void

Sets the y-axis position of the entity.

getPivotPoint()

function getPivotPoint(): PIXI.Point | PIXI.ObservablePoint

Gets the pivot point of the entity.

setPivotPoint()

function setPivotPoint(x: number, y: number): void

Sets the pivot point of the entity.

getVisible()

function getVisible(): boolean

Gets whether the entity is visible.

setVisible()

function setVisible(visible: boolean): void

Sets whether the entity is visible. Updates the underlying PIXI node's visibility.

getShouldCull()

function getShouldCull(): boolean

Gets whether the entity should be culled based on the viewport.

setShouldCull()

function setShouldCull(shouldCull: boolean): void

Sets whether the entity should be culled based on the viewport.