Writing Gamemodes - Revision history

Haxardous at 19:49, 19 April 2020

2020-04-19T19:49:46Z

← Older revision		Revision as of 19:49, 19 April 2020
Line 4:		Line 4:

	==What does "proper gamemode" mean?==		==What does "proper gamemode" mean?==
	To put it simply, a proper gamemode is one that makes full use of MTA's .map file system. This means that the gamemode code does not have any map-specific data hardcoded in it, like positions of players or cars. Instead, the gamemode should be able to load .map files which define these data. This way the gamemode can have multiple maps; also, people can create .map files for the gamemode with MTA's map editor, which is much more convenient than writing code.		To put it simply, a proper gamemode is one that makes full use of MTA's .map file system. This means that the gamemode code does not have any map-specific data hardcoded in it, like the positions of players or cars. Instead, the gamemode should be able to load .map files which define these data. This way the gamemode can have multiple maps; also, people can create .map files for the gamemode with MTA's map editor, which is much more convenient than writing code.

	An obvious example of a "proper gamemode" is MTA:Race. It allows ~~usermade~~ maps with lots of possibilities within the .map file. To alter spawnpoints, objects etc., the user doesn't need to edit the gamemode itself.		An obvious example of a "proper gamemode" is MTA:Race. It allows user-made maps with lots of possibilities within the .map file. To alter spawnpoints, objects, etc., the user doesn't need to edit the gamemode itself.

	===Map Files===		===Map Files===
	Map files are basically XML documents with a .map extension. They define an environment to play one or more specific gamemodes in. They are however not supposed to change the rules of the game - those are defined by the gamemode.		Map files are basically XML documents with a .map extension. They define an environment to play one or more specific gamemodes in. They are however not supposed to change the rules of the game - those are defined by the gamemode.

	Each element in a map corresponds to a node in the .map file. There is standard syntax for common things like spawnpoints, objects and vehicles; however, for "special", gamemode specific information, you need to invent your own syntax.		Each element in a map corresponds to a node in the .map file. There is standard syntax for common things like spawnpoints, objects, and vehicles; however, for "special", gamemode specific information, you need to invent your own syntax.

	====Example====		====Example====
Line 24:		Line 24:
	</syntaxhighlight>		</syntaxhighlight>

	Here you can see two MTA elements - a spawnpoint and a pickup. More importantly, this .map has a custom "flag" node ~~which~~ defines the position and color of the flag. The spawnpoint and pickup can be handled by existing external resources, custom elements have to be processed by the gamemode.		Here you can see two MTA elements - a spawnpoint and a pickup. More importantly, this .map has a custom "flag" node that defines the position and color of the flag. The spawnpoint and pickup can be handled by existing external resources, custom elements have to be processed by the gamemode.

	To summarize - we want mass mapper input as we saw in MTA:Race. Users should NOT have to touch the gamemode script itself at all.		To summarize - we want mass mapper input as we saw in MTA:Race. Users should NOT have to touch the gamemode script itself at all.
Line 71:		Line 71:
	* onGamemodeMapStop (if any unloading is necessary)		* onGamemodeMapStop (if any unloading is necessary)
	These are fired when a map for your gamemode is started or stopped, and pass the map resource as a parameter.		These are fired when a map for your gamemode is started or stopped, and pass the map resource as a parameter.
	Within the handler function for these events you can extract all info you need from the resource's map files and configuration files.		Within the handler function for these events, you can extract all info you need from the resource's map files and configuration files.

	====Example====		====Example====
Line 107:		Line 107:
	The helpmanager is ought to be the standard interface for players when they need help. If you use the helpmanager to display your gamemode's help, every player that used helpmanager before (e.g. in other gamemodes) will immediately know how to get there. It also displays help for different resources running resources in one window, if necessary.		The helpmanager is ought to be the standard interface for players when they need help. If you use the helpmanager to display your gamemode's help, every player that used helpmanager before (e.g. in other gamemodes) will immediately know how to get there. It also displays help for different resources running resources in one window, if necessary.

	There are ~~basicially~~ two ways to use the helpmanager:		There are basically two ways to use the helpmanager:
	* Provide a simple text that explains how to use your gamemode		* Provide a simple text that explains how to use your gamemode
	* Request a GUI element from the helpmanager that will be displayed in its own tab in the helpmanager window and lets you add any GUI elements to it. This is the recommended way for gamemodes that need to display more complex information that needs its own GUI.		* Request a GUI element from the helpmanager that will be displayed in its own tab in the helpmanager window and lets you add any GUI elements to it. This is the recommended way for gamemodes that need to display more complex information that needs its own GUI.
