SDKExtension Class Reference

Inherits SourceMod::IExtensionInterface.

Inherited by Sample.

Inheritance diagram for SDKExtension:

[legend]Collaboration diagram for SDKExtension:[legend]List of all members.


Public Member Functions
	SDKExtension ()
virtual bool	SDK_OnLoad (char *error, size_t maxlength, bool late)
	This is called after the initial loading sequence has been processed.
virtual void	SDK_OnUnload ()
	This is called right before the extension is unloaded.
virtual void	SDK_OnAllLoaded ()
	This is called once all known extensions have been loaded.
virtual void	SDK_OnPauseChange (bool paused)
	Called when the pause state is changed.
virtual bool	SDK_OnMetamodLoad (ISmmAPI ismm, char error, size_t maxlength, bool late)
	Called when Metamod is attached, before the extension version is called.
virtual bool	SDK_OnMetamodUnload (char *error, size_t maxlength)
	Called when Metamod is detaching, after the extension version is called. NOTE: By default this is blocked unless sent from SourceMod.
virtual bool	SDK_OnMetamodPauseChange (bool paused, char *error, size_t maxlength)
	Called when Metamod's pause state is changing. NOTE: By default this is blocked unless sent from SourceMod.
virtual bool	OnExtensionLoad (IExtension me, IShareSys sys, char *error, size_t maxlength, bool late)
	Called when the extension is loaded.
virtual void	OnExtensionUnload ()
	Called when the extension is about to be unloaded.
virtual void	OnExtensionsAllLoaded ()
	Called when all extensions are loaded (loading cycle is done). If loaded late, this will be called right after OnExtensionLoad().
virtual bool	IsMetamodExtension ()
virtual void	OnExtensionPauseChange (bool state)
	Called when the pause state changes.
virtual const char *	GetExtensionName ()
virtual const char *	GetExtensionURL ()
virtual const char *	GetExtensionTag ()
virtual const char *	GetExtensionAuthor ()
virtual const char *	GetExtensionVerString ()
virtual const char *	GetExtensionDescription ()
virtual const char *	GetExtensionDateString ()
virtual bool	Load (PluginId id, ISmmAPI ismm, char error, size_t maxlength, bool late)
virtual const char *	GetAuthor ()
virtual const char *	GetName ()
virtual const char *	GetDescription ()
virtual const char *	GetURL ()
virtual const char *	GetLicense ()
virtual const char *	GetVersion ()
virtual const char *	GetDate ()
virtual const char *	GetLogTag ()
virtual bool	Unload (char *error, size_t maxlength)
virtual bool	Pause (char *error, size_t maxlength)
virtual bool	Unpause (char *error, size_t maxlength)

Detailed Description

Definition at line 103 of file smsdk_ext.h.

Constructor & Destructor Documentation

SDKExtension::SDKExtension ( )

Constructor

Definition at line 107 of file smsdk_ext.cpp.

Member Function Documentation

bool SDKExtension::SDK_OnLoad	(	char *	error,
		size_t	maxlength,
		bool	late
	)			`[virtual]`

This is called after the initial loading sequence has been processed.

Parameters:

	error	Error message buffer.
	maxlength	Size of error message buffer.
	late	Whether or not the module was loaded after map load.

Returns:: True to succeed loading, false to fail.

Definition at line 265 of file smsdk_ext.cpp.

bool SDKExtension::SDK_OnMetamodLoad	(	ISmmAPI *	ismm,
		char *	error,
		size_t	maxlength,
		bool	late
	)			`[virtual]`

Called when Metamod is attached, before the extension version is called.

Parameters:

	error	Error buffer.
	maxlength	Maximum size of error buffer.
	late	Whether or not Metamod considers this a late load.

Returns:: True to succeed, false to fail.

Definition at line 419 of file smsdk_ext.cpp.

bool SDKExtension::SDK_OnMetamodUnload	(	char *	error,
		size_t	maxlength
	)			`[virtual]`

Called when Metamod is detaching, after the extension version is called. NOTE: By default this is blocked unless sent from SourceMod.

Parameters:

	error	Error buffer.
	maxlength	Maximum size of error buffer.

Returns:: True to succeed, false to fail.

Definition at line 424 of file smsdk_ext.cpp.

bool SDKExtension::SDK_OnMetamodPauseChange	(	bool	paused,
		char *	error,
		size_t	maxlength
	)			`[virtual]`

Called when Metamod's pause state is changing. NOTE: By default this is blocked unless sent from SourceMod.

Parameters:

	paused	Pause state being set.
	error	Error buffer.
	maxlength	Maximum size of error buffer.

Returns:: True to succeed, false to fail.

Definition at line 429 of file smsdk_ext.cpp.

