omegga 1.0.5 → 1.0.8

package/templates/safe-ts/omegga.d.ts

@@ -66,7 +66,7 @@ export declare type EnvironmentPreset = Preset<"Environment", {
 			starsIntensity?: number;
 			starsColor?: BRColor;
 			auroraIntensity?: number;
-			weatherIntensity?: BRColor;
+			weatherIntensity?: number;
 			rainSnow?: number;
 			cloudCoverage?: number;
 			cloudSpeedMultiplier?: number;
@@ -176,8 +176,9 @@ export declare type UnrealRotator = [
 	number,
 	number
 ];
-export declare type UnrealType = UnrealClass | UnrealObject | UnrealBoolean | UnrealFloat | UnrealColor | UnrealByte | UnrealRotator;
-export declare type UnrealTypeFromString<T> = T extends "Class" ? UnrealClass : T extends "Object" ? UnrealObject : T extends "Boolean" ? UnrealBoolean : T extends "Float" ? UnrealFloat : T extends "Color" ? UnrealColor : T extends "Byte" ? UnrealByte : T extends "Rotator" ? UnrealRotator : UnrealType;
+export declare type UnrealString = string;
+export declare type UnrealType = UnrealClass | UnrealObject | UnrealBoolean | UnrealFloat | UnrealColor | UnrealByte | UnrealRotator | UnrealString;
+export declare type UnrealTypeFromString<T> = T extends "Class" ? UnrealClass : T extends "Object" ? UnrealObject : T extends "Boolean" ? UnrealBoolean : T extends "Float" ? UnrealFloat : T extends "Color" ? UnrealColor : T extends "Byte" ? UnrealByte : T extends "Rotator" ? UnrealRotator : T extends "String" ? UnrealString : UnrealType;
 export interface User {
 	id: Uuid;
 	name: string;
@@ -277,6 +278,8 @@ export declare type KnownComponents = {
 		brick_indices?: number[];
 		properties: {
 			bPlayInteractSound: "Boolean";
+			Message: "String";
+			ConsoleTag: "String";
 		};
 	};
 	BCD_AudioEmitter: {
@@ -414,6 +417,42 @@ declare function hsv(h: number | {
 	s: number;
 	v: number;
 }, s?: number, v?: number): number[];
+export interface DebouncedFunc<T extends (...args: any[]) => any> {
+	/**
+	 * Call the original function, but applying the debounce rules.
+	 *
+	 * If the debounced function can be run immediately, this calls it and returns its return
+	 * value.
+	 *
+	 * Otherwise, it returns the return value of the last invocation, or undefined if the debounced
+	 * function was not invoked yet.
+	 */
+	(...args: Parameters<T>): ReturnType<T> | undefined;
+	/**
+	 * Throw away any pending invocation of the debounced function.
+	 */
+	cancel(): void;
+	/**
+	 * If there is a pending invocation of the debounced function, invoke it immediately and return
+	 * its return value.
+	 *
+	 * Otherwise, return the value from the last invocation, or undefined if the debounced function
+	 * was never invoked.
+	 */
+	flush(): ReturnType<T> | undefined;
+}
+export interface DebouncedFuncLeading<T extends (...args: any[]) => any> extends DebouncedFunc<T> {
+	(...args: Parameters<T>): ReturnType<T>;
+	flush(): ReturnType<T>;
+}
+export interface DebounceSettings {
+	leading?: boolean | undefined;
+	maxWait?: number | undefined;
+	trailing?: boolean | undefined;
+}
+export interface DebounceSettingsLeading extends DebounceSettings {
+	leading: true;
+}
 declare function parseDuration(str: string): number;
 declare function parseBrickadiaTime(str: string): number;
 declare function brn2n(brName: string): string;
@@ -493,12 +532,13 @@ export declare const _OMEGGA_UTILS_IMPORT: {
 	time: {
 		parseDuration: typeof parseDuration;
 		parseBrickadiaTime: typeof parseBrickadiaTime;
+		debounce: (<T_1 extends (...args: any) => any>(func: T_1, wait: number, options: DebounceSettingsLeading) => DebouncedFuncLeading<T_1>) | (<T_2 extends (...args: any) => any>(func: T_2, wait?: number, options?: DebounceSettings) => DebouncedFunc<T_2>);
 	};
 	map: {
 		DEFAULT_MAPS: {
 			name: string;
 			brName: string;
-		}[]; /** Brick name from catalog (Turkey Body, 4x Cube) */
+		}[];
 		brn2n: typeof brn2n;
 		n2brn: typeof n2brn;
 	};
@@ -525,12 +565,12 @@ export declare const _OMEGGA_UTILS_IMPORT: {
 				number
 			]>;
 		};
-		checkBounds: typeof checkBounds;
+		checkBounds: typeof checkBounds; /** message sent from a brick click interaction */
 		getBounds: typeof getBounds;
 		getBrickSize: typeof getBrickSize;
 		getScaleAxis: typeof getScaleAxis;
 		setOwnership: typeof setOwnership;
-		rotate: typeof rotate;
+		rotate: typeof rotate; /** data parsed from the line (if it starts with json:) */
 		rotate_x: typeof rotate_x;
 		rotate_y: typeof rotate_y;
 		rotate_z: typeof rotate_z;
@@ -548,13 +588,13 @@ export declare const _OMEGGA_UTILS_IMPORT: {
 		}): Uint8Array;
 		utils: any;
 		constants: {
-			MAGIC: Uint8Array; /**
-			 * True if the player is the host
-			 */
+			MAGIC: Uint8Array;
 			LATEST_VERSION: number;
 			MAX_INT: number;
 			DEFAULT_UUID: string;
-		};
+		}; /**
+		 * Returns omegga
+		 */
 	};
 };
 declare global {
@@ -584,7 +624,7 @@ export interface BrickBounds {
 	];
 }
 /** Created when a player clicks on a brick with an interact component */
