You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The Step Multiplier is a modified version of the Room Extender where it
has the button mappings on the script itself and is placed on the
controller script.
This also means the Room Extended and subsequent classes have also been
deprecated.
@@ -2560,26 +2560,28 @@ The SetCancelButton method sets the button used to cancel a slingshot jump.
2560
2560
2561
2561
---
2562
2562
2563
-
## Room Extender (VRTK_RoomExtender)
2563
+
## Step Multiplier (VRTK_StepMultiplier)
2564
2564
2565
2565
### Overview
2566
2566
2567
2567
Multiplies each real world step within the play area to enable further distances to be travelled in the virtual world.
2568
2568
2569
-
**Script Usage:**
2570
-
* Place the `VRTK_RoomExtender` script on any active scene GameObject.
2569
+
**Optional Components:**
2570
+
* `VRTK_ControllerEvents` - The events component to listen for the button presses on. This must be applied on the same GameObject as this script if one is not provided via the `Controller Events` parameter.
2571
2571
2572
-
**Script Dependencies:**
2573
-
* The Controller Events script on the controller Script Alias to determine when the touchpad is pressed.
2572
+
**Script Usage:**
2573
+
* Place the `VRTK_StepMultiplier` script on either:
2574
+
* Any GameObject in the scene if no activation button is required.
2575
+
* The GameObject with the Controller Events scripts if an activation button is required.
2576
+
* Any other scene GameObject and provide a valid `VRTK_ControllerEvents` component to the `Controller Events` parameter of this script if an activation button is required.
2574
2577
2575
2578
### Inspector Parameters
2576
2579
2580
+
* **Activation Button:** The controller button to activate the step multiplier effect. If it is `Undefined` then the step multiplier will always be active.
2577
2581
* **Movement Function:** This determines the type of movement used by the extender.
2578
-
* **Additional Movement Enabled:** Enables the additional movement.
2579
-
* **Additional Movement Enabled On Button Press:** If this is checked then the touchpad needs to be pressed to enable it. If this is unchecked then it is disabled by pressing the touchpad.
2580
2582
* **Additional Movement Multiplier:** This is the factor by which movement at the edge of the circle is amplified. `0` is no movement of the play area. Higher values simulate a bigger play area but may be too uncomfortable.
2581
2583
* **Head Zone Radius:** This is the size of the circle in which the play area is not moved and everything is normal. If it is to low it becomes uncomfortable when crouching.
2582
-
* **Debug Transform:** This transform visualises the circle around the user where the play area is not moved. In the demo scene this is a cylinder at floor level. Remember to turn of collisions.
2584
+
* **Controller Events:** The Controller Events to listen for the events on. If the script is being applied onto a controller then this parameter can be left blank as it will be auto populated by the controller the script is on at runtime.
2583
2585
2584
2586
### Class Variables
2585
2587
@@ -2589,7 +2591,7 @@ Multiplies each real world step within the play area to enable further distances
2589
2591
2590
2592
### Example
2591
2593
2592
-
`VRTK/Examples/028_CameraRig_RoomExtender` shows how the RoomExtender script is controlled by a VRTK_RoomExtender_Controller Example script located at both controllers. Pressing the `Touchpad` on the controller activates the Room Extender. The Additional Movement Multiplier is changed based on the touch distance to the centre of the touchpad.
2594
+
`VRTK/Examples/028_CameraRig_RoomExtender` shows how the Step Multiplier can be used to move around the scene with multiplied steps.
0 commit comments