h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2025-03-03 23:23:25 +08:00
Code Issues Releases Wiki Activity

Adjust comments on ICarouselPanel to imply external use

Browse Source
This commit is contained in:
Dean Herbert 2025-01-24 18:34:04 +09:00
parent f4270ab3b9
commit 92429b2ed9
No known key found for this signature in database
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
osu.Game/Screens/SelectV2/ICarouselPanel.cs
View File

@ -3,33 +3,33 @@
using osu.Framework.Bindables;
using osu.Framework.Graphics;
using osu.Framework.Graphics.Pooling;
namespace osu.Game.Screens.SelectV2
{
/// <summary>
/// An interface to be attached to any <see cref="Drawable"/>s which are used for display inside a <see cref="Carousel{T}"/>.
/// Importantly, all properties in this interface are managed by <see cref="Carousel{T}"/> and should not be written to elsewhere.
/// </summary>
public interface ICarouselPanel
{
/// <summary>
/// Whether this item has selection.
/// This is managed by <see cref="Carousel{T}"/> and should not be set manually.
/// Whether this item has selection. Should be read from to update the visual state.
/// </summary>
BindableBool Selected { get; }
/// <summary>
/// Whether this item has keyboard selection.
/// This is managed by <see cref="Carousel{T}"/> and should not be set manually.
/// Whether this item has keyboard selection. Should be read from to update the visual state.
/// </summary>
BindableBool KeyboardSelected { get; }
/// <summary>
/// The Y position which should be used for displaying this item within the carousel. This is managed by <see cref="Carousel{T}"/> and should not be set manually.
/// The Y position used internally for positioning in the carousel.
/// </summary>
double DrawYPosition { get; set; }
/// <summary>
/// The carousel item this drawable is representing. This is managed by <see cref="Carousel{T}"/> and should not be set manually.
/// The carousel item this drawable is representing. Will be set before <see cref="PoolableDrawable.PrepareForUse"/> is called.
/// </summary>
CarouselItem? Item { get; set; }
}