spells.cpp File Reference

#include "stratagus.h"
#include "spells.h"
#include "actions.h"
#include "commands.h"
#include "map.h"
#include "sound.h"
#include "unit.h"
#include "unit_find.h"
#include "upgrade.h"

Classes
class	AutoCastPrioritySort

spells.cpp - The spell cast action.
std::vector< SpellType * >	SpellTypeTable
static Target *	NewTargetUnit (CUnit &unit)
static bool	PassCondition (const CUnit &caster, const SpellType &spell, const CUnit *target, const Vec2i &goalPos, const ConditionInfo *condition)
static Target *	SelectTargetUnitsOfAutoCast (CUnit &caster, const SpellType &spell)
void	InitSpells ()
	init spell tables More...
SpellType *	SpellTypeByIdent (const std::string &ident)
	return spell type by ident string More...
bool	SpellIsAvailable (const CPlayer &player, int spellid)
	return 1 if spell is available, 0 if not (must upgrade) More...
bool	CanCastSpell (const CUnit &caster, const SpellType &spell, const CUnit *target, const Vec2i &goalPos)
	returns true if spell can be casted (enough mana, valid target) More...
int	AutoCastSpell (CUnit &caster, const SpellType &spell)
	auto cast the spell if possible More...
int	SpellCast (CUnit &caster, const SpellType &spell, CUnit *target, const Vec2i &goalPos)
	cast spell on target unit or place at x,y More...
void	CleanSpells ()
	done spell tables More...

Function Documentation

AutoCastSpell()

int AutoCastSpell	(	CUnit &	caster,
		const SpellType &	spell
	)

auto cast the spell if possible

Check if the spell can be auto cast and cast it.

Parameters

caster	Unit who can cast the spell.
spell	Spell-type pointer.

Returns

1 if spell is casted, 0 if not.

CanCastSpell()

bool CanCastSpell	(	const CUnit &	caster,
		const SpellType &	spell,
		const CUnit *	target,
		const Vec2i &	goalPos
	)

returns true if spell can be casted (enough mana, valid target)

Check if unit can cast the spell.

Parameters

caster	Unit that casts the spell
spell	Spell-type pointer
target	Target unit that spell is addressed to
goalPos	coord of target spot when/if target does not exist

Returns

=!0 if spell should/can casted, 0 if not

Note

caster must know the spell, and spell must be researched.

CleanSpells()

void CleanSpells

(

)

done spell tables

Cleanup the spell subsystem.

InitSpells()

void InitSpells

(

)

init spell tables

Spells constructor, inits spell id's and sounds

NewTargetUnit()

static Target* NewTargetUnit ( CUnit &  unit )

static

Target constructor for unit.

Parameters

unit	Target unit.

Returns

the new target.

PassCondition()

static bool PassCondition ( const CUnit &  caster, const SpellType &  spell, const CUnit *  target, const Vec2i &  goalPos, const ConditionInfo *  condition  )

static

Check the condition.

Parameters

caster	Pointer to caster unit.
spell	Pointer to the spell to cast.
target	Pointer to target unit, or 0 if it is a position spell.
goalPos	position, or {-1, -1} if it is a unit spell.
condition	Pointer to condition info.

Returns

true if passed, false otherwise.

SelectTargetUnitsOfAutoCast()

static Target* SelectTargetUnitsOfAutoCast ( CUnit &  caster, const SpellType &  spell  )

static

Select the target for the autocast.

Parameters

caster	Unit who would cast the spell.
spell	Spell-type pointer.

Returns

Target* chosen target or Null if spell can't be cast.

Todo:

FIXME: should be global (for AI) ???

FIXME: write for position target.

SpellCast()

int SpellCast	(	CUnit &	caster,
		const SpellType &	spell,
		CUnit *	target,
		const Vec2i &	goalPos
	)

cast spell on target unit or place at x,y

Spell cast!

Parameters

caster	Unit that casts the spell
spell	Spell-type pointer
target	Target unit that spell is addressed to
goalPos	coord of target spot when/if target does not exist

Returns

!=0 if spell should/can continue or 0 to stop

SpellIsAvailable()

bool SpellIsAvailable	(	const CPlayer &	player,
		int	spellid
	)

return 1 if spell is available, 0 if not (must upgrade)

Check if spell is research for player player.

Parameters

player	player for who we want to know if he knows the spell.
spellid	id of the spell to check.

Returns

0 if spell is not available, else no null.

SpellTypeByIdent()

SpellType* SpellTypeByIdent

(

const std::string &

ident

)

return spell type by ident string

Get spell-type struct pointer by string identifier.

Parameters

ident

Spell identifier.

Returns

spell-type struct pointer.

Variable Documentation

SpellTypeTable

std::vector<SpellType *> SpellTypeTable

Define the names and effects of all im play available spells.