-export declare type BrickInteraction = {
+export interface BrickInteraction {
 	/** Brick name from catalog (Turkey Body, 4x Cube) */
 	brick_name: string;
 	/** Player information, id, name, controller, and pawn */
@@ -600,7 +640,15 @@ export declare type BrickInteraction = {
 		number,
 		number
 	];
-};
+	/** message sent from a brick click interaction */
+	message: string;
+	/** data parsed from the line (if it starts with json:) */
+	data: null | number | string | boolean | Record<string, unknown>;
+	/** True when there was a json payload */
+	json: boolean;
+	/** True when there was a parse error */
+	error: boolean;
+}
 /** AutoRestart options */
 export declare type AutoRestartConfig = {
 	players: boolean;
@@ -759,6 +807,27 @@ export interface OmeggaPlayer {
 	 * @param item Item name (Weapon_Bow)
 	 */
 	takeItem(item: WeaponClass): void;
+	/**
+	 * Changes a player's team
+	 * @param teamIndex Team index
+	 */
+	setTeam(teamIndex: number): void;
+	/**
+	 * Changes a player's minigame
+	 * @param index Minigame index
+	 */
+	setMinigame(index: number): void;
+	/**
+	 * Changes a player's score
+	 * @param minigameIndex minigame index
+	 * @param score Score
+	 */
+	setScore(minigameIndex: number, score: number): void;
+	/**
+	 * Fetch a player's score
+	 * @param minigameIndex minigame index
+	 */
+	getScore(minigameIndex: number): Promise<number>;
 }
 export interface StaticPlayer {
 	/**
@@ -809,6 +878,35 @@ export interface StaticPlayer {
 	 * @param item Item name (Weapon_Bow)
 	 */
 	takeItem(omegga: OmeggaLike, target: string | OmeggaPlayer, item: WeaponClass): void;
+	/**
+	 * Changes a player's team
+	 * @param omegga Omegga instance
+	 * @param target Player or player name/id
+	 * @param teamIndex Team name? index?
+	 */
+	setTeam(omegga: OmeggaLike, target: string | OmeggaPlayer, teamIndex: number): void;
+	/**
+	 * Changes a player's minigame
+	 * @param omegga Omegga instance
+	 * @param target Player or player name/id
+	 * @param index Minigame index
+	 */
+	setMinigame(omegga: OmeggaLike, target: string | OmeggaPlayer, index: number): void;
+	/**
+	 * Changes a player's score
+	 * @param omegga Omegga instance
+	 * @param target Player or player name/id
+	 * @param minigameIndex minigame index
+	 * @param score Score
+	 */
+	setScore(omegga: OmeggaLike, target: string | OmeggaPlayer, minigameIndex: number, score: number): void;
+	/**
+	 * Fetches a player's score
+	 * @param omegga Omegga instance
+	 * @param target Player or player name/id
+	 * @param minigameIndex minigame index
+	 */
+	getScore(omegga: OmeggaLike, target: string | OmeggaPlayer, minigameIndex: number): Promise<number>;
 }
 export interface InjectedCommands {
 	/** Get server status */
@@ -974,7 +1072,14 @@ export interface OmeggaCore {
 	 * Save an environment preset
 	 * @param presetName preset name
 	 */
-	saveEnvironment(presetName: string): void;
+	saveEnvironment(presetName: string): Promise<void>;
+	/** Save a temporary environment preset and return its contents */
+	getEnvironmentData(): Promise<EnvironmentPreset>;
+	/**
+	 * Read environment data as json
+	 * @param presetName preset name
+	 */
+	readEnvironmentData(presetName: string): void;
 	/**
 	 * Load an environment preset
 	 * @param presetName preset name