Class ResourceRegeneration

Regenerate a the ValueManager.Value over time.
It also synchronize the regeneration with the ProgressBar.Regeneration class.

Inheritance
object
ValueRegeneration<ResourceManager>
ResourceRegeneration
Inherited Members
Namespace: TetraCreations.ProgressBarSystem
Assembly: cs.temp.dll.dll
Syntax
public class ResourceRegeneration : ValueRegeneration<ResourceManager>

Fields

_progressBar

Declaration
protected ProgressBar _progressBar
Field Value
Type Description
ProgressBar

_resource

Declaration
protected Resource _resource
Field Value
Type Description
Resource

Properties

ProgressBar

Reference to the ProgressBar (Optional).

Declaration
public ProgressBar ProgressBar { get; }
Property Value
Type Description
ProgressBar

Resource

Get/Set reference of the Resource to regenerate.

Declaration
public Resource Resource { get; set; }
Property Value
Type Description
Resource

ValueManager

Public getter / Protected setter of the ResourceManager reference.

Declaration
public override ResourceManager ValueManager { get; protected set; }
Property Value
Type Description
ResourceManager
Overrides
TetraCreations.ProgressBarSystem.ValueRegeneration<TetraCreations.ProgressBarSystem.ResourceManager>.ValueManager

Methods

AddListenersToProgressBar()

Add listeners to RegenerationValuesChangedEvent and RegenerationStateChangedEvent
To update the Regeneration values and to change their visibility depending on the RegenerationDisplay.

Declaration
protected virtual void AddListenersToProgressBar()

ListenToValueManagerEvents()

Declaration
protected override void ListenToValueManagerEvents()
Overrides
TetraCreations.ProgressBarSystem.ValueRegeneration<TetraCreations.ProgressBarSystem.ResourceManager>.ListenToValueManagerEvents()

OnInitialized()

Declaration
protected override void OnInitialized()
Overrides
TetraCreations.ProgressBarSystem.ValueRegeneration<TetraCreations.ProgressBarSystem.ResourceManager>.OnInitialized()

OnProgressBarChanged(object, ProgressBarChangedEventArgs)

When the ResourceManager progressBar changes, we remove the listeners from the current ProgressBar and to set the new one.

Declaration
protected virtual void OnProgressBarChanged(object sender, ProgressBarChangedEventArgs e)
Parameters
Type Name Description
object sender
ProgressBarChangedEventArgs e

RemoveListenersFromProgressBar()

Stop updating the ProgressBar.Regeneration values.

Declaration
protected virtual void RemoveListenersFromProgressBar()

SetProgressBar(ProgressBar)

Remove listners from the current progress bar.
Set a new ProgressBar to update the Regeneration values.

Declaration
public void SetProgressBar(ProgressBar progressBar)
Parameters
Type Name Description
ProgressBar progressBar

SetProgressBarRegenerationVisibility(object, RegenerationStateEventArgs)

When the RegenerationState changes we need to Hide or Show the regeneration values if the ProgressBar.Regeneration.Display is set to VisibleWhenRegenerating.
Keep in mind that sometimes the RegenerationState goes from Regenerating to Stopped so quickly that the canvas group doesn't have time to update.

Declaration
protected virtual void SetProgressBarRegenerationVisibility(object sender, RegenerationStateEventArgs args)
Parameters
Type Name Description
object sender
RegenerationStateEventArgs args

UnsetProgressBar()

Remove listeners and set the ProgressBar to null.

Declaration
public void UnsetProgressBar()