Class Updater

Class to update the data of versioned objects to conform to the latest version.

Inheritance

System.Object

Updater

MapGraphUpdater

Namespace: InsaneScatterbrain.Editor.Updates

Syntax

public abstract class Updater : object

Properties

LatestUpdateVersion

Gets the latest version that requires update actions to be performed.

Declaration

public Version LatestUpdateVersion { get; }

Property Value

Type	Description
Version

ProgressBarText

Sets the content displayed on the progress bar that's shown while updating.

Declaration

protected abstract string ProgressBarText { get; }

Property Value

Type	Description
System.String

ProgressBarTitle

Gets the tile displayed on the progress bar that's shown while updating.

Declaration

protected abstract string ProgressBarTitle { get; }

Property Value

Type	Description
System.String

UpdateActions

Gets all the available update actions for this updater.

Declaration

protected abstract IEnumerable<UpdateAction> UpdateActions { get; }

Property Value

Type	Description
IEnumerable<UpdateAction>

Methods

Initialize()

Declaration

public void Initialize()

SetActionProgress(Single)

Sets the progress of the update, to display on the progress bar, this should be called from the associated update actions.

Declaration

public void SetActionProgress(float progress)

Parameters

Type	Name	Description
System.Single	progress	The current progress made.

Update()

Performs all update actions required to conform to the latest version.

Declaration

public void Update()

Events

OnUpdateComplete

Event that's triggered whenever the updater completes updating.

Declaration

public event Action OnUpdateComplete

Event Type

Type	Description
Action