The Quest Script

No properties found.

• Found in:
  • Vanilla
  • SKSE

  eventOnStoryAddToPlayer(ObjectReferenceakOwner, ObjectReferenceakContainer, LocationakLocation, FormakItemBase, intaiAcquireType)

  Event called when this quest is started via an add to player story manager event.

• Found in:
  • Vanilla
  • SKSE

  eventOnStoryArrest(ObjectReferenceakArrestingGuard, ObjectReferenceakCriminal, LocationakLocation, intaiCrime)

  Event called when this quest is started via an arrest story manager event.

• Found in:
  • Vanilla
  • SKSE

  eventOnStoryAssaultActor(ObjectReferenceakVictim, ObjectReferenceakAttacker, LocationakLocation, intaiCrime)

  Event called when this quest is started via an assault actor story manager event.

• Found in:
  • Vanilla
  • SKSE

  eventOnStoryBribeNPC(ObjectReferenceakActor)

  Event called when this quest is started via a bribe NPC story manager event.

• Found in:
  • Vanilla
  • SKSE

  eventOnStoryCastMagic(ObjectReferenceakCastingActor, ObjectReferenceakSpellTarget, LocationakLocation, FormakSpell)

  Event called when this quest is started via a cast magic story manager event.

• Found in:
  • Vanilla
  • SKSE

  eventOnStoryChangeLocation(ObjectReferenceakActor, LocationakOldLocation, LocationakNewLocation)

  Event called when this quest is started via a change location story manager event.

• Found in:
  • Vanilla
  • SKSE

  eventOnStoryCrimeGold(ObjectReferenceakVictim, ObjectReferenceakCriminal, FormakFaction, intaiGoldAmount, intaiCrime)

  Event called when this quest is started via a crime gold story manager event.

• Found in:
  • Vanilla
  • SKSE

  eventOnStoryCure(FormakInfection)

  Event called when this quest is started via a cure story manager event.

• Found in:
  • Vanilla
  • SKSE

  eventOnStoryDialogue(LocationakLocation, ObjectReferenceakActor1, ObjectReferenceakActor2)

  Event called when this quest is started via a dialogue story manager event.

• Found in:
  • Vanilla
  • SKSE

  eventOnStoryDiscoverDeadBody(ObjectReferenceakActor, ObjectReferenceakDeadActor, LocationakLocation)

  Event called when this quest is started via a discover dead body story manager event.

• Found in:
  • Vanilla
  • SKSE

  eventOnStoryEscapeJail(LocationakLocation, FormakCrimeGroup)

  Event called when this quest is started via an escape jail story manager event.

• Found in:
  • Vanilla
  • SKSE

  eventOnStoryActivateActor(LocationakLocation, ObjectReferenceakActor)

  Event called when this quest is started via an activate actor story manager event.

• Found in:
  • Vanilla
  • SKSE

  eventOnStoryFlatterNPC(ObjectReferenceakActor)

  Event called when this quest is started via a flatter NPC story manager event.

• Found in:
  • Vanilla
  • SKSE

  eventOnStoryHello(LocationakLocation, ObjectReferenceakActor1, ObjectReferenceakActor2)

  Event called when this quest is started via a hello story manager event.

• Found in:
  • Vanilla
  • SKSE

  eventOnStoryIncreaseLevel(intaiNewLevel)

  Event called when this quest is started via an increase level story manager event.

• Found in:
  • Vanilla
  • SKSE

  eventOnStoryIncreaseSkill(stringasSkill)

  Event called when this quest is started via an increase level story manager event.

• Found in:
  • Vanilla
  • SKSE

  eventOnStoryInfection(ObjectReferenceakTransmittingActor, FormakInfection)

  Event called when this quest is started via an infection story manager event.

• Found in:
  • Vanilla
  • SKSE

  eventOnStoryIntimidateNPC(ObjectReferenceakActor)

  Event called when this quest is started via an intimidate NPC story manager event.

• Found in:
  • Vanilla
  • SKSE

  eventOnStoryJail(ObjectReferenceakGuard, FormakCrimeGroup, LocationakLocation, intaiCrimeGold)

  Event called when this quest is started via a jail story manager event.

• Found in:
  • Vanilla
  • SKSE

  eventOnStoryKillActor(ObjectReferenceakVictim, ObjectReferenceakKiller, LocationakLocation, intaiCrimeStatus, intaiRelationshipRank)

  Event called when this quest is started via a kill actor story manager event.

• Found in:
  • Vanilla
  • SKSE

  eventOnStoryCraftItem(ObjectReferenceakBench, LocationakLocation, FormakCreatedItem)

  Event called when this quest is started via a craft item story manager event.

