Class PreptimeWorld

Hierarchy

PreptimeWorld

Implements

IPreptimeWorld

Constructors

constructor

new PreptimeWorld(name?, $config?, $data?): PreptimeWorld
Parameters
- Optional name: string
- Optional $config: Partial<IPreptimeWorldConfig>
- Optional $data: Partial<IPreptimeData>
Returns PreptimeWorld
- Defined in src/world/preptime/preptime-world.ts:42

Properties

addEntitiesToGroup

addEntitiesToGroup: ((this, groupHandle, entities) => void) = addEntitiesToGroup

Type declaration

- (this, groupHandle, entities): void
- Parameters
  - this: PreptimeWorld | RuntimeWorld
  - groupHandle: number
  - entities: IterableIterator<Readonly<IEntity>> | readonly Readonly<IEntity>[]
  Returns void

addEntity

addEntity: ((this, entity) => void) = addEntity

Type declaration

- (this, entity): void
- Parameters
  - this: PreptimeWorld
  - entity: Readonly<IEntity>
  Returns void

addEntityToGroup

addEntityToGroup: ((this, groupHandle, entity) => void) = addEntityToGroup

Type declaration

- (this, groupHandle, entity): void
- Parameters
  - this: PreptimeWorld | RuntimeWorld
  - groupHandle: number
  - entity: Readonly<IEntity>
  Returns void

addResource

addResource: (<T>(this, Type, ...args) => T | TTypeProto<T>) = addResource

Type declaration

- <T>(this, Type, ...args): T | TTypeProto<T>
- Type Parameters
  - T extends object
  Parameters
  - this: PreptimeWorld
  - Type: T | TTypeProto<T>
  - Rest ...args: readonly unknown[]
  Returns T | TTypeProto<T>

assimilateGroup

assimilateGroup: ((this, otherWorld, handle) => TGroupHandle) = assimilateGroup

Type declaration

- (this, otherWorld, handle): TGroupHandle
- Parameters
  - this: PreptimeWorld | RuntimeWorld
  - otherWorld: Readonly<IPreptimeWorld>
  - handle: number
  Returns TGroupHandle

buildEntity

buildEntity: ((this, uuid?) => IEntityBuilder) = buildEntity

Type declaration

- (this, uuid?): IEntityBuilder
- Parameters
  - this: IMutableWorld
  - Optional uuid: string
  Returns IEntityBuilder

clearEntities

clearEntities: ((this) => void) = clearEntities

Type declaration

- (this): void
- Parameters
  - this: Object
  Returns void

clearGroups

clearGroups: ((this) => void) = clearGroups

Type declaration

- (this): void
- Parameters
  - this: PreptimeWorld | RuntimeWorld
  Returns void

clearResources

clearResources: ((this) => void) = clearResources

Type declaration

- (this): void
- Parameters
  - this: PreptimeWorld | RuntimeWorld
  Returns void

config

config: IPreptimeWorldConfig

Configuration of how a runtime should work

createEntity

createEntity: ((this) => IEntity) = createEntity

Type declaration

- (this): IEntity
- Parameters
  - this: IMutableWorld
  Returns IEntity

createGroup

createGroup: ((this) => TGroupHandle) = createGroup

Type declaration

- (this): TGroupHandle
- Parameters
  - this: PreptimeWorld | RuntimeWorld
  Returns TGroupHandle

data

data: IPreptimeData

Initial data to operate on

getEntities

getEntities: ((this, query?) => IterableIterator<IEntity>) = getEntities

Type declaration

- (this, query?): IterableIterator<IEntity>
- Parameters
  - this: PreptimeWorld | RuntimeWorld
  - Optional query: Readonly<IEntitiesQuery>
  Returns IterableIterator<IEntity>

getGroupEntities

getGroupEntities: ((this, groupHandle) => IterableIterator<IEntity>) = getGroupEntities

Type declaration

- (this, groupHandle): IterableIterator<IEntity>
- Parameters
  - this: PreptimeWorld | RuntimeWorld
  - groupHandle: number
  Returns IterableIterator<IEntity>

getResource

getResource: (<T>(this, type) => T) = getResource

Type declaration

- <T>(this, type): T
- Type Parameters
  - T extends object
  Parameters
  - this: RuntimeWorld
  - type: TTypeProto<T>
  Returns T

getResources

getResources: ((this, types?) => IterableIterator<object>) = getResources

Type declaration

- (this, types?): IterableIterator<object>
- Parameters
  - this: PreptimeWorld | RuntimeWorld
  - Optional types: readonly TExistenceQueryParameter<any>[]
  Returns IterableIterator<object>

hasEntity

hasEntity: ((this, entity) => boolean) = hasEntity

Type declaration

- (this, entity): boolean
- Parameters
  - this: PreptimeWorld
  - entity: Readonly<IEntity>
  Returns boolean

hasResource

