Reference API Roblox

Engine API

Website

Related

Reference API Roblox

ProximityPrompt

Summary

Member index 26

HistoryMember
553ActionText: string
553AutoLocalize: bool
553ClickablePrompt: bool
553Enabled: bool
553Exclusivity: ProximityPromptExclusivity
553GamepadKeyCode: KeyCode
553HoldDuration: float
553KeyboardKeyCode: KeyCode
553MaxActivationDistance: float
486ObjectText: string
553RequiresLineOfSight: bool
553RootLocalizationTable: LocalizationTable
553Style: ProximityPromptStyle
553UIOffset: Vector2
573InputHoldBegin(): null
573InputHoldEnd(): null
483PromptButtonHoldBegan(playerWhoTriggered: Player)
483PromptButtonHoldEnded(playerWhoTriggered: Player)
462PromptHidden()
462PromptShown(inputType: ProximityPromptInputType)
483TriggerEnded(playerWhoTriggered: Player)
483Triggered(playerWhoTriggered: Player)
inherited from Instance
553Archivable: bool
619Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
619Sandboxed: bool
616UniqueId: UniqueId
553className: string
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
486GetAttributes(): Dictionary
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

History 84

Members 26

ActionText

TypeDefault
stringInteract

History 4

AutoLocalize

TypeDefault
booltrue

History 4

ClickablePrompt

TypeDefault
booltrue

History 4

Enabled

TypeDefault
booltrue

History 4

Exclusivity

TypeDefault
ProximityPromptExclusivityOnePerButton

History 4

GamepadKeyCode

TypeDefault
KeyCodeButtonX

History 4

HoldDuration

TypeDefault
float0

History 4

InputHoldBegin

Parameters (0)
No parameters.
Returns (1)
null

History 3

InputHoldEnd

Parameters (0)
No parameters.
Returns (1)
null

History 3

KeyboardKeyCode

TypeDefault
KeyCodeE

History 4

MaxActivationDistance

TypeDefault
float10

History 4

ObjectText

TypeDefault
string

History 3

PromptButtonHoldBegan

Parameters (1)
playerWhoTriggeredPlayer

History 4

PromptButtonHoldEnded

Parameters (1)
playerWhoTriggeredPlayer

History 4

PromptHidden

Parameters (0)
No parameters.

History 2

PromptShown

Parameters (1)
inputTypeProximityPromptInputType

History 2

RequiresLineOfSight

TypeDefault
booltrue

History 4

RootLocalizationTable

TypeDefault
LocalizationTable

History 4

Style

TypeDefault
ProximityPromptStyleDefault

History 4

TriggerEnded

Parameters (1)
playerWhoTriggeredPlayer

History 3

Triggered

Parameters (1)
playerWhoTriggeredPlayer

History 3

UIOffset

TypeDefault
Vector20, 0

History 4

Settings