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

The Base class for all Character Classes in DOL. More...

Inheritance diagram for DOL.GS.CharacterClassBase:
DOL.GS.ICharacterClass DOL.GS.CharacterClassAnimist DOL.GS.CharacterClassBoneDancer DOL.GS.CharacterClassNecromancer DOL.GS.DefaultCharacterClass DOL.GS.PlayerClass.ClassAcolyte DOL.GS.PlayerClass.ClassAlbionRogue DOL.GS.PlayerClass.ClassElementalist DOL.GS.PlayerClass.ClassFighter DOL.GS.PlayerClass.ClassForester DOL.GS.PlayerClass.ClassGuardian DOL.GS.PlayerClass.ClassMage DOL.GS.PlayerClass.ClassMagician DOL.GS.PlayerClass.ClassMaulerAlb DOL.GS.PlayerClass.ClassMaulerHib DOL.GS.PlayerClass.ClassMaulerMid DOL.GS.PlayerClass.ClassMidgardRogue DOL.GS.PlayerClass.ClassMystic DOL.GS.PlayerClass.ClassNaturalist DOL.GS.PlayerClass.ClassSeer DOL.GS.PlayerClass.ClassStalker DOL.GS.PlayerClass.ClassViking

List of all members.

Public Member Functions

virtual void Init (GamePlayer player)
void SwitchToFemaleName ()
virtual string GetTitle (int level)
virtual IList< string > GetAutotrainableSkills ()
 Return the base list of Realm abilities that the class can train in. Added by Echostorm for RAs.
virtual
GameTrainer.eChampionTrainerType 
ChampionTrainerType ()
 What Champion trainer does this class use?
virtual void OnLevelUp (GamePlayer player)
 Add all skills and other things that are required for current level.
virtual void OnRealmLevelUp (GamePlayer player)
 Add various skills as the player levels his realm rank up.
virtual void OnSkillTrained (GamePlayer player, Specialization skill)
 Add all spell-lines and other things that are new when this skill is trained.
virtual bool CanUseLefthandedWeapon (GamePlayer player)
 Checks whether player has ability to use lefthanded weapons.
virtual bool HasAdvancedFromBaseClass ()
virtual void SetControlledBrain (IControlledBrain controlledBrain)
virtual void CommandNpcRelease ()
 Releases controlled object.
virtual void OnPetReleased ()
 Invoked when pet is released.
virtual bool StartAttack (GameObject attackTarget)
 Can this character start an attack?
virtual ShadeEffect CreateShadeEffect ()
 Create a shade effect for this player.
virtual void Shade (bool makeShade)
 Changes shade state of the player.
virtual bool RemoveFromWorld ()
 Called when player is removed from world.
virtual void Die (GameObject killer)
 What to do when this character dies.
virtual void Notify (DOLEvent e, object sender, EventArgs args)
virtual bool CanChangeCastingSpeed (SpellLine line, Spell spell)

Protected Attributes

int m_id
 id of class in Client
string m_name
 Name of class.
string m_femaleName
 Female name of class.
string m_basename
 Base of this class.
string m_profession
 Profession of character, e.g. Defenders of Albion.
int m_specializationMultiplier = 10
 multiplier for specialization points per level in 10th
int m_baseHP = 600
 BaseHP for hp calculation.
eStat m_primaryStat = eStat.UNDEFINED
 Stat gained every level. see eStat consts.
eStat m_secondaryStat = eStat.UNDEFINED
 Stat gained every second level. see eStat consts.
eStat m_tertiaryStat = eStat.UNDEFINED
 Stat gained every third level. see eStat consts.
eStat m_manaStat = eStat.UNDEFINED
 Stat that affects the power/mana pool. Do not set if they do not have a power pool/spells.
int m_wsbase = 400
 Weapon Skill Base value to influence weapon skill calc.
int m_wsbaseRanged = 440
 Weapon Skill Base value to influence ranged weapon skill calc.

Static Protected Attributes

static readonly log4net.ILog log = log4net.LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType)

Properties

GamePlayer Player [get, set]
 The GamePlayer for this character.
string FemaleName [get]
int BaseHP [get]
int ID [get]
string Name [get]
string BaseName [get]
string Profession [get]
int SpecPointsMultiplier [get]
int AdjustedSpecPointsMultiplier [get]
 This is specifically used for adjusting spec points as needed for new training window For standard DOL classes this will simply return the standard spec multiplier.
