Multi Theft Auto: Wiki - User contributions [en]

Element/Team

2011-03-16T05:45:27Z

Jay Deshaun: /* Related scripting functions */

__NOTOC__
The team class represents player teams. Players on the same team can use team features such as teamchat or friendly fire.

The element type of this class is: '''"team"'''.

'''NOTE:''' It is likely that the colorR/G/B values will be changed to the more standard color="#RRGGBB" before the final release.

==XML syntax==
<syntaxhighlight lang="xml">
<team name="" colorR="" colorG="" colorB="" friendlyfire=""/>
</syntaxhighlight>

===Required Attributes===
* '''name''': A name of the team

===Optional Attributes===
* '''colorR''': The red component of the team's color
* '''colorG''': The green component of the team's color
* '''colorB''': The blue component of the team's color
* '''friendlyfire''': Should friendly fire be allowed (true/false)

==Related scripting functions==
===Client===
{{Client_team_functions}}
===Server===
{{Team functions}}
[[Category:Element Types]]

Element/Team

2011-03-16T05:40:10Z

Jay Deshaun: /* Related scripting functions */

CreateTeam

2011-03-15T20:00:07Z

Jay Deshaun: /* Example */

__NOTOC__
{{Server function}}
This function is for creating a new [[team]], which can be used to group players. Players will not join the team until they are respawned.

==Syntax==
<syntaxhighlight lang="lua">
team createTeam ( string teamName, [int colorR = 255, int colorG = 255, int colorB = 255] )
</syntaxhighlight>

===Required Arguments===
*'''teamName:''' A string representing the teams name.
*'''colorR:''' An integer representing the red color value.
*'''colorG:''' An integer representing the green color value.
*'''colorB:''' An integer representing the blue color value.

===Returns===
Returns a team element if it was successfully created, ''false'' if invalid arguments are passed or a team with that name already exists.

==Example==
'''Example 1:''' This example creates a new team for a player, then adds him to it.
<syntaxhighlight lang="lua">
function gimmeATeam ( source, commandName, teamName )
local newTeam = createTeam ( teamName ) -- create a new team with the specified name
if newTeam then -- if it was successfully created
setPlayerTeam ( source, newTeam ) -- add the player to the new team
end
end
addCommandHandler ( "giveteam", gimmeATeam )
</syntaxhighlight>

'''Example 2:''' This example creates two teams, one for Admin and one for Freeroamers, when the resource this script is in is started.
<syntaxhighlight lang="lua">
function createTeamsOnStart ()
teamAdmmin = createTeam ( "Admin", 0, 255, 0 ) --change the 3 numbers(0,255,0), the first number is ColourR, the second is ColourG, and the last one is ColourB
teamFreeroamers = createTeam ( "Freeroamer", 200, 0, 100 )
end
addEventHandler ( "onResourceStart", getResourceRootElement(getThisResource()), createTeamsOnStart ) --we attach the function to this resource's root element
</syntaxhighlight>

==See Also==
{{Team_functions}}