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 | List of all members
ParameterClass Class Referenceabstract

#include <parameter.h>

Inherited by SimpleParameterClass< bool, ParameterClass::TYPE_BOOL >, SimpleParameterClass< Vector2, ParameterClass::TYPE_VECTOR2 >, SimpleParameterClass< Vector3, ParameterClass::TYPE_VECTOR3 >, SimpleParameterClass< Matrix3D, ParameterClass::TYPE_MATRIX3D >, SimpleParameterClass< RectClass, ParameterClass::TYPE_RECT >, SimpleParameterClass< Vector3, ParameterClass::TYPE_COLOR >, SimpleParameterClass< int, ParameterClass::TYPE_STRINGSDB_ID >, SimpleParameterClass< float, type >, SimpleParameterClass< int, type >, DefIDListParameterClass, DefParameterClass, EnumParameterClass, FilenameListParameterClass, ModelDefParameterClass, PhysDefParameterClass, ScriptListParameterClass, ScriptParameterClass, SeparatorParameterClass, SimpleParameterClass< T, type >, StringParameterClass, and ZoneParameterClass.

Public Types

enum  Type {
  TYPE_INT = 0 , TYPE_FLOAT , TYPE_STRING , TYPE_VECTOR3 ,
  TYPE_MATRIX3D , TYPE_BOOL , TYPE_TRANSITION , TYPE_MODELDEFINITIONID ,
  TYPE_FILENAME , TYPE_ENUM , TYPE_GAMEOBJDEFINITIONID , TYPE_SCRIPT ,
  TYPE_SOUND_FILENAME , TYPE_ANGLE , TYPE_WEAPONOBJDEFINITIONID , TYPE_AMMOOBJDEFINITIONID ,
  TYPE_SOUNDDEFINITIONID , TYPE_COLOR , TYPE_PHYSDEFINITIONID , TYPE_EXPLOSIONDEFINITIONID ,
  TYPE_DEFINITIONIDLIST , TYPE_ZONE , TYPE_FILENAMELIST , TYPE_SEPARATOR ,
  TYPE_GENERICDEFINITIONID , TYPE_SCRIPTLIST , TYPE_VECTOR2 , TYPE_RECT ,
  TYPE_TEXTURE_FILENAME , TYPE_STRINGSDB_ID
}
 

Public Member Functions

 ParameterClass (void)
 
 ParameterClass (const ParameterClass &src)
 
virtual ~ParameterClass (void)
 
const ParameterClass & operator= (const ParameterClass &src)
 
virtual bool operator== (const ParameterClass &src)=0
 
virtual DefParameterClass * As_DefParameterClass (void)
 
virtual Type Get_Type (void) const =0
 
virtual bool Is_Type (Type type) const
 
virtual bool Is_Modifed (void) const
 
virtual void Set_Modified (bool onoff=true)
 
virtual const char * Get_Name (void) const
 
virtual void Set_Name (const char *new_name)
 
virtual const char * Get_Units_Name (void) const
 
virtual void Set_Units_Name (const char *units_name)
 
virtual void Copy_Value (const ParameterClass &src)
 

Static Public Member Functions

static ParameterClass * Construct (ParameterClass::Type type, void *data, const char *param_name)
 

Detailed Description

Definition at line 68 of file parameter.h.

Member Enumeration Documentation

◆ Type

enum ParameterClass::Type
Enumerator
TYPE_INT 
TYPE_FLOAT 
TYPE_STRING 
TYPE_VECTOR3 
TYPE_MATRIX3D 
TYPE_BOOL 
TYPE_TRANSITION 
TYPE_MODELDEFINITIONID 
TYPE_FILENAME 
TYPE_ENUM 
TYPE_GAMEOBJDEFINITIONID 
TYPE_SCRIPT 
TYPE_SOUND_FILENAME 
TYPE_ANGLE 
TYPE_WEAPONOBJDEFINITIONID 
TYPE_AMMOOBJDEFINITIONID 
TYPE_SOUNDDEFINITIONID 
TYPE_COLOR 
TYPE_PHYSDEFINITIONID 
TYPE_EXPLOSIONDEFINITIONID 
TYPE_DEFINITIONIDLIST 
TYPE_ZONE 
TYPE_FILENAMELIST 
TYPE_SEPARATOR 
TYPE_GENERICDEFINITIONID 
TYPE_SCRIPTLIST 
TYPE_VECTOR2 
TYPE_RECT 
TYPE_TEXTURE_FILENAME 
TYPE_STRINGSDB_ID 

