Advanced Strategic Command
Public Member Functions | Public Attributes | List of all members
LoadableItemType Class Referenceabstract

An abstract base class that provides the interface for all kinds of items that ASC loads from disk. More...

#include <typen.h>

Inheritance diagram for LoadableItemType:
Inheritance graph
[legend]

Public Member Functions

virtual void read (tnstream &stream)=0
 read the binary representation of this item from the given stream More...
 
virtual void write (tnstream &stream) const =0
 write the binary representation of this item to the given stream More...
 
virtual void runTextIO (PropertyContainer &pc)=0
 registers the properties of this item for loading/writing into asctxt files More...
 
virtual ~LoadableItemType ()
 

Public Attributes

ASCString filename
 The name of the file from which the item was loaded. More...
 
ASCString location
 The filename and location on disk (including containerfiles) of the object. More...
 
ASCString archive
 

Detailed Description

An abstract base class that provides the interface for all kinds of items that ASC loads from disk.

Definition at line 287 of file typen.h.

Constructor & Destructor Documentation

virtual LoadableItemType::~LoadableItemType ( )
inlinevirtual

Definition at line 308 of file typen.h.

Member Function Documentation

virtual void LoadableItemType::read ( tnstream stream)
pure virtual

read the binary representation of this item from the given stream

Implemented in VehicleType, ContainerBaseType, ObjectType, Technology, TerrainType, TerrainType::Weather, BuildingType, TechAdapter, and TechDependency.

virtual void LoadableItemType::runTextIO ( PropertyContainer pc)
pure virtual

registers the properties of this item for loading/writing into asctxt files

Implemented in VehicleType, ContainerBaseType, ObjectType, Technology, TerrainType, TerrainType::Weather, BuildingType, TechAdapter, and TechDependency.

virtual void LoadableItemType::write ( tnstream stream) const
pure virtual

write the binary representation of this item to the given stream

Implemented in VehicleType, ContainerBaseType, ObjectType, Technology, TerrainType, TerrainType::Weather, BuildingType, TechAdapter, and TechDependency.

Member Data Documentation

ASCString LoadableItemType::archive

Definition at line 298 of file typen.h.

Referenced by PackageManager::storeData().

ASCString LoadableItemType::filename

The name of the file from which the item was loaded.

Definition at line 290 of file typen.h.

Referenced by ObjectStorage< T >::print(), VehicleType::read(), BuildingType::runTextIO(), ObjectType::runTextIO(), VehicleType::runTextIO(), and viewterraininfo().

ASCString LoadableItemType::location

The filename and location on disk (including containerfiles) of the object.

Can only be used for informational purposes. Example: "foo.wav located inside /usr/share/games/asc/main.ascdat"

Definition at line 296 of file typen.h.

Referenced by VehicleType::read(), viewterraininfo(), and viewUnitSetinfo().


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