Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
Team
Inherits from: Instance → Object
The Team class represents a faction in a Roblox place. The only valid parent for a Team is in the Teams service. Teams offer a range of features that are useful to developers that can be divided into two rough groups:
- Features that work 'out of the box'
- 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
Modelwill be colored to theTeam.TeamColor - Changing
Player.TeamColorwill causePlayer.Teamto switch to the Team with the correspondingTeam.TeamColor - When using the default player list users will be grouped and displayed together as a team
- Setting
Player.Neutralto true will cause thePlayerto be disassociated with the team, but it will not changePlayer.TeamorPlayer.TeamColor - When a
Playerjoins a game, they will be allocated to the team withTeam.AutoAssignableset to true that has the fewest players. If no auto assignable team is available,Player.Neutralwill be set to true - When
SpawnLocation.Neutralis set to false, only players whosePlayer.TeamColormatchesSpawnLocation.TeamColorcan spawn on thatSpawnLocation - When
SpawnLocation.AllowTeamChangeOnTouchis set to true, a player'sPlayer.TeamColorwill change toSpawnLocation.TeamColorwhen their character touches theSpawnLocation
Optional Extended Team Behaviors
Many developers chose to add the following features to teams in their own code.
- Implement checks in weapon code to prevent friendly fire.
- Implement checks in doors or other features that allow only certain teams to use them
- Periodically reassign teams to maintain team balance
Inherits from: Instance
Memory category: Instances
Code samples: View on Creator Hub (Team-Rebalance, Team-Kill-Check, Team-Only-Door, Party-Team-Integration).
Properties
| Name | Type / Returns | Description |
|---|---|---|
| Team.AutoAssignable | boolean | This property determines whether Players will be automatically placed onto the Team when joining. If multiple teams have this property set to true, Roblox will attempt to even the teams out when Players are added. |
| Team.AutoColorCharacters | boolean | Deprecated and no longer functional. Historically set whether or not Player character models on a team would be colored to Team.TeamColor. |
| Team.Score | int | This property can be used to store an integer value associated with the team. This property offers no additional functionality and is not used by any game services. |
| Team.TeamColor | BrickColor | This property sets the color of the Team. Determines the Player.TeamColor property of players who are a member of the team. Also determines the color displayed on the player list and above player's heads. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.Archivable | boolean | Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published. |
| Instance.archivable | boolean | |
| Instance.Capabilities | SecurityCapabilities | The set of capabilities allowed to be used for scripts inside this container. |
| Instance.IsInSandbox | boolean | Indicates whether the instance is inside a sandboxed container. |
| Instance.Name | string | A non-unique identifier of the Instance. |
| Instance.Parent | Instance | Determines the hierarchical parent of the Instance. |
| Instance.PredictionMode | PredictionMode | Reflects the client-side prediction mode applied to the instance under server-authoritative physics. |
| Instance.RobloxLocked | boolean | A deprecated property that used to protect CoreGui objects. |
| Instance.Sandboxed | boolean | When enabled, the instance can only access abilities in its Capabilities list. |
| Instance.UniqueId | UniqueId | A unique identifier for the instance. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.ClassName | string | A read-only string representing the class this Object belongs to. |
| Object.className | string |
Team.AutoAssignable
This property determines whether Players will be automatically placed onto the Team when joining. If multiple teams have this property set to true, Roblox will attempt to even the teams out when Players are added.
When a Player joins a game they will be assigned to the Team with Team.AutoAssignable set to true that has the fewest players. If no such team is available, Player.Neutral will be set to true.
Note while using this property will help even out teams when players are added, it will not do anything when players are removed. For this reason developers may wish to implement their own team balancing system.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Players"] |
Code samples: View on Creator Hub (Team-Rebalance).
Team.AutoColorCharacters
Deprecated. This property is deprecated and no longer functions, it should not be used for new work.
Historically set whether or not Player character models on a team would be colored to Team.TeamColor.
Developers are advised not to use this property as the script which changed the team colors has since been removed from the default character. This property is deprecated and should not be used for new work.
| Field | Value |
|---|---|
| type | boolean |
| tags | ["NotReplicated","Deprecated"] |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":false} |
| capabilities | ["Players"] |
Team.Score
Deprecated. This property is deprecated and should not be used in new work. For more information on how to handle leaderboards and scoring please see this tutorial.
This property can be used to store an integer value associated with the team. This property offers no additional functionality and is not used by any game services.
This property is deprecated and should not be used by developers for new work.
| Field | Value |
|---|---|
| type | int |
| tags | ["NotReplicated","Deprecated"] |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":false} |
| capabilities | ["Players"] |
Team.TeamColor
This property sets the color of the Team. Determines the Player.TeamColor property of players who are a member of the team.
A lot of Roblox's default team functionality is based on the team color, rather than the name or object. For example, SpawnLocations can be assigned to a team via SpawnLocation.TeamColor. For this reason it is recommended that developers ensure each Team has a unique TeamColor.
Any player which is a part of a team will have their name color changed to the team's TeamColor property. They will also be put underneath the team heading on the player list.
| Field | Value |
|---|---|
| type | BrickColor |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Players"] |
Code samples: View on Creator Hub (Team-Only-Door).
Methods
| Name | Type / Returns | Description |
|---|---|---|
| Team:GetPlayers | List | Returns a list of Players who are assigned to the Team. A Player is considered assigned if their Player.Team property is equal to the Team and Player.Neutral is false. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance:AddTag | () | Applies a tag to the instance. |
| Instance:children | Instances | Returns an array of the object's children. |
| Instance:ClearAllChildren | () | This method destroys all of an instance's children. |
| Instance:Clone | Instance | Create a copy of an instance and all its descendants, ignoring instances that are not Archivable. |
| Instance:clone | Instance | |
| Instance:Destroy | () | Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children. |
| Instance:destroy | () | |
| Instance:FindFirstAncestor | Instance? | Returns the first ancestor of the Instance whose Instance.Name is equal to the given name. |
| Instance:FindFirstAncestorOfClass | Instance? | Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className. |
| Instance:FindFirstAncestorWhichIsA | Instance? | Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstChild | Instance? | Returns the first child of the Instance found with the given name. |
| Instance:findFirstChild | Instance | |
| Instance:FindFirstChildOfClass | Instance? | Returns the first child of the Instance whose ClassName is equal to the given class name. |
| Instance:FindFirstChildWhichIsA | Instance? | Returns the first child of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstDescendant | Instance? | Returns the first descendant found with the given Instance.Name. |
| Instance:GetActor | Actor? | Returns the Actor associated with the Instance, if any. |
| Instance:GetAttribute | Variant | Returns the value which has been assigned to the given attribute name. |
| Instance:GetAttributeChangedSignal | RBXScriptSignal | Returns an event that fires when the given attribute changes. |
| Instance:GetAttributes | Dictionary | Returns a dictionary of the instance's attributes. |
| Instance:GetChildren | Instances | Returns an array containing all of the instance's children. |
| Instance:getChildren | Instances | |
| Instance:GetDebugId | string | Returns a coded string of the debug ID used internally by Roblox. |
| Instance:GetDescendants | Instances | Returns an array containing all of the descendants of the instance. |
| Instance:GetFullName | string | Returns a string describing the instance's ancestry. |
| Instance:GetStyled | Variant | Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. |
| Instance:GetStyledPropertyChangedSignal | RBXScriptSignal | Returns an event that fires when the given style property changes on the instance. |
| Instance:GetTags | Array | Gets an array of all tags applied to the instance. |
| Instance:HasTag | boolean | Check whether the instance has a given tag. |
| Instance:IsAncestorOf | boolean | Returns true if an Instance is an ancestor of the given descendant. |
| Instance:IsDescendantOf | boolean | Returns true if an Instance is a descendant of the given ancestor. |
| Instance:isDescendantOf | boolean | |
| Instance:IsPropertyModified | boolean | Returns true if the value stored in the specified property is not equal to the code-instantiated default. |
| Instance:QueryDescendants | Instances | Returns an array containing all descendants of the instance that match the selector string. |
| Instance:Remove | () | Sets the object's Parent to nil, and does the same for all its descendants. |
| Instance:remove | () | |
| Instance:RemoveTag | () | Removes a tag from the instance. |
| Instance:ResetPropertyToDefault | () | Resets a property to its default value. |
| Instance:SetAttribute | () | Sets the attribute with the given name to the given value. |
| Instance:WaitForChild | Instance | Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object:GetPropertyChangedSignal | RBXScriptSignal | Get an event that fires when a given property of the object changes. |
| Object:IsA | boolean | Returns true if an object's class matches or inherits from a given class. |
| Object:isA | boolean |
Team:GetPlayers
Returns a list of Players who are assigned to the Team. A Player is considered assigned if their Player.Team property is equal to the Team and Player.Neutral is false.
This function has a number of potential uses, including counting the number of players on a Team or giving every Player on a Team a Tool.
Returns
| Type | Description |
|---|---|
| List | An array of Players in the Team. |
| Field | Value |
|---|---|
| security | None |
| thread safety | Safe |
| capabilities | ["Players"] |
Code samples: View on Creator Hub (Teams-GetTeams).
Events
| Name | Type / Returns | Description |
|---|---|---|
| Team.PlayerAdded | Fires whenever a Player is assigned to the Team. A player is considered assigned if their Player.Team property is equal to the Team and Player.Neutral is false. | |
| Team.PlayerRemoved | Fires whenever a Player is removed from a Team. This can be due to the Player leaving the game, Player.Neutral being set to true or the Player joining a different team. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.AncestryChanged | Fires when the Instance.Parent property of this object or one of its ancestors is changed. | |
| Instance.AttributeChanged | Fires whenever an attribute is changed on the Instance. | |
| Instance.ChildAdded | Fires after an object is parented to this Instance. | |
| Instance.childAdded | ||
| Instance.ChildRemoved | Fires after a child is removed from this Instance. | |
| Instance.DescendantAdded | Fires after a descendant is added to the Instance. | |
| Instance.DescendantRemoving | Fires immediately before a descendant of the Instance is removed. | |
| Instance.Destroying | Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy(). | |
| Instance.StyledPropertiesChanged | Fires whenever any style property is changed on the instance, including when a property is set to nil. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.Changed | Fires immediately after a property of the object changes, with some limitations. |
Team.PlayerAdded
Fires whenever a Player is assigned to the Team. A player is considered assigned if their Player.Team property is equal to the Team and Player.Neutral is false.
This event is team specific and will only fire when a Player joints the specific Team. Any function connected to this event will be passed the Player object of the player who joined the team. For example:
Team.PlayerAdded:Connect(function(player)
print(player.Name.." has joined the team")
end) Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| player | Player | The Player that was added. |
| Field | Value |
|---|---|
| security | None |
| capabilities | ["Players"] |
Code samples: View on Creator Hub (Team-Rebalance).
Team.PlayerRemoved
Fires whenever a Player is removed from a Team. This can be due to the Player leaving the game, Player.Neutral being set to true or the Player joining a different team.
This event is team specific and will only fire when a Player leaves the specific Team. Any function connected to this event will be passed the Player object of the player who left the team. For example:
Team.PlayerRemoved:Connect(function(player)
print(player.Name.." has left the team")
end) Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| player | Player | The Player removed. |
| Field | Value |
|---|---|
| security | None |
| capabilities | ["Players"] |
Code samples: View on Creator Hub (Team-Rebalance).