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

Document FPV component

Browse Source
This commit is contained in:
bd_ 2022-11-06 18:51:11 -08:00 committed by bd_
parent b24c6d77ae
commit 2db6e5a213
2 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/docs/reference/first-person-visible.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 7.8 KiB

27
docs/docs/reference/first-person.md Normal file
View File

@ -0,0 +1,27 @@
# First Person Visible
![First person visible component](first-person-visible.png)
This component can be used to make a GameObject placed under the Head bone visible in first-person view.
## When should I use it?
When you want to see your own hair, or other accessories attached to your head, without needing to look in a mirror.
## When shouldn't I use it?
This component cannot be used as the child of a PhysBone chain (you can add it in the parent instead).
Using this component on _all_ children of the Head can be distracting, as your bangs continually get in the way.
Currently, animating aspects of objects or components under a First Person Visible object is not supported.
Additionally, due to technical limitations, First Person Visible is not supported on Quest standalone.
Finally, the processing involved in this component is somewhat heavyweight, and may result in slower build times.
## Setting up First Person Visible
Just attach a First Person Visible component under a child of the Head bone. There are no configuration options to set.
The component will automatically generate a clone of the Head bone, which is connected to the real head bone using a parent constraint.
Only one constraint will be generated, even if multiple First Person Visible components are used. As such, the performance impact of this component is the same whether you use one or dozens.