Highroad Engine v1.3
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
MoreMountains.Tools.MMRadialProgressBar Class Reference

Add this class to a radial image and it'll allow you to control its fill amount This is a legacy class, and it's recommended to use MMProgressBar instead, it'll provide the same functionality (make sure you pick FillAmount as the FillMode) and much more options, such as delayed bars, events, bump, and more! More...

Inheritance diagram for MoreMountains.Tools.MMRadialProgressBar:

Public Member Functions

virtual void UpdateBar (float currentValue, float minValue, float maxValue)
 Call this method to update the fill amount based on a currentValue between minValue and maxValue More...
 

Public Attributes

float StartValue = 1f
 the start fill amount value More...
 
float EndValue = 0f
 the end goad fill amount value More...
 
float Tolerance = 0.01f
 the distance to the start or end value at which the class should start lerping More...
 
string PlayerID
 optional - the ID of the player associated to this bar More...
 

Protected Member Functions

virtual void Awake ()
 On awake we grab our Image component More...
 

Protected Attributes

Image _radialImage
 
float _newPercent
 

Detailed Description

Add this class to a radial image and it'll allow you to control its fill amount This is a legacy class, and it's recommended to use MMProgressBar instead, it'll provide the same functionality (make sure you pick FillAmount as the FillMode) and much more options, such as delayed bars, events, bump, and more!

Member Function Documentation

◆ Awake()

virtual void MoreMountains.Tools.MMRadialProgressBar.Awake ( )
protectedvirtual

On awake we grab our Image component

◆ UpdateBar()

virtual void MoreMountains.Tools.MMRadialProgressBar.UpdateBar ( float  currentValue,
float  minValue,
float  maxValue 
)
virtual

Call this method to update the fill amount based on a currentValue between minValue and maxValue

Parameters
currentValueCurrent value.
minValueMinimum value.
maxValueMax value.

Member Data Documentation

◆ _newPercent

float MoreMountains.Tools.MMRadialProgressBar._newPercent
protected

◆ _radialImage

Image MoreMountains.Tools.MMRadialProgressBar._radialImage
protected

◆ EndValue

float MoreMountains.Tools.MMRadialProgressBar.EndValue = 0f

the end goad fill amount value

◆ PlayerID

string MoreMountains.Tools.MMRadialProgressBar.PlayerID

optional - the ID of the player associated to this bar

◆ StartValue

float MoreMountains.Tools.MMRadialProgressBar.StartValue = 1f

the start fill amount value

◆ Tolerance

float MoreMountains.Tools.MMRadialProgressBar.Tolerance = 0.01f

the distance to the start or end value at which the class should start lerping


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