{"_id":"5b1f8576c2505d0003125447","category":{"_id":"5b1f8576c2505d000312542e","version":"5b1f8576c2505d00031254db","project":"571fa55ca0acd42000af9545","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-01-01T16:58:11.374Z","from_sync":false,"order":11,"slug":"presence","title":"Presence"},"project":"571fa55ca0acd42000af9545","parentDoc":null,"user":"571fa519db52d01700f5cf3d","version":{"_id":"5b1f8576c2505d00031254db","project":"571fa55ca0acd42000af9545","__v":4,"forked_from":"594949e52be16d0026ec04cd","createdAt":"2017-06-20T16:14:29.816Z","releaseDate":"2017-06-20T16:14:29.816Z","categories":["5b1f8576c2505d0003125424","5b1f8576c2505d0003125425","5b1f8576c2505d0003125426","5b1f8576c2505d0003125427","5b1f8576c2505d0003125428","5b1f8576c2505d0003125429","5b1f8576c2505d000312542a","5b1f8576c2505d000312542b","5b1f8576c2505d000312542c","5b1f8576c2505d000312542d","5b1f8576c2505d000312542e","5b1f8576c2505d000312542f","5b1f8576c2505d0003125430","5b1f8576c2505d0003125431","5b1f8576c2505d0003125432","5b1f8576c2505d0003125433","5b1f8576c2505d0003125434","5b1f8576c2505d0003125435","5b1f8576c2505d0003125436","5b1f8576c2505d0003125437","5b1f8576c2505d0003125438","5b1f8aab9c683000032979e7","5b1f8b2f3073470003ffa5da","5b1f8bd9fd653400031d94f4","5b1f900bd4c5f000036b57bd"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Mangalica","version_clean":"3.3.0","version":"3.3.0"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-01-01T16:58:49.335Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"## Overview\n\nInitiates a fade of the headset view when a headset collision event is detected.\n\n**Required Components:**\n * `VRTK_HeadsetCollision` - A Headset Collision script to determine when the HMD has collided with valid geometry.\n * `VRTK_HeadsetFade` - A Headset Fade script to alter the visible colour on the HMD view.\n\n**Script Usage:**\n * Place the `VRTK_HeadsetCollisionFade` script on any active scene GameObject.\n\n## Inspector Parameters\n\n * **Time Till Fade:** The amount of time to wait until a fade occurs.\n * **Blink Transition Speed:** The fade blink speed on collision.\n * **Fade Color:** The colour to fade the headset to on collision.\n * **Target List Policy:** A specified VRTK_PolicyList to use to determine whether any objects will be acted upon by the Headset Collision Fade.\n * **Headset Collision:** The VRTK Headset Collision script to use when determining headset collisions. If this is left blank then the script will need to be applied to the same GameObject.\n * **Headset Fade:** The VRTK Headset Fade script to use when fading the headset. If this is left blank then the script will need to be applied to the same GameObject.\n\n## Example\n\n`VRTK/Examples/011_Camera_HeadSetCollisionFading` has collidable walls around the play area and if the user puts their head into any of the walls then the headset will fade to black.","excerpt":"","slug":"vrtk_headsetcollisionfade","type":"basic","title":"VRTK_HeadsetCollisionFade"}

VRTK_HeadsetCollisionFade


## Overview Initiates a fade of the headset view when a headset collision event is detected. **Required Components:** * `VRTK_HeadsetCollision` - A Headset Collision script to determine when the HMD has collided with valid geometry. * `VRTK_HeadsetFade` - A Headset Fade script to alter the visible colour on the HMD view. **Script Usage:** * Place the `VRTK_HeadsetCollisionFade` script on any active scene GameObject. ## Inspector Parameters * **Time Till Fade:** The amount of time to wait until a fade occurs. * **Blink Transition Speed:** The fade blink speed on collision. * **Fade Color:** The colour to fade the headset to on collision. * **Target List Policy:** A specified VRTK_PolicyList to use to determine whether any objects will be acted upon by the Headset Collision Fade. * **Headset Collision:** The VRTK Headset Collision script to use when determining headset collisions. If this is left blank then the script will need to be applied to the same GameObject. * **Headset Fade:** The VRTK Headset Fade script to use when fading the headset. If this is left blank then the script will need to be applied to the same GameObject. ## Example `VRTK/Examples/011_Camera_HeadSetCollisionFading` has collidable walls around the play area and if the user puts their head into any of the walls then the headset will fade to black.