Add get_contents method to Directory class

[KoBeWi]

Closes godotengine/godot-proposals#1225
Resolves #55776

Thing to consider:

• this could be theoretically used on an arbitrary directory without opening it (similar to Dir.entries in Ruby)
• this makes list_dir_begin() and related methods unnecessary, as they are less convenient

Theoretically list_dir_begin() is more optimal to use when you want to cancel iteration midway, but this happens very rarely and the difference is minimal.

[nathanfranke]

+1 for get_contents instead of get_files. Better not to argue about whether folders are considered "files" and just be explicit. :)

[dreamsComeTrue]

Would you be considering adding recursive parameter too? :)

[KoBeWi]

Would you be considering adding recursive parameter too? :)

I started implementing it, but the code feels like it would be simpler in GDScript. The additional complexity is not worth it IMO.

[nathanfranke]

#40763

There might be a redesign for 4.0 which may affect whether or not this is merged.

---

As for recursion, how would that even work? Are directories included in the list or only the files within them?

[Xrayez]

Recursive option is probably not worth it because you'll likely also want to add some filtering on top of that, which is better done via script then... given the development philosophy of Lean & Clean™. 🙂

[mhilbrunner]

PR meeting: the bool args should be properties (this should be refactored in core binds for all directory stuff), and it should likely be added as seperate methods to list files/directory
Otherwise this looks good :)

[KoBeWi]

Rebased and done requested changes.
Additionally show_navigational is now named include_navigational (same with hidden).

[akien-mga]

See #55776 - the listing is not deterministic, but it could be sorted here in get_contents(). And you could add a mention about list_dir_begin not guaranteeing order in the docs to close that issue.

[akien-mga]

Thanks!