AdventureCore.TriggerDamageSender Class Reference

Detailed Description

damage sender that damages TriggerDamageReceiver when unity trigger events occur (OnTriggerEnter/OnTriggerExit(2D))

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

Inheritance diagram for AdventureCore.TriggerDamageSender:

Public Types
enum	DirectionMode {   Forward , Up , Right , SenderToReceiver ,   SenderToReceiverXZ , SenderTransformToReceiver , SenderTransformToReceiverXZ , None }

Public Member Functions
virtual void	Activate ()
virtual void	Activate (float modifier)
virtual void	Deactivate ()
void	Send ()
virtual void	SendCharacterMessages (string e)
virtual void	SendCharacterMessage (string e)
virtual Vector3	GetPosition ()
	position of the receiver, may be used to determine damage direction
virtual Vector3	GetDirection (IDamageReceiver receiver)
	calculates direction of damage between this sender and a receiver
virtual bool	PreDamage (IDamageReceiver receiver)
	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 (IDamageReceiver receiver, 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
virtual void	SetCharacter (CharacterBase character)
Public Member Functions inherited from AdventureCore.TriggerArea< TriggerDamageSender, TriggerDamageReceiver >
virtual void	AddItem (TItem item)
virtual void	RemoveItem (TItem item)

Public Attributes
CharacterBase	Character
DamageParameter[]	Damages
DamageModifier[]	Modifiers
DamageMessage[]	Messages
DirectionMode	Direction
float	Magnitude = 0f
bool	SendStart = true
bool	SendTick = false
bool	SendEnd = false
float	TickRate
bool	SendOnce
UnityEvent	Damaged
Public Attributes inherited from AdventureCore.TriggerArea< TriggerDamageSender, TriggerDamageReceiver >
UnityEvent< TItem >	ItemAdded
UnityEvent< TItem >	ItemRemoved
UnityEvent	ItemsChanged

Protected Member Functions
virtual void	Update ()
override void	OnDisable ()
override void	onItemAdded (TriggerDamageReceiver item)
override void	onItemRemoved (TriggerDamageReceiver item)
virtual void	assignDamageVector (DamageEvent e)
Protected Member Functions inherited from AdventureCore.TriggerArea< TriggerDamageSender, TriggerDamageReceiver >
virtual void	OnEnable ()
virtual void	OnTriggerEnter2D (Collider2D collider)
virtual void	OnTriggerExit2D (Collider2D collider)
virtual void	OnTriggerEnter (Collider collider)
virtual void	OnTriggerExit (Collider collider)
void	clear ()
virtual void	tryAdd (Component component)
virtual void	tryRemove (Component component)
virtual void	onItemAdded (TItem item)
virtual void	onItemRemoved (TItem item)

Protected Attributes
Dictionary< TriggerDamageReceiver, DamageInstance >	_instances = new Dictionary<TriggerDamageReceiver, DamageInstance>()
List< TriggerDamageReceiver >	_sent = new List<TriggerDamageReceiver>()
List< CharacterBase >	_sentCharacters = new List<CharacterBase>()
float	_modifier = 1f
Protected Attributes inherited from AdventureCore.TriggerArea< TriggerDamageSender, TriggerDamageReceiver >
Dictionary< TItem, int >	_items

Properties
CharacterBase	AssociatedCharacter [get]
	character that owns or is otherwise associted with the object
Properties inherited from AdventureCore.TriggerArea< TriggerDamageSender, TriggerDamageReceiver >
IEnumerable< TItem >	Items [get]
Properties inherited from AdventureCore.IDamageSender
Properties inherited from AdventureCore.ICharacterAssociator

Member Enumeration Documentation

DirectionMode

enum AdventureCore.TriggerDamageSender.DirectionMode

Enumerator
Forward	the blue forward axis of the transform the sender is located on
Up	the green up axis of the transform the sender is located on
Right	the red right axis of the transform the sender is located on
SenderToReceiver	direction is calculated from sender to receiver, if a character is associated the character position is used
SenderToReceiverXZ	direction is calculated from sender to receiver, if a character is associated the character position is used, removes z component so characters are not removed from ground
SenderTransformToReceiver	direction is calculated from sender to receiver, if a character is associated with the receiver the character position is used
SenderTransformToReceiverXZ	direction is calculated from sender to receiver, if a character is associated with the receiver the character position is used, removes z component so characters are not removed from ground
None	no damage vector, target will not be pushed

Member Function Documentation

GetDirection()

virtual Vector3 AdventureCore.TriggerDamageSender.GetDirection ( IDamageReceiver receiver )

inlinevirtual

calculates direction of damage between this sender and a receiver

Parameters

receiver

Returns

Implements AdventureCore.IDamageSender.

Reimplemented in AdventureCore.MovingDamageSender.

GetPosition()

virtual Vector3 AdventureCore.TriggerDamageSender.GetPosition ( )

inlinevirtual

position of the receiver, may be used to determine damage direction

Returns

position of the receiver, or the character associated with it

Implements AdventureCore.IDamageSender.

OnDamage()

virtual void AdventureCore.TriggerDamageSender.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.IDamageSender.

OnDisable()

override void AdventureCore.TriggerDamageSender.OnDisable ( )

inlineprotectedvirtual

Reimplemented from AdventureCore.TriggerArea< TriggerDamageSender, TriggerDamageReceiver >.

PostDamage()

virtual void AdventureCore.TriggerDamageSender.PostDamage ( IDamageReceiver receiver, 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.IDamageSender.

Reimplemented in AdventureCore.ProjectileDamageSender.

PreDamage()

virtual bool AdventureCore.TriggerDamageSender.PreDamage ( IDamageReceiver receiver )

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

receiver

Returns

whether the damage handling should continue

Implements AdventureCore.IDamageSender.

Reimplemented in AdventureCore.ProjectileDamageSender.

Property Documentation

AssociatedCharacter

CharacterBase AdventureCore.TriggerDamageSender.AssociatedCharacter

get

character that owns or is otherwise associted with the object

Implements AdventureCore.ICharacterAssociator.