Interface RuntimeEntity

Small Interface to support: runtime.Entity. factory methods

interface RuntimeEntity {
    createRuntimeFactory(type: string): void;
    loadDefinitions(jsonDef: string): void;
    wrap(entityId: number): Entity;
}

Index

Methods

createRuntimeFactory loadDefinitions wrap

Methods

createRuntimeFactory

createRuntimeFactory(type: string): void
Add runtime support for creating/wrapping entity of given type.
Parameters
- type: string
  Entity type, e.g. "Cube", "Group" etc.
Returns void
- Defined in dist/cogs.esm.d.ts:3315

loadDefinitions

loadDefinitions(jsonDef: string): void
Load definitions of new Entities Stored in asset scene format. "templates".
Parameters
- jsonDef: string
  Entity definition(s).
Returns void
- Defined in dist/cogs.esm.d.ts:3308

wrap

wrap(entityId: number): Entity
Returns entity filled in with components defined using runtime reflection. Entity ids normally not used by applications.
Parameters
- entityId: number
  ID to wrap.
Returns Entity
Wrapped entity if valid ID
- Defined in dist/cogs.esm.d.ts:3300