Add to Server Only comments.

This commit is contained in:
Rolln 2024-08-20 13:28:55 -06:00
parent ee13344155
commit e4ed4df2b1

View File

@ -91,6 +91,7 @@ function net.json2lua(json) end
function net.kick(playerId, message) end function net.kick(playerId, message) end
--- # SERVER ONLY --- # SERVER ONLY
--- - Not available in the Mission scripting environment.
---___ ---___
---Loads the specified mission.<br> ---Loads the specified mission.<br>
---Example: Loads a mission from your saved games/missions folder. ---Example: Loads a mission from your saved games/missions folder.
@ -102,6 +103,7 @@ function net.kick(playerId, message) end
function net.load_mission(fileName) end function net.load_mission(fileName) end
--- # SERVER ONLY --- # SERVER ONLY
--- - Not available in the Mission scripting environment.
---___ ---___
---Loads the next mission from the server mission list. ---Loads the next mission from the server mission list.
---@return boolean -- True if the next mission was successfully loaded, false if at the end of the list. ---@return boolean -- True if the next mission was successfully loaded, false if at the end of the list.
@ -175,6 +177,7 @@ function net.get_chat_history(from) end
---@field banned_until number Unix time of ban end. ---@field banned_until number Unix time of ban end.
--- # SERVER ONLY --- # SERVER ONLY
--- - Not available in the Mission scripting environment.
---___ ---___
---Returns an array of active ban records. ---Returns an array of active ban records.
---___ ---___
@ -191,6 +194,7 @@ function net.banlist_get() end
--- # SERVER ONLY --- # SERVER ONLY
--- - Not available in the Mission scripting environment.
---___ ---___
---Adds a ban and kicks the player of 'id'. <br> ---Adds a ban and kicks the player of 'id'. <br>
---'period' is the duration of ban in seconds. ---'period' is the duration of ban in seconds.
@ -203,6 +207,7 @@ function net.banlist_add(id, period, reason) end
--- # SERVER ONLY --- # SERVER ONLY
--- - Not available in the Mission scripting environment.
---___ ---___
---Lifts the ban from a player with the given 'ucid'. ---Lifts the ban from a player with the given 'ucid'.
---___ ---___
@ -217,6 +222,7 @@ function net.banlist_remove(ucid) end
---@field current string Name of the current mission. ---@field current string Name of the current mission.
--- # SERVER ONLY --- # SERVER ONLY
--- - Not available in the Mission scripting environment.
---___ ---___
---Returns a table with current mission list. ---Returns a table with current mission list.
---___ ---___
@ -230,6 +236,7 @@ function net.banlist_remove(ucid) end
function net.missionlist_get() end function net.missionlist_get() end
--- # SERVER ONLY --- # SERVER ONLY
--- - Not available in the Mission scripting environment.
---___ ---___
---Adds a mission to the list. ---Adds a mission to the list.
---___ ---___
@ -238,6 +245,7 @@ function net.missionlist_get() end
function net.missionlist_append(miz_filename) end function net.missionlist_append(miz_filename) end
--- # SERVER ONLY --- # SERVER ONLY
--- - Not available in the Mission scripting environment.
---___ ---___
---Deletes a mission from the list at the given index. ---Deletes a mission from the list at the given index.
---___ ---___
@ -246,6 +254,7 @@ function net.missionlist_append(miz_filename) end
function net.missionlist_delete(miz_index) end function net.missionlist_delete(miz_index) end
--- # SERVER ONLY --- # SERVER ONLY
--- - Not available in the Mission scripting environment.
---___ ---___
---Moves a mission to a new location in the list. ---Moves a mission to a new location in the list.
---___ ---___
@ -255,6 +264,7 @@ function net.missionlist_delete(miz_index) end
function net.missionlist_move(old_index, new_index) end function net.missionlist_move(old_index, new_index) end
--- # SERVER ONLY --- # SERVER ONLY
--- - Not available in the Mission scripting environment.
---___ ---___
---Set the server to shuffle, or not to shuffle, the mission list. ---Set the server to shuffle, or not to shuffle, the mission list.
---___ ---___
@ -262,6 +272,7 @@ function net.missionlist_move(old_index, new_index) end
function net.missionlist_set_shuffle(bool) end function net.missionlist_set_shuffle(bool) end
--- # SERVER ONLY --- # SERVER ONLY
--- - Not available in the Mission scripting environment.
---___ ---___
---Set the server to loop, or not to loop, the mission list. ---Set the server to loop, or not to loop, the mission list.
---___ ---___
@ -269,6 +280,7 @@ function net.missionlist_set_shuffle(bool) end
function net.missionlist_set_loop(bool) end function net.missionlist_set_loop(bool) end
--- # SERVER ONLY --- # SERVER ONLY
--- - Not available in the Mission scripting environment.
---___ ---___
---Runs a mission at the given index. ---Runs a mission at the given index.
---___ ---___
@ -277,6 +289,7 @@ function net.missionlist_set_loop(bool) end
function net.missionlist_run(miz_index) end function net.missionlist_run(miz_index) end
--- # SERVER ONLY --- # SERVER ONLY
--- - Not available in the Mission scripting environment.
---___ ---___
---Clear the entire mission list. ---Clear the entire mission list.
---___ ---___