Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

---

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.

OOP Syntax Help! I don't understand this!

• Method: Team.create(...)

Syntax

team createTeam ( string teamName, [ int colorR = 235, int colorG = 221, int colorB = 178 ] )

Required Arguments

• teamName: A string representing the teams name.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use.

• colorR (default: 235): An integer representing the red color value.
• colorG (default: 221): An integer representing the green color value.
• colorB (default: 178): An integer representing the blue color value.

Returns

• team: value

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

Code Examples

Example 1 Example 2 Example 3

shared

Example 1:This example creates a new team for a player, then adds him to it.

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)

shared

Example 2:This example creates two teams, one for Admin and one for Freeroamers, when the resource this script is in is started.

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", resourceRoot, createTeamsOnStart) -- we attach the function to this resource's root element

shared

Example 3:This example creates a team for Admin and when an admin logs in, he will be set in the Admin team.

function createAdminTeamOnStart()
    AdminTeam = createTeam("Admin", 0, 255, 0) -- create a new team and name it 'Admin'
end
addEventHandler("onResourceStart", resourceRoot, createAdminTeamOnStart) -- add an event handler

function setAdminTeam()
    if isObjectInACLGroup("user." .. getAccountName(getPlayerAccount(source)), aclGetGroup("Admin")) then -- if he is admin
        setPlayerTeam(source, AdminTeam) -- set him to admin team
    end
end
addEventHandler("onPlayerLogin", root, setAdminTeam) -- add an event handler

See Also

Team Functions

• createTeam
• getTeamColor
• getTeamFriendlyFire
• getTeamFromName
• getTeamName
• setTeamColor
• setTeamFriendlyFire
• setTeamName

Team Elements

• team

Reference

• Scripting Functions