Guides
These docs are for v3.2.0. Click to read the latest docs for v3.3.0.

VRTK_WarpObjectControlAction

extends VRTK_BaseObjectControlAction

Overview

The Warp Object Control Action script is used to warp the controlled GameObject a given distance when changing the axis.

The effect is a immediate snap to a new position in the given direction.

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.