@bitsy/hecks/src/edit image from dialog.js

a collection of re-usable scripts for bitsy game maker

/**
🖌
@file edit image from dialog
@summary edit sprites, items, and tiles from dialog
@license MIT
@version 1.2.6
@requires 5.3
@author Sean S. LeBlanc

@description
You can use this to edit the image data of sprites (including the player avatar), items, and tiles through dialog.
Image data can be replaced with data from another image, and the palette index can be set.

(image "map, target, source")
Parameters:
  map:    Type of image (SPR, TIL, or ITM)
  target: id/name of image to edit
  source: id/name of image to copy

(imageNow "map, target, source")
Same as (image), but applied immediately instead of after dialog is closed.

(imagePal "map, target, palette")
Parameters:
  map:    Type of image (SPR, TIL, or ITM)
  target: id/name of image to edit
  source: palette index (0 is bg, 1 is tiles, 2 is sprites/items, anything higher requires editing your game data to include more)

(imagePalNow "map, target, palette")
Same as (imagePal), but applied immediately instead of after dialog is closed.

Examples:
  (image "SPR, A, a")
  (imageNow "TIL, a, floor")
  (image "ITM, a, b")
  (imagePal "SPR, A, 1")
  (imagePalNow "TIL, floor, 2")

HOW TO USE:
  1. Copy-paste this script into a new script tag after the Bitsy source code.
     It should appear *before* any other mods that handle loading your game
     data so it executes *after* them (last-in first-out).

TIPS:
  - The player avatar is always a sprite with id "A"; you can edit your gamedata to give them a name for clarity
  - You can use the full names or shorthand of image types (e.g. "SPR" and "sprite" will both work)
  - The "source" images don't have to be placed anywhere; so long as they exist in the gamedata they'll work
  - This is a destructive operation! Unless you have a copy of an overwritten image, you won't be able to get it back during that run

NOTE: This uses parentheses "()" instead of curly braces "{}" around function
      calls because the Bitsy editor's fancy dialog window strips unrecognized
      curly-brace functions from dialog text. To keep from losing data, write
      these function calls with parentheses like the examples above.

      For full editor integration, you'd *probably* also need to paste this
      code at the end of the editor's `bitsy.js` file. Untested.
*/
import bitsy from "bitsy";
import {
  after,
  addDualDialogTag
} from "./helpers/kitsy-script-toolkit";
import {
  getImage
} from "./helpers/utils";
import {
  getImageData,
  setImageData
} from "./helpers/edit image at runtime";

// map of maps
var maps;
after('load_game', function () {
	maps = {
    spr: bitsy.sprite,
    sprite: bitsy.sprite,
    til: bitsy.tile,
    tile: bitsy.tile,
    itm: bitsy.item,
    item: bitsy.item,
	};
});

function editImage(environment, parameters) {
  var i;

  // parse parameters
  var params = parameters[0].split(/,\s?/);
  params[0] = (params[0] || "").toLowerCase();
  var mapId = params[0];
  var tgtId = params[1];
  var srcId = params[2];

  if (!mapId || !tgtId || !srcId) {
    throw new Error('Image expects three parameters: "map, target, source", but received: "' + params.join(', ') + '"');
  }

  // get objects
  var mapObj = maps[mapId];
  if (!mapObj) {
    throw new Error('Invalid map "' + mapId + '". Try "SPR", "TIL", or "ITM" instead.');
  }
  var tgtObj = getImage(tgtId, mapObj);
  if (!tgtObj) {
    throw new Error('Target "' + tgtId + '" was not the id/name of a ' + mapId + '.');
  }
  var srcObj = getImage(srcId, mapObj);
  if (!srcObj) {
    throw new Error('Source "' + srcId + '" was not the id/name of a ' + mapId + '.');
  }

  // copy animation from target to source
  tgtObj.animation = {
    frameCount: srcObj.animation.frameCount,
    isAnimated: srcObj.animation.isAnimated,
    frameIndex: srcObj.animation.frameIndex
  };
  for (i = 0; i < srcObj.animation.frameCount; ++i) {
    setImageData(tgtId, i, mapObj, getImageData(srcId, i, mapObj));
  }
}

function editPalette(environment, parameters) {
  // parse parameters
  var params = parameters[0].split(/,\s?/);
  params[0] = (params[0] || "").toLowerCase();
  var mapId = params[0];
  var tgtId = params[1];
  var palId = params[2];

  if (!mapId || !tgtId || !palId) {
    throw new Error('Image expects three parameters: "map, target, palette", but received: "' + params.join(', ') + '"');
  }

  // get objects
  var mapObj = maps[mapId];
  if (!mapObj) {
    throw new Error('Invalid map "' + mapId + '". Try "SPR", "TIL", or "ITM" instead.');
  }
  var tgtObj = getImage(tgtId, mapObj);
  if (!tgtObj) {
    throw new Error('Target "' + tgtId + '" was not the id/name of a ' + mapId + '.');
  }
  var palObj = parseInt(palId);
  if (isNaN(palObj)) {
    throw new Error('Palette "' + palId + '" was not a number.');
  }

  // set palette
  tgtObj.col = palObj;

  // update images in cache
  bitsy.renderImageForAllPalettes(tgtObj);
}

// hook up the dialog tags
addDualDialogTag('image', editImage);
addDualDialogTag('imagePal', editPalette);