narraleaf-studio 1.6.3 → 1.8.0

package/dist/_api.d.ts

@@ -812,13 +812,26 @@ type StoryActionPayload = {
 	transform?: StoryTransformRef;
 } | {
 	action: "text";
-	operation: "create" | "setText" | "show" | "hide" | "setFontSize" | "setFontColor";
+	/**
+	 * `setFont` is the combined op: it sets whichever of {@link fontSize}, {@link fontColor} and
+	 * {@link outline} the row states, so one `/font` line can say all three. The two single ops
+	 * stay for the rows that hold them and for a line that names one value alone.
+	 *
+	 * Additive: no document written before it carries the value, so no schema bump - the same
+	 * rule `bringToFront` came in under.
+	 */
+	operation: "create" | "setText" | "show" | "hide" | "setFontSize" | "setFontColor" | "setFont";
 	objectName: string;
 	/** Which text a non-`create` op acts on. Same rule as the `image` arm's `target`. */
 	target?: StoryDisplayableTargetRef;
 	text?: string;
 	fontSize?: number;
 	fontColor?: string;
+	/**
+	 * The outline drawn round the glyphs, read by `setFont`. `null` takes an outline away
+	 * (`outline=0`); absent leaves whatever the text has.
+	 */
+	outline?: StoryTextOutline | null;
 	layer?: StoryLayerRef;
 	transform?: StoryTransformRef;
 } | {
@@ -1059,7 +1072,29 @@ type StoryActionPayload = {
 	params: Record<string, StoryPluginActionParamValue>;
 }
 /** The player's hands: a pad that shakes, a locked passage, a row that waits for a gesture. */
- | StoryInputActionPayload;
+ | StoryInputActionPayload | {
+	/**
+	 * Open one of the project's pages over the stage (`/page`), hold the story until the page
+	 * closes, and go on from the row after it - a phone, a map, a letter the player reads.
+	 *
+	 * The page is shown exactly as `Show Layer` shows one from a blueprint, so the page closes
+	 * itself with `Close This Layer`, and what it closes with is the row's answer. Unlike
+	 * `/quit`, the scene is not left: the story is where it was when the page goes away.
+	 */
+	action: "page";
+	/**
+	 * The page, by id - never by name, so a rename keeps the row on the same page, as `/quit`
+	 * keeps naming its page.
+	 */
+	surfaceId: string;
+	/**
+	 * A variable to write what the page closed with. A boolean, a number or a text variable
+	 * takes the result converted to its own type; a page closed with no result (Back on a
+	 * dismissible page, a load, the story rolled back past the row) writes nothing, so the
+	 * variable keeps the value it had. Absent writes nothing at all.
+	 */
+	resultTarget?: StoryVariableRef;
+};
 type StoryPluginActionParamValue = string | number | boolean | null | StoryPluginActionParamValue[] | {
 	[key: string]: StoryPluginActionParamValue;
 };
@@ -1557,6 +1592,10 @@ declare const STORY_TRANSFORM_REPEAT_TYPES: readonly [
 	"mirror"
 ];
 type StoryTransformRepeatType = (typeof STORY_TRANSFORM_REPEAT_TYPES)[number];
+type StoryTextOutline = {
+	width: number;
+	color: string;
+};
 type StoryTransformRef = {
 	/** Absent means `"props"`. Only a Story Motion has to say which it is. */
 	mode?: "props" | "animation";
@@ -1649,6 +1688,11 @@ type StoryAlignPositionValue = {
 	xoffset?: number;
 	yoffset?: number;
 };
+interface CharacterFrameSequence {
+	frameAssetIds: string[];
+	fps: number;
+	loop: boolean;
+}
 type BlueprintOwnerRef = {
 	kind: "globalMain";
 } | {
@@ -2305,6 +2349,14 @@ declare const en: {
 					readonly command: "Highlight commands";
 				};
 			};
+			readonly characterListGrouping: {
+				readonly label: "Character lists";
+				readonly description: "How the cast is arranged where a character is picked.";
+				readonly options: {
+					readonly grouped: "Group by cast group";
+					readonly all: "Show all characters";
+				};
+			};
 			readonly dictionaries: {
 				readonly label: "Spelling dictionaries";
 			};
@@ -3106,6 +3158,9 @@ declare const en: {
 				readonly auditionFilterAll: "All";
 				readonly auditionFilterApproved: "Approved";
 				readonly auditionFilterPending: "Pending";
+				readonly filterSpeakerAll: "All speakers";
+				readonly speakerFilterLabel: "Speaker";
+				readonly searchPlaceholder: "Search lines";
 				readonly narrationSpeaker: "Narration";
 				readonly narrationGroup: "Narration";
 				readonly choiceSpeaker: "Choice";
@@ -3498,6 +3553,7 @@ declare const en: {
 				readonly playtest_hover: "Hover in the game";
 				readonly playtest_key: "Press a key in the game";
 				readonly playtest_stop: "Stop playing";
+				readonly playtest_variables: "Read the game's variables";
 				readonly console_read: "Read Studio's console";
 				readonly build: "Build the game";
 			};
@@ -4636,6 +4692,7 @@ declare const en: {
 			readonly reason: {
 				readonly blueprintAction: "A blueprint runs this row, and a blueprint has no script form.";
 				readonly inputAction: "This row works with the player's input or the controller's rumble, and has no script form.";
+				readonly pageAction: "This row opens a page over the story and waits for it, and has no script form.";
 				readonly blueprintCondition: "A blueprint decides this condition.";
 				readonly blueprintInterpolation: "A blueprint computes a value inside this text.";
 				readonly inlineEvent: "The text carries an event that fires while it is being typed out.";
@@ -4662,6 +4719,7 @@ declare const en: {
 				readonly badTag: "This line carries a formatting tag that is unknown, or left open.";
 				readonly badExpression: "This expression does not resolve.";
 				readonly layerDeclaration: "A script cannot declare a layer. Add it to the scene's layers";
+				readonly retiredLead: "Options no longer read \"show if\" or \"enable if\". Write \"hide if\" or \"disable if\" followed by the condition under which the option is hidden or greyed out";
 			};
 			readonly view: {
 				readonly open: "Read as a script";
@@ -5100,6 +5158,8 @@ declare const en: {
 			readonly hold: "Hold Seconds";
 			readonly opacity: "Opacity";
 			readonly size: "Font Size";
+			readonly outline: "Outline px";
+			readonly outlineColor: "Outline Color";
 			readonly xOffset: "X Offset px";
 			readonly yOffset: "Y Offset px";
 			readonly zoom: "Zoom";
@@ -5866,6 +5926,10 @@ declare const en: {
 				readonly label: "Quit to page";
 				readonly detail: "End this playthrough at this line and show a page. No ending is recorded";
 			};
+			readonly page: {
+				readonly label: "Open page";
+				readonly detail: "Open a page over the story and wait until it closes. What the page closes with can be written into a variable";
+			};
 			readonly rumble: {
 				readonly label: "Rumble";
 				readonly detail: "Vibrate the player's controller. Pick a preset, or set each motor";
@@ -5948,6 +6012,7 @@ declare const en: {
 			readonly cut: "Cut point";
 			readonly ending: "Ending";
 			readonly quit: "Quit to page";
+			readonly page: "Page";
 			readonly rumble: "Rumble";
 			readonly input: "Input";
 			readonly jump: "Jump";
@@ -6016,6 +6081,8 @@ declare const en: {
 			readonly cutUnknown: "Cut point";
 			readonly ending: "Ending {name}";
 			readonly quit: "Quit to {page}";
+			readonly page: "Open {page}";
+			readonly pageUnset: "Open page";
 			readonly rumble: "Rumble: {shape}";
 			readonly rumbleStop: "Stop rumble";
 			readonly inputLock: "Lock player input";
@@ -6572,6 +6639,7 @@ declare const en: {
 			readonly setText: "Set text";
 			readonly setFontSize: "Set font size";
 			readonly setFontColor: "Set font color";
+			readonly setFont: "Set font";
 		};
 		readonly layerOperation: {
 			readonly setZIndex: "Set z-index";
@@ -6654,6 +6722,8 @@ declare const en: {
 			readonly textName: "Text name";
 			readonly fontSize: "Font size";
 			readonly fontColor: "Font color";
+			readonly outlineWidth: "Outline width";
+			readonly outlineColor: "Outline color";
 			readonly text: "Text";
 		};
 		readonly layer: {
@@ -6771,6 +6841,8 @@ declare const en: {
 			readonly quitPage: "Page shown afterwards";
 			readonly quitPageUnset: "Not set";
 			readonly quitHint: "This playthrough ends at this line and the page takes the screen. No ending is recorded.";
+			readonly pagePage: "Page";
+			readonly pageHint: "The page opens over the story, and the story waits until the page closes itself with Close This Layer. What it closes with is written into the result variable, converted to the variable's type; a page closed with nothing leaves the variable as it was.";
 			readonly branch: "Branch";
 			readonly elseHint: "Else branch runs when previous branches do not match.";
 		};
@@ -8859,6 +8931,8 @@ declare const en: {
 			readonly onFullscreenChanged: "On Fullscreen Changed";
 			readonly onWindowCloseRequested: "On Window Close Requested";
 			readonly onWindowFocusChanged: "On Window Focus Changed";
+			readonly onSavedVarChanged: "On Saved Var Changed";
+			readonly onPersistentChanged: "On Persistent Changed";
 			readonly onAction: "On Action";
 			readonly onKeyDown: "On Key Down";
 			readonly onKeyUp: "On Key Up";
@@ -9149,6 +9223,15 @@ declare const en: {
 			readonly colorReset: "Compute from the name";
 		};
 		readonly editor: {
+			readonly sequenceTitle: "Frame sequence";
+			readonly sequenceImport: "Import PNG frames";
+			readonly sequenceFps: "Frames per second";
+			readonly sequenceLoop: "Loop";
+			readonly sequenceStatic: "Use first frame only";
+			readonly sequenceMoveUp: "Move frame up";
+			readonly sequenceMoveDown: "Move frame down";
+			readonly sequencePngOnly: "All frames must be PNG images.";
+			readonly sequenceSizeMismatch: "All frames must have the same dimensions.";
 			readonly kind: {
 				readonly preset: "Preset sprites";
 				readonly layered: "Layered sprite";
@@ -9347,6 +9430,12 @@ declare const en: {
 			readonly select: "Select";
 			readonly thumbnailAlt: "thumbnail";
 			readonly color: "Color";
+			readonly aliases: "Aliases";
+			readonly aliasesTip: "A story line whose speaker is written as an alias belongs to this character. The game still shows the character's name.";
+			readonly addAliasPlaceholder: "Add alias\u2026";
+			readonly aliasIsName: "\"{alias}\" is this character's name.";
+			readonly aliasTakenByName: "\"{alias}\" is the name of {names}. Lines spoken as \"{alias}\" belong to {names}.";
+			readonly aliasShared: "\"{alias}\" is also an alias of {names}. Lines spoken as \"{alias}\" cannot be assigned to one character.";
 			readonly namePlaceholder: "Character name";
 			readonly descriptionPlaceholder: "Character description\u2026";
 			readonly tags: "Tags";
@@ -9679,6 +9768,9 @@ declare const en: {
 			readonly descriptionPlaceholder: "Enter description\u2026";
 			readonly info: {
 				readonly dimensions: "Dimensions";
+				readonly animation: "Animation";
+				readonly animationLoops: "{frames} frames, loops forever";
+				readonly animationPlays: "{frames} frames, plays {plays} \u00D7";
 				readonly format: "Format";
 				readonly size: "Size";
 				readonly hash: "Hash";
@@ -11738,7 +11830,7 @@ declare const en: {
 			readonly imageWebpQualityTitle: "WebP quality";
 			readonly imageWebpQualityDescription: "Quality passed to the WebP encoder, from 1 to 100.";
 			readonly imageMaxDimensionTitle: "Maximum image size";
-			readonly imageMaxDimensionDescription: "Images longer than this on their longest edge are scaled down. 0 keeps every image at the size it was saved.";
+			readonly imageMaxDimensionDescription: "Backgrounds and interface images longer than this on their longest edge are scaled down. Character sprites and other images drawn at their own pixel size keep their size. 0 keeps every image at the size it was saved.";
 			readonly audioModeTitle: "Audio compression settings";
 			readonly audioBitrateKbpsTitle: "Audio bitrate";
 			readonly audioBitrateKbpsDescription: "AAC bitrate, in kbit/s.";
@@ -11966,6 +12058,8 @@ declare const en: {
 			readonly title: "Setup complete";
 			readonly expectation: "Every setting asked for here is in Settings. F1 opens help for whatever is under the cursor.";
 			readonly docs: "Open the documentation";
+			readonly bilibili: "Follow us on Bilibili";
+			readonly youtube: "Follow us on YouTube";
 		};
 		readonly skipConfirm: {
 			readonly title: "Skip setup?";
@@ -13268,6 +13362,8 @@ declare const en: {
 			readonly compressionImages: "Images compressed";
 			readonly compressionMedia: "Audio and video compressed";
 			readonly compressionMetadata: "Metadata removed";
+			readonly compressionKeptAtSize: "Kept at full size";
+			readonly compressionKeptAtSizeHint: "Drawn at their own pixels";
 			readonly includedTitle: "Assets carried";
 			readonly includedEmpty: "This run carried no assets.";
 			readonly excludedTitle: "Assets left out";
@@ -13515,6 +13611,12 @@ declare const en: {
 				readonly message: "{asset} is {size}, over the {limit} a build should carry";
 				readonly help: string;
 			};
+			readonly assetsSpriteAnimationFinite: {
+				readonly title: "Sprite animation that stops";
+				readonly description: "A character sprite that is an animated PNG set to play a fixed number of times";
+				readonly message: "{asset} is an animated PNG that plays {plays} \u00D7 and then holds its last frame";
+				readonly help: string;
+			};
 			readonly assetsGroupIncomplete: {
 				readonly title: "Unfinished asset set";
 				readonly description: "A set that does not resolve to exactly one file for every variant it declares";
@@ -13628,6 +13730,13 @@ declare const en: {
 				readonly message: "This row comes after an ending and is never played. Move it before the ending, or delete it";
 				readonly help: string;
 			};
+			readonly storyPageMissing: {
+				readonly title: "Open page with no page";
+				readonly description: "A /page row that names no page, or one the project no longer has";
+				readonly message: "This row names no page, so nothing opens and the story goes straight on";
+				readonly deleted: "The page this row names is no longer in the project, so nothing opens and the story goes straight on";
+				readonly help: string;
+			};
 			readonly storyQuitPageMissing: {
 				readonly title: "Quit with no page";
 				readonly description: "A /quit row that names no page, or one the project no longer has";
@@ -13716,6 +13825,12 @@ declare const en: {
 				readonly message: "The tag \"{tag}\" is on both \"{first}\" and \"{second}\"";
 				readonly help: string;
 			};
+			readonly storyParallelSameTarget: {
+				readonly title: "One object in two parallel branches";
+				readonly description: "A /parallel group whose branches act on the same stage object";
+				readonly message: "Another branch of this /parallel group also acts on \"{object}\"";
+				readonly help: string;
+			};
 			readonly blueprintReferenceMissing: {
 				readonly title: "Missing target";
 				readonly description: "A node naming something the project no longer has";
@@ -14286,7 +14401,6 @@ declare const en: {
 			readonly groupAdded: "Group added";
 			readonly groupRemoved: "Group removed";
 			readonly fields: {
-				readonly nicknames: "Nicknames";
 				readonly group: "Group";
 				readonly canvas: "Canvas";
 				readonly avatarAxes: "Avatar axes";
@@ -17445,6 +17559,10 @@ export type SearchJumpTarget = {
 	storyId: string;
 	storyName: string;
 };
+type PngAnimation = {
+	frames: number;
+	plays: number;
+};
 type ModelBundleFormat = "live2d-cubism4" | "live2d-cubism2" | "spine-binary" | "spine-json" | "unknown";
 export declare enum AssetType {
 	Image = "image",
@@ -17478,6 +17596,8 @@ type ImageAssetMetadata = {
 	height: number;
 	format: string;
 	size: number;
+	/** What an APNG declares about its frames and loops; null for a still image. */
+	animation?: PngAnimation | null;
 };
 type AudioAssetMetadata = {
 	duration: number;
@@ -17850,6 +17970,7 @@ interface CharacterNamed {
 	name: string;
 }
 interface CharacterPose extends CharacterNamed {
+	sequence?: CharacterFrameSequence;
 	/** Groups the list in the editor. Never consulted when resolving. */
 	folder?: string;
 	assetId: string | null;
@@ -18054,6 +18175,7 @@ declare class CharacterAppearance {
 	createPose(name: string, folder?: string): CharacterPose | null;
 	removePose(poseId: string): boolean;
 	setPoseAsset(poseId: string, assetId: string | null): void;
+	setPoseSequence(poseId: string, input: CharacterFrameSequence): void;
 	setPoseFolder(poseId: string, folder: string | undefined): void;
 	setPosePortrait(poseId: string, portrait: PortraitCrop | undefined): void;
 	/**
@@ -20227,6 +20349,17 @@ interface TagsFieldDefinition<TData = any> extends BaseFieldDefinition<TData> {
 	 * that are not drawn, and removing a chip removes exactly the tag it stands for.
 	 */
 	formatTag?: (data: TData, tag: string) => string | null;
+	/**
+	 * Why a stored tag will not do what it is there for, or null when it will. A tag with an issue
+	 * is drawn in the warning tone and the sentence is printed under the field. It is still stored:
+	 * the field warns rather than refusing, because the fix may be on another record.
+	 */
+	tagIssue?: (data: TData, tag: string) => string | null;
+	/**
+	 * A tag the field drops instead of adding, as it drops a repeat. Absent: only repeats are
+	 * dropped.
+	 */
+	rejectTag?: (data: TData, tag: string) => boolean;
 }
 interface InfoFieldDefinition<TData = any> extends BaseFieldDefinition<TData> {
 	type: "info";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "narraleaf-studio",
-  "version": "1.6.3",
+  "version": "1.8.0",
   "description": "TypeScript declarations for the NarraLeaf Studio plugin API (narraleaf-studio/plugin and narraleaf-studio/runtime).",
   "license": "MPL-2.0",
   "type": "module",