VE Custom Vehicles - VE_CustomVehicles.js
シェア用テキスト：
▼VE Custom Vehicles（Victor Sant様作） - VE_CustomVehicles.js
https://plugin.fungamemake.com/archives/26947
乗り物の詳細設定ができ、デフォルトの3台以外にも追加できます。
ふりがな：かすたむしゃりょう
機能概要： 乗り物の詳細設定ができ、デフォルトの3台以外にも追加できます。
利用規約（ライセンス）：https://fungamemake.com/victor-engine-jaspanese
作者：Victor Sant
作者サイト：https://victorenginescripts.wordpress.com/
ダウンロードページ：https://fungamemake.com/archives/10073
ファイル名：VE_CustomVehicles.js
プラグインのヘルプ：
/*:ja
* @plugindesc v1.02 乗り物の詳細設定ができ、デフォルトの3台以外にも追加できます
* @author Victor Sant
*
* @param Vehicle Setup Event
* @text 乗り物設定コモンイベント
* @type common_event
* @desc ニューゲームで乗り物の設定を行うコモンイベントID
* @default 1
*
* @help
* 翻訳:ムノクラ
* https://fungamemake.com/
* https://twitter.com/munokura/
*
* 元プラグイン:
* https://victorenginescripts.wordpress.com/rpg-maker-mv/custom-vehicles/
*
*
* ===========================================================================
* 必要プラグイン
* ===========================================================================
*
* このプラグインを使用するには、下記のプラグインが必要です。
* - VE_BasicModule
*
*
* ---------------------------------------------------------------------------
* コモンイベントの注釈タグ
* ---------------------------------------------------------------------------
*
* <vehicle: 'type'>
* charset: 'filename', index
* initial map: id, X, Y
* character above
* idle animation
* step animation
* altitude: X
* speed: X
* passability: X
* switch: X
* passable region: X[, X...]
* landing region: X[, X...]
* boarding region: X[, X...]
* passable terrain: X[, X...]
* landing terrain: X[, X...]
* boarding terrain: X[, X...]
* music: 'filename', volume, pitch
* encounter rate: X%
* encounter region: X:Y [, X:Y...]
* idle sound: 'filename', volume, pitch, delay
* move sound: 'filename', volume, pitch, delay
* battleback: X:'bb1','bb2'[, X:'bb1','bb2'...]
* </vehicle>
*
* このタグで乗り物の設定を行います。
* この設定はかなり複雑で、様々なパーツに分かれています。
* 全てのオプションを追加する必要はなく、自分が使うものだけを追加して、
* 他は全て省略できます。
*
* ---------------
*
* - Type
* 乗り物のタイプは、乗り物のシンボル名です。
* これらは、プラグインコマンドを使用する時、
* 乗り物を識別するために使用されます。
* 各乗り物にはそれぞれシンボル名を付ける必要があります。
* 'walk'、'boat'、'ship'、'airship'というシンボル名は、
* デフォルトの乗り物/通常の歩行に予約されており、使用することはできません。
* その上で空白を入れないことを推奨します。
* 入れると、その乗り物ではプラグインコマンドが使えなくなります。
* 'type' : 乗り物のシンボル名。('で囲う)
*
* ---------------
*
* - Charset
* キャラセットファイル名とインデックス
* (8キャラのキャラシートを使用している場合)
* 'filename' : キャラセットファイル名 ('で囲う)
* index : キャラセットインデックス (0-8)
*
* ---------------
*
* - Initial Map
* 新しいゲームを開始した時のマップと乗り物の位置座標です。
* 設定されていない場合、
* プラグインコマンドを使用して乗り物を移動する必要があります。
* id : マップID
* X : X座標
* Y : Y座標
*
* ---------------
*
* - Character Above
* プレイヤーが乗るためには乗り物の上に移動する必要があります。
* タグなしで、プレイヤーは直面することによって、
* 乗り物に乗ることができます。
*
* ---------------
*
* - Step Animation
* 乗り物は運転中のアイドル時に足踏みアニメーションを表示します。
* セットされていなければ、動く時だけ動きがあります。
*
* ---------------
*
* - idle Animation
* 乗り物は運転されていない時、休止している時、段階的な動きをします。
* 設定されていない場合、乗り物は移動時にのみアニメーションするか、
* 'idle animation'タグがある場合、足踏みアニメーションをします。
*
* ---------------
*
* - Altitude
* 移動中の乗り物の高さ。
* X : 高さ (0より大きい数値)
*
* ---------------
*
* - Speed
* 移動中の乗り物の移動速度。
* X : 移動速度 (0より大きい数値)
*
* ---------------
*
* - Passability
* オブジェクトセットから通行可能な設定を継承します。
* これがなければ通行可能なものは、リージョンタイルのみを基準とします。
* X : オブジェクトシンボル名 (player, boat, ship, airship)
*
* ---------------
*
* - Switch
* 移動中はスイッチをONにします。
* 降りるとOFFにします。
* X : スイッチID
*
* ---------------
*
* - Passable Regions
* 乗り物が通行可能なリージョン。
* リストされていないリージョンは、タイルの通行設定に関わらず、
* 常にブロックされます。
* リージョンID0は、リージョンのないタイルを定義するために使用されます。
* 設定されていない場合、
* 通行設定は地形や基本的な乗り物から継承されたものになります。
* X : リージョンID
* カンマ区切りで値を追加できます。
*
* ---------------
*
* - Landing Regions
* プレーヤーが乗り物から降りられるリージョン。
* リストされたリージョン以外のリージョンでは、
* プレイヤーは乗り物から降りられません。
* リージョンID0は、リージョンのない任意のタイルを定義するために使用されます。
* 設定されていない場合、リージョンに基づく着陸の制限はありません。
* X : リージョンID
* カンマ区切りで値を追加できます。
*
* ---------------
*
* - Boarding Regions
* プレーヤーが乗り物に乗ることができるリージョン。
* リストされたもの以外のリージョンでは、
* プレイヤーは乗り物に乗ることができません。
* リージョンID0は、リージョンのないタイルを定義するのに使用されます。
* 設定されていない場合、リージョンに基づく制限はありません。
* X : リージョンID
* カンマ区切りで値を追加できます。
*
* ---------------
*
* - Passable Terrains
* 乗り物が通行可能な地形。
* リストされていない地形は、タイルの通行設定に関わらず、
* 常にブロックされます。
* 地形タグ0は、地形のないタイルを定義するために使用されます。
* 設定されていない場合、
* 通行設定は地形や基本的な乗り物から継承されたものになります。
* X : 地形タグ
* カンマ区切りで値を追加できます。
*
* ---------------
*
* - Landing Terrains
* 乗り物から降りることができる地形。
* リストされている以外の地形では、
* プレイヤーは乗り物から降りられません。
* 地形タグ0は、地形のない任意のタイルを定義するために使用されます。
* 設定されていない場合、地形に基づく制限はありません。
* X : 地形タグ
* カンマ区切りで値を追加できます。
*
* ---------------
*
* - Boarding Terrains
* プレイヤーが乗り物に乗れる地形。
* リスト以外の地形では、
* プレイヤーは乗り物に乗ることができません。
* 地形タグ0は、地形のないタイルを定義するために使用されます。
* 設定されていない場合、地形に基づく制限はありません。
* X : 地形タグ
* カンマ区切りで値を追加できます。
*
* ---------------
*
* - Music
* 運転中に再生されるBGMを設定します。
* 設定していない場合、再生しているBGMは変わりません。
* 'filename' : BGMファイル名 ('で囲う)
* volume : BGM音量 (0-100)
* pitch : BGMピッチ (50-150)
* pan : BGMパン (0-100, 正負の値)
*
* ---------------
*
* - Idle Sound
* 停止状態で効果音を繰り返し再生します。
* 設定されていない場合、音は鳴りません。
* 'filename' : SEファイル名 ('で囲う)
* volume : SE音量 (0-100)
* pitch : SEピッチ (50-150)
* pan : SEパン (0-100, 正負の値)
* delay : 音が再生される間隔をフレーム単位で指定します。
* (間隔の値が低いとラグが発生する場合があります)
*
* ---------------
*
* - Move Sound
* 乗り物が移動している時、効果音を繰り返し再生します。
* 設定されていない場合、音は鳴りません。
* 'filename' : SEファイル名 ('で囲う)
* volume : SE音量 (0-100)
* pitch : SEピッチ (50-150)
* pan : SEパン (0-100, 正負の値)
* delay : 音が再生される間隔をフレーム単位で指定します。
* (間隔の値が低いとラグが発生する場合があります)
*
* ---------------
*
* - Encounter Rate
* 移動中のエンカウント率。
* この値は、現在のエンカウント率を掛け合わせた%の値です。
* つまり、値が100%の場合はエンカウント率に変化がないことを意味し、
* 50%の場合はエンカウント率が半分になり、
* 0%の場合はエンカウントしないことを意味します。
* 設定されていない場合、エンカウント率は変更されません。
* X : エンカウント率
*
* ---------------
*
* - Encounter Region
* あるリージョンの敵グループを別のリージョンと入れ替えます。
* 古いリージョンと新しいリージョンのIDを設定する必要があります。
* リージョンID0がデフォルトとされ、
* リージョンのないタイルや設定のないリージョンに使用されます。
* X : 古いリージョンID
* Y : 新しいリージョンID
* カンマ区切りで値を追加できます。
* 例 : 0:2, 1:3, 4:6
*
* ---------------
*
* - Battleback
* リージョンの戦闘背景を入れ替えます。
* リージョンIDと2つの戦闘背景名を設定する必要があります。
* リージョンID0がデフォルトとされ、
* リージョンのないタイルや設定のないリージョンに使用されます。
* X : リージョンID
* 'bb1' : 戦闘背景1ファイル名 ('で囲う)
* 'bb2' : 戦闘背景2ファイル名 ('で囲う)
* カンマ区切りで値を追加できます。
* 例 : 0:'Ship','Clouds' , 1:'Ship','Sky', 2:'Sky',''
*
* ---------------------------------------------------------------------------
* プラグインコマンド
* ---------------------------------------------------------------------------
*
* 数値の代わりにv[id]を使用して、idが設定された変数から値を取得できます。
* 例えば、v[3]は変数ID3から値を取得します。
*
* ---------------
*
* SetVehicleLocation type mapId X Y
* 乗り物を新しい場所に移動させる
* type : 乗り物のシンボル名
* mapId : マップID
* X : X座標
* Y : Y座標
* 数値にはv[id]を使用して、変数から値を取得できます。
*
* ---------------
*
* ChangeVehicleImage type name index
* 乗り物のキャラセットの画像を変更します。
* type : 乗り物のシンボル名
* name : キャラセットファイル名
* index : キャラセットインデックス (0-8)
*
* ---------------
*
* ChangeVehicleBGM type name volume pitch pan
* 乗り物のBGMを変更します。
* type : 乗り物のシンボル名
* name : BGMファイル名 ('で囲う)
* volume : BGM音量 (0-100)
* pitch : BGMピッチ (50-150)
* pan : BGMパン (0-100, 正負の値)
* 数値にはv[id]を使用して、変数から値を取得できます。
*
* ---------------------------------------------------------------------------
* 追加情報
* ---------------------------------------------------------------------------
*
* - Creating new vehicles
* まずプラグインのパラメーター'Vehicle Setu pEvent'を設定する必要があります。
* このパラメータは、乗り物を作成する注釈を格納するコモンイベントのIDです。
* 乗り物の設定は全て注釈の中で行います。
*
* パラメータを設定したら、定義したコモンイベントに移動します。
* 上記のタグを使って注釈タグを作成する必要があります。
* 実際に使用する値だけを追加する必要があります。
*
* 全ての設定が<vehicle>タグ内にある限り、
* 注釈タグの設定を分割できます。
*
* 忘れずに、乗り物の設定に合わせてマップのリージョンを設定してください。
*
* ---------------------------------------------------------------------------
* 注釈タグの例
* ---------------------------------------------------------------------------
*
* <vehicle: 'ballon'>
* charset: 'Vehicle', 2
* initial map: 1, 5, 6
* step animation
* character above
* altitude: 36
* speed: 5
* passable region: 0, 1, 2
* landing region: 0
* encounter rate: 0%
* </vehicle>
*
* ---------------
*
* <vehicle: 'PortOnlyShip'>
* charset: 'Vehicle', 1
* initial map: 3, 10, 7
* speed: 5
* passability: ship
* landing region: 1
* boarding region: 1
* encounter rate: 50%
* encounter region: 0:2
* battleback: 0:'Ship','Ship'
* </vehicle>
*/