Class ComponentDescription

Hierarchy

ComponentDescription

Index

Constructors

Properties

canSpawnChildren cmpClz cmps linkedRequires linksGlobal linksStatic properties resources

Methods

getLinkedRequirements link registerChild registerComponent registerGlobalLink registerProperty registerResource registerStaticLink

Constructors

constructor

new ComponentDescription(cmpClz: any): ComponentDescription
Parameters
- cmpClz: any
Returns ComponentDescription
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/decorate/ComponentDescription.ts:20

Properties

`Private` canSpawnChildren

canSpawnChildren: Map<string, string> = ...

`Private` cmpClz

cmpClz: any

`Private` cmps

cmps: Map<string, [string, boolean]> = ...

`Private` linkedRequires

linkedRequires: false | ComponentRequirements

`Private` linksGlobal

linksGlobal: Set<string> = ...

`Private` linksStatic

linksStatic: Map<string, [string, string]> = ...

`Private` properties

properties: Map<string, ComponentProperty> = ...

`Private` resources

resources: Map<string, string> = ...

Methods

getLinkedRequirements

getLinkedRequirements(): false | ComponentRequirements
Returns false | ComponentRequirements
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/decorate/ComponentDescription.ts:278

`Private` link

link(): false | ComponentRequirements
Returns false | ComponentRequirements
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/decorate/ComponentDescription.ts:55

registerChild

registerChild(propertyName: string, child: string): void
Parameters
- propertyName: string
- child: string
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/decorate/ComponentDescription.ts:43

registerComponent

registerComponent(propertyName: string, otherComponent: string, optional: boolean): void
Parameters
- propertyName: string
- otherComponent: string
- optional: boolean
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/decorate/ComponentDescription.ts:39

registerGlobalLink

registerGlobalLink(propertyName: string): void
Parameters
- propertyName: string
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/decorate/ComponentDescription.ts:51

registerProperty

registerProperty(propertyName: string, propertyType: string, propertyInfo?: any, defaultValue?: any): void
Parameters
- propertyName: string
- propertyType: string
- Optional propertyInfo: any
- Optional defaultValue: any
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/decorate/ComponentDescription.ts:25

registerResource

registerResource(propertyName: string, loaderId: string): void
Parameters
- propertyName: string
- loaderId: string
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/decorate/ComponentDescription.ts:35

registerStaticLink

registerStaticLink(propertyName: string, componentName: string, world: string): void
Parameters
- propertyName: string
- componentName: string
- world: string
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/decorate/ComponentDescription.ts:47

Generated using TypeDoc