Rooms Table
The table below lists room properties visible from Lua at the time of writing. This is not even close to complete, just a small set to test the initial Lua implementation with.
|
Property |
Description |
|
|
Room name |
|
|
Key of room such as "aylor-12" |
|
|
Sector number of the room |
|
|
Clan the room belongs to |
|
|
Guild the room belongs to |
|
|
Heal rate of the room |
|
|
Mana rate of the room |
|
|
Current brightness level of the room |
|
|
Total number of characters in the room |
|
|
Total number of players in the room |
|
|
Owner of the room, usually only applies in manors |
|
|
Returns an EXIT type variable for North exit |
|
|
Returns an EXIT type variable for South exit |
|
|
Returns an EXIT type variable for East exit |
|
|
Returns an EXIT type variable for West exit |
|
|
Returns an EXIT type variable for Up exit |
|
|
Returns an EXIT type variable for Down exit |
Exit Properties
The direction variables on a ROOM type variable return an EXIT type variable which has a set of properties of its own. The table of properties is below. As an example, the test 'if room.south.locked' will be true if there is a locked door to the south in the current room. The EXIT properties are listed below:
|
Property |
Description |
|
|
The exit keyword if it has one |
|
|
Key of the room the exit leads to |
|
|
Returns 1 if the exit is open, 0 if not |
|
|
Returns 1 if the exit is closed |
|
|
Returns 1 if the exit is locked |