@kradle/challenges 0.0.1 → 0.1.0

package/src/actions.ts

@@ -24,10 +24,11 @@ import {
 	teleport,
 	tellraw,
 	time as timeCmd,
+	data,
 } from "sandstone";
 import type { ATTRIBUTES, BLOCKS, ENTITY_TYPES, ITEMS } from "sandstone/arguments/generated";
 import { Commands } from "./commands";
-import { ALL, DISPLAY_TAG } from "./constants";
+import { ALL, DISPLAY_TAG, END_STATE_KEY, KRADLE_STORAGE } from "./constants";
 import type { LiteralStringUnion } from "./utils";
 
 /// Targets that can be used in Actions
@@ -53,17 +54,13 @@ export function mapTarget(target: string | SelectorClass): SelectorClass<any, an
 	return Selector("@a", { tag: target }); // Assuming the target is a team name
 }
 
-export type Action = () => unknown;
-
 export const Actions = {
 	/**
 	 * Send a chat message to everyone.
 	 * @param {JSONTextComponent} message - The message to send.
 	 */
 	announce: ({ message }: { message: JSONTextComponent }) => {
-		return () => {
-			tellraw("@a", ["\n", { text: DISPLAY_TAG, color: "aqua" }, " | ", message, "\n"]);
-		};
+		tellraw("@a", ["\n", { text: DISPLAY_TAG, color: "aqua" }, " | ", message, "\n"]);
 	},
 
 	/**
@@ -71,7 +68,7 @@ export const Actions = {
 	 * @param {TargetNames} target - The target to clear the inventory of.
 	 */
 	clear: ({ target }: { target: TargetNames }) => {
-		return () => clear(mapTarget(target));
+		clear(mapTarget(target))
 	},
 
 	/**
@@ -80,7 +77,7 @@ export const Actions = {
 	 * @param {() => void} callback - The function to execute.
 	 */
 	custom: (callback: () => void) => {
-		return () => callback();
+		callback();
 	},
 
 	/**
@@ -115,64 +112,62 @@ export const Actions = {
 		absolute: boolean;
 		mode: "fill" | "line" | "pyramid";
 	}) => {
-		return () => {
-			// fill the region with the block
-			if (mode === "fill") {
-				const coordinates1 = absolute ? abs(x1, y1, z1) : rel(x1, y1, z1);
-				const coordinates2 = absolute ? abs(x2, y2, z2) : rel(x2, y2, z2);
-
-				fill(coordinates1, coordinates2, block);
-
-				return;
+		// fill the region with the block
+		if (mode === "fill") {
+			const coordinates1 = absolute ? abs(x1, y1, z1) : rel(x1, y1, z1);
+			const coordinates2 = absolute ? abs(x2, y2, z2) : rel(x2, y2, z2);
+
+			fill(coordinates1, coordinates2, block);
+
+			return;
+		}
+
+		// draw a line from the first coordinate to the second coordinate
+		if (mode === "line") {
+			const dx = x2 - x1;
+			const dy = y2 - y1;
+			const dz = z2 - z1;
+
+			const length = Math.max(Math.abs(dx), Math.abs(dy), Math.abs(dz));
+			const stepX = dx / length || 0;
+			const stepY = dy / length || 0;
+			const stepZ = dz / length || 0;
+
+			for (let i = 0; i <= length; i++) {
+				const x = Math.round(x1 + stepX * i);
+				const y = Math.round(y1 + stepY * i);
+				const z = Math.round(z1 + stepZ * i);
+				setblock(absolute ? abs(x, y, z) : rel(x, y, z), block);
 			}
 
-			// draw a line from the first coordinate to the second coordinate
-			if (mode === "line") {
-				const dx = x2 - x1;
-				const dy = y2 - y1;
-				const dz = z2 - z1;
-
-				const length = Math.max(Math.abs(dx), Math.abs(dy), Math.abs(dz));
-				const stepX = dx / length || 0;
-				const stepY = dy / length || 0;
-				const stepZ = dz / length || 0;
-
-				for (let i = 0; i <= length; i++) {
-					const x = Math.round(x1 + stepX * i);
-					const y = Math.round(y1 + stepY * i);
-					const z = Math.round(z1 + stepZ * i);
-					setblock(absolute ? abs(x, y, z) : rel(x, y, z), block);
-				}
+			return;
+		}
 
-				return;
-			}
+		if (mode === "pyramid") {
+			const height = Math.abs(y2);
+			const direction = Math.sign(y2); // +1 for up, -1 for down
 
-			if (mode === "pyramid") {
-				const height = Math.abs(y2);
-				const direction = Math.sign(y2); // +1 for up, -1 for down
+			for (let i = 0; i < height; i++) {
+				const y = y1 + i * direction;
+				const layerRadius = (height - 1 - i) * 2;
 
-				for (let i = 0; i < height; i++) {
-					const y = y1 + i * direction;
-					const layerRadius = (height - 1 - i) * 2;
+				const minX = x1 - layerRadius;
+				const maxX = x1 + layerRadius;
+				const minZ = z1 - layerRadius;
+				const maxZ = z1 + layerRadius;
 
-					const minX = x1 - layerRadius;
-					const maxX = x1 + layerRadius;
-					const minZ = z1 - layerRadius;
-					const maxZ = z1 + layerRadius;
-
-					for (let x = minX; x <= maxX; x++) {
-						for (let z = minZ; z <= maxZ; z++) {
-							setblock(absolute ? abs(x, y, z) : rel(x, y, z), block);
-						}
+				for (let x = minX; x <= maxX; x++) {
+					for (let z = minZ; z <= maxZ; z++) {
+						setblock(absolute ? abs(x, y, z) : rel(x, y, z), block);
 					}
 				}
-
-				return;
 			}
 
-			// if mode is not fill or line, throw an error
-			throw new Error(`Invalid fill mode: ${mode}`);
-		};
+			return;
+		}
+
+		// if mode is not fill or line, throw an error
+		throw new Error(`Invalid fill mode: ${mode}`);
 	},
 
 	/**
@@ -182,7 +177,7 @@ export const Actions = {
 	 * @param {number} count - The number of items to give.
 	 */
 	give: ({ item, target, count = 1 }: { item: ITEMS; target: TargetNames; count?: number }) => {
-		return () => give(mapTarget(target), item, count);
+		give(mapTarget(target), item, count);
 	},
 
 	/**
@@ -192,7 +187,7 @@ export const Actions = {
 	 */
 	giveLoot: ({ items, target }: { items: [{ name: ITEMS; count: number; weight: number }]; target: TargetNames }) => {
 		// sort incoming items and create a hash for table re-use
-		const lootItemsSorted = items.sort((a, b) => a.name.localeCompare(b.name));
+		const lootItemsSorted = [...items].sort((a, b) => a.name.localeCompare(b.name));
 		const lootItemsJson = JSON.stringify(lootItemsSorted);
 		const lootItemsHash = crypto.createHash("sha256").update(lootItemsJson).digest("hex");
 		const lootTableName = `loot_${lootItemsHash}`.slice(0, 16);
@@ -222,7 +217,7 @@ export const Actions = {
 		};
 
 		// on conflict, ignore because we can re-use duplicate loot tables
-		return () => LootTable(lootTableName, lootTable, { onConflict: "ignore" }).give(mapTarget(target));
+		LootTable(lootTableName, lootTable, { onConflict: "ignore" }).give(mapTarget(target));
 	},
 
 	/**
@@ -231,7 +226,7 @@ export const Actions = {
 	 * @param {boolean | number} value - The value to set the gamerule to.
 	 */
 	gamerule: ({ rule, value }: { rule: GAMERULES; value: boolean | number }) => {
-		return () => gamerule(rule, value);
+		gamerule(rule, value);
 	},
 
 	/**
@@ -239,7 +234,7 @@ export const Actions = {
 	 * @param {SelectorArgument} selector - The entities to kill.
 	 */
 	kill: ({ selector }: { selector: TargetNames }) => {
-		return () => kill(mapTarget(selector));
+		kill(mapTarget(selector));
 	},
 
 	/**
@@ -249,9 +244,7 @@ export const Actions = {
 	 * @param {TargetNames} target - The target to set the attribute for.
 	 */
 	setAttribute: ({ attribute_, value, target }: { attribute_: ATTRIBUTES; value: number; target: TargetNames }) => {
-		return () => {
-			execute.as(mapTarget(target)).run.attribute("@s", attribute_).baseSet(value);
-		};
+		execute.as(mapTarget(target)).run.attribute("@s", attribute_).baseSet(value);
 	},
 
 	/**
@@ -259,7 +252,7 @@ export const Actions = {
 	 * @param {'day' | 'night'} time_ - The time to set.
 	 */
 	setTime: ({ time }: { time: "day" | "night" }) => {
-		return () => timeCmd.set(time);
+		timeCmd.set(time);
 	},
 
 	/**
@@ -273,22 +266,26 @@ export const Actions = {
 		z: number;
 		absolute: boolean;
 	}) => {
-		return () => {
-			const coordinates = params.absolute ? abs(params.x, params.y, params.z) : rel(params.x, params.y, params.z);
-			for (let i = 0; i < params.count; i++) {
-				summon(params.entity, coordinates);
-			}
-		};
+		const coordinates = params.absolute ? abs(params.x, params.y, params.z) : rel(params.x, params.y, params.z);
+		for (let i = 0; i < params.count; i++) {
+			summon(params.entity, coordinates);
+		}
+	},
+
+	/**
+	 * Set the end state of the challenge.
+	 * @param {string} end_state - The end state to set.
+	 */
+	setEndState: ({ endState }: { endState: string }) => {
+		data.modify.storage(KRADLE_STORAGE, END_STATE_KEY).set.value(endState);
 	},
 
 	/**
 	 * Set a block at a specific location.
 	 */
 	setBlock: (params: { block: BLOCKS; x: number; y: number; z: number; absolute: boolean }) => {
-		return () => {
-			const coordinates = params.absolute ? abs(params.x, params.y, params.z) : rel(params.x, params.y, params.z);
-			setblock(coordinates, params.block);
-		};
+		const coordinates = params.absolute ? abs(params.x, params.y, params.z) : rel(params.x, params.y, params.z);
+		setblock(coordinates, params.block);
 	},
 
 	// teleport
@@ -316,7 +313,7 @@ export const Actions = {
 		absolute: boolean;
 	}) => {
 		const coordinates = absolute ? abs(x, y, z) : rel(x, y, z);
-		return () => teleport(mapTarget(target), coordinates);
+		teleport(mapTarget(target), coordinates);
 	},
 
 	/**
@@ -325,7 +322,7 @@ export const Actions = {
 	 * @param {TargetNames} target - The target to send the message to.
 	 */
 	tellraw: ({ message, target }: { message: string[]; target: TargetNames }) => {
-		return () => tellraw(mapTarget(target), message);
+		tellraw(mapTarget(target), message);
 	},
 
 	// Score operations
