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

This is a Base Class. Base Classes are abstract definitions used to share common methods and events between related child classes, thus you cannot spawn it directly.

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

🧑‍💻API Source

This page is auto-generated! The Functions, Properties and Events described here are defined in our GitHub's API Repository! Feel free to commit suggestions and changes to the source .json API files!

---

🦠 Functions

	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 vie max
	boolean	IsDead	Retourne si l'entité est morte
		Respawn	Respawns the Entity, filling its Health and moving it to its Initial Location
		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é

---

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	No description provided
string	bone_name?		No description provided
DamageType	damage_type?	DamageType.Shot	No description provided
Vector	from_direction?	Vector(0, 0, 0)	No description provided
Player	instigator?	nil	The player which caused the damage
any	causer?	nil	The object which caused the damage

Returns

Type	Description
integer	le dommage appliqué

---

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	No description provided

Returns

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

See also SetDamageMultiplier.

---

GetHealth

Obtient la santé actuelle

local health = my_damageable:GetHealth()

Returns

Type	Description
integer	health

See also SetHealth.

---

GetMaxHealth

Obtient la vie max

local max_health = my_damageable:GetMaxHealth()

Returns

Type	Description
integer	max_health

See also SetMaxHealth.

---

IsDead

Retourne si l'entité est morte

local is_dead = my_damageable:IsDead()

Returns

Type	Description
boolean	is_dead

---

Respawn

Respawns the Entity, filling its Health and moving it to its Initial Location

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)	No description provided

---

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	No description provided
float	multiplier	Required parameter	No description provided

See also GetDamageMultiplier.

---

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	No description provided

See also GetHealth.

---

SetMaxHealth

Définit la Santé maximale de cette Entité

my_damageable:SetMaxHealth(max_health)

Parameters

Type	Parameter	Default	Description
integer	max_health	Required parameter	No description provided

See also GetMaxHealth.

🚀 Events

	Name	Description
	Death	Lorsque l'Entité meurt
	HealthChange	When Entity has its Health changed, or because took damage or manually set through scripting or respawning
	Respawn	Lorsque l'Entité réapparaît
	TakeDamage	Déclenché lorsque cette Entité subit des dégâts

---

Death

Lorsque l'Entité meurt

Damageable.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	No description provided
integer	last_damage_taken	No description provided
string	last_bone_damaged	No description provided
DamageType	damage_type_reason	No description provided
Vector	hit_from_direction	No description provided
Player or nil	instigator	No description provided
Base Actor or nil	causer	The object which caused the damage

---

HealthChange

When Entity has its Health changed, or because took damage or manually set through scripting or respawning

Damageable.Subscribe("HealthChange", function(self, old_health, new_health)
	-- HealthChange was called
end)

Arguments

Type	Argument	Description
Base Damageable	self	No description provided
integer	old_health	No description provided
integer	new_health	No description provided

---

Respawn

Lorsque l'Entité réapparaît

Damageable.Subscribe("Respawn", function(self)
	-- Respawn was called
end)

Arguments

Type	Argument	Description
Base Damageable	self	No description provided

---

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

Damageable.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	No description provided
integer	damage	No description provided
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