BIS fnc relScaledDist: Difference between revisions

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


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


| arma3 |= Game name
|gr1= Geometry


|1.00|= Game version
|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.
____________________________________________________________________________________________


| <pre>/*
|s1= [referenceObject, relativeObject] call [[BIS_fnc_relScaledDist]]
File: fn_relScaledDist.sqf


Description:
|p1= referenceObject: [[Object]]
Returns


Parameter(s):
|p2= relativeObject: [[Object]]
_this select 0: Trigger
_this select 1: Object


Returns:
|r1= [[Number]]
- exponentially inflated rational number between 0 and 1, with 1 being center and 0 being edge of the trigger
Todo:
- Object or Position
- BOOL flag for no exp scale
- Finish rectangle implementation
*/
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_relScaledDist]]; --> |= Syntax
|x1= <sqf>[myTrigger, player] call BIS_fnc_relScaledDist;</sqf>
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= 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:Function Group: Geometry|{{uc:relScaledDist}}]]
[[Category:Functions|{{uc:relScaledDist}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:relScaledDist}}]]

Latest revision as of 17:27, 8 November 2023

Arma 3 logo black.png1.00
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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_relScaledDist&oldid=349415"