@@ -334,9 +331,7 @@ export const Actions = {
 	 * @param variable - The score variable to increment.
 	 */
 	increment: ({ variable }: { variable: Score }) => {
-		return () => {
-			variable.add(1);
-		};
+		variable.add(1);
 	},
 
 	/**
@@ -344,9 +339,7 @@ export const Actions = {
 	 * @param variable - The score variable to decrement.
 	 */
 	decrement: ({ variable }: { variable: Score }) => {
-		return () => {
-			variable.remove(1);
-		};
+		variable.remove(1);
 	},
 
 	/**
@@ -355,9 +348,7 @@ export const Actions = {
 	 * @param value - The value to set the score variable to, which can be a number or another score variable.
 	 */
 	set: ({ variable, value }: { variable: Score; value: number | Score }) => {
-		return () => {
-			variable.set(value);
-		};
+		variable.set(value);
 	},
 
 	/**
@@ -368,7 +359,7 @@ export const Actions = {
 	 */
 	// WARNING: the logs must have precisely this structure to be read by the watcher. DO NOT CHANGE THE STRUCTURE.
 	log_variable: ({ message, variable, store }: { message: string; variable: Score; store: boolean }) => {
-		return () => Commands.logVariable(message, variable, store);
+		Commands.logVariable(message, variable, store);
 	},
 
 	/**
@@ -380,9 +371,7 @@ export const Actions = {
 	 * @param {boolean} absolute - Whether the coordinates are absolute or relative.
 	 */
 	summonItem: ({ item, x, y, z, absolute }: { item: ITEMS; x: number; y: number; z: number; absolute: boolean }) => {
-		return () => {
-			const abs = absolute ? "" : "~";
-			raw(`summon item ${abs}${x} ${abs}${y} ${abs}${z} {Item:{id:"${item}",Count:1b}}`);
-		};
+		const abs = absolute ? "" : "~";
+		raw(`summon item ${abs}${x} ${abs}${y} ${abs}${z} {Item:{id:"${item}",Count:1b}}`);
 	},
-} satisfies Record<string, (...args: any[]) => Action>;
+} satisfies Record<string, (...args: any[]) => void | undefined>;

