Drag[en]gine Script Module DragonScript  1.23
Dragengine.Services.Mods.ServiceModStats Class Reference

Modification statistics. More...

Inheritance diagram for Dragengine.Services.Mods.ServiceModStats:

Public Member Functions

ServiceModStats new ()
 Create new instance of class ServiceModStats. More...
 

Public Attributes

float downloadCount
 Approximate total count of downloads. More...
 
float rankCount
 Approximate count of entries in the ranking. More...
 
float rankPosition
 Approximate ranking position. More...
 
float ratingAverage
 Average rating. More...
 
float ratingCount
 Approximate count of ratings. More...
 
Dictionary ratingCountPerType
 Approximate count of ratings per rating type. More...
 
String ratingDisplayText
 Tex representation of rating. More...
 
float ratingWeighted
 Weighted rating. More...
 
float subscriberCount
 Approximate total count of subscribers. More...
 

Detailed Description

Modification statistics.

Member Function Documentation

◆ new()

ServiceModStats Dragengine.Services.Mods.ServiceModStats.new ( )

Create new instance of class ServiceModStats.

Member Data Documentation

◆ downloadCount

float Dragengine.Services.Mods.ServiceModStats.downloadCount

Approximate total count of downloads.

◆ rankCount

float Dragengine.Services.Mods.ServiceModStats.rankCount

Approximate count of entries in the ranking.

◆ rankPosition

float Dragengine.Services.Mods.ServiceModStats.rankPosition

Approximate ranking position.

◆ ratingAverage

float Dragengine.Services.Mods.ServiceModStats.ratingAverage

Average rating.

Value is in the range from 0 to ServiceModsFeatures.modRatingCount.

◆ ratingCount

float Dragengine.Services.Mods.ServiceModStats.ratingCount

Approximate count of ratings.

◆ ratingCountPerType

Dictionary Dragengine.Services.Mods.ServiceModStats.ratingCountPerType

Approximate count of ratings per rating type.

Dictionary with int rating type key and float count value. The rating type is in the range from 0 to ServiceModsFeatures.modRatingCount. This allows to show a finer grained chart of submitted ratings.

◆ ratingDisplayText

String Dragengine.Services.Mods.ServiceModStats.ratingDisplayText

Tex representation of rating.

Typically contains values like "Positive", "Very Positive" or similar. The service provider is responsible for the translation.

◆ ratingWeighted

float Dragengine.Services.Mods.ServiceModStats.ratingWeighted

Weighted rating.

Service provider calculate rating with the goal to favor modifications with higher count of positive ratings. This value is best used to show rankings to the player. Value is in the range from 0 to ServiceModsFeatures.modRatingCount.

◆ subscriberCount

float Dragengine.Services.Mods.ServiceModStats.subscriberCount

Approximate total count of subscribers.


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