cw.menu classclient

Summary

Methods

Create(setOpen)client
Creates the main menu if it does not exist yet.
GetActivePanel()client
Returns the tab panel shown in the main menu.
GetHeight()client
Returns the height of the main menu.
GetHoldTime()client
Returns the time until which releasing the scoreboard key keeps the main menu open.
GetItems()client
Returns the tab buttons and panels created by the main menu.
GetOpen()client
Returns whether the main menu is open.
GetPanel()client
Returns the main menu panel.
GetWidth()client
Returns the width of the main menu's tab panels.
IsPanelActive(panel)client
Returns whether the main menu is open on a tab panel.
SetOpen(bIsOpen)client
Opens or closes the main menu.
ToggleOpen()client
Opens the main menu if it is closed, and closes it otherwise.

Methods

cw.menu:Create(setOpen)

client gamemodes/catwork/gamemode/core/libraries/cl_menu.lua:99

Creates the main menu if it does not exist yet.

Parameters

  • setOpen Boolean optional, defaults to nil Whether the new menu starts open

cw.menu:GetActivePanel()

client gamemodes/catwork/gamemode/core/libraries/cl_menu.lua:13

Returns the tab panel shown in the main menu.

Returns

  • Panel The active tab panel, or nil if there is none or the menu does not exist

cw.menu:GetHeight()

client gamemodes/catwork/gamemode/core/libraries/cl_menu.lua:51

Returns the height of the main menu.

Returns

  • Number Height in pixels

cw.menu:GetHoldTime()

client gamemodes/catwork/gamemode/core/libraries/cl_menu.lua:33

Returns the time until which releasing the scoreboard key keeps the main menu open.

Set to half a second after the menu is opened with the scoreboard key, so a short press leaves it open.

Returns

  • Number An UnPredictedCurTime value, or nil if the menu was never opened that way

cw.menu:GetItems()

client gamemodes/catwork/gamemode/core/libraries/cl_menu.lua:39

Returns the tab buttons and panels created by the main menu.

Returns

  • Map<Map> Tables with button and panel keyed by the VGUI class name of the tab

cw.menu:GetOpen()

client gamemodes/catwork/gamemode/core/libraries/cl_menu.lua:85

Returns whether the main menu is open.

Returns

  • Boolean Whether the menu is open

cw.menu:GetPanel()

client gamemodes/catwork/gamemode/core/libraries/cl_menu.lua:91

Returns the main menu panel.

Returns

  • Panel The menu, or nil if it has not been created or was removed

cw.menu:GetWidth()

client gamemodes/catwork/gamemode/core/libraries/cl_menu.lua:45

Returns the width of the main menu's tab panels.

Returns

  • Number Width in pixels

cw.menu:IsPanelActive(panel)

client gamemodes/catwork/gamemode/core/libraries/cl_menu.lua:24

Returns whether the main menu is open on a tab panel.

Parameters

  • panel Panel The tab panel to check

Returns

  • Boolean Whether the menu is open and panel is its active tab

cw.menu:SetOpen(bIsOpen)

client gamemodes/catwork/gamemode/core/libraries/cl_menu.lua:75

Opens or closes the main menu.

Does nothing if the menu does not exist.

Parameters

  • bIsOpen Boolean Whether to open the menu

See also

cw.menu:ToggleOpen()

client gamemodes/catwork/gamemode/core/libraries/cl_menu.lua:58

Opens the main menu if it is closed, and closes it otherwise.

Does nothing if the menu does not exist.

Defined in