PlatformerPro.CharacterHitBox Class Reference

The damage causing collider of a character or enemy, collides with hurt boxes to cause damage. More...

Inheritance diagram for PlatformerPro.CharacterHitBox:

Public Member Functions
virtual void	Init (DamageInfo info)
	Init this instance, this should be called by the attack system during Start(); More...
virtual void	UpdateDamageInfo (int amount, DamageType damageType)
	Updates the damage info with new values. More...
virtual void	EnableImmediate ()
	Start the hit with no timer. More...
virtual void	DisableImmediate ()
	Stop the hit immedaitely. More...
virtual void	EnableImmediate (float enableTime, float disableTime)
	Start the hit. 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
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
virtual IEnumerator	DoEnable (float enableTime, float disableTime)
	Turn on the hit box. More...
virtual bool	DoHit (Collider2D other)
	Do the actual hit. More...

Protected Attributes
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
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.

Member Function Documentation

DisableImmediate()

virtual void PlatformerPro.CharacterHitBox.DisableImmediate ( )

virtual

Stop the hit immedaitely.

DoEnable()

virtual IEnumerator PlatformerPro.CharacterHitBox.DoEnable ( float  enableTime, float  disableTime  )

protectedvirtual

Turn on the hit box.

.

Returns

The enable.

Parameters

enableTime	Enable time.
disableTime	Disable time.

DoHit()

virtual bool PlatformerPro.CharacterHitBox.DoHit ( Collider2D  other )

protectedvirtual

Do the actual hit.

Parameters

other

Other.

Returns

true if a hit was done.

Reimplemented in PlatformerPro.ProjectileHitBox, PlatformerPro.JumpOnHeadHitBox, and PlatformerPro.CharacterHitBoxWithMultiHit.

EnableImmediate() [1/2]

virtual void PlatformerPro.CharacterHitBox.EnableImmediate ( )

virtual

Start the hit with no timer.

Reimplemented in PlatformerPro.CharacterHitBoxWithMultiHit.

EnableImmediate() [2/2]

virtual void PlatformerPro.CharacterHitBox.EnableImmediate ( float  enableTime, float  disableTime  )

virtual

Start the hit.

Reimplemented in PlatformerPro.CharacterHitBoxWithMultiHit.

ForceStop()

virtual void PlatformerPro.CharacterHitBox.ForceStop ( )

virtual

Forces the attack to finish.

Init()

virtual void PlatformerPro.CharacterHitBox.Init ( DamageInfo  info )

virtual

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

Reimplemented in PlatformerPro.CharacterHitBoxWithMultiHit.

UpdateDamageInfo()

virtual void PlatformerPro.CharacterHitBox.UpdateDamageInfo ( int  amount, DamageType  damageType  )

virtual

Updates the damage info with new values.

Parameters

amount	Amount.
damageType	Damage type.

Member Data Documentation

character

IMob PlatformerPro.CharacterHitBox.character

protected

The character this hit box is for.

damageInfo

DamageInfo PlatformerPro.CharacterHitBox.damageInfo

protected

Cached damage info.

hasHitCharacter

bool PlatformerPro.CharacterHitBox.hasHitCharacter

protected

Tracks if this attack instance has hit an enemy.

hitTimer

float PlatformerPro.CharacterHitBox.hitTimer

protected

Tracks the time for enalbing and disabling the hit box.

myCollider

Collider2D PlatformerPro.CharacterHitBox.myCollider

protected

The actual collider.

weaponSlot

string PlatformerPro.CharacterHitBox.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.

Property Documentation

Character

virtual Character PlatformerPro.CharacterHitBox.Character

getset

Gets the character.

HasHit

virtual bool PlatformerPro.CharacterHitBox.HasHit

get

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

Header

override string PlatformerPro.CharacterHitBox.Header

get

Gets the header string used to describe the component.

The header.

---

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

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