Inheritance diagram for DOL.GS.GameRelic:

Classes
class	MiniTemp
	Returns a Template for Name and Model for the relic. More...
Public Member Functions
	GameRelic (DBRelic obj)
override bool	Interact (GamePlayer player)
	This method is called whenever a player tries to interact with this object.
virtual void	RelicPadTakesOver (GameRelicPad pad, bool returning)
override IList	GetExamineMessages (GamePlayer player)
	Adds messages to ArrayList which are sent when object is targeted.
override void	LoadFromDatabase (DataObject obj)
	Loads the GameRelic from Database.
override void	SaveIntoDatabase ()
	Saves the current GameRelic to the database.
Static Public Member Functions
static bool	IsPlayerCarryingRelic (GamePlayer player)
static MiniTemp	GetRelicTemplate (eRealm Realm, eRelicType RelicType)
Public Attributes
const string	PLAYER_CARRY_RELIC_WEAK = "IAmCarryingARelic"
Protected Member Functions
virtual void	Update ()
virtual void	PlayerTakesRelic (GamePlayer player)
	This method is called from the Interaction with the GameStaticItem.
virtual void	PlayerLoosesRelic (bool removeFromInventory)
	Is called whenever the CurrentCarrier is supposed to loose the relic.
virtual int	ReturnRelicTick (RegionTimer timer)
	when the relic is lost and ReturnRelicInterval is elapsed
virtual void	StartPlayerTimer (GamePlayer player)
	Starts the "signalising effect" sequence on the carrier.
virtual void	SetHandlers (GamePlayer player, bool activate)
	Enables or Deactivate the handlers for the carrying player behavior.
void	PlayerAbsence (DOLEvent e, object sender, EventArgs args)
Protected Attributes
const int	RelicEffectInterval = 4000
Properties
int	ReturnRelicInterval `[get]`
virtual GameRelicPad	ReturnRelicPad `[get, set]`
	The place were the relic should go if it is lost by players after the expiration timer.
eRelicType	RelicType `[get]`
	Get the RelicType (melee or magic)
eRealm	OriginalRealm `[get]`
	Get the original Realm of the relict (can only be 1(alb),2(mid) or 3(hibernia))
GameRelicPad	CurrentRelicPad `[get]`
	Returns the carriing player if there is one.
GamePlayer	CurrentCarrier `[get]`
	Returns the carriing player if there is one.
bool	IsMounted `[get]`

Member Function Documentation

override IList DOL.GS.GameRelic.GetExamineMessages ( GamePlayer player ) [virtual]

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

Parameters:

player GamePlayer that is examining this object

Returns:: list with string messages

Reimplemented from DOL.GS.GameStaticItem.

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

This method is called whenever a player tries to interact with this object.

Parameters:

player

Returns:

Reimplemented from DOL.GS.GameObject.

override void DOL.GS.GameRelic.LoadFromDatabase ( DataObject obj ) [virtual]

Loads the GameRelic from Database.

Parameters:

obj	The DBRelic-object for this relic

Reimplemented from DOL.GS.GameStaticItem.

virtual void DOL.GS.GameRelic.PlayerLoosesRelic ( bool removeFromInventory ) [protected, virtual]

Is called whenever the CurrentCarrier is supposed to loose the relic.

Parameters:

removeFromInventory Defines wheater the Item in the Inventory should be removed.

virtual void DOL.GS.GameRelic.PlayerTakesRelic ( GamePlayer player ) [protected, virtual]

This method is called from the Interaction with the GameStaticItem.

Parameters:

player

virtual int DOL.GS.GameRelic.ReturnRelicTick ( RegionTimer timer ) [protected, virtual]

when the relic is lost and ReturnRelicInterval is elapsed

override void DOL.GS.GameRelic.SaveIntoDatabase ( ) [virtual]

Saves the current GameRelic to the database.

Reimplemented from DOL.GS.GameStaticItem.

virtual void DOL.GS.GameRelic.SetHandlers	(	GamePlayer	player,
		bool	activate
	)		`[protected, virtual]`

Enables or Deactivate the handlers for the carrying player behavior.

Parameters:

player
activate

virtual void DOL.GS.GameRelic.StartPlayerTimer ( GamePlayer player ) [protected, virtual]

Starts the "signalising effect" sequence on the carrier.

Parameters:

player Player to set the timer on. Timer stops if param is null

Property Documentation

GamePlayer DOL.GS.GameRelic.CurrentCarrier [get]

Returns the carriing player if there is one.

GameRelicPad DOL.GS.GameRelic.CurrentRelicPad [get]

Returns the carriing player if there is one.

eRealm DOL.GS.GameRelic.OriginalRealm [get]

Get the original Realm of the relict (can only be 1(alb),2(mid) or 3(hibernia))

eRelicType DOL.GS.GameRelic.RelicType [get]

Get the RelicType (melee or magic)

virtual GameRelicPad DOL.GS.GameRelic.ReturnRelicPad [get, set]

The place were the relic should go if it is lost by players after the expiration timer.

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

C:/Users/Graveen/Documents/Dawn of Light/Svn DoL/GameServer/keeps/Relics/GameRelic.cs

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Properties

Member Function Documentation

Property Documentation