eStat PrimaryStat [get]
eStat SecondaryStat [get]
eStat TertiaryStat [get]
eStat ManaStat [get]
int WeaponSkillBase [get]
int WeaponSkillRangedBase [get]
virtual ushort MaxPulsingSpells [get]
 Maximum number of pulsing spells that can be active simultaneously.
virtual eClassType ClassType [get]
virtual byte HealthPercentGroupWindow [get]
 Return the health percent of this character.

Detailed Description

The Base class for all Character Classes in DOL.


Member Function Documentation

virtual void DOL.GS.CharacterClassBase.CommandNpcRelease ( ) [virtual]
virtual ShadeEffect DOL.GS.CharacterClassBase.CreateShadeEffect ( ) [virtual]

Create a shade effect for this player.

Returns:

Implements DOL.GS.ICharacterClass.

Reimplemented in DOL.GS.CharacterClassNecromancer.

virtual void DOL.GS.CharacterClassBase.Die ( GameObject  killer) [virtual]

What to do when this character dies.

Parameters:
killer

Implements DOL.GS.ICharacterClass.

Reimplemented in DOL.GS.CharacterClassNecromancer.

virtual void DOL.GS.CharacterClassBase.OnLevelUp ( GamePlayer  player) [virtual]

Add all skills and other things that are required for current level.

Parameters:
playerplayer to modify

Implements DOL.GS.ICharacterClass.

Reimplemented in DOL.GS.PlayerClass.ClassArmsman, DOL.GS.PlayerClass.ClassCabalist, DOL.GS.PlayerClass.ClassCleric, DOL.GS.PlayerClass.ClassFriar, DOL.GS.PlayerClass.ClassHeretic, DOL.GS.PlayerClass.ClassInfiltrator, DOL.GS.PlayerClass.ClassMaulerAlb, DOL.GS.PlayerClass.ClassMercenary, DOL.GS.PlayerClass.ClassMinstrel, DOL.GS.PlayerClass.ClassNecromancer, DOL.GS.PlayerClass.ClassPaladin, DOL.GS.PlayerClass.ClassReaver, DOL.GS.PlayerClass.ClassScout, DOL.GS.PlayerClass.ClassSorcerer, DOL.GS.PlayerClass.ClassTheurgist, DOL.GS.PlayerClass.ClassWizard, DOL.GS.PlayerClass.ClassAcolyte, DOL.GS.PlayerClass.ClassAlbionRogue, DOL.GS.PlayerClass.ClassDisciple, DOL.GS.PlayerClass.ClassElementalist, DOL.GS.PlayerClass.ClassFighter, DOL.GS.PlayerClass.ClassForester, DOL.GS.PlayerClass.ClassGuardian, DOL.GS.PlayerClass.ClassMage, DOL.GS.PlayerClass.ClassMagician, DOL.GS.PlayerClass.ClassMidgardRogue, DOL.GS.PlayerClass.ClassMystic, DOL.GS.PlayerClass.ClassNaturalist, DOL.GS.PlayerClass.ClassSeer, DOL.GS.PlayerClass.ClassStalker, DOL.GS.PlayerClass.ClassViking, DOL.GS.PlayerClass.ClassAnimist, DOL.GS.PlayerClass.ClassBainshee, DOL.GS.PlayerClass.ClassBard, DOL.GS.PlayerClass.ClassBlademaster, DOL.GS.PlayerClass.ClassChampion, DOL.GS.PlayerClass.ClassDruid, DOL.GS.PlayerClass.ClassEldritch, DOL.GS.PlayerClass.ClassEnchanter, DOL.GS.PlayerClass.ClassHero, DOL.GS.PlayerClass.ClassMaulerHib, DOL.GS.PlayerClass.ClassMentalist, DOL.GS.PlayerClass.ClassNightshade, DOL.GS.PlayerClass.ClassRanger, DOL.GS.PlayerClass.ClassValewalker, DOL.GS.PlayerClass.ClassVampiir, DOL.GS.PlayerClass.ClassWarden, DOL.GS.PlayerClass.ClassBerserker, DOL.GS.PlayerClass.ClassBonedancer, DOL.GS.PlayerClass.ClassHealer, DOL.GS.PlayerClass.ClassHunter, DOL.GS.PlayerClass.ClassMaulerMid, DOL.GS.PlayerClass.ClassRunemaster, DOL.GS.PlayerClass.ClassSavage, DOL.GS.PlayerClass.ClassShadowblade, DOL.GS.PlayerClass.ClassShaman, DOL.GS.PlayerClass.ClassSkald, DOL.GS.PlayerClass.ClassSpiritmaster, DOL.GS.PlayerClass.ClassThane, DOL.GS.PlayerClass.ClassValkyrie, DOL.GS.PlayerClass.ClassWarlock, and DOL.GS.PlayerClass.ClassWarrior.

