1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

4

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

Text key of title for the event message to create, in full localised [table]_[field]_[record_key] format.

4

string

Text key of primary text for the event message to create, in full localised [table]_[field]_[record_key] format.

5

string

Text key of secondary text for the event message to create, in full localised [table]_[field]_[record_key] format.

6

boolean

Persistence flag to pass to campaign_manager:show_message_event.

7

number

Index value to pass to campaign_manager:show_message_event. This determines the header image shown.

8

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

9

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

Text key of title for the event message to create, in full localised [table]_[field]_[record_key] format.

4

string

Text key of primary text for the event message to create, in full localised [table]_[field]_[record_key] format.

5

string

Text key of secondary text for the event message to create, in full localised [table]_[field]_[record_key] format.

6

boolean

Persistence flag to pass to campaign_manager:show_message_event.

7

number

Index value to pass to campaign_manager:show_message_event. This determines the header image shown.

8

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

9

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

function

optional, default value=nil

Intervention configuration callback. If supplied, this is passed to narrative_event:add_intervention_configuration_callback to pre-configure the intervention associated with the narrative event prior to it being triggered. The callback will be passed the intervention object as a single argument when called.

4

function

optional, default value=nil

Trigger callback to call when the intervention is triggered. If supplied, this is passed to narrative_event:set_trigger_callback. The callback will be passed the string triggering message, and a callback which can be used to prevent the narrative event completing immediately. Call the callback with false as an argument to stop it completing, then later with true as an argument to complete.

5

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

6

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

function

Callback to call.

4

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

5

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

number

Interval in seconds to wait.

4

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

5

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

Key of value to save.

4

value

Value to save. Supported data types are boolean, number, string and table.

5

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

6

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

Key of value to mark as seen.

4

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

5

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

Path of movie to play. See the documentation of cm:register_instant_movie for more information.

4

number

optional, default value=0.5

Duration in seconds over which to fade the picture to black before playing the movie.

5

number

optional, default value=0.5

Duration in seconds over which to fade back to picture after playing the movie.

6

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

7

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

number

Duration of scripted cutscene in seconds.

4

function

optional, default value=nil

This function will be called after the cutscene is created and before it is played. It can be used by client scripts to configure the cutscene object and populate it with actions. The function will be passed the cutscene object as a single argument.

5

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

6

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

Path to cindyscene, from the working data folder.

4

number

Cindyscene blend in duration in seconds.

5

number

Cindyscene blend out duration in seconds.

6

function

optional, default value=nil

This function will be called after the cutscene is created and before it is played. It can be used by client scripts to configure the cutscene object and populate it with actions, if required. The function will be passed the cutscene object as a single argument.

7

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

8

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

number

Duration of camera fade in seconds.

4

boolean

Sets whether the camera should fade to black. Supply false to fade to picture instead.

5

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

6

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

Key of the mission to cancel, from the missions database table. The mission will be cancelled for the specified faction.

4

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

5

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

optional, default value=nil

Key of advice to issue with this mission, if any, from the advice_threads database table.

4

string

Key of mission to issue, from the missions database table.

5

string

Key of mission text to display, from the mission_text database table. This must be set up for scripted missions such as this.

6

table

A table containing one or more event/condition records. Each record should be a table with a string "event" element and a "condition" element that's either a condition function or true.

7

function

optional, default value=nil

A camera scroll callback, to be supplied to narrative_event:set_camera_scroll_target_callback.

8

string

optional, default value="clan_elders"

Key of mission issuer, from the mission_issuers database table.

9

table

Rewards to add to the mission. This should be a table of strings. See the documentation for mission_manager:add_payload for more information on the string formatting and available options.

10

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

11

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

12

string

optional, default value=nil

Message to trigger when the mission has completed. This can be a table of strings if multiple on-completed messages are desired.

13

table

optional, default value=nil

Table of string names of other narrative events to inherit the rewards from. If this narrative event triggers before another that it's set to inherit from, this narrative event will add the mission rewards from the other to its own mission rewards, and prevent the other narrative event from triggering.

14

boolean

optional, default value=nil

this is used to override the default advice priority logic - by setting this to true, the supplied advice key will always be played regardless of advice level

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

optional, default value=nil

Key of advice to issue with this mission, if any, from the advice_threads database table.

4

string

Key of mission to issue, from the missions database table.

