Scene Script

From the Fallout4 CreationKit Wiki
(Redirected from Scene Script (Papyrus))
Jump to navigation Jump to search


Extends: Form Script

Script for the manipulation of scenes.

Definition[edit | edit source]

ScriptName Scene extends Form Native Hidden

Properties[edit | edit source]

None

Global Functions[edit | edit source]

None

Member Functions[edit | edit source]

  • Function ForceStart()
    • Forces the scene to start playing and kills any other scenes running on actors this scene needs.
  • Quest Function GetOwningQuest()
    • Returns the Quest that owns this scene.
  • bool Function IsActionComplete(int aiActionID)
    • Returns whether the specified action is complete or not.
  • bool Function IsPlaying()
    • Returns whether the scene is currently playing or not.
  • Function Pause(bool abPause)
    • Pauses or unpauses the scene.
  • Function Start()
    • Starts the scene.
  • Function Stop()
    • Stops the scene.

Events[edit | edit source]

  • Event OnAction(int auiActionID, ReferenceAlias akAlias)
    • Event received when a timer action fires off on this scene (in parallel with the fragment)
  • Event OnBegin()
    • Event received when this scene begins (in parallel with the fragment)
  • Event OnEnd()
    • Event received when this scene ends (in parallel with the fragment)
  • Event OnPhaseBegin(int auiPhaseIndex)
    • Event received when a scene phase begins (in parallel with the fragment)
  • Event OnPhaseEnd(int auiPhaseIndex)
    • Event received when a scene phase ends (in parallel with the fragment)

Related Fragments[edit | edit source]