AnimeFunsion/modular-avatar
1
0
Fork 0
mirror of https://github.com/bdunderscore/modular-avatar.git synced 2025-01-01 12:15:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix broken links

Browse Source
This commit is contained in:
bd_ 2023-04-05 22:36:53 +09:00
parent 5bb06e6c65
commit 68298e3c97
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/docs/reference/menu-item.md
View File

@ -6,17 +6,17 @@ The Menu Item component allows you to define an expressions menu item from withi
## When should I use it?
This component can provide a more convenient way to edit and define menu items than defining VRC Expressions Menu assets. You can move menu items around by dragging and dropping them through the hierarchy, and it provides an editor interface that is aware of parameter names defined on [MA Parameters](parameters.md) components. In combination with [action components](action-toggle-object.md), you can even define object toggles without having to create any animations or animators.
This component can provide a more convenient way to edit and define menu items than defining VRC Expressions Menu assets. You can move menu items around by dragging and dropping them through the hierarchy, and it provides an editor interface that is aware of parameter names defined on [MA Parameters](parameters) components. In combination with [action components](action-toggle-object), you can even define object toggles without having to create any animations or animators.
## How do I use it?
:::tip
A full tutorial on using the menu editor system is available [here](../tutorials/menu/index.md).
A full tutorial on using the menu editor system is available [here](../tutorials/menu).
:::
The menu item component defines a single menu item in a larger menu. You can configure the icon, menu type, [control group](control-group.md), and parameter for the menu item. The name of the menu item will be taken from the name of the containing game object. This lets you see the name of, and rename menu items directly from the hierarchy.
The menu item component defines a single menu item in a larger menu. You can configure the icon, menu type, [control group](control-group), and parameter for the menu item. The name of the menu item will be taken from the name of the containing game object. This lets you see the name of, and rename menu items directly from the hierarchy.
### Submenus
@ -31,15 +31,15 @@ When submenu source is children, you can also specify a "source object override"
In order to define where a menu item will go in the menu, another component will be needed to _bind_ it to a menu. There are three ways of doing this:
* The menu item can be set as the child of another menu item set in submenu / children mode.
* The menu item can be on the same game object as a [Menu Installer](menu-installer.md) component.
* The menu item can be the child of a [Menu Group](menu-group.md) object (which would typically be on a game object with a Menu Installer component)
* The menu item can be on the same game object as a [Menu Installer](menu-installer) component.
* The menu item can be the child of a [Menu Group](menu-group) object (which would typically be on a game object with a Menu Installer component)
Unbound menu items have no effect
### Using with actions
If an [action component](action-toggle-object.md) is on the same object as the menu item, the menu item will be configured to control this action component, instead of controlling an arbitrary parameter. See the action component documentation for details.
If an [action component](action-toggle-object) is on the same object as the menu item, the menu item will be configured to control this action component, instead of controlling an arbitrary parameter. See the action component documentation for details.
When an action component is present on the same object, you can no longer select the parameter name for the menu item; Modular Avatar will automatically assign a parameter at build time. By default, a boolean parameter will be created; if you attach a [control group](control-group.md) to the menu item, an int parameter will be used instead.
When an action component is present on the same object, you can no longer select the parameter name for the menu item; Modular Avatar will automatically assign a parameter at build time. By default, a boolean parameter will be created; if you attach a [control group](control-group) to the menu item, an int parameter will be used instead.
When a control group is attached, you can select a single menu item to be the "Group Default". When this is done, this menu item will be set to be initially selected; additionally, for certain types of actions (notably, [Toggle Object](action-toggle-object.md) actions), when _other_ menu items are selected, the action of this default item will be negated (so any objects this action toggles on, will be off by default in other states).
When a control group is attached, you can select a single menu item to be the "Group Default". When this is done, this menu item will be set to be initially selected; additionally, for certain types of actions (notably, [Toggle Object](action-toggle-object) actions), when _other_ menu items are selected, the action of this default item will be negated (so any objects this action toggles on, will be off by default in other states).