GetMaxPlayers: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 4: | Line 4: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">int getMaxPlayers ( | <syntaxhighlight lang="lua">int getMaxPlayers ()</syntaxhighlight> | ||
===Returns=== | ===Returns=== | ||
| Line 14: | Line 14: | ||
function showPlayers() | function showPlayers() | ||
local numPlayers = getPlayerCount() -- get number of currently connected players | local numPlayers = getPlayerCount() -- get number of currently connected players | ||
local maxPlayers = getMaxPlayers( | local maxPlayers = getMaxPlayers() -- get maximum number of players on the server | ||
outputChatBox("There are " .. numPlayers .. "/" .. maxPlayers .. " players playing", source) -- output a message to the joining player | outputChatBox("There are " .. numPlayers .. "/" .. maxPlayers .. " players playing", source) -- output a message to the joining player | ||
end | end | ||
Revision as of 14:46, 16 December 2014
This function returns the maximum number of player slots on the server.
Syntax
int getMaxPlayers ()
Returns
Returns the maximum number of players allowed on the server.
Example
This example outputs the current number of players together with the maximum number of players when a player joins.
function showPlayers()
local numPlayers = getPlayerCount() -- get number of currently connected players
local maxPlayers = getMaxPlayers() -- get maximum number of players on the server
outputChatBox("There are " .. numPlayers .. "/" .. maxPlayers .. " players playing", source) -- output a message to the joining player
end
addEventHandler("onPlayerJoin", getRootElement(), showPlayers) -- add the function as a handler for the "onPlayerJoin" event
See Also
- getMaxPlayers
- getServerConfigSetting
- getServerHttpPort
- getServerName
- getServerPassword
- getServerPort
- isGlitchEnabled
- setGlitchEnabled
- setMaxPlayers
- setServerConfigSetting
- setServerPassword
- shutdown