1

string

Unique name amongst other declared narrative queries.

2

string

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

3

string

Message on which this narrative query should trigger. If multiple trigger messages are required a table containing string message names can be supplied here instead.

4

string

Positive trigger message to fire if the saved value exists. This can be a single string or a table of strings if multiple messages are desired.

5

string

optional, default value=nil

Negative trigger message to fire if the saved value does not exist. This can be a single string or a table of strings if multiple messages are desired.

6

string

Key of value to look up from the savegame. This is passed to campaign_manager:get_saved_value to retrieve the value.

7

function

optional, default value=nil

Additional condition function which can force a positive or negative result. If supplied, the function is called with the context and narrative query objects passed in as separate functions. If it returns true then a positive result is forced, if false then a negative result is forced. If it returns any other value then no result is forced.

The condition function may also return a string as a second return value, which will be used for output.

1

string

Unique name amongst other declared narrative queries.

2

string

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

3

string

Message on which this narrative query should trigger. If multiple trigger messages are required a table containing string message names can be supplied here instead.

4

string

Positive trigger message to fire if the saved value exists. This can be a single string or a table of strings if multiple messages are desired.

5

string

optional, default value=nil

Negative trigger message to fire if the saved value does not exist. This can be a single string or a table of strings if multiple messages are desired.

6

string

Name of narrative event to query. This may also be a table of strings if multiple narrative events are to be queried.

7

boolean

optional, default value=false

Trigger the positive message if all specified narrative events have fired. If false or nil is supplied here then the positive message will be triggered if any of the specified narrative events have fired.

8

function

optional, default value=nil

Additional condition function which can force a positive or negative result. If supplied, the function is called with the context and narrative query objects passed in as separate functions. If it returns true then a positive result is forced, if false then a negative result is forced. If it returns any other value then no result is forced.

The condition function may also return a string as a second return value, which will be used for output.

1

string

Unique name amongst other declared narrative queries.

2

string

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

3

string

Message on which this narrative query should trigger. If multiple trigger messages are required a table containing string message names can be supplied here instead.

4

string

Message to trigger if the player has experienced the supplied advice. This can be a single string or a table of strings if multiple messages are desired.

5

string

optional, default value=nil

Message to trigger if the player has not experienced the supplied advice. This can be a single string or a table of strings if multiple messages are desired.

6

table

optional, default value=nil

Any advice strings table. When triggered, the narrative trigger will check the history of advice strings supplied in this table using the function common.get_advice_history_string_seen. If any advice strings in this table have been experienced by the local player then the advice-experienced message is triggered.

7

table

optional, default value=nil

All advice strings table. When triggered, the narrative trigger will check the history of all advice keys supplied in this table using the function common.get_advice_history_string_seen. If all advice strings in this table have been experienced by the local player then the advice-experienced message is triggered.

8

table

optional, default value=nil

Any advice keys table. When triggered, the narrative trigger will check the history of advice keys supplied in this table using the function common.get_advice_thread_score. If any advice items represented by keys in this table have been experienced by the local player then the advice-experienced message is triggered.

9

table

optional, default value=nil

All advice keys table. When triggered, the narrative trigger will check the history of all advice keys supplied in this table using the function common.get_advice_thread_score. If all advice items represented by keys in this table have been experienced by the local player then the advice-experienced message is triggered.

10

function

optional, default value=nil

Additional condition function which can force a positive or negative result. If supplied, the function is called with the context and narrative query objects passed in as separate functions. If it returns true then a positive result is forced, if false then a negative result is forced. If it returns any other value then no result is forced.

The condition function may also return a string as a second return value, which will be used for output.

1

string

Unique name amongst other declared narrative queries.

2

string

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

3

string

Message on which this narrative query should trigger. If multiple trigger messages are required a table containing string message names can be supplied here instead.

4

string

Target message to trigger if the player has experienced the supplied advice. This can be a single string or a table of strings if multiple messages are desired.

5

string

optional, default value=nil

Target message to trigger if the player has not experienced the supplied advice. This can be a single string or a table of strings if multiple messages are desired.

6

table

optional, default value=nil

All advice strings table. When triggered, the narrative trigger will check the history of advice strings supplied in this table using the function common.get_advice_history_string_seen. If all advice strings in this table have been experienced by the local player then the advice-experienced message is triggered.

7

function

optional, default value=nil

