Entity | @kiswa/kilo

An abstract base class for all entities.

Hierarchy

Entity
- Rect
- Container
- Text

Index

Constructors

constructor

Properties

Accessors

hasChildren

Methods

Constructors

constructor

new Entity(): Entity

- Defined in types/entity.ts:32
Initialize an Entity object.

Returns Entity

Properties

alpha

alpha: number

The opacity of the entity (from 0 to 1)

children

children: Partial<Entity>[]

An array of child entities for recursive update/render.

dead

dead: boolean

Whether or not the entity is dead.

pos

pos: Vec

Position of the entity.

scale

scale: Vec

Scale of the entity.

visible

visible: boolean

Whether or not the entity is visible.

Accessors

hasChildren

get hasChildren(): boolean

- Defined in types/entity.ts:30
Whether or not there are any child entities.

Returns boolean

Methods

add

add<T>(child: T): T

- Defined in types/entity.ts:60
Add and return a child object.

Type parameters
- T
Parameters
- child: T
  
  Object to add to the container.
Returns T

map

map(fn: (child: Partial<Entity>, index?: number) => void): any

- Defined in types/entity.ts:82
Map a function across all children.

Parameters
- fn: (child: Partial<Entity>, index?: number) => void
  
  Function to call for each child.
  - - (child: Partial<Entity>, index?: number): void
    - Parameters
      - child: Partial<Entity>
      - Optional index: number
      Returns void
Returns any

remove

remove<T>(child: T): T

- Defined in types/entity.ts:71
Remove and return a child object.

Type parameters
- T
Parameters
- child: T
  
  Object to remove from the container.
Returns T

Abstract update

update(dt: number, t: number): void

- Defined in types/entity.ts:53
Update method to be implemented by classes extending Entity.

Parameters
- dt: number
  
  Delta time since last update.
- t: number
  
  Timestamp in seconds.
Returns void