CreateTeam: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server functions}}
{{Server function}}
This function is for creating a new [[team]], which can be used to group players.
This function is for creating a new [[team]], which can be used to group players.



Revision as of 18:02, 15 August 2007

This function is for creating a new team, which can be used to group players.

Syntax

team createTeam ( string teamName, [int colorR = 255, int colorG = 255, int colorB = 255] )

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.

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
    addPlayerToTeam ( source, newTeam ) -- add the player to the new team
  end
end
addCommandHandler ( "giveteam", gimmeATeam )

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

function createTeamsOnStart ()
	teamGrove = createTeam ( "grove", 0, 255, 0 )
	teamBallas = createTeam ( "ballas", 200, 0, 100 )
end
addEventHandler ( "onResourceStart", getResourceRootElement(getThisResource()), createTeamsOnStart  ) --we attach the function to this resource's root element

See Also