Class EntityFactory

Manages the creation of entities for one world.

It glues together:

Loding resources accordning to EntityDefinition instances
Discovers possible state of entitiy configuration
- All components there?
- All required resources are loaded?
- Do we need resources for children?
Instantiates the objects for the world (new Component, new Entity, ...)

Hierarchy

EntityFactory

Index

Constructors

Properties

_linkedDefinitions _linker _nextEntityId _propertyParser _resourceManager _world

Methods

_unifyResourceProperties addDefinitions addPropertyParser parseProperties preloadEntities

Constructors

constructor

new EntityFactory(world: World, _resourceManager: ResourceManager): EntityFactory
Parameters
- world: World
- _resourceManager: ResourceManager
Returns EntityFactory
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/EntityFactory.ts:38

Properties

`Private` _linkedDefinitions

_linkedDefinitions: Record<string, LinkedEntityDefinition> = {}

`Private` `Readonly` _linker

_linker: EntityLinker = ...

`Private` _nextEntityId

_nextEntityId: number = 1

`Private` `Readonly` _propertyParser

_propertyParser: Record<string, PropertyParser> = {}

`Private` `Readonly` _resourceManager

_resourceManager: ResourceManager

`Private` `Readonly` _world

_world: World

Methods

`Private` _unifyResourceProperties

_unifyResourceProperties(req: any): string | string[]
uniforms resource parameter
Parameters
- req: any
Returns string | string[]
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/EntityFactory.ts:317

addDefinitions

addDefinitions(defs: any): void
Parameters
- defs: any
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/EntityFactory.ts:47

addPropertyParser

addPropertyParser(pp: PropertyParser): void
Parameters
- pp: PropertyParser
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/EntityFactory.ts:43

`Private` parseProperties

parseProperties(def: LinkedEntityDefinition, rawProps: any, entityName: any): {}
Here we parse the properties for an entity instance.

[myEntity]

Cmp1

Cmp2
life = 100 mana = 30

class Cmp1 { static requires = { props: { life: ['number', 5], mana: ['number', 5], } } }

class Cmp2 { static requires = { props: { super: ['bool', true] } } }
Parameters
- def: LinkedEntityDefinition
- rawProps: any
- entityName: any
Returns {}
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/EntityFactory.ts:447

preloadEntities

preloadEntities(instances: EntityInstance | EntityInstance[], onReady: ((any: any) => void), depth?: number): void
This function loads all data that is required for the provided entities.
Parameters
- instances: EntityInstance | EntityInstance[]
- onReady: ((any: any) => void)
  - - (any: any): void
    - Parameters
      
      any: any
      
      Returns void
- depth: number = 0
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/EntityFactory.ts:54

Generated using TypeDoc