CDecoVar Class Reference

#include <unittype.h>

Inheritance diagram for CDecoVar:

List of all members.

Public Member Functions
	CDecoVar ()
virtual	~CDecoVar ()
virtual void	Draw (int x, int y, const CUnit *unit) const =0
	function to draw the decorations.
Public Attributes
int	Index
	Index of the variable.
int	OffsetX
	Offset in X coord.
int	OffsetY
	Offset in Y coord.
int	OffsetXPercent
	Percent offset (TileWidth) in X coord.
int	OffsetYPercent
	Percent offset (TileHeight) in Y coord.
bool	IsCenteredInX
	if true, use center of deco instead of left border
bool	IsCenteredInY
	if true, use center of deco instead of upper border
bool	ShowIfNotEnable
	if false, Show only if var is enable
bool	ShowWhenMax
	if false, don't show if var is to max. (Like mana)
bool	ShowOnlySelected
	if true, show only for selected units.
bool	HideNeutral
	if true, don't show for neutral unit.
bool	HideAllied
	if true, don't show for allied unit. (but show own units)
bool	ShowOpponent
	if true, show for opponent unit.

---

Detailed Description

Decoration for user defined variable.

Definition at line 447 of file unittype.h.

---

Constructor & Destructor Documentation

CDecoVar::CDecoVar

(

)

[inline]

Definition at line 450 of file unittype.h.

virtual CDecoVar::~CDecoVar

(

)

[inline, virtual]

Definition at line 451 of file unittype.h.

---

Member Function Documentation

virtual void CDecoVar::Draw	(	int	x,
		int	y,
		const CUnit *	unit
	)			const [pure virtual]

function to draw the decorations.

Implemented in CDecoVarSpriteBar.

---

Member Data Documentation

int CDecoVar::Index

Index of the variable.

See also:

DefineVariables

Definition at line 456 of file unittype.h.

Referenced by CclDefineDecorations(), and CDecoVarSpriteBar::Draw().

int CDecoVar::OffsetX

Offset in X coord.

Definition at line 458 of file unittype.h.

Referenced by CclDefineDecorations().

int CDecoVar::OffsetY

Offset in Y coord.

Definition at line 459 of file unittype.h.

Referenced by CclDefineDecorations().

int CDecoVar::OffsetXPercent

Percent offset (TileWidth) in X coord.

Definition at line 461 of file unittype.h.

Referenced by CclDefineDecorations().

int CDecoVar::OffsetYPercent

Percent offset (TileHeight) in Y coord.

Definition at line 462 of file unittype.h.

Referenced by CclDefineDecorations().

bool CDecoVar::IsCenteredInX

if true, use center of deco instead of left border

Definition at line 464 of file unittype.h.

Referenced by CclDefineDecorations(), and CDecoVarSpriteBar::Draw().

bool CDecoVar::IsCenteredInY

if true, use center of deco instead of upper border

Definition at line 465 of file unittype.h.

Referenced by CclDefineDecorations(), and CDecoVarSpriteBar::Draw().

bool CDecoVar::ShowIfNotEnable

if false, Show only if var is enable

Definition at line 467 of file unittype.h.

Referenced by CclDefineDecorations().

bool CDecoVar::ShowWhenMax

if false, don't show if var is to max. (Like mana)

Definition at line 468 of file unittype.h.

Referenced by CclDefineDecorations().

bool CDecoVar::ShowOnlySelected

if true, show only for selected units.

Definition at line 469 of file unittype.h.

Referenced by CclDefineDecorations().

bool CDecoVar::HideNeutral

if true, don't show for neutral unit.

Definition at line 471 of file unittype.h.

Referenced by CclDefineDecorations().

bool CDecoVar::HideAllied

if true, don't show for allied unit. (but show own units)

Definition at line 472 of file unittype.h.

Referenced by CclDefineDecorations().

bool CDecoVar::ShowOpponent

if true, show for opponent unit.

Definition at line 473 of file unittype.h.

Referenced by CclDefineDecorations().

---

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

• unittype.h