Dawn of Light - Class documentation 2900
This is the Dawn of Light project
DOL.GS.NecromancerPet Class Reference

The necromancer pets. More...

Inheritance diagram for DOL.GS.NecromancerPet:
DOL.GS.GamePet DOL.GS.GameNPC DOL.GS.GameLiving DOL.GS.GameObject DOL.GS.Point3D DOL.GS.Point2D DOL.GS.IPoint3D DOL.GS.IPoint2D DOL.GS.IPoint2D

List of all members.

Public Member Functions

 NecromancerPet (INpcTemplate npcTemplate, int summonConBonus, int summonHitsBonus)
 Create necromancer pet from template. Con and hit bonuses from items the caster was wearing when the summon started, will be transferred to the pet.
override int GetModified (eProperty property)
 Get modified bonuses for the pet; some bonuses come from the shade, some come from the pet.
void DrawWeapon ()
 Draw the weapon, but don't actually start a melee attack.
override int CalculateLeftHandSwingCount ()
 Calculates how many times left hand can swing.
override void CastSpell (Spell spell, SpellLine line)
 Cast a spell with LOS check to a player.
override void OnAfterSpellCastSequence (ISpellHandler handler)
 Called when spell has finished casting.
override bool CanCastInCombat (Spell spell)
 Can this living cast the given spell while in combat?
override void ModifyAttack (AttackData attackData)
 Modify the attack done to this living. This method offers us a chance to modify the attack data prior to the living taking damage.
void Taunt ()
 Taunt the current target.
override bool SayReceive (GameLiving source, string str)
 This function is called when this object receives a Say.
override bool WhisperReceive (GameLiving source, string text)
 Actions to be taken when the pet receives a whisper.
void CutTether ()
 Pet stayed out of range for too long, despawn it.

Properties

override int Health [get, set]
 Current health (absolute value).
override short Strength [get]
 Base strength.
override short Constitution [get]
 Base constitution.
override short Dexterity [get]
 Base dexterity. Make greater necroservant slightly more dextrous than all the other pets.
override short Quickness [get]
 Base quickness.
override bool CanUseLefthandedWeapon [get]
 Whether or not pet can use left hand weapon.
String PetInstaSpellLine [get]
 Pet-only insta spells.

Detailed Description

The necromancer pets.

<author>Aredhel</author>


Constructor & Destructor Documentation

DOL.GS.NecromancerPet.NecromancerPet ( INpcTemplate  npcTemplate,
int  summonConBonus,
int  summonHitsBonus 
)

Create necromancer pet from template. Con and hit bonuses from items the caster was wearing when the summon started, will be transferred to the pet.

Parameters:
npcTemplate
ownerPlayer who summoned this pet.
summonConBonusItem constitution bonuses of the player.
summonHitsBonusHits bonuses of the player.

Member Function Documentation

override int DOL.GS.NecromancerPet.CalculateLeftHandSwingCount ( ) [virtual]

Calculates how many times left hand can swing.

Returns:

Reimplemented from DOL.GS.GamePet.

override bool DOL.GS.NecromancerPet.CanCastInCombat ( Spell  spell) [virtual]

Can this living cast the given spell while in combat?

Parameters:
spell
Returns:

Reimplemented from DOL.GS.GameLiving.

override void DOL.GS.NecromancerPet.CastSpell ( Spell  spell,
SpellLine  line 
) [virtual]

Cast a spell with LOS check to a player.

Parameters:
spell
line

Reimplemented from DOL.GS.GameNPC.

void DOL.GS.NecromancerPet.CutTether ( )

Pet stayed out of range for too long, despawn it.

void DOL.GS.NecromancerPet.DrawWeapon ( )

Draw the weapon, but don't actually start a melee attack.

override int DOL.GS.NecromancerPet.GetModified ( eProperty  property) [virtual]

Get modified bonuses for the pet; some bonuses come from the shade, some come from the pet.

Parameters:
property
Returns:

Reimplemented from DOL.GS.GameLiving.

override void DOL.GS.NecromancerPet.ModifyAttack ( AttackData  attackData) [virtual]

Modify the attack done to this living. This method offers us a chance to modify the attack data prior to the living taking damage.

Parameters:
attackDataThe attack data for this attack

Reimplemented from DOL.GS.GameLiving.

override void DOL.GS.NecromancerPet.OnAfterSpellCastSequence ( ISpellHandler  handler) [virtual]

Called when spell has finished casting.

Parameters:
handler

Reimplemented from DOL.GS.GamePet.

override bool DOL.GS.NecromancerPet.SayReceive ( GameLiving  source,
string  str 
) [virtual]

This function is called when this object receives a Say.

Parameters:
sourceSource of say
strText that was spoken
Returns:
true if the text should be processed further, false if it should be discarded

Reimplemented from DOL.GS.GameLiving.

void DOL.GS.NecromancerPet.Taunt ( )

Taunt the current target.

override bool DOL.GS.NecromancerPet.WhisperReceive ( GameLiving  source,
string  text 
) [virtual]

Actions to be taken when the pet receives a whisper.

Parameters:
sourceSource of the whisper.
text"Text that was whispered
Returns:
True if whisper was handled, false otherwise.

Reimplemented from DOL.GS.GameNPC.


Property Documentation

override bool DOL.GS.NecromancerPet.CanUseLefthandedWeapon [get]

Whether or not pet can use left hand weapon.

Reimplemented from DOL.GS.GamePet.

override short DOL.GS.NecromancerPet.Constitution [get]

Base constitution.

Reimplemented from DOL.GS.GamePet.

override short DOL.GS.NecromancerPet.Dexterity [get]

Base dexterity. Make greater necroservant slightly more dextrous than all the other pets.

Reimplemented from DOL.GS.GamePet.

override int DOL.GS.NecromancerPet.Health [get, set]

Current health (absolute value).

Reimplemented from DOL.GS.GameNPC.

String DOL.GS.NecromancerPet.PetInstaSpellLine [get]

Pet-only insta spells.

override short DOL.GS.NecromancerPet.Quickness [get]

Base quickness.

Reimplemented from DOL.GS.GamePet.

override short DOL.GS.NecromancerPet.Strength [get]

Base strength.

Reimplemented from DOL.GS.GamePet.


The documentation for this class was generated from the following file:
 All Classes Namespaces Functions Variables Enumerations Properties Events