The Quest Script

The Papyrus Index is still under construction. Structs have not been implemented yet.

No properties found.

• Found in:
  • Vanilla

  eventOnMissionAccepted()

  Event received when a mission-type quest is accepted via the mission board

• Found in:
  • Vanilla

  eventOnQuestInit()

  Event received when this quest has just started up - after aliases are filled, and at the same time as the quest startup stage is run.

• Found in:
  • Vanilla

  eventOnQuestShutdown()

  Event received when this quest is shut down. Aliases are cleared at this point.

• Found in:
  • Vanilla

  eventOnQuestStarted()

  Event received when the quest has been started

• Found in:
  • Vanilla

  eventOnQuestRejected()

  Event received when the quest is rejected

• Found in:
  • Vanilla

  eventOnQuestTimerStart(intaiReason)

  aiReason values for OnQuestTimer***** are 0=timer expired, 1=stage triggered, 2=script
  Event received when the quest timer has started

• Found in:
  • Vanilla

  eventOnQuestTimerEnd(intaiReason)

  Event received when the quest timer has ended

• Found in:
  • Vanilla

  eventOnQuestTimerPause(intaiReason)

  Event received when the quest timer has been paused

• Found in:
  • Vanilla

  eventOnQuestTimerResume(intaiReason)

  Event received when the quest timer has resumed

• Found in:
  • Vanilla

  eventOnQuestTimerMod(intaiReason)

  Event received when the quest timer has be modded

• Found in:
  • Vanilla

  eventOnReset()

  Event received when the quest owning this alias is reset

• Found in:
  • Vanilla

  eventOnStageSet(intauiStageID, intauiItemID)

  Event called when a quest stage is set.

• Found in:
  • Vanilla

  eventOnSpeechChallengeCompletion(SpeechChallengeObjectakSpeechChallenge, boolabSuccess)

  Event called when a speech challenge is completed (won or lost).

• Found in:
  • Vanilla

  eventOnStoryActivateActor(LocationakLocation, ObjectReferenceakActor)
• Found in:
  • Vanilla

  eventOnStoryActorAttach(ObjectReferenceakActor, LocationakLocation)
• Found in:
  • Vanilla

  eventOnStoryAddToPlayer(ObjectReferenceakOwner, ObjectReferenceakContainer, LocationakLocation, FormakItemBase, intaiAcquireType, intaiValue)
• Found in:
  • Vanilla

  eventOnStoryArrest(ObjectReferenceakArrestingGuard, ObjectReferenceakCriminal, LocationakLocation, intaiCrime)
• Found in:
  • Vanilla

  eventOnStoryAssaultActor(ObjectReferenceakVictim, ObjectReferenceakAttacker, LocationakLocation, boolabCrime)
• Found in:
  • Vanilla

  eventOnStoryAttractionObject(ObjectReferenceakActor, ObjectReferenceakObject, LocationakLocation, boolabCommanded)
• Found in:
  • Vanilla

  eventOnStoryBribeNPC(ObjectReferenceakActor, intaiAmount)
• Found in:
  • Vanilla

  eventOnStoryCastMagic(ObjectReferenceakCastingActor, ObjectReferenceakSpellTarget, LocationakLocation, FormakSpell)
• Found in:
  • Vanilla

  eventOnStoryChangeLocation(ObjectReferenceakActor, LocationakOldLocation, LocationakNewLocation)
• Found in:
  • Vanilla

  eventOnStoryExploredLocation(LocationakOldLocation)
• Found in:
  • Vanilla

  eventOnStoryCraftItem(ObjectReferenceakBench, LocationakLocation, FormakCreatedItem)
• Found in:
  • Vanilla

  eventOnStoryCrimeGold(ObjectReferenceakVictim, ObjectReferenceakCriminal, FormakFaction, intaiGoldAmount, intaiCrime)
• Found in:
  • Vanilla

  eventOnStoryCure(FormakInfection)
• Found in:
  • Vanilla

  eventOnStoryDialogue(LocationakLocation)
• Found in:
  • Vanilla

  eventOnStoryDiscoverDeadBody(ObjectReferenceakActor, ObjectReferenceakDeadActor, LocationakLocation)
• Found in:
  • Vanilla

  eventOnStoryEscapeJail(LocationakLocation, FormakCrimeGroup)
• Found in:
  • Vanilla

  eventOnStoryFlatterNPC(ObjectReferenceakActor)
• Found in:
  • Vanilla

  eventOnStoryHackTerminal(ObjectReferenceakComputer, boolabSucceeded)

  Sent when the player GUESSES in a terminal. This sends an event containing the terminal ref and the success of each guess input into the terminal.

  This event does not fire based on your success when you exit the terminal.

  Event OnStoryHackTerminal(ObjectReference akComputer, bool abSucceeded) 
      Debug.Trace("akComputer" + akComputer + " / Guess success: " + abSucceeded)
  EndEvent
  

