DOL.GS.GameMerchant Class Reference

Represents an in-game merchant. More...

Inheritance diagram for DOL.GS.GameMerchant:

List of all members.

Public Member Functions
	GameMerchant ()
	Constructor.
override IList	GetExamineMessages (GamePlayer player)
override bool	Interact (GamePlayer player)
	Called when a player right clicks on the merchant.
virtual void	SendMerchantWindow (GamePlayer player)
	send the merchants item offer window to a player
virtual void	OnPlayerBuy (GamePlayer player, int item_slot, int number)
	Called when a player buys an item.
virtual void	OnPlayerSell (GamePlayer player, InventoryItem item)
	Called when a player sells something.
virtual long	OnPlayerAppraise (GamePlayer player, InventoryItem item, bool silent)
	Called to appraise the value of an item.
override void	LoadTemplate (INpcTemplate template)
	Load a NPC template onto this NPC.
override void	LoadFromDatabase (DataObject merchantobject)
	Loads a merchant from the DB.
override void	SaveIntoDatabase ()
	Saves a merchant into the DB.
override void	DeleteFromDatabase ()
	Deletes a merchant from the DB.
Static Public Member Functions
static void	OnPlayerBuy (GamePlayer player, int item_slot, int number, MerchantTradeItems TradeItems)
	Called when a player buys an item.
Protected Member Functions
virtual void	SendMerchantWindowCallback (object state)
	Sends merchant window from threadpool thread.
Protected Attributes
MerchantTradeItems	m_tradeItems
	Items available for sale.
Properties
MerchantTradeItems	TradeItems [get, set]
	Gets the items available from this merchant.

---

Detailed Description

Represents an in-game merchant.

---

Constructor & Destructor Documentation

DOL.GS.GameMerchant.GameMerchant

(

)

Constructor.

---

Member Function Documentation

override void DOL.GS.GameMerchant.DeleteFromDatabase

(

)

[virtual]

Deletes a merchant from the DB.

Reimplemented from DOL.GS.GameNPC.

override IList DOL.GS.GameMerchant.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.GameNPC.

Reimplemented in DOL.GS.GameHousingHastener.

override bool DOL.GS.GameMerchant.Interact

(

GamePlayer

player

)

[virtual]

Called when a player right clicks on the merchant.

Parameters:

player

Player that interacted with the merchant

Returns:

True if succeeded

Reimplemented from DOL.GS.GameNPC.

Reimplemented in DOL.GS.ArtifactCreditMerchant, and DOL.GS.GameItemCurrencyMerchant.

override void DOL.GS.GameMerchant.LoadFromDatabase

(

DataObject

merchantobject

)

[virtual]

Loads a merchant from the DB.

Parameters:

merchantobject

The merchant DB object

Reimplemented from DOL.GS.GameNPC.

override void DOL.GS.GameMerchant.LoadTemplate

(

INpcTemplate

template

)

[virtual]

Load a NPC template onto this NPC.

Parameters:

template

Reimplemented from DOL.GS.GameNPC.

virtual long DOL.GS.GameMerchant.OnPlayerAppraise	(	GamePlayer	player,
		InventoryItem	item,
		bool	silent
	)		[virtual]

Called to appraise the value of an item.

Parameters:

player	The player whose item needs appraising
item	The item to be appraised
silent

Returns:

The price this merchant will pay for the offered items

virtual void DOL.GS.GameMerchant.OnPlayerBuy	(	GamePlayer	player,
		int	item_slot,
		int	number
	)		[virtual]

Called when a player buys an item.

Parameters:

player	The player making the purchase
item_slot	slot of the item to be bought
number	Number to be bought

Returns:

true if buying is allowed, false if buying should be prevented

Reimplemented in DOL.GS.GameBountyMerchant, DOL.GS.GameChampionMerchant, and DOL.GS.GameItemCurrencyMerchant.

static void DOL.GS.GameMerchant.OnPlayerBuy	(	GamePlayer	player,
		int	item_slot,
		int	number,
		MerchantTradeItems	TradeItems
	)		[static]

Called when a player buys an item.

Parameters:

player	The player making the purchase
item_slot	slot of the item to be bought
number	Number to be bought
TradeItems

Returns:

true if buying is allowed, false if buying should be prevented

virtual void DOL.GS.GameMerchant.OnPlayerSell	(	GamePlayer	player,
		InventoryItem	item
	)		[virtual]

Called when a player sells something.

Parameters:

player	Player making the sale
item	The InventoryItem to be sold

Returns:

true if selling is allowed, false if it should be prevented

override void DOL.GS.GameMerchant.SaveIntoDatabase

(

)

[virtual]

Saves a merchant into the DB.

Reimplemented from DOL.GS.GameNPC.

virtual void DOL.GS.GameMerchant.SendMerchantWindow

(

GamePlayer

player

)

[virtual]

send the merchants item offer window to a player

Parameters:

player

virtual void DOL.GS.GameMerchant.SendMerchantWindowCallback

(

object

state

)

[protected, virtual]

Sends merchant window from threadpool thread.

Parameters:

state

The game player to send to

Reimplemented in DOL.GS.GameBountyMerchant, and DOL.GS.GameItemCurrencyMerchant.

---

Member Data Documentation

MerchantTradeItems DOL.GS.GameMerchant.m_tradeItems [protected]

Items available for sale.

---

Property Documentation

MerchantTradeItems DOL.GS.GameMerchant.TradeItems [get, set]

Gets the items available from this merchant.

---

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

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