Class Player

The player of the game.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

Player

Namespace: DocFxForUnity

Assembly: DocFxForUnity.dll

Syntax

public class Player : MonoBehaviour

Properties

Equipment

Gets the list of the equipment carried by the player.

Declaration

public List<string> Equipment { get; }

Property Value

Type	Description
List<string>

Health

Gets the current health of the player.

Declaration

public int Health { get; }

Property Value

Type	Description
int

HurtClip

Gets the AudioClip that will be played when Hit(int) is called.

Declaration

public AudioClip HurtClip { get; }

Property Value

Type	Description
AudioClip

StartingHealth

Gets the starting health of the player.

Declaration

public int StartingHealth { get; }

Property Value

Type	Description
int

Methods

Hit(int)

Deacreases Health by a specified value and display a game over if Health drops to zero.

Declaration

public void Hit(int value)

Parameters

Type	Name	Description
int	value	How much to deacrease Health.

Start()

Sets Health with StartingHealth.

Declaration

protected virtual void Start()