LumpOpen: Difference between revisions

Update formatting and specifications on failure
(Update after Lump Reading API refactor)
(Update formatting and specifications on failure)
Tag: Source edit
Line 11: Line 11:
*''start'': The lump index to start searching for this lump after.
*''start'': The lump index to start searching for this lump after.
*''flags'': Can be a combination of the following values:
*''flags'': Can be a combination of the following values:
**''LUMP_OPEN_FULLPATH'': When specified, ''name'' represents the full path of the lump. For example, ''sounds/mysound.ogg''.
**<code>LUMP_OPEN_FULLPATH</code>: When specified, ''name'' represents the full path of the lump. For example, ''sounds/mysound.ogg''.


===Return value===
===Return value===
Returns the index of the lump, or -1 on failure.
Returns the index of the lump, or -1 if the lump was not found.
 
Failure would indicate the lump is not found in the remaining list of lumps after the specified index.


==Examples==
==Examples==