Types

Data shapes and public class surfaces referenced by the scripting API.

Referenced types are generated from the types directly linked by the documented API surface. This page is not a complete or authoritative representation of every type available.

Type	Kind	Summary
`ArmyConfigCore`	interface
`ArmyConfigPayload`	interface
`ArmyConfigRaw`	type alias
`ArmyEquipSet`	interface	Equipment is applied in this order: `safeClass`, `safePot`, `class`, `safePot`, `weapon`, `cape`, `helm`, `armor`, `pet`, each entry in `pots`, then `scroll`.
`ArmyEquipSetOptions`	interface
`ArmyError`	class
`ArmyLoopTauntAssignment`	interface	Assigns one target to the Army players allowed to keep it taunted.
`ArmyLoopTauntError`	class
`ArmyLoopTauntHandle`	interface	Stops a Loop Taunt run early; map and script lifecycle changes stop it automatically.
`ArmyLoopTauntParticipantSnapshot`	interface	Identifies an assigned Army player and its point-in-time projected state.
`ArmyLoopTauntPlan`	type alias	Ordered target priorities shared by every participant in the Army. The first group with a living target is selected. When all of its targets die, the next eligible group takes over; a respawn preempts lower groups and restarts that target’s rotation from its first assigned player.
`ArmyLoopTauntPriorityGroup`	interface	A set of target assignments evaluated at the same priority. Living assignments in the selected group run concurrently.
`ArmyLoopTauntSkipContext`	interface	Projected state available when deciding whether to yield a taunt attempt.
`ArmyLoopTauntSkipWhen`	type alias	Returns true when the selected player should yield to the next participant.
`ArmyLoopTauntStrategy`	type alias	Selects the encounter event that starts each taunt attempt.
`ArmyRunStepOptions`	interface
`ArmySession`	type alias	Alias of ArmySessionPayload.
`ArmySessionPayload`	interface
`ArmySetConfig`	interface
`AuraData`	interface
`AuraKind`	type alias
`AuraQueryOptions`	interface
`AuraSnapshot`	type alias
`AutoReloginState`	interface
`AutoZoneState`	interface
`AutoZoneSupportedMap`	type alias
`BankOpenOptions`	interface
`BankView`	type alias
`BoostType`	type alias
`CellPositionOptions`	interface
`ClientPacket`	type alias
`ClientPacketEncoding`	type alias
`CombatKillOptions`	interface
`CombatProfile`	type alias
`CombatProfileDefinition`	interface
`CombatProfileMessageTrigger`	type alias
`CombatProfileMessageTriggerDefinition`	type alias
`CombatProfileStep`	type alias
`CombatProfileStepDefinition`	type alias
`CompleteQuestOptions`	interface
`ConnectOutcome`	interface
`Enhancement`	interface
`EntityData`	interface
`EntitySnapshot`	type alias
`EntityState`	type alias
`EnvironmentAutomationCapability`	type alias
`EnvironmentAutomationOptions`	type alias
`EnvironmentDropPolicy`	type alias	Handling options for drops that are not registered by name.
`EnvironmentError`	interface
`EnvironmentQuestAutoRegisterOptions`	type alias
`EnvironmentSnapshot`	interface	A detached view of the current Environment configuration.
`EquipOptions`	interface
`ExtensionPacket`	type alias
`FactionData`	interface
`FactionSnapshot`	type alias
`FarmItemGoal`	interface	Identifies the item and minimum quantity a farming action should collect.
`FileSystemEntry`	interface
`FileSystemError`	class	Describes a failed filesystem action.
`FileSystemErrorReason`	type alias	Why a filesystem action failed.
`FileSystemOperation`	type alias
`FlashPacket`	type alias
`GameAction`	type alias
`HttpError`	class
`HttpErrorReason`	type alias	Why a script HTTP request or body read failed.
`HttpRequestBody`	type alias
`HttpRequestOptions`	interface
`HttpResponse`	interface	Fully downloaded response. Each body can be consumed once.
`HuntOptions`	interface
`Item`	interface
`ItemContext`	type alias
`ItemData`	interface
`ItemQuery`	type alias
`ItemRequirement`	interface
`ItemSelector`	type alias
`ItemSelectorById`	interface
`ItemSelectorByName`	interface
`ItemSnapshot`	type alias
`LiveAura`	class
`LiveEntity`	class
`LiveFaction`	class
`LiveItem`	class
`LiveMonster`	class
`LiveOutfit`	class
`LivePlayer`	class
`LiveQuest`	class
`LiveServer`	class
`LiveShop`	class
`MonsterData`	interface
`MonsterDrop`	interface	An item and its acquisition metadata from AQW’s monster-drop response.
`MonsterQuery`	type alias	Selects a monster by name, map ID, or selector object. String map IDs require `id` followed by `.`, `:`, `-`, or `'`: `id.123`, `id:123`, `id-123`, or `id'123`.
`MonsterSelector`	type alias
`MonsterSelectorByMapId`	interface
`MonsterSelectorByName`	interface
`MonsterSnapshot`	type alias
`OutfitColors`	interface
`OutfitData`	interface
`OutfitEquipment`	interface
`OutfitSnapshot`	type alias
`Packet`	type alias	Alias of FlashPacket.
`PacketDirection`	type alias
`PacketEncoding`	type alias
`PacketForDirection`	type alias
`PacketSelector`	interface
`PlayerData`	interface
`PlayerQuery`	type alias
`PlayerSelector`	type alias	Alias of PlayerSelectorByUsername.
`PlayerSelectorByUsername`	interface
`PlayerSnapshot`	type alias
`Position`	interface
`ProjectionEvent`	type alias
`ProjectionEventSelector`	type alias	An event-shaped partial selector. `type` chooses the event variant, and every other field is an exact-match constraint on a scalar field of that variant. Omitting a field leaves it unconstrained. With exact optional property types, explicitly passing `undefined` is invalid; untyped callers that do so safely fail to match instead of selecting events where the field happens to be absent.
`QuestCadence`	type alias
`QuestData`	interface
`QuestItem`	interface
`QuestReward`	interface
`QuestSnapshot`	type alias
`RestOptions`	interface
`ScriptCallbackResult`	type alias
`ScriptCombatMonsterTarget`	interface
`ScriptCombatPlayerTarget`	interface
`ScriptCombatTarget`	type alias
`ScriptEnhanceItemOptions`	interface
`ScriptEquipEnhancementSelector`	interface
`ScriptEvent`	type alias	Alias of ProjectionEvent.
`ScriptEventForType`	type alias
`ScriptEventSelector`	type alias	Alias of ProjectionEventSelector.
`ScriptEventSelectorForType`	type alias
`ScriptEventType`	type alias
`ScriptExecutionError`	class
`ScriptExitOptions`	interface	Actions performed when a script exits.
`ScriptGenerator`	type alias
`ScriptInputValue`	type alias
`ScriptInputValues`	type alias
`ScriptRenderingMode`	type alias	Controls game render visibility.
`ScriptRuntimeOptions`	interface
`ScriptRuntimeOptionsPatch`	type alias
`ScriptSettings`	interface
`ScriptSettingsPatch`	type alias	Only supplied fields are changed.
`ScriptShopQuantityOptions`	interface
`ScriptStopSignal`	class
`ServerData`	interface
`ServerPacket`	type alias
`ServerPacketEncoding`	type alias	Alias of PacketEncoding.
`ServerSnapshot`	type alias
`ShopData`	interface
`ShopItemQuery`	type alias
`ShopItemSelector`	type alias
`ShopItemSelectorById`	interface
`ShopSnapshot`	type alias
`SkillSlot`	type alias
`SkillUseOptions`	interface
`TriggeredWaitOptions`	interface	Runs `trigger` only after the subscription is live. A `true` result means the command was sent and a matching response should be awaited; `false` closes the scoped subscription immediately and returns `null`.
`WaitOptions`	interface
`WalkToOptions`	interface