GetPlayerCount: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Example section using.)
 
(17 intermediate revisions by 13 users not shown)
Line 2: Line 2:
__NOTOC__
__NOTOC__
This function returns the number of players currently connected to the server.
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.}}
Note: #getElementsByType("player") works the same as this function but also works client side unlike this function.
 
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int getPlayerCount ( )
int getPlayerCount ( )
</syntaxhighlight>
</syntaxhighlight>
 
{{OOP||[[Player]].getCount||}}
===Returns===
===Returns===
Returns the number of players connected to the server as an [[int]].
Returns the number of players connected to the server as an [[int]].


==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 20: Line 17:
outputChatBox ( "There are now " .. getPlayerCount() .. " players on this server!" )
outputChatBox ( "There are now " .. getPlayerCount() .. " players on this server!" )
end
end
addEventHandler ( "onPlayerJoin", getRootElement(), playerCount )
addEventHandler ( "onPlayerJoin", root, playerCount )
addEventHandler ( "onPlayerQuit", getRootElement(), playerCount )
addEventHandler ( "onPlayerQuit", root, playerCount )
</syntaxhighlight>
 
==Shared implementation of getPlayerCount==
''getElementsByType("player")'' returns a regular-indexed table with every player connected to the server, so by counting how many entries has the table (by using the ''#'' operator) we can archieve the same result as this function, but also clientside. However, it's more efficient to use the built-in function serverside. The next function replaces this function accordingly serverside and clientside to work on both.
<section name="Shared (client and server)" class="both" show="true">
<syntaxhighlight lang="lua">
local originalGetPlayerCount = getPlayerCount -- Store the original getPlayerCount function to a variable
 
function getPlayerCount()
    -- If originalGetPlayerCount is defined, that means that this function is executed serverside.
    -- The next line returns the result of the original function if it's defined. If not, it counts the number of player elements (to also work clientside).
    return originalGetPlayerCount and originalGetPlayerCount() or #getElementsByType("player")
end
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>


==See Also==
==See Also==
{{Player functions}}
{{Player functions|server}}
 
[[ru:getPlayerCount]]

Latest revision as of 22:41, 6 September 2024

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

[[{{{image}}}|link=|]] Note: #getElementsByType("player") works the same as this function but also works client side unlike this function.

Syntax

int getPlayerCount ( )

OOP Syntax Help! I don't understand this!

Method: Player.getCount(...)


Returns

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

Example

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", root, playerCount )
addEventHandler ( "onPlayerQuit", root, playerCount )

Shared implementation of getPlayerCount

getElementsByType("player") returns a regular-indexed table with every player connected to the server, so by counting how many entries has the table (by using the # operator) we can archieve the same result as this function, but also clientside. However, it's more efficient to use the built-in function serverside. The next function replaces this function accordingly serverside and clientside to work on both.

Click to collapse [-]
Shared (client and server)
local originalGetPlayerCount = getPlayerCount -- Store the original getPlayerCount function to a variable

function getPlayerCount()
    -- If originalGetPlayerCount is defined, that means that this function is executed serverside.
    -- The next line returns the result of the original function if it's defined. If not, it counts the number of player elements (to also work clientside).
    return originalGetPlayerCount and originalGetPlayerCount() or #getElementsByType("player")
end

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/GetPlayerCount?oldid=80392"