CameraRigSettings
Since 0.6
Fields
| Field | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|
eyeHeight | number | no | 1 | Metres up from the target to the eye (first-person) or the pivot the boom swings round. Default 1.65; 0 makes the target the eye. | |
probeRadius | number | no | Radius of the sphere the boom sweeps to stay out of geometry, metres. | ||
offset | Vec3 | no | fixed only: [x, y, z] from the target, metres (a top-down or isometric follow). | ||
pitch | number | no | Starting pitch in radians; positive looks up. | ||
yaw | number | no | Starting yaw in radians about world +Y. | ||
recenterDelay | number | no | Seconds without a steer before the rig swings back behind the target. Negative turns it off. | ||
recenterSpeedDeg | number | no | 90 | How fast the recenter swing turns, degrees per second. Default 90. | |
lookAhead | number | no | Seconds of the target's travel the followed point leads by. Default 0 (off). | ||
lookAheadMax | number | no | 2 | Longest the look-ahead lead may be, metres. Default 2. | |
lookAheadRate | number | no | 3 | How quickly the lead settles, per second. Default 3. | |
fadeStart | number | no | 1 | Arm length, metres, below which the target starts to fade. Default 1; 0 is off. | |
fadeFull | number | no | 0 | Arm length, metres, at which the target is gone. Default 0.45. | |
fadeRate | number | no | 12 | How quickly the fade follows the arm, per second. Default 12. | |
recoverRate | number | no | 5 | How quickly the arm grows back once a wall clears, per second. Default 5; 0 snaps. | |
shoulder | number | no | 0 | Metres to shift the pivot sideways while a wall has the arm short. Default 0. | |
avoidWalls | boolean | no | false | Swing the yaw away from a wall shortening the arm. Default false. | |
avoidSpeedDeg | number | no | 60 | Fastest the avoid swing turns, degrees per second. Default 60. | |
avoidAngleDeg | number | no | 30 | How far either side the avoid feelers look, degrees. Default 30. | |
avoidDelay | number | no | 0 | Seconds after a steer before the avoid swing may act. Default 0.5. | |
collisionLayers | string[] | no | Layers whose colliders pull the boom in. Default: every layer whose blocksCamera is not false. |