{"_id":"5b1f8576c2505d0003125443","category":{"_id":"5b1f8576c2505d0003125429","version":"5b1f8576c2505d00031254db","project":"571fa55ca0acd42000af9545","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-02-25T10:16:15.006Z","from_sync":false,"order":5,"slug":"object-control-actions","title":"Object Control Actions"},"user":"571fa519db52d01700f5cf3d","project":"571fa55ca0acd42000af9545","parentDoc":null,"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-02-25T10:18:09.389Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":5,"body":"> extends [VRTK_BaseObjectControlAction](doc:vrtk_baseobjectcontrolaction)\n\n## Overview\n\nProvides the ability to move a GameObject around by warping it across the `x/z` plane in the scene by updating the Transform position in defined steps when the corresponding Object Control axis changes.\n\n  > The effect is a immediate snap to a new position in the given direction.\n\n**Required Components:**\n * `VRTK_ObjectControl` - The Object Control script to listen for the axis changes on.\n\n**Optional Components:**\n * `VRTK_BodyPhysics` - The Body Physics script to utilise when checking for potential collisions on movement.\n\n**Script Usage:**\n * Place the `VRTK_WarpObjectControlAction` script on any active scene GameObject.\n * Link the required Object Control script to the `Object Control Script` parameter of this script.\n * Set the `Listen On Axis Change` parameter on this script to the axis change to affect with this movement type.\n\n## Inspector Parameters\n\n * **Warp Distance:** The distance to warp in the facing direction.\n * **Warp Multiplier:** The multiplier to be applied to the warp when the modifier button is pressed.\n * **Warp Delay:** The amount of time required to pass before another warp can be carried out.\n * **Floor Height Tolerance:** The height different in floor allowed to be a valid warp.\n * **Blink Transition Speed:** The speed for the headset to fade out and back in. Having a blink between warps can reduce nausia.\n * **Body Physics:** An optional Body Physics script to check for potential collisions in the moving direction. If any potential collision is found then the move will not take place. This can help reduce collision tunnelling.\n\n## Example\n\n`VRTK/Examples/017_CameraRig_TouchpadWalking` has a collection of walls and slopes that can be traversed by the user with the touchpad. There is also an area that can only be traversed if the user is crouching.\n\nTo enable the Warp Object Control Action, ensure one of the `TouchpadControlOptions` children (located under the Controller script alias) has the `Warp` control script active.","excerpt":"","slug":"vrtk_warpobjectcontrolaction","type":"basic","title":"VRTK_WarpObjectControlAction"}

VRTK_WarpObjectControlAction


> extends [VRTK_BaseObjectControlAction](doc:vrtk_baseobjectcontrolaction) ## Overview Provides the ability to move a GameObject around by warping it across the `x/z` plane in the scene by updating the Transform position in defined steps when the corresponding Object Control axis changes. > The effect is a immediate snap to a new position in the given direction. **Required Components:** * `VRTK_ObjectControl` - The Object Control script to listen for the axis changes on. **Optional Components:** * `VRTK_BodyPhysics` - The Body Physics script to utilise when checking for potential collisions on movement. **Script Usage:** * Place the `VRTK_WarpObjectControlAction` script on any active scene GameObject. * Link the required Object Control script to the `Object Control Script` parameter of this script. * Set the `Listen On Axis Change` parameter on this script to the axis change to affect with this movement type. ## Inspector Parameters * **Warp Distance:** The distance to warp in the facing direction. * **Warp Multiplier:** The multiplier to be applied to the warp when the modifier button is pressed. * **Warp Delay:** The amount of time required to pass before another warp can be carried out. * **Floor Height Tolerance:** The height different in floor allowed to be a valid warp. * **Blink Transition Speed:** The speed for the headset to fade out and back in. Having a blink between warps can reduce nausia. * **Body Physics:** An optional Body Physics script to check for potential collisions in the moving direction. If any potential collision is found then the move will not take place. This can help reduce collision tunnelling. ## Example `VRTK/Examples/017_CameraRig_TouchpadWalking` has a collection of walls and slopes that can be traversed by the user with the touchpad. There is also an area that can only be traversed if the user is crouching. To enable the Warp Object Control Action, ensure one of the `TouchpadControlOptions` children (located under the Controller script alias) has the `Warp` control script active.