Team¶
The Team class represents a faction in a Roblox place. The only valid parent for a Team is in the Teams service.
Description¶
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 Model will be colored to the Team.TeamColor
- Changing Player.TeamColor will cause Player.Team to switch to the Team with the corresponding Team.TeamColor
- When using the default player list users will be grouped and displayed together as a team
- Setting Player.Neutral to true will cause the Player to be disassociated with the team, but it 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 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
Inheritance¶
Nova inheritance: Instance → Team
Properties¶
AutoAssignable Supported Property This property determines whether Players will be automatically placed onto the Team when joining. If multiple teams have this property set to true, R…
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.
AutoColorCharacters Supported Property Deprecated Legacy team setting. Nova stores it, but no engine code reads it.
Legacy team setting. Nova stores it, but no engine code reads it.
Historically this controlled whether character models were tinted with the team colour. Nova stores and replicates the boolean, but the 2016 character code no longer consumes it.
Score Supported Property Deprecated Legacy team score. Nova stores it, but no game service reads it.
Legacy team score. Nova stores it, but no game service reads it.
This is a free integer storage field, not a functioning scoreboard. Nova stores and replicates it, but does not use it for leaderboards or team logic.
TeamColor Supported Property 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…
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.
Inherited members¶
Inherited from Instance: 8 properties, 36 methods, 7 events. They are documented on the base class page.
3 modern Roblox member(s) are not implemented yet — expand to inspect
Members declared by Roblox's Team class (or by a missing base class) that Nova does not expose. Use this list to scope a migration; the compatibility guide has the recommended workaround.
Methods¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
GetPlayers |
Team:GetPlayers(): Instances |
Not yet | Returns a list of Players who are assigned to the Team. A Player is considered assigned if their Player.Team prope… | — |
Events¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
PlayerAdded |
PlayerAdded(player: Player) |
Not yet | Fires whenever a Player is assigned to the Team. A player is considered assigned if their Player.Team property is equal to the… | — |
PlayerRemoved |
PlayerRemoved(player: Player) |
Not yet | Fires whenever a Player is removed from a Team. This can be due to the Player leaving the game, Player.Neutral… | — |
Roblox reference: Team
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.