Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Compass.trueHeading

var trueHeading: float;
float trueHeading;
trueHeading as float

Description

The heading in degrees relative to the geographic North Pole. (Read Only)

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)

function Update() {
		// Orient an object to point northward.
		transform.rotation = Quaternion.Euler(0, -Input.compass.trueHeading, 0);
	}