h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2025-01-12 22:33:05 +08:00
Code Issues Releases Wiki Activity

Add xmldoc around SkinComponentsContainerLookup

Browse Source
This commit is contained in:
Dean Herbert 2023-02-17 14:18:05 +09:00
parent cb7df7282b
commit 1a63ca9ece
2 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
osu.Game/Skinning/SkinComponentsContainer.cs
View File

@ -24,6 +24,9 @@ namespace osu.Game.Skinning
{
private Container? content;
/// <summary>
/// The lookup criteria which will be used to retrieve components from the active skin.
/// </summary>
public SkinComponentsContainerLookup Lookup { get; }
public IBindableList<ISerialisableDrawable> Components => components;

9
osu.Game/Skinning/SkinComponentsContainerLookup.cs
View File

@ -3,8 +3,14 @@
namespace osu.Game.Skinning
{
/// <summary>
/// Represents a lookup of a collection of elements that make up a particular skinnable <see cref="TargetArea"/> of the game.
/// </summary>
public class SkinComponentsContainerLookup : ISkinComponentLookup
{
/// <summary>
/// The target area / layer of the game for which skin components will be returned.
/// </summary>
public readonly TargetArea Target;
public SkinComponentsContainerLookup(TargetArea target)
@ -12,6 +18,9 @@ namespace osu.Game.Skinning
Target = target;
}
/// <summary>
/// Represents a particular area or part of a game screen whose layout can be customised using the skin editor.
/// </summary>
public enum TargetArea
{
MainHUDComponents,