Instances

fireproximityprompt

Triggers a ProximityPrompt with Real's ProximityPrompt trigger.

Syntax

fireproximityprompt(prompt: Instance)

Arguments

NameTypeDescription
promptInstanceInstance whose ClassName must be ProximityPrompt.

Description

Triggers a ProximityPrompt with Real's ProximityPrompt trigger. The prompt argument must be object with a ClassName field equal to "ProximityPrompt". If the value is not object, the call raises a type error. If ClassName is missing or not a string, it raises "Invalid Instance". If ClassName is not "ProximityPrompt", it raises "ProximityPrompt expected". The function takes no optional arguments and returns nothing.

Call it with 1 parameter(s): prompt. The argument table explains which values are required and which ones only refine the behavior.

It does not return data. Treat the call as an action and handle errors around the call site when needed.

Example

Trigger a ProximityPrompt with its required Instance argument.

local prompt = workspace.InteractivePart.ProximityPrompt

fireproximityprompt(prompt)