HopperBin

Show Deprecated
deprecated

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

Properties inherited from BackpackItem
  • read parallel

    The texture icon that is displayed for a tool in the player's backpack.

Properties inherited from ModelProperties inherited from PVInstance

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.

  • 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 BaseParts in the Model, aligned with the Model.PrimaryPart if it is set.

  • 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.

  • 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

Properties

Active

read parallel
read parallel

Methods

Events

Deselected


Selected

Parameters

mouse: Instance