BIS fnc EXP camp playerChecklist: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (rollback)
m (Text replacement - "|version1= 1.62" to "|version1= 1.62 |gr1 = Campaign |GROUP1=")
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{Function


| arma3 |Game name=
|game1= arma3


|1.62|Game version=
|version1= 1.62


<!---|arg= local |Multiplayer Arguments=--->
|gr1 = Campaign |GROUP1=


<!---|eff= local |Multiplayer Effects=--->
<!--|exec= server|=-->


| <pre>/*
<!--|arg= local-->
Author: Thomas Ryan


Description:
<!--|eff= local-->
Display a checklist of players that don't meet the given condition, thus preventing mission progress.


Parameters:
|descr= Display a checklist of players that don't meet the given condition, thus preventing mission progress.
_this select 0: CODE - General condition that must be met to proceed. Will not list player names.
_this select 1: CODE - Condition that must be met by each player. Use _player to reference the player unit.
_this select 2: CODE - Code to be executed when all players meet the defined condition.


Returns:
|mp= Should only be excuted on the server.
True if successful, false if not.
*/</pre>{{Informative|Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]]}} |Description=


|[] call [[BIS_fnc_EXP_camp_playerChecklist]]|Syntax=
|s1= [conditionProceed, conditionPlayer, code] call [[BIS_fnc_EXP_camp_playerChecklist]]


|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
|p1= conditionProceed: [[Code]] - (Optional, default {true}) General condition that must be met to proceed. Will not list player names.


|Datatype - description|Return value=
|p2= conditionPlayer: [[Code]] - (Optional, default {true}) Condition that must be met by each player. Use '''_player''' to reference the player unit.


|x1= <code></code>|Example 1=
|p3= code: [[Code]] - (Optional, default {}) Code to be executed when all players meet the defined condition.


|exec= call |Execution=
|r1= [[Boolean]] - [[True]] if successful, [[false]] if not
 
|x1= <code>[{[[count]] [[allPlayers]] == 4}] [[call]] [[BIS_fnc_EXP_camp_playerChecklist]];</code>
 
|exec= call
 
|seealso=


| |See also=
}}
}}


[[Category:Function Group: Campaign|{{uc:EXP_camp_playerChecklist}}]]
[[Category:Functions|{{uc:EXP_camp_playerChecklist}}]]
[[Category:Functions|{{uc:EXP_camp_playerChecklist}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:EXP_camp_playerChecklist}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:EXP_camp_playerChecklist}}]]

Revision as of 16:23, 12 October 2020

Arma 3 logo black.png1.62
Hover & click on the images for description

Description

Description:
Display a checklist of players that don't meet the given condition, thus preventing mission progress.
Execution:
call
Multiplayer:
Should only be excuted on the server.
Groups:
Campaign

Syntax

Syntax:
[conditionProceed, conditionPlayer, code] call BIS_fnc_EXP_camp_playerChecklist
Parameters:
conditionProceed: Code - (Optional, default {true}) General condition that must be met to proceed. Will not list player names.
conditionPlayer: Code - (Optional, default {true}) Condition that must be met by each player. Use _player to reference the player unit.
code: Code - (Optional, default {}) Code to be executed when all players meet the defined condition.
Return Value:
Boolean - True if successful, false if not

Examples

Example 1:
[{count allPlayers == 4}] call BIS_fnc_EXP_camp_playerChecklist;

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_EXP_camp_playerChecklist&oldid=167826"