Skip to main content

Export

Documentation pour la fonction getEmoteList​

Description​

La fonction getEmoteList retourne la liste des émotes disponibles, qui sont stockées dans RP.Emotes. Cette fonction permet d'accéder à toutes les émotes définies sur le serveur ou le client pour une utilisation dans les scripts ou les menus.

Syntaxe​

exports("getEmoteList", function()
    return RP.Emotes
end)

Retour​

La fonction renvoie un tableau (table) qui contient toutes les émotes disponibles. Chaque entrée du tableau représente une émote avec son nom ou ses informations associées.

Exemple d'utilisation​

  1. Récupérer la liste des émotes et l'afficher :
local emote_list = exports["gw-emote"]:getEmoteList()

-- Parcourt et affiche toutes les émotes disponibles
for i, emote in ipairs(emote_list) do
    print("Emote " .. i .. ": " .. emote.name)
end
  1. Afficher les émotes dans un menu interactif :
local emote_list = exports["gw-emote"]:getEmoteList()

-- Simuler un menu pour afficher les émotes disponibles
for i, emote in ipairs(emote_list) do
    print("Appuyez sur " .. i .. " pour jouer l'émote: " .. emote.name)
end
  1. Utiliser une émote spécifique à partir de la liste :
local emote_list = exports["gw-emote"]:getEmoteList()

-- Utilise la première émote de la liste
local first_emote = emote_list[1]

-- Déclencher l'émote avec une autre fonction (exemple)
TriggerEvent("playEmote", first_emote.name)

Détails supplémentaires​

  • RP.Emotes est une table qui contient toutes les émotes disponibles sur le serveur. Chaque entrée peut inclure des informations comme le nom de l'émote, la catégorie, ou d'autres détails utiles.
  • Cette fonction peut être utilisée dans un contexte client pour afficher un menu d'émotes ou permettre aux joueurs d'accéder à des émotes via des commandes.

Documentation pour la fonction getDanceList​

Description​

La fonction getDanceList permet de récupérer la liste des danses disponibles, stockées dans RP.Dances. Elle fournit un moyen simple d'accéder aux animations de danse configurées dans le script, que ce soit pour les utiliser dans un menu ou via d'autres fonctionnalités.

Syntaxe​

exports("getDanceList", function()
    return RP.Dances
end)

Retour​

La fonction retourne un tableau (table) contenant toutes les danses définies dans RP.Dances. Chaque entrée du tableau représente une danse avec son nom ou d'autres informations associées.

Exemple d'utilisation​

  1. Récupérer et afficher la liste des danses :
local dance_list = exports["gw-emote"]:getDanceList()

-- Parcourt et affiche toutes les danses disponibles
for i, dance in ipairs(dance_list) do
    print("Danse " .. i .. ": " .. dance.name)
end
  1. Créer un menu interactif pour les danses :
local dance_list = exports["gw-emote"]:getDanceList()

-- Simule un menu pour afficher et choisir une danse
for i, dance in ipairs(dance_list) do
    print("Appuyez sur " .. i .. " pour choisir la danse : " .. dance.name)
end
  1. Utiliser une danse spécifique à partir de la liste :
local dance_list = exports["gw-emote"]:getDanceList()

-- Utilise la première danse de la liste
local first_dance = dance_list[1]

-- Déclencher la danse avec une autre fonction (exemple)
TriggerEvent("playDance", first_dance.name)

Détails supplémentaires​

  • RP.Dances est une table qui contient les danses disponibles. Chaque entrée peut inclure des informations comme le nom de la danse, sa catégorie, ou d'autres détails utiles.
  • Cette fonction est principalement utilisée côté client pour permettre aux joueurs d'accéder à des danses via des menus ou des commandes.

Documentation pour la fonction playEmoteByNames​

Description​

La fonction playEmoteByNames permet de jouer une émote spécifique en utilisant son nom. Elle est utilisée pour déclencher une animation (émote) directement via son nom défini dans le système.

Syntaxe​

exports("playEmoteByNames", function(emoteName)
    playEmoteByNames(emoteName)
end)

Paramètre​

  • emoteName (string) : Le nom de l'émote à jouer. Ce nom doit correspondre à une émote valide définie dans le système.

Exemple d'utilisation​

  1. Jouer une émote spécifique :
exports["gw-emote"]:playEmoteByNames("wave")

Cet exemple joue l'émote nommée wave (faire un signe de la main).

  1. Jouer une émote depuis une entrée utilisateur :
local emoteName = "dance"
exports["gw-emote"]:playEmoteByNames(emoteName)

Dans cet exemple, l'émote dance est jouée, en fonction de la chaîne de caractères définie dans emoteName.

  1. Exemple avec un menu d'émotes :
local emote_list = exports["gw-emote"]:getEmoteList()

-- Boucle sur les émotes disponibles
for i, emote in ipairs(emote_list) do
    print("Appuyez sur " .. i .. " pour jouer l'émote : " .. emote.name)