Additional condition function which can force a positive or negative result. If supplied, the function is called with the context and narrative query objects passed in as separate functions. If it returns true then a positive result is forced, if false then a negative result is forced. If it returns any other value then no result is forced.

The condition function may also return a string as a second return value, which will be used for output.

1

string

Unique name amongst other declared narrative queries.

2

string

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

3

string

Message on which this narrative query should trigger. If multiple trigger messages are required a table containing string message names can be supplied here instead.

4

string

Message to trigger if the faction is one settlement from completing a province. This can be a single string or a table of strings if multiple messages are desired.

5

string

optional, default value=nil

Message to trigger if the faction is not one settlement from completing a province. This can be a single string or a table of strings if multiple messages are desired.

6

function

optional, default value=nil

Additional condition function which can force a positive or negative result. If supplied, the function is called with the context and narrative query objects passed in as separate functions. If it returns true then a positive result is forced, if false then a negative result is forced. If it returns any other value then no result is forced.

The condition function may also return a string as a second return value, which will be used for output.

1

string

Unique name amongst other declared narrative queries.

2

string

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

3

string

Message on which this narrative query should trigger. If multiple trigger messages are required a table containing string message names can be supplied here instead.

4

string

Message to trigger if the faction is one settlement from completing a province. This can be a single string or a table of strings if multiple messages are desired.

5

string

optional, default value=nil

Message to trigger if the faction is not one settlement from completing a province. This can be a single string or a table of strings if multiple messages are desired.

6

number

Number of provinces the faction has to fully control for the positive message to be forced.

7

function

optional, default value=nil

Additional condition function which can force a positive or negative result. If supplied, the function is called with the context and narrative query objects passed in as separate functions. If it returns true then a positive result is forced, if false then a negative result is forced. If it returns any other value then no result is forced.

The condition function may also return a string as a second return value, which will be used for output.

1

string

Unique name amongst other declared narrative queries.

2

string

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

3

string

Message on which this narrative query should trigger. If multiple trigger messages are required a table containing string message names can be supplied here instead.

4

string

Message to trigger if the faction has a settlement at or above the query level. This can be a single string or a table of strings if multiple messages are desired.

5

string

optional, default value=nil

Message to trigger if the faction does not have a settlement at or above the query level. This can be a single string or a table of strings if multiple messages are desired.

6

number

Minimum level the highest-level settlement of the faction must be in order to trigger the positive result message(s).

7

function

optional, default value=nil

Additional condition function which can force a positive or negative result. If supplied, the function is called with the context and narrative query objects passed in as separate functions. If it returns true then a positive result is forced, if false then a negative result is forced. If it returns any other value then no result is forced.

The condition function may also return a string as a second return value, which will be used for output.

1

string

Unique name amongst other declared narrative queries.

2

string

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

3

string

Message on which this narrative query should trigger. If multiple trigger messages are required a table containing string message names can be supplied here instead.

4

string

Message to trigger if the faction is currently researching a technology. This can be a single string or a table of strings if multiple messages are desired.

5

string

optional, default value=nil

Message to trigger if the faction is not currently researching a technology. This can be a single string or a table of strings if multiple messages are desired.

6

function

optional, default value=nil

Additional condition function which can force a positive or negative result. If supplied, the function is called with the context and narrative query objects passed in as separate functions. If it returns true then a positive result is forced, if false then a negative result is forced. If it returns any other value then no result is forced.

The condition function may also return a string as a second return value, which will be used for output.

1

string

Unique name amongst other declared narrative queries.

2

string

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

3

string

Message on which this narrative query should trigger. If multiple trigger messages are required a table containing string message names can be supplied here instead.

4

string

Message to trigger if the faction has technologies available. This can be a single string or a table of strings if multiple messages are desired.

5

string

optional, default value=nil

Message to trigger if the faction does not have technologies available. This can be a single string or a table of strings if multiple messages are desired.

6

function

optional, default value=nil

Additional condition function which can force a positive or negative result. If supplied, the function is called with the context and narrative query objects passed in as separate functions. If it returns true then a positive result is forced, if false then a negative result is forced. If it returns any other value then no result is forced.

The condition function may also return a string as a second return value, which will be used for output.

1

string

Unique name amongst other declared narrative queries.

2

string

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

3

string

Message on which this narrative query should trigger. If multiple trigger messages are required a table containing string message names can be supplied here instead.

4

string

Message to trigger if the faction has the required income. This can be a single string or a table of strings if multiple messages are desired.

