This site has been archived and made available for preservation purposes. No edits can be made.
GetName
(Difference between revisions)
Return to current revision
-
Retrieves the name of an [wiki]Object[/wiki].
[h="2"] Declaration [/h]
[highlight=cpp]
-
-
VAULTSCRIPT vaultmp::String (*GetName)(vaultmp::ID);
-
+
VAULTSCRIPT VAULTSPACE cRawString (*VAULTAPI(GetName))(VAULTSPACE ID) VAULTCPP(noexcept);
[/highlight]
[highlight=c]
-
native GetName(ID, name{});
[/highlight]
[h="2"] Parameters [/h]
-
-
[b][wiki="ID"]vaultmp::ID[/wiki][/b] - the ID of the [wiki]Object[/wiki]
-
+
[b][wiki="ID"]ID[/wiki][/b] - the ID of the [wiki]Object[/wiki]
-
[b]name[/b] (PAWN only) - an array large enough to hold at least [wiki]MAX_PLAYER_NAME[/wiki] characters. Note that [wiki="Object"]Objects[/wiki] which are not [wiki="Player"]Players[/wiki] can have longer names.
[h="2"] Return value [/h]
-
-
The C++ version returns a [wiki="String"]vaultmp::String[/wiki] containing the name. The PAWN version has no return value.
[h="2"] Usage example (C++) [/h]
[highlight=cpp]
vaultmp::String name;
name = GetName(object);
[/highlight]
[h="2"] Usage example (PAWN) [/h]
[highlight=c]
new name{MAX_PLAYER_NAME};
GetName(player, name);
[/highlight]
-
+
The C++ version returns a [wiki="cRawString"]cRawString[/wiki]. The PAWN version has no return value.
-
[category]VaultMP interface[/category]
[category]Scripting functions[/category]
[category]Object functions[/category]