5

string

Key of target enemy faction, from the factions database table.

6

number

Camera scroll target character cqi. If this is supplied the camera will scroll to the specified character when the mission is issued (assuming the narrative event decides to move the camera), otherwise it will scroll to the nearest character in the target faction to the local player's forces.

7

string

optional, default value="clan_elders"

Key of mission issuer, from the mission_issuers database table.

8

table

Rewards to add to the mission. This should be a table of strings. See the documentation for mission_manager:add_payload for more information on the string formatting and available options.

9

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

10

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

11

string

optional, default value=nil

Message to trigger when the mission has completed. This can be a table of strings if multiple on-completed messages are desired.

12

table

optional, default value=nil

Table of string names of other narrative events to inherit the rewards from. If this narrative event triggers before another that it's set to inherit from, this narrative event will add the mission rewards from the other to its own mission rewards, and prevent the other narrative event from triggering.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

optional, default value=nil

Key of advice to issue with this mission, if any, from the advice_threads database table.

4

string

Key of mission to issue, from the missions database table.

5

string

Key of target enemy faction, from the factions database table.

6

number

Camera scroll target character cqi. If this is supplied the camera will scroll to the specified character when the mission is issued (assuming the narrative event decides to move the camera), otherwise it will scroll to the nearest character in the target faction to the local player's forces.

7

string

optional, default value="clan_elders"

Key of mission issuer, from the mission_issuers database table.

8

table

Rewards to add to the mission. This should be a table of strings. See the documentation for mission_manager:add_payload for more information on the string formatting and available options.

9

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

10

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

11

string

optional, default value=nil

Message to trigger when the mission has completed. This can be a table of strings if multiple on-completed messages are desired.

12

table

optional, default value=nil

Table of string names of other narrative events to inherit the rewards from. If this narrative event triggers before another that it's set to inherit from, this narrative event will add the mission rewards from the other to its own mission rewards, and prevent the other narrative event from triggering.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

optional, default value=nil

Key of advice to issue with this mission, if any, from the advice_threads database table.

4

string

Key of mission to issue, from the missions database table.

5

string

Text key of mission ojective to show, in the full [table]_[field]_[key] format.

6

string

Key of target culture, from the cultures database table. This can also be a table of strings if multiple target cultures are desired.

7

string

optional, default value="clan_elders"

Key of mission issuer, from the mission_issuers database table.

8

table

Rewards to add to the mission. This should be a table of strings. See the documentation for mission_manager:add_payload for more information on the string formatting and available options.

9

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

10

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

11

string

optional, default value=nil

Message to trigger when the mission has completed. This can be a table of strings if multiple on-completed messages are desired.

12

table

optional, default value=nil

Table of string names of other narrative events to inherit the rewards from. If this narrative event triggers before another that it's set to inherit from, this narrative event will add the mission rewards from the other to its own mission rewards, and prevent the other narrative event from triggering.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

optional, default value=nil

Key of advice to issue with this mission, if any, from the advice_threads database table.

4

string

Key of mission to issue, from the missions database table.

5

string

optional, default value="clan_elders"

Key of mission issuer, from the mission_issuers database table.

6

table

Rewards to add to the mission. This should be a table of strings. See the documentation for mission_manager:add_payload for more information on the string formatting and available options.

7

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

8

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

9

string

optional, default value=nil

Message to trigger when the mission has completed. This can be a table of strings if multiple on-completed messages are desired.

10

table

optional, default value=nil

Table of string names of other narrative events to inherit the rewards from. If this narrative event triggers before another that it's set to inherit from, this narrative event will add the mission rewards from the other to its own mission rewards, and prevent the other narrative event from triggering.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

optional, default value=nil

Key of advice to issue with this mission, if any, from the advice_threads database table.

4

string

Key of mission to issue, from the missions database table.

5

string

Key of mission text to display, from the mission_text database table. This must be set up for scripted missions such as this.

6

string

Key of the pooled resource to monitor, from the pooled_resources database table.

7

number

Amount of the pooled resource that is required to be consumed for the mission to complete.

8

table

optional, default value=nil

Keys of specific factors to track.

9

string

optional, default value="clan_elders"

Key of mission issuer, from the mission_issuers database table.

10

table

Rewards to add to the mission. This should be a table of strings. See the documentation for mission_manager:add_payload for more information on the string formatting and available options.

