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

The mother class for all class trainers. More...

Inheritance diagram for DOL.GS.GameTrainer:
DOL.GS.GameNPC DOL.GS.GameLiving DOL.GS.GameObject DOL.GS.Point3D DOL.GS.Point2D DOL.GS.IPoint3D DOL.GS.IPoint2D DOL.GS.IPoint2D DOL.GS.Trainer.AcolyteTrainer DOL.GS.Trainer.AlbionMaulerTrainer DOL.GS.Trainer.AlbionRogueTrainer DOL.GS.Trainer.AnimistTrainer DOL.GS.Trainer.ArmsmanTrainer DOL.GS.Trainer.BainsheeTrainer DOL.GS.Trainer.BardTrainer DOL.GS.Trainer.BerserkerTrainer DOL.GS.Trainer.BlademasterTrainer DOL.GS.Trainer.BonedancerTrainer DOL.GS.Trainer.CabalistTrainer DOL.GS.Trainer.ChampionTrainer DOL.GS.Trainer.ClericTrainer DOL.GS.Trainer.DiscipleTrainer DOL.GS.Trainer.DruidTrainer DOL.GS.Trainer.EldritchTrainer DOL.GS.Trainer.ElementalistTrainer DOL.GS.Trainer.EnchanterTrainer DOL.GS.Trainer.FighterTrainer DOL.GS.Trainer.ForesterTrainer DOL.GS.Trainer.FriarTrainer DOL.GS.Trainer.GuardianTrainer DOL.GS.Trainer.HealerTrainer DOL.GS.Trainer.HereticTrainer DOL.GS.Trainer.HeroTrainer DOL.GS.Trainer.HiberniaMaulerTrainer DOL.GS.Trainer.HunterTrainer DOL.GS.Trainer.InfiltratorTrainer DOL.GS.Trainer.MageTrainer DOL.GS.Trainer.MagicianTrainer DOL.GS.Trainer.MentalistTrainer DOL.GS.Trainer.MercenaryTrainer DOL.GS.Trainer.MidgardMaulerTrainer DOL.GS.Trainer.MidgardRogueTrainer DOL.GS.Trainer.MinstrelTrainer DOL.GS.Trainer.MysticTrainer DOL.GS.Trainer.NaturalistTrainer DOL.GS.Trainer.NecromancerTrainer DOL.GS.Trainer.NightshadeTrainer DOL.GS.Trainer.PaladinTrainer DOL.GS.Trainer.RangerTrainer DOL.GS.Trainer.ReaverTrainer DOL.GS.Trainer.RunemasterTrainer DOL.GS.Trainer.SavageTrainer DOL.GS.Trainer.ScoutTrainer DOL.GS.Trainer.SeerTrainer DOL.GS.Trainer.ShadowbladeTrainer DOL.GS.Trainer.ShamanTrainer DOL.GS.Trainer.SkaldTrainer DOL.GS.Trainer.SorcererTrainer DOL.GS.Trainer.SpiritmasterTrainer DOL.GS.Trainer.StalkerTrainer DOL.GS.Trainer.ThaneTrainer DOL.GS.Trainer.TheurgistTrainer DOL.GS.Trainer.ValewalkerTrainer DOL.GS.Trainer.ValkyrieTrainer DOL.GS.Trainer.VampiirTrainer DOL.GS.Trainer.VikingTrainer DOL.GS.Trainer.WardenTrainer DOL.GS.Trainer.WarlockTrainer DOL.GS.Trainer.WarriorTrainer DOL.GS.Trainer.WizardTrainer

List of all members.

Public Types

enum  eChampionTrainerType {
  Acolyte = 4, AlbionRogue = 2, Disciple = 7, Elementalist = 5,
  Fighter = 1, Forester = 12, Guardian = 1, Mage = 6,
  Magician = 11, MidgardRogue = 3, Mystic = 9, Naturalist = 10,
  Seer = 8, Stalker = 2, Viking = 1, None = 0
}

Public Member Functions

 GameTrainer ()
 Constructs a new GameTrainer.
 GameTrainer (eChampionTrainerType championTrainerType)
 Constructs a new GameTrainer that will also train Champion levels.
override IList GetExamineMessages (GamePlayer player)
 Adds messages to ArrayList which are sent when object is targeted.
virtual bool CanTrain (GamePlayer player)
override bool Interact (GamePlayer player)
 Interact with trainer.
bool CanTrainChampionLevels (GamePlayer player)
 Can we offer this player training for Champion levels?
override bool WhisperReceive (GameLiving source, string text)
 Talk to trainer.
override bool ReceiveItem (GameLiving source, InventoryItem item)
 For Recieving Respec Stones.
void PromotePlayer (GamePlayer player)
bool PromotePlayer (GamePlayer player, int classid, string messageToPlayer, InventoryItem[] gifts)
 Called to promote a player.
virtual bool addGift (String template, GamePlayer player)
 Add a gift to the player.
override bool AddToWorld ()
 No trainer for disabled classes.

Protected Member Functions

virtual void OfferRespecialize (GamePlayer player)
 Offer respecialize to the player.
