あらすじ機能 – PreviouslyOnStory.js

タイトル
あらすじ機能
作者名
ヘルプ
あらすじ機能を実装します。

【特徴】
・セーブデータのロード時にあらすじシーンへ移行します。
・あらすじはプラグインコマンドから登録できます。
・イベントコマンドの「文章の表示」からも登録できるようになりました。(v1.0.1以降)
・背景やBGMなどの設定もプラグインコマンドを通じておこないます。
・登録していたコモンイベントを、セーブデータのロード時に実行できます。
・背景画像をスクロールさせたり、パーティクル画像を設定することができます。
・ボイスの再生も可能です(v1.1.1以降)
・カーソルキーおよびマウスでの操作OK。
・決定キーやキャンセルキーでの操作もOK。
・セーブしたあらすじは、振り返りシーンで再度読み込むことが可能です。(v1.1.0以降)

【使用方法】
プラグインの導入後、プラグインパラメーターを設定することによって使用できます。

全ての画像は「img/tsumio」フォルダから読み込まれます。
必要な画像は必ず「img/tsumio」フォルダに用意してください。

ボイスデータは「audio/se/voice」フォルダから読み込まれます。
必要なボイスデータは必ず「audio/se/voice」フォルダに用意してください。

背景画像およびパーティクルの速度にマイナスを指定した場合、逆向きへスクロールします。

【プラグインコマンド】
全てのプラグインコマンドは「POS」から始まります。
また、説明上では視認性のためにカギカッコを使用していますが、実際にプラグインコマンドに入力する際には
カギカッコの入力は不要です。

全てのプラグインコマンドは大文字と小文字を区別します。
各単語の間は半角スペースで区切ります(全角では認識しません)。
間違わないように気をつけてください。

改行は「\n」か、新しい「writeLine」によって可能です。
「\n」を利用する場合、前後に必ず半角の空白を挟んでください。

「POS writeLine 追加する文字」 : あらすじに文字列を追加します。制御文字の使用も可能ですが、全ての制御文字の動作を確認したわけではありません。
「POS newPage」 :あらすじに新しいページを追加します。以降のwriteLineは新しいページに対して行われます。
「POS setMainBackground 背景名」 : メイン背景の画像を設定します。
「POS setSubBackground 背景名」 : サブ背景の画像を設定します。
「POS setParticle パーティクル名」 : パーティクル画像を設定します。
「POS setBgm ファイル名 音量 ピッチ」 : BGMの設定をします。
「POS setPicture ファイル名 X座標 Y座標 透明度」 : ピクチャの設定をおこないます。
「POS setAlign 揃える方向」 : 文字列の揃える方向を指定します。「left」「center」が指定できます。
「POS reserveCommonEvent イベント番号」 : マップ画面遷移後に実行するコモンイベント番号を設定します。
「POS setVoice 音声ファイル名」 : 現在のページで再生する音声を設定します。
「POS clearAll」 : すべての設定を消去します。
「POS clearTextAndPage」 : テキストとページの設定を消去します。
「POS clearAllBackground」 : メイン背景とサブ背景の設定を消去します。
「POS clearParticle」 : パーティクルの設定を消去します。
「POS clearBgm」 : BGMの設定を消去します。
「POS clearPicture」 : ピクチャの設定を消去します。
「POS clearCommonEvent」 : コモンイベントの設定を消去します。
「POS saveSynopsis 保存名」 : 現在のあらすじデータを「保存名」で保存します。保存名を指定しなかった場合、自動でインデックスが与えられます。
「POS loadSynopsis 保存名」 : 保存されているあらすじデータを読み込みます。
「POS getDataLength」 : 保存しているあらすじデータの数をコンソール画面に出力します(デバッグ用)。
「POS initialize」 : 全てのあらすじデータを初期化します。

【あらすじの保存について】
「POS saveSynopsis 保存名」コマンドで保存したファイルは、「POS loadSynopsis 保存名」で読み込めます。
保存時に名前を指定しなかった場合は自動でインデックス名が与えられます。
また、すでに同名のファイルが存在した場合は上書きされます。

【プラグイン更新後にエラーが出た場合】
プラグイン更新後にエラーが出た場合、プラグインコマンドから「POS initialize」を実行してください。
全てのあらすじデータが破棄されますが、エラーが出なくなるかもしれません。

【文章の表示からwriteLineを実行する方法】
v1.0.1以降、「イベントコマンドの《文章の表示》」からもwriteLineと同等の機能を実行することができるようになりました。
通常の文章を入力するのと同じようにしてイベントコマンドを立ち上げ、各行の任意の場所に「<POS>」を入力してください。

