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

#include <Scripts.h>

Inherits MemoryPoolObject.

Public Types

enum  ParameterType {
  INT =0 , REAL , SCRIPT , TEAM ,
  COUNTER , FLAG , COMPARISON , WAYPOINT ,
  BOOLEAN , TRIGGER_AREA , TEXT_STRING , SIDE ,
  SOUND , SCRIPT_SUBROUTINE , UNIT , OBJECT_TYPE ,
  COORD3D , ANGLE , TEAM_STATE , RELATION ,
  AI_MOOD , DIALOG , MUSIC , MOVIE ,
  WAYPOINT_PATH , LOCALIZED_TEXT , BRIDGE , KIND_OF_PARAM ,
  ATTACK_PRIORITY_SET , RADAR_EVENT_TYPE , SPECIAL_POWER , SCIENCE ,
  UPGRADE , COMMANDBUTTON_ABILITY , BOUNDARY , BUILDABLE ,
  SURFACES_ALLOWED , SHAKE_INTENSITY , COMMAND_BUTTON , FONT_NAME ,
  OBJECT_STATUS , COMMANDBUTTON_ALL_ABILITIES , SKIRMISH_WAYPOINT_PATH , COLOR ,
  EMOTICON , OBJECT_PANEL_FLAG , FACTION_NAME , OBJECT_TYPE_LIST ,
  REVEALNAME , SCIENCE_AVAILABILITY , LEFT_OR_RIGHT , PERCENT ,
  NUM_ITEMS
}
 
enum  {
  LESS_THAN = 0 , LESS_EQUAL , EQUAL , GREATER_EQUAL ,
  GREATER , NOT_EQUAL
}
 
enum  { REL_ENEMY = ENEMIES , REL_NEUTRAL = NEUTRAL , REL_FRIEND = ALLIES }
 

Public Member Functions

 Parameter (ParameterType type, int val=0)
 
Int getInt (void) const
 
Real getReal (void) const
 
void getCoord3D (Coord3D *pLoc) const
 
ParameterType getParameterType (void) const
 
ObjectStatusMaskType getStatus () const
 
void friend_setInt (Int i)
 
void friend_setReal (Real r)
 
void friend_setCoord3D (const Coord3D *pLoc)
 
void friend_setString (AsciiString s)
 
void qualify (const AsciiString &qualifier, const AsciiString &playerTemplateName, const AsciiString &newPlayerName)
 
const AsciiString & getString (void) const
 
AsciiString getUiText (void) const
 
void WriteParameter (DataChunkOutput &chunkWriter)
 
- Public Member Functions inherited from MemoryPoolObject
void deleteInstance ()
 

Static Public Member Functions

static Parameter * ReadParameter (DataChunkInput &file)
 

Protected Member Functions

void setInt (Int i)
 
void setReal (Real r)
 
void setCoord3D (const Coord3D *pLoc)
 
void setString (AsciiString s)
 
void setStatus (ObjectStatusMaskType objectStatus)
 
- Protected Member Functions inherited from MemoryPoolObject
virtual ~MemoryPoolObject ()
 
void * operator new (size_t s)
 
void operator delete (void *p)
 
virtual MemoryPool * getObjectMemoryPool ()=0
 

Detailed Description

This is a parameter, in either a condition or an action.

Definition at line 713 of file Scripts.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
LESS_THAN 
LESS_EQUAL 
EQUAL 
GREATER_EQUAL 
GREATER 
NOT_EQUAL 

Definition at line 782 of file Scripts.h.

◆ anonymous enum

anonymous enum
Enumerator
REL_ENEMY 
REL_NEUTRAL 
REL_FRIEND 

Definition at line 791 of file Scripts.h.

◆ ParameterType

