plugin_template.cpp File Reference

#include <plugin_template.h>
#include <stdarg.h>
#include <plugin_template_proto.h>

Include dependency graph for plugin_template.cpp:

Go to the source code of this file.

Functions
CF_PLUGIN int	closePlugin (void)
	Close the plugin. More...
CF_PLUGIN void *	eventListener (int *type,...)
	Handles an object-related event. More...
CF_PLUGIN void *	getPluginProperty (int *type,...)
	Gets a plugin property. More...
CF_PLUGIN void *	globalEventListener (int *type,...)
void	initContextStack (void)
CF_PLUGIN int	initPlugin (const char *iversion, f_plug_api gethooksptr)
	Plugin initialisation function. More...
CFPContext *	popContext (void)
CF_PLUGIN int	postInitPlugin (void)
	Plugin was initialized, now to finish. More...
void	pushContext (CFPContext *context)
CF_PLUGIN int	runPluginCommand (object *op, char *params)

Variables
CFPContext *	context_stack
static int	current_command = -999
CFPContext *	current_context

Function Documentation

closePlugin()

CF_PLUGIN int closePlugin

(

void

)

Close the plugin.

Closes the sqlite database.

Returns

0.

Definition at line 295 of file plugin_template.cpp.

References cf_log(), llevDebug, and PLUGIN_VERSION.

Here is the call graph for this function:

eventListener()

CF_PLUGIN void* eventListener	(	int *	type,
			...
	)

Handles an object-related event.

Doesn't do anything.

Parameters

type

ignored.

Returns

0.

Todo:

build from current map's path, probably

Definition at line 260 of file plugin_template.cpp.

References CFPContext::activator, buf, cf_get_maps_directory(), cf_log(), CFPContext::event, CFPContext::event_code, CFPContext::fix, is_animated_object(), llevDebug, MAX_BUF, message, CFPContext::message, object::name, CFPContext::options, popContext(), pushContext(), CFPContext::returnvalue, object::slaying, start_animation(), CFPContext::third, is_valid_types_gen::type, and CFPContext::who.

Here is the call graph for this function:

getPluginProperty()

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

Gets a plugin property.

Parameters

type

ignored.

Returns

• the name, if asked for 'Identification'.
• the version, if asked for 'FullName'.
• NULL else.

Check if plugin handles custom command

Definition at line 78 of file plugin_template.cpp.

References buf, PLUGIN_NAME, PLUGIN_VERSION, and is_valid_types_gen::type.

globalEventListener()

CF_PLUGIN void* globalEventListener	(	int *	type,
			...
	)

Definition at line 141 of file plugin_template.cpp.

References CFPContext::activator, buf, cf_log(), CFPContext::event, EVENT_BORN, EVENT_CLOCK, CFPContext::event_code, EVENT_CRASH, EVENT_GKILL, EVENT_KICK, EVENT_LOGIN, EVENT_LOGOUT, EVENT_MAPENTER, EVENT_MAPLEAVE, EVENT_MAPRESET, EVENT_MUZZLE, EVENT_PLAYER_DEATH, EVENT_REMOVE, EVENT_SHOUT, EVENT_TELL, llevDebug, CFPContext::message, player::ob, popContext(), pushContext(), CFPContext::returnvalue, CFPContext::third, is_valid_types_gen::type, and CFPContext::who.

Here is the call graph for this function:

initContextStack()

void initContextStack

(

void

)

Definition at line 41 of file plugin_template.cpp.

References context_stack, and current_context.

Referenced by postInitPlugin().

Here is the caller graph for this function:

initPlugin()

CF_PLUGIN int initPlugin	(	const char *	iversion,
		f_plug_api	gethooksptr
	)

Plugin initialisation function.

Parameters

iversion	server version.
gethooksptr	function to get the hooks.

Returns

0

Plugin initialisation function.

Parameters

iversion	server version.
gethooksptr	function to get hooks from.

Returns

always 0.

Definition at line 69 of file plugin_template.cpp.

References cf_init_plugin(), cf_log(), llevDebug, and PLUGIN_VERSION.

Here is the call graph for this function:

popContext()

CFPContext* popContext

(

void

)

Definition at line 58 of file plugin_template.cpp.

References current_context, and CFPContext::down.

Referenced by eventListener(), and globalEventListener().

Here is the caller graph for this function:

postInitPlugin()

CF_PLUGIN int postInitPlugin

(

void

)

Plugin was initialized, now to finish.

Registers events, initializes the database.

Returns

0.

Definition at line 117 of file plugin_template.cpp.

References cf_log(), cf_system_register_global_event(), cfanim_globalEventListener(), EVENT_CLOCK, initContextStack(), llevDebug, PLUGIN_NAME, and PLUGIN_VERSION.

Here is the call graph for this function:

pushContext()

void pushContext

(

CFPContext *

context

)

Definition at line 46 of file plugin_template.cpp.

References context_stack, current_context, and CFPContext::down.

Referenced by eventListener(), and globalEventListener().

Here is the caller graph for this function:

runPluginCommand()

CF_PLUGIN int runPluginCommand	(	object *	op,
		char *	params
	)

Definition at line 113 of file plugin_template.cpp.

Variable Documentation

context_stack

CFPContext* context_stack

Definition at line 35 of file plugin_template.cpp.

Referenced by initContextStack(), and pushContext().

current_command

int current_command = -999

static

Definition at line 39 of file plugin_template.cpp.

current_context

CFPContext* current_context

Definition at line 37 of file plugin_template.cpp.

Referenced by initContextStack(), popContext(), and pushContext().