cw.system classclient

Defines the client-side cw.system library, the pages of the admin system menu.

A system is created with cw.system:New, given a toolTip, the access flags needed to see it and an OnDisplay function that builds the page, and then registered.

Summary

Methods

FindByID(identifier)client
Returns a registered system.
GetActive()client
Returns the system the system menu is showing.
GetAll()client
Returns every registered system.
GetPanel()client
Returns the system menu panel.
New(name)client
Creates a new admin system object to fill in and register.
Rebuild(name)client
Rebuilds the system menu if it is showing a system.
Register(system)client
Registers a system so it is listed in the system menu.
SetActive(name)client
Shows a system in the system menu.

Methods

cw.system:FindByID(identifier)

client gamemodes/catwork/gamemode/core/libraries/cl_system.lua:53

Returns a registered system.

Parameters

  • identifier String Name of the system

Returns

  • Map The system, or nil if there is none

cw.system:GetActive()

client gamemodes/catwork/gamemode/core/libraries/cl_system.lua:77

Returns the system the system menu is showing.

Returns

  • String Name of the active system, or nil if the menu does not exist or shows none

cw.system:GetAll()

client gamemodes/catwork/gamemode/core/libraries/cl_system.lua:20

Returns every registered system.

Returns

  • Map<Map> Systems keyed by name

cw.system:GetPanel()

client gamemodes/catwork/gamemode/core/libraries/cl_system.lua:59

Returns the system menu panel.

Returns

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

cw.system:New(name)

client gamemodes/catwork/gamemode/core/libraries/cl_system.lua:44

Creates a new admin system object to fill in and register.

A system is a page of the system menu. Set toolTip, access (the flags needed to see it, unless HasAccess is defined) and doesCreateForm, and define OnDisplay(systemPanel, systemForm) to build the page.

local SYSTEM = cw.system:New('Manage Players')
SYSTEM.toolTip = '#System_ManagePlayers_ToolTip'
SYSTEM.access = 'o'

function SYSTEM:OnDisplay(systemPanel, systemForm)
  -- build the page
end

SYSTEM:Register()

Parameters

  • name String optional, defaults to 'Unknown' Name of the system, used as its identifier

Returns

  • Map The new system object

cw.system:Rebuild(name)

client gamemodes/catwork/gamemode/core/libraries/cl_system.lua:67

Rebuilds the system menu if it is showing a system.

Parameters

  • name String Name of the system

cw.system:Register(system)

client gamemodes/catwork/gamemode/core/libraries/cl_system.lua:103

Registers a system so it is listed in the system menu.

Adds HasAccess (checks the local player for the system's access flags) if the system does not define it, and the IsActive and Rebuild methods.

Parameters

cw.system:SetActive(name)

client gamemodes/catwork/gamemode/core/libraries/cl_system.lua:89

Shows a system in the system menu.

Does nothing if the menu does not exist.

Parameters

  • name String Name of the system

Defined in