enum Parameter::ParameterType
Enumerator
INT 
REAL 
SCRIPT 
TEAM 
COUNTER 
FLAG 
COMPARISON 
WAYPOINT 
BOOLEAN 
TRIGGER_AREA 
TEXT_STRING 
SIDE 
SOUND 
SCRIPT_SUBROUTINE 
UNIT 
OBJECT_TYPE 
COORD3D 
ANGLE 
TEAM_STATE 
RELATION 
AI_MOOD 
DIALOG 
MUSIC 
MOVIE 
WAYPOINT_PATH 
LOCALIZED_TEXT 
BRIDGE 
KIND_OF_PARAM 
ATTACK_PRIORITY_SET 
RADAR_EVENT_TYPE 
SPECIAL_POWER 
SCIENCE 
UPGRADE 
COMMANDBUTTON_ABILITY 
BOUNDARY 
BUILDABLE 
SURFACES_ALLOWED 
SHAKE_INTENSITY 
COMMAND_BUTTON 
FONT_NAME 
OBJECT_STATUS 
COMMANDBUTTON_ALL_ABILITIES 
SKIRMISH_WAYPOINT_PATH 
COLOR 
EMOTICON 
OBJECT_PANEL_FLAG 
FACTION_NAME 
OBJECT_TYPE_LIST 
REVEALNAME 
SCIENCE_AVAILABILITY 
LEFT_OR_RIGHT 
PERCENT 
NUM_ITEMS 

Definition at line 725 of file Scripts.h.

Constructor & Destructor Documentation

◆ Parameter()

Parameter::Parameter ( ParameterType type,
int val = 0 )
inline

Definition at line 797 of file Scripts.h.

Member Function Documentation

◆ friend_setCoord3D()

void Parameter::friend_setCoord3D ( const Coord3D * pLoc)
inline

Definition at line 831 of file Scripts.h.

◆ friend_setInt()

void Parameter::friend_setInt ( Int i)
inline

Definition at line 829 of file Scripts.h.

◆ friend_setReal()

void Parameter::friend_setReal ( Real r)
inline

Definition at line 830 of file Scripts.h.

◆ friend_setString()

void Parameter::friend_setString ( AsciiString s)
inline

Definition at line 832 of file Scripts.h.

◆ getCoord3D()

void Parameter::getCoord3D ( Coord3D * pLoc) const

Definition at line 1807 of file Scripts.cpp.

◆ getInt()

Int Parameter::getInt ( void ) const
inline

Definition at line 823 of file Scripts.h.

◆ getParameterType()

ParameterType Parameter::getParameterType ( void ) const
inline

Definition at line 826 of file Scripts.h.

◆ getReal()

Real Parameter::getReal ( void ) const
inline

Definition at line 824 of file Scripts.h.

◆ getStatus()

ObjectStatusMaskType Parameter::getStatus ( ) const
inline

Definition at line 827 of file Scripts.h.

◆ getString()

const AsciiString & Parameter::getString ( void ) const
inline

Definition at line 836 of file Scripts.h.

◆ getUiText()

AsciiString Parameter::getUiText ( void ) const

Definition at line 1849 of file Scripts.cpp.

◆ qualify()

void Parameter::qualify ( const AsciiString & qualifier,
const AsciiString & playerTemplateName,
const AsciiString & newPlayerName )

otherwise drop down & qualify.

Definition at line 1824 of file Scripts.cpp.

◆ ReadParameter()

Parameter * Parameter::ReadParameter ( DataChunkInput & file)
static

Parameter::ReadParameter - read a parameter. Format is the newer CHUNKY format. See Parameter::WriteParameter for the writer. Input: DataChunkInput

Definition at line 2142 of file Scripts.cpp.

◆ setCoord3D()

void Parameter::setCoord3D ( const Coord3D * pLoc)
protected

Definition at line 1816 of file Scripts.cpp.

◆ setInt()

void Parameter::setInt ( Int i)
inlineprotected

Definition at line 816 of file Scripts.h.

◆ setReal()

void Parameter::setReal ( Real r)
inlineprotected

Definition at line 817 of file Scripts.h.

◆ setStatus()

void Parameter::setStatus ( ObjectStatusMaskType objectStatus)
inlineprotected

Definition at line 820 of file Scripts.h.

◆ setString()

void Parameter::setString ( AsciiString s)
inlineprotected

Definition at line 819 of file Scripts.h.

◆ WriteParameter()

void Parameter::WriteParameter ( DataChunkOutput & chunkWriter)

Parameter::WriteParameter - Writes an Parameter. Format is the newer CHUNKY format. Input: DataChunkInput

Definition at line 2115 of file Scripts.cpp.

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