Army
constArmy:object
Type Declaration
Section titled “Type Declaration”equipSet
Section titled “equipSet”equipSet: (
name,__namedParameters) =>Effect<boolean>
Equips this player’s gear for the set. Every player gets false if any player couldn’t equip all of theirs.
Parameters
Section titled “Parameters”string
__namedParameters?
Section titled “__namedParameters?”ArmyStepOptions = {}
Returns
Section titled “Returns”Effect<boolean>
gather
Section titled “gather”gather: <
A>(label,value,__namedParameters) =>Effect<readonlyA[]>
Values come back in player order.
Type Parameters
Section titled “Type Parameters”A extends Json
Parameters
Section titled “Parameters”string
A
__namedParameters?
Section titled “__namedParameters?”ArmyStepOptions = {}
Returns
Section titled “Returns”Effect<readonly A[]>
joinMap
Section titled “joinMap”joinMap: (
map,__namedParameters) =>Effect<boolean>
Joins <map>-<room>. Every player gets false if any player didn’t get into the room.
Parameters
Section titled “Parameters”string
__namedParameters?
Section titled “__namedParameters?”ArmyMapOptions = {}
Returns
Section titled “Returns”Effect<boolean>
start:
ArmyStart
Reads ~/Documents/Mira/armies/<name>.yaml and waits until every player in it has started.
sync: (
label,__namedParameters) =>Effect<void>
Parameters
Section titled “Parameters”string
__namedParameters?
Section titled “__namedParameters?”ArmyStepOptions = {}
Returns
Section titled “Returns”Effect<void>
takeTurns
Section titled “takeTurns”takeTurns: (
label,__namedParameters) =>Effect<Rotation>
Runs turn on one player at a time, in players order, until stop or the end of the
script. turn returns whether it acted. Players not listed take no turns.
Parameters
Section titled “Parameters”string
__namedParameters
Section titled “__namedParameters”Returns
Section titled “Returns”Effect<Rotation>
until: (
label,__namedParameters,__namedParameters) =>Effect<void>
Every player runs work in rounds until done is true for all of them at the same time.
Players that are done keep working.
Parameters
Section titled “Parameters”string
__namedParameters
Section titled “__namedParameters”__namedParameters?
Section titled “__namedParameters?”ArmyUntilOptions = {}
Returns
Section titled “Returns”Effect<void>