9 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

ProximityPromptService

Inherits from: Instance → Object

ProximityPromptService allows developers to interact with ProximityPrompt objects in a global way. It may be more convenient to listen to events through this service rather than on individual ProximityPrompt objects.

Inherits from: Instance

Memory category: Instances

Tags: Service, NotBrowsable

Properties

Name	Type / Returns	Description
ProximityPromptService.Enabled	boolean	Whether `ProximityPrompts` are enabled, and therefore shown, in-experience.
ProximityPromptService.MaxIndicatorsVisible	int	Maximum number of prompt indicators that can be visible at once.
ProximityPromptService.MaxPromptsVisible	int	Maximum number of `ProximityPrompts` that will be shown to the player.

Inherited from Instance

Name	Type / Returns	Description
Instance.Archivable	boolean	Determines if an `Instance` and its descendants can be cloned using `Instance:Clone()`, and can be saved/published.
Instance.archivable	boolean
Instance.Capabilities	SecurityCapabilities	The set of capabilities allowed to be used for scripts inside this container.
Instance.IsInSandbox	boolean	Indicates whether the instance is inside a sandboxed container.
Instance.Name	string	A non-unique identifier of the `Instance`.
Instance.Parent	Instance	Determines the hierarchical parent of the `Instance`.
Instance.PredictionMode	PredictionMode	Reflects the client-side prediction mode applied to the instance under server-authoritative physics.
Instance.RobloxLocked	boolean	A deprecated property that used to protect `CoreGui` objects.
Instance.Sandboxed	boolean	When enabled, the instance can only access abilities in its `Capabilities` list.
Instance.UniqueId	UniqueId	A unique identifier for the instance.

Inherited from Object

Name	Type / Returns	Description
Object.ClassName	string	A read-only string representing the class this `Object` belongs to.
Object.className	string

ProximityPromptService.Enabled

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:

Field	Value
type	boolean
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":true,"can_save":true}
capabilities	["Input"]

Code samples: View on Creator Hub (ProximityPromptService-Enabled).

ProximityPromptService.MaxIndicatorsVisible

This property sets the maximum number of prompt indicators that can be visible at the same time. Indicators are lightweight distance hints shown for ProximityPrompts when the player is within the prompt's MaxIndicatorDistance but still outside its MaxActivationDistance.

This property defaults to 16 and is clamped to the range [0, 64]. Because indicators are opt-in per prompt — a prompt's MaxIndicatorDistance defaults to 0, which disables its indicator — this property has no visible effect unless at least one prompt sets a non-zero MaxIndicatorDistance.

Field	Value
type	int
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":true,"can_save":true}
capabilities	["Input"]

ProximityPromptService.MaxPromptsVisible

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

Field	Value
type	int
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":true,"can_save":true}
capabilities	["Input"]

Events

Name	Type / Returns	Description
ProximityPromptService.IndicatorHidden		Triggers client-side when a prompt's indicator becomes hidden.
ProximityPromptService.IndicatorShown		Triggers client-side when a prompt's indicator becomes visible.
ProximityPromptService.PromptButtonHoldBegan		Triggers when the player begins holding down the `KeyboardKeyCode` key/button on a prompt with a non-zero `HoldDuration`.
ProximityPromptService.PromptButtonHoldEnded		Triggers when the player stops holding down the `KeyboardKeyCode` key/button on a prompt with a non-zero `HoldDuration`.
ProximityPromptService.PromptHidden		Triggers client-side when a prompt becomes hidden.
ProximityPromptService.PromptShown		Triggers client-side when a prompt becomes visible.
ProximityPromptService.PromptTriggered		Triggers when the user interacts with this prompt.
ProximityPromptService.PromptTriggerEnded		Triggers when the player stops holding down the `KeyboardKeyCode` key/button while triggering a prompt.

Inherited from Instance

Name	Type / Returns	Description
Instance.AncestryChanged		Fires when the `Instance.Parent` property of this object or one of its ancestors is changed.
Instance.AttributeChanged		Fires whenever an attribute is changed on the `Instance`.
Instance.ChildAdded		Fires after an object is parented to this `Instance`.
Instance.childAdded
Instance.ChildRemoved		Fires after a child is removed from this `Instance`.
Instance.DescendantAdded		Fires after a descendant is added to the `Instance`.
Instance.DescendantRemoving		Fires immediately before a descendant of the `Instance` is removed.
Instance.Destroying		Fires immediately before (or is deferred until after) the instance is destroyed via `Instance:Destroy()`.
Instance.StyledPropertiesChanged		Fires whenever any style property is changed on the instance, including when a property is set to `nil`.

Inherited from Object

Name	Type / Returns	Description
Object.Changed		Fires immediately after a property of the object changes, with some limitations.

ProximityPromptService.IndicatorHidden

This event triggers client-side in connected local scripts when the indicator for a ProximityPrompt is no longer visible, such as when the player moves outside the prompt's MaxIndicatorDistance or the prompt is disabled. It is the counterpart to IndicatorShown and is convenient for tearing down custom indicator UI globally rather than connecting to each individual ProximityPrompt.

Parameters

Name	Type	Default	Description
prompt	ProximityPrompt		The prompt whose indicator becomes hidden.

Field	Value
security	None
capabilities	["Input"]

ProximityPromptService.IndicatorShown

