GetMaxPlayers: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(10 intermediate revisions by 6 users not shown)
Line 10: Line 10:


==Example==
==Example==
<section name="Server" class="server" show="true">
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()
local maxPlayers = getMaxPlayers() -- get maximum number of players on the server
outputChatBox("There are "..getPlayerCount().."/"..getMaxPlayers().." players playing.",source) --output a message to the joined player informing the player count and max players.
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
end
addEventHandler("onPlayerJoin",getRootElement(),showPlayers) -- add the Event for "onPlayerJoin" that will call the "showPlayers" function
addEventHandler("onPlayerJoin",root,showPlayers) --Add an event handler to call the function when a player joins.
</syntaxhighlight> </section>
</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