feat: ✨ API: Add methods for deprecation + API Folder

[ithinkandicode]

Adds 3 new methods for deprecation, as outlined and discussed in #154, which this PR closes.

Deviates slightly from #154, in that the deprecation messages are generic, rather than specific to ModLoader. This means that mods can use these methods too, not just ModLoader.

Additionally, this PR introduces the api directory, as discussed in #153. Classes in this folder are considered to be available for public use.

Methods

# A method has changed its name/class
static func deprecated_changed(old_method: String, new_method: String, since_version: String, show_removal_note: bool = true)

# A method has been entirely removed, with no replacement
# (should never be needed but good to have just in case)
static func deprecated_removed(old_method: String, since_version: String, show_removal_note: bool = true)

# Freeform deprecation message.
# Allows you to add a deprecation comment without specifying the old/new method
static func deprecated_message(msg: String, since_version: String = "")

Examples

Code:

ModLoaderDeprecated.deprecated_changed("Hello.World", "Hello.Globe", "6.5.0")
ModLoaderDeprecated.deprecated_removed("Hello.World", "6.5.0")
ModLoaderDeprecated.deprecated_message("Generic deprecation message with version", "6.5.0")
ModLoaderDeprecated.deprecated_message("Generic deprecation message, no version")

Results:

deprecated_changed

deprecated_removed

deprecated_message (wi. version)

deprecated_message (no version)

Related

• Discussion: Deprecation #154
• Splitting up long files (utils/core) #153

[Qubus0]

nice, thank you