CCSCustomHudLayout

Inherits CBaseEntity

Fields

Field	Type
`m_strLayout`	`CUtlSymbolLarge`
`m_bObservable`	`bool`
`m_vecPlayerLayoutStates`	`CUtlVector<CCSCustomHudLayoutState>`
`m_globalLayoutState`	`CCSCustomHudLayoutState`
`m_vecPanelIds`	`CUtlVector<CUtlString>`
`m_vecClassNames`	`CUtlVector<CUtlString>`
`m_vecDialogVariableNames`	`CUtlVector<CUtlString>`

Schema fields are accessors: read with entity->m_field(), write with entity->m_field = value (the write marks the field for networking).

static CCSCustomHudLayout* Create(const char* pszLayout, const char* pszTargetName = nullptr);

Creates and spawns a custom_hud_layout for a panorama layout, e.g. "my_panel" for panorama/layout/custom_game/my_panel.vxml_c.

Parameter	Type	Default
`pszLayout`	`const char*`
`pszTargetName`	`const char*`	`nullptr`

CCSCustomHudLayoutState& GetLayoutState(CCSPlayerController* pController = nullptr);

Gets the layout state of one player, or the global state when no controller is given.

Parameter	Type	Default
`pController`	`CCSPlayerController*`	`nullptr`

void SetHasClass(const char* pszPanelId, const char* pszClassName, bool bHasClass, CCSPlayerController* pController = nullptr);

Adds or removes a CSS class on a panel of the layout.

void SetDialogVariableString(const char* pszPanelId, const char* pszVariableName, const char* pszValue, CCSPlayerController* pController = nullptr);

Sets a dialog variable string on a panel of the layout.

void SetInputCaptureEnabled(bool bEnable, CCSPlayerController* pController = nullptr);

Enables or disables mouse input capture, without which the player cannot click the layout.

Parameter	Type	Default
`bEnable`	`bool`
`pController`	`CCSPlayerController*`	`nullptr`

bool IsInputCaptureEnabled(CCSPlayerController* pController = nullptr);

Whether mouse input capture is enabled.

Parameter	Type	Default
`pController`	`CCSPlayerController*`	`nullptr`

void HookClick(std::function<void(CCSPlayerController*, CCSCustomHudLayout*, const char*)> callback);

Registers a callback fired when a player clicks a panel of this layout, keyed by the panel's id attribute.

Parameter	Type
`callback`	`std::function<void(CCSPlayerController, CCSCustomHudLayout, const char*)>`

void UnhookClicks();

Drops every click callback registered for this layout.