Report on Godot 4.0 breaking changes that impact Popochiu 1.x

[stickgrinder]

We need a precise list of changes for Popochiu to work on Godot 4.0.

To achieve this we may want to:

• Check for available Godot 3 to 4 migration paths online (some links below) and list all the impacted area in a comment
  • https://www.reddit.com/r/godot/comments/tsxgnj/migrating_from_3x_to_40/
  • https://gist.github.com/WolfgangSenff/168cb0cbd486c8c9cd507f232165b976
  • https://www.youtube.com/watch?v=ZjfYZPjLdQU
• Take note about all deprecation notices currently raised by Godot 3.6 in Popochiu 1.x (ex. Navigation2D is deprecated for NavigationServer - there may be more)
• Open popochiu-dev project in Godot 4.0 and take note / solve all the smallest issues (this will surely help but may become a bit of a "one at a time" sort of endeavor)

Should this issue be solvable in a single pass, it's easier to just commit the upgrades on it. If more work is required is better to open new issues under the same milestone.

[mapedorr]

New in Godot 4 and GDScript 2

• export is now @export
• onready is now @onready
• tool is now @tool
• File is now FileAccess
• Directory is now DirAccess
• YSort node removed, functionality moved to Node2D (just when I changed PopochiuRoom to extend from YSort instead of Node2D....). I don't know how this works, so we'll need to make tests. **Answer: ** Now this is setup in the CanvasItems' Ordering category.
• Position2D is now Marker2D.
• Connecting and emiting signals has changed: signals basics.
• No more yield, now use await
• Some properties in Control nodes have changed (i.e. how text is aligned in Label). So probably we'll need to open the scenes for creating the Popochiu Dock in order to fix those things.
• add_icon_override is now add_theme_icon_override.
• Now setting a class icon to show in the Editor is done with @icon(path_to_icon).
• Defining setters and getters for properties has changed: now it is done this way.
• SceneTree idle_frame signal is now process_frame.
• Control.get_stylebox is not Control.get_theme_stylebox.
• AcceptDialog now inherits from Window, not from Popup.
• ResourceSaver.save signature changed. 3.x -> 4.x
• ⭐We can't use yield() anymore... so E.run() will not work as it used to work on 3.x
• Engine.editor_hint is now Engine.is_editor_hint().
• Node.name property now is a StringName instead of a String.
• _unhandled_key_input signature changed, now it has an InputEvent parameter, instead of an InputEventKey.
• @GDScript.funcref() (FuncRef) is now Callable.
• At the moment of writing, I don't know how we can await for the signal name received as parameter is E.runnable(). For now I will not invest more time in this as we do not know if the E.runnable function will be maintained.
• ⭐ Calling methods in the parent class now is done with super.method(), not .method().
• Tween node dissappeared, now tweens are created only by code.
• ⭐ Import flags for pixelart images is no longer part of the Import dock. Now it is setup in the CanvasItem's Texture category: Texture > Filter > Nearest.

This file might be useful to know about methods and properties renames.
⭐ Here one can find useful info about the new functions in GDScript 2.

Things to improve or change

• In E.runnable(), the yield_signal: String parameter now can be "completed" when devs want to wait for the function to complete.
• We could change connections to Area2D.area_entered / CollisionObject2D.mouse_entered/etc. to the new Area2D.area_shape_entered / CollisionObject2D.mouse_shape_entered in order to allow PopochiuClickable and other objects to have more than one collision shape. This could be useful for defining different behaviors in the same object depending on the shape that triggers the action.
• ⭐ Now that making a texture to be pixelart-like is not defined by the flags used when importing the image, the setting that makes the game to be pixelart should be stored in the PopochiuSettings resource and it is something we'll have to evaluate for certain nodes (Sprite2D, TextureRect...) to set their CanvasItem.texture_filter to TEXTURE_FILTER_NEAREST.

[mapedorr]

Maybe we should start by fixing the addon first, instead of trying to fix things in popochiu-dev. In the end, the game is created using the plugin classes and scripts, so fixing the plugin should allow us to create the development game from it.

[stickgrinder]

@mapedorr not sure what's the difference in working on the dev repo. Nothing against this, just asking,

[mapedorr]

That there will be less things to fix as we will not have to fix bugs that are part of the demo itself @stickgrinder . But maybe I'm wrong, as importing the dev project directly in Godot 4 will run the script the Godot team created to migrate projects from 3.x to 4.x.

[mapedorr]

Things to test before the first beta release

Now that most of the plugin is working, there are some things we need to test in order to fix bugs and make sure all v1.x functionalities are ready.

Editor

• Installation.
• Create room.
• Create prop.
• Create hotspot.
• Create walkable area.
• Create region.
• Create character.
• Create inventory item.
• Create dialog.
• Make sure the plugin does something if it is marked as Pixel, or 2D: This is something we have to control at node level now that Godot 4 moved that from the import flags to the CanvasItem.texture_filter property.
• Delete room.
• Delete character.
• Delete prop.
• Delete hotspot.
• Delete walkable area.
• Delete region.
• Delete inventory item.
• Delete dialog.

In-game

• Save/Load (now PanelContainer becuase Window fucks everything:
  • Save working
  • Load working
  • The popup font looks blurry
  • The cursor dissapears when it enters the window
  • Closing the popup does not make it dissapear completely, looks like its panel container keeps visible, and that blocks interactions.
• Show in-line dialog.
• Remove inventory items.
• Play custom character animations.
• Change playable character.

[stickgrinder]

That there will be less things to fix as we will not have to fix bugs that are part of the demo itself @stickgrinder . But maybe I'm wrong, as importing the dev project directly in Godot 4 will run the script the Godot team created to migrate projects from 3.x to 4.x.

Ah I see! Well, I guess you are right.
The absence of a dependency manager for Godot is making this more painful that it needs to be :P But I guess you're right!

Sorry for taking so long to reply. I guess we can coordinate to address the list items in the next days, so we can speed the process up maybe?

[mapedorr]

I'm gonna close this issue because of the release of v2.0-alpha1. I'll create another issue just to keep track of the pending things.