Api update #1577

kianzarrin · 2022-05-22T20:59:48Z

added API so that node controller access TMPE through API.
node controller is still patching Junction restriction manager. that I can fix in next PR.
also added not implemented pedestrian/bike lane transition groups for better future proofing of AN.

Tested with:
AN-alpha
HUT-DCR.zip
Hide crossings

TLM/TLM/Manager/Impl/LaneConnection/LaneConnectionManager.cs

originalfoo

Code looks OK, not tested in-game though.

Elesbaan70

I didn't dive too deeply into implementation, but focused on the API instead. Implementation can always be changed. API, we're stuck with.

TLM/TMPE.API/Traffic/Enums/LaneEndTransitionGroup.cs

TLM/TLM/Constants.cs

TLM/TMPE.API/Manager/ITrafficLightManager.cs

TLM/TMPE.API/Manager/ITrafficLightSimulationManager.cs

TLM/TMPE.API/UI/IRoadSignTheme.cs

kianzarrin · 2022-05-24T20:51:57Z

@kvakvs @Elesbaan70 I made changes to UI API. Do you like my new ITheme and IUIFactory?

TLM/TLM/Manager/Impl/TrafficLightManager.cs

kvakvs · 2022-05-24T22:15:05Z

@kvakvs @Elesbaan70 I made changes to UI API. Do you like my new ITheme and IUIFactory?

Nice, keep it simple. One point access to all future UI interfaces.

Elesbaan70

These changes are mostly good, but the renaming of JunctionRestrictionFlags and its members needs to be rolled back, and CanToggleTL needs to be renamed to CanToggleTrafficLight and privately implemented to protect compatibility.

TLM/TMPE.API/Traffic/Enums/JunctionRestrictionRules.cs

Elesbaan70 · 2022-05-25T01:54:50Z

TLM/TMPE.API/Traffic/Enums/TrafficLightType.cs

