Difference between revisions of "Osiris/API/QuestIsSubquestEntry"

From Divinity Engine Wiki
Jump to: navigation, search
(Created page with "===== Full Definition(s) ===== * call '''QuestIsSubquestEntry'''('''[in]'''''(STRING)'''''_questID''', '''[in]'''''(STRING)'''''_stateID''', '''[out]'''''(INTEGER)'''''_bool''...")
 
m (call -> query, expanded explanation (Success/failure section needs verification))
Line 1: Line 1:
 
===== Full Definition(s) =====
 
===== Full Definition(s) =====
* call '''QuestIsSubquestEntry'''('''[in]'''''(STRING)'''''_questID''', '''[in]'''''(STRING)'''''_stateID''', '''[out]'''''(INTEGER)'''''_bool''')
+
* query '''QuestIsSubquestEntry'''('''''[in]'''(STRING)'''''_QuestID''', '''''[in]'''(STRING)'''''_StateID''', '''''[out]'''(INTEGER)'''''_Bool''')
 
===== Description =====
 
===== Description =====
Checks if quest state is from a subquest.
+
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''': Default return value.
 +
* '''_bool''': '''1''' if '''_StateID''' is belongs to a sub-quest, '''0''' otherwise.
 +
===== Notes =====
 +
* /
 +
===== See Also =====
 +
* [[Osiris/API/HasRecipeUnlockedWithIngredient|HasRecipeUnlockedWithIngredient]]
 +
* [[Osiris/API/UnlockJournalRecipe|UnlockJournalRecipe]]
 +
* [[Use_Action:Recipe]]
  
 
[[Category:Osiris Queries|QuestIsSubquestEntry]]
 
[[Category:Osiris Queries|QuestIsSubquestEntry]]
 
[[Category:Osiris Queries (Added in DOS2DE)|QuestIsSubquestEntry]]
 
[[Category:Osiris Queries (Added in DOS2DE)|QuestIsSubquestEntry]]

Revision as of 19:00, 19 September 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: Default return value.
  • _bool: 1 if _StateID is belongs to a sub-quest, 0 otherwise.
Notes
  • /
See Also