isKeyActive: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]OFP[ _]Elite *(\|.*)?\]\]" to "{{GameCategory|ofpe|Scripting Commands}}")
m (Text replacement - "\|x([0-9])= *<code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>")
 
(21 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma1 |Game name=
|game1= ofpe
|version1= 1.00


|1.00|Game version=
|game2= arma1
|version2= 1.00


|gr1= Mission Information |GROUP1=
|game3= arma2
____________________________________________________________________________________________
|version3= 1.00


| Checks whether the given key is active in the current user profile.
|game4= arma2oa
|version4= 1.50


See keys, keysLimit and doneKeys in the [[Description.ext#keys|description.ext]] file of the missions. |DESCRIPTION=
|game5= tkoh
____________________________________________________________________________________________
|version5= 1.00


| '''isKeyActive''' keyName |SYNTAX=
|game6= arma3
|version6= 0.50


|p1= keyName: [[String]] |PARAMETER1=
|gr1= Mission Information


| [[Boolean]] |RETURNVALUE=
|descr= Checks whether the given key is active in the current user profile.
____________________________________________________________________________________________
 
|x1= <code>_active = [[isKeyActive]] "Mission04Key";</code> |EXAMPLE1=
____________________________________________________________________________________________


| [[activateKey]], [[deActivateKey]] |SEEALSO=
See keys, keysLimit and doneKeys in the [[Description.ext#keys|description.ext]] file of the missions.


}}
|s1= [[isKeyActive]] keyName
 
|p1= keyName: [[String]]


<h3 style="display:none">Notes</h3>
|r1= [[Boolean]]
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x1= <sqf>_active = isKeyActive "Mission04Key";</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[activateKey]] [[deActivateKey]]
[[Category:Scripting Commands|ISKEYACTIVE]]
}}
{{GameCategory|ofpe|Scripting Commands}}
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 10:23, 13 May 2022

ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Checks whether the given key is active in the current user profile. See keys, keysLimit and doneKeys in the description.ext file of the missions.
Groups:
Mission Information

Syntax

Syntax:
isKeyActive keyName
Parameters:
keyName: String
Return Value:
Boolean

Examples

Example 1:
_active = isKeyActive "Mission04Key";

Additional Information

See also:
activateKey deActivateKey

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
Retrieved from "https://community.bistudio.com/wiki?title=isKeyActive&oldid=319058"