yaya_shiori3.dic¶

システム辞書とは¶

システム辞書とは、YAYA を「ゴーストの SHIORI として簡単に利用できるようにする」ための、一連の機能をもった YAYA スクリプトファイルの集まりのこと。現在、システム辞書は次の構成になっている（yaya_base フォルダ内にある）。

config.dic を除く辞書は、基本的にはユーザーが変更する必要はない。

最新安定版は、「はろーYAYAわーるど（紺野ややめ）」内で提供している。適宜更新すること。更新するときは、yaya.dll も同時に更新することをお勧めする。最新開発版は、yaya-dic で見られる。

yaya-dic を使うときは、基礎設定ファイルに次の行を追加する（基礎設定）。

dicdir, yaya_base

_loading_order.txt を編集すると、optional.dic を無効にしたり、compatible.dic を有効にしたりできる。

概要¶

yaya_shiori3.dic は、YAYA ベースのゴーストに SHIORI/3.0 としての核心機能を提供するシステム辞書。

SHIORI イベントの入出力¶

ベースウェアから渡される SHIORI イベントは、たとえば次のような文字列。

GET SHIORI/3.0
Sender: SSP
Charset: UTF-8
SecurityLevel: local
ID: OnSecondChange
Status: talking
Reference0: 107
Reference1: 0
Reference2: 0
Reference3: 1
Reference4: 0

yaya_shiori3.dic は、この文字列を解釈して次の動作を行う。

上記の動作の結果、OnSecondChange 関数内で処理が行われたあと、yaya_shiori3.dic はその結果を次のような文字列としてベースウェアに返す。

SHIORI/3.0 200 OK
Sender: AYA
Charset: UTF-8
Value: \0\s[0]あ、エミリさん。\1\s[10]テディも元気そうだな。
Reference0: Emily

ランダムトーク¶

ランダムトークを簡単に行えるようにするため、OnAiTalk 関数を aitalkinterval 秒ごとに呼び出す機能を持つ。本来 OnAiTalk はベースウェアには存在しない機能で、yaya_shiori3.dic がその機能を追加している。

内部トランスレート¶

すべてのイベントの処理後に、OnTranslateInternal 関数を呼び出す機能を持つ。その際の引数（_argv[0]）は、ベースウェアに出力しようとしているトーク内容になる。この関数で返した内容が、実際にベースウェアに出力されるトークになる。したがって、OnTranslateInternal 内で _argv[0] を適当に加工して返すことで、すべてのトークに一律変換を行う、などの処理ができる。

チェイントーク¶

チェイントークとは、「あるトークを契機として、一連のトークを指定した順序で行う」機能。これも yaya_shiori3.dic で実装されている。

トークの \e の後に :chain=○○ と書くと、チェイントークが発動する（○○ はチェイントークを区別するための識別子で、end 以外ならどんな文字列でもよい）。チェイントークが発動した場合、OnAiTalk ではランダムトークではなく、上で書いた ○○ 関数（チェイン関数）が呼び出される（この機能は yaya_shiori3.dic ではなく、ゴーストテンプレート側で記載されている）。

チェイン関数は、通常の関数とは異なり、次のように記載する（:chain=hoge とした場合）。

hoge
{{CHAIN
    "\0\s[0]りんご\e"
    "\0\s[1]ごりら\e"
    "\0\s[0]らっぱ\e:chain=end"
}}CHAIN

通常の関数では「りんご」「ごりら」「らっぱ」のどれか 1 つが無作為に選択されるが、チェイン関数では、上から順番にトークが連鎖する。\e の後に :chain=end と書くと、チェイントークを停止できる。

チェイン区切り文字（:chain=）¶

トークスクリプトの末尾に :chain=イベント名 を付けると、次のランダムトークの機会に、指定したイベントが呼ばれる。

OnMyEvent
{
    '\0\s[0]続きがあるよ。\e' + ':chain=' + 'OnMyEventPart2'
}

OnMyEventPart2
{
    '\0\s[0]これが続きです。\e'
}

遅延 EVAL¶

\e の後に :eval=式 と書くと、その式を実行（実際には EVAL(式) と書くのと同じ）できる。たとえば "\0\s[0]はじめまして。\e:eval=aisatu=1" と書くことで、「あるトークをしゃべることを契機としたフラグ処理」のようなものを簡単に行える。

セキュリティ上の理由から、この機能はデフォルトで無効化されている。有効化したい場合は、セキュリティ上のリスクをよく理解したうえで、config.dic 内の SHIORI3FW.ENABLE_DELAYED_EVAL を 1 に設定する。

インストール済みゴーストリスト¶

ID: installedghostlist を解釈し、グローバル変数 installedghostlist（ゴースト名の汎用配列）などを作成する。

