BIS fnc respect: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "\|seealso= ([^ ]+)(\]\]|\}\}), *(\[\[|\{\{)" to "|seealso= $1$2 $3")
 
(20 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


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


| arma2 |= Game name
|game2= arma2oa
|version2= 1.50


|1.00|= Game version
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| <pre>
|game4= arma3
/*
|version4= 0.50
File: RESTECP


Description:
|gr1= Sides
RESpect - The Effective Calculation Process.


Parameter(s):
|descr= RESpect - The Effective Calculation Process.
_this select 0: String - Mode


|s1= [mode, param1, param2, param3] call [[BIS_fnc_respect]]


* SET - set respect default values
|p1= mode: [[String]] - '''case-sensitive''', can be one of "SET", "ADD", "MODIFY", "KILLED"
o _this select 1: Nothing or Object
o Returned value: Array with zero respect values (if Object is passed as argument, 1 is on place of object's faction).
* ADD - add respect values depending on global town respect
o _this select 1: Object - Unit to which is given respect from assigned town with random difference defined in third argument.
o _this select 2: Number - Range of random difference.
o Returned value: Unit's respect values.
* MODIFY - change givern respect value
o _this select 1: Object - Unit of which respect value will be changed.
o _this select 2: String - Faction of which respect will be changed.
o _this select 3: String - Code which defines formula for change (current respect value is stored in variable _r) - e.g. "_r / 2"
o Returned value: Modified respect value.
* KILLED - Modify global town respect after civilian has been killed.
o _this select 1: Object - Units's killer
o _this select 2: Object - Town logic
o _this select 3: Number - Optional - change coeficient
o Returned value: Modified town respect value.


*/
|p2= depending on ''mode'':
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
* "SET" - set respect default values
____________________________________________________________________________________________
** param1: [[Nothing]] or [[Object]] (see '''Return value''')
* "ADD" - add respect values depending on global town respect
** param1: [[Object]] - unit to which is given respect from assigned town with random difference defined in third argument
** param2: [[Number]] - range of random difference
* "MODIFY" - change given respect value
** param1: [[Object]] - unit of which respect value will be changed
** param2: [[String]] - [[faction]] of which respect will be changed
** param3: [[String]] - [[Code|code]] which defines formula for change (current respect value is stored in variable _r) - e.g. "_r / 2"
* "KILLED" - modify global town respect after civilian has been killed
** param1: [[Object]] - killer
** param2: [[Object]] - town logic
** param3: [[Number]] - change coefficient


| <!-- [] call [[BIS_fnc_respect]]; --> |= Syntax
|r1=
* "SET": [[Array]] with zero respect values  (if [[Object]] is passed as argument, 1 is on place of object's faction)
* "ADD": unit's respect values
* "MODIFY": modified respect value
* "KILLED": modified town respect value


|p1= |= Parameter 1
|x1=
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[addRating]] [[Ambient Civilians]]
}}
}}
<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: Systems|{{uc:respect}}]]
[[Category:Functions|{{uc:respect}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:respect}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:respect}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:respect}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:respect}}]]

Latest revision as of 13:58, 1 July 2022

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

Description

Description:
RESpect - The Effective Calculation Process.
Execution:
call
Groups:
Sides

Syntax

Syntax:
[mode, param1, param2, param3] call BIS_fnc_respect
Parameters:
mode: String - case-sensitive, can be one of "SET", "ADD", "MODIFY", "KILLED"
depending on mode:
  • "SET" - set respect default values
  • "ADD" - add respect values depending on global town respect
    • param1: Object - unit to which is given respect from assigned town with random difference defined in third argument
    • param2: Number - range of random difference
  • "MODIFY" - change given respect value
    • param1: Object - unit of which respect value will be changed
    • param2: String - faction of which respect will be changed
    • param3: String - code which defines formula for change (current respect value is stored in variable _r) - e.g. "_r / 2"
  • "KILLED" - modify global town respect after civilian has been killed
Return Value:
  • "SET": Array with zero respect values (if Object is passed as argument, 1 is on place of object's faction)
  • "ADD": unit's respect values
  • "MODIFY": modified respect value
  • "KILLED": modified town respect value

Examples

Examples:
Example needed

Additional Information

See also:
addRating Ambient Civilians

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_respect&oldid=323931"