cwFAButton panelclient

Panel defined in core/derma/cl_fabutton.lua

Defines the cwFAButton panel, a button that draws a Font Awesome icon with an optional text label next to it.

The icon is drawn with cw.FontIcons:Draw and set up with SetIcon, SetIconSize and SetText; SetCallback sets what a click does. A collapsible button toggles between showing and hiding its text when clicked, and FadeIn and FadeOut animate its alpha. It is the base of the main menu's buttons, such as cw.menuButton.

Summary

Methods

FadeIn(speed, Callback)client
Shows the button and starts fading it in, playing the click sound.
FadeOut(speed, Callback)client
Starts fading the button out and hiding it, playing the rollover sound.
OnMousePressed()client
Toggles the button when it is collapsible and runs its callback, reporting any error it throws.
OverrideTextColor(color)client
Sets a color that replaces the text and icon color, including the hover color.
Paint(w, h)client
Draws the background, when enabled, then the icon and text, highlighted when hovered.
SetCallback(cb)client
Sets the function called when the button is clicked.
SetCollapsible(coll)client
Sets whether clicking the button toggles it open and closed.
SetDrawBackground(bDrawBackground)client
Sets whether the button draws its dark background box.
SetFont(font)client
Sets the font of the button's text.
SetIcon(id)client
Sets the Font Awesome icon drawn on the button.
SetIconSize(w, h, x, y)client
Sets the icon's size and offset.
SetOpen(bIsOpen)client
Sets whether the button is open, which shows its text next to the icon.
SetText(text)client
Sets the button's text and makes it visible.
SetTextOffset(x, y)client
Sets the position of the text inside the button, replacing the default placement after the icon.
ShouldHover(hover)client
Sets whether the button highlights itself when hovered.
SizeToText()client
Resizes the button to fit its icon and text.
Think()client
Shows the text only while the button is open.
Toggle()client
Toggles whether the button is open.

Methods

PANEL:FadeIn(speed, Callback)

client gamemodes/catwork/gamemode/core/derma/cl_fabutton.lua:215

Shows the button and starts fading it in, playing the click sound.

Parameters

  • speed Number Length of the fade in seconds
  • Callback Function optional, defaults to nil Called once the button is fully visible

PANEL:FadeOut(speed, Callback)

client gamemodes/catwork/gamemode/core/derma/cl_fabutton.lua:190

Starts fading the button out and hiding it, playing the rollover sound.

Parameters

  • speed Number Length of the fade in seconds
  • Callback Function optional, defaults to nil Called once the button is hidden

PANEL:OnMousePressed()

client gamemodes/catwork/gamemode/core/derma/cl_fabutton.lua:102

Toggles the button when it is collapsible and runs its callback, reporting any error it throws.

PANEL:OverrideTextColor(color)

client gamemodes/catwork/gamemode/core/derma/cl_fabutton.lua:238

Sets a color that replaces the text and icon color, including the hover color.

Parameters

  • color Color Color to use, or nil to use the default colors

PANEL:Paint(w, h)

client gamemodes/catwork/gamemode/core/derma/cl_fabutton.lua:129

Draws the background, when enabled, then the icon and text, highlighted when hovered.

Parameters

  • w
  • h

PANEL:SetCallback(cb)

client gamemodes/catwork/gamemode/core/derma/cl_fabutton.lua:124

Sets the function called when the button is clicked.

Parameters

  • cb Function Called with the button; errors are caught and printed

PANEL:SetCollapsible(coll)

client gamemodes/catwork/gamemode/core/derma/cl_fabutton.lua:97

Sets whether clicking the button toggles it open and closed.

Parameters

  • coll Boolean true to toggle on click

PANEL:SetDrawBackground(bDrawBackground)

client gamemodes/catwork/gamemode/core/derma/cl_fabutton.lua:30

Sets whether the button draws its dark background box.

Parameters

  • bDrawBackground Boolean true to draw the background

PANEL:SetFont(font)

client gamemodes/catwork/gamemode/core/derma/cl_fabutton.lua:62

Sets the font of the button's text.

Parameters

  • font String Font name; Derma16 is used when unset

Aliases

  • PANEL.SetTextFont

PANEL:SetIcon(id)

client gamemodes/catwork/gamemode/core/derma/cl_fabutton.lua:36

Sets the Font Awesome icon drawn on the button.

Parameters

PANEL:SetIconSize(w, h, x, y)

client gamemodes/catwork/gamemode/core/derma/cl_fabutton.lua:45

Sets the icon's size and offset.

Parameters

  • w Number optional, defaults to 16 Icon width
  • h Number optional, defaults to 16 Icon height, also used as the icon's draw size
  • x Number optional, defaults to 0 Horizontal offset of the icon
  • y Number optional, defaults to 0 Vertical offset of the icon

PANEL:SetOpen(bIsOpen)

client gamemodes/catwork/gamemode/core/derma/cl_fabutton.lua:24

Sets whether the button is open, which shows its text next to the icon.

Parameters

  • bIsOpen Boolean true to show the text

PANEL:SetText(text)

client gamemodes/catwork/gamemode/core/derma/cl_fabutton.lua:54

Sets the button's text and makes it visible.

Parameters

  • text String Text to draw

PANEL:SetTextOffset(x, y)

client gamemodes/catwork/gamemode/core/derma/cl_fabutton.lua:69

Sets the position of the text inside the button, replacing the default placement after the icon.

Parameters

  • x Number Horizontal offset
  • y Number Vertical offset

PANEL:ShouldHover(hover)

client gamemodes/catwork/gamemode/core/derma/cl_fabutton.lua:118

Sets whether the button highlights itself when hovered.

Parameters

  • hover Boolean true to highlight on hover

PANEL:SizeToText()

client gamemodes/catwork/gamemode/core/derma/cl_fabutton.lua:78

Resizes the button to fit its icon and text.

Aliases

  • PANEL.SizeToContents

PANEL:Think()

client gamemodes/catwork/gamemode/core/derma/cl_fabutton.lua:183

Shows the text only while the button is open.

PANEL:Toggle()

client gamemodes/catwork/gamemode/core/derma/cl_fabutton.lua:87

Toggles whether the button is open.

Defined in