ProximityPrompt
A client-visible world prompt whose validated activation is signalled on the server.
Properties
| Property | Type | Default |
|---|---|---|
ActionText | string | "Interact" |
AutoLocalize | boolean | true |
ClickablePrompt | boolean | true |
Enabled | boolean | true |
Exclusivity | EnumItem | Enum.ProximityPromptExclusivity.OnePerButton |
GamepadKeyCode | EnumItem | Enum.KeyCode.ButtonX |
HoldDuration | number | 0 |
KeyboardKeyCode | EnumItem | Enum.KeyCode.E |
MaxActivationDistance | number | 10 |
MaxIndicatorDistance | number | 10 |
ObjectText | string | "" |
RequiresLineOfSight | boolean | true |
RootLocalizationTable | any | nil |
Style | EnumItem | Enum.ProximityPromptStyle.Default |
UIOffset | Vector2 | Vector2.new(0, 0) |
Functions
`getAdornee`
`getPosition`
`getPlayerRoot`
`sameKey`
`managerFor`
`createPromptGui`
`refreshGui`
`updateVisibility`
`instance:Trigger`
`instance:InputHoldBegin`
`instance:InputHoldEnd`
getAdornee
Arguments
promptReturns
This function returns nothing.
getPosition
Arguments
objectReturns
This function returns nothing.
getPlayerRoot
Arguments
playerReturns
This function returns nothing.
sameKey
Arguments
left, rightReturns
This function returns nothing.
managerFor
Arguments
datamodelReturns
This function returns nothing.
createPromptGui
Arguments
This function takes no arguments.
Returns
This function returns nothing.
refreshGui
Arguments
This function takes no arguments.
Returns
This function returns nothing.
updateVisibility
Arguments
This function takes no arguments.
Returns
This function returns nothing.
instance:Trigger
Arguments
This function takes no arguments.
Returns
This function returns nothing.
instance:InputHoldBegin
Arguments
This function takes no arguments.
Returns
This function returns nothing.
instance:InputHoldEnd
Arguments
This function takes no arguments.
Returns
This function returns nothing.
API
instance:getAdornee(prompt)
instance:getPosition(object)
instance:getPlayerRoot(player)
instance:sameKey(left, right)
instance:managerFor(datamodel)
instance:createPromptGui()
instance:refreshGui()
instance:updateVisibility()
instance:Trigger()
instance:InputHoldBegin()
instance:InputHoldEnd()