LevelUpOverlay class

Renders LevelUpOverlayController's sequence over child — same in-tree-overlay pattern as NeonDialog/SceneTransitionOverlay (see CLAUDE.md's "Dialog pattern" note), so it also works over a full-screen Flame GameWidget.

child is excluded from the semantics tree and ignores pointer events for as long as LevelUpOverlayController.isActive is true, except for the overlay's own optional skip tap target — a stray tap can never reach whatever's underneath mid-celebration.

Respects reduced motion: when true (or, left null, when MediaQuery.of(context).disableAnimations is), every phase's visual animation duration collapses to zero — the controller's own timing (which drives WHEN each phase happens) is untouched, only what the widget shows while waiting is instant instead of animated.

Inheritance

Constructors

LevelUpOverlay({Key? key, required LevelUpOverlayController controller, required Widget child, bool enableHaptics = true, bool enableConfetti = true, bool? reducedMotion, VoidCallback? onSkipTap})
const

Properties

child → Widget
final
controller → LevelUpOverlayController
final
enableConfetti → bool
Shows a confetti burst during LevelUpPhase.rewardReveal — vetoed automatically under reduced motion, same as RewardPopup.
final
enableHaptics → bool
Fires HapticLevel.medium once per LevelUpPhase.levelPop — set false to opt out (e.g. under test, or a caller with its own haptic policy).
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onSkipTap → VoidCallback?
Called when the caller-supplied skip affordance is tapped — normally just controller.skip. Left null hides the skip button entirely.
final
reducedMotion → bool?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
createElement() → StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
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