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 - "_{10,} " to "")
Line 1: Line 1:
{{Command|Comments=
{{Command|Comments=
____________________________________________________________________________________________


| arma1 |Game name=
| arma1 |Game name=
Line 7: Line 6:


|gr1= Mission Information |GROUP1=
|gr1= Mission Information |GROUP1=
____________________________________________________________________________________________


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


| '''isKeyActive''' keyName |SYNTAX=
| '''isKeyActive''' keyName |SYNTAX=
Line 19: Line 16:


| [[Boolean]] |RETURNVALUE=
| [[Boolean]] |RETURNVALUE=
____________________________________________________________________________________________
   
   
|x1= <code>_active = [[isKeyActive]] "Mission04Key";</code> |EXAMPLE1=
|x1= <code>_active = [[isKeyActive]] "Mission04Key";</code> |EXAMPLE1=
____________________________________________________________________________________________


| [[activateKey]], [[deActivateKey]] |SEEALSO=
| [[activateKey]], [[deActivateKey]] |SEEALSO=

Revision as of 02:36, 17 January 2021

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:
activateKeydeActivateKey

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

Notes

Bottom Section