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

This class represents an inventory item. More...

Inheritance diagram for DOL.GS.GuildBannerItem:
DOL.GS.GameInventoryItem DOL.GS.IGameInventoryItem

List of all members.

Public Types

enum  eStatus { Active = 1, Dropped = 2, Recovered = 3 }

Public Member Functions

 GuildBannerItem (ItemTemplate template)
 GuildBannerItem (InventoryItem item)
override void OnReceive (GamePlayer player)
 Player receives this item (added to players inventory)
override void OnLose (GamePlayer player)
 Player has dropped, traded, or otherwise lost this item.
override WorldInventoryItem Drop (GamePlayer player)
 Drop this item on the ground.
override void OnRemoveFromWorld ()
 This object is being removed from the world.
override bool CheckValid (GamePlayer player)
 Is this a valid item for this player?

Properties

Guild OwnerGuild [get, set]
 What guild owns this banner.
GamePlayer SummonPlayer [get, set]
eStatus Status [get]

Detailed Description

This class represents an inventory item.


Member Function Documentation

override bool DOL.GS.GuildBannerItem.CheckValid ( GamePlayer  player) [virtual]

Is this a valid item for this player?

Parameters:
player
Returns:

Reimplemented from DOL.GS.GameInventoryItem.

override WorldInventoryItem DOL.GS.GuildBannerItem.Drop ( GamePlayer  player) [virtual]

Drop this item on the ground.

Parameters:
player
Returns:

Reimplemented from DOL.GS.GameInventoryItem.

override void DOL.GS.GuildBannerItem.OnLose ( GamePlayer  player) [virtual]

Player has dropped, traded, or otherwise lost this item.

Parameters:
player

Reimplemented from DOL.GS.GameInventoryItem.

override void DOL.GS.GuildBannerItem.OnReceive ( GamePlayer  player) [virtual]

Player receives this item (added to players inventory)

Parameters:
player

Reimplemented from DOL.GS.GameInventoryItem.

override void DOL.GS.GuildBannerItem.OnRemoveFromWorld ( ) [virtual]

This object is being removed from the world.

Reimplemented from DOL.GS.GameInventoryItem.


Property Documentation

Guild DOL.GS.GuildBannerItem.OwnerGuild [get, set]

What guild owns this banner.


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