BIS fnc finishCuratorChallenge: Difference between revisions

Latest revision as of 15:51, 8 November 2023

1.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:

0: String - Challenge class name
1: Object - Curator

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

@@ Line 1: / Line 1: @@
-{{Function|Comments=
+{{RV|type=function
-____________________________________________________________________________________________
-| arma3 |Game name=
+|game1= arma3
+|version1= 1.16
-|1.16|Game version=
+|gr1= CuratorChallenges
-|gr1 = CuratorChallenges |GROUP1=
+|descr= Handle repeated curator challenges.
-____________________________________________________________________________________________
-| 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
- |Description=
-____________________________________________________________________________________________
-| [curator,input,taskState]] call [[BIS_fnc_finishCuratorChallenge]] |Syntax=
+|s1= [curator,input,taskState]] call [[BIS_fnc_finishCuratorChallenge]]
-|p1=curator [[Object]] - Curator |Parameter 1=
+|p1=curator [[Object]] - curator
-|p2=input [[Array]] - Array in format:
+|p2=input [[Array]] - array in format:
 *0: [[String]] - Challenge class name
-*1: [[Object]] - Curator  |Parameter 2=
+*1: [[Object]] - Curator
-|p3= taskState [[String]] - Task state, can be:
+|p3= taskState [[String]] - task state, can be:
 *"SUCCEEDED"
 *"FAILED"
 *"CANCELED"
-*"ASSIGNED" |Parameter 3=
+*"ASSIGNED"
-| [[Boolean]] |Return value=
-____________________________________________________________________________________________
-|x1= <code>[BIS_curator,["DestroyVehicle",BIS_curator],"SUCCEEDED"] [[call]] [[BIS_fnc_finishCuratorChallenge]];
+|r1= [[Boolean]]
-_number = BIS_curator [[getVariable]] "DestroyVehicle";</code>
- |Example 1=
-____________________________________________________________________________________________
+|x1= <sqf>[BIS_curator,["DestroyVehicle",BIS_curator],"SUCCEEDED"] call BIS_fnc_finishCuratorChallenge;
+_number = BIS_curator getVariable "DestroyVehicle";</sqf>
-| [[Curator]],[[BIS_fnc_formatCuratorChallengeObjects]],[[BIS_fnc_manageCuratorChallenges]],[[BIS_fnc_addCuratorChallenge]]  |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:Functions|{{uc:finishCuratorChallenge}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:finishCuratorChallenge}}]]