animation.h File Reference

#include <string>
#include <map>
#include "upgrade_structs.h"

Go to the source code of this file.

Classes
class	CAnimation
class	CAnimations

animation.h - The animations headerfile.
#define	ANIMATIONS_DEATHTYPES   40
enum	AnimationType {   AnimationNone, AnimationFrame, AnimationExactFrame, AnimationWait,   AnimationRandomWait, AnimationSound, AnimationRandomSound, AnimationAttack,   AnimationRotate, AnimationRandomRotate, AnimationMove, AnimationUnbreakable,   AnimationLabel, AnimationGoto, AnimationRandomGoto, AnimationSpawnMissile,   AnimationSpawnUnit, AnimationIfVar, AnimationSetVar, AnimationSetPlayerVar,   AnimationDie, AnimationLuaCallback, AnimationWiggle }
enum	SetVar_ModifyTypes {   modSet = 0, modAdd, modSub, modMul,   modDiv, modMod, modAnd, modOr,   modXor, modNot }
std::string	ExtraDeathTypes [ANIMATIONS_DEATHTYPES]
CAnimations *	AnimationsByIdent (const std::string &ident)
	Get the animations structure by ident. More...
void	AnimationCclRegister ()
int	UnitShowAnimationScaled (CUnit &unit, const CAnimation *anim, int scale)
	Handle the animation of a unit. More...
int	UnitShowAnimation (CUnit &unit, const CAnimation *anim)
	Handle the animation of a unit. More...
int	ParseAnimInt (const CUnit &unit, const char *parseint)
int	ParseAnimFlags (const CUnit &unit, const char *parseflag)
void	FindLabelLater (CAnimation **anim, const std::string &name)
void	FreeAnimations ()

Macro Definition Documentation

ANIMATIONS_DEATHTYPES

#define ANIMATIONS_DEATHTYPES   40

Enumeration Type Documentation

AnimationType

enum AnimationType

Enumerator
AnimationNone
AnimationFrame
AnimationExactFrame
AnimationWait
AnimationRandomWait
AnimationSound
AnimationRandomSound
AnimationAttack
AnimationRotate
AnimationRandomRotate
AnimationMove
AnimationUnbreakable
AnimationLabel
AnimationGoto
AnimationRandomGoto
AnimationSpawnMissile
AnimationSpawnUnit
AnimationIfVar
AnimationSetVar
AnimationSetPlayerVar
AnimationDie
AnimationLuaCallback
AnimationWiggle

SetVar_ModifyTypes

enum SetVar_ModifyTypes

Enumerator
modSet
modAdd	Set value to this.
modSub	Addition.
modMul	Subtraction.
modDiv	Multiplication.
modMod	Division.
modAnd	Modulo.
modOr	Bitwise AND.
modXor	Bitwise OR.
modNot	Bitwise XOR.

Function Documentation

AnimationCclRegister()

void AnimationCclRegister

(

)

AnimationsByIdent()

CAnimations* AnimationsByIdent

(

const std::string &

ident

)

Get the animations structure by ident.

Get the animations structure by ident.

Parameters

ident

Identifier for the animation.

Returns

Pointer to the animation structure.

FindLabelLater()

void FindLabelLater	(	CAnimation **	anim,
		const std::string &	name
	)

Find a label later

FreeAnimations()

void FreeAnimations

(

)

ParseAnimFlags()

int ParseAnimFlags	(	const CUnit &	unit,
		const char *	parseflag
	)

Parse flags list in animation frame.

Parameters

unit	Unit of the animation.
parseflag	Flag list to parse.

Returns

The parsed value.

ParseAnimInt()

int ParseAnimInt	(	const CUnit &	unit,
		const char *	parseint
	)

Parse integer in animation frame.

Parameters

unit	Unit of the animation.
parseint	Integer to parse.

Returns

The parsed value.

UnitShowAnimation()

int UnitShowAnimation	(	CUnit &	unit,
		const CAnimation *	anim
	)

Handle the animation of a unit.

Handle the animation of a unit.

Show unit animation.

Parameters

unit	Unit of the animation.
anim	Animation script to handle.

Returns

The flags of the current script step.

UnitShowAnimationScaled()

int UnitShowAnimationScaled	(	CUnit &	unit,
		const CAnimation *	anim,
		int	scale
	)

Handle the animation of a unit.

Show unit animation.

Parameters

unit	Unit of the animation.
anim	Animation script to handle.
scale	Scaling factor of the wait times in animation (8 means no scaling).

Returns

The flags of the current script step.

Variable Documentation

ExtraDeathTypes

std::string ExtraDeathTypes[ANIMATIONS_DEATHTYPES]

Default names for the extra death types.

Default names for the resources.