Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


trueHeading

The heading in degrees relative to the geographic North Pole. (Read Only)
Read time 1 minuteLast updated 6 days ago

Definition

  • Type: Property
  • Namespace: UnityEngine
  • Assembly: UnityEngine.InputLegacyModule
public float trueHeading { get; }

Remarks

The value in this property is always measured relative to the top of the screen in its current orientation. Note, that if you want this property to contain a valid value, you must also enable location updates by calling
Input.location.Start()
. (Read Only)
Note: On the web platform this property will return the magnetic heading.

Examples

using UnityEngine;public class Example : MonoBehaviour{ void Update() { // Orient an object to point northward. transform.rotation = Quaternion.Euler(0, -Input.compass.trueHeading, 0); }}