CConstruction Class Reference

#include <construct.h>

List of all members.

Public Member Functions
	CConstruction ()
Public Attributes
std::string	Ident
	construction identifier
struct {
std::string   File
	sprite file
int   Width
	sprite width
int   Height
	sprite height
}	File
struct {
std::string   File
	sprite file
int   Width
	sprite width
int   Height
	sprite height
}	ShadowFile
CConstructionFrame *	Frames
	construction frames
CPlayerColorGraphic *	Sprite
	construction sprite image
CGraphic *	ShadowSprite
	construction shadow sprite image
int	ShadowWidth
	shadow sprite width
int	ShadowHeight
	shadow sprite height

---

Detailed Description

#include "construct.h"

Each building perhaps also units can have its own construction frames. This construction frames are currently not animated, this is planned for the future. What construction frames a building has, is handled by UnitType::Construction.

The construction structure members:

CConstruction::Ident

Unique identifier of the construction, used to reference it in the config files and during startup. As convention they start with "construction-" fe. "construction-land".

Note:

Don't use this member in game, use instead the pointer to this structure. See ConstructionByIdent().

CConstruction::File

Path file name of the sprite file.

CConstruction::ShadowFile

Path file name of shadow sprite file.

CConstruction::Frames

Frames of the construction sequence.

CConstruction::Sprite

Sprite image.

CConstruction::Width CConstruction::Height

Size of a sprite frame in pixels. All frames of a sprite have the same size. Also all sprites (tilesets) must have the same size.

CConstruction::ShadowSprite

Shadow sprite image.

CConstruction::ShadowWidth CConstruction::ShadowHeight

Size of a shadow sprite frame in pixels. All frames of a sprite have the same size. Also all sprites (tilesets) must have the same size.

Definition at line 116 of file construct.h.

---

Constructor & Destructor Documentation

CConstruction::CConstruction

(

)

[inline]

Definition at line 118 of file construct.h.

References File, and ShadowFile.

---

Member Data Documentation

std::string CConstruction::Ident

construction identifier

Definition at line 127 of file construct.h.

Referenced by CclDefineConstruction().

std::string CConstruction::File

sprite file

Definition at line 129 of file construct.h.

Referenced by CclDefineConstruction(), and CConstruction().

int CConstruction::Width

sprite width

Definition at line 130 of file construct.h.

Referenced by CclDefineConstruction(), DrawConstruction(), and DrawConstructionShadow().

int CConstruction::Height

sprite height

Definition at line 131 of file construct.h.

Referenced by CclDefineConstruction(), DrawConstruction(), and DrawConstructionShadow().

struct { ... } CConstruction::File

struct { ... } CConstruction::ShadowFile

Referenced by CclDefineConstruction(), and CConstruction().

CConstructionFrame* CConstruction::Frames

construction frames

Definition at line 133 of file construct.h.

Referenced by CclDefineConstruction(), CclParseBuilt(), CclUnit(), SaveUnit(), and UpdateConstructionFrame().

CPlayerColorGraphic* CConstruction::Sprite

construction sprite image

Definition at line 137 of file construct.h.

Referenced by DrawConstruction().

CGraphic* CConstruction::ShadowSprite

construction shadow sprite image

Definition at line 140 of file construct.h.

Referenced by DrawConstructionShadow().

int CConstruction::ShadowWidth

shadow sprite width

Definition at line 141 of file construct.h.

int CConstruction::ShadowHeight

shadow sprite height

Definition at line 142 of file construct.h.

---

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

• construct.h