Difference between revisions of "Quest Script"
→Events: see OnReset
imported>Jog (→Events) |
imported>SarthesArai |
||
(7 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
'''Extends:''' [[Form Script]] | '''Extends:''' [[Form Script]] | ||
Line 12: | Line 8: | ||
</source> | </source> | ||
== | == Member Functions == | ||
:'''[[CompleteAllObjectives - Quest|CompleteAllObjectives]]()''' | |||
:*Completes all a quests objectives. | |||
:'''[[CompleteQuest - Quest|CompleteQuest]]()''' | |||
''' | :*Flags this quest as completed. | ||
* | |||
:'''[[FailAllObjectives - Quest|FailAllObjectives]]()''' | |||
:*Flags all quest objects as failed. | |||
:'''Alias [[GetAlias - Quest|GetAlias]](Int ''aiAliasID'')''' | |||
:*Obtains the [[Alias Script|Alias]] attached to this quest associated with the specified ID. | |||
:'''Int [[GetCurrentStageID - Quest|GetCurrentStageID]]()''' | |||
:*Obtains the highest completed stage on this quest. | |||
:'''Int [[GetStage - Quest|GetStage]]()''' | |||
:*Alias for GetCurrentStageID(). | |||
:'''Bool [[GetStageDone - Quest|GetStageDone]](Int ''aiStage'')''' | |||
:*Alias for IsStageDone(). | |||
:'''Bool [[IsActive - Quest|IsActive]]()''' | |||
:*Is this quest "active"? (Tracked by the player). | |||
:'''Bool [[IsCompleted - Quest|IsCompleted]]()''' | |||
:*Returns whether this quest is completed or not. | |||
:'''Bool [[IsObjectiveCompleted - Quest|IsObjectiveCompleted]](Int ''aiObjective'')''' | |||
:*Obtains whether the specified objective is completed or not. | |||
:'''Bool [[IsObjectiveDisplayed - Quest|IsObjectiveDisplayed]](Int ''aiObjective'')''' | |||
:*Obtains whether the specified objective is displayed or not. | |||
''' | :'''Bool [[IsObjectiveFailed - Quest|IsObjectiveFailed]](Int ''aiObjective'')''' | ||
* | :*Obtains whether the specified objective is failed or not. | ||
''' | :'''Bool [[IsRunning - Quest|IsRunning]]()''' | ||
* | :*Returns whether this quest is currently running or not. | ||
''' | :'''Bool [[IsStageDone - Quest|IsStageDone]](Int ''aiStage'')''' | ||
* | :*Checks to see if the specified stage is done or not. | ||
''' | :'''Bool [[IsStarting - Quest|IsStarting]]()''' | ||
* | :*Returns whether this quest is currently enabled but not running yet. | ||
''' | :'''Bool [[IsStopping- Quest|IsStopping]]()''' | ||
* | :*Returns whether this quest is currently not enabled anymore but still shutting down. | ||
''' | :'''Bool [[IsStopped- Quest|IsStopped]]()''' | ||
* | :*Returns whether this quest is currently fully stopped. | ||
''' | :'''Bool [[ModObjectiveGlobal - Quest|ModObjectiveGlobal]](Float ''afModValue'', GlobalVariable ''aModGlobal'', Int ''aiObjectiveID'', Float ''afTargetValue'', Bool ''abCountingUp'', Bool ''abCompleteObjective'', Bool ''abRedisplayObjective'')''' | ||
* | :*Mods a global variable in a threadsafe way. Optional parameters allow automatic redisplay and completion (or failure) of a quest objective using this global variable. | ||
''' | :'''[[Reset - Quest|Reset]]()''' | ||
* | :*Resets this quest. | ||
''' | :'''[[SetActive - Quest|SetActive]](Bool ''abActive'')''' | ||
* | :*Sets or clears this quest as "active". (Tracked by the player) | ||
''' | :'''Bool [[SetCurrentStageID - Quest|SetCurrentStageID]](Int ''aiStageID'')''' | ||
* | :*Sets the quest to the requested stage, returning true if it succeeded. | ||
''' | :'''[[SetObjectiveCompleted - Quest|SetObjectiveCompleted]](Int ''aiObjective'', Bool ''abCompleted'')''' | ||
* | :*Sets whether the specified objective is completed or not. | ||
''' | :'''[[SetObjectiveDisplayed - Quest|SetObjectiveDisplayed]](Int ''aiObjective'', Bool ''abDisplayed'')''' | ||
* | :*Sets whether the specified objective is displayed or not. | ||
''' | :'''[[SetObjectiveFailed - Quest|SetObjectiveFailed]](Int ''aiObjective'', Bool ''abFailed'')''' | ||
* | :*Sets whether the specified objective is failed or not. | ||
''' | :'''Bool [[SetCurrentStageID - Quest|SetStage]](Int ''aiStage'')''' | ||
* | :*Alias of SetCurrentStageID(). | ||
''' | :'''Bool [[Start - Quest|Start]]()''' | ||
* | :*Starts this quest. | ||
''' | :'''[[Stop - Quest|Stop]]()''' | ||
* | :*Stops the quest. | ||
''' | :'''Bool [[UpdateCurrentInstanceGlobal - Quest|UpdateCurrentInstanceGlobal]](GlobalVariable ''aUpdateGlobal'')''' | ||
* | :*Updates the value for the given global for the quest's current instance. | ||
== SKSE Global Functions == | |||
''' | :'''Quest [[GetQuest - Quest|GetQuest]](String ''editorID'')''' | ||
* | :*Returns the Quest with the specified editor id. | ||
== SKSE Functions == | |||
''' | :'''String [[GetID - Quest|GetID]]()''' | ||
* | :*Returns the editor ID of the Quest. | ||
''' | :'''Int [[GetPriority - Quest|GetPriority]]()''' | ||
* | :*Returns the priority of the Quest. | ||
''' | :'''Int [[GetNumAliases - Quest|GetNumAliases]]()''' | ||
* | :*Returns the number of aliases associated with the Quest. | ||
''' | :'''Alias [[GetNthAlias - Quest|GetNthAlias]](Int ''index'')''' | ||
* | :*Returns the specified alias associated with the Quest. | ||
''' | :'''Alias [[GetAliasByName - Quest|GetAliasByName]](String ''name'')''' | ||
* | :*Returns the specified alias associated with the Quest. | ||
== Events == | == Events == | ||
:'''[[OnStoryActivateActor - Quest|OnStoryActivateActor]](Location ''akLocation'', ObjectReference ''akActor'')''' | |||
'' | :*Sent when this quest is started by an activate actor story manager event. | ||
*Sent when this quest is started by an activate actor story manager event. | |||
''' | :'''[[OnStoryAddToPlayer - Quest|OnStoryAddToPlayer]](ObjectReference ''akOwner'', ObjectReference ''akContainer'', Location ''akLocation'', Form ''akItemBase'', Int ''aiAcquireType'')''' | ||
*Sent when this quest is started by an add to player story manager event. | :*Sent when this quest is started by an add to player story manager event. | ||
''' | :'''[[OnStoryArrest - Quest|OnStoryArrest]](ObjectReference ''akArrestingGuard'', ObjectReference ''akCriminal'', Location ''akLocation'', Int ''aiCrime'')''' | ||
*Sent when this quest is started by an arrest story manager event. | :*Sent when this quest is started by an arrest story manager event. | ||
''' | :'''[[OnStoryAssaultActor - Quest|OnStoryAssaultActor]](ObjectReference ''akVictim'', ObjectReference ''akAttacker'', Location ''akLocation'', Int ''aiCrime'')''' | ||
*Sent when this quest is started by an assault actor story manager event. | :*Sent when this quest is started by an assault actor story manager event. | ||
''' | :'''[[OnStoryBribeNPC - Quest|OnStoryBribeNPC]](ObjectReference ''akActor'')''' | ||
*Sent when this quest is started by a bribe NPC story manager event. | :*Sent when this quest is started by a bribe NPC story manager event. | ||
''' | :'''[[OnStoryCastMagic - Quest|OnStoryCastMagic]](ObjectReference ''akCastingActor'', ObjectReference ''akSpellTarget'', Location ''akLocation'', Form ''akSpell'')''' | ||
*Sent when this quest is started by a cast magic story manager event. | :*Sent when this quest is started by a cast magic story manager event. | ||
''' | :'''[[OnStoryChangeLocation - Quest|OnStoryChangeLocation]](ObjectReference ''akActor'', Location ''akOldLocation'', Location ''akNewLocation'')''' | ||
*Sent when this quest is started by a change location story manager event. | :*Sent when this quest is started by a change location story manager event. | ||
''' | :'''[[OnStoryCraftItem - Quest|OnStoryCraftItem]](ObjectReference ''akBench'', Location ''akLocation'', Form ''akCreatedItem'')''' | ||
*Sent when this quest is started by a craft item story manager event. | :*Sent when this quest is started by a craft item story manager event. | ||
''' | :'''[[OnStoryCrimeGold - Quest|OnStoryCrimeGold]](ObjectReference ''akVictim'', ObjectReference ''akCriminal'', Faction ''akFaction'', Int ''aiGoldAmount'', Int ''aiCrime'')''' | ||
*Sent when this quest is started by a crime gold story manager event. | :*Sent when this quest is started by a crime gold story manager event. | ||
''' | :'''[[OnStoryCure - Quest|OnStoryCure]](Form ''akInfection'')''' | ||
*Sent when this quest is started by a cure story manager event. | :*Sent when this quest is started by a cure story manager event. | ||
''' | :'''[[OnStoryDialogue - Quest|OnStoryDialogue]](Location ''akLocation'', ObjectReference ''akActor1'', ObjectReference ''akActor2'')''' | ||
*Sent when this quest is started by a dialogue story manager event. | :*Sent when this quest is started by a dialogue story manager event. | ||
''' | :'''[[OnStoryDiscoverDeadBody - Quest|OnStoryDiscoverDeadBody]](ObjectReference ''akActor'', ObjectReference ''akDeadActor'', Location ''akLocation'')''' | ||
*Sent when this quest is started by a discover dead body story manager event. | :*Sent when this quest is started by a discover dead body story manager event. | ||
''' | :'''[[OnStoryEscapeJail - Quest|OnStoryEscapeJail]](Location ''akLocation'', Form ''akCrimeGroup'')''' | ||
*Sent when this quest is started by an escape jail story manager event. | :*Sent when this quest is started by an escape jail story manager event. | ||
''' | :'''[[OnStoryFlatterNPC - Quest|OnStoryFlatterNPC]](ObjectReference ''akActor'')''' | ||
*Sent when this quest is started by a flatter NPC story manager event. | :*Sent when this quest is started by a flatter NPC story manager event. | ||
''' | :'''[[OnStoryHello - Quest|OnStoryHello]](Location ''akLocation'', ObjectReference ''akActor1'', ObjectReference ''akActor2'')''' | ||
*Sent when this quest is started by a hello story manager event. | :*Sent when this quest is started by a hello story manager event. | ||
''' | :'''[[OnStoryIncreaseLevel - Quest|OnStoryIncreaseLevel]](Int ''aiNewLevel'')''' | ||
*Sent when this quest is started by an increase level story manager event. | :*Sent when this quest is started by an increase level story manager event. | ||
''' | :'''[[OnStoryIncreaseSkill - Quest|OnStoryIncreaseSkill]](String ''asSkill'')''' | ||
*Sent when this quest is started by an increase skill story manager event. | :*Sent when this quest is started by an increase skill story manager event. | ||
''' | :'''[[OnStoryInfection - Quest|OnStoryInfection]](ObjectReference ''akTransmittingActor'', Form ''akInfection'')''' | ||
*Sent when this quest is started by an infection story manager event. | :*Sent when this quest is started by an infection story manager event. | ||
''' | :'''[[OnStoryIntimidateNPC - Quest|OnStoryIntimidateNPC]](ObjectReference ''akActor'')''' | ||
*Sent when this quest is started by an intimidate NPC story manager event. | :*Sent when this quest is started by an intimidate NPC story manager event. | ||
''' | :'''[[OnStoryJail - Quest|OnStoryJail]](ObjectReference ''akGuard'', Form ''akCrimeGroup'', Location ''akLocation'', Int ''aiCrimeGold'')''' | ||
*Sent when this quest is started by a jail story manager event. | :*Sent when this quest is started by a jail story manager event. | ||
''' | :'''[[OnStoryKillActor - Quest|OnStoryKillActor]](ObjectReference ''akVictim'', ObjectReference ''akKiller'', Location ''akLocation'', Int ''aiCrimeStatus'', Int ''aiRelationshipRank'')''' | ||
*Sent when this quest is started by a kill actor story manager event. | :*Sent when this quest is started by a kill actor story manager event. | ||
''' | :'''[[OnStoryNewVoicePower - Quest|OnStoryNewVoicePower]](ObjectReference ''akActor'', Form ''akVoicePower'')''' | ||
*Sent when this quest is started by a new voice power story manager event. | :*Sent when this quest is started by a new voice power story manager event. | ||
''' | :'''[[OnStoryPickLock - Quest|OnStoryPickLock]](ObjectReference ''akActor'', ObjectReference ''akLock'')''' | ||
*Sent when this quest is started by a pick lock story manager event. | :*Sent when this quest is started by a pick lock story manager event. | ||
''' | :'''[[OnStoryPayFine - Quest|OnStoryPayFine]](ObjectReference ''akCriminal'', ObjectReference ''akGuard'', Form ''akCrimeGroup'', Int ''aiCrimeGold'')''' | ||
*Sent when this quest is started by a pay fine story manager event. | :*Sent when this quest is started by a pay fine story manager event. | ||
''' | :'''[[OnStoryPlayerGetsFavor - Quest|OnStoryPlayerGetsFavor]](ObjectReference ''akActor'')''' | ||
*Sent when this quest is started by a player gets favor story manager event. | :*Sent when this quest is started by a player gets favor story manager event. | ||
''' | :'''[[OnStoryRelationshipChange - Quest|OnStoryRelationshipChange]](ObjectReference ''akActor1'', ObjectReference ''akActor2'', Int ''aiOldRelationship'', Int ''aiNewRelationship'')''' | ||
*Sent when this quest is started by a relationship change story manager event. | :*Sent when this quest is started by a relationship change story manager event. | ||
''' | :'''[[OnStoryRemoveFromPlayer - Quest|OnStoryRemoveFromPlayer]](ObjectReference ''akOwner'', ObjectReference ''akItem'', Location ''akLocation'', Form ''akItembase'', Int ''aiRemoveType'')''' | ||
*Sent when this quest is started by a remove from player story manager event. | :*Sent when this quest is started by a remove from player story manager event. | ||
''' | :'''[[OnStoryScript - Quest|OnStoryScript]](Keyword ''akKeyword'', Location ''akLocation'', ObjectReference ''akRef1'', ObjectReference ''akRef2'', Int ''aiValue1'', Int ''aiValue2'')''' | ||
*Sent when this quest is started by a script story manager event. | :*Sent when this quest is started by a script story manager event. | ||
''' | :'''[[OnStoryServedTime - Quest|OnStoryServedTime]](Location ''akLocation'', Form ''akCrimeGroup'', Int ''aiCrimeGold'', Int ''aiDaysJail'')''' | ||
*Sent when this quest is started by a served time story manager event. | :*Sent when this quest is started by a served time story manager event. | ||
''' | :'''[[OnStoryTrespass - Quest|OnStoryTrespass]](ObjectReference ''akVictim'', ObjectReference ''akTrespasser'', Location ''akLocation'', Int ''aiCrime'')''' | ||
*Sent when this quest is started by a trespass story manager event. | :*Sent when this quest is started by a trespass story manager event. | ||
== Related Fragments == | == Related Fragments == | ||
*[[Quest Stage Fragments]] | *[[Quest Stage Fragments]] | ||
[[Category:Scripting]] | |||
[[Category:Papyrus]] | |||
[[Category:Script Objects]] |