InventoryUtils

InventoryUtils

Quelques fonctions permettant d'interagir correctement avec l'inventaire des joueurs.

Retirer un/des objet(s)

La fonction ${\color{NavyBlue}\normalsize{\textsf{RemoveFromInventory(Player player, int itemId, int quantity)}}}$ permet de retirer un objet selon la quantité transmise en paramètre.

Voici les paramètres de cette fonction.

• ${\color{Goldenrod}\normalsize{\textsf{player}}}$ : Instance de joueur dont l'inventaire sera modifié.
• ${\color{Goldenrod}\normalsize{\textsf{itemId}}}$ : L'identifiant de l'objet à supprimer.
• ${\color{Goldenrod}\normalsize{\textsf{quantity}}}$ : La quantité de l'objet à supprimer.

//Dans cette exemple, nous allons retirer 50 pierres (29 étant l'ID de l'objet "pierre")
InventoryUtils.RemoveFromInventory(player, 29, 50);

Ajouter un/des objet(s)

La fonction ${\color{NavyBlue}\normalsize{\textsf{AddItem(Player player, int itemId, int quantity)}}}$ permet d'ajouter un objet selon la quantité transmise en paramètre.
Sa particularité réside dans le fait qu'elle fait appel à la fonction utilitaire ${\color{NavyBlue}\normalsize{\textsf{ApplyItemData(int itemId)}}}$ situé dans ItemUtils.

Voici les paramètres de cette fonction.

• ${\color{Goldenrod}\normalsize{\textsf{player}}}$ : Instance de joueur dont l'inventaire sera modifié.
• ${\color{Goldenrod}\normalsize{\textsf{itemId}}}$ : L'identifiant de l'objet à ajouter.
• ${\color{Goldenrod}\normalsize{\textsf{quantity}}}$ : La quantité de l'objet à ajouter.

//Dans cette exemple, nous allons ajouter 50 pierres (29 étant l'ID de l'objet "pierre")
//Si le joueur ne possède pas suffisamment d'espace, la fonction renvoie FALSE 
InventoryUtils.AddItem(player, 29, 50)

Ouvrir l'inventaire d'un joueur

La fonction ${\color{NavyBlue}\normalsize{\textsf{TargetOpenPlayerInventory(Player player, Player target)}}}$ permet d'ouvrir l'inventaire d'un joueur à proximité.

Voici les paramètres de cette fonction.

• ${\color{Goldenrod}\normalsize{\textsf{player}}}$ : Instance du joueur qui ouvrira l'inventaire.
• ${\color{Goldenrod}\normalsize{\textsf{target}}}$ : Instance du joueur cible dont l'inventaire sera ouvert.

InventoryUtils.TargetOpenPlayerInventory(player, target)

Vérifier si l'inventaire contient l'objet

La fonction ${\color{NavyBlue}\normalsize{\textsf{CheckInventoryContainsItem(Player player, int itemId, int quantity)}}}$ vérifie si le joueur a une quantité spécifiée d'un objet spécifique dans son inventaire.

Voici les paramètres de cette fonction.

• ${\color{Goldenrod}\normalsize{\textsf{player}}}$ : Instance du joueur dont l'inventaire sera vérifié.
• ${\color{Goldenrod}\normalsize{\textsf{itemId}}}$ : ID de l'élément à vérifier.
• ${\color{Goldenrod}\normalsize{\textsf{quantity}}}$ : La quantité requise de l'article.

//vérifie si le joueur en paramètre possède 15 nuggets
CheckInventoryContainsItem(player, 2, 15)

Retourner l'inventaire du joueur

La fonction ${\color{NavyBlue}\normalsize{\textsf{ReturnPlayerInventory(Player player)}}}$ renvoie l'inventaire du joueur sous forme de dictionnaire, les clés étant les identifiants des objets et les valeurs représentant leurs quantités.

Voici les paramètres de cette fonction.

• ${\color{Goldenrod}\normalsize{\textsf{player}}}$ : Instance du joueur.

Dictionary<int, int> playerInventory = ReturnPlayerInventory(Player player);