Frontend

The frontend object is automatically provided by the frontend game environment to script, and provides functionality specific to the frontend. The functions it provides may be called directly on the object in the following form.

Example:

frontend.<function_name>(<args>)
Loaded in Frontend loaded in frontend
Back to top

Functionality

frontend.start_named_battle(string key)

Starts a named battle specified by key from the battles table.

Parameters:

1

string

key

Returns:

  1. nil

defined in ../../common/UIDll/Source/FrontEnd/FrontendUIScriptInterface.cpp, line 193

frontend.start_xml_battle(string xml_path)

Starts a battle from xml

Parameters:

1

string

xml_path

Returns:

  1. nil

defined in ../../common/UIDll/Source/FrontEnd/FrontendUIScriptInterface.cpp, line 210

frontend.start_campaign(string campaign key, string faction key, string political party key)

Starts the specified campaign, by string key from the campaigns table. A faction key from the factions table and a political party key from political_parties table.

Parameters:

1

string

campaign key

2

string

faction key

3

string

political party key

Returns:

  1. nil

defined in ../../common/UIDll/Source/FrontEnd/FrontendUIScriptInterface.cpp, line 228

frontend.load_campaign(string file path, [boolean from cloud])

Loads a campaign save file by name.

Parameters:

1

string

file path

2

boolean

optional, default value=false

from cloud

Returns:

  1. nil

defined in ../../common/UIDll/Source/FrontEnd/FrontendUIScriptInterface.cpp, line 251

frontend.continue_campaign([boolean from cloud])

Loads the most recently saved campaign game.

Parameters:

1

boolean

optional, default value=false

from cloud

Returns:

  1. nil

defined in ../../common/UIDll/Source/FrontEnd/FrontendUIScriptInterface.cpp, line 277

frontend.campaign_saves_exist()
Returns whether any singleplayer campaign save files exists.

Returns:

  1. boolean saves exist

defined in ../../common/UIDll/Source/FrontEnd/FrontendUIScriptInterface.cpp, line 301

frontend.campaign_saves_exist_mp()
Returns whether any multiplayer campaign save files exists.

Returns:

  1. boolean saves exist

defined in ../../common/UIDll/Source/FrontEnd/FrontendUIScriptInterface.cpp, line 315

Last updated 25/08/2021 12:07:51