isKeyActive: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\| arma1 \|1.00 \|([^g]|g[^a])" to "| ofpe | 1.00 |game2= arma1 |version2= 1.00 |game3= arma2 |version3= 1.00 |game4= arma2oa |version4= 1.50 |game5= tkoh |version5= 1.00 |game6= arma3 |version6= 0.50 |$1")
m (Text replacement - "\|x([0-9])= *<code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>")
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| ofpe
|game1= ofpe
| 1.00
|version1= 1.00


|game2= arma1
|game2= arma1
Line 21: Line 21:
|gr1= Mission Information
|gr1= Mission Information


| Checks whether the given key is active in the current user profile.
|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.
See keys, keysLimit and doneKeys in the [[Description.ext#keys|description.ext]] file of the missions.


| '''isKeyActive''' keyName
|s1= [[isKeyActive]] keyName


|p1= keyName: [[String]]
|p1= keyName: [[String]]


|r1=[[Boolean]]
|r1= [[Boolean]]


|x1= <code>_active = [[isKeyActive]] "Mission04Key";</code>
|x1= <sqf>_active = isKeyActive "Mission04Key";</sqf>


|seealso= [[activateKey]], [[deActivateKey]]
|seealso= [[activateKey]] [[deActivateKey]]
}}
}}
{{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"