PanelManager

The PanelManager script object is created automatically when the campaign UI loads, and offers a suite a functions that allow scripts to work with the PanelManager. It does not need to be created by script, and the functions it provides may be called directly on the object in the following form.

Example:

PanelManager.<function_name>(<args>)
Loaded in Campaign Loaded in Campaign
Loaded in Battle Loaded in Battle
Loaded in Frontend Loaded in Frontend
Back to top

Functionality

PanelManager.CloseAllPanels()
Closes all opened panels managed by the PanelManager and clears the cached component

Returns:

  1. nil

PanelManager.ClosePanel(String panel name or UIComponent address)
Closes the specified panel

Parameters:

1

String

panel name or UIComponent address

Returns:

  1. nil

PanelManager.IsPanelOpen(string Panel name)

Checks whether the specified panel is opened

Parameters:

1

string

Panel name

Returns:

  1. address to the panel component if opened

PanelManager.ClearCachedComponent()
Clears the cached component of the PanelManager. This is the last opened panel

Returns:

  1. nil

PanelManager.GetCachedComponentId()
Returns the Id of the cached component or an empty string if there is no cached component

Returns:

  1. string Id of the cached component or an empty string

PanelManager.OpenPanels()
Checks whether there are any opened panels managed by the PanelManager

Returns:

  1. boolean any_panels_opened
Last updated 8/23/2024 4:55:15 PM