This site has been archived and made available for preservation purposes. No edits can be made.
GetList
(Difference between revisions)
Return to current revision
-
Returns a vector of all instances of a given [wiki="Type"]Type[/wiki].
[h="2"] Declaration [/h]
[highlight=cpp]
VAULTSCRIPT VAULTSPACE UCount (*VAULTAPI(GetList))(VAULTSPACE Type, VAULTSPACE RawArray(VAULTSPACE ID)*) VAULTCPP(noexcept);
[/highlight]
[highlight=cp]
native GetList(Type:type, id[]);
[/highlight]
[h="2"] Parameters [/h]
[b][wiki="Type"]Type[/wiki][/b] - the type
-
-
[b]Pointer to [wiki="RawArray"]RawArray[/wiki] of [wiki]ID[/wiki][/b] - used to return a pointer to the resulting vector
-
+
[b][wiki="RawArray"]RawArray[/wiki]([wiki]ID[/wiki])*[/b] - used to return a pointer to the resulting vector
-
[b]id[/b] (PAWN only) - an array large enough to hold all instances. See [wiki]GetCount[/wiki]
[h="2"] Return value [/h]
Returns a [wiki="UCount"]UCount[/wiki], which is the number of instances in the vector.
[category]VaultMP interface[/category]
[category]Scripting functions[/category]
[category]Game functions[/category]
