BIS fnc moduleRank: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|x1= <code></code> |= " to "|x1= <code></code> |EXAMPLE1=")
m (Text replacement - " (\|[pr][0-9]+ *= *[^-]+) *- *A([a-z])" to " $1 - a$2")
 
(20 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|Comments=
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |Game name=
|gr1= Modules


|1.00|Game version=
|descr= Used by the Set Rank module.
____________________________________________________________________________________________


| ''N/A''<br>{{placeholder}} |DESCRIPTION=
|s1= [logic, units, activated] call [[BIS_fnc_moduleRank]]
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_moduleRank]]; --> |SYNTAX=
|p1= logic: [[Object]] - logic


|p1= |PARAMETER1=
|p2= units: [[Array]] - units to set rank to


| |RETURNVALUE=
|p3= activated: [[Boolean]] - (Optional, default [[true]]) if [[false]] nothing will happen
____________________________________________________________________________________________


|x1= <code></code> |EXAMPLE1=
|r1= [[Boolean]] - always [[true]]
____________________________________________________________________________________________


| |SEEALSO=
|x1= <sqf>[rankLogic, [player]] call BIS_fnc_moduleRank;</sqf>


|seealso= [[Modules]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: ObjectModifiers|{{uc:moduleRank}}]]
[[Category:Functions|{{uc:moduleRank}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:moduleRank}}]]

Latest revision as of 12:40, 8 November 2023

Hover & click on the images for description

Description

Description:
Used by the Set Rank module.
Execution:
call
Groups:
Modules

Syntax

Syntax:
[logic, units, activated] call BIS_fnc_moduleRank
Parameters:
logic: Object - logic
units: Array - units to set rank to
activated: Boolean - (Optional, default true) if false nothing will happen
Return Value:
Boolean - always true

Examples

Example 1:
[rankLogic, [player]] call BIS_fnc_moduleRank;

Additional Information

See also:
Modules

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