Definition at line 72 of file parameter.h.

Constructor & Destructor Documentation

◆ ParameterClass() [1/2]

ParameterClass::ParameterClass ( void )
inline

Definition at line 168 of file parameter.h.

◆ ParameterClass() [2/2]

ParameterClass::ParameterClass ( const ParameterClass & src)
inline

Definition at line 179 of file parameter.h.

◆ ~ParameterClass()

ParameterClass::~ParameterClass ( void )
inlinevirtual

Definition at line 191 of file parameter.h.

Member Function Documentation

◆ As_DefParameterClass()

virtual DefParameterClass * ParameterClass::As_DefParameterClass ( void )
inlinevirtual

Reimplemented in DefParameterClass.

Definition at line 125 of file parameter.h.

◆ Construct()

ParameterClass * ParameterClass::Construct ( ParameterClass::Type type,
void * data,
const char * param_name )
static

Definition at line 56 of file parameter.cpp.

◆ Copy_Value()

virtual void ParameterClass::Copy_Value ( const ParameterClass & src)
inlinevirtual

Reimplemented in AmmoObjDefParameterClass, DefIDListParameterClass, DefParameterClass, EnumParameterClass, ExplosionObjDefParameterClass, FilenameListParameterClass, FilenameParameterClass, GameObjDefParameterClass, GenericDefParameterClass, ModelDefParameterClass, PhysDefParameterClass, ScriptListParameterClass, ScriptParameterClass, SeparatorParameterClass, SimpleParameterClass< T, type >, SimpleParameterClass< bool, ParameterClass::TYPE_BOOL >, SimpleParameterClass< bool, ParameterClass::TYPE_BOOL >, SimpleParameterClass< float, type >, SimpleParameterClass< int, ParameterClass::TYPE_STRINGSDB_ID >, SimpleParameterClass< int, ParameterClass::TYPE_STRINGSDB_ID >, SimpleParameterClass< int, type >, SimpleParameterClass< Matrix3D, ParameterClass::TYPE_MATRIX3D >, SimpleParameterClass< Matrix3D, ParameterClass::TYPE_MATRIX3D >, SimpleParameterClass< RectClass, ParameterClass::TYPE_RECT >, SimpleParameterClass< RectClass, ParameterClass::TYPE_RECT >, SimpleParameterClass< Vector2, ParameterClass::TYPE_VECTOR2 >, SimpleParameterClass< Vector2, ParameterClass::TYPE_VECTOR2 >, SimpleParameterClass< Vector3, ParameterClass::TYPE_COLOR >, SimpleParameterClass< Vector3, ParameterClass::TYPE_COLOR >, SimpleParameterClass< Vector3, ParameterClass::TYPE_VECTOR3 >, SimpleParameterClass< Vector3, ParameterClass::TYPE_VECTOR3 >, StringParameterClass, TextureFilenameParameterClass, WeaponObjDefParameterClass, and ZoneParameterClass.

Definition at line 144 of file parameter.h.

◆ Get_Name()

const char * ParameterClass::Get_Name ( void ) const
inlinevirtual

Definition at line 212 of file parameter.h.

◆ Get_Type()

virtual Type ParameterClass::Get_Type ( void ) const
pure virtual

Implemented in AmmoObjDefParameterClass, DefIDListParameterClass, EnumParameterClass, ExplosionObjDefParameterClass, FilenameListParameterClass, FilenameParameterClass, GameObjDefParameterClass, GenericDefParameterClass, ModelDefParameterClass, PhysDefParameterClass, ScriptListParameterClass, ScriptParameterClass, SeparatorParameterClass, SimpleParameterClass< T, type >, SimpleParameterClass< bool, ParameterClass::TYPE_BOOL >, SimpleParameterClass< bool, ParameterClass::TYPE_BOOL >, SimpleParameterClass< float, type >, SimpleParameterClass< int, ParameterClass::TYPE_STRINGSDB_ID >, SimpleParameterClass< int, ParameterClass::TYPE_STRINGSDB_ID >, SimpleParameterClass< int, type >, SimpleParameterClass< Matrix3D, ParameterClass::TYPE_MATRIX3D >, SimpleParameterClass< Matrix3D, ParameterClass::TYPE_MATRIX3D >, SimpleParameterClass< RectClass, ParameterClass::TYPE_RECT >, SimpleParameterClass< RectClass, ParameterClass::TYPE_RECT >, SimpleParameterClass< Vector2, ParameterClass::TYPE_VECTOR2 >, SimpleParameterClass< Vector2, ParameterClass::TYPE_VECTOR2 >, SimpleParameterClass< Vector3, ParameterClass::TYPE_COLOR >, SimpleParameterClass< Vector3, ParameterClass::TYPE_COLOR >, SimpleParameterClass< Vector3, ParameterClass::TYPE_VECTOR3 >, SimpleParameterClass< Vector3, ParameterClass::TYPE_VECTOR3 >, SoundDefParameterClass, SoundFilenameParameterClass, StringParameterClass, TextureFilenameParameterClass, WeaponObjDefParameterClass, and ZoneParameterClass.