11

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

12

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

13

string

optional, default value=nil

Message to trigger when the mission has completed. This can be a table of strings if multiple on-completed messages are desired.

14

table

optional, default value=nil

Table of string names of other narrative events to inherit the rewards from. If this narrative event triggers before another that it's set to inherit from, this narrative event will add the mission rewards from the other to its own mission rewards, and prevent the other narrative event from triggering.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

optional, default value=nil

Key of advice to issue with this mission, if any, from the advice_threads database table.

4

string

Key of mission to issue, from the missions database table.

5

string

Key of pooled resource, from the pooled_resources database table.

6

string

Absolute quantity of pooled resource the faction has to acquire to complete the mission.

7

string

optional, default value="clan_elders"

Key of mission issuer, from the mission_issuers database table.

8

table

Rewards to add to the mission. This should be a table of strings. See the documentation for mission_manager:add_payload for more information on the string formatting and available options.

9

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

10

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

11

string

optional, default value=nil

Message to trigger when the mission has completed. This can be a table of strings if multiple on-completed messages are desired.

12

table

optional, default value=nil

Table of string names of other narrative events to inherit the rewards from. If this narrative event triggers before another that it's set to inherit from, this narrative event will add the mission rewards from the other to its own mission rewards, and prevent the other narrative event from triggering.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

optional, default value=nil

Key of advice to issue with this mission, if any, from the advice_threads database table.

4

string

Key of mission to issue, from the missions database table.

5

string

Absolute quantity of pooled resource the faction has to acquire to complete the mission.

6

string

optional, default value="clan_elders"

Key of mission issuer, from the mission_issuers database table.

7

table

Rewards to add to the mission. This should be a table of strings. See the documentation for mission_manager:add_payload for more information on the string formatting and available options.

8

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

9

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

10

string

optional, default value=nil

Message to trigger when the mission has completed. This can be a table of strings if multiple on-completed messages are desired.

11

table

optional, default value=nil

Table of string names of other narrative events to inherit the rewards from. If this narrative event triggers before another that it's set to inherit from, this narrative event will add the mission rewards from the other to its own mission rewards, and prevent the other narrative event from triggering.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

optional, default value=nil

Key of advice to issue with this mission, if any, from the advice_threads database table.

4

string

Key of mission to issue, from the missions database table.

5

string

Absolute quantity of pooled resource the faction has to acquire to complete the mission.

6

string

optional, default value="clan_elders"

Key of mission issuer, from the mission_issuers database table.

7

table

Rewards to add to the mission. This should be a table of strings. See the documentation for mission_manager:add_payload for more information on the string formatting and available options.

8

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

9

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

10

string

optional, default value=nil

Message to trigger when the mission has completed. This can be a table of strings if multiple on-completed messages are desired.

11

table

optional, default value=nil

Table of string names of other narrative events to inherit the rewards from. If this narrative event triggers before another that it's set to inherit from, this narrative event will add the mission rewards from the other to its own mission rewards, and prevent the other narrative event from triggering.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

optional, default value=nil

Key of advice to issue with this mission, if any, from the advice_threads database table.

4

string

Key of mission to issue, from the missions database table.

5

string

Key of mission text to display, from the mission_text database table. This must be set up for scripted missions such as this.

6

string

Key of the pooled resource to monitor, from the pooled_resources database table. This may also be a table of string pooled resource keys if multiple pooled resources are to be monitored.

7

number

Lower threshold level of the pooled resource(s) at which the mission completes. If not supplied, then there is no lower pooled resource bound at which the mission completes.

8

number

Upper threshold level of the pooled resource(s) at which the mission completes. If not supplied, then there is no upper pooled resource bound at which the mission completes. One or both of the lower and upper thresholds must be provided.

9

boolean

If set to true the value of all supplied specified pooled resources is counted towards the threshold value. If false is supplied, then the mission only completes when one of the pooled resources specified reaches the threshold value.

10

string

optional, default value="clan_elders"

Key of mission issuer, from the mission_issuers database table.

11

table

Rewards to add to the mission. This should be a table of strings. See the documentation for mission_manager:add_payload for more information on the string formatting and available options.

12

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

13

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

14

string

optional, default value=nil

Message to trigger when the mission has completed. This can be a table of strings if multiple on-completed messages are desired.

