Managed Forward, same as IForward, except the collection can be modified. More...

#include <public/IForwardSys.h>

Inheritance diagram for SourceMod::IChangeableForward:

Public Member Functions
virtual bool	RemoveFunction (IPluginFunction *func)=0
	Removes a function from the call list. NOTE: Only removes one instance. More...

virtual unsigned int	RemoveFunctionsOfPlugin (IPlugin *plugin)=0
	Removes all instances of a plugin from the call list. More...

virtual bool	AddFunction (IPluginFunction *func)=0
	Adds a function to the call list. NOTE: Cannot be used during an incomplete call. NOTE: If used during a call, function is temporarily queued until calls are over. NOTE: Adding multiple copies of the same function is illegal. More...

virtual bool	AddFunction (IPluginContext *ctx, funcid_t index)=0
	Adds a function to the call list. NOTE: Cannot be used during an incomplete call. NOTE: If used during a call, function is temporarily queued until calls are over. More...

virtual bool	RemoveFunction (IPluginContext *ctx, funcid_t index)=0
	Removes a function from the call list. NOTE: Only removes one instance. More...

Public Member Functions inherited from SourceMod::IForward
virtual	~IForward ()

virtual const char *	GetForwardName ()=0
	Returns the name of the forward. More...

virtual unsigned int	GetFunctionCount ()=0
	Returns the number of functions in this forward. More...

virtual ExecType	GetExecType ()=0
	Returns the method of multi-calling this forward has. More...

virtual int	Execute (cell_t result, IForwardFilter filter=NULL)=0
	Executes the forward. More...

virtual int	PushArray (cell_t *inarray, unsigned int cells, int flags=0)=0
	Pushes an array of cells onto the current call. Different rules than ICallable. NOTE: On Execute, the pointer passed will be modified according to the copyback rule. More...

Detailed Description

Managed Forward, same as IForward, except the collection can be modified.

Member Function Documentation

virtual bool SourceMod::IChangeableForward::AddFunction ( IPluginFunction * func )

pure virtual

Adds a function to the call list. NOTE: Cannot be used during an incomplete call. NOTE: If used during a call, function is temporarily queued until calls are over. NOTE: Adding multiple copies of the same function is illegal.

Parameters

func	Function to add.

Returns: True on success, otherwise false.

virtual bool SourceMod::IChangeableForward::AddFunction	(	IPluginContext *	ctx,
		funcid_t	index
	)

pure virtual

Adds a function to the call list. NOTE: Cannot be used during an incomplete call. NOTE: If used during a call, function is temporarily queued until calls are over.

Parameters

ctx	Context to use as a look-up.
index	Function id to add.

Returns: True on success, otherwise false.

virtual bool SourceMod::IChangeableForward::RemoveFunction ( IPluginFunction * func )

pure virtual

Removes a function from the call list. NOTE: Only removes one instance.

Parameters

func	Function to remove.

Returns: Whether or not the function was removed.

virtual bool SourceMod::IChangeableForward::RemoveFunction	(	IPluginContext *	ctx,
		funcid_t	index
	)

pure virtual

Removes a function from the call list. NOTE: Only removes one instance.

Parameters

ctx	Context to use as a look-up.
index	Function id to add.

Returns: Whether or not the function was removed.

virtual unsigned int SourceMod::IChangeableForward::RemoveFunctionsOfPlugin ( IPlugin * plugin )

pure virtual

Removes all instances of a plugin from the call list.

Parameters

plugin Plugin to remove instances of.

Returns: Number of functions removed therein.

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

public/IForwardSys.h

Public Member Functions

Detailed Description

Member Function Documentation