Platformer Pro  2.3.2
A platform game kit for Unity.
PlatformerPro.ProjectileHitBox Class Reference
Inheritance diagram for PlatformerPro.ProjectileHitBox:
PlatformerPro.CharacterHitBox PlatformerPro.PlatformerProMonoBehaviour PlatformerPro.ICharacterReference

Public Member Functions

virtual void Init (DamageInfo info, IMob character, Projectile projectile, bool destroyOnEnemyHit, bool destroyOnSceneryHit)
 Init this instance, used for projectiles or hit boxes which are not children of a character. More...
 
- Public Member Functions inherited from PlatformerPro.CharacterHitBox
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

bool allowMultiHit
 If true we can hit more than one thing 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...
 

Protected Attributes

bool destroyOnEnemyHit
 
bool destroyOnSceneryHit
 
Projectile projectile
 
- 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...
 

Additional Inherited Members

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

Member Function Documentation

◆ DoHit()

override bool PlatformerPro.ProjectileHitBox.DoHit ( Collider2D  other)
protectedvirtual

Do the actual hit.

Parameters
otherOther.

Reimplemented from PlatformerPro.CharacterHitBox.

◆ Init()

virtual void PlatformerPro.ProjectileHitBox.Init ( DamageInfo  info,
IMob  character,
Projectile  projectile,
bool  destroyOnEnemyHit,
bool  destroyOnSceneryHit 
)
virtual

Init this instance, used for projectiles or hit boxes which are not children of a character.

Member Data Documentation

◆ allowMultiHit

bool PlatformerPro.ProjectileHitBox.allowMultiHit

If true we can hit more than one thing

◆ destroyOnEnemyHit

bool PlatformerPro.ProjectileHitBox.destroyOnEnemyHit
protected

◆ destroyOnSceneryHit

bool PlatformerPro.ProjectileHitBox.destroyOnSceneryHit
protected

◆ projectile

Projectile PlatformerPro.ProjectileHitBox.projectile
protected

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