MapDisplayUIControl - Revision history

Phil: /* Map Display UI Control */

2017-06-27T21:11:13Z

Map Display UI Control

← Older revision		Revision as of 21:11, 27 June 2017
Line 1:		Line 1:
	= Map Display UI Control =		= Map Display UI Control =
	<b>NOTE: This UI control is currently not supported</b>		<b>NOTE: This UI control is currently not supported</b>

	The key items for using a control are:		The key items for using a control are:
	== The Height Map ==		== The Height Map ==

Phil at 21:11, 27 June 2017

2017-06-27T21:11:03Z

← Older revision		Revision as of 21:11, 27 June 2017
Line 1:		Line 1:
	= Map Display UI Control =		= Map Display UI Control =
			<b>NOTE: This UI control is currently not supported</b>
	The key items for using a control are:		The key items for using a control are:
	== The Height Map ==		== The Height Map ==

Phil: /* Adding Borders */

2017-01-11T18:27:38Z

Adding Borders

← Older revision		Revision as of 18:27, 11 January 2017
Line 29:		Line 29:
	== Adding Borders ==		== Adding Borders ==
	To add borders you can either enter them by hand (not recommended!), or edit them ingame using the control itself. To do this you must be in debug mode and then hit CTRL+E. You will see the control provide feedback that you are in the editor state. The editor has two modes, Border and Region. In Border mode you can edit, drag, remove, etc points which make up the borders of each territory. Use the LMB to add a point, and the RMB to stop editing the current territory ready to begin a new one (or edit an old one). The backspace key deletes points. To save your progress use CTRL+S (currently this will save to DATA/UI/MAP.DAT in the current campaign. The ability to choose the file to save is TBD).		To add borders you can either enter them by hand (not recommended!), or edit them ingame using the control itself. To do this you must be in debug mode and then hit CTRL+E. You will see the control provide feedback that you are in the editor state. The editor has two modes, Border and Region. In Border mode you can edit, drag, remove, etc points which make up the borders of each territory. Use the LMB to add a point, and the RMB to stop editing the current territory ready to begin a new one (or edit an old one). The backspace key deletes points. To save your progress use CTRL+S (currently this will save to DATA/UI/MAP.DAT in the current campaign. The ability to choose the file to save is TBD).

			There are submodes for the border drawing. They are accessed by the 1234 keys. They are Select, Draw, Delete, Insert. Select allows you to select a given region to edit. Draw allows you to add points, as well as remove them (with BACKSPACE) and switch to a new region (with the RMB). Delete allows you to delete points using the LMB. Insert allows the insertion of points along an existing edge.

			Tip: To delete an existing area entirely the quickest way is to Select it (1), then switch to Draw (2) and add an errant point. Then simply BACKSPACE through all the points on the region until it is gone.

	The I key toggles between Border mode and Region mode, where the territory borders can be viewed as they appear ingame.		The I key toggles between Border mode and Region mode, where the territory borders can be viewed as they appear ingame.

Phil: /* Logic */

2017-01-11T18:24:15Z

Logic

← Older revision		Revision as of 18:24, 11 January 2017
Line 46:		Line 46:
	=== Logic ===		=== Logic ===
	The functions allow for control over how areas are coloured, highlighted, etc. It also allows for UI control (e.g. selection of 3D entities on the map, drag and drop, etc). The key functions are:		The functions allow for control over how areas are coloured, highlighted, etc. It also allows for UI control (e.g. selection of 3D entities on the map, drag and drop, etc). The key functions are:
	<nowiki>//returns the region that the mouse is currently over, -2 if not over the control, -1 if not over a valid area. If all is nonzero, then the first work array has elements 0,1 as the xy map coords (1000ths), and 2,3 set to the selected entity type and id (or -1), 4,5 L/R mouse buttons.		<nowiki>//returns the region that the mouse is currently over, -2 if not over the control, -1 if not over a valid area. If all is nonzero, then the first work array has elements 0,1 as the xy map coords (1000ths),
			// and 2,3 set to the selected entity type and id (or -1), 4,5 L/R mouse buttons, 6 area index.
	MapViewGetMouse(objectName, [all])		MapViewGetMouse(objectName, [all])

Andrewg: /* CAMPAIGNVIEW.TXT */

2016-06-07T19:58:00Z

CAMPAIGNVIEW.TXT

← Older revision		Revision as of 19:58, 7 June 2016
Line 7:		Line 7:
	== CAMPAIGNVIEW.TXT ==		== CAMPAIGNVIEW.TXT ==
	This file works in the same way as MAPVIEW.TXT does for in-battle views. It also lives in DATA (either in the main or local path).		This file works in the same way as MAPVIEW.TXT does for in-battle views. It also lives in DATA (either in the main or local path).

			Additionally, basic lighting can be specified in CAMPAIGNVIEW.TXT by adding a WORLDLIGHT chunk, ex:
			[WORLDLIGHT]
			DIRECTION 1, -1, 1
			COLOUR 0.95 0.95 0.95
			AMBIENT 0.35 0.35 0.35

	== Using a Map Display ==		== Using a Map Display ==
	Once you have a heightmap and a map image, you can see the map ingame. Add the control to a UI txt file as normal - the below example could be the base for a custom campaign screen:		Once you have a heightmap and a map image, you can see the map ingame. Add the control to a UI txt file as normal - the below example could be the base for a custom campaign screen:

