Play Step SE - PlayStepSE.js

シェア用テキスト:
▼Play Step SE(神無月サスケ様作)
https://plugin.fungamemake.com/archives/2660
プレイヤーとイベントの足音を演奏します

ふりがな:ぷれいすてっぷさうんどえふぇくと

機能概要: プレイヤーとイベントの足音を演奏します

利用規約(ライセンス): MITライセンス

作者:神無月サスケ

作者サイト:https://twitter.com/ktakaki00

ダウンロードページ:https://forum.tkool.jp/index.php?threads/63/

ファイル名:PlayStepSE.js

プラグインのヘルプ:

/*:ja
 * @plugindesc プレイヤーとイベントの足音を演奏します
 * @author 神無月サスケ
 * 
 * @param Play Player Step SE
 * @desc デフォルトでプレイヤーの足音を出すかどうか(true:する false:しない)
 * @default false
 * 
 * @param Default SE Filename
 * @desc デフォルトの足音SEファイル名
 * @default Equip2
 * @require 1
 * @dir audio/se/
 * @type file
 * 
 * @param Default Volume
 * @desc デフォルトの足音ボリューム 
 * @default 20
 * 
 * @param Default Pitch
 * @desc デフォルトの足音ピッチ
 * @default 60
 * 
 * @param Default Interval
 * @desc デフォルトのインターバル。n歩ごとにSEを演奏
 * @default 1
 * 
 * @param Enable in EventRunning
 * @desc イベント中に音を出すか(true:する false:しない)
 * @default false
 * 
 * @help
 * プレイヤーとイベントの足音の設定を行います。
 * リージョン毎の指定も可能なのが特徴です。
 * 優先順位順にプラグインコマンド、マップやイベントでのメモ、
 * パラメータでの設定が可能です。
 * 
 * [パラメータ]
 * - デフォルトのSEおよびプレイヤーの演奏の是非を設定
 * - メモやプラグインコマンドに設定がある場合、そちらが優先
 * 
 * [メモ]
 * ・マップ
 * <StepSE:filename,volume,pitch,interval> マップ内のデフォルトの足音を設定
 * <StepRegion<regionId>SE:filename,volume,pitch,interval> マップ内の
 *  指定したリージョンでの足音を設定
 * 
 * - StepSE設定のないマップでは「パラメータまたはプラグインコマンドで設定した
 *   デフォルト」に
 * - マップのメモに設定があっても、自動的にはONにならない。
 *   プラグインコマンドで各キャラをONにする必要あり
 * - StepRegion<regionId>SE とは、StepRegion1SE やStepRegion255SE のように
 *   RegionIdを指定する形式のこと
 * - <StepSE><StepRegion10SE>のように : 以下を省略した場合、無音が設定される
 * 
 * ・イベント
 * <StepSE:filename,volume,pitch,interval> イベントのデフォルトの足音を設定
 * <StepRegion<regionId>SE:filename,volume,pitch,interval>
 *  イベントの指定したリージョンでの足音を設定
 * 
 * - イベントのメモに設定がある場合、デフォルトで足音ON。そうでない場合、OFF
 * - イベントのメモ欄に多数は書けないので、
 *   イベントのリージョンを多数指定したい場合、
 *   いくつかはプラグインコマンドで書くといい
 * 
 * ・メモ共通
 * - リージョンは複数指定可能。指定のないリージョンではデフォルトの足音を採用
 * - filename,volume,pitch,interval は省略可。
 *  省略の場合 空文字,100,90,1が設定される。
 *  interval とは何歩毎にSEを演奏するか
 * 
 * 例:
 * <StepSe:Coin,100>
 * <StepRegion12SE:Coin,90,150>
 * <StepRegion5SE:Noise,20,150,3>
 * 
 * [プラグインコマンド]
 * ・デフォルト足音の一時的変更
 * PlayStepSE default set <filename> <volume> <pitch> <interval>
 *  # ↑デフォルト設定を変更
 * PlayStepSE default reset  # デフォルト設定をリセット
 * PlayStepSE player set <filename> <volume> <pitch> <interval>
 *  # ↑プレイヤーの設定を変更
 * PlayStepSE player reset  # プレイヤーの設定をリセット
 * PlayStepSE event <eventId> set <filename> <volume> <pitch> <interval>
 *  # ↑イベントの設定を一時的に変更
 * PlayStepSE event <eventId> reset  # イベントの設定をリセット
 * 
 * ・リージョン関係の足音の一時的変更
 * PlayStepSE region <regionId> set <filename> <volume> <pitch> <interval>
 *  # ↑リージョンSE(共通)の設定を変更
 * PlayStepSE region <regionId> reset # リージョンSE(共通)をリセット
 * PlayStepSE player region <regionId> set <filename> <volume> <pitch> <interval>
 *  # ↑プレイヤーのリージョン設定を変更
 * PlayStepSE player region <regionId> reset
 *  # ↑プレイヤーのリージョン設定をリセット
 * PlayStepSE event <eventId> region <regionId> set <filename> <volume> <pitch>  <interval>
 *  # ↑イベントのリージョン設定を一時的に変更
 * PlayStepSE event <eventId> region <regionId> reset
 *  # ↑イベントのリージョン設定をリセット
 * PlayStepSE region <regionId> allreset 
 *  # ↑リージョンSE(共通)、プレイヤー、イベントの設定を一括リセット。
 *    マップの設定に戻す
 * 
 * - <filename> <volume> <pitch>  <interval> は省略可能で、省略した場合、
 *   空文字, 100, 90, 1 が設定される
 * - <interval> とは何歩毎にSEを演奏するか
 * - パラメータやメモの設定よりもプラグインコマンドが優先
 * - イベントの設定は、マップ移動が行われると、自動的にリセット
 * - プレイヤー、リージョンの設定はマップ移動が行われても持続。
 *   よってマップの設定に変更したい場合 reset や allreset を行うこと
 * - 「特定のリージョンだけ音を出したくない」という場合、そのリージョンの
 *   <filename>以下を全て省略するといい
 *   例:
 *   PlayStepSE player set  # プレイヤーの足音を無音に設定
 *   PlayStepSE region 10 set  # リージョン10の足音を無音に設定
 *   PlayStepSE player region 10 set  # プレイヤーのリージョン10の足音を無音に
 * 
 * ・設定音の演奏・停止の変更
 * PlayStepSE play player  # プレイヤーの足音を演奏開始
 * PlayStepSE stop player  # プレイヤーの足音を停止
 * PlayStepSE play event <eventId>  # 指定したイベントの足音を演奏開始
 * PlayStepSE stop event <eventId>  # 指定したイベントの足音を停止
 * 
 * - プレイヤーの設定は持続する。イベントの設定はマップ移動で自動的にリセット
 * 
 * ・イベント中足音演奏・停止の変更
 * PlayStepSE onEvent set   # イベント中でも足音を演奏するように設定
 * PlayStepSE onEvent reset # イベント中は足音を停止するように設定
 * 
 * [足音決定の優先順位の整理]
 * 設定がいろいろ複雑なので、優先順位を確認してください。
 * これで不便な場合、プラグイン作者までご連絡ください。
 * 
 * ・プレイヤーの足音を演奏するか
 *  - プラグインコマンドでの設定が優先
 *  - プラグインコマンドで設定しない場合、パラメータの設定(Play Player Step SE)
 * ・イベントの足音を演奏するか
 *  - プラグインコマンドでの設定が優先
 *  - プラグインコマンドで設定していない場合、イベントのメモに記述があればON、
 *    なければOFF
 * ・プレイヤーの足音
 *  - プラグインコマンドでのプレイヤーのリージョンSE
 *    (set で設定、 reset で設定解除。以下のプラグインコマンドも同様)
 *  - プラグインコマンドでの共通リージョンのSE
 *  - マップのメモのStepRegion???SE
 *  - プラグインコマンドでのプレイヤーのSE
 *  - マップのメモのStepSE
 *  - プラグインコマンドでのデフォルトのSE
 *  - パラメータ(Default SE Filename)
 * ・イベントの足音
 *  - プラグインコマンドでのイベントのリージョンSE
 *  - イベントのメモでのStepRegion???SE
 *  - プラグインコマンドでの共通リージョンSE
 *  - マップのメモのStepRegion???SE
 *  - プラグインコマンドでのイベントのSE
 *  - イベントのメモでのStepSE
 *  - マップのメモのStepSE
 *  - プラグインコマンドでのデフォルトのSE
 *  - パラメータ(Default SE Filename)
 * 
 * [注意]
 * - プラグインコマンドやメモで設定したSEファイルは不要ファイル削除ツールに
 *   必要ファイルとして登録されない。不要ファイル削除ツールを使う想定の場合
 *   ダミーのイベントを作成し、そこで設定するなど工夫が必要
 */
0

スポンサードリンク

スポンサードリンク

Copyright© #ツクプラ , 2020 All Rights Reserved.