Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
Squad Struct Reference

#include <Squad.h>

Inherits MemoryPoolObject, and Snapshot.

Public Member Functions

void addObject (Object *objectToAdd)
 
void addObjectID (ObjectID objectID)
 
void removeObject (Object *objectToRemove)
 
void clearSquad ()
 
const VecObjectPtr & getAllObjects (void)
 
const VecObjectPtr & getLiveObjects (void)
 
Int getSizeOfGroup (void) const
 
Bool isOnSquad (const Object *objToTest) const
 
void squadFromTeam (const Team *fromTeam, Bool clearSquadFirst)
 
void squadFromAIGroup (const AIGroup *fromAIGroup, Bool clearSquadFirst)
 
void aiGroupFromSquad (AIGroup *aiGroupToFill)
 
- Public Member Functions inherited from MemoryPoolObject
void deleteInstance ()
 
- Public Member Functions inherited from Snapshot
 Snapshot (void)
 
 ~Snapshot (void)
 

Public Attributes

unsigned long id
 
int sku
 
int members
 
int color1
 
int color2
 
int color3
 
int icon1
 
int icon2
 
int icon3
 
struct Squad __RPC_FAR * next
 
int rank
 
int team
 
int status
 
unsigned char email [81]
 
unsigned char icq [17]
 
unsigned char motto [81]
 
unsigned char url [129]
 
unsigned char name [41]
 
unsigned char abbreviation [41]
 

Protected Member Functions

virtual void crc (Xfer *xfer)
 
virtual void xfer (Xfer *xfer)
 
virtual void loadPostProcess (void)
 
- Protected Member Functions inherited from MemoryPoolObject
virtual ~MemoryPoolObject ()
 
void * operator new (size_t s)
 
void operator delete (void *p)
 
virtual MemoryPool * getObjectMemoryPool ()=0
 

Protected Attributes

VecObjectID m_objectIDs
 
VecObjectPtr m_objectsCached
 

Detailed Description

Definition at line 63 of file Squad.h.

Member Function Documentation

◆ addObject()

void Squad::addObject ( Object * objectToAdd)

Definition at line 58 of file Squad.cpp.

◆ addObjectID()

void Squad::addObjectID ( ObjectID objectID)

Definition at line 66 of file Squad.cpp.

◆ aiGroupFromSquad()

void Squad::aiGroupFromSquad ( AIGroup * aiGroupToFill)

Definition at line 182 of file Squad.cpp.

◆ clearSquad()

void Squad::clearSquad ( )

Definition at line 84 of file Squad.cpp.

◆ crc()

void Squad::crc ( Xfer * xfer)
protectedvirtual

CRC

Implements Snapshot.

Definition at line 198 of file Squad.cpp.

◆ getAllObjects()

const VecObjectPtr & Squad::getAllObjects ( void )

Definition at line 90 of file Squad.cpp.

◆ getLiveObjects()

const VecObjectPtr & Squad::getLiveObjects ( void )

Definition at line 108 of file Squad.cpp.

◆ getSizeOfGroup()

Int Squad::getSizeOfGroup ( void ) const

Definition at line 125 of file Squad.cpp.

◆ isOnSquad()

Bool Squad::isOnSquad ( const Object * objToTest) const

Definition at line 131 of file Squad.cpp.

◆ loadPostProcess()

void Squad::loadPostProcess ( void )
protectedvirtual

Load post process

Implements Snapshot.

Definition at line 268 of file Squad.cpp.

◆ removeObject()

void Squad::removeObject ( Object * objectToRemove)

Definition at line 71 of file Squad.cpp.

◆ squadFromAIGroup()

void Squad::squadFromAIGroup ( const AIGroup * fromAIGroup,
Bool clearSquadFirst )

Definition at line 168 of file Squad.cpp.

◆ squadFromTeam()

void Squad::squadFromTeam ( const Team * fromTeam,
Bool clearSquadFirst )

There should never be a TeamFromSqaud as Teams are entirely a construct to work with the AI. Since things can only be on one Team at a time, creating a Team from an arbitrary Squad will cause weird, difficult to reproduce bugs. Please don't do it.

Definition at line 151 of file Squad.cpp.

◆ xfer()

void Squad::xfer ( Xfer * xfer)
protectedvirtual

Xfer method Version Info: 1: Initial version

Implements Snapshot.

Definition at line 208 of file Squad.cpp.

Member Data Documentation

◆ abbreviation

unsigned char Squad::abbreviation[41]

Definition at line 594 of file wolapi.h.

◆ color1

int Squad::color1

Definition at line 579 of file wolapi.h.

◆ color2

int Squad::color2

Definition at line 580 of file wolapi.h.

◆ color3

int Squad::color3

Definition at line 581 of file wolapi.h.

◆ email

unsigned char Squad::email[81]

Definition at line 589 of file wolapi.h.

◆ icon1

int Squad::icon1

Definition at line 582 of file wolapi.h.

◆ icon2

int Squad::icon2

Definition at line 583 of file wolapi.h.

◆ icon3

int Squad::icon3

Definition at line 584 of file wolapi.h.

◆ icq

unsigned char Squad::icq[17]

Definition at line 590 of file wolapi.h.

◆ id

unsigned long Squad::id

Definition at line 576 of file wolapi.h.

◆ m_objectIDs

VecObjectID Squad::m_objectIDs
protected

Definition at line 73 of file Squad.h.

◆ m_objectsCached

VecObjectPtr Squad::m_objectsCached
protected

Definition at line 77 of file Squad.h.

◆ members

int Squad::members

Definition at line 578 of file wolapi.h.

◆ motto

unsigned char Squad::motto[81]

Definition at line 591 of file wolapi.h.

◆ name

unsigned char Squad::name[41]

Definition at line 593 of file wolapi.h.

◆ next

struct Squad __RPC_FAR* Squad::next

Definition at line 585 of file wolapi.h.

◆ rank

int Squad::rank

Definition at line 586 of file wolapi.h.

◆ sku

int Squad::sku

Definition at line 577 of file wolapi.h.

◆ status

int Squad::status

Definition at line 588 of file wolapi.h.

◆ team

int Squad::team

Definition at line 587 of file wolapi.h.

◆ url

unsigned char Squad::url[129]

Definition at line 592 of file wolapi.h.

The documentation for this struct was generated from the following files: