#include <global.h>
#include <loader.h>

Functions
static void	register_global_event (const char *plugin_name, int event_nr)
static void	unregister_global_event (const char *plugin_name, int event_nr)
static atrinik_plugin *	find_plugin (const char *id)
object *	get_event_object (object *op, int event_nr)
CommArray_s *	find_plugin_command (const char *cmd)
void	display_plugins_list (object *op)
void	init_plugins ()
void	init_plugin (const char *pluginfile)
void	remove_plugin (const char *id)
void	remove_plugins ()
void	map_event_obj_init (object *ob)
void	map_event_free (map_event *tmp)
void	map_event_obj_deinit (object *ob)
int	trigger_map_event (int event_id, mapstruct m, object activator, object other, object other2, const char *text, int parm)
void	trigger_global_event (int event_type, void parm1, void parm2)
int	trigger_event (int event_type, object const activator, object const me, object const other, const char msg, int parm1, int parm2, int parm3, int flags)
Variables
struct plugin_hooklist	hooklist
static atrinik_plugin *	plugins_list = NULL

Detailed Description

Handles the plugins code.

Definition in file plugins.c.

Function Documentation

void display_plugins_list ( object * op )

Display a list of loaded and loadable plugins in player's window.

Parameters:

op	The player to print the plugins to.

Definition at line 300 of file plugins.c.

static atrinik_plugin* find_plugin ( const char * id ) [static]

Find a plugin by its identification string.

Parameters:

id	Plugin's identification string.

Returns:: Pointer to the found plugin, NULL if not found.

Definition at line 195 of file plugins.c.

CommArray_s* find_plugin_command ( const char * cmd )

Tries to find if a given command is handled by a plugin.

Parameters:

cmd	The command name to find.

Returns:: Command array structure if found, NULL otherwise.

Definition at line 275 of file plugins.c.

object* get_event_object	(	object *	op,
		int	event_nr
	)

Browse through the inventory of an object to find first event that matches the event type of event_nr.

Parameters:

op	The object to search in.
event_nr	The event number.

Returns:: Script object matching the event type.

Definition at line 256 of file plugins.c.

void init_plugin ( const char * pluginfile )

Initializes a plugin known by its filename.

Parameters:

pluginfile The plugin filename.

Definition at line 398 of file plugins.c.

void init_plugins ( )

Initializes plugins. Browses the plugins directory and calls init_plugin() for each plugin file found with the extension being PLUGIN_SUFFIX.

Definition at line 342 of file plugins.c.

void map_event_free ( map_event * tmp )

Free a map_event.

Parameters:

tmp	What to free.

Definition at line 575 of file plugins.c.

void map_event_obj_deinit ( object * ob )

Deinitialize map event object.

Parameters:

ob	What to deinitialize.

Definition at line 583 of file plugins.c.

void map_event_obj_init ( object * ob )

Initialize map event object.

Parameters:

ob	What to initialize.

Definition at line 554 of file plugins.c.

static void register_global_event	(	const char *	plugin_name,
		int	event_nr
	)		`[static]`

Register a global event.

Parameters:

plugin_name	Plugin's name.
event_nr	Event ID to register.

Definition at line 219 of file plugins.c.

void remove_plugin ( const char * id )

Removes one plugin from memory. The plugin is identified by its keyname.

Parameters:

id	The plugin keyname.

Definition at line 495 of file plugins.c.

void remove_plugins ( )

Deinitialize all plugins.

Definition at line 527 of file plugins.c.

int trigger_event	(	int	event_type,
		object *const	activator,
		object *const	me,
		object *const	other,
		const char *	msg,
		int	parm1,
		int	parm2,
		int	parm3,
		int	flags
	)

Handles triggering normal events like EVENT_ATTACK, EVENT_STOP, etc.

Parameters:

event_type	The event type.
activator	Activator object.
me	Object the event object is in.
other	Other object.
msg	Message.
parm1	First parameter.
parm2	Second parameter.
parm3	Third parameter.
flags	Event flags.

Returns:: 1 if the event returns an event value, 0 otherwise.

Definition at line 690 of file plugins.c.

void trigger_global_event	(	int	event_type,
		void *	parm1,
		void *	parm2
	)

Handles triggering global events like EVENT_BORN, EVENT_MAPRESET, etc.

Parameters:

event_type	The event type.
parm1	First parameter.
parm2	Second parameter.

Definition at line 659 of file plugins.c.

int trigger_map_event	(	int	event_id,
		mapstruct *	m,
		object *	activator,
		object *	other,
		object *	other2,
		const char *	text,
		int	parm
	)

Triggers a map-wide event.

Parameters:

event_id	Event ID to trigger.
m	Map we're working on.
activator	Activator.
other	Some other object related to this event.
other2	Another object related to this event.
text	String related to this event.
parm	Integer related to this event.