Class Resource
Represent a type of 'Resource' like Health, Mana, Stamina, Hunger, Oxygen etc.
Inheritance
object
Resource
Namespace: TetraCreations.ProgressBarSystem
Assembly: cs.temp.dll.dll
Syntax
public class Resource : ScriptableObject
Fields
AllowValueDecrease
Allows or prevents any decrease in value.
Declaration
public bool AllowValueDecrease
Field Value
Type | Description |
---|---|
bool |
AllowValueIncrease
Allows or prevents any increase in value.
Declaration
public bool AllowValueIncrease
Field Value
Type | Description |
---|---|
bool |
DisplayName
Name to show in the UI
Declaration
public string DisplayName
Field Value
Type | Description |
---|---|
string |
Icon
Icon for the ProgressBar.
Declaration
public Sprite Icon
Field Value
Type | Description |
---|---|
Sprite |
IconColor
Color of the Icon
Declaration
public Color IconColor
Field Value
Type | Description |
---|---|
Color |
IsProtection
Determines if the Resource is used to represent a number of hit point like Health, Shield, Armor etc.
Declaration
public bool IsProtection
Field Value
Type | Description |
---|---|
bool |
IsVitalProtection
If the amount is a vital for the Entity. For example if Health reach 0 the entity is dead, we can have other protections which are not vital.
Declaration
public bool IsVitalProtection
Field Value
Type | Description |
---|---|
bool |
PrecisionTolerance
Used to compare the current value with Minimum and Maximum values, we can't compare float's equality.
We could tolerate a value of 99.98 to be equals to 100 for exemple.
Declaration
public float PrecisionTolerance
Field Value
Type | Description |
---|---|
float |
ResetOnLevelUp
Determines if the amount should be reset to the maximum possible value when leveling up.
Declaration
public bool ResetOnLevelUp
Field Value
Type | Description |
---|---|
bool |