CreateDefeatCondition

comment

Creates a defeat condition globally displayed for every enabled quest above the description text field of the quest menu.

note

Defeat conditions tell players what conditions would warrant a defeat. Note that this function will only display text. To put the condition in effect, you would need additional triggering (i.e. registering when a unit dies to end the game). This updates all quests with the list of defeat condition descriptions. To actually set the text use DefeatConditionSetDescription.

note

Each defeat condition has a hyphen "-" symbol prepended.

note

Defeat conditions share the text field with quest items (see QuestCreateItem), but they are rendered below quest items, regardless if they were created earlier than the items.

note

Defeat conditions are rendered in the order in which they were created.

note

The defeat condition will only be rendered after the quest is reselected, the quest menu is re-opened, or when an update is forced (see ForceQuestDialogUpdate).

patch

1.00

Source

common.j (raise an issue to discuss on Github or submit a PR)

return type

defeatcondition

Source code

native CreateDefeatCondition            takes nothing returns defeatcondition