CVariableHash Class¶

Overview
Quick Reference
Constructors
Methods

Overview¶

Note

The CVariableHash class handles the storing and retrieval of game tokens and variables in a hash table

The structure used for this class is CVariableHash

Quick Reference¶

Quick Ref

void CVariableHash::CVariableHash(long nSize)

void CVariableHash::~CVariableHash()

int CVariableHash::AddKey(CVariable& var)

void CVariableHash::ClearAll()

CVariable* CVariableHash::FindKey(CString inVarName)

int CVariableHash::Hash(CString name)

void CVariableHash::Marshal(CVariable** pList, unsigned short* pCount)

void CVariableHash::MarshalToCharacter(CGameSprite* pSprite)

void CVariableHash::Resize(long nSize)

Constructors¶

Name	Description
CVariableHash::CVariableHash	Constructs a `CVariableHash` object
CVariableHash::CVariableHash	Destroys a `CVariableHash` object

CVariableHash::CVariableHash¶

Constructs a CVariableHash object

void CVariableHash::CVariableHash();

Parameters

long nSize -

Remarks

Constructs a CVariableHash object

CVariableHash::~CVariableHash¶

Destroys the CVariableHash object

void CVariableHash::~CVariableHash();

Remarks

Destroys the CVariableHash object

Methods¶

Name	Description
CVariableHash::AddKey
CVariableHash::ClearAll
CVariableHash::FindKey
CVariableHash::Hash
CVariableHash::Marshal
CVariableHash::MarshalToCharacter
CVariableHash::Resize

CVariableHash::AddKey¶

Add a token or variable to the hash table

int CVariableHash::AddKey(CVariable& var);

Parameters

CVariable& var - address of variable to add

Return Value

Returns an int value

Remarks

CVariableHash::ClearAll¶

Clears all tokens and variables in the hash table

void CVariableHash::ClearAll();

Remarks

CVariableHash::FindKey¶

Locate and return a variable from the specified variable name

CVariable* CVariableHash::FindKey(:ref:`CString<CString>` inVarName);

Parameters

CString inVarName - string containing the name of the variable to find

Return Value

Returns CVariable*

Remarks

CVariableHash::Hash¶

Hash a token or variable name

int CVariableHash::Hash(CString name);

Parameters

CString name - string containing name of variable to hash

Return Value

Returns int

Remarks

CVariableHash::Marshal¶

void CVariableHash::Marshal(
   CVariable** pList,
   unsigned short* pCount);

Parameters

CVariable** pList - pointer to an array of pointers, each pointing to a variable
unsigned short* pCount - pointer to a short containing the count of pointers in pList

Remarks

CVariableHash::MarshalToCharacter¶

void CVariableHash::MarshalToCharacter(CGameSprite* pSprite);

Parameters

CGameSprite* pSprite - pointer to game sprite object

Remarks

CVariableHash::Resize¶

void CVariableHash::Resize(long nSize);

Parameters

long nSize -

Remarks