Campaign UI Manager

The campaign UI manager provides support functions for querying and manipulating the UI in campaign. A campaign ui manager is automatically created when the campaign_manager is created. A handle to the campaign ui manager can be retrieved from the campaign manager with campaign_manager:get_campaign_ui_manager.

Loaded in Campaign Loaded in Campaign
Loaded in Battle Loaded in Battle
Loaded in Frontend Loaded in Frontend
Back to top

Creation

campaign_ui_manager:new()
Creates and returns a new campaign ui manager object, or returns an existing one if one was previously created. This function can be used interchangeably with campaign_manager:get_campaign_ui_manager.

Returns:

  1. campaign_ui_manager campaign ui manager

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 148

Back to top

Usage

Once a campaign_ui_manager object has been created with campaign_ui_manager:new or campaign_manager:get_campaign_ui_manager, functions on it may be called using the form showed below.

Example - Specification:

<ui_manager_object>:<function_name>(<args>)

Example - Creation and Usage:

local uim = campaign_ui_manager:new()
if uim:is_panel_open("events") then        -- calling a function on the object once created
    out("Events panel is open")
end
Events panel is open
Back to top

UI Listeners

The campaign ui manager keeps track of what settlement and character is selected and what ui panels are open. This information can be queried with the functions in this section.

campaign_ui_manager:is_panel_open(string panel name)
Returns whether a ui panel with the supplied name is currently open.

Parameters:

1

string

panel name

Returns:

  1. boolean is panel open

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 453

campaign_ui_manager:is_event_panel_open()
Returns whether an event panel is currently open.

Returns:

  1. boolean is event panel open

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 468

campaign_ui_manager:get_open_fullscreen_panel()
Returns the name of the last fullscreen panel that's open, or false if no panels are open. Usually only one fullscreen panel is open at a time but in certain circumstances (such as diplomacy) more than one may be open at a time.

Returns:

  1. string open fullscreen panel

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 477

campaign_ui_manager:get_open_fullscreen_or_event_panel()
Returns the name of the last fullscreen panel that's open, including the events panel, or false if no panels are open. Usually only one fullscreen panel is open at a time but in certain circumstances (such as diplomacy) more than one may be open at a time.

Returns:

  1. string open fullscreen panel

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 493

campaign_ui_manager:is_char_selected(character character)

Returns whether the supplied character is selected.

Parameters:

1

character

character

Returns:

  1. boolean is character selected

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 507

campaign_ui_manager:get_char_selected_cqi()
Returns the cqi of the selected character. If no character is currently selected then false is returned.

Returns:

  1. number cqi

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 516

campaign_ui_manager:is_char_selected_from_faction(string faction name)

Returns whether a character from the supplied faction is selected.

Parameters:

1

string

faction name

Returns:

  1. boolean is character selected

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 524

campaign_ui_manager:get_mf_selected_cqi()
Returns the cqi of the currently selected military force. If no military force is currently selected then false is returned.

Returns:

  1. number military force cqi

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 533

campaign_ui_manager:get_mf_selected_type()
Returns the force type key of the currently selected military force. If no military force is currently selected then false is returned.

Returns:

  1. string force type key

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 541

campaign_ui_manager:is_settlement_selected(string settlement name)

Returns whether a settlement with the supplied key is selected.

Parameters:

1

string

Settlement name, from the campaign_map_settlements database table.

Returns:

  1. boolean is settlement selected

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 549

campaign_ui_manager:is_settlement_selected_from_region(string region name)

Returns whether the settlement in the region with the supplied key is selected.

Parameters:

1

string

Region name, from the regions database table.

Returns:

  1. boolean is settlement in region selected

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 558

campaign_ui_manager:get_selected_settlement()
Returns the string name of the selected settlement. If no settlement is selected a blank string is returned.

Returns:

  1. string selected settlement name

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 567

campaign_ui_manager:get_selected_settlement_region()
Returns the string name of the region containing the selected settlement. If no settlement is selected a blank string is returned.

Returns:

  1. string selected settlement region name

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 575

campaign_ui_manager:is_region_slot_selected(
  string selected region name,
  number selected region slot index number
)

Returns whether region slot #slot_index number, on the supplied region_name is selected.

Parameters:

1

string

selected region name

2

number

selected region slot index number

Returns:

  1. boolean is region slot selected

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 583

campaign_ui_manager:get_selected_region_slot()
Returns the string name of the selected region and the region slot index number. If none then an empty string and nil are returned.

Returns:

  1. string selected region name
  2. number selected region slot index number

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 593

Back to top

Scripted Sequences

campaign_ui_manager:start_scripted_sequence()
This is a mechanism by which client scripts can notify the ui manager that a scripted sequence has started, which registers "scripted_sequence" in the panel open list. This has the effect of making the ui manager think that a fullscreen panel is open, stalling any pending interventions. Avoid using this unless you really have to, probably the only case where it's valid is in the case of script that must work in singleplayer and also multiplayer.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 608

campaign_ui_manager:stop_scripted_sequence()
Removes "scripted_sequence" from the panel open list. This must be called after campaign_ui_manager:start_scripted_sequence.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 618

Back to top

End Turn Warnings

The campaign_ui_manager:suppress_end_turn_warning function can be used to restrict or unrestrict certain end turn warnings. The following types of warnings are available to restrict - not all of them may be supported by each project:

  • "low funds"

  • "research available"

  • "commandment available"

  • "character upgrade available"

  • "settlement upgrade available"

  • "vortex ritual available"

  • "siege construction available"

  • "low fightiness"

  • "damaged building"

  • "building available"

  • "office slot available"

  • "army ap available"

  • "hero ap available"

  • "imminent rebellion"

  • "garrison army ap available"

  • "unfulfillable_barter_agreement"

  • "priams_throne_race"

  • "sarpedon_available_resources"

  • "agamemnon_office_can_be_filled"

  • "assuwan_league_gift_region"

  • "barter_agreement_expired"

  • "military_strategy_dominance_full"

  • "phar_pharaohs_crown_path_not_selected"

  • "phar_pharaohs_power_available"

  • "phar_deity_slot_available"

  • "phar_local_deities_devoted_hero_available"

  • "phar_aten_unlockable_available"

  • "phar_aten_devoted_hero_available"

  • "phar_unequipped_ancillaries"

  • "phar_court_unused_intrigue"

  • "phar_court_posiion_available"

  • "phar_ancient_legacy_available"

  • "phar_hatshepsut_expedition_ready_to_move"

  • "phar_khufu_wonder_stage_available"

  • "phar_thutmose_action_available"

  • "all"

