api.environment

Mutations apply partial updates and return the full resulting snapshot.

Members

`api.environment.addBoost()`

api.environment.addBoost(name: string): Effect.Effect<EnvironmentSnapshot, EnvironmentError>

Name	Type	Required	Default	Description
`name`	`string`

Returns: EnvironmentSnapshot

Errors: EnvironmentError

`api.environment.addItem()`

api.environment.addItem(name: string): Effect.Effect<EnvironmentSnapshot, EnvironmentError>

Name	Type	Required	Default	Description
`name`	`string`

Returns: EnvironmentSnapshot

Errors: EnvironmentError

`api.environment.addQuest()`

api.environment.addQuest(questId: number, rewardItemId?: number): Effect.Effect<EnvironmentSnapshot, EnvironmentError>

Name	Type	Required	Default	Description
`questId`	`number`
`rewardItemId`	`number`

Returns: EnvironmentSnapshot

Errors: EnvironmentError

`api.environment.clearBoosts()`

api.environment.clearBoosts(): Effect.Effect<EnvironmentSnapshot, EnvironmentError>

Returns: EnvironmentSnapshot

Errors: EnvironmentError

`api.environment.clearItems()`

api.environment.clearItems(): Effect.Effect<EnvironmentSnapshot, EnvironmentError>

Returns: EnvironmentSnapshot

Errors: EnvironmentError

`api.environment.clearQuestReward()`

api.environment.clearQuestReward(questId: number): Effect.Effect<EnvironmentSnapshot, EnvironmentError>

Name	Type	Required	Default	Description
`questId`	`number`

Returns: EnvironmentSnapshot

Errors: EnvironmentError

`api.environment.clearQuests()`

api.environment.clearQuests(): Effect.Effect<EnvironmentSnapshot, EnvironmentError>

Returns: EnvironmentSnapshot

Errors: EnvironmentError

`api.environment.clearRegistrations()`

Clears quest, item, and boost registrations.

api.environment.clearRegistrations(): Effect.Effect<EnvironmentSnapshot, EnvironmentError>

Returns: EnvironmentSnapshot

Errors: EnvironmentError

`api.environment.getState()`

api.environment.getState(): Effect.Effect<EnvironmentSnapshot>

Returns: EnvironmentSnapshot

Errors: never

`api.environment.removeBoost()`

api.environment.removeBoost(name: string): Effect.Effect<EnvironmentSnapshot, EnvironmentError>

Name	Type	Required	Default	Description
`name`	`string`

Returns: EnvironmentSnapshot

Errors: EnvironmentError

`api.environment.removeItem()`

api.environment.removeItem(name: string): Effect.Effect<EnvironmentSnapshot, EnvironmentError>

Name	Type	Required	Default	Description
`name`	`string`

Returns: EnvironmentSnapshot

Errors: EnvironmentError

`api.environment.removeQuest()`

api.environment.removeQuest(questId: number): Effect.Effect<EnvironmentSnapshot, EnvironmentError>

Name	Type	Required	Default	Description
`questId`	`number`

Returns: EnvironmentSnapshot

Errors: EnvironmentError

`api.environment.setAutomationEnabled()`

api.environment.setAutomationEnabled(capability: EnvironmentAutomationCapability, enabled: boolean): Effect.Effect<EnvironmentSnapshot, EnvironmentError>

Name	Type	Required	Default	Description
`capability`	`EnvironmentAutomationCapability`
`enabled`	`boolean`

Returns: EnvironmentSnapshot

Errors: EnvironmentError

`api.environment.setItemNotification()`

api.environment.setItemNotification(name: string, enabled: boolean): Effect.Effect<EnvironmentSnapshot, EnvironmentError>

Name	Type	Required	Default	Description
`name`	`string`
`enabled`	`boolean`

Returns: EnvironmentSnapshot

Errors: EnvironmentError

`api.environment.setQuestReward()`

api.environment.setQuestReward(questId: number, rewardItemId: number): Effect.Effect<EnvironmentSnapshot, EnvironmentError>

Name	Type	Required	Default	Description
`questId`	`number`
`rewardItemId`	`number`

Returns: EnvironmentSnapshot

Errors: EnvironmentError

`api.environment.updateDropPolicy()`

Updates one or more drop-handling options.

api.environment.updateDropPolicy(patch: Partial<EnvironmentDropPolicy>): Effect.Effect<EnvironmentSnapshot, EnvironmentError>

Name	Type	Required	Default	Description
`patch`	`Partial`<`EnvironmentDropPolicy`>

Returns: EnvironmentSnapshot

Errors: EnvironmentError

`api.environment.updateQuestAutoRegister()`

api.environment.updateQuestAutoRegister(patch: Partial<EnvironmentQuestAutoRegisterOptions>): Effect.Effect<EnvironmentSnapshot, EnvironmentError>

Name	Type	Required	Default	Description
`patch`	`Partial`<`EnvironmentQuestAutoRegisterOptions`>

Returns: EnvironmentSnapshot

Errors: EnvironmentError