DOL.GS.GameBoat Class Reference

Inheritance diagram for DOL.GS.GameBoat:

List of all members.

Public Member Functions
	GameBoat (byte type)
override bool	AddToWorld ()
	Adds the npc to the world.
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.
bool	CanSeeBoat (GamePlayer player, GameBoat boat)
	Checks if a player can see the boat.
override bool	Interact (GamePlayer player)
	Must overide interact for Game Boat - Cannot allow boarders on player boat.
override void	LoadFromDatabase (DataObject obj)
	Loads this boat from a boat table.
override void	SaveIntoDatabase ()
	Saves a mob into the db if it exists, it is updated, else it creates a new object in the DB.
Protected Member Functions
int	RemoveCallback (RegionTimer timer)
Protected Attributes
DBBoat	m_dbBoat
Properties
DBBoat	theBoatDB [get, set]
	Gets or sets the boats db.
string	BoatID [get, set]
override string	Name [get, set]
	Gets or sets the name of this npc.
override ushort	Model [get, set]
	Gets or sets the model of this npc.
override short	MaxSpeedBase [get, set]
	Gets or sets the base max speed of this living.
string	BoatOwner [get, set]
override int	MAX_PASSENGERS [get]
	The maximum passengers the NPC can take.
override int	REQUIRED_PASSENGERS [get]
	The minimum number of passengers required to move.
override int	SLOT_OFFSET [get]
	The slot offset for this NPC.

---

Member Function Documentation

override bool DOL.GS.GameBoat.AddToWorld

(

)

[virtual]

Adds the npc to the world.

Returns:

true if the npc has been successfully added

Reimplemented from DOL.GS.GameNPC.

bool DOL.GS.GameBoat.CanSeeBoat	(	GamePlayer	player,
		GameBoat	boat
	)

Checks if a player can see the boat.

override bool DOL.GS.GameBoat.Interact

(

GamePlayer

player

)

[virtual]

Must overide interact for Game Boat - Cannot allow boarders on player boat.

Parameters:

player

Returns:

Reimplemented from DOL.GS.GameNPC.

override void DOL.GS.GameBoat.LoadFromDatabase

(

DataObject

obj

)

[virtual]

Loads this boat from a boat table.

Parameters:

obj

Reimplemented from DOL.GS.GameNPC.

override bool DOL.GS.GameBoat.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:

forced	if true, the dismounting can't be prevented by handlers
player	the player that is dismounting

Returns:

true if dismounted successfully

Reimplemented from DOL.GS.GameNPC.

override bool DOL.GS.GameBoat.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:

rider	GamePlayer that is the rider
forced	if true, mounting can't be prevented by handlers

Returns:

true if mounted successfully

Reimplemented from DOL.GS.GameNPC.

override void DOL.GS.GameBoat.SaveIntoDatabase

(

)

[virtual]

Saves a mob into the db if it exists, it is updated, else it creates a new object in the DB.

Reimplemented from DOL.GS.GameNPC.

---

Property Documentation

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

The maximum passengers the NPC can take.

Reimplemented from DOL.GS.GameNPC.

override short DOL.GS.GameBoat.MaxSpeedBase [get, set]

Gets or sets the base max speed of this living.

Reimplemented from DOL.GS.GameLiving.

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

Gets or sets the model of this npc.

Reimplemented from DOL.GS.GameMovingObject.

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

Gets or sets the name of this npc.

Reimplemented from DOL.GS.GameNPC.

override int DOL.GS.GameBoat.REQUIRED_PASSENGERS [get]

The minimum number of passengers required to move.

Reimplemented from DOL.GS.GameNPC.

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

The slot offset for this NPC.

Reimplemented from DOL.GS.GameNPC.

DBBoat DOL.GS.GameBoat.theBoatDB [get, set]

Gets or sets the boats db.

---

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

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