This article's documentation is for anything that uses the Source engine. Click here for more information.

Vgui screen: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Updated with data from the official portal2.fgd)
mNo edit summary
 
(18 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{portal2 point|vgui_screen}}
{{LanguageBar}}
{{this is a|point entity|name=vgui_screen}}
{{Source topicon}}


==Entity description==
{{CD|CVGuiScreen|file1=vguiscreen.cpp}} It is a VGUI screen. Useful for in-world monitors.
A VGUI screen. Useful for in-world monitors.
__NOTOC__
{{AltNames|name1=vgui_screen_team}}
{{warning|This entity does not work in {{hl2|4}}, {{hl2dm|4}}, or the unedited SDK code; it crashes the game. See [[VGUI Screen Creation]].}}


==Keyvalues==
==Keyvalues==
{{KV Targetname}}
{{KV Targetname}}
{{KV Parentname}}
{{KV|Panel Name|intn=panelname|string|Name of the panel to use. This is ''not'' a filename.}}
{{KV|Overlay Material|intn=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.}}}}
{{KV|Panel Width in World|intn=width|integer|Width of the panel in units.}}
{{KV|Panel Height in World|intn=height|integer|Height of the panel in units.}}
{{KV|Is Transparent?|intn=IsTransparent|boolean|since={{portal2}}|Set this to true if you would like your background to be invisible instead of a black fill.}}
{{KV Angles}}
{{KV Angles}}
{{KV|Overlay Material|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.}}
{{KV|Panel Width in World|integer|Width of the panel in units.}}
{{KV|Panel Height in World|integer|Height of the panel in units.}}
{{KV|Is Transparent?|boolean|Set this to true if you would like your background to be invisible instead of a black fill.}}


==Inputs==
==Inputs==
{{I Targetname}}
{{I|SetActive|Make the vgui screen visible.}}
{{I Parentname}}
{{I|SetInactive|Make the vgui screen invisible.}}
{{IO|SetActive|Make the vgui screen visible.}}
{{IO|SetInactive|Make the vgui screen invisible.}}


==Outputs==
==See also==
{{O Targetname}}
* [[VGUI Screen Creation]]
* {{ent|vgui_slideshow_display}}

Latest revision as of 14:04, 17 June 2025

English (en)Translate (Translate)

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

C++ Class hierarchy
CVGuiScreen
CBaseEntity
C++ vguiscreen.cpp

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 Half-Life 2 Half-Life 2, Half-Life 2: Deathmatch Half-Life 2: Deathmatch, 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.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.
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