MEMBERS

name :string

IncisorAPI.js, line 3279

Name of AppEvent

Example:

// Objective: Get the name of an AppEvent.
// Expected Result: The console should read "myAppEvent name keyboardEvent".

// Get an instance of the keyboardEvent (AppEventWithFocus) AppEvent.
let myAppEvent = nc.appEvents.keyboardEvent;
console.log("myAppEvent name", myAppEvent.name);

readonly type :string

IncisorAPI.js, line 3266

Type identifier

METHODS

addCallback(callbackOwner, callbackName, pauseImmunity (opt), singularFocusRequirements (opt))

IncisorAPI.js, line 3305

Adds the provided function to the list of functions called with the associated AppEvent occurs.

Parameters:

Name	Type	Attributes	Default	Description
callbackOwner	object			The object owning the callback function.
callbackName	string			The name of the callback function.
pauseImmunity	Array.<PauseEvent> | PauseEvent	<optional>		The PauseEvent or Array of PauseEvents that this AppEvent callback will be immune to. Set this parameter to [] to create callbacks with no immunity. If this parameter is left undefined, the current value of 'nc.defaultPauseImmunity' will be used. The value for 'nc.defaultPauseImmunity' defaults to [], but can be changed at any time. [DEFAULT: nc.defaultPauseImmunity]
singularFocusRequirements	Array.<object> | object	<optional>		Supplying this object or Array of objects is a way of requiring the correct focus context for this callback to occur. If left undefined, the callback will be invoked with any triggering event. If supplied, one of the objects in the singularFocusRequirements must be 'in focus' for the callback to be invoked.

Example:

// Objective: Add a callback to an AppEvent.
// Action: Press a key on the keyboard. For this example, press the letter 'a'.
// Expected Result: The console should have 2 log messages as follows:
//   callback type: keydown a
//   callback type: keyup a

// Add a callback function.
this.myCallback = function(args) {
    console.log('callback type:', args.type, args.key);
}

// Get an instance of the keyboardEvent (AppEventWithFocus) AppEvent.
let myAppEvent = nc.appEvents.keyboardEvent;
// Add the callback.
myAppEvent.addCallback( this, "myCallback" );

getRecipients() returns {Array.<object>}

IncisorAPI.js, line 3379

Returns an Array listing all of the callbacks currently connected to this AppEvent. The returned Array lists objects containing the callbackOwner, callbackName, and paused state for each callback.

Returns:

Array.<object>

Example:

// Objective: List all of the callbacks currently connected to this AppEvent.
// Expected Result: The console should have 2 log messages as follows:
//   recipient myCallback1
//   recipient myCallback2
//   recipient myCallback3

// Make 3 callbacks.
this.myCallback1 = function(args) {
    console.log('myCallback1 callback type:', args.type, args.key);
}
this.myCallback2 = function(args) {
    console.log('myCallback2 callback type:', args.type, args.key);
}
this.myCallback3 = function(args) {
    console.log('myCallback3 callback type:', args.type, args.key);
}

// Get an instance of the keyboardEvent (AppEventWithFocus) AppEvent.
let myAppEvent = nc.appEvents.keyboardEvent;
// Add all 3 callbacks to this AppEvent.
myAppEvent.addCallback( this, "myCallback1" );
myAppEvent.addCallback( this, "myCallback2" );
myAppEvent.addCallback( this, "myCallback3" );

// Iterate and console log the array of recipients.
let recipients = myAppEvent.getRecipients();
for ( let r of recipients ) {
    console.log('recipient', r.callbackName);
}

removeCallback(callbackOwner, callbackName)

IncisorAPI.js, line 3342

Removes the provided function from the list of functions called with the associated AppEvent occurs.

Parameters:

Name	Type	Attributes	Default	Description
callbackOwner	object			The object owning the callback function to be removed.
callbackName	string			The name of the callback function to be removed.

Example:

// Objective: Remove a callback from an AppEvent.
// Actions: 
// 1. Press a key on the keyboard. For this example, press the letter 'a'.
// 1. Expected Result: The console should have 2 log messages as follows:
//   callback type: keydown a
//   callback type: keyup a
//
// 2. Click the white box to remove the AppEvent.
// 2. Expected Result: Upon clicking the white box, the console should read "removing the callback". You will no longer see console log messages upon  pressing the keyboard.

// Add a callback function and name it 'myEventCallback'.
this.myEventCallback = function(args) {
    console.log('callback type:', args.type, args.key);
}
// Get an instance of the keyboardEvent (AppEventWithFocus) AppEvent.
let myAppEvent = nc.appEvents.keyboardEvent;
// Add the callback.
myAppEvent.addCallback( this, "myEventCallback" );

// Create a button to use to remove the callback. Use the WhiteBox GraphicAsset.
this.removeButton = nc.addButton( nc.graphicAssets.WhiteBox, nc.mainScene, "RemoveButton" );
// Create a callback function that handles the click of the white box and executes removeCallback(). Name the callback function "myButtonCallback".
this.myButtonCallback = function(args) {
    console.log('removing the callback');
    // Inside this press callback, remove the callback
    myAppEvent.removeCallback( this, "myEventCallback" );
}
// Add the PressCallback to handle the clicking of the white box
this.removeButton.addPressCallback( this, "myButtonCallback" );

trigger(callbackArgs (opt))

IncisorAPI.js, line 3385

Method that 'Triggers' the AppEvent, invoking all of the callback functions that have been added to it (provided that their singular focus requirements are met).

Parameters:

Name	Type	Attributes	Default	Description
callbackArgs	Array | any	<optional>		Parameter or Array of parameters that will be sent to this AppEvent's callback functions. It should be noted that if an Array is supplied, the individual members of the Array will be sent to callback functions as individual parameters.