Class EntityTypeFamilyComponent

Hierarchy (View Summary)

EntityComponent
- EntityTypeFamilyComponent

Index

Constructors

Properties

entity isValid typeId

Methods

getTypeFamilies hasTypeFamily

Constructors

`Private`constructor

new EntityTypeFamilyComponent(): EntityTypeFamilyComponent
Returns EntityTypeFamilyComponent
Overrides EntityComponent.constructor

Properties

`Readonly`entity

entity: Entity

Throws

This property can throw errors.

InvalidEntityError

World Ready

This property can't be read in early-execution mode.

`Readonly`isValid

isValid: boolean

`Readonly`typeId

typeId: string

Methods

getTypeFamilies

getTypeFamilies(): string[]
Returns string[]
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

hasTypeFamily

hasTypeFamily(typeFamily: string): boolean
Parameters
- typeFamily: string
Returns boolean
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.