C# Class Terraria.ModLoader.Setup.Task

Show file Open project: bluemagic123/tModLoader Class Usage Examples

Protected Properties

Property Type Description
progress int
taskInterface ITaskInterface

Public Methods

Method 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

Protected Methods

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

Method Details

ConfigurationDialog() public method

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

Copy() public static method

public static Copy ( string from, string to ) : void
from string
to string
return void

CreateDirectory() public static method

public static CreateDirectory ( string dir ) : void
dir string
return void

CreateParentDirectory() public static method

public static CreateParentDirectory ( string path ) : void
path string
return void

ExecuteParallel() protected method

protected ExecuteParallel ( List items, bool resetProgress = true, int maxDegree ) : void
items List
resetProgress bool
maxDegree int
return void

Failed() public method

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

FinishedDialog() public method

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

RelPath() public static method

public static RelPath ( string basePath, string path ) : string
basePath string
path string
return string

Run() public abstract method

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
return void

StartupWarning() public method

Display a startup warning dialog
public StartupWarning ( ) : bool
return bool

Task() protected method

protected Task ( ITaskInterface taskInterface ) : System
taskInterface ITaskInterface
return System

Warnings() public method

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

Property Details

progress protected property

protected int progress
return int

taskInterface protected property

protected ITaskInterface taskInterface
return ITaskInterface