pastime/js/plugins/UTSU_PictureBreath_MZ.js

//=============================================================================
// UTSU_PictureBreath_MZ.js
// ----------------------------------------------------------------------------
// Copyright (c) 2020 Utsuda Shinou
// This software is released under the MIT License.
// http://opensource.org/licenses/mit-license.php
// ----------------------------------------------------------------------------
// Version
// 1.0.0 2020/09/06 Add support RPG Maker MZ
//
// --- Fork from UTSU_PictureBreath.js ----
//
// 1.1.3 2020/08/26 Fix bug that breath of pictures in map stops after battle
// 1.1.2 2020/08/25 Fix to continue picture breath even if picture changed for the same picture number
// 1.1.1 2020/08/25 Fix bug about init params
// 1.1.0 2020/08/23 Fix plugin does not work in a battle
//                  Fix help about parameters, speed -> period
// 1.0.0 2020/08/21 Release
// ----------------------------------------------------------------------------
// [GitHub] : https://github.com/utsudashinou
// [Twitter]: https://twitter.com/virtualUtsuda
//=============================================================================

/*:
 * @target MZ
 * @plugindesc ピクチャ息遣い
 * @author Utsuda Shinou
 * @url https://github.com/utsudashinou/RPGMakerMV
 *
 * @command on
 * @text ピクチャ息遣いON
 * @desc
 *
 * @arg pictureIds
 * @text ピクチャ番号
 * @desc
 * @type number[]
 * @min 1
 *
 * @arg period
 * @text 周期
 * @desc
 * @type number
 * @default 150
 *
 * @command off
 * @text ピクチャ息遣いOFF
 * @desc
 *
 * @arg pictureIds
 * @text ピクチャ番号
 * @desc
 * @type number
 * @min 1
 *
 * @help ピクチャに息遣いの動作を加えます。
 *
 * * スクリプト
 * UTSU.PictureBreath.on(pictureIds, period);
 *   息遣いをする。pictureIdsは対象のピクチャIDの配列、periodは息遣いの周期。
 *   例: UTSU.PictureBreath.on([1,2,3]), 150);
 *
 * UTSU.PictureBreath.off(pictureIds);
 *   息遣いをやめる。
 *   例: UTSU.PictureBreath.off([1,2,3]);
 *
 *
 * * プラグインコマンド
 * ◆プラグインコマンド：UTSU_PictureBreath, ピクチャ息遣いON
 * ：　　　　　　　　　：ピクチャ番号
 * ：　　　　　　　　　：周期
 *   息遣いをする。ピクチャ番号は対象のピクチャ番号の配列、周期は息遣いの周期。
 *   例:
 *     ◆プラグインコマンド：UTSU_PictureBreath, ピクチャ息遣いON
 *     ：　　　　　　　　　：ピクチャ番号 = ["1", "2", "3", "4", "5"]
 *     ：　　　　　　　　　：周期 = 150
 *
 * ◆プラグインコマンド：UTSU_PictureBreath, ピクチャ息遣いOFF
 * ：　　　　　　　　　：ピクチャ番号
 *   息遣いをやめる。
 *   例:
 *     ◆プラグインコマンド：UTSU_PictureBreath, ピクチャ息遣いOFF
 *     ：　　　　　　　　　：ピクチャ番号 = ["1", "2", "3", "4", "5"]
 *
 */

((global) => {
  const pluginName = "UTSU_PictureBreath_MZ";

  global.UTSU = global.UTSU || {};
  global.UTSU.PictureBreath = global.UTSU.PictureBreath || {};

  const STATE_NO_OPERATION = -1;
  const STATE_REQUEST_DEACTIVATE = 0;
  const STATE_REQUEST_ACTIVATE = 1;

  const breathBackup = {};

  global.UTSU.PictureBreath.on = (pids, period) => {
    pids.forEach((pid) => {
      const picture = $gameScreen.picture(Number(pid));
      if (picture) {
        picture._breathState = STATE_REQUEST_ACTIVATE;
        picture._breathPeriod = Number(period);

        const realPictureId = $gameScreen.realPictureId(Number(pid));
        breathBackup[realPictureId] = {
          _breathPeriod: picture._breathPeriod,
        };
      }
    });
  };

  global.UTSU.PictureBreath.off = (pids) => {
    pids.forEach((pid) => {
      const picture = $gameScreen.picture(Number(pid));
      if (picture) {
        picture._breathState = STATE_REQUEST_DEACTIVATE;

        const realPictureId = $gameScreen.realPictureId(Number(pid));
        breathBackup[realPictureId] = null;
      }
    });
  };

  PluginManager.registerCommand(pluginName, "on", (args) => {
    UTSU.PictureBreath.on(JSON.parse(args["pictureIds"]), args["period"]);
  });

  PluginManager.registerCommand(pluginName, "off", (args) => {
    UTSU.PictureBreath.off(JSON.parse(args["pictureIds"]));
  });

  const _Game_Screen_showPicture = Game_Screen.prototype.showPicture;
  Game_Screen.prototype.showPicture = function (pictureId, name, origin, x, y, scaleX, scaleY, opacity, blendMode) {
    _Game_Screen_showPicture.call(this, pictureId, name, origin, x, y, scaleX, scaleY, opacity, blendMode);
    const realPictureId = this.realPictureId(pictureId);
    if (breathBackup[realPictureId]) {
      const picture = this._pictures[realPictureId];
      picture._breathState = STATE_REQUEST_ACTIVATE;
      picture._breathPeriod = breathBackup[realPictureId]._breathPeriod;
    }
  };

  const _Game_Picture_initBasic = Game_Picture.prototype.initBasic;
  Game_Picture.prototype.initBasic = function () {
    _Game_Picture_initBasic.call(this);
    this._breathActive = false;
    this._breathState = STATE_NO_OPERATION;
    this._breathPeriod = 0;
    this._breathCount = 0;
  };

  const _Game_Picture_update = Game_Picture.prototype.update;
  Game_Picture.prototype.update = function () {
    _Game_Picture_update.call(this);
    if (this._breathState === STATE_REQUEST_ACTIVATE) {
      this._breathState = STATE_NO_OPERATION;
      this._breathActive = true;
      this._breathCount = 0;
    }
    if (this._breathState === STATE_REQUEST_DEACTIVATE) {
      this._breathState = STATE_NO_OPERATION;
      this._breathActive = false;
    }
    if (this._breathActive) {
      this._breathCount = (this._breathCount + 1) % this._breathPeriod;
    }
  };

  const _Sprite_Picture_update = Sprite_Picture.prototype.update;
  Sprite_Picture.prototype.update = function () {
    _Sprite_Picture_update.call(this);
    if (this.visible) {
      this._breathUpdate();
    }
  };

  Sprite_Picture.prototype._breathUpdate = function () {
    const picture = this.picture();
    if (!picture) {
      return;
    }
    if (picture._breathActive) {
      const freq = Math.sin((Math.PI * picture._breathCount) / (picture._breathPeriod / 2));
      this.scale.y -= freq * 0.015 + 0.015;
      this.y -= Math.ceil((this.height * (1.0 - this.scale.y)) / 2);
      this.scale.x += freq * 0.005 + 0.005;
      this.x += Math.ceil(this.width * (1.0 - this.scale.x));
    }
  };
})(window);