package/src/challenge.ts

@@ -294,11 +294,11 @@ export class ChallengeBase<const ROLES_NAMES extends string, const VARIABLE_NAME
 				});
 
 				return {
-					actions: [
+					actions: () => {
 						// First action is to reset the score to 0
-						Actions.set({ variable: score, value: 0 }),
-						...event.actions,
-					],
+						Actions.set({ variable: score, value: 0 });
+						event.actions();
+					},
 					mode: event.mode,
 					score: score,
 				};
@@ -348,7 +348,7 @@ export class ChallengeBase<const ROLES_NAMES extends string, const VARIABLE_NAME
 			// For global scores, we can directly use the condition
 			comment(`Processing global custom score event ${debugName}`);
 			_.if(condition, () => {
-				actions.forEach((action) => action());
+				actions();
 				counter.add(1);
 			});
 		} else {
@@ -356,7 +356,7 @@ export class ChallengeBase<const ROLES_NAMES extends string, const VARIABLE_NAME
 			comment(`Processing individual custom score event ${debugName}`);
 			execute.as(ALL).run(getChildFunctionName(debugName), () => {
 				_.if(condition, () => {
-					actions.forEach((action) => action());
+					actions();
 					counter.add(1);
 				});
 			});
@@ -406,7 +406,7 @@ export class ChallengeBase<const ROLES_NAMES extends string, const VARIABLE_NAME
 			}
 
 			comment("3. Process the start_challenge events");
