Difference between revisions of "Scene Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Jlundin
 
imported>Jog
Line 19: Line 19:


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


== Events ==
== Events ==

Revision as of 13:04, 20 February 2012


Extends: Form Script

Script for the manipulation of scenes.

Definition

ScriptName Scene extends Form

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 Start()

  • Starts the scene.

Function Stop()

  • Stops the scene.

Events

None

Related Fragments