Fix #18665, #18559: Add API for getting g2 icons by name

[spacek531]

This PR attempts to solve the issues created by #18497. It creates an API to get G2 icons by string. It allows plugin creators to use strings to refer to icons by name instead of a hardcoded number. Plugins with old targetAPI will map to the new scheme and plugins with old targetAPI will map back to the old scheme when requesting the icon from the button (just in case).

[spacek531]

Does anyone know what's going on with the linux build?

[ltsSmitty]

Since the type in the d.ts isn't an Enum, can you alphabetize the list of icon names for legibility?

[Basssiiie]

Looks good to me. Thank you so much for putting your time into this, much appreciated! 🤩

How it looks ingame:

[spacek531]

I've added a reverse map when getting the image number since it's theoretically possible a plugin would want that.

[Gymnasiast]

From a quick glance, the implementation looks sound. Would want to test it, and have @IntelOrca do his own review.

[IntelOrca]

Is there a reason to allow the enum for anything other than getIcon, and just call getIcon when populating the window desc.

[spacek531]

It seemed easier to be able to write a string directly to the widget description than require getIcon. @Basssiiie @ltsSmitty you are the primary users, what do you think?

[Basssiiie]

I'd say the enum as it is currently implemented is more convenient. Why add additional steps if it can be done in one step? It keeps it easy. :)

[Gymnasiast]

Re-requested a review from @Basssiiie to be sure, but looks good to me now.

[Basssiiie]

Accessing sprites by G2 name:

Accessing by legacy id for old plugins:

Accessing via getIcon() on newer plugins:

Code for test plugin:

const icons = [
	[ "empty",  32248 ],
	[ "placeholder",  29363 ],
	[ "logo",  29357 ],
	[ "logo_text",  29358 ],
	[ "fast_forward",  29359 ],
	[ "game_speed_indicator",  29360 ],
	[ "game_speed_indicator_double",  29361 ],
	[ "map_gen_land",  29362 ],
	[ "zoom_in",  29364 ],
	[ "zoom_in_background",  29365 ],
	[ "zoom_out",  29366 ],
	[ "zoom_out_background",  29367 ],
	[ "map_gen_trees",  29368 ],
	[ "map_gen_noise",  29369 ],
	[ "large_scenery",  29370 ],
	[ "small_scenery",  29371 ],
	[ "paths",  29372 ],
	[ "rct1_close_off",  29373 ],
	[ "rct1_close_off_pressed",  29374 ],
	[ "rct1_close_on",  29375 ],
	[ "rct1_close_on_pressed",  29376 ],
	[ "rct1_test_off",  29377 ],
	[ "rct1_test_off_pressed",  29378 ],
	[ "rct1_test_on",  29379 ],
	[ "rct1_test_on_pressed",  29380 ],
	[ "rct1_open_off",  29381 ],
	[ "rct1_open_off_pressed",  29382 ],
	[ "rct1_open_on",  29383 ],
	[ "rct1_open_on_pressed",  29384 ],
	[ "title_restart",  29385 ],
	[ "title_stop",  29386 ],
	[ "title_play",  29387 ],
	[ "title_skip",  29388 ],
	[ "cheats",  29389 ],
	[ "news_messages",  29414 ],
	[ "server_password",  29415 ],
	[ "multiplayer",  29416 ],
	[ "sort",  29433 ],
	[ "copy",  29434 ],
	[ "paste",  29435 ],
	[ "mute",  29442 ],
	[ "mute_pressed",  29443 ],
	[ "unmute",  29444 ],
	[ "unmute_pressed",  29445 ],
	[ "search",  29461 ],
	[ "eyedropper",  29467 ],
	[ "chat",  29468 ],
	[ "map_north",  29469 ],
	[ "map_north_pressed",  29470 ],
	[ "map_west",  29471 ],
	[ "map_west_pressed",  29472 ],
	[ "map_south",  29473 ],
	[ "map_south_pressed",  29474 ],
	[ "map_east",  29475 ],
	[ "map_east_pressed",  29476 ],
	[ "multiplayer_toolbar",  29477 ],
	[ "multiplayer_toolbar_pressed",  29478 ],
	[ "multiplayer_sync",  29479 ],
	[ "multiplayer_desync",  29480 ],
	[ "simulate",  29481 ],
	[ "rct1_simulate_off",  29482 ],
	[ "rct1_simulate_off_pressed",  29483 ],
	[ "rct1_simulate_on",  29484 ],
	[ "rct1_simulate_on_pressed",  29485 ],
	[ "normal_selection_6x6",  29486 ],
	[ "mountain_tool_even",  29487 ],
	[ "mountain_tool_odd",  29488 ],
	[ "scenery_scatter_low",  29489 ],
	[ "scenery_scatter_medium",  29490 ],
	[ "scenery_scatter_high",  29491 ],
	[ "view",  29494 ],
	[ "path_railings",  29495 ],
	[ "legacy_paths",  29496 ],
	[ "path_surface",  29497 ],
	[ "ride_station",  29498 ],
	[ "terrain_edge",  29499 ],
	[ "hide_vegetation",  29500 ],
	[ "hide_scenery",  29501 ],
	[ "hide_vehicles",  29502 ],
	[ "hide_supports",  29503 ],
	[ "hide_partial",  29504 ],
	[ "hide_full",  29505 ],
	[ "link_chain",  29506 ],
	[ "sideways_tab",  29507 ],
	[ "sideways_tab_active",  29508 ],
	[ "arrow_up",  29509 ],
	[ "arrow_down",  29510 ],
	[ "reload",  29511 ],
].sort(function(a, b) { return a[0].localeCompare(b[0]) });

