isaacscript-common 26.2.0 → 26.3.0

package/dist/index.rollup.d.ts

@@ -8722,12 +8722,29 @@ export declare function logAllGridEntities(this: void, includeWalls?: boolean, g
  */
 export declare function logAndPrint(msg: string): void;
 
-/** Helper function to enumerate all of the values in an array. */
-export declare function logArray<T>(this: void, array: T[] | readonly T[]): void;
+/**
+ * Helper function to log all of the values in an array.
+ *
+ * @param array The array to log.
+ * @param name Optional. The name of the array, which will be logged before the elements.
+ */
+export declare function logArray<T>(this: void, array: T[] | readonly T[], name?: string): void;
 
-export declare function logCollectibleTypes(this: void, collectibleTypes: CollectibleType[]): void;
+/**
+ * Helper function to log the names of a collectible type array.
+ *
+ * @param collectibleTypes The collectible types to log.
+ * @param name Optional. The name of the array, which will be logged before the elements.
+ */
+export declare function logCollectibleTypes(this: void, collectibleTypes: CollectibleType[], name?: string): void;
 
-export declare function logColor(this: void, color: Color): void;
+/**
+ * Helper function to log a `Color` object.
+ *
+ * @param color The `Color` object to log.
+ * @param name Optional. The name of the object, which will be logged before the properties.
+ */
+export declare function logColor(this: void, color: Color, name?: string): void;
 
 /** Helper function for printing out every damage flag that is turned on. Useful when debugging. */
 export declare function logDamageFlags(this: void, flags: DamageFlag | BitFlags<DamageFlag>): void;
@@ -8765,14 +8782,26 @@ export declare function logGridEntities(this: void, gridEntities: GridEntity[]):
 /** Helper function for log information about a specific grid entity. */
 export declare function logGridEntity(this: void, gridEntity: GridEntity): void;
 
-export declare function logKColor(this: void, kColor: KColor): void;
+/**
+ * Helper function to log a `KColor` object.
+ *
+ * @param kColor The `KColor` object to log.
+ * @param name Optional. The name of the object, which will be logged before the properties.
+ */
+export declare function logKColor(this: void, kColor: KColor, name?: string): void;
 
 /**
  * Helper function for printing out every level state flag that is turned on. Useful when debugging.
  */
 export declare function logLevelStateFlags(this: void): void;
 
-export declare function logMap(this: void, map: Map<AnyNotNil, unknown>): void;
+/**
+ * Helper function to log a TSTL `Map`.
+ *
+ * @param map The TSTL `Map` to log.
+ * @param name Optional. The name of the map, which will be logged before the elements.
+ */
+export declare function logMap(this: void, map: Map<AnyNotNil, unknown>, name?: string): void;
 
 export declare function logMusic(this: void): void;
 
@@ -8808,7 +8837,13 @@ export declare function logRoom(this: void): void;
  */
 export declare function logSeedEffects(this: void): void;
 
-export declare function logSet(this: void, set: Set<AnyNotNil> | ReadonlySet<AnyNotNil>): void;
+/**
+ * Helper function to log a TSTL `Set`.
+ *
+ * @param set The TSTL `Set` to log.
+ * @param name Optional. The name of the set, which will be logged before the elements.
+ */
+export declare function logSet(this: void, set: Set<AnyNotNil> | ReadonlySet<AnyNotNil>, name?: string): void;
 
 /** Helper function for logging every sound effect that is currently playing. */
 export declare function logSounds(this: void): void;
@@ -8851,7 +8886,15 @@ export declare function logUseFlags(this: void, flags: UseFlag | BitFlags<UseFla
  */
 export declare function logUserdata(this: void, userdata: unknown): void;
 
-export declare function logVector(this: void, vector: Vector, round?: boolean): void;
+/**
+ * Helper function to log a `Vector` object.
+ *
+ * @param vector The `Vector` object to log.
+ * @param name Optional. The name of the object, which will be logged before the properties.
+ * @param round Optional. If true, will round the vector values to the nearest integer. Default is
+ *              false.
+ */
+export declare function logVector(this: void, vector: Vector, name?: string, round?: boolean): void;
 
 /** Helper type to match all of the lowercase keys of an object. */
 export declare type LowercaseKeys<T> = StartsWithLowercase<keyof T>;
@@ -12007,6 +12050,30 @@ export declare function newPickingUpItem(): PickingUpItem;
 /** Returns a `PlayerHealth` object with all zeros. */
 export declare function newPlayerHealth(): PlayerHealth;
 
+/**
+ * Helper function to create a read-only `Color` object. (Otherwise, you would have to manually
+ * specify both the type and the constructor.)
+ *
+ * Note that read-only colors will be writable at run-time.
+ */
+export declare function newReadonlyColor(r: float, g: float, b: float, a?: float, ro?: int, go?: int, bo?: int): Readonly<Color>;
+
+/**
+ * Helper function to create a read-only `KColor` object. (Otherwise, you would have to manually
+ * specify both the type and the constructor.)
+ *
+ * Note that read-only colors will be writable at run-time.
+ */
+export declare function newReadonlyKColor(r: float, g: float, b: float, a: float): Readonly<KColor>;
+
+/**
+ * Helper function to create a read-only `Vector` object. (Otherwise, you would have to manually
+ * specify both the type and the constructor.)
+ *
+ * Note that read-only vectors will be writable at run-time.
+ */
+export declare function newReadonlyVector(x: float, y: float): Readonly<Vector>;
+
 /**
  * Helper function to initialize a new RNG object using Blade's recommended shift index.
  *
@@ -15696,6 +15763,13 @@ export declare const VectorOne: Readonly<Vector>;
 /** Helper function for finding out which way a vector is pointing. */
 export declare function vectorToDirection(vector: Vector): Direction;
 
+/**
+ * Helper function to convert a vector to a string.
+ *
+ * @param vector The vector to convert.
+ * @param round Optional. If true, will round the vector values to the nearest integer. Default is
+ *              false.
+ */
 export declare function vectorToString(vector: Vector, round?: boolean): string;
 
 /**