Explaination Tutorial Script [FR]

French version of Example Script which means it will make you how to begin Lua Script with minimum knowledge.

Version français pour bien commencer dans le domaine du Lua. Vous êtes débutant mais vous ne savez pas où par commencer, bien joué.

Je ne vais pas vous mâcher avec des termes compliqués ou sinon vous n'allez rien comprendre, pensez à votre mémoire, comme le dit: "Percevoir finit par n’etre plus qu’une occasion de se souvenir".

Il ne faut pas s'inquiéter des termes compliqués ou bizarres, il faut savoir comprendre et à quoi peut-elle servir. Les sites utiles pour comprendre les Lua & Natives.

Commencons par définir ce que c'est un Lua.

• Un Lua est un langage de programmation de scripts léger, extensible et puissant. Il a été conçu pour être utilisé comme langage de script pour les applications, offrant une syntaxe simple mais expressive, ainsi qu'une performance élevée et une faible empreinte mémoire. Lua est un langage interprété qui peut être utilisé pour une grande variété de tâches, telles que l'écriture de scripts système, le développement de jeux, l'analyse de données et la création de programmes pour les périphériques embarqués. Il prend en charge la programmation impérative, fonctionnelle et orientée objet, et dispose d'une grande bibliothèque standard.

Et sinon c'est quoi Pluto ?

• Pluto est une version dérivée du langage de programmation Lua 5.4. Lua est conçu pour être un langage petit, rapide et intégrable. Il est très souvent utilisé dans les jeux et les régions à ressources limitées. Lua se heurte cependant à la nécessité de rester petit, car il manque de fonctionnalités d'usage général. Cette contrainte sur le langage rend difficile la production de scripts complexes à un rythme accéléré. Il faut plus de temps pour mettre en place des alternatives pour la syntaxe manquante, ou pour écrire vos propres fonctions manuelles pour diviser les chaînes de caractères.

Tutoriel complet en anglais: GitHub StandAPI Keramis (en anglais)

• nativeDB
• Stand API
• Docs FiveM Natives

Démarrage du script

Il est facile d'allumer le script, imaginons dans un cas, tu crées un lua script sans rien mettre, le lua script va nettement s'arrêter. Alors utilise ceci si tu ne veux pas que le lua script se retrouve stoppé. Vous pouvez placer soit au début du lua script ou à la fin selon vos préférences.

util.keep_running()

Les natives

Imaginons dans un cas, vous voulez faire du n'importe quoi dans votre Lua Script et que vous aurez besoin d'exploiter, exploiter les natives vous servent d'indication et comment le paramétrer. Attention: il faut vérifier que ça soit la dernière version. Des natives dans une liste interminable, vous pouvez les retrouver via "Lua Scripts/lib" et tout les noms commencent par "natives-".

Ce sont des exemples de natives dans Stand.

natives-1606100775
natives-1627063482

Et une liste interminable, vous comprenez, utiliser spécifiquement à vos besoins.

Mais comment les intégrer? Selon vos besoins, vous allez besoin d'avoir de "util.require_natives"

util.require_natives(1663599433) 

Ou soit (version longue), cela revient à la même chose:

util.requires_natives("natives-1663599433")

Les menus

Il existe différents types de menus dans le Lua Script de Stand.

Le menu root est la partie la plus essentielle et obligatoire dans un Lua Script, dirais-je pourquoi? Elle permet d'initialiser la visualisation des menus affichés, imaginons vous voulez afficher la liste "Armes", "Troll", etc..., il est facile de le faire. Vous aurez besoin de: menu.my_root()

Exemple concret:

local root = menu.my_root()

Le menu joueur est la partie la moins essentielle dans un Lua Script, dirais-je pourquoi? Elle est optionelle si dans vos besoins, vous n'avez pas besoin de la partie joueur si vous vous contentez à créer des projets externes tels que les Recovery, des luas scripts utilitaires ne mettant pas en relation avec les joueurs, il faut aborder comment l'utiliser. Vous aurez besoin de : menu.player_root(). On reviendra de suite comment faire fonctionner la partie joueur

Exemple concret:

players.on_join(function(pid) -- "pid" cible spécifiquement le joueur.
    local playeroot = menu.player_root(pid)
end)

Partie essentiels du Lua Script

Les boutons actions (menu.action)

Vous voulez créer une catégorie type "action" en pressant un bouton, catégorie "liste" pour cliquer et trouver autre chose, "slider", etc..., elles peuvent vous servir.

Commençons par initialiser une nouvelle variable dont on intégrera menu.my_root().

local mon_menu = menu.my_root()

Maintenant, tu veux créer une catégorie "action" pour boutton Pour comprendre, mon_menu désigle commandRef, par défaut, c'est: menu.my_root(), entre crochet désigne le nom de la commande, t'en a déjà vu passer des noms de commandes dans le mod menu Stand tel que "bottomless", "fillammo"..., c'est le même principe, crée ta propre commande. La troisième argument entre guillemet désigne la description de l'action/liste, etc... pour savoir c'est quoi au juste.

