Class CameraObject

A GameObject with a 2D position.

Hierarchy

Object2D
- CameraObject

Index

Constructors

constructor

new CameraObject(name: string, camera: Camera, pos?: Vector2, children?: GameObject[]): CameraObject
Parameters
- name: string
- camera: Camera
- Optional pos: Vector2
- Optional children: GameObject[]
Returns CameraObject
Overrides Object2D.constructor
- Defined in lib/game/CameraObject.ts:9

Properties

`Private` #children

#children: GameObject[] = []

`Private` #drawHandlers

#drawHandlers: Set<((delta: number) => void)> = ...

`Private` #inSceneTree

#inSceneTree: boolean = false

`Private` #preloadHandlers

#preloadHandlers: Set<(() => void | Promise<void>)> = ...

`Private` #readyHandlers

#readyHandlers: Set<(() => void)> = ...

`Private` #updateHandlers

#updateHandlers: Set<((delta: number) => void)> = ...

camera

camera: Camera

id

id: number

The numerical ID of a GameObject.

name

name: string

The name of a GameObject.

parent

parent: null | GameObject = null

The parent of a GameObject in the scene tree. If the object has no parent or is not in the scene tree, this value is null

pos

pos: Vector2

The 2D world position of the Object2D, relative to its parent.

`Static` cache

cache: Map<number, GameObject> = ...

A map of GameObjects and their ids.

`Static` nextFreeID

nextFreeID: number = 0

The next id available for a GameObject

Accessors

allNodes

get allNodes(): GameObject[]
A list of the GameObject and every descendant of the GameObject

Returns GameObject[]
Inherited from Object2D.allNodes
- Defined in lib/game/GameObject.ts:158

children

get children(): GameObject[]
The direct children of this GameObject in the scene tree.

Returns GameObject[]
Inherited from Object2D.children
- Defined in lib/game/GameObject.ts:169

globalPos

get globalPos(): Vector2
The 2D world position of the Object2D, relative to the origin.

Returns Vector2
Inherited from Object2D.globalPos
- Defined in lib/game/Object2D.ts:15
set globalPos(pos: Vector2): void
Parameters
- pos: Vector2
Returns void
Inherited from Object2D.globalPos
- Defined in lib/game/Object2D.ts:20

inSceneTree

set inSceneTree(value: true): void
Set to true when the GameObject is added.
Parameters
- value: true
Returns void
Inherited from Object2D.inSceneTree
- Defined in lib/game/GameObject.ts:142

Methods

addChild

addChild(child: GameObject): Promise<void>
Adds a child GameObject to this GameObject.
Parameters
- child: GameObject
Returns Promise<void>
Inherited from Object2D.addChild
- Defined in lib/game/GameObject.ts:119

draw

draw(delta: number): void
Calls everything that happens on draw.
Parameters
- delta: number
Returns void
Inherited from Object2D.draw
- Defined in lib/game/GameObject.ts:112

getChildByID

getChildByID<T>(id: number): null | T
Gets a child by its id property.
Type Parameters
- T extends GameObject<T>
Parameters
- id: number
Returns null | T
Inherited from Object2D.getChildByID
- Defined in lib/game/GameObject.ts:132

getChildByIndex

getChildByIndex<T>(idx: number): null | T
Gets a child by its index in the array of children.
Type Parameters
- T extends GameObject<T>
Parameters
- idx: number
Returns null | T
Inherited from Object2D.getChildByIndex
- Defined in lib/game/GameObject.ts:127

getChildByName

getChildByName<T>(name: string): null | T
Gets a child by its name property.
Type Parameters
- T extends GameObject<T>
Parameters
- name: string
Returns null | T
Inherited from Object2D.getChildByName
- Defined in lib/game/GameObject.ts:137

objectDraw

objectDraw(delta: number): void
Built-in functionality of the GameObject called on draw.

When extending GameObject, super.objectDraw(delta) must be called when overriding this.
Parameters
- delta: number
Returns void
Inherited from Object2D.objectDraw
- Defined in lib/game/GameObject.ts:109

objectPreload

objectPreload(): Promise<void>
Built-in functionality of the GameObject called on preload.

When extending GameObject, super.objectPreload() must be called when overriding this.

Returns Promise<void>
Inherited from Object2D.objectPreload
- Defined in lib/game/GameObject.ts:68

objectReady

objectReady(): void
Built-in functionality of the GameObject called on ready.

When extending GameObject, super.objectReady() must be called when overriding this.

