CAIGroup Class¶

Overview
Quick Reference
Methods

Overview¶

Note

The CAIGroup class handles group selection of party, characters and/or allied creatures

The structure used for this class is CAIGroup

Quick Reference¶

Quick Ref

POSITION* CAIGroup::Add(long spriteIndex)

void CAIGroup::Add(CGameSprite* pSprite)

void CAIGroup::AddEffect(CGameEffect* effect)

void CAIGroup::AddToSearch(CSearchBitmap* search)

void CAIGroup::AddTrigger(CAITrigger& trigger)

void CAIGroup::ClearActions()

void CAIGroup::FollowLeader(CPoint target, int additive)

short* CAIGroup::GetFacings(short formationType, short direction)

long CAIGroup::GetGroupLeader()

long* CAIGroup::GetGroupList()

CPoint* CAIGroup::GetOffsets(short formationType, short direction, unsigned char bFullParty)

void CAIGroup::GroupAction(CAIAction action, int override, CAIAction* leaderAction)

void CAIGroup::GroupCancelMove()

void CAIGroup::GroupDrawMove(CPoint target, short formationType, CPoint cursor)

void CAIGroup::GroupProtectPoint(CPoint target, short formationType, CPoint cursor, long range)

void CAIGroup::GroupSetTarget(long iObject)

void CAIGroup::GroupSetTarget(CPoint target, int additive, short formationType, CPoint cursor)

void CAIGroup::HandleFollowPath(long* pPath, short nPath, CPoint target, CPoint start, int additive)

int CAIGroup::InList(long index)

int CAIGroup::IsPartyLeader()

void CAIGroup::Remove(long id)

void CAIGroup::Remove(CGameSprite* pSprite)

void CAIGroup::RemoveFromSearch(CSearchBitmap* search)

virtual void __cdecl CAIGroup::RotateOffsets(CPoint* offsets, short numOffsets, short degreesOfRotation) = 0

void CAIGroup::SetGroupTriggerId(long triggerId)

void CAIGroup::Sort()

Methods¶

CAIGroup::Add¶

POSITION* CAIGroup::Add(long spriteIndex);

Parameters

long spriteIndex -

Return Value

POSITION

Remarks

CAIGroup::Add¶

void CAIGroup::Add(CGameSprite* pSprite);

Parameters

CGameSprite* pSprite -

Remarks

CAIGroup::AddEffect¶

void CAIGroup::AddEffect(CGameEffect* effect);

Parameters

CGameEffect* effect -

Remarks

CAIGroup::AddToSearch¶

void CAIGroup::AddToSearch(CSearchBitmap* search);

Parameters

CSearchBitmap* search -

Remarks

CAIGroup::AddTrigger¶

void CAIGroup::AddTrigger(CAITrigger& trigger);

Parameters

CAITrigger& trigger -

Remarks

CAIGroup::ClearActions¶

void CAIGroup::ClearActions();

Remarks

CAIGroup::FollowLeader¶

void CAIGroup::FollowLeader(
   CPoint target,
   int additive);

Parameters

CPoint target -
int additive -

Remarks

CAIGroup::GetFacings¶

short* CAIGroup::GetFacings(
   short formationType,
   short direction);

Parameters

short formationType -
short direction -

Return Value

short*

Remarks

CAIGroup::GetGroupLeader¶

long CAIGroup::GetGroupLeader();

Return Value

long

Remarks

CAIGroup::GetGroupList¶

long* CAIGroup::GetGroupList();

Return Value

long*

Remarks

CAIGroup::GetOffsets¶

CPoint* CAIGroup::GetOffsets(
   short formationType,
   short direction,
   unsigned char bFullParty);

Parameters

short formationType -
short direction -
unsigned char bFullParty -

Return Value

CPoint*

Remarks

CAIGroup::GroupAction¶

void CAIGroup::GroupAction(
   CAIAction action,
   int override,
   CAIAction* leaderAction);

Parameters

CAIAction action -
int override -
CAIAction* leaderAction -

Return Value

Remarks

CAIGroup::GroupCancelMove¶

void CAIGroup::GroupCancelMove();

Remarks

CAIGroup::GroupDrawMove¶

void CAIGroup::GroupDrawMove(
   CPoint target,
   short formationType,
   CPoint cursor);

Parameters

CPoint target -
short formationType -
CPoint cursor -

Remarks

CAIGroup::GroupProtectPoint¶

void CAIGroup::GroupProtectPoint(
   CPoint target,
   short formationType,
   CPoint cursor,
   long range);

Parameters

CPoint target -
short formationType -
CPoint cursor -
long range -

Remarks

CAIGroup::GroupSetTarget¶

void CAIGroup::GroupSetTarget(long iObject);

Parameters

long iObject -

Remarks

CAIGroup::GroupSetTarget¶

void CAIGroup::GroupSetTarget(
   CPoint target,
   int additive,
   short formationType,
   CPoint cursor);

Parameters

CPoint target -
int additive -
short formationType -
CPoint cursor -

Remarks

CAIGroup::HandleFollowPath¶

void CAIGroup::HandleFollowPath(
   long* pPath,
   short nPath,
   CPoint target,
   CPoint start,
   int additive);

Parameters

long* pPath -
short nPath -
CPoint target -
CPoint start -
int additive

Remarks

CAIGroup::InList¶

int CAIGroup::InList(long index);

Parameters

long index -

Return Value

int

Remarks

CAIGroup::IsPartyLeader¶

int CAIGroup::IsPartyLeader();

Return Value

int

Remarks

CAIGroup::Remove¶

void CAIGroup::Remove(long id);

Parameters

long id -

Remarks

CAIGroup::Remove¶

void CAIGroup::Remove(CGameSprite* pSprite);

Parameters

CGameSprite* pSprite -

Remarks

CAIGroup::RemoveFromSearch¶

void CAIGroup::RemoveFromSearch(CSearchBitmap* search);

Parameters

CSearchBitmap* search -

Remarks

CAIGroup::RotateOffsets¶

virtual void __cdecl CAIGroup::RotateOffsets(
   CPoint* offsets,
   short numOffsets,
   short degreesOfRotation);

Parameters

CPoint* offsets -
short numOffsets -
short degreesOfRotation -

Remarks

CAIGroup::SetGroupTriggerId¶

void CAIGroup::SetGroupTriggerId(long triggerId);

Parameters

long triggerId -

Remarks

CAIGroup::Sort¶

void CAIGroup::Sort();

Remarks