virtual void CheckAbilityToUseItem (GamePlayer player)
 Check Ability to use Item.
virtual void CheckChampionTraining (GamePlayer player)
 If we can't train champion levels then dismiss this player.
virtual void OfferTraining (GamePlayer player)
 Offer training to the player.

Protected Attributes

eChampionTrainerType m_championTrainerType = eChampionTrainerType.None

Properties

virtual eCharacterClass TrainedClass [get]

Detailed Description

The mother class for all class trainers.


Constructor & Destructor Documentation

DOL.GS.GameTrainer.GameTrainer ( )

Constructs a new GameTrainer.

DOL.GS.GameTrainer.GameTrainer ( eChampionTrainerType  championTrainerType)

Constructs a new GameTrainer that will also train Champion levels.


Member Function Documentation

virtual bool DOL.GS.GameTrainer.addGift ( String  template,
GamePlayer  player 
) [virtual]

Add a gift to the player.

Parameters:
templatethe template ID of the item
playerthe player to give it to
Returns:
true if succesful
override bool DOL.GS.GameTrainer.AddToWorld ( ) [virtual]

No trainer for disabled classes.

Returns:

Reimplemented from DOL.GS.GameNPC.

bool DOL.GS.GameTrainer.CanTrainChampionLevels ( GamePlayer  player)

Can we offer this player training for Champion levels?

Parameters:
player
Returns:
virtual void DOL.GS.GameTrainer.CheckAbilityToUseItem ( GamePlayer  player) [protected, virtual]

Check Ability to use Item.

Parameters:
player
virtual void DOL.GS.GameTrainer.CheckChampionTraining ( GamePlayer  player) [protected, virtual]

If we can't train champion levels then dismiss this player.

Parameters:
player
override IList DOL.GS.GameTrainer.GetExamineMessages ( GamePlayer  player) [virtual]

Adds messages to ArrayList which are sent when object is targeted.

Parameters:
playerGamePlayer that is examining this object
Returns:
list with string messages

Reimplemented from DOL.GS.GameNPC.

override bool DOL.GS.GameTrainer.Interact ( GamePlayer  player) [virtual]

Interact with trainer.

Parameters:
player
Returns:

Reimplemented from DOL.GS.GameNPC.

Reimplemented in DOL.GS.Trainer.AcolyteTrainer, DOL.GS.Trainer.AlbionMaulerTrainer, DOL.GS.Trainer.AlbionRogueTrainer, DOL.GS.Trainer.ArmsmanTrainer, DOL.GS.Trainer.CabalistTrainer, DOL.GS.Trainer.ClericTrainer, DOL.GS.Trainer.DiscipleTrainer, DOL.GS.Trainer.ElementalistTrainer, DOL.GS.Trainer.FighterTrainer, DOL.GS.Trainer.FriarTrainer, DOL.GS.Trainer.HereticTrainer, DOL.GS.Trainer.InfiltratorTrainer, DOL.GS.Trainer.MageTrainer, DOL.GS.Trainer.MercenaryTrainer, DOL.GS.Trainer.MinstrelTrainer, DOL.GS.Trainer.NecromancerTrainer, DOL.GS.Trainer.PaladinTrainer, DOL.GS.Trainer.ReaverTrainer, DOL.GS.Trainer.ScoutTrainer, DOL.GS.Trainer.SorcererTrainer, DOL.GS.Trainer.TheurgistTrainer, DOL.GS.Trainer.WizardTrainer, DOL.GS.Trainer.AnimistTrainer, DOL.GS.Trainer.BainsheeTrainer, DOL.GS.Trainer.BardTrainer, DOL.GS.Trainer.BlademasterTrainer, DOL.GS.Trainer.ChampionTrainer, DOL.GS.Trainer.DruidTrainer, DOL.GS.Trainer.EldritchTrainer, DOL.GS.Trainer.EnchanterTrainer, DOL.GS.Trainer.ForesterTrainer, DOL.GS.Trainer.GuardianTrainer, DOL.GS.Trainer.HeroTrainer, DOL.GS.Trainer.HiberniaMaulerTrainer, DOL.GS.Trainer.MagicianTrainer, DOL.GS.Trainer.MentalistTrainer, DOL.GS.Trainer.NaturalistTrainer, DOL.GS.Trainer.NightshadeTrainer, DOL.GS.Trainer.RangerTrainer, DOL.GS.Trainer.StalkerTrainer, DOL.GS.Trainer.ValewalkerTrainer, DOL.GS.Trainer.VampiirTrainer, DOL.GS.Trainer.WardenTrainer, DOL.GS.Trainer.BerserkerTrainer, DOL.GS.Trainer.BonedancerTrainer, DOL.GS.Trainer.HealerTrainer, DOL.GS.Trainer.HunterTrainer, DOL.GS.Trainer.MidgardMaulerTrainer, DOL.GS.Trainer.MidgardRogueTrainer, DOL.GS.Trainer.MysticTrainer, DOL.GS.Trainer.RunemasterTrainer, DOL.GS.Trainer.SavageTrainer, DOL.GS.Trainer.SeerTrainer, DOL.GS.Trainer.ShadowbladeTrainer, DOL.GS.Trainer.ShamanTrainer, DOL.GS.Trainer.SkaldTrainer, DOL.GS.Trainer.SpiritmasterTrainer, DOL.GS.Trainer.ThaneTrainer, DOL.GS.Trainer.ValkyrieTrainer, DOL.GS.Trainer.VikingTrainer, DOL.GS.Trainer.WarlockTrainer, and DOL.GS.Trainer.WarriorTrainer.

