BIS fnc tridentSetRelationship: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Added one example)
m (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *C([a-eg-z])" to "$1 - c$2")
 
(29 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{RV|type=function


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


| arma3 |= Game name
|gr1= Sides


|1.00|= Game version
|descr= Set relationship of competing Trident sides.
____________________________________________________________________________________________
When the value reaches threshold, side relationship will change.
The value slowly decreases towards 0.


| <pre>/*
|s1= [side1, side2, value, absolute] call [[BIS_fnc_tridentSetRelationship]]


Description:
|p1= side1: [[Side]]
Set relationship of competing Trident sides.
When the value reaches threshold, side relationship will change.
The value slowly decreases towards 0.


Parameter(s):
|p2= side2: [[Side]]
0: SIDE
1: SIDE
2: NUMBER - changed value
3: BOOL - true to add the value, false to set the value


Returns:
|p3= value: [[Number]] - changed value
NUMBER - relationship value after change
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|p4= absolute: [[Boolean]] - [[true]] to add the value, [[false]] to set the value
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_tridentSetRelationship]]; --> |= Syntax
|r1= [[Number]] - relationship value after changes


|p1= |= Parameter 1
|x1= <sqf>[west, east, 0.5, true] call BIS_fnc_tridentSetRelationship;</sqf>
 
| |= Return value
____________________________________________________________________________________________
 
 
|x1= <code>[west,independent,-50,false] spawn BIS_fnc_tridentSetRelationship;</code> |= Example 1
____________________________________________________________________________________________
 
| |= See also


|seealso= [[BIS_fnc_tridentGetRelationship]] [[BIS_fnc_tridentHandleDamage]] [[BIS_fnc_tridentExecute]]
}}
}}
<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: Misc|{{uc:tridentSetRelationship}}]]
[[Category:Functions|{{uc:tridentSetRelationship}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:tridentSetRelationship}}]]

Latest revision as of 14:00, 8 November 2023

Hover & click on the images for description

Description

Description:
Set relationship of competing Trident sides. When the value reaches threshold, side relationship will change. The value slowly decreases towards 0.
Execution:
call
Groups:
Sides

Syntax

Syntax:
[side1, side2, value, absolute] call BIS_fnc_tridentSetRelationship
Parameters:
side1: Side
side2: Side
value: Number - changed value
absolute: Boolean - true to add the value, false to set the value
Return Value:
Number - relationship value after changes

Examples

Example 1:
[west, east, 0.5, true] call BIS_fnc_tridentSetRelationship;

Additional Information

See also:
BIS_fnc_tridentGetRelationship BIS_fnc_tridentHandleDamage BIS_fnc_tridentExecute

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