Difference between revisions of "Osiris/API/GetPosition"
From Divinity Engine Wiki
(Created page with "===== Full Definition(s) ===== * query '''GetPosition'''('''''[in]'''(GUIDSTRING)'''''_Target''', '''''[out]'''(REAL)'''''_X''', '''''[out]'''(REAL)'''''_Y''', '''''[out]'''(R...") |
m |
||
| Line 2: | Line 2: | ||
* query '''GetPosition'''('''''[in]'''(GUIDSTRING)'''''_Target''', '''''[out]'''(REAL)'''''_X''', '''''[out]'''(REAL)'''''_Y''', '''''[out]'''(REAL)'''''_Z''') | * query '''GetPosition'''('''''[in]'''(GUIDSTRING)'''''_Target''', '''''[out]'''(REAL)'''''_X''', '''''[out]'''(REAL)'''''_Y''', '''''[out]'''(REAL)'''''_Z''') | ||
===== Description ===== | ===== Description ===== | ||
| − | Returns the position of the '''_Target''', with '''_Y''' being the vertical coordinate. | + | Returns the position of the '''_Target''', with '''_Y''' being the vertical coordinate. It works on any kind of game object. |
===== Return Values ===== | ===== Return Values ===== | ||
| − | * '''Success/Failure''': Fails if ''' | + | * '''Success/Failure''': Fails if '''_Target''' does not exist. |
| − | * '''_X''': X coordinate of | + | * '''_X''': X coordinate of '''_Target'''. |
| − | * '''_Y''': Y coordinate of | + | * '''_Y''': Y coordinate of '''_Target'''. |
| − | * '''_Z''': Z coordinate of | + | * '''_Z''': Z coordinate of '''_Target'''. |
===== Notes ===== | ===== Notes ===== | ||
| − | * / | + | * If '''_Target''' is an item and the item is inside the inventory of a character or a container, this call returns the rotation of the character/outermost container. |
| + | ===== See Also ===== | ||
| + | * [[Osiris/API/GetRotation|GetRotation]] | ||
[[Category:Osiris Queries|GetPosition]] | [[Category:Osiris Queries|GetPosition]] | ||
Revision as of 15:25, 31 January 2018
Full Definition(s)
- query GetPosition([in](GUIDSTRING)_Target, [out](REAL)_X, [out](REAL)_Y, [out](REAL)_Z)
Description
Returns the position of the _Target, with _Y being the vertical coordinate. It works on any kind of game object.
Return Values
- Success/Failure: Fails if _Target does not exist.
- _X: X coordinate of _Target.
- _Y: Y coordinate of _Target.
- _Z: Z coordinate of _Target.
Notes
- If _Target is an item and the item is inside the inventory of a character or a container, this call returns the rotation of the character/outermost container.
