Instantiated: brd.pawnEP()
The .pawnEP() method tests if the specified tile is marked as a target tile for capturing a Pawn with an En Passant manoeuvre, and if so, returns the pieceID string for the Pawn associated with that tile.
If the tile is determined not to be an En Passant target tile, pawnEP() returns false.
Syntax
brd.pawnEP(team, coordObject)
Parameters
team (String)
One-letter String value representing the team to evaluate. ('b' = Black, 'w' = White)
coordObject (Object)
Object literal representing a board tile in the form of a brd.tiles { x, y } coordinate pair.
Example: coordObject representing tile C5, also expressed as brd.tiles[4][2]
{
x: 2,
y: 4
}
Return Value
String containing the pieceID of the Pawn that double-stepped over the specified tile during its most recent turn; false if the specified tile is not marked as an En Passant target tile.
Description
pawnEP() tests if the tile at the specified { x, y } board coordinates is listed in the brd.pawnsEPT data roster. (See data rosters.)
If the tile is found in the brd.pawnsEPT data roster, pawnEP() returns the pieceID string of the Pawn exposed to En Passant capture.
Examples
Testing if a tile is marked as an En Passant target tile
For these examples, assume White King's Pawn 3 moved from G2 to G4 during its most recent turn.
brd.pawnEP(6, 2); // "wkp_p3" brd.pawnEP(6, 1); // false brd.pawnEP(2, 5); // false
Page last updated: 2024-07-23