point-click-lib 0.0.7 → 0.0.9

package/dist/point-click-lib.d.ts

@@ -1,3 +1,5 @@
+import { default as default_2 } from 'zod';
+import { XY } from 'typed-geometry';
 import { z } from 'zod';
 
 export declare type ActorData = z.infer<typeof ActorDataSchema>;
@@ -237,6 +239,8 @@ declare const actStepSchema: z.ZodObject<{
     timeElapsed?: number | undefined;
 }>;
 
+export declare const advanceTimeOneStep: (props: GameRunnerProps, eventReporter: InGameEventReporter, debugLogger: LogToDebug) => (state: GameData) => void;
+
 export declare const AmbientNoiseConsequenceSchema: z.ZodObject<{
     type: z.ZodLiteral<"ambientNoise">;
     sound: z.ZodOptional<z.ZodString>;
@@ -391,6 +395,12 @@ export declare type BoardProgression = z.infer<typeof BoardProgressionSchema>;
 
 export declare const BoardProgressionSchema: z.ZodEnum<["sound", "buttons"]>;
 
+export declare const CELL_SIZE = 5;
+
+export declare type CellMatrix = default_2.infer<typeof cellMatrixSchema>;
+
+export declare const cellMatrixSchema: default_2.ZodArray<default_2.ZodArray<default_2.ZodUnion<[default_2.ZodLiteral<0>, default_2.ZodLiteral<1>]>, "many">, "many">;
+
 export declare const changeHistory: VersionChange[];
 
 export declare const ChangePlayerCharacterConsequenceSchema: z.ZodObject<{
@@ -3507,6 +3517,13 @@ export declare const consequenceTypes: ConsequenceType[];
 
 export declare type ConsequenceWithDeprecated = z.infer<typeof ConsequenceSchemaWithDeprecated>;
 
+/**
+ * Takes the next step in the sequence, shifting stages the array
+ * when the stage is complete, until the sequence has finished
+ * @returns a partial state
+ */
+export declare const continueSequence: (props: GameRunnerProps, eventReporter: InGameEventReporter, debugLogger: LogToDebug) => (state: GameData) => Partial<GameData>;
+
 export declare type Conversation = z.infer<typeof ConversationSchema>;
 
 export declare type ConversationBranch = z.infer<typeof ConversationBranchSchema>;
@@ -12539,6 +12556,18 @@ export declare type ConversationWithDeprecatedConsequences = z.infer<typeof Conv
 
 export declare const DB_VERSION = 4;
 
+export declare const DEFAULT_ANIMATION: {
+    readonly say: "talk";
+    readonly move: "walk";
+    readonly goTo: "walk";
+    readonly wait: "default";
+    readonly act: "default";
+};
+
+export declare const DEFAULT_TALK_TIME = 200;
+
+export declare const describeCommand: (command: Command, useNames?: boolean) => string;
+
 declare type DesignParseResult = {
     success: true;
     gameDesign: GameDesign;
@@ -12611,6 +12640,13 @@ export declare const EndingSchema: z.ZodObject<{
     imageWidth?: number | undefined;
 }>;
 
+export declare function findPath(start: XY, goal: XY, matrix: CellMatrix, cellSize: number): XY[];
+
+export declare function findTarget(ids: {
+    targetId?: string;
+    roomId?: string;
+}, gameContents: GameContents, excludeItems?: boolean): CommandTarget | undefined;
+
 export declare type FixedGameInfo = z.infer<typeof FixedGameInfoSchema>;
 
 export declare const FixedGameInfoSchema: z.ZodObject<{
@@ -27967,6 +28003,9 @@ export declare const GameDataSchema: z.ZodIntersection<z.ZodObject<{
         requiredInventory?: string[] | undefined;
     }>>;
     gameNotBegun: z.ZodBoolean;
+    cellMatrix: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodUnion<[z.ZodLiteral<0>, z.ZodLiteral<1>]>, "many">, "many">>;
+    viewAngleX: z.ZodNumber;
+    viewAngleY: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
     actorOrders: Record<string, ({
         type: "move";
@@ -28027,6 +28066,8 @@ export declare const GameDataSchema: z.ZodIntersection<z.ZodObject<{
         endStatus?: string | undefined;
     })[]>;
     gameNotBegun: boolean;
+    viewAngleX: number;
+    viewAngleY: number;
     sequenceRunning?: {
         id: string;
         stages: {
@@ -28395,6 +28436,7 @@ export declare const GameDataSchema: z.ZodIntersection<z.ZodObject<{
         flagsThatMustBeTrue?: string[] | undefined;
         requiredInventory?: string[] | undefined;
     } | undefined;
+    cellMatrix?: (0 | 1)[][] | undefined;
 }, {
     actorOrders: Record<string, ({
         type: "move";
@@ -28455,6 +28497,8 @@ export declare const GameDataSchema: z.ZodIntersection<z.ZodObject<{
         endStatus?: string | undefined;
     })[]>;
     gameNotBegun: boolean;
+    viewAngleX: number;
+    viewAngleY: number;
     sequenceRunning?: {
         id: string;
         stages: {
@@ -28823,6 +28867,7 @@ export declare const GameDataSchema: z.ZodIntersection<z.ZodObject<{
         flagsThatMustBeTrue?: string[] | undefined;
         requiredInventory?: string[] | undefined;
     } | undefined;
+    cellMatrix?: (0 | 1)[][] | undefined;
 }>>;
 
 export declare type GameDesign = z.infer<typeof GameDesignSchema>;
@@ -38885,6 +38930,9 @@ export declare const GameHappeningsSchema: z.ZodObject<{
         requiredInventory?: string[] | undefined;
     }>>;
     gameNotBegun: z.ZodBoolean;
+    cellMatrix: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodUnion<[z.ZodLiteral<0>, z.ZodLiteral<1>]>, "many">, "many">>;
+    viewAngleX: z.ZodNumber;
+    viewAngleY: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
     actorOrders: Record<string, ({
         type: "move";
@@ -38945,6 +38993,8 @@ export declare const GameHappeningsSchema: z.ZodObject<{
         endStatus?: string | undefined;
     })[]>;
     gameNotBegun: boolean;
+    viewAngleX: number;
+    viewAngleY: number;
     sequenceRunning?: {
         id: string;
         stages: {
@@ -39313,6 +39363,7 @@ export declare const GameHappeningsSchema: z.ZodObject<{
         flagsThatMustBeTrue?: string[] | undefined;
         requiredInventory?: string[] | undefined;
     } | undefined;
+    cellMatrix?: (0 | 1)[][] | undefined;
 }, {
     actorOrders: Record<string, ({
         type: "move";
@@ -39373,6 +39424,8 @@ export declare const GameHappeningsSchema: z.ZodObject<{
         endStatus?: string | undefined;
     })[]>;
     gameNotBegun: boolean;
+    viewAngleX: number;
+    viewAngleY: number;
     sequenceRunning?: {
         id: string;
         stages: {
@@ -39741,8 +39794,29 @@ export declare const GameHappeningsSchema: z.ZodObject<{
         flagsThatMustBeTrue?: string[] | undefined;
         requiredInventory?: string[] | undefined;
     } | undefined;
+    cellMatrix?: (0 | 1)[][] | undefined;
 }>;
 
+export declare type GameRunnerProps = GameDesign & GameRuntimeOptions;
+
+export declare type GameRuntimeOptions = {
+    instantMode?: boolean;
+    orderSpeed?: number;
+    playSound: PlaySound;
+    cellSize: number;
+    defaultTalkTime: number;
+};
+
+export declare function generateCellMatrix(roomData: RoomData, cellSize: number): CellMatrix;
+
+export declare function getDefaultResponseText(command: Command, unreachable: boolean): string;
+
+export declare function getTargetPoint(target: ActorData | HotspotZone, roomData: RoomData): XY;
+
+export declare function getViewAngleXCenteredOn(xPosition: number, roomData: RoomData): number;
+
+export declare function getViewAngleYCenteredOn(yPosition: number, roomData: RoomData): number;
+
 export declare type GotoOrder = z.infer<typeof GotoOrderSchema>;
 
 export declare const GotoOrderSchema: z.ZodObject<{
@@ -39788,6 +39862,8 @@ export declare const GotoOrderSchema: z.ZodObject<{
     speed?: number | undefined;
 }>;
 
+export declare const handleConversationChoice: ({ sequences, defaultTalkTime }: GameRunnerProps, debugLogger: LogToDebug) => (state: GameData, choice: ConversationChoice) => GameData;
+
 export declare type HotspotZone = z.infer<typeof HotspotZoneSchema>;
 
 export declare const HotspotZoneSchema: z.ZodObject<{
@@ -40642,6 +40718,14 @@ export declare const ImmediateConsequenceSchemaWithDeprecated: z.ZodUnion<[z.Zod
 
 export declare const immediateConsequenceTypes: ConsequenceType[];
 
+export declare interface InGameEventReporter {
+    reportConsequence: (consequence: Consequence, success: boolean, offscreen: boolean) => void;
+    reportCommand: (command: Command) => void;
+    reportOrder: (order: Order, actor: ActorData) => void;
+    reportStage: (stage: Stage) => void;
+    reportCurrentConversation: () => void;
+}
+
 export declare type Interaction = z.infer<typeof InteractionSchema>;
 
 export declare const InteractionSchema: z.ZodObject<{
@@ -42995,6 +43079,8 @@ export declare const InventoryConsequenceSchema: z.ZodObject<{
     actorId?: string | undefined;
 }>;
 
+export declare const issueMoveOrder: (props: GameRunnerProps, debugLogger?: LogToDebug) => (state: GameData, destination: XY, actorId: string, appendToExisting?: boolean, ignoreObstacles?: boolean) => Partial<GameData>;
+
 export declare type ItemData = z.infer<typeof ItemDataSchema>;
 
 export declare const ItemDataSchema: z.ZodIntersection<z.ZodObject<{
@@ -43030,6 +43116,12 @@ export declare const ItemDataSchema: z.ZodIntersection<z.ZodObject<{
     row?: number | undefined;
 }>>;
 
+export declare type LogToDebug = (message: string, subject?: string) => void;
+
+export declare const makeCommandHandler: (props: GameRunnerProps, eventReporter: InGameEventReporter, debugLogger?: LogToDebug) => (state: GameData, command: Command) => GameData;
+
+export declare function matchInteraction(command: Command, room: RoomData | undefined, interactions: Interaction[], gameState: GameData): Interaction | undefined;
+
 export declare type MoveOrder = z.infer<typeof MoveOrderSchema>;
 
 export declare const MoveOrderSchema: z.ZodObject<{
@@ -43780,6 +43872,10 @@ declare const PagePictureSchema: z.ZodObject<{
 
 export declare const parseAndUpgrade: (maybeGameDesign: unknown) => DesignParseResult;
 
+export declare interface PlaySound {
+    (soundId: string, volume?: number): boolean;
+}
+
 export declare type Polygon = z.infer<typeof PolygonSchema>;
 
 declare const PolygonSchema: z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">;
@@ -63860,6 +63956,12 @@ export declare type VersionChange = {
     }[];
 };
 
+export declare const wildCard: {
+    readonly ITEM: "$ITEM";
+    readonly TARGET: "$TARGET";
+    readonly VERB: "$VERB";
+};
+
 export declare const xPlacement: z.ZodEnum<["center", "left", "right"]>;
 
 export declare const yPlacement: z.ZodEnum<["center", "top", "bottom"]>;