5

string

optional, default value=nil

Message to trigger if the faction does not have the required income. This can be a single string or a table of strings if multiple messages are desired.

6

number

Income amount.

7

function

optional, default value=nil

Additional condition function which can force a positive or negative result. If supplied, the function is called with the context and narrative query objects passed in as separate functions. If it returns true then a positive result is forced, if false then a negative result is forced. If it returns any other value then no result is forced.

The condition function may also return a string as a second return value, which will be used for output.

1

string

Unique name amongst other declared narrative queries.

2

string

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

3

string

Message on which this narrative query should trigger. If multiple trigger messages are required a table containing string message names can be supplied here instead.

4

string

Message to trigger if the faction can capture territory. This can be a single string or a table of strings if multiple messages are desired.

5

string

optional, default value=nil

Message to trigger if the faction cannot capture territory. This can be a single string or a table of strings if multiple messages are desired.

6

function

optional, default value=nil

Additional condition function which can force a positive or negative result. If supplied, the function is called with the context and narrative query objects passed in as separate functions. If it returns true then a positive result is forced, if false then a negative result is forced. If it returns any other value then no result is forced.

The condition function may also return a string as a second return value, which will be used for output.

1

string

Unique name amongst other declared narrative queries.

2

string

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

3

string

Message on which this narrative query should trigger. If multiple trigger messages are required a table containing string message names can be supplied here instead.

4

string

Message to trigger if the faction can recruit a hero. This can be a single string or a table of strings if multiple messages are desired.

5

string

optional, default value=nil

Message to trigger if the faction cannot recruit a hero. This can be a single string or a table of strings if multiple messages are desired.

6

function

optional, default value=nil

Additional condition function which can force a positive or negative result. If supplied, the function is called with the context and narrative query objects passed in as separate functions. If it returns true then a positive result is forced, if false then a negative result is forced. If it returns any other value then no result is forced.

The condition function may also return a string as a second return value, which will be used for output.

1

string

Unique name amongst other declared narrative queries.

2

string

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

3

string

Message on which this narrative query should trigger. If multiple trigger messages are required a table containing string message names can be supplied here instead.

4

string

Message to trigger if the faction can recruit a hero. This can be a single string or a table of strings if multiple messages are desired.

5

string

optional, default value=nil

Message to trigger if the faction cannot recruit a hero. This can be a single string or a table of strings if multiple messages are desired.

6

table

optional, default value=nil

Indexed table of string hero types. If no table is supplied then all hero types are matched.

7

function

optional, default value=nil

Additional condition function which can force a positive or negative result. If supplied, the function is called with the context and narrative query objects passed in as separate functions. If it returns true then a positive result is forced, if false then a negative result is forced. If it returns any other value then no result is forced.

The condition function may also return a string as a second return value, which will be used for output.

1

string

Unique name amongst other declared narrative queries.

2

string

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

3

string

Message on which this narrative query should trigger. If multiple trigger messages are required a table containing string message names can be supplied here instead.

4

string

Message to trigger if the faction can recruit a hero. This can be a single string or a table of strings if multiple messages are desired.

5

string

optional, default value=nil

Message to trigger if the faction cannot recruit a hero. This can be a single string or a table of strings if multiple messages are desired.

6

function

optional, default value=nil

Additional condition function which can force a positive or negative result. If supplied, the function is called with the context and narrative query objects passed in as separate functions. If it returns true then a positive result is forced, if false then a negative result is forced. If it returns any other value then no result is forced.

The condition function may also return a string as a second return value, which will be used for output.

1

string

Unique name amongst other declared narrative queries.

2

string

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

3

string

Message on which this narrative query should trigger. If multiple trigger messages are required a table containing string message names can be supplied here instead.

4

string

Message to trigger if the faction can recruit a hero. This can be a single string or a table of strings if multiple messages are desired.

5

string

optional, default value=nil

Message to trigger if the faction cannot recruit a hero. This can be a single string or a table of strings if multiple messages are desired.

6

table

optional, default value=nil

Indexed table of string character types to test against. If the specified faction contains any heroes matching any of the supplied types then a positive result is returned.

7

function

optional, default value=nil

Additional condition function which can force a positive or negative result. If supplied, the function is called with the context and narrative query objects passed in as separate functions. If it returns true then a positive result is forced, if false then a negative result is forced. If it returns any other value then no result is forced.

The condition function may also return a string as a second return value, which will be used for output.