virtual void DOL.GS.CharacterClassBase.OnPetReleased ( ) [virtual]

Invoked when pet is released.

Implements DOL.GS.ICharacterClass.

Reimplemented in DOL.GS.CharacterClassNecromancer.

virtual void DOL.GS.CharacterClassBase.OnRealmLevelUp ( GamePlayer  player) [virtual]

Add various skills as the player levels his realm rank up.

Parameters:
playerplayer to modify

Implements DOL.GS.ICharacterClass.

virtual void DOL.GS.CharacterClassBase.OnSkillTrained ( GamePlayer  player,
Specialization  skill 
) [virtual]

Add all spell-lines and other things that are new when this skill is trained.

Parameters:
playerplayer to modify
skillThe skill that is trained

Implements DOL.GS.ICharacterClass.

Reimplemented in DOL.GS.PlayerClass.ClassInfiltrator, DOL.GS.PlayerClass.ClassMinstrel, DOL.GS.PlayerClass.ClassScout, DOL.GS.PlayerClass.ClassNightshade, DOL.GS.PlayerClass.ClassRanger, DOL.GS.PlayerClass.ClassHunter, and DOL.GS.PlayerClass.ClassShadowblade.

virtual bool DOL.GS.CharacterClassBase.RemoveFromWorld ( ) [virtual]

Called when player is removed from world.

Returns:

Implements DOL.GS.ICharacterClass.

Reimplemented in DOL.GS.CharacterClassNecromancer.

virtual void DOL.GS.CharacterClassBase.Shade ( bool  makeShade) [virtual]

Changes shade state of the player.

Parameters:
stateThe new state.

Implements DOL.GS.ICharacterClass.

Reimplemented in DOL.GS.CharacterClassNecromancer.

virtual bool DOL.GS.CharacterClassBase.StartAttack ( GameObject  attackTarget) [virtual]

Can this character start an attack?

Parameters:
attackTarget
Returns:

Implements DOL.GS.ICharacterClass.

Reimplemented in DOL.GS.CharacterClassNecromancer.


Member Data Documentation

int DOL.GS.CharacterClassBase.m_baseHP = 600 [protected]

BaseHP for hp calculation.

Base of this class.

Female name of class.

id of class in Client

eStat DOL.GS.CharacterClassBase.m_manaStat = eStat.UNDEFINED [protected]

Stat that affects the power/mana pool. Do not set if they do not have a power pool/spells.

Name of class.

eStat DOL.GS.CharacterClassBase.m_primaryStat = eStat.UNDEFINED [protected]

Stat gained every level. see eStat consts.

Profession of character, e.g. Defenders of Albion.

eStat DOL.GS.CharacterClassBase.m_secondaryStat = eStat.UNDEFINED [protected]

Stat gained every second level. see eStat consts.

multiplier for specialization points per level in 10th

eStat DOL.GS.CharacterClassBase.m_tertiaryStat = eStat.UNDEFINED [protected]

Stat gained every third level. see eStat consts.

int DOL.GS.CharacterClassBase.m_wsbase = 400 [protected]

Weapon Skill Base value to influence weapon skill calc.

Weapon Skill Base value to influence ranged weapon skill calc.


Property Documentation

int DOL.GS.CharacterClassBase.AdjustedSpecPointsMultiplier [get]

This is specifically used for adjusting spec points as needed for new training window For standard DOL classes this will simply return the standard spec multiplier.

Implements DOL.GS.ICharacterClass.

virtual byte DOL.GS.CharacterClassBase.HealthPercentGroupWindow [get]

Return the health percent of this character.

Implements DOL.GS.ICharacterClass.

Reimplemented in DOL.GS.CharacterClassNecromancer.

virtual ushort DOL.GS.CharacterClassBase.MaxPulsingSpells [get]
GamePlayer DOL.GS.CharacterClassBase.Player [get, set]

The GamePlayer for this character.

Implements DOL.GS.ICharacterClass.


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