InstallationFacet
event AddedToQueue(uint256 _queueId, uint256 _installationId, uint256 _readyBlock, address _sender)
event QueueClaimed(uint256 _queueId)
event CraftTimeReduced(uint256 _queueId, uint256 _blocksReduced)
event UpgradeTimeReduced(uint256 _queueId, uint256 _realmId, uint256 _coordinateX, uint256 _coordinateY, uint256 _blocksReduced)
struct InstallationIdIO {
uint256 installationId;
uint256 balance;
}
struct ReservoirStats {
uint256 spillRate;
uint256 spillRadius;
uint256 capacity;
}
function installationsBalances(address _account) external view returns (struct InstallationFacet.InstallationIdIO[] bals_)
Returns balance for each installation that exists for an account
Name | Type | Description |
|---|---|---|
_account | address | Address of the account to query |
Name | Type | Description |
|---|---|---|
bals_ | struct InstallationFacet.InstallationIdIO[] | An array of structs, each struct containing details about each installation owned |
function installationsBalancesWithTypes(address _owner) external view returns (struct ItemTypeIO[] output_)
Returns balance for each installation(and their types) that exists for an account
Name | Type | Description |
|---|---|---|
_owner | address | Address of the account to query |
Name | Type | Description |
|---|---|---|
output_ | struct ItemTypeIO[] | An array of structs containing details about each installation owned(including the installation types) |
function balanceOfToken(address _tokenContract, uint256 _tokenId, uint256 _id) public view returns (uint256 value)
Get the balance of a non-fungible parent token
Name | Type | Description |
|---|---|---|
_tokenContract | address | The contract tracking the parent token |
_tokenId | uint256 | The ID of the parent token |
_id | uint256 | ID of the token |
Name | Type | Description |
|---|---|---|
value | uint256 | The balance of the token |
function installationBalancesOfToken(address _tokenContract, uint256 _tokenId) public view returns (struct InstallationFacet.InstallationIdIO[] bals_)
Returns the balances for all ERC1155 items for a ERC721 token
Name | Type | Description |
|---|---|---|
_tokenContract | address | Contract address for the token to query |
_tokenId | uint256 | Identifier of the token to query |
Name | Type | Description |
|---|---|---|
bals_ | struct InstallationFacet.InstallationIdIO[] | An array of structs containing details about each item owned |
function installationBalancesOfTokenWithTypes(address _tokenContract, uint256 _tokenId) external view returns (struct ItemTypeIO[] installationBalancesOfTokenWithTypes_)
Returns the balances for all ERC1155 items for a ERC721 token
Name | Type | Description |
|---|---|---|
_tokenContract | address | Contract address for the token to query |
_tokenId | uint256 | Identifier of the token to query |
Name | Type | Description |
|---|---|---|
installationBalancesOfTokenWithTypes_ | struct ItemTypeIO[] | An array of structs containing details about each installation owned(including installation types) |
function spilloverRateAndRadiusOfId(uint256 _id) external view returns (uint256, uint256)
Check the spillover radius of an installation type
Name | Type | Description |
|---|---|---|
_id | uint256 | id of the installationType to query |
Name | Type | Description |
|---|---|---|
[0] | uint256 | the spillover rate and radius the installation type with identifier _id |
[1] | uint256 | |
function installationBalancesOfTokenByIds(address _tokenContract, uint256 _tokenId, uint256[] _ids) external view returns (uint256[])
Query the installation balances of an ERC721 parent token
Name | Type | Description |
|---|---|---|
_tokenContract | address | The token contract of the ERC721 parent token |
_tokenId | uint256 | The identifier of the ERC721 parent token |
_ids | uint256[] | An array containing the ids of the installationTypes to query |
Name | Type | Description |
|---|---|---|
[0] | uint256[] | An array containing the corresponding balances of the installation types queried |
function getInstallationType(uint256 _installationTypeId) external view returns (struct InstallationType installationType)
Query the item type of a particular installation
Name | Type | Description |
|---|---|---|
_installationTypeId | uint256 | Item to query |
Name | Type | Description |
|---|---|---|
installationType | struct InstallationType | A struct containing details about the item type of an item with identifier _itemId |
function getInstallationUnequipType(uint256 _installationId) external view returns (uint256)
function getInstallationTypes(uint256[] _installationTypeIds) external view returns (struct InstallationType[] installationTypes_)
Query the item type of multiple installation types
Name | Type | Description |
|---|---|---|
_installationTypeIds | uint256[] | An array containing the identifiers of items to query |
Name | Type | Description |
|---|---|---|
installationTypes_ | struct InstallationType[] | An array of structs,each struct containing details about the item type of the corresponding item |
function getCraftQueue(address _owner) external view returns (struct QueueItem[] output_)
Query details about all ongoing craft queues
Name | Type | Description |
|---|---|---|
_owner | address | Address to query queue |
Name | Type | Description |
|---|---|---|
output_ | struct QueueItem[] | An array of structs, each representing an ongoing craft queue |
function getAltarLevel(uint256 _altarId) external view returns (uint256 altarLevel_)
function getLodgeLevel(uint256 _installationId) external view returns (uint256 lodgeLevel_)
function getReservoirCapacity(uint256 _installationId) external view returns (uint256 capacity_)
function getReservoirStats(uint256 _installationId) external view returns (struct InstallationFacet.ReservoirStats reservoirStats_)
struct BatchCraftInstallationsInput {
uint16 installationID;
uint16 amount;
uint40 gltr;
}
function batchCraftInstallations(struct InstallationFacet.BatchCraftInstallationsInput[] _inputs) external
function craftInstallations(uint16[] _installationTypes, uint40[] _gltr) external
Allow a user to craft installations
Will throw even if one of the installationTypes is deprecated Puts the installation into a queue
Name | Type | Description |
|---|---|---|
_installationTypes | uint16[] | An array containing the identifiers of the installationTypes to craft |
_gltr | uint40[] | Array of GLTR to spend on each crafting |
function claimInstallations(uint256[] _queueIds) external
Allow a user to claim installations from ready queues
Will throw if the caller is not the queue owner Will throw if one of the queues is not ready
Name | Type | Description |
|---|---|---|
_queueIds | uint256[] | An array containing the identifiers of queues to claim |
function reduceCraftTime(uint256[] _queueIds, uint40[] _amounts) external
Allow a user to speed up multiple queues(installation craft time) by paying the correct amount of $GLTR tokens
Will throw if the caller is not the queue owner $GLTR tokens are burnt upon usage amount expressed in block numbers
Name | Type | Description |
|---|---|---|
_queueIds | uint256[] | An array containing the identifiers of queues to speed up |
_amounts | uint40[] | An array containing the corresponding amounts of $GLTR tokens to pay for each queue speedup |
function equipInstallation(address _owner, uint256 _realmId, uint256 _installationId) external
Allow a user to equip an installation to a parcel
Will throw if the caller is not the parcel diamond contract Will also throw if various prerequisites for the installation are not met
Name | Type | Description |
|---|---|---|
_owner | address | Owner of the installation to equip |
_realmId | uint256 | The identifier of the parcel to equip the installation to |
_installationId | uint256 | Identifier of the installation to equip |
function unequipInstallation(address _owner, uint256 _realmId, uint256 _installationId) external
Allow a user to unequip an installation from a parcel
Will throw if the caller is not the parcel diamond contract
Name | Type | Description |
|---|---|---|
_owner | address | |
_realmId | uint256 | The identifier of the parcel to unequip the installation from |
_installationId | uint256 | Identifier of the installation to unequip |
function upgradeComplete(uint256 _queueId) external view returns (bool)