LumpOpen

Revision as of 10:25, 3 January 2024 by FusedQyou (talk | contribs) (Update after Lump Reading API refactor)
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.