Line 114:		Line 114:

	===Scoreboard===		===Scoreboard===
	~~Scoreboard~~ displays players and teams currently ~~ingame~~. You add custom columns to it to provide map specific information. For example the column 'points' in the 'ctf' gamemode could represent the player's points gained through kills or captures. As usual, see the [[Resource:Dxscoreboard\|scoreboard help page]] for more information.		The scoreboard displays players and teams currently in-game. You add custom columns to it to provide map specific information. For example the column 'points' in the 'ctf' gamemode could represent the player's points gained through kills or captures. As usual, see the [[Resource:Dxscoreboard\|scoreboard help page]] for more information.

	===Map cycler===		===Map cycler===
	The map cycler controls what gamemodes and maps are played on a server. You can ~~specifiy~~ for example how many times in a row a map will be played until it switches to the next. To achieve this, you need to tell the map cycler when your gamemode finished (e.g. when a round ends).		The map cycler controls what gamemodes and maps are played on a server. You can specify for example how many times in a row a map will be played until it switches to the next. To achieve this, you need to tell the map cycler when your gamemode finished (e.g. when a round ends).

	[[hu:Writing Gamemodes]]		[[hu:Writing Gamemodes]]

Myonlake: Undo revision 58223 by WolfPiotrK2 (talk)

2018-08-16T12:49:39Z

Undo revision 58223 by WolfPiotrK2 (talk)

Show changes

WolfPiotrK2: Replaced content with "Image:mtapl.jpg"

2018-08-16T12:47:05Z

Replaced content with "Image:mtapl.jpg"

Show changes

Surge at 12:51, 30 July 2018

2018-07-30T12:51:33Z

← Older revision		Revision as of 12:51, 30 July 2018
Line 119:		Line 119:
	The map cycler controls what gamemodes and maps are played on a server. You can specifiy for example how many times in a row a map will be played until it switches to the next. To achieve this, you need to tell the map cycler when your gamemode finished (e.g. when a round ends).		The map cycler controls what gamemodes and maps are played on a server. You can specifiy for example how many times in a row a map will be played until it switches to the next. To achieve this, you need to tell the map cycler when your gamemode finished (e.g. when a round ends).

			[[hu:Writing Gamemodes]]
	[[it:Scrivere una gamemode]]		[[it:Scrivere una gamemode]]
	[[ru:Writing Gamemodes]]		[[ru:Writing Gamemodes]]
	[[de:Gamemodes schreiben]]		[[de:Gamemodes schreiben]]
	[[Category:Tutorials]]		[[Category:Tutorials]]

JHXP: Reverted edits by Marcin778 (talk) to last revision by MrTasty

2017-01-01T18:44:04Z

Reverted edits by Marcin778 (talk) to last revision by MrTasty

Show changes

Marcin778 at 18:11, 1 January 2017

2017-01-01T18:11:30Z

Show changes

MrTasty: /* Helpmanager */

2015-08-24T06:49:36Z

Helpmanager

← Older revision		Revision as of 06:49, 24 August 2015
Line 111:		Line 111:
	* Request a GUI element from the helpmanager that will be displayed in its own tab in the helpmanager window and lets you add any GUI elements to it. This is the recommended way for gamemodes that need to display more complex information that needs its own GUI.		* Request a GUI element from the helpmanager that will be displayed in its own tab in the helpmanager window and lets you add any GUI elements to it. This is the recommended way for gamemodes that need to display more complex information that needs its own GUI.

	Read the helpmanager page for details on how to do it.		Read the [[Resource:Helpmanager\|helpmanager help page]] for details on how to do it.

	===Scoreboard===		===Scoreboard===

MrTasty: /* Scoreboard */

2015-08-24T06:49:34Z

Scoreboard

← Older revision		Revision as of 06:49, 24 August 2015
Line 114:		Line 114:

	===Scoreboard===		===Scoreboard===
	Scoreboard displays players and teams currently ingame. You add custom columns to it to provide map specific information. For example the column 'points' in the 'ctf' gamemode could represent the player's points gained through kills or captures. As usual, see the scoreboard help page for more information.		Scoreboard displays players and teams currently ingame. You add custom columns to it to provide map specific information. For example the column 'points' in the 'ctf' gamemode could represent the player's points gained through kills or captures. As usual, see the [[Resource:Dxscoreboard\|scoreboard help page]] for more information.

	===Map cycler===		===Map cycler===

Qaisjp at 00:58, 8 June 2014

2014-06-08T00:58:49Z

← Older revision		Revision as of 00:58, 8 June 2014
Line 122:		Line 122:
	[[ru:Writing Gamemodes]]		[[ru:Writing Gamemodes]]
	[[de:Gamemodes schreiben]]		[[de:Gamemodes schreiben]]
			[[Category:Tutorials]]

Qaisjp: Qais moved page Tutorial/Writing Gamemodes to Writing Gamemodes over redirect: Move back.

2014-06-08T00:58:28Z

Qais moved page Tutorial/Writing Gamemodes to Writing Gamemodes over redirect: Move back.

← Older revision

Revision as of 00:58, 8 June 2014