Class IntervalCreatorComponent

Interval Creator.

Creates a copy of the entity to which the component is attached at regular time intervals.

Hierarchy (View Summary)

CreatorComponent
- IntervalCreatorComponent

Index

Properties

`Readonly`entity

entity: Entity

The entity to which the component is attached.

Accessors

created

get created(): Subscribable<Entity>
Notifies immediately after the creator component has created an entity.

Returns Subscribable<Entity>
Inherited from CreatorComponent.created

delay

get delay(): number
The initial delay before the first entity is created.

Returns number
set delay(value: number): void
Parameters
- value: number
Returns void

deleted

get deleted(): Subscribable<Component>
Notifies when the component is detached from the entity.

Returns Subscribable<Component>
Inherited from CreatorComponent.deleted

display

get display(): CreatorDisplay
The display method.

Returns CreatorDisplay
Remarks
Specifies how the entity with the creator component is displayed.

Inherited from CreatorComponent.display
set display(value: CreatorDisplay): void
Parameters
- value: CreatorDisplay
Returns void
Inherited from CreatorComponent.display

geometry

get geometry(): CreatorCongestionGeometry
The congestion zone geometry.

Returns CreatorCongestionGeometry
Remarks
Entities will not be created whilst the congestion zone is occupied.
set geometry(value: CreatorCongestionGeometry): void
Parameters
- value: CreatorCongestionGeometry
Returns void

initialized

get initialized(): boolean
Whether the component has been initialized.

Returns boolean
Inherited from CreatorComponent.initialized

interval

get interval(): number
The time between which entities are created.

Returns number
set interval(value: number): void
Parameters
- value: number
Returns void

io

get io(): null | IO
The IO signals provided by the component.

Returns null | IO
Inherited from CreatorComponent.io

kinematics

get kinematics(): boolean
Whether entities with kinematic physics bodies should be detected by the congestion zone.

Returns boolean
Remarks
This is typically set to false, in order to avoid detecting conveyors or other static parts.
set kinematics(value: boolean): void
Parameters
- value: boolean
Returns void

layer

get layer(): string
The collision layer for the congestion zone.

Returns string
set layer(value: string): void
Parameters
- value: string
Returns void

name

get name(): string
The component name.

Returns string
Inherited from CreatorComponent.name
set name(value: string): void
Parameters
- value: string
Returns void
Inherited from CreatorComponent.name

world

get world(): World
The virtual world to which the owning entity belongs.

Returns World
Inherited from CreatorComponent.world

Methods

create

create(): null | Entity
Create a copy of the entity to which the component is attached.

Returns null | Entity
The created entity, or null if the operation failed.

Inherited from CreatorComponent.create

createCustom

createCustom(customizer: CreatorCustomizer): null | Entity
Creates a customized copy of the entity to which the component is attached.
Parameters
- customizer: CreatorCustomizer
  The customization function, which is passed the created entity.
Returns null | Entity
The created entity.

Remarks
The customization function is executed before any subscribers are notified that the entity has been created.

Inherited from CreatorComponent.createCustom

handle

handle<T extends ITrackable<any>>(
type: TrackableType<T>,
value?: null | T,
): Handle<T>
Creates a handle (weak reference) to a trackable object.
Type Parameters
- T extends ITrackable<any>
Parameters
- type: TrackableType<T>
  The type of object that is to be referenced.
- value: null | T = null
  The object that is initially referenced by the handle.
Returns Handle<T>
A handle to a trackable object.

Remarks
Handles created through this function are automatically cleared when the component is detached/removed.

Inherited from CreatorComponent.handle

`Protected` `Optional`initializeAsync

initializeAsync(): Promise<void>
Asynchronous initialization function called immediately before simulating when the model is initialized.

Returns Promise<void>
Inherited from CreatorComponent.initializeAsync

`Optional`postUpdate

postUpdate(dt: number): void
Post-update function called after physics has been updated.
Parameters
- dt: number
  The timestep (seconds).
Returns void
Inherited from CreatorComponent.postUpdate

`Protected` `Optional`postUpdateAsync

postUpdateAsync(dt: number): Promise<void>
Asynchronous post-update function called after physics has been updated.
Parameters
- dt: number
  The timestep (seconds).
Returns Promise<void>
Inherited from CreatorComponent.postUpdateAsync

requireAsyncInitialization

requireAsyncInitialization(): Promise<void>
Immediately triggers asynchronous initialization if the component hasn't already been initialized.

Returns Promise<void>
Remarks
This can be used in cases where one component references another in its asynchronous initialize function, but it is required that the referenced component has already been asynchronously initialized.

Inherited from CreatorComponent.requireAsyncInitialization

requireInitialization

requireInitialization(): void
Immediately triggers initialization if the component hasn't already been initialized.

Returns void
Remarks
This can be used in cases where one component references another in its initialize function, but it is required that the referenced component has already been initialized.

Inherited from CreatorComponent.requireInitialization

subscribe<T>(object: Subscribable<T>, subscriber: Subscriber<T>): void
Subscribes to a subscribable object.

Subscriptions created through this function are automatically unsubscribed when the component is detached/removed.
Type Parameters
- T
Parameters
- object: Subscribable<T>
  The subscribable object for which to subscribe.
- subscriber: Subscriber<T>
  The callback function that is triggered when the object's value is updated.
Returns void
Inherited from CreatorComponent.subscribe

unsubscribe

unsubscribe<T>(object: Subscribable<T>, subscriber: Subscriber<T>): boolean
Unsubscribes from a subscribable object.
Type Parameters
- T
Parameters
- object: Subscribable<T>
  The object from which to unsubscribe.
- subscriber: Subscriber<T>
  The callback function for the subscription.
Returns boolean
True if the subscription was canceled, false otherwise.

Inherited from CreatorComponent.unsubscribe

`Protected` `Optional`updateAsync

updateAsync(dt: number): Promise<void>
Asynchronous update function called every timestep when simulating.
Parameters
- dt: number
  The timestep (seconds).
Returns Promise<void>
Inherited from CreatorComponent.updateAsync

Class IntervalCreatorComponent

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

Readonlyentity

Accessors

created

Returns Subscribable<Entity>

delay

Returns number

Parameters

Returns void

deleted

Returns Subscribable<Component>

display

Returns CreatorDisplay

Remarks

Parameters

Returns void

geometry

Returns CreatorCongestionGeometry

Remarks

Parameters

Returns void

initialized

Returns boolean

interval

Returns number

Parameters

Returns void

io

Returns null | IO

kinematics

Returns boolean

Remarks

Parameters

Returns void

layer

Returns string

Parameters

Returns void

name

Returns string

Parameters

Returns void

world

Returns World

Methods

create

Returns null | Entity

createCustom

Parameters

Returns null | Entity

Remarks

handle

Type Parameters

Parameters

Returns Handle<T>

Remarks

Protected OptionalinitializeAsync

Returns Promise<void>

OptionalpostUpdate

Parameters

Returns void

Protected OptionalpostUpdateAsync

Parameters

Returns Promise<void>

requireAsyncInitialization

Returns Promise<void>

Remarks

requireInitialization

Returns void

Remarks

subscribe

Type Parameters

Parameters

Returns void

`Readonly`entity

`Protected` `Optional`initializeAsync

`Optional`postUpdate

`Protected` `Optional`postUpdateAsync

`Protected` `Optional`updateAsync