narrat 2.2.14 → 2.2.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (106) hide show
  1. package/LICENSE +21 -21
  2. package/dist/app.vue.d.ts +98 -92
  3. package/dist/components/MainMenu.vue.d.ts +12 -12
  4. package/dist/components/Skills.vue.d.ts +22 -22
  5. package/dist/components/StartMenu.vue.d.ts +46 -46
  6. package/dist/components/debug/debug-menu.vue.d.ts +48 -48
  7. package/dist/components/dialog-picture.vue.d.ts +9 -9
  8. package/dist/components/game-dialog.vue.d.ts +65 -65
  9. package/dist/components/hud.vue.d.ts +14 -14
  10. package/dist/components/in-game.vue.d.ts +46 -0
  11. package/dist/components/inventory-ui.vue.d.ts +30 -30
  12. package/dist/components/loading-bar.vue.d.ts +10 -10
  13. package/dist/components/menu-buttons.vue.d.ts +26 -26
  14. package/dist/components/notification-toast.vue.d.ts +6 -6
  15. package/dist/components/quests-ui.vue.d.ts +20 -20
  16. package/dist/components/save-slots.vue.d.ts +79 -58
  17. package/dist/components/saves/save-slot.vue.d.ts +108 -0
  18. package/dist/components/screen-layer.vue.d.ts +76 -76
  19. package/dist/components/screens.vue.d.ts +46 -46
  20. package/dist/components/transitions/NarratTransition.vue.d.ts +101 -101
  21. package/dist/components/utils/alert-modal.vue.d.ts +82 -0
  22. package/dist/components/utils/modal.vue.d.ts +18 -6
  23. package/dist/components/utils/yes-no.vue.d.ts +106 -0
  24. package/dist/components/volume-controls.vue.d.ts +18 -18
  25. package/dist/config.d.ts +181 -178
  26. package/dist/constants.d.ts +8 -8
  27. package/dist/defaultConfig.d.ts +2 -2
  28. package/dist/demo/demo.d.ts +1 -1
  29. package/dist/dialog-box.vue.d.ts +41 -41
  30. package/dist/exports/config.d.ts +1 -1
  31. package/dist/exports/display.d.ts +2 -2
  32. package/dist/exports/plugins.d.ts +20 -20
  33. package/dist/favicon.svg +30 -30
  34. package/dist/lib.d.ts +14 -14
  35. package/dist/main.d.ts +6 -6
  36. package/dist/narrat.es.js +9866 -9519
  37. package/dist/narrat.es.js.map +1 -1
  38. package/dist/narrat.umd.js +79 -79
  39. package/dist/narrat.umd.js.map +1 -1
  40. package/dist/plugins/NarratPlugin.d.ts +11 -11
  41. package/dist/stores/audio-store.d.ts +48 -48
  42. package/dist/stores/dialog-store.d.ts +32 -32
  43. package/dist/stores/hud-stats-store.d.ts +22 -22
  44. package/dist/stores/inventory-store.d.ts +37 -37
  45. package/dist/stores/main-store.d.ts +727 -391
  46. package/dist/stores/notification-store.d.ts +15 -15
  47. package/dist/stores/quest-log.d.ts +39 -39
  48. package/dist/stores/rendering-store.d.ts +13 -13
  49. package/dist/stores/screens-store.d.ts +35 -35
  50. package/dist/stores/skills.d.ts +40 -40
  51. package/dist/stores/vm-store.d.ts +180 -178
  52. package/dist/style.css +1 -1
  53. package/dist/types/app-types.d.ts +5 -5
  54. package/dist/types/character-types.d.ts +27 -27
  55. package/dist/types/dialog-box-types.d.ts +11 -11
  56. package/dist/types/game-save.d.ts +36 -30
  57. package/dist/types/parser.d.ts +93 -93
  58. package/dist/types/state.d.ts +3 -3
  59. package/dist/utils/InputsListener.d.ts +9 -9
  60. package/dist/utils/ajax.d.ts +1 -1
  61. package/dist/utils/audio-loader.d.ts +10 -10
  62. package/dist/utils/characters.d.ts +5 -5
  63. package/dist/utils/data-helpers.d.ts +25 -25
  64. package/dist/utils/debounce.d.ts +14 -14
  65. package/dist/utils/error-handling.d.ts +3 -3
  66. package/dist/utils/helpers.d.ts +6 -6
  67. package/dist/utils/images-loader.d.ts +6 -6
  68. package/dist/utils/logger.d.ts +11 -11
  69. package/dist/utils/object-iterators.d.ts +8 -8
  70. package/dist/utils/promises.d.ts +1 -1
  71. package/dist/utils/randomId.d.ts +1 -1
  72. package/dist/utils/save-helpers.d.ts +18 -15
  73. package/dist/utils/skillchecks.d.ts +17 -17
  74. package/dist/utils/string-helpers.d.ts +3 -3
  75. package/dist/utils/time-helpers.d.ts +2 -2
  76. package/dist/utils/transition.d.ts +15 -15
  77. package/dist/utils/type-utils.d.ts +1 -1
  78. package/dist/utils/typed-emitter.d.ts +18 -18
  79. package/dist/vm/commands/arithmetic-commands.d.ts +23 -23
  80. package/dist/vm/commands/audio-commands.d.ts +15 -15
  81. package/dist/vm/commands/choice.d.ts +37 -37
  82. package/dist/vm/commands/clear_dialog.d.ts +2 -2
  83. package/dist/vm/commands/command-helpers.d.ts +3 -3
  84. package/dist/vm/commands/command-plugin.d.ts +43 -43
  85. package/dist/vm/commands/flow-commands.d.ts +24 -18
  86. package/dist/vm/commands/if.d.ts +10 -10
  87. package/dist/vm/commands/index.d.ts +2 -2
  88. package/dist/vm/commands/inventory-commands.d.ts +15 -15
  89. package/dist/vm/commands/logic-command.d.ts +42 -42
  90. package/dist/vm/commands/math-commands.d.ts +30 -30
  91. package/dist/vm/commands/notify.d.ts +6 -6
  92. package/dist/vm/commands/quest-commands.d.ts +30 -30
  93. package/dist/vm/commands/random-commands.d.ts +10 -10
  94. package/dist/vm/commands/screen-commands.d.ts +15 -15
  95. package/dist/vm/commands/set.d.ts +6 -6
  96. package/dist/vm/commands/skill-commands.d.ts +30 -30
  97. package/dist/vm/commands/stats-commands.d.ts +12 -12
  98. package/dist/vm/commands/string-commands.d.ts +9 -9
  99. package/dist/vm/commands/text-field.d.ts +7 -7
  100. package/dist/vm/commands/text.d.ts +14 -14
  101. package/dist/vm/commands/wait.d.ts +4 -4
  102. package/dist/vm/vm-helpers.d.ts +18 -18
  103. package/dist/vm/vm-parser.d.ts +19 -19
  104. package/dist/vm/vm-parser.test.d.ts +1 -1
  105. package/dist/vm/vm.d.ts +18 -18
  106. package/package.json +1 -1
