GetAlivePlayers: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
 
(13 intermediate revisions by 9 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__
This function returns a table of all the alive players
{{Server function}}
This function returns a table of all the alive players on the server. Opposite function of [[getDeadPlayers]].


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
table getAlivePlayers ( void )
table getAlivePlayers ( )
</syntaxhighlight>
</syntaxhighlight>
 
{{OOP||[[Player]].getAllAlive||}}
===Returns===
===Returns===
Returns a table of all the alive players.
Returns a table of all the alive players.


==Example==
==Example==
This example prints a list of all alive players in a "name, name2, name3" format.  If no players are alive then it outputs "none".
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- Print a list of all the alive players
-- Print a list of all the alive players
  alivePlayers = getAlivePlayers ()
alivePlayers = getAlivePlayers ()
  if ( alivePlayers ) then -- if we got the table
if ( alivePlayers ) then -- if we got the table
     alivePlayersList = "none"
     alivePlayersList = "none"
     -- Loop through the table
     -- Loop through the table
     for playerKey, playerValue in alivePlayers do
     for playerKey, playerValue in ipairs(alivePlayers) do
      -- add their name to the list
        -- add their name to the list
      if ( alivePlayersList == "none" ) then
        if ( alivePlayersList == "none" ) then
        alivePlayersList = getClientName ( playerValue )
            alivePlayersList = getPlayerName ( playerValue )
      else
        else
        alivePlayersList = alivePlayersList .. ", " .. getClientName ( playerValue )
            alivePlayersList = alivePlayersList .. ", " .. getPlayerName ( playerValue )
      end
        end
     end
     end
     outputChatBox ( "Alive Players: " .. alivePlayersList )     
     outputChatBox ( "Alive Players: " .. alivePlayersList )     
  end
end
</syntaxhighlight>
</syntaxhighlight>


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

Latest revision as of 22:40, 6 September 2024

This function returns a table of all the alive players on the server. Opposite function of getDeadPlayers.

Syntax

table getAlivePlayers ( )

OOP Syntax Help! I don't understand this!

Method: Player.getAllAlive(...)


Returns

Returns a table of all the alive players.

Example

This example prints a list of all alive players in a "name, name2, name3" format. If no players are alive then it outputs "none". 

-- Print a list of all the alive players
alivePlayers = getAlivePlayers ()
if ( alivePlayers ) then -- if we got the table
    alivePlayersList = "none"
    -- Loop through the table
    for playerKey, playerValue in ipairs(alivePlayers) do
        -- add their name to the list
        if ( alivePlayersList == "none" ) then
            alivePlayersList = getPlayerName ( playerValue )
        else
            alivePlayersList = alivePlayersList .. ", " .. getPlayerName ( playerValue )
        end
    end
    outputChatBox ( "Alive Players: " .. alivePlayersList )    
end

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/GetAlivePlayers?oldid=80388"