Class GravityProvider

Locomotion provider that provides gravity to the player. This provider will also check if the player is grounded using a sphere cast from the player's head. Gravity will be applied to the player anytime useGravity is true and isGrounded is false. See IGravityController for external control over gravity.

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
LocomotionProvider
GravityProvider
Inherited Members
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Namespace: UnityEngine.XR.Interaction.Toolkit.Locomotion.Gravity
Assembly: Unity.XR.Interaction.Toolkit.dll
Syntax
[AddComponentMenu("XR/Locomotion/Gravity Provider", 11)]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@3.2/api/UnityEngine.XR.Interaction.Toolkit.Locomotion.Gravity.GravityProvider.html")]
[DefaultExecutionOrder(-207)]
public class GravityProvider : LocomotionProvider

Properties

gravityAccelerationModifier

Determines the speed at which a player reaches max gravity velocity.

Declaration
public float gravityAccelerationModifier { get; set; }
Property Value
Type Description
float

gravityControllers

(Read Only) The gravity controllers that can pause gravity.

Declaration
public List<IGravityController> gravityControllers { get; }
Property Value
Type Description
List<IGravityController>
Remarks

Automatically populated during Awake() with all components under the LocomotionMediator that implement the interface.

isGrounded

If the player is on the ground.

Declaration
public bool isGrounded { get; }
Property Value
Type Description
bool
See Also

onGravityLockChanged

Event that is called when gravity lock is changed.

Declaration
public UnityEvent<GravityOverride> onGravityLockChanged { get; set; }
Property Value
Type Description
UnityEvent<GravityOverride>

onGroundedChanged

Callback for anytime the grounded state changes.

Declaration
public UnityEvent<bool> onGroundedChanged { get; }
Property Value
Type Description
UnityEvent<bool>
See Also

sphereCastDistanceBuffer

Buffer for the distance of the sphere cast used to check if the player is grounded.

Declaration
public float sphereCastDistanceBuffer { get; set; }
Property Value
Type Description
float

sphereCastLayerMask

The layer mask used for the sphere cast to check if the player is grounded.

Declaration
public LayerMask sphereCastLayerMask { get; set; }
Property Value
Type Description
LayerMask

sphereCastRadius

Buffer for the radius of the sphere cast used to check if the player is grounded.

Declaration
public float sphereCastRadius { get; set; }
Property Value
Type Description
float

sphereCastTriggerInteraction

Whether trigger colliders are considered when using a sphere cast to determine if grounded.

Declaration
public QueryTriggerInteraction sphereCastTriggerInteraction { get; set; }
Property Value
Type Description
QueryTriggerInteraction
Remarks

When set to UseGlobal, the value of Queries Hit Triggers (queriesHitTriggers) in Edit > Project Settings > Physics will be used.

terminalVelocity

Determines the maximum fall speed based on units per second.

Declaration
public float terminalVelocity { get; set; }
Property Value
Type Description
float

transformation

The transformation that is used by this component to apply translation movement.

Declaration
public XROriginMovement transformation { get; set; }
Property Value
Type Description
XROriginMovement

updateCharacterControllerCenterEachFrame

Sets the center of the character controller to match the local x and z positions of the player camera.

Declaration
public bool updateCharacterControllerCenterEachFrame { get; set; }
Property Value
Type Description
bool

useGravity

Apply gravity to the XR Origin.

Declaration
public bool useGravity { get; set; }
Property Value
Type Description
bool

useLocalSpaceGravity

Apply gravity based on the current Up vector of the XR Origin.

Declaration
public bool useLocalSpaceGravity { get; set; }
Property Value
Type Description
bool

Methods

Awake()

See MonoBehaviour.

Declaration
protected override void Awake()
Overrides

GetCurrentUp()

Gets the current up direction based on useLocalSpaceGravity. This value is normalized.

Declaration
public Vector3 GetCurrentUp()
Returns
Type Description
Vector3

Returns -Physics.gravity.normalized or the up of the XR Origin.

IsGravityBlocked()

Checks if gravity is blocked by any of the following conditions:

  1. If gravity is not being used.
  2. If the player is grounded.
  3. If any provider is forcing gravity off.
  4. If any provider is pausing gravity while no provider is forcing gravity on.
Declaration
public bool IsGravityBlocked()
Returns
Type Description
bool

Returns true if gravity is blocked for any reason.

OnDrawGizmosSelected()

Unity calls this when drawing gizmos while the object is selected.

Declaration
protected void OnDrawGizmosSelected()

ResetFallForce()

Resets the fall force to zero.

Declaration
public void ResetFallForce()

Start()

MonoBehaviour

Declaration
protected virtual void Start()

TryLockGravity(IGravityController, GravityOverride)

Locks gravity for the provider based on gravityOverride.

Declaration
public bool TryLockGravity(IGravityController provider, GravityOverride gravityOverride)
Parameters
Type Name Description
IGravityController provider

The provider requesting the lock.
GravityOverride gravityOverride

Determines the type of lock used.
Returns
Type Description
bool

Returns true if the provider is not already being locked.
Remarks

This adds the provider to the internal lists keeping track of the locomotion providers that have forced gravity on or off.

See Also

TryProcessGravity(float)

Updates current fall velocity if gravity is not currently blocked.

Declaration
protected virtual bool TryProcessGravity(float time)
Parameters
Type Name Description
float time

By default, this uses deltaTime as it's called from Update().
Returns
Type Description
bool

Returns true if IsGravityBlocked() is false.

UnlockGravity(IGravityController)

Unlock gravity for the provider.

Declaration
public void UnlockGravity(IGravityController provider)
Parameters
Type Name Description
IGravityController provider

The provider to unlock.
Remarks

Removes the provider from the internal lists keeping track of the locomotion providers that have forced gravity on or off.

See Also

Update()

MonoBehaviour

Declaration
protected virtual void Update()