Destroyed lua API CreateRoom() (markdown)
@@ -1,36 +0,0 @@
|
||||
## Calling
|
||||
|
||||
This is a breakdown of the parameters needed for CreateRoom().
|
||||
|
||||
There are three ways to use this function:
|
||||
|
||||
--string as the sole parameter
|
||||
local room = CreateRoom("room name")
|
||||
--the room can be initialized later
|
||||
Initialize(room, arguments...)
|
||||
|
||||
or
|
||||
|
||||
--the list of parameters
|
||||
local room = CreateRoom("room name", arguments...)
|
||||
|
||||
or
|
||||
|
||||
--a table containing the parameters, with the room name as element 1
|
||||
local argTable = {
|
||||
arguments...
|
||||
}
|
||||
local room = CreateRoom("room name", argTable)
|
||||
|
||||
Rooms can be initialized with `Initialize()` at any time, but doing so will overwrite the old settings of that room, and at this stage, the side effects can't be predicted.
|
||||
|
||||
## Parameter List
|
||||
|
||||
In each of the above examples, a list of parameters is needed. The mandatory parameters are listed here in order:
|
||||
|
||||
* Room Name: a string indicating the name of the room; this cannot be changed after the room's creation
|
||||
* Tileset Name: a string indicating the tileset the clients should use for this room
|
||||
* Pager.Load: The function used for loading Region data
|
||||
* Pager.Save: The function used for saving Region data
|
||||
* Pager.Create: The function used for creating Region data
|
||||
* Pager.Unload: The function used for unloading Region data
|
||||
Reference in New Issue
Block a user