DOL.GS.GameStaticItem Class Reference

This class represents a static Item in the gameworld. More...

Inheritance diagram for DOL.GS.GameStaticItem:

List of all members.

Public Member Functions
	GameStaticItem ()
	Constructs a new GameStaticItem.
override string	GetName (int article, bool firstLetterUppercase)
	Returns name with article for nouns.
override IList	GetExamineMessages (GamePlayer player)
	Adds messages to ArrayList which are sent when object is targeted.
override void	LoadFromDatabase (DataObject obj)
override void	SaveIntoDatabase ()
	Saves this Item in the WorldObject DB.
override void	Delete ()
	Marks this object as deleted!
override void	DeleteFromDatabase ()
	Deletes this item from the WorldObject DB.
override bool	AddToWorld ()
	Called to create an item in the world.
override bool	RemoveFromWorld ()
	Called to remove the item from the world.
virtual bool	RemoveFromWorld (int respawnSeconds)
	Temporarily remove this static item from the world. Used mainly for quest interaction.
void	AddOwner (GameObject player)
	Adds an owner to this item.
bool	IsOwner (GameObject testOwner)
	Tests if a specific gameobject owns this item.
Protected Member Functions
virtual void	StartRespawn (int respawnSeconds)
	Starts the Respawn Timer.
virtual int	RespawnTimerCallback (RegionTimer respawnTimer)
	The callback that will respawn this object.
Protected Attributes
int	m_Emblem
	The emblem of the Object.
int	m_respawnInterval = 0
	The respawn interval of this world object.
RegionTimer	m_respawnTimer = null
	Timer used to respawn this object.
readonly object	m_respawnTimerLock = new object()
	The sync object for respawn timer modifications.
Properties
int	RespawnInterval [get, set]
override ushort	Model [get, set]
	gets or sets the model of this Item
virtual int	Emblem [get, set]
	Gets or Sets the current Emblem of the Object.
override string	Name [get, set]
	Gets or sets the name of this item.
bool	LoadedFromScript [get, set]
override ushort	Heading [get, set]
	Gets or sets the heading of this item.
override byte	Level [get, set]
	Gets or sets the level of this item.
override eRealm	Realm [get, set]
	Gets or sets the realm of this item.
GameObject[]	Owners [get]
	Returns an array of owners.

---

Detailed Description

This class represents a static Item in the gameworld.

---

Constructor & Destructor Documentation

DOL.GS.GameStaticItem.GameStaticItem

(

)

Constructs a new GameStaticItem.

---

Member Function Documentation

void DOL.GS.GameStaticItem.AddOwner

(

GameObject

player

)

Adds an owner to this item.

Parameters:

player

the object that is an owner

override bool DOL.GS.GameStaticItem.AddToWorld

(

)

[virtual]

Called to create an item in the world.

Returns:

true when created

Reimplemented from DOL.GS.GameObject.

Reimplemented in DOL.GS.SpawnDjinnStone, DOL.GS.GameStaticItemTimed, DOL.GS.Keeps.FrontiersPortalStone, DOL.GS.GameRelicPad, DOL.GS.MinotaurRelic, and DOL.GS.RealmAbilities.Statics.GenericBase.

override void DOL.GS.GameStaticItem.Delete

(

)

[virtual]

Marks this object as deleted!

Reimplemented from DOL.GS.GameObject.

Reimplemented in DOL.GS.GameStaticItemTimed, and DOL.GS.WorldInventoryItem.

override void DOL.GS.GameStaticItem.DeleteFromDatabase

(

)

[virtual]

Deletes this item from the WorldObject DB.

Reimplemented from DOL.GS.GameObject.

Reimplemented in DOL.GS.Keeps.GameKeepBanner.

override IList DOL.GS.GameStaticItem.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.GameObject.

Reimplemented in DOL.GS.Housing.GameLotMarker, and DOL.GS.GameRelic.

override string DOL.GS.GameStaticItem.GetName	(	int	article,
		bool	firstLetterUppercase
	)		[virtual]

