The locomotion provider is the base class for various locomotion implementations.
this class provides simple ways to interrogate the locomotion system for whether a locomotion can begin
and simple events for hooking into a start/end locomotion.
Inheritance
LocomotionProvider
public abstract class LocomotionProvider : MonoBehaviour
Properties
The Locomotion system that this locomotion provider will communicate with for exclusive access to an XR Rig.
If one is not provided, the system will attempt to locate one during its Awake call
Declaration
public LocomotionSystem system { get; set; }
Property Value
Methods
Declaration
protected virtual void Awake()
Declaration
protected bool BeginLocomotion()
Returns
Declaration
protected bool CanBeginLocomotion()
Returns
Declaration
protected bool EndLocomotion()
Returns
Events
The endingLocomotion action will be called when a Locomotion Provider stops a locomotion event
Declaration
public event Action<LocomotionSystem> endLocomotion
Event Type
The startingLocomotion action will be called when a Locomotion Provider starts a locomotion event
Declaration
public event Action<LocomotionSystem> startLocomotion
Event Type
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.