• Found in:
  • Vanilla
  • SKSE

  eventOnStoryNewVoicePower(ObjectReferenceakActor, FormakVoicePower)

  Event called when this quest is started via a new voice power story manager event.

• Found in:
  • Vanilla
  • SKSE

  eventOnStoryPickLock(ObjectReferenceakActor, ObjectReferenceakLock)

  Event called when this quest is started via a pick lock story manager event.

• Found in:
  • Vanilla
  • SKSE

  eventOnStoryPayFine(ObjectReferenceakCriminal, ObjectReferenceakGuard, FormakCrimeGroup, intaiCrimeGold)

  Event called when this quest is started via a pay fine story manager event.

• Found in:
  • Vanilla
  • SKSE

  eventOnStoryPlayerGetsFavor(ObjectReferenceakActor)

  Event called when this quest is started via a player gets favor story manager event.

• Found in:
  • Vanilla
  • SKSE

  eventOnStoryRelationshipChange(ObjectReferenceakActor1, ObjectReferenceakActor2, intaiOldRelationship, intaiNewRelationship)

  Event called when this quest is started via a relationship change story manager event.

• Found in:
  • Vanilla
  • SKSE

  eventOnStoryRemoveFromPlayer(ObjectReferenceakOwner, ObjectReferenceakItem, LocationakLocation, FormakItemBase, intaiRemoveType)

  Event called when this quest is started via a remove from player story manager event.

• Found in:
  • Vanilla
  • SKSE

  eventOnStoryScript(KeywordakKeyword, LocationakLocation, ObjectReferenceakRef1, ObjectReferenceakRef2, intaiValue1, intaiValue2)

  Event called when this quest is started via a script story manager event.

• Found in:
  • Vanilla
  • SKSE

  eventOnStoryServedTime(LocationakLocation, FormakCrimeGroup, intaiCrimeGold, intaiDaysJail)

  Event called when this quest is started via a served time story manager event.

• Found in:
  • Vanilla
  • SKSE

  eventOnStoryTrespass(ObjectReferenceakVictim, ObjectReferenceakTrespasser, LocationakLocation, intaiCrime)

  Event called when this quest is started via a trespass story manager event.

• Found in:
  • Vanilla
  • SKSE

  boolfunctionModObjectiveGlobal(floatafModValue, GlobalVariableaModGlobal, intaiObjectiveID=-1, floatafTargetValue=-1, boolabCountingUp=true, boolabCompleteObjective=true, boolabRedisplayObjective=true)

  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.

• Found in:
  • Vanilla
  • SKSE

  voidfunctionCompleteAllObjectives()Native

  Flags all objectives on this quest as complete.

• Found in:
  • Vanilla
  • SKSE

  voidfunctionCompleteQuest()Native

  Flags this quest as completed.

• Found in:
  • Vanilla
  • SKSE

  voidfunctionFailAllObjectives()Native

  Flags all objectives on this quest as failed.

• Found in:
  • Vanilla
  • SKSE

  AliasfunctionGetAlias(intaiAliasID)Native

  Obtains the alias with the specified ID that is attached to this quest.

• Found in:
  • Vanilla
  • SKSE

  intfunctionGetCurrentStageID()Native

  Obtains the highest completed stage in this quest.

• Found in:
  • Vanilla
  • SKSE

  intfunctionGetStage()

  Obtains the highest completed stage in this quest.

• Found in:
  • Vanilla
  • SKSE

  boolfunctionGetStageDone(intaiStage)

  Obtains whether the specified quest stage is done or not.

  A stage is "done" if it has ever been visited with the Quest.SetCurrentStageID(...) or Quest.SetCurrentStageID(...) functions.

  GetStageDone is an alias for IsStageDone.

• Found in:
  • Vanilla
  • SKSE

  boolfunctionIsActive()Native

  Checks to see if this quest is active (currently tracked by the player).

• Found in:
  • Vanilla
  • SKSE

  boolfunctionIsCompleted()Native

  Checks to see if this quest is completed.

• Found in:
  • Vanilla
  • SKSE

  boolfunctionIsObjectiveCompleted(intaiObjective)Native

  Obtains whether the specified quest objective is completed or not.

• Found in:
  • Vanilla
  • SKSE

  boolfunctionIsObjectiveDisplayed(intaiObjective)Native

  Obtains whether the specified quest objective is displayed or not.

• Found in:
  • Vanilla
  • SKSE

  boolfunctionIsObjectiveFailed(intaiObjective)Native

  Obtains whether the specified quest objective is failed or not.

• Found in:
  • Vanilla
  • SKSE

  boolfunctionIsRunning()Native

  Checks to see if this quest is running or not.

