shownCompass: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - ">Posted on March ([0-9]{1})[ a-zA-Z]*, ([0-9]{4})" to ">Posted on $2-03-0$1")
 
(45 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| ofp |= Game name
|game1= ofp
|version1= 1.00


|1.00|= Game version
|game2= ofpe
____________________________________________________________________________________________
|version2= 1.00


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


| '''shownCompass''' |SYNTAX=
|game4= arma2
|version4= 1.00


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


| [[showCompass]], [[visibleCompass]], [[shownGPS]], [[shownWatch]], [[shownHUD]] |SEEALSO=
|game6= tkoh
|version6= 1.00


|game7= arma3
|version7= 0.50
|gr1= Interaction
|descr= Checks if client has Compass enabled in [[Description.ext|description.ext]] (''showCompass'' param) or force enabled with [[showCompass]] command.
|s1= '''shownCompass'''
|r1= [[Boolean]]
|x1= <sqf>if (shownCompass) then {hint "You have Compass enabled"};</sqf>
|seealso= [[showCompass]] [[visibleCompass]] [[shownGPS]] [[shownWatch]] [[shownHUD]]
}}
}}


<h3 style="display:none">Notes</h3>
 
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
<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>
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|SHOWNCOMPASS]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|SHOWNCOMPASS]]
[[Category:Scripting Commands OFP 1.46|SHOWNCOMPASS]]
[[Category:Scripting Commands ArmA|SHOWNCOMPASS]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]

Latest revision as of 23:05, 13 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).