15

table

optional, default value=nil

Table of string names of other narrative events to inherit the rewards from. If this narrative event triggers before another that it's set to inherit from, this narrative event will add the mission rewards from the other to its own mission rewards, and prevent the other narrative event from triggering.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

optional, default value=nil

Key of advice to issue with this mission, if any, from the advice_threads database table.

4

string

Key of mission to issue, from the missions database table.

5

string

optional, default value=nil

Key of target enemy faction, from the factions database table. If no key is specified then the capture of any settlement qualifies.

6

string

optional, default value=nil

if multiple target settlements are desired. If no value is supplied then the capture of any settlement qualifies.

7

value

optional, default value=nil

Camera scroll target. This can be a string region key, a string faction key (region is looked up before faction), or a number character cqi. If this is supplied the camera will scroll to the specified target when the mission is issued (assuming the narrative event decides to move the camera).

8

string

optional, default value="clan_elders"

Key of mission issuer, from the mission_issuers database table.

9

table

Rewards to add to the mission. This should be a table of strings. See the documentation for mission_manager:add_payload for more information on the string formatting and available options.

10

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

11

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

12

string

optional, default value=nil

Message to trigger when the mission has completed. This can be a table of strings if multiple on-completed messages are desired.

13

table

optional, default value=nil

Table of string names of other narrative events to inherit the rewards from. If this narrative event triggers before another that it's set to inherit from, this narrative event will add the mission rewards from the other to its own mission rewards, and prevent the other narrative event from triggering.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

optional, default value=nil

Key of advice to issue with this mission, if any, from the advice_threads database table.

4

string

Key of mission to issue, from the missions database table.

5

string

Region key of target settlement, from the campaign_map_regions database table. If more than one target settlement is desired a table of region keys can be supplied.

6

string

optional, default value="clan_elders"

Key of mission issuer, from the mission_issuers database table.

7

table

Rewards to add to the mission. This should be a table of strings. See the documentation for mission_manager:add_payload for more information on the string formatting and available options.

8

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

9

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

10

string

optional, default value=nil

Message to trigger when the mission has completed. This can be a table of strings if multiple on-completed messages are desired.

11

table

optional, default value=nil

Table of string names of other narrative events to inherit the rewards from. If this narrative event triggers before another that it's set to inherit from, this narrative event will add the mission rewards from the other to its own mission rewards, and prevent the other narrative event from triggering.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

optional, default value=nil

Key of advice to issue with this mission, if any, from the advice_threads database table.

4

string

Key of mission to issue, from the missions database table.

5

number

optional, default value=1

Target number of provinces to control.

6

string

optional, default value=nil

Key of specific province to control. This may also be a table of string keys if multiple are desired.

7

value

optional, default value=nil

Camera scroll target. This can be a string region key, a string faction key (region is looked up before faction), or a number character cqi. If this is supplied the camera will scroll to the specified target when the mission is issued (assuming the narrative event decides to move the camera).

8

string

optional, default value="clan_elders"

Key of mission issuer, from the mission_issuers database table.

9

table

Rewards to add to the mission. This should be a table of strings. See the documentation for mission_manager:add_payload for more information on the string formatting and available options.

10

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

11

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

12

string

optional, default value=nil

Message to trigger when the mission has completed. This can be a table of strings if multiple on-completed messages are desired.

13

table

optional, default value=nil

Table of string names of other narrative events to inherit the rewards from. If this narrative event triggers before another that it's set to inherit from, this narrative event will add the mission rewards from the other to its own mission rewards, and prevent the other narrative event from triggering.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

optional, default value=nil

Key of advice to issue with this mission, if any, from the advice_threads database table.

4

string

Key of mission to issue, from the missions database table.

5

number

optional, default value=1

Target number of commandments to enact.

6

string

optional, default value=nil

Key of specific commamdment to enact.

7

string

optional, default value="clan_elders"

Key of mission issuer, from the mission_issuers database table.

8

table

Rewards to add to the mission. This should be a table of strings. See the documentation for mission_manager:add_payload for more information on the string formatting and available options.

9

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

10

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

11

string

optional, default value=nil

Message to trigger when the mission has completed. This can be a table of strings if multiple on-completed messages are desired.

12

table

optional, default value=nil

