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

Ancient bound djinn (Atlantis teleporter). More...

Inheritance diagram for DOL.GS.AncientBoundDjinn:
DOL.GS.GameTeleporter 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.PermanentDjinn DOL.GS.SummonedDjinn

List of all members.

Public Member Functions

 AncientBoundDjinn (DjinnStone djinnStone)
 Creates a new djinn.
virtual void Summon ()
 Summon the djinn.
override bool Interact (GamePlayer player)
 Player right-clicked the djinn.
override bool WhisperReceive (GameLiving source, String text)
 Talk to the djinn.
override bool Say (String message)
 "Say" content sent to the system window.

Protected Member Functions

override bool GetTeleportLocation (GamePlayer player, string text)
override void OnSubSelectionPicked (GamePlayer player, Teleport subSelection)
 Player has picked a subselection.
override void OnDestinationPicked (GamePlayer player, Teleport destination)
 Player has picked a teleport destination.
override void OnTeleport (GamePlayer player, Teleport destination)
 Teleport the player to the designated coordinates.

Properties

virtual new byte Size [get]
 Gets the actual size.
virtual int HoverHeight [get]
 Gets the height at which the djinn is hovering.
override String Type [get]
 Teleporter type, needed to pick the right TeleportID.
override eRealm DestinationRealm [get]
 The destination realm.
ushort VisibleModel [get]
 Pick a model for this zone.
virtual bool IsSummoned [get]
 Whether or not the djinn is summoned.

Detailed Description

Ancient bound djinn (Atlantis teleporter).

<author>Aredhel</author>


Constructor & Destructor Documentation

DOL.GS.AncientBoundDjinn.AncientBoundDjinn ( DjinnStone  djinnStone)

Creates a new djinn.


Member Function Documentation

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

Player right-clicked the djinn.

Parameters:
player
Returns:

Reimplemented from DOL.GS.GameTeleporter.

Reimplemented in DOL.GS.SummonedDjinn.

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

Player has picked a teleport destination.

Parameters:
player
destination

Reimplemented from DOL.GS.GameTeleporter.

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

Player has picked a subselection.

Parameters:
player
subSelection

Reimplemented from DOL.GS.GameTeleporter.

override void DOL.GS.AncientBoundDjinn.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.AncientBoundDjinn.Say ( String  message)

"Say" content sent to the system window.

Parameters:
message
Returns:
virtual void DOL.GS.AncientBoundDjinn.Summon ( ) [virtual]

Summon the djinn.

Reimplemented in DOL.GS.SummonedDjinn.

override bool DOL.GS.AncientBoundDjinn.WhisperReceive ( GameLiving  source,
String  text 
)

Talk to the djinn.

Parameters:
source
text
Returns:

Reimplemented in DOL.GS.SummonedDjinn.


Property Documentation

override eRealm DOL.GS.AncientBoundDjinn.DestinationRealm [get, protected]

The destination realm.

Reimplemented from DOL.GS.GameTeleporter.

virtual int DOL.GS.AncientBoundDjinn.HoverHeight [get, protected]

Gets the height at which the djinn is hovering.

Reimplemented in DOL.GS.PermanentDjinn.

virtual bool DOL.GS.AncientBoundDjinn.IsSummoned [get]

Whether or not the djinn is summoned.

Reimplemented in DOL.GS.SummonedDjinn.

virtual new byte DOL.GS.AncientBoundDjinn.Size [get, protected]

Gets the actual size.

Reimplemented from DOL.GS.GameNPC.

Reimplemented in DOL.GS.PermanentDjinn.

override String DOL.GS.AncientBoundDjinn.Type [get, protected]

Teleporter type, needed to pick the right TeleportID.

Reimplemented from DOL.GS.GameTeleporter.

ushort DOL.GS.AncientBoundDjinn.VisibleModel [get, protected]

Pick a model for this zone.


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