Difference between revisions of "BIS fnc spawnOrdered"

From Bohemia Interactive Community
Jump to navigation Jump to search
(added page)
 
m (page formatting)
Line 1: Line 1:
{{Function|= Comments
+
{{Function
  
| arma3 |Game name=
+
|game1= arma3
  
|1.95|Game version=
+
|version1= 1.95
  
<!---|arg= local |Multiplayer Arguments=--->
+
<!--|serverExec= server-->
  
<!---|eff= local |Multiplayer Effects=--->
+
<!--|arg= local-->
  
| <pre>/*
+
<!--|eff= local-->
Author:
 
Killzone_Kid
 
  
Description:
+
|descr= Spawns given function and executes it in the order it was called in case multiple calls are made. If mutex name is not specified, function name is used.
Spawns given function and executes it in the order it was called in case multiple calls are made.
 
If mutex name is not specified, function name is used.
 
  
Parameter(s):
+
|s1= [params, functionName, mutexName] call [[BIS_fnc_spawnOrdered]]
0: ANYTHING - function params
 
1: STRING - function name in current namespace
 
2: STRING (Optional) - mutex name
 
  
Returns:
+
|p1= params: [[Anything]] - Function params
BOOLEAN - false if function name is empty, otherwise true
 
 
Example:
 
myFnc = { diag_log [_this, canSuspend] };
 
for "_i" from 0 to 1000 do { [_i, "myFnc"] call BIS_fnc_spawnOrdered };
 
*/</pre>{{Informative|Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]]}} |Description=
 
  
|[] call [[BIS_fnc_spawnOrdered]]|Syntax=
+
|p2= functionName: [[String]] - Function name in current namespace
  
|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
+
|p3= mutexName: [[String]] - (Optional, default "") This is a reference to group of spawns
  
|Datatype - description|Return value=
+
|r1= [[Boolean]] - Returns [[false]] if function name is empty, otherwise [[true]]
  
|x1= <code></code>|Example 1=
+
|x1= <code>myFnc = { [[diag_log]] [_this, [[canSuspend]]] };
 +
[[for]] "_i" [[from]] 0 [[to]] 1000 [[do]] { [_i, "myFnc"] [[call]] [[BIS_fnc_spawnOrdered]] };</code>
  
|exec= call |Execution=
+
|exec= call
 +
 
 +
|seealso= [[spawn]]
  
| |See also=
 
 
}}
 
}}
 
[[Category:Function Group: MP|{{uc:spawnOrdered}}]]
 
[[Category:Functions|{{uc:spawnOrdered}}]]
 
[[Category:{{Name|arma3}}: Functions|{{uc:spawnOrdered}}]]
 

Revision as of 11:40, 20 May 2020

Hover & click on the images for description

Description

Description:
Spawns given function and executes it in the order it was called in case multiple calls are made. If mutex name is not specified, function name is used.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[params, functionName, mutexName] call BIS_fnc_spawnOrdered
Parameters:
params: Anything - Function params
functionName: String - Function name in current namespace
mutexName: String - (Optional, default "") This is a reference to group of spawns
Return Value:
Boolean - Returns false if function name is empty, otherwise true

Examples

Example 1:
myFnc = { diag_log [_this, canSuspend] }; for "_i" from 0 to 1000 do { [_i, "myFnc"] call BIS_fnc_spawnOrdered };

Additional Information

See also:
spawn

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