API-Level Hook for JunctionRestrictionsManager

[Elesbaan70]

I would like to give the Node Controller mods a better way of interacting with JunctionRestrictionsManager, so that the code can be cleaned up, revised, and enhanced without having to worry so much about breaking Node Controller.

The idea is to use .NET events to provide a hook at the API level, which Node Controller can use to alter the default and configurable states of the flags, without having to rely on Harmony-based patching. I would do the work in Node Controller and provide pull requests once the new API in TMPE is released to stable.

Here's a rough sketch of what I have in mind:

        public enum JunctionRestrictionFlags {
            AllowUTurn = 1 << 0,
            AllowNearTurnOnRed = 1 << 1,
            AllowFarTurnOnRed = 1 << 2,
            AllowForwardLaneChange = 1 << 3,
            AllowEnterWhenBlocked = 1 << 4,
            AllowPedestrianCrossing = 1 << 5,
        }

        public class JunctionRestrictionsHookData {

            public JunctionRestrictionFlags Mask { get; }

            public JunctionRestrictionFlags Result { get; set; }
        }

        public delegate void JunctionRestrictionsHook(JunctionRestrictionsHookData hookData);

        public interface IJunctionRestrictionsManager {

            event JunctionRestrictionsHook DefaultJunctionRestrictionsHook;

            event JunctionRestrictionsHook ConfigurableJunctionRestrictionsHook;
        }

and it would be used something like this:

        public class SomeClass {

            public SomeClass() {
                JunctionRestrictionsManager.ConfigurableJunctionRestrictionsHook += ConfigurableJunctionRestrictionsHook;
            }

            public void ConfigurableJunctionRestrictionsHook(JunctionRestrictionsHookData hookData) {
                if ((hookData.Mask & JunctionRestrictionFlags.AllowUTurn) != 0) {

                    // do the work of figuring out whether this is configurable

                    if (result)
                        hookData.Result |= JunctionRestrictionFlags.AllowUTurn;
                    else
                        hookData.Result &= ~JunctionRestrictionFlags.AllowUTurn;
                }
            }

        }

@krzychu124 @kianzarrin @MacSergey Any thoughts on this?

[kianzarrin]

I can update my patches. macsurgey has been busy lately but might come back if there is a mod breaking change.

[Elesbaan70]

@kianzarrin How does RM Crossings know when the pedestrian crossing flag changes? Is it patching JunctionRestrictionsManager? We could also add a FlagsChanged event.

I can't find the source for RM Crossings....

[krzychu124]

I can't find the source for RM Crossings....

@Elesbaan70 https://github.com/CitiesSkylinesMods/HideCrosswalks

[Elesbaan70]

Ahhh, since Kian was listed as the mod's creator, I was looking for it in his repositories. 🙂

[kianzarrin]

I put link to my mods repo in my mods page and also in discord

[Elesbaan70]

I put link to my mods repo in my mods page and also in discord

The link is buried deep in the text. I should have searched for "GitHub". 🙂