C# Class Cutscene, silverscreen

Inheritance: MonoBehaviour
Mostrar archivo Open project: mminer/silverscreen Class Usage Examples

Public Properties

Property Type Description
duration float
inPoint float
outPoint float
player GameObject
stopPlayer bool
subtitlePosition Rect
subtitleStyle GUIStyle

Public Methods

Method Description
AddTrack ( Cutscene, type ) : CutsceneTrack,

Attaches a new track component to the cutscene.

DisableAudio ( ) : void

Keeps all child audio sources from playing once the game starts.

DisableCameras ( ) : void

Turns off all child cameras so that they don't display before the cutscene starts.

DisableOtherCameras ( Camera exemptCam ) : void

Turns off all child cameras except for the one specified.

NewActor ( AnimationClip anim, GameObject go ) : CutsceneActor

Creates a new CutsceneActor object and attaches it to a new game object as a child of the Shots game object.

NewAudio ( AudioClip clip ) : CutsceneAudio

Creates a new CutsceneAudio object and attaches it to a new game object as a child of the Audio game object.

NewShot ( ) : CutsceneShot

Creates a new CutsceneShot object and attaches it to a new game object as a child of the Shots game object.

NewSubtitle ( string dialog ) : CutsceneSubtitle

Creates a new CutsceneSubtitle object and attaches it to the Subtitles game object.

OnDrawGizmos ( ) : void

Visually shows the cutscene in the scene view.

OnGUI ( ) : void
PauseCutscene ( ) : void

Pauses the cutscene.

PlayActor ( CutsceneClip clip ) : void

Plays the specified actor.

PlayAudio ( CutsceneClip clip ) : void

Plays the specified audio.

PlayCutscene ( ) : void

Starts playing the cutscene.

PlayShot ( CutsceneClip clip ) : void

Shows the specified shot.

PlaySubtitle ( CutsceneClip clip ) : void

Displays the specified subtitle.

SceneFinish ( ) : void

Called when the scene ends.

SceneStart ( ) : void

Called when the scene starts.

SetupMasterAnimationClip ( ) : void

Sets the in and out points of the master animation clip.

SetupTrackAnimationClips ( ) : void

Adds each track's animation clip to the main animation.

Start ( ) : void
StopSubtitle ( ) : void

Stops all subtitles from displaying by setting the current subtitle to null.

UnknownFunction ( CutsceneClip clip ) : void

Called when the clip type is unknown.

For debugging only; ideally this will never be called.

Private Methods

Method Description
StopActor ( CutsceneActor actor, float duration ) : IEnumerator

Stops the actor from playing at its out point.

StopAudio ( AudioSource aud, float duration ) : IEnumerator

Stops the audio from playing at its out point.

StopShot ( Camera cam, float duration ) : IEnumerator

Stops the shot from playing at its out point.

StopSubtitle ( float duration ) : IEnumerator

Stops the subtitle from displaying at its out point.

Method Details

AddTrack() public method

Attaches a new track component to the cutscene.
public AddTrack ( Cutscene, type ) : CutsceneTrack,
type Cutscene,
return CutsceneTrack,

DisableAudio() public method

Keeps all child audio sources from playing once the game starts.
public DisableAudio ( ) : void
return void

DisableCameras() public method

Turns off all child cameras so that they don't display before the cutscene starts.
public DisableCameras ( ) : void
return void

DisableOtherCameras() public method

Turns off all child cameras except for the one specified.
public DisableOtherCameras ( Camera exemptCam ) : void
exemptCam Camera The camera to stay enabled.
return void

NewActor() public method

Creates a new CutsceneActor object and attaches it to a new game object as a child of the Shots game object.
public NewActor ( AnimationClip anim, GameObject go ) : CutsceneActor
anim AnimationClip
go GameObject
return CutsceneActor

NewAudio() public method

Creates a new CutsceneAudio object and attaches it to a new game object as a child of the Audio game object.
public NewAudio ( AudioClip clip ) : CutsceneAudio
clip AudioClip The audio clip to be attached the CutsceneAudio object.
return CutsceneAudio

NewShot() public method

Creates a new CutsceneShot object and attaches it to a new game object as a child of the Shots game object.
public NewShot ( ) : CutsceneShot
return CutsceneShot

NewSubtitle() public method

Creates a new CutsceneSubtitle object and attaches it to the Subtitles game object.
public NewSubtitle ( string dialog ) : CutsceneSubtitle
dialog string The dialog to be displayed.
return CutsceneSubtitle

OnDrawGizmos() public method

Visually shows the cutscene in the scene view.
public OnDrawGizmos ( ) : void
return void

OnGUI() public method

public OnGUI ( ) : void
return void

PauseCutscene() public method

Pauses the cutscene.
public PauseCutscene ( ) : void
return void

PlayActor() public method

Plays the specified actor.
public PlayActor ( CutsceneClip clip ) : void
clip CutsceneClip
return void

PlayAudio() public method

Plays the specified audio.
public PlayAudio ( CutsceneClip clip ) : void
clip CutsceneClip
return void

PlayCutscene() public method

Starts playing the cutscene.
public PlayCutscene ( ) : void
return void

PlayShot() public method

Shows the specified shot.
public PlayShot ( CutsceneClip clip ) : void
clip CutsceneClip
return void

PlaySubtitle() public method

Displays the specified subtitle.
public PlaySubtitle ( CutsceneClip clip ) : void
clip CutsceneClip
return void

SceneFinish() public method

Called when the scene ends.
public SceneFinish ( ) : void
return void

SceneStart() public method

Called when the scene starts.
public SceneStart ( ) : void
return void

SetupMasterAnimationClip() public method

Sets the in and out points of the master animation clip.
public SetupMasterAnimationClip ( ) : void
return void

SetupTrackAnimationClips() public method

Adds each track's animation clip to the main animation.
public SetupTrackAnimationClips ( ) : void
return void

Start() public method

public Start ( ) : void
return void

StopSubtitle() public method

Stops all subtitles from displaying by setting the current subtitle to null.
public StopSubtitle ( ) : void
return void

UnknownFunction() public method

Called when the clip type is unknown.
For debugging only; ideally this will never be called.
public UnknownFunction ( CutsceneClip clip ) : void
clip CutsceneClip
return void

Property Details

duration public_oe property

public float duration
return float

inPoint public_oe property

public float inPoint
return float

outPoint public_oe property

public float outPoint
return float

player public_oe property

public GameObject player
return GameObject

stopPlayer public_oe property

public bool stopPlayer
return bool

subtitlePosition public_oe property

public Rect subtitlePosition
return Rect

subtitleStyle public_oe property

public GUIStyle subtitleStyle
return GUIStyle