This event triggers client-side in connected local scripts when the indicator for a ProximityPrompt becomes visible, which happens when the player moves within the prompt's MaxIndicatorDistance but remains outside its MaxActivationDistance. Indicators are opt-in: a prompt only shows one when its MaxIndicatorDistance is set greater than 0 (the default of 0 disables the indicator). Listening on the service rather than on each ProximityPrompt is convenient when implementing custom indicator UI globally.

Parameters

Name	Type	Default	Description
prompt	ProximityPrompt		The prompt whose indicator becomes visible.

Field	Value
security	None
capabilities	["Input"]

ProximityPromptService.PromptButtonHoldBegan

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

Parameters

Name	Type	Default	Description
prompt	ProximityPrompt		The prompt that the player begins interacting with.
playerWhoTriggered	Player		The player who holds the key/button.

Field	Value
security	None
capabilities	["Input"]

ProximityPromptService.PromptButtonHoldEnded

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

Parameters

Name	Type	Default	Description
prompt	ProximityPrompt		The prompt that the player stops interacting with.
playerWhoTriggered	Player		The player who releases the held key/button.

Field	Value
security	None
capabilities	["Input"]

ProximityPromptService.PromptHidden

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

Parameters

Name	Type	Default	Description
prompt	ProximityPrompt		The prompt instance that becomes hidden.

Field	Value
security	None
capabilities	["Input"]

ProximityPromptService.PromptShown

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

Parameters

Name	Type	Default	Description
prompt	ProximityPrompt		The prompt instance that becomes visible.
inputType	ProximityPromptInputType		The input that triggered the event.

Field	Value
security	None
capabilities	["Input"]

ProximityPromptService.PromptTriggered

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.

Parameters

Name	Type	Default	Description
prompt	ProximityPrompt		The prompt that the player interacts with.
playerWhoTriggered	Player		The interacting player.

Field	Value
security	None
capabilities	["Input"]

ProximityPromptService.PromptTriggerEnded

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.

Parameters

Name	Type	Default	Description
prompt	ProximityPrompt		The prompt that the player stops interacting with.
playerWhoTriggered	Player		The player that releases the key/button.

Field	Value
security	None
capabilities	["Input"]

Methods

Inherited from Instance

Name	Type / Returns	Description
Instance:AddTag	()	Applies a tag to the instance.
Instance:children	Instances	Returns an array of the object's children.
Instance:ClearAllChildren	()	This method destroys all of an instance's children.
Instance:Clone	Instance	Create a copy of an instance and all its descendants, ignoring instances that are not `Archivable`.
Instance:clone	Instance
Instance:Destroy	()	Sets the `Instance.Parent` property to `nil`, locks the `Instance.Parent` property, disconnects all connections, and calls `Destroy()` on all children.
Instance:destroy	()
Instance:FindFirstAncestor	Instance?	Returns the first ancestor of the `Instance` whose `Instance.Name` is equal to the given name.
Instance:FindFirstAncestorOfClass	Instance?	Returns the first ancestor of the `Instance` whose `Object.ClassName` is equal to the given className.
Instance:FindFirstAncestorWhichIsA	Instance?	Returns the first ancestor of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstChild	Instance?	Returns the first child of the `Instance` found with the given name.
Instance:findFirstChild	Instance
Instance:FindFirstChildOfClass	Instance?	Returns the first child of the `Instance` whose `ClassName` is equal to the given class name.
Instance:FindFirstChildWhichIsA	Instance?	Returns the first child of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstDescendant	Instance?	Returns the first descendant found with the given `Instance.Name`.
Instance:GetActor	Actor?	Returns the `Actor` associated with the Instance, if any.
Instance:GetAttribute	Variant	Returns the value which has been assigned to the given attribute name.
Instance:GetAttributeChangedSignal	RBXScriptSignal	Returns an event that fires when the given attribute changes.
Instance:GetAttributes	Dictionary	Returns a dictionary of the instance's attributes.
Instance:GetChildren	Instances	Returns an array containing all of the instance's children.
Instance:getChildren	Instances
Instance:GetDebugId	string	Returns a coded string of the debug ID used internally by Roblox.
Instance:GetDescendants	Instances	Returns an array containing all of the descendants of the instance.
Instance:GetFullName	string	Returns a string describing the instance's ancestry.
Instance:GetStyled	Variant	Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Instance:GetStyledPropertyChangedSignal	RBXScriptSignal	Returns an event that fires when the given style property changes on the instance.
Instance:GetTags	Array	Gets an array of all tags applied to the instance.
Instance:HasTag	boolean	Check whether the instance has a given tag.
Instance:IsAncestorOf	boolean	Returns true if an `Instance` is an ancestor of the given descendant.
Instance:IsDescendantOf	boolean	Returns `true` if an `Instance` is a descendant of the given ancestor.
Instance:isDescendantOf	boolean
Instance:IsPropertyModified	boolean	Returns `true` if the value stored in the specified property is not equal to the code-instantiated default.
Instance:QueryDescendants	Instances	Returns an array containing all descendants of the instance that match the `selector` string.
Instance:Remove	()	Sets the object's `Parent` to `nil`, and does the same for all its descendants.
Instance:remove	()
Instance:RemoveTag	()	Removes a tag from the instance.
Instance:ResetPropertyToDefault	()	Resets a property to its default value.
Instance:SetAttribute	()	Sets the attribute with the given name to the given value.
Instance:WaitForChild	Instance	Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.

Inherited from Object

Name	Type / Returns	Description
Object:GetPropertyChangedSignal	RBXScriptSignal	Get an event that fires when a given property of the object changes.
Object:IsA	boolean	Returns true if an object's class matches or inherits from a given class.
Object:isA	boolean