PlatformerPro.CharacterHitBoxWithMultiHit Class Reference

The damage causing collider of a character or enemy, collides with hurt boxes to cause damage. This version can hit multiple enemies from one attack. More...

Inheritance diagram for PlatformerPro.CharacterHitBoxWithMultiHit:

Public Member Functions
override void	Init (DamageInfo info)
	Init this instance, this should be called by the attack system during Start(); More...
virtual bool	HasHitMob (IMob mob)
	Returns true if the hit box has hit the given mob since it was last enabled. More...
override void	EnableImmediate ()
	Start the hit with no timer. More...
override void	EnableImmediate (float enableTime, float disableTime)
	Start the hit. More...
Public Member Functions inherited from PlatformerPro.CharacterHitBox
virtual void	UpdateDamageInfo (int amount, DamageType damageType)
	Updates the damage info with new values. More...
virtual void	DisableImmediate ()
	Stop the hit immedaitely. More...
virtual void	ForceStop ()
	Forces the attack to finish. More...
Public Member Functions inherited from PlatformerPro.PlatformerProMonoBehaviour
virtual void	Validate (PlatformerProMonoBehaviour myTarget)
	Override this method if you want to provide custom validation. The actual code should be surrounded by the if UNITY_EDITOR / endif directive. More...

Public Attributes
List< IMob >	hitMobs
	A list of mobs this hit box has hit since it was last enabled. More...
Public Attributes inherited from PlatformerPro.CharacterHitBox
string	weaponSlot
	If non-null we will apply the damage type from the weapon equipped in the given weapon slot, overriding any damage type set on the attack. More...

Protected Member Functions
override bool	DoHit (Collider2D other)
	Do the actual hit. More...
Protected Member Functions inherited from PlatformerPro.CharacterHitBox
virtual IEnumerator	DoEnable (float enableTime, float disableTime)
	Turn on the hit box. More...

Additional Inherited Members
Protected Attributes inherited from PlatformerPro.CharacterHitBox
IMob	character
	The character this hit box is for. More...
Collider2D	myCollider
	The actual collider. More...
float	hitTimer
	Tracks the time for enalbing and disabling the hit box. More...
bool	hasHitCharacter
	Tracks if this attack instance has hit an enemy. More...
DamageInfo	damageInfo
	Cached damage info. More...
Properties inherited from PlatformerPro.CharacterHitBox
override string	Header [get]
	Gets the header string used to describe the component. More...
virtual Character	Character [get, set]
	Gets the character. More...
virtual bool	HasHit [get]
	Returns true if the hit box has hit something since it was last enabled. More...
Properties inherited from PlatformerPro.PlatformerProMonoBehaviour
virtual string	Header [get]
	Gets the header string used to describe the component. More...
virtual string	DocLink [get]
	Gets a link to documentation site. More...
virtual string	VideoLink [get]
	Gets a link to a youtube video. More...
virtual string	Deprecated [get]
	If non-null this component is deprecated. The string shows a message indicating how it should be replaced. More...
Properties inherited from PlatformerPro.ICharacterReference
Character	Character [get, set]
	Get the character. More...

Detailed Description

The damage causing collider of a character or enemy, collides with hurt boxes to cause damage. This version can hit multiple enemies from one attack.

Member Function Documentation

DoHit()

override bool PlatformerPro.CharacterHitBoxWithMultiHit.DoHit ( Collider2D  other )

protectedvirtual

Do the actual hit.

Parameters

other

Other.

Returns

true if a hit was done.

Reimplemented from PlatformerPro.CharacterHitBox.

EnableImmediate() [1/2]

override void PlatformerPro.CharacterHitBoxWithMultiHit.EnableImmediate ( )

virtual

Start the hit with no timer.

Reimplemented from PlatformerPro.CharacterHitBox.

EnableImmediate() [2/2]

override void PlatformerPro.CharacterHitBoxWithMultiHit.EnableImmediate ( float  enableTime, float  disableTime  )

virtual

Start the hit.

Reimplemented from PlatformerPro.CharacterHitBox.

HasHitMob()

virtual bool PlatformerPro.CharacterHitBoxWithMultiHit.HasHitMob ( IMob  mob )

virtual

Returns true if the hit box has hit the given mob since it was last enabled.

Init()

override void PlatformerPro.CharacterHitBoxWithMultiHit.Init ( DamageInfo  info )

virtual

Init this instance, this should be called by the attack system during Start();

Reimplemented from PlatformerPro.CharacterHitBox.

Member Data Documentation

hitMobs

List<IMob> PlatformerPro.CharacterHitBoxWithMultiHit.hitMobs

A list of mobs this hit box has hit since it was last enabled.

---

The documentation for this class was generated from the following file:

• D:/Projects/platformer-pro-2019.3/Assets/PlatformerPro/Scripts/Attacks/CharacterHitBoxWithMultiHit.cs