BIS fnc finishCuratorChallenge: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *T([a-z ])" to "$1 - t$2")
 
(32 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.16


| arma3 |= Game name
|gr1= CuratorChallenges


|1.00|= Game version
|descr= Handle repeated curator challenges.
____________________________________________________________________________________________
When rewards defined in the argument are exceeded, refilling points bar fill be offered instead. Number of challenges can be retrieved by


| <pre>/*
|s1= [curator,input,taskState]] call [[BIS_fnc_finishCuratorChallenge]]


Description:
|p1=curator [[Object]] - curator
Return number of completed curator challenges


Parameter(s):
|p2=input [[Array]] - array in format:
0: OBJECT - curator
*0: [[String]] - Challenge class name
1: ARRAY in format [<challengeClass>,<curator>]
*1: [[Object]] - Curator
2: STRING - task state


Returns:
|p3= taskState [[String]] - task state, can be:
BOOL
*"SUCCEEDED"
*/
*"FAILED"
*"CANCELED"
*"ASSIGNED"


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|r1= [[Boolean]]
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_finishCuratorChallenge]]; --> |= Syntax
|x1= <sqf>[BIS_curator,["DestroyVehicle",BIS_curator],"SUCCEEDED"] call BIS_fnc_finishCuratorChallenge;
 
_number = BIS_curator getVariable "DestroyVehicle";</sqf>
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[Arma 3: Curator]] [[BIS_fnc_formatCuratorChallengeObjects]] [[BIS_fnc_manageCuratorChallenges]] [[BIS_fnc_addCuratorChallenge]]
}}
}}
<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:Function Group: CuratorChallenges|{{uc:finishCuratorChallenge}}]]
[[Category:Functions|{{uc:finishCuratorChallenge}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:finishCuratorChallenge}}]]

Latest revision as of 16:51, 8 November 2023

Arma 3 logo black.png1.16
Hover & click on the images for description

Description

Description:
Handle repeated curator challenges. When rewards defined in the argument are exceeded, refilling points bar fill be offered instead. Number of challenges can be retrieved by
Execution:
call
Groups:
CuratorChallenges

Syntax

Syntax:
[curator,input,taskState]] call BIS_fnc_finishCuratorChallenge
Parameters:
curator Object - curator
input Array - array in format:
taskState String - task state, can be:
  • "SUCCEEDED"
  • "FAILED"
  • "CANCELED"
  • "ASSIGNED"
Return Value:
Boolean

Examples

Example 1:
[BIS_curator,["DestroyVehicle",BIS_curator],"SUCCEEDED"] call BIS_fnc_finishCuratorChallenge; _number = BIS_curator getVariable "DestroyVehicle";

Additional Information

See also:
Arma 3: Curator BIS_fnc_formatCuratorChallengeObjects BIS_fnc_manageCuratorChallenges BIS_fnc_addCuratorChallenge

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=BIS_fnc_finishCuratorChallenge&oldid=349249"