The civ.ui library - Revision history

Prof. Garfield: Added to category lua resources

2019-01-26T20:09:22Z

Added to category lua resources

← Older revision		Revision as of 20:09, 26 January 2019
Line 1:		Line 1:
	[[Category:Resources]]		[[Category:Lua Resources]]

	Back To [[TOTPP Functions]]		Back To [[TOTPP Functions]]

Prof. Garfield: Put code tags in the code lines

2019-01-01T22:06:15Z

Put code tags in the code lines

← Older revision		Revision as of 22:06, 1 January 2019
Line 6:		Line 6:
	[[civ.ui.centerView\|centerView]]		[[civ.ui.centerView\|centerView]]

	civ.ui.centerView(tile)		<code>civ.ui.centerView(tile)</code>

	Centers the map on the given tile.		Centers the map on the given tile.
Line 13:		Line 13:
	[[civ.ui.redrawMap\|redrawMap]]		[[civ.ui.redrawMap\|redrawMap]]

	civ.ui.redrawMap()		<code>civ.ui.redrawMap()</code>

	Redraws the entire map.		Redraws the entire map.
Line 20:		Line 20:
	[[civ.ui.redrawTile\|redrawTile]]		[[civ.ui.redrawTile\|redrawTile]]

	civ.ui.redrawTile(tile)		<code>civ.ui.redrawTile(tile)</code>

	Redraws the given tile.		Redraws the given tile.
Line 27:		Line 27:
	[[civ.ui.setZoom\|setZoom]]		[[civ.ui.setZoom\|setZoom]]

	civ.ui.setZoom(integer)		<code>civ.ui.setZoom(integer)</code>

	Sets the zoom level (range from -7 (max zoom out) to 8 (max zoom in)).		Sets the zoom level (range from -7 (max zoom out) to 8 (max zoom in)).
Line 34:		Line 34:
	[[civ.ui.text\|text]]		[[civ.ui.text\|text]]

	civ.ui.text(string)		<code>civ.ui.text(string)</code>

	Display a pop-up text box with the given string as text.		Display a pop-up text box with the given string as text.
Line 41:		Line 41:
	[[civ.ui.zoomIn\|zoomIn]]		[[civ.ui.zoomIn\|zoomIn]]

	civ.ui.zoomIn()		<code>civ.ui.zoomIn()</code>

	Zooms in on the map (increases zoom level by 1).		Zooms in on the map (increases zoom level by 1).
Line 48:		Line 48:
	[[civ.ui.zoomOut\|zoomOut]]		[[civ.ui.zoomOut\|zoomOut]]

	civ.ui.zoomOut()		<code>civ.ui.zoomOut()</code>

	Zooms out of the map (decreases zoom level by 1).		Zooms out of the map (decreases zoom level by 1).
Line 55:		Line 55:
	[[civ.ui.loadTerrain\|loadTerrain]]		[[civ.ui.loadTerrain\|loadTerrain]]

	civ.ui.loadTerrain(map, filename1, filename2)		<code>civ.ui.loadTerrain(map, filename1, filename2)</code>

	Replaces terrain graphics for map number `map`, loading graphics from `filename1` (corresponding to "TERRAIN1.BMP") and `filename2` (corresponding to "TERRAIN2.BMP")		Replaces terrain graphics for map number `map`, loading graphics from `filename1` (corresponding to "TERRAIN1.BMP") and `filename2` (corresponding to "TERRAIN2.BMP")
Line 62:		Line 62:
	[[civ.ui.createDialog\|createDialog]]		[[civ.ui.createDialog\|createDialog]]

	civ.ui.createDialog() -> dialog		<code>civ.ui.createDialog() -> dialog</code>

	Creates and initializes a dialog. See the [[The dialog object\|dialog]] section for more details.		Creates and initializes a dialog. See the [[The dialog object\|dialog]] section for more details.

Prof. Garfield at 21:50, 1 January 2019

2019-01-01T21:50:30Z

← Older revision		Revision as of 21:50, 1 January 2019
Line 44:		Line 44:

	Zooms in on the map (increases zoom level by 1).		Zooms in on the map (increases zoom level by 1).


	[[civ.ui.zoomOut\|zoomOut]]		[[civ.ui.zoomOut\|zoomOut]]


	civ.ui.zoomOut()		civ.ui.zoomOut()

Prof. Garfield at 21:50, 1 January 2019

2019-01-01T21:50:00Z

← Older revision		Revision as of 21:50, 1 January 2019
Line 46:		Line 46:

	[[civ.ui.zoomOut\|zoomOut]]		[[civ.ui.zoomOut\|zoomOut]]


	civ.ui.zoomOut()		civ.ui.zoomOut()

	Zooms out of the map (decreases zoom level by 1).		Zooms out of the map (decreases zoom level by 1).


	[[civ.ui.loadTerrain\|loadTerrain]]		[[civ.ui.loadTerrain\|loadTerrain]]
