____                _       __
    / __ )____  _____   | |     / /___ ___________
   / __  / __ \/ ___/   | | /| / / __ `/ ___/ ___/
  / /_/ / /_/ (__  )    | |/ |/ / /_/ / /  (__  )
 /_____/\____/____/     |__/|__/\__,_/_/  /____/

       A futuristic real-time strategy game.
          This file is part of Bos Wars.
(C) Copyright 2001-2007 by the Bos Wars and Stratagus Project. Distributed under the "GNU General Public License"

SpellType Class Reference

#include <spells.h>

List of all members.

Public Member Functions

 SpellType (int slot, const std::string &ident)
 ~SpellType ()

Public Attributes

std::string Ident
 Spell unique identifier (spell-holy-vision).
std::string Name
 Spell name shown by the engine.
int Slot
 Spell numeric identifier.
TargetType Target
 Targetting information. See TargetType.
std::vector< SpellActionType * > Action
 More arguments for spell (damage, delay, additional sounds...).
int Range
 Max range of the target.
int ManaCost
 Required mana for each cast.
int RepeatCast
 If the spell will be cast again until out of targets.
int DependencyId
 Id of upgrade, -1 if no upgrade needed for cast the spell.
ConditionInfoCondition
 Conditions to cast the spell. (generic (no test for each target)).
AutoCastInfoAutoCast
 AutoCast information for your own units.
AutoCastInfoAICast
 AutoCast information for ai. More detalied.
SoundConfig SoundWhenCast
 Sound played if cast.


Detailed Description

Base structure of a spell type.

Definition at line 351 of file spells.h.


Constructor & Destructor Documentation

SpellType::SpellType ( int  slot,
const std::string &  ident 
)

SpellType constructor.

Definition at line 1127 of file spells.cpp.

SpellType::~SpellType (  ) 

SpellType destructor.

Definition at line 1138 of file spells.cpp.

References Action, AICast, AutoCast, and Condition.


Member Data Documentation

std::string SpellType::Ident

Spell unique identifier (spell-holy-vision).

Definition at line 357 of file spells.h.

Referenced by CommandSpellCast(), SaveOrder(), and SpellCast().

std::string SpellType::Name

Spell name shown by the engine.

Definition at line 358 of file spells.h.

Referenced by CclDefineSpell(), and HandleActionSpellCast().

Spell numeric identifier.

Definition at line 359 of file spells.h.

Referenced by AddButton(), AutoCastSpell(), CclDefineUnitType(), CclUnit(), and CommandSpellCast().

Targetting information. See TargetType.

Definition at line 362 of file spells.h.

Referenced by CanCastSpell(), CclDefineSpell(), PassCondition(), SelectTargetUnitsOfAutoCast(), and SpellCast().

More arguments for spell (damage, delay, additional sounds...).

Definition at line 363 of file spells.h.

Referenced by CclDefineSpell(), SpellCast(), and ~SpellType().

Max range of the target.

Definition at line 365 of file spells.h.

Referenced by AreaAdjustVitals::Cast(), CclDefineSpell(), and CommandSpellCast().

If the spell will be cast again until out of targets.

Definition at line 368 of file spells.h.

Referenced by CclDefineSpell(), and SpellCast().

Id of upgrade, -1 if no upgrade needed for cast the spell.

Definition at line 370 of file spells.h.

Conditions to cast the spell. (generic (no test for each target)).

Definition at line 371 of file spells.h.

Referenced by CanCastSpell(), CclDefineSpell(), SelectTargetUnitsOfAutoCast(), and ~SpellType().

AutoCast information for your own units.

Definition at line 374 of file spells.h.

Referenced by CclDefineSpell(), CclDefineUnitType(), SelectTargetUnitsOfAutoCast(), and ~SpellType().

AutoCast information for ai. More detalied.

Definition at line 375 of file spells.h.

Referenced by CclDefineSpell(), SelectTargetUnitsOfAutoCast(), and ~SpellType().

Sound played if cast.

Definition at line 378 of file spells.h.

Referenced by CclDefineSpell(), and SpellCast().


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

Generated on Sat Feb 21 00:28:25 2009 for Bos Wars by  doxygen 1.5.6