Class GenericDamageHandler
- Namespace
- Exiled.API.Features.DamageHandlers
- Assembly
- Exiled.API.dll
Allows generic damage to a player.
public class GenericDamageHandler : CustomReasonDamageHandler
- Inheritance
-
DamageHandlerBaseStandardDamageHandlerCustomReasonDamageHandlerGenericDamageHandler
- Inherited Members
-
CustomReasonDamageHandler.<Damage>k__BackingFieldCustomReasonDamageHandler._deathReasonCustomReasonDamageHandler._cassieAnnouncementCustomReasonDamageHandler.WriteAdditionalData(NetworkWriter)CustomReasonDamageHandler.ReadAdditionalData(NetworkReader)CustomReasonDamageHandler.RagdollInspectTextCustomReasonDamageHandler.DeathScreenTextStandardDamageHandler.<DealtHealthDamage>k__BackingFieldStandardDamageHandler.<AbsorbedAhpDamage>k__BackingFieldStandardDamageHandler.<AbsorbedHumeDamage>k__BackingFieldStandardDamageHandler.KillValueStandardDamageHandler.HitboxStandardDamageHandler.StartVelocityStandardDamageHandler._velXStandardDamageHandler._velYStandardDamageHandler._velZStandardDamageHandler.ProcessDamage(ReferenceHub)StandardDamageHandler.ProcessRagdoll(BasicRagdoll)StandardDamageHandler.DealtHealthDamageStandardDamageHandler.AbsorbedAhpDamageStandardDamageHandler.AbsorbedHumeDamageStandardDamageHandler.TotalDamageDealtStandardDamageHandler.ServerMetricsTextDamageHandlerBase.WriteDeathScreen(NetworkWriter)
- Extension Methods
Constructors
GenericDamageHandler(Player, Player, float, DamageType, CassieAnnouncement, string)
Initializes a new instance of the GenericDamageHandler class. Transform input data to custom generic handler.
[Obsolete("This constructor will be deleted in Exiled 10")]
public GenericDamageHandler(Player player, Player attacker, float damage, DamageType damageType, DamageHandlerBase.CassieAnnouncement cassieAnnouncement, string damageText)
Parameters
playerPlayerCurrent player (Target).
attackerPlayerAttacker.
damagefloatDamage quantity.
damageTypeDamageTypeDamage type.
cassieAnnouncementDamageHandlerBase.CassieAnnouncementCustom cassie announcment.
damageTextstringText to provide to player death screen.
GenericDamageHandler(Player, Player, float, DamageType, CassieAnnouncement, string, bool)
Initializes a new instance of the GenericDamageHandler class. Transform input data to custom generic handler.
public GenericDamageHandler(Player player, Player attacker, float damage, DamageType damageType, DamageHandlerBase.CassieAnnouncement cassieAnnouncement, string damageText = null, bool overrideCassieForAllRole = false)
Parameters
playerPlayerCurrent player (Target).
attackerPlayerAttacker.
damagefloatDamage quantity.
damageTypeDamageTypeDamage type.
cassieAnnouncementDamageHandlerBase.CassieAnnouncementCustom cassie announcment.
damageTextstringText to provide to player death screen.
overrideCassieForAllRoleboolWhether to play Cassie for non-SCPs as well.
Properties
AllowSelfDamage
Gets a value indicating whether allow self damage.
public bool AllowSelfDamage { get; }
Property Value
Attacker
Gets or sets the current attacker.
public Footprint Attacker { get; set; }
Property Value
- Footprint
Base
Gets or sets a custom base.
public DamageHandlerBase Base { get; set; }
Property Value
- DamageHandlerBase
CassieDeathAnnouncement
Gets the PlayerStatsSystem.DamageHandlerBase.CassieAnnouncement the base game uses when a player dies.
public override DamageHandlerBase.CassieAnnouncement CassieDeathAnnouncement { get; }
Property Value
- DamageHandlerBase.CassieAnnouncement
Damage
public override float Damage { get; set; }
Property Value
ServerLogsText
public override string ServerLogsText { get; }
Property Value
Methods
ApplyDamage(ReferenceHub)
Custom Exiled process damage.
public override DamageHandlerBase.HandlerOutput ApplyDamage(ReferenceHub ply)
Parameters
plyReferenceHubCurrent player hub.
Returns
- DamageHandlerBase.HandlerOutput
Handles processing damage outcome.