Add a pin toggle to prevent involuntary bottom editor switching

[YeldhamDev]

This PR adds a lock button to the bottom panel, that when toggled, stops switching of one bottom editor to another.
That means if you have the "Output" tab open, then you select an AnimationPlayer node, having the lock enabled will stop it from switching to the "Animation" tab.

Sponsored By: 🐺 Lone Wolf Technology / 🍀 W4 Games.

Production edit:

• Closes Allow bottom panels to persist after selecting a different node godot-proposals#9218.
• Closes Add a Pin button to the Inspector dock godot-proposals#9265.

[Jowan-Spooner]

I very much like this. However as there is no proposal linked, I'll just ask here: Does this make the pin in the animation editor unnecessary? Or how do these work together?

[YeldhamDev]

@Jowan-Spooner The animation pin just locks the animation context to the selected AnimationPlayer node, which means that if you selected one player, then pin, it will not switch to the context of another player when clicking it.

My PR is completely unrelated to that.

[groud]

I think that's a cool feature. Maybe it should use a "pin" instead of a lock though? Locks usually means you can't edit something.

[YeldhamDev]

@groud I thought about that, but I feared that some people would confuse the functionality with something related to the animation pinning. Which actually just happened above, in fact! 😛

[coppolaemilio]

To me, lock feels like you won't be able to interact with the panel. Pin gives me a better idea that the panel won't go away

[YeldhamDev]

Alright, it has been changed from a lock to a pin:

[fire]

@SaracenOne @lyuma we have discussing for a long time to make pins like this. Letting them know

[Calinou]

Tested locally, it works as expected. This is pretty useful to enable before running the project when you don't want automatic switching to Output to occur (but only momentarily) 🙂

[tetrapod00]

This discussion godotengine/godot-proposals#11087 asks for similar functionality: locking the bottom panel closed, i.e. preventing any bottom panel from opening. They suggest an editor setting, but it seems like this PR could easily be extended to support locking/pinning no open bottom panel.

If this PR is extended to support that use case, a lock icon seems slightly more fitting than a pin icon. But locking/pinning a bottom panel open is a much more common use case, so a pin icon is probably still better overall.

Supporting this other use case can easily be a followup PR, too, but I felt like mentioning it because of the icon issue.

[The2AndOnly]

This discussion godotengine/godot-proposals#11087 asks for similar functionality: locking the bottom panel closed, i.e. preventing any bottom panel from opening. They suggest an editor setting, but it seems like this PR could easily be extended to support locking/pinning no open bottom panel.

I think this already fixes that. I was suggesting an option to stop the tabs from automatically switching. The bottom panel opening is a result of it switching tabs.

[tetrapod00]

@The2AndOnly
From the other discussion:

I like to work with the bottom tab closed, since it takes a lot of space. But there is an issue that has bothered me ever since I began working with Godot. It's that the tab will automatically open whenever I click on certain nodes in the scene tree.

For example, if I click on an AnimatedSprite2D then it will automatically open / switch to the SpriteFrames tab.
And if I click on an AnimationPLayer then it will automatically open / switch to the Animation tab.

This PR currently does not prevent a closed bottom panel from opening; it only prevents an open bottom panel from switching to another bottom panel. You can try it out yourself by downloading one of the artifacts from the Checks tab of this PR, if you want.

[akien-mga]

Seems fine to me.

[YeldhamDev]

@akien-mga Changes made.

[Repiteo]

Thanks!