shownCompass: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Command|Comments=
{{Command|Comments=
____________________________________________________________________________________________


| ofp |Game name=
| ofp |Game name=
Line 7: Line 6:


|gr1= Interaction |GROUP1=
|gr1= Interaction |GROUP1=
____________________________________________________________________________________________


| Checks if client has Compass enabled in [[description.ext]] (''showCompass'' param) or force enabled with [[showCompass]] command. |DESCRIPTION=
| Checks if client has Compass enabled in [[description.ext]] (''showCompass'' param) or force enabled with [[showCompass]] command. |DESCRIPTION=
____________________________________________________________________________________________


| '''shownCompass''' |SYNTAX=
| '''shownCompass''' |SYNTAX=


| [[Boolean]] |RETURNVALUE=
| [[Boolean]] |RETURNVALUE=
____________________________________________________________________________________________
   
   
|x1= <code>[[if]] ([[shownCompass]]) [[then]] {[[hint]] "You have Compass enabled"};</code> |EXAMPLE1=
|x1= <code>[[if]] ([[shownCompass]]) [[then]] {[[hint]] "You have Compass enabled"};</code> |EXAMPLE1=
____________________________________________________________________________________________


| [[showCompass]], [[visibleCompass]], [[shownGPS]], [[shownWatch]], [[shownHUD]] |SEEALSO=
| [[showCompass]], [[visibleCompass]], [[shownGPS]], [[shownWatch]], [[shownHUD]] |SEEALSO=

Revision as of 03:59, 17 January 2021

Hover & click on the images for description

Description

Description:
Checks if client has Compass enabled in description.ext (showCompass param) or force enabled with showCompass command.
Groups:
Interaction

Syntax

Syntax:
shownCompass
Return Value:
Boolean

Examples

Example 1:
if (shownCompass) then {hint "You have Compass enabled"};

Additional Information

See also:
showCompassvisibleCompassshownGPSshownWatchshownHUD

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

Notes

Bottom Section

Posted on March 9, 2020 - 08:12 (UTC)
POLPOX
Even if you're aiming down a sight (which is usually you can't open the compass), shownCompass returns true if you press the compass key (K).