Shutdown: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Remove old syntax) |
||
Line 6: | Line 6: | ||
==Syntax== | ==Syntax== | ||
{{Added feature/item|1.5.9|1.5.8|20915| | {{Added feature/item|1.5.9|1.5.8|20915| | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> |
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