FCV Engine 0.1
A tool and framework for tutorials in game development
Loading...
Searching...
No Matches
Weapon Class Reference

Weapon base class to hold all information and basic functions for a weapon mechanic. More...

Inheritance diagram for Weapon:
MeleeWeapon RangedWeapon

Public Member Functions

virtual void Equip ()
 Equips weapon and subcribes to fireAction.
 
virtual void UnEquip ()
 Unequips and un-subscribes to fireAction.
 

Protected Member Functions

virtual void Update ()
 Updates cooldown and controls input for invoking fireAction.
 
virtual void Fire ()
 Base function for Fire, should be overriden to control what happens on fire.
 
virtual void DealDamage (Health health, Vector2 direction)
 If weapon hits: this function removes health from the Health component provided.
 
virtual bool CanFire ()
 function for if the cooldown has elapsed
 

Detailed Description

Weapon base class to hold all information and basic functions for a weapon mechanic.

Definition at line 11 of file Weapon.cs.

Member Function Documentation

◆ CanFire()

virtual bool CanFire ( )
protectedvirtual

function for if the cooldown has elapsed

Returns
true if cooldown has elapsed

Definition at line 83 of file Weapon.cs.

◆ DealDamage()

virtual void DealDamage ( Health health,
Vector2 direction )
protectedvirtual

If weapon hits: this function removes health from the Health component provided.

Parameters
healthHealth component to deal damage to
directiondirection hit came from, put to (0,0) if no knockback is desired

Definition at line 67 of file Weapon.cs.


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