An object that lets you prompt players to interact with an object in the 3D world.
- Memory category
- Instances
- Own members
- 29
- Inherited members
- 75
- Subclasses
- 0
- Siblings
- 608
Properties38
Property categoryBehavior
- Determines if an
Instanceand its descendants can be cloned usingInstance:Clone(), and can be saved/published. - Deprecated: This deprecated property is a variant of
Instance.Archivablewhich should be used instead.Use Archivable instead.
Property categoryData
Property categoryPermissions
- The set of capabilities allowed to be used for scripts inside this container.
- Indicates whether the instance is inside a sandboxed container.
- When enabled, the instance can only access abilities in its
Capabilitieslist.
Defined byProximityPrompt15
Property categoryData
ProximityPrompt.ActionText: string = "Interact" The action text shown to the user.ProximityPrompt.ClickablePrompt: boolean = true Whether the prompt can be activated by clicking/tapping on the prompt UI.ProximityPrompt.Enabled: boolean = true Whether or not this prompt should be shown.ProximityPrompt.Exclusivity: Enum.ProximityPromptExclusivity = Enum.ProximityPromptExclusivity.OnePerButton Used to customize which prompts can be shown at the same time.ProximityPrompt.GamepadKeyCode: Enum.KeyCode = Enum.KeyCode.ButtonX The gamepad button the player should press to trigger the prompt.ProximityPrompt.HoldDuration: number = 0 The duration, in seconds, that the player must hold the button/key down to trigger the prompt.ProximityPrompt.KeyboardKeyCode: Enum.KeyCode = Enum.KeyCode.E The key the player should press to trigger the prompt.ProximityPrompt.MaxActivationDistance: number = 10 The maximum distance a Player'scharactercan be from theProximityPromptfor the prompt to appear.ProximityPrompt.MaxIndicatorDistance: number = 0 The maximum distance at which a lightweight indicator for the prompt is shown, hinting at a nearby interaction before the player is close enough to trigger it.ProximityPrompt.ObjectText: string = "" An optional property that determines the object name text shown to the user.ProximityPrompt.RequiresLineOfSight: boolean = true Whether the prompt is hidden if the path between the player'sCameraand object parented to theProximityPromptis obstructed.ProximityPrompt.Style: Enum.ProximityPromptStyle = Enum.ProximityPromptStyle.Default The style of the prompt's UI.- The pixel offset applied to the prompt's UI.
Property categoryLocalization
ProximityPrompt.AutoLocalize: boolean = true Whether the prompt'sProximityPrompt.ActionTextandProximityPrompt.ObjectTextwill be localized according to theProximityPrompt.RootLocalizationTable.ProximityPrompt.RootLocalizationTable: LocalizationTable A reference to aLocalizationTableto be used to apply automated localization to this prompt'sProximityPrompt.ActionTextandProximityPrompt.ObjectText.
No properties match the filters.
Methods44
Object:GetPropertyChangedSignal( property: string): RBXScriptSignal Get an event that fires when a given property of the object changes.Parameters Parameter Description property: stringThe property to connect to.Returns Type Description RBXScriptSignalA signal that fires whenever the property changes.- Returns true if an object's class matches or inherits from a given class.
Parameters Parameter Description className: stringThe class against which the Object's class will be checked. Case-sensitive.Returns Type Description booleanDescribes whether the Object's class matched or is a subclass of the given class. - Deprecated: This deprecated function is a variant of
Object:IsA()which should be used instead.Parameters Parameter className: stringReturns Type booleanUse IsA instead.
- Applies a tag to the instance.
Parameters Parameter Description tag: stringThe tag to apply to the instance. - This method destroys all of an instance's children.
- Create a copy of an instance and all its descendants, ignoring instances that are not
Archivable.Returns Type Description InstanceA copy of the instance, ornilif the instance is notArchivable. - Sets the
Instance.Parentproperty tonil, locks theInstance.Parentproperty, disconnects all connections, and callsDestroy()on all children. Instance:FindFirstAncestor( name: string): Instance Returns the first ancestor of theInstancewhoseInstance.Nameis equal to the given name.Parameters Parameter Description name: stringTheInstance.Nameto be looked for.Instance:FindFirstAncestorOfClass( className: string): Instance Returns the first ancestor of theInstancewhoseObject.ClassNameis equal to the given className.Parameters Parameter Description className: stringTheObject.ClassNameto be looked for.Instance:FindFirstAncestorWhichIsA( className: string): Instance Returns the first ancestor of theInstancefor whomObject:IsA()returns true for the given className.Parameters Parameter Description className: stringTheObject.ClassNameto be looked for.Instance:FindFirstChild( name: string, recursive: boolean? = false): Instance Returns the first child of theInstancefound with the given name.Parameters Parameter Description name: stringTheInstance.Nameto be searched for.recursive: boolean? = falseWhether or not the search should be conducted recursively.Instance:FindFirstChildOfClass( className: string): Instance Parameters Parameter Description className: stringTheObject.ClassNameto be looked for.Instance:FindFirstChildWhichIsA(className: string,recursive: boolean? = false,): Instance Returns the first child of theInstancefor whomObject:IsA()returns true for the given className.Parameters Parameter Description className: stringTheObject.ClassNameto be searched for.recursive: boolean? = falseWhether or not the search should be conducted recursively.Instance:FindFirstDescendant( name: string): Instance Returns the first descendant found with the givenInstance.Name.Parameters Parameter Description name: stringTheInstance.Nameto search for.- Returns the
Actorassociated with the Instance, if any. Instance:GetAttribute( attribute: string): any Returns the value which has been assigned to the given attribute name.Parameters Parameter Description attribute: stringThe name of the attribute being retrieved.Returns Type Description anyThe value which has been assigned to the given attribute name. If no attribute has been assigned,nilis returned.Instance:GetAttributeChangedSignal( attribute: string): RBXScriptSignal Returns an event that fires when the given attribute changes.Parameters Parameter Description attribute: stringThe name of the specified attribute for which the change signal is being returned.Returns Type Description RBXScriptSignalAn event that fires when the given attribute changes.- Returns a dictionary of the instance's attributes.
Returns Type Description { [string]: any }A dictionary of string → variant pairs for each attribute where the string is the name of the attribute and the variant is a non-nil value. - Returns an array containing all of the instance's children.
Returns Type Description { Instance }An array containing the instance's children. Instance:GetDebugId( scopeLength: number? = 4): string Returns a coded string of the debug ID used internally by Roblox.Parameters Parameter Description scopeLength: number? = 4The scope length.Returns Type Description stringThe Debug ID string.- Returns an array containing all of the descendants of the instance.
Returns Type Description { Instance }An array containing the instance's descendants. - Returns a string describing the instance's ancestry.
- Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Parameters Parameter Description name: stringName of the property to query.selector: string?Optional selector for the pseudo instance you are targeting on the instance.Returns Type Description anyThe styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. Instance:GetStyledPropertyChangedSignal( property: string): RBXScriptSignal Returns an event that fires when the given style property changes on the instance.Parameters Parameter Description property: stringName of the style property for which to listen for changes.Returns Type Description RBXScriptSignalEvent that fires when the given style property changes.- Gets an array of all tags applied to the instance.
Returns Type Description { any }An array of strings, each representing a tag applied to the instance. - Check whether the instance has a given tag.
Parameters Parameter Description tag: stringThe tag to check for on the instance.Returns Type Description booleantrueif the instance has the given tag,falseotherwise. Instance:IsAncestorOf( descendant: Instance): boolean Returns true if anInstanceis an ancestor of the given descendant.Instance:IsDescendantOf( ancestor: Instance): boolean Returnstrueif anInstanceis a descendant of the given ancestor.Instance:IsPropertyModified( property: string): boolean Returnstrueif the value stored in the specified property is not equal to the code-instantiated default.Parameters Parameter Description property: stringName of the property to query.Returns Type Description booleanBoolean indicating whether the property is modified from its code‑instantiated default.Instance:QueryDescendants( selector: string): { Instance } Returns an array containing all descendants of the instance that match theselectorstring.Parameters Parameter Description selector: stringSelector string used to filter elements.Returns Type Description { Instance }An array of instances (empty if nothing matched the selector).- Removes a tag from the instance.
Parameters Parameter Description tag: stringThe tag to remove from the instance. Instance:ResetPropertyToDefault( property: string) Resets a property to its default value.Parameters Parameter Description property: stringName of the property to reset.Instance:SetAttribute( attribute: string, value: any) Sets the attribute with the given name to the given value.Instance:WaitForChild( childName: string, timeOut: number): Instance Returns the child of theInstancewith the given name. If the child does not exist, it will yield the current thread until it does.Parameters Parameter Description childName: stringTheInstance.Nameto be looked for.timeOut: numberAn optional time out parameter.- Deprecated: This item is deprecated in favor of
Instance:Destroy()andInstance:ClearAllChildren(). If you must remove an object from the game, and wish to use the object later, set itsParentproperty tonilinstead of using this method.
Sets the object'sParenttonil, and does the same for all its descendants. - Deprecated: This item has been superseded by
Instance:GetChildren()which should be used in all new work.
Returns an array of the object's children.Returns Type Description { Instance }Array of child objects/instances.Use GetChildren instead.
- Deprecated: This deprecated function is a variant of
Instance:Clone()which should be used instead.Returns Type InstanceUse Clone instead.
- Deprecated: This deprecated function is a variant of
Instance:Destroy()which should be used instead.Use Destroy instead.
Instance:findFirstChild( name: string, recursive: boolean? = false): Instance Deprecated: This deprecated function is a variant ofInstance:FindFirstChild()which should be used instead.Returns Type InstanceUse FindFirstChild instead.
- Deprecated: This deprecated function is a variant of
Instance:GetChildren()which should be used instead.Returns Type { Instance }Use GetChildren instead.
Instance:isDescendantOf( ancestor: Instance): boolean Deprecated: This deprecated function is a variant ofInstance:IsDescendantOf()which should be used instead.Parameters Parameter ancestor: InstanceReturns Type booleanUse IsDescendantOf instead.
- Deprecated: This deprecated function is a variant of
Instance:Remove()which has also been deprecated. Neither function should be used in new work.Use Remove instead.
Defined byProximityPrompt2
No methods match the filters.
Events22
Object.Changed: RBXScriptSignal<( property: string)> Fires immediately after a property of the object changes, with some limitations.Parameters Parameter property: string
Instance.AncestryChanged: RBXScriptSignal<( child: Instance, parent: Instance)> Fires when theInstance.Parentproperty of this object or one of its ancestors is changed.Instance.AttributeChanged: RBXScriptSignal<( attribute: string)> Fires whenever an attribute is changed on theInstance.Parameters Parameter attribute: stringInstance.ChildAdded: RBXScriptSignal<( child: Instance)> Fires after an object is parented to thisInstance.Parameters Parameter child: InstanceInstance.ChildRemoved: RBXScriptSignal<( child: Instance)> Fires after a child is removed from thisInstance.Parameters Parameter child: InstanceInstance.DescendantAdded: RBXScriptSignal<( descendant: Instance)> Fires after a descendant is added to theInstance.Parameters Parameter descendant: InstanceInstance.DescendantRemoving: RBXScriptSignal<( descendant: Instance)> Fires immediately before a descendant of theInstanceis removed.Parameters Parameter descendant: Instance- Fires immediately before (or is deferred until after) the instance is destroyed via
Instance:Destroy(). - Fires whenever any style property is changed on the instance, including when a property is set to
nil. Instance.childAdded: RBXScriptSignal<( child: Instance)> Deprecated: This deprecated event is a variant ofInstance.ChildAddedwhich should be used instead.Parameters Parameter child: InstanceUse ChildAdded instead.
Defined byProximityPrompt12
ProximityPrompt.ButtonHoldBeganActionReplicated: RBXScriptSignal<( player: Player)> Parameters Parameter player: PlayerProximityPrompt.ButtonHoldEndedActionReplicated: RBXScriptSignal<( player: Player)> Parameters Parameter player: PlayerProximityPrompt.IndicatorHidden: RBXScriptSignal<( )> Fires on the client when a lightweight indicator for the prompt is no longer shown.ProximityPrompt.IndicatorShown: RBXScriptSignal<( )> Fires on the client when a lightweight indicator for the prompt becomes visible.ProximityPrompt.PromptButtonHoldBegan: RBXScriptSignal<( playerWhoTriggered: Player)> Triggered when a player begins holding down thekey/button connected to a prompt with a non-zeroProximityPrompt.HoldDuration.Parameters Parameter playerWhoTriggered: PlayerProximityPrompt.PromptButtonHoldEnded: RBXScriptSignal<( playerWhoTriggered: Player)> Triggers when the player ends holding down the button on a prompt with a non-zeroProximityPrompt.HoldDuration.Parameters Parameter playerWhoTriggered: PlayerProximityPrompt.PromptHidden: RBXScriptSignal<( )> Triggers when thepromptbecomes hidden.ProximityPrompt.PromptShown: RBXScriptSignal<( inputType: Enum.ProximityPromptInputType)> Triggers when thepromptbecomes visible.Parameters Parameter inputType: Enum.ProximityPromptInputTypeProximityPrompt.Triggered: RBXScriptSignal<( playerWhoTriggered: Player)> Triggered when the promptkey/button is pressed, or after a specified amount of time holding the button, ifProximityPrompt.HoldDurationis used.Parameters Parameter playerWhoTriggered: PlayerProximityPrompt.TriggeredActionReplicated: RBXScriptSignal<( player: Instance)> Parameters Parameter player: InstanceProximityPrompt.TriggerEnded: RBXScriptSignal<( playerWhoTriggered: Player)> Triggers whenkey/button is released, for longer events where the user is required to hold down the button.Parameters Parameter playerWhoTriggered: PlayerProximityPrompt.TriggerEndedActionReplicated: RBXScriptSignal<( player: Player)> Parameters Parameter player: Player
No events match the filters.