• Found in:
  • Vanilla

  eventOnStoryHello(LocationakLocation, ObjectReferenceakActor1, ObjectReferenceakActor2)
• Found in:
  • Vanilla

  eventOnStoryIncreaseLevel(intaiNewLevel)

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

• Found in:
  • Vanilla

  eventOnStoryInfection(ObjectReferenceakTransmittingActor, FormakInfection)
• Found in:
  • Vanilla

  eventOnStoryIntimidateNPC(ObjectReferenceakActor)
• Found in:
  • Vanilla

  eventOnStoryIronSights(ObjectReferenceakActor, FormakWeapon)
• Found in:
  • Vanilla

  eventOnStoryJail(ObjectReferenceakGuard, FormakCrimeGroup, LocationakLocation, intaiCrimeGold)
• Found in:
  • Vanilla

  eventOnStoryKillActor(ObjectReferenceakVictim, ObjectReferenceakKiller, LocationakLocation, intaiCrimeStatus, intaiRelationshipRank)
• Found in:
  • Vanilla

  eventOnStoryLocationLoaded(LocationakLocation)
• Found in:
  • Vanilla

  eventOnStoryMineExplosion(ObjectReferenceakVictim, ObjectReferenceakAttacker)
• Found in:
  • Vanilla

  eventOnStoryNewVoicePower(ObjectReferenceakActor, FormakVoicePower)
• Found in:
  • Vanilla

  eventOnStoryPayFine(ObjectReferenceakCriminal, ObjectReferenceakGuard, FormakCrimeGroup, intaiCrimeGold)
• Found in:
  • Vanilla

  eventOnStoryPickLock(ObjectReferenceakActor, ObjectReferenceakLock, boolabCrime)
• Found in:
  • Vanilla

  eventOnStoryPickPocket(ObjectReferenceakVictim, boolabSuccess)
• Found in:
  • Vanilla

  eventOnStoryPiracyActor(ObjectReferenceakVictim, ObjectReferenceakAttacker, LocationakLocation, boolabCrime)
• Found in:
  • Vanilla

  eventOnStoryPlayerGetsFavor(ObjectReferenceakActor)
• Found in:
  • Vanilla

  eventOnStoryRelationshipChange(ObjectReferenceakActor1, ObjectReferenceakActor2, intaiOldRelationship, intaiNewRelationship)
• Found in:
  • Vanilla

  eventOnStoryRemoveFromPlayer(ObjectReferenceakOwner, ObjectReferenceakItem, LocationakLocation, FormakItemBase, intaiRemoveType, intaiValue)
• Found in:
  • Vanilla

  eventOnStoryScript(KeywordakKeyword, LocationakLocation, ObjectReferenceakRef1, ObjectReferenceakRef2, intaiValue1, intaiValue2)
• Found in:
  • Vanilla

  eventOnStoryServedTime(LocationakLocation, FormakCrimeGroup, intaiCrimeGold, intaiDaysJail)
• Found in:
  • Vanilla

  eventOnStoryShipDock(ObjectReferenceakDockingShip, ObjectReferenceakDockTargetShip, boolabDocking)
• Found in:
  • Vanilla

  eventOnStoryShipLanding(ObjectReferenceakLandingShip, ObjectReferenceakLandingMarker)
• Found in:
  • Vanilla

  eventOnStorySpeechChallengeCompletion(SpeechChallengeObjectakChallenge, boolabSuccess)
• Found in:
  • Vanilla

  eventOnStoryTrespass(ObjectReferenceakVictim, ObjectReferenceakTrespasser, LocationakLocation, boolabCrime)

• Found in:
  • Vanilla

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

  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

  voidfunctionSetAllStages(intlastStage)

  kmk- for testing - sets all stages up to lastStage

• Found in:
  • Vanilla

  voidfunctionSetQuestStage(Quest:QuestStagequestStageToSet)Global

  Sets the quest stage on the specified quest.

• Found in:
  • Vanilla

  boolfunctionGetQuestStageDone(Quest:QuestStagequestStageToCheck)Global

  Returns whether the specified quest stage is set.

