Difference between revisions of "Scene Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Jog
imported>CraftySentinel
m (→‎Member Functions: Formatting Change)
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]]()'''
{|class="wikitable" width =100%
*Returns the [[Quest Script|Quest]] that owns this scene.
!style="text-align:left;"|Function
!style="text-align:left;"|Description
|-
|[[ForceStart - Scene|'''ForceStart'''()]]
|Forces the scene to start playing and kills any other scenes running on actors this scene needs.
|-


'''bool Function [[IsActionComplete - Scene|IsActionComplete]](int aiActionID)'''
|[[GetOwningQuest - Scene|Quest '''GetOwningQuest'''()]]
*Returns whether the specified action is complete or not.
|Returns the [[Quest Script|Quest]] that owns this scene.
|-


'''bool Function [[IsPlaying - Scene|IsPlaying]]()'''
|[[IsActionComplete - Scene|Bool '''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]]()'''
|[[IsPlaying - Scene|Bool '''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 ==

Revision as of 05:25, 24 October 2013


Extends: Form Script

Script for the manipulation of scenes.

Definition

ScriptName Scene extends Form

Properties

None

Global Functions

None

Member Functions

Function Description
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

None

Related Fragments