Unity v2 Plugin 0.1
mod management for Unity projects
ModIO.ProgressHandle Class Reference

A ProgressHandle can only be used to monitor the progress of an operation and cannot be used to cancel or suspend ongoing operations. The OperationType enum field specifies what type of operation this handle is for. The Progress field can be used to get the percentage (0.0 - 1.0) of the progress. The Completed and Failed fields can be used to determine if the operation is complete and whether or not it failed. More...

Properties

ModId modId [get, set]
 The ModId of the mod that this operation pertains to.
 
ModManagementOperationType OperationType [get, set]
 The type of operation being performed, eg. Download, Upload, Install
 
float Progress [get, set]
 The progress of the operation being performed, float range from 0.0f - 1.0f
 
long BytesPerSecond [get, set]
 The average number of bytes being processed per second by the operation (Updated every 10 milliseconds) More...
 
bool Completed [get, set]
 Is set to True when the operation has finished More...
 
bool Failed [get, set]
 Is set to True if the operation encounters an error or is cancelled before completion
 

Detailed Description

A ProgressHandle can only be used to monitor the progress of an operation and cannot be used to cancel or suspend ongoing operations. The OperationType enum field specifies what type of operation this handle is for. The Progress field can be used to get the percentage (0.0 - 1.0) of the progress. The Completed and Failed fields can be used to determine if the operation is complete and whether or not it failed.

Property Documentation

◆ BytesPerSecond

long ModIO.ProgressHandle.BytesPerSecond
getset

The average number of bytes being processed per second by the operation (Updated every 10 milliseconds)

Only applicable to Download and Upload operations

◆ Completed

bool ModIO.ProgressHandle.Completed
getset

Is set to True when the operation has finished

If an operation fails then Completed will still be True, therefore it is recommended to check Failed as well


The documentation for this class was generated from the following file: