COMMAND Struct Reference

#include <plugins.h>

Public Attributes
const char *	command
	A string containing the command name. More...
const char *	desc
	A string containing the help text for the command. More...
CommandProcType	help_proc
	Optional handler to provide extended help beyond the desc field above. More...
union {
const char *   action
	The raw IRC command to send (if proc_type == COMMAND_ACTION) More...
CommandProcType   proc
	The command handler (if proc_type == COMMAND_PROC) More...
};
uint32	proc_type
	COMMAND_ACTION or COMMAND_PROC. More...
COMMAND_ACL	acl
	The flags needed (and not allowed) to use this command. More...
uint32	mask
	A bitmask of the CM_ALLOW_* defines below, specifies from which contexts a command may be used. Commands loaded from ircbot.text will also have CM_FROM_TEXT set as well, which is used by the Rehash command. More...
int	plugin
	Plugin number that registered this command, or -1 for an IRCBot internal command. More...
uint32	ref_cnt
	DO NOT TOUCH!!! More...

Detailed Description

The COMMAND structure is the internal record of a command. It contains the command, how to handle it, help text, ACL, what protocols may use it, etc.

See also

API_commands

Member Data Documentation

const char* COMMAND::command

A string containing the command name.

const char* COMMAND::desc

A string containing the help text for the command.

CommandProcType COMMAND::help_proc

Optional handler to provide extended help beyond the desc field above.

const char* COMMAND::action

The raw IRC command to send (if proc_type == COMMAND_ACTION)

CommandProcType COMMAND::proc

The command handler (if proc_type == COMMAND_PROC)

union { ... }

uint32 COMMAND::proc_type

COMMAND_ACTION or COMMAND_PROC.

COMMAND_ACL COMMAND::acl

The flags needed (and not allowed) to use this command.

uint32 COMMAND::mask

A bitmask of the CM_ALLOW_* defines below, specifies from which contexts a command may be used. Commands loaded from ircbot.text will also have CM_FROM_TEXT set as well, which is used by the Rehash command.

int COMMAND::plugin

Plugin number that registered this command, or -1 for an IRCBot internal command.

uint32 COMMAND::ref_cnt

DO NOT TOUCH!!!

---

The documentation for this struct was generated from the following file:

• plugins.h