ResetMap: Difference between revisions

From Zandronum Wiki
No edit summary
Tag: Source edit
No edit summary
Tag: Source edit
 
Line 8: Line 8:


Example GAMEMODE lump:
Example GAMEMODE lump:
<syntaxhighlight line="1">
<syntaxhighlight lang="text">
Cooperative  
Cooperative  
{
{

Latest revision as of 00:41, 3 July 2022

This article documents a Zandronum-specific ACS feature which may not be supported by ZDoom and its other child ports.

bool ResetMap (void)

Usage

Resets the map, akin to Survival after a mission start or fail. Everything will be restored as it was when the map first started. The map will be reset after the tic ends, any commands stated immediately after ResetMap will be executed before the map actually is reset.

In order to use this function, the MapResets flag must be set for the gamemode in question. It is set by default in Survival, (T)LMS, Invasion and Duel. For other modes, including possession which actually does not do map resets, the flag must be set via the GAMEMODE lump. This is because storing the original state for actors uses additional memory on the server.

Example GAMEMODE lump:

Cooperative 
{
    addflag MAPRESETS
}

Return value

Returns true if the map reset was requested successfully; otherwise returns false and prints a message to the server console.

Examples

Script 5 DEATH
{
    PrintBold(s: "You've died! Restarting map.");
    Delay(90);
    ResetMap();
}