Scene Script

Extends: Form Script

Script for the manipulation of scenes.

Definition

ScriptName Scene extends Form Native Hidden

Properties

None

Global Functions

None

Member Functions

• 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

• 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

• Scene Fragments
• Scene Phase Fragments
• Scene Timer Action Fragments