campaign_ui_manager:suppress_end_turn_warning(string warning_types, boolean suppress)

Activates or deactivates a suppression on a specified end-turn warnings. If an end-turn warning is suppressed it is prevented from appearing. End-turn warnings are specified by a string.

Parameters:

1

string

Warnings to suppress - should be a comma separated list of strings from the table above or "all".

2

boolean

Activate suppression.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 1024

Back to top

Output Stamps

campaign_ui_manager:get_next_output_stamp()
Returns an incremental number which can be used for matching output between tabs.

Returns:

  1. number output stamp

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 1094

Back to top

Locking/Unlocking UI

campaign_ui_manager:lock_ui()
Partially locks the ui, preventing the player from ending turn or moving armies and suppressing the events rollout. Subsequent calls to the function will increase the lock level on the ui, with calls to campaign_ui_manager:unlock_ui reducing the lock level on the ui. The ui will only unlock when the lock level is reduced back to zero.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 1115

campaign_ui_manager:unlock_ui()
Attempts to unlock the ui after it has been locked with campaign_ui_manager:lock_ui. Each call to campaign_ui_manager:lock_ui increases the lock level on the ui while each call to this function reduces the lock level. The ui is only unlocked when the lock level returns to zero.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 1158

Back to top

Auto-Opening Event Panel

campaign_ui_manager:enable_event_panel_auto_open(boolean should enable)
Enables or disables the event panel from auto-opening. Each call to disable the event panel auto-opening made with this function increases the lock level by one, and each call to enable it decreases the lock level by one. Auto-opening is only re-enabled when the lock level drops to zero. This allows multiple client scripts to suppress event panels at the same time, and only when all have relinquished their lock will event panels be allowed to auto-open again.

Parameters:

1

boolean

should enable

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 1225

Back to top

UI Overrides

campaign_ui_manager:set_should_save_override_state(boolean should save)
Sets the campaign ui manager to save and restore the state of all ui overrides when the game is saved and reloaded. By default the state of these is saved - use this function to disable this.

Parameters:

1

boolean

should save

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 1276

campaign_ui_manager:set_all_overrides([boolean should unlock allowed overrides])

Locks and (potentially) unlocks all overrides based on whether they are allowed. This is mainly used internally when the UI is created to restore the locked status any overrides that are set as disallowed in the savegame data.

Parameters:

1

boolean

optional, default value=true

Should perform an unlock operation on UI overrides that are set to be allowed. This should be set to false if being called after the UI is created (or re-created) as the UI will be in its default allowed state.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 1288

campaign_ui_manager:set_all_overrides_allowed()
Sets all known ui overrides to be allowed.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 1320

campaign_ui_manager:set_ui_overrides_should_trigger_campaign_ui_script_events(
  [boolean should trigger]
)

Sets all UI overrides to trigger campaign ui script events when they are locked or unlocked. If set to trigger, each ui override will use CampaignUI.TriggerCampaignScriptEvent to send a message to all clients in a multiplayer game that the override has been locked or unlocked. Client scripts can listen for a UITriggerScriptEvent event, with a context string in the form "ui_override_lock,<override_name>" when locking or "ui_override_lock,<override_name>" when unlocking.
By default, this behaviour is disabled - use this function to enable it.

Parameters:

1

boolean

optional, default value=true

should trigger

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 1394

Back to top

Whitelists

The whitelist system allow scripts to prevent the player from selecting any settlements, characters or both. Individual settlements or characters can then be whitelisted so that only they may be selected.

campaign_ui_manager:enable_character_selection_whitelist()
Enables the character selection whitelist so that it starts being enforced. After this function is called the player will be unable to select any characters that have not been added to the whitelist until the character whitelist system is disabled with campaign_ui_manager:disable_character_selection_whitelist.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 1446

campaign_ui_manager:disable_character_selection_whitelist()
Disables the character selection whitelist so that it is no longer enforced. Calling this does not clear characters from the whitelist - use campaign_ui_manager:clear_character_selection_whitelist to do this.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 1468

campaign_ui_manager:add_character_selection_whitelist(number character cqi)
Adds a character to the character whitelist by cqi. The character whitelist system must be enabled with campaign_ui_manager:enable_character_selection_whitelist for this to have an effect.

Parameters:

1

number

character cqi

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 1479

campaign_ui_manager:remove_character_selection_whitelist(number character cqi)
Removes a character from the character whitelist by cqi.

Parameters:

1

number

character cqi

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 1498

campaign_ui_manager:clear_character_selection_whitelist()
Clears all characters from the character whitelist.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 1514

campaign_ui_manager:add_all_characters_for_faction_selection_whitelist(string faction name)
Adds all characters from the specified faction to the character selection whitelist.

Parameters:

1

string

faction name

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 1522

campaign_ui_manager:enable_settlement_selection_whitelist()
Enables the settlement selection whitelist so that it starts being enforced. After this function is called the player will be unable to select any settlements that have not been added to the whitelist until the settlement whitelist system is disabled with campaign_ui_manager:disable_settlement_selection_whitelist.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 1559

campaign_ui_manager:disable_settlement_selection_whitelist()
Diables the settlement selection whitelist so that it is no longer enforced. Calling this does not clear settlements from the whitelist - use campaign_ui_manager:clear_settlement_selection_whitelist to do this.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 1588

campaign_ui_manager:add_settlement_selection_whitelist(string settlement name)
Adds the specified settlement to the settlement selection whitelist. The settlement name will be in the form settlement:[region_name]. The settlement whitelist system must be enabled with campaign_ui_manager:enable_settlement_selection_whitelist for this to have an effect.

