This site has been archived and made available for preservation purposes. No edits can be made.
AxisToString
(Difference between revisions)
Return to current revision
-
Retrieves the string representation of an [wiki]Axis[/wiki].
[h="2"] Declaration [/h]
[highlight=cpp]
-
-
VAULTSCRIPT vaultmp::String (*AxisToString)(vaultmp::Index);
-
+
VAULTSCRIPT VAULTSPACE cRawString (*VAULTAPI(AxisToString))(VAULTSPACE Index) _CPP(noexcept);
[/highlight]
[highlight=c]
-
native AxisToString(index, value{});
[/highlight]
[h="2"] Parameters [/h]
-
-
[b][wiki="Index"]vaultmp::Index[/wiki][/b] - the index of the [wiki]Axis[/wiki]
-
+
[b][wiki="Index"]Index[/wiki][/b] - the index of the [wiki]Axis[/wiki]
-
[b]value[/b] (PAWN only) - an array large enough to hold at least 64 characters
[h="2"] Return value [/h]
-
-
The C++ version returns a [wiki="String"]vaultmp::String[/wiki] containing the string representation of the axis. The PAWN version has no return value.
[h="2"] Usage example (C++) [/h]
[highlight=cpp]
vaultmp::String value;
value = AxisToString(index);
[/highlight]
[h="2"] Usage example (PAWN) [/h]
[highlight=c]
new value{64};
AxisToString(index, value);
[/highlight]
-
+
The C version returns a [wiki="cRawString"]cRawString[/wiki] containing the string representation of the axis. The PAWN version has no return value.
-
[category]VaultMP interface[/category]
[category]Scripting functions[/category]
[category]Misc functions[/category]
