PieceSelectorData class

A configuration for a piece selector, i.e. for promotion or gating.

Constructors

PieceSelectorData({required int square, required bool startLight, required List<String?> pieces, bool gate = false, int? gatingSquare, bool disambiguateGating = false})

Properties

disambiguateGating bool
Used during algebraic move string generation as a result of moves made by a piece selector. There are cases where multiple piece selectors can be shown at once for gating, such as when a castling move is made. If there is only one then we don't want to disambiguate. Remember that the piece selector (or indeed a BoardController) has no knowledge of castling.
final
gate bool
Whether this is a gating selector, or a promotion selector.
final
gatingSquare int?
The square to anchor the selector to if gating. If this is null, then square will be used instead.
final
hashCode int
The hash code for this object.
no setterinherited
pieces List<String?>
The pieces in the selector. Null indicates an empty square and can be used a move could have a selected piece or not, such as with Crazyhouse drops.
final
props List<Object?>
The list of properties that will be used to determine whether two instances are equal.
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
square int
The square that the move that spawned this selector is to. For promotion and some types of gating, this will also serve as the square that the selector is anchored to.
final
startLight bool
A piece selector has alternating colour background squares like a board. startLight indicates whether the first square should be light.
final
stringify bool?
If set to true, the toString method will be overridden to output this instance's props.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.

Operators

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