CGameTrigger Class¶

The structure used for this class is CGameTrigger

Quick Ref

void CGameTrigger::CGameTrigger(CGameArea* pArea, CAreaFileTriggerObject* pTriggerObject, CAreaPoint* pPoints, unsigned short maxPts)

virtual void CGameTrigger::AIUpdate()

virtual void CGameTrigger::AddEffect(CGameEffect* pEffect, unsigned char list, int noSave, int immediateApply)

virtual unsigned char CGameTrigger::CanSaveGame(unsigned long& strError, int restCheck, int combatCheck)

virtual unsigned char CGameTrigger::CompressTime(unsigned long deltaTime)

virtual void CGameTrigger::DebugDump(CString& message, unsigned char bEchoToScreen)

virtual unsigned char CGameTrigger::DoAIUpdate(unsigned char active, long counter)

virtual CRect CGameTrigger::GetBounding()

unsigned short CGameTrigger::GetTrapActivated()

virtual int CGameTrigger::IsOver(CPoint& pt)

virtual int CGameTrigger::IsOverActivate(CPoint& pt)

void CGameTrigger::Marshal(STriggerObjectWrapper* pTriggerWrapper)

virtual void CGameTrigger::OnActionButton(CPoint& pt)

virtual void CGameTrigger::RemoveFromArea()

virtual void CGameTrigger::Render(CGameArea* pArea, CVidMode* pVidMode)

virtual void CGameTrigger::SetCursor(long nToolTip)

void CGameTrigger::SetDrawPoly(short time)

Constructors¶

Name	Description
CGameTrigger::CGameTrigger	Constructs a `CGameTrigger` object

CGameTrigger::CGameTrigger¶

Constructs a CGameTrigger object

void CGameTrigger::CGameTrigger(
   CGameArea* pArea,
   CAreaFileTriggerObject* pTriggerObject,
   CAreaPoint* pPoints,
   unsigned short maxPts);

Parameters

CGameArea* pArea - pointer to area
CAreaFileTriggerObject* pTriggerObject - pointer to trigger object
CAreaPoint* pPoints - pointer to array of points
unsigned short maxPts - count of points in array

Remarks

Constructs a CGameTrigger object

Methods¶

Name	Description
CGameTrigger::AIUpdate
CGameTrigger::AddEffect
CGameTrigger::CanSaveGame
CGameTrigger::CompressTime
CGameTrigger::DebugDump
CGameTrigger::DoAIUpdate
CGameTrigger::GetBounding
CGameTrigger::GetTrapActivated
CGameTrigger::IsOver
CGameTrigger::IsOverActivate
CGameTrigger::Marshal
CGameTrigger::OnActionButton
CGameTrigger::RemoveFromArea
CGameTrigger::Render
CGameTrigger::SetCursor
CGameTrigger::SetDrawPoly

CGameTrigger::AIUpdate¶

virtual void CGameTrigger::AIUpdate();

Remarks

CGameTrigger::AddEffect¶

Add a game effect to a trigger object

virtual void CGameTrigger::AddEffect(
   CGameEffect* pEffect,
   unsigned char list,
   int noSave,
   int immediateApply);

Parameters

CGameEffect* pEffect - pointer to game effect to add to trigger
unsigned char list -
int noSave - if a saving throw is allowed to avoid or reduce damage caused by effect
int immediateApply - if the effect is immediate or delayed

Remarks

CGameTrigger::CanSaveGame¶

virtual unsigned char CGameTrigger::CanSaveGame(
   unsigned long& strError,
   int restCheck,
   int combatCheck);

Parameters

unsigned long& strError* -
int restCheck* -
int combatCheck* -

Return Value

Returns unsigned char

Remarks

CGameTrigger::CompressTime¶

virtual unsigned char CGameTrigger::CompressTime(unsigned long deltaTime);

Parameters

unsigned long deltaTime -

Return Value

Returns unsigned char

Remarks

CGameTrigger::DebugDump¶

Debug message from CGameTrigger class

virtual void CGameTrigger::DebugDump(
   CString& message,
   unsigned char bEchoToScreen);

Parameters

CString& message - debug message to output to console
unsigned char bEchoToScreen - output debug message to screen as well as console

Remarks

CGameTrigger::DoAIUpdate¶

virtual unsigned char CGameTrigger::DoAIUpdate(
   unsigned char active,
   long counter);

Parameters

unsigned char active -
long counter -

Return Value

Returns unsigned char

Remarks

CGameTrigger::GetBounding¶

Get the bounding rectangle for the trigger object

virtual CRect CGameTrigger::GetBounding();

Return Value

Returns a CRect which defines the bounding dimensions of the trigger object

Remarks

CGameTrigger::GetTrapActivated¶

unsigned short CGameTrigger::GetTrapActivated();

Return Value

Returns short

Remarks

CGameTrigger::IsOver¶

Determines if mouse position is over the trigger object

virtual int CGameTrigger::IsOver(CPoint& pt);

Parameters

CPoint& pt - x and y coordinate of mouse position

Return Value

Returns int

Remarks

CGameTrigger::IsOverActivate¶

Determines if mouse position is over the trigger object and the trigger is activated

virtual int CGameTrigger::IsOverActivate(CPoint& pt);

Parameters

CPoint& pt - x and y coordinate of mouse position

Return Value

Returns int

Remarks

CGameTrigger::Marshal¶

void CGameTrigger::Marshal(STriggerObjectWrapper* pTriggerWrapper);

Parameters

STriggerObjectWrapper* pTriggerWrapper -

Remarks

CGameTrigger::OnActionButton¶

virtual void CGameTrigger::OnActionButton(CPoint& pt);

Parameters

CPoint& pt - x and y coordinate of mouse position

Remarks

CGameTrigger::RemoveFromArea¶

virtual void CGameTrigger::RemoveFromArea();

Remarks

CGameTrigger::Render¶

virtual void CGameTrigger::Render(
   CGameArea* pArea,
   CVidMode* pVidMode);

Parameters

CGameArea* pArea - pointer to area
CVidMode* pVidMode - pointer to vid mode

Remarks

CGameTrigger::SetCursor¶

virtual void CGameTrigger::SetCursor(long nToolTip);

Parameters

long nToolTip -

Remarks

CGameTrigger::SetDrawPoly¶

void CGameTrigger::SetDrawPoly(short time);

Parameters

short time -

Remarks