API v0.2.3

[0.2.3] - 2024-02-26

General

Cette mise à jour met en place une gestion plus précise des versions des mods, du jeu et de l'API.
Elle marque également la fin de la prise en charge de la classe CharacterAPI dont le maintien entre en conflit avec les principes de la nouvelle version de l'API de modding.

Added

• Classe Version qui permet de gérer de manière plus precise les differentes version du jeu et de l'API
  • Getters pour les champs major, minor, patch, label, build
  • Méthode toString qui permet de récupérer une représentation textuelle de la version
  • isEquals, isGreaterThan, isGreaterThanOrEquals, isLowerThan, isLowerThanOrEquals qui permettent de comparer deux versions
• Champs gameVersions et apiVersions dans la classe Mod qui permettent de définir les versions du jeu et de l'API nécessaires pour le mod
• Champ modVersion dans la classe Mod qui permet de définir la version du mod
• Méthode isCompatibleWithAPI et isCompatibleWithGame dans la classe Mod qui permettent de vérifier la compatibilité du mod avec l'API et le jeu
  • Ces méthodes utilisent la classe Version pour comparer les versions
  • Actuellement, si le mod définit une version du jeu ou de l'API à null, il est considéré comme compatible
  • Dans la version 0.3.0, les versions du jeu et de l'API seront obligatoires, et si elles ne sont pas définies, le mod sera considéré comme incompatible
• Classe Main qui affiche un message dans la console pour rediriger l'utilisateur vers le repos de l'API
  • Cette classe a été ajoutée dans le cas ou l'utilisateur lance le jar de l'API au lieu de lancer le jeu
• Constantes NULL_CONSUMABLE dans l'interface IConsumable qui permettent de définir un objet consommable nul

Changed

• Méthode load dans la classe ModLoader pour prendre en charge les nouvelles méthodes de vérification de compatibilité entre le mod, le jeu et l'API
• Fichier MANIFEST.MF pour ajouter les champs Main-Class pour permettre de lancer l'API avec java -jar LSG_API<version>.jar
• La classe ConsumeNullException utilse maintenant la constante NULL_CONSUMABLE de l'inteface IConsumable à la place de new Consumable(null, 0, null)

Deprecated

• Champs version dans la classe Mod qui est remplacé par le champ modVersion
  • Sera supprimé dans la version 0.3.0
• Constructeur de la classe Mod qui prend en paramètre une version de type String qui est remplacé par une version de type Version
  • Sera supprimé dans la version 0.3.0

Removed

• Messages de debug oubliés dans les méthodes de la classe Mod
• Classe CharacterAPI et toutes ses méthodes
  • Cette classe avait été dépréciée dans la version 0.2.0
• Documentation publique et privée
  • Devenue obsolète. Une nouvelle documentation est en cours de rédaction (pas encore de release prévue)