Difference between revisions of "Osiris/API/QuestIsSubquestEntry"
From Divinity Engine Wiki
m (call -> query, expanded explanation (Success/failure section needs verification)) |
m (Documented "always fails" conditions) |
||
| Line 2: | Line 2: | ||
* query '''QuestIsSubquestEntry'''('''''[in]'''(STRING)'''''_QuestID''', '''''[in]'''(STRING)'''''_StateID''', '''''[out]'''(INTEGER)'''''_Bool''') | * query '''QuestIsSubquestEntry'''('''''[in]'''(STRING)'''''_QuestID''', '''''[in]'''(STRING)'''''_StateID''', '''''[out]'''(INTEGER)'''''_Bool''') | ||
===== Description ===== | ===== Description ===== | ||
| − | In DOS2:DE, a quest can have sub-quests. You create a sub-quest by creating a new (top-level) quest with a particular identifier, but without quest updates. Next, you can add quest updates to this sub-quest by filling in the '''SubQuests''' entry of a '''Quest State''' in the journal editor. This will also make that sub-quest a sub-quest of quest yo which the '''Quest State'' belongs. This query can be used to determine whether or not a particular quest state is from a sub-quest. | + | In DOS2:DE, a quest can have sub-quests. You create a sub-quest by creating a new (top-level) quest with a particular identifier, but without quest updates. Next, you can add quest updates to this sub-quest by filling in the '''SubQuests''' entry of a '''Quest State''' in the journal editor. This will also make that sub-quest a sub-quest of quest yo which the '''Quest State''' belongs. This query can be used to determine whether or not a particular quest state is from a sub-quest. |
===== Return Values ===== | ===== Return Values ===== | ||
| − | * '''Success/Failure''': | + | * '''Success/Failure''': Fails if there is no quest with name '''_QuestID''' or if it has not quest state with the name '''_StateID'''. |
* '''_bool''': '''1''' if '''_StateID''' is belongs to a sub-quest, '''0''' otherwise. | * '''_bool''': '''1''' if '''_StateID''' is belongs to a sub-quest, '''0''' otherwise. | ||
===== Notes ===== | ===== Notes ===== | ||
Latest revision as of 13:12, 8 October 2018
Full Definition(s)
- query QuestIsSubquestEntry([in](STRING)_QuestID, [in](STRING)_StateID, [out](INTEGER)_Bool)
Description
In DOS2:DE, a quest can have sub-quests. You create a sub-quest by creating a new (top-level) quest with a particular identifier, but without quest updates. Next, you can add quest updates to this sub-quest by filling in the SubQuests entry of a Quest State in the journal editor. This will also make that sub-quest a sub-quest of quest yo which the Quest State belongs. This query can be used to determine whether or not a particular quest state is from a sub-quest.
Return Values
- Success/Failure: Fails if there is no quest with name _QuestID or if it has not quest state with the name _StateID.
- _bool: 1 if _StateID is belongs to a sub-quest, 0 otherwise.
Notes
- /