-			this._events.start_challenge?.actions.forEach((action) => action());
+			this._events.start_challenge?.();
 
 			comment("4. Schedule the init_participants function to run after 1s");
 			init_participants.schedule("1s");
@@ -447,7 +447,7 @@ export class ChallengeBase<const ROLES_NAMES extends string, const VARIABLE_NAME
 			}
 
 			comment("3. Process the init_participants events");
-			this._events.init_participants?.actions.forEach((action) => action());
+			this._events.init_participants?.();
 
 			comment("4. Set the game state to ON");
 			this.full_variables.game_state.score.set(GAME_STATES.ON);
@@ -479,7 +479,7 @@ export class ChallengeBase<const ROLES_NAMES extends string, const VARIABLE_NAME
 					})();
 
 					comment("2. Process the on_tick event");
-					this._events.on_tick?.actions.forEach((action) => action());
+					this._events.on_tick?.();
 
 					comment("3. Process custom events");
 					MCFunction("process_custom_events", () => {
@@ -520,7 +520,7 @@ export class ChallengeBase<const ROLES_NAMES extends string, const VARIABLE_NAME
 			this.full_variables.game_state.score.set(GAME_STATES.OFF);
 
 			comment("2. Process the end_challenge events");
-			this._events.end_challenge?.actions.forEach((action) => action());
+			this._events.end_challenge?.();
 
 			comment("3. Announce the winners");
 			for (const [role, condition] of Object.entries(this._win_conditions || {})) {
@@ -528,13 +528,12 @@ export class ChallengeBase<const ROLES_NAMES extends string, const VARIABLE_NAME
 					_.if(condition as ConditionType, () => {
 						Actions.announce({
 							message: [Selector("@s"), " has won the challenge!"],
-						})();
+						});
 						tag("@s").add(WINNER_TAG);
 					});
 				});
 			}
