shownCompass: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - ">Posted on March ([0-9]{1})[ a-zA-Z]*, ([0-9]{4})" to ">Posted on $2-03-0$1")
 
(69 intermediate revisions by 12 users not shown)
Line 1: Line 1:
back to [[Scripting_Reference#S|COMREF]]
{{RV|type=command


<h2 style="color:#000066">'''shownCompass'''</h2>
|game1= ofp
|version1= 1.00


|game2= ofpe
|version2= 1.00


'''Operand types:'''
|game3= arma1
|version3= 1.00


None.
|game4= arma2
|version4= 1.00


'''Type of returned value:'''
|game5= arma2oa
|version5= 1.50


[[Boolean]]
|game6= tkoh
|version6= 1.00


'''Description:'''
|game7= arma3
|version7= 0.50


Check if player has compass enabled.
|gr1= Interaction


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


'''Example:'''
|s1= '''shownCompass'''


? '''showncompass''' : [[hint]] "You have a compass."
|r1= [[Boolean]]
 
|x1= <sqf>if (shownCompass) then {hint "You have Compass enabled"};</sqf>
 
|seealso= [[showCompass]] [[visibleCompass]] [[shownGPS]] [[shownWatch]] [[shownHUD]]
}}
 
 
<dl class="command_description">
 
<dt></dt>
<dd class="notedate">Posted on 2020-03-09 - 08:12 (UTC)</dd>
<dt class="note">[[User:POLPOX|POLPOX]]</dt>
<dd class="note">
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).
</dd>
 
</dl>

Latest revision as of 00:05, 14 May 2023

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:
showCompass visibleCompass shownGPS shownWatch shownHUD

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


Posted on 2020-03-09 - 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).