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

Description r�sum�e de GameSiegeWeapon. More...

Inheritance diagram for DOL.GS.GameSiegeWeapon:
DOL.GS.GameMovingObject DOL.GS.GameNPC DOL.GS.GameLiving DOL.GS.GameObject DOL.GS.Point3D DOL.GS.Point2D DOL.GS.IPoint3D DOL.GS.IPoint2D DOL.GS.IPoint2D DOL.GS.GameSiegeBallista DOL.GS.GameSiegeCatapult DOL.GS.GameSiegeCauldron DOL.GS.GameSiegeRam DOL.GS.GameSiegeTrebuchet

List of all members.

Public Types

enum  eState { Inactive = 0x0, Armed = 0x01, Aimed = 0x02, Ready = 0x03 }
enum  eCommand {
  None = 0x00, PutAmmo = 0x01, Aim = 0x03, Fire = 0x04,
  Move = 0x05, Repair = 0x06, Salvage = 0x07, Release = 0x08
}

Public Member Functions

void TakeControl (GamePlayer player)
virtual void ReleaseControl ()
override void Die (GameObject killer)
 Called when this living dies.
void Aim ()
void Arm ()
void Move ()
void StopMove ()
void Load (int ammo)
void Aimed ()
void Armed ()
void Fire ()
virtual void DoDamage ()
void Repair ()
void salvage ()
override bool ReceiveItem (GameLiving source, DOL.Database.InventoryItem item)
override void TakeDamage (GameObject source, eDamageType damageType, int damageAmount, int criticalAmount)
 This methode is override to remove XP system.
override bool Interact (GamePlayer player)
 This function is called from the ObjectInteractRequestHandler.
override void LoadFromDatabase (DataObject obj)
 Load a npc from the npc template.
override bool AddToWorld ()
 Adds the npc to the world.
override bool RemoveFromWorld ()
 Removes the npc from the world.
override void StartHealthRegeneration ()
 Starts the health regeneration.

Public Attributes

const int SIEGE_WEAPON_CONTROLE_DISTANCE = 256
const int TIME_TO_DECAY = 60 * 1000 * 3
const int DECAYPERIOD = 240000

Protected Attributes

ArrayList m_ammo
SiegeTimer m_siegeTimer
RegionTimer m_decayTimer
readonly object m_decayTimerLock = new object()
 The lock object for lazy regen timers initialization.
int[] ActionDelay

Properties

GameKeepHookPoint HookPoint [get, set]
override Region CurrentRegion [get, set]
 Gets or Sets the current Region of the Object.
byte AmmoType [get, set]
GamePlayer Owner [get, set]
eState CurrentState [get, set]
virtual ushort Effect [get, set]
virtual ArrayList Ammo [get, set]
virtual SiegeTimer SiegeWeaponTimer [get, set]
override int MaxHealth [get]
override int Mana [get]
 npcs can always have mana to cast
int TimesRepaired [get, set]
ushort AmmoSlot [get, set]
int DecayedHp [get]
int DeductHp [get]
string ItemId [get, set]
bool EnableToMove [get, set]
static SpellLine SiegeSpellLine [get]

Detailed Description

Description r�sum�e de GameSiegeWeapon.


Member Function Documentation

override bool DOL.GS.GameSiegeWeapon.AddToWorld ( ) [virtual]

Adds the npc to the world.

Returns:
true if the npc has been successfully added

Reimplemented from DOL.GS.GameNPC.

Reimplemented in DOL.GS.GameSiegeCauldron.

override void DOL.GS.GameSiegeWeapon.Die ( GameObject  killer) [virtual]

Called when this living dies.

Reimplemented from DOL.GS.GameNPC.

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

This function is called from the ObjectInteractRequestHandler.

Parameters:
playerGamePlayer that interacts with this object
Returns:
false if interaction is prevented

Reimplemented from DOL.GS.GameNPC.

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

Load a npc from the npc template.

Parameters:
objtemplate to load from

Reimplemented from DOL.GS.GameNPC.

override bool DOL.GS.GameSiegeWeapon.RemoveFromWorld ( ) [virtual]

Removes the npc from the world.

Returns:
true if the npc has been successfully removed

Reimplemented from DOL.GS.GameNPC.

override void DOL.GS.GameSiegeWeapon.StartHealthRegeneration ( ) [virtual]

Starts the health regeneration.

Reimplemented from DOL.GS.GameLiving.

override void DOL.GS.GameSiegeWeapon.TakeDamage ( GameObject  source,
eDamageType  damageType,
int  damageAmount,
int  criticalAmount 
) [virtual]

This methode is override to remove XP system.

Parameters:
sourcethe damage source
damageTypethe damage type
damageAmountthe amount of damage
criticalAmountthe amount of critical damage

Reimplemented from DOL.GS.GameMovingObject.


Member Data Documentation

readonly object DOL.GS.GameSiegeWeapon.m_decayTimerLock = new object() [protected]

The lock object for lazy regen timers initialization.


Property Documentation

override Region DOL.GS.GameSiegeWeapon.CurrentRegion [get, set]

Gets or Sets the current Region of the Object.

Reimplemented from DOL.GS.GameNPC.

override int DOL.GS.GameSiegeWeapon.Mana [get]

npcs can always have mana to cast

Reimplemented from DOL.GS.GameNPC.


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