{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"VRTK_TeleportDisableOnHeadsetCollision","type":"basic","slug":"vrtk_teleportdisableonheadsetcollision","excerpt":"","body":"## Overview\n\nPrevents teleportation when the HMD is colliding with valid geometry.\n\n**Required Components:**\n * `VRTK_BasicTeleport` - A Teleport script to utilise for teleporting the play area.\n * `VRTK_HeadsetCollision` - A Headset Collision script for detecting when the headset has collided with valid geometry.\n\n**Script Usage:**\n * Place the `VRTK_TeleportDisableOnHeadsetCollision` script on any active scene GameObject.\n\n## Inspector Parameters\n\n * **Teleporter:** The Teleporter script to deal play area teleporting. If the script is being applied onto an object that already has a VRTK_BasicTeleport component, this parameter can be left blank as it will be auto populated by the script at runtime.\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.","updates":[],"order":4,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5b1f8576c2505d00031254b1","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Locomotion","slug":"locomotion","order":4,"from_sync":false,"reference":false,"_id":"5b1f8576c2505d0003125428","version":"5b1f8576c2505d00031254db","project":"571fa55ca0acd42000af9545","createdAt":"2017-01-01T16:41:26.797Z","__v":0},"parentDoc":null,"project":"571fa55ca0acd42000af9545","user":"571fa519db52d01700f5cf3d","version":{"version":"3.3.0","version_clean":"3.3.0","codename":"Mangalica","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"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"],"_id":"5b1f8576c2505d00031254db","project":"571fa55ca0acd42000af9545","__v":4,"forked_from":"594949e52be16d0026ec04cd","createdAt":"2017-06-20T16:14:29.816Z","releaseDate":"2017-06-20T16:14:29.816Z"},"createdAt":"2017-01-01T16:43:47.497Z","githubsync":"","__v":0}

VRTK_TeleportDisableOnHeadsetCollision


## Overview Prevents teleportation when the HMD is colliding with valid geometry. **Required Components:** * `VRTK_BasicTeleport` - A Teleport script to utilise for teleporting the play area. * `VRTK_HeadsetCollision` - A Headset Collision script for detecting when the headset has collided with valid geometry. **Script Usage:** * Place the `VRTK_TeleportDisableOnHeadsetCollision` script on any active scene GameObject. ## Inspector Parameters * **Teleporter:** The Teleporter script to deal play area teleporting. If the script is being applied onto an object that already has a VRTK_BasicTeleport component, this parameter can be left blank as it will be auto populated by the script at runtime. * **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.