WorldInput API change

[handsomematt]

The WorldInput API has changed, this resolves a lot of issues people were having with them, giving you more control and allowing stuff like simultaneous inputs for VR.

2021-11-09.02-14-54-1.mp4

To use the API now, create an instance of Sandbox.UI.WorldInput and update the values on that directly either in BuildInput or FrameSimulate or anywhere you think makes sense. This is ticked internally just like normal panel input.

The ideal way to use them is to have WorldInput be a field on either your Pawn or VRHand or something similar, that way the lifecycle is directly attached to it.

Here are some basic examples of various ways you might use them:

// A basic pawn with a WorldInput where they're looking.
partial class MinimalPlayer : Player
{
    WorldInput WorldInput = new();

    public override void BuildInput( InputBuilder input )
    {
        WorldInput.Ray = new Ray( EyePos, EyeRot.Forward );
        WorldInput.MouseLeftPressed = input.Down( InputButton.Attack1 );

        if ( WorldInput.Hovered != null )
        {
            input.ClearButton( InputButton.Attack1 );
            input.ClearButton( InputButton.Attack2 );
        }

        base.BuildInput( input );
    }
}

// VR hand with a WorldInput ( you would make 2 of these )
public partial class BaseVrHand : AnimEntity
{
    public virtual Input.VrHand InputHand { get; }

    WorldInput WorldInput = new();

    public override void FrameSimulate( Client cl )
    {
        WorldInput.Ray = new Ray( Transform.Position, (Rotation * Rotation.FromPitch( 35 )).Forward );
        WorldInput.MouseLeftPressed = InputHand.Trigger.Value > 0.5f;
    }
}

// Using the mouse input directly for your WorldInput
public override void BuildInput( InputBuilder input )
{
	if ( Mouse.Visible )
	{
		WorldInput.Ray = Input.Cursor;
		WorldInput.UseMouseInput = true;
	}
}