Name | Type | Deprecated | Secure | Description |
---|---|---|---|---|
Command.Minion.Claim | function | Claims an award from a minion adventure in "finished" mode. | ||
Command.Minion.Hurry | function | Hurry a minion adventure in "working" mode. | ||
Command.Minion.Send | function | Send a minion on an adventure. | ||
Command.Minion.Shuffle | function | Shuffle an adventure for a new option. | ||
Command.Minion.Unlock | function | Unlock another minion adventure slot. | ||
Event.Minion.Adventure.Change | Signals a change in a minion adventure. | |||
Event.Minion.Minion.Change | Signals a change in a minion. | |||
Inspect.Minion.Adventure.Detail | function | Provides detailed information about minion adventures. | ||
Inspect.Minion.Adventure.List | function | Lists known minion adventures. | ||
Inspect.Minion.Minion.Detail | function | Provides detailed information about minions. | ||
Inspect.Minion.Minion.List | function | Lists available minions. | ||
Inspect.Minion.Slot | function | Returns the total number of minion adventure slots. |
Claims an award from a minion adventure in "finished" mode.
Command.Minion.Claim(adventure) | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
adventure | parameter | minionadventure | The minion adventure to be affected. |
Hurry a minion adventure in "working" mode.
Throttled.
Command.Minion.Hurry(adventure, currency) | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
adventure | parameter | minionadventure | The minion adventure to be affected. |
currency | parameter | string | The currency to use for this command. May be any of "none", "aventurine", or "credit". |
Send a minion on an adventure.
Command.Minion.Send(minion, adventure) | |||
Command.Minion.Send(minion, adventure, currency) | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
adventure | parameter | minionadventure | The minion adventure to be affected. |
currency | parameter | string | The currency to use for this command. May be any of "none", "aventurine", or "credit". |
minion | parameter | minionminion | The minion to be affected. |
Shuffle an adventure for a new option.
Throttled.
Command.Minion.Shuffle(adventure, currency) | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
adventure | parameter | minionadventure | The minion adventure to be affected. |
currency | parameter | string | The currency to use for this command. May be any of "none", "aventurine", or "credit". |
Unlock another minion adventure slot.
Command.Minion.Unlock() |
Signals a change in a minion adventure.
Event.Minion.Adventure.Change(adventures) | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
adventures | parameter | variant | A table of minion adventures that have changed. Takes the form of a table. The key is the minion adventure ID. |
Signals a change in a minion.
Event.Minion.Minion.Change(minions) | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
minions | parameter | variant | A table of minions that have changed. Takes the form of a table. The key is the minion ID. |
Provides detailed information about minion adventures.
detail = Inspect.Minion.Adventure.Detail(adventure) | |||
details = Inspect.Minion.Adventure.Detail(adventures) | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
adventure | parameter | minionadventure | The identifier of the minion adventure to retrieve detail for. |
adventures | parameter | table | A table of identifiers of minion adventures to retrieve detail for. |
detail | result | table | Detail table for a single minion adventure. |
details | result | table | Detail table for all requested minion adventures. The key is the minion adventure ID, the value is the adventure's detail table. |
completion | The time a "working" adventure will change to "finished", represented as UNIX time. |
---|---|
costAventurine | The cost to start this adventure in Aventurine. |
costCredit | The cost to start this adventure in credits. |
costStamina | The cost to start this adventure in stamina. |
duration | The duration of this adventure in seconds. |
hurryAventurine | The cost to hurry this adventure in Aventurine. |
hurryCredit | The cost to hurry this adventure in credits. |
id | The ID of the requested element. |
minion | The minion currently involved with this adventure. |
mode | The mode this adventure is in. One of "available", "working", or "finished". |
name | The name of this adventure. |
reward | The reward type of this adventure. |
rewardQuality | The final reward quality of this adventure once in "finished" mode. |
statAir | Indicates greater rewards if finished by a minion with an Air stat. |
statArtifact | Indicates greater rewards if finished by a minion with an Artifact stat. |
statAssassination | Indicates greater rewards if finished by a minion with an Assassination stat. |
statDeath | Indicates greater rewards if finished by a minion with a Death stat. |
statDimension | Indicates greater rewards if finished by a minion with a Dimension stat. |
statDiplomacy | Indicates greater rewards if finished by a minion with a Diplomacy stat. |
statEarth | Indicates greater rewards if finished by a minion with an Earth stat. |
statExploration | Indicates greater rewards if finished by a minion with an Exploration stat. |
statFire | Indicates greater rewards if finished by a minion with a Fire stat. |
statHarvesting | Indicates greater rewards if finished by a minion with a Harvesting stat. |
statHunting | Indicates greater rewards if finished by a minion with a Hunting stat. |
statLife | Indicates greater rewards if finished by a minion with a Life stat. |
statWater | Indicates greater rewards if finished by a minion with a Water stat. |
Lists known minion adventures.
list = Inspect.Minion.Adventure.List() | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
list | result | table | A table of minion adventure IDs. The key is the minion adventure ID. |
Provides detailed information about minions.
detail = Inspect.Minion.Minion.Detail(minion) | |||
details = Inspect.Minion.Minion.Detail(minions) | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
minion | parameter | minionminion | The identifier of the minion to retrieve detail for. |
minions | parameter | table | A table of identifiers of minions to retrieve detail for. |
detail | result | table | Detail table for a single minion. |
details | result | table | Detail table for all requested minions. The key is the minion ID, the value is the minion's detail table. |
description | The description of this minion. |
---|---|
experienceAccumulated | If not at max level, this minion's accumulated experience in their current level. |
experienceNeeded | If not at max level, the amount of experience required to gain a level. |
id | The ID of the requested element. |
level | The current level of this minion. |
name | The name of this minion. |
rarity | The rarity of this minion. "common", "uncommon", "rare", or "epic". |
stamina | The current stamina of this minion. |
staminaMax | The maximum stamina of this minion. |
statAir | This minion's Air stat. |
statArtifact | This minion's Artifact stat. |
statAssassination | This minion's Assassination stat. |
statDeath | This minion's Death stat. |
statDimension | This minion's Dimension stat. |
statDiplomacy | This minion's Diplomacy stat. |
statEarth | This minion's Earth stat. |
statExploration | This minion's Exploration stat. |
statFire | This minion's Fire stat. |
statHarvesting | This minion's Harvesting stat. |
statHunting | This minion's Hunting stat. |
statLife | This minion's Life stat. |
statWater | This minion's Water stat. |
Lists available minions.
list = Inspect.Minion.Minion.List() | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
list | result | table | A table of minion IDs. The key is the minion ID. |
Returns the total number of minion adventure slots.
slots = Inspect.Minion.Slot() | |||
Parameter | Type | Datatype | Description |
---|---|---|---|
slots | result | number | The number of slots available for active minion adventures. |