LSDE Dialog Engine / ChoiceContext
Interface: ChoiceContext
Defined in: types.ts:343
What a CHOICE handler gets.
Extends
Properties
actors
actors:
Card[]
Defined in: types.ts:316
Every card the block cites, resolved through the export's cards table, in file order.
Inherited from
character
character:
Card|undefined
Defined in: types.ts:314
The actor onResolveCharacter() picked for this block, or undefined.
A block lists a CAST in actors — card ids, in an order LSDE deliberately refuses to give a meaning to. Whether the first one speaks, whether they all do, whether the rest are simply present is the game's call, so the engine hands the whole list to onResolveCharacter() and keeps whatever comes back. It does not elect a first one, the way v1 did.
Inherited from
emotion
emotion:
Card|undefined
Defined in: types.ts:324
The emotion of the block, resolved through cards — the TONE of the line, not of a speaker.
In v1 each character carried its own emotion, which meant writing the same feeling twice for two actors saying one sentence, and being free to desynchronise them by accident. A block is one line and one line has one tone; actors says who may carry it.
Inherited from
intensity
intensity:
number|undefined
Defined in: types.ts:326
How strongly, when the writer set an emotion. Passed through untouched.
Inherited from
options
options:
RuntimeChoiceItem[]
Defined in: types.ts:351
EVERY option of the block, tagged. Not a shortened list.
With engine.onResolveCondition() installed, each carries visible: true | false; without one it is undefined — unknown, not hidden. Show the offered ones with options.filter( o => o.visible !== false ), or keep the rest to grey them out.
preventGlobalHandler
preventGlobalHandler: () =>
void
Defined in: types.ts:328
Stop the global (Tier 1) handler from running after this scene handler.
Returns
void
Inherited from
BaseBlockContext.preventGlobalHandler
selectChoice
selectChoice: (
optionId) =>void
Defined in: types.ts:353
Pick an option by its id (C1). That id is also the port the flow leaves by.
Parameters
optionId
string
Returns
void