BIS fnc moduleRating: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Page filling)
m (template:command argument fix)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


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


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


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


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


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


| [[Boolean]] - [[true]] when done |= Return value
| [[Boolean]] - [[true]] when done |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


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


| [[Arma 3: Editor Modules]] |= See also
| [[Arma 3: Editor Modules]] |SEEALSO=
}}
}}



Revision as of 14:31, 7 April 2019

Hover & click on the images for description

Description

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

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

Notes

Bottom Section