GetPlayersInTeam

2014-03-31T20:41:38Z

Shortybsd: /* Example */

__NOTOC__
{{Server client function}}
This function retrieves all the players of the specified team.

==Syntax==
<syntaxhighlight lang="lua">
table getPlayersInTeam ( team theTeam )
</syntaxhighlight>

===Arguments===
*'''theTeam:''' The team you wish to retrieve all the players from.

===Returns===
Returns a [[table]] of all the players in the team, or an empty one if there are none else false if invalid arguments are passed.

==Example==
<section name="Server" class="server" show="true">
Find and kill all the players in the specified team (for example 'killTeam Red').
<syntaxhighlight lang="lua">
function killTeamFunction ( thePlayer, command, teamName )
-- Find and kill all the players in the team that was specified with the console command
local theTeam = getTeamFromName ( teamName )
if ( theTeam ) then
local players = getPlayersInTeam ( theTeam )
-- Loop through the player table
for playerKey, playerValue in ipairs ( players ) do
-- kill the player
killPlayer ( playerValue )
end
end
end

addCommandHandler ( "killTeam", killTeamFunction )
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
This example will show all players in a team when a player types the 'showTeam TeamName' command.
<syntaxhighlight lang="lua">
function showTeamFunction ( command, teamName )
-- Find and show all the players in the team that was specified with the console command
local theTeam = getTeamFromName ( teamName )
if ( theTeam ) then
local players = getPlayersInTeam ( theTeam )
-- Loop through the player table
for playerKey, playerValue in ipairs ( players ) do
outputChatBox ( getPlayerName(playerValue) )
end
end
end

addCommandHandler ( "showTeam", showTeamFunction )
</syntaxhighlight>
</section>

==See Also==
{{Team functions}}

Multi Theft Auto: Wiki - User contributions [en]

GetPlayersInTeam