GetMaxPlayers: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server function}} | |||
This function returns the maximum number of player slots on the server. | This function returns the maximum number of player slots on the server. | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">int getMaxPlayers ()</syntaxhighlight> | <syntaxhighlight lang="lua">int getMaxPlayers ()</syntaxhighlight> | ||
===Returns=== | ===Returns=== | ||
Returns the maximum number of players allowed on the server. | Returns the maximum number of players allowed on the server. | ||
==Example== | ==Example== | ||
Revision as of 13:24, 3 August 2007
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 maxPlayers = getMaxPlayers() -- get maximum number of players on the server
local players = getElementsByType("player") -- get a table of all current players
outputChatBox("There are "..#players.."/"..maxPlayers.." players playing",source) -- output a message to the joining player
end
addEventHandler("onPlayerJoin",getRootElement(),showPlayers) -- add the Event for "onPlayerJoin" that will call the "showPlayers" function
See Also
- getMaxPlayers
- getServerConfigSetting
- getServerHttpPort
- getServerName
- getServerPassword
- getServerPort
- isGlitchEnabled
- setGlitchEnabled
- setMaxPlayers
- setServerConfigSetting
- setServerPassword
- shutdown