Resource:Battlefield/getSquad: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 5: | Line 5: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
squad getSquad ( | squad getSquad ( string [squadName/squadShortn], team squadTeam ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 20: | Line 20: | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
nameTable = { "Alpha", "Bravo", "Charlie", "Delta", "Echo", "Foxtrot", "Golf", "Hotel" } | nameTable = { "Alpha", "Bravo", "Charlie", "Delta", "Echo", "Foxtrot", "Golf", "Hotel" } | ||
function getSquad ( team | function getSquad ( name, team ) | ||
local squads = getElementsByType ( "squad" ) | local squads = getElementsByType ( "squad" ) | ||
for k,v in ipairs ( squads ) do | for k,v in ipairs ( squads ) do | ||
Revision as of 15:31, 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/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 |