Skip to content

ModLoaderDeprecated🔗

Inherits: Object

API methods for deprecating funcs. Can be used by mods with public APIs.

Constants🔗

• LOG_NAME: "ModLoader:Deprecated"🔗

Method Descriptions🔗

• void deprecated_changed(old_method: String, new_method: String, since_version: String, show_removal_note: bool) static🔗

Description:🔗

Marks a method that has changed its name or class.

Parameters:🔗

  • old_method (String): The name of the deprecated method.
  • new_method (String): The name of the new method to use.
  • since_version (String): The version number from which the method has been deprecated.
  • show_removal_note (bool): (optional) If true, includes a note about future removal of the old method. Default is true.

Returns:

  • No return value

• void deprecated_removed(old_method: String, since_version: String, show_removal_note: bool) static🔗

Description:🔗

Marks a method that has been entirely removed, with no replacement.

Parameters:🔗

  • old_method (String): The name of the removed method.
  • since_version (String): The version number from which the method has been deprecated.
  • show_removal_note (bool): (optional) If true, includes a note about future removal of the old method. Default is true.

Returns:

  • No return value

Note

This should rarely be needed but is included for completeness.

• void deprecated_message(msg: String, since_version: String) static🔗

Description:🔗

Marks a method with a freeform deprecation message.

Parameters:🔗

  • msg (String): The deprecation message.
  • since_version (String): (optional) The version number from which the deprecation applies.

Returns:

  • No return value