s&box docs
API ReferenceSandbox

WorldInputclass

A router for world input, the best place to put this is on your player's camera. Uses cursor ray when mouse is active, otherwise the direction of this gameobject. You could also put this on a VR controller to interact with world panels.

object→Component→WorldInput
Namespace
Sandbox
Assembly
Sandbox.Engine
Declaration
public sealed class Sandbox.WorldInput : Sandbox.Component

Constructors1

Showing 1 constructors

public WorldInput()PUBLICCONSTRUCTORINGEST

Properties4

Showing 4 properties

public Sandbox.UI.Panel Sandbox.WorldInput.Hovered { get; set; }PUBLICGETSET

The `Sandbox.UI.Panel` that is currently hovered by this input.

Returns:Panel—

public string Sandbox.WorldInput.LeftMouseAction { get; set; }PUBLICGETSET

Which action is our left clicking button?

Returns:string—

public string Sandbox.WorldInput.RightMouseAction { get; set; }PUBLICGETSET

Which action is our right clicking button?

Returns:string—

public Sandbox.VR.VRHand.HandSources Sandbox.WorldInput.VRHandSource { get; set; }PUBLICGETSET

If using VR this will be the hand source for input.

Returns:HandSources—

WorkshopId

Previous Page

Hovered

Next Page

On this page

Constructorspublic WorldInput()Propertiespublic Sandbox.UI.Panel Sandbox.WorldInput.Hovered { get; set; }public System.String Sandbox.WorldInput.LeftMouseAction { get; set; }public System.String Sandbox.WorldInput.RightMouseAction { get; set; }public Sandbox.VR.VRHand.HandSources Sandbox.WorldInput.VRHandSource { get; set; }Metadata