BIS fnc tridentSetRelationship: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Added one example)
m (pf)
Line 1: Line 1:
{{Function|Comments=
____________________________________________________________________________________________
| arma3 |Game name=


{{Function|= Comments
|1.00|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


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


| <pre>/*
| [side_1,side_2,value,absolute] call [[BIS_fnc_tridentSetRelationship]] |Syntax=


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


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


Returns:
|p2= side_2: [[Side]] |Parameter 2=
NUMBER - relationship value after change
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|p3= value: [[Number]] - Changed value |Parameter 3=
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_tridentSetRelationship]]; --> |= Syntax
|p4= absolute: [[Boolean]] - [[True]] to add the value, [[false]] to set the value |Parameter 4=


|p1= |= Parameter 1


| |= Return value
| [[Number]] - Relationship value after changes|Return value=
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code>[ [[west]], [[east]], 0.5, [[true]] ] [[call]] [[BIS_fnc_tridentSetRelationship]];</code>|Example 1=


|x1= <code>[west,independent,-50,false] spawn BIS_fnc_tridentSetRelationship;</code> |= Example 1
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
| [[BIS_fnc_tridentGetRelationship]], [[BIS_fnc_tridentHandleDamage]] |See also=
 
}}
}}



Revision as of 14:54, 19 June 2018

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:
Uncategorised

Syntax

Syntax:
[side_1,side_2,value,absolute] call BIS_fnc_tridentSetRelationship
Parameters:
side_1: Side
side_2: 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_tridentGetRelationshipBIS_fnc_tridentHandleDamage

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