fireGlobalEvent

(since 1.0)



Executes all events of the specified type present in the core and pipe.

Description


string fireGlobalEvent ( string type, [mixed args], [integer delay] )

This method allow you to fire an event on a pipe and also on Core.

When an event is fired on the core, it's also fired on the APE Client (as client and core share the same events)

Parameters


type
The event name (e.g. 'yourEvent')

args
Array or single object, arguments to pass to the function. If more than one argument, must be an array.

delay
Delay (in ms) to wait to execute the event.

Examples


//ape var is a reference to APE instance
//myPipe var is a reference to a pipe object
//client var is a reference to a client instance
 
//Intercept event on pipe
myPipe.addEvent('testEvent', function() {
    console.log('event received on pipe');
});
 
//Intercept event on core
ape.addEvent('testEvent', function() {
    console.log('event received on core');
});
 
 
//Fire the event "testEvent" on the Pipe & Core
myPipe.fireGlobalEvent('testEvent', ['args1', 'args2']);
 
 
 

User notes


# No comment

Post a note


User notes may be edited or deleted, and usually a note is deleted because of the following reasons:
  • Bugs: Instead report a bug
  • Missing documentation: report that as a bug.
  • Support questions: See the community for available options.

In other words, do not ask questions within the user notes.

Note <b>,<u>,<i> HTML tags are allowed in the posts and the note formatting is preserved. URLs will be turned into clickable links, JavaScipt and C code blocks enclosed in the <source="javascript">JS Code</source> and <source="c">C Code</source> tags will be source highlighted automatically.