CutsceneOverlay class final

What a cutscene puts over the picture: the dark of its fade, the words of its subtitles, and the way out of it. Drawn over the game while a Sequence plays.

Only what the cutscene says, read every frame. The fade and the subtitle come from SequenceView, which reads them off the step the SequencePlayer reached and the frame's place between two steps; this widget keeps nothing of the cutscene, so a rewind or a skip shows what the step says at once.

But the fade goes through a FlashLimit. A sequence that blinks to black and back faster than three times a second is a strobe, whoever wrote it, so the fade is held to the limit as it is drawn. A fade in or out, at any speed, is untouched.

The words sit on GameUiTheme.panel, and so does the way out, so they read over a bright frame as over a dark one.

Inheritance

Constructors

CutsceneOverlay({Key? key, required double fade, required String? subtitle, required String skipHint, required VoidCallback onSkip})
An overlay darkened by fade, showing subtitle when there is one and skipHint always, calling onSkip when skipped.
const

Properties

fade → double
How dark the screen is, nought to one.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onSkip → VoidCallback
Called when the player taps the way out, the button labelled skipHint in the bottom right corner.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
skipHint → String
How to skip, in the words of the device in hand.
final
subtitle → String?
What is being said, or null.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<CutsceneOverlay>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited