5.0

Retrieves an array of entity handles in the draw order

extern "C" APICALL int WINAPI VCGetDrawList(short* iError, ENTITYHANDLE* Buffer, int* Size, vbool ValidOnly);

function VCGetDrawList(var iError: Smallint; var Buffer: LongInt; var Size: LongInt; ValidOnly: WordBool):LongInt; stdcall;

Function GetDrawList(ByVal ValidOnly As Integer) As Variant

Buffer - pointer to a buffer to receive the entity handle array, can be NULL

Size - Pointer to an integer that contains or will receive the size, in bytes, of the array pointed to by Buffer, can be NULL if Buffer is NULL

ValidOnly - Flag to indicate whether all entities or only valid (non-erased) should be retrieved

The number of entity handles in the array

0 - Success
1 - Invalid World
2 - Valid Size pointer was not provided with non-NULL Buffer

VCADD's draw order is maintained as a linked list of entity handles.  The draw order list is parsed from beginning to end and the entities are drawn in the order that their handles are encountered in the list.  The first entity in the list is drawn first and the last entity is drawn last.  The draw order can be manipulated by changing an entity's position in the draw order list.

This call will retrieve an array that contains the entity handles in the order that they will draw.  It is normally used by first calling it with Buffer set to NULL to obtain the number of entities in the list.  If Size is non-NULL, it will contain the size of buffer required when the call returns.  Note that the return value is the number of entity handles, so the buffer size must be 4 times larger.  When Buffer is non-NULL, VCGetDrawList will fill the buffer with as many entity handles as will fit in the Size specified.  If the buffer size is not large enough to hold all of the entries, only as many handles as will fit in the buffer will be returned.

VCDrawCurrentEntityFirst, VCDrawCurrentEntityLast, VCDrawCurrentEntityBefore, VCDrawCurrentEntityAfter, VCDrawSelectedLast, VCDrawSelectedBefore, VCDrawSelectedAfter, VCGetDrawOrdinal