cw.theme classclient

Starts building a new theme with the arguments in the old order.

Parameters

• isFixed Boolean optional, defaults to nil Whether players cannot change the information color
• name String optional, defaults to 'Schema' Name of the theme
• baseName String optional, defaults to nil Name of the theme to derive from

Returns

• Map The new theme table

Calls a hook of the active theme.

Theme hooks such as PreMainMenuPaint live in the theme's hooks table. The Pre hooks can return true to replace the default drawing or behaviour.

Parameters

• hookName String Name of the hook
• ... Any Arguments passed to the hook

Returns

• Any Whatever the hook returns, or nil if the active theme does not define it

Copies the active theme's skin table into the Clockwork Derma skin and refreshes the skins.

Returns whether a theme is registered.

Parameters

• id String Name of the theme

Returns

• Boolean Whether the theme exists

Returns a registered theme by name.

Parameters

• id String Name of the theme

Returns

• Map The theme table, or nil if it does not exist

Saves a theme to the theme library and clears cwTHEME.

Parameters

• themeTable Map The theme table
• bNoSwitch Boolean optional, defaults to nil Whether to keep the current theme instead of switching to this one

See also

• cw.theme:Register

Returns the active theme.

Returns

• Map The active theme table, or nil if none is loaded

Returns every registered theme.

Returns

• Map<Map> Theme tables keyed by name

Returns a new markup object for building tooltip and info text.

local markup = cw.theme:GetMarkupObject()
markup:Title(itemTable.name)
markup:Add(itemTable.description)
local toolTip = markup:GetText()

Returns

• Map The markup object, with Add, Title and GetText methods

Adds a function that runs after a method of a Derma panel class, in the theme being built.

Must be called between cw.theme:New and cw.theme:Register; does nothing otherwise or if the panel class or method does not exist.

Parameters

• vguiName String Name of the panel class
• functionName String Name of the method
• callback Function Called with the panel and the method's arguments after the method

See also

• cw.theme:HookBefore

Adds a function that runs before a method of a Derma panel class, in the theme being built.

Must be called between cw.theme:New and cw.theme:Register; does nothing otherwise or if the panel class or method does not exist.

Parameters

• vguiName String Name of the panel class
• functionName String Name of the method
• callback Function Called with the panel and the method's arguments before the method

See also

• cw.theme:HookAfter

Replaces a method of a Derma panel class in the theme being built.

Must be called between cw.theme:New and cw.theme:Register; does nothing otherwise or if the panel class does not exist.

cw.theme:HookReplace('cwStorage', 'Paint', function(panel, w, h)
  draw.RoundedBox(0, 0, 0, w, h, Color(20, 20, 20))
end)

Parameters

• vguiName String Name of the panel class
• functionName String Name of the method to replace
• callback Function The new method, called with the panel and the method's arguments

See also

• cw.theme:HookBefore
• cw.theme:HookAfter

Loads the starting theme when Catwork initializes.

Uses the default_theme config, or the player's cwActiveTheme console variable when the modify_themes config is on, falling back to Clockwork.

Returns whether the active theme stops players from changing the information color.

Returns

• Boolean Whether the color is fixed; nil if no theme is active

Loads a theme and its base themes.

Calls the theme's CreateFonts, Initialize and PostInitialize methods, registers its module as the Theme plugin module and merges its panel changes into the VGUI factory. Does not unload the previous theme; use cw.theme:SetActive.

Parameters

• themeTable Map The theme table
• isBase Boolean optional, defaults to nil Whether the theme is loaded as the base of another, which skips the module and panel changes

Starts building a new theme and stores it in the global cwTHEME.

The theme starts as a copy of its base theme, or of the Clockwork theme when no base is given. Fill in its hooks (theme hooks run by cw.theme:Call), module (plugin hooks), skin and factory tables and its CreateFonts, Initialize, PostInitialize and OnUnloaded methods, then call cw.theme:Register.

local THEME = cw.theme:New('Combine', 'Clockwork')

function THEME.hooks:PostMainMenuPaint(panel)
  draw.RoundedBox(0, 0, 0, panel:GetWide(), 4, Color(0, 120, 255))
end

cw.theme:Register()

Parameters

• themeName String optional, defaults to 'Schema' Name of the theme
• baseName String optional, defaults to nil Name of the theme to derive from
• isFixed Boolean optional, defaults to nil Whether players cannot change the information color

Returns

• Map The new theme table

Saves the theme being built in cwTHEME with cw.theme:Finish.

Parameters

• bSwitchTo Boolean optional, defaults to nil Whether to switch to the theme right away

Returns

• String Name of the theme, or nil if no theme was being built

Switches to a theme, unloading the active one first.

Loads the theme with its bases and copies its skin. Does nothing if a theme name is given and no such theme exists.

Parameters

• theme String Name of the theme, or the theme table itself
• firstLoad Boolean optional, defaults to nil Whether this is the first theme loaded, which skips unloading; only set by Catwork when it initializes

Unloads a theme and its base themes.

Calls the theme's OnUnloaded method, removes the Theme plugin module and restores the panel methods it changed from the backup factory. Does not load another theme; use cw.theme:SetActive.

Parameters

• theme Map optional, defaults to nil The theme table; the active theme when nil
• isBase Boolean optional, defaults to nil Whether the theme is unloaded as the base of another