Difference between revisions of "Scene Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Jog
imported>CraftySentinel
(→‎Member Functions: Reverted to List)
 
(One intermediate revision by the same user 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.


'''Quest Function [[GetOwningQuest - Scene|GetOwningQuest]]()'''
:'''[[ForceStart - Scene|ForceStart]]()'''
*Returns the [[Quest Script|Quest]] that owns this scene.
:*Forces the scene to start playing and kills any other scenes running on actors this scene needs.


'''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]]()'''
:'''Bool [[IsActionComplete - Scene|IsActionComplete]](Int ''aiActionID'')'''
*Returns whether the scene is currently playing or not.
:*Returns whether the specified action is complete or not.


'''Function [[Start - Scene|Start]]()'''
:'''Bool [[IsPlaying - Scene|IsPlaying]]()'''
*Starts the scene.
:*Returns whether the scene is currently playing or not.


'''Function [[Stop - Scene|Stop]]()'''
:'''[[Start - Scene|Start]]()'''
*Stops the scene.
:*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]