# ProximityPromptService

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

Allows developers to interact with [`ProximityPrompt`](https://rapi.sleaze.dev/classes/ProximityPrompt.md) objects in a global way.

## Properties

### Enabled

```luau
ProximityPromptService.Enabled: boolean = true
```

- Tags: Capabilities: Input

Whether `ProximityPrompts` are enabled, and therefore shown, in-experience.

### MaxIndicatorsVisible

```luau
ProximityPromptService.MaxIndicatorsVisible: number = 16
```

- Tags: Capabilities: Input

Maximum number of prompt indicators that can be visible at once.

### MaxPromptsVisible

```luau
ProximityPromptService.MaxPromptsVisible: number = 16
```

- Tags: Capabilities: Input

Maximum number of `ProximityPrompts` that will be shown to the player.

## Events

### IndicatorHidden

```luau
ProximityPromptService.IndicatorHidden: RBXScriptSignal<(prompt: ProximityPrompt)>
```

- Tags: Capabilities: Input

Triggers client-side when a prompt's indicator becomes hidden.

### IndicatorShown

```luau
ProximityPromptService.IndicatorShown: RBXScriptSignal<(prompt: ProximityPrompt)>
```

- Tags: Capabilities: Input

Triggers client-side when a prompt's indicator becomes visible.

### PromptButtonHoldBegan

```luau
ProximityPromptService.PromptButtonHoldBegan: RBXScriptSignal<(prompt: ProximityPrompt, playerWhoTriggered: Player)>
```

- Tags: Capabilities: Input

Triggers when the player begins holding down the `KeyboardKeyCode` key/button on a prompt with a non-zero `HoldDuration`.

### PromptButtonHoldEnded

```luau
ProximityPromptService.PromptButtonHoldEnded: RBXScriptSignal<(prompt: ProximityPrompt, playerWhoTriggered: Player)>
```

- Tags: Capabilities: Input

Triggers when the player stops holding down the `KeyboardKeyCode` key/button on a prompt with a non-zero `HoldDuration`.

### PromptHidden

```luau
ProximityPromptService.PromptHidden: RBXScriptSignal<(prompt: ProximityPrompt)>
```

- Tags: Capabilities: Input

Triggers client-side when a prompt becomes hidden.

### PromptShown

```luau
ProximityPromptService.PromptShown: RBXScriptSignal<(prompt: ProximityPrompt, inputType: Enum.ProximityPromptInputType)>
```

- Tags: Capabilities: Input

Triggers client-side when a prompt becomes visible.

### PromptTriggered

```luau
ProximityPromptService.PromptTriggered: RBXScriptSignal<(prompt: ProximityPrompt, playerWhoTriggered: Player)>
```

- Tags: Capabilities: Input

Triggers when the user interacts with this prompt.

### PromptTriggerEnded

```luau
ProximityPromptService.PromptTriggerEnded: RBXScriptSignal<(prompt: ProximityPrompt, playerWhoTriggered: Player)>
```

- Tags: Capabilities: Input

Triggers when the player stops holding down the `KeyboardKeyCode` key/button while triggering a prompt.

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