docs: update MA Parameters docs (#1351)

This commit is contained in:
bd_ 2024-11-16 19:43:19 -08:00 committed by GitHub
parent e68e176aa4
commit 4b5cf06097
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 68 additions and 64 deletions

View File

@ -14,36 +14,50 @@ than VRChat builtins.
## How do I use it?
### Setting defaults
Each entry in the MA Parameters list configures a single parameter, or a prefix used for a VRChat PhysBone.
You set the name (or prefix) in the top row, with the type of parameter next to it.
The parameters UI shows each parameter initially in a collapsed view. This view makes it easy to set the default values
for each parameter, and whether they are saved when you change avatars, or change worlds. Setting a non-blank default
value will override the value in the main Expressions Parameters asset, if any.
### Parameter types
You can set a blank value here as well; this can be useful if multiple MA Parameters components define the same
parameter, where the "default value" field will ignore any MA Parameters component which does not set a default.
Setting default values for the same parameter in multiple Parameters components will result in a warning, as it's
unclear which should be used.
The parameter type field in the upper right can be set to any of the following:
For the "Saved" option, generally speaking the parameter will be saved if any MA Parameters component sets it to be
saved. However, there is an exception; see the section on "Nesting" for more information. Note also that the "Saved"
setting will be enabled if either MA Parameters or the original Expression Parameters asset enables saving for the
parameter.
* Bool
* Int
* Float
* Animator Only
* PB Prefix
Normally, the default values you set will only affect the Expressions Parameters settings for your avatar. However,
you can override the default values for the _animator_ itself by either setting the "Parameter Type" to "Animator Only",
or by enabling the "Override Animator Defaults" checkbox (note that this is ignored for animator only parameters).
If you select Animator Only, the parameter will not be added to the Expressions Parameters list. However, it will still
be able to rename the parameter in question, as described below.
The PB Prefix setting is used when this parameter prefix is set in a PhysBones component. As with Animator Only, this will
not be added to the Expressions Parameters list.
### Renaming parameters
By setting the "Change name to" field you can _rename_ a parameter. That is, if you have a parameter "foo", which has
a "Change name to" setting of "bar", then on the object with the MA Parameters component and its children you can
refer to this parameter as "foo" (eg in [MA Menu Item](menu-item.md), [MA Merge Animator](merge-animator.md), or in
VRChat Contact Receivers); however, outside of this object, the parameter will be referred to as "bar".
If you enter a name in the "Change name to" field, the parameter will be renamed to that name for anything _outside_
of the MA Parameters object and its children. This can be useful for avoiding conflicts between different gimmicks,
or conversely, deliberately connecting two different gimmicks by making them use the same parameter.
By renaming parameters on multiple components to use the same name, you can wire up one gimmick to trigger another.
You can also select "Auto Rename" to have Modular Avatar automatically select an unused name; this will help avoid
accidental name collisions between different gimmicks.
You can also click the "Auto rename" box to have Modular Avatar automatically select an unused name for you.
### Default values
You can set a default value for each parameter. This value will be used when you avatar is reset. If you leave the
default box blank, then the value (if any) in the main Expressions Parameters asset will be used, or otherwise zero (or
false) will be used.
If you click the "Override Animator Defaults" box, then any default values specified in the _animator controller_ of
your asset will be changed to this default. This is occasionally useful with particularly complex gimmicks. If you
selected "Animator Only" and specified a default value, then this box will be ignored, and the animator controller
default will always be replaced.
### Saved/Synced
The Saved box controls whether the parameter will be saved across avatar changes and restarting VRChat.
The Synced box controls whether the parameter will be synced across the network. If you clear this box, this parameter
won't use your limited parameter space.
### Creating new parameters
@ -58,18 +72,6 @@ Either way, after creating the parameter, click the chevron next to the new para
There, you can set the parameter type (which controls whether the parameter is synced), and other attributes of the
parameter.
### PhysBones and Contacts
MA Parameters can rename parameters used by VRChat PhysBone components and Contact Receivers. For PhysBones, enter the
prefix (the value in the "Parameter" field of the VRC Phys Bone component) as the parameter name, and click the
"Is PhysBone Prefix" option. This will be automatically set if you add it via the "Unregistered Parameters" section.
### Expression Parameters
Set the "Parameter type" field to register the parameter in the VRC Expressions Parameters list. This will sync the
parameter over the network, and allow for it to be used in the expressions menu and in OSC. If you don't need the
parameter to be synced, click "Local Only".
### Nesting
MA Parameters components can be nested. This lets you build up a complex system out of multiple subcomponents. Each

Binary file not shown.

Before

Width:  |  Height:  |  Size: 47 KiB

After

Width:  |  Height:  |  Size: 57 KiB

View File

@ -12,32 +12,45 @@ VRChatが提供するパラメーター以外の、自分で定義するパラ
## 使い方
### 初期値を設定する
MA Parametersリストの各エントリーは、一つのパラメーター、またはVRChatのPhysBoneの前置詞を指定します。上段に名前または前置詞を、
その横にパラメーターの型を設定します。
ParametersのUIは最初はたたんだ状態でパラメーター情報を表示します。この表示では初期値と、アバター変更やワールド移動でで保存されるかを
設定できます。空以外の設定だと、Expressions Parametersに設定された初期値も上書きします。
### パラメーター型
複数のMA Parametersで同じパラメーターが設定された場合は、初期値を空欄にするのが便利です。設定されたところだけ初期値に関与します。
なお、複数のMA Parametersコンポーネントで同じパラメーターの初期値を設定してしまうと初期値が不定になるため注意がでます。
右上のパラメーター型欄には、以下のいずれかを設定できます。
「保存する」設定に関しては、どれか一つのMA Parametersで有効になっている場合は保存状態となります。しかし、例外もあります。詳しくは
「入れ子にする」に参照。なお、Expressions ParametersとMA Parameters両方に定義される場合は、どちらかあるいは両方に「保存する」が
有効になっていると、保存される扱いとなります。
* Bool
* Int
* Float
* Animatorのみ
* PB前置詞
普段は設定した初期値はアバターのExpressions Parameters設定のみに適用されます。ただし、「パラメーター型」を「Animatorのみ」に設定するか、
「アニメーターの初期値を設定」を有効にすることで、アニメーター自体の初期値を上書きすることができます。なお、「アニメーターの初期値を設定」は
「アニメーターのみ」の場合無視されます。
「Animatorのみ」を選択すると、そのパラメーターはExpressions Parametersリストに追加されません。ただし、下記の名前変更はできます。
### 名前を変更
「PB前置詞」設定は、このパラメーター前置詞がPhysBonesコンポー年tおに設定されている場合に使います。Animatorのみと同様、Expressions Parameters
リストには追加されません。
「名前を変更」欄に新しい名前を入れると、パラメーターのリネームができます。たとえば、「hoge」という名のパラメーターに、「piyo」という
「名前を変更」設定を入れると、MA Parametersコンポーネントのあるオブジェクトとその子では「hoge」として参照できます。その中の
[MA Menu Item](menu-item.md)、[MA Merge Animator](merge-animator.md)、VRChat Contact Receiverなどは「hoge」で扱うわけです。
しかし、そのオブジェクトの外では、「piyo」として扱われます。
### パラメーターのリネーム
複数のMA Parametersで名前がかぶるように設定すると、一つのギミックで別のギミックを制御するように連動させることができたりします。
また、「自動リネーム」を設定すれば、Modular Avatarに自動的に衝突しない名前を選択してもらえます。これで意図してない名前の衝突を避ける
ことができます。
「名前を変更」欄に新しい名前を入れると、そのパラメーターはMA Parametersオブジェクトとその子の外ではその名前として扱われます。これは、
異なるギミック間の衝突を避けるために使ったり、逆に同じパラメーターを使って二つのギミックを連動させるために使うことができます。
「自動リネーム」をクリックすると、使われていない名前が自動的に選択されます。
### 初期値
各パラメーターには初期値を設定できます。この値はアバターをリセットしたときに使われます。初期値を空欄にすると、アバターのExpressions Parameters
アセットに設定された値が使われます。それもない場合は、0またはfalseが使われます。
「アニメーターでの初期値を設定」を有効にすると、アニメーターコントローラーの初期値を上書きします。一部複雑なギミックを作る際に便利です。
「Animatorのみ」を選択して初期値を設定した場合は、この設定は無視され、常にアニメーターコントローラーの初期値が上書きされます。
### 保存・同期
「保存する」設定は、パラメーターがアバター変更やVRChat再起動時に保存されるかを設定します。
「同期する」設定は、パラメーターがネットワーク経由で同期されるかを設定します。この設定をクリアすると、パラメーターはネットワーク上での
パラメーター数を消費しません。
### パラメーターの新規作成
@ -49,17 +62,6 @@ ParametersのUIは最初はたたんだ状態でパラメーター情報を表
どのみち、パラメーターを作ったら▶を押せば詳細画面を開けます。そこで同期状態をつかさどるパラメーター型を設定したり、その他詳細設定ができます。
### PhysBoneやContact
MA ParametersはVRC Phys BoneやContact Receiverコンポーネントにも対応しています。PhysBonesの場合は、VRC Phys Boneコンポーネント
の「Parameter」欄にも登録されている、前置詞をパラメーター名にしてから、「PhysBone前置詞名」を有効にしてください。なお、
「未登録パラメーター」のリストから追加する場合は自動的に設定されます。
### Expression Parameters
VRC Expression Parametersに登録する場合は、「パラメーター型」を設定してください。ネットワーク経由で同期されるようになり、
Expressions MenuアクションメニューやOSCで使えるようになります。ネットワーク同期が不要の場合は「Local Only」を設定してくささい。
### 入れ子にする
MA Parametersコンポーネントは入れ子状態にできます。これで複雑なシステムを、複数のモジュールから組み上げることができます。

Binary file not shown.

Before

Width:  |  Height:  |  Size: 44 KiB

After

Width:  |  Height:  |  Size: 54 KiB