addRating: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "Category:Scripting Commands ArmA2" to "Category:Scripting Commands Arma 2")
m (Some wiki formatting)
 
(43 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| ofp |Game name=
|game1= ofp
|version1= 1.00


|1.00|Game version=
|game2= ofpe
|version2= 1.00


|arg= local |Multiplayer Arguments=
|game3= arma1
|version3= 1.00


|eff= global |Multiplayer Effects=
|game4= arma2
____________________________________________________________________________________________
|version4= 1.00


| Add a number to the [[rating]] of a unit - negative values can be used to reduce the rating.
|game5= arma2oa
<br>This command is usually used to reward for completed mission objectives. The rating is given at the end of the mission and is automatically adjusted when killing enemies or friendlies.  
|version5= 1.50


<br>When the rating gets below -2000, the unit's side switches to "ENEMY" ([[sideEnemy]]) and the unit is attacked by everyone.(see [[ArmA:_Rating Values|Rating Values]])
|game6= tkoh
|version6= 1.00


<br><br>See also: [[Arma_3:_Event_Handlers#HandleRating]] |DESCRIPTION=
|game7= arma3
____________________________________________________________________________________________
|version7= 0.50


| unitName '''addRating''' rating |SYNTAX=
|arg= local


|p1= unitName: [[Object]] |PARAMETER1=
|eff= global


|p2= rating: [[Number]] |PARAMETER2=
|gr1= Object Manipulation


| [[Nothing]] |RETURNVALUE=
|descr= Add a number to the [[rating]] of a unit - negative values can be used to reduce the rating.<br>
____________________________________________________________________________________________
This command is usually used to reward for completed mission objectives.The rating is given at the end of the mission and is automatically adjusted when killing enemies or friendlies.<br>
 
When the rating gets below -2000, the unit's side switches to [[sideEnemy]] and the unit is attacked by everyone.
|x1= <code>[[player]] [[addRating]] 2000;</code> |EXAMPLE1=
{{Feature|informative|See also {{Link|ArmA: Armed Assault: Rating Values}} and {{Link|Arma 3: Event Handlers#HandleRating}}.}}
____________________________________________________________________________________________


| [[Side relations]], [[ArmA: Rating Values|Rating Values]], [[rating]], [[rank]], [[setUnitRank]], [[sideEnemy]] |SEEALSO=
|s1= unitName [[addRating]] rating


}}
|p1= unitName: [[Object]]


<h3 style="display:none">Notes</h3>
|p2= rating: [[Number]]
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|r1= [[Nothing]]
</dl>


<h3 style="display:none">Bottom Section</h3>
|x1= <sqf>player addRating 2000;</sqf>


[[Category:Scripting Commands|ADDRATING]]
|x2= Set the rating to a specific value:
[[Category:Scripting Commands OFP 1.99|ADDRATING]]
<sqf>
[[Category:Scripting Commands OFP 1.96|ADDRATING]]
private _wantedRating = 9001;
[[Category:Scripting Commands OFP 1.46|ADDRATING]]
player addRating (_wantedRating - rating player);
[[Category:Scripting Commands ArmA|ADDRATING]]
</sqf>
[[Category:Command_Group:_Mission_Information|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]


<!-- CONTINUE Notes -->
|seealso= [[Side Relations]] [[ArmA: Rating Values|Rating Values]] [[rating]] [[rank]] [[setUnitRank]] [[sideEnemy]]
<dl class="command_description">
}}
<dd class="notedate">Posted on November 16, 2014 - 19:11 (UTC)</dd>
<dt class="note">[[User:Benargee|Benargee]]</dt>
<dd class="note">
Since there is no '''setRating''' command, its expected behaviour can scripted as such:
<code>BNRG_fnc_setRating = {
  _setRating = _this select 0;
  _unit = _this select 1;
  _getRating = rating _unit;
  _addVal = _setRating - _getRating;
  _unit addRating _addVal;
};
 
[1000,player] call BNRG_fnc_setRating//set player rating 1000</code>
Using this example, no matter what the units rating was before, it will always set its rating to 1000.
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 14:07, 12 March 2024

Logo A0.png1.00ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
LALocalGEGlobal
Hover & click on the images for description

Description

Description:
Add a number to the rating of a unit - negative values can be used to reduce the rating.
This command is usually used to reward for completed mission objectives.The rating is given at the end of the mission and is automatically adjusted when killing enemies or friendlies.
When the rating gets below -2000, the unit's side switches to sideEnemy and the unit is attacked by everyone.
ⓘ
Groups:
Object Manipulation

Syntax

Syntax:
unitName addRating rating
Parameters:
unitName: Object
rating: Number
Return Value:
Nothing

Examples

Example 1:
player addRating 2000;
Example 2:
Set the rating to a specific value:
private _wantedRating = 9001; player addRating (_wantedRating - rating player);

Additional Information

See also:
Side Relations Rating Values rating rank setUnitRank sideEnemy

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=addRating&oldid=353042"