virtual void DOL.GS.GameTrainer.OfferRespecialize ( GamePlayer  player) [protected, virtual]

Offer respecialize to the player.

Parameters:
player
virtual void DOL.GS.GameTrainer.OfferTraining ( GamePlayer  player) [protected, virtual]

Offer training to the player.

Parameters:
player
bool DOL.GS.GameTrainer.PromotePlayer ( GamePlayer  player,
int  classid,
string  messageToPlayer,
InventoryItem[]  gifts 
)

Called to promote a player.

Parameters:
playerthe player to promote
classidthe new classid
messageToPlayerthe message for the player
giftsArray of inventory items as promotion gifts
Returns:
true if successfull
override bool DOL.GS.GameTrainer.ReceiveItem ( GameLiving  source,
InventoryItem  item 
) [virtual]

For Recieving Respec Stones.

Parameters:
source
item
Returns:

Reimplemented from DOL.GS.GameLiving.

Reimplemented in DOL.GS.Trainer.FriarTrainer.

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

Talk to trainer.

Parameters:
source
text
Returns:

Reimplemented from DOL.GS.GameNPC.

Reimplemented in DOL.GS.Trainer.AcolyteTrainer, DOL.GS.Trainer.AlbionMaulerTrainer, DOL.GS.Trainer.AlbionRogueTrainer, DOL.GS.Trainer.ArmsmanTrainer, DOL.GS.Trainer.CabalistTrainer, DOL.GS.Trainer.ClericTrainer, DOL.GS.Trainer.DiscipleTrainer, DOL.GS.Trainer.ElementalistTrainer, DOL.GS.Trainer.FighterTrainer, DOL.GS.Trainer.FriarTrainer, DOL.GS.Trainer.HereticTrainer, DOL.GS.Trainer.InfiltratorTrainer, DOL.GS.Trainer.MageTrainer, DOL.GS.Trainer.MercenaryTrainer, DOL.GS.Trainer.MinstrelTrainer, DOL.GS.Trainer.NecromancerTrainer, DOL.GS.Trainer.PaladinTrainer, DOL.GS.Trainer.ReaverTrainer, DOL.GS.Trainer.ScoutTrainer, DOL.GS.Trainer.SorcererTrainer, DOL.GS.Trainer.TheurgistTrainer, DOL.GS.Trainer.WizardTrainer, DOL.GS.Trainer.AnimistTrainer, DOL.GS.Trainer.BainsheeTrainer, DOL.GS.Trainer.BardTrainer, DOL.GS.Trainer.BlademasterTrainer, DOL.GS.Trainer.ChampionTrainer, DOL.GS.Trainer.DruidTrainer, DOL.GS.Trainer.EldritchTrainer, DOL.GS.Trainer.EnchanterTrainer, DOL.GS.Trainer.ForesterTrainer, DOL.GS.Trainer.GuardianTrainer, DOL.GS.Trainer.HeroTrainer, DOL.GS.Trainer.HiberniaMaulerTrainer, DOL.GS.Trainer.MagicianTrainer, DOL.GS.Trainer.MentalistTrainer, DOL.GS.Trainer.NaturalistTrainer, DOL.GS.Trainer.NightshadeTrainer, DOL.GS.Trainer.RangerTrainer, DOL.GS.Trainer.StalkerTrainer, DOL.GS.Trainer.ValewalkerTrainer, DOL.GS.Trainer.VampiirTrainer, DOL.GS.Trainer.WardenTrainer, DOL.GS.Trainer.BerserkerTrainer, DOL.GS.Trainer.BonedancerTrainer, DOL.GS.Trainer.HealerTrainer, DOL.GS.Trainer.HunterTrainer, DOL.GS.Trainer.MidgardMaulerTrainer, DOL.GS.Trainer.MidgardRogueTrainer, DOL.GS.Trainer.MysticTrainer, DOL.GS.Trainer.RunemasterTrainer, DOL.GS.Trainer.SavageTrainer, DOL.GS.Trainer.SeerTrainer, DOL.GS.Trainer.ShadowbladeTrainer, DOL.GS.Trainer.ShamanTrainer, DOL.GS.Trainer.SkaldTrainer, DOL.GS.Trainer.SpiritmasterTrainer, DOL.GS.Trainer.ThaneTrainer, DOL.GS.Trainer.ValkyrieTrainer, DOL.GS.Trainer.VikingTrainer, DOL.GS.Trainer.WarlockTrainer, and DOL.GS.Trainer.WarriorTrainer.


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