Hand class
A hand of pieces to drop from, such as in Crazyhouse.
- Inheritance
Constructors
-
Hand({required double squareSize, bool stackPieces = true, BoardTheme theme = BoardTheme.blueGrey, required PieceSet pieceSet, List<
String> pieces = const [], List<String> fixedPieces = const [], bool showCounts = true, BadgePosition? badgePosition, BadgeStyle badgeStyle = const badges.BadgeStyle(), MainAxisAlignment mainAxisAlignment = MainAxisAlignment.start, void onTap(String)?, void onDragStarted(String)?, void onDragCancelled(String)?, void onDragEnd(String, DraggableDetails)?, double dragFeedbackSize = 2.0, Offset dragFeedbackOffset = const Offset(0.0, -1.0)}) -
const
Properties
- badgePosition → BadgePosition?
-
Position of piece count badges.
final
- badgeStyle → BadgeStyle
-
The style of the piece count badges.
final
- dragFeedbackOffset → Offset
-
A vector to offset the position of dragged pieces by, relative to the size of the piece.
No offset is recommended for web, and Offset(0,-1) for mobile, in which case
the bottom of the piece will be anchored to the finger.
final
- dragFeedbackSize → double
-
The size of pieces being dragged will be multiplied by this.
1.5 is a good value for mobile, but 1.0 is preferable for web.
final
-
fixedPieces
→ List<
String> -
A list of the piece types that should be fixed in the hand. These will always be
present in the hand, in dulled form, even if there are no pieces of their type available.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- mainAxisAlignment → MainAxisAlignment
-
Alignment of piece widgets in the main row.
final
- onDragCancelled → (void Function(String)?)
-
Called when a drag is cancelled.
final
- onDragEnd → (void Function(String, DraggableDetails)?)
-
Called when a drag ends, i.e. it was dropped on a target.
final
- onDragStarted → (void Function(String)?)
-
Called when a drag is started.
final
- onTap → (void Function(String)?)
-
Called when the piece is tapped.
final
-
pieces
→ List<
String> -
A list of the pieces in the hand. These should be single character piece symbols.
Uppercase symbols will be white, lowercase ones will be black.
final
- pieceSet → PieceSet
-
The set of widgets to use for pieces on the board.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showCounts → bool
-
If true, the number of available pieces will be displayed in a small
badge above each piece.
final
- squareSize → double
-
final
- stackPieces → bool
-
Whether to stack duplicate pieces, or lay them out individually.
final
- theme → BoardTheme
-
The theme to derive colours from.
final
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
DiagnosticsNodeobjects 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