ProximityPromptService¶
Not yet Class NotBrowsable Service
Allows developers to interact with ProximityPrompt objects in a global way.
Not implemented yet
Ships with ProximityPrompt and is likewise missing.
0 Nova members · 17 modern Roblox members not implemented yet
Description¶
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.
Inheritance¶
Object → Instance → ProximityPromptService
Properties¶
| Member | Signature | Summary |
|---|---|---|
Enabled |
Enabled: bool |
Whether ProximityPrompts are enabled, and therefore shown, in-experience. |
MaxIndicatorsVisible |
MaxIndicatorsVisible: int |
Maximum number of prompt indicators that can be visible at once. |
MaxPromptsVisible |
MaxPromptsVisible: int |
Maximum number of ProximityPrompts that will be shown to the player. |
Events¶
| Member | Signature | Summary |
|---|---|---|
IndicatorHidden |
IndicatorHidden(prompt: ProximityPrompt) |
Triggers client-side when a prompt's indicator becomes hidden. |
IndicatorShown |
IndicatorShown(prompt: ProximityPrompt) |
Triggers client-side when a prompt's indicator becomes visible. |
PromptButtonHoldBegan |
PromptButtonHoldBegan(prompt: ProximityPrompt, playerWhoTriggered: Player) |
Triggers when the player begins holding down the KeyboardKeyCode key/button on a prompt with a non-zero [HoldDuration](ProximityPro… |
PromptButtonHoldEnded |
PromptButtonHoldEnded(prompt: ProximityPrompt, playerWhoTriggered: Player) |
Triggers when the player stops holding down the KeyboardKeyCode key/button on a prompt with a non-zero [HoldDuration](ProximityProm… |
PromptHidden |
PromptHidden(prompt: ProximityPrompt) |
Triggers client-side when a prompt becomes hidden. |
PromptShown |
PromptShown(prompt: ProximityPrompt, inputType: ProximityPromptInputType) |
Triggers client-side when a prompt becomes visible. |
PromptTriggered |
PromptTriggered(prompt: ProximityPrompt, playerWhoTriggered: Player) |
Triggers when the user interacts with this prompt. |
PromptTriggerEnded |
PromptTriggerEnded(prompt: ProximityPrompt, playerWhoTriggered: Player) |
Triggers when the player stops holding down the KeyboardKeyCode key/button while triggering a prompt. |
Roblox reference: ProximityPromptService
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.