@@ -0,0 +1,9 @@
+namespace TrafficManager.API.Traffic.Enums {
+    public enum TrafficLightType {


I don't think TrafficLightType is the right name for this. It includes things like "paused."

It's pretty UI-centric. Maybe its name should reflect that?

what should I call it?

TrafficLightFlags?

Paused traffic light acts like normal vanilla traffic light.
I also have the option of dropping paused.

I consider this to be a specifically UI-related enumeration. Basically, it indicates which traffic light tool has control of the light, and indicates additional state information. So why not call it TrafficLightToolState, and then ITrafficLightManager.GetTrafficLightToolState and ITheme.TrafficLightToolState()?

And no, I say don't drop paused. Under my interpretation, it belongs there.

krzychu124

Minor suggestions for consideration, nothing blocking

krzychu124 · 2022-05-28T20:49:56Z

TLM/TMPE.API/UI/ITheme.cs

+
+        Texture2D VehicleRestriction(ExtVehicleType type, bool allow);
+
+        Texture2D GetTrafficLightIcon(ushort nodeId);


Suggested change

Texture2D GetTrafficLightIcon(ushort nodeId);

Texture2D TrafficLightIcon(ushort nodeId);

must be public though.

krzychu124 · 2022-05-28T20:50:50Z

TLM/TMPE.API/Manager/ITrafficLightManager.cs

+        /// <summary>
+        /// returns if the node as any kind of traffic light (vanilla, manual, timed).
+        /// </summary>
+        public bool HasTrafficLight(ushort nodeId);


Suggested change

public bool HasTrafficLight(ushort nodeId);

bool HasTrafficLight(ushort nodeId);

implicitly public so redundant

@krzychu124 no that does not work

Interface Implementation has to be public.

unless if I do like this:

But that is not necessary in this case.

It might not be a bad idea to implicitly define all API implementations that we do not want to use internally. If we want to go that route we need to have a discussion about it and apply the rule consistently everywhere.

you get an error probably because you are explicitly implementing the interface and implementation you shown is private then making it explicit you force us to cast to the interface to use that method (is there another one with the same signature?). Explicit and implicit implementation are completely different things with some implications.
Basically when you create explicit implementation you won't be able to use it like this
TraffLightManager.Instance.CanToggleTrafficLight() (assuming that Instance returns TrafficLightManager, not the interface)
but forced to do this instead:
((ITrafficLightManager)TraffLightManager.Instance).CanToggleTrafficLight()

What you said first does not work:

Suggested change

public bool HasTrafficLight(ushort nodeId);

bool HasTrafficLight(ushort nodeId);

but this will work:

Suggested change

public bool HasTrafficLight(ushort nodeId);

bool ITrafficLightManager.HasTrafficLight(ushort nodeId);

I understand how implicit/explicit works.

Elesbaan70

I second the last couple of recommendations from @krzychu124, for naming consistency and clean-looking code. Otherwise looks good.

… into API-update

kianzarrin · 2022-05-29T10:11:55Z

Cool. I will update NC/HUT/DCR/HTC (AN already uses TMPE API) after both stable and Test are using this Hotfix

API update for compatibility with NC/DCR/HUT * TrafficLights/JunctionRestrictions: updated API * LaneEndTransitionGroup : Added Bicycle and Pedestrian for future proofing. * Expose Road sign theme in API. (cherry picked from commit 2a4c104)

API update for compatibility with NC/DCR/HUT * TrafficLights/JunctionRestrictions: updated API * LaneEndTransitionGroup : Added Bicycle and Pedestrian for future proofing. * Expose Road sign theme in API.

kianzarrin added 3 commits May 22, 2022 21:50

LaneEndTransitionGroup : Added Bicycle and Pedestrian

39cda82

expose Road sign theme in API

5133f5e

Traffic lights

0e940ec

kianzarrin added the API API for external mods label May 22, 2022

kianzarrin requested review from kvakvs, originalfoo, krzychu124 and Elesbaan70 May 22, 2022 20:59

kianzarrin self-assigned this May 22, 2022

Merge branch 'master' into API-update

551fe2e

kianzarrin marked this pull request as ready for review May 22, 2022 21:04

kianzarrin commented May 22, 2022

View reviewed changes

TLM/TLM/Manager/Impl/LaneConnection/LaneConnectionManager.cs Show resolved Hide resolved

kvakvs approved these changes May 22, 2022

View reviewed changes

krzychu124 approved these changes May 22, 2022

View reviewed changes

originalfoo approved these changes May 23, 2022

View reviewed changes

Elesbaan70 reviewed May 23, 2022

View reviewed changes

pr fixes

c53f47b

kianzarrin requested a review from kvakvs May 24, 2022 20:49

kianzarrin commented May 24, 2022

View reviewed changes

TLM/TLM/Manager/Impl/TrafficLightManager.cs Outdated Show resolved Hide resolved

pr fixes

8082ba2

kianzarrin requested a review from chameleon-tbn May 24, 2022 23:16

Elesbaan70 requested changes May 25, 2022

View reviewed changes

TLM/TMPE.API/Traffic/Enums/JunctionRestrictionRules.cs Outdated Show resolved Hide resolved

kianzarrin added 4 commits May 25, 2022 04:08

rolled back JunctionRestrictionFlags

e85a3ac

ea6b25e

280f971

implement CanToggleTrafficLight privately

2790471

kianzarrin requested a review from Elesbaan70 May 25, 2022 01:18

ad1c5ed

Elesbaan70 reviewed May 25, 2022

View reviewed changes

traffic light pr fixes

cd1f632

kianzarrin requested a review from Elesbaan70 May 27, 2022 11:30

Merge branch 'master' into API-update

009bb22

krzychu124 approved these changes May 28, 2022

View reviewed changes

Elesbaan70 approved these changes May 29, 2022

View reviewed changes

kianzarrin added 2 commits May 29, 2022 13:09

pr fixes

8f043ac

Merge branch 'API-update' of https://github.com/CitiesSkylinesMods/TMPE…

9c45c7e

… into API-update

kianzarrin merged commit 2a4c104 into master May 29, 2022

kianzarrin deleted the API-update branch May 29, 2022 10:19

krzychu124 mentioned this pull request May 31, 2022

Release 11.6.5.3 #1576

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Api update #1577

Api update #1577

kianzarrin commented May 22, 2022

originalfoo left a comment

Elesbaan70 left a comment

kianzarrin commented May 24, 2022

kvakvs commented May 24, 2022

Elesbaan70 left a comment •

edited

Loading

Elesbaan70 May 25, 2022

kianzarrin May 25, 2022

kianzarrin May 25, 2022

kianzarrin May 25, 2022

Elesbaan70 May 25, 2022

Elesbaan70 May 25, 2022

krzychu124 left a comment

krzychu124 May 28, 2022

kianzarrin May 29, 2022

krzychu124 May 28, 2022

kianzarrin May 29, 2022

kianzarrin May 29, 2022 •

edited

Loading

krzychu124 May 29, 2022

kianzarrin May 29, 2022

Elesbaan70 left a comment

kianzarrin commented May 29, 2022

		@@ -0,0 +1,9 @@
		namespace TrafficManager.API.Traffic.Enums {
		public enum TrafficLightType {


		Texture2D VehicleRestriction(ExtVehicleType type, bool allow);

		Texture2D GetTrafficLightIcon(ushort nodeId);

	Texture2D GetTrafficLightIcon(ushort nodeId);
	Texture2D TrafficLightIcon(ushort nodeId);

	public bool HasTrafficLight(ushort nodeId);
	bool HasTrafficLight(ushort nodeId);

	public bool HasTrafficLight(ushort nodeId);
	bool ITrafficLightManager.HasTrafficLight(ushort nodeId);

Api update #1577

Api update #1577

Conversation

kianzarrin commented May 22, 2022

originalfoo left a comment

Choose a reason for hiding this comment

Elesbaan70 left a comment

Choose a reason for hiding this comment

kianzarrin commented May 24, 2022

kvakvs commented May 24, 2022

Elesbaan70 left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

krzychu124 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kianzarrin May 29, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Elesbaan70 left a comment

Choose a reason for hiding this comment

kianzarrin commented May 29, 2022

Elesbaan70 left a comment •

edited

Loading

kianzarrin May 29, 2022 •

edited

Loading