RealmFacet

MintParcelInput

struct MintParcelInput {
  uint256 coordinateX;
  uint256 coordinateY;
  uint256 district;
  string parcelId;
  string parcelAddress;
  uint256 size;
  uint256[4] boost;
}

EquipInstallation

event EquipInstallation(uint256 _realmId, uint256 _installationId, uint256 _x, uint256 _y)

UnequipInstallation

event UnequipInstallation(uint256 _realmId, uint256 _installationId, uint256 _x, uint256 _y)

EquipTile

event EquipTile(uint256 _realmId, uint256 _tileId, uint256 _x, uint256 _y)

UnequipTile

event UnequipTile(uint256 _realmId, uint256 _tileId, uint256 _x, uint256 _y)

AavegotchiDiamondUpdated

event AavegotchiDiamondUpdated(address _aavegotchiDiamond)

InstallationUpgraded

event InstallationUpgraded(uint256 _realmId, uint256 _prevInstallationId, uint256 _nextInstallationId, uint256 _coordinateX, uint256 _coordinateY)

mintParcels

function mintParcels(address[] _to, uint256[] _tokenIds, struct RealmFacet.MintParcelInput[] _metadata) external

Allow the diamond owner to mint new parcels

Parameters

NameTypeDescription

_to

address[]

The address to mint the parcels to

_tokenIds

uint256[]

The identifiers of tokens to mint

_metadata

struct RealmFacet.MintParcelInput[]

An array of structs containing the metadata of each parcel being minted

BatchEquipIO

struct BatchEquipIO {
  uint256[] types;
  bool[] equip;
  uint256[] ids;
  uint256[] x;
  uint256[] y;
}

batchEquip

function batchEquip(uint256 _realmId, uint256 _gotchiId, struct RealmFacet.BatchEquipIO _params, bytes[] _signatures) external

equipInstallation

function equipInstallation(uint256 _realmId, uint256 _gotchiId, uint256 _installationId, uint256 _x, uint256 _y, bytes _signature) public

Allow a parcel owner to equip an installation

_The _x and y denote the starting coordinates of the installation and are used to make sure that slot is available on a parcel

Parameters

NameTypeDescription

_realmId

uint256

The identifier of the parcel which the installation is being equipped on

_gotchiId

uint256

The Gotchi ID of the Aavegotchi being played. Must be verified by the backend API.

_installationId

uint256

The identifier of the installation being equipped

_x

uint256

The x(horizontal) coordinate of the installation

_y

uint256

The y(vertical) coordinate of the installation

_signature

bytes

unequipInstallation

function unequipInstallation(uint256 _realmId, uint256 _gotchiId, uint256 _installationId, uint256 _x, uint256 _y, bytes _signature) public

Allow a parcel owner to unequip an installation

_The _x and y denote the starting coordinates of the installation and are used to make sure that slot is available on a parcel

Parameters

NameTypeDescription

_realmId

uint256

The identifier of the parcel which the installation is being unequipped from

_gotchiId

uint256

_installationId

uint256

The identifier of the installation being unequipped

_x

uint256

The x(horizontal) coordinate of the installation

_y

uint256

The y(vertical) coordinate of the installation

_signature

bytes

moveInstallation

function moveInstallation(uint256 _realmId, uint256 _installationId, uint256 _x0, uint256 _y0, uint256 _x1, uint256 _y1) external

Allow a parcel owner to move an installation

Parameters

NameTypeDescription

_realmId

uint256

The identifier of the parcel which the installation is being moved on

_installationId

uint256

The identifier of the installation being moved

_x0

uint256

The x(horizontal) coordinate of the installation

_y0

uint256

The y(vertical) coordinate of the installation

_x1

uint256

The x(horizontal) coordinate of the installation to move to

_y1

uint256

The y(vertical) coordinate of the installation to move to

equipTile

function equipTile(uint256 _realmId, uint256 _gotchiId, uint256 _tileId, uint256 _x, uint256 _y, bytes _signature) public

Allow a parcel owner to equip a tile

_The _x and y denote the starting coordinates of the tile and are used to make sure that slot is available on a parcel

Parameters

NameTypeDescription

_realmId

uint256

The identifier of the parcel which the tile is being equipped on

_gotchiId

uint256

_tileId

uint256

The identifier of the tile being equipped

_x

uint256

The x(horizontal) coordinate of the tile

_y

uint256

The y(vertical) coordinate of the tile

_signature

bytes

unequipTile

function unequipTile(uint256 _realmId, uint256 _gotchiId, uint256 _tileId, uint256 _x, uint256 _y, bytes _signature) public

Allow a parcel owner to unequip a tile

_The _x and y denote the starting coordinates of the tile and are used to make sure that slot is available on a parcel

Parameters

NameTypeDescription

_realmId

uint256

The identifier of the parcel which the tile is being unequipped from

_gotchiId

uint256

_tileId

uint256

The identifier of the tile being unequipped

_x

uint256

The x(horizontal) coordinate of the tile

_y

uint256

The y(vertical) coordinate of the tile

_signature

bytes

moveTile

function moveTile(uint256 _realmId, uint256 _tileId, uint256 _x0, uint256 _y0, uint256 _x1, uint256 _y1) external

Allow a parcel owner to move a tile

Parameters

NameTypeDescription

_realmId

uint256

The identifier of the parcel which the tile is being moved on

_tileId

uint256

The identifier of the tile being moved

_x0

uint256

The x(horizontal) coordinate of the tile

_y0

uint256

The y(vertical) coordinate of the tile

_x1

uint256

The x(horizontal) coordinate of the tile to move to

_y1

uint256

The y(vertical) coordinate of the tile to move to

upgradeInstallation

function upgradeInstallation(uint256 _realmId, uint256 _prevInstallationId, uint256 _nextInstallationId, uint256 _coordinateX, uint256 _coordinateY) external

addUpgradeQueueLength

function addUpgradeQueueLength(uint256 _realmId) external

subUpgradeQueueLength

function subUpgradeQueueLength(uint256 _realmId) external

fixGrid

function fixGrid(uint256 _realmId, uint256 _installationId, uint256[] _x, uint256[] _y, bool tile) external

buildingFrozen

function buildingFrozen() external view returns (bool)

setFreezeBuilding

function setFreezeBuilding(bool _freezeBuilding) external