Home » Docs » Server »
 

addEvent

(since 1.0)



Listen an APE event

Description


string addEvent ( string name, function fn )

Used to listen global Ape events. See example for more information.

Parameters


name
The event's name

fn
The callback function, see each event's entry for more information.

Examples


Ape.addEvent('init', function(){
	Ape.log('Ape is ready !');
});

Ape.addEvent("adduser", function(user) {
	Ape.log("New user :)");
});
Ape.addEvent("join", function(user, channel) {
	Ape.log("New user has joined the channel ("+channel.getProperty('name')+") :)");
});

//Note that all objects passed to Events are persistent.
//This means that you can store private data inside user, channel, ...
 
Ape.addEvent("adduser", function(user) {
	Ape.log("New user.");
	user.foo = "bar";
});
Ape.addEvent("join", function(user, channel) {
	Ape.log(user.foo+" joined the channel ("+channel.getProperty('name')+").");
});

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.