Platformer Pro  2.3.2
A platform game kit for Unity.
PlatformerPro.EnemyHurtBox Class Reference

Enemy hurt box. More...

Inheritance diagram for PlatformerPro.EnemyHurtBox:
PlatformerPro.PlatformerProMonoBehaviour PlatformerPro.IHurtable PlatformerPro.EnemyHurtBoxWithDamageFilter

Public Member Functions

virtual void Damage (DamageInfo info)
 Pass damage from the given hazard to the Enemy script. More...
 
override 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...
 

Protected Attributes

Enemy enemy
 Cached reference to the enemy script. More...
 

Properties

override string Header [get]
 Gets the header string used to describe the component. More...
 
virtual Enemy Enemy [get]
 Gets the enemy reference. More...
 
virtual bool IsInvulnerable [get]
 Is the enemy currently invulnerable? More...
 
virtual IMob Mob [get]
 Get the mobile (charater) that this hurt box belongs too. Can return null. 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.IHurtable
IMob Mob [get]
 Get the mobile (charater or enemy) that this hurt box belongs too. Can return null. More...
 

Detailed Description

Enemy hurt box.

Member Function Documentation

◆ Damage()

virtual void PlatformerPro.EnemyHurtBox.Damage ( DamageInfo  info)
virtual

Pass damage from the given hazard to the Enemy script.

Parameters
infoInformation about the damage such as the hazard causing the damage.

Implements PlatformerPro.IHurtable.

Reimplemented in PlatformerPro.EnemyHurtBoxWithDamageFilter.

◆ Validate()

override void PlatformerPro.EnemyHurtBox.Validate ( PlatformerProMonoBehaviour  myTarget)
virtual

Override this method if you want to provide custom validation. The actual code should be surrounded by the if UNITY_EDITOR / endif directive.

Reimplemented from PlatformerPro.PlatformerProMonoBehaviour.

Member Data Documentation

◆ enemy

Enemy PlatformerPro.EnemyHurtBox.enemy
protected

Cached reference to the enemy script.

Property Documentation

◆ Enemy

virtual Enemy PlatformerPro.EnemyHurtBox.Enemy
get

Gets the enemy reference.

The enemy.

◆ Header

override string PlatformerPro.EnemyHurtBox.Header
get

Gets the header string used to describe the component.

The header.

◆ IsInvulnerable

virtual bool PlatformerPro.EnemyHurtBox.IsInvulnerable
get

Is the enemy currently invulnerable?

The character.

◆ Mob

virtual IMob PlatformerPro.EnemyHurtBox.Mob
get

Get the mobile (charater) that this hurt box belongs too. Can return null.


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