GetPlayersInTeam: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(→‎Returns: Reason for it to return false.)
(OOP syntax added)
 
(One intermediate revision by one other user not shown)
Line 7: Line 7:
table getPlayersInTeam ( team theTeam )
table getPlayersInTeam ( team theTeam )
</syntaxhighlight>  
</syntaxhighlight>  
 
{{OOP||[[team]]:getPlayers|players|}}
===Arguments===  
===Arguments===  
*'''theTeam:''' The team you wish to retrieve all the players from.
*'''theTeam:''' The team you wish to retrieve all the players from.
Line 22: Line 22:
local theTeam = getTeamFromName ( teamName )
local theTeam = getTeamFromName ( teamName )
if ( theTeam ) then
if ( theTeam ) then
local players = getPlayersInTeam ( theteam )
local players = getPlayersInTeam ( theTeam )
-- Loop through the player table
-- Loop through the player table
for playerKey, playerValue in ipairs ( players ) do
for playerKey, playerValue in ipairs ( players ) do

Latest revision as of 06:46, 12 July 2014

This function retrieves all the players of the specified team.

Syntax

table getPlayersInTeam ( team theTeam )

OOP Syntax Help! I don't understand this!

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


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

Click to collapse [-]
Server

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 )
Click to collapse [-]
Client

This example will show all players in a team when a player types the 'showTeam TeamName' command.

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 )

See Also