1

string

Unique name amongst other declared narrative queries.

2

string

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

3

string

Message on which this narrative query should trigger. If multiple trigger messages are required a table containing string message names can be supplied here instead.

4

string

Message to trigger if the faction can recruit a hero. This can be a single string or a table of strings if multiple messages are desired.

5

string

optional, default value=nil

Message to trigger if the faction cannot recruit a hero. This can be a single string or a table of strings if multiple messages are desired.

6

string

optional, default value=nil

Message to trigger if the faction cannot recruit a hero. This can be a single string or a table of strings if multiple messages are desired.

7

string

optional, default value=nil

Culture key of region owner to exclude. If an eligible region has a faction owner with this culture, the region will not be included.

8

string

Corruption type, from the pooled_resources database table.

9

number

Threshold value which the corruption must meet or exceed in an adjacent region for the query to pass.

10

function

optional, default value=nil

Additional condition function which can force a positive or negative result. If supplied, the function is called with the context and narrative query objects passed in as separate functions. If it returns true then a positive result is forced, if false then a negative result is forced. If it returns any other value then no result is forced.

The condition function may also return a string as a second return value, which will be used for output.

1

string

Unique name amongst other declared narrative queries.

2

string

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

3

string

Message on which this narrative query should trigger. If multiple trigger messages are required a table containing string message names can be supplied here instead.

4

string

Message to trigger if the faction can capture territory. This can be a single string or a table of strings if multiple messages are desired.

5

string

optional, default value=nil

Message to trigger if the faction cannot capture territory. This can be a single string or a table of strings if multiple messages are desired.

6

number

optional, default value=1

THreshold number of plagues.

7

function

optional, default value=nil

Additional condition function which can force a positive or negative result. If supplied, the function is called with the context and narrative query objects passed in as separate functions. If it returns true then a positive result is forced, if false then a negative result is forced. If it returns any other value then no result is forced.

The condition function may also return a string as a second return value, which will be used for output.

1

string

Unique name amongst other declared narrative queries.

2

string

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

3

string

Message on which this narrative query should trigger. If multiple trigger messages are required a table containing string message names can be supplied here instead.

4

string

Message to trigger if the faction can capture territory. This can be a single string or a table of strings if multiple messages are desired.

5

string

optional, default value=nil

Message to trigger if the faction cannot capture territory. This can be a single string or a table of strings if multiple messages are desired.

6

string

optional, default value=nil

Faction key of a target faction which the subject should have an agreement with, from the factions database table. A table of string faction keys may be specified if more than one target faction is desired. In this case, the query passes if an agreement exists with any of the target factions in the list.

7

string

optional, default value=nil

Culture key of a target faction which the subject should have an agreement with, from the cultures database table. A table of string culture keys may be specified if more than one target culture is desired. In this case, the query passes if an agreement exists with a faction of any of the target cultures in the list.

8

string

optional, default value=nil

Subculture key of a target faction which the subject should have an agreement with, from the cultures_subcultures database table. A table of string subculture keys may be specified if more than one target subculture is desired. In this case, the query passes if an agreement exists with a faction of any of the target subcultures in the list.

9

function

optional, default value=nil

Additional condition function which can force a positive or negative result. If supplied, the function is called with the context and narrative query objects passed in as separate functions. If it returns true then a positive result is forced, if false then a negative result is forced. If it returns any other value then no result is forced.

The condition function may also return a string as a second return value, which will be used for output.

1

string

Unique name amongst other declared narrative queries.

2

string

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

3

string

Message on which this narrative query should trigger. If multiple trigger messages are required a table containing string message names can be supplied here instead.

4

string

Message to trigger if the faction can capture territory. This can be a single string or a table of strings if multiple messages are desired.

5

string

optional, default value=nil

Message to trigger if the faction cannot capture territory. This can be a single string or a table of strings if multiple messages are desired.

6

string

optional, default value=nil

Faction key of a target faction which the subject should have an agreement with, from the factions database table. A table of string faction keys may be specified if more than one target faction is desired. In this case, the query passes if an agreement exists with any of the target factions in the list.

7

string

optional, default value=nil

Culture key of a target faction which the subject should have an agreement with, from the cultures database table. A table of string culture keys may be specified if more than one target culture is desired. In this case, the query passes if an agreement exists with a faction of any of the target cultures in the list.

8

string

optional, default value=nil

