# Team

Roblox Engine API class from Roblox Studio 0.744.0.7441077 (version-7aaa6838d36c4448).

- Inherits from, nearest first: [Instance](https://rapi.sleaze.dev/classes/Instance.md), [Object](https://rapi.sleaze.dev/classes/Object.md)
- Memory category: Instances
- HTML page: https://rapi.sleaze.dev/classes/Team/
- Roblox documentation: https://create.roblox.com/docs/reference/engine/classes/Team

The [`Team`](https://rapi.sleaze.dev/classes/Team.md) class represents a faction in a Roblox place. The only valid parent for a Team is in the [`Teams`](https://rapi.sleaze.dev/classes/Teams.md) service.

## Properties

### AutoAssignable

```luau
Team.AutoAssignable: boolean = true
```

- Tags: Read capabilities: Players

This property determines whether [`Players`](https://rapi.sleaze.dev/classes/Players.md) will be automatically placed onto the [`Team`](https://rapi.sleaze.dev/classes/Team.md) when joining. If multiple teams have this property set to true, Roblox will attempt to even the teams out when [`Players`](https://rapi.sleaze.dev/classes/Players.md) are added.

### ChildOrder

```luau
Team.ChildOrder: number = -1
```

- Tags: Hidden, Roblox script security, Read capabilities: Players

### TeamColor

```luau
Team.TeamColor: BrickColor
```

- Tags: Read capabilities: Players

This property sets the color of the [`Team`](https://rapi.sleaze.dev/classes/Team.md). Determines the [`Player.TeamColor`](https://rapi.sleaze.dev/classes/Player.md) property of players who are a member of the team. Also determines the color displayed on the player list and above player's heads.

### AutoColorCharacters

```luau
Team.AutoColorCharacters: boolean = true
```

- Tags: Deprecated, Not replicated, Read capabilities: Players, Load only

**Deprecated:** This property is deprecated and no longer functions, it should not be used for new work.

Deprecated and no longer functional. Historically set whether or not [`Player`](https://rapi.sleaze.dev/classes/Player.md) character models on a team would be colored to [`Team.TeamColor`](https://rapi.sleaze.dev/classes/Team.md).

### Score

```luau
Team.Score: number = 0
```

- Tags: Deprecated, Not replicated, Read capabilities: Players, Load only

**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](https://create.roblox.com/docs/players/leaderboards).

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.

## Methods

### GetPlayers

```luau
Team:GetPlayers(): { Instance }
```

- Tags: Thread safe, Capabilities: Players

Returns a list of [`Players`](https://rapi.sleaze.dev/classes/Players.md) who are assigned to the [`Team`](https://rapi.sleaze.dev/classes/Team.md). A [`Player`](https://rapi.sleaze.dev/classes/Player.md) is considered assigned if their [`Player.Team`](https://rapi.sleaze.dev/classes/Player.md) property is equal to the [`Team`](https://rapi.sleaze.dev/classes/Team.md) and [`Player.Neutral`](https://rapi.sleaze.dev/classes/Player.md) is false.

Returns: An array of [`Players`](https://rapi.sleaze.dev/classes/Players.md) in the [`Team`](https://rapi.sleaze.dev/classes/Team.md).

## Events

### PlayerAdded

```luau
Team.PlayerAdded: RBXScriptSignal<(player: Player)>
```

- Tags: Capabilities: Players

Fires whenever a [`Player`](https://rapi.sleaze.dev/classes/Player.md) is assigned to the [`Team`](https://rapi.sleaze.dev/classes/Team.md). A player is considered assigned if their [`Player.Team`](https://rapi.sleaze.dev/classes/Player.md) property is equal to the [`Team`](https://rapi.sleaze.dev/classes/Team.md) and [`Player.Neutral`](https://rapi.sleaze.dev/classes/Player.md) is false.

### PlayerRemoved

```luau
Team.PlayerRemoved: RBXScriptSignal<(player: Player)>
```

- Tags: Capabilities: Players

Fires whenever a [`Player`](https://rapi.sleaze.dev/classes/Player.md) is removed from a [`Team`](https://rapi.sleaze.dev/classes/Team.md). This can be due to the [`Player`](https://rapi.sleaze.dev/classes/Player.md) leaving the game, [`Player.Neutral`](https://rapi.sleaze.dev/classes/Player.md) being set to true or the [`Player`](https://rapi.sleaze.dev/classes/Player.md) joining a different team.

## Inherited members

- From [Instance](https://rapi.sleaze.dev/classes/Instance.md): `Archivable`, `archivable`, `Attributes`, `AttributesReplicate`, `AttributesSerialize`, `HistoryId`, `Name`, `Parent`, `PredictionMode`, `PropertyStatusStudio`, `RobloxLocked`, `SerializedOverrides`, `SourceAssetId`, `Tags`, `UniqueId`, `numExpectedDirectChildren`, `DataCost`, `Capabilities`, `DefinesCapabilities`, `IsInSandbox`, `Sandboxed`, `AddTag`, `ClearAllChildren`, `Clone`, `Destroy`, `FindFirstAncestor`, `FindFirstAncestorOfClass`, `FindFirstAncestorWhichIsA`, `FindFirstChild`, `FindFirstChildOfClass`, `FindFirstChildWhichIsA`, `FindFirstDescendant`, `GetActor`, `GetAttribute`, `GetAttributeChangedSignal`, `GetAttributes`, `GetChildren`, `GetDebugId`, `GetDescendants`, `GetFullName`, `GetStyled`, `GetStyledPropertyChangedSignal`, `GetTags`, `HasTag`, `IsAncestorOf`, `IsDescendantOf`, `IsPropertyModified`, `QueryDescendants`, `RemoveTag`, `ResetPropertyToDefault`, `SetAttribute`, `WaitForChild`, `Remove`, `children`, `clone`, `destroy`, `findFirstChild`, `getChildren`, `isDescendantOf`, `remove`, `AncestryChanged`, `AttributeChanged`, `ChildAdded`, `ChildRemoved`, `DescendantAdded`, `DescendantRemoving`, `Destroying`, `StyledPropertiesChanged`, `childAdded`
- From [Object](https://rapi.sleaze.dev/classes/Object.md): `ClassName`, `className`, `GetPropertyChangedSignal`, `IsA`, `isA`, `Changed`