GetPlayerCount: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Example section using.)
Line 14: Line 14:


==Example==
==Example==
<section show="true" name="Server" class="server">
This example displays a chat message with the number of players connected to the server when a player joins or quits.
This example displays a chat message with the number of players connected to the server when a player joins or quits.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Line 22: Line 23:
addEventHandler ( "onPlayerQuit", getRootElement(), playerCount )
addEventHandler ( "onPlayerQuit", getRootElement(), playerCount )
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Player functions}}
{{Player functions}}

Revision as of 22:26, 14 November 2011

This function returns the number of players currently connected to the server.

Note: #getElementsByType("player") works the same as this function but also works client side unlike this function.

Syntax

int getPlayerCount ( )

Returns

Returns the number of players connected to the server as an int.

Example

Click to collapse [-]
Server

This example displays a chat message with the number of players connected to the server when a player joins or quits.

function playerCount ( )
	outputChatBox ( "There are now " .. getPlayerCount() .. " players on this server!" )
end
addEventHandler ( "onPlayerJoin", getRootElement(), playerCount )
addEventHandler ( "onPlayerQuit", getRootElement(), playerCount )

See Also