unlockAchievement: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Some wiki formatting)
 
(43 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma2 |= Game name
|game1= arma2
|version1= 1.00


|1.00|= Game version
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


| Unlock the given achievement. |DESCRIPTION=
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| '''unlockAchievement''' name |SYNTAX=
|game4= arma3
|version4= 0.50


|p1= name: [[String]] |PARAMETER1=  
|gr1= Broken Commands


|gr2= System


| [[Boolean]] |RETURNVALUE=
|descr= Unlocks the given achievement. The achievements are listed in CfgAchievements, however none of the currently listed achievements is used in Arma 3, hence the command always returns [[false]].<br><br>


{{Feature|important|
This command is obsolete and was used in the experimental (unreleased) {{arma2}} Xbox 360 version as stated
{{Link|https://forums.bohemia.net/forums/topic/187873-unlockachievment-command/?tab{{=}}comments#comment-2978436|here}}.
}}
{{Feature|arma3|To unlock a [[Arma 3: Stat Names|Steam Achievement]] for {{arma3}}, see [[setStatValue]].}}


|x1= <code>_isUnlocked = [[unlockAchievement]] "someAchievement";</code>|EXAMPLE1=
|s1= [[unlockAchievement]] name


____________________________________________________________________________________________
|p1= name: [[String]] - achievement name


| |SEEALSO=  
|r1= [[Boolean]] - [[true]] if achievement was unlocked


| |MPBEHAVIOUR=  
|x1= <sqf>_isUnlocked = unlockAchievement "Hunter";</sqf>
____________________________________________________________________________________________
 
|seealso= [[setStatValue]]
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on February 10, 2016 - 09:06 (UTC)</dd>
<dt class="note">[[User:Harmdhast|Harmdhast]]</dt>
<dd class="note">
This is an obsolete command used in the experimental Arma 2 Xbox 360 version.
https://forums.bistudio.com/topic/187873-unlockachievment-command/
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 12:07, 5 May 2024

Hover & click on the images for description

Description

Description:
Unlocks the given achievement. The achievements are listed in CfgAchievements, however none of the currently listed achievements is used in Arma 3, hence the command always returns false.

This command is obsolete and was used in the experimental (unreleased) Arma 2 Xbox 360 version as stated here.
Arma 3
To unlock a Steam Achievement for Arma 3, see setStatValue.
Groups:
Broken CommandsSystem

Syntax

Syntax:
unlockAchievement name
Parameters:
name: String - achievement name
Return Value:
Boolean - true if achievement was unlocked

Examples

Example 1:
_isUnlocked = unlockAchievement "Hunter";

Additional Information

See also:
setStatValue

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