# CollaboratorsService

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)
- Tags: Not creatable, Service
- Memory category: Instances
- HTML page: https://rapi.sleaze.dev/classes/CollaboratorsService/
- Roblox documentation: https://create.roblox.com/docs/reference/engine/classes/CollaboratorsService

## Methods

### GetCollaboratorsList

```luau
CollaboratorsService:GetCollaboratorsList(): { Instance }
```

- Tags: Roblox script security

### GetSelectionHighlightsEnabled

```luau
CollaboratorsService:GetSelectionHighlightsEnabled(): boolean
```

- Tags: Roblox script security

### MultiGetCanCollaborate

```luau
CollaboratorsService:MultiGetCanCollaborate(userIds: string)
```

- Tags: Roblox script security

### RequestFlyToCollaborator

```luau
CollaboratorsService:RequestFlyToCollaborator(collaboratorId: number)
```

- Tags: Roblox script security

### ToggleSelectionHighlights

```luau
CollaboratorsService:ToggleSelectionHighlights(showHighlights: boolean)
```

- Tags: Roblox script security

### ToggleTeamCreate

```luau
CollaboratorsService:ToggleTeamCreate(on: boolean)
```

- Tags: Roblox script security

## Events

### CollaboratorIdleUpdate

```luau
CollaboratorsService.CollaboratorIdleUpdate: RBXScriptSignal<(collaboratorId: number, isIdle: boolean)>
```

- Tags: Roblox script security

### CollaboratorInstanceCreatedSignal

```luau
CollaboratorsService.CollaboratorInstanceCreatedSignal: RBXScriptSignal<(collaboratorId: number)>
```

- Tags: Roblox script security

### CollaboratorInstanceDestroyedSignal

```luau
CollaboratorsService.CollaboratorInstanceDestroyedSignal: RBXScriptSignal<(collaboratorId: number)>
```

- Tags: Roblox script security

### CollaboratorStatusUpdatedSignal

```luau
CollaboratorsService.CollaboratorStatusUpdatedSignal: RBXScriptSignal<(collaboratorId: number, newStatus: Enum.CollaboratorStatus)>
```

- Tags: Roblox script security

### CollaboratorStatusUpdateRequestedSignal

```luau
CollaboratorsService.CollaboratorStatusUpdateRequestedSignal: RBXScriptSignal<(collaboratorId: number, newStatus: Enum.CollaboratorStatus)>
```

- Tags: Hidden, Roblox script security

### MultiGetCanCollaborateRetrieved

```luau
CollaboratorsService.MultiGetCanCollaborateRetrieved: RBXScriptSignal<(requestId: string, canCollaborateResponses: { any })>
```

- Tags: Roblox script security

### ServerMultiGetCanCollaborateRequested

```luau
CollaboratorsService.ServerMultiGetCanCollaborateRequested: RBXScriptSignal<(userIds: string)>
```

- Tags: Roblox engine security

### ToggleSelectionHighlightsSignal

```luau
CollaboratorsService.ToggleSelectionHighlightsSignal: RBXScriptSignal<(areHighlightsShown: boolean)>
```

- Tags: Roblox script security

## 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`