例:
<POS>テストメッセージです。
テスト\I[1]テ<POS>スト。
タグPOSの位置はどこでもOKです。<POS>

【振り返りシーンについて】
振り返りシーンと、通常のあらすじシーンは別のシーンを指します。まずこの点に注意してください。

「POS saveSynopsis 保存名」で保存したあらすじは、振り返りシーンで再度読み込むことが可能です。
振り返りシーンはメニュー画面から表示させることができます。
この振り返りシーンの背景およびパーティクルは、現在の背景およびパーティクルが適用されます。
実際に振り返りシーンからあらすじシーンを読み込んだときは、そのとき保存した背景およびパーティクルが再生されます。
また、振り返りシーンの機能はOFFにできます。

振り返りシーンに適用されるタイトルは、あらすじの保存名です。

【更新履歴】
1.1.4 2017/10/02 利用規約更新。
1.1.3 2017/10/01 説明を少し変更。
1.1.2 2017/09/30 GitHubのアドレスを追加。
1.1.1 2017/09/02 ボイス再生機能に対応。
1.1.0 2017/08/26 振り返りシーンの追加と、不具合の修正。
1.0.2 2017/08/25 あらすじのセーブとロード機能の追加。
1.0.1 2017/08/24 いくつかの不具合の修正と、機能の追加(writeLineの拡張とデフォルトウィンドウの指定)。
1.0.0 2017/08/23 公開。

【備考】
当プラグインを利用したことによるいかなる損害に対しても、制作者は一切の責任を負わないこととします。

【利用規約】
ソースコードの著作権者が自分であると主張しない限り、
作者に無断で改変、再配布が可能です。
利用形態(商用、18禁利用等)についても制限はありません。
自由に使用してください。
パラメータ
param ----基本的な設定----
desc
default

param ページ数を表示する
type boolean
desc 画面下部にページ数を表示するかどうかを設定します。
default true

param 確認ウィンドウを表示する
type boolean
desc 確認ウィンドウを表示するかどうかを設定します。
default true

param フェードアウトの時間
type number
max 1000
min 1
desc マップ画面へ移行する際のフェードアウトの時間を設定します。
default 90

param テキスト空白時にスキップ
type boolean
desc テキストが空白のとき、あらすじシーンをスキップするかどうかを設定します。
default true

param ----タイトルウィンドウの設定----
desc
default

param タイトルウィンドウのスキン
type file
require 1
desc タイトルウィンドウのスキンを設定します。
dir img/tsumio
default
param タイトルウィンドウの透明度
type number
max 255
desc タイトルウィンドウの透明度を設定します。
default 255

param あらすじを表す文字
type string
desc あらすじを表す文字を設定します。
default これまでのあらすじ


param タイトルウィンドウの高さ
type number
max 1000
desc タイトルウィンドウの高さを設定します。
default 80


param ----あらすじウィンドウの設定----
desc
default

param あらすじウィンドウのスキン
type file
require 1
desc あらすじウィンドウのスキンを設定します。
dir img/tsumio
default
param あらすじウィンドウの透明度
type number
max 255
desc あらすじウィンドウの透明度を設定します。
default 255

param あらすじX座標のオフセット
type number
min -1000
max 1000
desc あらすじ文字列のX座標のオフセットを設定します。
default 0

param あらすじY座標のオフセット
type number
min -1000
max 1000
desc あらすじ文字列のY座標のオフセットを設定します。
default 0

param ----確認ウィンドウの設定----
desc
default

param 確認ウィンドウのスキン
type file
require 1
desc 確認ウィンドウのスキンを設定します。
dir img/tsumio
default
param 確認ウィンドウの説明文
type string
desc 確認ウィンドウ内の説明文を設定します。
default あらすじを読みますか?

param 「はい」を表す文字
type string
desc 確認ウィンドウ内の「はい」を表す文字を設定します。
default はい

param 「いいえ」を表す文字
type string
desc 確認ウィンドウ内の「いいえ」を表す文字を設定します。
default いいえ

param 確認ウィンドウの透明度
type number
max 255
desc あらすじウィンドウの透明度を設定します。
default 255

param 確認ウィンドウのX座標オフセット
type number
min -2000
max 2000
desc 確認ウィンドウのX座標のオフセットを設定します。
default 0

param 確認ウィンドウのY座標オフセット
type number
min -2000
max 2000
desc 確認ウィンドウのY座標のオフセットを設定します。
default 0

