notes:data:piece
Differences
This shows you the differences between two versions of the page.
| notes:data:piece [2010/11/18 02:33] – created bwilson3 | notes:data:piece [2010/12/19 05:51] (current) – afassett | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | ====Game Piece Function==== | ||
| + | |||
| + | FILES: | ||
| + | * piece/ | ||
| + | * include/ | ||
| + | * piece/ | ||
| + | * piece/ | ||
| + | * piece/ | ||
| + | |||
| + | ===int getColor()=== | ||
| + | |||
| + | ^ Function | ||
| + | | getColor() | ||
| + | <code c++> | ||
| + | Returns the game pieces color ID (0 for black, 1 for white) | ||
| + | </ | ||
| + | |||
| + | ===int getLocation()=== | ||
| + | |||
| + | ^ Function ^ Parameter(s) ^ Return value | | ||
| + | | getLocation() | ||
| + | <code c++> | ||
| + | Function returns a pieces location on the board in integer format. | ||
| + | </ | ||
| + | |||
| + | |||
| + | ===int getPieceId()=== | ||
| + | |||
| + | ^ Function ^ Parameter(s) ^ Return value | | ||
| + | | getPieceId() | ||
| + | <code c++> | ||
| + | Function returns a pieces unique identifier in integer format. | ||
| + | </ | ||
| + | |||
| + | |||
| + | ===bool setColor(int color)=== | ||
| + | |||
| + | ^ Function ^ Parameter(s) ^ Return value | | ||
| + | | setColor(int color) | ||
| + | <code c++> | ||
| + | Function set's game piece color identifier via supplied int argument. | ||
| + | Returns boolean success. | ||
| + | </ | ||
| + | |||
| + | ===bool setLocation(int loc)=== | ||
| + | |||
| + | ^ Function ^ Parameter(s) ^ Return value | | ||
| + | | setLocation(int loc) | int | bool | | ||
| + | <code c++> | ||
| + | Function set's game piece' | ||
| + | Returns boolean success. | ||
| + | </ | ||
| + | |||
| + | ===bool setPieceId(int id)=== | ||
| + | |||
| + | ^ Function ^ Parameter(s) ^ Return value | | ||
| + | | setPieceId(int id) | int | bool | | ||
| + | <code c++> | ||
| + | Function set's game piece' | ||
| + | Returns boolean success. | ||
| + | </ | ||
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
