CGameEffectList Class

Note

See CGameEffect<Effect> Methods for methods that are shared by all game effect classes. Only the additional methods specific to each class are documented here.

Methods

Name	Description
CGameEffectList::CheckEffects
CGameEffectList::FakeExpireCheck
CGameEffectList::GetTypeOnList
CGameEffectList::HandleList
CGameEffectList::IsTypeOnList
CGameEffectList::Marshal
CGameEffectList::ModifyAllOfType
CGameEffectList::Remove
CGameEffectList::RemoveAllEffects
CGameEffectList::RemoveAllEffectsFromSourceRes
CGameEffectList::RemoveAllEffectsIgnoreMoreThenPermanent
CGameEffectList::RemoveAllOfSchool
CGameEffectList::RemoveAllOfSecondaryType
CGameEffectList::RemoveAllOfType
CGameEffectList::RemoveOneOfSchool
CGameEffectList::RemoveOneOfSecondaryType
CGameEffectList::RemoveOneOfType
CGameEffectList::Unmarshal

CGameEffectList::CheckEffects

int CGameEffectList::CheckEffects();

Return Value

Returns int

Remarks

CGameEffectList::FakeExpireCheck

void CGameEffectList::FakeExpireCheck(
   CGameSprite* pSprite,
   long elapsedTime);

Parameters

CGameSprite* pSprite - pointer to game sprite object
long elapsedTime -

Remarks

CGameEffectList::GetTypeOnList

CGameEffect* CGameEffectList::GetTypeOnList(
   unsigned short effectId,
   unsigned long flags);

Parameters

unsigned short effectId -
unsigned long flags -

Return Value

Returns CGameEffect*

Remarks

CGameEffectList::HandleList

int CGameEffectList::HandleList(CGameSprite* pSprite);

Parameters

CGameSprite* pSprite - pointer to game sprite object

Return Value

Returns int

Remarks

CGameEffectList::IsTypeOnList

unsigned char CGameEffectList::IsTypeOnList(
   unsigned short effectId,
   unsigned long flags);

Parameters

unsigned short effectId -
unsigned long flags -

Return Value

Returns unsigned char

Remarks

CGameEffectList::Marshal

unsigned long CGameEffectList::Marshal(
   unsigned char** ptrPtr,
   unsigned char version,
   int moreThenPermanentOnly,
   int stripEquiped);

Parameters

unsigned char** ptrPtr -
unsigned char version -
int moreThenPermanentOnly -
int stripEquiped -

Return Value

Returns unsigned long

Remarks

CGameEffectList::ModifyAllOfType

int CGameEffectList::ModifyAllOfType(
   unsigned short effectId,
   long newEffectAmount,
   int increment,
   unsigned long dwFlags,
   int useFlags,
   int moreThenPermanentOnly);

Parameters

unsigned short effectId -
long newEffectAmount -
int increment -
unsigned long dwFlags -
int useFlags -
int moreThenPermanentOnly -

Return Value

Returns int

Remarks

CGameEffectList::ModifyAllOfType

void CGameEffectList::ModifyAllOfType(
   CGameSprite* pSprite,
   unsigned short effectId,
   POSITION* posLeave,
   long effectAmount);

Parameters

CGameSprite* pSprite - pointer to game sprite object
unsigned short effectId -
POSITION* posLeave -
long effectAmount -

Return Value

Returns

Remarks

CGameEffectList::Remove

int CGameEffectList::Remove(
   CGameEffect* effect,
   CGameSprite* pSprite,
   int compareSourceType);

Parameters

CGameEffect* effect - pointer to game effect object
CGameSprite* pSprite - pointer to game sprite object
int compareSourceType* -

Return Value

Returns int

Remarks

CGameEffectList::RemoveAllEffects

void CGameEffectList::RemoveAllEffects(
   CGameSprite* pSprite,
   POSITION* posLeave,
   int checkDispellable,
   int useLevelDiff,
   unsigned char prob,
   unsigned char dispelLevel);

Parameters

