EscapeGameWidget class

The main widget, that allows to render an escapeGame.

Inheritance

Constructors

EscapeGameWidget({Key? key, required EscapeGame escapeGame, bool autostart = false, Size? baseSize, Color? backgroundColor, GameWidgetBuilder? beforeGameStartBuilder, RoomWidgetBuilder roomWidgetBuilder = defaultRoomWidgetBuilder, GameWidgetBuilder inventoryWidgetBuilder = defaultInventoryWidgetBuilder, GameWidgetBuilder countdownWidgetBuilder = defaultCountdownWidgetBuilder, GameWidgetBuilder? afterGameFinishedBuilder, TryExitCallback? onTryToExit, RoomTransitionBuilder roomTransitionBuilder = defaultRoomTransitionBuilder})
Creates a new EscapeGameWidget instance.
const

Properties

afterGameFinishedBuilder → GameWidgetBuilder?
Builds the widget that is rendered after the game end.
final
autostart → bool
Whether to start automatically the game.
final
backgroundColor → Color?
The background color.
final
baseSize → Size?
The base size of the game.
final
beforeGameStartBuilder → GameWidgetBuilder?
Builds the widget that is rendered before the game start.
final
countdownWidgetBuilder → GameWidgetBuilder
Builds a widget that renders the escapeGame.countdown.
final
escapeGame → EscapeGame
The EscapeGame instance.
final
hashCode → int
The hash code for this object.
no setterinherited
inventoryWidgetBuilder → GameWidgetBuilder
Builds a widget that renders the escapeGame.inventory.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onTryToExit → TryExitCallback?
Called when the user tried to exit the game.
final
roomTransitionBuilder → RoomTransitionBuilder
Allows to build the RoomTransition that corresponds to the current room and the previous room.
final
roomWidgetBuilder → RoomWidgetBuilder
Builds a widget that renders the escapeGame.currentRoom.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<StatefulWidget>
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}) → 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

Static Methods

defaultCountdownWidgetBuilder(BuildContext context, EscapeGame escapeGame) → Widget
The default Countdown widget builder.
defaultInventoryWidgetBuilder(BuildContext context, EscapeGame escapeGame) → Widget
The default Inventory widget builder.
defaultRoomTransitionBuilder(EscapeGame escapeGame, Room? previousRoom, Room newRoom) → RoomTransition
The default RoomTransition builder.
defaultRoomWidgetBuilder(BuildContext context, EscapeGame escapeGame, Room room) → Widget
The default Room widget builder.