Map manager/Implementation: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Added getGamemodes)
(Automatically fixing double redirect from Map manager to Resource:Mapmanager in a maintenance job)
Tag: Redirect target changed
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
The map manager lists maps and manages gamemode and gamemode map loading.
#REDIRECT [[Resource:Mapmanager]]
 
==Usage==
You have to tag the '''gamemode resource''' with the correct type in its info tag:
<syntaxhighlight lang="xml"><info description="A gamemode" type="gamemode" /></syntaxhighlight>
 
'''Map resources''' also need the ''type="map"'' tag, plus a ''gamemodes'' tag listing the gamemode resources they're compatible with in a comma-separated list ''without spaces''.
<syntaxhighlight lang="xml"><info description="A gamemode map" type="map" gamemodes="ctv,koth" /></syntaxhighlight>
 
There can be only one gamemode and one gamemode map loaded at once.
 
==Commands==
'''changemap newmap [newgamemode]'''
 
'''gamemode newgamemode [newmap]'''
 
==Exported functions==
<syntaxhighlight lang="lua">bool changeGamemode ( resource newGamemode, [ resource mapToLoadWith ] )</syntaxhighlight>
Changes the gamemode to a new one, optionally specifying an initial map for it (will load without a map by default).
<syntaxhighlight lang="lua">bool changeGamemodeMap ( resource newMap, [ resource gamemodeToChangeTo ] )</syntaxhighlight>
Changes the GM map to a new one, optionally specifying a gamemode to change to before loading it (will load with the current gamemode by default).
<syntaxhighlight lang="lua">bool stopGamemode ( )</syntaxhighlight>
Stops the current gamemode and its map.
<syntaxhighlight lang="lua">bool stopGamemodeMap ( )</syntaxhighlight>
Stop the current GM map.
<syntaxhighlight lang="lua">resource getRunningGamemode ( )</syntaxhighlight>
Returns the currently running gamemode's resource pointer.
<syntaxhighlight lang="lua">resource getRunningGamemodeMap ( )</syntaxhighlight>
Returns the currently running GM map's resource pointer.
<syntaxhighlight lang="lua">table getMapsCompatibleWithGamemode ( resource theGamemode )</syntaxhighlight>
Returns a table of compatible map resource pointers.
<syntaxhighlight lang="lua">table getGamemodes ( )</syntaxhighlight>
Returns a table of gamemode resource pointers.
 
==Fired events==
''(For all these events, "source" is the resource's root element.)''
<syntaxhighlight lang="lua">onGamemodeStart ( resource startedGamemode )</syntaxhighlight>
Fired before a gamemode starts.
<syntaxhighlight lang="lua">onGamemodeStop ( resource startedGamemode )</syntaxhighlight>
Fired before a gamemode is stopped.
<syntaxhighlight lang="lua">onGamemodeMapStart ( resource startedMap )</syntaxhighlight>
Fired before a GM map starts.
<syntaxhighlight lang="lua">onGamemodeMapStop ( resource startedMap )</syntaxhighlight>
Fired before a GM map is stopped.

Latest revision as of 11:24, 27 August 2022

Redirect to:

Retrieved from "https://wiki.multitheftauto.com/wiki/Map_manager/Implementation?oldid=75389"