ProximityPromptService
Controls and observes proximity prompts across a place.
- Service
game:GetService("ProximityPromptService")- Inherits
- Instance
- Replication
- Never
Behavior
ProximityPromptService controls and observes proximity prompts across a place.
Summary
Whether this proximity prompt service is enabled.
The maximum number of prompts displayed simultaneously.
Returns this instance if it is an ExecutionGroup.
Fires when a player begins holding a proximity prompt.
Fires when a player stops holding a proximity prompt.
Fires when a proximity prompt becomes hidden.
Fires when a proximity prompt becomes visible.
Fires when a prompt's triggering interaction ends.
Fires when a player activates a proximity prompt.
Properties
Enabled
ProximityPromptService.Enabled: boolean = trueWhether this proximity prompt service is enabled.
MaxPromptsVisible
ProximityPromptService.MaxPromptsVisible: number = 4The maximum number of prompts displayed simultaneously.
Methods
GetExecutionGroup
ProximityPromptService:GetExecutionGroup(): ExecutionGroup?Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.
Events
PromptButtonHoldBegan
ProximityPromptService.PromptButtonHoldBegan: RBXScriptSignalFires when a player begins holding a proximity prompt.
PromptButtonHoldEnded
ProximityPromptService.PromptButtonHoldEnded: RBXScriptSignalFires when a player stops holding a proximity prompt.
PromptHidden
ProximityPromptService.PromptHidden: RBXScriptSignalFires when a proximity prompt becomes hidden.
PromptShown
ProximityPromptService.PromptShown: RBXScriptSignalFires when a proximity prompt becomes visible.
PromptTriggerEnded
ProximityPromptService.PromptTriggerEnded: RBXScriptSignalFires when a prompt's triggering interaction ends.
PromptTriggered
ProximityPromptService.PromptTriggered: RBXScriptSignalFires when a player activates a proximity prompt.
Inherited members
- Properties
- ArchivableClassNameNameParent
- Methods
- AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
- Events
- AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying