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

Ancient bound djinn (Atlantis teleporter). This is the type that is summoned through the djinn stone. More...

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

List of all members.

Classes

class  DjinnEvent
 Event for summoning/vanishing.
class  SummonTimer
 Provides a timer for summoning.

Public Member Functions

 SummonedDjinn (DjinnStone djinnStone)
 Creates a new SummonedDjinn.
override void Summon ()
 Starts the summon.
override bool Interact (GamePlayer player)
 Interacting with the djinn resets the timer.
override bool WhisperReceive (GameLiving source, String text)
 Talking to the djinn resets the timer.
override void Notify (DOLEvent e)
 Processes events coming from the timer.

Properties

override bool IsSummoned [get]
 Returns true if djinn has been summoned, else false.

Detailed Description

Ancient bound djinn (Atlantis teleporter). This is the type that is summoned through the djinn stone.

<author>Aredhel</author>


Constructor & Destructor Documentation

DOL.GS.SummonedDjinn.SummonedDjinn ( DjinnStone  djinnStone)

Creates a new SummonedDjinn.

Parameters:
djinnStone

Member Function Documentation

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

Interacting with the djinn resets the timer.

Parameters:
player
Returns:

Reimplemented from DOL.GS.AncientBoundDjinn.

override void DOL.GS.SummonedDjinn.Notify ( DOLEvent  e) [virtual]

Processes events coming from the timer.

Parameters:
e

Reimplemented from DOL.GS.GameObject.

override void DOL.GS.SummonedDjinn.Summon ( ) [virtual]

Starts the summon.

Reimplemented from DOL.GS.AncientBoundDjinn.

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

Talking to the djinn resets the timer.

Parameters:
source
text
Returns:

Reimplemented from DOL.GS.AncientBoundDjinn.


Property Documentation

override bool DOL.GS.SummonedDjinn.IsSummoned [get]

Returns true if djinn has been summoned, else false.

Reimplemented from DOL.GS.AncientBoundDjinn.


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