Environment
Properties
Section titled “Properties”Type: Bot
autoRegisterRequirements Getter Setter
Section titled “autoRegisterRequirements ”Gets the auto register requirements flag.
Type: boolean
autoRegisterRewards Getter Setter
Section titled “autoRegisterRewards ”Gets the auto register rewards flag.
Type: boolean
boosts Getter
Section titled “boosts ”Gets the set of boosts.
Type: ReadonlySet<string>
itemNames Getter
Section titled “itemNames ”Gets the set of item names.
Type: ReadonlySet<string>
questIds Getter
Section titled “questIds ”Gets the set of quest IDs.
Type: ReadonlySet<number>
questItemIds Getter
Section titled “questItemIds ”Gets the map of quest IDs to selected item IDs.
Type: ReadonlyMap<number, number>
rejectElse Getter Setter
Section titled “rejectElse ”Gets the reject else flag.
Type: boolean
Methods
Section titled “Methods”addBoost
Section titled “addBoost”Adds a boost to the environment.
| Parameter | Type | Description |
|---|---|---|
| boostName | string | The boost name to add. |
Returns: void
addItemName
Section titled “addItemName”Adds an item name to the environment.
| Parameter | Type | Description |
|---|---|---|
| itemName | string | The item name to add. |
Returns: void
addQuestId
Section titled “addQuestId”Adds a quest ID to the environment.
| Parameter | Type | Description |
|---|---|---|
| questId | string | number | The quest ID to add. |
Returns: void
applyUpdate
Section titled “applyUpdate”Updates the environment state with the given update payload.
| Parameter | Type | Description |
|---|---|---|
| update | EnvironmentUpdatePayload | the update payload |
Returns: void
getQuestItemId
Section titled “getQuestItemId”Gets the item ID for a quest.
| Parameter | Type | Description |
|---|---|---|
| questId | number | The quest ID. |
Returns: number | undefined
hasBoost
Section titled “hasBoost”Checks if the environment has the specified boost.
| Parameter | Type | Description |
|---|---|---|
| boostName | string | The boost name to check. |
Returns: boolean
hasItemName
Section titled “hasItemName”Checks if the environment has the specified item name.
| Parameter | Type | Description |
|---|---|---|
| itemName | string | The item name to check. |
Returns: boolean
removeBoost
Section titled “removeBoost”Removes a boost from the environment.
| Parameter | Type | Description |
|---|---|---|
| boostName | string | The boost name to remove. |
Returns: void
removeItemName
Section titled “removeItemName”Removes an item name from the environment.
| Parameter | Type | Description |
|---|---|---|
| itemName | string | The item name to remove. |
Returns: void
removeQuestId
Section titled “removeQuestId”Removes a quest ID from the environment.
| Parameter | Type | Description |
|---|---|---|
| questId | string | number | The quest ID to remove. |
Returns: void
removeQuestItemId
Section titled “removeQuestItemId”Removes the item ID for a quest.
| Parameter | Type | Description |
|---|---|---|
| questId | number | The quest ID. |
Returns: void
setQuestItemId
Section titled “setQuestItemId”Sets the item ID for a quest (for quests with multiple rewards).
| Parameter | Type | Description |
|---|---|---|
| questId | number | The quest ID. |
| itemId | number | The item ID to select when completing the quest. |
Returns: void