param ----背景の設定----
desc
default

param メイン背景の描画領域
type number[]
min -2000
max 2000
desc メイン背景の描画領域を指定します。[x, y, width, heigh]の順。サイズに-1を指定した場合、スクリーンのサイズが代入されます。
default ["0","0","-1","-1"]

param メイン背景のX方向の速度
type number
min -255
max 255
decimals 2
desc メイン背景のX方向の速度を設定します。
default 0

param メイン背景のY方向の速度
type number
min -255
max 255
decimals 2
desc メイン背景のX方向の速度を設定します。
default 0

param サブ背景のX方向の速度
type number
min -255
max 255
decimals 2
desc サブ背景のX方向の速度を設定します。
default 0

param サブ背景のY方向の速度
type number
min -255
max 255
decimals 2
desc サブ背景のY方向の速度を設定します。
default 0

param サブ背景の描画領域
type number[]
min -2000
max 2000
desc サブ背景の描画領域を指定します。[x, y, width, heigh]の順。サイズに-1を指定した場合、スクリーンのサイズが代入されます。
default ["0","0","-1","-1"]


param ----パーティクルの設定----
desc
default


param パーティクル画像の描画領域
type number[]
min -2000
max 2000
desc 画像の描画領域を指定します。[x, y, width, heigh]の順。サイズに-1を指定した場合、スクリーンのサイズが代入されます。
default ["0","0","-1","-1"]

param パーティクル画像の設定
type number[]
min -2000
max 2000
desc 画像の透明度とブレンドモード(0:通常 1:加算 2:乗算 3:スクリーン)を指定します。[opacity, blendMode]の順。
default ["255","0"]


param パーティクル画像の点滅
type boolean
desc パーティクル画像を点滅させるかどうかを設定します。
default true

param パーティクル画像のX方向の速度
type number
min -255
max 255
decimals 2
desc パーティクル画像の横方向の速度を設定します。
default 0

param パーティクル画像のY方向の速度
type number
min -255
max 255
decimals 2
desc パーティクル画像のY方向の速度を設定します。
default 0

param ----SEの設定----
desc
default
param 進むSE
desc ページが進んだときに再生されるSEを設定します。
default Book1
require 1
dir audio/se/
type file

param 進むSE音量
type number
desc ページが進んだときに再生されるSEの音量を設定します。
default 100

param 進むSEピッチ
type number
desc ページが進んだときに再生されるSEのピッチを設定します。
default 100

param 戻るSE
desc ページが戻ったときに再生されるSEを設定します。
default Book2
require 1
dir audio/se/
type file

param 戻るSE音量
type number
desc ページが戻ったときに再生されるSEの音量を設定します。
default 100

param 戻るSEピッチ
type number
desc ページが戻ったときに再生されるSEのピッチを設定します。
default 100

param ----振り返りシーンの設定----
desc
default

param 振り返りシーンを利用する
type boolean
desc スイッチをONにすると、メニュー画面に振り返りシーンコマンドが追加されます。
default true

param 振り返りシーンのタイトル
type string
desc 振り返りシーンのタイトルを設定します。
default これまでの冒険


param 振り返りシーンの短縮名
type string
desc メニュー画面で使用される、振り返りシーンの短縮名を設定します。
default 振り返り

param 振り返りシーンの行
type number
max 255
desc 振り返りシーンのウィンドウに一度に表示するアイテムの行の数を設定します。
default 3

param 振り返りシーンの列
type number
max 255
desc 振り返りシーンのウィンドウに一度に表示するアイテムの列の数を設定します。
default 3

param 各タイトルの色
type number
max 255
desc 振り返りシーンの各タイトルに使用する色番号を設定します(ウィンドウ画像に準拠)。
default 1

param 振り返りシーン文字の最大行数
type number
max 255
min 1
desc 振り返りシーンに表示される文字列の最大行数を設定します。
default 3

param 振り返りシーン一行の最大文字数
type number
max 255
min 4
desc 振り返りシーンに表示される文字列の、一行あたりの最大文字数を設定します。
default 8

ライセンス表記
当プラグインを利用したことによるいかなる損害に対しても、制作者は一切の責任を負わないこととします。
ソースコードの著作権者が自分であると主張しない限り、
作者に無断で改変、再配布が可能です。
Copyright (c) 2017 Tsumio
This software is released under the MIT License.
http://opensource.org/licenses/mit-license.php

紹介ページ https://github.com/Tsumio/rmmv-plugins/blob/master/plugins/PreviouslyOnStory.js