Returns name with article for nouns.

Parameters:

article	0=definite, 1=indefinite
firstLetterUppercase	Forces the first letter of the returned string to be uppercase

Returns:

name of this object (includes article if needed)

Reimplemented from DOL.GS.GameObject.

bool DOL.GS.GameStaticItem.IsOwner

(

GameObject

testOwner

)

Tests if a specific gameobject owns this item.

Parameters:

testOwner

the owner to test for

Returns:

true if this object owns this item

override void DOL.GS.GameStaticItem.LoadFromDatabase

(

DataObject

obj

)

[virtual]

Parameters:

obj

Reimplemented from DOL.GS.GameObject.

Reimplemented in DOL.GS.Keeps.GameKeepBanner, DOL.GS.GameRelic, and DOL.GS.MinotaurRelic.

virtual bool DOL.GS.GameStaticItem.RemoveFromWorld

(

int

respawnSeconds

)

[virtual]

Temporarily remove this static item from the world. Used mainly for quest interaction.

Parameters:

respawnSeconds

Returns:

override bool DOL.GS.GameStaticItem.RemoveFromWorld

(

)

[virtual]

Called to remove the item from the world.

Returns:

true if removed

Reimplemented from DOL.GS.GameObject.

Reimplemented in DOL.GS.WorldInventoryItem, DOL.GS.Keeps.FrontiersPortalStone, and DOL.GS.GameRelicPad.

virtual int DOL.GS.GameStaticItem.RespawnTimerCallback

(

RegionTimer

respawnTimer

)

[protected, virtual]

The callback that will respawn this object.

Parameters:

respawnTimer

the timer calling this callback

Returns:

the new interval

Reimplemented in DOL.GS.MinotaurRelic.

override void DOL.GS.GameStaticItem.SaveIntoDatabase

(

)

[virtual]

Saves this Item in the WorldObject DB.

Reimplemented from DOL.GS.GameObject.

Reimplemented in DOL.GS.Housing.GameLotMarker, DOL.GS.GameRelic, and DOL.GS.MinotaurRelic.

virtual void DOL.GS.GameStaticItem.StartRespawn

(

int

respawnSeconds

)

[protected, virtual]

Starts the Respawn Timer.

---

Member Data Documentation

int DOL.GS.GameStaticItem.m_Emblem [protected]

The emblem of the Object.

int DOL.GS.GameStaticItem.m_respawnInterval = 0 [protected]

The respawn interval of this world object.

RegionTimer DOL.GS.GameStaticItem.m_respawnTimer = null [protected]

Timer used to respawn this object.

readonly object DOL.GS.GameStaticItem.m_respawnTimerLock = new object() [protected]

The sync object for respawn timer modifications.

---

Property Documentation

virtual int DOL.GS.GameStaticItem.Emblem [get, set]

Gets or Sets the current Emblem of the Object.

override ushort DOL.GS.GameStaticItem.Heading [get, set]

Gets or sets the heading of this item.

Reimplemented from DOL.GS.GameObject.

override byte DOL.GS.GameStaticItem.Level [get, set]

Gets or sets the level of this item.

Reimplemented from DOL.GS.GameObject.

override ushort DOL.GS.GameStaticItem.Model [get, set]

gets or sets the model of this Item

Reimplemented from DOL.GS.GameObject.

Reimplemented in DOL.GS.Keeps.FrontiersPortalStone, and DOL.GS.GameRelicPad.

override string DOL.GS.GameStaticItem.Name [get, set]

Gets or sets the name of this item.

Reimplemented from DOL.GS.GameObject.

Reimplemented in DOL.GS.Keeps.FrontiersPortalStone.

GameObject [] DOL.GS.GameStaticItem.Owners [get]

Returns an array of owners.

override eRealm DOL.GS.GameStaticItem.Realm [get, set]

Gets or sets the realm of this item.

Reimplemented from DOL.GS.GameObject.

Reimplemented in DOL.GS.Keeps.FrontiersPortalStone, and DOL.GS.GameRelicPad.

---

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

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