escape_game_kit library
Create escape games with ease !
Classes
-
ActionResult<
T> - Returned when the user does an Action.
- Clue
- A LockedInteractable that is meant to be a clue.
- Countdown
- A little utility class that allows to create countdowns.
- CountdownWidget
- Allows to display a countdown.
- CredentialsPadlock
- A padlock that can be unlocked by providing the correct username and the correct password.
- CredentialsPadlockDialog
- Allows to unlock a CredentialsPadlock.
- DigitsPadlock
- A padlock that can be unlocked by providing the correct digits.
- DigitsPadlockDialog
- Allows to unlock a DigitsPadlock.
- Door
- A LockedInteractable that is meant to be a door.
- EscapeGame
- Represents an EscapeGame, with some rooms and an inventory.
- EscapeGameAlertDialog
- An AlertDialog, built for escape games.
- EscapeGameAlertDialogCloseButton
- Allows to create a Close button easily.
-
EscapeGameAlertDialogOkButton<
T> - Allows to create an OK button easily.
- EscapeGameAlertDialogPadlockNewTry
-
Displays the
padlock.failedToUnlockMessage. -
EscapeGameDialog<
T> - Represents an in-game dialog.
- EscapeGameObject
- Represents an in-game object.
- EscapeGameWidget
- The main widget, that allows to render an escapeGame.
- Interactable
- Represents an in-game displayed object that is interactable.
- InteractableAnimation
- Represents an interactable animation.
- InteractableRenderSettings
- Controls how an Interactable should be rendered in-game.
- InteractableTooltip
- Represents a displayable tooltip.
- InteractableWidget
- Allows to render an Interactable.
- Inventory
- Represents an in-game inventory.
- InventoryButton
- The inventory button widget.
- InventoryDialog
- Allows to display the inventory in a dialog.
- InventoryList
- Allows to display the inventory in a list.
- InventoryWidget
- Base class that allows to create a widget that display an Inventory.
-
InventoryWidgetState<
T extends InventoryWidget> - Base class that allows to create the state of a widget that display an Inventory.
-
ListEqualPadlock<
T> - A Padlock that can be unlocked by providing a specific list.
- LockedInteractable
- Represents an Interactable object that is locked.
-
ObjectEqualPadlock<
T> - A Padlock that can be unlocked by providing a specific object.
-
Padlock<
C> - Represents an in-game padlock that should be unlocked in order for the user to complete an action.
-
PadlockAlertDialog<
T extends Padlock> - Allows to easily create dialogs to unlock padlocks.
-
PadlockAlertDialogState<
T extends PadlockAlertDialog< Padlock> > - Base state for a PadlockAlertDialog widget.
- PadlockHint
- Represents a padlock hint.
- PadlockSequence
- A very special padlock that is unlocked only when its children are unlocked.
- PatternCoordinate
-
Represents a
(x, y)coordinate. - PatternPadlock
- A padlock that can be unlocked by providing the correct pattern.
- PatternPadlockDialog
- Allows to unlock a PatternPadlock. Thanks https://github.com/baothg/pattern_lock_screen_flutter/blob/master/lib/main.dart.
- PickableObject
- A LockedInteractable that is meant to be a pickable object.
- PositionedRenderSettings
- Controls how an object should be rendered and positioned in the game.
- RenderSettings
- Controls how an object should be rendered in the game.
- RenderSettingsWidget
- Builds a widget that corresponds to the given renderSettings.
- Room
- Represents a room.
- RoomBackgroundWidget
- Allows to render the background of a Room.
- RoomTransition
- Controls the transition between two rooms.
- RoomWidget
- Allows to render a Room.
Enums
- ActionResultState
- An ActionResult state.
- InteractableAnimationType
- Represents an interactable animation type.
Mixins
- CountdownListener
- Represents a countdown listener that can react to various countdown events.
Extensions
- PadlockDialogs on Padlock
- Allows to unlock padlocks with a dialog.
Constants
- kDefaultFailedToUnlockMessage → const String
- The text displayed by default in padlock dialogs when the user failed to unlock a padlock.
- kDefaultPadlockHintTitle → const String
- The default title of a padlock hint.
- kDefaultPadlockTitle → const String
- The default title of padlocks.
- kDefaultPadlockUnlockMessage → const String
- The text displayed by default in padlock dialogs.
Typedefs
-
Action<
T> = ActionResult< T> Function(EscapeGame escapeGame) - Represents an action, triggered by the player.
- BackgroundWidgetBuilder = Widget Function(BuildContext context, EscapeGame escapeGame, Room room)
- Allows to build the background widget.
- EscapeGameObjectWidgetBuilder = Widget Function(BuildContext context, EscapeGame escapeGame, EscapeGameObject object)
- Allows to build the widget that displays an EscapeGameObject.
- GameWidgetBuilder = Widget Function(BuildContext context, EscapeGame escapeGame)
-
Allows to build a widget according to the specified
escapeGame. - HintBuilder = PadlockHint? Function(EscapeGame escapeGame, Padlock padlock, int tryCount)
- The hint builder type.
- InteractableWidgetBuilder = Widget Function(BuildContext context, EscapeGame escapeGame, Room room, Interactable interactable)
- Allows to build the interactable widget.
- PadlockDialogBuilder = Widget? Function(BuildContext context, EscapeGame escapeGame, Padlock padlock)
- Builds a dialog that allows to unlock a Padlock.
- RoomTransitionBuilder = RoomTransition Function(EscapeGame escapeGame, Room? previousRoom, Room newRoom)
-
Builds a RoomTransition according to the
previousRoomand thenewRoom. - RoomWidgetBuilder = Widget Function(BuildContext context, EscapeGame escapeGame, Room room)
-
Allows to render a specified
room. -
TryExitCallback
= Future<
bool> Function(EscapeGame escapeGame) -
Should be triggered when the user tries to exit the current
escapeGame.