Skip to content

Latest commit

 

History

History
417 lines (313 loc) · 17.1 KB

pluginList.md

File metadata and controls

417 lines (313 loc) · 17.1 KB

プラグインリスト

mv

H2A_SSRemoteController

H2APG.SSRemote(イベントID,"A/B/C/D",true/false/null);
H2APG.SSRemote("文字列が含まれるイベント名のイベント","A/B/C/D",true/false/null);

第3引数がnullの場合は反転します。

このようにすると自分のセルフスイッチを操作できます。
H2APG.SSRemote(this._eventId,"A/B/C/D",true/false/null);

H2A_SetSwitchOn

Load Save IDに存在しないセーブデータIDを入力しないこと。

また、通常のロード時にスイッチはONになりません。

このプラグインはニューゲーム時にスイッチを切り替える時のために作ったプラグインのため、
もしタイトルスキップ関連でもっと高機能なプラグインが必要なら、
トリアコンタン氏の AutoLoad.js を使ったほうがいいかもしれません。


mz

H2A_AutoSaveAndTransfer

同一マップ間移動時に、
データのロードが発生しないようにします。

また、パラメーターで
オートセーブに関する挙動を設定できます。
その場合、「システム1」のオプションで
「オートセーブを有効化」する必要があります。

またプラグインコマンドを使用することで、
オートセーブを呼び出すことができます。

注意:
設定の優先度は以下のようになっています。
コモンイベントのオートセーブ > 禁止スイッチ > オートセーブ設定
禁止スイッチが ON の状態でもコモンイベントからオートセーブが可能で、
禁止スイッチが ON だとオートセーブ設定が all でもセーブされません。

H2A_DialogLoader

ダイアログスクリプトが書かれたテキストファイルを好きなタイミングで開いて実行します。

・使い方
1. プロジェクトの index.html があるフォルダに dialogs フォルダを追加する
2. dialogs フォルダにダイアログスクリプトが書かれたテキストファイルを置く
3. コマンドエディタでダイアログスクリプトを実行したいタイミングでプラグインコマンド「実行」を挿入

より詳しい使い方とリファレンス:
https://github.com/katai5plate/RPGMakerPlugins/blob/main/js/plugins/mz/H2A_DialogLoader/README.md

H2A_DontPauseWhenBlur

ツクール MZ から、ゲームをフォーカスしていない時に
ゲームが一時停止する仕様になりました。
しかしそれだとデバッグ時などで都合が悪いケースがありそうです。
このプラグインでは、その挙動を無効にし、
フォーカスしていない時でもゲームを一時停止しないようにします。

v2.0.0 から、VSCode 拡張の Live Server に対応しました。

H2A_ErrorWhenSlowNet

ゲーム起動~タイトル画面までの読み込みが指定の時間を越えると、
エラーメッセージを表示してゲームを中断します。
プラグインコマンドから、
読み込みにかかった時間を変数に代入することもできます。

注意:
ブラウザにゲームデータのキャッシュが残っている状態で、
ゲームを起動すると、回線の速さに関係なくロード時間が短縮します。
そのため、リロードするとエラーが表示されなくなることがあります。

参考:
基本的に 1 秒程度でタイトルまで読み込む事ができれば、
特に大きな問題なく快適にプレイすることができるはずです。
光ファイバー等の高速回線であれば 500 ミリ秒も可能だと思います。

H2A_ImageToPicture

[使い方]
1. 画像を設定せずに「ピクチャの表示」を設定する
2. その処理の直後にプラグインコマンド「ピクチャ変更」を実行
3. 指定した画像がピクチャとして変更される

[顔グラフィックを使用する例]
◆ピクチャの表示:#1, なし, 左上 (0,0), (100%,100%), 255, 通常
◆プラグインコマンド:H2A_ImageToPicture, ピクチャ変更
:         :番号 = 1
:         :画像 = faces/Nature
:         :インデックス = 4
:         :横分割 = 4
:         :縦分割 = 2

[Tips]
・すでに表示中のピクチャであっても変更可能です。

H2A_JapaneseErrors

window.Error を書き換え、特定のエラー文字列を日本語化します。
Error を実行するとスタックトレースの先頭行に
このプラグインが占有するのでご注意ください。
また、pixi.js などのコアスクリプト以外のエラーメッセージは翻訳されません。

H2A_MIDIPlayer

※このプラグインは実験的なものです。
 メモリリークやクラッシュなど、何か問題が発生しても、一切責任を取りません。
 自己責任で使用してください。

[使う準備]
1. 前提ライブラリをダウンロードし、js/plugins/ に追加する

