Epok Engine

EPOK RUNTIME

Dialogue

dialogue.hpp · the dialogue module

Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.

Module

the dialogue module.

Header
dialogue.hpp
Include
#include "dialogue.hpp"
Stability
Engine internal

Include this module

C++ include
#include "dialogue.hpp"

Types

ActionType alias declared by the dialogue module for the dialogue module.Type aliasAssignmentStruct declared by the dialogue module for the dialogue module.StructBindingStruct declared by the dialogue module for the dialogue module.StructConditionType alias declared by the dialogue module for the dialogue module.Type aliasConversationStruct declared by the dialogue module for the dialogue module.StructDialoguePhaseEnum declared by the dialogue module for the dialogue module.EnumDialogueResultEnum declared by the dialogue module for the dialogue module.EnumEnteredType alias declared by the dialogue module for the dialogue module.Type aliasFinishedFinish notifications also identify the presenter.Type aliasKindEnum declared by the dialogue module for the dialogue module.EnumNodeStruct declared by the dialogue module for the dialogue module.StructOptionStruct declared by the dialogue module for the dialogue module.StructPageStruct declared by the dialogue module for the dialogue module.StructPhaseType alias declared by the dialogue module for the dialogue module.Type aliasResourceStruct declared by the dialogue module for the dialogue module.StructResultType alias declared by the dialogue module for the dialogue module.Type aliasRoleStruct declared by the dialogue module for the dialogue module.StructSessionClass declared by the dialogue module for the dialogue module.ClassSnapshotStruct declared by the dialogue module for the dialogue module.StructStartStruct declared by the dialogue module for the dialogue module.StructStartedType alias declared by the dialogue module for the dialogue module.Type aliasStyleSession policy only.StructTextStruct declared by the dialogue module for the dialogue module.StructTimingStruct declared by the dialogue module for the dialogue module.Struct

Functions and methods

activation_changedPerforms `activation changed` as part of the dialogue module.FunctionactivePerforms `active` as part of the dialogue module.MethodadvancePerforms `advance` as part of the dialogue module.MethodcancelPerforms `cancel` as part of the dialogue module.Methodchoice_idPerforms `choice id` as part of the dialogue module.Methodchoice_textPerforms `choice text` as part of the dialogue module.MethodinitiatorPerforms `initiator` as part of the dialogue module.Methodinvalidate_presenterPerforms `invalidate presenter` as part of the dialogue module.Methodmove_selectionPerforms `move selection` as part of the dialogue module.MethodpresenterPerforms `presenter` as part of the dialogue module.MethodprunePerforms `prune` as part of the dialogue module.MethodresetResets reset as part of the dialogue module.MethodresourcePerforms `resource` as part of the dialogue module.FunctionsessionPerforms `session` as part of the dialogue module.FunctionsnapshotPerforms `snapshot` as part of the dialogue module.MethodsourcePerforms `source` as part of the dialogue module.MethodspeakerPerforms `speaker` as part of the dialogue module.Methodspeaker_namePerforms `speaker name` as part of the dialogue module.Methodspeaker_portraitPerforms `speaker portrait` as part of the dialogue module.MethodstartStarts start as part of the dialogue module.Methodterminal_phasePerforms `terminal phase` as part of the dialogue module.FunctiontextPerforms `text` as part of the dialogue module.MethodupdateUpdates update as part of the dialogue module.Methodupdate_microsecondsUpdates microseconds as part of the dialogue module.Method

Fields, variables and values

