Difference between revisions of "Osiris/API/GetDistanceTo"
From Divinity Engine Wiki
(Osiris Core APIs) |
m |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 4: | Line 4: | ||
Calculates the distance between '''_Object1''' and '''_Object2'''. | Calculates the distance between '''_Object1''' and '''_Object2'''. | ||
===== Return Values ===== | ===== Return Values ===== | ||
| − | * '''Success/Failure''': Fails if if either '''_Object1''' or _'''Object2''' is in a container or in an inventory. Use | + | * '''Success/Failure''': Fails if if either '''_Object1''' or _'''Object2''' is in a container or in an inventory. Use [[Osiris/API/ItemIsInInventory|ItemIsInInventory]] to check for this. |
* '''_Dist''': The distance in metres. | * '''_Dist''': The distance in metres. | ||
===== Notes ===== | ===== Notes ===== | ||
* / | * / | ||
===== See Also ===== | ===== See Also ===== | ||
| − | * [[Osiris/API/ItemIsInInventory]] | + | * [[Osiris/API/ItemIsInInventory|ItemIsInInventory]] |
| − | [[Category:Osiris Queries]] | + | [[Category:Osiris Queries|GetDistanceTo]] |
Latest revision as of 15:29, 19 December 2017
Full Definition(s)
- query GetDistanceTo([in](GUIDSTRING)_Object1, [in](GUIDSTRING)_Object2, [out](REAL)_Dist)
Description
Calculates the distance between _Object1 and _Object2.
Return Values
- Success/Failure: Fails if if either _Object1 or _Object2 is in a container or in an inventory. Use ItemIsInInventory to check for this.
- _Dist: The distance in metres.
Notes
- /