bool SDKExtension::OnExtensionLoad	(	IExtension *	me,
		IShareSys *	sys,
		char *	error,
		size_t	maxlength,
		bool	late
	)			`[virtual]`

Called when the extension is loaded.

Parameters:

	me	Pointer back to extension.
	sys	Pointer to interface sharing system of SourceMod.
	error	Error buffer to print back to, if any.
	maxlength	Maximum size of error buffer.
	late	If this extension was loaded "late" (i.e. manually).

Returns:: True if load should continue, false otherwise.

Implements SourceMod::IExtensionInterface.

Definition at line 116 of file smsdk_ext.cpp.

bool SDKExtension::IsMetamodExtension ( ) [virtual]

Returns whether or not this is a Metamod-based extension

Implements SourceMod::IExtensionInterface.

Definition at line 200 of file smsdk_ext.cpp.

void SDKExtension::OnExtensionPauseChange ( bool state ) [virtual]

Called when the pause state changes.

Parameters:

state

True if being paused, false if being unpaused.

Implements SourceMod::IExtensionInterface.

Definition at line 209 of file smsdk_ext.cpp.

const char * SDKExtension::GetExtensionName ( ) [virtual]

Returns name

Implements SourceMod::IExtensionInterface.

Definition at line 250 of file smsdk_ext.cpp.

const char * SDKExtension::GetExtensionURL ( ) [virtual]

Returns URL

Implements SourceMod::IExtensionInterface.

Definition at line 260 of file smsdk_ext.cpp.

const char * SDKExtension::GetExtensionTag ( ) [virtual]

Returns log tag

Implements SourceMod::IExtensionInterface.

Definition at line 255 of file smsdk_ext.cpp.

const char * SDKExtension::GetExtensionAuthor ( ) [virtual]

Returns author

Implements SourceMod::IExtensionInterface.

Definition at line 230 of file smsdk_ext.cpp.

const char * SDKExtension::GetExtensionVerString ( ) [virtual]

Returns version string

Implements SourceMod::IExtensionInterface.

Definition at line 245 of file smsdk_ext.cpp.

const char * SDKExtension::GetExtensionDescription ( ) [virtual]

Returns description string

Implements SourceMod::IExtensionInterface.

Definition at line 240 of file smsdk_ext.cpp.

const char * SDKExtension::GetExtensionDateString ( ) [virtual]

Returns date string

Implements SourceMod::IExtensionInterface.

Definition at line 235 of file smsdk_ext.cpp.

bool SDKExtension::Load	(	PluginId	id,
		ISmmAPI *	ismm,
		char *	error,
		size_t	maxlength,
		bool	late
	)			`[virtual]`

Called when the extension is attached to Metamod.

Definition at line 316 of file smsdk_ext.cpp.

const char * SDKExtension::GetAuthor ( ) [virtual]

Returns the author to MM

Definition at line 379 of file smsdk_ext.cpp.

const char * SDKExtension::GetName ( ) [virtual]

Returns the name to MM

Definition at line 404 of file smsdk_ext.cpp.

const char * SDKExtension::GetDescription ( ) [virtual]

Returns the description to MM

Definition at line 389 of file smsdk_ext.cpp.

const char * SDKExtension::GetURL ( ) [virtual]

Returns the URL to MM

Definition at line 409 of file smsdk_ext.cpp.

const char * SDKExtension::GetLicense ( ) [virtual]

Returns the license to MM

Definition at line 394 of file smsdk_ext.cpp.

const char * SDKExtension::GetVersion ( ) [virtual]

Returns the version string to MM

Definition at line 414 of file smsdk_ext.cpp.

const char * SDKExtension::GetDate ( ) [virtual]

Returns the date string to MM

Definition at line 384 of file smsdk_ext.cpp.

const char * SDKExtension::GetLogTag ( ) [virtual]

Returns the logtag to MM

Definition at line 399 of file smsdk_ext.cpp.

bool SDKExtension::Unload	(	char *	error,
		size_t	maxlength
	)			`[virtual]`

Called on unload

Definition at line 333 of file smsdk_ext.cpp.

bool SDKExtension::Pause	(	char *	error,
		size_t	maxlength
	)			`[virtual]`

Called on pause

Definition at line 347 of file smsdk_ext.cpp.

bool SDKExtension::Unpause	(	char *	error,
		size_t	maxlength
	)			`[virtual]`

Called on unpause

Definition at line 363 of file smsdk_ext.cpp.

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

public/sample_ext/sdk/smsdk_ext.h
public/sample_ext/sdk/smsdk_ext.cpp

Generated on Thu Aug 28 22:10:16 2008 for SourceMod SDK by

1.5.1

SDKExtension Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation