芋スコープ PotatoScope/1.3


■これはなに？
	ゴーストのセーブデータから指定した値を得る制作者向けプラグイン。
	この機能を実行するには、制作者だけでなくユーザーもこのプラグインを
	インストールしている必要があります。


■仕様・特徴
	読み込めるセーブファイルは里々/文(YAYA)/華和梨。
	別のフォルダに分けられているゴーストが対象でも自動で処理します。
	PLUGIN/2.0のためベースウェアはSSP 2.x以降専用な事に注意。

	基本的には里々ゴーストでの使用を想定しています。
	他ゴーストのセーブを読み込む目的だけなら、専用のSAORIを積むよりも
	実装コストや管理が楽になります。

	PotatoScope/1.2 特定の値を保存するおまけ機能がつきました。
	PotatoScope/1.3 栞の手動指定に対応しました。


■注意点
	「現時点でのファイルを読み込む」事に注意して下さい。
	対象が起動中のゴーストだったり、一度終了したもののSSPが終了していない場合、
	つまりセーブファイルが出力されていない状態では、値が最新ではありません。
	動的な情報が必要な場合は、共有変数プラグインの使用をおすすめします。

	■現在の問題点
	YAYAでかつセーブファイルの文字コードがUTF-8で保存されている場合は
	全角2バイト文字が文字化けします。
	Shift-JISで保存されている場合は大丈夫。UTF-8でも半角英数字はOK。


■使用方法

	■実行方法
	以下のさくらスクリプトのどちらかによってプラグインを実行させます。

	\![raiseplugin,芋スコープ,OnPotatoGet,<フォルダ名>,<ファイル名>,<変数1>,<変数2>...]
	\![raiseplugin,8AD59FAA-B6E4-4bf7-BFC6-C4E907F1AADB,OnPotatoGet,<フォルダ名>,<ファイル名>,<変数1>,<変数2>...]

	<フォルダ名>
		読み込む対象のゴーストのフォルダ名を正確に記述して下さい。
	<ファイル名>
		読み込む対象のゴーストのセーブデータのファイル名を記述。
		ただし、対象のSHIORIが里々/文(YAYA)の場合は空白で構いません。
		華和梨の時はできるだけ正確に記述して下さい。(※)
	<変数n>
		参照したい変数の名称を記述。同時に複数の値を参照できます。
		（以降の引数を追加して下さい）

	(※)里々と文(YAYA)はファイル名が固定のため、ファイル名指定が不要です。
	　　華和梨はOpenKEEPS/かりん/パリパリなどを探しますが、固定ではないので
	　　ほぼファイル名指定が必要となります。


	■発生するイベント
	上記のさくらスクリプトを実行すると、ゴースト側にイベントが通知されます。

	%% フォルダ指定が正常で、セーブファイルが無事に見つかった
		ID: OnPotatoReturn
		Reference0: 要求した変数名をコンマ区切りで繋いだもの（<変数1>,<変数2>...）
		Reference1: <変数1>の値
		Reference2: <変数2>の値
		Reference3...

	%% フォルダ指定は正常だがセーブファイルが見つからなかった
		ID: OnPotatoFileNotFound
		Reference0: 要求した変数名をコンマ区切りで繋いだもの（<変数1>,<変数2>...）

	%% フォルダ指定が間違っている、又は動作対象外のSHIORIだった
		ID: OnPotatoError
		Referenceなし

	OnPotatoReturn/OnPotatoNotFound の Reference0 は識別用に。


■具体例
	\![raiseplugin,芋スコープ,OnPotatoGet,emily4,-,username]

		Emily/Phase4のセーブデータから[username]の内容を得る。
		実行後、イベントOnPotatoReturnのReference1にて取得。

	\![raiseplugin,芋スコープ,OnPotatoGet,2elf,-,起動回数,乳カウント]

		双子のエルフのセーブデータから[起動回数] [乳カウント]の内容を得る。
		実行後、イベントOnPotatoReturnのReference1、2にて取得。


