SourceMod::IChangeableForward Class Reference

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

#include <public/IForwardSys.h>

Inherits SourceMod::IForward.

Collaboration diagram for SourceMod::IChangeableForward:

List of all members.

Public Member Functions
virtual bool	RemoveFunction (IPluginFunction *func)=0
	Removes a function from the call list. NOTE: Only removes one instance.
virtual unsigned int	RemoveFunctionsOfPlugin (IPlugin *plugin)=0
	Removes all instances of a plugin from the call list.
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.
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.
virtual bool	RemoveFunction (IPluginContext *ctx, funcid_t index)=0
	Removes a function from the call list. NOTE: Only removes one instance.

---

Detailed Description

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

Definition at line 148 of file IForwardSys.h.

---

Member Function Documentation

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 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.

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	(	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.

---

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

• public/IForwardSys.h