party
Works the party picker, the screen the game shows after a follower joins and at camp, as a player’s clicks do. It refuses when the picker is not open (health reports mode partypicker when it is).
action:
look: returns who ischosen(each slot’s id, name and tag), and everyone the pickeroffered, each with itsstate: chosen, available, unavailable, suspended or lockedActive (kept in the party by the story).choose: picks the followername, as a click on them does.unchoose: removes the chosen followername, like clicking their portrait.clear: removes everyone except the hero and those the story keeps.accept: confirms the party as chosen, and returns thepartyonce the picker has closed.
Up to four can be chosen: unchoose one before choosing a fifth. A choice the picker refuses is an error saying why. choose, unchoose and clear refuse when the picker’s status is not use, meaning the picker is only for viewing. A picker you open yourself with the script command ShowPartyPickerGUI may be view-only: call SetPartyPickerGUIStatus with 2 through script before opening it, so it can change the party.
Arguments
| Name | Type | Required | What |
|---|---|---|---|
action | "look" | "choose" | "unchoose" | "accept" | "clear" | yes | What to do; each action is described above. |
name | string | With choose or unchoose: a follower’s name as the picker shows it, their tag, or their id. |
Call it as party over MCP, or POST /api/tool/party with the arguments as JSON.