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: @@
+{{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.
-| <pre>/*
+|s1= [curator,challenges,numChallenges,rewards,defaultRewards]] call [[BIS_fnc_manageCuratorChallenges]]
-	Description:
-	Handle repeated curator challenges.
-	When rewards defined in the argument are exceeded, refilling points bar fill be offered instead.
-	Parameter(s):
+|p1=curator [[Object]] - curator
-: OBJECT - curator
-(Optional): ARRAY - list of supported challenges from CfgCuratorChallenges (default: all challenges)
-(Optional): NUMBER - number of added challenges (default: 3)
-(Optional): ARRAY of ARRAYs in format [<code>,<description>] - rewards and their descriptions
-(Optional): ARRAY of ARRAYs in format [<code>,<description>] - default reward (used when previous rewards are exhausted)
-	Returns:
-	BOOL
-*/
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
+|p2=challenges [[Array]] - (Optional, default all challenges) list of supported challenges from CfgCuratorChallenges
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_manageCuratorChallenges]]; --> |= Syntax
+|p3=challenges [[Number]] - (Optional, default 3) number of added challenges
-|p1= |= Parameter 1
+|p4=rewards [[Array]] of [[Array|arrays]] - (Optional, default <sqf inline>[]</sqf>) rewards and their descriptions in format:
+*0: [[Code]] - Code executed
+*1: [[String]] - Description
-| |= Return value
+|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
-|x1= <code></code> |=
+|r1= [[Boolean]]
-____________________________________________________________________________________________
-| |= See also
+|x1= <sqf>[BIS_curator, nil, 1, [[{ hint "Message" }, "Description"]]] call BIS_fnc_manageCuratorChallenges;</sqf>
+|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:Function Group: CuratorChallenges|{{uc:manageCuratorChallenges}}]]
-[[Category:Functions|{{uc:manageCuratorChallenges}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:manageCuratorChallenges}}]]