GetPlayersInTeam: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 14: Line 14:


==Example==
==Example==
Find and kill all the players in the specified team (for example 'killTeam Red').
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- Find and kill all the players in the specified team (for example 'killTeam Red').
function killTeamFunction(player,command,teamName)
function killTeamFunction(player,command,teamName)
-- Find and kill all the players in a team called "red"
-- Find and kill all the players in a team called "red"

Revision as of 11:33, 7 August 2007

This function retrieves all the players of the specified team.

Syntax

table getPlayersInTeam ( team theTeam )

Optional 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.

Example

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

function killTeamFunction(player,command,teamName)
	-- Find and kill all the players in a team called "red"
	local team = getTeamFromName ( teamName )
	if ( team ) then
		local players = getPlayersInTeam ( team )  
		-- 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