クエストシステム - QuestSystem.js
シェア用テキスト：
▼クエストシステム（うなぎおおとろ様作） - QuestSystem.js
https://plugin-mz.fungamemake.com/archives/677
クエストシステムを導入するプラグインです。
ふりがな：くえすとしすてむ
機能概要： クエストシステムを導入するプラグインです。
利用規約（ライセンス）： MITライセンス
作者：うなぎおおとろ
作者サイト：https://twitter.com/unagiootoro8388
ダウンロードページ：https://raw.githubusercontent.com/unagiootoro/RPGMZ/mas…
ファイル名：QuestSystem.js
プラグインのヘルプ：
/*:
@target MZ
@plugindesc クエストシステム v1.1.0
@author うなぎおおとろ
@url https://raw.githubusercontent.com/unagiootoro/RPGMZ/master/QuestSystem.js
@help
クエストシステムを導入するプラグインです。
【使用方法】
■クエストの作成
クエストはプラグインパラメータ「QuestDatas」を
編集することによって作成します。
このパラメータによってクエストに必要な「依頼者」「報酬」「クエストの内容」
などの項目を設定します。
■クエストの状態管理
各クエストは状態(未受注、進行中、報告済み など)を持ち、
その状態は変数によって管理します。
変数の値が持つ意味は以下の通りです。
0: クエスト未登録
登録されておらず、一覧に表示されないクエスト
1: クエスト未受注
未受注のクエスト
2: クエスト進行中
受注を行い、進行中のクエスト
3: クエスト報告可能
依頼を達成し、報告可能となったクエスト
4: クエスト報告済み
報告を行ったクエスト
5: クエスト失敗
失敗したクエスト報酬
6: クエスト期限切れ
期限切れとなったクエスト
7: 隠しクエスト
概要のみ分かる隠しクエスト
■クエストプラグインが行う状態管理について
クエストプラグインでは、次の状態管理のみを行います。
・クエストを受注したとき、状態を未受注から進行中にする
・クエストを報告したとき、状態を報告可から報告済みにする
・進行中のクエストをキャンセルしたとき、状態を進行中から未受注にする
上記以外の状態にする場合はイベントコマンドで
変数の値を変更する必要があります。
■報酬の受け取り
クエストの報酬は、報告を行ったタイミングで受け取ります。
■クエストシーン開始
クエストシーンは次の二通りの方法によって開始することができます。
・メニューから「クエスト管理」を呼び出す
・プラグインコマンド「StartQuestScene」を実行する
この二つは主に次のように使い分けることを想定しています。
プラグインコマンド：依頼所のような施設を作り、
そこでクエストの受注と報告を行う。
メニュー：各クエストの状況を確認する。
■クエストコマンド
クエストコマンドは、クエストの分類、およびクエストの受注と報告を行う
コマンドを管理するために使用します。
※プラグインコマンドとメニューで設定するクエストコマンドは
デフォルトで設定されているため、
基本的な使い方をするのであれば特に変更の必要はありません。
クエストコマンドには以下の種類があります。
all: 全てのクエストを表示する
questOrder: 未受注のクエストを表示する
orderingQuest: 進行中のクエストを表示する
questCancel: 進行中のクエストについて、クエストの受注をキャンセルする
questReport: 報告可能なクエストについて、報告済みにして報酬を受け取る
reportedQuest: 報告済みのクエストを表示する
failedQuest: 失敗したクエストを表示する
expiredQuest: 期限切れのクエストを表示する
hiddenQuest: 隠しクエストを表示する
【ライセンス】
このプラグインは、MITライセンスの条件の下で利用可能です。
@param QuestDatas
@text クエストデータ
@type struct<QuestData>[]
@default []
@desc
クエストのデータを登録します。
@param EnabledQuestMenu
@text クエストメニュー有効化
@type boolean
@on 表示
@off 非表示
@default true
@desc
メニューへのクエスト管理画面の追加有無を指定します。
@param EnabledQuestMenuSwitchId
@text クエストメニュー有効化スイッチID
@type switch
@default 0
@desc
メニューのクエスト管理画面の有効/無効を判定するスイッチIDを指定します。
@param MenuCommands
@text メニュー表示コマンド
@type select[]
@option all
@option questOrder
@option orderingQuest
@option questCancel
@option questReport
@option reportedQuest
@option failedQuest
@option expiredQuest
@option hiddenQuest
@default ["orderingQuest","reportedQuest","all"]
@desc
メニューのクエスト管理画面で使用するフィルターコマンドを指定します。ヘルプのクエストコマンド参照
@param MenuBackgroundImage
@text メニュー背景画像
@type struct<BackgroundImage>
@default {"FileName1":"","FileName2":"","XOfs":"240","YOfs":"300"}
@desc
メニューのクエストシーンの背景画像を指定します。
@param DisplayRequestor
@text 依頼者の表示
@type boolean
@on 表示
@off 非表示
@default true
@desc
タイトルの表示有無を指定します。
@param DisplayRewards
@text 報酬の表示
@type boolean
@default true
@desc
報酬の依頼場所の表示有無を指定します。
@param DisplayDifficulty
@text 難易度の表示
@type boolean
@on 表示
@off 非表示
@default true
@desc
クエスト難易度の表示有無を指定します。
@param DisplayPlace
@text 場所の表示
@type boolean
@default true
@desc
クエストの依頼場所の表示有無を指定します。
@param DisplayTimeLimit
@text 有効期限の表示
@type boolean
@on 表示
@off 非表示
@default true
@desc
クエストの有効期限の表示有無を指定します。
@param QuestOrderSe
@text クエスト受注SE
@type struct<QuestOrderSe>
@default {"FileName":"Skill1","Volume":"90","Pitch":"100","Pan":"0"}
@desc
クエストを受注したときに再生するSEを設定します。
@param QuestReportMe
@text クエスト報告ME
@type struct<QuestReportMe>
@default {"FileName":"Item","Volume":"90","Pitch":"100","Pan":"0"}
@desc
クエストを報告したときに再生するMEを設定します。
@param WindowSize
@text ウィンドウのサイズ
@type struct<WindowSize>
@default {"CommandWindowWidth":"300","CommandWindowHeight":"160","DialogWindowWidth":"400","DialogWindowHeight":"160","GetRewardWindowWidth":"540","GetRewardWindowHeight":"160"}
@desc
各種ウィンドウのサイズを設定します。
@param Text
@text 表示テキスト
@type struct<Text>
@default {"MenuQuestSystemText":"クエスト確認","QuestOrderText":"このクエストを受けますか？","QuestOrderYesText":"受ける","QuestOrderNoText":"受けない","QuestCancelText":"このクエストをキャンセルしますか？","QuestCancelYesText":"キャンセルする","QuestCancelNoText":"キャンセルしない","QuestReportText":"このクエストを報告しますか？","QuestReportYesText":"報告する","QuestReportNoText":"報告しない","NothingQuestText":"該当するクエストはありません。","GetRewardText":"報酬として次のアイテムを受け取りました。","HiddenTitleText":"？？？？？？","AllCommandText":"全クエスト","QuestOrderCommandText":"クエストを受ける","OrderingQuestCommandText":"進行中のクエスト","QuestCancelCommandText":"クエストのキャンセル","QuestReportCommandText":"クエストを報告する","ReportedQuestCommandText":"報告済みのクエスト","FailedQuestCommandText":"失敗したクエスト","ExpiredQuestCommandText":"期限切れのクエスト","HiddenQuestCommandText":"未知のクエスト","NotOrderedStateText":"未受注","OrderingStateText":"進行中","ReportableStateText":"報告可","ReportedStateText":"報告済み","FailedStateText":"失敗","ExpiredStateText":"期限切れ","RequesterText":"【依頼者】：","RewardText":"【報酬】：","DifficultyText":"【難易度】：","PlaceText":"【場所】：","TimeLimitText":"【期間】："}
@desc
ゲーム中で使用されるテキストを設定します。
@param TextColor
@text 表示テキスト色
@type struct<TextColor>
@default {"NotOrderedStateColor":"#ffffff","OrderingStateColor":"#ffffff","ReportableStateColor":"#ffffff","ReportedStateColor":"#ffffff","FailedStateColor":"#ffffff","ExpiredStateColor":"#ff0000"}
@desc
ゲーム中で使用されるテキストのカラーを設定します。
@param GoldIcon
@text ゴールドのアイコン
@type number
@default 314
@desc
報酬欄に表示するゴールドのアイコンを設定します。
@param ExpIcon
@text 経験値のアイコン
@type number
@default 89
@desc
報酬欄に表示する経験値のアイコンを設定します。
@command StartQuestScene
@text クエストシーン開始
@desc クエストシーンを開始します。
@arg QuestCommands
@type select[]
@option all
@option questOrder
@option orderingQuest
@option questCancel
@option questReport
@option reportedQuest
@option failedQuest
@option expiredQuest
@option hiddenQuest
@default ["questOrder","questCancel","questReport"]
@text クエストコマンド
@desc クエストコマンドを指定します。
@arg BackgroundImage
@text 背景画像
@type struct<BackgroundImage>
@default {"FileName1":"","FileName2":"","XOfs":"240","YOfs":"300"}
@desc
クエストシーンの背景画像を指定します。
@command GetRewards
@text 報酬を入手
@desc クエストの報酬を入手します。
@arg VariableId
@type number
@text 変数ID
@desc 報酬を入手するクエストの変数IDを指定します。
@command ChangeDetail
@text クエスト詳細変更
@desc クエストの詳細を変更します。
@arg VariableId
@type number
@text 変数ID
@desc 詳細を変更するクエストの変数IDを指定します。
@arg Detail
@type string
@text 詳細
@desc 変更するクエスト詳細を設定します。
@command ChangeRewards
@text 報酬変更
@desc クエストの報酬を変更します。
@arg VariableId
@type number
@text 変数ID
@desc 報酬を変更するクエストの変数IDを指定します。
@arg Rewards
@type struct<Reward>[]
@text 報酬
@desc 変更するクエストの報酬を設定します。
*/