Exports
- Added
- Updated
Server side
openEditorFor
Opens a session for one player.
| Arguments | Returns |
|---|---|
src: integer, request?: Editor.Request | boolean |
openEditorForAndWait
Opens a session and waits for the player to finish.
| Arguments | Returns |
|---|---|
src: integer, request?: Editor.Request | Editor.Result|nil |
closeEditorFor
Closes the player's session.
| Arguments | Returns |
|---|---|
src: integer | boolean |
isEditorActiveFor
Reports whether this server holds a session for the player.
| Arguments | Returns |
|---|---|
src: integer | boolean |
getWeather
Returns the server weather state.
| Arguments | Returns |
|---|---|
| None | Weather.State |
updateWeather
Changes any supplied weather-state fields.
| Arguments | Returns |
|---|---|
payload: Weather.UpdatePayload | boolean, string|nil |
setWeather
Changes the weather type.
| Arguments | Returns |
|---|---|
weatherType: string, transition?: number | boolean, string|nil |
setTime
Changes the time.
| Arguments | Returns |
|---|---|
hour: integer, minute?: integer | boolean, string|nil |
setFreezeTime
Freezes or resumes the clock.
| Arguments | Returns |
|---|---|
freeze: boolean | boolean, string|nil |
setDynamicWeather
Enables or disables the automatic weather cycle.
| Arguments | Returns |
|---|---|
enabled: boolean | boolean, string|nil |
setBlackout
Enables or disables blackout.
| Arguments | Returns |
|---|---|
enabled: boolean | boolean, string|nil |
formatRecords
Renders records without opening the editor.
| Arguments | Returns |
|---|---|
records: Editor.Record[], spec?: Format.Spec|function | string |
startPlacementFor
Start placement for a player.
| Arguments | Returns |
|---|---|
src: integer, request: Placement.Request | boolean |
startPlacementForAndWait
Wait for completion; returns nil on disconnect or failure to start.
| Arguments | Returns |
|---|---|
src: integer, request: Placement.Request | Placement.Result|nil |
cancelPlacementFor
Cancel placement for a player.
| Arguments | Returns |
|---|---|
src: integer | boolean |
isPlacementActiveFor
Check whether the player has a placement session.
| Arguments | Returns |
|---|---|
src: integer | boolean |
Client side
openEditor
Opens a session without waiting.
| Arguments | Returns |
|---|---|
request?: Editor.Request | boolean |
openEditorAndWait
Opens a session and waits for it to finish.
| Arguments | Returns |
|---|---|
request?: Editor.Request | Editor.Result|nil |
saveEditor
Saves the active session.
| Arguments | Returns |
|---|---|
| None | boolean |
closeEditor
Closes the active session without saving.
| Arguments | Returns |
|---|---|
| None | boolean |
isEditorActive
Reports whether the editor is active.
| Arguments | Returns |
|---|---|
| None | boolean |
getEditorSession
Returns the active session summary.
| Arguments | Returns |
|---|---|
| None | Editor.SessionInfo|nil |
getEditorRecords
Returns a snapshot of the current records.
| Arguments | Returns |
|---|---|
| None | Editor.Record[] |
getEditorResult
Builds the current result.
| Arguments | Returns |
|---|---|
reason?: SessionReason | Editor.Result |
placeSelected
Starts aim placement for the current selection.
| Arguments | Returns |
|---|---|
| None | boolean |
placeEntity
Starts aim placement for an entity handle.
| Arguments | Returns |
|---|---|
entityHandle: integer, isNew?: boolean | boolean |
getWeather
Returns the last weather state received by the client.
| Arguments | Returns |
|---|---|
| None | Weather.State|nil |
formatRecords
Renders records without opening the editor.
| Arguments | Returns |
|---|---|
records: Editor.Record[], spec?: Format.Spec|function | string |
startPlacement
Start placement without waiting.
| Arguments | Returns |
|---|---|
request: Placement.Request | boolean |
startPlacementAndWait
Wait for placement to finish.
| Arguments | Returns |
|---|---|
request: Placement.Request | Placement.Result|nil |
cancelPlacement
Cancel placement.
| Arguments | Returns |
|---|---|
| — | boolean |
finishPlacement
Finish early once minCount is met.
| Arguments | Returns |
|---|---|
| — | boolean |
isPlacementActive
Check whether placement is active.
| Arguments | Returns |
|---|---|
| — | boolean |
getPlacementState
Return the current placement state.
| Arguments | Returns |
|---|---|
| — | Placement.State|nil |
Type definitions
The complete request, result, format, and weather-state types are declared in annotations.lua.