BIS fnc EXP camp playerChecklist: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (rollback)
m (Text replacement - "(\|p[0-9]+ *= *[^(]+\(Optional(, default[^)]*)\) )G([a-z])" to "$1g$3")
 
(24 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function


| arma3 |Game name=
|game1= arma3
|version1= 1.62


|1.62|Game version=
|gr1= Campaign


<!---|arg= local |Multiplayer Arguments=--->
|descr= Display a checklist of players that don't meet the given condition, thus preventing mission progress.


<!---|eff= local |Multiplayer Effects=--->
|mp= Should only be excuted on the server.


| <pre>/*
|s1= [conditionProceed, conditionPlayer, code] call [[BIS_fnc_EXP_camp_playerChecklist]]
Author: Thomas Ryan


Description:
|p1= conditionProceed: [[Code]] - (Optional, default {true}) general condition that must be met to proceed. Will not list player names.
Display a checklist of players that don't meet the given condition, thus preventing mission progress.


Parameters:
|p2= conditionPlayer: [[Code]] - (Optional, default {true}) condition that must be met by each player. Use '''_player''' to reference the player unit.
_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:
|p3= code: [[Code]] - (Optional, default {}) code to be executed when all players meet the defined condition.
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=
|r1= [[Boolean]] - [[true]] if successful, [[false]] if not


|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
|x1= <sqf>[{count allPlayers == 4}] call BIS_fnc_EXP_camp_playerChecklist;</sqf>


|Datatype - description|Return value=
|seealso=
 
|x1= <code></code>|Example 1=
 
|exec= call |Execution=
 
| |See also=
}}
}}
[[Category:Function Group: Campaign|{{uc:EXP_camp_playerChecklist}}]]
[[Category:Functions|{{uc:EXP_camp_playerChecklist}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:EXP_camp_playerChecklist}}]]

Latest revision as of 12:29, 8 November 2023

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