This property determines whether ProximityPrompts are enabled, and therefore shown, in-experience. When false, no prompts will be shown.

For example, in a round-based system, you can disable prompts at certain points in the experience to disable proximity-based interactions:

1
2
3
4
5
6
7
8
9

local ProximityPromptService = game:GetService("ProximityPromptService")
local ReplicatedStorage = game:GetService("ReplicatedStorage")

local enablePrompts = ReplicatedStorage:FindFirstChild("EnablePrompts") -- BindableEvent

-- Connect to the BindableEvent and fire from another script controlling experience logic
enablePrompts.OnServerEvent:Connect(function(enabled)
	ProximityPromptService.Enabled = enabled
end)

This property indicates the maximum number of ProximityPrompts that will be shown to the player.

This event triggers when the player begins holding down the KeyboardKeyCode key/button on a prompt with a non-zero HoldDuration.

This event triggers when the player stops holding down the KeyboardKeyCode key/button on a prompt with a non-zero HoldDuration.

This event triggers client-side in connected local scripts when a prompt becomes hidden.

This event triggers client-side in connected local scripts when a prompt becomes visible.

This event triggers when the player stops holding down the KeyboardKeyCode key/button while triggering a prompt. This is intended to allow interactions which require the player to hold a key/button while something happens in-experience.

This event triggers when the player completes interaction with a prompt, either when the KeyboardKeyCode key/button is pressed, or after a specified amount of time holding the key/button if the prompt's HoldDuration is non-zero.