end

-- Imaginons que l'utilisateur sélectionne la première émote
exports["gw-emote"]:playEmoteByNames(emote_list[1].name)

Détails supplémentaires​

  • La fonction playEmoteByNames(emoteName) est appelée en interne et permet de jouer l'animation associée au nom d'émote fourni.
  • Cette fonction est principalement utilisée pour simplifier le déclenchement d'émotes par nom, notamment via des menus ou des commandes.

Documentation pour la fonction clientOpenMenu​

Description​

La fonction clientOpenMenu permet d'ouvrir un menu côté client en déclenchant directement la fonction clientOpenMenu().

Syntaxe​

exports("clientOpenMenu", function()
    clientOpenMenu()
end)

Retour​

Cette fonction ne retourne aucune valeur, elle est uniquement utilisée pour ouvrir un menu client.

Exemple d'utilisation​

  1. Ouvrir le menu à partir d'un autre script :
exports["gw-emote"]:clientOpenMenu()
  1. Utilisation avec une commande :
RegisterCommand("openMenu", function()
    exports["gw-emote"]:clientOpenMenu()
end, false)

Dans cet exemple, l'utilisateur peut taper la commande /openMenu pour ouvrir le menu.

Documentation pour la fonction cancelEmote​

Description​

La fonction cancelEmote permet d'annuler l'émote actuellement en cours pour un joueur. Si l'émote en cours a une option de sortie (ExitEmote), cette dernière est jouée avant d'annuler l'émote. Ensuite, les tâches du joueur sont effacées et tous les objets associés à l'émote sont détruits.

Syntaxe​

exports("cancelEmote", function()
    if not current_emote then return end
    if current_emote.AnimationOptions.ExitEmote then 
        EmoteToPlay = RP.Exits[current_emote.AnimationOptions.ExitEmote]
        playEmote(PlayerPedId(), EmoteToPlay[1], EmoteToPlay[2], EmoteToPlay.AnimationOptions, EmoteToPlay[3])
        ClearPedTasks(PlayerPedId())
        DestroyAllProps(PlayerPedId())
        current_emote = nil
        return
    end
end)

Fonctionnement​

  1. Vérification de l'émote actuelle : Si aucune émote n'est en cours, la fonction ne fait rien.
  2. Vérification des options de sortie (ExitEmote) : Si l'émote en cours dispose d'une option de sortie, elle est jouée avant d'annuler l'émote.
  3. Effacement des tâches et destruction des objets :
    • Les tâches du joueur sont effacées avec ClearPedTasks.
    • Tous les objets associés à l'émote sont détruits avec DestroyAllProps.
  4. Réinitialisation de l'émote : La variable current_emote est mise à nil, indiquant qu'il n'y a plus d'émote active.

Exemple d'utilisation​

  1. Annuler l'émote actuelle :
exports["gw-emote"]:cancelEmote()

Ce code annule l'émote en cours pour le joueur, en jouant l'option de sortie si elle existe, puis en effaçant toutes les tâches et les objets associés.

Détails supplémentaires​

  • ExitEmote : Si l'émote a une animation de sortie définie, celle-ci sera jouée avant l'annulation complète de l'émote.
  • ClearPedTasks et DestroyAllProps : Ces fonctions sont utilisées pour s'assurer que le joueur ne conserve aucune animation ou objet après l'annulation de l'émote.

Documentation pour la fonction getCurrentEmote​

Description​

La fonction getCurrentEmote renvoie les informations sur l'émote actuellement en cours, avec deux valeurs spécifiques : lib et dict. Le premier élément est la bibliothèque ou l'animation liée à l'émote, et le second élément est un dictionnaire ou des options associées à l'émote.

Syntaxe​

exports("getCurrentEmote", function()
    return {current_emote[1], current_emote[2]}
end)

Retour​

La fonction renvoie une table avec deux éléments :

  • current_emote[1] : La lib (bibliothèque) associée à l'émote en cours, utilisée pour jouer l'animation.
  • current_emote[2] : Le dict (dictionnaire) ou les options associées à l'émote actuelle, qui peuvent contenir des informations supplémentaires sur l'animation ou son comportement.

Exemple d'utilisation​

  1. Récupérer et afficher la lib et le dict de l'émote actuelle :
local emote_info = exports["gw-emote"]:getCurrentEmote()

-- Affiche la lib (bibliothèque) et le dict (options)
print("Lib : " .. tostring(emote_info[1]))
print("Dict : " .. tostring(emote_info[2]))

Détails supplémentaires​

  • Lib (current_emote[1]) : Représente la bibliothèque ou l'animation de base utilisée pour l'émote.
  • Dict (current_emote[2]) : Contient des informations supplémentaires ou des paramètres liés à l'émote, comme des options d'animation.

Cette version reflète le fait que current_emote[1] correspond à la lib et current_emote[2] au dict.