■使用例１
	＃里々用、単体で読む場合。

	＊OnPotatoReturn
	＞OnPotatoReturn_（Ｒ０）

	＊実行
	\![raiseplugin,芋スコープ,OnPotatoGet,333-666,-,ユーザ名,起動回数]

	＊OnPotatoReturn_ユーザ名,起動回数
	＄美耳のユーザ名【タブ】（Ｒ１）
	＄美耳の起動回数【タブ】（Ｒ２）
	：よっ、（美耳のユーザ名）。


■使用例２
	＃里々用、起動時などにコッソリ一括読み込みする場合。（Ｒ１）は識別用IDに使用。
	＃通知されるイベントでは、トークを書かない限り表示の邪魔をしません。
	＃つまり、raisepluginを連発しても、里々が内部でこっそり処理してくれるということ。

	＊OnPotatoReturn
	＞OnPotatoReturn_（Ｒ０）

	＊OnBoot
	（起動）（一括セーブ読み）

	＊一括セーブ読み
	\![raiseplugin,芋スコープ,OnPotatoGet,333-666,-,美耳,ユーザ名,起動回数]
	\![raiseplugin,芋スコープ,OnPotatoGet,Iron_Dream,-,鉄の夢,ユーザ誕生月,ユーザ誕生日]

	＊OnPotatoReturn_美耳,ユーザ名,起動回数
	＄美耳ユーザ名【タブ】（Ｒ２）
	＄美耳起動回数【タブ】（Ｒ３）

	＊OnPotatoReturn_鉄の夢,ユーザ誕生月,ユーザ誕生日
	＄鉄の夢ユーザ誕生月【タブ】（Ｒ２）
	＄鉄の夢ユーザ誕生日【タブ】（Ｒ３）


_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/


■1.3追加機能
	栞の自動判別をせず、手動で栞を指定できるようになりました。
	通常と違うのは、descript.txtを読み込まないこと。動作が多少早くなるかも？

	■里々
	\![raiseplugin,芋スコープ,OnPotatoGetSatori,<フォルダ名>,<ファイル名>,<変数1>,<変数2>...]

	■華和梨
	\![raiseplugin,芋スコープ,OnPotatoGetKawari,<フォルダ名>,<ファイル名>,<変数1>,<変数2>...]

	■YAYA又は文（どっちも同じ）
	\![raiseplugin,芋スコープ,OnPotatoGetAya,<フォルダ名>,<ファイル名>,<変数1>,<変数2>...]
	\![raiseplugin,芋スコープ,OnPotatoGetYaya,<フォルダ名>,<ファイル名>,<変数1>,<変数2>...]


_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/


■1.2追加機能（おまけ的）
	ゴースト毎に保存できる共有変数。掲示板、ゲーセンノート的な機能です。
	保存できる領域は各ゴースト一体につき一つなので、複数の値を記録したい場合は
	独自に区切り文字（半角コンマとか）を入れ、読み出す側が適宜処理を行います。

	ぶっちゃけ上記のセーブファイル読み込みが可能なら不要な機能です。
	非対応のSHIORI、文字コードによる文字化けなどの回避、最新の値を記録したい時などに。


