CVisualEffect Class¶

Overview
Quick Reference
Constructors
Methods

Overview¶

Note

The CVisualEffect class handles

The structure used for this class is CVisualEffect

Quick Reference¶

Quick Ref

void CVisualEffect::CVisualEffect()

virtual void CVisualEffect::~CVisualEffect()

void CVisualEffect::Activate(CGameArea* pArea, CPoint& pos, long height, unsigned char listType)

virtual void CVisualEffect::AIUpdate()

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

int CVisualEffect::CheckAndAdd(CResRef& vvcRes)

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

void CVisualEffect::Destroy()

virtual long __cdecl CVisualEffect::Load(CString name, CGameArea* pArea, CPoint& start, long targetId, CPoint& targetPos, long height, int linkToObject, long speed) = 0

void CVisualEffect::Move(CPoint& ptCurrDest)

void CVisualEffect::Remove(CResRef& vvcRes, unsigned char level)

virtual void CVisualEffect::RemoveFromArea()

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

void CVisualEffect::SetAllDelete()

void CVisualEffect::SetRenderMask()

Constructors¶

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

CVisualEffect::CVisualEffect¶

Constructs a CVisualEffect object

void CVisualEffect::CVisualEffect();

Remarks

Constructs a CVisualEffect object

CVisualEffect::~CVisualEffect¶

Destroys the CVisualEffect object

virtual void CVisualEffect::~CVisualEffect();

Remarks

Destroys the CVisualEffect object

Methods¶

Name	Description
CVisualEffect::Activate
CVisualEffect::AIUpdate
CVisualEffect::CanSaveGame
CVisualEffect::CheckAndAdd
CVisualEffect::CompressTime
CVisualEffect::Destroy
CVisualEffect::Load
CVisualEffect::Move
CVisualEffect::Remove
CVisualEffect::RemoveFromArea
CVisualEffect::Render
CVisualEffect::SetAllDelete
CVisualEffect::SetRenderMask

CVisualEffect::Activate¶

void CVisualEffect::Activate(
   CGameArea* pArea,
   CPoint& pos,
   long height,
   unsigned char listType);

Parameters

CGameArea* pArea -
CPoint& pos -
long height -
unsigned char listType -

Remarks

CVisualEffect::AIUpdate¶

virtual void CVisualEffect::AIUpdate();

Remarks

CVisualEffect::CanSaveGame¶

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

Parameters

unsigned long& strError -
int restCheck -
int combatCheck -

Return Value

Returns unsigned char

Remarks

CVisualEffect::CheckAndAdd¶

int CVisualEffect::CheckAndAdd(CResRef& vvcRes);

Parameters

CResRef& vvcRes -

Return Value

Returns int

Remarks

CVisualEffect::CompressTime¶

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

Parameters

unsigned long deltaTime -

Return Value

Returns unsigned char

Remarks

CVisualEffect::Destroy¶

void CVisualEffect::Destroy();

Remarks

CVisualEffect::Load¶

virtual long __cdecl CVisualEffect::Load(
   CString name,
   CGameArea* pArea,
   CPoint& start,
   long targetId,
   CPoint& targetPos,
   long height,
   int linkToObject,
   long speed);

Parameters

CString name -
CGameArea* pArea -
CPoint& start -
long targetId -
CPoint& targetPos -
long height -
int linkToObject -
long speed -

Return Value

Returns long

Remarks

CVisualEffect::Move¶

void CVisualEffect::Move(CPoint& ptCurrDest);

Parameters

CPoint& ptCurrDest -

Remarks

CVisualEffect::Remove¶

void CVisualEffect::Remove(
   CResRef& vvcRes,
   unsigned char level);

Parameters

CResRef& vvcRes -
unsigned char level -

Remarks

CVisualEffect::RemoveFromArea¶

virtual void CVisualEffect::RemoveFromArea();

Remarks

CVisualEffect::Render¶

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

Parameters

CGameArea* pArea -
CVidMode* pVidMode -

Remarks

CVisualEffect::SetAllDelete¶

void CVisualEffect::SetAllDelete();

Remarks

CVisualEffect::SetRenderMask¶

void CVisualEffect::SetRenderMask();

Remarks