Campaign Documentation

Scripting Homepage

Search

Search campaign only




Game Areas

• > Campaign Index
• Battle Index
• Frontend Index

On this page

Key

Loaded in Battle
Loaded in Campaign
Loaded in Frontend

• ScriptedValueRegistry
•   Creation
•     new
•   Usage
•   Game Session Registry
•     SaveBool
•     LoadBool
•     SaveString
•     LoadString
•     SavePersistentBool
•     LoadPersistentBool
•     SavePersistentString
•     LoadPersistentString
•   Operating System Registry
•     SaveRegistryBool
•     LoadRegistryBool

Campaign Topics

• Campaign Index
• Campaign Script Structure
• Lua Language
• Scripted Events

Game Code Pages

• CampaignUI
• Cinematics
• Effect
• Episodic Scripting
• > ScriptedValueRegistry
• UIComponents

Script Pages

• Campaign Manager
• Core
• Campaign Cutscenes
• Campaign Interface
• Campaign UI Manager
• Chapter Missions
• Convex Areas
• Global
• Infotext Manager
• Interventions
• Invasion Manager
• Mission Managers
• Narrative Events
• Objectives Manager
• Random Army Manager
• Script Messager
• Text Pointers

ScriptedValueRegistry

The scriped value registry is an object that may be used by scripts to store persistent values across game environments. Using the scripted value registry, campaign and battle scripts can pass simple messages between one another which is otherwise difficult to achieve. The values stored in the scripted value registry are cleared whenever loading into the frontend, however, unless they've been saved as persistent.

The scriped value registry also provides functions that allow script to save boolean values into the operating system registry, which can be queried later to determine if a particular event has ever occurred, for example.

Loaded in Battle
Loaded in Campaign
Loaded in Frontend

Once a scripted value registry has been created, functions may be called on it in the following form.

Example - Specification:

Example - Creation and Usage:

The functions in this section can be used to save values into the scripted value registry that may be read by scripts in other environments. The values are not saved into the operating system registry, however, so will be cleared when the game is shut down and restarted.

Values saved with ScriptedValueRegistry:SaveBool or ScriptedValueRegistry:SaveString will be cleared if the game loads back into the frontend. Values may be saved as persistent to avoid them being cleared in this way with the functions ScriptedValueRegistry:SavePersistentBool and ScriptedValueRegistry:SavePersistentString. These values may be read later with ScriptedValueRegistry:LoadPersistentBool and ScriptedValueRegistry:LoadPersistentString.

The internal mapping used for persistent and non-persistent values are different, so a value saved with ScriptedValueRegistry:SavePersistentString cannot be loaded with ScriptedValueRegistry:LoadString, for example.

The functions in this section can be used to store and retrieve values from the operating system registry, which is persistent between game loads. No path within the registry may be specified.