Line 56:		Line 58:

	Replaces terrain graphics for map number `map`, loading graphics from `filename1` (corresponding to "TERRAIN1.BMP") and `filename2` (corresponding to "TERRAIN2.BMP")		Replaces terrain graphics for map number `map`, loading graphics from `filename1` (corresponding to "TERRAIN1.BMP") and `filename2` (corresponding to "TERRAIN2.BMP")


	[[civ.ui.createDialog\|createDialog]]		[[civ.ui.createDialog\|createDialog]]

Prof. Garfield: Changed the names of the linked to pages, so that they are the full command (for clarity and to prevent conflicts)

2019-01-01T21:49:06Z

Changed the names of the linked to pages, so that they are the full command (for clarity and to prevent conflicts)

← Older revision		Revision as of 21:49, 1 January 2019
Line 4:		Line 4:

	----		----
	~~Follow the link in the function name for additional information about that function, if it is available.~~		[[civ.ui.centerView\|centerView]]


	[[centerView]]

	civ.ui.centerView(tile)		civ.ui.centerView(tile)
Line 14:		Line 11:


	[[redrawMap]]		[[civ.ui.redrawMap\|redrawMap]]

	civ.ui.redrawMap()		civ.ui.redrawMap()
Line 21:		Line 18:


	[[redrawTile]]		[[civ.ui.redrawTile\|redrawTile]]

	civ.ui.redrawTile(tile)		civ.ui.redrawTile(tile)
Line 28:		Line 25:


	[[setZoom]]		[[civ.ui.setZoom\|setZoom]]

	civ.ui.setZoom(integer)		civ.ui.setZoom(integer)
Line 35:		Line 32:


	[[text]]		[[civ.ui.text\|text]]

	civ.ui.text(string)		civ.ui.text(string)
Line 42:		Line 39:


	[[zoomIn]]		[[civ.ui.zoomIn\|zoomIn]]

	civ.ui.zoomIn()		civ.ui.zoomIn()
Line 48:		Line 45:
	Zooms in on the map (increases zoom level by 1).		Zooms in on the map (increases zoom level by 1).

			[[civ.ui.zoomOut\|zoomOut]]
	[[zoomOut]]

	civ.ui.zoomOut()		civ.ui.zoomOut()
Line 55:		Line 51:
	Zooms out of the map (decreases zoom level by 1).		Zooms out of the map (decreases zoom level by 1).

			[[civ.ui.loadTerrain\|loadTerrain]]
	[[loadTerrain]]

	civ.ui.loadTerrain(map, filename1, filename2)		civ.ui.loadTerrain(map, filename1, filename2)
Line 62:		Line 57:
	Replaces terrain graphics for map number `map`, loading graphics from `filename1` (corresponding to "TERRAIN1.BMP") and `filename2` (corresponding to "TERRAIN2.BMP")		Replaces terrain graphics for map number `map`, loading graphics from `filename1` (corresponding to "TERRAIN1.BMP") and `filename2` (corresponding to "TERRAIN2.BMP")

			[[civ.ui.createDialog\|createDialog]]
	[[createDialog]]

	civ.ui.createDialog() -> dialog		civ.ui.createDialog() -> dialog

	Creates and initializes a dialog. See the [[dialog]] section for more details.		Creates and initializes a dialog. See the [[The dialog object\|dialog]] section for more details.

Prof. Garfield at 20:58, 1 January 2019

2019-01-01T20:58:36Z

← Older revision		Revision as of 20:58, 1 January 2019
Line 4:		Line 4:

	----		----
			Follow the link in the function name for additional information about that function, if it is available.


	[[centerView]]		[[centerView]]

Prof. Garfield: New page for civ.ui library

2019-01-01T20:57:17Z

New page for civ.ui library

New page

[[Category:Resources]]

Back To [[TOTPP Functions]]

----

[[centerView]]

civ.ui.centerView(tile)

Centers the map on the given tile.

[[redrawMap]]

civ.ui.redrawMap()

Redraws the entire map.

[[redrawTile]]

civ.ui.redrawTile(tile)

Redraws the given tile.

[[setZoom]]

civ.ui.setZoom(integer)

Sets the zoom level (range from -7 (max zoom out) to 8 (max zoom in)).

[[text]]

civ.ui.text(string)

Display a pop-up text box with the given string as text.

[[zoomIn]]

civ.ui.zoomIn()

Zooms in on the map (increases zoom level by 1).

[[zoomOut]]

civ.ui.zoomOut()

Zooms out of the map (decreases zoom level by 1).

[[loadTerrain]]

civ.ui.loadTerrain(map, filename1, filename2)

Replaces terrain graphics for map number `map`, loading graphics from `filename1` (corresponding to "TERRAIN1.BMP") and `filename2` (corresponding to "TERRAIN2.BMP")

[[createDialog]]

civ.ui.createDialog() -> dialog

Creates and initializes a dialog. See the [[dialog]] section for more details.