ゲーム画面の他に、ウィンドウのみ/スプライトのみを - YKNR_MZ_SnapshotExporter.js

シェア用テキスト：

▼ゲーム画面の他に、ウィンドウのみ/スプライトのみを（焼きノリ様作） - YKNR_MZ_SnapshotExporter.js
https://plugin-mz.fungamemake.com/archives/8473
ゲーム画面の他に、ウィンドウのみ/スプライトのみを

ふりがな：げーむがめんのほかに、うぃんどうのみ/すぷらいとのみを

機能概要： ゲーム画面の他に、ウィンドウのみ/スプライトのみを

利用規約（ライセンス）： MITライセンス

作者：焼きノリ

作者サイト：https://github.com/Yakinori0424/RPGMakerMVPlugins/blob/master/plugins/YKNR_SnapshotExporter/YKNR_MZ_SnapshotExporter.js

解説ページ：https://github.com/Yakinori0424/RPGMakerMVPlugins/tree/…

ダウンロードページ：https://raw.githubusercontent.com/Yakinori0424/RPGMaker…

ファイル名：YKNR_MZ_SnapshotExporter.js

プラグインのヘルプ：

@help YKNR_MZ_SnapshotExporter.js
 * ----------------------------------------------------------------------------
 * 【！注意！】
 * ※本スクリプトはツクールMZ専用です。
 *   このプラグインは主に開発者向けに作られたもので、
 *   MV版の YKNR_SnapshotExporter.js をMZ版へと移植したものとなります。
 * ----------------------------------------------------------------------------
 *【機能紹介】
 * プラグインパラメータで設定したショートカットキーで、
 * ゲーム画面のスクリーンショットをいつでも撮影 & ダウンロードできます。
 * 
 * また、スクリプトを実行することで任意のウィンドウやスプライトだけを撮影して
 * 撮影 & ダウンロードすることもできます。
 * ゲーム中に表示されたUIのみを出力したいときに使えるかもしれませんが、
 * マイナーすぎる機能な感じもします..。
 * 
 * ----------------------------------------------------------------------------
 *【ダウンロード仕様】
 * ブラウザ経由で画像をダウンロードするため、
 * ネット上にアップロードしたゲームでも本機能は有効です。
 * （Chrome/FireFoxを用いて、GitHub上で動作確認済み）
 * ※Safariでは一部動作しないようなので、別タブで画像を開くようにしています。
 * 
 * ダウンロードした画像の保存場所は、ブラウザの設定に依存します。
 * ツクールからのテスト実行では、毎回保存場所を聞かれます。
 * 
 * ダウンロードする画像のファイル名のフォーマットは以下になっています。
 *   (ゲームタイトル)_(クラス名)_(年月日時分秒ミリ秒).(png/jpg)
 *   (ゲームタイトル)_(シーン名)_(年月日時分秒ミリ秒).(png/jpg)
 * 
 * ---------------------------------------------------------------------------
 * ※以下、スクリプトわかる方向け
 * ---------------------------------------------------------------------------
 *【提供している追加関数】
 * ・Bitmap/Sprite/Windowクラスのprototypeに撮影用関数を用意しました。
 *   基本的にはこちらの関数を使うのがよいです。
 *     Bitmap.prototype.exportPNG(className?: string)
 *     Bitmap.prototype.exportJPG(className?: string， quality?: number)
 *     Sprite.prototype.exportPNG()
 *     Sprite.prototype.exportJPG(quality?: number)
 *     Window.prototype.exportPNG()
 *     Window.prototype.exportJPG(quality?: number)
 * 
 * ・SceneManagerクラスに現在の画面を撮影する関数を用意しました。
 *     SceneManager.exportPNG()
 *     SceneManager.exportJPG(quality?: number)
 * 
 * ・Sprite/Windowクラスを撮影するためにBitmapへ変換する関数を用意しました。
 *     Bitmap.convert(pixi: PIXI.Container， dw?: number， dh?: number)
 * 
 * ---------------------------------------------------------------------------
 *【利用例】
 * パラメータの「スクリーンショットキー」と「装飾キー」を設定して
 * ゲーム中に設定したキーを押下することでゲーム画面を撮影できます。
 * 
 * スクリプトはコンソールから実行して撮影も可能です。
 * 
 * -------------------------------------
 * // 現在の画面をpng形式で撮影する
 * SceneManager.exportPNG();
 * -------------------------------------
 * // メニュー画面で実行すると背景の画像をpng形式で撮影する
 * SceneManager.backgroundBitmap().exportPNG();
 * -------------------------------------
 * // タイトル画面で実行すると
 * // 「はじめから」などのコマンドのウィンドウをpng形式で撮影する
 * SceneManager._scene._commandWindow.exportPNG();
 * -------------------------------------