1
0
mirror of https://github.com/ppy/osu.git synced 2024-09-22 03:27:24 +08:00

Comments in StarCounter

This commit is contained in:
Adonais Romero González 2016-10-12 21:36:52 -05:00
parent 55420d4356
commit 8f0093f133

View File

@ -17,9 +17,6 @@ using System.Threading.Tasks;
namespace osu.Game.Graphics.UserInterface
{
/// <summary>
/// Shows a float count as stars. Used as star difficulty display.
/// </summary>
public class StarCounter : RollingCounter<float>
{
protected override Type transformType => typeof(TransformStarCounter);
@ -27,6 +24,12 @@ namespace osu.Game.Graphics.UserInterface
protected Container starContainer;
protected List<TextAwesome> stars = new List<TextAwesome>();
/// <summary>
/// Maximum amount of stars displayed.
/// </summary>
/// <remarks>
/// This does not limit the counter value, but the amount of stars displayed.
/// </remarks>
public int MaxStars
{
get;
@ -41,6 +44,10 @@ namespace osu.Game.Graphics.UserInterface
public int StarSize = 20;
public int StarSpacing = 4;
/// <summary>
/// Shows a float count as stars. Used as star difficulty display.
/// </summary>
/// <param name="stars">Maximum amount of stars to display.</param>
public StarCounter(int stars = 10) : base()
{
IsRollingProportional = true;