#include <unittype.h>

Inheritance diagram for CDecoVar:

Public Member Functions
	CDecoVar ()

virtual	~CDecoVar ()

virtual void	Draw (int x, int y, const CUnitType &type, const CVariable &var) const =0
	function to draw the decorations. More...

unit_draw.cpp - The draw routines for units.
bool	BoolFlagMatches (const CUnitType &type) const
	Check if this decoration defines a condition on boolean flags and if so, if that condition matches. More...

Public Attributes
unsigned int	Index

int	OffsetX
	Index of the variable. More...

int	OffsetY
	Offset in X coord. More...

int	OffsetXPercent
	Offset in Y coord. More...

int	OffsetYPercent
	Percent offset (TileWidth) in X coord. More...

bool	IsCenteredInX
	Percent offset (TileHeight) in Y coord. More...

bool	IsCenteredInY
	if true, use center of deco instead of left border More...

bool	ShowIfNotEnable
	if true, use center of deco instead of upper border More...

bool	ShowWhenNull
	if false, Show only if var is enable More...

bool	HideHalf
	if false, don't show if var is null (F.E poison) More...

bool	ShowWhenMax
	if true, don't show when 0 < var < max. More...

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

bool	HideNeutral
	if true, show only for selected units. More...

bool	HideAllied
	if true, don't show for neutral unit. More...

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

bool	BoolFlagInvert
	if true, show for opponent unit. More...

int	BoolFlag
	if 1, invert the bool flag check More...

Detailed Description

Decoration for user defined variable.

It is used to show variables graphicly.

Todo:: add more stuff in this struct.

Constructor & Destructor Documentation

◆ CDecoVar()

CDecoVar::CDecoVar ( )

inline

◆ ~CDecoVar()

virtual CDecoVar::~CDecoVar ( )

inlinevirtual

Member Function Documentation

◆ BoolFlagMatches()

bool CDecoVar::BoolFlagMatches ( const CUnitType & type ) const

Check if this decoration defines a condition on boolean flags and if so, if that condition matches.

Parameters

type	the unit type to check against

Returns: true if the decoration has a condition on a boolean variable and that condition matches, false otherwise

◆ Draw()

virtual void CDecoVar::Draw	(	int	x,
		int	y,
		const CUnitType &	type,
		const CVariable &	var
	)		const

pure virtual

function to draw the decorations.

Implemented in CDecoVarAnimatedSprite, CDecoVarStaticSprite, CDecoVarSpriteBar, CDecoVarText, CDecoVarFrame, and CDecoVarBar.

Member Data Documentation

◆ BoolFlag

int CDecoVar::BoolFlag

if 1, invert the bool flag check

◆ BoolFlagInvert

bool CDecoVar::BoolFlagInvert

if true, show for opponent unit.

◆ HideAllied

bool CDecoVar::HideAllied

if true, don't show for neutral unit.

◆ HideHalf

bool CDecoVar::HideHalf

if false, don't show if var is null (F.E poison)

◆ HideNeutral

bool CDecoVar::HideNeutral

if true, show only for selected units.

◆ Index

unsigned int CDecoVar::Index

◆ IsCenteredInX

bool CDecoVar::IsCenteredInX

Percent offset (TileHeight) in Y coord.

◆ IsCenteredInY

bool CDecoVar::IsCenteredInY

if true, use center of deco instead of left border

◆ OffsetX

int CDecoVar::OffsetX

Index of the variable.

See also: DefineVariables

◆ OffsetXPercent

int CDecoVar::OffsetXPercent

Offset in Y coord.

◆ OffsetY

int CDecoVar::OffsetY

Offset in X coord.

◆ OffsetYPercent

int CDecoVar::OffsetYPercent

Percent offset (TileWidth) in X coord.

◆ ShowIfNotEnable

bool CDecoVar::ShowIfNotEnable

if true, use center of deco instead of upper border

◆ ShowOnlySelected

bool CDecoVar::ShowOnlySelected

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

◆ ShowOpponent

bool CDecoVar::ShowOpponent

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

◆ ShowWhenMax

bool CDecoVar::ShowWhenMax

if true, don't show when 0 < var < max.

◆ ShowWhenNull

bool CDecoVar::ShowWhenNull

if false, Show only if var is enable

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

src/include/unittype.h
src/unit/unit_draw.cpp

Public Member Functions

Public Attributes