@turnipxenon/pineapple 2.9.0 → 3.0.0-alpha-3

package/src/lib/components/dialog_manager/DialogManager.ts

@@ -1,308 +0,0 @@
-/**
- * DialogManager is the object we want to interact with in Svelte
- */
-
-import { writable } from "svelte/store";
-import type { DialogDetail } from "$pkg/types/pineapple_fiber/DialogDetail";
-import { DialogState } from "$pkg/types/pineapple_fiber/DialogState";
-import { tweened } from "svelte/motion";
-import { backOut } from "svelte/easing";
-import { PortraitType } from "$pkg/types/pineapple_fiber/PortraitType";
-import AresHappy from "$pkg/assets/characters/ares/ares_happy.webp";
-import AresBlushing from "$pkg/assets/characters/ares/ares_blushing.webp";
-import AresDisappointed from "$pkg/assets/characters/ares/ares_disappointed.webp";
-import AresLetsGo from "$pkg/assets/characters/ares/ares_lets_go.webp";
-import AresMad from "$pkg/assets/characters/ares/ares_mad.webp";
-import AresNeutral from "$pkg/assets/characters/ares/ares_neutral.webp";
-import AresSlightlyMad from "$pkg/assets/characters/ares/ares_slightly_mad.webp";
-import AresSurprised from "$pkg/assets/characters/ares/ares_surprised.webp";
-import AresYay from "$pkg/assets/characters/ares/ares_yay.webp";
-import {
-	defaultDialogMessage,
-	dialogVariableStore,
-	enableDialogueOverlay,
-	updateRate
-} from "$pkg/components/dialog_manager/DialogManagerStore";
-import { DialogProcessor } from "$pkg/components/dialog_manager/DialogProcessor";
-import { parseYarn } from "$pkg/scripts/pineapple_fiber/PineappleFiberParser";
-
-const shouldDebugYarn = false;
-
-export type OnSetDialogChoiceCallback = (newMessage: DialogDetail) => void;
-
-export class DialogManager {
-	dialogMessageMap: Map<string, DialogDetail> = new Map();
-	currentDialogTree: DialogDetail[] = [];
-	fullCurrentMessage: string = defaultDialogMessage[0].textContent;
-	currentMessageMeta: DialogDetail = defaultDialogMessage[0];
-	currentMessage = writable("");
-	currentIndex = 0;
-	previousTimestamp = 0;
-	isDoneTransition = false;
-	currentPortrait = writable();
-	portraitMap: Map<string, any> = new Map();
-	currentState = DialogState.Visible;
-	currentReadableState = writable(this.currentState);
-	hidePercent = tweened(100, {
-		duration: 400,
-		easing: backOut
-	}); // 100 = 100%
-	skipNextActiveTime = 0;
-	dialogProcessor = new DialogProcessor();
-	// for queueing actions
-	_setDialogChoiceQueue: DialogDetail[] = [];
-	_setDialogChoiceMutex = false;
-	onSetDialogListeners: OnSetDialogChoiceCallback[] = [];
-	enableDialogueOverlayCache = false;
-
-	constructor() {
-		enableDialogueOverlay.subscribe((value) => {
-			// todo: investigate why we cant put setDialogDefault inside the then clause
-			// ISSUE #82 https://github.com/TurnipXenon/pineapple/issues/82
-			this.enableDialogueOverlayCache = value;
-			if (value) {
-				this.hidePercent.set(0).then(() => {
-					this.currentState = DialogState.Visible;
-					this.currentReadableState.set(this.currentState);
-				});
-			} else {
-				this.hidePercent.set(100).then(() => {
-					this.currentState = DialogState.Invisible;
-					this.currentReadableState.set(this.currentState);
-				});
-				this.setDialogTree([{ textContent: "" }]);
-			}
-		});
-	}
-
-	/**
-	 * when users interact with the dialog, they can skip the transition like in a game
-	 * note that there is a cool down to this, check out skipNextActiveTime
-	 */
-	skipAnimation = () => {
-		if (
-			this.previousTimestamp > this.skipNextActiveTime &&
-			this.currentState == DialogState.Visible &&
-			!this.isDoneTransition // crucial for dynamic links!
-		) {
-			this.currentIndex = this.fullCurrentMessage.length - 1;
-			this.currentMessage.update(() => this.fullCurrentMessage.slice(0, this.currentIndex));
-		}
-	};
-
-	/**
-	 * hides or shows the dialog UI
-	 * @param shouldEnable
-	 */
-	enableDialog = (shouldEnable: boolean) => {
-		enableDialogueOverlay.update(() => shouldEnable);
-	};
-
-	/**
-	 * sets the possible dialog that might appear on the Dialog UI
-	 * note that it overwrites the previous tree and does not append on it due to the possibility
-	 * of node name conflicts
-	 * @param newDialogTree
-	 */
-	setDialogTree = (newDialogTree: DialogDetail[]) => {
-		this.currentDialogTree = newDialogTree;
-
-		this.dialogMessageMap.clear();
-		newDialogTree.map((value) => {
-			if (value.dialogId) {
-				this.dialogMessageMap.set(value.dialogId!, value);
-			}
-		});
-
-		// lazy load map
-		if (this.portraitMap.size == 0) {
-			this.portraitMap.set(PortraitType.AresHappy.toString(), AresHappy);
-			this.portraitMap.set(PortraitType.AresBlushing.toString(), AresBlushing);
-			this.portraitMap.set(PortraitType.AresDisappointed.toString(), AresDisappointed);
-			this.portraitMap.set(PortraitType.AresLetsGo.toString(), AresLetsGo);
-			this.portraitMap.set(PortraitType.AresMad.toString(), AresMad);
-			this.portraitMap.set(PortraitType.AresNeutral.toString(), AresNeutral);
-			this.portraitMap.set(PortraitType.AresSlightlyMad.toString(), AresSlightlyMad);
-			this.portraitMap.set(PortraitType.AresSurprised.toString(), AresSurprised);
-			this.portraitMap.set(PortraitType.AresYay.toString(), AresYay);
-		}
-
-		this.setDialogChoice(newDialogTree[0]);
-	};
-
-	/**
-	 * Remember to call this before SetDialogTree
-	 * and unsubscribe during onDestroy
-	 * @param callback
-	 */
-	subscribeToSetDialogChoice = (callback: OnSetDialogChoiceCallback) => {
-		this.onSetDialogListeners.push(callback);
-	};
-
-	/**
-	 * Remember to call this during onDestroy
-	 * @param callback
-	 * todo: double check if this works???
-	 */
-	unsubscribeToSetDialogChoice = (callback: OnSetDialogChoiceCallback) => {
-		// from: https://stackoverflow.com/a/5767357/17836168
-		const index = this.onSetDialogListeners.indexOf(callback);
-		if (index > -1) {
-			// only splice array when item is found
-			this.onSetDialogListeners.splice(index, 1); // 2nd parameter means remove one item only
-		}
-	};
-
-	/**
-	 * Sets the next dialog to show depending on which special choice a href link the user
-	 * has interacted with
-	 * @param newMessage
-	 *
-	 * you can listen to this!
-	 */
-	setDialogChoice = (newMessage: DialogDetail | undefined) => {
-		if (!newMessage || !newMessage.textContent) {
-			return;
-		}
-
-		this._setDialogChoiceQueue.push(newMessage);
-
-		if (!this._setDialogChoiceMutex) {
-			this._setDialogChoiceMutex = true; // not a true mutex but this will do
-			this._setDialogChoice();
-		}
-	};
-
-	_setDialogChoice = () => {
-		const newMessage = this._setDialogChoiceQueue.shift();
-		if (newMessage === undefined) {
-			this._setDialogChoiceMutex = false; // set it free!
-			this.onSetDialogListeners.forEach((listener) => {
-				listener(this.currentMessageMeta);
-			});
-			return;
-		}
-
-		this.currentMessageMeta = newMessage;
-
-		// set the portrait
-		let portraitValue = AresHappy;
-		if (this.currentMessageMeta.portraitType) {
-			portraitValue = this.portraitMap.get(this.currentMessageMeta.portraitType);
-		}
-		if (portraitValue) {
-			this.currentPortrait.update(() => portraitValue);
-		}
-
-		// process the dialogue here line-by-line
-		this.fullCurrentMessage = this.dialogProcessor.processDialog(this.currentMessageMeta);
-		this.currentMessage.update(() => "");
-		this.currentIndex = 0;
-		this.skipNextActiveTime = this.previousTimestamp + 1000; // guard
-		this.isDoneTransition = false; // must be after the guard
-
-		if (shouldDebugYarn) {
-			console.info(`Currently processing node: ${this.currentMessageMeta.dialogId}`);
-		}
-
-		// save that we visited AND processed the node
-		if (this.currentMessageMeta.dialogId) {
-			const key = `+${this.currentMessageMeta.dialogId}`;
-			const value = Number(dialogVariableStore.getItem(key));
-			if (isNaN(value)) {
-				dialogVariableStore.setItem(key, "1");
-			} else {
-				dialogVariableStore.setItem(key, `${value + 1}`);
-			}
-		}
-
-		// reloop this to process all messages
-		this._setDialogChoice();
-	};
-
-	setDialogToDefault = () => {
-		this.setDialogTree(defaultDialogMessage);
-	};
-
-	/**
-	 * updates the information and detail frame by frame
-	 * you can think of this like the main game loop
-	 *
-	 * @param timestamp
-	 *
-	 * todo: this might be too big we might want to refactor this method for better readability
-	 * ISSUE #81 https://github.com/TurnipXenon/pineapple/issues/81
-	 */
-	update = (timestamp: number) => {
-		if (this.currentState == DialogState.Invisible || this.currentState == DialogState.Busy) {
-			window.requestAnimationFrame(this.update);
-			return;
-		}
-
-		// if visible
-
-		// text transition loop
-		if (!this.isDoneTransition && this.currentIndex > this.fullCurrentMessage.length) {
-			const elementList = document.getElementsByClassName("dialog-choice");
-			for (const el of elementList) {
-				el.addEventListener("click", (event) => {
-					// todo: make more robust; for now we're assuming first class is our choice
-					const choice = el.classList[0].split("-")[1];
-					this.setDialogChoice(this.dialogMessageMap.get(choice));
-				});
-			}
-
-			this.isDoneTransition = true;
-		}
-
-		// guard: skip if done or if not yet time to update
-		if (
-			this.currentIndex > this.fullCurrentMessage.length ||
-			this.previousTimestamp + updateRate > timestamp
-		) {
-			window.requestAnimationFrame(this.update);
-			return;
-		}
-		this.previousTimestamp = timestamp;
-
-		// check if valid text
-		// there is an assumption that previous character is valid
-		// let validCharacterIndex = this.currentLength - 1;
-		// validCharacterIndex++;
-		// the code above is just to show you how it looks like but let's assume
-		// that currentLength = validCharacter + 1
-		while (
-			this.fullCurrentMessage[this.currentIndex] == "<" &&
-			this.currentIndex + 1 < this.fullCurrentMessage.length
-			) {
-			// find valid character, trap with closing
-			this.currentIndex = this.fullCurrentMessage.indexOf(">", this.currentIndex) + 1;
-			// normalize
-			this.currentIndex = Math.min(this.currentIndex, this.fullCurrentMessage.length - 1);
-		}
-
-		this.currentMessage.update(() => this.fullCurrentMessage.slice(0, this.currentIndex));
-
-		// increment
-		++this.currentIndex;
-
-		window.requestAnimationFrame(this.update);
-	};
-
-	enableDialogOverlay(enable: boolean) {
-		enableDialogueOverlay.set(enable);
-	}
-
-	toggleDialogOverlay() {
-		enableDialogueOverlay.set(!this.enableDialogueOverlayCache);
-	};
-
-	async parseAndSetDialogTree(dialogYarn: string): Promise<DialogDetail[]> {
-		return parseYarn(dialogYarn)
-			.then((dialogTree) => {
-				console.log(dialogTree);
-				this.setDialogTree(dialogTree);
-				return dialogTree;
-			});
-	}
-}