• Found in:
  • Vanilla

  voidfunctionSetObjectiveSkipped(intaiObjectiveID)

  Sets the specified objective as skipped (hidden in this case, if it wasn't completed)

• Found in:
  • Vanilla

  voidfunctionSetObjectiveActive(intaiObjective, boolabForceRedisplay=true)

  jduvall - convenience function - uncompletes, unfails and displays the objective

• Found in:
  • Vanilla

  voidfunctionCompleteAllObjectives()Native

  Flags all objectives on this quest as complete.

• Found in:
  • Vanilla

  voidfunctionCompleteQuest()Native

  Flags this quest as completed.

• Found in:
  • Vanilla

  voidfunctionFailAllObjectives()Native

  Flags all objectives on this quest as failed.

• Found in:
  • Vanilla

  AliasfunctionGetAlias(intaiAliasID)Native

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

• Found in:
  • Vanilla

  intfunctionGetCurrentStageID()Native

  Obtains the highest completed stage in this Quest.

• Found in:
  • Vanilla

  ObjectReference[]functionGetCurrentStageTargets()Native

  Returns the array of object reference targets pertinent to the current quest stage

• Found in:
  • Vanilla

  intfunctionGetStage()

  Obtains the highest completed stage in this Quest.

• Found in:
  • Vanilla

  floatfunctionGetQuestTimeRemaining()Native

  gets the remaining time for the quest timer if any

• Found in:
  • Vanilla

  boolfunctionGetStageDone(intaiStage)

  Obtains whether the specified stage is done or not.

• Found in:
  • Vanilla

  boolfunctionHasObjective(intaiObjective)Native

  Returns whether or not the quest has the given objective.

• Found in:
  • Vanilla

  boolfunctionIsActive()Native

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

• Found in:
  • Vanilla

  boolfunctionIsCompleted()Native

  Checks to see if this quest is completed.

• Found in:
  • Vanilla

  boolfunctionIsObjectiveCompleted(intaiObjective)Native

  Obtains whether the specified quest objective is completed or not.

• Found in:
  • Vanilla

  boolfunctionIsObjectiveDisplayed(intaiObjective)Native

  Obtains whether the specified quest objective is displayed or not.

• Found in:
  • Vanilla

  boolfunctionIsObjectiveFailed(intaiObjective)Native

  Obtains whether the specified quest objective is failed or not.

• Found in:
  • Vanilla

  voidfunctionSetObjectiveDisplayedAtTop(intaiObjective)Native

  Sets the specified objective to be displayed at the top of the player's objective list

• Found in:
  • Vanilla

  boolfunctionIsQuestTimerPaused()Native

  Checks if the quest timer is paused; returns true if paused otherwise false which means the timer is running

• Found in:
  • Vanilla

  boolfunctionIsRunning()Native

  Checks to see if this quest is running or not.

• Found in:
  • Vanilla

  boolfunctionIsStageDone(intaiStage)Native

  Obtains whether the specified stage is done or not.

• Found in:
  • Vanilla

  boolfunctionIsStarting()Native

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

• Found in:
  • Vanilla

  boolfunctionIsStopping()Native

  Checks to see if this quest is in the process of shutting down.

• Found in:
  • Vanilla

  boolfunctionIsStopped()Native

  Checks to see if this quest is completely stopped.

• Found in:
  • Vanilla

  voidfunctionModQuestTimer(floatafModValue)Native

  Modifies a quest timer
  The timer is modified by the given afModValue can be negative or positive but not 0

• Found in:
  • Vanilla

  voidfunctionPauseQuestTimer(boolabPause=true)Native

  Pauses the quest timer if abPause is true, resumes it if false. If the timer was already in the requested state nothing happens.

• Found in:
  • Vanilla

  voidfunctionRemoveRequestedPCMQuestLocations()Native

  Removes PCM locations requested by this quest.

• Found in:
  • Vanilla

  voidfunctionReset()Native

  Resets this quest.

• Found in:
  • Vanilla

  voidfunctionSetActive(boolabActive=true)Native

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

• Found in:
  • Vanilla

  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

  voidfunctionSetObjectiveCompleted(intaiObjective, boolabCompleted=true)Native

  Sets whether the specified quest objective is completed or not.

• Found in:
  • Vanilla

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

  Sets whether the specified quest objective is displayed or not.

• Found in:
  • Vanilla

  voidfunctionSetObjectiveFailed(intaiObjective, boolabFailed=true)Native

  Sets whether the specified quest objective is failed or not.

• Found in:
  • Vanilla

  voidfunctionSetObjectiveFailedIfNotCompleted(intaiObjective)

  jduvall - convenience function
  fails the objective if it's not completed

• Found in:
  • Vanilla

  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

  voidfunctionSetStageNoWait(intaiStage)Native

  Sets the quest to the requested stage. Will NOT wait for the quest to start up, or for fragments to run. As such, it cannot return whether
  the stage was set or not, unlike SetStage or SetCurrentStageID

• Found in:
  • Vanilla

  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

  boolfunctionStartNoWait()Native

  Starts the quest - returns whether the quest was able to be started or not
  This function does not wait for aliases to fill or fragments to run and returns immediately

• Found in:
  • Vanilla

  voidfunctionStartQuestTimer(floatafTimeInHours=-1)Native

  Starts this quests timer with the given time or the time saved on the quest itself if none was given.
  Will reset the timer with the new time if the timer was running.

• Found in:
  • Vanilla

  voidfunctionStop()Native

  Stops the quest.

• Found in:
  • Vanilla

  voidfunctionStopQuestTimer()Native

  stop the running quest timer
  Will trigger OnQuestTimerEnd

• Found in:
  • Vanilla

  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.