@@ -0,0 +1,82 @@
1
+ declare const _default: {
2
+ new (...args: any[]): {
3
+ $: import("vue").ComponentInternalInstance;
4
+ $data: {};
5
+ $props: Partial<{}> & Omit<Readonly<import("vue").ExtractPropTypes<{
6
+ title: {
7
+ type: StringConstructor;
8
+ required: false;
9
+ };
10
+ text: {
11
+ type: StringConstructor;
12
+ required: false;
13
+ };
14
+ }>> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, never>;
15
+ $attrs: {
16
+ [x: string]: unknown;
17
+ };
18
+ $refs: {
19
+ [x: string]: unknown;
20
+ };
21
+ $slots: Readonly<{
22
+ [name: string]: import("vue").Slot | undefined;
23
+ }>;
24
+ $root: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}>> | null;
25
+ $parent: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}>> | null;
26
+ $emit: (event: string, ...args: any[]) => void;
27
+ $el: any;
28
+ $options: import("vue").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<{
29
+ title: {
30
+ type: StringConstructor;
31
+ required: false;
32
+ };
33
+ text: {
34
+ type: StringConstructor;
35
+ required: false;
36
+ };
37
+ }>>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, {}> & {
38
+ beforeCreate?: ((() => void) | (() => void)[]) | undefined;
39
+ created?: ((() => void) | (() => void)[]) | undefined;
40
+ beforeMount?: ((() => void) | (() => void)[]) | undefined;
41
+ mounted?: ((() => void) | (() => void)[]) | undefined;
42
+ beforeUpdate?: ((() => void) | (() => void)[]) | undefined;
43
+ updated?: ((() => void) | (() => void)[]) | undefined;
44
+ activated?: ((() => void) | (() => void)[]) | undefined;
45
+ deactivated?: ((() => void) | (() => void)[]) | undefined;
46
+ beforeDestroy?: ((() => void) | (() => void)[]) | undefined;
47
+ beforeUnmount?: ((() => void) | (() => void)[]) | undefined;
48
+ destroyed?: ((() => void) | (() => void)[]) | undefined;
49
+ unmounted?: ((() => void) | (() => void)[]) | undefined;
50
+ renderTracked?: (((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[]) | undefined;
51
+ renderTriggered?: (((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[]) | undefined;
52
+ errorCaptured?: (((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}>> | null, info: string) => boolean | void) | ((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}>> | null, info: string) => boolean | void)[]) | undefined;
53
+ };
54
+ $forceUpdate: () => void;
55
+ $nextTick: typeof import("vue").nextTick;
56
+ $watch(source: string | Function, cb: Function, options?: import("vue").WatchOptions<boolean> | undefined): import("vue").WatchStopHandle;
57
+ } & Readonly<import("vue").ExtractPropTypes<{
58
+ title: {
59
+ type: StringConstructor;
60
+ required: false;
61
+ };
62
+ text: {
63
+ type: StringConstructor;
64
+ required: false;
65
+ };
66
+ }>> & import("vue").ShallowUnwrapRef<{}> & {} & import("vue").ComponentCustomProperties;
67
+ __isFragment?: undefined;
68
+ __isTeleport?: undefined;
69
+ __isSuspense?: undefined;
70
+ } & import("vue").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<{
71
+ title: {
72
+ type: StringConstructor;
73
+ required: false;
74
+ };
75
+ text: {
76
+ type: StringConstructor;
77
+ required: false;
78
+ };
79
+ }>>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, {}> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & (new () => {
80
+ $slots: {};
81
+ });
82
+ export default _default;
@@ -1,6 +1,18 @@
1
- declare const _default: import("vue").DefineComponent<{
2
- containerCssClass: StringConstructor;
3
- }, unknown, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
4
- containerCssClass: StringConstructor;
5
- }>>, {}>;
6
- export default _default;
1
+ declare const _default: import("vue").DefineComponent<{
2
+ containerCssClass: StringConstructor;
3
+ cantClose: {
4
+ type: BooleanConstructor;
5
+ default: boolean;
6
+ };
7
+ }, unknown, unknown, {}, {
8
+ close(): void;
9
+ }, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
10
+ containerCssClass: StringConstructor;
11
+ cantClose: {
12
+ type: BooleanConstructor;
13
+ default: boolean;
14
+ };
15
+ }>>, {
16
+ cantClose: boolean;
17
+ }>;
18
+ export default _default;
@@ -0,0 +1,106 @@
1
+ declare const _default: {
2
+ new (...args: any[]): {
3
+ $: import("vue").ComponentInternalInstance;
4
+ $data: {};
5
+ $props: Partial<{}> & Omit<Readonly<import("vue").ExtractPropTypes<{
6
+ prompt: {
7
+ type: StringConstructor;
8
+ required: true;
9
+ };
10
+ onConfirm: {
11
+ type: FunctionConstructor;
12
+ required: false;
13
+ };
14
+ onRefuse: {
15
+ type: FunctionConstructor;
16
+ required: false;
17
+ };
18
+ }>> & {
19
+ onChoice?: ((...args: any[]) => any) | undefined;
20
+ } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, never>;
21
+ $attrs: {
22
+ [x: string]: unknown;
23
+ };
24
+ $refs: {
25
+ [x: string]: unknown;
26
+ };
27
+ $slots: Readonly<{
28
+ [name: string]: import("vue").Slot | undefined;
29
+ }>;
30
+ $root: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}>> | null;
31
+ $parent: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}>> | null;
32
+ $emit: (event: "choice", ...args: any[]) => void;
33
+ $el: any;
34
+ $options: import("vue").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<{
35
+ prompt: {
36
+ type: StringConstructor;
37
+ required: true;
38
+ };
39
+ onConfirm: {
40
+ type: FunctionConstructor;
41
+ required: false;
42
+ };
43
+ onRefuse: {
44
+ type: FunctionConstructor;
45
+ required: false;
46
+ };
47
+ }>> & {
48
+ onChoice?: ((...args: any[]) => any) | undefined;
49
+ }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "choice"[], string, {}> & {
50
+ beforeCreate?: ((() => void) | (() => void)[]) | undefined;
51
+ created?: ((() => void) | (() => void)[]) | undefined;
52
+ beforeMount?: ((() => void) | (() => void)[]) | undefined;
53
+ mounted?: ((() => void) | (() => void)[]) | undefined;
54
+ beforeUpdate?: ((() => void) | (() => void)[]) | undefined;
55
+ updated?: ((() => void) | (() => void)[]) | undefined;
56
+ activated?: ((() => void) | (() => void)[]) | undefined;
57
+ deactivated?: ((() => void) | (() => void)[]) | undefined;
58
+ beforeDestroy?: ((() => void) | (() => void)[]) | undefined;
59
+ beforeUnmount?: ((() => void) | (() => void)[]) | undefined;
60
+ destroyed?: ((() => void) | (() => void)[]) | undefined;
61
+ unmounted?: ((() => void) | (() => void)[]) | undefined;
62
+ renderTracked?: (((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[]) | undefined;
63
+ renderTriggered?: (((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[]) | undefined;
64
+ errorCaptured?: (((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}>> | null, info: string) => boolean | void) | ((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}>> | null, info: string) => boolean | void)[]) | undefined;
65
+ };
66
+ $forceUpdate: () => void;
67
+ $nextTick: typeof import("vue").nextTick;
68
+ $watch(source: string | Function, cb: Function, options?: import("vue").WatchOptions<boolean> | undefined): import("vue").WatchStopHandle;
69
+ } & Readonly<import("vue").ExtractPropTypes<{
70
+ prompt: {
71
+ type: StringConstructor;
72
+ required: true;
73
+ };
74
+ onConfirm: {
75
+ type: FunctionConstructor;
76
+ required: false;
77
+ };
78
+ onRefuse: {
79
+ type: FunctionConstructor;
80
+ required: false;
81
+ };
82
+ }>> & {
83
+ onChoice?: ((...args: any[]) => any) | undefined;
84
+ } & import("vue").ShallowUnwrapRef<{}> & {} & import("vue").ComponentCustomProperties;
85
+ __isFragment?: undefined;
86
+ __isTeleport?: undefined;
87
+ __isSuspense?: undefined;
88
+ } & import("vue").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<{
89
+ prompt: {
90
+ type: StringConstructor;
91
+ required: true;
92
+ };
93
+ onConfirm: {
94
+ type: FunctionConstructor;
95
+ required: false;
96
+ };
97
+ onRefuse: {
98
+ type: FunctionConstructor;
99
+ required: false;
100
+ };
101
+ }>> & {
102
+ onChoice?: ((...args: any[]) => any) | undefined;
103
+ }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "choice"[], "choice", {}> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & (new () => {
104
+ $slots: {};
105
+ });
106
+ export default _default;
@@ -1,18 +1,18 @@
1
- import { AudioModeKey } from '../stores/audio-store';
2
- declare const _default: import("vue").DefineComponent<{}, {}, {
3
- muted: boolean;
4
- volumes: {
5
- mode: 'master' | AudioModeKey;
6
- volume: number;
7
- }[];
8
- modeNames: {
9
- master: string;
10
- music: string;
11
- ambiant: string;
12
- sound: string;
13
- };
14
- }, {}, {
15
- changeVolume(mode: 'master' | AudioModeKey, event: Event): void;
16
- toggleMute(): void;
17
- }, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, import("vue").EmitsOptions, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}>;
18
- export default _default;
1
+ import { AudioModeKey } from '../stores/audio-store';
2
+ declare const _default: import("vue").DefineComponent<{}, {}, {
3
+ muted: boolean;
4
+ volumes: {
5
+ mode: 'master' | AudioModeKey;
6
+ volume: number;
7
+ }[];
8
+ modeNames: {
9
+ master: string;
10
+ music: string;
11
+ ambiant: string;
12
+ sound: string;
13
+ };
14
+ }, {}, {
15
+ changeVolume(mode: 'master' | AudioModeKey, event: Event): void;
16
+ toggleMute(): void;
17
+ }, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, import("vue").EmitsOptions, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}>;
18
+ export default _default;
package/dist/config.d.ts CHANGED
@@ -1,178 +1,181 @@
1
- import { TransitionSettings } from './utils/transition';
2
- export declare function setConfig(conf: Config): void;
3
- export declare function getConfig(): Config;
4
- export declare function getSkillConfig(id: string): SkillData;
5
- export declare function getImageUrl(imageKeyOrUrl: string): string;
6
- export declare function getAssetUrl(assetPath: string): string;
7
- export declare function getButtonConfig(button: string): ButtonConfig;
8
- export declare function getItemConfig(id: string): ItemData;
9
- export declare function getQuestConfig(questId: string): QuestData;
10
- export declare function getObjectiveConfig(quest: string, objectiveId: string): ObjectiveData;
11
- export interface AppOptions {
12
- baseAssetsPath?: string;
13
- logging: boolean;
14
- debug: boolean;
15
- }
16
- export interface Config {
17
- baseAssetsPath?: string;
18
- gameTitle: string;
19
- images: {
20
- [key: string]: string;
21
- };
22
- layout: {
23
- backgrounds: {
24
- width: number;
25
- height: number;
26
- };
27
- dialogBottomPadding: number;
28
- minTextWidth: number;
29
- mobileDialogHeightPercentage: number;
30
- verticalLayoutThreshold: number;
31
- portraits: {
32
- width: number;
33
- height: number;
34
- };
35
- };
36
- gameFlow: {
37
- labelToJumpOnScriptEnd?: string;
38
- };
39
- screens: {
40
- [key: string]: ScreenConfig;
41
- };
42
- buttons: {
43
- [key: string]: ButtonConfig;
44
- };
45
- skills: {
46
- [key: string]: SkillData;
47
- };
48
- skillOptions: {
49
- xpPerLevel: number;
50
- notifyLevelUp: boolean;
51
- };
52
- skillChecks: {
53
- rollRange: number;
54
- skillMultiplier: number;
55
- failureChance: number;
56
- difficultyText: Array<[number, string]>;
57
- };
58
- scripts: string[];
59
- audio: {
60
- [key: string]: AudioConfig;
61
- };
62
- audioOptions: {
63
- volume: number;
64
- defaultMusic?: string;
65
- musicFadeInTime: number;
66
- musicFadeInDelay: number;
67
- musicFadeOutTime: number;
68
- };
69
- sound?: {
70
- [key: string]: AudioConfig;
71
- };
72
- music?: {
73
- [key: string]: AudioConfig;
74
- };
75
- notifications: {
76
- timeOnScreen: number;
77
- alsoPrintInDialogue?: boolean;
78
- };
79
- hudStats: {
80
- [key: string]: HudStatConfig;
81
- };
82
- items: {
83
- [key: string]: ItemData;
84
- };
85
- interactionTags: {
86
- [key: string]: {
87
- onlyInteractOutsideOfScripts: boolean;
88
- };
89
- };
90
- quests: {
91
- [key: string]: QuestData;
92
- };
93
- transitions: {
94
- [key: string]: TransitionSettings;
95
- };
96
- audioTriggers: {
97
- [key: string]: string;
98
- };
99
- menuButtons: {
100
- [key: string]: MenuButtonData;
101
- };
102
- debugging: {
103
- showScriptFinishedMessage?: boolean;
104
- };
105
- }
106
- export interface ScreenConfig {
107
- background: string;
108
- buttons: Array<string | InlineButtonConfig>;
109
- }
110
- export interface MenuButtonData {
111
- text: string;
112
- }
113
- export interface QuestData {
114
- title: string;
115
- description: string;
116
- objectives: {
117
- [key: string]: ObjectiveData;
118
- };
119
- }
120
- export interface ObjectiveData {
121
- description: string;
122
- hidden?: boolean;
123
- }
124
- export interface ItemData {
125
- name: string;
126
- description: string;
127
- icon: string;
128
- onUse?: {
129
- action: 'jump' | 'run';
130
- label: string;
131
- };
132
- tag?: string;
133
- }
134
- export interface HudStatConfig {
135
- name: string;
136
- icon: string;
137
- startingValue: number;
138
- minValue?: number;
139
- maxValue?: number;
140
- }
141
- export interface AudioConfig {
142
- src: string;
143
- path?: string;
144
- volume?: number;
145
- rate?: number;
146
- html5?: boolean;
147
- }
148
- export interface MusicConfig extends AudioConfig {
149
- loop?: boolean;
150
- }
151
- export interface ButtonConfig {
152
- enabled: boolean;
153
- background?: string;
154
- text?: string;
155
- position: {
156
- left: number;
157
- top: number;
158
- width?: number;
159
- height?: number;
160
- };
161
- anchor?: {
162
- x: number;
163
- y: number;
164
- };
165
- action: string;
166
- actionType?: 'jump' | 'run';
167
- tag?: string;
168
- }
169
- export interface InlineButtonConfig extends ButtonConfig {
170
- id: string;
171
- }
172
- export interface SkillData {
173
- name: string;
174
- description: string;
175
- startingLevel: number;
176
- hidden?: boolean;
177
- icon: string;
178
- }
1
+ import { TransitionSettings } from './utils/transition';
2
+ export declare function setConfig(conf: Config): void;
3
+ export declare function getConfig(): Config;
4
+ export declare function getSkillConfig(id: string): SkillData;
5
+ export declare function getImageUrl(imageKeyOrUrl: string): string;
6
+ export declare function getAssetUrl(assetPath: string): string;
7
+ export declare function getButtonConfig(button: string): ButtonConfig;
8
+ export declare function getItemConfig(id: string): ItemData;
9
+ export declare function getQuestConfig(questId: string): QuestData;
10
+ export declare function getObjectiveConfig(quest: string, objectiveId: string): ObjectiveData;
11
+ export interface AppOptions {
12
+ baseAssetsPath?: string;
13
+ logging: boolean;
14
+ debug: boolean;
15
+ }
16
+ export interface Config {
17
+ baseAssetsPath?: string;
18
+ gameTitle: string;
19
+ images: {
20
+ [key: string]: string;
21
+ };
22
+ layout: {
23
+ backgrounds: {
24
+ width: number;
25
+ height: number;
26
+ };
27
+ dialogBottomPadding: number;
28
+ minTextWidth: number;
29
+ mobileDialogHeightPercentage: number;
30
+ verticalLayoutThreshold: number;
31
+ portraits: {
32
+ width: number;
33
+ height: number;
34
+ };
35
+ };
36
+ gameFlow: {
37
+ labelToJumpOnScriptEnd?: string;
38
+ };
39
+ screens: {
40
+ [key: string]: ScreenConfig;
41
+ };
42
+ buttons: {
43
+ [key: string]: ButtonConfig;
44
+ };
45
+ skills: {
46
+ [key: string]: SkillData;
47
+ };
48
+ skillOptions: {
49
+ xpPerLevel: number;
50
+ notifyLevelUp: boolean;
51
+ };
52
+ skillChecks: {
53
+ rollRange: number;
54
+ skillMultiplier: number;
55
+ failureChance: number;
56
+ difficultyText: Array<[number, string]>;
57
+ };
58
+ scripts: string[];
59
+ audio: {
60
+ [key: string]: AudioConfig;
61
+ };
62
+ audioOptions: {
63
+ volume: number;
64
+ defaultMusic?: string;
65
+ musicFadeInTime: number;
66
+ musicFadeInDelay: number;
67
+ musicFadeOutTime: number;
68
+ };
69
+ sound?: {
70
+ [key: string]: AudioConfig;
71
+ };
72
+ music?: {
73
+ [key: string]: AudioConfig;
74
+ };
75
+ notifications: {
76
+ timeOnScreen: number;
77
+ alsoPrintInDialogue?: boolean;
78
+ };
79
+ hudStats: {
80
+ [key: string]: HudStatConfig;
81
+ };
82
+ items: {
83
+ [key: string]: ItemData;
84
+ };
85
+ interactionTags: {
86
+ [key: string]: {
87
+ onlyInteractOutsideOfScripts: boolean;
88
+ };
89
+ };
90
+ quests: {
91
+ [key: string]: QuestData;
92
+ };
93
+ transitions: {
94
+ [key: string]: TransitionSettings;
95
+ };
96
+ audioTriggers: {
97
+ [key: string]: string;
98
+ };
99
+ menuButtons: {
100
+ [key: string]: MenuButtonData;
101
+ };
102
+ debugging: {
103
+ showScriptFinishedMessage?: boolean;
104
+ };
105
+ saves: {
106
+ mode: 'game-slots' | 'manual';
107
+ };
108
+ }
109
+ export interface ScreenConfig {
110
+ background: string;
111
+ buttons: Array<string | InlineButtonConfig>;
112
+ }
113
+ export interface MenuButtonData {
114
+ text: string;
115
+ }
116
+ export interface QuestData {
117
+ title: string;
118
+ description: string;
119
+ objectives: {
120
+ [key: string]: ObjectiveData;
121
+ };
122
+ }
123
+ export interface ObjectiveData {
124
+ description: string;
125
+ hidden?: boolean;
126
+ }
127
+ export interface ItemData {
128
+ name: string;
129
+ description: string;
130
+ icon: string;
131
+ onUse?: {
132
+ action: 'jump' | 'run';
133
+ label: string;
134
+ };
135
+ tag?: string;
136
+ }
137
+ export interface HudStatConfig {
138
+ name: string;
139
+ icon: string;
140
+ startingValue: number;
141
+ minValue?: number;
142
+ maxValue?: number;
143
+ }
144
+ export interface AudioConfig {
145
+ src: string;
146
+ path?: string;
147
+ volume?: number;
148
+ rate?: number;
149
+ html5?: boolean;
150
+ }
151
+ export interface MusicConfig extends AudioConfig {
152
+ loop?: boolean;
153
+ }
154
+ export interface ButtonConfig {
155
+ enabled: boolean;
156
+ background?: string;
157
+ text?: string;
158
+ position: {
159
+ left: number;
160
+ top: number;
161
+ width?: number;
162
+ height?: number;
163
+ };
164
+ anchor?: {
165
+ x: number;
166
+ y: number;
167
+ };
168
+ action: string;
169
+ actionType?: 'jump' | 'run';
170
+ tag?: string;
171
+ }
172
+ export interface InlineButtonConfig extends ButtonConfig {
173
+ id: string;
174
+ }
175
+ export interface SkillData {
176
+ name: string;
177
+ description: string;
178
+ startingLevel: number;
179
+ hidden?: boolean;
180
+ icon: string;
181
+ }
@@ -1,8 +1,8 @@
1
- export declare const SAVE_FILE = "gameSave";
2
- export declare const PRE_SIGNAL = "###_--_~=:;";
3
- export declare const JUMP_SIGNAL = "###_--_~=:;_JUMP";
4
- export declare const RETURN_SIGNAL = "###_--_~=:;_RETURN";
5
- export declare const OK_SIGNAL = "###_--_~=:;_OK";
6
- export declare const STOP_SIGNAL = "###_--_~=:;_STOP";
7
- export declare type ReturnSignal = typeof JUMP_SIGNAL | typeof RETURN_SIGNAL | typeof OK_SIGNAL | typeof STOP_SIGNAL;
8
- export declare function isReturnSignal(s: string): s is ReturnSignal;
1
+ export declare const SAVE_FILE = "gameSave";
2
+ export declare const PRE_SIGNAL = "###_--_~=:;";
3
+ export declare const JUMP_SIGNAL = "###_--_~=:;_JUMP";
4
+ export declare const RETURN_SIGNAL = "###_--_~=:;_RETURN";
5
+ export declare const OK_SIGNAL = "###_--_~=:;_OK";
6
+ export declare const STOP_SIGNAL = "###_--_~=:;_STOP";
7
+ export declare type ReturnSignal = typeof JUMP_SIGNAL | typeof RETURN_SIGNAL | typeof OK_SIGNAL | typeof STOP_SIGNAL;
8
+ export declare function isReturnSignal(s: string): s is ReturnSignal;
@@ -1,2 +1,2 @@
1
- import { Config } from './config';
2
- export declare const defaultConfig: Config;
1
+ import { Config } from './config';
2
+ export declare const defaultConfig: Config;
@@ -1 +1 @@
1
- export {};
1
+ export {};