Returns void
Inherited from Object2D.objectReady
- Defined in lib/game/GameObject.ts:81

objectUpdate

objectUpdate(delta: number): void
Built-in functionality of the GameObject called on update.

When extending GameObject, super.objectUpdate(delta) must be called when overriding this.
Parameters
- delta: number
Returns void
Overrides Object2D.objectUpdate
- Defined in lib/game/CameraObject.ts:14

onDraw

onDraw(f: ((delta: number) => void)): CameraObject
Adds a function to be called on draw.
Parameters
- f: ((delta: number) => void)
  - - (delta: number): void
    - Parameters
      
      delta: number
      
      Returns void
Returns CameraObject
Inherited from Object2D.onDraw
- Defined in lib/game/GameObject.ts:54

onPreload

onPreload(f: (() => void | Promise<void>)): CameraObject
Adds a function to be called on preload. If the object is added to the scene after the game loads, it will be called right before the object is added.
Parameters
- f: (() => void | Promise<void>)
  - - (): void | Promise<void>
    - Returns void | Promise<void>
Returns CameraObject
Inherited from Object2D.onPreload
- Defined in lib/game/GameObject.ts:36

onReady

onReady(f: (() => void)): CameraObject
Adds a function to be called on ready. If the object is added to the scene after the game loads, it will be called right after the object is added.
Parameters
- f: (() => void)
  - - (): void
    - Returns void
Returns CameraObject
Inherited from Object2D.onReady
- Defined in lib/game/GameObject.ts:42

onUpdate

onUpdate(f: ((delta: number) => void)): CameraObject
Adds a function to be called on update.
Parameters
- f: ((delta: number) => void)
  - - (delta: number): void
    - Parameters
      
      delta: number
      
      Returns void
Returns CameraObject
Inherited from Object2D.onUpdate
- Defined in lib/game/GameObject.ts:48

preload

preload(): Promise<void>
Calls everything that happens on preload.

Returns Promise<void>
Inherited from Object2D.preload
- Defined in lib/game/GameObject.ts:71

ready

ready(): void
Calls everything that happens on ready.

Returns void
Inherited from Object2D.ready
- Defined in lib/game/GameObject.ts:86

remove

remove(): void
Removes the GameObject from the scene tree. The GameObject must have a parent.

Returns void
Inherited from Object2D.remove
- Defined in lib/game/GameObject.ts:152

removeChild

removeChild(id: number): void
Removes a child from the scene tree.
Parameters
- id: number
Returns void
Inherited from Object2D.removeChild
- Defined in lib/game/GameObject.ts:147

update

update(delta: number): void
Calls everything that happens on update.
Parameters
- delta: number
Returns void
Inherited from Object2D.update
- Defined in lib/game/GameObject.ts:99

`Static` getGameObjectByID

getGameObjectByID<T>(id: number): null | T
Gets a GameObject from GameObject.cache by its id. Returns null if the object is not found.
Type Parameters
- T extends GameObject<T>
Parameters
- id: number
Returns null | T
Inherited from Object2D.getGameObjectByID
- Defined in lib/game/GameObject.ts:60

Class CameraObject

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

name: string

camera: Camera

Optional pos: Vector2

Optional children: GameObject[]

Returns CameraObject

Properties

Private #children

Private #drawHandlers

Private #inSceneTree

Private #preloadHandlers

Private #readyHandlers

Private #updateHandlers

camera

id

name

parent

pos

Static cache

Static nextFreeID

Accessors

allNodes

Returns GameObject[]

children

Returns GameObject[]

globalPos

Returns Vector2

Parameters

pos: Vector2

Returns void

inSceneTree

Parameters

value: true

Returns void

Methods

addChild

Parameters

child: GameObject

Returns Promise<void>

draw

Parameters

delta: number

Returns void

getChildByID

Type Parameters

T extends GameObject<T>

Parameters

id: number

Returns null | T

getChildByIndex

Type Parameters

T extends GameObject<T>

Parameters

idx: number

Returns null | T

getChildByName

Type Parameters

T extends GameObject<T>

Parameters

name: string

Returns null | T

objectDraw

Parameters

delta: number

Returns void

objectPreload

Returns Promise<void>

objectReady

Returns void

objectUpdate

Parameters

`Optional` pos: Vector2

`Optional` children: GameObject[]

`Private` #children

`Private` #drawHandlers

`Private` #inSceneTree

`Private` #preloadHandlers

`Private` #readyHandlers

`Private` #updateHandlers

`Static` cache

`Static` nextFreeID

`Static` getGameObjectByID