{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"VRTK_DashTeleport","type":"basic","slug":"vrtk_dashteleport","excerpt":"","body":"> extends [VRTK_HeightAdjustTeleport](doc:vrtk_heightadjustteleport)\n\n## Overview\n\nUpdates the `x/y/z` position of the SDK Camera Rig with a lerp to the new position creating a dash effect.\n\n**Script Usage:**\n * Place the `VRTK_DashTeleport` script on any active scene GameObject.\n\n**Script Dependencies:**\n * An optional Destination Marker (such as a Pointer) to set the destination of the teleport location.\n\n## Inspector Parameters\n\n * **Normal Lerp Time:** The fixed time it takes to dash to a new position.\n * **Min Speed Mps:** The minimum speed for dashing in meters per second.\n * **Capsule Top Offset:** The Offset of the CapsuleCast above the camera.\n * **Capsule Bottom Offset:** The Offset of the CapsuleCast below the camera.\n * **Capsule Radius:** The radius of the CapsuleCast.\n\n## Class Events\n\n * `WillDashThruObjects` - Emitted when the CapsuleCast towards the target has found that obstacles are in the way.\n * `DashedThruObjects` - Emitted when obstacles have been crossed and the dash has ended.\n\n## Unity Events\n\nAdding the `VRTK_DashTeleport_UnityEvents` component to `VRTK_DashTeleport` object allows access to `UnityEvents` that will react identically to the Class Events.\n\n * All C# delegate events are mapped to a Unity Event with the `On` prefix. e.g. `MyEvent` -> `OnMyEvent`.\n\n## Event Payload\n\n * `RaycastHit[] hits` - An array of RaycastHits that the CapsuleCast has collided with.\n\n## Example\n\n`VRTK/Examples/038_CameraRig_DashTeleport` shows how to turn off the mesh renderers of objects that are in the way during the dash.","updates":[],"order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5b1f8576c2505d00031254b0","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},"user":"571fa519db52d01700f5cf3d","project":"571fa55ca0acd42000af9545","parentDoc":null,"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:33.014Z","githubsync":"","__v":0}
> extends [VRTK_HeightAdjustTeleport](doc:vrtk_heightadjustteleport) ## Overview Updates the `x/y/z` position of the SDK Camera Rig with a lerp to the new position creating a dash effect. **Script Usage:** * Place the `VRTK_DashTeleport` script on any active scene GameObject. **Script Dependencies:** * An optional Destination Marker (such as a Pointer) to set the destination of the teleport location. ## Inspector Parameters * **Normal Lerp Time:** The fixed time it takes to dash to a new position. * **Min Speed Mps:** The minimum speed for dashing in meters per second. * **Capsule Top Offset:** The Offset of the CapsuleCast above the camera. * **Capsule Bottom Offset:** The Offset of the CapsuleCast below the camera. * **Capsule Radius:** The radius of the CapsuleCast. ## Class Events * `WillDashThruObjects` - Emitted when the CapsuleCast towards the target has found that obstacles are in the way. * `DashedThruObjects` - Emitted when obstacles have been crossed and the dash has ended. ## Unity Events Adding the `VRTK_DashTeleport_UnityEvents` component to `VRTK_DashTeleport` object allows access to `UnityEvents` that will react identically to the Class Events. * All C# delegate events are mapped to a Unity Event with the `On` prefix. e.g. `MyEvent` -> `OnMyEvent`. ## Event Payload * `RaycastHit[] hits` - An array of RaycastHits that the CapsuleCast has collided with. ## Example `VRTK/Examples/038_CameraRig_DashTeleport` shows how to turn off the mesh renderers of objects that are in the way during the dash.