Subculture key of a target faction which the subject should have an agreement with, from the cultures_subcultures database table. A table of string subculture keys may be specified if more than one target subculture is desired. In this case, the query passes if an agreement exists with a faction of any of the target subcultures in the list.

9

function

optional, default value=nil

Additional condition function which can force a positive or negative result. If supplied, the function is called with the context and narrative query objects passed in as separate functions. If it returns true then a positive result is forced, if false then a negative result is forced. If it returns any other value then no result is forced.

The condition function may also return a string as a second return value, which will be used for output.

1

string

Unique name amongst other declared narrative queries.

2

string

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

3

string

Message on which this narrative query should trigger. If multiple trigger messages are required a table containing string message names can be supplied here instead.

4

string

Message to trigger if the faction can capture territory. This can be a single string or a table of strings if multiple messages are desired.

5

string

optional, default value=nil

Message to trigger if the faction cannot capture territory. This can be a single string or a table of strings if multiple messages are desired.

6

string

optional, default value=nil

Faction key of a target faction which the subject should have an agreement with, from the factions database table. A table of string faction keys may be specified if more than one target faction is desired. In this case, the query passes if an agreement exists with any of the target factions in the list.

7

string

optional, default value=nil

Culture key of a target faction which the subject should have an agreement with, from the cultures database table. A table of string culture keys may be specified if more than one target culture is desired. In this case, the query passes if an agreement exists with a faction of any of the target cultures in the list.

8

string

optional, default value=nil

Subculture key of a target faction which the subject should have an agreement with, from the cultures_subcultures database table. A table of string subculture keys may be specified if more than one target subculture is desired. In this case, the query passes if an agreement exists with a faction of any of the target subcultures in the list.

9

function

optional, default value=nil

Additional condition function which can force a positive or negative result. If supplied, the function is called with the context and narrative query objects passed in as separate functions. If it returns true then a positive result is forced, if false then a negative result is forced. If it returns any other value then no result is forced.

The condition function may also return a string as a second return value, which will be used for output.

1

string

Unique name amongst other declared narrative queries.

2

string

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

3

string

Message on which this narrative query should trigger. If multiple trigger messages are required a table containing string message names can be supplied here instead.

4

string

Message to trigger if the faction can capture territory. This can be a single string or a table of strings if multiple messages are desired.

5

string

optional, default value=nil

Message to trigger if the faction cannot capture territory. This can be a single string or a table of strings if multiple messages are desired.

6

string

optional, default value=nil

Faction key of a target faction which the subject should have an agreement with, from the factions database table. A table of string faction keys may be specified if more than one target faction is desired. In this case, the query passes if an agreement exists with any of the target factions in the list.

7

string

optional, default value=nil

Culture key of a target faction which the subject should have an agreement with, from the cultures database table. A table of string culture keys may be specified if more than one target culture is desired. In this case, the query passes if an agreement exists with a faction of any of the target cultures in the list.

8

string

optional, default value=nil

Subculture key of a target faction which the subject should have an agreement with, from the cultures_subcultures database table. A table of string subculture keys may be specified if more than one target subculture is desired. In this case, the query passes if an agreement exists with a faction of any of the target subcultures in the list.

9

function

optional, default value=nil

Additional condition function which can force a positive or negative result. If supplied, the function is called with the context and narrative query objects passed in as separate functions. If it returns true then a positive result is forced, if false then a negative result is forced. If it returns any other value then no result is forced.

The condition function may also return a string as a second return value, which will be used for output.

1

string

Unique name amongst other declared narrative queries.

2

string

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

3

string

Message on which this narrative query should trigger. If multiple trigger messages are required a table containing string message names can be supplied here instead.

4

string

Message to trigger if the faction can capture territory. This can be a single string or a table of strings if multiple messages are desired.

5

string

optional, default value=nil

Message to trigger if the faction cannot capture territory. This can be a single string or a table of strings if multiple messages are desired.

6

string

Pooled resource key, from the pooled resources database table. If more than one pooled resource is to be queried then a table of strings may be specified here.

7

number

Threshold value, which the pooled resource should meet or exceed for the positive message to be triggered.

8

function

optional, default value=nil

Additional condition function which can force a positive or negative result. If supplied, the function is called with the context and narrative query objects passed in as separate functions. If it returns true then a positive result is forced, if false then a negative result is forced. If it returns any other value then no result is forced.

The condition function may also return a string as a second return value, which will be used for output.