Vgui screen

Class hierarchy
CVGuiScreen ↳CBaseEntity
vguiscreen.cpp

It is a VGUI screen. Useful for in-world monitors.

Warning:This entity does not work in HL2, HL2:DM, or the unedited SDK code; it crashes the game. See VGUI Screen Creation.

Keyvalues

Name (targetname) <string>[ Edit ]

The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.

See also:  Generic Keyvalues, Inputs and Outputs available to all entities

Panel Name (panelname) <string>

Name of the panel to use. This is not a filename.

Overlay Material (overlaymaterial) <string>

Name of a material to overlay over the top of the VGUI screen.

Note:This material must write Z for the VGUI screen to work.

Panel Width in World (width) <integer>

Width of the panel in units.

Panel Height in World (height) <integer>

Height of the panel in units.

Is Transparent? (IsTransparent) <boolean> (in all games since )

Set this to true if you would like your background to be invisible instead of a black fill.

Pitch Yaw Roll (Y Z X) (angles) <QAngle>

This entity's orientation in the world. Pitch is rotation around the Y axis, yaw is the rotation around the Z axis, roll is the rotation around the X axis.

Inputs

SetActive

Make the vgui screen visible.

SetInactive

Make the vgui screen invisible.

See also

• VGUI Screen Creation