Public Member Functions

SourceMod::IGameConfig Class Reference

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

#include <public/IGameConfigs.h>

List of all members.

Public Member Functions

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

Detailed Description

Describes a game private data config file.

Definition at line 54 of file IGameConfigs.h.


Member Function Documentation

virtual bool SourceMod::IGameConfig::GetOffset ( const char *  key,
int *  value 
) [pure virtual]

Returns an offset value.

Parameters:
key Key to retrieve from the offset section.
value Pointer 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:
key Key to retrieve from the property section.
Returns:
A SendProp pointer, or NULL if not found.
virtual const char* SourceMod::IGameConfig::GetKeyValue ( const char *  key  )  [pure virtual]

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

Parameters:
key Key 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:
key Name of the signature.
addr Pointer to store the memory address in.
Returns:
True if the key was found, false otherwise. Note that true is a valid return even if the address is NULL.
virtual bool SourceMod::IGameConfig::GetAddress ( const char *  key,
void **  addr 
) [pure virtual]

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

Parameters:
key Key to retrieve from the Address section.
addr Pointer to store the memory address.
Returns:
True on success, false on failure.

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