BIS fnc counter: Difference between revisions

Latest revision as of 16:43, 11 April 2024

Hover & click on the images for description

Description:: Modify the given counter, create it if does not exist.
⚠
It is not possible to broadcast the counter (like setVariable does) with this function.
Execution:: call
Groups:: Systems

Syntax:: [varName, add, modulo] call BIS_fnc_counter
Parameters:: varName: String or Array format [varName, namespace] - default namespace is missionNamespace
: add: Number - (Optional, default 0) the value to be added
: modulo: Number - (Optional, default -1) the modulo to use for counter cycle, applied after the addition
Return Value:: Number the new counter value

: 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
-| tkoh
+|game1= tkoh
+|version1= 1.00
-|1.00
+|game2= arma3
+|version2= 0.50
-|gr1 = Systems
+|arg= global
+|eff= local
-| <pre>/*
+|gr1= Systems
-	Description:
+|descr= Modify the given counter, create it if does not exist.
-	Modify the given counter (create it if doesn't exist)
+{{Feature|important|It is '''not''' possible to broadcast the counter (like [[setVariable]] does) with this function.}}
-	Parameter(s):
+|s1= [varName, add, modulo] call [[BIS_fnc_counter]]
-	_this select 0:
-		STRING - variable name of counter
-		ARRAY in format [variableName,nameSpace], where nameSpace can be object, group or missionNameSpace/uiNameSpace
-	_this select 1 (Optional): NUMBER - added value
-	_this select 2 (Optional): NUMBER - modulo value
-	Returns:
+|p1= varName: [[String]] or [[Array]] format [varName, namespace] - default namespace is [[missionNamespace]]
-	NUMBER - counter's value
-*/
-{{placeholder}}
+|p2= add: [[Number]] - (Optional, default 0) the value to be added
-| <!-- [] call [[BIS_fnc_counter]]; -->
+|p3= modulo: [[Number]] - (Optional, default -1) the [[mod]]ulo to use for counter cycle, applied after the addition
-|p1=
+|r1= [[Number]] the new counter value
-|x1=
+|x1= <sqf>[["TAG_Score", player], 1] call BIS_fnc_counter;</sqf>
-| [[BIS_fnc_deleteCounter]]
+|seealso= [[BIS_fnc_deleteCounter]]
 }}
-[[Category:{{Name|tkoh}}: Functions|{{uc:counter}}]]