Vgui screen: Difference between revisions
Jump to navigation
Jump to search
m (Equalizer5118 moved page Vgui screen to Vgui screen/en) |
(-added class hierarchy, cleanup) |
||
| Line 1: | Line 1: | ||
{{Source topicon}} | {{Source topicon}} | ||
{{Language subpage}} | {{Language subpage}} | ||
{{ | {{CD|CVGuiScreen|file1=vguiscreen.cpp}} | ||
{{entity|vgui_screen|type=e0}} It is a VGUI screen. Useful for in-world monitors. | |||
__NOTOC__ | |||
{{ModernWarning|This entity does not work in HL2, HL2:DM, or the unedited SDK code; it crashes the game. See [[VGUI Screen Creation]].}} | {{ModernWarning|This entity does not work in HL2, HL2:DM, or the unedited SDK code; it crashes the game. See [[VGUI Screen Creation]].}} | ||
==Keyvalues== | ==Keyvalues== | ||
{{KV Targetname}} | {{KV Targetname}} | ||
{{KV|Panel Name|intn=panelname|string|Name of the panel to use. This is ''not'' a filename.}} | {{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|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 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|Panel Height in World|intn=height|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.}} | {{KV|Is Transparent?|intn=???|boolean|Set this to true if you would like your background to be invisible instead of a black fill.{{todo|internal name}}}} | ||
{{KV Angles}} | |||
==Inputs== | ==Inputs== | ||
{{IO|SetActive|Make the vgui screen visible.}} | {{IO|SetActive|Make the vgui screen visible.}} | ||
{{IO|SetInactive|Make the vgui screen invisible.}} | {{IO|SetInactive|Make the vgui screen invisible.}} | ||
==See also== | ==See also== | ||
* [[VGUI Screen Creation]] | * [[VGUI Screen Creation]] | ||
Revision as of 23:16, 5 September 2023
 Class hierarchy
|
|---|
| CVGuiScreen |
| vguiscreen.cpp
|
Template:Entity It is a VGUI screen. Useful for in-world monitors.
Keyvalues
- Name (targetname) <string>[ Edit ]
- The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g.
parentnameortarget).
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? (???) <boolean>
- Set this to true if you would like your background to be invisible instead of a black fill.Todo: internal name
- 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.