The Developer Hub is now deprecated and information on this page may no longer be accurate. To see our new and improved documentation, please click here. You can read more about the future of documentation here.
Collapse Sidebar


Bind an Enum/KeyCode that can be used with an Enum/UserInputType to activate ClickDetector events and Tool objects. When the given key/button is pressed, it fires the Mouse/Button1Down event on the mouse sent to Tool/Equipped. This in turn fires the Tool/Activated event if Tool/ManualActivationOnly is not set to true. For gamepad input, this function is called by the default control scripts in order to bind the ButtonR2 enum/KeyCode.

Note that the Enum/UserInputType specified must be Keyboard or Gamepad1 through Gamepad8 in order to be valid.


Name Type Default Description

Must be Keyboard or Gamepad1 through Gamepad8


The KeyCode (e.g. ButtonX) to bind


Return Type Summary