SourceMod SDK  1.7
SourceMod::IGameConfig Class Referenceabstract

Describes a game private data config file. More...

#include <public/IGameConfigs.h>

Public Member Functions

virtual bool GetOffset (const char *key, int *value)=0
 Returns an offset value. More...
 
virtual SendProp * GetSendProp (const char *key)=0
 Returns information about a dynamic offset. More...
 
virtual const char * GetKeyValue (const char *key)=0
 Returns the value of a key from the "Keys" section. More...
 
virtual bool GetMemSig (const char *key, void **addr)=0
 Retrieves a cached memory signature. More...
 
virtual bool GetAddress (const char *key, void **addr)=0
 Retrieves the value of an address from the "Address" section. More...
 

Detailed Description

Describes a game private data config file.

Member Function Documentation

virtual bool SourceMod::IGameConfig::GetAddress ( const char *  key,
void **  addr 
)
pure virtual

Retrieves the value of an address from the "Address" section.

Parameters
keyKey to retrieve from the Address section.
addrPointer to store the memory address.
Returns
True on success, false on failure.
virtual const char* SourceMod::IGameConfig::GetKeyValue ( const char *  key)
pure virtual

Returns the value of a key from the "Keys" section.

Parameters
keyKey to retrieve from the Keys section.
Returns
String containing the value, or NULL if not found.
virtual bool SourceMod::IGameConfig::GetMemSig ( const char *  key,
void **  addr 
)
pure virtual

Retrieves a cached memory signature.

Parameters
keyName of the signature.
addrPointer to store the memory address in. (NULL is copied if signature is not found in binary).
Returns
True if the section exists and key for current platform was found, false otherwise.
virtual bool SourceMod::IGameConfig::GetOffset ( const char *  key,
int *  value 
)
pure virtual

Returns an offset value.

Parameters
keyKey to retrieve from the offset section.
valuePointer to store the offset value in.
Returns
True if found, false otherwise.
virtual SendProp* SourceMod::IGameConfig::GetSendProp ( const char *  key)
pure virtual

Returns information about a dynamic offset.

Parameters
keyKey to retrieve from the property section.
Returns
A SendProp pointer, or NULL if not found.

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