AdventureCore.TriggerDamageReceiver Class Reference

Detailed Description

damage receiver that gets damaged by TriggerDamageSender when unity trigger events occur (OnTriggerEnter/OnTriggerExit(2D))

https://adventure.softleitner.com/manual/damage

Inheritance diagram for AdventureCore.TriggerDamageReceiver:

Public Member Functions
virtual bool	PreDamage (IDamageSender sender)
	called before any real damage handling to check if the handling is valid and should continue for example if a character is currently dodging damage handling can be cancelled here
virtual void	OnDamage (DamageEvent e)
	this is where the main damage handling should take place and damage vectors are assigned OnDamage is called in the order Sender > Receiver > Damage for example if a character is wearing protective gear it may reduce the damage value here this method is called for every damage parameter see DamageEvent for more details
virtual void	PostDamage (IDamageSender sender, List< DamageEvent > events)
	called after alle the damages have been applied this is a good spot to react to the change of state that has been done by the damages for example death or destruction if health was reduced to 0 by the damages
Public Member Functions inherited from AdventureCore.TriggerItem< TriggerDamageSender, TriggerDamageReceiver >
virtual void	AddArea (TArea area)
virtual void	RemoveArea (TArea area)

Public Attributes
CharacterBase	Character
DamageKind[]	Filter
UnityEvent< DamageEvent >	Damaging
UnityEvent< DamageEvent[]>	Damaged
Public Attributes inherited from AdventureCore.TriggerItem< TriggerDamageSender, TriggerDamageReceiver >
UnityEvent< TArea >	AreaAdded
UnityEvent< TArea >	AreaRemoved

Properties
CharacterBase	AssociatedCharacter [get]
	character that owns or is otherwise associted with the object
Properties inherited from AdventureCore.TriggerItem< TriggerDamageSender, TriggerDamageReceiver >
IReadOnlyList< TArea >	Areas [get]
Properties inherited from AdventureCore.ICharacterAssociator

Additional Inherited Members
Protected Member Functions inherited from AdventureCore.TriggerItem< TriggerDamageSender, TriggerDamageReceiver >
virtual void	OnEnable ()
virtual void	OnDisable ()
virtual void	onAreaAdded (TArea area)
virtual void	onAreaRemoved (TArea area)
Protected Attributes inherited from AdventureCore.TriggerItem< TriggerDamageSender, TriggerDamageReceiver >
List< TArea >	_areas

Member Function Documentation

OnDamage()

virtual void AdventureCore.TriggerDamageReceiver.OnDamage ( DamageEvent e )

inlinevirtual

this is where the main damage handling should take place and damage vectors are assigned
OnDamage is called in the order Sender > Receiver > Damage
for example if a character is wearing protective gear it may reduce the damage value here
this method is called for every damage parameter see DamageEvent for more details

Parameters

e

Implements AdventureCore.IDamageReceiver.

PostDamage()

virtual void AdventureCore.TriggerDamageReceiver.PostDamage ( IDamageSender sender, List< DamageEvent > events )

inlinevirtual

called after alle the damages have been applied
this is a good spot to react to the change of state that has been done by the damages
for example death or destruction if health was reduced to 0 by the damages

Parameters

sender
events

Implements AdventureCore.IDamageReceiver.

Reimplemented in AdventureCore.DestructibleDamageReceiver, and AdventureCore.MovableDamageReceiver.

PreDamage()

virtual bool AdventureCore.TriggerDamageReceiver.PreDamage ( IDamageSender sender )

inlinevirtual

called before any real damage handling to check if the handling is valid and should continue
for example if a character is currently dodging damage handling can be cancelled here

Parameters

sender

Returns

whether the damage handling should continue

Implements AdventureCore.IDamageReceiver.

Property Documentation

AssociatedCharacter

CharacterBase AdventureCore.TriggerDamageReceiver.AssociatedCharacter

get

character that owns or is otherwise associted with the object

Implements AdventureCore.ICharacterAssociator.