LumpGetInfo: Difference between revisions

From Zandronum Wiki
(Created page with "{{ACSWarning}} {{DevfeatureWarning|version=3.2|type=an ACS function}} mixed '''LumpGetInfo''' (int ''lump'', int ''info'') {{Devfeature|3.2|alpha}} ==Usage== Returns information of the lump, based on ''info''. ===Parameters=== *''lump'': The lump index as returned from <tt>LumpOpen</tt>. *''info'': The type of information to return. **<code>LUMP_INFO_SIZE</code>: The buffer size of the lump. **<code>LUMP_INFO_NAME</code>: The full name (including path) of the...")
 
(Update specifications on failure)
Line 18: Line 18:
If ''info'' is <code>LUMP_INFO_NAME</code>, returns a string containing the lump's full name.
If ''info'' is <code>LUMP_INFO_NAME</code>, returns a string containing the lump's full name.


Returns 0 on invalid input, or when attempting to read a lump that has not yet been opened with <tt>[[LumpOpen]]</tt>.
Returns 0 on invalid input, alongside a console message.


==Examples==
==Examples==

Revision as of 08:21, 4 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.

mixed LumpGetInfo (int lump, int info) (development version 3.2-alpha and above only)

Usage

Returns information of the lump, based on info.

Parameters

  • lump: The lump index as returned from LumpOpen.
  • info: The type of information to return.
    • LUMP_INFO_SIZE: The buffer size of the lump.
    • LUMP_INFO_NAME: The full name (including path) of the lump.

Return value

If info is LUMP_INFO_SIZE, returns an integer specifying the buffer size of the lump.

If info is LUMP_INFO_NAME, returns a string containing the lump's full name.

Returns 0 on invalid input, alongside a console message.

Examples

This article lists no examples, please add one.