@drincs/pixi-vn 1.3.36 → 1.4.0

package/dist/{HistoryChoiceMenuOption-ZdrL_kYX.d.ts → HistoryChoiceMenuOption-BOHqf57l.d.ts}

@@ -1,4 +1,4 @@
-import { ChoiceInterface, CharacterInterface, GameStepState } from '@drincs/pixi-vn';
+import { ChoiceInterface, StepLabelProps, StepLabelResult, CharacterInterface, GameStepState } from '@drincs/pixi-vn';
 import deepDiff from 'deep-diff';
 import { Difference } from 'microdiff';
 import { a as StorageElementType } from './StorageElementType-dAIVJeiw.js';
@@ -42,6 +42,30 @@ type StoredIndexedChoiceInterface = StoredChoiceInterface & {
     choiceIndex: number;
 };
 
+/**
+ * Result of a {@link StepLabelType} execution.
+ *
+ * - `StepLabelResult`: a structured result consumed by the narration engine.
+ * - `void`: the step completed without returning an explicit result.
+ * - `string`: a simple token or message interpreted by higher-level logic.
+ *
+ * Prefer returning a well-typed {@link StepLabelResult} for anything that
+ * needs to be consumed programmatically. Use plain strings only where a
+ * lightweight, convention-based signal is sufficient and clearly documented
+ * by the surrounding game logic.
+ */
+type StepLabelResultType = StepLabelResult | void | string;
+type StepLabelPropsType<T extends {} = {}> = StepLabelProps & T;
+/**
+ * StepLabel is a function that will be executed as the game continues.
+ */
+type StepLabelType<T extends {} = {}> = (props: StepLabelPropsType<T>, info: {
+    /**
+     * The id of the label.
+     */
+    labelId: string;
+}) => StepLabelResultType | Promise<StepLabelResultType>;
+
 interface DialogueInterface {
     /**
      * The text of the dialogue.
@@ -161,4 +185,4 @@ type HistoryChoiceMenuOption = {
     hidden: boolean;
 };
 
-export { type ChoiceOptionInterface as C, type DialogueInterface as D, type HistoryStep as H, type LabelIdType as L, type NarrationHistory as N, type OpenedLabel as O, type StoredIndexedChoiceInterface as S, type LabelRunModeType as a, type CloseChoiceOptionInterface as b, type CloseType as c, type StoredChoiceInterface as d, Close as e, type HistoryChoiceMenuOption as f };
+export { type ChoiceOptionInterface as C, type DialogueInterface as D, type HistoryStep as H, type LabelIdType as L, type NarrationHistory as N, type OpenedLabel as O, type StepLabelType as S, type LabelRunModeType as a, type CloseChoiceOptionInterface as b, type CloseType as c, type StepLabelPropsType as d, type StepLabelResultType as e, type StoredIndexedChoiceInterface as f, type StoredChoiceInterface as g, Close as h, type HistoryChoiceMenuOption as i };

package/dist/{HistoryChoiceMenuOption-BjnxDyK5.d.cts → HistoryChoiceMenuOption-PzBGGqOC.d.cts}

@@ -1,4 +1,4 @@
-import { ChoiceInterface, CharacterInterface, GameStepState } from '@drincs/pixi-vn';
+import { ChoiceInterface, StepLabelProps, StepLabelResult, CharacterInterface, GameStepState } from '@drincs/pixi-vn';
 import deepDiff from 'deep-diff';
 import { Difference } from 'microdiff';
 import { a as StorageElementType } from './StorageElementType-dAIVJeiw.cjs';
@@ -42,6 +42,30 @@ type StoredIndexedChoiceInterface = StoredChoiceInterface & {
     choiceIndex: number;
 };
 
+/**
+ * Result of a {@link StepLabelType} execution.
+ *
+ * - `StepLabelResult`: a structured result consumed by the narration engine.
+ * - `void`: the step completed without returning an explicit result.
+ * - `string`: a simple token or message interpreted by higher-level logic.
+ *
+ * Prefer returning a well-typed {@link StepLabelResult} for anything that
+ * needs to be consumed programmatically. Use plain strings only where a
+ * lightweight, convention-based signal is sufficient and clearly documented
+ * by the surrounding game logic.
+ */
+type StepLabelResultType = StepLabelResult | void | string;
+type StepLabelPropsType<T extends {} = {}> = StepLabelProps & T;
+/**
+ * StepLabel is a function that will be executed as the game continues.
+ */
+type StepLabelType<T extends {} = {}> = (props: StepLabelPropsType<T>, info: {
+    /**
+     * The id of the label.
+     */
+    labelId: string;
+}) => StepLabelResultType | Promise<StepLabelResultType>;
+
 interface DialogueInterface {
     /**
      * The text of the dialogue.
@@ -161,4 +185,4 @@ type HistoryChoiceMenuOption = {
     hidden: boolean;
 };
 
-export { type ChoiceOptionInterface as C, type DialogueInterface as D, type HistoryStep as H, type LabelIdType as L, type NarrationHistory as N, type OpenedLabel as O, type StoredIndexedChoiceInterface as S, type LabelRunModeType as a, type CloseChoiceOptionInterface as b, type CloseType as c, type StoredChoiceInterface as d, Close as e, type HistoryChoiceMenuOption as f };
+export { type ChoiceOptionInterface as C, type DialogueInterface as D, type HistoryStep as H, type LabelIdType as L, type NarrationHistory as N, type OpenedLabel as O, type StepLabelType as S, type LabelRunModeType as a, type CloseChoiceOptionInterface as b, type CloseType as c, type StepLabelPropsType as d, type StepLabelResultType as e, type StoredIndexedChoiceInterface as f, type StoredChoiceInterface as g, Close as h, type HistoryChoiceMenuOption as i };