Button: Difference between revisions
Jump to navigation
Jump to search
(Created page with "A button players can click on. Inherits all properties from Panel. == Properties == {{Button_Properties}} {{Panel_Properties}} == See Also == * https://developer.valveso...") |
No edit summary |
||
Line 4: | Line 4: | ||
{{Button_Properties}} | {{Button_Properties}} | ||
{{Panel_Properties}} | {{Panel_Properties}} | ||
== Example == | |||
<pre> | |||
"Button" | |||
{ | |||
"ControlName" "Button" | |||
"fieldName" "Button" | |||
"xpos" "120" | |||
"ypos" "20" | |||
"wide" "82" | |||
"tall" "24" | |||
"autoResize" "0" | |||
"pinCorner" "3" | |||
"visible" "1" | |||
"enabled" "1" | |||
"tabPosition" "2" | |||
"labelText" "#Button_Text" | |||
"textAlignment" "west" | |||
"dulltext" "0" | |||
"brighttext" "0" | |||
"wrap" "0" | |||
} | |||
</pre> | |||
== See Also == | == See Also == | ||
* https://developer.valvesoftware.com/wiki/Understanding_VGUI2_Resource_Files#Button | * https://developer.valvesoftware.com/wiki/Understanding_VGUI2_Resource_Files#Button | ||
[[Category:VGUI Elements]] | [[Category:VGUI Elements]] |
Revision as of 13:48, 7 August 2017
A button players can click on. Inherits all properties from Panel.
Properties
Properties Inherited from Button
- command: Determines which argument to use on the OnCommand event when pressed.
- default: A boolean that determines if this button is to be activated when the user presses the enter or space bar keys. Only one such button can exist.
- selected: A boolean that determines if this button appears to have been selected.
- sound_armed: Determines what sound the button makes when hovered over.
- sound_depressed: Determines what sound the button makes when pressed upon.
- sound_released: Determines what sound the button makes when released
- defaultFgColor_override: Button specific foreground color option.
- defaultBgColor_override: Button specific foreground color option.
- armedFgColor_override: Foreground color when hovering.
- armedBgColor_override: Background color when hovering.
- depressedFgColor_override: Foreground color when depressed.
- depressedBgColor_override: Background color when depressed.
- selectedFgColor_override: Foreground color when selected.
- selectedBgColor_override: Background color when selected.
- keyboardFocusColor_override: Color when element has keyboard focus.
- blinkFgColor_override: Color when blinking.
Properties Inherited from Label
- labelText: Determines the text that the label will display.
- textAlignment: Determines the alignment of the label. Valid values are north-west, north, north-east, west, center, east, south-west, south and south-east.
- associate: Allows the label to be associated with another control. Fill in the fieldName of the element you want to focus on when this label is clicked.
- dulltext: A boolean that determines if text should be displayed in a dull manner. Cannot be used together with brighttext.
- brighttext: A boolean that determines if text should be displayed in a bright manner. Cannot be used together with dulltext.
- font: Determines the font used by the label. Use the font name as defined in the SourceScheme.res file.
- wrap: Determines if your label wraps around the available space.
- centerwrap: Same as above, except it also works for centered text.
- textinsetx: Additional horizontal offset space from whichever side it is aligned.
- textinsety: Additional vertical offset space from whichever side it is aligned.
- disabledfgcolor2_override: Sets the foreground color when the label is disabled.
Properties Inherited from Panel
- fieldName: Determines the name of the control.
- xpos: Determines the horizontal offset from the top left (by default) of the parent panel.
- ypos: Determines the vertical offset from the top left (by default) of the parent panel.
- wide: Determines the width of the control.
- tall: Determines the height of the control.
- zpos: Determines the depth of the panel. Deeper panels are drawn first. Lower numbers = deeper.
- pinCorner: The pinned corner is the one positioned at xpos/ypos. Values are: TOPLEFT (default), TOPRIGHT, BOTTOMLEFT, BOTTOMRIGHT
- pinnedCornerOffsetX:
- pinnedCornerOffsetY:
- unpinnedCornerOffsetX:
- unpinnedCornerOffsetY:
- visible: Determines if the control will be drawn.
- enabled: Determines if the control is enabled. Used by controls higher up the chain (like Buttons).
- ignoreScheme:
- tabPosition: Determines the tab order of the control.
- tooltiptext: Determines the tooltip text to show when you hover over this control.
- paintbackground: Paint the background color of this control.
- paintBackgroundType:
- paintborder: Paint the border of this control.
- autoResize: Sets which edges of the panel can be resized. Values are: 0 (NO, default), 1 (RIGHT), 2 (DOWN), 3 (DOWNANDRIGHT)
- fgcolor_override: Sets the foreground color
- bgcolor_override: Sets the background color
Properties Inherited from Panel
- fieldName: Determines the name of the control.
- xpos: Determines the horizontal offset from the top left (by default) of the parent panel.
- ypos: Determines the vertical offset from the top left (by default) of the parent panel.
- wide: Determines the width of the control.
- tall: Determines the height of the control.
- zpos: Determines the depth of the panel. Deeper panels are drawn first. Lower numbers = deeper.
- pinCorner: The pinned corner is the one positioned at xpos/ypos. Values are: TOPLEFT (default), TOPRIGHT, BOTTOMLEFT, BOTTOMRIGHT
- pinnedCornerOffsetX:
- pinnedCornerOffsetY:
- unpinnedCornerOffsetX:
- unpinnedCornerOffsetY:
- visible: Determines if the control will be drawn.
- enabled: Determines if the control is enabled. Used by controls higher up the chain (like Buttons).
- ignoreScheme:
- tabPosition: Determines the tab order of the control.
- tooltiptext: Determines the tooltip text to show when you hover over this control.
- paintbackground: Paint the background color of this control.
- paintBackgroundType:
- paintborder: Paint the border of this control.
- autoResize: Sets which edges of the panel can be resized. Values are: 0 (NO, default), 1 (RIGHT), 2 (DOWN), 3 (DOWNANDRIGHT)
- fgcolor_override: Sets the foreground color
- bgcolor_override: Sets the background color
Example
"Button" { "ControlName" "Button" "fieldName" "Button" "xpos" "120" "ypos" "20" "wide" "82" "tall" "24" "autoResize" "0" "pinCorner" "3" "visible" "1" "enabled" "1" "tabPosition" "2" "labelText" "#Button_Text" "textAlignment" "west" "dulltext" "0" "brighttext" "0" "wrap" "0" }