Shutdown: Difference between revisions
Jump to navigation
Jump to search
m (→Example) |
m (Remove old syntax) |
||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Server | {{Server function}} | ||
__NOTOC__ | __NOTOC__ | ||
This function shuts down the server. | This function shuts down the server. | ||
| Line 6: | Line 6: | ||
==Syntax== | ==Syntax== | ||
{{Added feature/item|1.5.9|1.5.8|20915| | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool shutdown ( string reason ) | bool shutdown ( [ string reason = "No reason specified", number exitCode = 0 ] ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
|20915}} | |||
=== | ===Optional Arguments=== | ||
*'''reason:''' the reason why the server has been | *'''reason:''' the reason why the server has been shutdown. | ||
{{Added feature/item|1.5.9|1.5.8|20915| | |||
*'''exitCode:''' the server application exit code to be returned on shutdown. | |||
|20915}} | |||
===Returns=== | ===Returns=== | ||
Latest revision as of 16:58, 18 August 2024
This function shuts down the server.
Make sure your server ACL setup has function.shutdown object protected.
Syntax
bool shutdown ( [ string reason = "No reason specified", number exitCode = 0 ] )
Optional Arguments
- reason: the reason why the server has been shutdown.
- exitCode: the server application exit code to be returned on shutdown.
Returns
Returns false if it was not possible to shut down the server.
Example
This command shuts down the server on request
addCommandHandler ( "shutdown", function ( player, command, reason )
if ( hasObjectPermissionTo ( player, "function.shutdown" ) ) then
shutdown ( reason or "" )
end
end )
See Also
- getMaxPlayers
- getServerConfigSetting
- getServerHttpPort
- getServerName
- getServerPassword
- getServerPort
- isGlitchEnabled
- setGlitchEnabled
- setMaxPlayers
- setServerConfigSetting
- setServerPassword
- shutdown