BIS fnc moduleRating: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Comments" to "|Comments=")
m (Text replacement - "Objects" to "Objects")
 
(25 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 1.00


|1.00|= Game version
|gr1= Modules
____________________________________________________________________________________________


| Function used by the Rating [[Arma_3:_Editor_Modules|module]]. |DESCRIPTION=
|descr= Function used by the Rating [[Arma_3:_Editor_Modules|module]].
____________________________________________________________________________________________


| [logic, units, activated] call [[BIS_fnc_moduleRating]]; |SYNTAX=
|s1= [logic, units, activated] call [[BIS_fnc_moduleRating]]


|p1= logic: [[Object]] - a logic, but can be any object. Rating and Score are set with [[setVariable]] |PARAMETER1=
|p1= logic: [[Object]] - a logic, but can be any object. Rating and Score are set with [[setVariable]]


|p2= units: [[Array]] of [[Object|Objects]] - units to add rating/score to |PARAMETER2=
|p2= units: [[Array]] of [[Object]]s - units to add rating/score to


|p3= activated: [[Boolean]] - (Optional, default true) [[true]] to activate |PARAMETER3=
|p3= activated: [[Boolean]] - (Optional, default true) [[true]] to activate


| [[Boolean]] - [[true]] when done |RETURNVALUE=
|r1= [[Boolean]] - [[true]] when done
____________________________________________________________________________________________


|x1= <code>[myLogic, [[units]] [[group]] [[player]], [[true]]] [[call]] [[BIS_fnc_moduleRating]];</code> |EXAMPLE1=
|x1= <sqf>[myLogic, units group player, true] call BIS_fnc_moduleRating;</sqf>
____________________________________________________________________________________________


| [[Arma 3: Editor Modules]] |SEEALSO=
|seealso= [[Arma 3: Editor 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:moduleRating}}]]
[[Category:Functions|{{uc:moduleRating}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:moduleRating}}]]

Latest revision as of 00:39, 13 July 2022

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

Description

Description:
Function used by the Rating module.
Execution:
call
Groups:
Modules

Syntax

Syntax:
[logic, units, activated] call BIS_fnc_moduleRating
Parameters:
logic: Object - a logic, but can be any object. Rating and Score are set with setVariable
units: Array of Objects - units to add rating/score to
activated: Boolean - (Optional, default true) true to activate
Return Value:
Boolean - true when done

Examples

Example 1:
[myLogic, units group player, true] call BIS_fnc_moduleRating;

Additional Information

See also:
Arma 3: Editor 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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_moduleRating&oldid=327571"