Aardwolf MUD

Location: Home / Lua Coding / Room Properties

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
name	Room name
key	Key of room such as "aylor-12"
sector	Sector number of the room
clan	Clan the room belongs to
guild	Guild the room belongs to
healrate	Heal rate of the room
manarate	Mana rate of the room
brightness	Current brightness level of the room
peoplecount	Total number of characters in the room
playercount	Total number of players in the room
owner	Owner of the room, usually only applies in manors
repoptime	Seconds until the next repop in the area.
north	Returns an EXIT type variable for North exit
south	Returns an EXIT type variable for South exit
east	Returns an EXIT type variable for East exit
west	Returns an EXIT type variable for West exit
up	Returns an EXIT type variable for Up exit
down	Returns an EXIT type variable for Down exit
zonekey	Key of the area the room is in
zonename	Name of the area the room is in

data1	See below
data2	See below
data3	See below
data4	See below
data5	See below
zonedata1	See below
zonedata2	See below
zonedata3	See below
zonedata4	See below
zonedata5	See below

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
keyword	The exit keyword if it has one
target	Key of the room the exit leads to
open	Returns 1 if the exit is open, 0 if not
closed	Returns 1 if the exit is closed
locked	Returns 1 if the exit is locked

Data1 .. Data5 Values

The Data1 to Data5 values are numeric values that can be set on a room and are saved over a reboot. These have generic names because their purpose is not defined - it is whatever makes sense for the builder to track. Some examples may be number of times a certain action has been done in the area, an internal date after which a certain action should occur such as the loading of a mob that starts a goal, the last time the area goal was completed, etc.

The Zonedata1 to Zonedata5 values are the same thing but set at area level so the whole area shares the same 5 values. In addition to the example above this could be used to set a flag that allows a goal to start or the last time the area goal was started or completed, etc.