HopperBin

Show Deprecated

Deprecated

This deprecated class has been replaced by Tool. Please use Tool for new work instead.

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.

For capturing user input (from the Mouse for example), it is no longer necessary to use HopperBins or Tools. Instead, please use these alternatives:

Summary

Properties

Active:bool
Read Parallel
Deprecated
BinType:Enum.BinType
Read Parallel
Deprecated

Properties inherited from BackpackItem

TextureId:ContentId
Read Parallel
The texture icon that is displayed for a tool in the player's backpack.

Properties inherited from Model

LevelOfDetail:Enum.ModelLevelOfDetail
Plugin Security
Read Parallel
Sets the level of detail on the model for experiences with instance streaming enabled.
ModelStreamingMode:Enum.ModelStreamingMode
Read Parallel
Controls the model streaming behavior on Models when instance streaming is enabled.
PrimaryPart:BasePart
Read Parallel
The primary part of the Model, or nil if not explicitly set.
Scale:number
Not Replicated
Not Scriptable
Read Parallel
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.
WorldPivot:CFrame
Not Replicated
Read Parallel
Determines where the pivot of a Model which does not have a set Model.PrimaryPart is located.

Properties inherited from PVInstance

Origin:CFrame
Not Replicated
Not Scriptable
Read Parallel
Pivot Offset:CFrame
Not Replicated
Not Scriptable
Read Parallel

View all inherited from Instance

View all inherited from Object

Methods

Methods inherited from Model

AddPersistentPlayer(playerInstance : Player):void
Sets this model to be persistent for the specified player. Model.ModelStreamingMode must be set to PersistentPerPlayer for behavior to be changed as a result of addition.
GetBoundingBox():Tuple
Returns a description of a volume that contains all parts of a 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.
GetPersistentPlayers():Instances
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.
GetScale():number
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.
MoveTo(position : Vector3):void
Moves the PrimaryPart to the given position. If a primary part has not been specified, the root part of the model will be used.
RemovePersistentPlayer(playerInstance : Player):void
Makes this model no longer persistent for specified player. Model.ModelStreamingMode must be set to PersistentPerPlayer for behavior to be changed as a result of removal.
ScaleTo(newScaleFactor : number):void
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.
TranslateBy(delta : Vector3):void
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.

Methods inherited from PVInstance

GetPivot():CFrame
Write Parallel
Gets the pivot of a PVInstance.
PivotTo(targetCFrame : CFrame):void
Transforms the PVInstance along with all of its descendant PVInstances such that the pivot is now located at the specified CFrame.