Class LightSourceComponent

A core component that emits a directed light.

Hierarchy (view full)

Properties

entity

Accessors

color deleted initialized intensity io name world

Methods

added? handle initialize? initializeAsync? postUpdate? postUpdateAsync? requireAsyncInitialization requireInitialization subscribe unsubscribe update? updateAsync?

Properties

Readonly entity

entity: Entity

The entity to which the component is attached.

Accessors

color

  • get color(): Color

  • The light color.

    Returns Color

  • set color(value): void

  • Parameters

    Returns void

deleted

initialized

  • get initialized(): boolean

  • Whether the component has been initialized.

    Returns boolean

intensity

  • get intensity(): number

  • The light intensity (lux).

    Returns number

  • set intensity(value): void

  • Parameters

    • value: number

    Returns void

io

  • get io(): null | IO

  • The IO signals provided by the component.

    Returns null | IO

name

  • get name(): string

  • The component name.

    Returns string

  • set name(value): void

  • Parameters

    • value: string

    Returns void

world

  • get world(): World

  • The virtual world to which the owning entity belongs.

    Returns World

Methods

Protected Optional added

  • added(): void

  • Added function called immediately after the component is attached to an entity.

    Returns void

Protected handle

  • handle<T>(type, value?): Handle<InstanceType<(new () => never) & T>>

  • Creates a handle (weak reference) to a trackable object.

    Type Parameters

    Parameters

    • type: 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<InstanceType<(new () => never) & T>>

    A handle to a trackable object.

    Remarks

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

    Example: Creating a handle to an entity.

    const handle = this.handle(Entity, this.world.find("Some Entity"));

    Example: Creating a handle to a scripted component of a specific type.

    const handle = this.handle(MyScriptComponent);

Protected Optional initialize

  • initialize(): void

  • Initialization function called immediately before simulating when the model is initialized.

    Returns void

Protected Optional initializeAsync

  • initializeAsync(): Promise<void>

  • Asynchronous initialization function called immediately before simulating when the model is initialized.

    Returns Promise<void>

Protected Optional postUpdate

  • postUpdate(dt): void

  • Post-update function called after physics has been updated.

    Parameters

    • dt: number

      The timestep (seconds).

    Returns void

Protected Optional postUpdateAsync

  • postUpdateAsync(dt): Promise<void>

  • Asynchronous post-update function called after physics has been updated.

    Parameters

    • dt: number

      The timestep (seconds).

    Returns Promise<void>

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.

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.

Protected subscribe

  • subscribe<T>(object, subscriber): 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

Protected unsubscribe

  • unsubscribe<T>(object, subscriber): 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.

Protected Optional update

  • update(dt): void

  • Update function called every timestep when simulating.

    Parameters

    • dt: number

      The timestep (seconds).

    Returns void

Protected Optional updateAsync

  • updateAsync(dt): Promise<void>

  • Asynchronous update function called every timestep when simulating.

    Parameters

    • dt: number

      The timestep (seconds).

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc