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

A collider that can register damage agaisnt the character but also supports blocking damage via a BlockAttack movement. More...

Inheritance diagram for PlatformerPro.CharacterBlockingHurtBox:
PlatformerPro.CharacterHurtBox PlatformerPro.PlatformerProMonoBehaviour PlatformerPro.IHurtable PlatformerPro.ICharacterReference

Public Member Functions

override void Damage (DamageInfo info)
 Pass damage from the given hazard to the CharacterHealth script. More...
 
- Public Member Functions inherited from PlatformerPro.CharacterHurtBox
virtual void Damage (int amount)
 Pass damage of the given amount to the CharacterHealth script. More...
 
override void Validate (PlatformerProMonoBehaviour myTarget)
 Show validation details. More...
 

Public Attributes

int actionButton
 Action button to use for block. More...
 
BlockDirection blockDirection
 
BlockAttack block
 The block to use. Only used if ActionButton = -1; More...
 
List< DamageTypeunblockableTypes
 

Static Public Attributes

const float MIN_FOR_HIGH = 50.0f
 Angle at which an attack is considered high. More...
 
const float MAX_FOR_LOW = 130.0f
 Angle at which attack is considered low. More...
 

Protected Member Functions

virtual bool IsBlocking (DamageInfo damageInfo)
 

Additional Inherited Members

- Protected Attributes inherited from PlatformerPro.CharacterHurtBox
CharacterHealth health
 Cached reference to the characters health script. More...
 
- Properties inherited from PlatformerPro.CharacterHurtBox
override string Header [get]
 Gets the header string used to describe the component. More...
 
virtual Character Character [get, set]
 Gets the character reference. More...
 
virtual bool IsInvulnerable [get]
 Is the character 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...
 
- Properties inherited from PlatformerPro.ICharacterReference
Character Character [get, set]
 Get the character. More...
 

Detailed Description

A collider that can register damage agaisnt the character but also supports blocking damage via a BlockAttack movement.

Member Function Documentation

◆ Damage()

override void PlatformerPro.CharacterBlockingHurtBox.Damage ( DamageInfo  info)
virtual

Pass damage from the given hazard to the CharacterHealth script.

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

Reimplemented from PlatformerPro.CharacterHurtBox.

◆ IsBlocking()

virtual bool PlatformerPro.CharacterBlockingHurtBox.IsBlocking ( DamageInfo  damageInfo)
protectedvirtual

Member Data Documentation

◆ actionButton

int PlatformerPro.CharacterBlockingHurtBox.actionButton

Action button to use for block.

◆ block

BlockAttack PlatformerPro.CharacterBlockingHurtBox.block

The block to use. Only used if ActionButton = -1;

◆ blockDirection

BlockDirection PlatformerPro.CharacterBlockingHurtBox.blockDirection

◆ MAX_FOR_LOW

const float PlatformerPro.CharacterBlockingHurtBox.MAX_FOR_LOW = 130.0f
static

Angle at which attack is considered low.

◆ MIN_FOR_HIGH

const float PlatformerPro.CharacterBlockingHurtBox.MIN_FOR_HIGH = 50.0f
static

Angle at which an attack is considered high.

◆ unblockableTypes

List<DamageType> PlatformerPro.CharacterBlockingHurtBox.unblockableTypes

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