Attention: Les commandes entre crochets ne doit pas contenir d'espaces, comme ça: {"crack test"}

Premier exemple (sans la variable mon_menu intégré)

menu.action(menu.my_root(), "Salut", {"salut1"}, "Description 1", function()
  util.toast("Salut, c'est mon premier Lua Script")
end)

Second exemple (avec la variable mon_menu intégré)

local mon_menu = menu.my_root()

menu.action(mon_menu, "Salut", {"salut1"}, "Description 1", function()
  util.toast("Salut, c'est mon premier Lua Script")
end)

Dernier exemple (avec la variable mon_menu intégré)

local mon_menu = menu.my_root()

mon_menu:action("Salut", {"salut1"}, "Description 1", function()
  util.toast("Salut, c'est mon premier Lua Script")
end)

Le bouton liste (menu.list)

Vous comprendrez pourquoi les exemples sont différents, c'est selon votre choix comment vous voulez soit laisser le code par défaut, soit donner quelque chose d'esthétique, simpliste ou clean.

Tu veux créer une liste qui permet de catégoriser certains types de fonctions/options, etc... ? Même exemple, on utilisera menu.list(commandRef, "Nom", {"commande"}, "Description", function()end) pour faire fonctionner, on utilisera la variable qu'on a crée dont mon_menu. L'exemple à suivre, j'ai crée une autre variable dont elle va être en redirection de la catégorie qu'on souhaite voir par exemple Salut dans la catégorie. Elle s'applique à m'importe quel type de "menu.", peu importe.

Premier Exemple

local mon_menu = menu.my_root()

local CategorieSuivant = menu.list(mon_menu, "Message Test") -- Vous n'avez pas besoin de rajouter d'autres éléments, ceci est optionelle.

menu.action(CategorieSuivant, "Salut", {"salut1"}, "Description 1", function() -- On a ajouté CategorieSuivant pour ça.
  util.toast("Salut, c'est mon premier Lua Script")
end)

Deuxième Exemple

local mon_menu = menu.my_root()

local CategorieSuivant = menu.list(mon_menu, "Message Test") -- Vous n'avez pas besoin de rajouter d'autres éléments, ceci est optionelle.

CategorieSuivant:action("Salut", {"salut1"}, "Description 1", function() -- On a ajouté CategorieSuivant au début au détriment de "menu." pour ça.
  util.toast("Salut, c'est mon premier Lua Script")
end)

Exemples en image:

Les boutons boucles finis (menu.toggle) / infinies (menu.toggle_loop)

Passons à autre chose, les boucles, il existe deux types de boucles:

• les boucles finies, qui se finit direct comme le dit son nom avec: menu.toggle(commandref, "nom", {"command"}, "description", function() end)
• les boucles infinies, qui se finit jamais, repérable avec: menu.toggle_loop(commandRef, "nom", {"cmd"}, "desc", function()end)

Premier exemple (Boucle fini)

local mon_menu = menu.my_root()

menu.toggle(mon_menu, "Vérifier si il y'a des chiottes", {"chiottetoggle"}, "description 1", function(toggle) -- Dans un cas précis, vous voulez "toggle", alors vous pouvez, nommer le peu importe, toggled, f, on, etc... Soyez créatif en tt cas.
    if toggle then 
        util.toast("Les chiottes sont présents à Los Santos")
    else -- vous donnez une autre condition si elle s'arrête, en gros, vous le désactiver, il affiche qqch
        util.toast("Arrêt des recherches de chiottes")
    end
end)

Boucle.fini.mp4

Second exemple (Boucle infini)

local mon_menu = menu.my_root()

menu.toggle_loop(mon_menu, "Vérifier si il y'a des chiottes", {"chiottes"}, "description 1", function() -- Dans un cas précis, vous n'avez pas besoin de "toggle" comme dans l'autre, il est en boucle.
    util.toast("Les chiottes sont présents à Los Santos") -- affiche en permanence le message suivant.
end, function()
    util.toast("Arrêt des recherches de chiottes")
end)

Boucle.infini.mp4

Partie optionel du Lua Scripts

Faire apparaitre une entité (véhicule/ped...)

Tout d'abord, on va commencer par créer une fonction dont on utilisera à partir du site de Stand.gg en premier lieu. C'est à vous de voir mais cela évite de copier toujours la même chose util.request_model(hash, miliseconds) à chaque fois, c'est optionel.

function EntityRequest(hash, msc)
    util.request_model(hash, msc)
end

Apparaitre une entité (Ped)

---

Pour faire apparaitre un ped, nous allons utiliser entities.create_ped(int type, int hash, Vector3 pos, number heading) et d'utiliser la localisation exacte du joueur en question dont players.user_ped().

Exemple

local mon_menu = menu.my_root()

function EntityRequest(hash, msc)
    util.request_model(hash, msc)
end

menu.action(mon_menu, "Faire apparaitre un Singe", {''}, 'Faites moi apparaitre un singe', function()
    local hash = util.joaat('a_c_chimp')
    EntityRequest(hash, 2000)
    local pos = ENTITY.GET_ENTITY_COORDS(players.user_ped())
    entities.create_ped(1, hash, pos, 0)
    -- PED.CREATE_PED(1, hash, pos.x, pos.y, pos.z, 0, true, true), c'est la même chose.
end)