-
-			Commands.declareWinners();
+			Commands.gameOver();
 		});
 
 		savePack("datapack", {

package/src/commands.ts

@@ -1,5 +1,5 @@
 import { _, type JSONTextComponent, type Score, Selector, type SelectorClass, tellraw } from "sandstone";
-import { WATCHER, WINNER_TAG } from "./constants";
+import { END_STATE_KEY, KRADLE_STORAGE, WATCHER, WINNER_TAG } from "./constants";
 
 /**
  * Converts a Sandstone Selector to a JSON Text Component that will be displayed like a JSON array in the chat.
@@ -43,6 +43,27 @@ function selectorToJSONString(selector: SelectorClass<any, any>): JSONTextCompon
 	return ['"', { selector: selector.toString(), separator: "," } as any, '"'];
 }
 
+/**
+ * Converts a storage to a JSON string that will be displayed like a JSON string in the chat.
+ * @param storage The storage holding the value to convert.
+ * @param storageKey The key of the value to convert in the storage.
+ * @returns A JSON string that will be displayed like a JSON string in the chat.
+ * 
+ * 
+ * If the value is found in the storage, it will be sent as a JSON string.
+ * Ex: { "end_state": "win" }
+ * 
+ * If the value is not found in the storage, an empty string will be sent.
+ * Ex: { "end_state": "" }
+ * 
+ */
+function storageToJSONString(storage: string, storageKey: string): JSONTextComponent[] {
+	return ['"', {
+		storage: storage,
+		nbt: storageKey,
+	}, '"'];
+}
+
 /**
  * Commands for interacting with Kradle's Watcher.
  */
@@ -83,7 +104,11 @@ export const Commands = {
 				return value.toString();
 			}
 			if (typeof value === "string") {
-				return JSON.stringify(value);
+				try {
+					JSON.parse(value);
+				} catch (error) {
+					throw new Error(`When using Commands.raw with string values, they must represent a valid JSON object. Invalid JSON string: ${value}`);
+				}
 			}
 			return value;
 		}
@@ -99,26 +124,35 @@ export const Commands = {
 	},
 
 	/**
-	 * Declare winners of the challenge to the Watcher. This will end the challenge.
+	 * Game over command - sends a command to Kradle's Watcher to end the challenge.
+	 * This will also announce the winners and the end state. 
 	 *
 	 * The `winners` argument of the payload will be a JSON list of player names.
 	 * Ex: { "winners": ["player1", "player2"] }
 	 *
 	 * If no winners are selected, an empty array will be sent.
 	 * Ex: { "winners": [] }
+	 *  
+	 * The `end_state` argument of the payload will be a JSON string that represents the end state of the challenge.
+	 * Ex: { "end_state": "win" }
+	 * 
+	 * If no end state is selected, an empty string will be sent.
+	 * Ex: { "end_state": "" }
 	 */
-	declareWinners: () => {
+	gameOver: () => {
 		const selector = Selector("@a", { tag: WINNER_TAG });
 
 		// If no winners are selected, we send them as a JSON array.
 		_.if(selector, () => {
-			Commands.raw("declare_winners", {
+			Commands.raw("game_over", {
 				winners: selectorToJSONArray(selector),
+				end_state: storageToJSONString(KRADLE_STORAGE, END_STATE_KEY),
 			});
 		}).else(() => {
 			// Else, we send an empty array.
-			Commands.raw("declare_winners", {
-				winners: "[]",
+			Commands.raw("game_over", {
+				winners: JSON.stringify([]),
+				end_state: storageToJSONString(KRADLE_STORAGE, END_STATE_KEY),
 			});
 		});
 	},
@@ -128,13 +162,13 @@ export const Commands = {
 		const variableName = variable.target.toString();
 
 		return Commands.raw("log_variable", {
-			message,
+			message: JSON.stringify(message),
 			store,
 			variable: JSON.stringify({
 				objective: objectiveName,
 				selector: variableName,
 			}),
-			value: variable,
+			value: JSON.stringify(variable),
 			targets: selectorToJSONString(Selector(variableName as any)),
 		});
 	},

package/src/constants.ts

@@ -16,6 +16,9 @@ export const KRADLE_PARTICIPANT_TAG = "kradle_participant";
 export const WINNER_TAG = "kradle_winner";
 export const DISPLAY_TAG = "***KRADLE***";
 
+export const KRADLE_STORAGE = "kradle_storage";
+export const END_STATE_KEY = "end_state";
+
 export const MAX_DURATION = 5 * 60 * 20; // 5 minutes in ticks
 
 /// The selector that targets all participants in the game.
@@ -98,7 +101,7 @@ export const BUILTIN_VARIABLES = {
 			_.if(value.greaterThan(0), () => {
 				Actions.announce({
 					message: [Selector("@s"), " has died!"],
-				})();
+				});
 				value.set(0); // Reset the death count after announcing
 			});
 		},
@@ -112,10 +115,8 @@ export const BUILTIN_SCORE_EVENTS = (variables: Record<BUILTIN_VARIABLE_NAMES, S
 		{
 			mode: "repeatable",
 			score: variables.main_score,
-			actions: [
-				() => {
-					VISIBLE_OBJECTIVE("@s").set(variables.main_score);
-				},
-			],
+			actions: () => {
+				VISIBLE_OBJECTIVE("@s").set(variables.main_score);
+			},
 		},
 	] satisfies _InputCustomEventType[];

package/src/types.ts

@@ -1,7 +1,6 @@
 import type { Score } from "sandstone";
 import type { OBJECTIVE_CRITERION } from "sandstone/arguments/generated";
 import type { AdvancementTriggers } from "sandstone/arguments/resources/AdvancementTriggers";
-import type { Action } from "./actions";
 import type { BUILTIN_VARIABLE_NAMES, POSSIBLE_SCENARIO_EVENTS } from "./constants";
 
 export { Actions } from "./actions";
@@ -77,7 +76,7 @@ export type _BaseConfig<ROLE_NAMES extends string, VARIABLE_NAMES extends string
 	custom_variables: Record<VARIABLE_NAMES, _InputVariableType<VARIABLE_NAMES | BUILTIN_VARIABLE_NAMES>>;
 };
 
-export type _ScenarioEvents = Partial<Record<POSSIBLE_SCENARIO_EVENTS, { actions: Action[] }>>;
+export type _ScenarioEvents = Partial<Record<POSSIBLE_SCENARIO_EVENTS, () => void>>;
 
 export type Roles<ROLES_NAMES extends string = string> = {
 	[role in ROLES_NAMES]: role;
@@ -106,7 +105,7 @@ type _InputEventCommonProperties = {
 	/** The mode of the event, either fire once or fire every time the score reaches the target */
 	mode: "fire_once" | "repeatable";
 	/** Actions to execute when the event is triggered */
-	actions: Action[];
+	actions: () => void;
 };
 
 export type _InputScoreCustomEventType = {