1,562
edits
(Added page for GetMapRotationInfo.) |
DrinkyBird (talk | contribs) (Add example) Tag: Source edit |
||
(2 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{ACSWarning}} | {{ACSWarning}} | ||
int '''GetMapRotationInfo''' (int ''position'', int ''info'') | int '''GetMapRotationInfo''' (int ''position'', int ''info'') | ||
==Usage== | == Usage == | ||
Retrieves information on a particular entry in the map rotation. | |||
=== Parameters === | |||
* ''position'': The index into the map rotation. This can be 0 to return the current map (printed in green when the <tt>maplist</tt> [[Console Commands|console command]] is used); otherwise it must be between 1 and the value returned by [[GetMapRotationSize]]. | |||
* ''info'': One of: | |||
:*'''MAPROTATION_Name''' = 0 | |||
::The name of the map (e.g. "Entryway"). | |||
:*'''MAPROTATION_LumpName''' = 1 | |||
::The lump name of the map (e.g. "MAP01"). | |||
:*'''MAPROTATION_Used''' = 2 | |||
::Whether or not this map has already been played. Used maps are printed in red when the <tt>maplist</tt> [[Console Commands|console command]] is used. | |||
:*'''MAPROTATION_MinPlayers''' = 3 | |||
::The minimum number of players required to load this level. If this is 0, then there's no minimum limit. | |||
:*'''MAPROTATION_MaxPlayers''' = 4 | |||
::The maximum number of players allowed to load this level. If this is 64, then there's no maximum limit. | |||
=== Return value === | |||
Returns the value of the given property of the specified map rotation entry. | |||
[[category:ACS | == Examples == | ||
<syntaxhighlight lang="c" line="1"> | |||
// This script prints the indices and names of the maps in the rotation when the map loads. | |||
Script 1 OPEN { | |||
int size = GetMapRotationSize(); | |||
Log(d: size, s: " maps are in the rotation."); | |||
// Note: the list starts at 1; position 0 is the current map. | |||
for (int i = 1; i <= size; i++) | |||
{ | |||
Log( | |||
d: i, s: ". ", | |||
s: GetMapRotationInfo(i, MAPROTATION_LumpName), s: " - ", | |||
s: GetMapRotationInfo(i, MAPROTATION_Name) | |||
); | |||
} | |||
} | |||
</syntaxhighlight> | |||
== See also == | |||
* [[GetMapRotationSize]] | |||
[[category:ACS functions]] |