| Package | com.electrotank.electroserver5.zone |
| Class | public class Zone |
| Inheritance | Zone  Object |
| Property | Defined By | ||
|---|---|---|---|
| id : int
Gets the id of the zone. | Zone | ||
| name : String
Ges the name of the zone. | Zone | ||
| rooms : Array [read-only]
Gets the list of Room objects in this zone. | Zone | ||
| Method | Defined By | ||
|---|---|---|---|
Zone()
Creates a new instance of the Zone class. | Zone | ||
addJoinedRoom(room:Room):void
Adds a room to the joinedRooms list. | Zone | ||
getJoinedRooms():Array
Gets a list of rooms in this zone that you happen to be joined to. | Zone | ||
removeJoinedRoom(room:Room):void
Removes a room from the joinedRoom list. | Zone | ||
Gets a Room by id. | Zone | ||
roomByName(name:String):Room
Gets a Room by name. | Zone | ||
| id | property |
id:intGets the id of the zone.
public function get id():int public function set id(value:int):void| name | property |
name:StringGes the name of the zone.
public function get name():String public function set name(value:String):void| rooms | property |
rooms:Array [read-only] Gets the list of Room objects in this zone.
public function get rooms():Array| Zone | () | Constructor |
public function Zone()Creates a new instance of the Zone class.
| addJoinedRoom | () | method |
public function addJoinedRoom(room:Room):voidAdds a room to the joinedRooms list.
Parameters
room:Room — room to add.
|
| getJoinedRooms | () | method |
public function getJoinedRooms():ArrayGets a list of rooms in this zone that you happen to be joined to.
ReturnsArray —
|
| removeJoinedRoom | () | method |
public function removeJoinedRoom(room:Room):voidRemoves a room from the joinedRoom list.
Parameters
room:Room — to remove.
|
| roomById | () | method |
public function roomById(id:int):RoomGets a Room by id.
Parameters
id:int — of the room to return.
|
Room — Room object with the id specified.
|
| roomByName | () | method |
public function roomByName(name:String):RoomGets a Room by name.
Parameters
name:String — of the room to return.
|
Room — Room object with the name specified.
|