dao::partypicker

Declared in dao/PartyPicker.h.

Classes

Class  
Entry A creature the picker shows.

Enumerations

Refusal

enum class Refusal : std::uint8_t

Why a step was refused, or None if it was taken.

Value  
None  
NotShown the party picker is not the current mode, or is showing or leaving
ReadOnly the picker is shown only to look at (GetPartyPickerGUIStatus is not USE)
NotOffered the picker shows no such creature
Locked the hero, or a follower the story keeps or keeps out
AlreadySo chosen already, or not chosen to let go
PartyFull four are chosen

State

enum class State : std::int32_t

An entry’s state, the follower’s as the picker took it (FOLLOWER_STATE_*), and changed by choosing.

Value  
Chosen = 1 in the party when the picker is accepted
Available = 2 may be chosen
Unavailable = 3 shown, not to be chosen
Suspended = 5 not to be chosen
LockedActive = 7 kept in the party by the story; not to be let go

Functions

Accept()

Refusal Accept()

Accepts the party as the picker’s button does and closes it.

The party changes after, when the module’s scripts have had the picker’s events: wait for a frame or more before reading it.

Choose()

Refusal Choose(ObjectId creature)

Chooses a follower as a click on them does: their figure steps forward and they take a place.

Entries()

std::vector<Entry> Entries()

Returns the creatures the picker shows, in its order.

Call it, and the rest, on the game thread.

Returns none unless the party picker is the current mode and done showing

Release()

Refusal Release(ObjectId creature)

Lets a chosen follower go as a click on them, or on their portrait, does.

ReleaseAll()

Refusal ReleaseAll()

Lets every chosen follower go but the hero and those the story keeps, as Remove All does.