package/src/lib/components/dialog_manager/DialogManagerStore.ts

@@ -1,52 +0,0 @@
-/**
- * DialogManagerStore is for variables that will be used as a Svelte store
- * or is saved in local storage
- */
-
-import type { DialogMapStore } from "$lib/types/pineapple_fiber/DialogVariableStore";
-import { createNewMapStore } from "$lib/types/pineapple_fiber/DialogVariableStore";
-import { writable } from "svelte/store";
-import type { DialogDetail } from "$lib/types/pineapple_fiber/DialogDetail";
-import { DialogManager } from "$lib/components/dialog_manager/DialogManager";
-
-/**
- * Enables the dialogue overlay
- *
- * @example
- * When updating to false, remember to restore the value to true, our default value, onDestroy.
- * Avoid async to prevent weird flashes of updates!
- * ```
- * import {enableDialogueOverlay} from "$lib/store.ts";
- * enableDialogueOverlay.update(() => false);
- *
- * onDestroy(() => {
- *     enableDialogueOverlay.update(() =>  true);
- * });
- * ```
- */
-export const enableDialogueOverlay = writable(true);
-
-export const dialogVariableStore: DialogMapStore = createNewMapStore();
-export const updateRate: number = 40 / 1000; // *at least* 40ms per letter
-
-// todo: if we go through doing yarn to typescript, move this!
-export const defaultDialogMessage: DialogDetail[] = [
-	{
-		textContent: `<p>I don't really have anything to say. Have you drank water? Or perhaps, you've checked out <a target="_blank" class="external-link" href="http://crouton.net">one of the best webpages</a> out there?`
-	}
-];
-
-/**
- * strictly must be declared last! or you might receive a weird error that looks like:
- *
- * 2:04:21 AM [vite] Error when evaluating SSR module /src/lib/components/dialog_manager/DialogManagerStore.ts:
- * |- TypeError: Cannot read properties of undefined (reading '0')
- *     at <instance_members_initializer> (/src/lib/components/dialog_manager/DialogManager.ts:38:67)
- *     at new DialogManager (/src/lib/components/dialog_manager/DialogManager.ts:53:14)
- *     at eval (/src/lib/components/dialog_manager/DialogManagerStore.ts:15:23)
- *     at async instantiateModule (file:///C:/Users/Pumpkin/Projects/Web/pineapple/node_modules/vite/dist/node/chunks/dep-934dbc7c.js:54360:9)
- *
- * what this means is that one member of dialogManager cannot be initialized. in our case, it was the
- * defaultDialogMessage not yet being initialized
- */
-export const dialogManager = new DialogManager();

