ProximityPrompt

This property determines the action text shown to the user.

This property determines whether the prompt's ProximityPrompt.ActionText and ProximityPrompt.ObjectText will be localized according to the ProximityPrompt.RootLocalizationTable. When set to true, localization will be applied.

This property determines whether the prompt can be activated by clicking/tapping on the prompt's UI. When set to false, the prompt cannot be activated by click/tap except on mobile.

This property indicates whether or this ProximityPrompt should be shown.

This property is used to customize which prompts can be shown at the same time.

This property determines the gamepad button the player should press to trigger the ProximityPrompt. Default is ButtonX.

This property indicates the duration, in seconds, that the player must hold the button/key down to trigger the prompt.

This property determines the key the player should press to trigger the ProximityPrompt. Default is E.

This property determines the maximum distance a Player's character can be from the ProximityPrompt for the prompt to appear.

The maximum distance a player's character can be from the ProximityPrompt for a lightweight indicator to appear. An indicator is shown while the player is farther than ProximityPrompt.MaxActivationDistance but no farther than MaxIndicatorDistance, hinting that an interaction is nearby before the prompt itself becomes active.

The default is 0, which disables the indicator; an indicator only appears when this property is set to a value greater than 0. The number of indicators shown at once is capped by ProximityPromptService.MaxIndicatorsVisible.

This optional property determines the optional object name text shown to the user.

This property indicates whether the prompt is hidden if the path between the player's Camera and object parented to the ProximityPrompt is obstructed. If true, this prompt will only be shown if there is a clear path from the camera to the object.

The parent Part or Model of the prompt will be excluded from this check.

This property serves as a reference to the LocalizationTable used to apply automated localization to the prompt's ProximityPrompt.ActionText and ProximityPrompt.ObjectText. In order for this to apply, ProximityPrompt.AutoLocalize must be set.

Developers can set this to reference a LocalizationTable anywhere in the DataModel. It is not required to be a child of LocalizationService. If there is no translation available in the referenced table it will look for a translation in the parent of that table, if it is also a LocalizationTable, and so on.

This property indicates the prompt's style. When set to Custom, no default UI will be provided.

The provided UI can be swapped out for a custom UI. In order to do this, set Style to Custom. Then, listen to the ProximityPrompt.PromptShown and ProximityPrompt.PromptHidden events in a LocalScript, where developers should create and tear down the UI.

Developers may also use ProximityPrompt.PromptButtonHoldBegan and ProximityPrompt.PromptButtonHoldEnded in order to utilize the ProximityPrompt.HoldDuration progress animation feature.

This property indicates the pixel offset applied to the prompt's UI.

This function triggers a signal indicating that the user began pressing the ProximityPrompt prompt button. It should be used by developers who wish to customize the prompt and trigger it from a prompt GUI button press.

A counterpoint to ProximityPrompt:InputHoldBegin(), this signals that the user ended pressing the prompt GUI button.

Fires client-side when a lightweight indicator for this ProximityPrompt is hidden, which occurs when the player's character moves farther than ProximityPrompt.MaxIndicatorDistance from the prompt or the prompt itself becomes active. Use this event to tear down a custom indicator UI.

As with ProximityPrompt.IndicatorShown, indicators only appear when ProximityPrompt.MaxIndicatorDistance is set to a value greater than 0; it defaults to 0.

Fires client-side when a lightweight indicator for this ProximityPrompt becomes visible, which occurs when the player's character is within ProximityPrompt.MaxIndicatorDistance of the prompt but still farther away than ProximityPrompt.MaxActivationDistance. Listen to this event to render a custom indicator UI.

Because ProximityPrompt.MaxIndicatorDistance defaults to 0, indicators are disabled unless you set it to a value greater than 0.

This event triggers when a player begins holding down the key/button on a prompt with a non-zero ProximityPrompt.HoldDuration. One possible usage includes to animate a hold progress bar.

This event triggers when the player ends holding down the button on a prompt with a non-zero ProximityPrompt.HoldDuration. One possible usage includes to animate a hold progress bar.

This event triggers when the prompt becomes hidden. This event is triggered client-side for LocalScripts.

This event triggers when the prompt becomes visible. This event is triggered client-side for LocalScripts.

This event is triggered when the prompt key/button is pressed, or after a specified amount of time holding the button, if ProximityPrompt.HoldDuration is used.

This event is triggered when the key/button is released, for longer events where the user is required to hold down the button (e.g. heal another player over time.)