OnNotifyInstalledGhostName などのイベントを受け取ると、次の変数が自動的に更新される。インデックスは対応しており、installedghostlist[i] のゴーストのさくら名は installedsakuralist[i] になる。

SAORI 呼び出し¶

SAORI 呼び出しを簡単に行えるよう、yaya_shiori3.dic で次の関数を提供している。SAORI のロード、アンロードも、FUNCTIONEX を利用したときに自動的に行われる。

FUNCTIONEX¶

FUNCTIONEX( dllname [, Argument0 , Argument1 , ... ] )

FUNCTIONEX の返り値は、SAORI の返り値（Result の値）になる。SAORI がそれ以上の返り値（Value0、1、…）を返した場合は、valueex 配列および グローバル変数 valueex0、valueex1、… に格納される。

_result = FUNCTIONEX('kawari8.dll', 'こんにちは')
// 追加の戻り値は valueex[0], valueex[1], ... で参照

詳しくは FUNCTIONEX を参照。

ベースウェアの内蔵モジュール（SAORI over DirectSSTP）¶

dllname が internal_ で始まるとき（internal_crypto、internal_time.dll など。大文字小文字は区別せず、末尾の .dll は付いていてもよい）は、DLL を読み込まず、DIRECTSSTP でベースウェア（SSP 2.9.13 以降）の内蔵モジュールを呼ぶ。書き方、返り値、valueex、LIB.STATUSCODE は、DLL の SAORI と同じ。モジュールと関数は SAORI over DirectSSTP を参照。

_hash = FUNCTIONEX('internal_crypto', 'Digest', 'sha256', 'abc')
_text = FUNCTIONEX('internal_time', 'Format', 0, '%Y/%m/%d', '--tz=+09:00')

• そのモジュールが使えないとき（旧 SSP、SSP 以外のベースウェア、知らないモジュール）は 0 を返す。使えるかどうかは、モジュールごとに最初の 1 回だけ GET Version SAORI/1.0 で確かめて覚える。ゴーストの窓（SHIORI3FW.HWnd[0]）がまだ分からない起動直後は、覚えずに 0 を返す
• 失敗したとき（400、500）の Result は空で、LIB.STATUSCODE に 400 Bad Request などが入る。失敗の理由（ErrorDescription）は var.lib.key / var.lib.value から読める
• 引数に改行（CR・LF）が含まれるときは、ヘッダを書き足せてしまうので送らず、0 を返す。改行や前後の空白を含むデータは、--data-in=base64 などの形式で渡す
• 文字コードは UTF-8 で固定
• 時間のかかる処理（DeriveKey、HashPassword など）には --async=識別子 を付ける。結果はあとでイベント（OnInternalSaoriComplete など）で届き、FUNCTIONEX の返り値は空（LIB.STATUSCODE は 204 No Content）になる

SAORI¶

FUNCTIONEX のシノニム（別名）。書き方は FUNCTIONEX と同じ（internal_ の内蔵モジュールも同じ）。一段下駄が入る分、FUNCTIONEX より低速になるが、気にするほどではない。

FUNCTIONLOAD¶

SAORI の DLL を読み込む。引数は SAORI の DLL ファイル名。成功時は 1、失敗時は 0 を返す。

FUNCTIONLOAD('kawari8.dll')

SHIORI3FW.SaoriUnloadAll¶

現在ロードされているすべての SAORI の DLL をアンロードする。引数も戻り値もない。

ベースウェアプロパティ関数¶

SSP など、DIRECTSSTP に対応したベースウェアのプロパティを読み書きしたり、EXECUTE SSTP のコマンドを実行したりする。

_vol = GET_PROPERTY('volume')
SET_PROPERTY('volume', '80')

EXECUTE_SSTP¶

EXECUTE_SSTP( コマンド名 [, 引数0 , 引数1 , ... ] )

DIRECTSSTP でベースウェアに EXECUTE SSTP/1.1 のリクエストを送り、結果を返す。2 つめ以降の引数は Reference0、Reference1、… として送られる。使えるコマンドはベースウェアの SSTP 仕様（GetVersion、GetGhostNameList、GetStatus、GetCookie など）を参照。

• 返り値: 成功時（ステータスが 2xx）は、空行より後ろの追加データ（末尾の改行は取り除く）。失敗時は空文字列。一覧を返すコマンドの結果は C_CRLF 区切りの文字列になる
• 結果の変数: SSTP.STATUSCODE にステータス行の結果（200 OK、501 Not Implemented など）、SSTP.STATUS にその数値が入る。送信できなかったときは '' と 0
• コマンドや引数に改行（CR・LF）が含まれるときは、ヘッダを書き足せてしまうので送らず、空文字列を返す（SSTP.STATUS は 0）

追加データの無いコマンドは、成功しても空文字列を返すので、成否は SSTP.STATUS で確かめる。

_ver = EXECUTE_SSTP('GetShortVersion')
_ghosts = SPLIT(EXECUTE_SSTP('GetGhostNameList'), C_CRLF)

_dummy = EXECUTE_SSTP('SetCookie', 'mykey', 'value')
if SSTP.STATUS == 200 || SSTP.STATUS == 204 {
    // 成功
}

GET_PROPERTY は EXECUTE_SSTP('GetProperty', プロパティ名)、SET_PROPERTY は EXECUTE_SSTP('SetProperty', プロパティ名, 値) と同じで、SSTP.STATUSCODE と SSTP.STATUS も同じように入る。

配列操作¶

_配列 = ("A","B","C","D","E")
結果 = JOIN(_配列, "★")   // "A★B★C★D★E"

テキスト処理・状態確認¶

SHIORI3FW.RemoveAllTags¶

さくらスクリプトタグ（\0、\s[0] など）をすべて除去した文字列を返す。

_plain = SHIORI3FW.RemoveAllTags('\0\s[0]こんにちは。\e')
// → "こんにちは。"

タグを除去するのではなく、エスケープして表示したいときは、SHIORI3FW.EscapeAllTags を使う。

SHIORI3FW.CanTalk¶

現在ゴーストがしゃべれる状態かどうかを返す。status ヘッダに talking・choosing・minimizing・timecritical のいずれかが含まれている場合は、しゃべれないと判断する。しゃべれる場合は 1、しゃべれない場合は 0 を返す。

if SHIORI3FW.CanTalk {
    // ランダムトーク発動
}

遅延イベント（「遅れてしゃべる」イベント）¶

指定した秒数後に、特定のイベントを 1 度だけ発動させる。発動は OnSecondChange（1 秒ごと）のタイミングで処理される。

SHIORI3FW.SetDelayEvent¶

SHIORI3FW.SetDelayEvent( '発生させるイベント名' , 遅れる秒数 [, Reference0, ...] )

遅延イベントを登録する。イベント名が空文字列だとキャンセルする。第 3 引数以降は、イベント発動時にセットする Reference 値（省略可）。

// 10秒後に OnMyDelayedEvent を発動
SHIORI3FW.SetDelayEvent('OnMyDelayedEvent', 10)

// キャンセル
SHIORI3FW.SetDelayEvent('', 0)

SHIORI3FW.GetDelayEvent¶

現在登録されている遅延イベントの情報を、(イベント名, 残り秒数, Reference の配列) で返す。

レスポンスヘッダ追加¶

イベントハンドラのレスポンスに、任意のヘッダを追加できる。設定はリクエストごとにリセットされる。

イベントハンドラ内で次の変数に値を設定すると、レスポンスヘッダに自動的に付加される。

OnMyEvent
{
    res_reference0 = 'value0'
    res_reference1 = 'value1'
    '\0\s[0]処理しました。\e'
}

res_reference の上限インデックスは config.dic の SHIORI3FW.RES_REF_MAX（初期値 32）で決まる。

変数管理ユーティリティ¶

SHIORI3FW.RegisterTempVar¶

SHIORI3FW.RegisterTempVar( 変数名, ... )

終了時（unload 時）に自動削除するグローバル変数を登録する。保存が不要な一時的なグローバル変数の管理に使う。

myTempVar = '一時データ'
SHIORI3FW.RegisterTempVar('myTempVar')

疑似イベント¶

これらの関数をゴーストの辞書に定義すると、特定のタイミングで呼び出される。

OnSHIORI3FW.SurfaceRestore
{
    '\0\s[0]\1\s[10]\e'
}

システム変数¶

そのままでは利用が面倒な関数を簡単に利用するため、次の変数が提供されている。システム情報を取得するために使える。これらの変数はシステムが自動的に更新するので、参照専用として使うこと。

時刻系変数¶

メモリ系変数¶

センダーヘッダ系変数¶

ゴースト・シェル情報¶

ユーザー設定変数¶

ゴーストの動作をカスタマイズするために、読み書きできる変数。

aitalkinterval = 300

config.dic の主要設定¶

config.dic でシステムの動作を変更できる。

AI グラフの既定値¶

SSP の AI グラフ（レーダーチャート）は、SHIORI リソース getaistate で描かれる。ゴースト側に On_getaistate が無い、または空を返したときは、システム辞書の SHIORI3EV.On_getaistate が次の 6 軸を返す。ゴースト側で On_getaistate を定義すれば、そちらが優先される。

• 段階スケールは、値を収められる最小の 10、20、50、100、200、500、… （SHIORI3FW.AIGraphMax）
• Memory と Repertoire には、システム辞書自身の変数・関数も含まれる
• Uptime(h) の表示値と加算値は小数（SSP 2.4.26 以降が小数を扱える）

関連¶

• yaya_optional.dic
• FUNCTIONEX
• システム辞書内関数マニュアル（yaya-dic）