C# Class Terraria.TerraCustom.Setup.Task

Afficher le fichier Open project: JavidPack/TerraCustom Class Usage Examples

Protected Properties

Свойство Type Description
progress int
taskInterface ITaskInterface

Méthodes publiques

Méthode Description
ConfigurationDialog ( ) : bool

Display a configuration dialog. Return false if the operation should be cancelled.
Copy ( string from, string to ) : void
CreateDirectory ( string dir ) : void
CreateParentDirectory ( string path ) : void
Failed ( ) : bool

Will prevent successive tasks from executing and cause FinishedDialog to be called
FinishedDialog ( ) : void

Called to display a finished dialog if Failures() || warnings are not supressed and Warnings()
RelPath ( string basePath, string path ) : string
Run ( ) : void

Run the task, any exceptions thrown will be written to a log file and update the status label with the exception message
StartupWarning ( ) : bool

Display a startup warning dialog
Warnings ( ) : bool

Will cause FinishedDialog to be called if warnings are not supressed

Méthodes protégées

Méthode Description
ExecuteParallel ( List items, bool resetProgress = true, int maxDegree ) : void
Task ( ITaskInterface taskInterface ) : System

Method Details

ConfigurationDialog() public méthode

Display a configuration dialog. Return false if the operation should be cancelled.
public ConfigurationDialog ( ) : bool
Résultat bool

Copy() public static méthode

public static Copy ( string from, string to ) : void
from string
to string
Résultat void

CreateDirectory() public static méthode

public static CreateDirectory ( string dir ) : void
dir string
Résultat void

CreateParentDirectory() public static méthode

public static CreateParentDirectory ( string path ) : void
path string
Résultat void

ExecuteParallel() protected méthode

protected ExecuteParallel ( List items, bool resetProgress = true, int maxDegree ) : void
items List
resetProgress bool
maxDegree int
Résultat void

Failed() public méthode

Will prevent successive tasks from executing and cause FinishedDialog to be called
public Failed ( ) : bool
Résultat bool

FinishedDialog() public méthode

Called to display a finished dialog if Failures() || warnings are not supressed and Warnings()
public FinishedDialog ( ) : void
Résultat void

RelPath() public static méthode

public static RelPath ( string basePath, string path ) : string
basePath string
path string
Résultat string

Run() public abstract méthode

Run the task, any exceptions thrown will be written to a log file and update the status label with the exception message
public abstract Run ( ) : void
Résultat void

StartupWarning() public méthode

Display a startup warning dialog
public StartupWarning ( ) : bool
Résultat bool

Task() protected méthode

protected Task ( ITaskInterface taskInterface ) : System
taskInterface ITaskInterface
Résultat System

Warnings() public méthode

Will cause FinishedDialog to be called if warnings are not supressed
public Warnings ( ) : bool
Résultat bool

Property Details

progress protected_oe property

protected int progress
Résultat int

taskInterface protected_oe property

protected ITaskInterface taskInterface
Résultat ITaskInterface