SetTeamFriendlyFire: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
 
(6 intermediate revisions by 5 users not shown)
Line 1: Line 1:
[[Category:Incomplete]]
__NOTOC__
 
{{Server function}}
__NOTOC__
This function sets the friendly fire value for the specified team.
This fake function is for use with blah & blah and does blahblahblabhalbhl


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Insert syntax here             
bool setTeamFriendlyFire ( team theTeam , bool friendlyFire )
</syntaxhighlight>  
</syntaxhighlight>  
 
{{OOP||[[team]]:setFriendlyFire|friendlyFire|getTeamFriendlyFire}}
===Required Arguments===  
===Required Arguments===  
*'''argumentName:''' description
*'''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'').
===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' descriptiona
*'''argumentName3:''' description


===Returns===
===Returns===
Returns ''true'' if blah, ''false'' otherwise.
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==  
==Example==  
This example does...
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">
--This line does...
-- get a table with all teams
blabhalbalhb --abababa
local allTeams = getElementsByType ( "team" )
--This line does this...
-- for every team,
mooo
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
</syntaxhighlight>
</syntaxhighlight>


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

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



Retrieved from "https://wiki.multitheftauto.com/wiki/SetTeamFriendlyFire?oldid=53026"