Call `close` in `resetSubState`

[DetectiveBaldi]

Proposal is to call subState.close(); here. Flixel clearly wants this sub state gone, it calls its closeCallback, and the state's subStateClosed signal, but it never actually finishes the job and calls close on the sub state.

The fact that closing a sub state, (specifically by opening a new one!!) doesn't call the original sub state's close method has personally caused me a really hard to debug issue.

I have some code from one of my projects that I used to work around this issue, but not only does it use Reflect but I also believe it is generally a pretty confusing piece of code that could be removed if FlxState properly called the close method in the scenario mentioned.

Here is the aforementioned code with some comments to hopefully help explain what the issue is:

override function openSubState(newSubState:FlxSubState):Void
{
    super.openSubState(newSubState);

    var typeOf:Class<FlxSubState> = Type.getClass(newSubState);

    // If the sub state trying to open ISN'T of type `CustomTransition`, proceed.
    if (typeOf != CustomTransition)
    {
        // Get type of currently closing sub state.
        typeOf = Type.getClass(subState);

        /**
         * We set `persistentUpdate` to false here because Flixel has internally already closed the `CustomTransition`
         * sub state, but it hasn't (and won't) dispatched the sub state's `close` method, which WOULD set this to false.
         * Therefore, we have to do it ourselves here.
         */
        if (typeOf == CustomTransition)
            persistentUpdate = false;
    }
}

TLDR: Flixel should call subState.close(); in resetSubState because Flixel calls several related methods and the currently this not being implemented can cause some issues.

Sorry if this issue is a bit confusing, it's one that's sort of hard to convey. If there's any clarification I can offer let me know.

[ACrazyTown]

I'm not completely familiar with this but wouldn't this break nesting substates? (which is something that Flixel explicitly states to be intended)

flixel/flixel/FlxState.hx

Lines 55 to 58 in ca2d0a9

	/**
	* Current substate. Substates also can be nested.
	*/
	public var subState(default, null):FlxSubState;

[DetectiveBaldi]

I'm not completely familiar with this but wouldn't this break nesting substates? (which is something that Flixel explicitly states to be intended)

flixel/flixel/FlxState.hx

Lines 55 to 58 in ca2d0a9

/**

• Current substate. Substates also can be nested.
  */
  public var subState(default, null):FlxSubState;

Perhaps, but as mentioned Flixel seems really inconsistent about all this. Calling openSubState subsequently calls resetSubState, which calls a bunch of closing related functions. Unless I'm misunderstanding nested sub states wouldn't even work?

[ACrazyTown]

Perhaps, but as mentioned Flixel seems really inconsistent about all this. Calling openSubState subsequently calls resetSubState, which calls a bunch of closing related functions. Unless I'm misunderstanding nested sub states wouldn't even work?

Actually I think that in order to nest substates you're supposed to call openSubState() IN a substate (it extends FlxState). So it might not actually break anything. From a quick glance, I think it'd make sense to close them here, considering that they also seem to get destroyed?

[Geokureli]

I don't understand the need to call close, and I don't understand your example. I also don't think this change would work the way you expect. close() just sets _requestSubStateReset = true, which is already done in openSubState.

close() is a way for the substate to close itself and tell the parent state, not a function called by the parent state to tell the substate it was closed. If you're overidding close() to track when a substate closes itself AND when it's closed externally, than you're just doing it wrong. Tell me more about your actual use case where you expected close called