GetMaxPlayers: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (12 intermediate revisions by 8 users not shown) | |||
| 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== | ||
This example outputs the current number of players together with the maximum number of players when a player joins. | This example outputs the current number of players together with the maximum number of players when a player joins. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function showPlayers() | function showPlayers() | ||
outputChatBox("There are "..getPlayerCount().."/"..getMaxPlayers().." players playing.",source) --output a message to the joined player informing the player count and max players. | |||
outputChatBox("There are ".. | |||
end | end | ||
addEventHandler("onPlayerJoin", | addEventHandler("onPlayerJoin",root,showPlayers) --Add an event handler to call the function when a player joins. | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Server functions}} | {{Server functions}} | ||
Latest revision as of 18:52, 18 February 2016
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()
outputChatBox("There are "..getPlayerCount().."/"..getMaxPlayers().." players playing.",source) --output a message to the joined player informing the player count and max players.
end
addEventHandler("onPlayerJoin",root,showPlayers) --Add an event handler to call the function when a player joins.
See Also
- getFPSLimit
- getMaxPlayers
- getServerHttpPort
- getServerName
- getServerPassword
- getServerPort
- getVersion
- isGlitchEnabled
- isTransferBoxAlwaysVisible
- isTransferBoxVisible
- setFPSLimit
- setGlitchEnabled
- setMaxPlayers
- setServerPassword
- setTransferBoxVisible
- shutdown