Moderator elections are being held. See Valve Developer Community:Moderator elections for more details.
Users who would like to run for moderator must be autoconfirmed and have at least 100 edits. Users can check their own edit count at Special:Preferences.
This article's documentation is for anything that uses the Source engine. Click here for more information.

vgui_screen

From Valve Developer Community
Jump to: navigation, search

vgui_screen is a point entity available in all Source Source games.

English (en)
Edit

class hierarchy
CVGuiScreen defined in vguiscreen.cpp
CBaseEntity

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

AltNames.pngAltNames: This entity is also tied to vgui_screen_team.
Warning.pngWarning:This entity does not work in HL2, HL2:DM, or the unedited SDK code; it crashes the game. See VGUI Screen Creation.

Keyvalues

Targetname:

Name (targetname) <string>
The targetname that other entities refer to this entity by.
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.pngNote: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 Portal 2)
Set this to true if you would like your background to be invisible instead of a black fill.

Angles:

Pitch Yaw Roll (Y Z X) (angles) <angle>
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