DOL.GS.BoatMgr Class Reference

The BoatMgr holds pointers to all player boats. More...

List of all members.

Static Public Member Functions
static bool	AddBoat (GameBoat boat)
	Adds a player boat to the list of boats.
static bool	RemoveBoat (GameBoat boat)
	Removes a player boat from the manager.
static bool	DoesBoatExist (string boatName)
	Checks if a boat with that boat name exists.
static GameBoat	CreateBoat (GamePlayer creator, GameBoat boat)
	Creates a new boat.
static bool	DeleteBoat (string boatName)
	Delete's a boat.
static GameBoat	GetBoatByName (string boatName)
	Returns a boat according to the matching name.
static GameBoat	GetBoatByBoatID (string boatid)
	Returns a boat according to the matching database ID.
static string	BoatNameToBoatID (string boatName)
	Returns a database ID for a matching boat name.
static GameBoat	GetBoatByOwner (string owner)
	Returns a boat according to the matching database boat Owner.
static ICollection	ListBoat ()
	Returns a list of boats by their status.
static bool	LoadAllBoats ()
	Load all boats from the database.
static void	SaveAllBoats ()
	Save all boats into database.
static ArrayList	GetAllBoats ()
static bool	IsBoatOwner (string playerstrID, GameBoat boat)

---

Detailed Description

The BoatMgr holds pointers to all player boats.

---

Member Function Documentation

static bool DOL.GS.BoatMgr.AddBoat

(

GameBoat

boat

)

[static]

Adds a player boat to the list of boats.

Parameters:

boat	The boat to add

Returns:

True if the function succeeded, otherwise false

static string DOL.GS.BoatMgr.BoatNameToBoatID

(

string

boatName

)

[static]

Returns a database ID for a matching boat name.

Returns:

Boat

static GameBoat DOL.GS.BoatMgr.CreateBoat	(	GamePlayer	creator,
		GameBoat	boat
	)		[static]

Creates a new boat.

Returns:

BoatEntry

static bool DOL.GS.BoatMgr.DeleteBoat

(

string

boatName

)

[static]

Delete's a boat.

Returns:

true or false

static bool DOL.GS.BoatMgr.DoesBoatExist

(

string

boatName

)

[static]

Checks if a boat with that boat name exists.

Parameters:

boatName

The boat to check

Returns:

true or false

static GameBoat DOL.GS.BoatMgr.GetBoatByBoatID

(

string

boatid

)

[static]

Returns a boat according to the matching database ID.

Returns:

Boat

static GameBoat DOL.GS.BoatMgr.GetBoatByName

(

string

boatName

)

[static]

Returns a boat according to the matching name.

Returns:

Boat

static GameBoat DOL.GS.BoatMgr.GetBoatByOwner

(

string

owner

)

[static]

Returns a boat according to the matching database boat Owner.

Returns:

Boat

static ICollection DOL.GS.BoatMgr.ListBoat

(

)

[static]

Returns a list of boats by their status.

Returns:

ArrayList of boats

static bool DOL.GS.BoatMgr.LoadAllBoats

(

)

[static]

Load all boats from the database.

static bool DOL.GS.BoatMgr.RemoveBoat

(

GameBoat

boat

)

[static]

Removes a player boat from the manager.

Parameters:

boat

the boat

Returns:

static void DOL.GS.BoatMgr.SaveAllBoats

(

)

[static]

Save all boats into database.

---

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

• C:/Users/Graveen/Documents/Dawn of Light/Svn DoL/GameServer/gameutils/BoatMgr.cs