SourceMod SDK  1.7
SDKExtension Class Reference
Inheritance diagram for SDKExtension:
SourceMod::IExtensionInterface

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. More...
 
virtual void SDK_OnUnload ()
 This is called once the extension unloading process begins.
 
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 void SDK_OnDependenciesDropped ()
 Called after SDK_OnUnload, once all dependencies have been removed, and the extension is about to be removed from memory.
 
virtual bool SDK_OnMetamodLoad (ISmmAPI *ismm, char *error, size_t maxlength, bool late)
 Called when Metamod is attached, before the extension version is called. More...
 
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. More...
 
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. More...
 
virtual bool OnExtensionLoad (IExtension *me, IShareSys *sys, char *error, size_t maxlength, bool late)
 Called when the extension is loaded. More...
 
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. More...
 
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 void OnDependenciesDropped ()
 
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)
 
- Public Member Functions inherited from SourceMod::IExtensionInterface
virtual unsigned int GetExtensionVersion ()
 
virtual bool QueryInterfaceDrop (SMInterface *pInterface)
 Asks the extension whether it's safe to remove an external interface it's using. If it's not safe, return false, and the extension will be unloaded afterwards. More...
 
virtual void NotifyInterfaceDrop (SMInterface *pInterface)
 Notifies the extension that an external interface it uses is being removed. More...
 
virtual bool QueryRunning (char *error, size_t maxlength)
 Return false to tell Core that your extension should be considered unusable. More...
 
virtual void OnCoreMapStart (edict_t *pEdictList, int edictCount, int clientMax)
 Called on server activation before plugins receive the OnServerLoad forward. More...
 
virtual void OnCoreMapEnd ()
 Called on level shutdown.
 

Constructor & Destructor Documentation

SDKExtension::SDKExtension ( )

Constructor

Member Function Documentation

const char * SDKExtension::GetAuthor ( )
virtual

Returns the author to MM

const char * SDKExtension::GetDate ( )
virtual

Returns the date string to MM

const char * SDKExtension::GetDescription ( )
virtual

Returns the description to MM

const char * SDKExtension::GetExtensionAuthor ( )
virtual

Returns author

Implements SourceMod::IExtensionInterface.

const char * SDKExtension::GetExtensionDateString ( )
virtual

Returns date string

Implements SourceMod::IExtensionInterface.

const char * SDKExtension::GetExtensionDescription ( )
virtual

Returns description string

Implements SourceMod::IExtensionInterface.

const char * SDKExtension::GetExtensionName ( )
virtual

Returns name

Implements SourceMod::IExtensionInterface.

const char * SDKExtension::GetExtensionTag ( )
virtual

Returns log tag

Implements SourceMod::IExtensionInterface.

const char * SDKExtension::GetExtensionURL ( )
virtual

Returns URL

Implements SourceMod::IExtensionInterface.

const char * SDKExtension::GetExtensionVerString ( )
virtual

Returns version string

Implements SourceMod::IExtensionInterface.

const char * SDKExtension::GetLicense ( )
virtual

Returns the license to MM

const char * SDKExtension::GetLogTag ( )
virtual

Returns the logtag to MM

const char * SDKExtension::GetName ( )
virtual

Returns the name to MM

const char * SDKExtension::GetURL ( )
virtual

Returns the URL to MM

const char * SDKExtension::GetVersion ( )
virtual

Returns the version string to MM

bool SDKExtension::IsMetamodExtension ( )
virtual

Returns whether or not this is a Metamod-based extension

Implements SourceMod::IExtensionInterface.

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

Called when the extension is attached to Metamod.

void SDKExtension::OnDependenciesDropped ( )
virtual

Called after OnExtensionUnload, once dependencies have been dropped.

Reimplemented from SourceMod::IExtensionInterface.

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

Called when the extension is loaded.

Parameters
mePointer back to extension.
sysPointer to interface sharing system of SourceMod.
errorError buffer to print back to, if any.
maxlengthMaximum size of error buffer.
lateIf this extension was loaded "late" (i.e. manually).
Returns
True if load should continue, false otherwise.

Implements SourceMod::IExtensionInterface.

void SDKExtension::OnExtensionPauseChange ( bool  state)
virtual

Called when the pause state changes.

Parameters
stateTrue if being paused, false if being unpaused.

Implements SourceMod::IExtensionInterface.

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

Called on pause

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

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

Parameters
errorError message buffer.
maxlengthSize of error message buffer.
lateWhether or not the module was loaded after map load.
Returns
True to succeed loading, false to fail.
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
errorError buffer.
maxlengthMaximum size of error buffer.
lateWhether or not Metamod considers this a late load.
Returns
True to succeed, false to fail.
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
pausedPause state being set.
errorError buffer.
maxlengthMaximum size of error buffer.
Returns
True to succeed, false to fail.
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
errorError buffer.
maxlengthMaximum size of error buffer.
Returns
True to succeed, false to fail.
bool SDKExtension::Unload ( char *  error,
size_t  maxlength 
)
virtual

Called on unload

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

Called on unpause


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