api.army
Members
api.army.equipSet()
api.army.equipSet(setName: string, options?: ArmyEquipSetOptions): Effect.Effect<void, ArmyError>| Name | Type | Required | Default | Description |
|---|---|---|---|---|
setName |
string |
|||
options |
ArmyEquipSetOptions |
Returns: void
Errors: ArmyError
api.army.getConfigString()
api.army.getConfigString(key: string, defaultValue?: string): Effect.Effect<string>| Name | Type | Required | Default | Description |
|---|---|---|---|---|
key |
string |
|||
defaultValue |
string |
Returns: string
Errors: never
api.army.getConfigValue()
api.army.getConfigValue(key: string, defaultValue?: unknown): Effect.Effect<unknown>| Name | Type | Required | Default | Description |
|---|---|---|---|---|
key |
string |
|||
defaultValue |
unknown |
Returns: unknown
Errors: never
api.army.getPlayerNumber()
api.army.getPlayerNumber(): Effect.Effect<number | null>Returns: number | null
Errors: never
api.army.getSession()
api.army.getSession(): Effect.Effect<ArmySession | null>Returns: ArmySession | null
Errors: never
api.army.isLeader()
api.army.isLeader(): Effect.Effect<boolean>Returns: boolean
Errors: never
api.army.isMember()
api.army.isMember(): Effect.Effect<boolean>Returns: boolean
Errors: never
api.army.isStarted()
api.army.isStarted(): Effect.Effect<boolean>Returns: boolean
Errors: never
api.army.joinMap()
api.army.joinMap(map: string, options?: CellPositionOptions): Effect.Effect<void, ArmyError>| Name | Type | Required | Default | Description |
|---|---|---|---|---|
map |
string |
|||
options |
CellPositionOptions |
Returns: void
Errors: ArmyError
api.army.kill()
api.army.kill(target: MonsterQuery, options?: CombatKillOptions): Effect.Effect<void, ArmyError>| Name | Type | Required | Default | Description |
|---|---|---|---|---|
target |
MonsterQuery |
|||
options |
CombatKillOptions |
Returns: void
Errors: ArmyError
api.army.killForItem()
api.army.killForItem(target: MonsterQuery, goal: FarmItemGoal, options?: CombatKillOptions): Effect.Effect<void, ArmyError>| Name | Type | Required | Default | Description |
|---|---|---|---|---|
target |
MonsterQuery |
|||
goal |
FarmItemGoal |
|||
options |
CombatKillOptions |
Returns: void
Errors: ArmyError
api.army.killForTempItem()
api.army.killForTempItem(target: MonsterQuery, goal: FarmItemGoal, options?: CombatKillOptions): Effect.Effect<void, ArmyError>| Name | Type | Required | Default | Description |
|---|---|---|---|---|
target |
MonsterQuery |
|||
goal |
FarmItemGoal |
|||
options |
CombatKillOptions |
Returns: void
Errors: ArmyError
api.army.leave()
api.army.leave(): Effect.Effect<void>Returns: void
Errors: never
api.army.loopTaunt()
Starts a map-scoped Loop Taunt plan across the full Army roster.
api.army.loopTaunt(plan: ArmyLoopTauntPlan): Effect.Effect<ArmyLoopTauntHandle, ArmyLoopTauntError>| Name | Type | Required | Default | Description |
|---|---|---|---|---|
plan |
ArmyLoopTauntPlan |
The ordered target priority groups every participant runs. |
Returns: ArmyLoopTauntHandle
Errors: ArmyLoopTauntError
api.army.runStep()
api.army.runStep<A, E>(label: string, action: Effect.Effect<A, E>, options?: ArmyRunStepOptions): Effect.Effect<A, E | ArmyError>| Name | Type | Required | Default | Description |
|---|---|---|---|---|
label |
string |
|||
action |
Effect.Effect<A, E> |
|||
options |
ArmyRunStepOptions |
Returns: A
Errors: E | ArmyError
api.army.start()
api.army.start(configName: string): Effect.Effect<ArmySession, ArmyError>| Name | Type | Required | Default | Description |
|---|---|---|---|---|
configName |
string |
Returns: ArmySession
Errors: ArmyError
api.army.sync()
api.army.sync(label?: string, options?: ArmyRunStepOptions): Effect.Effect<void, ArmyError>| Name | Type | Required | Default | Description |
|---|---|---|---|---|
label |
string |
"sync" |
The coordination label. | |
options |
ArmyRunStepOptions |
Returns: void
Errors: ArmyError
api.army.waitForAllInMap()
api.army.waitForAllInMap(): Effect.Effect<void, ArmyError>Returns: void
Errors: ArmyError