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

GameMovingObject is a base class for boats and siege weapons. More...

Inheritance diagram for DOL.GS.GameSiegeRam:
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

List of all members.

Public Member Functions

override ushort Type ()
override void DoDamage ()
override bool RiderMount (GamePlayer rider, bool forced)
 This function is called when a rider mounts this npc Since only players can ride NPC's you should use the GamePlayer.MountSteed function instead to make sure all callbacks are called correctly.
override bool RiderDismount (bool forced, GamePlayer player)
 Called to dismount a rider from this npc. Since only players can ride NPC's you should use the GamePlayer.MountSteed function instead to make sure all callbacks are called correctly.
override void ReleaseControl ()
void UpdateRamStatus ()

Properties

override int MAX_PASSENGERS [get]
 The maximum passengers the NPC can take.
override int SLOT_OFFSET [get]
 The slot offset for this NPC.
override int AttackRange [get]
 Returns the AttackRange of this living.
override short MaxSpeed [get]
 Gets the maxspeed of this living.

Detailed Description

GameMovingObject is a base class for boats and siege weapons.


Member Function Documentation

override bool DOL.GS.GameSiegeRam.RiderDismount ( bool  forced,
GamePlayer  player 
) [virtual]

Called to dismount a rider from this npc. Since only players can ride NPC's you should use the GamePlayer.MountSteed function instead to make sure all callbacks are called correctly.

Parameters:
forcedif true, the dismounting can't be prevented by handlers
playerthe player that is dismounting
Returns:
true if dismounted successfully

Reimplemented from DOL.GS.GameNPC.

override bool DOL.GS.GameSiegeRam.RiderMount ( GamePlayer  rider,
bool  forced 
) [virtual]

This function is called when a rider mounts this npc Since only players can ride NPC's you should use the GamePlayer.MountSteed function instead to make sure all callbacks are called correctly.

Parameters:
riderGamePlayer that is the rider
forcedif true, mounting can't be prevented by handlers
Returns:
true if mounted successfully

Reimplemented from DOL.GS.GameNPC.


Property Documentation

override int DOL.GS.GameSiegeRam.AttackRange [get]

Returns the AttackRange of this living.

Reimplemented from DOL.GS.GameLiving.

override int DOL.GS.GameSiegeRam.MAX_PASSENGERS [get]

The maximum passengers the NPC can take.

Reimplemented from DOL.GS.GameNPC.

override short DOL.GS.GameSiegeRam.MaxSpeed [get]

Gets the maxspeed of this living.

Reimplemented from DOL.GS.GameLiving.

override int DOL.GS.GameSiegeRam.SLOT_OFFSET [get]

The slot offset for this NPC.

Reimplemented from DOL.GS.GameNPC.


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