Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
HopperBin
Inherits from: BackpackItem → Model → PVInstance → Instance → Object
HopperBins are an outdated system for creating tools that can be used by a player. In place of HopperBins, please use Tool instead.
Historically, only HopperBins worked without a 'Handle' Part, but this is no longer the case thanks to the Tool.RequiresHandle property of Tools.
Inherits from: BackpackItem
Memory category: BaseParts
Tags: Deprecated
Deprecated: This deprecated class has been replaced by Tool. Please use Tool for new work instead.
Properties
| Name | Type / Returns | Description |
|---|---|---|
| HopperBin.Active | boolean | |
| HopperBin.BinType | BinType |
Inherited from BackpackItem
| Name | Type / Returns | Description |
|---|---|---|
| BackpackItem.TextureContent | Content | The texture icon that is displayed for a tool in the player's backpack. Only supports asset URIs. |
| BackpackItem.TextureId | ContentId | The texture icon that is displayed for a tool in the player's backpack. |
Inherited from Model
| Name | Type / Returns | Description |
|---|---|---|
| Model.LevelOfDetail | ModelLevelOfDetail | Sets the level of detail on the model for experiences with instance streaming enabled. |
| Model.ModelStreamingMode | ModelStreamingMode | Controls the model streaming behavior on Models when instance streaming is enabled. |
| Model.PrimaryPart | BasePart | The primary part of the Model, or nil if not explicitly set. |
| Model.Scale | float | 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.WorldPivot | CFrame | Determines where the pivot of a Model which does not have a set Model.PrimaryPart is located. |
Inherited from PVInstance
| Name | Type / Returns | Description |
|---|---|---|
| PVInstance.Origin | CFrame | Editor-only property that reads and sets the world CFrame of the PVInstance's pivot, moving the entire instance when changed from the Studio Properties window. |
| PVInstance.Pivot Offset | CFrame | Editor-only property that displays and edits the pivot's CFrame relative to the instance, moving only the pivot and leaving the instance in place. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.Archivable | boolean | Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published. |
| Instance.archivable | boolean | |
| Instance.Capabilities | SecurityCapabilities | The set of capabilities allowed to be used for scripts inside this container. |
| Instance.IsInSandbox | boolean | Indicates whether the instance is inside a sandboxed container. |
| Instance.Name | string | A non-unique identifier of the Instance. |
| Instance.Parent | Instance | Determines the hierarchical parent of the Instance. |
| Instance.PredictionMode | PredictionMode | Reflects the client-side prediction mode applied to the instance under server-authoritative physics. |
| Instance.RobloxLocked | boolean | A deprecated property that used to protect CoreGui objects. |
| Instance.Sandboxed | boolean | When enabled, the instance can only access abilities in its Capabilities list. |
| Instance.UniqueId | UniqueId | A unique identifier for the instance. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.ClassName | string | A read-only string representing the class this Object belongs to. |
| Object.className | string |
HopperBin.Active
Deprecated. The HopperBin object has been superseded by the Tool object which should be used for all new work.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Input"] |
HopperBin.BinType
Deprecated. The HopperBin object has been superseded by the Tool object which should be used for all new work.
| Field | Value |
|---|---|
| type | BinType |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Input"] |
Events
| Name | Type / Returns | Description |
|---|---|---|
| HopperBin.Deselected | ||
| HopperBin.Selected |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.AncestryChanged | Fires when the Instance.Parent property of this object or one of its ancestors is changed. | |
| Instance.AttributeChanged | Fires whenever an attribute is changed on the Instance. | |
| Instance.ChildAdded | Fires after an object is parented to this Instance. | |
| Instance.childAdded | ||
| Instance.ChildRemoved | Fires after a child is removed from this Instance. | |
| Instance.DescendantAdded | Fires after a descendant is added to the Instance. | |
| Instance.DescendantRemoving | Fires immediately before a descendant of the Instance is removed. | |
| Instance.Destroying | Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy(). | |
| Instance.StyledPropertiesChanged | Fires whenever any style property is changed on the instance, including when a property is set to nil. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.Changed | Fires immediately after a property of the object changes, with some limitations. |
HopperBin.Deselected
Deprecated. The HopperBin object has been superseded by the Tool object which should be used for all new work.
| Field | Value |
|---|---|
| security | None |
| capabilities | ["Input"] |
HopperBin.Selected
Deprecated. The HopperBin object has been superseded by the Tool object which should be used for all new work.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| mouse | Instance |
| Field | Value |
|---|---|
| security | None |
| capabilities | ["Input"] |
Methods
Inherited from Model
| Name | Type / Returns | Description |
|---|---|---|
| Model:AddPersistentPlayer | () | Sets this model to be persistent for the specified player. ModelStreamingMode must be set to PersistentPerPlayer for behavior to be changed as a result of addition. |
| Model:BreakJoints | () | Breaks connections between BaseParts, including surface connections with any adjacent parts, WeldConstraints and all Welds and other JointInstances. |
| Model:breakJoints | () | |
| Model:GetBoundingBox | Tuple | Returns a description of a volume that contains all parts of a Model. |
| Model:GetExtentsSize | Vector3 | Returns the size of the smallest bounding box that contains all of the BaseParts in the Model, aligned with the Model.PrimaryPart if it is set. |
| Model:GetModelCFrame | CFrame | This value historically returned the CFrame of a central position in the model. |
| Model:GetModelSize | Vector3 | Returns the Vector3 size of the Model. |
| Model:GetPersistentPlayers | List | Returns all the Player objects that this model object is persistent for. Behavior varies based on whether this method is called from a Script or a LocalScript. |
| Model:GetPrimaryPartCFrame | CFrame | Returns the CFrame of the model's Model.PrimaryPart. This function will throw an error if no primary part exists for the Model. |
| Model:GetScale | float | 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(). |
| Model:MakeJoints | () | Goes through all BaseParts in the Model. If any part's side has a SurfaceType that can make a joint it will create a joint with any adjacent parts. |
| Model:makeJoints | () | |
| Model:move | () | |
| Model:MoveTo | () | Moves the PrimaryPart to the given position. If a primary part has not been specified, the root part of the model will be used. |
| Model:moveTo | () | |
| Model:RemovePersistentPlayer | () | Makes this model no longer persistent for the specified player. ModelStreamingMode must be set to PersistentPerPlayer for behavior to be changed as a result of removal. |
| Model:ResetOrientationToIdentity | () | Resets the rotation of the model's parts to the previously set identity rotation, which is done through the Model:SetIdentityOrientation() method. |
| Model:ScaleTo | () | 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. |
| Model:SetIdentityOrientation | () | Sets the identity rotation of the given model, allowing you to reset the rotation of the entire model later, through the use of the ResetOrientationToIdentity method. |
| Model:SetPrimaryPartCFrame | () | Sets the BasePart.CFrame of the model's Model.PrimaryPart. All other parts in the model will also be moved and will maintain their orientation and offset respective to the Model.PrimaryPart. |
| Model:TranslateBy | () | Shifts a Model by the given Vector3 offset, preserving the model's orientation. If another BasePart or Terrain already exists at the new position then the Model will overlap said object. |
Inherited from PVInstance
| Name | Type / Returns | Description |
|---|---|---|
| PVInstance:GetPivot | CFrame | Gets the pivot of a PVInstance. |
| PVInstance:PivotTo | () | Transforms the PVInstance along with all of its descendant PVInstances such that the pivot is now located at the specified CFrame. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance:AddTag | () | Applies a tag to the instance. |
| Instance:children | Instances | Returns an array of the object's children. |
| Instance:ClearAllChildren | () | This method destroys all of an instance's children. |
| Instance:Clone | Instance | Create a copy of an instance and all its descendants, ignoring instances that are not Archivable. |
| Instance:clone | Instance | |
| Instance:Destroy | () | Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children. |
| Instance:destroy | () | |
| Instance:FindFirstAncestor | Instance? | Returns the first ancestor of the Instance whose Instance.Name is equal to the given name. |
| Instance:FindFirstAncestorOfClass | Instance? | Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className. |
| Instance:FindFirstAncestorWhichIsA | Instance? | Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstChild | Instance? | Returns the first child of the Instance found with the given name. |
| Instance:findFirstChild | Instance | |
| Instance:FindFirstChildOfClass | Instance? | Returns the first child of the Instance whose ClassName is equal to the given class name. |
| Instance:FindFirstChildWhichIsA | Instance? | Returns the first child of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstDescendant | Instance? | Returns the first descendant found with the given Instance.Name. |
| Instance:GetActor | Actor? | Returns the Actor associated with the Instance, if any. |
| Instance:GetAttribute | Variant | Returns the value which has been assigned to the given attribute name. |
| Instance:GetAttributeChangedSignal | RBXScriptSignal | Returns an event that fires when the given attribute changes. |
| Instance:GetAttributes | Dictionary | Returns a dictionary of the instance's attributes. |
| Instance:GetChildren | Instances | Returns an array containing all of the instance's children. |
| Instance:getChildren | Instances | |
| Instance:GetDebugId | string | Returns a coded string of the debug ID used internally by Roblox. |
| Instance:GetDescendants | Instances | Returns an array containing all of the descendants of the instance. |
| Instance:GetFullName | string | Returns a string describing the instance's ancestry. |
| Instance:GetStyled | Variant | Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. |
| Instance:GetStyledPropertyChangedSignal | RBXScriptSignal | Returns an event that fires when the given style property changes on the instance. |
| Instance:GetTags | Array | Gets an array of all tags applied to the instance. |
| Instance:HasTag | boolean | Check whether the instance has a given tag. |
| Instance:IsAncestorOf | boolean | Returns true if an Instance is an ancestor of the given descendant. |
| Instance:IsDescendantOf | boolean | Returns true if an Instance is a descendant of the given ancestor. |
| Instance:isDescendantOf | boolean | |
| Instance:IsPropertyModified | boolean | Returns true if the value stored in the specified property is not equal to the code-instantiated default. |
| Instance:QueryDescendants | Instances | Returns an array containing all descendants of the instance that match the selector string. |
| Instance:Remove | () | Sets the object's Parent to nil, and does the same for all its descendants. |
| Instance:remove | () | |
| Instance:RemoveTag | () | Removes a tag from the instance. |
| Instance:ResetPropertyToDefault | () | Resets a property to its default value. |
| Instance:SetAttribute | () | Sets the attribute with the given name to the given value. |
| Instance:WaitForChild | Instance | Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object:GetPropertyChangedSignal | RBXScriptSignal | Get an event that fires when a given property of the object changes. |
| Object:IsA | boolean | Returns true if an object's class matches or inherits from a given class. |
| Object:isA | boolean |