# Module `twdll.campaign_ui`

Campaign UI singleton accessor for Total War: Attila.

## Functions

GetMemoryAddress () | Returns the memory address of the CAMPAIGN_UI singleton as a hexadecimal string.
SetMaxSlotsMajor (slots) | Overrides the maximum number of building slots shown on the main (capital) settlement card in the settlement panel.
SetMaxSlotsMinor (slots) | Overrides the maximum number of building slots shown on the minor settlement cards in the settlement panel.
GetMaxSlotsMajor () | Returns the currently configured major-slot override, or nil if none is set.
GetMaxSlotsMinor () | Returns the currently configured minor-slot override, or nil if none is set.
ClearMaxSlots () | Restores the game default max-slot count (4, or 6 for the main settlement card).
RefreshSettlements () | Forces an immediate visual refresh of all settlement building models on the campaign map.

## Functions

GetMemoryAddress ()
  Returns the memory address of the CAMPAIGN_UI singleton as a hexadecimal string.

  ### Returns:

  string memory address (e.g. "0x12345678"), or nil if not yet initialised
SetMaxSlotsMajor (slots)
  Overrides the maximum number of building slots shown on the main (capital) settlement card in the settlement panel. Clamped to 1..20. Applies from the next panel open/refresh onwards. Values below 1 are rejected (no-op).

  ### Parameters:

  - slots number max slot count to display

  ### Returns:

  number the applied value, or nil if rejected
SetMaxSlotsMinor (slots)
  Overrides the maximum number of building slots shown on the minor settlement cards in the settlement panel. Clamped to 1..20. Applies from the next panel open/refresh onwards. Values below 1 are rejected (no-op).

  ### Parameters:

  - slots number max slot count to display

  ### Returns:

  number the applied value, or nil if rejected
GetMaxSlotsMajor ()
  Returns the currently configured major-slot override, or nil if none is set.

  ### Returns:

  number or nil slots
GetMaxSlotsMinor ()
  Returns the currently configured minor-slot override, or nil if none is set.

  ### Returns:

  number or nil slots
ClearMaxSlots ()
  Restores the game default max-slot count (4, or 6 for the main settlement card).
RefreshSettlements ()
  Forces an immediate visual refresh of all settlement building models on the campaign map.

generated by LDoc 1.5.0