Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
DefinitionClass Class Referenceabstract

#include <definition.h>

Inherits PersistClass, and EditableClass.

Inherited by AudibleSoundDefinitionClass, and TwiddlerClass.

Public Member Functions

 DECLARE_EDITABLE (DefinitionClass, EditableClass)
 
 DefinitionClass (void)
 
virtual ~DefinitionClass (void)
 
virtual uint32 Get_Class_ID (void) const =0
 
virtual uint32 Get_ID (void) const
 
virtual void Set_ID (uint32 id)
 
virtual PersistClassCreate (void) const =0
 
virtual const char * Get_Name (void) const
 
virtual void Set_Name (const char *new_name)
 
virtual bool Is_Valid_Config (StringClass &message)
 
virtual bool Save (ChunkSaveClass &csave)
 
virtual bool Load (ChunkLoadClass &cload)
 
uint32 Get_User_Data (void) const
 
void Set_User_Data (uint32 data)
 
bool Is_Save_Enabled (void) const
 
void Enable_Save (bool onoff)
 
- Public Member Functions inherited from PersistClass
virtual const PersistFactoryClassGet_Factory (void) const =0
 
- Public Member Functions inherited from PostLoadableClass
 PostLoadableClass (void)
 
virtual ~PostLoadableClass (void)
 
virtual void On_Post_Load (void)
 
bool Is_Post_Load_Registered (void)
 
void Set_Post_Load_Registered (bool onoff)
 
- Public Member Functions inherited from EditableClass
virtual int Get_Parameter_Count (void) const
 
virtual ParameterClassLock_Parameter (int i)
 
virtual void Unlock_Parameter (int i)
 

Protected Attributes

int m_DefinitionMgrLink
 

Friends

class DefinitionMgrClass
 

Detailed Description

Definition at line 61 of file definition.h.

Constructor & Destructor Documentation

◆ DefinitionClass()

DefinitionClass::DefinitionClass ( void )
inline

Definition at line 139 of file definition.h.

◆ ~DefinitionClass()

DefinitionClass::~DefinitionClass ( void )
inlinevirtual

Definition at line 151 of file definition.h.

Member Function Documentation

◆ Create()

virtual PersistClass * DefinitionClass::Create ( void ) const
pure virtual

◆ DECLARE_EDITABLE()

DefinitionClass::DECLARE_EDITABLE ( DefinitionClass ,
EditableClass  )

◆ Enable_Save()

void DefinitionClass::Enable_Save ( bool onoff)
inline

Definition at line 103 of file definition.h.

◆ Get_Class_ID()

virtual uint32 DefinitionClass::Get_Class_ID ( void ) const
pure virtual

◆ Get_ID()

uint32 DefinitionClass::Get_ID ( void ) const
inlinevirtual

Definition at line 179 of file definition.h.

◆ Get_Name()

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

Definition at line 160 of file definition.h.

◆ Get_User_Data()

uint32 DefinitionClass::Get_User_Data ( void ) const
inline

Definition at line 98 of file definition.h.

◆ Is_Save_Enabled()

bool DefinitionClass::Is_Save_Enabled ( void ) const
inline

Definition at line 102 of file definition.h.

◆ Is_Valid_Config()

bool DefinitionClass::Is_Valid_Config ( StringClass & message)
inlinevirtual

Definition at line 188 of file definition.h.

◆ Load()

bool DefinitionClass::Load ( ChunkLoadClass & cload)
virtual

Reimplemented from PersistClass.

Reimplemented in AudibleSoundDefinitionClass, and TwiddlerClass.

Definition at line 80 of file definition.cpp.

◆ Save()

bool DefinitionClass::Save ( ChunkSaveClass & csave)
virtual

Reimplemented from PersistClass.

Reimplemented in AudibleSoundDefinitionClass, and TwiddlerClass.

Definition at line 62 of file definition.cpp.

◆ Set_ID()

void DefinitionClass::Set_ID ( uint32 id)
virtual

Definition at line 148 of file definition.cpp.

◆ Set_Name()

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

Definition at line 169 of file definition.h.

◆ Set_User_Data()

void DefinitionClass::Set_User_Data ( uint32 data)
inline

Definition at line 99 of file definition.h.

Friends And Related Symbol Documentation

◆ DefinitionMgrClass

friend class DefinitionMgrClass
friend

Definition at line 131 of file definition.h.

Member Data Documentation

◆ m_DefinitionMgrLink

int DefinitionClass::m_DefinitionMgrLink
protected

Definition at line 110 of file definition.h.


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