Parameters:

1

string

settlement name

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 1599

campaign_ui_manager:remove_settlement_selection_whitelist(string settlement name)
Removes the specified settlement from the settlement selection whitelist. The settlement name will be in the form settlement:[region_name].

Parameters:

1

string

settlement name

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 1621

campaign_ui_manager:clear_settlement_selection_whitelist()
Clears the settlement selection whitelist.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 1640

campaign_ui_manager:add_all_settlements_for_faction_selection_whitelist(string faction name)
Adds all settlements belonging to the specified faction to the settlement whitelist.

Parameters:

1

string

faction name

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 1649

Back to top

Pulse Strength Constants

The campaign ui manager stores pulse strength constants, which are numbers which represent how intensely a ui component of a certain size should flash in certain situations. Smaller components (i.e. buttons) should flash more intensely than larger components (i.e. panels) to attract attention to themselves.

campaign_ui_manager:get_panel_pulse_strength()
Returns the panel pulse strength constant (currently 5).

Returns:

  1. number panel pulse strength constant

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 1694

campaign_ui_manager:get_button_pulse_strength()
Returns the button pulse strength constant (currently 10).

Returns:

  1. number button pulse strength constant

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 1702

Back to top

Settlement Highlighting

campaign_ui_manager:highlight_settlement(
  string settlement name,
  [string marker type],
  [number x offset],
  [number y offset],
  [number height offset]
)
Places a highlight effect at the position of the supplied settlement. An offset position may optionally be set - sometimes it's better not to highlight a settlement's central position if a character is stood there as it's unclear what's being highlighted.
A marker type can be supplied - recognised marker types are currently move_to, select, pointer, move_to_vfx, select_vfx (default), look_at_vfx, objective. If one of these is specified then the marker is added with the underlying add_marker command provided by the game interface. If no marker type is specified then a vfx is added with the add_vfx command instead, of type advice_settlement_marker.
Any highlight added with this function can be removed later with campaign_ui_manager:unhighlight_settlement.

Parameters:

1

string

Full settlement name. This is generally "settlement:" concatenated with the region key.

2

string

optional, default value=nil

Marker type.

3

number

optional, default value=0

X offset.

4

number

optional, default value=0

Y offset.

5

number

optional, default value=0

Height offset.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 1730

campaign_ui_manager:unhighlight_settlement(string settlement name, [boolean is marker])
Removes a highlight effect at the position of the supplied settlement that was previously added with campaign_ui_manager:highlight_settlement.

Parameters:

1

string

Full settlement name. This is generally "settlement:" concatenated with the region key.

2

boolean

optional, default value=false

Is marker. If set to true this removes a marker at the settlement - set this if a marker type was specified to campaign_ui_manager:highlight_settlement. If set to false then a vfx is removed - set this if no marker type was specified to campaign_ui_manager:highlight_settlement.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 1801

campaign_ui_manager:highlight_all_settlements_for_faction(
  string faction key,
  [boolean show highlight],
  [string marker type]
)
A shorthand method for highlighting or unhighlighting all settlements belonging to a specified faction. This function uses campaign_ui_manager:highlight_settlement and campaign_ui_manager:unhighlight_settlement to perform the actual highlighting and unhighlighting.

Parameters:

1

string

Faction key.

2

boolean

optional, default value=false

Show highlight.

3

string

optional, default value=nil

Marker type to be supplied to campaign_ui_manager:highlight_settlement or campaign_ui_manager:unhighlight_settlement - see the documentation for those functions for more information.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 1829

campaign_ui_manager:highlight_all_settlements_near_camera(
  [boolean show highlight],
  number radius,
  [function condition]
)
A shorthand method for highlighting or unhighlighting all settlements currently near the position of the camera. An optional condition may be supplied to filter the settlements to highlight.
Note that the highlighting won't update if the camera is moved.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

Radius in display units.

3

function

optional, default value=nil

Filter condition. If supplied, this should be a function which accepts a settlement object as a single argument and returns a boolean result. If the boolean result evaluates to true then the settlement is highlighted. The filter is only considered when highlighting - when unhighlighting, all settlements within the radius are unhighlighted regardless of any filter.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 1864

campaign_ui_manager:highlight_settlement_for_selection(
  string settlement name,
  string province name,
  function callback,
  [number x offset],
  [number y offset]
)
Highlights a settlement, and then calls a supplied callback when that character is selected. This function uses campaign_ui_manager:highlight_settlement to perform the actual highlighting.

Parameters:

1

string

Full settlement name. This is generally "settlement:" concatenated with the region key.

2

string

Province name to which the settlement belongs.

3

function

callback

4

number

optional, default value=0

X offset.

5

number

optional, default value=0

Y offset.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 1915

campaign_ui_manager:unhighlight_settlement_for_selection(character character object)
Unhighlights a settlement after it has been highlighted with campaign_ui_manager:highlight_settlement_for_selection. Note that client scripts do not need to call this themselves to clean up after campaign_ui_manager:highlight_settlement_for_selection has triggered - it is for cancelling a running selection listener.

Parameters:

1

character

character object

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 1961

Back to top

Region Highlighting

campaign_ui_manager:highlight_region_slot(
  string region slot key,
  [string marker type],
  [number x offset],
  [number y offset],
  [number height offset]
)
Places a highlight effect at the position of the supplied region slot. An offset position may optionally be set - sometimes it's better not to highlight a region slot's central position if a character is stood there as it's unclear what's being highlighted.
A marker type can be supplied - recognised marker types are currently move_to, select, pointer, move_to_vfx, select_vfx (default), look_at_vfx, objective. If one of these is specified then the marker is added with the underlying add_marker command provided by the game interface. If no marker type is specified then a vfx is added with the add_vfx command instead, of type advice_settlement_marker.
Any highlight added with this function can be removed later with campaign_ui_manager:unhighlight_region_slot.

Parameters:

1

string

region slot key

2

string

optional, default value=nil

Marker type.

3

number

optional, default value=0

X offset.

4

number

optional, default value=0

Y offset.

5

number

optional, default value=0

Height offset.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 1996