smfplayer.min.js
https://raw.githubusercontent.com/gree/smfplayer.js/5a1124afcf93a65e1e3f5ad9b7d8531a57a895c2/bin/smfplayer.min.js
sf2synth.min.js
https://raw.githubusercontent.com/gree/sf2synth.js/3c792f42aded69560c0bac8679718ff059e000d7/bin/sf2synth.min.js

2. プラグイン設定で、このプラグインの上に2つの前提ライブラリを設置する

例:
[ON] smfplayer.min
[ON] sf2synth.min
[ON] H2A_MIDIPlayer

3. fonts/ に使いたいサウンドフォントを置く

A320U.sf2 がおすすめ。
https://github.com/denemo/denemo/tree/master/soundfonts

4. midi/ に使いたい MIDI 素材を置く
index.html と同じフォルダに midi/ を追加してその中に入れる。
未使用素材削除機能は使えないので注意。

[使い方]

プラグインコマンドを使ってください。

スクリプトやプラグインから実行したい場合は、
$midi というグローバル変数が用意されているので、
そこからアクセスしてください。

例:
$midi.play(
  "戦闘1", // 戦闘1.mid
  0.5 // 音量 50%
);
$midi.stop();

[注意]

- MIDIを都度読み込んでから再生するため、MIDIの容量に応じて再生に時間がかかります。
- メモリリーク対策で次の再生まで 1 秒経ってない場合は再生させない仕様にしてます。

[動作サンプル]
https://game.nicovideo.jp/atsumaru/games/gm26154

H2A_RegionWalker

キャラクターがリージョンに沿って移動します。
真後ろには移動せず、前方から見て前・左・右にのみ動きます。

・「厳格モード」では、通行を妨げるタイルがあったり、
 ランダム歩行が無効なのに一本道ではない場合に、
 コンソールに警告を出したり、エラーでゲームを強制終了します。
・「ランダム歩行」では、一本道でない道に来た時、
 ランダムで方角を決定します。
・通常、行き止まりに到達して立ち止まった時は、
 終端のリージョンを踏んでいる状態になります。
 そのため、到達時にリージョンの外まで歩かせたい場合は
 「到着したら一歩前進」を有効化してください。
・プラグインコマンドの「スクリプト」は、上級者向け機能です。
  `ROUTE_MOVE_DOWN` `ROUTE_WAIT 60`
  `ROUTE_CHANGE_IMAGE "Actor1" 3`
  `ROUTE_PLAY_SE {"name":"Dog","pan":0,"pitch":100,"volume":90}`
  のように記述します。 (ROUTE_? arg1 arg2)
  ROUTE_ で始まる文は、rmmz_objects.js の
  processMoveCommand の定義を参照してください。
  ROUTE_ は省略しても構いません。 例: `WAIT 60`
  スペースで区切り、2 塊目からは JSON で値が評価されます。
  ROUTE_PLAY_SE のように JSON を引数に渡す場合はスペースを省いてください。

[注意]
・「移動完了まで待つ」場合、
 経路の途中に通行を妨げるキャライベント等があると、
 そのままゲームが先に進まなくなる可能性があります。

H2A_SkipTitle

タイトルをスキップし、
ニューゲームかコンティニューします。

モード説明:

- オートセーブ含む直前のセーブ > ニューゲーム
オートセーブ含む全セーブデータのうち最新のものがロードされます。
セーブデータが見つからない場合はニューゲームになります。

- 直前の手動セーブ > オートセーブ > ニューゲーム
直前にユーザー操作によりセーブしたデータが見つかればそれがロードされます。
見つからない場合、オートセーブがロードされ、
それもなければニューゲームになります。

- オートセーブ > 直前の手動セーブ > ニューゲーム
オートセーブされたデータがあればそれがロードされます。
なければ、直前にユーザー操作によりセーブしたデータをロードします。
それもなければニューゲームになります

- オートセーブ > ニューゲーム
オートセーブされたデータがあればそれがロードされます。
なければニューゲームになります。

- ニューゲーム
単純にニューゲームになります。

- 直前のセーブ
オートセーブ含む全セーブデータのうち最新のものがロードされます。
セーブデータが存在しない場合、エラーになります。

- 直前の手動セーブ
ユーザー操作によりセーブしたデータが見つかればそれがロードされます。
存在しない場合、エラーになります。

- オートセーブ
オートセーブされたデータがあればそれがロードされます。
存在しない場合、エラーになります。

H2A_TileOptimizedScreen

1.5.0 から、タイルサイズを変更できるようになりましたが、
画面のズーム率までは変わらないため、
そのままだと広大なマップにポツンと小さいマップが存在するような見た目になってしまい、
なんかコレジャナイ感がありますよね。

