PlayerMetric

java.lang.Object
- bytemusketeers.heslingtonhustle.metrics.PlayerMetric

All Implemented Interfaces:

MetricEntry
```
class PlayerMetric
extends java.lang.Object
implements MetricEntry
```
A PlayerMetric represents a MetricEntry pertaining to the player-controlled character to be managed by the MetricController.

Author:

ENG1 Team 23 (Cohort 3)

Field Summary

Fields
Modifier and Type	Field	Description
`private static int`	`STANDARD_INCREMENT`	The standard amount by which the `value` may be increased or decreased.
`private java.lang.Integer`	`value`	The integral value of the `PlayerMetric`

Constructor Summary

Constructors
Constructor Description

PlayerMetric()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`(package private) void`	`decrementMetric(int multiplier)`	Decrements the `value` by the given multiple of the `STANDARD_INCREMENT`
`java.lang.String`	`getValue()`	Retrieves the `Integer` associated with the `PlayerMetric`
`(package private) void`	`incrementMetric(int multiplier)`	Increments the `value` by the given multiple of the `STANDARD_INCREMENT`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - STANDARD_INCREMENT
```
private static final int STANDARD_INCREMENT
```
    The standard amount by which the value may be increased or decreased. Any integer multiple of this value may also be used.
    
    See Also:
    
    incrementMetric(int), decrementMetric(int), Constant Field Values
  - value
```
private java.lang.Integer value
```
    The integral value of the PlayerMetric
- Constructor Detail
  - PlayerMetric
```
PlayerMetric()
```
- Method Detail
  - getValue
```
public java.lang.String getValue()
```
    Retrieves the Integer associated with the PlayerMetric
    
    Specified by:
    
    getValue in interface MetricEntry
    
    Returns:
    
    A String representation of the value
  - incrementMetric
```
void incrementMetric(int multiplier)
```
    Increments the value by the given multiple of the STANDARD_INCREMENT
    
    Parameters:
    
    multiplier - An integer multiplier of the STANDARD_INCREMENT
  - decrementMetric
```
void decrementMetric(int multiplier)
```
    Decrements the value by the given multiple of the STANDARD_INCREMENT
    
    Parameters:
    
    multiplier - An integer multiplier of the STANDARD_INCREMENT