BIS fnc relScaledDist: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (fixed example)
m (Text replacement - ">\[ +(.*) *\] +(call|spawn)" to ">[$1] $2")
 
(23 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.00


|1.00|Game version=
|gr1= Geometry
____________________________________________________________________________________________


| Original description: <pre>Exponentially inflated rational number between 0 and 1, with 1 being center and 0 being edge of the trigger</pre>
|descr= Exponentially inflated rational number between 0 and 1, with 1 being center and 0 being edge of the trigger. This function can be used to check where in a trigger area an object is. Is it near the border of the trigger area the number will go against 0.
{{Stub}}|Description=
____________________________________________________________________________________________


| [referenceObject, relativeObject] call [[BIS_fnc_relScaledDist]] |Syntax=
|s1= [referenceObject, relativeObject] call [[BIS_fnc_relScaledDist]]


|p1= referenceObject: [[Object]] |Parameter 1=
|p1= referenceObject: [[Object]]


|p2= relativeObject: [[Object]] |Parameter 2=
|p2= relativeObject: [[Object]]


| [[Number]] |Return value=
|r1= [[Number]]
____________________________________________________________________________________________


|x1= <code>[ myTrigger, [[player]] ] [[call]] [[BIS_fnc_relScaledDist]];</code> |Example 1=
|x1= <sqf>[myTrigger, player] call BIS_fnc_relScaledDist;</sqf>
____________________________________________________________________________________________


| [[distance]], [[distanceSqr]] |See also=
|seealso= [[distance]] [[distanceSqr]]
}}
}}
<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:Functions|{{uc:relScaledDist}}]]
[[Category:Function Group: Geometry|{{uc:relScaledDist}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:relScaledDist}}]]

Latest revision as of 17:27, 8 November 2023

Hover & click on the images for description

Description

Description:
Exponentially inflated rational number between 0 and 1, with 1 being center and 0 being edge of the trigger. This function can be used to check where in a trigger area an object is. Is it near the border of the trigger area the number will go against 0.
Execution:
call
Groups:
Geometry

Syntax

Syntax:
[referenceObject, relativeObject] call BIS_fnc_relScaledDist
Parameters:
referenceObject: Object
relativeObject: Object
Return Value:
Number

Examples

Example 1:
[myTrigger, player] call BIS_fnc_relScaledDist;

Additional Information

See also:
distance distanceSqr

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