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

       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"

Summon Class Reference

#include <spells.h>

Inheritance diagram for Summon:

SpellActionType

List of all members.

Public Member Functions

 Summon ()
virtual int Cast (CUnit *caster, const SpellType *spell, CUnit *target, int x, int y)

Public Attributes

CUnitTypeUnitType
 Type of unit to be summoned.
int TTL
 Time to live for summoned unit. 0 means infinite.
int RequireCorpse
 Corpse consumed while summoning.


Detailed Description

Definition at line 231 of file spells.h.


Constructor & Destructor Documentation

Summon::Summon (  )  [inline]

Definition at line 233 of file spells.h.


Member Function Documentation

int Summon::Cast ( CUnit caster,
const SpellType spell,
CUnit target,
int  x,
int  y 
) [virtual]

Cast summon spell.

Parameters:
caster Unit that casts the spell
spell Spell-type pointer
target Target unit that spell is addressed to
x X coord of target spot when/if target does not exist
y Y coord of target spot when/if target does not exist
Returns:
=!0 if spell should be repeated, 0 if not

Implements SpellActionType.

Definition at line 635 of file spells.cpp.

References _C_, CUnitType::Building, DebugPrint, DropOutOnSide(), GameCycle, LookingW, MakeUnit(), MANA_INDEX, SpellType::ManaCost, CUnitType::Name, NoUnitP, CUnit::Orders, CUnit::Player, CUnit::Release(), CUnit::Remove(), RequireCorpse, CUnitCache::Select(), TTL, CUnit::Type, UnitActionDie, UnitCache, UnitMax, UnitType, CVariable::Value, CUnit::Variable, CUnit::X, and CUnit::Y.


Member Data Documentation

Type of unit to be summoned.

Definition at line 237 of file spells.h.

Referenced by Cast(), and CclSpellAction().

Time to live for summoned unit. 0 means infinite.

Definition at line 238 of file spells.h.

Referenced by Cast(), and CclSpellAction().

Corpse consumed while summoning.

Definition at line 239 of file spells.h.

Referenced by Cast(), and CclSpellAction().


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