◆ Get_Units_Name()

const char * ParameterClass::Get_Units_Name ( void ) const
inlinevirtual

Definition at line 240 of file parameter.h.

◆ Is_Modifed()

virtual bool ParameterClass::Is_Modifed ( void ) const
inlinevirtual

Definition at line 132 of file parameter.h.

◆ Is_Type()

virtual bool ParameterClass::Is_Type ( Type type) const
inlinevirtual

Reimplemented in AmmoObjDefParameterClass, DefIDListParameterClass, EnumParameterClass, ExplosionObjDefParameterClass, FilenameListParameterClass, FilenameParameterClass, GameObjDefParameterClass, GenericDefParameterClass, ModelDefParameterClass, PhysDefParameterClass, ScriptListParameterClass, ScriptParameterClass, SeparatorParameterClass, SoundDefParameterClass, SoundFilenameParameterClass, StringParameterClass, TextureFilenameParameterClass, WeaponObjDefParameterClass, and ZoneParameterClass.

Definition at line 129 of file parameter.h.

◆ operator=()

const ParameterClass & ParameterClass::operator= ( const ParameterClass & src)
inline

Definition at line 201 of file parameter.h.

◆ operator==()

virtual bool ParameterClass::operator== ( const ParameterClass & src)
pure virtual

Implemented in AmmoObjDefParameterClass, DefIDListParameterClass, DefParameterClass, EnumParameterClass, ExplosionObjDefParameterClass, FilenameListParameterClass, FilenameParameterClass, GameObjDefParameterClass, GenericDefParameterClass, ModelDefParameterClass, PhysDefParameterClass, ScriptListParameterClass, ScriptParameterClass, SeparatorParameterClass, SimpleParameterClass< T, type >, SimpleParameterClass< bool, ParameterClass::TYPE_BOOL >, SimpleParameterClass< bool, ParameterClass::TYPE_BOOL >, SimpleParameterClass< float, type >, SimpleParameterClass< int, ParameterClass::TYPE_STRINGSDB_ID >, SimpleParameterClass< int, ParameterClass::TYPE_STRINGSDB_ID >, SimpleParameterClass< int, type >, SimpleParameterClass< Matrix3D, ParameterClass::TYPE_MATRIX3D >, SimpleParameterClass< Matrix3D, ParameterClass::TYPE_MATRIX3D >, SimpleParameterClass< RectClass, ParameterClass::TYPE_RECT >, SimpleParameterClass< RectClass, ParameterClass::TYPE_RECT >, SimpleParameterClass< Vector2, ParameterClass::TYPE_VECTOR2 >, SimpleParameterClass< Vector2, ParameterClass::TYPE_VECTOR2 >, SimpleParameterClass< Vector3, ParameterClass::TYPE_COLOR >, SimpleParameterClass< Vector3, ParameterClass::TYPE_COLOR >, SimpleParameterClass< Vector3, ParameterClass::TYPE_VECTOR3 >, SimpleParameterClass< Vector3, ParameterClass::TYPE_VECTOR3 >, SoundDefParameterClass, StringParameterClass, WeaponObjDefParameterClass, and ZoneParameterClass.

◆ Set_Modified()

virtual void ParameterClass::Set_Modified ( bool onoff = true)
inlinevirtual

Definition at line 133 of file parameter.h.

◆ Set_Name()

void ParameterClass::Set_Name ( const char * new_name)
inlinevirtual

Definition at line 221 of file parameter.h.

◆ Set_Units_Name()

void ParameterClass::Set_Units_Name ( const char * units_name)
inlinevirtual

Definition at line 249 of file parameter.h.

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