Class
ProximityPrompt
since 1.6.2-alpha
A world-space prompt the player can trigger when they get close to an object.
InheritsInstance
Properties
7| Name | Type | Access | Description |
|---|---|---|---|
| ClickablePrompt | boolean | readwrite | Whether the prompt can also be triggered with a mouse click or tap, instead of only the keyboard/gamepad. since 1.6.2-alphaRoblox ↗ |
| RequiresLineOfSight | boolean | readwrite | Whether the player must have an unobstructed line of sight to the prompt for it to show. since 1.6.2-alphaRoblox ↗ |
| HoldDuration | number | readwrite | How long, in seconds, the player must hold the input before the prompt triggers. since 1.6.13a-alphaRoblox ↗ |
| Exclusivity | number | readwrite | The exclusivity mode controlling how this prompt competes with other nearby prompts (as the underlying enum value). since 1.6.13a-alphaRoblox ↗ |
| MaxActivationDistance | number | readwrite | The maximum distance, in studs, at which the prompt becomes available. since 1.6.13a-alphaRoblox ↗ |
| ObjectText | string | read | The name of the object the prompt is attached to, shown in the prompt UI. since 1.6.13a-alphaRoblox ↗ |
| ActionText | string | read | The action label shown in the prompt UI (e.g. since 1.6.13a-alphaRoblox ↗ |