Roblox API Reference

ProximityPromptService On DevHub

Summary

This class is a service. It is a singleton that may be acquired with GetService.

This item is not browsable. It is not visible in Studio's object browser.

Memory Category	Instances

Tags: [Service, NotBrowsable]

Inherits (1)

Instance

Member index (8)

Type		Member	History
bool		Enabled
int		MaxPromptsVisible
		PromptButtonHoldBegan (ProximityPrompt prompt, Player playerWhoTriggered)	458 483
		PromptButtonHoldEnded (ProximityPrompt prompt, Player playerWhoTriggered)	458 483
		PromptHidden (ProximityPrompt prompt)	483
		PromptShown (ProximityPrompt prompt, ProximityPromptInputType inputType)	483
		PromptTriggerEnded (ProximityPrompt prompt, Player playerWhoTriggered)	483
		PromptTriggered (ProximityPrompt prompt, Player playerWhoTriggered)	483
57 members inherited from Instance

483 Change Parameters of ProximityPromptService.PromptButtonHoldBegan from (Instance prompt, Instance playerWhoTriggered) to (ProximityPrompt prompt, Player playerWhoTriggered)
483 Change Parameters of ProximityPromptService.PromptButtonHoldEnded from (Instance prompt, Instance playerWhoTriggered) to (ProximityPrompt prompt, Player playerWhoTriggered)
483 Change Parameters of ProximityPromptService.PromptHidden from (Instance prompt) to (ProximityPrompt prompt)
483 Change Parameters of ProximityPromptService.PromptShown from (Instance prompt, ProximityPromptInputType inputType) to (ProximityPrompt prompt, ProximityPromptInputType inputType)
483 Change Parameters of ProximityPromptService.PromptTriggerEnded from (Instance prompt, Instance playerWhoTriggered) to (ProximityPrompt prompt, Player playerWhoTriggered)
483 Change Parameters of ProximityPromptService.PromptTriggered from (Instance prompt, Instance playerWhoTriggered) to (ProximityPrompt prompt, Player playerWhoTriggered)
458 Change Parameters of ProximityPromptService.PromptButtonHoldBegan from (Instance prompt) to (Instance prompt, Instance playerWhoTriggered)
458 Change Parameters of ProximityPromptService.PromptButtonHoldEnded from (Instance prompt) to (Instance prompt, Instance playerWhoTriggered)
454 Add ProximityPromptService

Members

Enabled On DevHub

Value Type	bool
Category	Data
Can Load	true
Can Save	true

MaxPromptsVisible On DevHub

Value Type	int
Category	Data
Can Load	true
Can Save	true

PromptButtonHoldBegan On DevHub

Parameters	2

Name	Type	Default
prompt	ProximityPrompt	none
playerWhoTriggered	Player	none

History

483 Change Parameters of ProximityPromptService.PromptButtonHoldBegan from (Instance prompt, Instance playerWhoTriggered) to (ProximityPrompt prompt, Player playerWhoTriggered)
458 Change Parameters of ProximityPromptService.PromptButtonHoldBegan from (Instance prompt) to (Instance prompt, Instance playerWhoTriggered)

PromptButtonHoldEnded On DevHub

Parameters	2

Name	Type	Default
prompt	ProximityPrompt	none
playerWhoTriggered	Player	none

History

483 Change Parameters of ProximityPromptService.PromptButtonHoldEnded from (Instance prompt, Instance playerWhoTriggered) to (ProximityPrompt prompt, Player playerWhoTriggered)
458 Change Parameters of ProximityPromptService.PromptButtonHoldEnded from (Instance prompt) to (Instance prompt, Instance playerWhoTriggered)

PromptHidden On DevHub

Parameters	1

Name	Type	Default
prompt	ProximityPrompt	none

History

483 Change Parameters of ProximityPromptService.PromptHidden from (Instance prompt) to (ProximityPrompt prompt)

PromptShown On DevHub

Parameters	2

Name	Type	Default
prompt	ProximityPrompt	none
inputType	ProximityPromptInputType	none

History

483 Change Parameters of ProximityPromptService.PromptShown from (Instance prompt, ProximityPromptInputType inputType) to (ProximityPrompt prompt, ProximityPromptInputType inputType)

PromptTriggerEnded On DevHub

Parameters	2

Name	Type	Default
prompt	ProximityPrompt	none
playerWhoTriggered	Player	none

History

483 Change Parameters of ProximityPromptService.PromptTriggerEnded from (Instance prompt, Instance playerWhoTriggered) to (ProximityPrompt prompt, Player playerWhoTriggered)

PromptTriggered On DevHub

Parameters	2

Name	Type	Default
prompt	ProximityPrompt	none
playerWhoTriggered	Player	none

History

483 Change Parameters of ProximityPromptService.PromptTriggered from (Instance prompt, Instance playerWhoTriggered) to (ProximityPrompt prompt, Player playerWhoTriggered)

Relevant classes (2)

Relevant enums (1)

ProximityPromptInputType