mirror of
https://github.com/ppy/osu.git
synced 2024-09-22 20:07:24 +08:00
Fix and add missing XMLDoc
This commit is contained in:
parent
17bae532bd
commit
a1274a9eb0
@ -10,7 +10,7 @@ using osu.Game.Graphics;
|
|||||||
namespace osu.Game.Screens.Play.HUD
|
namespace osu.Game.Screens.Play.HUD
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <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>
|
/// </summary>
|
||||||
public class FaillingLayer : HealthDisplay
|
public class FaillingLayer : HealthDisplay
|
||||||
{
|
{
|
||||||
|
@ -4,9 +4,14 @@
|
|||||||
using osu.Framework.Bindables;
|
using osu.Framework.Bindables;
|
||||||
using osu.Framework.Graphics.Containers;
|
using osu.Framework.Graphics.Containers;
|
||||||
using osu.Game.Rulesets.Scoring;
|
using osu.Game.Rulesets.Scoring;
|
||||||
|
using osu.Game.Rulesets.UI;
|
||||||
|
|
||||||
namespace osu.Game.Screens.Play.HUD
|
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 abstract class HealthDisplay : Container
|
||||||
{
|
{
|
||||||
public readonly BindableDouble Current = new BindableDouble
|
public readonly BindableDouble Current = new BindableDouble
|
||||||
@ -15,6 +20,10 @@ namespace osu.Game.Screens.Play.HUD
|
|||||||
MaxValue = 1
|
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)
|
public virtual void BindHealthProcessor(HealthProcessor processor)
|
||||||
{
|
{
|
||||||
Current.BindTo(processor.Health);
|
Current.BindTo(processor.Health);
|
||||||
|
Loading…
Reference in New Issue
Block a user