CGameStatic Class¶

The structure used for this class is CGameStatic

Quick Ref

void CGameStatic::CGameStatic(CGameArea* pArea, CAreaFileStaticObject* pStaticObject)

virtual void CGameStatic::~CGameStatic()

virtual void CGameStatic::AIUpdate()

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

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

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

void CGameStatic::Marshal(CAreaFileStaticObject** pStaticObject)

virtual void CGameStatic::RemoveFromArea()

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

void CGameStatic::RenderBam(CGameArea* pArea, CVidMode* pVidMode)

void CGameStatic::RenderPVR(CGameArea* pArea, CVidMode* pVidMode)

void CGameStatic::RenderWebm(CGameArea* pArea, CVidMode* pVidMode)

void CGameStatic::SetActivated(unsigned short active)

void CGameStatic::SetPalette(CResRef res)

Constructors¶

Name	Description
CGameStatic::CGameStatic	Constructs a `CGameStatic` object
CGameStatic::~CGameStatic	Destroys a `CGameStatic` object

CGameStatic::CGameStatic¶

Constructs a CGameStatic object

void CGameStatic::CGameStatic(
   CGameArea* pArea,
   CAreaFileStaticObject* pStaticObject);

Parameters

CGameArea* pArea -
CAreaFileStaticObject* pStaticObject -

Remarks

Constructs a CGameStatic object

CGameStatic::~CGameStatic¶

Destroys the CGameStatic object

virtual void CGameStatic::~CGameStatic();

Remarks

Destroys the CGameStatic object

Methods¶

Name	Description
CGameStatic::AIUpdate
CGameStatic::CanSaveGame
CGameStatic::CompressTime
CGameStatic::DoAIUpdate
CGameStatic::Marshal
CGameStatic::RemoveFromArea
CGameStatic::Render
CGameStatic::RenderBam	Render BAM image
CGameStatic::RenderPVR	Render PowerVR based image
CGameStatic::RenderWebm	Render WBM movie frame
CGameStatic::SetActivated
CGameStatic::SetPalette

CGameStatic::AIUpdate¶

virtual void CGameStatic::AIUpdate();

Remarks

CGameStatic::CanSaveGame¶

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

Parameters

unsigned long& strError -
int restCheck -
int combatCheck -

Return Value

Returns unsigned char

Remarks

CGameStatic::CompressTime¶

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

Parameters

unsigned long deltaTime -

Return Value

Returns unsigned char

Remarks

CGameStatic::DoAIUpdate¶

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

Parameters

unsigned char active -
long counter -

Return Value

Returns unsigned char

Remarks

CGameStatic::Marshal¶

void CGameStatic::Marshal(CAreaFileStaticObject** pStaticObject);

Parameters

CAreaFileStaticObject** pStaticObject -

Remarks

CGameStatic::RemoveFromArea¶

virtual void CGameStatic::RemoveFromArea();

Remarks

CGameStatic::Render¶

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

Parameters

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

Remarks

CGameStatic::RenderBam¶

Render BAM image

void CGameStatic::RenderBam(
   CGameArea* pArea,
   CVidMode* pVidMode);

Parameters

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

Remarks

CGameStatic::RenderPVR¶

Render PowerVR based image

void CGameStatic::RenderPVR(
   CGameArea* pArea,
   CVidMode* pVidMode);

Parameters

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

Remarks

Enhanced Edition games use PVR/PVRZ based MOS, TIS and BAM file formats

CGameStatic::RenderWebm¶

Render WBM movie frame

void CGameStatic::RenderWebm(
   CGameArea* pArea,
   CVidMode* pVidMode);

Parameters

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

Remarks

WebM is an audiovisual media file format. Movie files in the Enhanced Edition games use the .WBM extension

CGameStatic::SetActivated¶

void CGameStatic::SetActivated(unsigned short active);

Parameters

unsigned short active -

Remarks

CGameStatic::SetPalette¶

void CGameStatic::SetPalette(:ref:`CResRef<CResRef>` res);

Parameters

CResRef res -

Remarks