Difference between revisions of "Scene Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Jlundin
 
imported>CraftySentinel
(→‎Member Functions: Reverted to List)
 
(2 intermediate revisions by 2 users not shown)
Line 19: Line 19:


== Member Functions ==
== Member Functions ==
*Function [[ForceStart - Scene|ForceStart]]()
 
**Forces the scene to start playing and kills any other scenes running on actors this scene needs.
:'''[[ForceStart - Scene|ForceStart]]()'''
*Quest Function [[GetOwningQuest - Scene|GetOwningQuest]]()
:*Forces the scene to start playing and kills any other scenes running on actors this scene needs.
**Returns the [[Quest Script|Quest]] that owns this scene.
 
*bool Function [[IsActionComplete - Scene|IsActionComplete]](int aiActionID)
:'''Quest [[GetOwningQuest - Scene|GetOwningQuest]]()'''
**Returns whether the specified action is complete or not.
:*Returns the [[Quest Script|Quest]] that owns this scene.
*bool Function [[IsPlaying - Scene|IsPlaying]]()
 
**Returns whether the scene is currently playing or not.
:'''Bool [[IsActionComplete - Scene|IsActionComplete]](Int ''aiActionID'')'''
*Function [[Start - Scene|Start]]()
:*Returns whether the specified action is complete or not.
**Starts the scene.
 
*Function [[Stop - Scene|Stop]]()
:'''Bool [[IsPlaying - Scene|IsPlaying]]()'''
**Stops the scene.
:*Returns whether the scene is currently playing or not.
 
:'''[[Start - Scene|Start]]()'''
:*Starts the scene.
 
:'''[[Stop - Scene|Stop]]()'''
:*Stops the scene.


== Events ==
== Events ==

Latest revision as of 21:55, 2 February 2014


Extends: Form Script

Script for the manipulation of scenes.

Definition[edit | edit source]

ScriptName Scene extends Form

Properties[edit | edit source]

None

Global Functions[edit | edit source]

None

Member Functions[edit | edit source]

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

Events[edit | edit source]

None

Related Fragments[edit | edit source]