■使用方法

	■実行方法

	★書き込む（芋を揚げる）
	以下のさくらスクリプトを実行します。

	\![raiseplugin,芋スコープ,OnPotatoFry,<記録したい内容>]
	\![raiseplugin,8AD59FAA-B6E4-4bf7-BFC6-C4E907F1AADB,OnPotatoFry,<記録したい内容>]

	<記録したい内容>
		そのまんま。内容は「常に上書き」である事に注意して下さい。
		ゴースト名領域に記録されるので、自分以外の領域には書き込めません。


	★読み込む（食べる）
	以下のさくらスクリプトを実行します。

	\![raiseplugin,芋スコープ,OnPotatoEat,<領域ゴースト名>,<識別用メモ>]
	\![raiseplugin,8AD59FAA-B6E4-4bf7-BFC6-C4E907F1AADB,OnPotatoEat,<記録したい内容>]

	<領域ゴースト名>
		読み込みたいゴースト名の領域を指定します。
		こちらはフォルダ名でなく「ゴースト名」である事に注意して下さい。
		イベント名はEatですが読み込んでも消えないのでご安心を。
	<識別用メモ>
		省略可。後で識別するための任意の文字列。


	■発生するイベント
	上記のさくらスクリプトを実行すると、ゴースト側にイベントが通知されます。
	ただし、書き込み系のイベントはデバッグ以外ではまず使わないでしょう。

	%% 書き込みに成功した
		ID: OnPotatoFryComplete
		Reference0: 自分のゴースト名
		Reference1: 書き込んだ内容

	%% 書き込みに失敗した（芋スコープのバグの可能性大）
		ID: OnPotatoFryFailure
		Reference0: 自分のゴースト名
		Reference1: 書き込もうとした内容

	%% 読み込みに成功した
		ID: OnPotatoEatComplete
		Reference0: 読み込もうとした対象ゴースト名
		Reference1: 読み出した内容
		Reference2: <識別用メモ>

	%% 読み込みに失敗した（指定領域がない、又は内容がからっぽ）
		ID: OnPotatoEatFailure
		Reference0: 読み込もうとした対象ゴースト名
		Reference1: 文字列"__BLANK__"
		Reference2: <識別用メモ>


■使用例（里々用）

	＃ゴーストＡ

	＊こっそり書き込む
	：\![raiseplugin,芋スコープ,OnPotatoFry,ユーザがセクハラした回数,（セクハラ回数）]φ
	（８）ん？　なんでもないよー。


	＃ゴーストＢ

	＊こっそり読み込む
	\![raiseplugin,芋スコープ,OnPotatoEat,ゴーストＡ,テスト]φ

	＊OnPotatoEatComplete
	＞OnPotatoEatComplete_（Ｒ２）

	＊OnPotatoEatComplete_テスト
	＄ゴーストＡへのセクハラ回数【タブ】（nop、（split、（Ｒ１）、,））（Ｓ１）
	：（８）ほうほう、（ゴーストＡへのセクハラ回数）回か……。


_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/


■おまけのおまけ
	上記の記録を「誰でも上書きできる」共通のもの。
	消されても構わない謎メモを残したりなど。


■実行方法

	★書き込む
	\![raiseplugin,芋スコープ,OnPotatoFryCommon,<記録したい内容>]
	\![raiseplugin,8AD59FAA-B6E4-4bf7-BFC6-C4E907F1AADB,OnPotatoFryCommon,<記録したい内容>]

	<記録したい内容>
		内容は「常に上書き」。

	★読み込む
	\![raiseplugin,芋スコープ,OnPotatoEatCommon,<識別用メモ>]
	\![raiseplugin,8AD59FAA-B6E4-4bf7-BFC6-C4E907F1AADB,OnPotatoEatCommon,<識別用メモ>]

	<識別用メモ>
		省略可。


	■発生するイベント
	上記のさくらスクリプトを実行すると、ゴースト側にイベントが通知されます。
	基本的に通常のフライ＆食べるのと同じ。ゴースト名は"Common"になります。

		ID: 
		OnPotatoFryCommonComplete
		OnPotatoFryCommonFailure
		OnPotatoEatCommonComplete
		OnPotatoEatCommonFailure

		Reference0: 文字列"Common"
		Reference1: 書かれていた内容 又は "__BLANK__"
		Reference2: <識別用メモ>


■使用例（里々用）

	＊読み込む
	\![raiseplugin,芋スコープ,OnPotatoEatCommon,テスト]φ

	＊OnPotatoEatCommonComplete
	＞OnPotatoEatCommonComplete_（Ｒ２）

	＊OnPotatoEatCommonComplete_テスト
	：なんかメモがあったよ。
	（Ｒ１）
	だってさ。


_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/


■クレジット
	プログラマブル準AI華和梨 Phase 8.2.8 http://kawari.sourceforge.net/