BCKClass
Classe représentant une classe Java pour la documentation. Cette classe est utilisée pour encapsuler les informations d'une classe Java, y compris son nom, sa description (généralement récupérée depuis le Javadoc), et ses méthodes associées.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
BCKClass | Constructeur de la classe BCKClass. Initialise le nom de la classe. | ‣ nom ( |
|
getName | Permet de récupérer le nom de la classe. | ||
setName | Permet de définir le nom de la classe. | ‣ nom ( |
|
getDescription | Permet de récupérer la description de la classe. | ||
setDescription | Permet de définir la description de la classe. | ‣ description ( |
|
getMethods | Permet de récupérer la liste des méthodes de la classe. | ||
setMethods | Permet de définir la liste des méthodes de la classe. | ‣ méthodes ( |
Exemple d'Utilisation
// Exemple d'utilisation pour BCKClass :
// Exemple de code ici...
Class representing a Java class for documentation. This class is used to encapsulate the information of a Java class, including its name, its description (usually retrieved from the Javadoc), and its associated methods.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
BCKClass | Constructor of the BCKClass. Initializes the name of the class. | ‣ name ( |
|
getName | Getter to retrieve the class name. | ||
setName | Setter to set the class name. | ‣ name ( |
|
getDescription | Getter to retrieve the class description. | ||
setDescription | Setter to set the class description. | ‣ description ( |
|
getMethods | Getter to retrieve the list of methods of the class. | ||
setMethods | Setter to define the list of methods of the class. | ‣ methods ( |
Example of Use
// Usage example for BCKClass:
// Example code here...
Classe représentant une classe Java pour la documentation. Cette classe est utilisée pour encapsuler les informations d'une classe Java, y compris son nom, sa description (généralement récupérée depuis le Javadoc), et ses méthodes associées.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
BCKClass | Constructeur de la classe BCKClass. Initialise le nom de la classe. | ‣ nom ( |
|
getName | Permet de récupérer le nom de la classe. | ||
setName | Permet de définir le nom de la classe. | ‣ nom ( |
|
getDescription | Permet de récupérer la description de la classe. | ||
setDescription | Permet de définir la description de la classe. | ‣ description ( |
|
getMethods | Permet de récupérer la liste des méthodes de la classe. | ||
setMethods | Permet de définir la liste des méthodes de la classe. | ‣ méthodes ( |
Exemple d'Utilisation
// Exemple d'utilisation pour BCKClass :
// Exemple de code ici...
Class representing a Java class for documentation. This class is used to encapsulate the information of a Java class, including its name, its description (usually retrieved from the Javadoc), and its associated methods.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
BCKClass | Constructor of the BCKClass. Initializes the name of the class. | ‣ name ( |
|
getName | Getter to retrieve the class name. | ||
setName | Setter to set the class name. | ‣ name ( |
|
getDescription | Getter to retrieve the class description. | ||
setDescription | Setter to set the class description. | ‣ description ( |
|
getMethods | Getter to retrieve the list of methods of the class. | ||
setMethods | Setter to define the list of methods of the class. | ‣ methods ( |
Example of Use
// Usage example for BCKClass:
// Example code here...
BCKMethod
Classe représentant une méthode d'une classe Java. Elle contient des informations sur le nom de la méthode, le type de retour, les paramètres de la méthode et une description de la méthode, qui peuvent être utilisés pour générer de la documentation ou pour d'autres analyses.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
BCKMethod | Constructeur de la classe BCKMethod. Initialise une nouvelle méthode avec son nom, son type de retour, sa liste de paramètres et sa description. |
‣ name ( ‣ returnType ( ‣ parameters ( ‣ description ( ‣ annotation ( |
|
getParameters | Permet d'obtenir la liste des paramètres de la méthode. | ||
getReturnType | Permet d'obtenir le type de retour de la méthode. | ||
getDescription | Permet d'obtenir la description de la méthode. | ||
getName | Permet d'obtenir le nom de la méthode. | ||
getAnnotation | Permet d'obtenir l'annotation de la méthode. |
Exemple d'Utilisation
// Exemple d'utilisation pour BCKMethod :
BCKMethod method = new BCKMethod(
"calculateSum",
"int",
List.of(new BCKParameter("a", "int"), new BCKParameter("b", "int")),
"Adds two integers and returns the result.",
"@Override"
);
SuperLog.info("MyMod", method.getName());
Class representing a method of a Java class. It contains information about the method name, return type, parameters, and a description of the method, which can be used for documentation or other analyses.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
BCKMethod | Constructor of the BCKMethod class. Initializes a new method with its name, return type, parameters, and description. |
‣ name ( ‣ returnType ( ‣ parameters ( ‣ description ( ‣ annotation ( |
|
getParameters | Retrieves the list of method parameters. | ||
getReturnType | Retrieves the return type of the method. | ||
getDescription | Retrieves the description of the method. | ||
getName | Retrieves the name of the method. | ||
getAnnotation | Retrieves the method annotation. |
Example of Use
// Usage example for BCKMethod:
BCKMethod method = new BCKMethod(
"calculateSum",
"int",
List.of(new BCKParameter("a", "int"), new BCKParameter("b", "int")),
"Adds two integers and returns the result.",
"@Override"
);
SuperLog.info("MyMod", method.getName());
Classe représentant une méthode d'une classe Java. Elle contient des informations sur le nom de la méthode, le type de retour, les paramètres de la méthode et une description de la méthode, qui peuvent être utilisés pour générer de la documentation ou pour d'autres analyses.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
BCKMethod | Constructeur de la classe BCKMethod. Initialise une nouvelle méthode avec son nom, son type de retour, sa liste de paramètres et sa description. |
‣ name ( ‣ returnType ( ‣ parameters ( ‣ description ( ‣ annotation ( |
|
getParameters | Permet d'obtenir la liste des paramètres de la méthode. | ||
getReturnType | Permet d'obtenir le type de retour de la méthode. | ||
getDescription | Permet d'obtenir la description de la méthode. | ||
getName | Permet d'obtenir le nom de la méthode. | ||
getAnnotation | Permet d'obtenir l'annotation de la méthode. |
Exemple d'Utilisation
// Exemple d'utilisation pour BCKMethod :
BCKMethod method = new BCKMethod(
"calculateSum",
"int",
List.of(new BCKParameter("a", "int"), new BCKParameter("b", "int")),
"Adds two integers and returns the result.",
"@Override"
);
SuperLog.info("MyMod", method.getName());
Class representing a method of a Java class. It contains information about the method name, return type, parameters, and a description of the method, which can be used for documentation or other analyses.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
BCKMethod | Constructor of the BCKMethod class. Initializes a new method with its name, return type, parameters, and description. |
‣ name ( ‣ returnType ( ‣ parameters ( ‣ description ( ‣ annotation ( |
|
getParameters | Retrieves the list of method parameters. | ||
getReturnType | Retrieves the return type of the method. | ||
getDescription | Retrieves the description of the method. | ||
getName | Retrieves the name of the method. | ||
getAnnotation | Retrieves the method annotation. |
Example of Use
// Usage example for BCKMethod:
BCKMethod method = new BCKMethod(
"calculateSum",
"int",
List.of(new BCKParameter("a", "int"), new BCKParameter("b", "int")),
"Adds two integers and returns the result.",
"@Override"
);
SuperLog.info("MyMod", method.getName());
BCKParameter
Classe représentant un paramètre d'une méthode Java pour la documentation. Cette classe est utilisée pour stocker les informations relatives à un paramètre, telles que son type et son nom, dans le cadre de la documentation des méthodes.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
BCKParameter |
Constructeur de la classe BCKParameter. Initialise un objet représentant un paramètre avec son type et son nom. |
‣ type ( ‣ name ( |
|
getType |
Getter pour le type du paramètre. Permet de récupérer le type du paramètre. |
||
getName |
Getter pour le nom du paramètre. Permet de récupérer le nom du paramètre. |
Exemple d'Utilisation
// Exemple d'utilisation pour BCKParameter :
BCKParameter param = new BCKParameter("String", "name");
SuperLog.info("MyMod", "Paramètre créé : " + param.getType() + " " + param.getName());
Class representing a parameter of a Java method for documentation purposes. This class is used to store information related to a parameter, such as its type and name, in the context of method documentation.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
BCKParameter |
Constructor of the BCKParameter class. Initializes an object representing a parameter with its type and name. |
‣ type ( ‣ name ( |
|
getType |
Getter for the parameter type. Allows retrieving the type of the parameter. |
||
getName |
Getter for the parameter name. Allows retrieving the name of the parameter. |
Usage Example
// Usage example for BCKParameter:
BCKParameter param = new BCKParameter("String", "name");
SuperLog.info("MyMod", "Parameter created: " + param.getType() + " " + param.getName());
Classe représentant un paramètre d'une méthode Java pour la documentation. Cette classe est utilisée pour stocker les informations relatives à un paramètre, telles que son type et son nom, dans le cadre de la documentation des méthodes.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
BCKParameter |
Constructeur de la classe BCKParameter. Initialise un objet représentant un paramètre avec son type et son nom. |
‣ type ( ‣ name ( |
|
getType |
Getter pour le type du paramètre. Permet de récupérer le type du paramètre. |
||
getName |
Getter pour le nom du paramètre. Permet de récupérer le nom du paramètre. |
Exemple d'Utilisation
// Exemple d'utilisation pour BCKParameter :
BCKParameter param = new BCKParameter("String", "name");
SuperLog.info("MyMod", "Paramètre créé : " + param.getType() + " " + param.getName());
Class representing a parameter of a Java method for documentation purposes. This class is used to store information related to a parameter, such as its type and name, in the context of method documentation.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
BCKParameter |
Constructor of the BCKParameter class. Initializes an object representing a parameter with its type and name. |
‣ type ( ‣ name ( |
|
getType |
Getter for the parameter type. Allows retrieving the type of the parameter. |
||
getName |
Getter for the parameter name. Allows retrieving the name of the parameter. |
Usage Example
// Usage example for BCKParameter:
BCKParameter param = new BCKParameter("String", "name");
SuperLog.info("MyMod", "Parameter created: " + param.getType() + " " + param.getName());
BCKPermissions
Classe gérant les permissions des joueurs et du serveur. Elle permet d'ajouter, de supprimer et de vérifier des permissions pour les joueurs et le serveur.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
defaultPermissions |
Ajoute les permissions par défaut à un joueur si elles ne sont pas
déjà attribuées. |
‣ entity ( ‣ callback ( |
|
Variante sans argument callback. Paramètre : entity ( Retourne |
|||
getFormattedServerPermissions |
Formate les permissions du serveur selon un modèle spécifié. |
‣ pattern ( ‣ replaceable ( |
|
Variante sans argument replaceable. Paramètre : pattern ( Retourne |
|||
getFormattedPlayerPermissions |
Formate les permissions d'un joueur selon un modèle spécifié. |
‣ entity ( ‣ pattern ( ‣ replaceable ( |
|
Variante sans argument replaceable. Paramètres : entity ( Retourne |
|||
addPermission |
Ajoute une permission à un joueur. |
‣ entity ( ‣ permission ( ‣ callback ( |
|
Variante sans argument callback. Paramètres : entity ( Retourne |
|||
removePermission |
Supprime une permission d'un joueur. |
‣ entity ( ‣ permission ( ‣ callback ( |
|
Variante sans argument callback. Paramètres : entity ( Retourne |
|||
getPermissionsArray | Récupère les permissions d'un joueur sous forme de tableau. | ‣ entity ( |
|
hasPermission | Vérifie si un joueur possède une permission. |
‣ entity ( ‣ permission ( |
|
getEntityPermissions | Récupère les permissions d'une entité. | ‣ entity ( |
|
setPlayerPermissions | Définit les permissions d'un joueur dans les données utilisateurs. |
‣ entity ( ‣ permissions ( |
|
getServerPermissions | Récupère les permissions du serveur sous forme de tableau. | ||
addServerPermission |
Ajoute une permission au serveur si elle n'existe pas déjà. |
‣ permission ( ‣ callback ( |
|
Variante sans argument callback. Paramètre : permission ( Retourne |
|||
removeServerPermission |
Supprime une permission du serveur si elle existe. |
‣ permission ( ‣ callback ( |
|
Variante sans argument callback. Paramètre : permission ( Retourne |
|||
getPermissionsArray | Récupère les permissions d'un joueur sous forme de tableau. | ‣ entity ( |
|
hasPermission | Vérifie si un joueur possède une permission. |
‣ entity ( ‣ permission ( |
|
getEntityPermissions | Récupère les permissions d'une entité. | ‣ entity ( |
|
setPlayerPermissions | Définit les permissions d'un joueur dans les données utilisateurs. |
‣ entity ( ‣ permissions ( |
Exemple d'Utilisation
// Exemple d'utilisation pour BCKPermissions :
Entity player = ...; // Obtenez une entité joueur
BCKPermissions.defaultPermissions(player, 1);
SuperLog.info("MyMod", "Permissions par défaut attribuées au joueur : " + player.getName().getString());
Class managing player and server permissions. It allows adding, removing, and verifying permissions for players and the server.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
defaultPermissions |
Adds default permissions to a player if they are not already
assigned. |
‣ entity ( ‣ callback ( |
|
Variant without callback argument. Parameter: entity ( Returns |
|||
getFormattedServerPermissions |
Formats server permissions based on a specified pattern. |
‣ pattern ( ‣ replaceable ( |
|
Variant without replaceable argument. Parameter: pattern ( Returns |
|||
getFormattedPlayerPermissions |
Formats a player's permissions according to a specified
pattern. |
‣ entity ( ‣ pattern ( ‣ replaceable ( |
|
Variant without the replaceable argument. Parameters: entity ( Returns |
|||
addPermission |
Adds a permission to a player. |
‣ entity ( ‣ permission ( ‣ callback ( |
|
Variant without the callback argument. Parameters: entity ( Returns |
|||
removePermission |
Removes a permission from a player. |
‣ entity ( ‣ permission ( ‣ callback ( |
|
Variant without the callback argument. Parameters: entity ( Returns |
|||
getPermissionsArray | Retrieves a player's permissions as an array. | ‣ entity ( |
|
hasPermission | Checks if a player has a specific permission. |
‣ entity ( ‣ permission ( |
|
getEntityPermissions | Retrieves the permissions of an entity. | ‣ entity ( |
|
setPlayerPermissions | Sets the permissions of a player in the user data. |
‣ entity ( ‣ permissions ( |
|
getServerPermissions | Retrieves the server's permissions as an array. | ||
addServerPermission |
Adds a permission to the server if it does not already exist. |
‣ permission ( ‣ callback ( |
|
Variant without the callback argument. Parameter: permission ( Returns |
|||
removeServerPermission |
Removes a permission from the server if it exists. |
‣ permission ( ‣ callback ( |
|
Variant without the callback argument. Parameter: permission ( Returns |
|||
getPermissionsArray | Retrieves a player's permissions as an array. | ‣ entity ( |
|
hasPermission | Checks if a player has a specific permission. |
‣ entity ( ‣ permission ( |
|
getEntityPermissions | Retrieves all permissions assigned to an entity. | ‣ entity ( |
|
setPlayerPermissions | Defines a set of permissions for a player within the user data. |
‣ entity ( ‣ permissions ( |
Example of Use
// Usage example for BCKPermissions:
Entity player = ...; // Obtain a player entity
BCKPermissions.defaultPermissions(player, 1);
SuperLog.info("MyMod", "Default permissions assigned to player: " + player.getName().getString());
Classe gérant les permissions des joueurs et du serveur. Elle permet d'ajouter, de supprimer et de vérifier des permissions pour les joueurs et le serveur.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
defaultPermissions |
Ajoute les permissions par défaut à un joueur si elles ne sont pas
déjà attribuées. |
‣ entity ( ‣ callback ( |
|
Variante sans argument callback. Paramètre : entity ( Retourne |
|||
getFormattedServerPermissions |
Formate les permissions du serveur selon un modèle spécifié. |
‣ pattern ( ‣ replaceable ( |
|
Variante sans argument replaceable. Paramètre : pattern ( Retourne |
|||
getFormattedPlayerPermissions |
Formate les permissions d'un joueur selon un modèle spécifié. |
‣ entity ( ‣ pattern ( ‣ replaceable ( |
|
Variante sans argument replaceable. Paramètres : entity ( Retourne |
|||
addPermission |
Ajoute une permission à un joueur. |
‣ entity ( ‣ permission ( ‣ callback ( |
|
Variante sans argument callback. Paramètres : entity ( Retourne |
|||
removePermission |
Supprime une permission d'un joueur. |
‣ entity ( ‣ permission ( ‣ callback ( |
|
Variante sans argument callback. Paramètres : entity ( Retourne |
|||
getPermissionsArray | Récupère les permissions d'un joueur sous forme de tableau. | ‣ entity ( |
|
hasPermission | Vérifie si un joueur possède une permission. |
‣ entity ( ‣ permission ( |
|
getEntityPermissions | Récupère les permissions d'une entité. | ‣ entity ( |
|
setPlayerPermissions | Définit les permissions d'un joueur dans les données utilisateurs. |
‣ entity ( ‣ permissions ( |
|
getServerPermissions | Récupère les permissions du serveur sous forme de tableau. | ||
addServerPermission |
Ajoute une permission au serveur si elle n'existe pas déjà. |
‣ permission ( ‣ callback ( |
|
Variante sans argument callback. Paramètre : permission ( Retourne |
|||
removeServerPermission |
Supprime une permission du serveur si elle existe. |
‣ permission ( ‣ callback ( |
|
Variante sans argument callback. Paramètre : permission ( Retourne |
|||
getPermissionsArray | Récupère les permissions d'un joueur sous forme de tableau. | ‣ entity ( |
|
hasPermission | Vérifie si un joueur possède une permission. |
‣ entity ( ‣ permission ( |
|
getEntityPermissions | Récupère les permissions d'une entité. | ‣ entity ( |
|
setPlayerPermissions | Définit les permissions d'un joueur dans les données utilisateurs. |
‣ entity ( ‣ permissions ( |
Exemple d'Utilisation
// Exemple d'utilisation pour BCKPermissions :
Entity player = ...; // Obtenez une entité joueur
BCKPermissions.defaultPermissions(player, 1);
SuperLog.info("MyMod", "Permissions par défaut attribuées au joueur : " + player.getName().getString());
Class managing player and server permissions. It allows adding, removing, and verifying permissions for players and the server.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
defaultPermissions |
Adds default permissions to a player if they are not already
assigned. |
‣ entity ( ‣ callback ( |
|
Variant without callback argument. Parameter: entity ( Returns |
|||
getFormattedServerPermissions |
Formats server permissions based on a specified pattern. |
‣ pattern ( ‣ replaceable ( |
|
Variant without replaceable argument. Parameter: pattern ( Returns |
|||
getFormattedPlayerPermissions |
Formats a player's permissions according to a specified
pattern. |
‣ entity ( ‣ pattern ( ‣ replaceable ( |
|
Variant without the replaceable argument. Parameters: entity ( Returns |
|||
addPermission |
Adds a permission to a player. |
‣ entity ( ‣ permission ( ‣ callback ( |
|
Variant without the callback argument. Parameters: entity ( Returns |
|||
removePermission |
Removes a permission from a player. |
‣ entity ( ‣ permission ( ‣ callback ( |
|
Variant without the callback argument. Parameters: entity ( Returns |
|||
getPermissionsArray | Retrieves a player's permissions as an array. | ‣ entity ( |
|
hasPermission | Checks if a player has a specific permission. |
‣ entity ( ‣ permission ( |
|
getEntityPermissions | Retrieves the permissions of an entity. | ‣ entity ( |
|
setPlayerPermissions | Sets the permissions of a player in the user data. |
‣ entity ( ‣ permissions ( |
|
getServerPermissions | Retrieves the server's permissions as an array. | ||
addServerPermission |
Adds a permission to the server if it does not already exist. |
‣ permission ( ‣ callback ( |
|
Variant without the callback argument. Parameter: permission ( Returns |
|||
removeServerPermission |
Removes a permission from the server if it exists. |
‣ permission ( ‣ callback ( |
|
Variant without the callback argument. Parameter: permission ( Returns |
|||
getPermissionsArray | Retrieves a player's permissions as an array. | ‣ entity ( |
|
hasPermission | Checks if a player has a specific permission. |
‣ entity ( ‣ permission ( |
|
getEntityPermissions | Retrieves all permissions assigned to an entity. | ‣ entity ( |
|
setPlayerPermissions | Defines a set of permissions for a player within the user data. |
‣ entity ( ‣ permissions ( |
Example of Use
// Usage example for BCKPermissions:
Entity player = ...; // Obtain a player entity
BCKPermissions.defaultPermissions(player, 1);
SuperLog.info("MyMod", "Default permissions assigned to player: " + player.getName().getString());
BCKSuggestionProvider
Classe fournissant des méthodes pour générer des suggestions de commandes pour les permissions. Ces suggestions sont utilisées dans un contexte de commande Minecraft via Brigadier.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
suggestions | Génère des suggestions de permissions basées sur le type et l'entité du joueur. |
‣ context ( ‣ builder ( ‣ type ( ‣ player ( |
|
listSuggestions | Génère des suggestions basées sur une liste donnée. |
‣ context ( ‣ builder ( ‣ list ( |
|
createSuggestionProvider | Crée un fournisseur de suggestions basé sur un type de permissions et un joueur. |
‣ type ( ‣ player ( |
|
createSuggestionProviderFromList | Crée un fournisseur de suggestions basé sur une liste spécifique de données. |
‣ list ( |
|
suggest | Crée un fournisseur de suggestions à partir d'un tableau de suggestions. |
‣ suggestions ( |
Exemple d'Utilisation
// Exemple d'utilisation pour BCKSuggestionProvider :
SuggestionProvider provider =
BCKSuggestionProvider.createSuggestionProvider("player_permissions", player);
SuperLog.info("MyMod", "SuggestionProvider créé avec succès.");
Class providing methods for generating command suggestions for permissions. These suggestions are used in a Minecraft command context via Brigadier.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
suggestions | Generates suggestions for permissions based on type and player entity. |
‣ context ( ‣ builder ( ‣ type ( ‣ player ( |
|
listSuggestions | Generates suggestions based on a provided list. |
‣ context ( ‣ builder ( ‣ list ( |
|
createSuggestionProvider | Creates a suggestion provider based on permission type and player entity. |
‣ type ( ‣ player ( |
|
createSuggestionProviderFromList | Creates a suggestion provider based on a specific list of data. |
‣ list ( |
|
suggest | Creates a suggestion provider from an array of suggestions. |
‣ suggestions ( |
Example of Use
// Usage example for BCKSuggestionProvider:
SuggestionProvider provider =
BCKSuggestionProvider.createSuggestionProvider("player_permissions", player);
SuperLog.info("MyMod", "SuggestionProvider created successfully.");
Classe fournissant des méthodes pour générer des suggestions de commandes pour les permissions. Ces suggestions sont utilisées dans un contexte de commande Minecraft via Brigadier.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
suggestions | Génère des suggestions de permissions basées sur le type et l'entité du joueur. |
‣ context ( ‣ builder ( ‣ type ( ‣ player ( |
|
listSuggestions | Génère des suggestions basées sur une liste donnée. |
‣ context ( ‣ builder ( ‣ list ( |
|
createSuggestionProvider | Crée un fournisseur de suggestions basé sur un type de permissions et un joueur. |
‣ type ( ‣ player ( |
|
createSuggestionProviderFromList | Crée un fournisseur de suggestions basé sur une liste spécifique de données. |
‣ list ( |
|
suggest | Crée un fournisseur de suggestions à partir d'un tableau de suggestions. |
‣ suggestions ( |
Exemple d'Utilisation
// Exemple d'utilisation pour BCKSuggestionProvider :
SuggestionProvider provider =
BCKSuggestionProvider.createSuggestionProvider("player_permissions", player);
SuperLog.info("MyMod", "SuggestionProvider créé avec succès.");
Class providing methods for generating command suggestions for permissions. These suggestions are used in a Minecraft command context via Brigadier.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
suggestions | Generates suggestions for permissions based on type and player entity. |
‣ context ( ‣ builder ( ‣ type ( ‣ player ( |
|
listSuggestions | Generates suggestions based on a provided list. |
‣ context ( ‣ builder ( ‣ list ( |
|
createSuggestionProvider | Creates a suggestion provider based on permission type and player entity. |
‣ type ( ‣ player ( |
|
createSuggestionProviderFromList | Creates a suggestion provider based on a specific list of data. |
‣ list ( |
|
suggest | Creates a suggestion provider from an array of suggestions. |
‣ suggestions ( |
Example of Use
// Usage example for BCKSuggestionProvider:
SuggestionProvider provider =
BCKSuggestionProvider.createSuggestionProvider("player_permissions", player);
SuperLog.info("MyMod", "SuggestionProvider created successfully.");
BlockEventBreak
Classe qui gère l'événement de destruction de blocs dans le jeu. Cette
classe est enregistrée pour écouter les événements de type
Méthodes Disponibles
Méthode | Description | Annotations | Paramètre | Retour |
---|---|---|---|---|
onBlockBreak | Méthode appelée lors de l'événement de rupture d'un bloc. Elle enregistre un message avec les informations sur le bloc cassé, le joueur et le monde dans lequel cela se produit. |
‣ event ( |
Exemple d'Utilisation
// Exemple d'utilisation pour BlockEventBreak :
BlockEvent.BreakEvent event = ...; // Obtenez un événement de rupture de bloc
BlockEventBreak.onBlockBreak(event);
SuperLog.info("MyMod", "Bloc cassé par un joueur, log enregistré.");
Class that handles block break events in the game. This class is
registered to listen to events of type
Available Methods
Method | Description | Annotations | Parameter | Return |
---|---|---|---|---|
onBlockBreak | Method called when a block break event occurs. It logs a message with information about the broken block, the player, and the world where it happens. |
‣ event ( |
Example of Use
// Usage example for BlockEventBreak:
BlockEvent.BreakEvent event = ...; // Obtain a block break event
BlockEventBreak.onBlockBreak(event);
SuperLog.info("MyMod", "Block broken by a player, log recorded.");
Classe qui gère l'événement de destruction de blocs dans le jeu. Cette
classe est enregistrée pour écouter les événements de type
Méthodes Disponibles
Méthode | Description | Annotations | Paramètre | Retour |
---|---|---|---|---|
onBlockBreak | Méthode appelée lors de l'événement de rupture d'un bloc. Elle enregistre un message avec les informations sur le bloc cassé, le joueur et le monde dans lequel cela se produit. |
‣ event ( |
Exemple d'Utilisation
// Exemple d'utilisation pour BlockEventBreak :
BlockEvent.BreakEvent event = ...; // Obtenez un événement de rupture de bloc
BlockEventBreak.onBlockBreak(event);
SuperLog.info("MyMod", "Bloc cassé par un joueur, log enregistré.");
Class that handles block break events in the game. This class is
registered to listen to events of type
Available Methods
Method | Description | Annotations | Parameter | Return |
---|---|---|---|---|
onBlockBreak | Method called when a block break event occurs. It logs a message with information about the broken block, the player, and the world where it happens. |
‣ event ( |
Example of Use
// Usage example for BlockEventBreak:
BlockEvent.BreakEvent event = ...; // Obtain a block break event
BlockEventBreak.onBlockBreak(event);
SuperLog.info("MyMod", "Block broken by a player, log recorded.");
BlockEventPlace
Classe qui gère l'événement de placement de blocs dans le jeu. Cette
classe est enregistrée pour écouter les événements de type
Méthodes Disponibles
Méthode | Description | Annotations | Paramètre | Retour |
---|---|---|---|---|
onBlockBreak | Méthode appelée lors de l'événement de placement d'un bloc. Elle enregistre un message avec les informations sur le bloc placé, le joueur (entité) et le monde dans lequel cela se produit. |
‣ event (
|
Exemple d'Utilisation
// Exemple d'utilisation pour BlockEventPlace :
BlockEvent.EntityPlaceEvent event = ...; // Obtenez un événement de placement de bloc
BlockEventPlace.onBlockBreak(event);
SuperLog.info("MyMod", "Bloc placé par une entité, log enregistré.");
Class that handles block placement events in the game. This class is
registered to listen to events of type
Available Methods
Method | Description | Annotations | Parameter | Return |
---|---|---|---|---|
onBlockBreak | Method called during a block placement event. It logs a message with information about the placed block, the player (entity), and the world where it happens. |
‣ event (
|
Example of Use
// Usage example for BlockEventPlace:
BlockEvent.EntityPlaceEvent event = ...; // Obtain a block placement event
BlockEventPlace.onBlockBreak(event);
SuperLog.info("MyMod", "Block placed by an entity, log recorded.");
Classe qui gère l'événement de placement de blocs dans le jeu. Cette
classe est enregistrée pour écouter les événements de type
Méthodes Disponibles
Méthode | Description | Annotations | Paramètre | Retour |
---|---|---|---|---|
onBlockBreak | Méthode appelée lors de l'événement de placement d'un bloc. Elle enregistre un message avec les informations sur le bloc placé, le joueur (entité) et le monde dans lequel cela se produit. |
‣ event (
|
Exemple d'Utilisation
// Exemple d'utilisation pour BlockEventPlace :
BlockEvent.EntityPlaceEvent event = ...; // Obtenez un événement de placement de bloc
BlockEventPlace.onBlockBreak(event);
SuperLog.info("MyMod", "Bloc placé par une entité, log enregistré.");
Class that handles block placement events in the game. This class is
registered to listen to events of type
Available Methods
Method | Description | Annotations | Parameter | Return |
---|---|---|---|---|
onBlockBreak | Method called during a block placement event. It logs a message with information about the placed block, the player (entity), and the world where it happens. |
‣ event (
|
Example of Use
// Usage example for BlockEventPlace:
BlockEvent.EntityPlaceEvent event = ...; // Obtain a block placement event
BlockEventPlace.onBlockBreak(event);
SuperLog.info("MyMod", "Block placed by an entity, log recorded.");
BorderManager
Classe qui gère les bordures personnalisées pour les objets dans le jeu. Elle permet d'ajouter et de récupérer des bordures spécifiques associées à chaque objet.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
addCustomBorder | Méthode pour ajouter une bordure personnalisée à un objet. |
‣ itemStack ( ‣ borderStyle ( BorderStyle) |
|
getBorderStyle | Méthode pour récupérer la bordure personnalisée d'un objet. |
‣ itemStack ( |
BorderStyle (nullable) |
Exemple d'Utilisation
// Exemple d'utilisation pour BorderManager :
ItemStack itemStack = ...; // Obtenez un objet ItemStack
BorderStyle borderStyle = ...; // Définissez un style de bordure
// Ajout d'une bordure personnalisée
BorderManager.addCustomBorder(itemStack, borderStyle);
SuperLog.info("MyMod", "Bordure ajoutée avec succès.");
// Récupération de la bordure personnalisée
BorderStyle retrievedStyle = BorderManager.getBorderStyle(itemStack);
if (retrievedStyle != null) {
SuperLog.info("MyMod", "Bordure récupérée : " + retrievedStyle.toString());
} else {
SuperLog.info("MyMod", "Aucune bordure définie pour cet objet.");
}
Class that manages custom borders for items in the game. It allows adding and retrieving specific borders associated with each item.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
addCustomBorder | Method to add a custom border to an item. |
‣ itemStack ( ‣ borderStyle ( BorderStyle) |
|
getBorderStyle | Method to retrieve the custom border of an item. |
‣ itemStack ( |
BorderStyle (nullable) |
Example of Use
// Usage example for BorderManager:
ItemStack itemStack = ...; // Obtain an ItemStack object
BorderStyle borderStyle = ...; // Define a border style
// Adding a custom border
BorderManager.addCustomBorder(itemStack, borderStyle);
SuperLog.info("MyMod", "Border successfully added.");
// Retrieving the custom border
BorderStyle retrievedStyle = BorderManager.getBorderStyle(itemStack);
if (retrievedStyle != null) {
SuperLog.info("MyMod", "Border retrieved: " + retrievedStyle.toString());
} else {
SuperLog.info("MyMod", "No border defined for this item.");
}
Classe qui gère les bordures personnalisées pour les objets dans le jeu. Elle permet d'ajouter et de récupérer des bordures spécifiques associées à chaque objet.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
addCustomBorder | Méthode pour ajouter une bordure personnalisée à un objet. |
‣ itemStack ( ‣ borderStyle ( BorderStyle) |
|
getBorderStyle | Méthode pour récupérer la bordure personnalisée d'un objet. |
‣ itemStack ( |
BorderStyle (nullable) |
Exemple d'Utilisation
// Exemple d'utilisation pour BorderManager :
ItemStack itemStack = ...; // Obtenez un objet ItemStack
BorderStyle borderStyle = ...; // Définissez un style de bordure
// Ajout d'une bordure personnalisée
BorderManager.addCustomBorder(itemStack, borderStyle);
SuperLog.info("MyMod", "Bordure ajoutée avec succès.");
// Récupération de la bordure personnalisée
BorderStyle retrievedStyle = BorderManager.getBorderStyle(itemStack);
if (retrievedStyle != null) {
SuperLog.info("MyMod", "Bordure récupérée : " + retrievedStyle.toString());
} else {
SuperLog.info("MyMod", "Aucune bordure définie pour cet objet.");
}
Class that manages custom borders for items in the game. It allows adding and retrieving specific borders associated with each item.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
addCustomBorder | Method to add a custom border to an item. |
‣ itemStack ( ‣ borderStyle ( BorderStyle) |
|
getBorderStyle | Method to retrieve the custom border of an item. |
‣ itemStack ( |
BorderStyle (nullable) |
Example of Use
// Usage example for BorderManager:
ItemStack itemStack = ...; // Obtain an ItemStack object
BorderStyle borderStyle = ...; // Define a border style
// Adding a custom border
BorderManager.addCustomBorder(itemStack, borderStyle);
SuperLog.info("MyMod", "Border successfully added.");
// Retrieving the custom border
BorderStyle retrievedStyle = BorderManager.getBorderStyle(itemStack);
if (retrievedStyle != null) {
SuperLog.info("MyMod", "Border retrieved: " + retrievedStyle.toString());
} else {
SuperLog.info("MyMod", "No border defined for this item.");
}
BorderStyle
Enumération représentant différents styles de bordures pour les objets. Chaque style de bordure est associé à une couleur (ou un code hexadécimal).
Constantes Disponibles
- DEFAULT : Bordure par défaut (aucune couleur spécifique).
- GREEN_BORDER : Bordure verte (#4dff76).
- BLUE_BORDER : Bordure bleue (#00d5ff).
- PURPLE_BORDER : Bordure violette (#9a4dff).
- YELLOW_BORDER : Bordure jaune (#e5ff00).
- CUSTOM_BORDER : Bordure personnalisée (sans couleur définie par défaut).
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotations |
---|---|---|---|---|
toString | Méthode qui retourne la représentation sous forme de chaîne de caractère du style de bordure. |
Exemple d'Utilisation
// Exemple d'utilisation pour BorderStyle :
BorderStyle style = BorderStyle.GREEN_BORDER;
SuperLog.info("MyMod", "Le style de bordure sélectionné est : " + style.toString());
Enumeration representing different border styles for objects. Each border style is associated with a color (or a hexadecimal code).
Available Constants
- DEFAULT: Default border (no specific color).
- GREEN_BORDER: Green border (#4dff76).
- BLUE_BORDER: Blue border (#00d5ff).
- PURPLE_BORDER: Purple border (#9a4dff).
- YELLOW_BORDER: Yellow border (#e5ff00).
- CUSTOM_BORDER: Custom border (no default color defined).
Available Methods
Method | Description | Parameter | Return | Annotations |
---|---|---|---|---|
toString | Method that returns the string representation of the border style. |
Example of Use
// Usage example for BorderStyle:
BorderStyle style = BorderStyle.GREEN_BORDER;
SuperLog.info("MyMod", "The selected border style is: " + style.toString());
Enumération représentant différents styles de bordures pour les objets. Chaque style de bordure est associé à une couleur (ou un code hexadécimal).
Constantes Disponibles
- DEFAULT : Bordure par défaut (aucune couleur spécifique).
- GREEN_BORDER : Bordure verte (#4dff76).
- BLUE_BORDER : Bordure bleue (#00d5ff).
- PURPLE_BORDER : Bordure violette (#9a4dff).
- YELLOW_BORDER : Bordure jaune (#e5ff00).
- CUSTOM_BORDER : Bordure personnalisée (sans couleur définie par défaut).
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotations |
---|---|---|---|---|
toString | Méthode qui retourne la représentation sous forme de chaîne de caractère du style de bordure. |
Exemple d'Utilisation
// Exemple d'utilisation pour BorderStyle :
BorderStyle style = BorderStyle.GREEN_BORDER;
SuperLog.info("MyMod", "Le style de bordure sélectionné est : " + style.toString());
Enumeration representing different border styles for objects. Each border style is associated with a color (or a hexadecimal code).
Available Constants
- DEFAULT: Default border (no specific color).
- GREEN_BORDER: Green border (#4dff76).
- BLUE_BORDER: Blue border (#00d5ff).
- PURPLE_BORDER: Purple border (#9a4dff).
- YELLOW_BORDER: Yellow border (#e5ff00).
- CUSTOM_BORDER: Custom border (no default color defined).
Available Methods
Method | Description | Parameter | Return | Annotations |
---|---|---|---|---|
toString | Method that returns the string representation of the border style. |
Example of Use
// Usage example for BorderStyle:
BorderStyle style = BorderStyle.GREEN_BORDER;
SuperLog.info("MyMod", "The selected border style is: " + style.toString());
ChestEventOpen
Classe qui gère l'événement d'ouverture d'un coffre par un joueur dans
le jeu. Cette classe écoute les événements de type
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotations |
---|---|---|---|---|
onRightClickBlock | Méthode appelée lors d'un clic droit sur un bloc. Cette méthode vérifie si le joueur a interagi avec un coffre et enregistre un message de log avec les détails de l'événement. |
‣ event
( |
Exemple d'Utilisation
// Exemple d'utilisation pour ChestEventOpen :
PlayerInteractEvent.RightClickBlock event = ...; // Simuler un événement
ChestEventOpen.onRightClickBlock(event);
SuperLog.info("MyMod", "Un joueur a ouvert un coffre !");
Class that handles the event of a player opening a chest in the game.
This class listens to
Available Methods
Method | Description | Parameter | Return | Annotations |
---|---|---|---|---|
onRightClickBlock | Method called when a block is right-clicked. This method checks if the player interacted with a chest and logs a message with the event details. |
‣ event
( |
Example of Use
// Usage example for ChestEventOpen:
PlayerInteractEvent.RightClickBlock event = ...; // Simulate an event
ChestEventOpen.onRightClickBlock(event);
SuperLog.info("MyMod", "A player has opened a chest!");
Classe qui gère l'événement d'ouverture d'un coffre par un joueur dans
le jeu. Cette classe écoute les événements de type
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotations |
---|---|---|---|---|
onRightClickBlock | Méthode appelée lors d'un clic droit sur un bloc. Cette méthode vérifie si le joueur a interagi avec un coffre et enregistre un message de log avec les détails de l'événement. |
‣ event
( |
Exemple d'Utilisation
// Exemple d'utilisation pour ChestEventOpen :
PlayerInteractEvent.RightClickBlock event = ...; // Simuler un événement
ChestEventOpen.onRightClickBlock(event);
SuperLog.info("MyMod", "Un joueur a ouvert un coffre !");
Class that handles the event of a player opening a chest in the game.
This class listens to
Available Methods
Method | Description | Parameter | Return | Annotations |
---|---|---|---|---|
onRightClickBlock | Method called when a block is right-clicked. This method checks if the player interacted with a chest and logs a message with the event details. |
‣ event
( |
Example of Use
// Usage example for ChestEventOpen:
PlayerInteractEvent.RightClickBlock event = ...; // Simulate an event
ChestEventOpen.onRightClickBlock(event);
SuperLog.info("MyMod", "A player has opened a chest!");
CommandEventHandler
Classe qui gère l'événement lié à l'exécution des commandes dans le jeu. Elle écoute les événements de commande et enregistre des informations dans les logs chaque fois qu'une commande est exécutée, avec des détails sur le joueur qui a envoyé la commande et la commande elle-même.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotations |
---|---|---|---|---|
onCommandEvent | Méthode appelée chaque fois qu'une commande est exécutée dans le jeu. Elle enregistre un message de log contenant des informations sur la commande exécutée et sur le joueur qui a envoyé la commande. |
‣ event ( |
Exemple d'Utilisation
// Exemple d'utilisation pour CommandEventHandler :
CommandEvent event = ...; // Simuler un événement de commande
CommandEventHandler.onCommandEvent(event);
SuperLog.info("MyMod", "Une commande a été exécutée.");
Class that handles events related to the execution of commands in the game. It listens to command events and logs information every time a command is executed, including details about the player who issued the command and the command itself.
Available Methods
Method | Description | Parameter | Return | Annotations |
---|---|---|---|---|
onCommandEvent | Method called whenever a command is executed in the game. It logs a message containing information about the executed command and the player who issued it. |
‣ event ( |
Example of Use
// Usage example for CommandEventHandler:
CommandEvent event = ...; // Simulate a command event
CommandEventHandler.onCommandEvent(event);
SuperLog.info("MyMod", "A command has been executed.");
Classe qui gère l'événement lié à l'exécution des commandes dans le jeu. Elle écoute les événements de commande et enregistre des informations dans les logs chaque fois qu'une commande est exécutée, avec des détails sur le joueur qui a envoyé la commande et la commande elle-même.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotations |
---|---|---|---|---|
onCommandEvent | Méthode appelée chaque fois qu'une commande est exécutée dans le jeu. Elle enregistre un message de log contenant des informations sur la commande exécutée et sur le joueur qui a envoyé la commande. |
‣ event ( |
Exemple d'Utilisation
// Exemple d'utilisation pour CommandEventHandler :
CommandEvent event = ...; // Simuler un événement de commande
CommandEventHandler.onCommandEvent(event);
SuperLog.info("MyMod", "Une commande a été exécutée.");
Class that handles events related to the execution of commands in the game. It listens to command events and logs information every time a command is executed, including details about the player who issued the command and the command itself.
Available Methods
Method | Description | Parameter | Return | Annotations |
---|---|---|---|---|
onCommandEvent | Method called whenever a command is executed in the game. It logs a message containing information about the executed command and the player who issued it. |
‣ event ( |
Example of Use
// Usage example for CommandEventHandler:
CommandEvent event = ...; // Simulate a command event
CommandEventHandler.onCommandEvent(event);
SuperLog.info("MyMod", "A command has been executed.");
Config
Classe qui gère la configuration de l'application TetraLibs. Cette classe permet de charger, modifier et supprimer des configurations à partir d'un fichier JSON, de gérer les configurations temporaires et d'effectuer des vérifications sur les paramètres.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotations |
---|---|---|---|---|
getTemporaryConfigurations | Récupère les configurations temporaires sous forme de carte. |
|
||
getTemporaryConfigurationsAsTetraConfig | Récupère les configurations temporaires sous forme d'un objet TetraConfig. | TetraConfig | ||
clearTemporaryConfigurations |
Efface toutes les configurations temporaires. Si le paramètre
callback est true, un message de confirmation est enregistré dans
les logs. |
‣ callback ( |
||
Variante sans argument callback. Retourne |
||||
setTemporaryConfigurations | Charge les configurations temporaires depuis un fichier JSON. Les configurations sont lues et stockées dans la carte temporaryConfigurations. | |||
initializeConfigurations | Initialise les configurations de base du module TetraLibs. Cette méthode ajoute les configurations par défaut et les configurations supplémentaires définies par l'utilisateur. | |||
addConfiguration | Ajoute une nouvelle configuration avec un nom et une valeur. |
‣ name ( ‣ value ( |
||
removeConfiguration | Supprime une configuration par son nom. | ‣ name ( |
||
getConfiguration | Récupère la valeur d'une configuration par son nom. | ‣ name ( |
||
isConfigurationEnabled | Vérifie si une configuration est activée (retourne true). | ‣ name ( |
||
transferConfig | Transfère toutes les configurations d'un autre objet Config vers celui-ci. | ‣ config (Config) | ||
getAdditionalConfigurations | Récupère les configurations supplémentaires. |
|
Exemple d'Utilisation
// Exemple d'utilisation pour Config :
Config config = new Config();
config.addConfiguration("new_feature", true);
SuperLog.info("MyMod", "Nouvelle configuration ajoutée !");
Class that manages the configuration of the TetraLibs application. This class allows loading, modifying, and deleting configurations from a JSON file, managing temporary configurations, and performing parameter validations.
Available Methods
Method | Description | Parameter | Return | Annotations |
---|
Method | Description | Parameter | Return | Annotations |
---|---|---|---|---|
getTemporaryConfigurations | Retrieves temporary configurations as a map. |
|
||
getTemporaryConfigurationsAsTetraConfig | Retrieves temporary configurations as a TetraConfig object. | TetraConfig | ||
clearTemporaryConfigurations |
Clears all temporary configurations. If the callback parameter is
true, a confirmation message is logged. |
‣ callback ( |
||
Variant without the callback argument. Returns |
||||
setTemporaryConfigurations | Loads temporary configurations from a JSON file. Configurations are read and stored in the `temporaryConfigurations` map. | |||
initializeConfigurations | Initializes the basic configurations of the TetraLibs module. This method adds default configurations and additional user-defined configurations. | |||
addConfiguration | Adds a new configuration with a name and a value. |
‣ name ( ‣ value ( |
||
removeConfiguration | Removes a configuration by its name. | ‣ name ( |
||
getConfiguration | Retrieves the value of a configuration by its name. | ‣ name ( |
||
isConfigurationEnabled | Checks if a configuration is enabled (returns true). | ‣ name ( |
||
transferConfig | Transfers all configurations from another Config object to this one. | ‣ config (Config) | ||
getAdditionalConfigurations | Retrieves additional configurations. |
|
Example of Use
// Usage example for Config:
Config config = new Config();
config.addConfiguration("new_feature", true);
SuperLog.info("MyMod", "New configuration added!");
Classe qui gère la configuration de l'application TetraLibs. Cette classe permet de charger, modifier et supprimer des configurations à partir d'un fichier JSON, de gérer les configurations temporaires et d'effectuer des vérifications sur les paramètres.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotations |
---|---|---|---|---|
getTemporaryConfigurations | Récupère les configurations temporaires sous forme de carte. |
|
||
getTemporaryConfigurationsAsTetraConfig | Récupère les configurations temporaires sous forme d'un objet TetraConfig. | TetraConfig | ||
clearTemporaryConfigurations |
Efface toutes les configurations temporaires. Si le paramètre
callback est true, un message de confirmation est enregistré dans
les logs. |
‣ callback ( |
||
Variante sans argument callback. Retourne |
||||
setTemporaryConfigurations | Charge les configurations temporaires depuis un fichier JSON. Les configurations sont lues et stockées dans la carte temporaryConfigurations. | |||
initializeConfigurations | Initialise les configurations de base du module TetraLibs. Cette méthode ajoute les configurations par défaut et les configurations supplémentaires définies par l'utilisateur. | |||
addConfiguration | Ajoute une nouvelle configuration avec un nom et une valeur. |
‣ name ( ‣ value ( |
||
removeConfiguration | Supprime une configuration par son nom. | ‣ name ( |
||
getConfiguration | Récupère la valeur d'une configuration par son nom. | ‣ name ( |
||
isConfigurationEnabled | Vérifie si une configuration est activée (retourne true). | ‣ name ( |
||
transferConfig | Transfère toutes les configurations d'un autre objet Config vers celui-ci. | ‣ config (Config) | ||
getAdditionalConfigurations | Récupère les configurations supplémentaires. |
|
Exemple d'Utilisation
// Exemple d'utilisation pour Config :
Config config = new Config();
config.addConfiguration("new_feature", true);
SuperLog.info("MyMod", "Nouvelle configuration ajoutée !");
Class that manages the configuration of the TetraLibs application. This class allows loading, modifying, and deleting configurations from a JSON file, managing temporary configurations, and performing parameter validations.
Available Methods
Method | Description | Parameter | Return | Annotations |
---|
Method | Description | Parameter | Return | Annotations |
---|---|---|---|---|
getTemporaryConfigurations | Retrieves temporary configurations as a map. |
|
||
getTemporaryConfigurationsAsTetraConfig | Retrieves temporary configurations as a TetraConfig object. | TetraConfig | ||
clearTemporaryConfigurations |
Clears all temporary configurations. If the callback parameter is
true, a confirmation message is logged. |
‣ callback ( |
||
Variant without the callback argument. Returns |
||||
setTemporaryConfigurations | Loads temporary configurations from a JSON file. Configurations are read and stored in the `temporaryConfigurations` map. | |||
initializeConfigurations | Initializes the basic configurations of the TetraLibs module. This method adds default configurations and additional user-defined configurations. | |||
addConfiguration | Adds a new configuration with a name and a value. |
‣ name ( ‣ value ( |
||
removeConfiguration | Removes a configuration by its name. | ‣ name ( |
||
getConfiguration | Retrieves the value of a configuration by its name. | ‣ name ( |
||
isConfigurationEnabled | Checks if a configuration is enabled (returns true). | ‣ name ( |
||
transferConfig | Transfers all configurations from another Config object to this one. | ‣ config (Config) | ||
getAdditionalConfigurations | Retrieves additional configurations. |
|
Example of Use
// Usage example for Config:
Config config = new Config();
config.addConfiguration("new_feature", true);
SuperLog.info("MyMod", "New configuration added!");
ConfigManager
Classe responsable de la gestion des fichiers de configuration dans TetraLibs. Elle permet de charger, sauvegarder et copier des fichiers de configuration pour le serveur Minecraft.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | |
---|---|---|---|---|
initializeConfig |
Charge et stocke les configurations au démarrage du monde. |
‣ reloaded ( Optionnel |
||
Variante sans le paramètre reloaded .Paramètre : Retourne : |
||||
getLoadedConfig | Récupère la configuration chargée. Lève une exception si la configuration n'a pas été initialisée. | TetraConfig | ||
loadConfig |
Charge la configuration depuis un fichier. |
‣ callback ( ‣ reloaded ( Optionnel |
TetraConfig | |
Variantes supplémentaires : 1. Avec uniquement callback comme paramètre.Paramètre : callback (Retourne : TetraConfig. 2. Sans aucun paramètre. Paramètre : Retourne : TetraConfig. |
||||
saveConfig | Sauvegarde la configuration dans un fichier au format JSON. | ‣ config (TetraConfig) | ||
copyFile | Copie un fichier vers le répertoire de configuration. Si le fichier existe déjà, il est remplacé. | ‣ file ( |
Exemple d'Utilisation
// Exemple d'utilisation pour ConfigManager :
ConfigManager.initializeConfig(true);
TetraConfig config = ConfigManager.getLoadedConfig();
SuperLog.info("MyMod", "Configuration chargée avec succès !");
Class responsible for managing configuration files in TetraLibs. This class allows loading, saving, and copying configuration files for the Minecraft server.
Available Methods
Method | Description | Parameter | Return | |
---|---|---|---|---|
initializeConfig |
Loads and stores configurations during world initialization. |
‣ reloaded ( Optional |
||
Variant without the reloaded parameter.Parameter : Returns : |
||||
getLoadedConfig | Retrieves the loaded configuration. Throws an exception if the configuration has not been initialized. | TetraConfig | ||
loadConfig |
Loads the configuration from a file. |
‣ callback ( ‣ reloaded ( Optional |
TetraConfig | |
Additional variants: 1. With only callback as a parameter.Parameter : callback (Returns : TetraConfig. 2. Without any parameters. Parameter : Returns : TetraConfig. |
||||
saveConfig | Saves the configuration to a file in JSON format. | ‣ config (TetraConfig) | ||
copyFile | Copies a file to the configuration directory. If the file already exists, it is replaced. | ‣ file ( |
Example of Use
// Usage example for ConfigManager:
ConfigManager.initializeConfig(true);
TetraConfig config = ConfigManager.getLoadedConfig();
SuperLog.info("MyMod", "Configuration loaded successfully!");
Classe responsable de la gestion des fichiers de configuration dans TetraLibs. Elle permet de charger, sauvegarder et copier des fichiers de configuration pour le serveur Minecraft.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | |
---|---|---|---|---|
initializeConfig |
Charge et stocke les configurations au démarrage du monde. |
‣ reloaded ( Optionnel |
||
Variante sans le paramètre reloaded .Paramètre : Retourne : |
||||
getLoadedConfig | Récupère la configuration chargée. Lève une exception si la configuration n'a pas été initialisée. | TetraConfig | ||
loadConfig |
Charge la configuration depuis un fichier. |
‣ callback ( ‣ reloaded ( Optionnel |
TetraConfig | |
Variantes supplémentaires : 1. Avec uniquement callback comme paramètre.Paramètre : callback (Retourne : TetraConfig. 2. Sans aucun paramètre. Paramètre : Retourne : TetraConfig. |
||||
saveConfig | Sauvegarde la configuration dans un fichier au format JSON. | ‣ config (TetraConfig) | ||
copyFile | Copie un fichier vers le répertoire de configuration. Si le fichier existe déjà, il est remplacé. | ‣ file ( |
Exemple d'Utilisation
// Exemple d'utilisation pour ConfigManager :
ConfigManager.initializeConfig(true);
TetraConfig config = ConfigManager.getLoadedConfig();
SuperLog.info("MyMod", "Configuration chargée avec succès !");
Class responsible for managing configuration files in TetraLibs. This class allows loading, saving, and copying configuration files for the Minecraft server.
Available Methods
Method | Description | Parameter | Return | |
---|---|---|---|---|
initializeConfig |
Loads and stores configurations during world initialization. |
‣ reloaded ( Optional |
||
Variant without the reloaded parameter.Parameter : Returns : |
||||
getLoadedConfig | Retrieves the loaded configuration. Throws an exception if the configuration has not been initialized. | TetraConfig | ||
loadConfig |
Loads the configuration from a file. |
‣ callback ( ‣ reloaded ( Optional |
TetraConfig | |
Additional variants: 1. With only callback as a parameter.Parameter : callback (Returns : TetraConfig. 2. Without any parameters. Parameter : Returns : TetraConfig. |
||||
saveConfig | Saves the configuration to a file in JSON format. | ‣ config (TetraConfig) | ||
copyFile | Copies a file to the configuration directory. If the file already exists, it is replaced. | ‣ file ( |
Example of Use
// Usage example for ConfigManager:
ConfigManager.initializeConfig(true);
TetraConfig config = ConfigManager.getLoadedConfig();
SuperLog.info("MyMod", "Configuration loaded successfully!");
ConsoleColors
Enumération qui contient les codes de couleur ANSI pour la coloration du texte dans la console. Ces couleurs peuvent être utilisées pour modifier l'apparence du texte dans un terminal compatible.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotations |
---|---|---|---|---|
toString | Retourne le code ANSI de la couleur sous forme de chaîne de caractères. |
Exemple d'Utilisation
// Exemple d'utilisation pour ConsoleColors :
System.out.println(ConsoleColors.GREEN + "Texte vert" + ConsoleColors.RESET);
System.out.println(ConsoleColors.RED_BOLD + "Texte rouge en gras" + ConsoleColors.RESET);
Enumeration that contains ANSI color codes for text coloring in the console. These colors can be used to modify the appearance of text in a compatible terminal.
Available Methods
Method | Description | Parameter | Return | Annotations |
---|---|---|---|---|
toString | Returns the ANSI color code as a string. |
Example of Use
// Usage example for ConsoleColors:
System.out.println(ConsoleColors.GREEN + "Green text" + ConsoleColors.RESET);
System.out.println(ConsoleColors.RED_BOLD + "Bold red text" + ConsoleColors.RESET);
Enumération qui contient les codes de couleur ANSI pour la coloration du texte dans la console. Ces couleurs peuvent être utilisées pour modifier l'apparence du texte dans un terminal compatible.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotations |
---|---|---|---|---|
toString | Retourne le code ANSI de la couleur sous forme de chaîne de caractères. |
Exemple d'Utilisation
// Exemple d'utilisation pour ConsoleColors :
System.out.println(ConsoleColors.GREEN + "Texte vert" + ConsoleColors.RESET);
System.out.println(ConsoleColors.RED_BOLD + "Texte rouge en gras" + ConsoleColors.RESET);
Enumeration that contains ANSI color codes for text coloring in the console. These colors can be used to modify the appearance of text in a compatible terminal.
Available Methods
Method | Description | Parameter | Return | Annotations |
---|---|---|---|---|
toString | Returns the ANSI color code as a string. |
Example of Use
// Usage example for ConsoleColors:
System.out.println(ConsoleColors.GREEN + "Green text" + ConsoleColors.RESET);
System.out.println(ConsoleColors.RED_BOLD + "Bold red text" + ConsoleColors.RESET);
CreativeChecker
Classe permettant de vérifier si un joueur est en mode créatif et d'exécuter des actions spécifiques en fonction de cette vérification.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
CreativeChecker | Constructeur de la classe CreativeChecker. | ‣ player ( |
|
isNotInCreativeMode |
Vérifie si le joueur n'est pas en mode créatif. Retourne true si le joueur est en mode autre que créatif
(par exemple : survie), et false si le joueur est en mode créatif.
|
||
setNonCreativeEvent | Permet de définir un événement personnalisé à exécuter si le joueur n'est pas en mode créatif. | ‣ event ( |
|
action |
Exécute l'événement personnalisé si le joueur n'est pas en mode créatif. Si le joueur est en mode créatif, aucun événement n'est exécuté. |
Exemple d'Utilisation
// Exemple d'utilisation pour CreativeChecker :
Player player = ...; // Obtenez un joueur
CreativeChecker checker = new CreativeChecker(player);
checker.setNonCreativeEvent(p -> {
SuperLog.info("MyMod", "Le joueur " + p.getName().getString() + " n'est pas en mode créatif.");
});
checker.action();
Class to check if a player is in creative mode and perform specific actions based on this verification.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
CreativeChecker | Constructor for the CreativeChecker class. | ‣ player ( |
|
isNotInCreativeMode |
Checks if the player is not in creative mode. Returns true if the player is in a mode other than creative
(e.g., survival), and false if the player is in creative mode.
|
||
setNonCreativeEvent | Allows defining a custom event to execute if the player is not in creative mode. | ‣ event ( |
|
action |
Executes the custom event if the player is not in creative mode. If the player is in creative mode, no event is executed. |
Example of Use
// Usage example for CreativeChecker:
Player player = ...; // Obtain a player
CreativeChecker checker = new CreativeChecker(player);
checker.setNonCreativeEvent(p -> {
SuperLog.info("MyMod", "Player " + p.getName().getString() + " is not in creative mode.");
});
checker.action();
Classe permettant de vérifier si un joueur est en mode créatif et d'exécuter des actions spécifiques en fonction de cette vérification.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
CreativeChecker | Constructeur de la classe CreativeChecker. | ‣ player ( |
|
isNotInCreativeMode |
Vérifie si le joueur n'est pas en mode créatif. Retourne true si le joueur est en mode autre que créatif
(par exemple : survie), et false si le joueur est en mode créatif.
|
||
setNonCreativeEvent | Permet de définir un événement personnalisé à exécuter si le joueur n'est pas en mode créatif. | ‣ event ( |
|
action |
Exécute l'événement personnalisé si le joueur n'est pas en mode créatif. Si le joueur est en mode créatif, aucun événement n'est exécuté. |
Exemple d'Utilisation
// Exemple d'utilisation pour CreativeChecker :
Player player = ...; // Obtenez un joueur
CreativeChecker checker = new CreativeChecker(player);
checker.setNonCreativeEvent(p -> {
SuperLog.info("MyMod", "Le joueur " + p.getName().getString() + " n'est pas en mode créatif.");
});
checker.action();
Class to check if a player is in creative mode and perform specific actions based on this verification.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
CreativeChecker | Constructor for the CreativeChecker class. | ‣ player ( |
|
isNotInCreativeMode |
Checks if the player is not in creative mode. Returns true if the player is in a mode other than creative
(e.g., survival), and false if the player is in creative mode.
|
||
setNonCreativeEvent | Allows defining a custom event to execute if the player is not in creative mode. | ‣ event ( |
|
action |
Executes the custom event if the player is not in creative mode. If the player is in creative mode, no event is executed. |
Example of Use
// Usage example for CreativeChecker:
Player player = ...; // Obtain a player
CreativeChecker checker = new CreativeChecker(player);
checker.setNonCreativeEvent(p -> {
SuperLog.info("MyMod", "Player " + p.getName().getString() + " is not in creative mode.");
});
checker.action();
DocumentationGenerator
Classe permettant de générer une documentation au format JSON à partir du code source Java d'un projet. La documentation inclut les classes, leurs descriptions, et leurs méthodes avec les paramètres et types de retour.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotations |
---|---|---|---|---|
main |
Méthode principale pour générer la documentation de toutes les
classes Java dans le dossier spécifié. Parcourt tous les fichiers Java, génère la documentation et la sauvegarde dans un fichier JSON. |
|||
generateDocumentation |
Génère la documentation d'une classe à partir de son fichier
source. Retourne un objet représentant la classe, ou null si une erreur survient. |
‣ file ( |
BCKClass | |
getClassDescription | Extrait la description Javadoc de la classe à partir de son contenu source. | ‣ fileContent ( |
||
getMethods | Extrait les méthodes et leurs descriptions Javadoc à partir du contenu source. | ‣ fileContent ( |
|
|
generateJsonDocumentation | Génère la documentation JSON à partir d'une liste de classes et de méthodes. |
‣ classes
( |
||
saveDocumentationToFile | Sauvegarde la documentation JSON dans un fichier. | ‣ jsonDoc ( |
Exemple d'Utilisation
// Exemple d'utilisation pour DocumentationGenerator :
DocumentationGenerator.main();
Class for generating JSON documentation from the Java source code of a project. The documentation includes classes, their descriptions, and their methods with parameters and return types.
Available Methods
Method | Description | Parameter | Return | Annotations |
---|---|---|---|---|
main |
Main method to generate documentation for all Java classes in the
specified folder. Scans all Java files, generates the documentation, and saves it to a JSON file. |
|||
generateDocumentation |
Generates the documentation for a class from its source file. Returns an object representing the class, or null if an error occurs. |
‣ file ( |
BCKClass | |
getClassDescription | Extracts the Javadoc description of the class from its source content. | ‣ fileContent ( |
||
getMethods | Extracts methods and their Javadoc descriptions from the source content. | ‣ fileContent ( |
|
|
generateJsonDocumentation | Generates JSON documentation from a list of classes and methods. |
‣ classes
( |
||
saveDocumentationToFile | Saves the JSON documentation to a file. | ‣ jsonDoc ( |
Example of Use
// Usage example for DocumentationGenerator:
DocumentationGenerator.main();
Classe permettant de générer une documentation au format JSON à partir du code source Java d'un projet. La documentation inclut les classes, leurs descriptions, et leurs méthodes avec les paramètres et types de retour.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotations |
---|---|---|---|---|
main |
Méthode principale pour générer la documentation de toutes les
classes Java dans le dossier spécifié. Parcourt tous les fichiers Java, génère la documentation et la sauvegarde dans un fichier JSON. |
|||
generateDocumentation |
Génère la documentation d'une classe à partir de son fichier
source. Retourne un objet représentant la classe, ou null si une erreur survient. |
‣ file ( |
BCKClass | |
getClassDescription | Extrait la description Javadoc de la classe à partir de son contenu source. | ‣ fileContent ( |
||
getMethods | Extrait les méthodes et leurs descriptions Javadoc à partir du contenu source. | ‣ fileContent ( |
|
|
generateJsonDocumentation | Génère la documentation JSON à partir d'une liste de classes et de méthodes. |
‣ classes
( |
||
saveDocumentationToFile | Sauvegarde la documentation JSON dans un fichier. | ‣ jsonDoc ( |
Exemple d'Utilisation
// Exemple d'utilisation pour DocumentationGenerator :
DocumentationGenerator.main();
Class for generating JSON documentation from the Java source code of a project. The documentation includes classes, their descriptions, and their methods with parameters and return types.
Available Methods
Method | Description | Parameter | Return | Annotations |
---|---|---|---|---|
main |
Main method to generate documentation for all Java classes in the
specified folder. Scans all Java files, generates the documentation, and saves it to a JSON file. |
|||
generateDocumentation |
Generates the documentation for a class from its source file. Returns an object representing the class, or null if an error occurs. |
‣ file ( |
BCKClass | |
getClassDescription | Extracts the Javadoc description of the class from its source content. | ‣ fileContent ( |
||
getMethods | Extracts methods and their Javadoc descriptions from the source content. | ‣ fileContent ( |
|
|
generateJsonDocumentation | Generates JSON documentation from a list of classes and methods. |
‣ classes
( |
||
saveDocumentationToFile | Saves the JSON documentation to a file. | ‣ jsonDoc ( |
Example of Use
// Usage example for DocumentationGenerator:
DocumentationGenerator.main();
EconomyManager
Classe permettant de gérer les interactions économiques d'un joueur dans le jeu, incluant l'argent en poche et en banque. Fournit des méthodes pour manipuler, transférer et sauvegarder les soldes d'argent.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
saveBalances |
Sauvegarde les soldes d'un joueur (argent en poche et en banque) dans la base de données. |
‣ player ( ‣ callback ( |
|
Variante sans argument callback. Paramètre : player ( Retourne |
|||
loadBalances |
Charge les soldes d'un joueur (argent en poche et en banque) depuis la base de données. |
‣ player ( ‣ callback ( |
|
Variante sans argument callback. Paramètre : player ( Retourne |
|||
addMoney |
Ajoute une somme d'argent au solde en poche du joueur. |
‣ player ( ‣ amount ( ‣ callback ( |
|
Variante sans argument callback. Paramètres : ‣ player ( ‣ amount ( Retourne |
|||
removeMoney |
Retire une somme d'argent au solde en poche du joueur. |
‣ player ( ‣ amount ( ‣ callback ( |
|
Variante sans argument callback. Paramètres : ‣ player ( ‣ amount ( Retourne |
|||
setMoney |
Définit un montant précis pour l'argent en poche du joueur. |
‣ player ( ‣ amount ( ‣ callback ( |
|
Variante sans argument callback. Paramètres : ‣ player ( ‣ amount ( Retourne |
|||
getMoney | Récupère le solde actuel d'argent du joueur en poche. |
‣ player ( |
|
hasMoney | Vérifie si un joueur a un solde suffisant en poche. |
‣ player ( ‣ amount ( |
|
addBank |
Ajoute une somme d'argent au compte bancaire du joueur. |
‣ player ( ‣ amount ( ‣ callback ( |
|
Variante sans argument callback. Paramètres : ‣ player ( ‣ amount ( Retourne |
|||
removeBank |
Retire une somme d'argent du compte bancaire du joueur. |
‣ player ( ‣ amount ( ‣ callback ( |
|
Variante sans argument callback. Paramètres : ‣ player ( ‣ amount ( Retourne |
|||
setBank |
Définit un montant précis pour le solde bancaire du joueur. |
‣ player ( ‣ amount ( ‣ callback ( |
|
Variante sans argument callback. Paramètres : ‣ player ( ‣ amount ( Retourne |
|||
getBank | Récupère le solde actuel du compte bancaire du joueur. |
‣ player ( |
|
hasBank | Vérifie si un joueur a un solde bancaire suffisant. |
‣ player ( ‣ amount ( |
|
transferBank |
Transfère une somme d'argent du compte bancaire d'un joueur à celui d'un autre. |
‣ sender ( ‣ receiver ( ‣ amount ( ‣ callback ( |
|
Comportement : Si le joueur expéditeur (sender) n'a pas un solde bancaire suffisant, le transfert échoue et retourne Paramètres : ‣ sender ( ‣ receiver ( ‣ amount ( ‣ callback ( |
Exemple d'Utilisation
// Exemple d'utilisation pour EconomyManager :
Player player1 = ...; // Obtenez un joueur
EconomyManager.saveBalances(player1, true);
EconomyManager.addMoney(player1, 500.0);
Class for managing a player's economic interactions in the game, including wallet and bank balances. Provides methods to manipulate, transfer, and save balances.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
saveBalances |
Saves a player's balances (wallet and bank) to the database. |
‣ player ( ‣ callback ( |
|
Variant without callback argument. Parameter: player ( Returns |
|||
loadBalances |
Loads a player's balances (wallet and bank) from the database. |
‣ player ( ‣ callback ( |
|
Variant without callback argument. Parameter: player ( Returns |
|||
addMoney |
Adds an amount to the player's wallet balance. |
‣ player ( ‣ amount ( ‣ callback ( |
|
Variant without callback argument. Parameters: ‣ player ( ‣ amount ( Returns |
|||
removeBank |
Removes a specified amount from the player's bank account. |
‣ player ( ‣ amount ( ‣ callback ( |
|
Variant without callback argument. Parameters: ‣ player ( ‣ amount ( Returns |
|||
setBank |
Sets a specific amount for the player's bank account balance. |
‣ player ( ‣ amount ( ‣ callback ( |
|
Variant without callback argument. Parameters: ‣ player ( ‣ amount ( Returns |
|||
getBank | Retrieves the player's current bank account balance. |
‣ player ( |
|
hasBank | Checks if the player has sufficient funds in their bank account. |
‣ player ( ‣ amount ( |
|
transferBank |
Transfers an amount from the sender's bank account to the receiver's account. |
‣ sender ( ‣ receiver ( ‣ amount ( ‣ callback ( |
|
Behavior: If the sender does not have sufficient bank balance, the transfer fails and returns Parameters: ‣ sender ( ‣ receiver ( ‣ amount ( ‣ callback ( |
Example of Use
// Usage example for EconomyManager:
Player player1 = ...; // Obtain a player
EconomyManager.saveBalances(player1, true);
EconomyManager.addMoney(player1, 500.0);
Classe permettant de gérer les interactions économiques d'un joueur dans le jeu, incluant l'argent en poche et en banque. Fournit des méthodes pour manipuler, transférer et sauvegarder les soldes d'argent.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
saveBalances |
Sauvegarde les soldes d'un joueur (argent en poche et en banque) dans la base de données. |
‣ player ( ‣ callback ( |
|
Variante sans argument callback. Paramètre : player ( Retourne |
|||
loadBalances |
Charge les soldes d'un joueur (argent en poche et en banque) depuis la base de données. |
‣ player ( ‣ callback ( |
|
Variante sans argument callback. Paramètre : player ( Retourne |
|||
addMoney |
Ajoute une somme d'argent au solde en poche du joueur. |
‣ player ( ‣ amount ( ‣ callback ( |
|
Variante sans argument callback. Paramètres : ‣ player ( ‣ amount ( Retourne |
|||
removeMoney |
Retire une somme d'argent au solde en poche du joueur. |
‣ player ( ‣ amount ( ‣ callback ( |
|
Variante sans argument callback. Paramètres : ‣ player ( ‣ amount ( Retourne |
|||
setMoney |
Définit un montant précis pour l'argent en poche du joueur. |
‣ player ( ‣ amount ( ‣ callback ( |
|
Variante sans argument callback. Paramètres : ‣ player ( ‣ amount ( Retourne |
|||
getMoney | Récupère le solde actuel d'argent du joueur en poche. |
‣ player ( |
|
hasMoney | Vérifie si un joueur a un solde suffisant en poche. |
‣ player ( ‣ amount ( |
|
addBank |
Ajoute une somme d'argent au compte bancaire du joueur. |
‣ player ( ‣ amount ( ‣ callback ( |
|
Variante sans argument callback. Paramètres : ‣ player ( ‣ amount ( Retourne |
|||
removeBank |
Retire une somme d'argent du compte bancaire du joueur. |
‣ player ( ‣ amount ( ‣ callback ( |
|
Variante sans argument callback. Paramètres : ‣ player ( ‣ amount ( Retourne |
|||
setBank |
Définit un montant précis pour le solde bancaire du joueur. |
‣ player ( ‣ amount ( ‣ callback ( |
|
Variante sans argument callback. Paramètres : ‣ player ( ‣ amount ( Retourne |
|||
getBank | Récupère le solde actuel du compte bancaire du joueur. |
‣ player ( |
|
hasBank | Vérifie si un joueur a un solde bancaire suffisant. |
‣ player ( ‣ amount ( |
|
transferBank |
Transfère une somme d'argent du compte bancaire d'un joueur à celui d'un autre. |
‣ sender ( ‣ receiver ( ‣ amount ( ‣ callback ( |
|
Comportement : Si le joueur expéditeur (sender) n'a pas un solde bancaire suffisant, le transfert échoue et retourne Paramètres : ‣ sender ( ‣ receiver ( ‣ amount ( ‣ callback ( |
Exemple d'Utilisation
// Exemple d'utilisation pour EconomyManager :
Player player1 = ...; // Obtenez un joueur
EconomyManager.saveBalances(player1, true);
EconomyManager.addMoney(player1, 500.0);
Class for managing a player's economic interactions in the game, including wallet and bank balances. Provides methods to manipulate, transfer, and save balances.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
saveBalances |
Saves a player's balances (wallet and bank) to the database. |
‣ player ( ‣ callback ( |
|
Variant without callback argument. Parameter: player ( Returns |
|||
loadBalances |
Loads a player's balances (wallet and bank) from the database. |
‣ player ( ‣ callback ( |
|
Variant without callback argument. Parameter: player ( Returns |
|||
addMoney |
Adds an amount to the player's wallet balance. |
‣ player ( ‣ amount ( ‣ callback ( |
|
Variant without callback argument. Parameters: ‣ player ( ‣ amount ( Returns |
|||
removeBank |
Removes a specified amount from the player's bank account. |
‣ player ( ‣ amount ( ‣ callback ( |
|
Variant without callback argument. Parameters: ‣ player ( ‣ amount ( Returns |
|||
setBank |
Sets a specific amount for the player's bank account balance. |
‣ player ( ‣ amount ( ‣ callback ( |
|
Variant without callback argument. Parameters: ‣ player ( ‣ amount ( Returns |
|||
getBank | Retrieves the player's current bank account balance. |
‣ player ( |
|
hasBank | Checks if the player has sufficient funds in their bank account. |
‣ player ( ‣ amount ( |
|
transferBank |
Transfers an amount from the sender's bank account to the receiver's account. |
‣ sender ( ‣ receiver ( ‣ amount ( ‣ callback ( |
|
Behavior: If the sender does not have sufficient bank balance, the transfer fails and returns Parameters: ‣ sender ( ‣ receiver ( ‣ amount ( ‣ callback ( |
Example of Use
// Usage example for EconomyManager:
Player player1 = ...; // Obtain a player
EconomyManager.saveBalances(player1, true);
EconomyManager.addMoney(player1, 500.0);
GameModeHandler
Classe fournissant des méthodes utilitaires pour vérifier le mode de jeu (solo ou multijoueur) et exécuter du code spécifiquement côté client ou serveur.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
isSinglePlayer |
Vérifie si le joueur est en mode solo (jeu en solo). Cette méthode utilise l'instance de Minecraft pour déterminer si le jeu est en mode solo. |
|
|
isMultiPlayerServer |
Vérifie si le joueur est sur un serveur multijoueur. Cette méthode utilise l'instance de MinecraftServer pour vérifier si le joueur est connecté à un serveur multijoueur. |
|
|
executeClientOnlyCode |
Exécute du code côté client uniquement. Cette méthode permet d'exécuter une action spécifique au client. |
‣ action ( |
|
executeServerOnlyCode |
Exécute du code côté serveur uniquement. Cette méthode permet d'exécuter une action spécifique au serveur. |
‣ action ( |
Exemple d'Utilisation
// Exemple d'utilisation pour GameModeHandler :
if (GameModeHandler.isSinglePlayer()) {
SuperLog.info("TetraLibs/GameModeHandler", "Le joueur est en mode solo.");
} else {
SuperLog.info("TetraLibs/GameModeHandler", "Le joueur est sur un serveur multijoueur.");
}
GameModeHandler.executeClientOnlyCode(() -> {
SuperLog.info("TetraLibs/GameModeHandler", "Code côté client exécuté.");
});
GameModeHandler.executeServerOnlyCode(() -> {
SuperLog.info("TetraLibs/GameModeHandler", "Code côté serveur exécuté.");
});
Class providing utility methods to check the game mode (single-player or multiplayer) and execute code specifically on the client or server side.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
isSinglePlayer |
Checks if the player is in single-player mode. This method uses the Minecraft instance to determine if the game is in single-player mode. |
|
|
isMultiPlayerServer |
Checks if the player is on a multiplayer server. This method uses the MinecraftServer instance to check if the player is connected to a multiplayer server. |
|
|
executeClientOnlyCode |
Executes client-only code. This method allows running an action specific to the client. |
‣ action ( |
|
executeServerOnlyCode |
Executes server-only code. This method allows running an action specific to the server. |
‣ action ( |
Example of Use
// Example usage for GameModeHandler:
if (GameModeHandler.isSinglePlayer()) {
SuperLog.info("TetraLibs/GameModeHandler", "Player is in single-player mode.");
} else {
SuperLog.info("TetraLibs/GameModeHandler", "Player is on a multiplayer server.");
}
GameModeHandler.executeClientOnlyCode(() -> {
SuperLog.info("TetraLibs/GameModeHandler", "Client-side code executed.");
});
GameModeHandler.executeServerOnlyCode(() -> {
SuperLog.info("TetraLibs/GameModeHandler", "Server-side code executed.");
});
Classe fournissant des méthodes utilitaires pour vérifier le mode de jeu (solo ou multijoueur) et exécuter du code spécifiquement côté client ou serveur.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
isSinglePlayer |
Vérifie si le joueur est en mode solo (jeu en solo). Cette méthode utilise l'instance de Minecraft pour déterminer si le jeu est en mode solo. |
|
|
isMultiPlayerServer |
Vérifie si le joueur est sur un serveur multijoueur. Cette méthode utilise l'instance de MinecraftServer pour vérifier si le joueur est connecté à un serveur multijoueur. |
|
|
executeClientOnlyCode |
Exécute du code côté client uniquement. Cette méthode permet d'exécuter une action spécifique au client. |
‣ action ( |
|
executeServerOnlyCode |
Exécute du code côté serveur uniquement. Cette méthode permet d'exécuter une action spécifique au serveur. |
‣ action ( |
Exemple d'Utilisation
// Exemple d'utilisation pour GameModeHandler :
if (GameModeHandler.isSinglePlayer()) {
SuperLog.info("TetraLibs/GameModeHandler", "Le joueur est en mode solo.");
} else {
SuperLog.info("TetraLibs/GameModeHandler", "Le joueur est sur un serveur multijoueur.");
}
GameModeHandler.executeClientOnlyCode(() -> {
SuperLog.info("TetraLibs/GameModeHandler", "Code côté client exécuté.");
});
GameModeHandler.executeServerOnlyCode(() -> {
SuperLog.info("TetraLibs/GameModeHandler", "Code côté serveur exécuté.");
});
Class providing utility methods to check the game mode (single-player or multiplayer) and execute code specifically on the client or server side.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
isSinglePlayer |
Checks if the player is in single-player mode. This method uses the Minecraft instance to determine if the game is in single-player mode. |
|
|
isMultiPlayerServer |
Checks if the player is on a multiplayer server. This method uses the MinecraftServer instance to check if the player is connected to a multiplayer server. |
|
|
executeClientOnlyCode |
Executes client-only code. This method allows running an action specific to the client. |
‣ action ( |
|
executeServerOnlyCode |
Executes server-only code. This method allows running an action specific to the server. |
‣ action ( |
Example of Use
// Example usage for GameModeHandler:
if (GameModeHandler.isSinglePlayer()) {
SuperLog.info("TetraLibs/GameModeHandler", "Player is in single-player mode.");
} else {
SuperLog.info("TetraLibs/GameModeHandler", "Player is on a multiplayer server.");
}
GameModeHandler.executeClientOnlyCode(() -> {
SuperLog.info("TetraLibs/GameModeHandler", "Client-side code executed.");
});
GameModeHandler.executeServerOnlyCode(() -> {
SuperLog.info("TetraLibs/GameModeHandler", "Server-side code executed.");
});
Init
Cette classe gère l'initialisation du mod TetraLibs. Elle s'exécute lors du cycle de vie de Forge et effectue des configurations générales, comme l'affichage de messages dans les logs ou l'appel à des méthodes importantes comme la génération de documentation.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotations |
---|---|---|---|---|
init |
Méthode appelée automatiquement par Forge lors de l'événement FMLCommonSetupEvent. Agit comme un point d'entrée pour l'initialisation des fonctionnalités générales du mod. |
|||
executeInit |
Méthode publique d'initialisation principale. Permet d'appeler l'initialisation sans paramètre d'événement. |
|||
executeInit |
Méthode privée d'initialisation détaillée. Effectue les principales actions d'initialisation, comme l'affichage de messages dans les logs et l'appel au générateur de documentation. |
‣ event ( |
Exemple d'Utilisation
// Exemple d'utilisation pour Init :
Init.executeInit(); // Exécute l'initialisation principale sans événement.
This class handles the initialization of the TetraLibs mod. It runs during the Forge lifecycle and performs general configuration, such as logging messages and calling important methods like generating documentation.
Available Methods
Method | Description | Parameter | Return | Annotations |
---|---|---|---|---|
init |
Method automatically called by Forge during the FMLCommonSetupEvent. Acts as an entry point for initializing the mod's general features. |
|||
executeInit |
Main public initialization method. Allows calling the initialization without an event parameter. |
|||
executeInit |
Private detailed initialization method. Performs the main initialization actions, such as logging messages and calling the documentation generator. |
‣ event ( |
Example of Use
// Example usage for Init:
Init.executeInit(); // Executes the main initialization without an event.
Cette classe gère l'initialisation du mod TetraLibs. Elle s'exécute lors du cycle de vie de Forge et effectue des configurations générales, comme l'affichage de messages dans les logs ou l'appel à des méthodes importantes comme la génération de documentation.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotations |
---|---|---|---|---|
init |
Méthode appelée automatiquement par Forge lors de l'événement FMLCommonSetupEvent. Agit comme un point d'entrée pour l'initialisation des fonctionnalités générales du mod. |
|||
executeInit |
Méthode publique d'initialisation principale. Permet d'appeler l'initialisation sans paramètre d'événement. |
|||
executeInit |
Méthode privée d'initialisation détaillée. Effectue les principales actions d'initialisation, comme l'affichage de messages dans les logs et l'appel au générateur de documentation. |
‣ event ( |
Exemple d'Utilisation
// Exemple d'utilisation pour Init :
Init.executeInit(); // Exécute l'initialisation principale sans événement.
This class handles the initialization of the TetraLibs mod. It runs during the Forge lifecycle and performs general configuration, such as logging messages and calling important methods like generating documentation.
Available Methods
Method | Description | Parameter | Return | Annotations |
---|---|---|---|---|
init |
Method automatically called by Forge during the FMLCommonSetupEvent. Acts as an entry point for initializing the mod's general features. |
|||
executeInit |
Main public initialization method. Allows calling the initialization without an event parameter. |
|||
executeInit |
Private detailed initialization method. Performs the main initialization actions, such as logging messages and calling the documentation generator. |
‣ event ( |
Example of Use
// Example usage for Init:
Init.executeInit(); // Executes the main initialization without an event.
InventoryManager
Cette classe offre des méthodes utilitaires pour gérer l'inventaire des joueurs dans Minecraft. Elle fournit des fonctionnalités comme l'ajout, la suppression, la vérification et le comptage des objets dans l'inventaire d'un joueur.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
clearInventory | Vide l'intégralité de l'inventaire d'un joueur. |
‣ player ( |
|
addItem | Ajoute un objet spécifique à l'inventaire d'un joueur. |
‣ player ( ‣ item ( |
|
removeItem | Supprime un objet spécifique de l'inventaire d'un joueur. |
‣ player ( ‣ item ( |
|
getPlayerItems | Récupère tous les objets présents dans l'inventaire d'un joueur. |
‣ player ( |
|
hasItem | Vérifie si un joueur possède un objet spécifique dans son inventaire. |
‣ player ( ‣ item ( |
|
countItems | Compte le nombre d'instances d'un objet spécifique dans l'inventaire d'un joueur. |
‣ player ( ‣ item ( |
Exemple d'Utilisation
// Exemple d'utilisation pour InventoryManager :
Player player = ...; // Obtenez un joueur
ItemStack item = ...; // Créez un objet à ajouter
InventoryManager.addItem(player, item);
SuperLog.info("TetraLibs/InventoryManager", "Objet ajouté à l'inventaire du joueur.");
This class provides utility methods to manage a player's inventory in Minecraft. It offers features like adding, removing, checking, and counting items in a player's inventory.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
clearInventory | Clears the entire inventory of a player. |
‣ player ( |
|
addItem | Adds a specific item to a player's inventory. |
‣ player ( ‣ item ( |
|
removeItem | Removes a specific item from a player's inventory. |
‣ player ( ‣ item ( |
|
getPlayerItems | Retrieves all the items present in a player's inventory. |
‣ player ( |
|
hasItem | Checks if a player has a specific item in their inventory. |
‣ player ( ‣ item ( |
|
countItems | Counts the number of instances of a specific item in a player's inventory. |
‣ player ( ‣ item ( |
Example of Use
// Example usage for InventoryManager:
Player player = ...; // Obtain a player
ItemStack item = ...; // Create an item to add
InventoryManager.addItem(player, item);
SuperLog.info("TetraLibs/InventoryManager", "Item added to player's inventory.");
Cette classe offre des méthodes utilitaires pour gérer l'inventaire des joueurs dans Minecraft. Elle fournit des fonctionnalités comme l'ajout, la suppression, la vérification et le comptage des objets dans l'inventaire d'un joueur.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
clearInventory | Vide l'intégralité de l'inventaire d'un joueur. |
‣ player ( |
|
addItem | Ajoute un objet spécifique à l'inventaire d'un joueur. |
‣ player ( ‣ item ( |
|
removeItem | Supprime un objet spécifique de l'inventaire d'un joueur. |
‣ player ( ‣ item ( |
|
getPlayerItems | Récupère tous les objets présents dans l'inventaire d'un joueur. |
‣ player ( |
|
hasItem | Vérifie si un joueur possède un objet spécifique dans son inventaire. |
‣ player ( ‣ item ( |
|
countItems | Compte le nombre d'instances d'un objet spécifique dans l'inventaire d'un joueur. |
‣ player ( ‣ item ( |
Exemple d'Utilisation
// Exemple d'utilisation pour InventoryManager :
Player player = ...; // Obtenez un joueur
ItemStack item = ...; // Créez un objet à ajouter
InventoryManager.addItem(player, item);
SuperLog.info("TetraLibs/InventoryManager", "Objet ajouté à l'inventaire du joueur.");
This class provides utility methods to manage a player's inventory in Minecraft. It offers features like adding, removing, checking, and counting items in a player's inventory.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
clearInventory | Clears the entire inventory of a player. |
‣ player ( |
|
addItem | Adds a specific item to a player's inventory. |
‣ player ( ‣ item ( |
|
removeItem | Removes a specific item from a player's inventory. |
‣ player ( ‣ item ( |
|
getPlayerItems | Retrieves all the items present in a player's inventory. |
‣ player ( |
|
hasItem | Checks if a player has a specific item in their inventory. |
‣ player ( ‣ item ( |
|
countItems | Counts the number of instances of a specific item in a player's inventory. |
‣ player ( ‣ item ( |
Example of Use
// Example usage for InventoryManager:
Player player = ...; // Obtain a player
ItemStack item = ...; // Create an item to add
InventoryManager.addItem(player, item);
SuperLog.info("TetraLibs/InventoryManager", "Item added to player's inventory.");
ItemEventDrop
Cette classe gère les événements liés au largage d'objets par les joueurs. Elle est inscrite en tant qu'abonné aux événements Forge, ce qui permet de déclencher des actions spécifiques lorsque des événements ciblés surviennent.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotations |
---|---|---|---|---|
onGemDropped |
Gestionnaire de l'événement de largage d'objet. Cette méthode est appelée lorsque le joueur largue un objet dans le monde. |
‣ event ( |
Exemple d'Utilisation
// Exemple d'utilisation pour ItemEventDrop :
ItemEventDrop.onGemDropped(event); // Appelle l'événement de largage d'objet
SuperLog.info("TetraLibs/ItemEventDrop", "L'objet a été largué avec succès.");
This class handles events related to item drops by players. It is subscribed to Forge events, allowing specific actions to be triggered when targeted events occur.
Available Methods
Method | Description | Parameter | Return | Annotations |
---|---|---|---|---|
onGemDropped |
Handles the item drop event. This method is called when the player drops an item in the world. |
‣ event ( |
Example of Use
// Example usage for ItemEventDrop:
ItemEventDrop.onGemDropped(event); // Calls the item drop event
SuperLog.info("TetraLibs/ItemEventDrop", "The item has been dropped successfully.");
Cette classe gère les événements liés au largage d'objets par les joueurs. Elle est inscrite en tant qu'abonné aux événements Forge, ce qui permet de déclencher des actions spécifiques lorsque des événements ciblés surviennent.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotations |
---|---|---|---|---|
onGemDropped |
Gestionnaire de l'événement de largage d'objet. Cette méthode est appelée lorsque le joueur largue un objet dans le monde. |
‣ event ( |
Exemple d'Utilisation
// Exemple d'utilisation pour ItemEventDrop :
ItemEventDrop.onGemDropped(event); // Appelle l'événement de largage d'objet
SuperLog.info("TetraLibs/ItemEventDrop", "L'objet a été largué avec succès.");
This class handles events related to item drops by players. It is subscribed to Forge events, allowing specific actions to be triggered when targeted events occur.
Available Methods
Method | Description | Parameter | Return | Annotations |
---|---|---|---|---|
onGemDropped |
Handles the item drop event. This method is called when the player drops an item in the world. |
‣ event ( |
Example of Use
// Example usage for ItemEventDrop:
ItemEventDrop.onGemDropped(event); // Calls the item drop event
SuperLog.info("TetraLibs/ItemEventDrop", "The item has been dropped successfully.");
ItemEventExpire
Gère les événements liés à l'expiration d'un objet dans le monde.
Cette classe est enregistrée pour écouter les événements Forge, notamment
les événements d'expiration des objets (
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
onGemDropped |
Gestionnaire de l'événement d'expiration d'objet. Cette méthode est appelée lorsque qu'un objet dans le monde expire (disparaît). |
‣ event ( |
Exemple d'Utilisation
// Exemple d'utilisation pour ItemEventExpire :
ItemEventExpire.onGemDropped(event); // Appelle l'événement d'expiration d'objet
SuperLog.info("TetraLibs/ItemEventExpire", "L'objet a expiré avec succès.");
Handles events related to the expiration of an item in the world.
This class is registered to listen to Forge events, including item expiration events (
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
onGemDropped |
Handles the item expiration event. This method is called when an item in the world expires (disappears). |
‣ event ( |
Example of Use
// Example usage for ItemEventExpire:
ItemEventExpire.onGemDropped(event); // Calls the item expiration event
SuperLog.info("TetraLibs/ItemEventExpire", "The item has expired successfully.");
Gère les événements liés à l'expiration d'un objet dans le monde.
Cette classe est enregistrée pour écouter les événements Forge, notamment
les événements d'expiration des objets (
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
onGemDropped |
Gestionnaire de l'événement d'expiration d'objet. Cette méthode est appelée lorsque qu'un objet dans le monde expire (disparaît). |
‣ event ( |
Exemple d'Utilisation
// Exemple d'utilisation pour ItemEventExpire :
ItemEventExpire.onGemDropped(event); // Appelle l'événement d'expiration d'objet
SuperLog.info("TetraLibs/ItemEventExpire", "L'objet a expiré avec succès.");
Handles events related to the expiration of an item in the world.
This class is registered to listen to Forge events, including item expiration events (
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
onGemDropped |
Handles the item expiration event. This method is called when an item in the world expires (disappears). |
‣ event ( |
Example of Use
// Example usage for ItemEventExpire:
ItemEventExpire.onGemDropped(event); // Calls the item expiration event
SuperLog.info("TetraLibs/ItemEventExpire", "The item has expired successfully.");
ItemEventPickup
Gère les événements liés à la récupération d'objets par un joueur.
Cette classe est enregistrée comme gestionnaire d'événements Forge pour
écouter les événements de type
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
onGemDropped |
Gestionnaire de l'événement de ramassage d'objet. Cette méthode est déclenchée lorsque qu'un joueur ramasse un objet dans le monde. |
‣ event ( |
Exemple d'Utilisation
// Exemple d'utilisation pour ItemEventPickup :
ItemEventPickup.onGemDropped(event); // Appelle l'événement de ramassage d'objet
SuperLog.info("TetraLibs/ItemEventPickup", "L'objet a été ramassé avec succès.");
This class handles events related to item pickups by players. It is registered as a Forge event handler
to listen to events like
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
onGemDropped |
Handles the item pickup event. This method is triggered when a player picks up an item in the world. |
‣ event ( |
Example of Use
// Example usage for ItemEventPickup:
ItemEventPickup.onGemDropped(event); // Calls the item pickup event
SuperLog.info("TetraLibs/ItemEventPickup", "The item has been picked up successfully.");
Gère les événements liés à la récupération d'objets par un joueur.
Cette classe est enregistrée comme gestionnaire d'événements Forge pour
écouter les événements de type
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
onGemDropped |
Gestionnaire de l'événement de ramassage d'objet. Cette méthode est déclenchée lorsque qu'un joueur ramasse un objet dans le monde. |
‣ event ( |
Exemple d'Utilisation
// Exemple d'utilisation pour ItemEventPickup :
ItemEventPickup.onGemDropped(event); // Appelle l'événement de ramassage d'objet
SuperLog.info("TetraLibs/ItemEventPickup", "L'objet a été ramassé avec succès.");
This class handles events related to item pickups by players. It is registered as a Forge event handler
to listen to events like
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
onGemDropped |
Handles the item pickup event. This method is triggered when a player picks up an item in the world. |
‣ event ( |
Example of Use
// Example usage for ItemEventPickup:
ItemEventPickup.onGemDropped(event); // Calls the item pickup event
SuperLog.info("TetraLibs/ItemEventPickup", "The item has been picked up successfully.");
ItemInfoTooltip
Classe qui gère l'affichage d'informations supplémentaires dans les infobulles des objets. Elle est associée à l'abonnement aux événements liés à l'affichage des infobulles des objets. Utilise un événement Forge pour modifier les infobulles des objets en fonction de leur clé.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotations |
---|---|---|---|---|
onTooltipRender |
Événement qui est déclenché lorsque l'infobulle d'un objet est affichée. Ajoute des informations supplémentaires si l'objet est dans la liste itemsWithAdditionalInfo et si la touche Shift est enfoncée.
|
‣ event ( |
||
getAdditionalInfo |
Récupère les informations supplémentaires d'un objet en utilisant sa clé. La clé de l'objet est utilisée pour générer une clé de traduction pour l'infobulle. |
‣ stack ( |
||
addItemWithAdditionalInfo | Ajoute un objet à la liste des objets ayant des informations supplémentaires dans l'infobulle. |
‣ item ( |
||
removeItemWithAdditionalInfo | Supprime un objet de la liste des objets ayant des informations supplémentaires dans l'infobulle. |
‣ item ( |
Exemple d'Utilisation
// Exemple d'utilisation pour ItemInfoTooltip :
ItemInfoTooltip.addItemWithAdditionalInfo("mod:item_name"); // Ajoute un objet avec des infos supplémentaires
ItemInfoTooltip.removeItemWithAdditionalInfo("mod:item_name"); // Supprime un objet
SuperLog.info("TetraLibs/ItemInfoTooltip", "Infobulle mise à jour.");
Class that manages the display of additional information in item tooltips. It subscribes to events related to displaying item tooltips using a Forge event to modify the tooltips based on the item key.
Available Methods
Method | Description | Parameter | Return | Annotations |
---|---|---|---|---|
onTooltipRender |
Event triggered when an item tooltip is displayed. Adds additional information if the item is in the itemsWithAdditionalInfo list and the Shift key is pressed.
|
‣ event ( |
||
getAdditionalInfo |
Retrieves additional information for an item using its key. The item key is used to generate a translation key for the tooltip. |
‣ stack ( |
||
addItemWithAdditionalInfo | Adds an item to the list of items with additional information in the tooltip. |
‣ item ( |
||
removeItemWithAdditionalInfo | Removes an item from the list of items with additional information in the tooltip. |
‣ item ( |
Example of Use
// Example usage for ItemInfoTooltip:
ItemInfoTooltip.addItemWithAdditionalInfo("mod:item_name"); // Adds an item with additional info
ItemInfoTooltip.removeItemWithAdditionalInfo("mod:item_name"); // Removes an item
SuperLog.info("TetraLibs/ItemInfoTooltip", "Tooltip updated.");
Classe qui gère l'affichage d'informations supplémentaires dans les infobulles des objets. Elle est associée à l'abonnement aux événements liés à l'affichage des infobulles des objets. Utilise un événement Forge pour modifier les infobulles des objets en fonction de leur clé.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotations |
---|---|---|---|---|
onTooltipRender |
Événement qui est déclenché lorsque l'infobulle d'un objet est affichée. Ajoute des informations supplémentaires si l'objet est dans la liste itemsWithAdditionalInfo et si la touche Shift est enfoncée.
|
‣ event ( |
||
getAdditionalInfo |
Récupère les informations supplémentaires d'un objet en utilisant sa clé. La clé de l'objet est utilisée pour générer une clé de traduction pour l'infobulle. |
‣ stack ( |
||
addItemWithAdditionalInfo | Ajoute un objet à la liste des objets ayant des informations supplémentaires dans l'infobulle. |
‣ item ( |
||
removeItemWithAdditionalInfo | Supprime un objet de la liste des objets ayant des informations supplémentaires dans l'infobulle. |
‣ item ( |
Exemple d'Utilisation
// Exemple d'utilisation pour ItemInfoTooltip :
ItemInfoTooltip.addItemWithAdditionalInfo("mod:item_name"); // Ajoute un objet avec des infos supplémentaires
ItemInfoTooltip.removeItemWithAdditionalInfo("mod:item_name"); // Supprime un objet
SuperLog.info("TetraLibs/ItemInfoTooltip", "Infobulle mise à jour.");
Class that manages the display of additional information in item tooltips. It subscribes to events related to displaying item tooltips using a Forge event to modify the tooltips based on the item key.
Available Methods
Method | Description | Parameter | Return | Annotations |
---|---|---|---|---|
onTooltipRender |
Event triggered when an item tooltip is displayed. Adds additional information if the item is in the itemsWithAdditionalInfo list and the Shift key is pressed.
|
‣ event ( |
||
getAdditionalInfo |
Retrieves additional information for an item using its key. The item key is used to generate a translation key for the tooltip. |
‣ stack ( |
||
addItemWithAdditionalInfo | Adds an item to the list of items with additional information in the tooltip. |
‣ item ( |
||
removeItemWithAdditionalInfo | Removes an item from the list of items with additional information in the tooltip. |
‣ item ( |
Example of Use
// Example usage for ItemInfoTooltip:
ItemInfoTooltip.addItemWithAdditionalInfo("mod:item_name"); // Adds an item with additional info
ItemInfoTooltip.removeItemWithAdditionalInfo("mod:item_name"); // Removes an item
SuperLog.info("TetraLibs/ItemInfoTooltip", "Tooltip updated.");
JsonKeyExtractor
Cette classe extrait toutes les clés imbriquées d'un fichier JSON dans le répertoire de configuration du mod,
y compris les objets vides. Elle récupère les clés au format de chemin complet (par exemple, block.id
,
block.properties.hardness
).
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
extractFullyQualifiedKeys | Extrait toutes les clés imbriquées avec des chemins complets à partir d'un fichier JSON dans le répertoire de configuration du mod, y compris les objets vides. |
‣ fileName ( ‣ path ( |
|
extractKeysRecursive | Extrait de manière récursive uniquement les clés complètes à partir d'un élément JSON, en s'assurant que les objets vides sont inclus. |
‣ element ( ‣ parentPath ( ‣ keys ( |
Exemple d'Utilisation
// Exemple d'utilisation pour JsonKeyExtractor :
Set keys = JsonKeyExtractor.extractFullyQualifiedKeys("example.json", "/config/path/");
SuperLog.info("TetraLibs/JsonKeyExtractor", "Clés extraites : " + keys);
This class extracts all nested keys from a JSON file in the mod's config directory,
including empty objects. It retrieves the keys in the full path format (e.g., block.id
,
block.properties.hardness
).
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
extractFullyQualifiedKeys | Extracts all nested keys with full paths from a JSON file in the mod's config directory, including empty objects. |
‣ fileName ( ‣ path ( |
|
extractKeysRecursive | Recursively extracts only fully qualified keys from a JSON element, ensuring empty objects are included. |
‣ element ( ‣ parentPath ( ‣ keys ( |
Example of Use
// Example usage for JsonKeyExtractor:
Set keys = JsonKeyExtractor.extractFullyQualifiedKeys("example.json", "/config/path/");
SuperLog.info("TetraLibs/JsonKeyExtractor", "Extracted keys: " + keys);
Cette classe extrait toutes les clés imbriquées d'un fichier JSON dans le répertoire de configuration du mod,
y compris les objets vides. Elle récupère les clés au format de chemin complet (par exemple, block.id
,
block.properties.hardness
).
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
extractFullyQualifiedKeys | Extrait toutes les clés imbriquées avec des chemins complets à partir d'un fichier JSON dans le répertoire de configuration du mod, y compris les objets vides. |
‣ fileName ( ‣ path ( |
|
extractKeysRecursive | Extrait de manière récursive uniquement les clés complètes à partir d'un élément JSON, en s'assurant que les objets vides sont inclus. |
‣ element ( ‣ parentPath ( ‣ keys ( |
Exemple d'Utilisation
// Exemple d'utilisation pour JsonKeyExtractor :
Set keys = JsonKeyExtractor.extractFullyQualifiedKeys("example.json", "/config/path/");
SuperLog.info("TetraLibs/JsonKeyExtractor", "Clés extraites : " + keys);
This class extracts all nested keys from a JSON file in the mod's config directory,
including empty objects. It retrieves the keys in the full path format (e.g., block.id
,
block.properties.hardness
).
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
extractFullyQualifiedKeys | Extracts all nested keys with full paths from a JSON file in the mod's config directory, including empty objects. |
‣ fileName ( ‣ path ( |
|
extractKeysRecursive | Recursively extracts only fully qualified keys from a JSON element, ensuring empty objects are included. |
‣ element ( ‣ parentPath ( ‣ keys ( |
Example of Use
// Example usage for JsonKeyExtractor:
Set keys = JsonKeyExtractor.extractFullyQualifiedKeys("example.json", "/config/path/");
SuperLog.info("TetraLibs/JsonKeyExtractor", "Extracted keys: " + keys);
Load
Cette classe est responsable de la gestion de l'événement lorsque le joueur se connecte au serveur. Lors de la connexion, elle effectue diverses initialisations et envoie des informations spécifiques au joueur concernant les fonctionnalités du mod.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotations |
---|---|---|---|---|
onPlayerLoggedIn | Événement déclenché lors de la connexion d'un joueur. Lors de la connexion, l'exécution de diverses initialisations et configurations spécifiques est effectuée. |
‣ event ( |
||
execute | Méthode de surcharges permettant d'exécuter des actions lorsque le joueur se connecte, mais sans avoir à utiliser directement l'événement. Permet de spécifier les coordonnées et l'entité dans différents contextes. |
‣ world ( ‣ x ( ‣ y ( ‣ z ( ‣ entity ( |
||
execute (avec Event) | Exécute toutes les actions nécessaires au moment de la connexion du joueur, comme l'affichage de pages d'aide et le chargement des variables du joueur. |
‣ event ( ‣ world ( ‣ x ( ‣ y ( ‣ z ( ‣ entity ( |
Exemple d'Utilisation
// Exemple d'utilisation pour Load :
Load.onPlayerLoggedIn(event);
This class is responsible for managing the event when a player logs into the server. Upon login, it performs various initializations and sends specific information to the player regarding the mod's features.
Available Methods
Method | Description | Parameter | Return | Annotations |
---|---|---|---|---|
onPlayerLoggedIn | Event triggered when a player logs in. During login, various initializations and specific configurations are executed. |
‣ event ( |
||
execute | Overloaded method that executes actions when a player logs in, but without directly using the event. It allows specifying coordinates and the entity in different contexts. |
‣ world ( ‣ x ( ‣ y ( ‣ z ( ‣ entity ( |
||
execute (with Event) | Executes all necessary actions at the moment of player login, such as displaying help pages and loading player variables. |
‣ event ( ‣ world ( ‣ x ( ‣ y ( ‣ z ( ‣ entity ( |
Example of Use
// Example usage for Load:
Load.onPlayerLoggedIn(event);
Cette classe est responsable de la gestion de l'événement lorsque le joueur se connecte au serveur. Lors de la connexion, elle effectue diverses initialisations et envoie des informations spécifiques au joueur concernant les fonctionnalités du mod.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotations |
---|---|---|---|---|
onPlayerLoggedIn | Événement déclenché lors de la connexion d'un joueur. Lors de la connexion, l'exécution de diverses initialisations et configurations spécifiques est effectuée. |
‣ event ( |
||
execute | Méthode de surcharges permettant d'exécuter des actions lorsque le joueur se connecte, mais sans avoir à utiliser directement l'événement. Permet de spécifier les coordonnées et l'entité dans différents contextes. |
‣ world ( ‣ x ( ‣ y ( ‣ z ( ‣ entity ( |
||
execute (avec Event) | Exécute toutes les actions nécessaires au moment de la connexion du joueur, comme l'affichage de pages d'aide et le chargement des variables du joueur. |
‣ event ( ‣ world ( ‣ x ( ‣ y ( ‣ z ( ‣ entity ( |
Exemple d'Utilisation
// Exemple d'utilisation pour Load :
Load.onPlayerLoggedIn(event);
This class is responsible for managing the event when a player logs into the server. Upon login, it performs various initializations and sends specific information to the player regarding the mod's features.
Available Methods
Method | Description | Parameter | Return | Annotations |
---|---|---|---|---|
onPlayerLoggedIn | Event triggered when a player logs in. During login, various initializations and specific configurations are executed. |
‣ event ( |
||
execute | Overloaded method that executes actions when a player logs in, but without directly using the event. It allows specifying coordinates and the entity in different contexts. |
‣ world ( ‣ x ( ‣ y ( ‣ z ( ‣ entity ( |
||
execute (with Event) | Executes all necessary actions at the moment of player login, such as displaying help pages and loading player variables. |
‣ event ( ‣ world ( ‣ x ( ‣ y ( ‣ z ( ‣ entity ( |
Example of Use
// Example usage for Load:
Load.onPlayerLoggedIn(event);
LogLevel
Cette classe gère le niveau de journalisation (log level) pour les joueurs d'un serveur Minecraft. Elle permet d'afficher des messages dans le chat des joueurs en fonction de leur niveau de log, ainsi que de configurer les niveaux de log des joueurs.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
tetraLog |
Envoie un message de log à tous les joueurs connectés, en fonction de leur niveau de log. Le message peut être envoyé uniquement à certains niveaux spécifiques, ou à tous les joueurs. |
‣ title ( ‣ text ( ‣ level ( ‣ only ( |
|
1. Variante sans argument only. Paramètres : ‣ title ( ‣ text ( ‣ level ( Retourne 2. Variante sans argument titre. Paramètres : ‣ text ( ‣ level ( ‣ only ( Retourne 3. Variante sans argument titre et only. Paramètres : ‣ text ( ‣ level ( Retourne |
|||
get | Récupère le niveau de log d'un joueur. |
‣ entity ( |
|
set |
Définit le niveau de log d'un joueur. |
‣ entity ( ‣ num ( ‣ callback ( |
|
Variante sans argument callback. Paramètres : ‣ entity ( ‣ num ( ‣ callback ( |
Exemple d'Utilisation
// Exemple d'utilisation pour LogLevel :
// Exemple avec un titre
LogLevel.tetraLog("MyMod", "Ceci est un texte", 4);
// Exemple avec un titre & avec only
LogLevel.tetraLog("MyMod", "Ceci est un texte", 2, true);
This class manages the log level for players on a Minecraft server. It allows you to display messages in player chat based on their log level, as well as configure player log levels.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
tetraLog |
Sends a log message to all connected players, based on their log level. The message can be sent only to specific levels, or to all players. |
‣ title ( ‣ text ( ‣ level ( ‣ only ( |
|
1. Variant without argument only. Parameters : ‣ title ( ‣ text ( ‣ level ( Return 2. Variant without argument title. Parameters : ‣ text ( ‣ level ( ‣ only ( Return 3. Variant without argument title and only. Parameters : ‣ text ( ‣ level ( Return |
|||
get | Retrieves a player's log level. |
‣ entity ( |
|
set |
Defines a player's log level. |
‣ entity ( ‣ num ( ‣ callback ( |
|
Variant without callback argument. Parameters : ‣ entity ( ‣ num ( ‣ callback ( |
Example of Use
// Example of use for LogLevel :
// Example with a title
LogLevel.tetraLog("MyMod", "This is a text", 4);
// Example with a title & with only
LogLevel.tetraLog("MyMod", "This is a text", 2, true);
Cette classe gère le niveau de journalisation (log level) pour les joueurs d'un serveur Minecraft. Elle permet d'afficher des messages dans le chat des joueurs en fonction de leur niveau de log, ainsi que de configurer les niveaux de log des joueurs.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
tetraLog |
Envoie un message de log à tous les joueurs connectés, en fonction de leur niveau de log. Le message peut être envoyé uniquement à certains niveaux spécifiques, ou à tous les joueurs. |
‣ title ( ‣ text ( ‣ level ( ‣ only ( |
|
1. Variante sans argument only. Paramètres : ‣ title ( ‣ text ( ‣ level ( Retourne 2. Variante sans argument titre. Paramètres : ‣ text ( ‣ level ( ‣ only ( Retourne 3. Variante sans argument titre et only. Paramètres : ‣ text ( ‣ level ( Retourne |
|||
get | Récupère le niveau de log d'un joueur. |
‣ entity ( |
|
set |
Définit le niveau de log d'un joueur. |
‣ entity ( ‣ num ( ‣ callback ( |
|
Variante sans argument callback. Paramètres : ‣ entity ( ‣ num ( ‣ callback ( |
Exemple d'Utilisation
// Exemple d'utilisation pour LogLevel :
// Exemple avec un titre
LogLevel.tetraLog("MyMod", "Ceci est un texte", 4);
// Exemple avec un titre & avec only
LogLevel.tetraLog("MyMod", "Ceci est un texte", 2, true);
This class manages the log level for players on a Minecraft server. It allows you to display messages in player chat based on their log level, as well as configure player log levels.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
tetraLog |
Sends a log message to all connected players, based on their log level. The message can be sent only to specific levels, or to all players. |
‣ title ( ‣ text ( ‣ level ( ‣ only ( |
|
1. Variant without argument only. Parameters : ‣ title ( ‣ text ( ‣ level ( Return 2. Variant without argument title. Parameters : ‣ text ( ‣ level ( ‣ only ( Return 3. Variant without argument title and only. Parameters : ‣ text ( ‣ level ( Return |
|||
get | Retrieves a player's log level. |
‣ entity ( |
|
set |
Defines a player's log level. |
‣ entity ( ‣ num ( ‣ callback ( |
|
Variant without callback argument. Parameters : ‣ entity ( ‣ num ( ‣ callback ( |
Example of Use
// Example of use for LogLevel :
// Example with a title
LogLevel.tetraLog("MyMod", "This is a text", 4);
// Example with a title & with only
LogLevel.tetraLog("MyMod", "This is a text", 2, true);
MobUtil
Cette classe utilitaire permet de manipuler les attributs des entités vivantes dans Minecraft. Elle permet de définir et de récupérer des valeurs de base pour divers attributs comme les dégâts, la vitesse, la santé, etc.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
setBaseDamage | Définit les dégâts de base d'une entité vivante. |
‣ entity ( ‣ newDamage ( |
|
setBaseAttackSpeed | Définit la vitesse d'attaque de base d'une entité vivante. |
‣ entity ( ‣ newSpeed ( |
|
setBaseSpeed | Définit la vitesse de déplacement de base d'une entité vivante. |
‣ entity ( ‣ newSpeed ( |
|
setBaseMaxHealth | Définit la santé maximale de base d'une entité vivante. |
‣ entity ( ‣ newHealth ( |
|
setBaseJumpStrength | Définit la force de saut de base d'une entité vivante. |
‣ entity ( ‣ newJumpStrength ( |
|
setBaseArmor | Définit l'armure de base d'une entité vivante. |
‣ entity ( ‣ newArmor ( |
|
setBaseArmorToughness | Définit la robustesse de l'armure de base d'une entité vivante. |
‣ entity ( ‣ newArmorToughness ( |
|
setBaseAttackKnockback | Définit le recul d'attaque de base d'une entité vivante. |
‣ entity ( ‣ newAttackKnockback ( |
|
setBaseKnockbackResistance | Définit la résistance au recul de base d'une entité vivante. |
‣ entity ( ‣ newKnockbackResistance ( |
|
setBaseLuck | Définit la chance de base d'une entité vivante. |
‣ entity ( ‣ newLuck ( |
|
getBaseDamage | Récupère la valeur des dégâts de base d'une entité vivante. |
‣ entity ( |
|
getDamage | Récupère la valeur des dégâts actuels d'une entité vivante. |
‣ entity ( |
|
getBaseArmorToughness | Récupère la valeur de la robustesse de l'armure de base d'une entité vivante. |
‣ entity ( |
|
getBaseJumpStrength | Récupère la valeur de la force de saut de base d'une entité vivante. |
‣ entity ( |
|
getBaseArmorKnockback | Récupère la valeur du recul d'attaque de base d'une entité vivante. |
‣ entity ( |
|
getBaseKnockbackResistance | Récupère la valeur de la résistance au recul de base d'une entité vivante. |
‣ entity ( |
|
getBaseLuck | Récupère la valeur de la chance de base d'une entité vivante. |
‣ entity ( |
Exemple d'Utilisation
// Exemple d'utilisation pour MobUtil :
// Définir les dégâts de base d'une entité
MobUtil.setBaseDamage(entity, 10.0);
// Définir la vitesse d'attaque
MobUtil.setBaseAttackSpeed(entity, 1.5);
// Récupérer les dégâts actuels
double damage = MobUtil.getDamage(entity);
This utility class manages the attributes of living entities in Minecraft. It allows you to define and retrieve base values for various attributes such as damage, speed, health, etc.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
setBaseDamage | Sets the base damage of a living entity. |
‣ entity ( ‣ newDamage ( |
|
setBaseAttackSpeed | Sets the base attack speed of a living entity. |
‣ entity ( ‣ newSpeed ( |
|
setBaseSpeed | Sets the base movement speed of a living entity. |
‣ entity ( ‣ newSpeed ( |
|
setBaseMaxHealth | Sets the base max health of a living entity. |
‣ entity ( ‣ newHealth ( |
|
setBaseJumpStrength | Sets the base jump strength of a living entity. |
‣ entity ( ‣ newJumpStrength ( |
|
setBaseArmor | Sets the base armor value of a living entity. |
‣ entity ( ‣ newArmor ( |
|
setBaseArmorToughness | Sets the base armor toughness of a living entity. |
‣ entity ( ‣ newArmorToughness ( |
|
setBaseAttackKnockback | Sets the base attack knockback value of a living entity. |
‣ entity ( ‣ newAttackKnockback ( |
|
setBaseKnockbackResistance | Sets the base knockback resistance of a living entity. |
‣ entity ( ‣ newKnockbackResistance ( |
|
setBaseLuck | Sets the base luck value of a living entity. |
‣ entity ( ‣ newLuck ( |
|
getBaseDamage | Retrieves the base damage value of a living entity. |
‣ entity ( |
|
getDamage | Retrieves the current damage value of a living entity. |
‣ entity ( |
|
getBaseArmorToughness | Retrieves the base armor toughness value of a living entity. |
‣ entity ( |
|
getBaseJumpStrength | Retrieves the base jump strength value of a living entity. |
‣ entity ( |
|
getBaseArmorKnockback | Retrieves the base attack knockback value of a living entity. |
‣ entity ( |
|
getBaseKnockbackResistance | Retrieves the base knockback resistance value of a living entity. |
‣ entity ( |
|
getBaseLuck | Retrieves the base luck value of a living entity. |
‣ entity ( |
Example of Use
// Example of use for MobUtil :
// Set base damage for an entity
MobUtil.setBaseDamage(entity, 10.0);
// Set attack speed
MobUtil.setBaseAttackSpeed(entity, 1.5);
// Retrieve the current damage
double damage = MobUtil.getDamage(entity);
Cette classe utilitaire permet de manipuler les attributs des entités vivantes dans Minecraft. Elle permet de définir et de récupérer des valeurs de base pour divers attributs comme les dégâts, la vitesse, la santé, etc.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
setBaseDamage | Définit les dégâts de base d'une entité vivante. |
‣ entity ( ‣ newDamage ( |
|
setBaseAttackSpeed | Définit la vitesse d'attaque de base d'une entité vivante. |
‣ entity ( ‣ newSpeed ( |
|
setBaseSpeed | Définit la vitesse de déplacement de base d'une entité vivante. |
‣ entity ( ‣ newSpeed ( |
|
setBaseMaxHealth | Définit la santé maximale de base d'une entité vivante. |
‣ entity ( ‣ newHealth ( |
|
setBaseJumpStrength | Définit la force de saut de base d'une entité vivante. |
‣ entity ( ‣ newJumpStrength ( |
|
setBaseArmor | Définit l'armure de base d'une entité vivante. |
‣ entity ( ‣ newArmor ( |
|
setBaseArmorToughness | Définit la robustesse de l'armure de base d'une entité vivante. |
‣ entity ( ‣ newArmorToughness ( |
|
setBaseAttackKnockback | Définit le recul d'attaque de base d'une entité vivante. |
‣ entity ( ‣ newAttackKnockback ( |
|
setBaseKnockbackResistance | Définit la résistance au recul de base d'une entité vivante. |
‣ entity ( ‣ newKnockbackResistance ( |
|
setBaseLuck | Définit la chance de base d'une entité vivante. |
‣ entity ( ‣ newLuck ( |
|
getBaseDamage | Récupère la valeur des dégâts de base d'une entité vivante. |
‣ entity ( |
|
getDamage | Récupère la valeur des dégâts actuels d'une entité vivante. |
‣ entity ( |
|
getBaseArmorToughness | Récupère la valeur de la robustesse de l'armure de base d'une entité vivante. |
‣ entity ( |
|
getBaseJumpStrength | Récupère la valeur de la force de saut de base d'une entité vivante. |
‣ entity ( |
|
getBaseArmorKnockback | Récupère la valeur du recul d'attaque de base d'une entité vivante. |
‣ entity ( |
|
getBaseKnockbackResistance | Récupère la valeur de la résistance au recul de base d'une entité vivante. |
‣ entity ( |
|
getBaseLuck | Récupère la valeur de la chance de base d'une entité vivante. |
‣ entity ( |
Exemple d'Utilisation
// Exemple d'utilisation pour MobUtil :
// Définir les dégâts de base d'une entité
MobUtil.setBaseDamage(entity, 10.0);
// Définir la vitesse d'attaque
MobUtil.setBaseAttackSpeed(entity, 1.5);
// Récupérer les dégâts actuels
double damage = MobUtil.getDamage(entity);
This utility class manages the attributes of living entities in Minecraft. It allows you to define and retrieve base values for various attributes such as damage, speed, health, etc.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
setBaseDamage | Sets the base damage of a living entity. |
‣ entity ( ‣ newDamage ( |
|
setBaseAttackSpeed | Sets the base attack speed of a living entity. |
‣ entity ( ‣ newSpeed ( |
|
setBaseSpeed | Sets the base movement speed of a living entity. |
‣ entity ( ‣ newSpeed ( |
|
setBaseMaxHealth | Sets the base max health of a living entity. |
‣ entity ( ‣ newHealth ( |
|
setBaseJumpStrength | Sets the base jump strength of a living entity. |
‣ entity ( ‣ newJumpStrength ( |
|
setBaseArmor | Sets the base armor value of a living entity. |
‣ entity ( ‣ newArmor ( |
|
setBaseArmorToughness | Sets the base armor toughness of a living entity. |
‣ entity ( ‣ newArmorToughness ( |
|
setBaseAttackKnockback | Sets the base attack knockback value of a living entity. |
‣ entity ( ‣ newAttackKnockback ( |
|
setBaseKnockbackResistance | Sets the base knockback resistance of a living entity. |
‣ entity ( ‣ newKnockbackResistance ( |
|
setBaseLuck | Sets the base luck value of a living entity. |
‣ entity ( ‣ newLuck ( |
|
getBaseDamage | Retrieves the base damage value of a living entity. |
‣ entity ( |
|
getDamage | Retrieves the current damage value of a living entity. |
‣ entity ( |
|
getBaseArmorToughness | Retrieves the base armor toughness value of a living entity. |
‣ entity ( |
|
getBaseJumpStrength | Retrieves the base jump strength value of a living entity. |
‣ entity ( |
|
getBaseArmorKnockback | Retrieves the base attack knockback value of a living entity. |
‣ entity ( |
|
getBaseKnockbackResistance | Retrieves the base knockback resistance value of a living entity. |
‣ entity ( |
|
getBaseLuck | Retrieves the base luck value of a living entity. |
‣ entity ( |
Example of Use
// Example of use for MobUtil :
// Set base damage for an entity
MobUtil.setBaseDamage(entity, 10.0);
// Set attack speed
MobUtil.setBaseAttackSpeed(entity, 1.5);
// Retrieve the current damage
double damage = MobUtil.getDamage(entity);
ModsUsingAPI
Cette classe gère les événements liés à l'utilisation de l'API TetraLibs par d'autres mods. Elle permet d'afficher la liste des mods qui utilisent l'API de TetraLibs lors de l'initialisation du mod.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotations |
---|---|---|---|---|
init |
Méthode d'initialisation appelée lors de l'événement |
‣ event ( |
Exemple d'Utilisation
// Exemple d'utilisation pour ModsUsingAPI :
// Lors de l'initialisation, cette méthode vérifiera quels mods utilisent l'API TetraLibs
ModsUsingAPI.init(event);
This class handles events related to the use of the TetraLibs API by other mods. It allows displaying a list of mods that use the TetraLibs API during the mod's initialization.
Available Methods
Method | Description | Parameter | Return | Annotations |
---|---|---|---|---|
init |
Initialization method called during the |
‣ event ( |
Example of Use
// Example of use for ModsUsingAPI :
// During initialization, this method will check which mods are using the TetraLibs API
ModsUsingAPI.init(event);
Cette classe gère les événements liés à l'utilisation de l'API TetraLibs par d'autres mods. Elle permet d'afficher la liste des mods qui utilisent l'API de TetraLibs lors de l'initialisation du mod.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotations |
---|---|---|---|---|
init |
Méthode d'initialisation appelée lors de l'événement |
‣ event ( |
Exemple d'Utilisation
// Exemple d'utilisation pour ModsUsingAPI :
// Lors de l'initialisation, cette méthode vérifiera quels mods utilisent l'API TetraLibs
ModsUsingAPI.init(event);
This class handles events related to the use of the TetraLibs API by other mods. It allows displaying a list of mods that use the TetraLibs API during the mod's initialization.
Available Methods
Method | Description | Parameter | Return | Annotations |
---|---|---|---|---|
init |
Initialization method called during the |
‣ event ( |
Example of Use
// Example of use for ModsUsingAPI :
// During initialization, this method will check which mods are using the TetraLibs API
ModsUsingAPI.init(event);
NumberConverter
Cette classe contient des méthodes pour convertir un nombre en une chaîne de caractères, avec un format approprié en fonction de la taille du nombre (ex. : milliers, millions, milliards, trillions).
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
convertNumberToString |
Convertit un nombre en une chaîne de caractères avec un format adapté à la taille du nombre,
en arrondissant à un certain nombre de décimales. |
‣ number ( ‣ decimalDigits ( |
|
Variante sans argument `decimalDigits`. Paramètres : ‣ number ( Retourne |
|||
convertNumberToString |
Convertit un nombre en une chaîne de caractères avec un format adapté,
en arrondissant à 1 chiffre après la virgule. |
‣ number ( |
Exemple d'Utilisation
// Exemple d'utilisation pour NumberConverter :
// Exemple avec un nombre et des décimales
String formattedNumber = NumberConverter.convertNumberToString(1234567.89, 2);
// Exemple avec un nombre sans spécifier de décimales
String formattedNumberDefault = NumberConverter.convertNumberToString(1234567.89);
This class contains methods for converting a number into a string, with a format appropriate to the size of the number (e.g., thousands, millions, billions, trillions).
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
convertNumberToString |
Converts a number into a string with an appropriate format depending on the size of the number,
rounding to a specific number of decimal places. |
‣ number ( ‣ decimalDigits ( |
|
Variant without `decimalDigits` argument. Parameters : ‣ number ( Returns |
|||
convertNumberToString |
Converts a number into a string with an appropriate format,
rounding to 1 decimal place. |
‣ number ( |
Example of Use
// Example of use for NumberConverter :
// Example with a number and decimals
String formattedNumber = NumberConverter.convertNumberToString(1234567.89, 2);
// Example with a number without specifying decimals
String formattedNumberDefault = NumberConverter.convertNumberToString(1234567.89);
Cette classe contient des méthodes pour convertir un nombre en une chaîne de caractères, avec un format approprié en fonction de la taille du nombre (ex. : milliers, millions, milliards, trillions).
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
convertNumberToString |
Convertit un nombre en une chaîne de caractères avec un format adapté à la taille du nombre,
en arrondissant à un certain nombre de décimales. |
‣ number ( ‣ decimalDigits ( |
|
Variante sans argument `decimalDigits`. Paramètres : ‣ number ( Retourne |
|||
convertNumberToString |
Convertit un nombre en une chaîne de caractères avec un format adapté,
en arrondissant à 1 chiffre après la virgule. |
‣ number ( |
Exemple d'Utilisation
// Exemple d'utilisation pour NumberConverter :
// Exemple avec un nombre et des décimales
String formattedNumber = NumberConverter.convertNumberToString(1234567.89, 2);
// Exemple avec un nombre sans spécifier de décimales
String formattedNumberDefault = NumberConverter.convertNumberToString(1234567.89);
This class contains methods for converting a number into a string, with a format appropriate to the size of the number (e.g., thousands, millions, billions, trillions).
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
convertNumberToString |
Converts a number into a string with an appropriate format depending on the size of the number,
rounding to a specific number of decimal places. |
‣ number ( ‣ decimalDigits ( |
|
Variant without `decimalDigits` argument. Parameters : ‣ number ( Returns |
|||
convertNumberToString |
Converts a number into a string with an appropriate format,
rounding to 1 decimal place. |
‣ number ( |
Example of Use
// Example of use for NumberConverter :
// Example with a number and decimals
String formattedNumber = NumberConverter.convertNumberToString(1234567.89, 2);
// Example with a number without specifying decimals
String formattedNumberDefault = NumberConverter.convertNumberToString(1234567.89);
RandomBlock
Cette classe contient des méthodes pour obtenir un bloc aléatoire de Minecraft, soit sous forme de `BlockState` (l'état du bloc) soit sous forme d'un objet `Block`.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
blockstate |
Retourne un |
||
block |
Retourne un bloc aléatoire sous forme d'objet |
Exemple d'Utilisation
// Exemple d'utilisation pour RandomBlock :
// Exemple pour obtenir un BlockState aléatoire
BlockState randomBlockState = RandomBlock.blockstate();
// Exemple pour obtenir un Block aléatoire
Block randomBlock = RandomBlock.block();
This class contains methods to obtain a random block in Minecraft, either as a `BlockState` (the block state) or as a `Block` object.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
blockstate |
Returns a random |
||
block |
Returns a random |
Example of Use
// Example of use for RandomBlock :
// Example to get a random BlockState
BlockState randomBlockState = RandomBlock.blockstate();
// Example to get a random Block
Block randomBlock = RandomBlock.block();
Cette classe contient des méthodes pour obtenir un bloc aléatoire de Minecraft, soit sous forme de `BlockState` (l'état du bloc) soit sous forme d'un objet `Block`.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
blockstate |
Retourne un |
||
block |
Retourne un bloc aléatoire sous forme d'objet |
Exemple d'Utilisation
// Exemple d'utilisation pour RandomBlock :
// Exemple pour obtenir un BlockState aléatoire
BlockState randomBlockState = RandomBlock.blockstate();
// Exemple pour obtenir un Block aléatoire
Block randomBlock = RandomBlock.block();
This class contains methods to obtain a random block in Minecraft, either as a `BlockState` (the block state) or as a `Block` object.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
blockstate |
Returns a random |
||
block |
Returns a random |
Example of Use
// Example of use for RandomBlock :
// Example to get a random BlockState
BlockState randomBlockState = RandomBlock.blockstate();
// Example to get a random Block
Block randomBlock = RandomBlock.block();
RandomEffect
Cette classe fournit une méthode permettant d'appliquer un effet aléatoire à une entité vivante dans le jeu.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
apply | Applique un effet aléatoire à une entité vivante. Cette méthode choisit aléatoirement un effet parmi ceux enregistrés dans le jeu. Si le paramètre `blacklist` est activé, certains effets spécifiques (comme la guérison ou le malus) seront exclus du tirage. |
‣ victim ( ‣ duration ( ‣ blacklist ( |
Exemple d'Utilisation
// Exemple d'utilisation pour RandomEffect :
// Applique un effet aléatoire à un joueur avec une durée de 100 ticks (5 secondes),
// sans exclure les effets de guérison ou de malus.
RandomEffect.apply(player, 100, false);
// Applique un effet aléatoire à un joueur avec une durée de 100 ticks (5 secondes),
// en excluant les effets de guérison et de malus.
RandomEffect.apply(player, 100, true);
This class provides a method to apply a random effect to a living entity in the game.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
apply | Applies a random effect to a living entity. This method randomly selects an effect from the registered effects in the game. If the `blacklist` parameter is set to true, certain effects (such as healing or harm) will be excluded from the selection. |
‣ victim ( ‣ duration ( ‣ blacklist ( |
Example of Use
// Example of use for RandomEffect :
// Apply a random effect to a player with a duration of 100 ticks (5 seconds),
// without excluding healing or harm effects.
RandomEffect.apply(player, 100, false);
// Apply a random effect to a player with a duration of 100 ticks (5 seconds),
// excluding healing and harm effects.
RandomEffect.apply(player, 100, true);
Cette classe fournit une méthode permettant d'appliquer un effet aléatoire à une entité vivante dans le jeu.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
apply | Applique un effet aléatoire à une entité vivante. Cette méthode choisit aléatoirement un effet parmi ceux enregistrés dans le jeu. Si le paramètre `blacklist` est activé, certains effets spécifiques (comme la guérison ou le malus) seront exclus du tirage. |
‣ victim ( ‣ duration ( ‣ blacklist ( |
Exemple d'Utilisation
// Exemple d'utilisation pour RandomEffect :
// Applique un effet aléatoire à un joueur avec une durée de 100 ticks (5 secondes),
// sans exclure les effets de guérison ou de malus.
RandomEffect.apply(player, 100, false);
// Applique un effet aléatoire à un joueur avec une durée de 100 ticks (5 secondes),
// en excluant les effets de guérison et de malus.
RandomEffect.apply(player, 100, true);
This class provides a method to apply a random effect to a living entity in the game.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
apply | Applies a random effect to a living entity. This method randomly selects an effect from the registered effects in the game. If the `blacklist` parameter is set to true, certain effects (such as healing or harm) will be excluded from the selection. |
‣ victim ( ‣ duration ( ‣ blacklist ( |
Example of Use
// Example of use for RandomEffect :
// Apply a random effect to a player with a duration of 100 ticks (5 seconds),
// without excluding healing or harm effects.
RandomEffect.apply(player, 100, false);
// Apply a random effect to a player with a duration of 100 ticks (5 seconds),
// excluding healing and harm effects.
RandomEffect.apply(player, 100, true);
RandomEnchantment
Cette classe permet d'appliquer un enchantement aléatoire sur un objet (
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
apply |
Applique un enchantement aléatoire à un objet ( |
‣ item ( ‣ verif ( |
Exemple d'Utilisation
// Exemple d'utilisation pour RandomEnchantment :
// Exemple avec vérification avant d'appliquer l'enchantement
RandomEnchantment.apply(itemStack, true);
// Exemple sans vérification
RandomEnchantment.apply(itemStack, false);
This class applies a random enchantment to an item (
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
apply |
Applies a random enchantment to an item ( |
‣ item ( ‣ verif ( |
Example of Use
// Example of use for RandomEnchantment :
// Example with verification before applying enchantment
RandomEnchantment.apply(itemStack, true);
// Example without verification
RandomEnchantment.apply(itemStack, false);
Cette classe permet d'appliquer un enchantement aléatoire sur un objet (
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
apply |
Applique un enchantement aléatoire à un objet ( |
‣ item ( ‣ verif ( |
Exemple d'Utilisation
// Exemple d'utilisation pour RandomEnchantment :
// Exemple avec vérification avant d'appliquer l'enchantement
RandomEnchantment.apply(itemStack, true);
// Exemple sans vérification
RandomEnchantment.apply(itemStack, false);
This class applies a random enchantment to an item (
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
apply |
Applies a random enchantment to an item ( |
‣ item ( ‣ verif ( |
Example of Use
// Example of use for RandomEnchantment :
// Example with verification before applying enchantment
RandomEnchantment.apply(itemStack, true);
// Example without verification
RandomEnchantment.apply(itemStack, false);
RandomItem
Cette classe permet de sélectionner un objet aléatoire parmi tous les objets disponibles dans le registre Forge.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
execute |
Crée et retourne un |
||
getItem |
Retourne un objet aléatoire sous forme d'instance de |
||
getRandomItem | Sélectionne un objet aléatoire parmi tous les objets du jeu. |
Exemple d'Utilisation
// Exemple d'utilisation pour RandomItem
ItemStack randomStack = RandomItem.execute();
Item randomItem = RandomItem.getItem();
This class allows selecting a random item from all items available in the Forge registry.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
execute |
Creates and returns an |
||
getItem |
Returns a random item as an |
||
getRandomItem | Selects a random item from all items in the game. |
Example of Use
// Example of use for RandomItem
ItemStack randomStack = RandomItem.execute();
Item randomItem = RandomItem.getItem();
Cette classe permet de sélectionner un objet aléatoire parmi tous les objets disponibles dans le registre Forge.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
execute |
Crée et retourne un |
||
getItem |
Retourne un objet aléatoire sous forme d'instance de |
||
getRandomItem | Sélectionne un objet aléatoire parmi tous les objets du jeu. |
Exemple d'Utilisation
// Exemple d'utilisation pour RandomItem
ItemStack randomStack = RandomItem.execute();
Item randomItem = RandomItem.getItem();
This class allows selecting a random item from all items available in the Forge registry.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
execute |
Creates and returns an |
||
getItem |
Returns a random item as an |
||
getRandomItem | Selects a random item from all items in the game. |
Example of Use
// Example of use for RandomItem
ItemStack randomStack = RandomItem.execute();
Item randomItem = RandomItem.getItem();
Save
Cette classe est responsable de la gestion de la sauvegarde des données liées à un joueur, telles que les données utilisateur et les balances économiques, lors de la déconnexion du joueur.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotation |
---|---|---|---|---|
onPlayerLoggedOut | Méthode appelée lorsqu'un joueur se déconnecte. Elle sauvegarde les données du joueur et de l'économie en fonction de la configuration du mod. |
‣ event ( |
||
execute | Méthode qui permet de sauvegarder les données d'un joueur dans le monde donné à des coordonnées spécifiques. Cette méthode est une version simplifiée sans événement. |
‣ world ( ‣ x ( ‣ y ( ‣ z ( ‣ entity ( |
This class is responsible for managing the saving of data related to a player, such as user data and economic balances, when the player disconnects.
Available Methods
Method | Description | Parameter | Return | Annotation |
---|---|---|---|---|
onPlayerLoggedOut | Method called when a player disconnects. It saves the player's data and economy based on the mod's configuration. |
‣ event ( |
||
execute | Method that saves the player's data in the given world at specific coordinates. This is a simplified version without an event. |
‣ world ( ‣ x ( ‣ y ( ‣ z ( ‣ entity ( |
Cette classe est responsable de la gestion de la sauvegarde des données liées à un joueur, telles que les données utilisateur et les balances économiques, lors de la déconnexion du joueur.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotation |
---|---|---|---|---|
onPlayerLoggedOut | Méthode appelée lorsqu'un joueur se déconnecte. Elle sauvegarde les données du joueur et de l'économie en fonction de la configuration du mod. |
‣ event ( |
||
execute | Méthode qui permet de sauvegarder les données d'un joueur dans le monde donné à des coordonnées spécifiques. Cette méthode est une version simplifiée sans événement. |
‣ world ( ‣ x ( ‣ y ( ‣ z ( ‣ entity ( |
This class is responsible for managing the saving of data related to a player, such as user data and economic balances, when the player disconnects.
Available Methods
Method | Description | Parameter | Return | Annotation |
---|---|---|---|---|
onPlayerLoggedOut | Method called when a player disconnects. It saves the player's data and economy based on the mod's configuration. |
‣ event ( |
||
execute | Method that saves the player's data in the given world at specific coordinates. This is a simplified version without an event. |
‣ world ( ‣ x ( ‣ y ( ‣ z ( ‣ entity ( |
ServerPermissionsInit
Cette classe gère l'initialisation des permissions des serveurs lors du démarrage. Elle permet d'ajouter des permissions par défaut pour divers aspects du serveur ainsi que pour toutes les commandes disponibles.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotation |
---|---|---|---|---|
onServerStarting | Méthode appelée lors du démarrage du serveur. Elle initialise les permissions par défaut pour différentes actions sur le serveur et attribue des permissions pour chaque commande disponible. |
‣ event ( |
This class manages the initialization of server permissions during startup. It allows adding default permissions for various server aspects and assigning permissions for all available commands.
Available Methods
Method | Description | Parameter | Return | Annotation |
---|---|---|---|---|
onServerStarting | Method called during server startup. It initializes default permissions for various server actions and assigns permissions for each available command. |
‣ event ( |
Cette classe gère l'initialisation des permissions des serveurs lors du démarrage. Elle permet d'ajouter des permissions par défaut pour divers aspects du serveur ainsi que pour toutes les commandes disponibles.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotation |
---|---|---|---|---|
onServerStarting | Méthode appelée lors du démarrage du serveur. Elle initialise les permissions par défaut pour différentes actions sur le serveur et attribue des permissions pour chaque commande disponible. |
‣ event ( |
This class manages the initialization of server permissions during startup. It allows adding default permissions for various server aspects and assigning permissions for all available commands.
Available Methods
Method | Description | Parameter | Return | Annotation |
---|---|---|---|---|
onServerStarting | Method called during server startup. It initializes default permissions for various server actions and assigns permissions for each available command. |
‣ event ( |
Serverdata
Classe responsable de la gestion des données du serveur dans un fichier JSON unique. Permet de charger, sauvegarder, initialiser et manipuler les données globales du serveur.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
load | Charge les données du serveur à partir du fichier JSON. Si le fichier n'existe pas, il est créé avec des valeurs par défaut. |
|
|
save | Sauvegarde les données du serveur dans le fichier JSON. |
|
|
init | Initialise les données d'un joueur dans un fichier JSON si ce dernier n'existe pas. |
|
|
data |
Gère l'extraction ou la mise à jour des données dans un système de stockage global. Cette méthode permet d'extraire des données ou de mettre à jour les données dans le fichier JSON du serveur. |
‣ key ( ‣ mode ( ‣ value ( |
|
Variante sans l'argument mode et value. Mode de base l'extraction. Paramètres : ‣ key ( Retourne |
|||
get | Récupère une valeur imbriquée à partir d'un fichier JSON. |
‣ key ( |
|
set | Définit une valeur dans un fichier JSON en suivant un chemin imbriqué. Si un niveau intermédiaire est manquant, il est créé automatiquement. Les modifications sont persistées dans le fichier JSON. |
‣ filePath ( ‣ keyPath ( ‣ value ( |
|
has | Vérifie si une clé existe dans les données du serveur. |
‣ key ( |
Exemple d'Utilisation
// Exemple d'utilisation pour Serverdata :
// Obtenir une valeur
Serverdata.data("test.data");
// Définir une valeur
Serverdata.data("test.data", "set", 0);
Class responsible for managing server data into a single JSON file. Allows you to load, save, initialize and manipulate global server data.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
load | Loads server data from JSON file. If the file does not exist, it is created with default values. |
|
|
save | Saves server data to JSON file. |
|
|
init | Initializes a player's data in a JSON file if it does not exist. |
|
|
data |
Manages the retrieval or updating of data in a global storage system. This method extracts data or updates data in the server's JSON file. |
‣ key ( ‣ mode ( ‣ value ( |
|
Variant without the mode and value arguments. Basic extraction mode. Paramètres : ‣ key ( Return |
|||
get | Retrieves a nested value from a JSON file. |
‣ key ( |
|
set | Sets a value in a JSON file following a nested path. If a middle level is missing, it is created automatically. Changes are persisted to the JSON file. |
‣ filePath ( ‣ keyPath ( ‣ value ( |
|
has | Checks if a key exists in the server data. |
‣ key ( |
Example of Use
// Example of use for Serverdata :
// Get a value
Serverdata.data("test.data");
// Set a value
Serverdata.data("test.data", "set", 0);
Classe responsable de la gestion des données du serveur dans un fichier JSON unique. Permet de charger, sauvegarder, initialiser et manipuler les données globales du serveur.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
load | Charge les données du serveur à partir du fichier JSON. Si le fichier n'existe pas, il est créé avec des valeurs par défaut. |
|
|
save | Sauvegarde les données du serveur dans le fichier JSON. |
|
|
init | Initialise les données d'un joueur dans un fichier JSON si ce dernier n'existe pas. |
|
|
data |
Gère l'extraction ou la mise à jour des données dans un système de stockage global. Cette méthode permet d'extraire des données ou de mettre à jour les données dans le fichier JSON du serveur. |
‣ key ( ‣ mode ( ‣ value ( |
|
Variante sans l'argument mode et value. Mode de base l'extraction. Paramètres : ‣ key ( Retourne |
|||
get | Récupère une valeur imbriquée à partir d'un fichier JSON. |
‣ key ( |
|
set | Définit une valeur dans un fichier JSON en suivant un chemin imbriqué. Si un niveau intermédiaire est manquant, il est créé automatiquement. Les modifications sont persistées dans le fichier JSON. |
‣ filePath ( ‣ keyPath ( ‣ value ( |
|
has | Vérifie si une clé existe dans les données du serveur. |
‣ key ( |
Exemple d'Utilisation
// Exemple d'utilisation pour Serverdata :
// Obtenir une valeur
Serverdata.data("test.data");
// Définir une valeur
Serverdata.data("test.data", "set", 0);
Class responsible for managing server data into a single JSON file. Allows you to load, save, initialize and manipulate global server data.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
load | Loads server data from JSON file. If the file does not exist, it is created with default values. |
|
|
save | Saves server data to JSON file. |
|
|
init | Initializes a player's data in a JSON file if it does not exist. |
|
|
data |
Manages the retrieval or updating of data in a global storage system. This method extracts data or updates data in the server's JSON file. |
‣ key ( ‣ mode ( ‣ value ( |
|
Variant without the mode and value arguments. Basic extraction mode. Paramètres : ‣ key ( Return |
|||
get | Retrieves a nested value from a JSON file. |
‣ key ( |
|
set | Sets a value in a JSON file following a nested path. If a middle level is missing, it is created automatically. Changes are persisted to the JSON file. |
‣ filePath ( ‣ keyPath ( ‣ value ( |
|
has | Checks if a key exists in the server data. |
‣ key ( |
Example of Use
// Example of use for Serverdata :
// Get a value
Serverdata.data("test.data");
// Set a value
Serverdata.data("test.data", "set", 0);
SuperLog
Cette classe fournit des méthodes utilitaires pour enregistrer des messages dans les logs de l'application. Elle offre plusieurs niveaux de log (info, debug, warn, error, fatal) ainsi qu'une méthode pour écrire dans un fichier de log.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
info | Enregistre un message au niveau INFO dans la console. |
‣ name ( ‣ message ( |
|
debug | Enregistre un message au niveau DEBUG dans la console. |
‣ name ( ‣ message ( |
|
warn | Enregistre un message au niveau WARN dans la console. |
‣ name ( ‣ message ( |
|
error | Enregistre un message au niveau ERROR dans la console. |
‣ name ( ‣ message ( |
|
fatal | Enregistre un message au niveau FATAL dans la console. |
‣ name ( ‣ message ( |
|
throwable | Crée et enregistre une exception avec un message donné dans la console. |
‣ name ( ‣ message ( |
|
write | Enregistre un texte dans un fichier de log à un emplacement spécifié. Le texte peut être ajouté à la fin du fichier ou écrit sur une nouvelle ligne. |
‣ text ( ‣ inline ( ‣ path ( ‣ fileName ( |
Exemple d'Utilisation
// Exemple d'utilisation pour SuperLog :
Superlog.info("MyMod", "Texte d'information");
Superlog.debug("MyMod", "Texte de débug");
Superlog.warn("MyMod", "Texte d'avertissement");
Superlog.error("MyMod", "Texte d'erreur");
Superlog.fatal("MyMod", "Texte fatal");
try {
// Une situation où une exception pourrait se produire
int result = 10 / 0; // Cela va générer une exception ArithmeticException
} catch (Exception e) {
// Enregistrer l'exception avec un message personnalisé dans le journal
Throwable exception = SuperLog.throwable("MyMod", "Une erreur est survenue dans myMethod : " + e.getMessage());
// Vous pouvez également gérer l'exception, la relancer, etc.
// Par exemple, ici on la relance après l'avoir loggée
throw exception;
}
This class provides utility methods for logging messages to application logs. It offers several log levels (info, debug, warn, error, fatal) as well as a method for writing to a log file.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
info | Logs a message at INFO level in the console. |
‣ name ( ‣ message ( |
|
debug | Logs a message at DEBUG level to the console. |
‣ name ( ‣ message ( |
|
warn | Logs a message at the WARN level in the console. |
‣ name ( ‣ message ( |
|
error | Logs a message at ERROR level in the console. |
‣ name ( ‣ message ( |
|
fatal | Logs a message at FATAL level to the console. |
‣ name ( ‣ message ( |
|
throwable | Creates and logs an exception with a given message in the console. |
‣ name ( ‣ message ( |
|
write | Saves text to a log file at a specified location. The text can be appended to the end of the file or written on a new line. |
‣ text ( ‣ inline ( ‣ path ( ‣ fileName ( |
Exemple of Use
// Exemple of use for SuperLog :
Superlog.info("MyMod", "Info text");
Superlog.debug("MyMod", "Debug text");
Superlog.warn("MyMod", "Warn text");
Superlog.error("MyMod", "Error text");
Superlog.fatal("MyMod", "Fatal text");
try {
// A situation where an exception could occur
int result = 10 / 0; // This will throw an ArithmeticException
} catch (Exception e) {
// Log the exception with a custom message in the log
Throwable exception = SuperLog.throwable("MyMod", "An error occurred in myMethod : " + e.getMessage());
// You can also handle the exception, rethrow it, etc.
// For example, here we restart it after having logged it
throw exception;
}
Cette classe fournit des méthodes utilitaires pour enregistrer des messages dans les logs de l'application. Elle offre plusieurs niveaux de log (info, debug, warn, error, fatal) ainsi qu'une méthode pour écrire dans un fichier de log.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
info | Enregistre un message au niveau INFO dans la console. |
‣ name ( ‣ message ( |
|
debug | Enregistre un message au niveau DEBUG dans la console. |
‣ name ( ‣ message ( |
|
warn | Enregistre un message au niveau WARN dans la console. |
‣ name ( ‣ message ( |
|
error | Enregistre un message au niveau ERROR dans la console. |
‣ name ( ‣ message ( |
|
fatal | Enregistre un message au niveau FATAL dans la console. |
‣ name ( ‣ message ( |
|
throwable | Crée et enregistre une exception avec un message donné dans la console. |
‣ name ( ‣ message ( |
|
write | Enregistre un texte dans un fichier de log à un emplacement spécifié. Le texte peut être ajouté à la fin du fichier ou écrit sur une nouvelle ligne. |
‣ text ( ‣ inline ( ‣ path ( ‣ fileName ( |
Exemple d'Utilisation
// Exemple d'utilisation pour SuperLog :
Superlog.info("MyMod", "Texte d'information");
Superlog.debug("MyMod", "Texte de débug");
Superlog.warn("MyMod", "Texte d'avertissement");
Superlog.error("MyMod", "Texte d'erreur");
Superlog.fatal("MyMod", "Texte fatal");
try {
// Une situation où une exception pourrait se produire
int result = 10 / 0; // Cela va générer une exception ArithmeticException
} catch (Exception e) {
// Enregistrer l'exception avec un message personnalisé dans le journal
Throwable exception = SuperLog.throwable("MyMod", "Une erreur est survenue dans myMethod : " + e.getMessage());
// Vous pouvez également gérer l'exception, la relancer, etc.
// Par exemple, ici on la relance après l'avoir loggée
throw exception;
}
This class provides utility methods for logging messages to application logs. It offers several log levels (info, debug, warn, error, fatal) as well as a method for writing to a log file.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
info | Logs a message at INFO level in the console. |
‣ name ( ‣ message ( |
|
debug | Logs a message at DEBUG level to the console. |
‣ name ( ‣ message ( |
|
warn | Logs a message at the WARN level in the console. |
‣ name ( ‣ message ( |
|
error | Logs a message at ERROR level in the console. |
‣ name ( ‣ message ( |
|
fatal | Logs a message at FATAL level to the console. |
‣ name ( ‣ message ( |
|
throwable | Creates and logs an exception with a given message in the console. |
‣ name ( ‣ message ( |
|
write | Saves text to a log file at a specified location. The text can be appended to the end of the file or written on a new line. |
‣ text ( ‣ inline ( ‣ path ( ‣ fileName ( |
Exemple of Use
// Exemple of use for SuperLog :
Superlog.info("MyMod", "Info text");
Superlog.debug("MyMod", "Debug text");
Superlog.warn("MyMod", "Warn text");
Superlog.error("MyMod", "Error text");
Superlog.fatal("MyMod", "Fatal text");
try {
// A situation where an exception could occur
int result = 10 / 0; // This will throw an ArithmeticException
} catch (Exception e) {
// Log the exception with a custom message in the log
Throwable exception = SuperLog.throwable("MyMod", "An error occurred in myMethod : " + e.getMessage());
// You can also handle the exception, rethrow it, etc.
// For example, here we restart it after having logged it
throw exception;
}
TeamUtil
Utilitaire pour la gestion des équipes dans le jeu Minecraft. Contient des méthodes pour récupérer des informations sur les équipes, modifier leurs propriétés, et effectuer diverses opérations liées à l'équipe.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
getTeam | Récupère une équipe par son nom. |
‣ world ( ‣ teamName ( |
|
getPlayersNumber | Récupère le nombre de joueurs dans une équipe. |
‣ world ( ‣ teamName ( |
|
getTeamsNumber | Récupère le nombre total d'équipes. |
‣ world ( |
|
getTeamExists | Vérifie si une équipe existe dans le monde. |
‣ world ( ‣ teamName ( |
|
getTeamName | Récupère le nom de l'équipe d'un joueur. |
‣ world ( ‣ entity ( |
|
setCollisionRules |
Modifie les règles de collision d'une équipe. |
‣ world ( ‣ teamName ( ‣ rule ( ‣ callback ( |
|
Variante sans l'argument callback. Paramètres : ‣ world ( ‣ teamName ( ‣ rule ( |
|||
setColor |
Modifie la couleur d'une équipe. |
‣ world ( ‣ teamName ( ‣ color ( ‣ callback ( |
|
Variante sans l'argument callback. Paramètres : ‣ world ( ‣ teamName ( ‣ color ( |
|||
setDeathMessageVisibility |
Modifie la visibilité du message de décès d'une équipe. |
‣ world ( ‣ teamName ( ‣ visibility ( ‣ callback ( |
|
Variante sans l'argument callback. Paramètres : ‣ world ( ‣ teamName ( ‣ visibility ( |
|||
setDisplayName |
Définit le nom affiché pour une équipe donnée. |
‣ world ( ‣ teamName ( ‣ name ( ‣ callback ( |
|
Variante sans l'argument callback. Paramètres : ‣ world ( ‣ teamName ( ‣ name ( |
|||
setFriendlyFire |
Définit si les membres de l'équipe peuvent se causer des dégâts entre eux (FriendlyFire). |
‣ world ( ‣ teamName ( ‣ fire ( ‣ callback ( |
|
Variante sans l'argument callback. Paramètres : ‣ world ( ‣ teamName ( ‣ fire ( |
|||
setNametagVisibility |
Définit la visibilité des étiquettes de nom pour les membres d'une équipe. |
‣ world ( ‣ teamName ( ‣ visibility ( ‣ callback ( |
|
Variante sans l'argument callback. Paramètres : ‣ world ( ‣ teamName ( ‣ visibility ( |
|||
sePrefix |
Définit le préfixe des joueurs dans une équipe. |
‣ world ( ‣ teamName ( ‣ prefix ( ‣ callback ( |
|
Variante sans l'argument callback. Paramètres : ‣ world ( ‣ teamName ( ‣ prefix ( |
|||
setSeeFriendlyInvisibles |
Définit si les membres de l'équipe peuvent voir les invisibles alliés. |
‣ world ( ‣ teamName ( ‣ see ( ‣ callback ( |
|
Variante sans l'argument callback. Paramètres : ‣ world ( ‣ teamName ( ‣ see ( |
|||
setSuffix |
Définit si les membres de l'équipe peuvent voir les invisibles alliés. |
‣ world ( ‣ teamName ( ‣ suffix ( ‣ callback ( |
|
Variante sans l'argument callback. Paramètres : ‣ world ( ‣ teamName ( ‣ suffix ( |
|||
getRawCollisionRules | Récupère la règle de collision brute pour une équipe donnée. |
‣ world ( ‣ teamName ( |
|
getStringCollisionRules | Récupère la règle de collision sous forme de chaîne pour une équipe donnée. |
‣ world ( ‣ teamName ( |
|
getRawColor | Récupère la couleur brute de l'équipe. |
‣ world ( ‣ teamName ( |
|
getStringColor | Récupère la couleur de l'équipe sous forme de chaîne. |
‣ world ( ‣ teamName ( ‣ lowercase ( |
|
getRawDeathMessageVisibility | Récupère la visibilité des messages de mort pour une équipe. |
‣ world ( ‣ teamName ( |
|
getStringDeathMessageVisibility | Récupère la visibilité des messages de mort sous forme de chaîne. |
‣ world ( ‣ teamName ( ‣ lowercase ( |
|
getDisplayName | Récupère le nom affiché pour une équipe. |
‣ world ( ‣ teamName ( | |
getRawNametagVisibility | Récupère la visibilité des étiquettes de nom pour une équipe. |
‣ world ( ‣ teamName ( |
|
getStringNametagVisibility | Récupère la visibilité des étiquettes de nom sous forme de chaîne. |
‣ world ( ‣ teamName ( ‣ lowercase ( |
|
getPrefix | Récupère le préfixe d'une équipe. |
‣ world ( ‣ teamName ( | |
getSuffix | Récupère le suffixe d'une équipe |
‣ world ( ‣ teamName ( | |
colisionRulesFromString | Convertit une chaîne en une règle de collision pour une équipe. |
‣ str ( | |
colisionRulesFromString | Convertit une règle de collision en une chaîne. |
‣ str ( | |
colorFromString | Convertit une chaîne en une couleur de texte Minecraft. |
‣ str ( | |
teamVisibilityFromString | Convertit une chaîne en une visibilité de l'équipe. |
‣ str ( |
Exemple d'Utilisation
// Exemple d'utilisation pour TeamUtil :
// Exemple pour getTeam
Team team = TeamUtil.getTeam(world, "MyTeam");
// Exemple pour getPlayersNumber
double playersNumber = TeamUtil.getPlayersNumber(world, "MyTeam");
// Exemple pour getTeamsNumber
double teamsNumber = TeamUtil.getTeamsNumber(world);
// Exemple pour getTeamExists
boolean teamExists = TeamUtil.getTeamExists(world, "MyTeam");
// Exemple pour getTeamName
String teamName = TeamUtil.getTeamName(world, entity);
// Exemple pour setCollisionRules
TeamUtil.setCollisionRules(world, "MyTeam", "newRule", true);
// Exemple pour setColor
TeamUtil.setColor(world, "MyTeam", "red", true);
// Exemple pour setDeathMessageVisibility
TeamUtil.setDeathMessageVisibility(world, "MyTeam", "visible", true);
// Exemple pour setDisplayName
TeamUtil.setDisplayName(world, "MyTeam", "AwesomeTeam", true);
// Exemple pour setFriendlyFire
TeamUtil.setFriendlyFire(world, "MyTeam", true, true);
// Exemple pour setNametagVisibility
TeamUtil.setNametagVisibility(world, "MyTeam", "visible", true);
// Exemple pour setPrefix
TeamUtil.setPrefix(world, "MyTeam", "[Team1]", true);
// Exemple pour setSeeFriendlyInvisibles
TeamUtil.setSeeFriendlyInvisibles(world, "MyTeam", true, true);
// Exemple pour setSuffix
TeamUtil.setSuffix(world, "MyTeam", "_VIP", true);
// Exemple pour getRawCollisionRules
Team.CollisionRule collisionRule = TeamUtil.getRawCollisionRules(world, "MyTeam");
// Exemple pour getStringCollisionRules
String collisionRuleStr = TeamUtil.getStringCollisionRules(world, "MyTeam");
// Exemple pour getRawColor
Team.CollisionRule color = TeamUtil.getRawColor(world, "MyTeam");
// Exemple pour getStringColor
String colorStr = TeamUtil.getStringColor(world, "MyTeam", "true");
// Exemple pour getRawDeathMessageVisibility
Team.Visibility deathMessageVisibility = TeamUtil.getRawDeathMessageVisibility(world, "MyTeam");
// Exemple pour getStringDeathMessageVisibility
String deathMessageVisibilityStr = TeamUtil.getStringDeathMessageVisibility(world, "MyTeam", "true");
// Exemple pour getDisplayName
String displayName = TeamUtil.getDisplayName(world, "MyTeam");
// Exemple pour getRawNametagVisibility
Team.Visibility nametagVisibility = TeamUtil.getRawNametagVisibility(world, "MyTeam");
// Exemple pour getStringNametagVisibility
String nametagVisibilityStr = TeamUtil.getStringNametagVisibility(world, "MyTeam", "true");
// Exemple pour getPrefix
String prefix = TeamUtil.getPrefix(world, "MyTeam");
// Exemple pour getSuffix
String suffix = TeamUtil.getSuffix(world, "MyTeam");
// Exemple pour colisionRulesFromString
Team.CollisionRule rule = TeamUtil.colisionRulesFromString("newRule");
// Exemple pour colisionRulesToString
String ruleStr = TeamUtil.colisionRulesToString(Team.CollisionRule.ALWAYS);
// Exemple pour colorFromString
ChatFormatting color = TeamUtil.colorFromString("red");
// Exemple pour teamVisibilityFromString
Team.Visibility visibility = TeamUtil.teamVisibilityFromString("visible");
Utility for managing teams in the Minecraft game. Contains methods for retrieving information about teams, modifying their properties, and performing various team-related operations.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
getTeam | Retrieves a team by its name. |
‣ world ( ‣ teamName ( |
|
getPlayersNumber | Retrieves the number of players in a team. |
‣ world ( ‣ teamName ( |
|
getTeamsNumber | Retrieves the total number of teams. |
‣ world ( |
|
getTeamExists | Checks if a team exists in the world. |
‣ world ( ‣ teamName ( |
|
getTeamName | Retrieves the team name of a player. |
‣ world ( ‣ entity ( |
|
setCollisionRules |
Modifies the collision rules of a team. |
‣ world ( ‣ teamName ( ‣ rule ( ‣ callback ( |
|
Variant without the callback argument. Parameters: ‣ world ( ‣ teamName ( ‣ rule ( |
|||
setColor |
Modifies the color of a team. |
‣ world ( ‣ teamName ( ‣ color ( ‣ callback ( |
|
Variant without the callback argument. Parameters: ‣ world ( ‣ teamName ( ‣ color ( |
|||
setDeathMessageVisibility |
Modifies the visibility of the death message for a team. |
‣ world ( ‣ teamName ( ‣ visibility ( ‣ callback ( |
|
Variant without the callback argument. Parameters: ‣ world ( ‣ teamName ( ‣ visibility ( |
|||
setDisplayName |
Sets the display name for a given team. |
‣ world ( ‣ teamName ( ‣ name ( ‣ callback ( |
|
Variant without the callback argument. Parameters: ‣ world ( ‣ teamName ( ‣ name ( |
|||
setFriendlyFire |
Defines whether team members can damage each other (FriendlyFire). |
‣ world ( ‣ teamName ( ‣ fire ( ‣ callback ( |
|
Variant without the callback argument. Parameters: ‣ world ( ‣ teamName ( ‣ fire ( |
|||
setNametagVisibility |
Sets the visibility of name tags for team members. |
‣ world ( ‣ teamName ( ‣ visibility ( ‣ callback ( |
|
Variant without the callback argument. Parameters: ‣ world ( ‣ teamName ( ‣ visibility ( |
|||
setPrefix |
Sets the prefix for players in a team. |
‣ world ( ‣ teamName ( ‣ prefix ( ‣ callback ( |
|
Variant without the callback argument. Parameters: ‣ world ( ‣ teamName ( ‣ prefix ( |
|||
setSeeFriendlyInvisibles |
Sets whether team members can see invisible allies. |
‣ world ( ‣ teamName ( ‣ see ( ‣ callback ( |
|
Variant without the callback argument. Parameters: ‣ world ( ‣ teamName ( ‣ see ( |
|||
setSuffix |
Sets the suffix for a team. |
‣ world ( ‣ teamName ( ‣ suffix ( ‣ callback ( |
|
Variant without the callback argument. Parameters: ‣ world ( ‣ teamName ( ‣ suffix ( |
|||
getRawCollisionRules | Retrieves the raw collision rule for a given team. |
‣ world ( ‣ teamName ( |
|
getStringCollisionRules | Retrieves the collision rule as a string for a given team. |
‣ world ( ‣ teamName ( |
|
getRawColor | Retrieves the raw color of a team. |
‣ world ( ‣ teamName ( |
|
getStringColor | Retrieves the team's color as a string. |
‣ world ( ‣ teamName ( ‣ lowercase ( |
|
getRawDeathMessageVisibility | Retrieves the death message visibility for a team. |
‣ world ( ‣ teamName ( |
|
getStringDeathMessageVisibility | Retrieves the death message visibility as a string. |
‣ world ( ‣ teamName ( ‣ lowercase ( |
|
getDisplayName | Retrieves the display name for a team. |
‣ world ( ‣ teamName ( |
|
getRawNametagVisibility | Retrieves the visibility of name tags for a team. |
‣ world ( ‣ teamName ( |
|
getStringNametagVisibility | Retrieves the visibility of name tags as a string. |
‣ world ( ‣ teamName ( ‣ lowercase ( |
|
getPrefix | Retrieves the prefix for a team. |
‣ world ( ‣ teamName ( |
|
getSuffix | Retrieves the suffix for a team. |
‣ world ( ‣ teamName ( |
|
colisionRulesFromString | Converts a string into a collision rule for a team. |
‣ str ( |
|
colisionRulesToString | Converts a collision rule into a string. |
‣ str ( |
|
colorFromString | Converts a string into a Minecraft text color. |
‣ str ( |
|
teamVisibilityFromString | Converts a string into a team visibility. |
‣ str ( |
Exemple of Use
// Exemple of use for TeamUtil :
// Example for getTeam
Team team = TeamUtil.getTeam(world, "MyTeam");
// Example for getPlayersNumber
double playersNumber = TeamUtil.getPlayersNumber(world, "MyTeam");
// Example for getTeamsNumber
double teamsNumber = TeamUtil.getTeamsNumber(world);
// Example for getTeamExists
boolean teamExists = TeamUtil.getTeamExists(world, "MyTeam");
// Example for getTeamName
String teamName = TeamUtil.getTeamName(world, entity);
// Example for setCollisionRules
TeamUtil.setCollisionRules(world, "MyTeam", "newRule", true);
// Example for setColor
TeamUtil.setColor(world, "MyTeam", "red", true);
// Example for setDeathMessageVisibility
TeamUtil.setDeathMessageVisibility(world, "MyTeam", "visible", true);
// Example for setDisplayName
TeamUtil.setDisplayName(world, "MyTeam", "AwesomeTeam", true);
// Example for setFriendlyFire
TeamUtil.setFriendlyFire(world, "MyTeam", true, true);
// Example for setNametagVisibility
TeamUtil.setNametagVisibility(world, "MyTeam", "visible", true);
// Example for setPrefix
TeamUtil.setPrefix(world, "MyTeam", "[Team1]", true);
// Example for setSeeFriendlyInvisibles
TeamUtil.setSeeFriendlyInvisibles(world, "MyTeam", true, true);
// Example for setSuffix
TeamUtil.setSuffix(world, "MyTeam", "_VIP", true);
// Example for getRawCollisionRules
Team.CollisionRule collisionRule = TeamUtil.getRawCollisionRules(world, "MyTeam");
// Example for getStringCollisionRules
String collisionRuleStr = TeamUtil.getStringCollisionRules(world, "MyTeam");
// Example for getRawColor
Team.CollisionRule color = TeamUtil.getRawColor(world, "MyTeam");
// Example for getStringColor
String colorStr = TeamUtil.getStringColor(world, "MyTeam", "true");
// Example for getRawDeathMessageVisibility
Team.Visibility deathMessageVisibility = TeamUtil.getRawDeathMessageVisibility(world, "MyTeam");
// Example for getStringDeathMessageVisibility
String deathMessageVisibilityStr = TeamUtil.getStringDeathMessageVisibility(world, "MyTeam", "true");
// Example for getDisplayName
String displayName = TeamUtil.getDisplayName(world, "MyTeam");
// Example for getRawNametagVisibility
Team.Visibility nametagVisibility = TeamUtil.getRawNametagVisibility(world, "MyTeam");
// Example for getStringNametagVisibility
String nametagVisibilityStr = TeamUtil.getStringNametagVisibility(world, "MyTeam", "true");
// Example for getPrefix
String prefix = TeamUtil.getPrefix(world, "MyTeam");
// Example for getSuffix
String suffix = TeamUtil.getSuffix(world, "MyTeam");
// Example for colisionRulesFromString
Team.CollisionRule rule = TeamUtil.colisionRulesFromString("newRule");
// Example for colisionRulesToString
String ruleStr = TeamUtil.colisionRulesToString(Team.CollisionRule.ALWAYS);
// Example for colorFromString
ChatFormatting color = TeamUtil.colorFromString("red");
// Example for teamVisibilityFromString
Team.Visibility visibility = TeamUtil.teamVisibilityFromString("visible");
Utilitaire pour la gestion des équipes dans le jeu Minecraft. Contient des méthodes pour récupérer des informations sur les équipes, modifier leurs propriétés, et effectuer diverses opérations liées à l'équipe.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
getTeam | Récupère une équipe par son nom. |
‣ world ( ‣ teamName ( |
|
getPlayersNumber | Récupère le nombre de joueurs dans une équipe. |
‣ world ( ‣ teamName ( |
|
getTeamsNumber | Récupère le nombre total d'équipes. |
‣ world ( |
|
getTeamExists | Vérifie si une équipe existe dans le monde. |
‣ world ( ‣ teamName ( |
|
getTeamName | Récupère le nom de l'équipe d'un joueur. |
‣ world ( ‣ entity ( |
|
setCollisionRules |
Modifie les règles de collision d'une équipe. |
‣ world ( ‣ teamName ( ‣ rule ( ‣ callback ( |
|
Variante sans l'argument callback. Paramètres : ‣ world ( ‣ teamName ( ‣ rule ( |
|||
setColor |
Modifie la couleur d'une équipe. |
‣ world ( ‣ teamName ( ‣ color ( ‣ callback ( |
|
Variante sans l'argument callback. Paramètres : ‣ world ( ‣ teamName ( ‣ color ( |
|||
setDeathMessageVisibility |
Modifie la visibilité du message de décès d'une équipe. |
‣ world ( ‣ teamName ( ‣ visibility ( ‣ callback ( |
|
Variante sans l'argument callback. Paramètres : ‣ world ( ‣ teamName ( ‣ visibility ( |
|||
setDisplayName |
Définit le nom affiché pour une équipe donnée. |
‣ world ( ‣ teamName ( ‣ name ( ‣ callback ( |
|
Variante sans l'argument callback. Paramètres : ‣ world ( ‣ teamName ( ‣ name ( |
|||
setFriendlyFire |
Définit si les membres de l'équipe peuvent se causer des dégâts entre eux (FriendlyFire). |
‣ world ( ‣ teamName ( ‣ fire ( ‣ callback ( |
|
Variante sans l'argument callback. Paramètres : ‣ world ( ‣ teamName ( ‣ fire ( |
|||
setNametagVisibility |
Définit la visibilité des étiquettes de nom pour les membres d'une équipe. |
‣ world ( ‣ teamName ( ‣ visibility ( ‣ callback ( |
|
Variante sans l'argument callback. Paramètres : ‣ world ( ‣ teamName ( ‣ visibility ( |
|||
sePrefix |
Définit le préfixe des joueurs dans une équipe. |
‣ world ( ‣ teamName ( ‣ prefix ( ‣ callback ( |
|
Variante sans l'argument callback. Paramètres : ‣ world ( ‣ teamName ( ‣ prefix ( |
|||
setSeeFriendlyInvisibles |
Définit si les membres de l'équipe peuvent voir les invisibles alliés. |
‣ world ( ‣ teamName ( ‣ see ( ‣ callback ( |
|
Variante sans l'argument callback. Paramètres : ‣ world ( ‣ teamName ( ‣ see ( |
|||
setSuffix |
Définit si les membres de l'équipe peuvent voir les invisibles alliés. |
‣ world ( ‣ teamName ( ‣ suffix ( ‣ callback ( |
|
Variante sans l'argument callback. Paramètres : ‣ world ( ‣ teamName ( ‣ suffix ( |
|||
getRawCollisionRules | Récupère la règle de collision brute pour une équipe donnée. |
‣ world ( ‣ teamName ( |
|
getStringCollisionRules | Récupère la règle de collision sous forme de chaîne pour une équipe donnée. |
‣ world ( ‣ teamName ( |
|
getRawColor | Récupère la couleur brute de l'équipe. |
‣ world ( ‣ teamName ( |
|
getStringColor | Récupère la couleur de l'équipe sous forme de chaîne. |
‣ world ( ‣ teamName ( ‣ lowercase ( |
|
getRawDeathMessageVisibility | Récupère la visibilité des messages de mort pour une équipe. |
‣ world ( ‣ teamName ( |
|
getStringDeathMessageVisibility | Récupère la visibilité des messages de mort sous forme de chaîne. |
‣ world ( ‣ teamName ( ‣ lowercase ( |
|
getDisplayName | Récupère le nom affiché pour une équipe. |
‣ world ( ‣ teamName ( | |
getRawNametagVisibility | Récupère la visibilité des étiquettes de nom pour une équipe. |
‣ world ( ‣ teamName ( |
|
getStringNametagVisibility | Récupère la visibilité des étiquettes de nom sous forme de chaîne. |
‣ world ( ‣ teamName ( ‣ lowercase ( |
|
getPrefix | Récupère le préfixe d'une équipe. |
‣ world ( ‣ teamName ( | |
getSuffix | Récupère le suffixe d'une équipe |
‣ world ( ‣ teamName ( | |
colisionRulesFromString | Convertit une chaîne en une règle de collision pour une équipe. |
‣ str ( | |
colisionRulesFromString | Convertit une règle de collision en une chaîne. |
‣ str ( | |
colorFromString | Convertit une chaîne en une couleur de texte Minecraft. |
‣ str ( | |
teamVisibilityFromString | Convertit une chaîne en une visibilité de l'équipe. |
‣ str ( |
Exemple d'Utilisation
// Exemple d'utilisation pour TeamUtil :
// Exemple pour getTeam
Team team = TeamUtil.getTeam(world, "MyTeam");
// Exemple pour getPlayersNumber
double playersNumber = TeamUtil.getPlayersNumber(world, "MyTeam");
// Exemple pour getTeamsNumber
double teamsNumber = TeamUtil.getTeamsNumber(world);
// Exemple pour getTeamExists
boolean teamExists = TeamUtil.getTeamExists(world, "MyTeam");
// Exemple pour getTeamName
String teamName = TeamUtil.getTeamName(world, entity);
// Exemple pour setCollisionRules
TeamUtil.setCollisionRules(world, "MyTeam", "newRule", true);
// Exemple pour setColor
TeamUtil.setColor(world, "MyTeam", "red", true);
// Exemple pour setDeathMessageVisibility
TeamUtil.setDeathMessageVisibility(world, "MyTeam", "visible", true);
// Exemple pour setDisplayName
TeamUtil.setDisplayName(world, "MyTeam", "AwesomeTeam", true);
// Exemple pour setFriendlyFire
TeamUtil.setFriendlyFire(world, "MyTeam", true, true);
// Exemple pour setNametagVisibility
TeamUtil.setNametagVisibility(world, "MyTeam", "visible", true);
// Exemple pour setPrefix
TeamUtil.setPrefix(world, "MyTeam", "[Team1]", true);
// Exemple pour setSeeFriendlyInvisibles
TeamUtil.setSeeFriendlyInvisibles(world, "MyTeam", true, true);
// Exemple pour setSuffix
TeamUtil.setSuffix(world, "MyTeam", "_VIP", true);
// Exemple pour getRawCollisionRules
Team.CollisionRule collisionRule = TeamUtil.getRawCollisionRules(world, "MyTeam");
// Exemple pour getStringCollisionRules
String collisionRuleStr = TeamUtil.getStringCollisionRules(world, "MyTeam");
// Exemple pour getRawColor
Team.CollisionRule color = TeamUtil.getRawColor(world, "MyTeam");
// Exemple pour getStringColor
String colorStr = TeamUtil.getStringColor(world, "MyTeam", "true");
// Exemple pour getRawDeathMessageVisibility
Team.Visibility deathMessageVisibility = TeamUtil.getRawDeathMessageVisibility(world, "MyTeam");
// Exemple pour getStringDeathMessageVisibility
String deathMessageVisibilityStr = TeamUtil.getStringDeathMessageVisibility(world, "MyTeam", "true");
// Exemple pour getDisplayName
String displayName = TeamUtil.getDisplayName(world, "MyTeam");
// Exemple pour getRawNametagVisibility
Team.Visibility nametagVisibility = TeamUtil.getRawNametagVisibility(world, "MyTeam");
// Exemple pour getStringNametagVisibility
String nametagVisibilityStr = TeamUtil.getStringNametagVisibility(world, "MyTeam", "true");
// Exemple pour getPrefix
String prefix = TeamUtil.getPrefix(world, "MyTeam");
// Exemple pour getSuffix
String suffix = TeamUtil.getSuffix(world, "MyTeam");
// Exemple pour colisionRulesFromString
Team.CollisionRule rule = TeamUtil.colisionRulesFromString("newRule");
// Exemple pour colisionRulesToString
String ruleStr = TeamUtil.colisionRulesToString(Team.CollisionRule.ALWAYS);
// Exemple pour colorFromString
ChatFormatting color = TeamUtil.colorFromString("red");
// Exemple pour teamVisibilityFromString
Team.Visibility visibility = TeamUtil.teamVisibilityFromString("visible");
Utility for managing teams in the Minecraft game. Contains methods for retrieving information about teams, modifying their properties, and performing various team-related operations.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
getTeam | Retrieves a team by its name. |
‣ world ( ‣ teamName ( |
|
getPlayersNumber | Retrieves the number of players in a team. |
‣ world ( ‣ teamName ( |
|
getTeamsNumber | Retrieves the total number of teams. |
‣ world ( |
|
getTeamExists | Checks if a team exists in the world. |
‣ world ( ‣ teamName ( |
|
getTeamName | Retrieves the team name of a player. |
‣ world ( ‣ entity ( |
|
setCollisionRules |
Modifies the collision rules of a team. |
‣ world ( ‣ teamName ( ‣ rule ( ‣ callback ( |
|
Variant without the callback argument. Parameters: ‣ world ( ‣ teamName ( ‣ rule ( |
|||
setColor |
Modifies the color of a team. |
‣ world ( ‣ teamName ( ‣ color ( ‣ callback ( |
|
Variant without the callback argument. Parameters: ‣ world ( ‣ teamName ( ‣ color ( |
|||
setDeathMessageVisibility |
Modifies the visibility of the death message for a team. |
‣ world ( ‣ teamName ( ‣ visibility ( ‣ callback ( |
|
Variant without the callback argument. Parameters: ‣ world ( ‣ teamName ( ‣ visibility ( |
|||
setDisplayName |
Sets the display name for a given team. |
‣ world ( ‣ teamName ( ‣ name ( ‣ callback ( |
|
Variant without the callback argument. Parameters: ‣ world ( ‣ teamName ( ‣ name ( |
|||
setFriendlyFire |
Defines whether team members can damage each other (FriendlyFire). |
‣ world ( ‣ teamName ( ‣ fire ( ‣ callback ( |
|
Variant without the callback argument. Parameters: ‣ world ( ‣ teamName ( ‣ fire ( |
|||
setNametagVisibility |
Sets the visibility of name tags for team members. |
‣ world ( ‣ teamName ( ‣ visibility ( ‣ callback ( |
|
Variant without the callback argument. Parameters: ‣ world ( ‣ teamName ( ‣ visibility ( |
|||
setPrefix |
Sets the prefix for players in a team. |
‣ world ( ‣ teamName ( ‣ prefix ( ‣ callback ( |
|
Variant without the callback argument. Parameters: ‣ world ( ‣ teamName ( ‣ prefix ( |
|||
setSeeFriendlyInvisibles |
Sets whether team members can see invisible allies. |
‣ world ( ‣ teamName ( ‣ see ( ‣ callback ( |
|
Variant without the callback argument. Parameters: ‣ world ( ‣ teamName ( ‣ see ( |
|||
setSuffix |
Sets the suffix for a team. |
‣ world ( ‣ teamName ( ‣ suffix ( ‣ callback ( |
|
Variant without the callback argument. Parameters: ‣ world ( ‣ teamName ( ‣ suffix ( |
|||
getRawCollisionRules | Retrieves the raw collision rule for a given team. |
‣ world ( ‣ teamName ( |
|
getStringCollisionRules | Retrieves the collision rule as a string for a given team. |
‣ world ( ‣ teamName ( |
|
getRawColor | Retrieves the raw color of a team. |
‣ world ( ‣ teamName ( |
|
getStringColor | Retrieves the team's color as a string. |
‣ world ( ‣ teamName ( ‣ lowercase ( |
|
getRawDeathMessageVisibility | Retrieves the death message visibility for a team. |
‣ world ( ‣ teamName ( |
|
getStringDeathMessageVisibility | Retrieves the death message visibility as a string. |
‣ world ( ‣ teamName ( ‣ lowercase ( |
|
getDisplayName | Retrieves the display name for a team. |
‣ world ( ‣ teamName ( |
|
getRawNametagVisibility | Retrieves the visibility of name tags for a team. |
‣ world ( ‣ teamName ( |
|
getStringNametagVisibility | Retrieves the visibility of name tags as a string. |
‣ world ( ‣ teamName ( ‣ lowercase ( |
|
getPrefix | Retrieves the prefix for a team. |
‣ world ( ‣ teamName ( |
|
getSuffix | Retrieves the suffix for a team. |
‣ world ( ‣ teamName ( |
|
colisionRulesFromString | Converts a string into a collision rule for a team. |
‣ str ( |
|
colisionRulesToString | Converts a collision rule into a string. |
‣ str ( |
|
colorFromString | Converts a string into a Minecraft text color. |
‣ str ( |
|
teamVisibilityFromString | Converts a string into a team visibility. |
‣ str ( |
Exemple of Use
// Exemple of use for TeamUtil :
// Example for getTeam
Team team = TeamUtil.getTeam(world, "MyTeam");
// Example for getPlayersNumber
double playersNumber = TeamUtil.getPlayersNumber(world, "MyTeam");
// Example for getTeamsNumber
double teamsNumber = TeamUtil.getTeamsNumber(world);
// Example for getTeamExists
boolean teamExists = TeamUtil.getTeamExists(world, "MyTeam");
// Example for getTeamName
String teamName = TeamUtil.getTeamName(world, entity);
// Example for setCollisionRules
TeamUtil.setCollisionRules(world, "MyTeam", "newRule", true);
// Example for setColor
TeamUtil.setColor(world, "MyTeam", "red", true);
// Example for setDeathMessageVisibility
TeamUtil.setDeathMessageVisibility(world, "MyTeam", "visible", true);
// Example for setDisplayName
TeamUtil.setDisplayName(world, "MyTeam", "AwesomeTeam", true);
// Example for setFriendlyFire
TeamUtil.setFriendlyFire(world, "MyTeam", true, true);
// Example for setNametagVisibility
TeamUtil.setNametagVisibility(world, "MyTeam", "visible", true);
// Example for setPrefix
TeamUtil.setPrefix(world, "MyTeam", "[Team1]", true);
// Example for setSeeFriendlyInvisibles
TeamUtil.setSeeFriendlyInvisibles(world, "MyTeam", true, true);
// Example for setSuffix
TeamUtil.setSuffix(world, "MyTeam", "_VIP", true);
// Example for getRawCollisionRules
Team.CollisionRule collisionRule = TeamUtil.getRawCollisionRules(world, "MyTeam");
// Example for getStringCollisionRules
String collisionRuleStr = TeamUtil.getStringCollisionRules(world, "MyTeam");
// Example for getRawColor
Team.CollisionRule color = TeamUtil.getRawColor(world, "MyTeam");
// Example for getStringColor
String colorStr = TeamUtil.getStringColor(world, "MyTeam", "true");
// Example for getRawDeathMessageVisibility
Team.Visibility deathMessageVisibility = TeamUtil.getRawDeathMessageVisibility(world, "MyTeam");
// Example for getStringDeathMessageVisibility
String deathMessageVisibilityStr = TeamUtil.getStringDeathMessageVisibility(world, "MyTeam", "true");
// Example for getDisplayName
String displayName = TeamUtil.getDisplayName(world, "MyTeam");
// Example for getRawNametagVisibility
Team.Visibility nametagVisibility = TeamUtil.getRawNametagVisibility(world, "MyTeam");
// Example for getStringNametagVisibility
String nametagVisibilityStr = TeamUtil.getStringNametagVisibility(world, "MyTeam", "true");
// Example for getPrefix
String prefix = TeamUtil.getPrefix(world, "MyTeam");
// Example for getSuffix
String suffix = TeamUtil.getSuffix(world, "MyTeam");
// Example for colisionRulesFromString
Team.CollisionRule rule = TeamUtil.colisionRulesFromString("newRule");
// Example for colisionRulesToString
String ruleStr = TeamUtil.colisionRulesToString(Team.CollisionRule.ALWAYS);
// Example for colorFromString
ChatFormatting color = TeamUtil.colorFromString("red");
// Example for teamVisibilityFromString
Team.Visibility visibility = TeamUtil.teamVisibilityFromString("visible");
TetraConfig
Interface représentant une configuration de type Tetra. Cette interface définit les méthodes permettant de gérer les configurations sous forme de paires nom-valeur.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
initializeConfigurations | Initialise les configurations de manière spécifique. Cette méthode permet de préparer les configurations en chargeant les paramètres nécessaires. |
|
|
addConfiguration | Ajoute une nouvelle configuration avec un nom et une valeur booléenne. |
‣ name ( ‣ value ( |
|
removeConfiguration | Supprime une configuration existante par son nom. |
‣ name ( |
|
getConfiguration | Récupère la valeur booléenne d'une configuration en fonction de son nom. |
‣ name ( |
|
isConfigurationEnabled | Vérifie si une configuration est activée. |
‣ name ( |
Exemple d'Utilisation
// Exemple d'utilisation pour TetraConfig :
// Exemple pour initializeConfigurations
TetraConfig.initializeConfigurations();
// Exemple pour addConfiguration
TetraConfig.addConfiguration("myConfig", true);
// Exemple pour removeConfiguration
TetraConfig.removeConfiguration("myConfig");
// Exemple pour getConfiguration
boolean configValue = TetraConfig.getConfiguration("myConfig");
// Exemple pour isConfigurationEnabled
boolean isEnabled = TetraConfig.isConfigurationEnabled("myConfig");
Interface representing a Tetra type configuration. This interface defines methods for handling configurations as name-value pairs.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
initializeConfigurations | Initializes the configurations in a specific way. This method prepares the configurations by loading the necessary parameters. |
|
|
addConfiguration | Adds a new configuration with a name and a boolean value. |
‣ name ( ‣ value ( |
|
removeConfiguration | Removes an existing configuration by its name. |
‣ name ( |
|
getConfiguration | Retrieves the boolean value of a configuration based on its name. |
‣ name ( |
|
isConfigurationEnabled | Checks if a configuration is enabled. |
‣ name ( |
Exemple of Use
// Exemple of use for TetraConfig :
// Example of use for TetraConfig :
// Example for initializeConfigurations
TetraConfig.initializeConfigurations();
// Example for addConfiguration
TetraConfig.addConfiguration("myConfig", true);
// Example for removeConfiguration
TetraConfig.removeConfiguration("myConfig");
// Example for getConfiguration
boolean configValue = TetraConfig.getConfiguration("myConfig");
// Example for isConfigurationEnabled
boolean isEnabled = TetraConfig.isConfigurationEnabled("myConfig");
Interface représentant une configuration de type Tetra. Cette interface définit les méthodes permettant de gérer les configurations sous forme de paires nom-valeur.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
initializeConfigurations | Initialise les configurations de manière spécifique. Cette méthode permet de préparer les configurations en chargeant les paramètres nécessaires. |
|
|
addConfiguration | Ajoute une nouvelle configuration avec un nom et une valeur booléenne. |
‣ name ( ‣ value ( |
|
removeConfiguration | Supprime une configuration existante par son nom. |
‣ name ( |
|
getConfiguration | Récupère la valeur booléenne d'une configuration en fonction de son nom. |
‣ name ( |
|
isConfigurationEnabled | Vérifie si une configuration est activée. |
‣ name ( |
Exemple d'Utilisation
// Exemple d'utilisation pour TetraConfig :
// Exemple pour initializeConfigurations
TetraConfig.initializeConfigurations();
// Exemple pour addConfiguration
TetraConfig.addConfiguration("myConfig", true);
// Exemple pour removeConfiguration
TetraConfig.removeConfiguration("myConfig");
// Exemple pour getConfiguration
boolean configValue = TetraConfig.getConfiguration("myConfig");
// Exemple pour isConfigurationEnabled
boolean isEnabled = TetraConfig.isConfigurationEnabled("myConfig");
Interface representing a Tetra type configuration. This interface defines methods for handling configurations as name-value pairs.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
initializeConfigurations | Initializes the configurations in a specific way. This method prepares the configurations by loading the necessary parameters. |
|
|
addConfiguration | Adds a new configuration with a name and a boolean value. |
‣ name ( ‣ value ( |
|
removeConfiguration | Removes an existing configuration by its name. |
‣ name ( |
|
getConfiguration | Retrieves the boolean value of a configuration based on its name. |
‣ name ( |
|
isConfigurationEnabled | Checks if a configuration is enabled. |
‣ name ( |
Exemple of Use
// Exemple of use for TetraConfig :
// Example of use for TetraConfig :
// Example for initializeConfigurations
TetraConfig.initializeConfigurations();
// Example for addConfiguration
TetraConfig.addConfiguration("myConfig", true);
// Example for removeConfiguration
TetraConfig.removeConfiguration("myConfig");
// Example for getConfiguration
boolean configValue = TetraConfig.getConfiguration("myConfig");
// Example for isConfigurationEnabled
boolean isEnabled = TetraConfig.isConfigurationEnabled("myConfig");
TetraLibsOptions
Classe responsable de gérer l'ajout d'options supplémentaires dans l'écran des paramètres du jeu. Elle permet d'ajouter un bouton personnalisé à l'écran des paramètres qui ouvre un autre écran spécifique à TetraLibs.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotations |
---|---|---|---|---|
onGuiScreenInit | Méthode qui est appelée après l'initialisation de l'écran de paramètres pour ajouter un bouton personnalisé. Le bouton ouvre un écran spécifique à TetraLibs quand il est cliqué. |
‣ event ( |
Exemple d'Utilisation
// Exemple d'utilisation pour TetraLibsOptions :
// ScreenEvent.Init.Post
TetraLibsOptions.onGuiScreenInit(event)
Class responsible for handling the addition of additional options in the game settings screen. Allows you to add a custom button to the settings screen that opens another TetraLibs specific screen.
Available Methods
Method | Description | Parameter | Return | Annotations |
---|---|---|---|---|
onGuiScreenInit | Method that is called after initializing the settings screen to add a custom button. The button opens a TetraLibs specific screen when clicked. |
‣ event ( |
Exemple of Use
// Exemple of use for TetraLibsOptions :
// ScreenEvent.Init.Post
TetraLibsOptions.onGuiScreenInit(event)
Classe responsable de gérer l'ajout d'options supplémentaires dans l'écran des paramètres du jeu. Elle permet d'ajouter un bouton personnalisé à l'écran des paramètres qui ouvre un autre écran spécifique à TetraLibs.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotations |
---|---|---|---|---|
onGuiScreenInit | Méthode qui est appelée après l'initialisation de l'écran de paramètres pour ajouter un bouton personnalisé. Le bouton ouvre un écran spécifique à TetraLibs quand il est cliqué. |
‣ event ( |
Exemple d'Utilisation
// Exemple d'utilisation pour TetraLibsOptions :
// ScreenEvent.Init.Post
TetraLibsOptions.onGuiScreenInit(event)
Class responsible for handling the addition of additional options in the game settings screen. Allows you to add a custom button to the settings screen that opens another TetraLibs specific screen.
Available Methods
Method | Description | Parameter | Return | Annotations |
---|---|---|---|---|
onGuiScreenInit | Method that is called after initializing the settings screen to add a custom button. The button opens a TetraLibs specific screen when clicked. |
‣ event ( |
Exemple of Use
// Exemple of use for TetraLibsOptions :
// ScreenEvent.Init.Post
TetraLibsOptions.onGuiScreenInit(event)
TetraLibsOptionsScreen
Classe représentant l'écran des options personnalisées de TetraLibs dans le jeu. Cet écran permet de configurer certaines options spécifiques à TetraLibs et de revenir à l'écran des paramètres.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotations |
---|---|---|---|---|
TetraLibsOptionsScreen | Constructeur de la classe TetraLibsOptionsScreen. Ce constructeur prend l'écran parent en paramètre pour pouvoir y revenir si nécessaire. |
‣ parent ( |
||
render | Rendu graphique de l'écran, y compris l'arrière-plan et le texte du titre. |
‣ guiGraphics ( ‣ mouseX ( ‣ mouseY ( ‣ partialTicks ( |
||
shouldCloseOnEsc | Indique si cet écran peut être fermé avec la touche ESC. Retourne true pour permettre la fermeture. |
‣ guiGraphics ( ‣ mouseX ( ‣ mouseY ( ‣ partialTicks ( |
Exemple d'Utilisation
// Exemple d'utilisation pour TetraLibsOptionsScreen :
// Event déclenché après l'initialisation de l'écran
TetraLibsOptions.onGuiScreenInit(event);
Class representing the TetraLibs custom options screen in the game. This screen allows you to configure some TetraLibs-specific options and return to the settings screen.
Available Methods
Method | Description | Parameter | Return | Annotations |
---|---|---|---|---|
TetraLibsOptionsScreen | Constructor for the TetraLibsOptionsScreen class. This constructor takes the parent screen as a parameter so that it can return to it if necessary. |
‣ parent ( |
||
render | The graphical rendering of the screen, including the background and title text. |
‣ guiGraphics ( ‣ mouseX ( ‣ mouseY ( ‣ partialTicks ( |
||
shouldCloseOnEsc | Indicates if this screen can be closed with the ESC key. Returns true to allow closing. |
‣ guiGraphics ( ‣ mouseX ( ‣ mouseY ( ‣ partialTicks ( |
Exemple of Use
// Exemple of use for TetraLibsOptionsScreen :
// ScreenEvent.Init.Post event triggered after the screen initialization
TetraLibsOptions.onGuiScreenInit(event);
Classe représentant l'écran des options personnalisées de TetraLibs dans le jeu. Cet écran permet de configurer certaines options spécifiques à TetraLibs et de revenir à l'écran des paramètres.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotations |
---|---|---|---|---|
TetraLibsOptionsScreen | Constructeur de la classe TetraLibsOptionsScreen. Ce constructeur prend l'écran parent en paramètre pour pouvoir y revenir si nécessaire. |
‣ parent ( |
||
render | Rendu graphique de l'écran, y compris l'arrière-plan et le texte du titre. |
‣ guiGraphics ( ‣ mouseX ( ‣ mouseY ( ‣ partialTicks ( |
||
shouldCloseOnEsc | Indique si cet écran peut être fermé avec la touche ESC. Retourne true pour permettre la fermeture. |
‣ guiGraphics ( ‣ mouseX ( ‣ mouseY ( ‣ partialTicks ( |
Exemple d'Utilisation
// Exemple d'utilisation pour TetraLibsOptionsScreen :
// Event déclenché après l'initialisation de l'écran
TetraLibsOptions.onGuiScreenInit(event);
Class representing the TetraLibs custom options screen in the game. This screen allows you to configure some TetraLibs-specific options and return to the settings screen.
Available Methods
Method | Description | Parameter | Return | Annotations |
---|---|---|---|---|
TetraLibsOptionsScreen | Constructor for the TetraLibsOptionsScreen class. This constructor takes the parent screen as a parameter so that it can return to it if necessary. |
‣ parent ( |
||
render | The graphical rendering of the screen, including the background and title text. |
‣ guiGraphics ( ‣ mouseX ( ‣ mouseY ( ‣ partialTicks ( |
||
shouldCloseOnEsc | Indicates if this screen can be closed with the ESC key. Returns true to allow closing. |
‣ guiGraphics ( ‣ mouseX ( ‣ mouseY ( ‣ partialTicks ( |
Exemple of Use
// Exemple of use for TetraLibsOptionsScreen :
// ScreenEvent.Init.Post event triggered after the screen initialization
TetraLibsOptions.onGuiScreenInit(event);
TetraLibsWorldOptions
Classe qui gère les congiurations personnalisées de TetraLibs(Config, ConfigManager) lors de la création d'un monde et la gestion des fichiers associés. Cette classe permet d'ajouter des boutons à l'interface de création de monde, ainsi que de gérer des fichiers de configuration temporaires.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotations |
---|---|---|---|---|
onGuiScreenInit | Méthode déclenchée lors de l'initialisation des écrans dans le jeu. Elle ajoute un bouton d'options pour TetraLibs dans l'écran de création de monde. |
‣ event ( |
||
onWorldCreate | Méthode déclenchée lors de la création d'un monde dans le jeu. Elle gère la création de fichiers temporaires pour les configurations spécifiques à TetraLibs. |
‣ event ( |
Exemple d'Utilisation
// Exemple d'utilisation pour TetraLibsOptionsScreen :
// Event déclenché après l'initialisation de l'écran
TetraLibsOptions.onGuiScreenInit(event);
// Exemple pour onWorldCreate
// Lors de la création d'un monde, cette méthode gère la création des fichiers temporaires.
TetraLibsOptions.onWorldCreate(event);
Class that manages TetraLibs Configs(Config, ConfigManager) when creating a world and managing associated files. This class allows you to add buttons to the world creation interface, as well as manage temporary configuration files.
Available Methods
Method | Description | Parameter | Return | Annotations |
---|---|---|---|---|
onGuiScreenInit | Method triggered during the screen initialization in the game. It adds a TetraLibs options button to the world creation screen. |
‣ event ( |
||
onWorldCreate | Method triggered when creating a world in the game. It handles the creation of temporary files for TetraLibs-specific configurations. |
‣ event ( |
Exemple of Use
// Exemple of use for TetraLibsOptionsScreen :
// ScreenEvent.Init.Post event triggered after the screen initialization
TetraLibsOptions.onGuiScreenInit(event);
// Example for onWorldCreate
// When creating a world, this method handles the creation of temporary files.
TetraLibsOptions.onWorldCreate(event);
Classe qui gère les congiurations personnalisées de TetraLibs(Config, ConfigManager) lors de la création d'un monde et la gestion des fichiers associés. Cette classe permet d'ajouter des boutons à l'interface de création de monde, ainsi que de gérer des fichiers de configuration temporaires.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotations |
---|---|---|---|---|
onGuiScreenInit | Méthode déclenchée lors de l'initialisation des écrans dans le jeu. Elle ajoute un bouton d'options pour TetraLibs dans l'écran de création de monde. |
‣ event ( |
||
onWorldCreate | Méthode déclenchée lors de la création d'un monde dans le jeu. Elle gère la création de fichiers temporaires pour les configurations spécifiques à TetraLibs. |
‣ event ( |
Exemple d'Utilisation
// Exemple d'utilisation pour TetraLibsOptionsScreen :
// Event déclenché après l'initialisation de l'écran
TetraLibsOptions.onGuiScreenInit(event);
// Exemple pour onWorldCreate
// Lors de la création d'un monde, cette méthode gère la création des fichiers temporaires.
TetraLibsOptions.onWorldCreate(event);
Class that manages TetraLibs Configs(Config, ConfigManager) when creating a world and managing associated files. This class allows you to add buttons to the world creation interface, as well as manage temporary configuration files.
Available Methods
Method | Description | Parameter | Return | Annotations |
---|---|---|---|---|
onGuiScreenInit | Method triggered during the screen initialization in the game. It adds a TetraLibs options button to the world creation screen. |
‣ event ( |
||
onWorldCreate | Method triggered when creating a world in the game. It handles the creation of temporary files for TetraLibs-specific configurations. |
‣ event ( |
Exemple of Use
// Exemple of use for TetraLibsOptionsScreen :
// ScreenEvent.Init.Post event triggered after the screen initialization
TetraLibsOptions.onGuiScreenInit(event);
// Example for onWorldCreate
// When creating a world, this method handles the creation of temporary files.
TetraLibsOptions.onWorldCreate(event);
TetraLibsWorldOptionsScreen
Écran de configuration des configurations personnalisées de TetraLibs(Config, ConfigManager) pour le monde en cours. Cette classe permet de gérer l'affichage et la modification des options de configuration d'un monde, et de sauvegarder ces options dans un fichier JSON.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotations |
---|---|---|---|---|
TetraLibsWorldOptionsScreen | Constructeur de l'écran des options de TetraLibs pour le monde. Charge les options de configuration et initialise l'écran. |
‣ parent ( |
||
addButton | Ajoute une nouvelle option de configuration à la liste des options disponibles. |
‣ name ( ‣ value ( |
||
onClose | Méthode appelée lorsque l'écran est fermé, pour sauvegarder les options avant de quitter. |
|
||
render | Méthode de rendu pour dessiner l'écran, y compris le titre et l'arrière-plan personnalisé. |
‣ guiGraphics ( ‣ mouseX ( ‣ mouseY ( ‣ partialTicks ( |
||
shouldCloseOnEsc | Indique si l'écran doit se fermer lorsqu'on appuie sur ESC. |
|
Exemple d'Utilisation
// Exemple d'utilisation pour TetraLibsOptionsScreen :
// Exemple pour TetraLibsWorldOptionsScreen
// Création de l'écran des options du monde avec un écran parent
TetraLibsWorldOptionsScreen worldOptionsScreen = new TetraLibsWorldOptionsScreen(parent);
// Exemple pour addButton
// Ajouter une nouvelle option de configuration pour le monde
worldOptionsScreen.addButton("Option1", true);
// Exemple pour onClose
// Sauvegarde des options lorsque l'écran est fermé
worldOptionsScreen.onClose();
// Exemple pour render
// Dessiner l'écran, y compris le titre et l'arrière-plan
worldOptionsScreen.render(guiGraphics, mouseX, mouseY, partialTicks);
// Exemple pour shouldCloseOnEsc
// Vérifie si l'écran doit se fermer lorsqu'on appuie sur ESC
boolean shouldClose = worldOptionsScreen.shouldCloseOnEsc();
TetraLibs custom configs(Config, ConfigManager) configuration screen for the current world. This class allows you to manage the display and modification of the configuration options of a world, and save these options in a JSON file.
Available Methods
Method | Description | Parameter | Return | Annotations |
---|---|---|---|---|
TetraLibsWorldOptionsScreen | Constructor for the TetraLibs world options screen. Loads configuration options and initializes the screen. |
‣ parent ( |
||
addButton | Adds a new configuration option to the list of available options. |
‣ name ( ‣ value ( |
||
onClose | Method called when the screen is closed, to save the options before exiting. |
|
||
render | Render method for drawing the screen, including the title and custom background. |
‣ guiGraphics ( ‣ mouseX ( ‣ mouseY ( ‣ partialTicks ( |
||
shouldCloseOnEsc | Indicates if the screen should close when pressing ESC. |
|
Exemple of Use
// Exemple of use for TetraLibsOptionsScreen :
// Example for TetraLibsWorldOptionsScreen
// Create the world options screen with a parent screen
TetraLibsWorldOptionsScreen worldOptionsScreen = new TetraLibsWorldOptionsScreen(parent);
// Example for addButton
// Add a new configuration option for the world
worldOptionsScreen.addButton("Option1", true);
// Example for onClose
// Save the options when the screen is closed
worldOptionsScreen.onClose();
// Example for render
// Render the screen, including the title and custom background
worldOptionsScreen.render(guiGraphics, mouseX, mouseY, partialTicks);
// Example for shouldCloseOnEsc
// Check if the screen should close when pressing ESC
boolean shouldClose = worldOptionsScreen.shouldCloseOnEsc();
Écran de configuration des configurations personnalisées de TetraLibs(Config, ConfigManager) pour le monde en cours. Cette classe permet de gérer l'affichage et la modification des options de configuration d'un monde, et de sauvegarder ces options dans un fichier JSON.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour | Annotations |
---|---|---|---|---|
TetraLibsWorldOptionsScreen | Constructeur de l'écran des options de TetraLibs pour le monde. Charge les options de configuration et initialise l'écran. |
‣ parent ( |
||
addButton | Ajoute une nouvelle option de configuration à la liste des options disponibles. |
‣ name ( ‣ value ( |
||
onClose | Méthode appelée lorsque l'écran est fermé, pour sauvegarder les options avant de quitter. |
|
||
render | Méthode de rendu pour dessiner l'écran, y compris le titre et l'arrière-plan personnalisé. |
‣ guiGraphics ( ‣ mouseX ( ‣ mouseY ( ‣ partialTicks ( |
||
shouldCloseOnEsc | Indique si l'écran doit se fermer lorsqu'on appuie sur ESC. |
|
Exemple d'Utilisation
// Exemple d'utilisation pour TetraLibsOptionsScreen :
// Exemple pour TetraLibsWorldOptionsScreen
// Création de l'écran des options du monde avec un écran parent
TetraLibsWorldOptionsScreen worldOptionsScreen = new TetraLibsWorldOptionsScreen(parent);
// Exemple pour addButton
// Ajouter une nouvelle option de configuration pour le monde
worldOptionsScreen.addButton("Option1", true);
// Exemple pour onClose
// Sauvegarde des options lorsque l'écran est fermé
worldOptionsScreen.onClose();
// Exemple pour render
// Dessiner l'écran, y compris le titre et l'arrière-plan
worldOptionsScreen.render(guiGraphics, mouseX, mouseY, partialTicks);
// Exemple pour shouldCloseOnEsc
// Vérifie si l'écran doit se fermer lorsqu'on appuie sur ESC
boolean shouldClose = worldOptionsScreen.shouldCloseOnEsc();
TetraLibs custom configs(Config, ConfigManager) configuration screen for the current world. This class allows you to manage the display and modification of the configuration options of a world, and save these options in a JSON file.
Available Methods
Method | Description | Parameter | Return | Annotations |
---|---|---|---|---|
TetraLibsWorldOptionsScreen | Constructor for the TetraLibs world options screen. Loads configuration options and initializes the screen. |
‣ parent ( |
||
addButton | Adds a new configuration option to the list of available options. |
‣ name ( ‣ value ( |
||
onClose | Method called when the screen is closed, to save the options before exiting. |
|
||
render | Render method for drawing the screen, including the title and custom background. |
‣ guiGraphics ( ‣ mouseX ( ‣ mouseY ( ‣ partialTicks ( |
||
shouldCloseOnEsc | Indicates if the screen should close when pressing ESC. |
|
Exemple of Use
// Exemple of use for TetraLibsOptionsScreen :
// Example for TetraLibsWorldOptionsScreen
// Create the world options screen with a parent screen
TetraLibsWorldOptionsScreen worldOptionsScreen = new TetraLibsWorldOptionsScreen(parent);
// Example for addButton
// Add a new configuration option for the world
worldOptionsScreen.addButton("Option1", true);
// Example for onClose
// Save the options when the screen is closed
worldOptionsScreen.onClose();
// Example for render
// Render the screen, including the title and custom background
worldOptionsScreen.render(guiGraphics, mouseX, mouseY, partialTicks);
// Example for shouldCloseOnEsc
// Check if the screen should close when pressing ESC
boolean shouldClose = worldOptionsScreen.shouldCloseOnEsc();
TetraPage
Cette classe gère la pagination et l'affichage du texte à travers des pages pour le mod TetraLibs. Elle permet d'ajouter des pages, de les naviguer et de personnaliser les actions sur chaque texte affiché.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
pagesCount |
Nombre total de pages dans la liste pages . Cette variable statique est initialisée avec la taille actuelle de la collection pages , ce qui représente le nombre d'éléments (pages) stockés. Elle est mise à jour dynamiquement chaque fois que la collection pages est modifiée, assurant ainsi une valeur correcte du nombre total de pages.
|
|
|
addPage | Ajoute une page à la liste des pages standards. |
‣ content ( |
|
addCustomPage | Ajoute une page à la liste des pages personnalisées. |
‣ content ( |
|
navigMenu | Crée un composant représentant un menu de navigation avec les boutons pour la page précédente et la suivante. |
‣ entity ( |
|
display | Affiche la page actuelle pour un joueur. |
‣ source ( ‣ entity ( |
|
pagesList | Affiche la liste des pages disponibles au joueur. |
‣ source ( |
|
createText |
Crée un composant de texte avec des événements de survol et de clic configurés. |
‣ text ( ‣ hoverText ( ‣ clickAction ( ‣ clickValue ( ‣ entity ( |
|
Variante sans l'argument entity. Paramètres : ‣ text ( ‣ hoverText ( ‣ clickAction ( ‣ clickValue ( Retourne |
|||
modifyText | Modifie un composant de texte existant en lui ajoutant des actions de survol et de clic. |
‣ component ( ‣ text ( ‣ hoverText ( ‣ clickAction ( ‣ clickValue ( ‣ entity ( |
|
logAllList | Enregistre les actions et les événements de survol pour des logs. |
|
|
logPagesCount |
Enregistre le nombre de pages et la distinction entre pages standards et personnalisées. |
‣ edited ( |
|
Variante sans l'argument edited. Retourne |
|||
setPlayerPage | Met à jour la page du joueur. |
‣ entity ( ‣ num ( |
|
getPlayerPage | Récupère la page actuelle du joueur. |
‣ entity ( ‣ num ( |
Exemple d'Utilisation
// Exemple d'utilisation pour TetraPage :
// Exemple d'utilisation pour la méthode pagesCount
int totalPages = yourClass.pagesCount;
// Exemple d'utilisation pour la méthode addPage
List pageContent = new ArrayList<>();
pageContent.add(new TextComponent("Page 1 Content"));
yourClass.addPage(pageContent);
// Exemple d'utilisation pour la méthode addCustomPage
List customPageContent = new ArrayList<>();
customPageContent.add(new TextComponent("Custom Page Content"));
yourClass.addCustomPage(customPageContent);
// Exemple d'utilisation pour la méthode navigMenu
Entity playerEntity = Minecraft.getInstance().player;
Component navMenu = yourClass.navigMenu(playerEntity);
// Exemple d'utilisation pour la méthode display
CommandSourceStack source = /* obtenir le source */;
Entity player = Minecraft.getInstance().player;
yourClass.display(source, player);
// Exemple d'utilisation pour la méthode pagesList
yourClass.pagesList(source);
// Exemple d'utilisation pour la méthode createText
Component textComponent = yourClass.createText("Click me!", "Hover Text", "openPage", "page1", player);
// Exemple d'utilisation pour la méthode modifyText
Component existingText = /* obtenir le composant existant */;
Component updatedText = yourClass.modifyText(existingText, "New Text", "New Hover Text", "openPage", "page2", player);
// Exemple d'utilisation pour la méthode logAllList
yourClass.logAllList();
// Exemple d'utilisation pour la méthode logPagesCount
yourClass.logPagesCount(true);
// Exemple d'utilisation pour la méthode setPlayerPage
Entity playerEntity = Minecraft.getInstance().player;
yourClass.setPlayerPage(playerEntity, 2);
// Exemple d'utilisation pour la méthode getPlayerPage
double currentPage = yourClass.getPlayerPage(playerEntity, 1);
This class handles pagination and displaying text across pages for the TetraLibs mod. It allows you to add pages, navigate them and personalize the actions on each displayed text.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
pagesCount |
Total number of pages in the pages list. This static variable is initialized with the current size of the pages collection, representing the number of elements (pages) stored. It is dynamically updated each time the pages collection is modified, ensuring the correct value for the total number of pages.
|
|
|
addPage | Adds a page to the standard pages list. |
‣ content ( |
|
addCustomPage | Adds a page to the custom pages list. |
‣ content ( |
|
navigMenu | Creates a component representing a navigation menu with buttons for the previous and next page. |
‣ entity ( |
|
display | Displays the current page to a player. |
‣ source ( ‣ entity ( |
|
pagesList | Displays the list of available pages to the player. |
‣ source ( |
|
createText |
Creates a text component with hover and click events configured. |
‣ text ( ‣ hoverText ( ‣ clickAction ( ‣ clickValue ( ‣ entity ( |
|
Variant without the entity argument. Parameters: ‣ text ( ‣ hoverText ( ‣ clickAction ( ‣ clickValue ( Returns |
|||
modifyText | Modifies an existing text component by adding hover and click actions. |
‣ component ( ‣ text ( ‣ hoverText ( ‣ clickAction ( ‣ clickValue ( ‣ entity ( |
|
logAllList | Logs the actions and hover events for logs. |
|
|
logPagesCount |
Logs the number of pages and distinguishes between standard and custom pages. |
‣ edited ( |
|
Variant without the edited argument. Returns |
|||
setPlayerPage | Updates the player's page. |
‣ entity ( ‣ num ( |
|
getPlayerPage | Retrieves the current page of the player. |
‣ entity ( ‣ num ( |
Exemple of Use
// Exemple of use for TetraPage :
// Example usage for pagesCount method
int totalPages = yourClass.pagesCount;
// Example usage for addPage method
List pageContent = new ArrayList<>();
pageContent.add(new TextComponent("Page 1 Content"));
yourClass.addPage(pageContent);
// Example usage for addCustomPage method
List customPageContent = new ArrayList<>();
customPageContent.add(new TextComponent("Custom Page Content"));
yourClass.addCustomPage(customPageContent);
// Example usage for navigMenu method
Entity playerEntity = Minecraft.getInstance().player;
Component navMenu = yourClass.navigMenu(playerEntity);
// Example usage for display method
CommandSourceStack source = /* get the source */;
Entity player = Minecraft.getInstance().player;
yourClass.display(source, player);
// Example usage for pagesList method
yourClass.pagesList(source);
// Example usage for createText method
Component textComponent = yourClass.createText("Click me!", "Hover Text", "openPage", "page1", player);
// Example usage for modifyText method
Component existingText = /* get existing component */;
Component updatedText = yourClass.modifyText(existingText, "New Text", "New Hover Text", "openPage", "page2", player);
// Example usage for logAllList method
yourClass.logAllList();
// Example usage for logPagesCount method
yourClass.logPagesCount(true);
// Example usage for setPlayerPage method
Entity playerEntity = Minecraft.getInstance().player;
yourClass.setPlayerPage(playerEntity, 2);
// Example usage for getPlayerPage method
double currentPage = yourClass.getPlayerPage(playerEntity, 1);
Cette classe gère la pagination et l'affichage du texte à travers des pages pour le mod TetraLibs. Elle permet d'ajouter des pages, de les naviguer et de personnaliser les actions sur chaque texte affiché.
Méthodes Disponibles
Méthode | Description | Paramètre | Retour |
---|---|---|---|
pagesCount |
Nombre total de pages dans la liste pages . Cette variable statique est initialisée avec la taille actuelle de la collection pages , ce qui représente le nombre d'éléments (pages) stockés. Elle est mise à jour dynamiquement chaque fois que la collection pages est modifiée, assurant ainsi une valeur correcte du nombre total de pages.
|
|
|
addPage | Ajoute une page à la liste des pages standards. |
‣ content ( |
|
addCustomPage | Ajoute une page à la liste des pages personnalisées. |
‣ content ( |
|
navigMenu | Crée un composant représentant un menu de navigation avec les boutons pour la page précédente et la suivante. |
‣ entity ( |
|
display | Affiche la page actuelle pour un joueur. |
‣ source ( ‣ entity ( |
|
pagesList | Affiche la liste des pages disponibles au joueur. |
‣ source ( |
|
createText |
Crée un composant de texte avec des événements de survol et de clic configurés. |
‣ text ( ‣ hoverText ( ‣ clickAction ( ‣ clickValue ( ‣ entity ( |
|
Variante sans l'argument entity. Paramètres : ‣ text ( ‣ hoverText ( ‣ clickAction ( ‣ clickValue ( Retourne |
|||
modifyText | Modifie un composant de texte existant en lui ajoutant des actions de survol et de clic. |
‣ component ( ‣ text ( ‣ hoverText ( ‣ clickAction ( ‣ clickValue ( ‣ entity ( |
|
logAllList | Enregistre les actions et les événements de survol pour des logs. |
|
|
logPagesCount |
Enregistre le nombre de pages et la distinction entre pages standards et personnalisées. |
‣ edited ( |
|
Variante sans l'argument edited. Retourne |
|||
setPlayerPage | Met à jour la page du joueur. |
‣ entity ( ‣ num ( |
|
getPlayerPage | Récupère la page actuelle du joueur. |
‣ entity ( ‣ num ( |
Exemple d'Utilisation
// Exemple d'utilisation pour TetraPage :
// Exemple d'utilisation pour la méthode pagesCount
int totalPages = yourClass.pagesCount;
// Exemple d'utilisation pour la méthode addPage
List pageContent = new ArrayList<>();
pageContent.add(new TextComponent("Page 1 Content"));
yourClass.addPage(pageContent);
// Exemple d'utilisation pour la méthode addCustomPage
List customPageContent = new ArrayList<>();
customPageContent.add(new TextComponent("Custom Page Content"));
yourClass.addCustomPage(customPageContent);
// Exemple d'utilisation pour la méthode navigMenu
Entity playerEntity = Minecraft.getInstance().player;
Component navMenu = yourClass.navigMenu(playerEntity);
// Exemple d'utilisation pour la méthode display
CommandSourceStack source = /* obtenir le source */;
Entity player = Minecraft.getInstance().player;
yourClass.display(source, player);
// Exemple d'utilisation pour la méthode pagesList
yourClass.pagesList(source);
// Exemple d'utilisation pour la méthode createText
Component textComponent = yourClass.createText("Click me!", "Hover Text", "openPage", "page1", player);
// Exemple d'utilisation pour la méthode modifyText
Component existingText = /* obtenir le composant existant */;
Component updatedText = yourClass.modifyText(existingText, "New Text", "New Hover Text", "openPage", "page2", player);
// Exemple d'utilisation pour la méthode logAllList
yourClass.logAllList();
// Exemple d'utilisation pour la méthode logPagesCount
yourClass.logPagesCount(true);
// Exemple d'utilisation pour la méthode setPlayerPage
Entity playerEntity = Minecraft.getInstance().player;
yourClass.setPlayerPage(playerEntity, 2);
// Exemple d'utilisation pour la méthode getPlayerPage
double currentPage = yourClass.getPlayerPage(playerEntity, 1);
This class handles pagination and displaying text across pages for the TetraLibs mod. It allows you to add pages, navigate them and personalize the actions on each displayed text.
Available Methods
Method | Description | Parameter | Return |
---|---|---|---|
pagesCount |
Total number of pages in the pages list. This static variable is initialized with the current size of the pages collection, representing the number of elements (pages) stored. It is dynamically updated each time the pages collection is modified, ensuring the correct value for the total number of pages.
|
|
|
addPage | Adds a page to the standard pages list. |
‣ content ( |
|
addCustomPage | Adds a page to the custom pages list. |
‣ content ( |
|
navigMenu | Creates a component representing a navigation menu with buttons for the previous and next page. |
‣ entity ( |
|
display | Displays the current page to a player. |
‣ source ( ‣ entity ( |
|
pagesList | Displays the list of available pages to the player. |
‣ source ( |
|
createText |
Creates a text component with hover and click events configured. |
‣ text ( ‣ hoverText ( ‣ clickAction ( ‣ clickValue ( ‣ entity ( |
|
Variant without the entity argument. Parameters: ‣ text ( ‣ hoverText ( ‣ clickAction ( ‣ clickValue ( Returns |
|||
modifyText | Modifies an existing text component by adding hover and click actions. |
‣ component ( ‣ text ( ‣ hoverText ( ‣ clickAction ( ‣ clickValue ( ‣ entity ( |
|
logAllList | Logs the actions and hover events for logs. |
|
|
logPagesCount |
Logs the number of pages and distinguishes between standard and custom pages. |
‣ edited ( |
|
Variant without the edited argument. Returns |
|||
setPlayerPage | Updates the player's page. |
‣ entity ( ‣ num ( |
|
getPlayerPage | Retrieves the current page of the player. |
‣ entity ( ‣ num ( |
Exemple of Use
// Exemple of use for TetraPage :
// Example usage for pagesCount method
int totalPages = yourClass.pagesCount;
// Example usage for addPage method
List pageContent = new ArrayList<>();
pageContent.add(new TextComponent("Page 1 Content"));
yourClass.addPage(pageContent);
// Example usage for addCustomPage method
List customPageContent = new ArrayList<>();
customPageContent.add(new TextComponent("Custom Page Content"));
yourClass.addCustomPage(customPageContent);
// Example usage for navigMenu method
Entity playerEntity = Minecraft.getInstance().player;
Component navMenu = yourClass.navigMenu(playerEntity);
// Example usage for display method
CommandSourceStack source = /* get the source */;
Entity player = Minecraft.getInstance().player;
yourClass.display(source, player);
// Example usage for pagesList method
yourClass.pagesList(source);
// Example usage for createText method
Component textComponent = yourClass.createText("Click me!", "Hover Text", "openPage", "page1", player);
// Example usage for modifyText method
Component existingText = /* get existing component */;
Component updatedText = yourClass.modifyText(existingText, "New Text", "New Hover Text", "openPage", "page2", player);
// Example usage for logAllList method
yourClass.logAllList();
// Example usage for logPagesCount method
yourClass.logPagesCount(true);
// Example usage for setPlayerPage method
Entity playerEntity = Minecraft.getInstance().player;
yourClass.setPlayerPage(playerEntity, 2);
// Example usage for getPlayerPage method
double currentPage = yourClass.getPlayerPage(playerEntity, 1);