Class DefinitionModifier`Beta`

Contains a set of updates to the component definition state of an entity.

Index

Constructors

Methods

getComponentGroupsToAdd getComponentGroupsToRemove getTriggers setComponentGroupsToAdd setComponentGroupsToRemove setTriggers

Constructors

constructor

new DefinitionModifier(): DefinitionModifier
Beta
Returns DefinitionModifier

Methods

getComponentGroupsToAdd

getComponentGroupsToAdd(): string[]
Beta
Returns string[]
Remarks
Retrieves the list of component groups that will be added via this definition modification.

This function can't be called in read-only mode.

getComponentGroupsToRemove

getComponentGroupsToRemove(): string[]
Beta
Returns string[]
Remarks
Retrieves the list of component groups that will be removed via this definition modification.

This function can't be called in read-only mode.

getTriggers

getTriggers(): Trigger[]
Beta
Returns Trigger[]
Remarks
Retrieves the list of entity definition events that will be fired via this update.

This function can't be called in read-only mode.

setComponentGroupsToAdd

setComponentGroupsToAdd(newGroups: string[]): void
Beta
Parameters
- newGroups: string[]
Returns void
Remarks
Updates the list of component groups that will be added via this definition modification.

This function can't be called in read-only mode.

setComponentGroupsToRemove

setComponentGroupsToRemove(removedGroups: string[]): void
Beta
Parameters
- removedGroups: string[]
Returns void
Remarks
Updates the list of component groups that will be removed via this definition modification.

This function can't be called in read-only mode.

setTriggers

setTriggers(newTriggers: Trigger[]): void
Beta
Parameters
- newTriggers: Trigger[]
Returns void
Remarks
Updates the list of entity definition events that will be fired via this update.

This function can't be called in read-only mode.