C# Class PolaMUD.Room

Inheritance: Entity
Datei anzeigen Open project: Polatrite/PolaMUD Class Usage Examples

Public Properties

Property Type Description
Area PolaMUD.Area
Description string
Exits Exit>.Dictionary
MobResets List
Terrain Terrain

Public Methods

Method Description
Display ( Player player ) : void

Show the Room to Player, including all contents.

GetThing ( Type reference, string name ) : Thing

Get a Thing from the room with the provided Type (Mob, Player, etc.) that matches Name.

Load ( XmlNode room ) : void

Loads a new room from the provided XmlNode.

Load ( XmlNode room, PolaMUD.Area area ) : void

Loads a new room from the provided XmlNode while automatically setting the area that the room belongs to.

Room ( int number ) : System

Creates a new room with the specified IndexNumber and adds it to Global.RoomTable.

SendMessage ( string message ) : void
SendMessage ( string message, string mobileMessage ) : void

Send a message to all valid Mobs in the Room.

SendMobileMessage ( string mobileMessage ) : void
ToString ( ) : string

Displays the short descriptive string of the room.

Method Details

Display() public method

Show the Room to Player, including all contents.
public Display ( Player player ) : void
player Player
return void

GetThing() public method

Get a Thing from the room with the provided Type (Mob, Player, etc.) that matches Name.
public GetThing ( Type reference, string name ) : Thing
reference System.Type The Type to search for (Mob, Player, etc.)
name string Name to match
return Thing

Load() public method

Loads a new room from the provided XmlNode.
public Load ( XmlNode room ) : void
room System.Xml.XmlNode
return void

Load() public method

Loads a new room from the provided XmlNode while automatically setting the area that the room belongs to.
public Load ( XmlNode room, PolaMUD.Area area ) : void
room System.Xml.XmlNode
area PolaMUD.Area
return void

Room() public method

Creates a new room with the specified IndexNumber and adds it to Global.RoomTable.
public Room ( int number ) : System
number int
return System

SendMessage() public method

public SendMessage ( string message ) : void
message string
return void

SendMessage() public method

Send a message to all valid Mobs in the Room.
public SendMessage ( string message, string mobileMessage ) : void
message string
mobileMessage string
return void

SendMobileMessage() public method

public SendMobileMessage ( string mobileMessage ) : void
mobileMessage string
return void

ToString() public method

Displays the short descriptive string of the room.
public ToString ( ) : string
return string

Property Details

Area public_oe property

public Area,PolaMUD Area
return PolaMUD.Area

Description public_oe property

public string Description
return string

Exits public_oe property

public Dictionary Exits
return Exit>.Dictionary

MobResets public_oe property

public List MobResets
return List

Terrain public_oe property

public Terrain,PolaMUD Terrain
return Terrain