campaign_ui_manager:unhighlight_region_slot(string region slot key, [boolean is marker])
Removes a highlight effect at the position of the supplied region slot that was previously added with campaign_ui_manager:highlight_region_slot.

Parameters:

1

string

region slot key

2

boolean

optional, default value=false

Is marker. If set to true this removes a marker at the region slot - set this if a marker type was specified to campaign_ui_manager:highlight_region_slot If set to false then a vfx is removed - set this if no marker type was specified to campaign_ui_manager:highlight_region_slot.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 2065

campaign_ui_manager:highlight_region_slot_for_selection(
  string region slot key,
  function callback,
  [number x offset],
  [number y offset]
)
Highlights a region slot, and then calls a supplied callback when that region slot is selected. This function uses campaign_ui_manager:highlight_region_slot to perform the actual highlighting.

Parameters:

1

string

region slot key

2

function

callback

3

number

optional, default value=0

X offset.

4

number

optional, default value=0

Y offset.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 2093

campaign_ui_manager:unhighlight_region_slot_for_selection(character character object)
Unhighlights a region slot after it has been highlighted with campaign_ui_manager:highlight_region_slot_for_selection. Note that client scripts do not need to call this themselves to clean up after campaign_ui_manager:highlight_region_slot_for_selection has triggered - it is for cancelling a running selection listener.

Parameters:

1

character

character object

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 2130

Back to top

Character Highlighting

campaign_ui_manager:highlight_character(
  character character object,
  [string marker type],
  [number height offset]
)
Places a highlight effect at the position of the supplied character. A marker type can be supplied - recognised marker types are currently move_to, select, pointer, move_to_vfx, select_vfx (default), look_at_vfx, objective. If one of these is specified then the marker is added with the underlying add_marker command provided by the game interface. If no marker type is specified then a vfx is added with the add_vfx command instead, of type advice_settlement_marker.
Any highlight added with this function can be removed later with campaign_ui_manager:unhighlight_character.

Parameters:

1

character

character object

2

string

optional, default value=nil

marker type

3

number

optional, default value=0

height offset

Returns:

  1. boolean character was highlighted

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 2159

campaign_ui_manager:unhighlight_character(character character object, [boolean is marker])
Removes a highlight effect at the position of the supplied character that was previously added with campaign_ui_manager:highlight_character.

Parameters:

1

character

Character object.

2

boolean

optional, default value=false

Is marker. If set to true this removes a marker at the character - set this if a marker type was specified to campaign_ui_manager:highlight_character. If set to false then a vfx is removed - set this if no marker type was specified to campaign_ui_manager:highlight_character.

Returns:

  1. boolean character was unhighlighted

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 2216

campaign_ui_manager:highlight_all_general_characters_for_faction(
  string faction key,
  [boolean should highlight]
)
A shorthand method for highlighting/unhighlight all armies for a faction.

Parameters:

1

string

faction key

2

boolean

optional, default value=false

should highlight

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 2242

campaign_ui_manager:highlight_all_characters_near_camera(
  [boolean show highlight],
  number radius,
  [function condition]
)
A shorthand method for highlighting or unhighlighting all characters currently near the position of the camera. An optional condition may be supplied to filter the characters to highlight.
Note that the highlighting won't update if the camera is moved.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

Radius in display units.

3

function

optional, default value=nil

Filter condition. If supplied, this should be a function which accepts a character object as a single argument and returns a boolean result. If the boolean result evaluates to true then the character is highlighted. The filter is only considered when highlighting - when unhighlighting, all characters within the radius are unhighlighted regardless of any filter.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 2279

campaign_ui_manager:highlight_all_generals_near_camera(
  [boolean show highlight],
  number radius,
  [function condition]
)
A shorthand method for highlighting or unhighlighting all general/lord characters currently near the position of the camera. Uses campaign_ui_manager:highlight_all_characters_near_camera.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

Radius in display units.

3

function

optional, default value=nil

Filter condition. If supplied, this should be a function which accepts a character object as a single argument and returns a boolean result. If the boolean result evaluates to true then the character is highlighted. The filter is only considered when highlighting - when unhighlighting, all characters within the radius are unhighlighted regardless of any filter.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 2329

campaign_ui_manager:highlight_all_heroes_near_camera(
  [boolean show highlight],
  number radius,
  [function condition]
)
A shorthand method for highlighting or unhighlighting all hero characters currently near the position of the camera. Uses campaign_ui_manager:highlight_all_characters_near_camera.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

Radius in display units.

3

function

optional, default value=nil

Filter condition. If supplied, this should be a function which accepts a character object as a single argument and returns a boolean result. If the boolean result evaluates to true then the character is highlighted. The filter is only considered when highlighting - when unhighlighting, all characters within the radius are unhighlighted regardless of any filter.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 2347

campaign_ui_manager:highlight_character_for_selection(
  character character object,
  function callback,
  [number height offset]
)
Highlights a character, and then calls a supplied callback when that character is selected. This function uses campaign_ui_manager:highlight_character to perform the actual highlighting.

Parameters:

1

character

character object

2

function

callback

3

number

optional, default value=0

height offset

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 2365

campaign_ui_manager:unhighlight_character_for_selection(character character object)
Unhighlights a character after it has been highlighted with campaign_ui_manager:highlight_character_for_selection. Note that client scripts do not need to call this themselves to clean up after campaign_ui_manager:highlight_character_for_selection has triggered - it is for cancelling a running selection listener.

Parameters:

1

character

character object

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 2407

Back to top

Tutorial-Specific UI Hiding

The functions here are bespoke for tutorials and hide or show various bits of the UI.

campaign_ui_manager:display_first_turn_ui(boolean show ui)
Hides or shows a large amount of the campaign UI.

Parameters:

1

boolean

show ui

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 2445

campaign_ui_manager:display_faction_buttons(boolean should show)
Hides or shows the faction buttons docker on the campaign UI, which is the panel on which the end-turn button is displayed.

Parameters:

1

boolean

should show

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 2553

campaign_ui_manager:display_resources_bar(boolean should show)
Hides or shows the resources bar at the top of the campaign UI.

