GetTeamFriendlyFire: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
(OOP syntax added) |
||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | {{Server client function}} | ||
This function | __NOTOC__ | ||
This function tells you if friendly fire is turned on for the specified team. | |||
==Syntax== | ==Syntax== | ||
| Line 6: | Line 7: | ||
bool getTeamFriendlyFire ( team theTeam ) | bool getTeamFriendlyFire ( team theTeam ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[team]]:getFriendlyFire|friendlyFire|setTeamFriendlyFire}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''theTeam:''' The team that will be checked | *'''theTeam:''' The team object that will be checked | ||
===Returns=== | ===Returns=== | ||
Returns ''true'' if friendly fire is on for the specified team, ''false'' if | Returns ''true'' if friendly fire is on for the specified team, ''false'' if it is turned off or if invalid arguments are specified. | ||
==Example== | ==Example== | ||
This example checks if friendly fire is on for | This example makes a command that checks if friendly fire is on for each team, and toggles it on if it isn't. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- | function setFriendlyFireOn ( ) | ||
for index, theTeam in getElementsByType ( "team" ) do | -- For each team, | ||
for index, theTeam in ipairs ( getElementsByType("team") ) do | |||
-- if friendly fire is off, | |||
if ( getTeamFriendlyFire ( theTeam ) == false ) then | |||
-- switch it on. | |||
setTeamFriendlyFire ( theTeam, true ) | |||
end | |||
end | end | ||
end | end | ||
-- Add console command 'setFF' | |||
addCommandHandler ( "setFF", setFriendlyFireOn ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Team functions}} | {{Team functions}} | ||
Latest revision as of 06:48, 12 July 2014
This function tells you if friendly fire is turned on for the specified team.
Syntax
bool getTeamFriendlyFire ( team theTeam )
OOP Syntax Help! I don't understand this!
- Method: team:getFriendlyFire(...)
- Variable: .friendlyFire
- Counterpart: setTeamFriendlyFire
Required Arguments
- theTeam: The team object that will be checked
Returns
Returns true if friendly fire is on for the specified team, false if it is turned off or if invalid arguments are specified.
Example
This example makes a command that checks if friendly fire is on for each team, and toggles it on if it isn't.
function setFriendlyFireOn ( )
-- For each team,
for index, theTeam in ipairs ( getElementsByType("team") ) do
-- if friendly fire is off,
if ( getTeamFriendlyFire ( theTeam ) == false ) then
-- switch it on.
setTeamFriendlyFire ( theTeam, true )
end
end
end
-- Add console command 'setFF'
addCommandHandler ( "setFF", setFriendlyFireOn )
See Also
- countPlayersInTeam
- getPlayerTeam
- getPlayersInTeam
- getTeamColor
- getTeamFriendlyFire
- getTeamFromName
- getTeamName