• Found in:
  • Vanilla
  • SKSE

  boolfunctionIsStageDone(intaiStage)Native

  Obtains whether the specified quest stage is done or not.

  A stage is "done" if it has ever been visited with the Quest.SetCurrentStageID(...) or Quest.SetCurrentStageID(...) functions.

  GetStageDone is an alias for IsStageDone.

• Found in:
  • Vanilla
  • SKSE

  boolfunctionIsStarting()Native

  Checks to see if this quest is in the process of starting up.

• Found in:
  • Vanilla
  • SKSE

  boolfunctionIsStopping()Native

  Checks to see if the quest is not enabled anymore but still shutting down

• Found in:
  • Vanilla
  • SKSE

  boolfunctionIsStopped()Native

  Checks to see if the quest is no longer enabled or running

• Found in:
  • Vanilla
  • SKSE

  voidfunctionReset()Native

  Resets this quest.

• Found in:
  • Vanilla
  • SKSE

  voidfunctionSetActive(boolabActive=true)Native

  Flags this quest as active or not (tracked by the player).

• Found in:
  • Vanilla
  • SKSE

  boolfunctionSetCurrentStageID(intaiStageID)Native

  Attempts to set the quest's current stage. If the stage exists, and was successfully set, the function returns true. Otherwise, the function returns false and the stage is unchanged. Is latent and will wait for the quest to start if it has to start the quest. If the stage has any fragments attached to it, the function will also wait for those fragments to finish running before returning.

• Found in:
  • Vanilla
  • SKSE

  voidfunctionSetObjectiveCompleted(intaiObjective, boolabCompleted=true)Native

  Sets whether the specified quest objective is completed or not.

• Found in:
  • Vanilla
  • SKSE

  voidfunctionSetObjectiveDisplayed(intaiObjective, boolabDisplayed=true, boolabForce=false)Native

  Sets whether the specified quest objective is displayed or not.

• Found in:
  • Vanilla
  • SKSE

  voidfunctionSetObjectiveFailed(intaiObjective, boolabFailed=true)Native

  Sets whether the specified quest objective is failed or not.

  NOTE: This function does not work if called from a stage fragment script that is marked as "Complete Quest" or "Fail Quest".

• Found in:
  • Vanilla
  • SKSE

  boolfunctionSetStage(intaiStage)

  Attempts to set the quest's current stage. If the stage exists, and was successfully set, the function returns true. Otherwise, the function returns false and the stage is unchanged. Is latent and will wait for the quest to start if it has to start the quest. If the stage has any fragments attached to it, the function will also wait for those fragments to finish running before returning.

• Found in:
  • Vanilla
  • SKSE

  boolfunctionStart()Native

  Starts this quest. Is latent and will not return until the quest is actually started (and any start-up stage fragments run).

• Found in:
  • Vanilla
  • SKSE

  voidfunctionStop()Native

  Stops the quest.

• Found in:
  • Vanilla
  • SKSE

  boolfunctionUpdateCurrentInstanceGlobal(GlobalVariableaUpdateGlobal)Native

  Attempts to update the stored value of the given global in the instance data for the quest's current instance. The function only returns false on failure which can be caused by calling the function when there is no active instance on the quest or by passing a global not in the quest's text global list.

• Found in:
  • SKSE

  QuestfunctionGetQuest(stringeditorId)NativeGlobal

  Type: SKSE Global Function.

  Returns the quest of the specified editor id, or None if none match.

• Found in:
  • SKSE

  stringfunctionGetID()Native

  Type: SKSE Function.

  Returns the editor id of the Quest.

• Found in:
  • SKSE

  intfunctionGetPriority()Native

  Type: SKSE Function.

  Returns the quest's priority.

• Found in:
  • SKSE

  intfunctionGetNumAliases()Native

  returns the number of aliases associated with the quest

• Found in:
  • SKSE

  AliasfunctionGetNthAlias(intindex)Native

  Assuming the code below is a quest script getting it's own aliases.

  int idx  = self.GetNumAliases()
  while idx > 0
      idx -= 1
      Alias nthAlias = self.GetNthAlias(idx) as Alias
  
      ; LocationAlias or ReferenceAlias
      if nthAlias
          ; do stuff
      endIf
  endWhile
  

• Found in:
  • SKSE

  AliasfunctionGetAliasByName(stringname)Native

  Obtains the alias with the specified name that is attached to this quest. This is the name appearing in the Alias Name field of the Reference Alias form.

• Found in:
  • SKSE

  AliasfunctionGetAliasById(intaliasId)Native

  returns the alias by AlisID

• Found in:
  • SKSE

  Alias[]functionGetAliases()Native

  Returns all the aliases of this quest