Phil: /* Adding Borders */

2016-05-31T20:10:12Z

Adding Borders

← Older revision		Revision as of 20:10, 31 May 2016
Line 25:		Line 25:
	The I key toggles between Border mode and Region mode, where the territory borders can be viewed as they appear ingame.		The I key toggles between Border mode and Region mode, where the territory borders can be viewed as they appear ingame.

	Once you have saved a MAP.DAT file (which is a text file) you can tweak it should you desire, allowing you to use alternate textures for height and display, and also to change the height scaling of the map, as well as the scaling of its axes.		Once you have saved a MAP.DAT file (which is a text file) you can tweak it should you desire, allowing you to use alternate textures for height and display, and also to change the height scaling of the map, as well as the scaling of its axes, and tweaking the height of the borders above the terrain.

	== Attaching Data ==		== Attaching Data ==

Phil at 20:06, 31 May 2016

2016-05-31T20:06:58Z

← Older revision		Revision as of 20:06, 31 May 2016
Line 5:		Line 5:
	== The Map Image ==		== The Map Image ==
	This image is used to texture the map, and can be any valid image format. The default name is MAP.TGA (or DDS, etc). It should be in the DATA/UI/TEXTURES folder also. Note that these texture names are customisable if needed using the scenario file (see below).		This image is used to texture the map, and can be any valid image format. The default name is MAP.TGA (or DDS, etc). It should be in the DATA/UI/TEXTURES folder also. Note that these texture names are customisable if needed using the scenario file (see below).
			== CAMPAIGNVIEW.TXT ==
			This file works in the same way as MAPVIEW.TXT does for in-battle views. It also lives in DATA (either in the main or local path).
	== Using a Map Display ==		== Using a Map Display ==
	Once you have a heightmap and a map image, you can see the map ingame. Add the control to a UI txt file as normal - the below example could be the base for a custom campaign screen:		Once you have a heightmap and a map image, you can see the map ingame. Add the control to a UI txt file as normal - the below example could be the base for a custom campaign screen:

Phil: /* Adding Borders */

2016-05-31T19:55:04Z

Adding Borders

← Older revision		Revision as of 19:55, 31 May 2016
Line 22:		Line 22:

	The I key toggles between Border mode and Region mode, where the territory borders can be viewed as they appear ingame.		The I key toggles between Border mode and Region mode, where the territory borders can be viewed as they appear ingame.

			Once you have saved a MAP.DAT file (which is a text file) you can tweak it should you desire, allowing you to use alternate textures for height and display, and also to change the height scaling of the map, as well as the scaling of its axes.

	== Attaching Data ==		== Attaching Data ==
	The simplest way to attach data to your map is using the LoadVariableFromParserFile command, loading data into your own variable which matches with the respective area (territory) you have defined.		The simplest way to attach data to your map is using the LoadVariableFromParserFile command, loading data into your own variable which matches with the respective area (territory) you have defined.

Phil at 19:52, 31 May 2016

2016-05-31T19:52:51Z

@@ Line 23: / Line 23: @@
 The I key toggles between Border mode and Region mode, where the territory borders can be viewed as they appear ingame.
 == Attaching Data ==
-The simplest way to attach data to your map is using the
+The simplest way to attach data to your map is using the LoadVariableFromParserFile command, loading data into your own variable which matches with the respective area (territory) you have defined.

Phil at 18:04, 31 May 2016

2016-05-31T18:04:10Z

← Older revision		Revision as of 18:04, 31 May 2016
Line 17:		Line 17:
	script CAMPAIGN.BSF		script CAMPAIGN.BSF
	handler QUESTHANDLER</nowiki>		handler QUESTHANDLER</nowiki>
			Note the file MAP.DAT entry. This is placeholder for data we will generate later, The control will load the default files when this is missing.
			== Adding Borders ==
			To add borders you can either enter them by hand (not recommended!), or edit them ingame using the control itself. To do this you must be in debug mode and then hit CTRL+E. You will see the control provide feedback that you are in the editor state. The editor has two modes, Border and Region. In Border mode you can edit, drag, remove, etc points which make up the borders of each territory. Use the LMB to add a point, and the RMB to stop editing the current territory ready to begin a new one (or edit an old one). The backspace key deletes points. To save your progress use CTRL+S (currently this will save to DATA/UI/MAP.DAT in the current campaign. The ability to choose the file to save is TBD).

			The I key toggles between Border mode and Region mode, where the territory borders can be viewed as they appear ingame.
			== Attaching Data ==
			The simplest way to attach data to your map is using the