(Difference between revisions)
Return to current revision
-
-
Retrieves the last known position (X, Y, Z coordinates) of an [[Object]].
== Declaration ==
<code cpp>
VAULTSCRIPT void (*GetPos)(vaultmp::ID, vaultmp::Value&, vaultmp::Value&, vaultmp::Value&);
-
+
Retrieves the current position (X, Y, Z coordinates) of an [wiki]Object[/wiki].
[h="2"] Declaration [/h]
[highlight=cpp]
VAULTSCRIPT VAULTSPACE Void (*VAULTAPI(GetPos))(VAULTSPACE ID, VAULTSPACE Value*, VAULTSPACE Value*, VAULTSPACE Value*) VAULTCPP(noexcept);
[/highlight]
[highlight=c]
-
native GetPos(ID, &Float:X, &Float:Y, &Float:Z);
-
-
</code>
== Parameters ==
'''[[vaultmp::ID]]''' - the ID of the Object
'''[[vaultmp::Value]]&''' - a reference to a Value (X coordinate)
'''[[vaultmp::Value]]&''' - a reference to a Value (Y coordinate)
'''[[vaultmp::Value]]&''' - a reference to a Value (Z coordinate)
== Return value ==
-
+
[/highlight]
[h="2"] Parameters [/h]
[b][wiki="ID"]ID[/wiki][/b] - the ID of the [wiki]Object[/wiki]
[b][wiki="Value"]Value[/wiki]*[/b] - used to return a [wiki]Value[/wiki] (X coordinate)
[b][wiki="Value"]Value[/wiki]*[/b] - used to return a [wiki]Value[/wiki] (Y coordinate)
[b][wiki="Value"]Value[/wiki]*[/b] - used to return a [wiki]Value[/wiki] (Z coordinate)
[h="2"] Return value [/h]
-
None.
-
-
== Usage example (C++) ==
<code cpp>
vaultmp::Value X, Y, Z;
GetPos(object, X, Y, Z);
</code>
-
+
[category]VaultMP interface[/category]
[category]Scripting functions[/category]
[category]Object functions[/category]
