SetTeamFriendlyFire: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 7: | Line 7: | ||
bool setTeamFriendlyFire ( team theTeam , bool friendlyFire ) | bool setTeamFriendlyFire ( team theTeam , bool friendlyFire ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[team]]:setFriendlyFire|friendlyFire|getTeamFriendlyFire}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''theTeam:''' The team that will have friendly fire set | *'''theTeam:''' The [[team]] that will have friendly fire set | ||
*'''friendlyFire:''' | *'''friendlyFire:''' A boolean denoting whether the players from the same team can kill each other (''true'') or whether the players can't kill each other (''false''). | ||
===Returns=== | ===Returns=== | ||
| Line 18: | Line 18: | ||
This example checks if friendly fire is on for every team, and toggles it on if it isn't. | This example checks if friendly fire is on for every team, and toggles it on if it isn't. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- get a table with all teams | |||
local allTeams = getElementsByType ( "team" ) | |||
-- for every team, | -- for every team, | ||
for index, theTeam in | for index, theTeam in ipairs(allTeams) do | ||
-- if friendly fire is off, | -- if friendly fire is off, | ||
if ( getTeamFriendlyFire ( theTeam ) == false ) then | if ( getTeamFriendlyFire ( theTeam ) == false ) then | ||
Latest revision as of 16:23, 3 December 2017
This function sets the friendly fire value for the specified team.
Syntax
bool setTeamFriendlyFire ( team theTeam , bool friendlyFire )
OOP Syntax Help! I don't understand this!
- Method: team:setFriendlyFire(...)
- Variable: .friendlyFire
- Counterpart: getTeamFriendlyFire
Required Arguments
- theTeam: The team that will have friendly fire set
- friendlyFire: A boolean denoting whether the players from the same team can kill each other (true) or whether the players can't kill each other (false).
Returns
Returns true if the friendly fire value is set for the specified team, false if the friendly fire value can't be set for the specified team or if invalid arguments are specified.
Example
This example checks if friendly fire is on for every team, and toggles it on if it isn't.
-- get a table with all teams local allTeams = getElementsByType ( "team" ) -- for every team, for index, theTeam in ipairs(allTeams) do -- if friendly fire is off, if ( getTeamFriendlyFire ( theTeam ) == false ) then -- switch it on setTeamFriendlyFire ( theTeam, true ) end end
See Also
Shared
- countPlayersInTeam
- getPlayerTeam
- getPlayersInTeam
- getTeamColor
- getTeamFriendlyFire
- getTeamFromName
- getTeamName