Gizmos available in game

[garrynewman]

You can now use gizmos in game. This is a stepping stone to allowing hammer entities to have their own gizmos and implementing some kind of scene view of the main game world.

When using gizmos in game code you need to be aware that if you're creating/using gizmos serverside, they will only show on the listen server host's client pc. They will still totally be usable, and it's totally valid to be doing this stuff for debugging - but if you're doing it expecting other clients to be able to use them - they won't.

What is the gizmo library

Think of gizmos are like IMGUI but for the 3d world. You can use them to draw debug shapes or models or particles.

The main use case is for adding development gizmos, like position and rotate.. but you could totally use them to render effects and other clientside 3d interactables in your actual game.

Example

Each banana in this scene is rendered using the Gizmo api. Every frame a function is called which is saying "render a banana here". The gizmo library does all the optimizing work on the backend saying "this is the same banana object as the last one, so don't change anything" to keep things running nice.

sbox_0043.mp4

The code for rendering one of these bananas is simply

// make the next section clickable
Gizmo.Hitbox.Sphere( new Sphere( 0.0f, 4.0f ) );

// draw a different color if the hitbox above is hovered
Gizmo.Draw.Color = Gizmo.IsHovered ? Color.Green :  Color.White;

// change the size if the hitbox above is pressed down
if ( Gizmo.IsPressed )
	Gizmo.Transform = Gizmo.Transform.WithScale( 2.0f );

// draw the banana model
Gizmo.Draw.Model( "models/rust_props/small_junk/banana.vmdl" );

[Phyksar]

Great news! But does this supposed to work with Event.Debug.Overlay? I'm getting errors of missing objects inside internal methods, I guess, it's currently only for Hammer?

[Event.Debug.Overlay("test", "Test", "square")]
private static void TestOverlay()
{
    Gizmo.Transform = new Transform();
    Gizmo.Draw.IgnoreDepth = true;
    Gizmo.Draw.Color = Color.Green;
    Gizmo.Draw.LineCircle(position, radius);
}

Error calling event 'debugoverlay.test' on 'Sandbox.Pawn'
System.NullReferenceException: Object reference not set to an instance of an object.
   at Sandbox.Gizmo.set_Transform(Transform value)

[garrynewman]

I haven't tested it with that event.. it'll work with client.frame