Parameters:

1

boolean

should show

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 2571

Back to top

Unit Cards

campaign_ui_manager:num_queued_unit_cards_visible()
Returns the number of unit cards currently queued for recruitment on the army panel.

Returns:

  1. number queued unit cards

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 2603

Back to top

Interaction Monitor

An interaction monitor sets up an event/condition listener. Should the event occur and the condition be satisfied then a supplied key is saved into the advice history. The presence of this key in the advice history can then be queried by external scripts with campaign_ui_manager:get_interaction_monitor_state.

This mechanism allows client scripts to set up listeners for the player ever performing an action (e.g. changing stance, recruiting a unit, declaring war etc). Other scripts can then query whether or not the player has performed one of these actions at any point.

campaign_ui_manager:add_interaction_monitor(string key, string event name, [function condition])
Sets up an interaction monitor. If the supplied key is not already present in the advice history then a listener is established for the supplied event and condition. Should the event be triggered and the condition met, then the key is set in the advice history.

Parameters:

1

string

Interaction monitor key.

2

string

Event name to listen for.

3

function

optional, default value=true

Conditional test. This can either be a function that takes the event context as a single arguments and returns a boolean result, or just the value true to always match when the event is triggered (which is the default value).

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 2645

campaign_ui_manager:add_click_interaction_monitor(string key, [function condition])
Sets up an on-click interaction monitor. This sets up an interaction monitor with campaign_ui_manager:add_interaction_monitor for the ComponentLClickUp event.

Parameters:

1

string

Interaction monitor key.

2

function

optional, default value=true

Conditional test. This can either be a function that takes the event context as a single arguments and returns a boolean result, or just the value true to always match when the event is triggered (which is the default value).

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 2683

campaign_ui_manager:add_campaign_panel_closed_interaction_monitor(string key, [function condition])
Sets up a panel-closing interaction monitor. This sets up an interaction monitor with campaign_ui_manager:add_interaction_monitor for the PanelClosedCampaign event.

Parameters:

1

string

Interaction monitor key.

2

function

optional, default value=true

Conditional test. This can either be a function that takes the event context as a single arguments and returns a boolean result, or just the value true to always match when the event is triggered (which is the default value).

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 2692

campaign_ui_manager:get_interaction_monitor_state(string key)
Gets the state of a supplied interaction monitor. If the monitor has ever been triggered then true is returned, otherwise false is returned instead.

Parameters:

1

string

Interaction monitor key.

Returns:

  1. boolean monitor ever triggered

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 2701

Back to top

Diplomacy Audio Locking

Multiple independent client scripts wish to lock and unlock the diplomacy_audio override at the same time, so the campaign ui manager provides this specific interface for doing so. Each call to campaign_ui_manager:lock_diplomacy_audio increases the lock level, whereas each call to campaign_ui_manager:unlock_diplomacy_audio decreases it. The ui override itself only gets locked/unlocked when the lock level moves from 0 to 1 or 1 to 0.

campaign_ui_manager:lock_diplomacy_audio()
Increases the lock level on the diplomacy_audio ui override, locking it if the level is moving from 0 to 1.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 2722

campaign_ui_manager:unlock_diplomacy_audio()
Decreases the lock level on the diplomacy_audio ui override, unlocking it if the level is moving from 1 to 0.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 2733

Back to top

Specific Component/Tooltip Pulse Highlighting

The campaign ui manager provides a large number of functions, listed below, to pulse-highlight various specific sections of the campaign UI. Client scripts may call one or more of the functions listed below to highlight a section of the ui, then campaign_ui_manager:unhighlight_all_for_tooltips to subsequently unhighlight any ui section currently highlighted by them. This is primarily for use with the tooltip/help system, which pulse-highlights sections of the UI when the cursor is placed over a relevant hyperlinked word in help system text.

The help_page_link_highlighting ui override may be set to disable this system, although each highlighting function allows the action to be forced using a flag.

Where sensible, each highlight function will call a different highlight function if its uicomponents are not visible. For example, a call to highlight the army panel will highlight armies instead if the army panel is not visible - hopefully communicating to the player that they can select an army to see the panel.

campaign_ui_manager:unhighlight_all_for_tooltips([boolean force unhighlight])
Unhighlights any component that's been highlighted by the tooltip system using one of the other functions in this section.

Parameters:

1

boolean

optional, default value=false

Force unhighlight, even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 2763

