This file has generic functions for calling hooks, and passing parameters to them. Hooks are stored as variables on the object, area or module, and each of those are called in order from object to area to module. Any of those can indicate that the processing of will terminate there, i.e. do not continue to other hooks, or the normal processing of the script.

See Hooks for list of hooks.

See the generic hooks page about generic hooks.

Here is list of generic hooks in the cerea2 module:

ch_g_q_incquest
ch_g_q_saytext
ch_g_q_tagger

(Hook)

Call the hooks, and return FALSE if the caller should continue prosessing normally. If this script returns TRUE, then the caller should terminate normal processing, i.e. the hook did everything to be done, and normal processing should be skipped. The sParameter is the string to be passed to the hook, and nParameter is the int to passwd to the hook

int C_CallHooks(object oObject,
		object oPC,
		string sHookVarName,
		string sParameter = "",
		int nParameter = 0);

(Hook)

Get the parameter from the caller.

string C_GetHookParamString(object oObject = OBJECT_SELF);

(Hook)

Get the parameter from the caller.

int C_GetHookParamInt(object oObject = OBJECT_SELF);

(Hook)

Get the PC from the caller.

object C_GetHookPC(object oObject = OBJECT_SELF);

(Hook)

Set the skip normal operation flag after returning from hook

void C_SetHookSkipNormalProcessing(object oObject = OBJECT_SELF);

(Hook)

Are we now inside the hook? Return TRUE if this script was executed from hook.

int C_GetIsHook(object oObject = OBJECT_SELF);