Resource:Battlefield/getSquad: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Undo revision 31069 by Jaysds (talk))
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
This command retrieves a squad element when given the name or ID of a squad and the team.
__NOTOC__
==Purpose==
This command retrieves a [[Resource:Battlefield/squad|squad]] element when given the name or [[Resource:Battlefield/shortname|shortname]] of a squad and the team.


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
squad getSquad ( [string squadName, string squadID], team squadTeam )
squad getSquad ( [string squadName, string squadShortn], team squadTeam )
</syntaxhighlight>
</syntaxhighlight>


[[Resource:Battlefield]]
===Required Arguments===
*'''squadTeam:''' The [[team]] element the squad will be attached to.
 
===Optional Arguments===
*'''squadName:''' The name of the squad.
*'''squadShortn:''' The shortname of the squad.
===Returns===
Returns the ''squad element'' if it was found, otherwise ''false''.
 
==Function Source==
<syntaxhighlight lang="lua">
nameTable = { "Alpha", "Bravo", "Charlie", "Delta", "Echo", "Foxtrot", "Golf", "Hotel" }
function getSquad ( name, team )
local squads = getElementsByType ( "squad" )
for k,v in ipairs ( squads ) do
local sTeam = getElementData ( v, "team" )
if team == sTeam then
for j,l in ipairs ( nameTable ) do
shortn = string.lower ( string.sub ( l, 1, 1 ) )
if name == l or name == shortn then
return v
else
return false
end
end
else
return false
end
end
end
</syntaxhighlight>
 
 
{| width="100%" style="text-align:left; background-color:#F9F9F9; border:1px solid #AAAAAA;"
| [[Resource:Battlefield|Return to Battlefield Resource]]
|}

Latest revision as of 15:32, 22 May 2012

Purpose

This command retrieves a squad element when given the name or shortname of a squad and the team.

Syntax

squad getSquad ( [string squadName, string squadShortn], team squadTeam )

Required Arguments

  • squadTeam: The team element the squad will be attached to.

Optional Arguments

  • squadName: The name of the squad.
  • squadShortn: The shortname of the squad.

Returns

Returns the squad element if it was found, otherwise false.

Function Source

nameTable = { "Alpha", "Bravo", "Charlie", "Delta", "Echo", "Foxtrot", "Golf", "Hotel" }
function getSquad ( name, team )
	local squads = getElementsByType ( "squad" )
	for k,v in ipairs ( squads ) do
		local sTeam = getElementData ( v, "team" )
		if team == sTeam then
			for j,l in ipairs ( nameTable ) do
				shortn = string.lower ( string.sub ( l, 1, 1 ) )
				if name == l or name == shortn then
					return v
				else
					return false
				end
			end
		else
			return false
		end
	end
end


Return to Battlefield Resource