Armes et outils en Lua

Écrire des armes entièrement en Lua (les SWEP de Garry's Mod), jeter et ramasser des armes au sol, créer des outils de toolgun (les STOOL) avec leur panneau de réglages, et contrôler le toolgun, le physgun et la touche E avec des hooks.

Armes en Lua (SWEP)

Où les écrire

Ces fichiers sont chargés côté serveur et côté client : le serveur fait les dégâts, le client donne le retour immédiat (son, traçantes, animation, chargeur affiché). Pendant le chargement, la table globale SWEP est prête (avec SWEP.Primary = {} et SWEP.Secondary = {}) ; la classe est le nom du fichier sans .lua, en minuscules. Nom de classe : lettres minuscules, chiffres et _, 48 caractères au plus, et pas le nom d'une arme du jeu (physgun, toolgun, crowbar, pistol, shotgun, rifle). 256 classes au plus.

Pour donner l'arme : ply:Give("classe") (serveur). Avec SWEP.Spawnable = true, elle apparaît aussi dans l'onglet Armes du menu de spawn.

Champs de SWEP

Fonctions appelées par le jeu

Côté client, PrimaryAttack, SecondaryAttack et Reload ne tournent que chez le propriétaire (prédiction) ; les autres joueurs voient le tir grâce au serveur.

Méthodes de l'arme (self)

Bibliothèque weapons

Exemple : pistolet laser

-- gamemodes/mon_mode/weapons/laser_pistol.lua (ou lua/weapons/laser_pistol.lua dans un addon)
SWEP.PrintName = "Pistolet laser"
SWEP.Category = "Armes de test"
SWEP.Slot = 1               -- touche 2
SWEP.Spawnable = true
SWEP.Base = "pistol"         -- modèle, animations et sons du pistolet du jeu
SWEP.Instructions = "Clic G : tirer · Clic D : rafale de 3 · R : recharger"

SWEP.Primary.ClipSize = 20
SWEP.Primary.DefaultClip = 60   -- 20 dans le chargeur, 40 en réserve
SWEP.Primary.Ammo = "laser"
SWEP.Primary.Automatic = false
SWEP.Primary.Damage = 18
SWEP.Primary.Delay = 0.2
SWEP.ReloadTime = 1.4

function SWEP:PrimaryAttack()
	if not self:CanPrimaryAttack() then return end
	self:ShootBullet(18, 1, 0.3, 300)          -- dégâts, balles, dispersion (°), portée (m)
	self:ShootEffects()
	self:EmitSound("physicore/weapons/pistol_fire.wav", 75, 140)
	self:TakePrimaryAmmo(1)
	self:ViewPunch(0.6)
	self:SetNextPrimaryFire(CurTime() + 0.2)
end

function SWEP:SecondaryAttack()
	if self:Clip1() < 3 then return end
	self:ShootBullet(14, 3, 2.5)
	self:ShootEffects()
	self:EmitSound("physicore/weapons/pistol_fire.wav", 75, 90)
	self:TakePrimaryAmmo(3)
	self:SetNextPrimaryFire(CurTime() + 0.6)
	self:SetNextSecondaryFire(CurTime() + 0.6)
end

if CLIENT then
	function SWEP:DrawHUD()
		draw.SimpleText("Laser : " .. self:Clip1(), "Default", ScrW() / 2, ScrH() / 2 + 40, Color(255, 80, 80), 1, 1)
	end
end

Pour le donner : ply:Give("laser_pistol") ; des munitions en plus : ply:GiveAmmo(40, "laser").

Exemple : un prop comme arme

SWEP.PrintName = "Planche à claques"
SWEP.Slot = 2
SWEP.Spawnable = true
SWEP.Model = "builtin:plank"
SWEP.ModelScale = 0.35
SWEP.ModelAngle = Vector(0, 90, 0)   -- la planche dans l'axe de la vue
SWEP.ModelOffset = Vector(0, 0, -0.2)
SWEP.ModelColor = Color(255, 120, 120)  -- planche teintée de rouge
SWEP.Primary.ClipSize = -1
SWEP.Primary.Ammo = "none"
SWEP.DrawCrosshair = false

function SWEP:PrimaryAttack()
	self:SendWeaponAnim(ACT_VM_MISSCENTER)          -- mouvement de frappe
	self:ShootBullet(35, 1, 0, 2, 400)               -- portée 2 m, grosse poussée
	self:EmitSound("physicore/weapons/crowbar_swing.wav")
	self:SetNextPrimaryFire(CurTime() + 0.6)
end

Exemple : héritage

-- weapons/laser_rifle.lua : reprend tout du pistolet laser, en automatique.
SWEP.Base = "laser_pistol"
SWEP.PrintName = "Fusil laser"
SWEP.Slot = 3
SWEP.Primary.Automatic = true
SWEP.Primary.ClipSize = 40

Modèle de vue personnalisé

SWEP.ViewModel donne à l'arme sa propre vue 1re personne : un modèle d'un addon ("addon:<clé>/models/v_arme.glb", importé comme un prop) ou du jeu ("builtin:…"). Il est placé dans le repère de la caméra : son origine est l'œil du joueur, l'avant vers −Z, comme les modèles de vue des armes du jeu (modélise-le bras compris, tel qu'il doit apparaître à l'écran). Il suit le balancement et la marche du jeu. Le modèle en main pour les autres joueurs reste Model / WorldModel, ou celui de la base, et la pose en 3e personne suit la base.

• SWEP.UseHands = true ajoute la main du jeu au modèle (pour un modèle d'arme seule).
• SWEP.ViewModelFlip = true retourne le modèle en miroir (arme dans la main gauche).
• Animations : si le modèle a un AnimationPlayer (les actions d'un .glb exporté de Blender), ses clips jouent comme ceux des armes du jeu : "idle" en boucle au repos, "draw" à la sortie, et self:SendWeaponAnim(clip, durée) joue un clip du même nom ("fire" prend "attack" s'il n'y a pas de "fire" ; durée > 0 cale la vitesse du clip). Après chaque clip, le modèle revient à "idle". ShootEffects() joue "fire", DefaultReload() joue "reload" calé sur SWEP.ReloadTime. Un clip absent ne fait rien ; un modèle sans AnimationPlayer reste fixe.
• Un nœud Muzzle dans le modèle donne le départ des traçantes, un nœud Flash est montré à chaque tir (éclair du canon), comme pour les armes du jeu.

Fonctions client, appelées à chaque image de la vue 1re personne du propriétaire (pour toute arme Lua dont la vue vient d'une arme du jeu, d'un prop ou de ViewModel ; pas quand la base est une arme de l'éditeur sans Model) :

vm vaut toujours nil : il n'y a pas d'entité de modèle de vue. SWEP.ViewModelFOV n'est pas géré.

-- weapons/fusil_scifi.lua : modèle de vue d'un addon, abaissé quand on court, caché en visant.
SWEP.PrintName = "Fusil SF"
SWEP.Base = "rifle"                -- tir, chargeur et pose en 3e personne du fusil du jeu
SWEP.Spawnable = true
SWEP.ViewModel = "addon:mon_pack/models/v_fusil_sf.glb"   -- clips draw, idle, fire, reload
SWEP.WorldModel = "addon:mon_pack/models/w_fusil_sf.glb"

if CLIENT then
	function SWEP:GetViewModelPosition(pos, ang)
		local ply = self:GetOwner()
		if ply:KeyDown(IN_SPEED) and ply:GetVelocity():Length() > 4 then
			return pos - ang:Up() * 0.06, ang + Vector(-12, 8, 0)
		end
	end

	function SWEP:PreDrawViewModel(vm, wep, ply)
		return ply:KeyDown(IN_ATTACK2)   -- lunette : on cache le modèle
	end

	function SWEP:DrawWorldModel(flags)
		if not self:GetOwner():GetNWBool("cache_arme") then self:DrawModel() end
	end
end

Hook EntityFireBullets

EntityFireBullets(tireur, balle) est appelé à chaque FireBullets (donc à chaque ShootBullet), côté serveur et côté client (chez le tireur, pour sa prédiction). balle est la table du tir : Damage, Num, Spread, Distance, Force (les champs absents prennent leur valeur par défaut). Renvoyer false annule le tir ; on peut modifier la table (renvoyer true, comme dans GMod) pour changer le tir. Seules les armes Lua passent par ce hook.

-- shared.lua : dégâts doublés pour l'équipe 2, pas de tir dans la zone de départ.
hook.Add("EntityFireBullets", "regles_tir", function(tireur, balle)
	if tireur:GetPos():Distance(Vector(0, 0, 0)) < 10 then return false end
	if tireur:Team() == 2 then
		balle.Damage = (balle.Damage or 10) * 2
		return true
	end
end)

Armes au sol et sélection

Une arme au sol se ramasse en marchant dessus ou en la visant avec E. Si le joueur a déjà l'arme, il ne prend que les munitions (l'arme reste au sol s'il n'y en a pas). Celui qui l'a jetée ne la ramasse pas en marchant pendant 1,5 s. 64 armes au sol au plus (les plus anciennes disparaissent). Elle ne bloque pas les joueurs.

-- init.lua : on lâche son arme à la mort ; les armes lourdes sont interdites aux civils.
local TEAM_CIVIL = 1 -- numéro d'équipe déclaré avec team.SetUp

hook.Add("PlayerDeath", "lacher_arme", function(victime)
	local id = victime:GetActiveWeapon()
	if id ~= "" and id ~= "physgun" and id ~= "toolgun" then victime:DropWeapon(id) end
end)

hook.Add("PlayerCanPickupWeapon", "civils", function(ply, id)
	if ply:Team() == TEAM_CIVIL and (id == "rifle" or id == "shotgun") then return false end
end)

concommand.Add("jeter", function(ply) ply:DropWeapon() end)

-- shared.lua : pas de changement d'arme pendant qu'on vise avec le clic droit.
hook.Add("PlayerSwitchWeapon", "pas_en_visant", function(ply, ancienne, nouvelle)
	if ply:IsKeyDown(MOUSE_RIGHT) then return true end
end)

Outils de toolgun (TOOL)

Où les écrire

Chargé côté serveur et côté client. La table globale TOOL est prête (TOOL.ClientConVar = {}) ; le nom de l'outil est le nom du fichier en minuscules (minuscules, chiffres et _, pas le nom d'un outil du jeu). L'outil apparaît dans la liste des outils du menu de spawn.

Champs de TOOL

Fonctions appelées par le jeu

Ces fonctions tournent des deux côtés : côté client pour le retour immédiat, mais les modifications du monde se font côté serveur (if CLIENT then return true end). trace contient Hit, HitPos, HitNormal, HitWorld, HitNonWorld, Entity (prop touché ou nil), StartPos (les yeux), Normal (direction) et Fraction.

Méthodes de l'outil (self)

Panneau de réglages

Un réglage absent de ClientConVar affiche une erreur Lua. 200 contrôles au plus. Bibliothèque : tool.Register(TOOL, nom), tool.Get(nom) (la table TOOL), tool.GetList() (noms triés).

Exemple : peinture rouge

-- gamemodes/mon_mode/stools/rouge.lua (ou lua/weapons/gmod_tool/stools/rouge.lua)
TOOL.Name = "Peinture rouge"
TOOL.Category = "Édition"
TOOL.Desc = "Clic G : peindre en rouge · Clic D : couleur d'origine · R : intensité actuelle"
TOOL.ClientConVar = { intensite = "255", transparent = false }

function TOOL:LeftClick(trace)
	local ent = trace.Entity
	if not IsValid(ent) then return false end
	if CLIENT then return true end                 -- le client montre juste le tir
	local r = math.Clamp(self:GetClientNumber("intensite", 255), 0, 255)
	local a = self:GetClientBool("transparent") and 120 or 255
	ent:SetColor(Color(r, 0, 0, a))
	return true
end

function TOOL:RightClick(trace)
	if not IsValid(trace.Entity) then return false end
	if SERVER then trace.Entity:SetColor(Color(255, 255, 255)) end
	return true
end

function TOOL:Reload(trace)
	if CLIENT then return false end
	self:GetOwner():ChatPrint("Intensité actuelle : " .. self:GetClientInfo("intensite"))
	return false
end

function TOOL.BuildCPanel(panel)
	panel:Help("Peint les props en rouge.")
	panel:NumSlider("Intensité du rouge", "rouge_intensite", 0, 255, 0)
	panel:CheckBox("Semi-transparent", "rouge_transparent")
end

Toolgun, physgun et touche E

-- Protection des props : seul le propriétaire (ou un admin) peut les modifier.
hook.Add("CanTool", "proprio", function(ply, trace, outil)
	local ent = trace and trace.Entity
	if IsValid(ent) and ent:GetOwner() ~= ply and not ply:IsAdmin() then
		if SERVER then ply:ChatPrint("Ce prop n'est pas à toi.") end
		return false
	end
end)

-- Seule la police peut monter dans les voitures de police.
local TEAM_POLICE = 2
hook.Add("PlayerUse", "voitures_police", function(ply, ent)
	if ent:IsVehicle() and ent:GetNWBool("police") and ply:Team() ~= TEAM_POLICE then return false end
end)

Voir aussi la liste complète des hooks.