Exportable plugin functions

Functions

MODULEAPI void initPlugin (struct plugin_hooklist *hooklist)
MODULEAPI void * getPluginProperty (int *type,...)
MODULEAPI void * triggerEvent (int *type,...)
MODULEAPI void postinitPlugin ()
MODULEAPI void closePlugin ()

Detailed Description

Exportable functions. Any plugin should define all these.


Function Documentation

MODULEAPI void closePlugin (  ) 

Called when the plugin is about to be unloaded.

Definition at line 181 of file plugin_arena.c.

MODULEAPI void* getPluginProperty ( int *  type,
  ... 
)

Called to ask various informations about the plugin.

Parameters:
type Integer pointer for va_start().
Returns:
Return value depends on the type of information requested. Can be NULL.

Definition at line 186 of file plugin_arena.c.

MODULEAPI void initPlugin ( struct plugin_hooklist hooklist  ) 

Called when the plugin initialization process starts.

Parameters:
hooklist Plugin hooklist to register.

Definition at line 173 of file plugin_arena.c.

MODULEAPI void postinitPlugin (  ) 

Called by the server when the plugin loading is completed.

Definition at line 217 of file plugin_arena.c.

MODULEAPI void* triggerEvent ( int *  type,
  ... 
)

Called whenever an event occurs.

Parameters:
type Integer pointer for va_start().
Returns:
Integer containing the event's return value.

Definition at line 650 of file plugin_arena.c.


Generated by  doxygen 1.6.2