LumpOpen: Difference between revisions
DrinkyBird (talk | contribs) (Created page with "{{ACSWarning}} {{DevfeatureWarning|version=3.2|type=an ACS function}} {{stub}} int '''LumpOpen''' (str ''name''[, int ''start'']) {{Devfeature|3.2|alpha}} ==Usage== Returns the index of the given lump, starting the search after ''start''. ===Parameters=== * ''name'': The name of the lump to find. * ''start'': The lump index to start searching for this lump after. ===Return value=== Returns the index of the lump, or -1 on error. ==Examples== {{noexamples}} Cat...") Tag: Source edit |
(Update after Lump Reading API refactor) |
||
| Line 1: | Line 1: | ||
{{ACSWarning}} | {{ACSWarning}} | ||
{{DevfeatureWarning|version=3.2|type=an [[ACS]] function}} | {{DevfeatureWarning|version=3.2|type=an [[ACS]] function}} | ||
int '''LumpOpen''' (str ''name''[, int ''start'']) {{Devfeature|3.2|alpha}} | int '''LumpOpen''' (str ''name''[, int ''start'', int ''flags'']) {{Devfeature|3.2|alpha}} | ||
==Usage== | ==Usage== | ||
| Line 9: | Line 8: | ||
===Parameters=== | ===Parameters=== | ||
* ''name'': The name of the lump to find. | *''name'': The name of the lump to find. | ||
* ''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: | |||
**''LUMP_OPEN_FULLPATH'': 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 | Returns the index of the lump, or -1 on failure. | ||
Failure would indicate the lump is not found in the remaining list of lumps after the specified index. | |||
==Examples== | ==Examples== | ||
Revision as of 10:25, 3 January 2024
|
This article documents a Zandronum-specific ACS feature which may not be supported by ZDoom and its other child ports. |
|
This article documents an ACS function which is only available in development builds of Zandronum 3.2 and newer. |
int LumpOpen (str name[, int start, int flags]) (development version 3.2-alpha and above only)
Usage
Returns the index of the given lump, starting the search after start.
Parameters
- name: The name of the lump to find.
- start: The lump index to start searching for this lump after.
- 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.
Return value
Returns the index of the lump, or -1 on failure.
Failure would indicate the lump is not found in the remaining list of lumps after the specified index.
Examples
| This article lists no examples, please add one. |