Map manager/Implementation - Revision history

Redirect fixer: Automatically fixing double redirect from Map manager to Resource:Mapmanager in a maintenance job

2022-08-27T11:24:37Z

Automatically fixing double redirect from Map manager to Resource:Mapmanager in a maintenance job

← Older revision		Revision as of 11:24, 27 August 2022
Line 1:		Line 1:
	#REDIRECT [[~~Map_manager~~]]		#REDIRECT [[Resource:Mapmanager]]

Jbeta at 12:15, 9 July 2007

2007-07-09T12:15:46Z

← Older revision		Revision as of 12:15, 9 July 2007
Line 1:		Line 1:
	~~The map manager lists maps and manages gamemode and gamemode map loading.~~		#REDIRECT [[Map_manager]]

	~~==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.~~

Jbeta: Added getGamemodes

2007-07-07T15:40:21Z

Added getGamemodes

← Older revision		Revision as of 15:40, 7 July 2007
Line 30:		Line 30:
	<syntaxhighlight lang="lua">table getMapsCompatibleWithGamemode ( resource theGamemode )</syntaxhighlight>		<syntaxhighlight lang="lua">table getMapsCompatibleWithGamemode ( resource theGamemode )</syntaxhighlight>
	Returns a table of compatible map resource pointers.		Returns a table of compatible map resource pointers.
			<syntaxhighlight lang="lua">table getGamemodes ( )</syntaxhighlight>
			Returns a table of gamemode resource pointers.

	==Fired events==		==Fired events==

Jbeta at 15:03, 5 July 2007

2007-07-05T15:03:00Z

← Older revision		Revision as of 15:03, 5 July 2007
Line 32:		Line 32:

	==Fired events==		==Fired events==
			''(For all these events, "source" is the resource's root element.)''
	<syntaxhighlight lang="lua">onGamemodeStart ( resource startedGamemode )</syntaxhighlight>		<syntaxhighlight lang="lua">onGamemodeStart ( resource startedGamemode )</syntaxhighlight>
	Fired before a gamemode starts.		Fired before a gamemode starts.

Jbeta: Updated

2007-07-03T22:00:34Z

Updated

Jbeta at 21:47, 2 June 2007

2007-06-02T21:47:18Z

New page

The map manager lists maps and manages gamemode and gamemode map loading.

==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>

Maps 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>

==Fired events==
<syntaxhighlight lang="lua">onGamemodeStart ( resource startedGamemode )</syntaxhighlight>
Fired before a gamemode starts. Can be cancelled to prevent it from starting.
<syntaxhighlight lang="lua">onGamemodeStop ( resource startedGamemode )</syntaxhighlight>
Fired before a gamemode is stopped. Can be cancelled to prevent it from stopping (unless it wasn't stopped through the manager).
<syntaxhighlight lang="lua">onGamemodeMapStart ( resource startedMap )</syntaxhighlight>
Fired before a GM map starts. Can be cancelled to prevent it from starting.
<syntaxhighlight lang="lua">onGamemodeMapStop ( resource startedMap )</syntaxhighlight>
Fired before a GM map is stopped. Can be cancelled to prevent it from stopping (unless it wasn't stopped through the manager).

← Older revision		Revision as of 22:00, 3 July 2007
Line 5:		Line 5:
	<syntaxhighlight lang="xml"><info description="A gamemode" type="gamemode" /></syntaxhighlight>		<syntaxhighlight lang="xml"><info description="A gamemode" type="gamemode" /></syntaxhighlight>

	~~Maps~~ 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.		'''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>		<syntaxhighlight lang="xml"><info description="A gamemode map" type="map" gamemodes="ctv,koth" /></syntaxhighlight>

Line 28:		Line 28:
	<syntaxhighlight lang="lua">resource getRunningGamemodeMap ( )</syntaxhighlight>		<syntaxhighlight lang="lua">resource getRunningGamemodeMap ( )</syntaxhighlight>
	Returns the currently running GM map's resource pointer.		Returns the currently running GM map's resource pointer.
	</syntaxhighlight>		<syntaxhighlight lang="lua">table getMapsCompatibleWithGamemode ( resource theGamemode )</syntaxhighlight>
			Returns a table of compatible map resource pointers.

	==Fired events==		==Fired events==
	<syntaxhighlight lang="lua">onGamemodeStart ( resource startedGamemode )</syntaxhighlight>		<syntaxhighlight lang="lua">onGamemodeStart ( resource startedGamemode )</syntaxhighlight>
	Fired before a gamemode starts~~. Can be cancelled to prevent it from starting~~.		Fired before a gamemode starts.
	<syntaxhighlight lang="lua">onGamemodeStop ( resource startedGamemode )</syntaxhighlight>		<syntaxhighlight lang="lua">onGamemodeStop ( resource startedGamemode )</syntaxhighlight>
	Fired before a gamemode is stopped~~. Can be cancelled to prevent it from stopping (unless it wasn't stopped through the manager)~~.		Fired before a gamemode is stopped.
	<syntaxhighlight lang="lua">onGamemodeMapStart ( resource startedMap )</syntaxhighlight>		<syntaxhighlight lang="lua">onGamemodeMapStart ( resource startedMap )</syntaxhighlight>
	Fired before a GM map starts~~. Can be cancelled to prevent it from starting~~.		Fired before a GM map starts.
	<syntaxhighlight lang="lua">onGamemodeMapStop ( resource startedMap )</syntaxhighlight>		<syntaxhighlight lang="lua">onGamemodeMapStop ( resource startedMap )</syntaxhighlight>
	Fired before a GM map is stopped~~. Can be cancelled to prevent it from stopping (unless it wasn't stopped through the manager)~~.		Fired before a GM map is stopped.