Base Damageable

Classe de base pour toutes les entités pouvant être endommagées. Elle fournit des méthodes et des événements liés à la santé et aux dégâts.

👪Base Class🧑‍💻API Source

👪Base Class

This is a Base Class, an abstract definition that shares common methods and events with it's child classes. You cannot spawn it, and you cannot call anything on the Base Class name itself. Use any class that inherits it.

Classes that share methods and events from this Base Class: Character, CharacterSimple, VehicleWheeled, VehicleWater.

---

🦠 Fonctions

	Returns	Name	Description
	integer	ApplyDamage	Infliger des dégâts à cette entité
	float	GetDamageMultiplier	Obtient le multiplicateur de dégâts d'un os
	integer	GetHealth	Obtient la santé actuelle
	integer	GetMaxHealth	Obtient la santé maximale
	boolean	IsDead	Retourne si l'entité est morte
		Respawn	Fait réapparaître l'entité, restaure entièrement sa santé et la déplace vers son emplacement initial
		SetDamageMultiplier	Modifie la quantité de dégâts que cette entité subit sur des os spécifiques
		SetHealth	Définit la Santé de cette Entité
		SetMaxHealth	Définit la Santé maximale de cette Entité

---

Moderate

ApplyDamage

Inflige des dégâts à cette entité ; déclenche tous les événements associés et applique les dégâts modifiés en fonction de l'os touché. Applique également une impulsion s'il s'agit d'une forte explosion

local ret = my_damageable:ApplyDamage(damage, bone_name?, damage_type?, from_direction?, instigator?, causer?)

Parameters

Type	Parameter	Default	Description
integer	damage	Required parameter	Amount of damage
string	bone_name?		Name of the bone or socket
DamageType	damage_type?	DamageType.Shot	Type of the damage, used for effects and in the damage events
Vector	from_direction?	Vector(0, 0, 0)	Direction the damage came from
Player	instigator?	nil	The player which caused the damage
any	causer?	nil	The object which caused the damage

Returns

Type	Description
integer	les dégats appliqué

---

Optimal

GetDamageMultiplier

Obtient le multiplicateur de dégâts d'un os

local multiplier = my_damageable:GetDamageMultiplier(bone_name)

Parameters

Type	Parameter	Default	Description
string	bone_name	Required parameter	Name of the bone or socket

Returns

Type	Description
float	Le multiplicateur de dégâts de l'os

See also SetDamageMultiplier.

---

Optimal

GetHealth

Obtient la santé actuelle

local health = my_damageable:GetHealth()

Returns

Type	Description
integer	Current health

See also SetHealth.

---

Optimal

GetMaxHealth

Obtient la santé maximale

local max_health = my_damageable:GetMaxHealth()

Returns

Type	Description
integer	Max Health

See also SetMaxHealth.

---

Optimal

IsDead

Retourne si l'entité est morte

local is_dead = my_damageable:IsDead()

Returns

Type	Description
boolean	Whether the entity is dead

---

Moderate

Respawn

Fait réapparaître l'entité, restaure entièrement sa santé et la déplace vers son emplacement initial

my_damageable:Respawn(location?, rotation?)

Parameters

Type	Parameter	Default	Description
Vector	location?	initial location	Si non fourni, utilisera l'emplacement initial défini lors de l'apparition de l'entité
Rotator	rotation?	Rotator(0, 0, 0)	Rotation to respawn with

---

Optimal

SetDamageMultiplier

Modifie la quantité de dégâts que cette entité subit sur des os spécifiques

my_damageable:SetDamageMultiplier(bone_name, multiplier)

Parameters

Type	Parameter	Default	Description
string	bone_name	Required parameter	Name of the bone or socket
float	multiplier	Required parameter	Damage multiplier for that bone, 1 is the default

See also GetDamageMultiplier.

---

Optimal

SetHealth

Définit la Santé de cette Entité. Ne peut être appelée que sur des Entités vivantes (appelez d'abord Respawn)

my_damageable:SetHealth(new_health)

Parameters

Type	Parameter	Default	Description
integer	new_health	Required parameter	The new Health of this Entity

See also GetHealth.

---

Optimal

SetMaxHealth

Définit la Santé maximale de cette Entité

my_damageable:SetMaxHealth(max_health)

Parameters

Type	Parameter	Default	Description
integer	max_health	Required parameter	The new MaxHealth of this Entity

See also GetMaxHealth.

🚀 Événements

	Name	Description
	Death	Lorsque l'Entité meurt
	HealthChange	Quand la santé de l'entité est modifiée, ou parce qu'elle a subi des dégâts ou a été manuellement définie par le script ou la réapparition
	Respawn	Lorsque l'Entité réapparaît
	TakeDamage	Déclenché lorsque cette Entité subit des dégâts

---

Death

Lorsque l'Entité meurt

<AnyDamageableClass>.Subscribe("Death", function(self, last_damage_taken, last_bone_damaged, damage_type_reason, hit_from_direction, instigator, causer)
	-- Death was called
end)

Arguments

Type	Argument	Description
Base Damageable	self	The Damageable that triggered the event
integer	last_damage_taken	Damage of the hit that killed it
string	last_bone_damaged	Bone hit by the last damage
DamageType	damage_type_reason	Type of the damage that killed it
Vector	hit_from_direction	Direction the last damage came from
Player or nil	instigator	The Player responsible for the death, if any
Base Actor or nil	causer	The object which caused the damage

---

HealthChange

Quand la santé de l'entité est modifiée, ou parce qu'elle a subi des dégâts ou a été manuellement définie par le script ou la réapparition

<AnyDamageableClass>.Subscribe("HealthChange", function(self, old_health, new_health)
	-- HealthChange was called
end)

Arguments

Type	Argument	Description
Base Damageable	self	The Damageable that triggered the event
integer	old_health	Health before the change
integer	new_health	Health after the change

---

Respawn

Lorsque l'Entité réapparaît

<AnyDamageableClass>.Subscribe("Respawn", function(self)
	-- Respawn was called
end)

Arguments

Type	Argument	Description
Base Damageable	self	The Damageable that triggered the event

---

TakeDamage

Déclenché lorsque cette Entité subit des dégâts

Renvoie le multiplicateur appliqué aux dégâts finaux. Renvoyez 0 pour annuler les dégâts (les animations, particules et forces d'impact seront tout de même appliquées). Valeur par défaut : 1.0

<AnyDamageableClass>.Subscribe("TakeDamage", function(self, damage, bone, type, from_direction, instigator, causer)
	-- TakeDamage was called
	return 1.0
end)

Arguments

Type	Argument	Description
Base Damageable	self	The Damageable that triggered the event
integer	damage	Amount of damage taken
string	bone	Damaged bone
DamageType	type	Damage Type
Vector	from_direction	Direction of the damage relative to the damaged actor
Player	instigator	The player which caused the damage
any	causer	The object which caused the damage