Skip to content

FPR Exclusion

When you wear a Humanoid avatar, ChilloutVR automatically hides the head from first-person view so the head does not obstruct your view while looking around.

This component lets you take control of that behavior and show or hide entire chains of bones in first person. Useful for helmets, hats, hair, or other elements you want visible (or explicitly hidden) from the player view.

NameTypeDescription
Is ShownboolWhether the bones are shown in first person. Animatable at runtime.
If true, the bones are shown in first person.
If false, the bones are hidden in first person.
TargetTransformTransform at the root of the bone chain you want to show or hide in first person. Can be any transform in the avatar’s hierarchy; includes every child until the next FPR Exclusion component is found.
ModeboolControls hiding behavior: Shrink scales transforms to zero; Cut hides mesh vertices.

ChilloutVR automatically adds this component to the head bone on avatar load if one is not already present. You may add it manually to the head bone if you want to customize the automatic head-hiding behavior.

You can use the Portable Camera in-game to display the head-hiding behavior of your avatar:

  1. Open the Quick Menu or Main Menu.
  2. Click Portable Camera.
  3. Click Settings in the Portable Camera.
  4. Enable Expert Mode near the top of the Portable Camera settings.
  5. Enable Display FPR Exclusions near the bottom of the Portable Camera settings.
  6. Face the camera toward yourself. You should now see your avatar without the head visible.

The CCK component stores the serialized state; the actual mesh/scale manipulation is performed at runtime by an IExclusionBehaviour implementation attached by the game-side avatar setup. UpdateExclusions delegates to that behaviour, passing the current isShown and shrinkToZero flags. OnDidApplyAnimationProperties triggers an update whenever isShown changes so animators can flip visibility without calling code.

  • CVR-GameFiles/ABI.CCK.Components/FPRExclusion.cs
  • CVR-GameFiles/ABI.CCK.Components/IExclusionBehaviour.cs