Instantiated: brd.pcLoc()
The .pcLoc() method returns a coordObject containing the { x, y } brd.tiles array position of the specified piece, or false if the piece is not found on the board.
Syntax
brd.pcLoc(pieceID)
Parameters
pieceID (String)
ID string for the piece being located. (See piece reference.)
Return Value
Object literal containing X-axis and Y-axis array positions corresponding to the board tile on which the specified piece was located; false if the specified piece was not found on any board tile.
Description
pcLoc() examines every board tile, seeking the specified piece. If the piece is found, its location is returned.
Examples
Locating pieces
For these examples, assume the following board layout:
brd.pcLoc('wko_bi'); // { "x": 3, "y": 4 }
brd.pcLoc('bko_kg'); // { "x": 4, "y": 7 }
brd.pcLoc('wqo_qn'); // false
Page last updated: 2024-07-23