Class ScriptType

app

entity

enabled

• set enabled(value): void

• True if the instance of this type is in running state. False when script is not running, because the Entity or any of its parents are disabled or the ScriptComponent is disabled or the Script Instance is disabled. When disabled no update methods will be called on each tick. initialize and postInitialize methods will run once when the script instance is in enabled state during app tick.

  Parameters

  • value: boolean

  Returns void

StaticscriptName

• get scriptName(): string

• Name of a Script Type.

  Returns string

fire

• fire(name, arg1?, arg2?, arg3?, arg4?, arg5?, arg6?, arg7?, arg8?): 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');
  Copy

hasEvent

• hasEvent(name): 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
  Copy

off

• off(name?, callback?, scope?): 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
  Copy

on

• on(name, callback, scope?): 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
  Copy

  Example

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

once

• once(name, callback, scope?): 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
  Copy

StaticEVENT_ATTR

export class PlayerController extends Script {
    initialize() {
        this.on('attr', (name, newValue, oldValue) => {
            console.log(`Attribute '${name}' changed from '${oldValue}' to '${newValue}'`);
        });
    }
};
Copy

export class PlayerController extends Script {
    initialize() {
        this.on('attr:speed', (newValue, oldValue) => {
            console.log(`Attribute 'speed' changed from '${oldValue}' to '${newValue}'`);
        });
    }
};
Copy

StaticEVENT_DESTROY

export class PlayerController extends Script {
    initialize() {
        this.on('destroy', () => {
            // no longer part of the entity
            // this is a good place to clean up allocated resources used by the script
        });
    }
};
Copy

StaticEVENT_DISABLE

export class PlayerController extends Script {
    initialize() {
        this.on('disable', () => {
            // Script Instance is now disabled
        });
    }
};
Copy

StaticEVENT_ENABLE

export class PlayerController extends Script {
    initialize() {
        this.on('enable', () => {
            // Script Instance is now enabled
        });
    }
};
Copy

StaticEVENT_ERROR

export class PlayerController extends Script {
    initialize() {
        this.on('error', (err, method) => {
            // caught an exception
            console.log(err.stack);
        });
    }
};
Copy

StaticEVENT_STATE

export class PlayerController extends Script {
    initialize() {
        this.on('state', (enabled) => {
            console.log(`Script Instance is now ${enabled ? 'enabled' : 'disabled'}`);
        });
    }
};
Copy