campaign_ui_manager:highlight_advice_history_buttons(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the advice history buttons. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 2781

campaign_ui_manager:highlight_advisor_button(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the advisor button. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 2817

campaign_ui_manager:highlight_advisor(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the advisor. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 2842

campaign_ui_manager:highlight_armies(
  [boolean show highlight],
  [string faction key],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights armies near the camera, optionally for a target faction. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

string

optional, default value=nil

Target faction key. Can be omitted to highlight armies for all factions.

3

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

4

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 2892

campaign_ui_manager:highlight_armies_at_sea(
  [boolean show highlight],
  [string faction key],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights armies at sea near the camera, optionally for a target faction. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

string

optional, default value=nil

Target faction key. Can be omitted to highlight armies for all factions.

3

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

4

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 2916

campaign_ui_manager:highlight_army_panel(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the army panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 2940

campaign_ui_manager:highlight_army_panel_unit_cards(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the unit cards on the army panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 2999

campaign_ui_manager:highlight_autoresolve_button(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the autoresolve button. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 3048

campaign_ui_manager:highlight_balance_of_power_bar(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the balance of power bar. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 3081

campaign_ui_manager:highlight_banners_and_marks(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights banners and marks. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 3107

campaign_ui_manager:highlight_building_browser_button(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the building browser button. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 3170

campaign_ui_manager:highlight_building_browser(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the building browser. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 3197

campaign_ui_manager:highlight_building_browser_buildings(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean dont highlight upstream]
)
Highlights building browser buildings. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Suppress highlighting of any upstream components if this one is not currently visible.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 3324

campaign_ui_manager:highlight_building_panel(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean dont highlight upstream]
)
Highlights the building panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Suppress highlighting of any upstream components if this one is not currently visible.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 3364

campaign_ui_manager:highlight_building_panel_tab(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the building panel tab on the army panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 3433

campaign_ui_manager:highlight_buildings(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean first settlement only],
  [boolean all but first settlement]
)
Highlights buildings on the army panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Only highlight buildings for the first settlement on the army panel.

5

boolean

optional, default value=false

Highlight buildings for all but the first settlement on the army panel.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 3459

campaign_ui_manager:highlight_character_available_skill_points(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean dont highlight upstream]
)
Highlights the available skill points indicator on the character details panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Suppress highlighting of any upstream components if this one is not currently visible.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 3547

campaign_ui_manager:highlight_character_details(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the character details subpanel on the character details panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 3575

campaign_ui_manager:highlight_character_details_button(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean dont highlight upstream]
)
Highlights the character details button. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Suppress highlighting of any upstream components if this one is not currently visible.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 3638

campaign_ui_manager:highlight_character_details_panel(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the character details panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 3667

campaign_ui_manager:highlight_character_details_panel_details_button(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean dont highlight upstream]
)
Highlights the details tab button on the character details panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Suppress highlighting of any upstream components if this one is not currently visible.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 3829

campaign_ui_manager:highlight_character_details_panel_rank_indicator(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the character rank indicator on the character details panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 3857

campaign_ui_manager:highlight_character_details_panel_skills_button(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean dont highlight upstream]
)
Highlights the skills tab button on the character details panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Suppress highlighting of any upstream components if this one is not currently visible.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 3879

campaign_ui_manager:highlight_character_info_panel(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the character info panel that appears when a character is selected. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 3907

campaign_ui_manager:highlight_character_magic_items(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights magic items on the character details panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 3963

campaign_ui_manager:highlight_character_skills(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the character skills subpanel on the character details panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 3990

campaign_ui_manager:highlight_character_skills_button(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean dont highlight upstream]
)
Highlights the character skills button on the character details panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Suppress highlighting of any upstream components if this one is not currently visible.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 4031

campaign_ui_manager:highlight_character_traits(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the character traits on the character details panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 4059

campaign_ui_manager:highlight_commandments(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights commandments. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 4092

campaign_ui_manager:highlight_corruption(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights corruption. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 4119

campaign_ui_manager:highlight_diplomacy_attitude_icons(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights diplomacy attitude icons on the diplomacy screen. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 4153

campaign_ui_manager:highlight_diplomacy_button(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the diplomacy button. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 4188

campaign_ui_manager:highlight_diplomacy_centre_panel(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean dont highlight upstream]
)
Highlights the centre panel on the diplomacy screen. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Suppress highlighting of any upstream components if this one is not currently visible.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 4214

campaign_ui_manager:highlight_diplomacy_left_panel(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean dont highlight upstream]
)
Highlights the left panel on the diplomacy screen. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Suppress highlighting of any upstream components if this one is not currently visible.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 4258

campaign_ui_manager:highlight_diplomacy_right_panel(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean dont highlight upstream]
)
Highlights the right panel on the diplomacy screen. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Suppress highlighting of any upstream components if this one is not currently visible.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 4290

campaign_ui_manager:highlight_diplomacy_screen(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights just the diplomacy screen. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 4322

campaign_ui_manager:highlight_drop_down_list_buttons(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the drop-down list buttons. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 4351

campaign_ui_manager:highlight_dynasties(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights dynasties. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 4369

campaign_ui_manager:highlight_dynasties_panel(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the dynasties panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 4379

campaign_ui_manager:highlight_end_turn_button(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the end-turn button. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 4389

campaign_ui_manager:highlight_events_list(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the events drop-down list. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 4413

campaign_ui_manager:highlight_factions_list(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the factions drop-down list. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 4439

campaign_ui_manager:highlight_faction_summary_button(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the factions summary button. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 4465

campaign_ui_manager:highlight_faction_summary_records_tab(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean dont highlight upstream]
)
Highlights the records tab on the faction screen. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Suppress highlighting of any upstream components if this one is not currently visible.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 4489

campaign_ui_manager:highlight_faction_summary_screen(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the faction summary screen. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 4654

campaign_ui_manager:highlight_faction_summary_summary_tab(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean dont highlight upstream]
)
Highlights the summary tab on the faction screen. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Suppress highlighting of any upstream components if this one is not currently visible.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 4694

campaign_ui_manager:highlight_faction_summary_statistics_tab(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean dont highlight upstream]
)
Highlights the statistics tab on the faction screen. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Suppress highlighting of any upstream components if this one is not currently visible.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 4785

campaign_ui_manager:highlight_fightiness_bar(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean dont highlight upstream]
)
Highlights the fightiness bar. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Suppress highlighting of any upstream components if this one is not currently visible.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 4825

campaign_ui_manager:highlight_fleet_office_button(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the fleet office button. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 4863

campaign_ui_manager:highlight_fleet_office_panel(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the fleet office panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 4888

campaign_ui_manager:highlight_food(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the food indicator on the top bar of the campaign interface. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 4959

campaign_ui_manager:highlight_food_bar(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the food bar. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 4976

campaign_ui_manager:highlight_forces_list(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the forces drop-down list. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5021

campaign_ui_manager:highlight_garrison_armies(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights garrison army unit cards on the army panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5048

campaign_ui_manager:highlight_garrison_details_button(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the garrison details button. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5090

campaign_ui_manager:highlight_global_recruitment_pool(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean dont highlight upstream]
)
Highlights the global recruitment pool on the recruitment panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Suppress highlighting of any upstream components if this one is not currently visible.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5115

campaign_ui_manager:highlight_gods_bar(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the gods bar. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5157

campaign_ui_manager:highlight_growth(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the growth section of the province info panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5181

campaign_ui_manager:highlight_help_pages_button(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the help pages button. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5215

campaign_ui_manager:highlight_heroes(
  [boolean show highlight],
  [string faction key],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights any visible heroes on the campaign map. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

string

optional, default value=nil

Target faction key. Can be omitted to highlight armies for all factions.

3

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

4

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5237

campaign_ui_manager:highlight_hero_deployment_button(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the hero deployment button. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5261

campaign_ui_manager:highlight_hero_recruitment_button(
  [boolean show highlight],
  [number pulse strength override],
  [value highlight specifier]
)

Highlights the hero recruitment button. If it is not visible, highlight settlements for selection. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

If false is supplied here then a square highlight will be used instead of a pulse highlight.

3

value

optional, default value=false

Highlight specifier, which specifies what hero recruitment button to highlight. If the value supplied here is true then all hero recruitment buttons are highlighted. If the value is a number, then that specific hero recruitment button is highlighted, counting from the left (starting from 1). If the value is a string, then only the hero recruitment button for the settlement belonging to the specified region key is highlighted. Otherwise, just the first hero recruitment button is highlighted.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5286

campaign_ui_manager:highlight_hero_recruitment_panel(
  [boolean show highlight],
  [number pulse strength override]
)
Highlights the hero recruitment panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5372

campaign_ui_manager:highlight_hero_recruitment_panel_tab_buttons(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the hero recruitment panel tab buttons. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5441

campaign_ui_manager:highlight_horde_growth(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights horde growth. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5471

campaign_ui_manager:highlight_horde_buildings(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean dont highlight upstream]
)
Highlights horde buildings. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Suppress highlighting of any upstream components if this one is not currently visible.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5507

campaign_ui_manager:highlight_infamy(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the infamy indicator. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5535

campaign_ui_manager:highlight_influence(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the influence indicator on the top bar of the campaign interface. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5552

campaign_ui_manager:highlight_interventions(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the interventions button. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5569

campaign_ui_manager:highlight_legendary_knight_button(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the Legendary Knight button. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5594

campaign_ui_manager:highlight_list_button_events(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the events list button. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5620

campaign_ui_manager:highlight_list_button_factions(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the factions list button. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5644

campaign_ui_manager:highlight_list_button_forces(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the forces list button. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5668

campaign_ui_manager:highlight_list_button_missions(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the missions list button. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5692

campaign_ui_manager:highlight_list_button_provinces(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the provinces list button. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5716

campaign_ui_manager:highlight_local_recruitment_pool(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean dont highlight upstream]
)
Highlights the local recruitment pool on the recruitment panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Suppress highlighting of any upstream components if this one is not currently visible.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5740

campaign_ui_manager:highlight_lords(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights lords on the pre-battle screen. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5779

campaign_ui_manager:highlight_lords_pre_battle_screen(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean reinforcements only]
)
Highlights lords on the pre-battle screen. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Only highlights reinforcement lords.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5793

campaign_ui_manager:highlight_missions_list(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the missions list. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5845

campaign_ui_manager:highlight_movement_range(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean dont highlight upstream]
)
Highlights the movement range indicator on the character info panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Suppress highlighting of any upstream components if this one is not currently visible.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5871

campaign_ui_manager:highlight_objectives_button(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the objectives button. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5904

campaign_ui_manager:highlight_objectives_panel(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the objectives panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5928

campaign_ui_manager:highlight_objectives_panel_chapter_missions(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the chapter missions tab on the objectives panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5970

campaign_ui_manager:highlight_objectives_panel_victory_conditions(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the victory conditions tab on the objectives panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 5998

campaign_ui_manager:highlight_offices(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the offices panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 6026

campaign_ui_manager:highlight_offices_button(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the offices button. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 6084

campaign_ui_manager:highlight_peasants(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights peasants. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 6108

campaign_ui_manager:highlight_per_turn_income(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the per-turn income indicator. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 6125

campaign_ui_manager:highlight_pieces_of_eight_button(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the Pieces of Eight button. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 6141

campaign_ui_manager:highlight_ports(
  [boolean show highlight],
  [string faction key],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights any visible port settlements. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

string

optional, default value=nil

Target faction key. Can be omitted to highlight ports for all factions.

3

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

4

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 6166

campaign_ui_manager:highlight_post_battle_options(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights post battle option buttons. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 6190

campaign_ui_manager:highlight_post_battle_options_for_click([boolean show highlight])
Highlights post battle option buttons for clicking. This function works differently to other functions in this section as it highlights the post-battle options with a square highlight indicating that they should be clicked on. It also waits until the post_battle_panel is in position before activating the highlight.
Unlike other functions in this section this highlight should be disabled by calling this function again with false as a single argument.

Parameters:

1

boolean

optional, default value=false

show highlight

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 6253

campaign_ui_manager:highlight_post_battle_panel(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the post battle panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 6294

campaign_ui_manager:highlight_post_battle_panel_unit_cards(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean unit types only],
  [boolean unit experience only],
  [boolean unit banners only]
)
Highlights unit cards on the post battle panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Only highlights the unit type indicator on each card instead of the whole card.

5

boolean

optional, default value=false

Only highlights the unit experience indicator on each card instead of the whole card.

6

boolean

optional, default value=false

Only highlights unit banners on each card instead of the whole card.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 6327

campaign_ui_manager:highlight_pre_battle_options(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights unit cards on the pre-battle panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 6344

campaign_ui_manager:highlight_pre_battle_panel(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the pre-battle panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 6398

campaign_ui_manager:highlight_pre_battle_panel_unit_cards(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean is post-battle panel],
  [boolean unit types only],
  [boolean unit experience only],
  [boolean unit banners only]
)
Highlights unit cards on the pre-battle panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

sets whether this is actually the post-battle panel we are highlighting (campaign_ui_manager:highlight_post_battle_panel_unit_cards sets this flag).

5

boolean

optional, default value=false

Only highlights the unit type indicator on each card instead of the whole card.

6

boolean

optional, default value=false

Only highlights the unit experience indicator on each card instead of the whole card.

7

boolean

optional, default value=false

Only highlights unit banners on each card instead of the whole card.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 6453

campaign_ui_manager:highlight_province_info_panel(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the province info panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 6551

campaign_ui_manager:highlight_provinces_list(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the provinces drop-down list. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 6597

campaign_ui_manager:highlight_province_overview_panel(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the province overview panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 6623

campaign_ui_manager:highlight_province_overview_panel_settlement_headers(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean first settlement only],
  [boolean all but first settlement]
)
Highlights just the settlement headers on the province overview panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Only highlight headers for the first settlement on the army panel.

5

boolean

optional, default value=false

Highlight headers for all but the first settlement on the army panel.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 6672

campaign_ui_manager:highlight_public_order(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights public order on the province info panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 6720

campaign_ui_manager:highlight_raise_forces_button(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the raise forces button. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 6760

campaign_ui_manager:highlight_raise_forces_panel(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the raise forces panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 6802

campaign_ui_manager:highlight_recruit_hero_button(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the recruit hero button. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 6878

campaign_ui_manager:highlight_recruitment_button(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the recruitment button. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 6919

campaign_ui_manager:highlight_recruitment_capacity(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean dont highlight upstream]
)
Highlights the recruitment capacity indicators on the recruitment panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Suppress highlighting of any upstream components if this one is not currently visible.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 6946

campaign_ui_manager:highlight_recruitment_panel_unit_cards(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean unit types only],
  [boolean unit experience only]
)
Highlights unit cards on the recruitment panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Only highlights the unit type indicator on each card instead of the whole card.

5

boolean

optional, default value=false

Only highlights the unit experience indicator on each card instead of the whole card.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 6983

campaign_ui_manager:highlight_regiments_of_renown_panel(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the regiments of renown panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 7039

campaign_ui_manager:highlight_regiments_of_renown_button(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the regiments of renown button. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 7086

campaign_ui_manager:highlight_reinforcements(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights reinforcements on the pre-battle screen. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 7116

campaign_ui_manager:highlight_settlements(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [string faction key]
)
Highlights any visible settlements. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

string

optional, default value=nil

Target faction key. Can be omitted to highlight settlements for all factions.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 7130

campaign_ui_manager:highlight_ship_building_button(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the shipbuilding tab on the army panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 7154

campaign_ui_manager:highlight_ship_building_panel(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean dont highlight upstream]
)
Highlights the shipbuilding panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Suppress highlighting of any upstream components if this one is not currently visible.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 7180

campaign_ui_manager:highlight_siege_panel(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the siege panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 7250

campaign_ui_manager:highlight_siege_weapons(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights siege weapons on the siege panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 7285

campaign_ui_manager:highlight_stances(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean dont highlight upstream]
)
Highlights the stances rollout. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Suppress highlighting of any upstream components if this one is not currently visible.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 7311

campaign_ui_manager:highlight_strategic_map_layer_buttons(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the layer buttons on the strategic map. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 7349

campaign_ui_manager:highlight_strat_map_button(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the strategy map button. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 7375

campaign_ui_manager:highlight_tax(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the tax indicator on the province info panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 7399

campaign_ui_manager:highlight_technologies(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean dont highlight upstream]
)
Highlights technologies. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Suppress highlighting of any upstream components if this one is not currently visible.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 7413

campaign_ui_manager:highlight_technology_button(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the technologies button. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 7454

campaign_ui_manager:highlight_technology_panel(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the technologies panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 7478

campaign_ui_manager:highlight_treasure_map_button(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the Treasure map button. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 7536

campaign_ui_manager:highlight_treasure_map_panel(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the treasure maps panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 7560

campaign_ui_manager:highlight_treasury(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the treasury value. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 7613

campaign_ui_manager:highlight_treasury_button(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the treasury button. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 7630

campaign_ui_manager:highlight_treasury_panel(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the treasury panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 7654

campaign_ui_manager:highlight_treasury_panel_details_tab(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean dont highlight upstream]
)
Highlights the details tab on the treasury panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Suppress highlighting of any upstream components if this one is not currently visible.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 7689

campaign_ui_manager:highlight_treasury_panel_summary_tab(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean dont highlight upstream]
)
Highlights the summary tab on the treasury panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Suppress highlighting of any upstream components if this one is not currently visible.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 7720

campaign_ui_manager:highlight_treasury_panel_trade_tab(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean dont highlight upstream]
)
Highlights the trade tab on the treasury panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Suppress highlighting of any upstream components if this one is not currently visible.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 7751

campaign_ui_manager:highlight_unit_cards(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight],
  [boolean dont highlight upstream],
  [boolean unit types only],
  [boolean unit experience only]
)
Highlights unit cards across the campaign UI. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

4

boolean

optional, default value=false

Suppress highlighting of any upstream components if this one is not currently visible.

5

boolean

optional, default value=false

Only highlights the unit type indicator on each card instead of the whole card.

6

boolean

optional, default value=false

Only highlights the unit experience indicator on each card instead of the whole card.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 7782

campaign_ui_manager:highlight_unit_exchange_panel(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the unit exchange panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 7803

campaign_ui_manager:highlight_unit_experience(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights experience indicators on visible unit cards. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 7827

campaign_ui_manager:highlight_unit_information_panel(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the unit information panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 7841

campaign_ui_manager:highlight_unit_recruitment_panel(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights the unit recruitment panel. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 7892

campaign_ui_manager:highlight_unit_types(
  [boolean show highlight],
  [number pulse strength override],
  [boolean force highlight]
)
Highlights unit type indicators on visible unit cards. Best practise is to use campaign_ui_manager:unhighlight_all_for_tooltips to cancel the highlight later.

Parameters:

1

boolean

optional, default value=false

Show highlight.

2

number

optional, default value=nil

Pulse Strength Override. Default is 10 for smaller components such as buttons, and 5 for larger components such as panels. Set a higher number for a more pronounced pulsing.

3

boolean

optional, default value=false

Forces the highlight to show even if the help_page_link_highlighting ui override is set.

Returns:

  1. nil

defined in ../../Warhammer/working_data/script/_lib/lib_campaign_ui.lua, line 7942

Last updated 8/23/2024 4:55:15 PM