Table of Contents

Namespace VMagicMirror.Buddy

Classes

BlendShapePresetNames

IAvatarFacialなどで適用されることのあるブレンドシェイプ名のうち、 VRM1.0 の標準として定義されるブレンドシェイプの名称を定義したクラスです。

PerfectSyncBlendShapeNames

パーフェクトシンク機能で参照するアバターのブレンドシェイプ名です。

Structs

AudioStartedInfo

AudioStarted イベントに付随する情報です。

AudioStoppedInfo

AudioStopped イベントに付随する情報です。

Pose

位置と回転のペアを表すデータです。

Quaternion

UnityEngineのQuaternionとほぼ同等のことが出来る四元数のデータです。 回転を表すことを目的として定義されています。

Vector2

UnityEngineのVector2とほぼ同等のことが出来るようなデータです。

Vector3

UnityEngineのVector3とほぼ同等のことが出来るようなデータです。

Interfaces

IAudio

音声の再生に関連するAPIです。

IAvatarFacial

アバターの表情の状態に関するAPIです。

IAvatarLoadEvent

アバターのロード状態に関するAPIです。

IAvatarMotionEvent

アバターの動作をイベントとして検出できるAPIです。

IAvatarPose

アバターの姿勢情報に関するAPIです。

IDefaultSpritesSetting

まばたき、口パクの画像差分を含むスプライト画像で構成されたデフォルト立ち絵を操作するための設定を定義します。

IDeviceLayout

アバターがいる空間内のキーボードなどのデバイスや、アバターウィンドウを撮影しているカメラの配置などのレイアウト情報を取得できるAPIです。

IFloatingSpriteEffect

浮遊しているような視覚効果を適用するエフェクトの設定です。

IGlb

GLB形式の3Dモデルの読み込みと操作に関するAPIです。 本APIは作成途上のものであり、VMagicMirror v4.0.0の時点では本APIは利用できません。

IInput

キーボード、マウス、ゲームパッドなどの入力状態を取得できるAPIです。

IJumpSpriteEffect

ジャンプ動作を適用するエフェクトの設定です。

IManifestTransforms

manifest.json で定義され、ユーザーがレイアウトを編集可能な2Dまたは3DのTransform情報を取得できるAPIです。

IProperty

マニフェストで定義されたプロパティ値を取得できるAPIです。

IPuniSpriteEffect

x軸に伸びながらy軸方向に縮む、またその逆を行うような、ぷにぷにする視覚効果を適用するエフェクトの設定です。

IReadOnlyTransform2D

現在の姿勢やアバターの親ボーンのアタッチ先を読み取り可能なTransform情報です。 とくに、マニフェストの定義に基づいて生成され、ユーザーがレイアウトを編集できる2DのTransform情報がこのinterfaceの値として表現されます。

IReadOnlyTransform3D

現在の姿勢やアバターの親ボーンのアタッチ先を読み取り可能なTransform情報です。 とくに、マニフェストの定義に基づいて生成され、ユーザーがレイアウトを編集できる3DのTransform情報がこのinterfaceの値として表現されます。

IRootApi

スクリプトから Api 変数としてアクセスできるような、サブキャラの制御に利用できるAPI群です。

IScreen

アバターを表示しているウィンドウの状態に関するAPIです。

ISprite2D

画像をアバターウィンドウの最前面に平面的に表示するAPIです。

ISprite3D

画像を3D空間上のスプライトとして表示するAPIです。

ISpriteEffect

スプライトを移動・回転・変形できるようなエフェクトを提供するAPIです。

ITransform2D

画面の最前面に表示されたオブジェクトについて、2D空間上の姿勢が取得、設定できるインスタンスです。

ITransform3D

姿勢を取得・編集できるような3DオブジェクトのTransform情報です。

IVibrateSpriteEffect

x軸とy軸の各方向に振動するような視覚効果を適用するエフェクトの設定です。

IVrm

サブキャラとしてVRMのロードと操作を行うAPIです。 本APIは作成途上のものであり、VMagicMirror v4.0.0の時点では本APIは利用できません。

IVrmAnimation

VRM Animationの読み込み処理に関するAPIです。 本APIは作成途上のものであり、VMagicMirror v4.0.0の時点では本APIは利用できません。

Enums

AppLanguage

VMagicMirrorの表示に使用している言語です。

AudioStoppedReason

Play(string, float, float, string) で再生した音声が停止した理由を表す値です。

FaceSwitchState

GetActiveFaceSwitch() の結果として取得できるような、 Face Switch機能で検出したユーザーの表情です。

GamepadButton

ゲームパッドのボタンです。

HumanBodyBones

UnityEngineのHumanBodyBonesと同じ順序で定義された人型ボーン情報の一覧です。 ただし、UnityEngineの値とは異なり、無効なボーンを表す None が追加で定義されています。

Sprite2DTransitionStyle

Show(string) でスプライト画像を切り替えるプリセット演出の種類です。