registerPlugin({
	name: 'Test G2',
	version: '1',
	authors: ['Basssiiie'],
	type: 'remote',
	licence: 'MIT',
	//targetApiVersion: 65,
	main() {
		ui.registerMenuItem("Test G2 icons", function()
		{
			ui.openWindow({
				classification: "g2-test", title: "G2 test",
				x: 20, y: 50, width: 1800, height: 900,
				tabs: [
					{
						image: "zoom_in",
						widgets: create("new g2 name", icons, function(icon) { return icon[0] })
					},
					{
						image: 29499, // terrain edge shovel
						widgets: create("legacy id", icons, function(icon) { return icon[1] })
					},
					{
						image: context.getIcon("chat"),
						widgets: create("getIcon()", icons, function(icon) { return context.getIcon(icon[0]) })
					}
				]
			});
		});
	},
});


function create(name, icons, getId)
{
	var widgets = [
		{ type: "label", text: name, x: 100, y: 30, width: 200, height: 20 },
	];
	var columns = 14
	var span = 130;

	for (var i = 0; i < icons.length; i++)
	{
		var icon = icons[i];
		var id = getId(icon);
		var x = 20 + (i % columns) * span;
		var y = 50 + Math.floor(i / columns) * span;
		widgets.push({
			type: "button", image: id, x: x, y: y, width: 32, height: 32
		});
		widgets.push({
			type: "label", text: (icon[0] + "\n" + icon[1]), x: x, y: y + 40, width: span, height: 32
		});
	}
	return widgets;
}

So besides the few small issues, LGTM! Thank you all for your time.

[Gymnasiast]

Please fix the icon names as I requested.

Also change G2Names.hpp to IconNames.hpp - icons from g1 should be added as well (in another PR, preferably).

[IntelOrca]

Also change G2Names.hpp to IconNames.hpp - icons from g1 should be added as well (in another PR, preferably).

Use IconNames.h. .hpp is for header-only implementations (i.e. fully implemented classes or functions without a .cpp file).

[Gymnasiast]

Also change G2Names.hpp to IconNames.hpp - icons from g1 should be added as well (in another PR, preferably).

Use IconNames.h. .hpp is for header-only implementations (i.e. fully implemented classes or functions without a .cpp file).

There are a few functions defined in that file, so doesn’t .hpp make more sense here?

[IntelOrca]

I didn't realise it was in scripting. I originally made most of the scripting code .hpp to reduce code and definition duplicates. But that has since been changed and now scripting files have been changed into .h and .cpp pairs. So I don't know what the plan is now with new stuff.