package/src/lib/components/dialog_manager/DialogProcessor.ts

@@ -1,68 +0,0 @@
-import type { DialogDetail } from "$lib/types/pineapple_fiber/DialogDetail";
-import { BehaviorState } from "$lib/components/dialog_manager/behavior_tree/line_processors/BehaviorState";
-import { IfNode } from "$lib/components/dialog_manager/behavior_tree/line_processors/IfNode";
-import { EndIfNode } from "$lib/components/dialog_manager/behavior_tree/line_processors/EndIfNode";
-import { ElseNode } from "$lib/components/dialog_manager/behavior_tree/line_processors/ElseNode";
-import { ElseIfNode } from "$lib/components/dialog_manager/behavior_tree/line_processors/ElseIfNode";
-import { SetVariableNode } from "$lib/components/dialog_manager/behavior_tree/line_processors/SetVariableNode";
-import { IgnoreGuardNode } from "$lib/components/dialog_manager/behavior_tree/line_processors/IgnoreGuardNode";
-import { NormalLineProcessorNode } from "$lib/components/dialog_manager/behavior_tree/line_processors/NormalLineProcessorNode";
-import { LineSelectorNode } from "$lib/components/dialog_manager/behavior_tree/line_core/LineSelectorNode";
-import { browser } from "$app/environment";
-import { LineCommentNode } from "$lib/components/dialog_manager/behavior_tree/line_processors/LineCommentNode";
-import { DeclareCommand } from "$lib/components/dialog_manager/behavior_tree/line_processors/commands/DeclareCommand";
-import { JumpCommand } from "$lib/components/dialog_manager/behavior_tree/line_processors/commands/JumpCommand";
-import { IgnoreJumpNode } from "$lib/components/dialog_manager/behavior_tree/line_processors/IgnoreJumpNode";
-import { UnvisitCommand } from "$lib/components/dialog_manager/behavior_tree/line_processors/commands/UnvisitCommand";
-
-/**
- * DialogProcessor processes dialogs
- */
-export class DialogProcessor {
-	processingTree = new LineSelectorNode([
-		/*region comment based formats*/
-		new IgnoreJumpNode(), // must be prioritized above line comment node
-		new LineCommentNode(),
-		/*endregion commend based formats*/
-		new EndIfNode(),
-		new ElseIfNode(),
-		new ElseNode(),
-		new IfNode(),
-		new IgnoreGuardNode(),
-		/*region commands*/
-		new SetVariableNode(),
-		new DeclareCommand(),
-		new JumpCommand(),
-		new UnvisitCommand(),
-		/*endregion commands*/
-		new NormalLineProcessorNode()
-	]);
-
-	/**
-	 * process the dialog line by line and return a presentable string
-	 * @param dialogDetail
-	 */
-	processDialog = (dialogDetail: DialogDetail): string => {
-		if (!browser) {
-			return ""; // don't process any line in the server
-		}
-
-		let currentState = new BehaviorState();
-
-		// split each yarn line
-		return dialogDetail.textContent
-			.trim()
-			.split("\n")
-			.map((line_, index) => {
-				const result = this.processingTree.process({
-					initState: currentState,
-					line: line_.trim(),
-					lineIndex: index
-				});
-				currentState = result.nextState;
-
-				return result.renderedLine;
-			})
-			.join("\n"); // combine all processed lines
-	};
-}