AcceptedNamed value `Accepted` in `epok::DialogueResult`.Enum valueactionExposes `action` on `epok::dialogue::Binding` for the dialogue module.Fieldadvance_soundExposes `advance_sound` on `epok::dialogue::Style` for the dialogue module.Fieldauto_msExposes `auto_ms` on `epok::dialogue::Node` for the dialogue module.Fieldauto_msExposes `auto_ms` on `epok::dialogue::Timing` for the dialogue module.Fieldautomatic_inputExposes `automatic_input` on `epok::dialogue::Start` for the dialogue module.FieldbindingExposes `binding` on `epok::dialogue::Node` for the dialogue module.FieldbindingExposes `binding` on `epok::dialogue::Option` for the dialogue module.Fieldbinding_countExposes `binding_count` on `epok::dialogue::Conversation` for the dialogue module.FieldbindingsExposes `bindings` on `epok::dialogue::Conversation` for the dialogue module.FieldBranchNamed value `Branch` in `epok::dialogue::Kind`.Enum valueBusyNamed value `Busy` in `epok::DialogueResult`.Enum valueCancelledNamed value `Cancelled` in `epok::DialoguePhase`.Enum valueCaptureExhaustedNamed value `CaptureExhausted` in `epok::DialogueResult`.Enum valueCaptureLostNamed value `CaptureLost` in `epok::DialogueResult`.Enum valueChoiceNamed value `Choice` in `epok::dialogue::Kind`.Enum valuechoice_pageExposes `choice_page` on `epok::dialogue::Snapshot` for the dialogue module.FieldchoicesExposes `choices` on `epok::dialogue::Snapshot` for the dialogue module.Fieldclose_soundExposes `close_sound` on `epok::dialogue::Style` for the dialogue module.FieldCompletedNamed value `Completed` in `epok::DialoguePhase`.Enum valueCompletedNamed value `Completed` in `epok::DialogueResult`.Enum valueconditionExposes `condition` on `epok::dialogue::Binding` for the dialogue module.FieldconversationExposes `conversation` on `epok::dialogue::Resource` for the dialogue module.FieldconversationExposes `conversation` on `epok::dialogue::Snapshot` for the dialogue module.FieldDomainMismatchNamed value `DomainMismatch` in `epok::DialogueResult`.Enum valueEndNamed value `End` in `epok::dialogue::Kind`.Enum valueenteredExposes `entered` on `epok::dialogue::Start` for the dialogue module.FieldentryExposes `entry` on `epok::dialogue::Conversation` for the dialogue module.FieldEventNamed value `Event` in `epok::dialogue::Kind`.Enum valueExecutingNamed value `Executing` in `epok::DialoguePhase`.Enum valueFailedNamed value `Failed` in `epok::DialoguePhase`.Enum valuefinishedExposes `finished` on `epok::dialogue::Start` for the dialogue module.FieldgenerationExposes `generation` on `epok::dialogue::Snapshot` for the dialogue module.FieldGenerationExhaustedNamed value `GenerationExhausted` in `epok::DialogueResult`.Enum valueglyphsExposes `glyphs` on `epok::dialogue::Page` for the dialogue module.FieldglyphsExposes `glyphs` on `epok::dialogue::Snapshot` for the dialogue module.FieldidExposes `id` on `epok::dialogue::Conversation` for the dialogue module.FieldidExposes `id` on `epok::dialogue::Node` for the dialogue module.FieldidExposes `id` on `epok::dialogue::Option` for the dialogue module.FieldidExposes `id` on `epok::dialogue::Role` for the dialogue module.FieldIdleNamed value `Idle` in `epok::DialoguePhase`.Enum valueinitiatorExposes `initiator` on `epok::dialogue::Start` for the dialogue module.FieldInvalidBindingNamed value `InvalidBinding` in `epok::DialogueResult`.Enum valueInvalidDataNamed value `InvalidData` in `epok::DialogueResult`.Enum valueInvalidOwnerNamed value `InvalidOwner` in `epok::DialogueResult`.Enum valuekindExposes `kind` on `epok::dialogue::Node` for the dialogue module.Fieldlanguage_countExposes `language_count` on `epok::dialogue::Text` for the dialogue module.Fieldlanguage_offsetslanguage-major page ranges; language_count + 1 offsets.FieldLevelUnloadedNamed value `LevelUnloaded` in `epok::DialogueResult`.Enum valueLineNamed value `Line` in `epok::dialogue::Kind`.Enum valuemax_optionsExposes `max_options` on the `epok::dialogue` namespace for the dialogue module.Variablemax_rolesExposes `max_roles` on the `epok::dialogue` namespace for the dialogue module.Variablemax_transitionsExposes `max_transitions` on the `epok::dialogue` namespace for the dialogue module.VariablemissingExposes `missing` on the `epok::dialogue` namespace for the dialogue module.VariableMissingPresenterNamed value `MissingPresenter` in `epok::DialogueResult`.Enum valuenameExposes `name` on `epok::dialogue::Role` for the dialogue module.FieldnextExposes `next` on `epok::dialogue::Node` for the dialogue module.FieldnextExposes `next` on `epok::dialogue::Option` for the dialogue module.Fieldno_roleExposes `no_role` on the `epok::dialogue` namespace for the dialogue module.VariableNoChoicesNamed value `NoChoices` in `epok::DialogueResult`.Enum valuenodeExposes `node` on `epok::dialogue::Snapshot` for the dialogue module.Fieldnode_countExposes `node_count` on `epok::dialogue::Conversation` for the dialogue module.FieldnodesExposes `nodes` on `epok::dialogue::Conversation` for the dialogue module.FieldNoSessionNamed value `NoSession` in `epok::DialogueResult`.Enum valueopen_soundExposes `open_sound` on `epok::dialogue::Style` for the dialogue module.Fieldoption_countExposes `option_count` on `epok::dialogue::Node` for the dialogue module.FieldoptionsExposes `options` on `epok::dialogue::Node` for the dialogue module.FieldotherwiseExposes `otherwise` on `epok::dialogue::Node` for the dialogue module.FieldOutOfRangeNamed value `OutOfRange` in `epok::DialogueResult`.Enum valueownerExposes `owner` on `epok::dialogue::Start` for the dialogue module.FieldpageExposes `page` on `epok::dialogue::Snapshot` for the dialogue module.Fieldpage_countExposes `page_count` on `epok::dialogue::Text` for the dialogue module.FieldpagesExposes `pages` on `epok::dialogue::Snapshot` for the dialogue module.FieldpagesExposes `pages` on `epok::dialogue::Text` for the dialogue module.FieldphaseExposes `phase` on `epok::dialogue::Snapshot` for the dialogue module.FieldportExposes `port` on `epok::dialogue::Snapshot` for the dialogue module.FieldportExposes `port` on `epok::dialogue::Start` for the dialogue module.FieldportraitExposes `portrait` on `epok::dialogue::Role` for the dialogue module.FieldpresentationExposes `presentation` on `epok::dialogue::Resource` for the dialogue module.FieldpresenterExposes `presenter` on `epok::dialogue::Start` for the dialogue module.FieldPresenterUnavailableNamed value `PresenterUnavailable` in `epok::DialogueResult`.Enum valuereceiverExposes `receiver` on `epok::dialogue::Assignment` for the dialogue module.Fieldreceiver_classExposes `receiver_class` on `epok::dialogue::Binding` for the dialogue module.Fieldresource_countExposes `resource_count` on the `epok::dialogue` namespace for the dialogue module.VariableresourcesEmitted once by the host cook beside scene data, as with object_classes.VariableresultExposes `result` on `epok::dialogue::Snapshot` for the dialogue module.Fieldreveal_msSentinels inherit style timing.Fieldreveal_msExposes `reveal_ms` on `epok::dialogue::Timing` for the dialogue module.FieldrevealedExposes `revealed` on `epok::dialogue::Snapshot` for the dialogue module.FieldRevealingNamed value `Revealing` in `epok::DialoguePhase`.Enum valueroleExposes `role` on `epok::dialogue::Assignment` for the dialogue module.FieldroleExposes `role` on `epok::dialogue::Binding` for the dialogue module.Fieldrole_countExposes `role_count` on `epok::dialogue::Conversation` for the dialogue module.Fieldrole_countExposes `role_count` on `epok::dialogue::Start` for the dialogue module.FieldrolesExposes `roles` on `epok::dialogue::Conversation` for the dialogue module.FieldrolesExposes `roles` on `epok::dialogue::Start` for the dialogue module.FieldselectedExposes `selected` on `epok::dialogue::Snapshot` for the dialogue module.FieldSelectingNamed value `Selecting` in `epok::DialoguePhase`.Enum valueSourceUnavailableNamed value `SourceUnavailable` in `epok::DialogueResult`.Enum valuespeakerExposes `speaker` on `epok::dialogue::Node` for the dialogue module.FieldstartedExposes `started` on `epok::dialogue::Start` for the dialogue module.FieldstyleExposes `style` on `epok::dialogue::Resource` for the dialogue module.FieldtableExposes `table` on `epok::dialogue::Resource` for the dialogue module.FieldtextExposes `text` on `epok::dialogue::Node` for the dialogue module.FieldtextExposes `text` on `epok::dialogue::Option` for the dialogue module.FieldtextExposes `text` on `epok::dialogue::Page` for the dialogue module.Fieldtext_countExposes `text_count` on `epok::dialogue::Conversation` for the dialogue module.FieldtextsExposes `texts` on `epok::dialogue::Conversation` for the dialogue module.FieldtimingExposes `timing` on `epok::dialogue::Start` for the dialogue module.FieldtimingExposes `timing` on `epok::dialogue::Style` for the dialogue module.FieldTransitionBudgetNamed value `TransitionBudget` in `epok::DialogueResult`.Enum valueUnavailableNamed value `Unavailable` in `epok::DialogueResult`.Enum valueUserCancelledNamed value `UserCancelled` in `epok::DialogueResult`.Enum valuevisible_optionsExposes `visible_options` on the `epok::dialogue` namespace for the dialogue module.VariableWaitingNamed value `Waiting` in `epok::DialoguePhase`.Enum valuewidgetExposes `widget` on `epok::dialogue::Resource` for the dialogue module.Field