An object, such as a weapon, that can be equipped by a
Humanoid.- Memory category
- BaseParts
- Own members
- 17
- Inherited members
- 116
- Subclasses
- 1
- Siblings
- 2
Properties51
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.
Property categoryPivot
- Editor-only property that displays and edits the pivot's
CFramerelative to the instance, moving only the pivot and leaving the instance in place.
Property categoryTransform
- Editor-only property that reads and sets the world
CFrameof thePVInstance's pivot, moving the entire instance when changed from the Studio Properties window.
Property categoryAppearance
- Sets the level of detail on the model for experiences with instance streaming enabled.
Property categoryBehavior
- Controls the model streaming behavior on
Modelswhen instance streaming is enabled.
Property categoryData
Model.ModelMeshCFrame: CFrame = CFrame.identity Model.ModelMeshSize: Vector3 = Vector3.zero Model.NeedsPivotMigration: boolean = false
Property categoryPivot
- The primary part of the
Model, ornilif not explicitly set. - Editor-only property used to scale the model around its pivot. Setting this property will move the scale as though
Model:ScaleTo()was called on it. Model.ScaleFactor: number = 1 Model.WorldPivot: CFrame = CFrame.identity Determines where the pivot of aModelwhich does not have a setModel.PrimaryPartis located.
Property categoryData
- The texture icon that is displayed for a tool in the player's backpack. Only supports asset URIs.
- The texture icon that is displayed for a tool in the player's backpack.
Defined byTool10
Property categoryAppearance
Tool.ToolTip: string = "" Controls the message displayed when the player's mouse hovers over the tool in their backpack.
Property categoryBehavior
No properties match the filters.
Methods67
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.
- Gets the pivot of a
PVInstance. PVInstance:PivotTo( targetCFrame: CFrame) Transforms thePVInstancealong with all of its descendantPVInstancessuch that the pivot is now located at the specifiedCFrame.Parameters Parameter Description targetCFrame: CFrameTheCFramethat thePVInstancepivot should equal after moving it.
Model:AddPersistentPlayer( playerInstance: Player? = nil) Sets this model to be persistent for the specified player.ModelStreamingModemust be set toPersistentPerPlayerfor behavior to be changed as a result of addition.Model:GetBoundingBox( ): (CFrame, Vector3) Returns a description of a volume that contains all parts of a Model.- Returns the size of the smallest bounding box that contains all of the
BasePartsin theModel, aligned with theModel.PrimaryPartif it is set. - Returns all the
Playerobjects that this model object is persistent for. Behavior varies based on whether this method is called from aScriptor aLocalScript.Returns Type Description { Instance }A table with all thePlayerobjects that this model object is persistent for. - Returns the canonical scale of the model, which defaults to 1 for newly created models and will change as it is scaled via
Model:ScaleTo().Returns Type Description numberThe current canonical scale factor of the model. - Moves the
PrimaryPartto the given position. If a primary part has not been specified, the root part of the model will be used. Model:RemovePersistentPlayer( playerInstance: Player? = nil) Makes this model no longer persistent for the specified player.ModelStreamingModemust be set toPersistentPerPlayerfor behavior to be changed as a result of removal.- Sets the scale factor of the model, adjusting the sizing and location of all descendant Instances such that they have that scale factor relative to their initial sizes and locations when scale factor was 1.
Parameters Parameter Description newScaleFactor: numberThe new scale factor for the model, which must be a positive non-zero number. A value of 1 represents the model's original size. Model:TranslateBy( delta: Vector3) - Deprecated:
Breaks connections betweenBaseParts, including surface connections with any adjacent parts,WeldConstraintsand allWeldsand otherJointInstances. - Deprecated: This function has been deprecated as it did not provide reliable results. You can instead use
Model:GetPrimaryPartCFrame()to retrieve theCFrameof the model's primary part.
This value historically returned the CFrame of a central position in the model.Use GetPrimaryPartCFrame instead.
- Deprecated: This item is deprecated. Do not use it for new work. Developers can instead use
Model.GetExtentsSize.
Returns the Vector3 size of the Model.Use GetExtentsSize instead.
- Deprecated:
Returns theCFrameof the model'sModel.PrimaryPart. This function will throw an error if no primary part exists for theModel.Returns Type Description CFrameTheCFrameof the model'sModel.PrimaryPart.Use GetPivot instead.
- Deprecated: This joint type has been deprecated. Don't use it for new work. Use
WeldConstraintsandHingeConstraintsinstead.
Goes through allBasePartsin theModel. If any part's side has a SurfaceType that can make a joint it will create a joint with any adjacent parts. - Deprecated: This function has been deprecated; it remains to prevent legacy scripts from throwing errors, but it does nothing when called.
Resets the rotation of the model's parts to the previously set identity rotation, which is done through theModel:SetIdentityOrientation()method.Use SetPrimaryPartCFrame instead.
- Deprecated: This function has been deprecated; it remains to prevent legacy scripts from throwing errors, but it does nothing when called.
Sets the identity rotation of the given model, allowing you to reset the rotation of the entire model later, through the use of theResetOrientationToIdentitymethod.Use SetPrimaryPartCFrame instead.
Model:SetPrimaryPartCFrame( cframe: CFrame) Deprecated:
Sets theBasePart.CFrameof the model'sModel.PrimaryPart. All other parts in the model will also be moved and will maintain their orientation and offset respective to theModel.PrimaryPart.Use PivotTo instead.
- Deprecated: This deprecated function is a variant of
Model:BreakJoints()which should be used instead.Use BreakJoints instead.
- Deprecated: This deprecated function is a variant of
Model:MakeJoints()which should be used instead.Use MakeJoints instead.
- Deprecated: This item has been superseded by
Model:MoveTo()which should be used in all new workParameters Parameter location: Vector3Use MoveTo instead.
- Deprecated: This deprecated function is a variant of
Model:MoveTo()which should be used instead.Parameters Parameter location: Vector3Use MoveTo instead.
Defined byTool2
No methods match the filters.
Events15
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 byTool5
Tool.Activated: RBXScriptSignal<( )> Fires when the player clicks while the tool is equipped.Tool.Deactivated: RBXScriptSignal<( )> Fires when the player releases their click while the tool is equipped and activated.Tool.Equipped: RBXScriptSignal<( mouse: Mouse)> Fires when the tool is equipped.Parameters Parameter mouse: MouseTool.Unequipped: RBXScriptSignal<( )> Fires when the tool is unequipped.Tool.VRLaserPointerClicked: RBXScriptSignal<( player: Player)> Parameters Parameter player: Player
No events match the filters.