Summon.Ped.mp4

Apparaitre une entité (Véhicule)

---

Pour faire apparaitre un véhicule, même exemple que le précédent mais tout change: entities.create_vehicle(int hash, Vector3 pos, number heading) et d'utiliser la localisation exacte du joueur en question dont players.user_ped().

Premier exemple (apparition fixe de la position du joueur)

local mon_menu = menu.my_root()

function EntityRequest(hash, msc)
    util.request_model(hash, msc)
end

menu.action(mon_menu, "Faire apparaitre une Adder", {''}, 'Faites moi apparaitre un véhicule', function()
    local hash = util.joaat('adder')
    EntityRequest(hash, 2000)
    local pos = ENTITY.GET_ENTITY_COORDS(players.user_ped())
    entities.create_vehicle(hash, pos, 0)
    -- VEHICLE.CREATE_VEHICLE(hash, pos.x, pos.y, pos.z, 0, true, true, false)
end)

Vehicle1.mp4

Deuxième exemple (apparition éloigné de la position du joueur)

local mon_menu = menu.my_root()

function EntityRequest(hash, msc)
    util.request_model(hash, msc)
end

menu.action(mon_menu, "Faire apparaitre une Adder", {''}, 'Faites moi apparaitre un véhicule', function()
    local hash = util.joaat('adder')
    EntityRequest(hash, 2000)
    local ped = players.user_ped()
    local pos = ENTITY.GET_OFFSET_FROM_ENTITY_IN_WORLD_COORDS(ped, 0.0, 5.0, 0.0) -- On change de native pour cela.
    entities.create_vehicle(hash, pos, 0)
    -- VEHICLE.CREATE_VEHICLE(hash, pos.x, pos.y, pos.z, 0, true, true, false)
end)

Veh2.mp4

Troisième exemple (apparition du véhicule, par commande)

local mon_menu = menu.my_root()

function EntityRequest(hash, msc)
    util.request_model(hash, msc)
end

menu.action(mon_menu, "Apparaitre un véhicule modèle", {'fairespawn'}, 'Faites moi apparaitre un véhicule', function(type)
    menu.show_command_box_click_based(type, "fairespawn ")
end, function(argument) 
    local hash = util.joaat(argument)
    EntityRequest(hash, 2000)
    local ped = players.user_ped()
    local c = ENTITY.GET_OFFSET_FROM_ENTITY_IN_WORLD_COORDS(ped, 0.0, 5.0, 0.0) 
    entities.create_vehicle(hash, c, 0)
end)

Vehicle3.mp4

Autre exemple mais vous voulez afficher un message d'erreur si le modèle du véhicule est invalide. Intégrons STREAMING.IS_MODEL_A_VEHICLE(modelVeh) pour vérifier si le véhicule est reconnu ou pas.

local mon_menu = menu.my_root()

function EntityRequest(hash, msc)
    util.request_model(hash, msc)
end

menu.action(mon_menu, "Apparaitre un véhicule modèle (Condition)", {'fairespawn2'}, 'Faites moi apparaitre un véhicule', function(type)
    menu.show_command_box_click_based(type, "fairespawn2 ")
end, function(argument) 
    local hash = util.joaat(argument)
    if STREAMING.IS_MODEL_A_VEHICLE(hash) then 
        EntityRequest(hash, 2000)
        local ped = players.user_ped()
        local c = ENTITY.GET_OFFSET_FROM_ENTITY_IN_WORLD_COORDS(ped, 0.0, 5.0, 0.0) 
        entities.create_vehicle(hash, c, 0)
    else
        util.toast("Le véhicule que vous avez écrit: "..argument.." n'est pas reconnu.")
    end
end)

Vehicle4.mp4

Les menus joueurs

Commençons par créer ça:

players.on_join(function(pid) -- vous pouvez nommer m'importe comment "pid" soit par playerPid, PlayerID, etc... Soyez créatifs.
    -- Intègre le code à l'intérieur
end)

Normalement, rien se passe, vous voulez ajouter un bouton menu dans la partie du joueur spécifique, il est possible. Il faut que menu.player_root() soit intégré à l'intérieur players.on_join(function(...)end)

players.on_join(function(pid) 
    local playerMenu = menu.player_root(pid) -- attention, obligatoirement mettre le target ID du joueur en question.
    menu.divider(playerMenu, "Mon Lua Script")
end)

Vous allez me dire pourquoi le menu n'affiche pas la colonne divider "Mon Lua Script"

Ajouter en premier temps la partie à la fin:

players.dispatch_on_join()
players.on_leave(function()end)

Exemple

players.on_join(function(pid) 
    local playerMenu = menu.player_root(pid) -- attention, obligatoirement mettre le target ID du joueur en question.
    menu.divider(playerMenu, "Mon Lua Script")
end)

players.dispatch_on_join()
players.on_leave(function()end)

Il va permettre d'afficher la partie que vous souhaitez la visualiser.