h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2025-02-15 21:42:55 +08:00
Code Issues Releases Wiki Activity

Fix and add missing XMLDoc

Browse Source
This commit is contained in:
Lucas A 2020-03-18 08:17:41 +01:00
parent 17bae532bd
commit a1274a9eb0
2 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
osu.Game/Screens/Play/HUD/FaillingLayer.cs
View File

@ -10,7 +10,7 @@ using osu.Game.Graphics;
namespace osu.Game.Screens.Play.HUD
{
/// <summary>
/// An overlay layer on top of the player HUD which fades to red when the current player health falls a certain threshold defined by <see cref="LowHealthThreshold"/>.
/// An overlay layer on top of the playfield which fades to red when the current player health falls a certain threshold defined by <see cref="LowHealthThreshold"/>.
/// </summary>
public class FaillingLayer : HealthDisplay
{

11
osu.Game/Screens/Play/HUD/HealthDisplay.cs
View File

@ -4,9 +4,14 @@
using osu.Framework.Bindables;
using osu.Framework.Graphics.Containers;
using osu.Game.Rulesets.Scoring;
using osu.Game.Rulesets.UI;
namespace osu.Game.Screens.Play.HUD
{
/// <summary>
/// A container for components displaying the current player health.
/// Gets bound automatically to the <see cref="HealthProcessor"/> when inserted to <see cref="DrawableRuleset.Overlays"/> hierarchy.
/// </summary>
public abstract class HealthDisplay : Container
{
public readonly BindableDouble Current = new BindableDouble
@ -14,7 +19,11 @@ namespace osu.Game.Screens.Play.HUD
MinValue = 0,
MaxValue = 1
};
/// <summary>
/// Bind the tracked fields of <see cref="HealthProcessor"/> to this health display.
/// </summary>
/// <param name="processor"></param>
public virtual void BindHealthProcessor(HealthProcessor processor)
{
Current.BindTo(processor.Health);