Class Zone

Hierarchy

Zone

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Zone(__namedParameters: { description: string; index: number; name: string }): Zone

- Defined in zones/zone.ts:64
Class constructor.

Parameters
- __namedParameters: { description: string; index: number; name: string }
  - description: string
  - index: number
  - name: string
Returns Zone

Properties

Private _currentTime

_currentTime: number = 0

Private _description

_description: string

Private _id

_id: string

Private _index

_index: number

Private _name

_name: string

Private _scene

_scene: Scene

Private _state

_state: ZoneState = ZoneState.UNINITIALIZED

Accessors

description

get description(): string

- Defined in zones/zone.ts:46
Gets this zone's description.

Returns string
string

id

get id(): string

- Defined in zones/zone.ts:25
Gets this zone's ID.

Returns string
string

index

get index(): number

- Defined in zones/zone.ts:32
Gets this zone's index.

Returns number
number

name

get name(): string

- Defined in zones/zone.ts:39
Gets this zone's name.

Returns string
string

scene

get scene(): Scene

- Defined in zones/zone.ts:53
Gets this zone's scene.

Returns Scene
Scene

Methods

initialize

initialize(zoneData: any): void

- Defined in zones/zone.ts:76
Initializes the zone with JSON data.

Parameters
- zoneData: any
Returns void
void

load

load(): void

- Defined in zones/zone.ts:88
Loads the scene and all it's entities.

Returns void
void

Private loadEntity

loadEntity(dataSection: any, parent?: Entity): void

- Defined in zones/zone.ts:147
Loads an entity into the scene.

Parameters
- dataSection: any
- Optional parent: Entity
Returns void
void

onActivated

onActivated(): void

- Defined in zones/zone.ts:128
Called when the scene is activated.

Returns void
void

onDeactivated

onDeactivated(): void

- Defined in zones/zone.ts:135
Called when the scene is deactivated.

Returns void
void

render

render(shader: Shader): void

- Defined in zones/zone.ts:119
Calls render on the scene.

Parameters
- shader: Shader
Returns void
void

unload

unload(): void

- Defined in zones/zone.ts:99
Unloads the scene.

Returns void
void

update

update(delta: number): void

- Defined in zones/zone.ts:109
Calls update on the scene.

Parameters
- delta: number
Returns void
void

Generated using TypeDoc