Home » Docs » Server »
 

registerHookCmd

(since 1.0)



Register a hook on an user command.

Description


string registerHookCmd ( string name, function fn )

You can register a hook, the callback function will be called before the command execution. Any error returned cancels the command call.

See registerCmd for errors you can return.

Parameters


name
The command name

fn
  • params - (object) The list of parameters sent by the client.
  • info - (object) Contains information about the client (see registerCmd for more informations)

Examples


Ape.registerHookCmd("foocmd", function(params, info) {
	if (!$defined(params.john)) return 0;
	return 1;
});
 

See also


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.