DOL.GS.SimpleTeleporter Class Reference

Simple Teleporter. This teleporter uses the npc guild name to determine available teleport locations in the Teleport table PackageID is used for the text displayed to the player. More...

Inheritance diagram for DOL.GS.SimpleTeleporter:

List of all members.

Public Member Functions
override bool	Interact (GamePlayer player)
	Player right-clicked the teleporter.
override bool	WhisperReceive (GameLiving source, string text)
	Talk to the teleporter.
Protected Member Functions
void	LoadDestinations ()
	Use the NPC Guild Name to find all the valid destinations for this teleporter.
override void	OnDestinationPicked (GamePlayer player, Teleport destination)
	Player has picked a destination.
override void	OnTeleport (GamePlayer player, Teleport destination)
	Teleport the player to the designated coordinates.
Properties
override 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.
override bool	ShowTeleporterIndicator [get]
	Display the teleport indicator around this teleporters feet.

---

Detailed Description

Simple Teleporter. This teleporter uses the npc guild name to determine available teleport locations in the Teleport table PackageID is used for the text displayed to the player.

Example: Add this npc to the world and set guild name to 'My Teleports' Go to a location you want to teleport too and use the command /teleport 'location name' 'My Teleports'

You can whisper refresh to this teleporter to reload the teleport locations

<author>Tolakram; from SI teleporter created by Aredhel</author>

---

Member Function Documentation

override bool DOL.GS.SimpleTeleporter.Interact

(

GamePlayer

player

)

[virtual]

Player right-clicked the teleporter.

Parameters:

player

Returns:

Reimplemented from DOL.GS.GameTeleporter.

void DOL.GS.SimpleTeleporter.LoadDestinations

(

)

[protected]

Use the NPC Guild Name to find all the valid destinations for this teleporter.

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

Player has picked a destination.

Parameters:

player
destination

Reimplemented from DOL.GS.GameTeleporter.

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

Teleport the player to the designated coordinates.

Parameters:

player
destination

Reimplemented from DOL.GS.GameTeleporter.

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

Talk to the teleporter.

Parameters:

source
text

Returns:

Reimplemented from DOL.GS.GameTeleporter.

---

Property Documentation

override bool DOL.GS.SimpleTeleporter.ShowTeleporterIndicator [get]

Display the teleport indicator around this teleporters feet.

Reimplemented from DOL.GS.GameNPC.

override string DOL.GS.SimpleTeleporter.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 from DOL.GS.GameTeleporter.

---

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

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