BIS fnc MP: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Created page with "{{Function|= Comments ____________________________________________________________________________________________ | TKOH |= Game name |1.00|= Game version ____________________...")
Line 1: Line 1:
{{Function|= Comments
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________


| tkoh |= Game name
| TKOH |= Game name


|1.00|= Game version
|1.00|= Game version
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Send function for remote execution (and executes locally if conditions are met) . |= Description
____________________________________________________________________________________________


Description:
| [params, functionName, target, isSpawn, isPersistent] spawn BIS_fnc_MP; |= Syntax
Send function for remote execution (and executes locally if conditions are met)


Parameter(s):
|p1= '''params''': [[Anything]] - function params |=
0: ANY - function params
|p2= '''functionName''': [[String]] - function name |=
1: STRING - function name
|p3= '''target''': [[Object]] - function will be executed only where unit is local [default: everyone] |=
2 (Optional):
|p4= '''isSpawn''': [[Boolean]] - true for calling function using 'spawn' command (otherwise 'call' is used) [default: false] |=
BOOL - true to execute on each machine (including the one where the function was called from), false to execute it on server only [default: true]
|p5= '''isPersistent''': [[Boolean]] - true for persistent call (will be called now and for every JIP client) [default: false] |=
STRING - the function will be executed only where unit defined by the variable is local
OBJECT - the function will be executed only where unit is local
GROUP - the function will be executed only on client who is member of the group
SIDE - the function will be executed on all players of the given side
NUMBER - the function will be executed only on client with the given ID
ARRAY - array of previous data types
3 (Optional): BOOL - true for persistent call (will be called now and for every JIP client) [default: false]
Returns:
ARRAY - sent packet
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
| [[Array]] - sent packet |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________
 
|x1= <code><nowiki>[</nowiki>"Imma spamming your log!","[[BIS_fnc_log]]"] spawn BIS_fnc_MP;</code>
Logs a message for every player who's currently joined.|=


| <!-- [] call [[BIS_fnc_MP]]; --> |= Syntax
|x2= <code><nowiki>[</nowiki>["Hello World"],"[[BIS_fnc_guiMessage]]",nil,true,true] spawn BIS_fnc_MP;</code>
 
Send a message containing "Hello World" to every player, including the ones who joins later using JIP.|=
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=  
|exec= spawn |=
____________________________________________________________________________________________


| |= See also
| |= See also
Line 55: Line 42:


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: MP|{{uc:MP}}]]
 
[[Category:Functions|{{uc:MP}}]]
[[Category:Take_On_Helicopters:_Functions|mp]]
[[Category:{{Name|tkoh}}: Functions|{{uc:MP}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:MP}}]]

Revision as of 09:08, 21 October 2011

Hover & click on the images for description

Description

Description:
Send function for remote execution (and executes locally if conditions are met) .
Execution:
spawn
Groups:
Uncategorised

Syntax

Syntax:
[params, functionName, target, isSpawn, isPersistent] spawn BIS_fnc_MP;
Parameters:
params: Anything - function params
functionName: String - function name
target: Object - function will be executed only where unit is local [default: everyone]
isSpawn: Boolean - true for calling function using 'spawn' command (otherwise 'call' is used) [default: false]
isPersistent: Boolean - true for persistent call (will be called now and for every JIP client) [default: false]
Return Value:
Array - sent packet

Examples

Example 1:
["Imma spamming your log!","BIS_fnc_log"] spawn BIS_fnc_MP; Logs a message for every player who's currently joined.
Example 2:
[["Hello World"],"BIS_fnc_guiMessage",nil,true,true] spawn BIS_fnc_MP; Send a message containing "Hello World" to every player, including the ones who joins later using JIP.

Additional Information

See also:
See also needed

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

Notes

Bottom Section