Skip to content

Latest commit

 

History

History
205 lines (169 loc) · 6.45 KB

BoardContract.md

File metadata and controls

205 lines (169 loc) · 6.45 KB

BoardContract

/** Implements game logic and board's features

Functions

constructor

  function constructor(
    address _VRFCoordinator,
    address _LinkToken,
    bytes32 _keyHash,
    uint256 _Chainlinkfee
  ) public

Constructor

Parameters:

Name Type Description
_VRFCoordinator address ChainLink VRFCoordinator contract address
_LinkToken address LINK token address
_keyHash bytes32 ChainLink keyHash parameter for VRF
_Chainlinkfee uint256 ChainLink fee for VRF*/

isPurchasable

  function isPurchasable(
    uint16 edition,
    uint8 land
  ) external returns (bool)
  • check if a land can be bought (PROP tokens available)

Parameters:

Name Type Description
edition uint16 board edition
land uint8 cell number

Return Values:

Name Type Description
true uint16 or false*/

getMaxEdition

  function getMaxEdition(
  ) external returns (uint16)
  • get the number of board editions

Return Values:

Name Type Description
number of board editions*/

getNbLands

  function getNbLands(
    uint16 edition
  ) external returns (uint8)
  • get the number of lands for a board edition

Parameters:

Name Type Description
edition uint16 board edition

Return Values:

Name Type Description
number uint16 of lands*/

getRarityLevel

  function getRarityLevel(
    uint16 edition
  ) external returns (uint8)
  • get the number of rarity level for a board edition

Parameters:

Name Type Description
edition uint16 board edition

Return Values:

Name Type Description
number uint16 of rarity levels*/

newBoard

  function newBoard(
    uint8 _nbOfLands,
    uint8 _rarityLevel,
    uint8[] _maxPawns
  ) public
  • create a new board

Parameters:

Name Type Description
_nbOfLands uint8 number of lands
_rarityLevel uint8 number of rarity levels
_maxPawns uint8[] max number of pawns allowed*/

register

  function register(
    uint16 _edition,
    uint256 _pawnID
  ) external returns (bool isOnBoarded)
  • register a pawn on a board

Parameters:

Name Type Description
_edition uint16 board edition
_pawnID uint256 pawn ID*/

isRegistered

  function isRegistered(
    uint16 _edition,
    uint256 _pawnID
  ) public returns (bool)
  • check if a pawn is registered

Parameters:

Name Type Description
_edition uint16 board edition
_pawnID uint256 pawn ID

Return Values:

Name Type Description
true uint16 or false*/

play

  function play(
    uint16 _edition,
    uint256 _pawnID
  ) external returns (bytes32 requestId)
  • play with a pawn

Parameters:

Name Type Description
_edition uint16 board edition
_pawnID uint256 pawn ID*/

getPawnInfo

  function getPawnInfo(
    uint16 _edition,
    uint256 _pawnID
  ) external returns (struct BoardContract.PawnInfo p)
  • get Pawn information on a board

Parameters:

Name Type Description
_edition uint16 board edition
_pawnID uint256 pawn ID

Return Values:

Name Type Description
p uint16 Pawn information*/

setPawnInfo

  function setPawnInfo(
    uint16 _edition,
    uint256 _pawnID,
    struct BoardContract.PawnInfo _pawnInfo
  ) external
  • set Pawn information on a board

Parameters:

Name Type Description
_edition uint16 board edition
_pawnID uint256 pawn ID
_pawnInfo struct BoardContract.PawnInfo pawn information*/