DOL.GS.GameTeleporter Class Reference

Base class for all teleporter type NPCs. More...

Inheritance diagram for DOL.GS.GameTeleporter:

List of all members.

Public Member Functions
override bool	Interact (GamePlayer player)
	Turn the teleporter to face the player.
override bool	WhisperReceive (GameLiving source, string text)
	Talk to the teleporter.
Protected Member Functions
virtual bool	GetTeleportLocation (GamePlayer player, string text)
virtual void	OnDestinationPicked (GamePlayer player, Teleport destination)
	Player has picked a destination. Override if you need the teleporter to say something to the player before porting him.
virtual void	OnSubSelectionPicked (GamePlayer player, Teleport subSelection)
	Player has picked a subselection. Override to pass teleport options on to the player.
virtual void	OnTeleportSpell (GamePlayer player, Teleport destination)
	Teleport the player to the designated coordinates using the portal spell.
virtual void	OnTeleport (GamePlayer player, Teleport destination)
	Teleport the player to the designated coordinates.
Properties
virtual String	Type [get]
	The type of teleporter; this is used in order to be able to handle identical TeleportIDs differently, depending on the actual teleporter.
virtual eRealm	DestinationRealm [get]
	The destination realm.

---

Detailed Description

Base class for all teleporter type NPCs.

<author>Aredhel</author>

---

Member Function Documentation

override bool DOL.GS.GameTeleporter.Interact

(

GamePlayer

player

)

[virtual]

Turn the teleporter to face the player.

Parameters:

player

Returns:

Reimplemented from DOL.GS.GameNPC.

Reimplemented in DOL.GS.AncientBoundDjinn, DOL.GS.SummonedDjinn, DOL.GS.AlbionSITeleporter, DOL.GS.AlbionTeleporter, DOL.GS.HiberniaSITeleporter, DOL.GS.HiberniaTeleporter, DOL.GS.MidgardSITeleporter, DOL.GS.MidgardTeleporter, and DOL.GS.SimpleTeleporter.

virtual void DOL.GS.GameTeleporter.OnDestinationPicked	(	GamePlayer	player,
		Teleport	destination
	)		[protected, virtual]

Player has picked a destination. Override if you need the teleporter to say something to the player before porting him.

Parameters:

player
destination

Reimplemented in DOL.GS.AncientBoundDjinn, DOL.GS.AlbionSITeleporter, DOL.GS.AlbionTeleporter, DOL.GS.HiberniaSITeleporter, DOL.GS.HiberniaTeleporter, DOL.GS.MidgardSITeleporter, DOL.GS.MidgardTeleporter, and DOL.GS.SimpleTeleporter.

virtual void DOL.GS.GameTeleporter.OnSubSelectionPicked	(	GamePlayer	player,
		Teleport	subSelection
	)		[protected, virtual]

Player has picked a subselection. Override to pass teleport options on to the player.

Parameters:

player
subSelection

Reimplemented in DOL.GS.AncientBoundDjinn, DOL.GS.AlbionTeleporter, DOL.GS.HiberniaTeleporter, and DOL.GS.MidgardTeleporter.

virtual void DOL.GS.GameTeleporter.OnTeleport	(	GamePlayer	player,
		Teleport	destination
	)		[protected, virtual]

Teleport the player to the designated coordinates.

Parameters:

player
destination

Reimplemented in DOL.GS.AncientBoundDjinn, DOL.GS.AlbionSITeleporter, DOL.GS.AlbionTeleporter, DOL.GS.HiberniaSITeleporter, DOL.GS.HiberniaTeleporter, DOL.GS.MidgardSITeleporter, DOL.GS.MidgardTeleporter, and DOL.GS.SimpleTeleporter.

virtual void DOL.GS.GameTeleporter.OnTeleportSpell	(	GamePlayer	player,
		Teleport	destination
	)		[protected, virtual]

Teleport the player to the designated coordinates using the portal spell.

Parameters:

player
destination

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

Talk to the teleporter.

Parameters:

source
text

Returns:

Reimplemented from DOL.GS.GameNPC.

Reimplemented in DOL.GS.SimpleTeleporter.

---

Property Documentation

virtual eRealm DOL.GS.GameTeleporter.DestinationRealm [get, protected]

The destination realm.

Reimplemented in DOL.GS.AncientBoundDjinn.

virtual String DOL.GS.GameTeleporter.Type [get, protected]

The type of teleporter; this is used in order to be able to handle identical TeleportIDs differently, depending on the actual teleporter.

Reimplemented in DOL.GS.AncientBoundDjinn, and DOL.GS.SimpleTeleporter.

---

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

• C:/Users/Graveen/Documents/Dawn of Light/Svn DoL/GameServer/gameobjects/GameTeleporter.cs