BIS fnc manageCuratorChallenges: Difference between revisions

Latest revision as of 18:16, 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.
Execution:: call
Groups:: CuratorChallenges

Syntax

Syntax:

[curator,challenges,numChallenges,rewards,defaultRewards]] call BIS_fnc_manageCuratorChallenges

Parameters:

curator Object - curator

challenges Array - (Optional, default all challenges) list of supported challenges from CfgCuratorChallenges

challenges Number - (Optional, default 3) number of added challenges

rewards Array of arrays - (Optional, default []) rewards and their descriptions in format:

0: Code - Code executed
1: String - Description

defaultRewards Array of arrays - (Optional, default []) default reward, used when previous rewards are exausted in format:

0: Code - Code executed
1: String - Description

Return Value:

Boolean

Examples

Example 1:: [BIS_curator, nil, 1, [[{ hint "Message" }, "Description"]]] call BIS_fnc_manageCuratorChallenges;

Additional Information

See also:: Arma 3: Curator BIS_fnc_formatCuratorChallengeObjects BIS_fnc_finishCuratorChallenge 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.
+	When rewards defined in the argument are exceeded, refilling points bar fill be offered instead.
-| Handle repeated curator challenges.
+|s1= [curator,challenges,numChallenges,rewards,defaultRewards]] call [[BIS_fnc_manageCuratorChallenges]]
-	When rewards defined in the argument are exceeded, refilling points bar fill be offered instead. |Description=
-| [curator,challenges,numChallenges,rewards,defaultRewards]] call [[BIS_fnc_manageCuratorChallenges]] |Syntax=
+|p1=curator [[Object]] - curator
-|p1=curator [[Object]] - Curator |Parameter 1=
+|p2=challenges [[Array]] - (Optional, default all challenges) list of supported challenges from CfgCuratorChallenges
-|p2=challenges [[Array]] - (Optional, default all challenges) List of supported challenges from CfgCuratorChallenges |Parameter 2=
+|p3=challenges [[Number]] - (Optional, default 3) number of added challenges
-|p3=challenges [[Number]] - (Optional, default 3) Number of added challenges |Parameter 3=
+|p4=rewards [[Array]] of [[Array|arrays]] - (Optional, default <sqf inline>[]</sqf>) rewards and their descriptions in format:
-|p4=rewards [[Array]] of [[Array|arrays]] - (Optional, default []) Rewards and their descriptions in format:
 *0: [[Code]] - Code executed
-*1: [[String]] - Description|Parameter 4=
+*1: [[String]] - Description
-|p5=defaultRewards [[Array]] of [[Array|arrays]] - (Optional, default []) Default reward, used when previous rewards are exausted  in format:
+|p5=defaultRewards [[Array]] of [[Array|arrays]] - (Optional, default <sqf inline>[]</sqf>) default reward, used when previous rewards are exausted  in format:
 *0: [[Code]] - Code executed
-*1: [[String]] - Description|Parameter 5=
+*1: [[String]] - Description
-| [[Boolean]] |Return value=
-|x1= <code>[ BIS_curator, nil, 1, [ [{ [[hint]] "Message" }, "Description" ] ] ] [[call]] [[BIS_fnc_manageCuratorChallenges]];</code>|Example 1=
+|r1= [[Boolean]]
+|x1= <sqf>[BIS_curator, nil, 1, [[{ hint "Message" }, "Description"]]] call BIS_fnc_manageCuratorChallenges;</sqf>
-| [[Curator]],[[BIS_fnc_formatCuratorChallengeObjects]],[[BIS_fnc_finishCuratorChallenge]],[[BIS_fnc_addCuratorChallenge]]  |See also=
+|seealso= [[Arma 3: Curator]] [[BIS_fnc_formatCuratorChallengeObjects]] [[BIS_fnc_finishCuratorChallenge]] [[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:manageCuratorChallenges}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:manageCuratorChallenges}}]]