Assumes you are in the PlayState.

Static variables

@:value(new FlxSignal())staticfinalread onlyonVideoEnded:FlxSignal = new FlxSignal()

Called when the video is ended or skipped.

@:value(new FlxSignal())staticfinalread onlyonVideoPaused:FlxSignal = new FlxSignal()

Called if the video is paused.

@:value(new FlxSignal())staticfinalread onlyonVideoRestarted:FlxSignal = new FlxSignal()

Called if the video is restarted. onVideoStarted is not called.

@:value(new FlxSignal())staticfinalread onlyonVideoResumed:FlxSignal = new FlxSignal()

Called if the video is resumed.

@:value(new FlxSignal())staticfinalread onlyonVideoStarted:FlxSignal = new FlxSignal()

Called when the video is started.

Static methods

staticdestroyVideo():Void

Destroy the active cutscene, if any. Separate from finishVideo() so that it doesn't trigger onCutsceneFinish().

@:value({ transitionTime : 0.5 })staticfinishVideo(transitionTime:Float = 0.5):Void

Finish the active video cutscene. Done when the video is finished or when the player skips the cutscene.

Parameters:

transitionTime

The duration of the transition to the next state. Defaults to 0.5 seconds (this time is always used when cancelling the video).

finishCutscene

The callback to call when the transition is finished.

statichideVideo():Void

staticisPlaying():Bool

staticpauseVideo():Void

@:value({ cutsceneType : STARTING })staticplay(filePath:String, cutsceneType:CutsceneType = STARTING):Void

Play a video cutscene. TODO: Currently this is hardcoded to start the countdown after the video is done.

Parameters:

path

The path to the video file. Use Paths.file(path) to get the correct path.

cutseneType

The type of cutscene to play, determines what the game does after. Defaults to CutsceneType.STARTING.

staticrestartVideo():Void

staticresumeVideo():Void

staticshowVideo():Void