Class ComponentSystemRegistry

Store, access and delete instances of the various ComponentSystems.

Hierarchy (View Summary)

Constructors

constructor

Properties

anim animation audiolistener button camera collision element layoutchild layoutgroup light model particlesystem render rigidbody screen script scrollbar scrollview sound sprite

Methods

fire hasEvent off on once

Constructors

constructor

Properties

Readonlyanim

anim: AnimComponentSystem

Gets the AnimComponentSystem from the registry.

Readonlyanimation

animation: AnimationComponentSystem

Gets the AnimationComponentSystem from the registry.

Readonlyaudiolistener

audiolistener: AudioListenerComponentSystem

Gets the AudioListenerComponentSystem from the registry.

Readonlybutton

button: ButtonComponentSystem

Gets the ButtonComponentSystem from the registry.

Readonlycamera

camera: CameraComponentSystem

Gets the CameraComponentSystem from the registry.

Readonlycollision

collision: CollisionComponentSystem

Gets the CollisionComponentSystem from the registry.

Readonlyelement

element: ElementComponentSystem

Gets the ElementComponentSystem from the registry.

Readonlylayoutchild

layoutchild: LayoutChildComponentSystem

Gets the LayoutChildComponentSystem from the registry.

Readonlylayoutgroup

layoutgroup: LayoutGroupComponentSystem

Gets the LayoutGroupComponentSystem from the registry.

Readonlylight

light: LightComponentSystem

Gets the LightComponentSystem from the registry.

Readonlymodel

model: ModelComponentSystem

Gets the ModelComponentSystem from the registry.

Readonlyparticlesystem

particlesystem: ParticleSystemComponentSystem

Gets the ParticleSystemComponentSystem from the registry.

Readonlyrender

render: RenderComponentSystem

Gets the RenderComponentSystem from the registry.

Readonlyrigidbody

rigidbody: RigidBodyComponentSystem

Gets the RigidBodyComponentSystem from the registry.

Readonlyscreen

screen: ScreenComponentSystem

Gets the ScreenComponentSystem from the registry.

Readonlyscript

script: ScriptComponentSystem

Gets the ScriptComponentSystem from the registry.

Readonlyscrollbar

scrollbar: ScrollbarComponentSystem

Gets the ScrollbarComponentSystem from the registry.

Readonlyscrollview

scrollview: ScrollViewComponentSystem

Gets the ScrollViewComponentSystem from the registry.

Readonlysound

sound: SoundComponentSystem

Gets the SoundComponentSystem from the registry.

Readonlysprite

sprite: SpriteComponentSystem

Gets the SpriteComponentSystem from the registry.

Methods

fire

  • fire(
        name: string,
        arg1?: any,
        arg2?: any,
        arg3?: any,
        arg4?: any,
        arg5?: any,
        arg6?: any,
        arg7?: any,
        arg8?: any,
    ): EventHandler

  • Fire an event, all additional arguments are passed on to the event listener.

    Parameters

    • name: string

      Name of event to fire.

    • Optionalarg1: any

      First argument that is passed to the event handler.

    • Optionalarg2: any

      Second argument that is passed to the event handler.

    • Optionalarg3: any

      Third argument that is passed to the event handler.

    • Optionalarg4: any

      Fourth argument that is passed to the event handler.

    • Optionalarg5: any

      Fifth argument that is passed to the event handler.

    • Optionalarg6: any

      Sixth argument that is passed to the event handler.

    • Optionalarg7: any

      Seventh argument that is passed to the event handler.

    • Optionalarg8: any

      Eighth argument that is passed to the event handler.

    Returns EventHandler

    Self for chaining.

    Example

    obj.fire('test', 'This is the message');

hasEvent

  • hasEvent(name: string): boolean

  • Test if there are any handlers bound to an event name.

    Parameters

    • name: string

      The name of the event to test.

    Returns boolean

    True if the object has handlers bound to the specified event name.

    Example

    obj.on('test', function () { }); // bind an event to 'test'
    obj.hasEvent('test'); // returns true
    obj.hasEvent('hello'); // returns false

off

  • off(name?: string, callback?: HandleEventCallback, scope?: object): EventHandler

  • Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.

    Parameters

    • Optionalname: string

      Name of the event to unbind.

    • Optionalcallback: HandleEventCallback

      Function to be unbound.

    • Optionalscope: object

      Scope that was used as the this when the event is fired.

    Returns EventHandler

    Self for chaining.

    Example

    const handler = function () {
    };
    obj.on('test', handler);

    obj.off(); // Removes all events
    obj.off('test'); // Removes all events called 'test'
    obj.off('test', handler); // Removes all handler functions, called 'test'
    obj.off('test', handler, this); // Removes all handler functions, called 'test' with scope this

on

  • on(name: string, callback: HandleEventCallback, scope?: object): EventHandle

  • Attach an event handler to an event.

    Parameters

    • name: string

      Name of the event to bind the callback to.

    • callback: HandleEventCallback

      Function that is called when event is fired. Note the callback is limited to 8 arguments.

    • Optionalscope: object = ...

      Object to use as 'this' when the event is fired, defaults to current this.

    Returns EventHandle

    Can be used for removing event in the future.

    Example

    obj.on('test', function (a, b) {
        console.log(a + b);
    });
    obj.fire('test', 1, 2); // prints 3 to the console

    Example

    const evt = obj.on('test', function (a, b) {
        console.log(a + b);
    });
    // some time later
    evt.off();

once

  • once(name: string, callback: HandleEventCallback, scope?: object): EventHandle

  • Attach an event handler to an event. This handler will be removed after being fired once.

    Parameters

    • name: string

      Name of the event to bind the callback to.

    • callback: HandleEventCallback

      Function that is called when event is fired. Note the callback is limited to 8 arguments.

    • Optionalscope: object = ...

      Object to use as 'this' when the event is fired, defaults to current this.

    Returns EventHandle

    • can be used for removing event in the future.

    Example

    obj.once('test', function (a, b) {
        console.log(a + b);
    });
    obj.fire('test', 1, 2); // prints 3 to the console
    obj.fire('test', 1, 2); // not going to get handled

Settings

Member Visibility

On This Page

Constructors
Properties
Methods