package/src/lib/components/dialog_manager/DialogUtils.ts

@@ -1,10 +0,0 @@
-import { dialogVariableStore } from "$lib/components/dialog_manager/DialogManagerStore";
-
-class _DialogUtils {
-	isNodeVisited = (dialogId: string): boolean => {
-		const value = Number(dialogVariableStore.getItem(`+${dialogId}`));
-		return !isNaN(value) && value > 0;
-	};
-}
-
-export const DialogUtils = new _DialogUtils();

package/src/lib/components/dialog_manager/behavior_tree/core/BTreeUtils.ts

@@ -1,40 +0,0 @@
-class BTreeUtils {
-	/**
-	 * peek the top of a stack object with the assumption it's not an empty stack
-	 * todo: add possible protection like an assertion
-	 * @param stack
-	 * @return top of the stack
-	 */
-	peek = <T>(stack: T[]): T => {
-		return stack[stack.length - 1];
-	};
-
-	removeQuotes = (value: string): string => {
-		return value
-			.replace(/^"/, "") // remove possible " at the start: https://stackoverflow.com/a/2182602
-			.replace(/"$/, ""); // remove possible " at the end: https://stackoverflow.com/a/12249011
-	};
-
-	simplifyToken = (oldToken: string): string => {
-		if (oldToken[0] == "$") {
-			const value = localStorage.getItem(oldToken);
-			if (value) {
-				return value;
-			}
-			console.error(`Value obtained in local storage false: ${oldToken}`);
-			return "";
-		}
-
-		return btreeUtils.removeQuotes(oldToken);
-	};
-
-	isTrue = (value: string): boolean => {
-		return value.trim().toLowerCase() === "true";
-	};
-
-	isFalse = (value: string): boolean => {
-		return value.trim().toLowerCase() === "false";
-	};
-}
-
-export const btreeUtils = new BTreeUtils();

package/src/lib/components/dialog_manager/behavior_tree/core/BaseBehaviorResult.ts

@@ -1,5 +0,0 @@
-import type { BehaviorStatus } from "$lib/components/dialog_manager/behavior_tree/core/BehaviorStatus";
-
-export interface BaseBehaviorResult {
-	status: BehaviorStatus;
-}

package/src/lib/components/dialog_manager/behavior_tree/core/BehaviorNode.ts

@@ -1,3 +0,0 @@
-export interface BehaviorNode<Argument, Result> {
-	process: (nodeArgs: Argument) => Result;
-}

package/src/lib/components/dialog_manager/behavior_tree/core/BehaviorStatus.ts

@@ -1,5 +0,0 @@
-export enum BehaviorStatus {
-	Running,
-	Success,
-	Failure
-}

package/src/lib/components/dialog_manager/behavior_tree/core/SelectorNode.ts

@@ -1,32 +0,0 @@
-import type { BehaviorNode } from "$lib/components/dialog_manager/behavior_tree/core/BehaviorNode";
-import { BehaviorStatus } from "$lib/components/dialog_manager/behavior_tree/core/BehaviorStatus";
-import type { BaseBehaviorResult } from "$lib/components/dialog_manager/behavior_tree/core/BaseBehaviorResult";
-
-/**
- * Selector is a composite behavior node where it tries to process everything until it
- * finds a non-failing node
- */
-export abstract class SelectorNode<Argument, Result extends BaseBehaviorResult>
-	implements BehaviorNode<Argument, Result>
-{
-	nodeList: BehaviorNode<Argument, Result>[];
-	abstract defaultResult: () => Result;
-
-	protected constructor(nodeList: BehaviorNode<Argument, Result>[]) {
-		this.nodeList = nodeList;
-	}
-
-	process(nodeArgs: Argument): Result {
-		let finalResult: Result = this.defaultResult();
-
-		for (const node of this.nodeList) {
-			const currentResult = node.process(nodeArgs);
-			if (currentResult.status !== BehaviorStatus.Failure) {
-				finalResult = currentResult;
-				break;
-			}
-		}
-
-		return finalResult;
-	}
-}

package/src/lib/components/dialog_manager/behavior_tree/expression/ExpressionArguments.ts

@@ -1,6 +0,0 @@
-import type { ExpressionState } from "$lib/components/dialog_manager/behavior_tree/expression/ExpressionState";
-
-export interface ExpressionArguments {
-	token: string;
-	initState: ExpressionState;
-}

package/src/lib/components/dialog_manager/behavior_tree/expression/ExpressionBehaviorNode.ts

@@ -1,5 +0,0 @@
-import type { BehaviorNode } from "$lib/components/dialog_manager/behavior_tree/core/BehaviorNode";
-import type { ExpressionArguments } from "$lib/components/dialog_manager/behavior_tree/expression/ExpressionArguments";
-import type { ExpressionResult } from "$lib/components/dialog_manager/behavior_tree/expression/ExpressionResult";
-
-export type ExpressionBehaviorNode = BehaviorNode<ExpressionArguments, ExpressionResult>;