CGameDoor Class¶
The structure used for this class is CGameDoor
Quick Ref |
void CGameDoor::CGameDoor(CGameArea* pArea, CAreaFileDoorObject* pDoorObject, CAreaPoint* pPoints, unsigned short maxPts) |
virtual void CGameDoor::~CGameDoor() |
virtual void CGameDoor::AIUpdate() |
virtual void CGameDoor::AddEffect(CGameEffect* pEffect, unsigned char list, int noSave, int immediateApply) |
virtual unsigned char CGameDoor::CanSaveGame(unsigned long& strError, int restCheck, int combatCheck) |
virtual unsigned char CGameDoor::CompressTime(unsigned long deltaTime) |
virtual void CGameDoor::DebugDump(CString& message, unsigned char bEchoToScreen) |
virtual unsigned char CGameDoor::DoAIUpdate(unsigned char active, long counter) |
CRect CGameDoor::GetBoundingRectClosed() |
CRect CGameDoor::GetBoundingRectOpen() |
virtual int CGameDoor::IsOver(CPoint& pt) |
void CGameDoor::Marshal(SAreaFileDoorWrapper* pDoorWrapper) |
virtual void CGameDoor::OnActionButton(CPoint& pt) |
void CGameDoor::OnDoorStatusUpdate(unsigned char bDoorOpened, unsigned long dwFlags, unsigned short nTrapActivated, unsigned short nTrapDetected) |
virtual void CGameDoor::RemoveFromArea() |
virtual void CGameDoor::Render(CGameArea* pArea, CVidMode* pVidMode) |
virtual void CGameDoor::SetCursor(long nToolTip) |
void CGameDoor::SetDrawPoly(short time) |
void CGameDoor::ToggleDoor(CAIObjectType& user, int ignoreLocked) |
void CGameDoor::ToggleTransitionTrigger(int bClosed) |
Constructors¶
Name |
Description |
Constructs a |
|
Destroys a |
CGameDoor::CGameDoor¶
Constructs a CGameDoor
object
void CGameDoor::CGameDoor(
CGameArea* pArea,
CAreaFileDoorObject* pDoorObject,
CAreaPoint* pPoints,
unsigned short maxPts);
Parameters
CGameArea* pArea - pointer to area
CAreaFileDoorObject* pDoorObject - pointer to door object
CAreaPoint* pPoints - pointer to array of points used for polygon to highlight door
unsigned short
maxPts - count of points in array for polygon
Remarks
Constructs a CGameDoor
object
CGameDoor::~CGameDoor¶
Destroys the CGameDoor
object
virtual void CGameDoor::~CGameDoor();
Remarks
Destroys the CGameDoor
object
Methods¶
Name |
Description |
Add a game effect to a door |
|
Debug message from door class |
|
Get the bounding rectangle for the door when it is closed |
|
Get the bounding rectangle for the door when it is open |
|
Determines if mouse position is over the door |
|
Event action for when mouse is clicked on the door |
|
Set the cursor and tooltip when mouse is over the door |
|
Toggles door, opens door if it is currently closed, and closes if currently open |
|
CGameDoor::AIUpdate¶
virtual void CGameDoor::AIUpdate();
Remarks
CGameDoor::AddEffect¶
Add a game effect to a door
virtual void CGameDoor::AddEffect(
CGameEffect* pEffect,
unsigned char list,
int noSave,
int immediateApply);
Parameters
CGameEffect* pEffect - pointer to game effect to add to door
unsigned char
list -int
noSave - if a saving throw is allowed to avoid or reduce effect if trap is triggeredint
immediateApply - if the effect is immediate or delayed
Remarks
Used for setting trap effects on doors, eg. fireball, lightning, poison, or piercing, slashing damage etc
CGameDoor::CanSaveGame¶
virtual unsigned char CGameDoor::CanSaveGame(
unsigned long& strError,
int restCheck,
int combatCheck) ;
Parameters
unsigned long
& strError -int
restCheck -int
combatCheck -
Return Value
Remarks
CGameDoor::CompressTime¶
virtual unsigned char CGameDoor::CompressTime(unsigned long deltaTime);
Parameters
unsigned long
deltaTime -
Return Value
Remarks
CGameDoor::DebugDump¶
Debug message from door class
virtual void CGameDoor::DebugDump(
CString& message,
unsigned char bEchoToScreen);
Parameters
CString& message - address of debug message string to output to console
unsigned char
bEchoToScreen - output debug message to screen as well as console
Remarks
CGameDoor::DoAIUpdate¶
virtual unsigned char CGameDoor::DoAIUpdate(
unsigned char active,
long counter);
Parameters
unsigned char
active -long
counter -
Return Value
Remarks
CGameDoor::GetBoundingRectClosed¶
Get the bounding rectangle for the door when it is closed
CRect CGameDoor::GetBoundingRectClosed();
Return Value
Returns a CRect which defines the bounding dimensions of the closed door
Remarks
CGameDoor::GetBoundingRectOpen¶
Get the bounding rectangle for the door when it is open
CRect CGameDoor::GetBoundingRectOpen();
Return Value
Returns a CRect which defines the bounding dimensions of the open door
Remarks
CGameDoor::GetMoveDest¶
CPoint& CGameDoor::GetMoveDest\(CPoint& ptSource);
Parameters
CPoint& ptSource -
Return Value
Returns CPoint&
Remarks
CGameDoor::IsOver¶
Determines if mouse position is over the door
virtual int CGameDoor::IsOver(CPoint& pt);
Parameters
CPoint& pt - x and y coordinates of the mouse position
Return Value
Returns an int
value representing 1
true, or 0
false
Remarks
CGameDoor::Marshal¶
void CGameDoor::Marshal(SAreaFileDoorWrapper* pDoorWrapper);
Parameters
SAreaFileDoorWrapper* pDoorWrapper -
Remarks
CGameDoor::OnDoorStatusUpdate¶
void CGameDoor::OnDoorStatusUpdate(
unsigned char bDoorOpened,
unsigned long dwFlags,
unsigned short nTrapActivated,
unsigned short nTrapDetected);
Parameters
unsigned char
bDoorOpened -unsigned long
dwFlags -unsigned short
nTrapActivated -unsigned short
nTrapDetected -
Remarks
CGameDoor::RemoveFromArea¶
virtual void CGameDoor::RemoveFromArea();
Remarks
CGameDoor::Render¶
virtual void CGameDoor::Render(
CGameArea* pArea,
CVidMode* pVidMode);
Parameters
Remarks
CGameDoor::SetCursor¶
Set the cursor and tooltip when mouse is over the door
virtual void CGameDoor::SetCursor(long nToolTip);
Parameters
long
nToolTip - pointer to tooltip text?
Remarks
CGameDoor::SetDrawPoly¶
void CGameDoor::SetDrawPoly(short time);
Parameters
short
time -
Remarks
CGameDoor::ToggleDoor¶
Toggles door by the specified character, opens door if it is currently closed, and closes if currently open
void CGameDoor::ToggleDoor(
CAIObjectType& user,
int ignoreLocked);
Parameters
CAIObjectType& user - character that opens the door
int
ignoreLocked - true of false to ignore locked door
Remarks
CGameDoor::ToggleTransitionTrigger¶
void CGameDoor::ToggleTransitionTrigger(int bClosed);
Parameters
int
bClosed - true or false for door open or closed
Remarks