冒険メモ - TA_AdventureNote.js

シェア用テキスト：

▼冒険メモ（沫那環様作） - TA_AdventureNote.js
https://plugin.fungamemake.com/archives/28822
「冒険メモ」の機能を追加します。

ふりがな：てぃーえーあどべんちゃーのーと

機能概要： 「冒険メモ」の機能を追加します。

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

作者：沫那環

作者サイト：https://razor-edge.work/

直接ダウンロード：Zipファイル

ダウンロードページ：https://raw.githubusercontent.com/t-awana/TA_MVZPlugin/…

ファイル名：TA_AdventureNote.js

備考：ver.1.1.1にて、プラグインコマンド「AdvNote Open」のヘルプの記載漏れ、 コードやヘルプの誤字を修正。
ver.1.1にて、プラグインコマンド「AdvNote Open」や、サブイベントの詳細表示時に、その他のウィンドウを表示するかどうかの設定を追加。

プラグインのヘルプ：

/*:
 * @plugindesc Add the function of "adventure note".
 * @author Tamaki Awana
 * @help Add the "adventure note" function that show the next action
 *  to take in the game, and list of sub events.
 * ･Display a sentence that describes the next action to
 *  be taken according to the value of the set variable.
 * ･Display the text according to the value of the variable corresponding
 *  to the sub event in the dedicated detail window.
 * ･When sub event cleared, you can add a cleared symbol
 *  to the event list and details window.
 * 
 * About Main Event:
 *  If you assign the value set in MainEventValue to the
 *  variable set in MainEventVariable, the text and title linked with
 *  the assigned value will be displayed in a dedicated window.
 *  You can switch the displayed text by changing the value of
 *  the variable as the main event progresses.
 * 
 * About Sub Event:
 *  ･When the variable set in SubEventVariable in each subevent becomes
 *   the value set in SubEventStartValue or larger than that,
 *   it is determined that the event has started.
 *  ･Sub event is considered cleared when the value of the variable
 *   is greater than or equal to the value of SubEventClearValue.
 *  ･You can switch the displayed text by changing the value
 *   of the variable as you progress.
 * 
 * Plugin Commands:
 *  AdvNote_SubEvent SetStart [ID of subevent]
 *  Set sub event to start state with the setted ID number.
 * 
 *  AdvNote_SubEvent SetClear [ID of subevent]
 *  Set sub event to clear state with the setted ID number.
 * 
 *  AdvNote_SubEvent AllReset
 *  Resets the progress of all sub events,
 *  and sets the all sub events unstarted.
 * 
 *  AdvNote Open
 *  Open the adventure note scene.
 * 
 * Notions:
 *  There is no function to display a dedicated notification
 *  at the start / end of a sub event.
 *  If you want to let the player know the progress of the event,
 *  please use various event commands and other plugins.
 *
 * Update History:
 * ver.1.1.1 Fixed an omission in the help of the plug-in command "AdvNote Open".
 *           Fixed typos in code and help.
 * ver.1.1 Added plugin command of "AdvNote Open".
 *         Added a setting to display other windows
 *         when displaying the details of sub events.
 * ver.1.0   Released.
 * 
 * ---
 *
 * This plugin is released under MIT license.
 * https://opensource.org/licenses/mit-license.php
 *
 * This plugin is based on a RGSS2 sample script of
 *  "Rector And Black Lion Coat Of Arms"(レクトールと黒獅子の紋章)
 *  of RMVX sample game, and 回想領域's RGSS3 material
 *  "Adventure note"(冒険メモ).
 * Thanks to 回想領域(http://kaisou-ryouiki.sakura.ne.jp/) and
 *  "Rector And Black Lion Coat Of Arms".
 */
/*:ja
 * @plugindesc 「冒険メモ」の機能を追加します
 * @author 沫那環
 * @help ゲーム内で次に取るべき行動や、サブイベントの一覧を表示する
 * 機能を備えた「冒険メモ」を追加します。
 * ・設定した変数の値に応じた、次にとるべき行動を記した
 * 　文章を表示することができます。
 * ・サブイベントと対応した変数の値に応じた文章を、
 * 　専用の詳細ウィンドウに表示することができます。
 * ・サブイベントのクリア時に、イベント一覧や詳細ウィンドウに、
 * 　クリア済みのマークを付けることができます。
 * 
 * 【メインイベントについて】
 * 　MainEventVariableで設定した変数に、MainEventValueで設定した値を代入すると、
 * 　代入された値と連動したテキストとタイトルが、専用のウィンドウに表示されます。
 * 　メインイベントの進行に合わせて変数の値を変更することで、
 * 　表示されるテキストを切り替えることができます。
 * 
 * 【サブイベントについて】
 * 　・各サブイベントにあるSubEventVariableで設定した変数が、
 * 　　SubEventStartValueに設定された値、またはそれより大きくなると、
 * 　　そのイベントが開始されていると判定されます。
 * 　・変数の値がSubEventClearValueの値、またはそれより大きくなると、
 * 　　そのサブイベントはクリアされたとみなされます。
 * 　・進行に合わせて変数の値を変更することで、表示されるテキストを
 * 　　切り替えることができます。
 * 
 * 【プラグインコマンド】
 * 　AdvNote_SubEvent SetStart [サブイベントのID]
 * 　指定したIDのサブイベントを開始状態に設定します。
 * 
 * 　AdvNote_SubEvent SetClear [サブイベントのID]
 * 　指定したIDのサブイベントをクリア状態に設定します。
 * 
 * 　AdvNote_SubEvent AllReset
 * 　全てのサブイベントの進行状況をリセットし、開始されていない状態に設定します。
 * 
 * 　AdvNote Open
 * 　冒険メモを開きます。
 * 
 * 【注意】
 * 　サブイベントの開始時・終了時に、専用の通知を表示する機能はありません。
 * 　イベントの進行をプレイヤーに知らせたい場合は、
 * 　各種イベントコマンドや、他のプラグインを利用してください。
 *
 * 【更新履歴】
 * 　ver.1.1.1 プラグインコマンド「AdvNote Open」のヘルプの記載漏れを修正。
 *             コードやヘルプの誤字を修正。
 * 　ver.1.1 プラグインコマンドに「AdvNote Open」を追加。
 *           サブイベントの詳細表示時に、その他のウィンドウを
 *           表示するかどうかの設定を追加。
 * 　ver.1.0   公開
 * 
 * ---
 *
 * このプラグインは MIT License にもとづいて提供されています。
 * https://opensource.org/licenses/mit-license.php
 *
 * このプラグインを制作するにあたり、
 * RPGツクールVXサンプルゲーム
 * 「レクトールと黒獅子の紋章」の内部スクリプトの一部と、
 * 「回想領域」（http://kaisou-ryouiki.sakura.ne.jp/）の
 * RGSS3素材「冒険メモ」を参考にさせていただきました。
 * この場を借りて、お礼申し上げます。
 */