Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


magneticHeading

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

Definition

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

Remarks

The value in this property is always measured relative to the top of the screen in its current orientation. The heading of magnetic north is not exactly the same as true geographical north - to get the exact heading, use the Compass.trueHeading property.

Examples

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