このプラグインでは、データベースの「システム2」→「タイルサイズ」設定に合わせて、
マップの解像度を自動的に調整します。

[仕組みと注意]
バッファ内で素材画像を48x48に変換し、48x48で表示する体にして描画しています。
その関係上、素材の読み込みに通常より時間がかかることがあります。

H2A_TopLevelAwait

スクリプト内で await を使用できるようになります。
完了するまでウェイト状態になるので、
イベントコマンドで非同期処理を組み込みやすくなります。
移動ルートの指定でも使用可能です。

たとえばこんなふうに書けます。

const request = await fetch("./index.html");
const data = await request.text();
$gameVariables.setValue(1, data.match(/title>(.+)</)[1]);

[注意]
- 対応しているのはスクリプトと移動ルートの指定のみです。変数の操作、条件分岐では使用できません。

H2A_ZzFXPlayer

※このプラグインは実験的なものです。
 メモリリークやクラッシュなど、何か問題が発生しても、一切責任を取りません。
 自己責任で使用してください。

[使う準備]
1. 前提ライブラリをダウンロードし、js/plugins/ に追加する

zzfx.js
https://raw.githubusercontent.com/keithclark/ZzFXM/cb07fa9ca36aefd67a0c8c656d2958b62f8ed9fe/zzfx.js
zzfxm.min.js
https://raw.githubusercontent.com/keithclark/ZzFXM/cb07fa9ca36aefd67a0c8c656d2958b62f8ed9fe/zzfxm.min.js

2. プラグイン設定で、このプラグインの上に2つの前提ライブラリを設置する

例:
[ON] zzfx
[ON] zzfxm.min
[ON] H2A_ZzFXPlayer

3. 音楽作りと音作りをする

音楽作りはこのサイトで行う
https://keithclark.github.io/ZzFXM/tracker/
作った音楽は左上の File -> Save にて JS ファイルでダウンロードできる。

音作りはこのサイトで行う。
https://killedbyapixel.github.io/ZzFX/
作った音は画面下部の「ZzFX JavaScript (Use this code to play the sound)」の部分に
コードが生成されるので、[] で囲まれた部分を使用する。

4. zzfx/ に ZzFXM Tracker で作った曲の JS ファイルを置く
index.html と同じフォルダに zzfx/ を追加してその中に入れる。
未使用素材削除機能は使えないので注意。

5. zzfx/sound.json にサウンドボードを置く
zzfx/ フォルダの中に JSON ファイルを置き、以下のように書く。
{
  "音の名前1": "[,,126,,.05,.08,1,.07,-13,-2.6,,,,,,,,.73,.06]",
  "音の名前2": "[1.32,,118,.11,.18,.02,3,.41,25,40,,,.09,,,,.19,,.03]",
  "音の名前3": "[,,441,.02,.14,.3,,.47,,.6,-195,.05,.09,,,.1,,.66,.1]"
}

[使い方]

プラグインコマンドを使ってください。
曲を止めたい時は BGM の時と同様に BGM を無音にしてください。

スクリプトやプラグインから実行したい場合は、
$zfx というグローバル変数が用意されているので、
そこからアクセスしてください。

例:
$zfx.playSound(
  // 音データ
  [,,126,,.05,.08,1,.07,-13,-2.6,,,,,,,,.73,.06],
  // 音量 50%
  0.5
)
$zfx.playSoundFromFile(
  // zzfx/sounds.json の音名
  "音の名前1",
  // 音量 50%
  0.5
)
$zfx.stopSound()
$zfx.playSong(
  // 譜面データ
  songData,
  // ループするか
  true,
  // 音量 50%
  0.5
)
$zfx.playSongFromFile(
  // ファイル名(拡張子抜き)
  "MyNewSong",
  // ループするか
  true,
  // 音量 50%
  0.5
)
$zfx.stopSong()

[プラグインパラメーター:システムSE設定]

データベース -> システム1 -> 効果音 にて設定が OFF になっている効果音は、
ここで設定した音に置き換わります。

[Tips]

- 音データ単体で音量を変更したい場合は、配列の最初の値を変更すれば変えられます。
例1: [1.23,,107,,.01,.01,3,.21,,,,,.18,,390,,.36,.61,.01]
       ↓
     [2.34,,107,,.01,.01,3,.21,,,,,.18,,390,,.36,.61,.01]
例2: [,,107,,.01,.01,3,.21,,,,,.18,,390,,.36,.61,.01]
       ↓
     [1.23,,107,,.01,.01,3,.21,,,,,.18,,390,,.36,.61,.01]