This site has been archived and made available for preservation purposes. No edits can be made.

GetList

This is an old revision of this page, as edited 11-15-2012, 01:37 AM by foxtacles (contribs). It may differ significantly from the current revision.
Returns a vector of all instances of a given Type.

[top]Declaration

Code cpp:
VAULTSCRIPT VAULTSPACE UCount (*VAULTAPI(GetList))(VAULTSPACE Type, VAULTSPACE RawArray(VAULTSPACE ID)*) VAULTCPP(noexcept);
Code cp:
native GetList(Type:type, id[]);

[top]Parameters

Type - the type
Pointer to RawArray of ID - used to return a pointer to the resulting vector
id (PAWN only) - an array large enough to hold all instances. See GetCount

[top]Return value

Returns a UCount, which is the number of instances in the vector.