Interface IPreptimeWorld

Hierarchy

IWorld
- IPreptimeWorld

Implemented by

PreptimeWorld

Properties

config

config: IPreptimeWorldConfig

Configuration of how a runtime should work

data

data: IPreptimeData

Initial data to operate on

`Optional` `Readonly` name

name?: string

World's name

Methods

addEntitiesToGroup

addEntitiesToGroup(groupHandle, entities): void
Add several entities in this world to a group in this world
Parameters
- groupHandle: number
- entities: IterableIterator<IEntity> | readonly Readonly<IEntity>[]
Returns void
Inherited from IWorld.addEntitiesToGroup
- Defined in src/world/world.spec.ts:130

addEntity

addEntity(entity): void
Add an entity to this world
Parameters
- entity: Readonly<IEntity>
Returns void
Inherited from IWorld.addEntity
- Defined in src/world/world.spec.ts:89

addEntityToGroup

addEntityToGroup(groupHandle, entity): void
Add an entity in this world to a group in this world
Parameters
- groupHandle: number
- entity: Readonly<IEntity>
Returns void
Inherited from IWorld.addEntityToGroup
- Defined in src/world/world.spec.ts:123

addResource

addResource<T>(type, ...args): T | TTypeProto<T>
Add a resource to this world and returns the resource instance
Type Parameters
- T extends object
Parameters
- type: T | TTypeProto<T>
- Rest ...args: readonly unknown[]
  
  constructor parameters
Returns T | TTypeProto<T>
Inherited from IWorld.addResource
- Defined in src/world/world.spec.ts:196

assimilateGroup

assimilateGroup(otherWorld, groupHandle): number
Move group from other world to this one. A new handle will be generated!
Parameters
- otherWorld: Readonly<IPreptimeWorld>
- groupHandle: number
Returns number
Inherited from IWorld.assimilateGroup
- Defined in src/world/world.spec.ts:138

buildEntity

buildEntity(uuid?): IEntityBuilder
Convenience builder to create a new Entity
Parameters
- Optional uuid: string
Returns IEntityBuilder
Inherited from IWorld.buildEntity
- Defined in src/world/world.spec.ts:95

clearEntities

clearEntities(): void
Clear all entities and groups from this world

Returns void
Inherited from IWorld.clearEntities
- Defined in src/world/world.spec.ts:100

clearGroups

clearGroups(): void
Disband all groups. Entities will not be removed

Returns void
Inherited from IWorld.clearGroups
- Defined in src/world/world.spec.ts:144

clearResources

clearResources(): void
Remove all resources from this world

Returns void
Inherited from IWorld.clearResources
- Defined in src/world/world.spec.ts:201

createEntity

createEntity(): IEntity
Create a new entity and add it to this world

Returns IEntity
Inherited from IWorld.createEntity
- Defined in src/world/world.spec.ts:105

createGroup

createGroup(): number
Create a new group and add it to this world

Returns number
Inherited from IWorld.createGroup
- Defined in src/world/world.spec.ts:149

getEntities

getEntities(query?): IterableIterator<IEntity>
Query entities and find the ones with a certain combination of component. To get a single entity by ID, please use the global function getEntity()
Parameters
- Optional query: Readonly<IEntitiesQuery>
Returns IterableIterator<IEntity>
Inherited from IWorld.getEntities
- Defined in src/world/world.spec.ts:25

getExistingRuntimeWorlds

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

Returns readonly IRuntimeWorld[]
- Defined in src/world/preptime/preptime-world.spec.ts:48

getGroupEntities

getGroupEntities(groupHandle): IterableIterator<IEntity>
Get all entities associated with a group
Parameters
- groupHandle: number
Returns IterableIterator<IEntity>
Inherited from IWorld.getGroupEntities
- Defined in src/world/world.spec.ts:42

getResource

getResource<T>(type): T
Get a resource which was previously stored
Type Parameters
- T extends object
Parameters
- type: TTypeProto<T>
Returns T
Inherited from IWorld.getResource
- Defined in src/world/world.spec.ts:65

getResources

getResources(types?): IterableIterator<object>
Get all resources stored in this world. Useful for debugging
Parameters
- Optional types: readonly TExistenceQueryParameter<any>[]
Returns IterableIterator<object>
Inherited from IWorld.getResources
- Defined in src/world/world.spec.ts:71

hasEntity

hasEntity(entity): boolean
Check whether an entity exists in this world
Parameters
- entity: Readonly<IEntity>
Returns boolean
Inherited from IWorld.hasEntity
- Defined in src/world/world.spec.ts:31

hasResource

hasResource<T>(type): boolean
Check if a resource was stored
Type Parameters
- T extends object
Parameters
- type: T | TTypeProto<T>
Returns boolean
Inherited from IWorld.hasResource
- Defined in src/world/world.spec.ts:77

load

load(prefab, options?, intoGroup?): number
Load a prefab
Parameters
- prefab: Readonly<ISerialFormat>
- Optional options: Readonly<ISerDeOptions<TDeserializer>>
- Optional intoGroup: number
Returns number
Inherited from IWorld.load
- Defined in src/world/world.spec.ts:180

merge

merge(world, intoGroup?): [number, IEntity[]]
Merge entities from another world into this one
Parameters
- world: Readonly<IRuntimeWorld | IPreptimeWorld>
- Optional intoGroup: number
Returns [number, IEntity[]]
Inherited from IWorld.merge
- Defined in src/world/world.spec.ts:167

prepareRun

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

removeEntity

removeEntity(entity): void
Remove an entity from this world
Parameters
- entity: Readonly<IEntity>
Returns void
Inherited from IWorld.removeEntity
- Defined in src/world/world.spec.ts:111

removeGroup

removeGroup(groupHandle): void
Remove a group and all entities inside from this world
Parameters
- groupHandle: number
Returns void
Inherited from IWorld.removeGroup
- Defined in src/world/world.spec.ts:155

removeResource

removeResource<T>(type): void
Remove a resource from this world
Type Parameters
- T extends object
Parameters
- type: TTypeProto<T>
Returns void
Inherited from IWorld.removeResource
- Defined in src/world/world.spec.ts:207

save

save(options?): ISerialFormat
Prepare a savable version of the current world. The query can be used to only save a sub-set with specific conditions
Parameters
- Optional options: Readonly<ISerDeOptions<TSerializer>>
Returns ISerialFormat
Inherited from IWorld.save
- Defined in src/world/world.spec.ts:54

Generated using TypeDoc