DC/RTS Documentation  v1.62
A Unity3D System Incorporating the Functionality of a Dungeon Crawler or Real Time Strategy System
 All Classes Files Functions Variables Enumerations Enumerator Properties Pages
TimerBarSystem Class Reference

This Class extends the ScrollBarEssentials, simulating the behavior for a TimerSystem Game Bar More...

Inheritance diagram for TimerBarSystem:
ScrollBarEssentials

Public Member Functions

 TimerBarSystem ()
 
 TimerBarSystem (Rect sb_dimen, Rect sbs_dimen, bool vbar, Texture sb_bt, Texture st, float rot)
 
void ReInitializeTimerBar (Rect sb_dimen, Rect sbv_dimen, bool vbar, Texture sb_bt, Texture st, float rot)
 Reinitializes the TimerBar system with the provided values More...
 
void InitializeTime (float tT)
 Initializes the TimerBar with a current value and max value and a totalTime it'll take to scroll the bar upward or downward More...
 
void Update ()
 Provides Update to this TimerBarSystem More...
 
override void DoInMouseRect ()
 What to do when hovering over a Game Bar More...
 
override void DoOutMouseRect ()
 What to do when not hovering over a Game Bar System More...
 
override void IncrimentBar (float value)
 Incriments or De-incriments the current value More...
 
void ActivateTimerBar ()
 Begin the Timer Bar Count Down More...
 
void ChangeScrollBarPosition (int x, int y)
 
float getPercentage ()
 
void ResetTimerBar ()
 Resets the TimerBarSystem More...
 
bool isActiveBar ()
 Is this currently an Active Bar? More...
 
bool isReadyToBuild ()
 Is this TimerBarSystem ready? More...
 
bool isInitialized ()
 Has this TimerBarSystem been initialized More...
 
- Public Member Functions inherited from ScrollBarEssentials
 ScrollBarEssentials ()
 A default initializer for a ScrollBarEssentaisl Game Bar System More...
 
 ScrollBarEssentials (Rect sb_dimen, bool vbar, Texture sb_bt, Texture st, float rot)
 Creates a ScrollBarEssentials Game Bar System More...
 
 ScrollBarEssentials (Rect sb_dimen, Rect sbv_dimen, bool vbar, Texture sb_bt, Texture st, float rot)
 Creates a ScrollBarEssentials HealthSystem Game Bar More...
 
virtual void DrawBar ()
 Draws the ScrollBarEssentials Game Bar More...
 
float getCurrentValue ()
 The current_value of the Game Bar More...
 
float getMaxValue (float value)
 The max_value of the Game Bar More...
 
Rect getScrollBarRect ()
 The main Scroll Bar Dimensions More...
 
Rect getScrollBarTextureDimens ()
 The Scroll Bar Texture Dimensions More...
 

Properties

bool Pause [get, set]
 Either sets or gets the Pause state More...
 
bool ReverseTimeScroll [get, set]
 

Additional Inherited Members

- Protected Member Functions inherited from ScrollBarEssentials
virtual float DetermineMaxVal (float value)
 Overridable function for determining a max value More...
 
void ProcessValue (float value)
 Function for changing the current_value by a value More...
 
void SetCurrentValue (float value)
 Sets the current_value to a value More...
 
- Protected Attributes inherited from ScrollBarEssentials
GUIStyle style = new GUIStyle()
 
Vector2 string_size
 
Vector2 pivotVector = Vector2.zero
 
bool MouseInRect = false
 
float current_value = 0
 
float max_value = 100
 
Rect ScrollBarDimens = new Rect()
 
Rect ScrollBarTextureDimens
 
bool VerticleBar = false
 
float texture_rotation = 0
 
Texture ScrollBarBubbleTexture
 
Texture ScrollTexture
 

Detailed Description

This Class extends the ScrollBarEssentials, simulating the behavior for a TimerSystem Game Bar

Constructor & Destructor Documentation

TimerBarSystem.TimerBarSystem ( )
TimerBarSystem.TimerBarSystem ( Rect  sb_dimen,
Rect  sbs_dimen,
bool  vbar,
Texture  sb_bt,
Texture  st,
float  rot 
)

Member Function Documentation

void TimerBarSystem.ActivateTimerBar ( )

Begin the Timer Bar Count Down

void TimerBarSystem.ChangeScrollBarPosition ( int  x,
int  y 
)
override void TimerBarSystem.DoInMouseRect ( )
virtual

What to do when hovering over a Game Bar

Reimplemented from ScrollBarEssentials.

override void TimerBarSystem.DoOutMouseRect ( )
virtual

What to do when not hovering over a Game Bar System

Reimplemented from ScrollBarEssentials.

float TimerBarSystem.getPercentage ( )
override void TimerBarSystem.IncrimentBar ( float  value)
virtual

Incriments or De-incriments the current value

Parameters
valueThe value to change the current value by

Reimplemented from ScrollBarEssentials.

void TimerBarSystem.InitializeTime ( float  tT)

Initializes the TimerBar with a current value and max value and a totalTime it'll take to scroll the bar upward or downward

bool TimerBarSystem.isActiveBar ( )

Is this currently an Active Bar?

bool TimerBarSystem.isInitialized ( )

Has this TimerBarSystem been initialized

Returns
bool TimerBarSystem.isReadyToBuild ( )

Is this TimerBarSystem ready?

void TimerBarSystem.ReInitializeTimerBar ( Rect  sb_dimen,
Rect  sbv_dimen,
bool  vbar,
Texture  sb_bt,
Texture  st,
float  rot 
)

Reinitializes the TimerBar system with the provided values

void TimerBarSystem.ResetTimerBar ( )

Resets the TimerBarSystem

void TimerBarSystem.Update ( )

Provides Update to this TimerBarSystem

Property Documentation

bool TimerBarSystem.Pause
getset

Either sets or gets the Pause state

bool TimerBarSystem.ReverseTimeScroll
getset

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