isaacscript-common 4.0.2 → 4.0.5

package/functions/color.ts

@@ -1,128 +0,0 @@
-import { SerializationBrand } from "../enums/private/SerializationBrand";
-import { SerializationType } from "../enums/SerializationType";
-import { isaacAPIClassEquals, isIsaacAPIClassOfType } from "./isaacAPIClass";
-import { copyValuesToTable, getNumbersFromTable, tableHasKeys } from "./table";
-import { isTable } from "./types";
-
-type SerializedColor = LuaTable<string, unknown> & {
-  readonly __serializedColorBrand: unique symbol;
-};
-
-interface CopyColorReturn {
-  [SerializationType.NONE]: Color;
-  [SerializationType.SERIALIZE]: SerializedColor;
-  [SerializationType.DESERIALIZE]: Color;
-}
-
-const KEYS = ["R", "G", "B", "A", "RO", "GO", "BO"];
-const OBJECT_NAME = "Color";
-
-export function colorEquals(color1: Color, color2: Color): boolean {
-  return isaacAPIClassEquals(color1, color2, KEYS);
-}
-
-/**
- * Helper function to copy a `Color` object.
- *
- * @param color The Color object to copy. In the case of deserialization, this will actually be a
- *              Lua table instead of an instantiated Color class.
- * @param serializationType Default is `SerializationType.NONE`.
- */
-export function copyColor<
-  C extends Color | SerializedColor,
-  S extends SerializationType,
->(color: C, serializationType: S): CopyColorReturn[S];
-export function copyColor<C extends Color | SerializedColor>(
-  color: C,
-): CopyColorReturn[SerializationType.NONE];
-export function copyColor(
-  color: Color | SerializedColor,
-  serializationType = SerializationType.NONE,
-): CopyColorReturn[keyof CopyColorReturn] {
-  switch (serializationType) {
-    case SerializationType.NONE: {
-      if (!isColor(color)) {
-        error(
-          `Failed to copy a ${OBJECT_NAME} object since the provided object was not a userdata ${OBJECT_NAME} class.`,
-        );
-      }
-
-      return Color(
-        color.R,
-        color.G,
-        color.B,
-        color.A,
-        color.RO,
-        color.GO,
-        color.BO,
-      );
-    }
-
-    case SerializationType.SERIALIZE: {
-      if (!isColor(color)) {
-        error(
-          `Failed to serialize a ${OBJECT_NAME} object since the provided object was not a userdata ${OBJECT_NAME} class.`,
-        );
-      }
-
-      const colorTable = new LuaTable<string, unknown>();
-      copyValuesToTable(color, KEYS, colorTable);
-      colorTable.set(SerializationBrand.COLOR, "");
-      return colorTable as SerializedColor;
-    }
-
-    case SerializationType.DESERIALIZE: {
-      if (!isTable(color)) {
-        error(
-          `Failed to deserialize a ${OBJECT_NAME} object since the provided object was not a Lua table.`,
-        );
-      }
-
-      const [r, g, b, a, ro, go, bo] = getNumbersFromTable(
-        color as LuaTable<string, unknown>,
-        OBJECT_NAME,
-        ...KEYS,
-      );
-
-      if (r === undefined) {
-        error(
-          `Failed to deserialize a ${OBJECT_NAME} object since the provided object did not have a value for: r`,
-        );
-      }
-      if (g === undefined) {
-        error(
-          `Failed to deserialize a ${OBJECT_NAME} object since the provided object did not have a value for: g`,
-        );
-      }
-      if (b === undefined) {
-        error(
-          `Failed to deserialize a ${OBJECT_NAME} object since the provided object did not have a value for: b`,
-        );
-      }
-
-      return Color(r, g, b, a, ro, go, bo);
-    }
-  }
-}
-
-/** Returns `Color(1, 1, 1)`. */
-export function getDefaultColor(): Color {
-  return Color(1, 1, 1);
-}
-
-/** Helper function to check if something is an instantiated Color object. */
-export function isColor(object: unknown): object is Color {
-  return isIsaacAPIClassOfType(object, OBJECT_NAME);
-}
-
-/**
- * Used to determine is the given table is a serialized `Color` object created by the save data
- * manager and/or the `deepCopy` function.
- */
-export function isSerializedColor(object: unknown): object is SerializedColor {
-  if (!isTable(object)) {
-    return false;
-  }
-
-  return tableHasKeys(object, ...KEYS) && object.has(SerializationBrand.COLOR);
-}

package/functions/debug.ts

@@ -1,68 +0,0 @@
-import { log } from "./log";
-
-/**
- * Helper function to get a stack trace.
- *
- * This will only work if the `--luadebug` launch option is enabled or the Racing+ sandbox is
- * enabled.
- */
-export function getTraceback(): string {
-  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-  if (debug !== undefined) {
-    // The --luadebug launch flag is enabled.
-    return debug.traceback();
-  }
-
-  if (sandboxGetTraceback !== undefined) {
-    return sandboxGetTraceback();
-  }
-
-  return 'stack traceback:\n(the "--luadebug" flag is not enabled)';
-}
-
-/**
- * Players can boot the game with an launch option called "--luadebug", which will enable additional
- * functionality that is considered to be unsafe. For more information about this flag, see the
- * wiki: https://bindingofisaacrebirth.fandom.com/wiki/Launch_Options
- *
- * When this flag is enabled, the global environment will be slightly different. The differences are
- * documented here: https://wofsauge.github.io/IsaacDocs/rep/Globals.html
- *
- * This function uses the `package` global variable as a proxy to determine if the "--luadebug" flag
- * is enabled or not.
- */
-export function isLuaDebugEnabled(): boolean {
-  // "package" is not always defined like the Lua definitions imply.
-  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-  return _G.package !== undefined;
-}
-
-/**
- * Helper function to print a stack trace to the "log.txt" file, similar to JavaScript's
- * `console.trace` function.
- *
- * This will only work if the `--luadebug` launch option is enabled or the Racing+ sandbox is
- * enabled.
- */
-export function traceback(): void {
-  const tracebackOutput = getTraceback();
-  log(tracebackOutput);
-}
-
-function setDebugFunctionsGlobal() {
-  // "debug" is not always defined like the Lua definitions imply.
-  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-  if (_G.debug === undefined && sandboxGetTraceback === undefined) {
-    return;
-  }
-
-  const globals = _G as Record<string, unknown>;
-
-  globals["getTraceback"] = getTraceback;
-  globals["traceback"] = traceback;
-}
-
-// If the debug functions will provide useful output, make them global by default.
-if (isLuaDebugEnabled() || sandboxGetTraceback !== undefined) {
-  setDebugFunctionsGlobal();
-}