import {EntityManager} from 'shapez.io/js/game/entity_manager.js'

public class | source

EntityManager

Extends:

BasicSerializableObject → EntityManager

Static Method Summary

Static Public Methods
public static	getId(): string
public static	getSchema(): {"nextUid": *}

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	componentToEntity: Object<string, Array<Entity>>
public	destroyList: Array<Entity>
public	entities: Array<Entity>
public	nextUid: number
public	root: GameRoot

Method Summary

Public Methods
public	attachDynamicComponent(entity: Entity, component: Component) Call to attach a new component after the creation of the entity
public	destroyEntity(entity: Entity) Queues an entity for destruction
public	findByUid(uid: number, errorWhenNotFound: boolean=): Entity Finds an entity buy its uid, kinda slow since it loops over all entities
public	generateUid(): number Generates a new uid
public	getAllWithComponent(componentHandle: typeof Component): Array<Entity> Returns all entities having the given component
public	getFrozenUidSearchMap(): Map<number, Entity> Returns a map which gives a mapping from UID to Entity.
public	getStatsText(): *
public	processDestroyList()
public	registerEntity(entity: Entity, uid: number=) Registers a new entity
public	removeDynamicComponent(entity: Entity, component: typeof Component) Call to remove a component after the creation of the entity
public	unregisterEntityComponents(entity: Entity) Unregisters all components of an entity from the component to entity mapping
public	update()

Inherited Summary

From class BasicSerializableObject
public static	getCachedSchema(): Schema
public static	getId()
public static	getSchema(): Schema Should return the serialization schema
public static	verify(data: *): string \| void
public	deserialize(data: any, root: import("./savegame_serializer").GameRoot): string \| void
public	serialize(): object

Static Public Methods

public static getId(): string source

Override:

BasicSerializableObject#getId

Return:

string

public static getSchema(): {"nextUid": *} source

Should return the serialization schema

Override:

BasicSerializableObject#getSchema

Return:

{"nextUid": *}

Public Constructors

public constructor() source

Fixes typeof DerivedComponent is not assignable to typeof Component, compiled out in non-dev builds

Override:

BasicSerializableObject#constructor

Public Members

public componentToEntity: Object<string, Array<Entity>> source

public destroyList: Array<Entity> source

public entities: Array<Entity> source

public nextUid: number source

public root: GameRoot source

Public Methods

public attachDynamicComponent(entity: Entity, component: Component) source

Call to attach a new component after the creation of the entity

Params:

Name	Type	Attribute	Description
entity	Entity
component	Component

public destroyEntity(entity: Entity) source

Queues an entity for destruction

Params:

Name	Type	Attribute	Description
entity	Entity

public findByUid(uid: number, errorWhenNotFound: boolean=): Entity source

Finds an entity buy its uid, kinda slow since it loops over all entities

Params:

Name	Type	Attribute	Description
uid	number
errorWhenNotFound	boolean=

Return:

Entity

public generateUid(): number source

Generates a new uid

Return:

number

public getAllWithComponent(componentHandle: typeof Component): Array<Entity> source

Returns all entities having the given component

Params:

Name	Type	Attribute	Description
componentHandle	typeof Component

Return:

Array<Entity>

entities

public getFrozenUidSearchMap(): Map<number, Entity> source

Returns a map which gives a mapping from UID to Entity. This map is not updated.

Return:

Map<number, Entity>

public getStatsText(): * source

Return:

public processDestroyList() source

public registerEntity(entity: Entity, uid: number=) source

Registers a new entity

Params:

Name	Type	Attribute	Description
entity	Entity
uid	number=		Optional predefined uid

public removeDynamicComponent(entity: Entity, component: typeof Component) source

Call to remove a component after the creation of the entity

Params:

Name	Type	Attribute	Description
entity	Entity
component	typeof Component

public unregisterEntityComponents(entity: Entity) source

Unregisters all components of an entity from the component to entity mapping

Params:

Name	Type	Attribute	Description
entity	Entity

EntityManager

Extends:

Static Method Summary

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Static Public Methods

public static getId(): string source

Override:

Return:

public static getSchema(): {"nextUid": *} source

Override:

Return:

Public Constructors

public constructor() source

Override:

Public Members

public componentToEntity: Object<string, Array<Entity>> source

public destroyList: Array<Entity> source

public entities: Array<Entity> source

public nextUid: number source

public root: GameRoot source

Public Methods

public attachDynamicComponent(entity: Entity, component: Component) source

Params:

public destroyEntity(entity: Entity) source

Params:

public findByUid(uid: number, errorWhenNotFound: boolean=): Entity source

Params:

Return:

public generateUid(): number source

Return:

public getAllWithComponent(componentHandle: typeof Component): Array<Entity> source

Params:

Return:

public getFrozenUidSearchMap(): Map<number, Entity> source

Return:

public getStatsText(): * source

Return:

public processDestroyList() source

public registerEntity(entity: Entity, uid: number=) source

Params:

public removeDynamicComponent(entity: Entity, component: typeof Component) source

Params:

public unregisterEntityComponents(entity: Entity) source

Params:

public update() source