Teams
CreatorHub

The Teams service holds a game's Team objects. Team objects must be parented to the Teams service.

Instances of this class cannot be created with Instance.new.

It is a singleton that may be acquired with GetService.

Memory category	Instances

Tags: [NotCreatable, Service]

Member index 2

History		Member
648		GetTeams(): Instances
573		RebalanceTeams(): null
63 members inherited from Instance
553		Archivable: bool
553		Attributes: string
553		AttributesReplicate: string
553		AttributesSerialize: BinaryString
635		Capabilities: SecurityCapabilities
553		DataCost: int
619		DefinesCapabilities: bool
553		HistoryId: UniqueId
553		Name: string
553		Parent: Instance
553		PropertyStatusStudio: PropertyStatus
553		RobloxLocked: bool
635		Sandboxed: bool
616		SourceAssetId: int64
553		Tags: BinaryString
616		UniqueId: UniqueId
553		archivable: bool
553		numExpectedDirectChildren: int
576		AddTag(tag: string): null
573		ClearAllChildren(): null
462		Clone(): Instance
573		Destroy(): null
486		FindFirstAncestor(name: string): Instance
486		FindFirstAncestorOfClass(className: string): Instance
486		FindFirstAncestorWhichIsA(className: string): Instance
486		FindFirstChild(name: string, recursive: bool = false): Instance
486		FindFirstChildOfClass(className: string): Instance
486		FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486		FindFirstDescendant(name: string): Instance
563		GetActor(): Actor
486		GetAttribute(attribute: string): Variant
462		GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631		GetAttributes(): Dictionary
648		GetChildren(): Instances
462		GetDebugId(scopeLength: int = 4): string
486		GetDescendants(): Array
486		GetFullName(): string
641		GetStyled(name: string): Variant
576		GetTags(): Array
576		HasTag(tag: string): bool
486		IsAncestorOf(descendant: Instance): bool
486		IsDescendantOf(ancestor: Instance): bool
580		IsPropertyModified(name: string): bool
573		Remove(): null
576		RemoveTag(tag: string): null
580		ResetPropertyToDefault(name: string): null
573		SetAttribute(attribute: string, value: Variant): null
462		WaitForChild(childName: string, timeOut: double): Instance
648		children(): Instances
553		clone(): Instance
573		destroy(): null
553		findFirstChild(name: string, recursive: bool = false): Instance
648		getChildren(): Instances
553		isDescendantOf(ancestor: Instance): bool
573		remove(): null
462		AncestryChanged(child: Instance, parent: Instance)
462		AttributeChanged(attribute: string)
462		ChildAdded(child: Instance)
462		ChildRemoved(child: Instance)
462		DescendantAdded(descendant: Instance)
462		DescendantRemoving(descendant: Instance)
500		Destroying()
553		childAdded(child: Instance)
6 members inherited from Object
647		ClassName: string
647		className: string
647		GetPropertyChangedSignal(property: string): RBXScriptSignal
647		IsA(className: string): bool
650		isA(className: string): bool
647		Changed(property: string)

Description

The Teams service holds a game's Team objects. Team objects must be parented to the Teams service.

Teams offer a range of features that are useful to developers. These can broadly be divided into features that work out-of-the-box and features developers can program into their game.

Built-in team behavior The following functionality of Teams exists by default and does not require the developer to program any custom behavior.

When part of a Team, the name above a player's character Model will be colored to the Team.TeamColor
Changing Player.TeamColor will cause Player.Team switch to the Team with the corresponding Team.TeamColor
When using the default player list users will be grouped and displayed by team
Setting Player.Neutral to true will cause the Player to be dis-associated with the team, but will not change Player.Team or Player.TeamColor
When a Player joins a game, they will be allocated to the team with Team.AutoAssignable set to true that has the fewest players. If no auto assignable team is available, Player.Neutral will be set to true
When SpawnLocation.Neutral is set to false, only players whose Player.TeamColor matches SpawnLocation.TeamColor can spawn on that SpawnLocation
When SpawnLocation.AllowTeamChangeOnTouch is set to true, a player's Player.TeamColor will change to SpawnLocation.TeamColor when their character touches the SpawnLocation

Optional extended team behavior Many developers chose to add the following features to teams in their own code.

Implement checks for team in weapon code to prevent team killing
Implement doors or other features that only certain teams can use
Periodically reassign teams to maintain team balance

History 8
Hide member changes

648 Change ReturnType of GetTeams from Objects to Instances
573 Change ReturnType of RebalanceTeams from void to null
462 Change ThreadSafety of RebalanceTeams from to Unsafe
462 Change ThreadSafety of GetTeams from to Unsafe
208 Change Tags of RebalanceTeams from [] to [Deprecated]
47 Add RebalanceTeams
47 Add GetTeams
47 Add Teams

Members 2

GetTeams
CreatorHub

Parameters (0)
No parameters.
Returns (1)
Instances

The GetTeam function returns a table containing the game's Team objects.

Note this will only return Team objects that are directly parented to the Teams service. For this reason it is recommended developers only parent Team objects to the Teams service and not to other Instances (or to each other).

Thread safety	Unsafe

History 3

648 Change ReturnType of GetTeams from Objects to Instances
462 Change ThreadSafety of GetTeams from to Unsafe
47 Add GetTeams

RebalanceTeams
CreatorHub

Parameters (0)
No parameters.
Returns (1)
null

Evens the number of people on each team. This function does not work correctly and should not be used.

It exists only for backward compatibility, and should not be used for new work.

Thread safety	Unsafe

History 4

573 Change ReturnType of RebalanceTeams from void to null
462 Change ThreadSafety of RebalanceTeams from to Unsafe
208 Change Tags of RebalanceTeams from [] to [Deprecated]
47 Add RebalanceTeams

Tags: [Deprecated]

Reference API Roblox

Engine API

Website

Related