GetMapPosition: Difference between revisions

From Zandronum Wiki
Tag: Source edit
(This was renamed to GetMapPosition, and can return the index of either the current or next map in the map rotation.)
Tag: Source edit
Line 2: Line 2:
{{DevfeatureWarning|version=3.2|type=an [[ACS]] function}}
{{DevfeatureWarning|version=3.2|type=an [[ACS]] function}}


int '''GetCurrentMapPosition''' (void) {{Devfeature|3.2|alpha}}
int '''GetMapPosition''' (int ''type'') {{Devfeature|3.2|alpha}}


== Usage ==
== Usage ==
Returns the index of the current map in the map rotation.
Returns the index of the current or next map in the map rotation.
 
=== Parameters ===
* ''type'': Can be either:
:*'''MAPPOSITION_CURRENT''' = 0
::The current map being played on.
:*'''MAPPOSITION_NEXT''' = 1
::The next map that will be entered.


=== Return value ===
=== Return value ===

Revision as of 17:27, 17 November 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 GetMapPosition (int type) (development version 3.2-alpha and above only)

Usage

Returns the index of the current or next map in the map rotation.

Parameters

  • type: Can be either:
  • MAPPOSITION_CURRENT = 0
The current map being played on.
  • MAPPOSITION_NEXT = 1
The next map that will be entered.

Return value

Returns the map's position in the map rotation (starting from 1). If there is no rotation, or the map currently being played is not in the rotation, then this function returns 0.

Examples

This article lists no examples, please add one.

See also