h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2024-11-11 09:27:29 +08:00
Code Issues Releases Wiki Activity

Add detailed explaination on existence of ScheduleUntilTransitionEnd

Browse Source
This commit is contained in:
Salman Ahmed 2023-11-11 02:57:29 +03:00
parent bb912bc616
commit 96da7a07bb
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
osu.Game/Screens/BackgroundScreenStack.cs
View File

@ -5,6 +5,8 @@ using System;
using System.Collections.Generic;
using osu.Framework.Graphics;
using osu.Framework.Screens;
using osu.Framework.Threading;
using osu.Game.Screens.Backgrounds;
namespace osu.Game.Screens
{
@ -35,6 +37,19 @@ namespace osu.Game.Screens
return true;
}
/// <summary>
/// Schedules a delegate to run after 500ms, the time length of a background screen transition.
/// This is used in <see cref="BackgroundScreenDefault"/> to dispose of the storyboard once the background screen is completely off-screen.
/// </summary>
/// <remarks>
/// Late storyboard disposals cannot be achieved with any local scheduler from <see cref="BackgroundScreenDefault"/> or any component inside it,
/// due to the screen becoming dead at the moment the transition finishes. And, on the frame that it is dead on, it will not receive an <see cref="Drawable.UpdateSubTree"/>,
/// therefore not guaranteeing to dispose the storyboard at any period of time close to the end of the transition.
/// This might require reconsideration framework-side, possibly exposing a "death" event in <see cref="Screen"/> or all <see cref="Drawable"/>s in general.
/// </remarks>
/// <param name="action">The delegate </param>
/// <returns></returns>
/// <seealso cref="BackgroundScreen.TRANSITION_LENGTH"/>
internal ScheduledDelegate ScheduleUntilTransitionEnd(Action action) => Scheduler.AddDelayed(action, BackgroundScreen.TRANSITION_LENGTH);
}
}