Table of string names of other narrative events to inherit the rewards from. If this narrative event triggers before another that it's set to inherit from, this narrative event will add the mission rewards from the other to its own mission rewards, and prevent the other narrative event from triggering.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

optional, default value=nil

Key of advice to issue with this mission, if any, from the advice_threads database table.

4

string

Key of mission to issue, from the missions database table.

5

string

Faction key of target faction, from the factions database table. This may also be a table of multiple target faction keys.

6

string

optional, default value="clan_elders"

Key of mission issuer, from the mission_issuers database table.

7

table

Rewards to add to the mission. This should be a table of strings. See the documentation for mission_manager:add_payload for more information on the string formatting and available options.

8

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

9

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

10

string

optional, default value=nil

Message to trigger when the mission has completed. This can be a table of strings if multiple on-completed messages are desired.

11

table

optional, default value=nil

Table of string names of other narrative events to inherit the rewards from. If this narrative event triggers before another that it's set to inherit from, this narrative event will add the mission rewards from the other to its own mission rewards, and prevent the other narrative event from triggering.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

optional, default value=nil

Key of advice to issue with this mission, if any, from the advice_threads database table.

4

string

Key of mission to issue, from the missions database table.

5

number

Target number of units to recruit.

6

string

optional, default value=nil

Optional unit key of unit that must be recruited, from the land_units database table. This may also be a table of string unit keys. If a value is supplied here then recruited units only count towards the total if their unit keys match. If no value is supplied then any unit matches.

7

boolean

optional, default value=false

Excluding pre-existing units from the count.

8

string

optional, default value="clan_elders"

Key of mission issuer, from the mission_issuers database table.

9

table

Rewards to add to the mission. This should be a table of strings. See the documentation for mission_manager:add_payload for more information on the string formatting and available options.

10

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

11

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

12

string

optional, default value=nil

Message to trigger when the mission has completed. This can be a table of strings if multiple on-completed messages are desired.

13

table

optional, default value=nil

Table of string names of other narrative events to inherit the rewards from. If this narrative event triggers before another that it's set to inherit from, this narrative event will add the mission rewards from the other to its own mission rewards, and prevent the other narrative event from triggering.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

optional, default value=nil

Key of advice to issue with this mission, if any, from the advice_threads database table.

4

string

Key of mission to issue, from the missions database table.

5

number

Target number of buildings to construct.

6

string

optional, default value=nil

Key of building chain the building must be a part of, from the building_chains database table. This may also be a table of string chain keys. If a value is supplied here then the constructed buildings only count towards the total if they belong to a specified chain. If no value is supplied then any constructed building counts towards the total.

7

boolean

optional, default value=false

Excluding pre-existing buildings from the count.

8

value

optional, default value=nil

Camera scroll target. This can be a string region key, a string faction key (region is looked up before faction), or a number character cqi. If this is supplied the camera will scroll to the specified target when the mission is issued (assuming the narrative event decides to move the camera).

9

string

optional, default value="clan_elders"

Key of mission issuer, from the mission_issuers database table.

10

table

Rewards to add to the mission. This should be a table of strings. See the documentation for mission_manager:add_payload for more information on the string formatting and available options.

11

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

12

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

13

string

optional, default value=nil

Message to trigger when the mission has completed. This can be a table of strings if multiple on-completed messages are desired.

14

table

optional, default value=nil

Table of string names of other narrative events to inherit the rewards from. If this narrative event triggers before another that it's set to inherit from, this narrative event will add the mission rewards from the other to its own mission rewards, and prevent the other narrative event from triggering.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

optional, default value=nil

Key of advice to issue with this mission, if any, from the advice_threads database table.

4

string

Key of mission to issue, from the missions database table.

5

string

Key that specifies the objective text, from the mission_texts table.

6

function

optional, default value=nil

Condition function to pass. If no condition function is supplied then the condition always passes.

7

string

optional, default value="clan_elders"

Key of mission issuer, from the mission_issuers database table.

8

table

Rewards to add to the mission. This should be a table of strings. See the documentation for mission_manager:add_payload for more information on the string formatting and available options.

9

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

10

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

11

string

optional, default value=nil

Message to trigger when the mission has completed. This can be a table of strings if multiple on-completed messages are desired.

12

table

optional, default value=nil

