isKeyActive: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "\|x([0-9])= *<code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>")
 
(57 intermediate revisions by 10 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|I]]
{{RV|type=command
[[Category:Scripting Commands OFP Elite |I]]
[[Category:Scripting Commands ArmA|I]]


<new command not populated>
|game1= ofpe
|version1= 1.00


|game2= arma1
|version2= 1.00


<h2 style="color:#000066">''''' isKeyActive '''''</h2>
|game3= arma2
|version3= 1.00


|game4= arma2oa
|version4= 1.50


'''Operand types:'''
|game5= tkoh
|version5= 1.00


'''Type of returned value:'''
|game6= arma3
|version6= 0.50


'''Compatibility:'''
|gr1= Mission Information


'''Description:'''
|descr= Checks whether the given key is active in the current user profile.


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


'''Example:'''
|s1= [[isKeyActive]] keyName
 
|p1= keyName: [[String]]
 
|r1= [[Boolean]]
 
|x1= <sqf>_active = isKeyActive "Mission04Key";</sqf>
 
|seealso= [[activateKey]] [[deActivateKey]]
}}

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"