GetPlayersInTeam - Revision history

MarioKart: OOP syntax added

2014-07-12T06:46:55Z

OOP syntax added

← Older revision		Revision as of 06:46, 12 July 2014
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.

Shortybsd: /* Example */

2014-03-31T20:41:38Z

Example

← Older revision		Revision as of 20:41, 31 March 2014
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

Jaysds1: /* Returns */ Reason for it to return false.

2013-07-16T23:45:02Z

Returns: Reason for it to return false.

← Older revision		Revision as of 23:45, 16 July 2013
Line 12:		Line 12:

	===Returns===		===Returns===
	Returns a [[table]] of all the players in the team, or an empty one if there are none.		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==		==Example==

Arc at 14:57, 19 August 2007

2007-08-19T14:57:18Z

← Older revision		Revision as of 14:57, 19 August 2007
Line 15:		Line 15:

	==Example==		==Example==
			<section name="Server" class="server" show="true">
	Find and kill all the players in the specified team (for example 'killTeam Red').		Find and kill all the players in the specified team (for example 'killTeam Red').
	~~<section name="Server" class="server" show="true">~~
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function killTeamFunction(~~player~~,command,teamName)		function killTeamFunction ( thePlayer, command, teamName )
	-- Find and kill all the players in a team ~~called "red"~~		-- Find and kill all the players in the team that was specified with the console command
	local ~~team~~ = getTeamFromName ( teamName )		local theTeam = getTeamFromName ( teamName )
	if ( ~~team~~ ) then		if ( theTeam ) then
	local players = getPlayersInTeam ( ~~team~~ )		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
	-- kill the player		-- kill the player
	killPlayer ( playerValue )		killPlayer ( playerValue )
Line 31:		Line 31:
	end		end

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

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

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

EAi: I assume the team isn't an optional argument?

2007-08-08T03:22:30Z

I assume the team isn't an optional argument?

← Older revision		Revision as of 03:22, 8 August 2007
Line 8:		Line 8:
	</syntaxhighlight>		</syntaxhighlight>

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

Driver2 at 11:49, 7 August 2007

2007-08-07T11:49:36Z

← Older revision		Revision as of 11:49, 7 August 2007
Line 12:		Line 12:

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

	==Example==		==Example==
	Find and kill all the players in the specified team (for example 'killTeam Red').		Find and kill all the players in the specified team (for example 'killTeam Red').
			<section name="Server" class="server" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function killTeamFunction(player,command,teamName)		function killTeamFunction(player,command,teamName)
Line 32:		Line 33:
	addCommandHandler("killTeam",killTeamFunction)		addCommandHandler("killTeam",killTeamFunction)
	</syntaxhighlight>		</syntaxhighlight>
			</section>

			This example will show all players in a team, when a player types the 'showTeam TeamName' command.
			<section name="Client" class="client">
			<syntaxhighlight lang="lua">
			function showTeamFunction(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
			outputChatBox ( getPlayerName(playerValue) )
			end
			end
			end

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

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

Driver2 at 11:34, 7 August 2007

2007-08-07T11:34:11Z

← Older revision		Revision as of 11:34, 7 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
			{{Server client function}}
	This function retrieves all the players of the specified team.		This function retrieves all the players of the specified team.

Driver2 at 11:33, 7 August 2007

2007-08-07T11:33:58Z

← Older revision		Revision as of 11:33, 7 August 2007
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"

Driver2 at 14:08, 27 July 2007

2007-07-27T14:08:56Z

← Older revision		Revision as of 14:08, 27 July 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	This function ~~is for retrieving~~ all the players in the specified team.		This function retrieves all the players of the specified team.

	==Syntax==		==Syntax==
Line 11:		Line 11:

	===Returns===		===Returns===
	Returns a table of all the players in the team.		Returns a table of all the players in the team, or an empty one if there are none.

	==Example==		==Example==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	-- Find and kill all the players in a team called "red"		-- Find and kill all the players in the specified team (for example 'killTeam Red').
	~~redTeam~~ = getTeamFromName ( ~~"red"~~ )		function killTeamFunction(player,command,teamName)
	if ( ~~redTeam~~ ) then		-- Find and kill all the players in a team called "red"
	players = getPlayersInTeam ( ~~redTeam~~ )		local team = getTeamFromName ( teamName )
	-- Loop through the player table		if ( team ) then
	for playerKey, playerValue in ipairs(players) do		local players = getPlayersInTeam ( team )
	-- kill the player		-- Loop through the player table
	killPlayer ( playerValue )		for playerKey, playerValue in ipairs(players) do
	end		-- kill the player
			killPlayer ( playerValue )
			end
			end
	end		end

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

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

VRocker2: /* Example */

2007-05-06T22:30:35Z

Example

← Older revision		Revision as of 22:30, 6 May 2007
Line 20:		Line 20:
	players = getPlayersInTeam ( redTeam )		players = getPlayersInTeam ( redTeam )
	-- Loop through the player table		-- Loop through the player table
	for playerKey, playerValue in players do		for playerKey, playerValue in ipairs(players) do
	-- kill the player		-- kill the player
	killPlayer ( playerValue )		killPlayer ( playerValue )