Class ScriptTypeBase

扩展脚本类

Hierarchy

  • ScriptTypeBase

Constructors

Properties

_attributesData: { [key: string]: AttributeParams }

脚本属性设置

Type declaration

  • [key: string]: AttributeParams
app: AppBase

此脚本所在的app实例

attributes: ScriptAttributes

脚本属性

enabled: boolean

此脚本是否运行

entity: Entity

此脚本所附加到的物体

scriptName: string

此脚本的名称

Accessors

Methods

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

    Returns

    Self for chaining.

    Example

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

    Parameters

    • name: any

      Name of event to fire.

    • Optional arg1: any

      First argument that is passed to the event handler.

    • Optional arg2: any

      Second argument that is passed to the event handler.

    • Optional arg3: any

      Third argument that is passed to the event handler.

    • Optional arg4: any

      Fourth argument that is passed to the event handler.

    • Optional arg5: any

      Fifth argument that is passed to the event handler.

    • Optional arg6: any

      Sixth argument that is passed to the event handler.

    • Optional arg7: any

      Seventh argument that is passed to the event handler.

    • Optional arg8: any

      Eighth argument that is passed to the event handler.

    Returns EventHandler

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

    Returns

    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

    Parameters

    • name: string

      The name of the event to test.

    Returns boolean

  • 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.

    Returns

    Self for chaining.

    Example

    var 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 hander functions, called 'test' with scope this

    Parameters

    • Optional name: string

      Name of the event to unbind.

    • Optional callback: HandleEventCallback

      Function to be unbound.

    • Optional scope: any

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

    Returns EventHandler

  • Attach an event handler to an event.

    Returns

    Self for chaining.

    Example

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

    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.

    • Optional scope: any

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

    Returns EventHandler

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

    Returns

    Self for chaining.

    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

    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.

    • Optional scope: any

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

    Returns EventHandler

  • Called for enabled (running state) scripts on each tick, after update.

    Parameters

    • dt: number

      The delta time in seconds since the last frame.

    Returns void

  • Called when a ScriptType that already exists in the registry gets redefined. If the new ScriptType has a swap method in its prototype, then it will be executed to perform hot-reload at runtime.

    Returns void