🎒Module Item (Client & Shared)

Le module Item permet la gestion complète des objets dans le framework Eko. Il gère les objets standards, utilisables, les armes, les munitions ainsi que les objets plaçables côté client.


📦 API

Eko.Item.Get(name)

Récupère la définition d’un item à partir de son nom.

  • Paramètres

    • name (string): Nom de l’item.

  • Retour

    • table: Les données de l’item.


Eko.Item.Create(name, metadata, quantity, slot)

Crée une instance d’item avec ses métadonnées, quantité et slot.

  • Paramètres - name (string): Nom de l’item. - metadata (table): Données dynamiques associées. - quantity (number): Quantité. - slot (string | number): Slot d’inventaire.

  • Retour - Item: L’instance créée, ou nil si l’item n’existe pas.


Eko.Item.RegisterUsable(name, cb, type?) -- Coté client uniquement

Rend un item utilisable via une fonction personnalisée.

  • Paramètres

    • name (string): Nom de l’item.

    • cb (function): Fonction appelée lors de l’utilisation. Doit retourner true pour consommer 1 unité.

    • type (string, optionnel): "ground" si l’item doit être utilisé à une position spécifique.


Vérifie si un item est utilisable.

  • Paramètres

    • name (string): Nom de l’item.

  • Retour

    • boolean: true si l’item est utilisable.


Déclenche l’utilisation de l’item si celui-ci est déclaré utilisable.

  • Paramètres

    • item (Item): L’item à utiliser.

    • entity (integer, optionnel): Entité concernée.

    • coords (vector3, optionnel): Position.

  • Retour

    • boolean: true si l’item est consommable, false sinon.


Déclare un item comme une arme utilisable.

  • Paramètres

    • name (string): Nom de l’item.

    • model (string): Hash du modèle d’arme.

    • ammo (string): Nom de la munition associée.


Vérifie si un item est une arme.

  • Paramètres

    • name (string): Nom de l’item.

  • Retour

    • boolean: true si l’item est une arme.


Vérifie si un item est une munition.

  • Paramètres

    • name (string): Nom de l’item.

  • Retour

    • boolean: true si l’item est une munition.


Retourne le nom d’un item arme à partir de son hash.

  • Paramètres

    • model (string): Hash du modèle.

  • Retour

    • string: Nom de l’item arme.


Retourne le nom de la munition associée à un modèle d’arme.

  • Paramètres

    • model (string): Hash du modèle.

  • Retour

    • string: Nom de l’item munition.


Permet de déclarer un objet plaçable dans le monde.

  • Paramètres

    • name (string): Nom de l’item.

    • model (string): Modèle du prop.


🛠️ Exemple d’utilisation


⚠️ Notes

  • Ces méthodes sont principalement disponibles côté client.

  • L’utilisation est protégée par un anti-spam interne.

Last updated