getPlayersInTeam | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

getPlayersInTeam

Client-side
Server-side
Shared

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

This function retrieves all the players of the specified team.

OOP Syntax Help! I don't understand this!

  • Method:team:getPlayers(...)
  • Variable: .players

Syntax 

table getPlayersInTeam ( team theTeam )
Required Arguments
  • theTeam: MISSING_PARAM_DESC

Returns

  • table: value

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.

Code Examples

shared

Find and kill all the players in the specified team (for example 'killTeam Red').

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 )

See Also

Player Functions
Player Events
Reference