GetMaxPlayers

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

Click to collapse [-]

Server

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

• getFPSLimit
• getMaxPlayers
• getServerHttpPort
• getServerName
• getServerPassword
• getServerPort
• getVersion
• isGlitchEnabled
• isTransferBoxAlwaysVisible
• isTransferBoxVisible
• setFPSLimit
• setGlitchEnabled
• setMaxPlayers
• setServerPassword
• setTransferBoxVisible
• shutdown