Difference between revisions of "Scene Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>CraftySentinel
m (→‎Member Functions: Formatting Change)
imported>CraftySentinel
(→‎Member Functions: Reverted to List)
 
Line 20: Line 20:
== Member Functions ==
== Member Functions ==


{|class="wikitable" width =100%
:'''[[ForceStart - Scene|ForceStart]]()'''
!style="text-align:left;"|Function
:*Forces the scene to start playing and kills any other scenes running on actors this scene needs.
!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.
|-


|[[GetOwningQuest - Scene|Quest '''GetOwningQuest'''()]]
:'''Quest [[GetOwningQuest - Scene|GetOwningQuest]]()'''
|Returns the [[Quest Script|Quest]] that owns this scene.
:*Returns the [[Quest Script|Quest]] that owns this scene.
|-


|[[IsActionComplete - Scene|Bool '''IsActionComplete'''(Int ''aiActionID'')]]
:'''Bool [[IsActionComplete - Scene|IsActionComplete]](Int ''aiActionID'')'''
|Returns whether the specified action is complete or not.
:*Returns whether the specified action is complete or not.
|-


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


|[[Start - Scene|'''Start'''()]]
:'''[[Start - Scene|Start]]()'''
|Starts the scene.
:*Starts the scene.
|-


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