hasResource: (<T>(this, obj) => boolean) = hasResource

Type declaration

- <T>(this, obj): boolean
- Type Parameters
  - T extends object
  Parameters
  - this: PreptimeWorld | RuntimeWorld
  - obj: Readonly<T> | TTypeProto<T>
  Returns boolean

load

load: ((this, prefab, options?, intoGroup?) => TGroupHandle) = load

Type declaration

- (this, prefab, options?, intoGroup?): TGroupHandle
- Parameters
  - this: PreptimeWorld
  - prefab: Readonly<ISerialFormat>
  - Optional options: Readonly<ISerDeOptions<TDeserializer>>
  - Optional intoGroup: number
  Returns TGroupHandle

merge

merge: ((this, elsewhere, intoGroup?) => [TGroupHandle, IEntity[]]) = merge

Type declaration

- (this, elsewhere, intoGroup?): [TGroupHandle, IEntity[]]
- Parameters
  - this: Object
  - elsewhere: Readonly<IPreptimeWorld>
  - Optional intoGroup: number
  Returns [TGroupHandle, IEntity[]]

`Optional` name

name?: string

World's name

removeEntity

removeEntity: ((this, entity) => void) = removeEntity

Type declaration

- (this, entity): void
- Parameters
  - this: PreptimeWorld
  - entity: Readonly<IEntity>
  Returns void

removeGroup

removeGroup: ((this, groupHandle) => void) = removeGroup

Type declaration

- (this, groupHandle): void
- Parameters
  - this: Object
  - groupHandle: number
  Returns void

removeResource

removeResource: (<T>(this, type) => void) = removeResource

Type declaration

- <T>(this, type): void
- Type Parameters
  - T extends object
  Parameters
  - this: PreptimeWorld
  - type: TTypeProto<T>
  Returns void

save

save: ((this, options?) => ISerialFormat) = save

Type declaration

- (this, options?): ISerialFormat
- Parameters
  - this: PreptimeWorld
  - Optional options: Readonly<ISerDeOptions<TSerializer>>
  Returns ISerialFormat

Methods

getExistingRuntimeWorlds

getExistingRuntimeWorlds(): readonly IRuntimeWorld[]
Get a list of RuntimeWorlds which was generated from this PreptimeWorld

Returns readonly IRuntimeWorld[]
Implementation of IPreptimeWorld.getExistingRuntimeWorlds
- Defined in src/world/preptime/preptime-world.ts:75

prepareRun

prepareRun(options?): Promise<IRuntimeWorld>
Prepare a runtime environment from this world
Parameters
- Optional options: Readonly<Partial<IPreptimeOptions>>
Returns Promise<IRuntimeWorld>
Implementation of IPreptimeWorld.prepareRun
- Defined in src/world/preptime/preptime-world.ts:81

Class PreptimeWorld

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional name: string

Optional $config: Partial<IPreptimeWorldConfig>

Optional $data: Partial<IPreptimeData>

Returns PreptimeWorld

Properties

addEntitiesToGroup

Type declaration

Parameters

this: PreptimeWorld | RuntimeWorld

groupHandle: number

entities: IterableIterator<Readonly<IEntity>> | readonly Readonly<IEntity>[]

Returns void

addEntity

Type declaration

Parameters

this: PreptimeWorld

entity: Readonly<IEntity>

Returns void

addEntityToGroup

Type declaration

Parameters

this: PreptimeWorld | RuntimeWorld

groupHandle: number

entity: Readonly<IEntity>

Returns void

addResource

Type declaration

Type Parameters

T extends object

Parameters

this: PreptimeWorld

Type: T | TTypeProto<T>

Rest ...args: readonly unknown[]

Returns T | TTypeProto<T>

assimilateGroup

Type declaration

Parameters

this: PreptimeWorld | RuntimeWorld

otherWorld: Readonly<IPreptimeWorld>

handle: number

Returns TGroupHandle

buildEntity

Type declaration

Parameters

this: IMutableWorld

Optional uuid: string

Returns IEntityBuilder

clearEntities

Type declaration

Parameters

this: Object

Returns void

clearGroups

Type declaration

Parameters

this: PreptimeWorld | RuntimeWorld

Returns void

clearResources

Type declaration

Parameters

this: PreptimeWorld | RuntimeWorld

Returns void

config

createEntity

Type declaration

Parameters

this: IMutableWorld

Returns IEntity

createGroup

Type declaration

`Optional` name: string

`Optional` $config: Partial<IPreptimeWorldConfig>

`Optional` $data: Partial<IPreptimeData>

`Rest` ...args: readonly unknown[]

`Optional` uuid: string

`Optional` query: Readonly<IEntitiesQuery>

`Optional` types: readonly TExistenceQueryParameter<any>[]

`Optional` options: Readonly<ISerDeOptions<TDeserializer>>

`Optional` intoGroup: number

`Optional` intoGroup: number

`Optional` name