1
0
mirror of https://github.com/ppy/osu.git synced 2026-06-02 06:49:54 +08:00

Adjust documentation

This commit is contained in:
Salman Ahmed
2021-04-11 09:02:32 +03:00
committed by Christine Chen
Unverified
parent 2b947a44da
commit 3d85dc11c6
+2 -1
View File
@@ -22,7 +22,8 @@ namespace osu.Game.Utils
public virtual bool IsCharging { get; } = false;
/// <summary>
/// Returns true if <see cref="IsCharging"/> = false and <see cref="ChargeLevel"/> &lt;= <see cref="BatteryCutoff"/>.
/// Whether the battery is currently low in charge.
/// Returns true if not charging and current charge level is lower than or equal to <see cref="BatteryCutoff"/>.
/// </summary>
public bool IsLowBattery => !IsCharging && ChargeLevel <= BatteryCutoff;
}