BIS fnc moduleRating: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<code>([^<]*)\[\[([a-zA-Z][a-zA-Z0-9_]+)\]\]([^<]*) *<\/code>" to "<code>$1$2$3</code>")
m (Text replacement - "Objects" to "Objects")
 
(2 intermediate revisions by the same user not shown)
Line 8: Line 8:
|descr= Function used by the Rating [[Arma_3:_Editor_Modules|module]].
|descr= Function used by the Rating [[Arma_3:_Editor_Modules|module]].


|s1=[logic, units, activated] call [[BIS_fnc_moduleRating]]
|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]]
|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
|p2= units: [[Array]] of [[Object]]s - units to add rating/score to


|p3= activated: [[Boolean]] - (Optional, default true) [[true]] to activate
|p3= activated: [[Boolean]] - (Optional, default true) [[true]] to activate
Line 18: Line 18:
|r1= [[Boolean]] - [[true]] when done
|r1= [[Boolean]] - [[true]] when done


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


|seealso= [[Arma 3: Editor Modules]]
|seealso= [[Arma 3: Editor Modules]]
}}
}}

Latest revision as of 23:39, 12 July 2022

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