Skip to main content

OpenTD .NET8 reference 2025 R2

OpenTD.AddIn.ProgressToken Class Reference

Last update: 16.07.2025

<exclude > More...

Inheritance diagram for OpenTD.AddIn.ProgressToken:
OpenTD.AddIn.IProgressReporter

Public Member Functions

void SetTitle (string title)
 Sets the title of the progress-indicating object, for example a ProgressBar.
 
void Report (string status)
 Report progress status, e.g., "Starting to test file 'myfile'".
 
void Report (int progressPercent)
 Report on progress as percent complete. Might be used to set a progress bar, for example.
 
void Show ()
 
void Hide ()
 

Events

EventHandler< AddIn.ProgressEventArgs > ProgressChanged
 

Detailed Description

<exclude >

Member Function Documentation

◆ Hide()

void OpenTD.AddIn.ProgressToken.Hide ( )
inline

◆ Report() [1/2]

void OpenTD.AddIn.ProgressToken.Report ( int progressPercent)
inline

Report on progress as percent complete. Might be used to set a progress bar, for example.

Implements OpenTD.AddIn.IProgressReporter.

◆ Report() [2/2]

void OpenTD.AddIn.ProgressToken.Report ( string status)
inline

Report progress status, e.g., "Starting to test file 'myfile'".

Implements OpenTD.AddIn.IProgressReporter.

◆ SetTitle()

void OpenTD.AddIn.ProgressToken.SetTitle ( string title)
inline

Sets the title of the progress-indicating object, for example a ProgressBar.

Implements OpenTD.AddIn.IProgressReporter.

◆ Show()

void OpenTD.AddIn.ProgressToken.Show ( )
inline

Event Documentation

◆ ProgressChanged

EventHandler<AddIn.ProgressEventArgs> OpenTD.AddIn.ProgressToken.ProgressChanged

The documentation for this class was generated from the following file:
  • C:/Users/mgarrett/source/repos/BuildsTdSuite/builds/OpenTD/OpenTD/AddIn/ProgressToken.cs

Connect with Ansys