2024年10月24日このページでは、UIDやパラメータIDなどから外部連携APIを通してエディタ内の情報を設定、および取得する命令やイベント、エラータイプを紹介します。命令RegisterPlugin外部アプリケーションをエディタに登録します。登録が終わるとトークンを返します。このトークンはアプリと紐付いており、次回の接続時に指定することでユーザーの許可状態を引き継ぐことができます。詳しくは「トークン認証」をご覧ください。アプリケーション名(任意):ユニークな名前を付けてください。他のアプリと名前が被っても動作に影響はありません。トークン:省略、または未登録のトークンの場合は、RegisterPluginは新しいトークンを返します。指定されたトークンが登録済みの場合は、そのトークンをそのまま返します。アイコンPNG画像のBASE64文字列:サイズは32×32以上、256×256以下の正方形で0.5MB以下とします。アプリケーションのパス情報を表示します。注意事項RegisterPluginを最初に行い、ユーザーから許可を貰わない限り以下のほぼすべての命令は、PluginNotRegisteredのエラーを返してAPIによる操作を受け付けません。GetIsApprovalユーザーがこのアプリに対して通信を許可しているかどうかを取得します。設定ダイアログの「許可」のチェックボックスと連動しています。0.9.0パラメータIDを指定してモデルの現在のパラメータIDと値を取得します。パラメータIDの指定がない場合はモデルの全パラメータIDと値を取得します。アニメーションの情報は含まれません。0.9.1パラメータIDを指定してモデルの現在のパラメータIDと値を取得します。パラメータIDの指定がない場合はモデルの全パラメータIDと値を取得します。物理演算、モデル編集、アニメーションの情報が取得できます。0.9.0指定のパラメータIDと値を設定します。アニメーションファイルのモデルにパラメータは送信できません。0.9.1指定のパラメータIDと値を設定します。アニメーションファイルのモデルにパラメータを送信する場合、モデルトラックを選択している必要があります。物理演算エディタ、アニメーションのモデルの場合、パラメータを即時反映はせずテンポラリに保持されます。0.9.0モデルがもつパラメータ一覧を取得します。ModelUIDとDocumentUIDは省略可能ですが、どちらかは必須となります。ブレンドシェイプになります。アニメーションファイル(.can3)のモデルがもつパラメータ一覧は取得できません。0.9.1モデルがもつパラメータ一覧を取得します。ModelUIDとDocumentUIDは省略可能ですが、どちらかは必須となります。ブレンドシェイプになります。アニメーションファイルに含まれるモデルのパラメータ一覧を取得する場合、モデルトラックを選択している必要があります。モデルが組み込み用モデルトラックの場合、GroupUIDには空文字が返ります。0.9.0モデルがもつパラメータグループの一覧を取得します。ModelUIDとDocumentUIDは省略可能ですが、どちらかは必須となります。アニメーションファイル(.can3)に含まれるモデルがもつパラメータ一覧は取得できません。0.9.1モデルがもつパラメータグループの一覧を取得します。ModelUIDとDocumentUIDは省略可能ですが、どちらかは必須となります。アニメーションファイルに含まれるモデルのグループ一覧を取得する場合、モデルトラックを選択している必要があります。モデルが組み込み用モデルトラックの場合、GroupUIDには空文字が返ります。0.9.0ドキュメントの情報を返します。物理演算、モデル編集と種類ごとに別れ、存在しない場合は0個のドキュメント配列を返します。1モデルの分割表示を行った場合は、Viewsが増えます。0.9.1ドキュメントの情報を返します。物理演算、モデル編集と種類ごとに別れ、存在しない場合は0個のドキュメント配列を返します。1モデルの分割表示を行った場合は、Viewsが増えます。0.9.3ドキュメントのUIDを指定してドキュメントの情報を返します。0.9.3現在エディタ上でカレントになっているドキュメントのUIDを返します。0.9.0現在エディタ上でカレントになっているモデルのUIDを返します。アニメーションファイルに含まれるモデルのUIDは取得できません。0.9.1現在エディタ上でカレントになっているモデルのUIDを返します。アニメーションファイルに含まれるモデルのUIDを取得する場合、モデルトラックを選択している必要があります。0.9.0現在エディタ上でカレントになっている編集モードを返します。0.9.1使用するAPIバージョンを設定できます。これにより外部アプリケーションで使用するAPIバージョンを固定することができます。未設定の場合は、指定なしに戻すことができます。0.9.1対象のモデルに送信したパラメータをクリアします。SetParameterValueで送信したパラメータはエディタでテンポラリに保持します。物理演算エディタやアニメーションの場合、モデル更新の関係でテンポラリにパラメータを保持し続けることがあります。テンポラリに保持したパラメータを明示的にクリアしたい場合このAPIを使用します。0.9.2物理演算設定エディタにおける計算FPSを取得します。0.9.3エディタのログとして文字列を送信します。Messageの最大文字長は5000文字です。Displayはログパレットへの表示有無となっており、省略時はデフォルト値をtrueとしてログパレットに表示します。InvalidDataInvalidModelイベントイベントを扱う場合は、まずクライアントがサーバーに対して許可フラグを有効にする必要があります。}}すると、サーバーは特定の処理(イベント)を行った際に、クライアントからのリクエストに関係なくJSONを送信します。モデルファイルが一度も保存されていない場合、ModelFilePathフィールドには空文字が入ります。0.9.0物理演算設定ファイルの書き出し時の通知設定を行います。0.9.3MOC3ファイルの書き出し時の通知設定を行います。設定が有効の場合、MOC3ファイルの情報と関連ファイルの情報を通知します。0.9.0MOC3ファイルの書き出し時の通知設定を行います。設定が有効の場合、MOC3ファイルの情報を通知します。0.9.0モーションファイルの書き出し時の通知設定を行います。0.9.0モーションシンク設定ファイルの書き出し時の通知設定を行います。0.9.0編集モードが切り替わったときの通知設定を行います。EditModeについては「GetCurrentEditMode」をご覧ください。JSON構造が正しくありません。互換性のないバージョンです。指定された命令が見つかりません。Typeの設定が不正です。命令の引数が正しくありません。引数が足りなかったり、引数に異なる型を指定した場合にこのエラーを返します。プラグインの登録が完了していません。プラグインの登録(RegisterPlugin)、ユーザーによる許可が完了していない状態で、命令をリクエストするとこのエラーを返します。指定されたLive2Dパラメータが存在しません。指定されたLive2Dモデルが存在しません。指定されたドキュメントがエディタに存在しません。指定されたビューが存在しません。0.9.0この記事はお役に立ちましたか?はいいいえこの記事に関するご意見・ご要望をお聞かせください。付いている欄は必須項目です。