Table of string names of other narrative events to inherit the rewards from. If this narrative event triggers before another that it's set to inherit from, this narrative event will add the mission rewards from the other to its own mission rewards, and prevent the other narrative event from triggering.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

optional, default value=nil

Key of advice to issue with this mission, if any, from the advice_threads database table.

4

string

Key of mission to issue, from the missions database table.

5

string

Key that specifies the objective text, from the mission_texts table.

6

function

optional, default value=nil

Condition function to pass. If no condition function is supplied then the condition always passes.

7

string

optional, default value="clan_elders"

Key of mission issuer, from the mission_issuers database table.

8

table

Rewards to add to the mission. This should be a table of strings. See the documentation for mission_manager:add_payload for more information on the string formatting and available options.

9

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

10

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

11

string

optional, default value=nil

Message to trigger when the mission has completed. This can be a table of strings if multiple on-completed messages are desired.

12

table

optional, default value=nil

Table of string names of other narrative events to inherit the rewards from. If this narrative event triggers before another that it's set to inherit from, this narrative event will add the mission rewards from the other to its own mission rewards, and prevent the other narrative event from triggering.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

optional, default value=nil

Key of advice to issue with this mission, if any, from the advice_threads database table.

4

string

Key of mission to issue, from the missions database table.

5

function

optional, default value=nil

Additional condition function to pass. If a condition is supplied, it will need to be passed in addition to the base "unlocks technologies" requirement.

6

string

optional, default value="clan_elders"

Key of mission issuer, from the mission_issuers database table.

7

table

Rewards to add to the mission. This should be a table of strings. See the documentation for mission_manager:add_payload for more information on the string formatting and available options.

8

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

9

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

10

string

optional, default value=nil

Message to trigger when the mission has completed. This can be a table of strings if multiple on-completed messages are desired.

11

table

optional, default value=nil

Table of string names of other narrative events to inherit the rewards from. If this narrative event triggers before another that it's set to inherit from, this narrative event will add the mission rewards from the other to its own mission rewards, and prevent the other narrative event from triggering.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

optional, default value=nil

Key of advice to issue with this mission, if any, from the advice_threads database table.

4

string

Key of mission to issue, from the missions database table.

5

string

optional, default value="clan_elders"

Key of mission issuer, from the mission_issuers database table.

6

table

Rewards to add to the mission. This should be a table of strings. See the documentation for mission_manager:add_payload for more information on the string formatting and available options.

7

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

8

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

9

string

optional, default value=nil

Message to trigger when the mission has completed. This can be a table of strings if multiple on-completed messages are desired.

10

table

optional, default value=nil

Table of string names of other narrative events to inherit the rewards from. If this narrative event triggers before another that it's set to inherit from, this narrative event will add the mission rewards from the other to its own mission rewards, and prevent the other narrative event from triggering.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

optional, default value=nil

Key of advice to issue with this mission, if any, from the advice_threads database table.

4

string

Key of mission to issue, from the missions database table.

5

number

Number of technologies that must be researched.

6

string

The key of any mandatory technology that must be researched before the mission can be completed. This may be supplied as a table of strings if multiple are desired.

7

boolean

optional, default value=false

Sets whether pre-existing technologies count towards the total.

8

string

optional, default value="clan_elders"

Key of mission issuer, from the mission_issuers database table.

9

table

Rewards to add to the mission. This should be a table of strings. See the documentation for mission_manager:add_payload for more information on the string formatting and available options.

10

string

Script message on which the narrative event should trigger. This can also be a table of strings if multiple trigger messages are desired.

11

string

optional, default value=nil

Message to trigger when the narrative event has finished issuing. This can be a table of strings if multiple on-issued messages are desired.

12

string

optional, default value=nil

Message to trigger when the mission has completed. This can be a table of strings if multiple on-completed messages are desired.

13

table

optional, default value=nil

Table of string names of other narrative events to inherit the rewards from. If this narrative event triggers before another that it's set to inherit from, this narrative event will add the mission rewards from the other to its own mission rewards, and prevent the other narrative event from triggering.

1

string

Unique name amongst other declared narrative events.

2

string

Key of the faction to which this narrative event applies, from the factions database table.

3

string

optional, default value=nil

Key of advice to issue with this mission, if any, from the advice_threads database table.

4

string

Key of mission to issue, from the missions database table.

5

number

Income level to be gained.

6

string