Legacy Documentation: Version 4.6(go to latest)
Language: English
  • C#
  • JS
  • Boo

Script language

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

Compass

Namespace: UnityEngine

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Interface into compass functionality.

Variables

enabled Used to enable or disable compass. Note, that if you want Input.compass.trueHeading property to contain a valid value, you must also enable location updates by calling Input.location.Start().
headingAccuracy Accuracy of heading reading in degrees.
magneticHeading The heading in degrees relative to the magnetic North Pole. (Read Only)
rawVector The raw geomagnetic data measured in microteslas. (Read Only)
timestamp Timestamp (in seconds since 1970) when the heading was last time updated. (Read Only)
trueHeading The heading in degrees relative to the geographic North Pole. (Read Only)
Copyright © 2014 Unity Technologies
LearnCommunityAsset StoreBuyDownload