cwLabelButton panelclient

Panel defined in core/derma/cl_labelbutton.lua

Defines cwLabelButton, a DLabel that works as a button with hovered, depressed and disabled states and an optional background box.

Has FadeIn and FadeOut animations that play the theme's click and rollover sounds, OverrideTextColor, and SetCallback to set the click handler. The character menu and the quiz use it for their buttons.

Summary

Methods

FadeIn(speed, Callback)client
Shows the label and starts fading it in, playing the click sound.
FadeOut(speed, Callback)client
Starts fading the label out and hiding it, playing the rollover sound.
GetDepressed()client
Returns whether the label is held down.
GetDisabled()client
Returns whether the label is disabled.
GetHovered()client
Returns whether the label is hovered.
OnCursorEntered()client
Marks the label as hovered unless it is disabled.
OnCursorExited()client
Clears the label's hovered state.
OnMousePressed(code)client
Captures the mouse and marks the label as held down.
OnMouseReleased(code)client
Releases the mouse and calls DoClick when the left button is released over an enabled label.
OverrideTextColor(color)client
Sets a text color that replaces the default white, with a darker variant used when hovered or disabled.
Paint(w, h)client
Draws the background box, when enabled, lighter while hovered.
SetBackgroundSize(w, h)client
Sets the size of the background box, or makes it follow the text size.
SetCallback(Callback)client
Sets the function called when the label is clicked, playing the click sound first.
SetDepressed(depressed)client
Sets whether the label is held down.
SetDisabled(disabled)client
Sets whether the label ignores hovering and clicks and is drawn greyed out.
SetDrawBackground(bDraw)client
Sets whether a translucent box is drawn behind the label.
SetHovered(hovered)client
Sets whether the label is hovered.
Think()client
Runs the fade animation, sizes the label to its background box and colors the text for its disabled, hovered or normal state.

Methods

PANEL:FadeIn(speed, Callback)

client gamemodes/catwork/gamemode/core/derma/cl_labelbutton.lua:143

Shows the label 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 label is fully visible

PANEL:FadeOut(speed, Callback)

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

Starts fading the label 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 label is hidden

PANEL:GetDepressed()

client gamemodes/catwork/gamemode/core/derma/cl_labelbutton.lua:38

Returns whether the label is held down.

Returns

  • Boolean Whether the label is held down

PANEL:GetDisabled()

client gamemodes/catwork/gamemode/core/derma/cl_labelbutton.lua:26

Returns whether the label is disabled.

Returns

  • Boolean Whether the label is disabled

PANEL:GetHovered()

client gamemodes/catwork/gamemode/core/derma/cl_labelbutton.lua:50

Returns whether the label is hovered.

Returns

  • Boolean Whether the label is hovered

PANEL:OnCursorEntered()

client gamemodes/catwork/gamemode/core/derma/cl_labelbutton.lua:55

Marks the label as hovered unless it is disabled.

PANEL:OnCursorExited()

client gamemodes/catwork/gamemode/core/derma/cl_labelbutton.lua:84

Clears the label's hovered state.

PANEL:OnMousePressed(code)

client gamemodes/catwork/gamemode/core/derma/cl_labelbutton.lua:90

Captures the mouse and marks the label as held down.

Parameters

  • code

PANEL:OnMouseReleased(code)

client gamemodes/catwork/gamemode/core/derma/cl_labelbutton.lua:96

Releases the mouse and calls DoClick when the left button is released over an enabled label.

Parameters

  • code

PANEL:OverrideTextColor(color)

client gamemodes/catwork/gamemode/core/derma/cl_labelbutton.lua:166

Sets a text color that replaces the default white, with a darker variant used when hovered or disabled.

Parameters

  • color Color Text color, or nil/false to use the default colors

PANEL:Paint(w, h)

client gamemodes/catwork/gamemode/core/derma/cl_labelbutton.lua:221

Draws the background box, when enabled, lighter while hovered.

Parameters

  • w
  • h

PANEL:SetBackgroundSize(w, h)

client gamemodes/catwork/gamemode/core/derma/cl_labelbutton.lua:72

Sets the size of the background box, or makes it follow the text size.

Parameters

  • w Number optional, defaults to nil Width of the box; leave out with h to fit the text
  • h Number optional, defaults to nil Height of the box; leave out with w to fit the text

PANEL:SetCallback(Callback)

client gamemodes/catwork/gamemode/core/derma/cl_labelbutton.lua:237

Sets the function called when the label is clicked, playing the click sound first.

Parameters

  • Callback Function Called with the label

PANEL:SetDepressed(depressed)

client gamemodes/catwork/gamemode/core/derma/cl_labelbutton.lua:32

Sets whether the label is held down.

Parameters

  • depressed Boolean true while the mouse button is held on it

PANEL:SetDisabled(disabled)

client gamemodes/catwork/gamemode/core/derma/cl_labelbutton.lua:20

Sets whether the label ignores hovering and clicks and is drawn greyed out.

Parameters

  • disabled Boolean true to disable the label

PANEL:SetDrawBackground(bDraw)

client gamemodes/catwork/gamemode/core/derma/cl_labelbutton.lua:65

Sets whether a translucent box is drawn behind the label.

Parameters

  • bDraw Boolean optional, defaults to false true to draw the box

PANEL:SetHovered(hovered)

client gamemodes/catwork/gamemode/core/derma/cl_labelbutton.lua:44

Sets whether the label is hovered.

Parameters

  • hovered Boolean true while the cursor is over it

PANEL:Think()

client gamemodes/catwork/gamemode/core/derma/cl_labelbutton.lua:179

Runs the fade animation, sizes the label to its background box and colors the text for its disabled, hovered or normal state.

Defined in