Dragengine.Services.Mods.ServiceModProgress Class Reference

Progress of a modification management process. More...

Inheritance diagram for Dragengine.Services.Mods.ServiceModProgress:

Classes
enum	State
	Progress state. More...

Public Member Functions
ServiceModProgress	new ()

Public Attributes
float	current
	Current progress value.
String	modId
	Modification identifier.
float	progress
	Percentage progress in the range from 0 to 1.
Float	remainingTime
	Estimated remaining time in seconds until progress is finished.
State	state
	Progress state.
float	total
	Total progress value.

Detailed Description

Progress of a modification management process.

Version

1.23

Such process can be installing, updating or uploading a modification.

Member Function Documentation

new()

ServiceModProgress Dragengine.Services.Mods.ServiceModProgress.new

(

)

Create new instance of class ServiceModProgress.

Member Data Documentation

current

float Dragengine.Services.Mods.ServiceModProgress.current

Current progress value.

Typically this is an approximation of a size indication for example the size of the file already downloaded.

modId

String Dragengine.Services.Mods.ServiceModProgress.modId

Modification identifier.

progress

float Dragengine.Services.Mods.ServiceModProgress.progress

Percentage progress in the range from 0 to 1.

remainingTime

Float Dragengine.Services.Mods.ServiceModProgress.remainingTime

Estimated remaining time in seconds until progress is finished.

Is null if the service module can not give a reasonable estimation.

state

State Dragengine.Services.Mods.ServiceModProgress.state

Progress state.

total

float Dragengine.Services.Mods.ServiceModProgress.total

Total progress value.

Typically this is an approximation of a size indication for example the size of the file to download.

---

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

• ServiceModProgress.ds