nizima LIVE Script API

概要

nizima LIVEで利用できるスクリプトについてのリポジトリです。

スクリプトの種類

アプリケーション全体で管理されるアプリケーションスクリプトと、モデルごとに管理されるモデルスクリプトがあります。

配置する場所が異なり、できる操作も多少の違いがあります。

JavaScriptで記載します。

イベントの種類

以下のようなタイミングでスクリプトを制御できます。

• スクリプトの有効/無効を切り替えた時
• 初期化完了時
• 更新時
• 描画時
• マウス、キーの入力時
• モデルの削除時

オブジェクトの種類

以下のようなオブジェクトにアクセスして、情報を取得したり操作したりできます。

• Live : アプリケーション全体の情報。グローバル変数liveでアクセス可能。
• Scene : 一つのウィンドウ内のすべてのオブジェクトを管理。グローバル変数sceneでアクセス可能。
• Model : 一つのモデルの情報。グローバル変数modelでアクセス可能
  • Parameter : 各パラメータ情報
  • Part : 各パーツ情報
  • Drawable : 各描画オブジェクトの情報
  • Motion : 各モーションの情報
  • Expression : 各表情の情報

β版からの変更点

• グローバル変数としてlive,scene,modelを追加しました。
  • それに伴い各種イベント関数の第一引数で受け取っていた方法は非推奨になります。(nizima LIVE 1.8.0時点ではどちらの記法でも動作します)
• Shiftなどを押したときにキーイベント関数でShift+Shiftのような文字列として取得していたの修正しました
• 文字を描画するときの基準位置を左上基準に変更しました。
• ドキュメントの記載ミスなどを修正しました。
• その他アプリケーション上での使い勝手の改善はnizima LIVEの更新情報をご確認ください

サンプル

https://github.com/Live2D-Garage/nizimaLIVESampleScript

仕様

https://live2d-garage.github.io/nizimaLIVEScriptAPI