YEP Grid-Free Doodads - YEP_GridFreeDoodads.js

シェア用テキスト：

▼YEP Grid-Free Doodads（Yanfly様作） - YEP_GridFreeDoodads.js
https://plugin.fungamemake.com/archives/10657
マップ上に小物をピクセル単位で配置

ふりがな：ぐりっどふりーどぅーだっど

機能概要： マップ上に小物をピクセル単位で配置

利用規約（ライセンス）：http://www.yanfly.moe/wiki/Category:Yanfly_Engine_Plugi…

作者：Yanfly

作者サイト：http://yanfly.moe/

解説ページ：https://fungamemake.com/archives/1670

ダウンロードページ：http://yanfly.moe/2016/09/17/yep-116-grid-free-doodads-…

ファイル名：YEP_GridFreeDoodads.js

プラグインのヘルプ：

/*:ja
 * @plugindesc v1.10 ゲーム内エディタを使用して、Grid-FreeDoodadsをゲームに配置 します。静的およびアニメーションdoodadを使用することができます。
 *
 * @author Yanfly Engine Plugins
 *
 * @param ---一般---
 * @default
 *
 * @param Doodads Folder
 * @parent ---一般---
 * @desc doodadsフォルダへのパス
 *
 * @default img/doodads/
 *
 * @param Doodads Smoothing
 * @parent ---一般---
 * @type boolean
 * @on 滑らか
 * @off 硬い
 * @desc デフォルトでdoodadのエッジを滑らかにするか、それとも硬いエッジを与える か?
 * 滑らか - true     硬い - false
 * @default false
 *
 * @param Alphabetical Settings
 * @parent ---一般---
 * @type boolean
 * @on アルファベット順
 * @off ID順
 * @desc doodad設定をアルファベット順に一覧表示しますか？
 * アルファベット順 - true     ID順 - false
 * @default false
 *
 * @param ---グリッドスナップ---
 * @default
 *
 * @param Default Grid Snap
 * @parent ---グリッドスナップ---
 * @type boolean
 * @on 有効
 * @off 無効
 * @desc デフォルトのグリッドスナップ設定
 * 有効 - true     無効 - false
 * @default false
 *
 * @param Grid Snap Width
 * @parent ---グリッドスナップ---
 * @type number
 * @min 1
 * @desc デフォルトのグリッドスナップ幅
 * @default 48
 *
 * @param Grid Snap Height
 * @parent ---グリッドスナップ---
 * @type number
 * @min 1
 * @desc デフォルトのグリッドスナップの高さ
 * @default 48
 *
 * @help
 * 翻訳:ムノクラ
 * https://munokura.tk/
 * https://twitter.com/munokura/
 *
 * ============================================================================
 * Introduction
 * ============================================================================
 *
 * RPGツクールMVでは、
 * タイルセットはマッピング目的で使用されます。
 * タイルセットAは土地の表示に使用され、
 * タイルセットBからEは上書きの追加に使用されます。
 * しかしRPGツクールMVでは、
 * タイルセットBからEで追加されたdoodadはグリッドに固定されているため、
 * かなり不自然な感じになります。
 * このプラグインを使用すると、グリッドから解放され、
 * グリッドに拘束されていないdoodadを追加できます。
 * doodadsは、静的からアニメートまで、大小様々な形で登場します。
 *
 * ============================================================================
 * Instructions - Requirements
 * ============================================================================
 *
 * プラグインの使用方法
 *
 * 1.プロジェクトの'data'フォルダ内にDoodads.jsonが必要です。
 * 2.プロジェクトの'img'フォルダの中に'doodads'フォルダが必要です。
 *    (あなたがそれをプラグインパラメータで何か他の名前を付けない限り)。
 * あなたはこのフォルダ内にあなたのdoodadsを持っている必要があります。
 *
 * Yanfly.moeから上記のリソースを見つけることができます。
 * http://yanfly.moe/2016/09/17/yep-116-grid-free-doodads-rpg-maker-mv/
 *
 * ============================================================================
 * Instructions - Placing Doodads
 * ============================================================================
 *
 * ゲームにdoodadsを配置するには、
 * まずテストプレイモードでゲームをロードします。
 * RPGツクールMVでゲームを開いて[Game]に移動し、
 * [PlayTest](ショートカットCtrl+R)を選択してこれを実行できます。
 *
 * doodadを配置したいマップにロードしたら、
 * F10キーを押してdoodadエディタにアクセスします。
 * あなたはオプションを選択することができます。
 * 'Doodadsを配置'doodadsを配置し始めます。
 *
 * - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
 *
 * ---Main Menu---
 * メインメニューは、マップ上でF10キーを押した時に
 * 最初に表示されるメニューです。
 *
 *   Place Doodads
 *   - マップ上に配置するdoodadを選択することができるdoodadsフォルダをするのに
 *   かかります。
 *
 *   Edit Doodads
 *   - 既にマップ上に置いたdoodadを編集することを可能にするでしょう。
 *   上にあるレイヤーに基づいて、
 *   全てのdoodadから一度にどっちのdoodadを選択することができます。
 *   Doodadsは上から下、左から右への位置に基づいて並べられます。
 *
 *   Clear Doodads
 *   - マップ上の全てのdoodadsをクリアします。
 *
 *   Toggle Region Overlay
 *   - どのタイルがどのリージョンの影響を受けるのかを示すために、
 *   リージョンのオーバーレイが画面に表示されます。
 *   リージョンを隠すにはもう一度使用します。
 *   警告:大きなマップではじめてこれを使用すると、
 *   リージョンをロードする必要があるため、少し時間がかかります。
 *   マップが大きいほど、ロードにかかる時間が長くなります。
 *
 *   Cancel and Close
 *   - マップ上のdoodad設定に加えられた変更が削除され、
 *   Doodadメニューが閉じます。
 *
 *   Save and Close
 *   - マップ上のdoodad設定に対する変更が保存され、
 *   Doodadメニューが閉じます。
 *
 * - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
 *
 * ---Doodad List---
 * doodadリストには、
 * 現在のフォルダに基づいてマップに使用できる全てのdoodadのリストが
 * 表示されます。
 * ここから選択できる3種類のオプションがあります。
 *
 *   IconSet
 *   - iconsetのアイコンからdoodadを作成できます。
 *   アイコンから作られたdoodadはもう少し制限があり、
 *   色相の変更を利用することはできません。
 *   使いたいアイコンを選択することができるメニューDoodadPlacingModeに行きます。
 *
 *   Folders
 *   - フォルダは名前の最後に/が付き、
 *   他の全てのフォルダと共有されているアイコンが表示されます。
 *   フォルダを選択すると、そのフォルダの内容に移動します。
 *
 *   Images
 *   - 画像は、名前の左側に自分自身の小さなプレビューを表示します。
 *   これらの画像は何の制限もなくdoodadとして使用することができます。
 *   画像を選択すると、DoodadPlacingModeに入ります。
 *
 * - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
 *
 * ---Doodad Placing Mode---
 * DoodadPlacingModeにいる時、
 * いくつかの説明テキストと共に以下のスクリーンの小さいセクションに
 * 気づくでしょ う。
 *
 *   Q E - Layer -/+
 *   - doodadの現在のレイヤーを増減できます。
 *
 *   T - Tweak Settings
 *   - Doodad設定メニューが開きます。
 *
 *   W A S D - Move Screen
 *   - スクリーンを動かすので、プレイヤーキャラクターの位置を変えなくても
 *   マップをはっきりと見ることができます。
 *
 *   ↑←↓→ - Precision Move
 *   - 方向キーを押すと、
 *   マウスの代わりにキーボードを使ってdoodadを動かすことができます。
 *   マウスを使って移動したい場合、
 *   どこかのマップをクリックしてマウスに制御を戻します。
 *
 *   Z X - Place or Cancel
 *   - Zを押すと、マップ上でdoodadが現在のステートになります。
 *   - Xを押すと、
 *   DoodadList(アイコンから作られたdoodadを配置している場合、IconPicker)に
 *   戻ります。
 *
 * 使うことができる隠されたキーボードコマンドがいくつかあります。
 * これらの指示を注意深く読んだ使用者に報いられます。万歳。
 *
 *   H - Hide/Show the Instruction Window
 *   - Hを押すと、指示ウィンドウが非表示になり、
 *   doodadをどこに置いているのかがはっきりわかります。
 *   もう一度押すと元に戻ります。
 *
 *   1 2 3 4 5 6 7 8 9 0 - Quick Opacity Change
 *   - 1から0のキー(NumPadではない)を使用すると、
 *   doodadの不透明度をすばやく調整できます。
 *   1は10%を設定し、2は20%を設定し、3は30%を設定します。
 *
 *   G - Grid Snap Menu
 *   - グリッドスナップメニューが開き、
 *   グリッドスナップとグリッドスナップパラメータを有効・無効にできます。
 *
 *   R - Region Overlay
 *   - どのタイルがどのリージョンの影響を受けるのかを示すために、
 *   リージョンのオーバーレイが画面に表示されます。
 *   リージョンを非表示にするには、もう一度Rを押します。
 *   警告:大きなマップではじめてこれを使用すると、
 *   リージョンをロードする必要があるため、少し時間がかかります。
 *   マップが大きいほど、ロードにかかる時間が長くなります。
 *
 * - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
 *
 * ---Doodad Settings---
 * Doodad配置モード中に'T'を押すか、個々のDoodadにアクセスすると、
 * Doodad設定に出くわすでしょう。
 *
 *   Change Position
 *   - 個々のdoodad管理からアクセスされる場合のみ選択可能です。
 *   あなたはdoodadの位置を変えることができます。
 *
 *   Layer
 *   - doodadのレイヤーを変更することを可能にします。
 *   より高い層はdoodadを他の(そして文字)の上に表示させ、
 *   より低い層はdoodadを下に表示させます。
 *
 *   Hue
 *   - 色相に変更すると、
 *   doodadの現在のカラーシフトが変わります。
 *   このプロセスには大量の処理能力が必要となるので注意してください。
 *   モバイルにエクスポートする予定がある場合、
 *   色合いの異なるdoodadを使用しないことを強くお勧めします。
 *
 *   Opacity
 *   - doodadの不透明度を変更します。
 *   不透明度の値が高いと、doodadの透明度は低くなります。
 *   不透明度の値が低いほど、透明度が高くなります。
 *
 *   Scale X, Scale Y
 *   - doodadのストレッチ量が変わります。
 *   Xはdoodadを水平方向に伸ばし、Yはdoodadを垂直方向に伸ばします。
 *   負の値を使用した場合、doodadはミラー化されます。
 *
 *   Anchor X, Anchor Y
 *   - doodadのベース座標を設定します。
 *   同じレイヤーの他のdoodad/オブジェクトが
 *   このdoodadとどのように相互作用するかは、
 *   その座標に基づきます。
 *
 *   Frame Speed
 *   - doodadがアニメーション化されている場合、
 *   ここでdoodadのフレーム速度を調整できます。
 *   この数は、
 *   doodadが次のアニメーションセルに更新されるまでに
 *   通過しなければならないフレーム数を表します。
 *   数値が小さいほどアニメーションが速くなり、
 *   数値が大きいほどアニメーションが遅くなります。
 *
 *   Blend
 *   - あなたはdoodadのブレンドモードを変更することができます。
 *   ブレンドモードは、
 *   ブレンドモードのタイプに基づく色の違いを、
 *   その背後にある視覚効果に合わせるようにします。
 *
 *   Smooth
 *   - doodadに滑らかなエッジと硬いエッジの
 *   どちらをロードするかを選択しましょう。
 *
 *   Delete Doodad
 *    - 個々のdoodad管理からアクセスされる場合のみ選択可能です。
 *    doodadを削除してからdoodad管理リストに戻ることができます。
 *
 *   Revert Settings
 *   - 全ての設定をキャンセルして前のモードに戻ります。
 *
 *   Accept Settings
 *   - 全ての設定を受け入れて、以前のモードに戻ります。
 *
 * - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
 *
 * ============================================================================
 * Instructions - Making Your Own Doodads
 * ============================================================================
 *
 * Doodadsには2つの要件があります。
 *
 * 1.それらはPNGでなければなりません。
 * 2.それらは'doodads'フォルダ(プラグインパラメータから指定されたフォルダ)内、
 *   'doodads'フォルダ内のフォルダ内に存在する必要があります。
 *
 * フォルダが'doodads'フォルダ内に配置されている場合、
 * ナビゲートするディレクトリツリーとしてdoodadsリストに表示されます。
 *
 * - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
 * Making Animated Doodads
 * - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
 *
 * doodadはアニメーションdoodadにすることができます。
 * アニメーションdoodadは、
 * ゲームの画像が更新される度にアニメートされるものです。
 * アニメーションdoodadを作るためにこれらのステップに従ってください。
 *
 * 1.スプライトに似たセルレイアウトでdoodadを作成します。
 * 2.各セルは、他のセルと同じ幅と高さでなければなりません。
 * 3.doodadに名前を付ける時、名前に[AxB]を追加します。
 *   AとBを水平方向のセル数(A)と垂直方向のセル数(B)を表す数字に置き換えます。
 *   横3セル、縦2セルのdoodadは、
 *   'Torch[3x2].png'のような名前になります。
 * 4.doodadsセルが左から右にアニメートします。
 *   彼らが完全に完全に到達すると、
 *   彼らは行を下に移動して再び左から右に更新します。
 *   'Torch[3x2].png'という名前のdoodadが次のように更新されます。
 *
 *      0   1   2
 *      3   4   5
 *
 * どのようにアニメ化されたdoodadの創造に取りかかるだろうかです。
 * これがわかりにくい場合、
 * Yanfly.moeから提供されている例をいくつか見てください 。
 *
 * ============================================================================
 * Changelog
 * ============================================================================
 *
 * Version 1.10:
 * - Fixed loading issues for people using version 1.5.0+ and not using the
 * YEP_X_CoreUpdatesOpt and desktop optimization setting.
 *
 * Version 1.09:
 * - Fixed a bug for the Toggle Region Overlay that made certain dimensions not
 * work properly.
 *
 * Version 1.08:
 * - Updated for RPG Maker MV version 1.6.0 again. There was an issue with
 * newly added doodads not saving properly due to the changed file structure.
 *
 * Version 1.07:
 * - Updated for RPG Maker MV version 1.6.0.
 *
 * Version 1.06:
 * - Added 'Import from Another Map' command to the main doodad menu.
 *
 * Version 1.05:
 * - Updated for RPG Maker MV version 1.5.0.
 *
 * Version 1.04:
 * - Calculations made for previous version are now rounded upward instead of
 * rounding down to accomodate for smoother screen scrolling.
 *
 * Version 1.03:
 * - Adjusted calculations for grid-snapping when graphic resolutions aren't
 * divisible by tile width or height.
 *
 * Version 1.02:
 * - Made the height for certain setting options default to the height of the
 * screen if the screen is too small to hold all the options.
 * - Rearranged some settings in the settings menu to make it more optimal for
 * the addition of new doodad settings options.
 * - Added 'Alphabetical Settings' option to plugin parameters. This will turn
 * the settings list for the doodads to flow in alphabetical order.
 *
 * Version 1.01:
 * - Fixed a bug that caused doodads to overlap onto the other border of the
 * map if it was clipped off.
 * Version 1.00:
 * - Finished Plugin!
 */