CGameSprite* pSprite - pointer to game sprite object
POSITION* posLeave -
int checkDispellable -
int useLevelDiff -
unsigned char prob -
unsigned char dispelLevel -

Remarks

CGameEffectList::RemoveAllEffectsFromSourceRes

void CGameEffectList::RemoveAllEffectsFromSourceRes(
   CGameSprite* pSprite,
   POSITION* posLeave,
   CResRef& res);

Parameters

CGameSprite* pSprite - pointer to game sprite object
POSITION* posLeave -
CResRef& res - resource reference

Remarks

CGameEffectList::RemoveAllEffectsIgnoreMoreThenPermanent

void CGameEffectList::RemoveAllEffectsIgnoreMoreThenPermanent(
   CGameSprite* pSprite,
   POSITION* posLeave,
   int checkDispellable,
   int useLevelDiff,
   unsigned char prob,
   unsigned char dispelLevel);

Parameters

CGameSprite* pSprite - pointer to game sprite object
POSITION* posLeave -
int checkDispellable -
int useLevelDiff -
unsigned char prob -
unsigned char dispelLevel -

Remarks

CGameEffectList::RemoveAllOfSchool

int CGameEffectList::RemoveAllOfSchool(
   CGameSprite* pSprite,
   unsigned long school,
   POSITION* posLeave,
   long maxLevel,
   int& found);

Parameters

CGameSprite* pSprite - pointer to game sprite object
unsigned long school -
POSITION* posLeave -
long maxLevel -
int& found -

Return Value

Returns int

Remarks

CGameEffectList::RemoveAllOfSecondaryType

int CGameEffectList::RemoveAllOfSecondaryType(
   CGameSprite* pSprite,
   unsigned long secType,
   POSITION* posLeave,
   long maxLevel,
   int& found);

Parameters

CGameSprite* pSprite - pointer to game sprite object
unsigned long secType -
POSITION* posLeave -
long maxLevel -
int& found -

Return Value

Returns int

Remarks

CGameEffectList::RemoveAllOfType

void CGameEffectList::RemoveAllOfType(
   CGameSprite* pSprite,
   unsigned short effectId,
   POSITION* posLeave,
   long effectAmount,
   CResRef res,
   int leaveMoreThenPermanent);

Parameters

CGameSprite* pSprite - pointer to game sprite object
unsigned short effectId -
POSITION* posLeave -
long effectAmount -
CResRef res -
int leaveMoreThenPermanent -

Remarks

CGameEffectList::RemoveOneOfSchool

int CGameEffectList::RemoveOneOfSchool(
   CGameSprite* pSprite,
   unsigned long school,
   POSITION* posLeave,
   long maxLevel,
   int& found);

Parameters

CGameSprite* pSprite - pointer to game sprite object
unsigned long school -
POSITION* posLeave -
long maxLevel -
int& found -

Return Value

Returns int

Remarks

CGameEffectList::RemoveOneOfSecondaryType

int CGameEffectList::RemoveOneOfSecondaryType(
   CGameSprite* pSprite,
   unsigned long secType,
   POSITION* posLeave,
   long maxLevel,
   int& found);

Parameters

CGameSprite* pSprite - pointer to game sprite object
unsigned long secType -
POSITION* posLeave -
long maxLevel -
int& found -

Return Value

Returns int

Remarks

CGameEffectList::RemoveOneOfType

int CGameEffectList::RemoveOneOfType(
   CGameSprite* pSprite,
   unsigned short effectId,
   POSITION* posLeave,
   long effectAmount,
   CResRef res);

Parameters

CGameSprite* pSprite - pointer to game sprite object
unsigned short effectId -
POSITION* posLeave -
long effectAmount -
CResRef res -

Return Value

Returns int

Remarks

CGameEffectList::Unmarshal

void CGameEffectList::Unmarshal(
   unsigned char* data,
   unsigned long nSize,
   CGameSprite* pSprite,
   unsigned char version);

Parameters

unsigned char* data -
unsigned long nSize -
CGameSprite* pSprite - pointer to game sprite object
unsigned char version -

Remarks