1
0
mirror of https://github.com/ppy/osu.git synced 2025-01-28 14:12:55 +08:00

Add some missing xmldoc

This commit is contained in:
Dean Herbert 2018-04-12 21:04:45 +09:00
parent b50bad0072
commit 0ca703beaa

View File

@ -10,6 +10,9 @@ using osu.Game.Screens.Edit.Screens.Compose;
namespace osu.Game.Screens.Edit
{
/// <summary>
/// A decoupled clock which adds editor-specific functionality, such as snapping to a user-defined beat divisor.
/// </summary>
public class EditorClock : DecoupleableInterpolatingFramedClock
{
public ControlPointInfo ControlPointInfo;
@ -23,6 +26,11 @@ namespace osu.Game.Screens.Edit
ControlPointInfo = controlPointInfo;
}
/// <summary>
/// Seek to the closest valid snap value.
/// </summary>
/// <param name="position">The raw position which should be seeked around.</param>
/// <returns>Whether the seek could be performed.</returns>
public bool SeekSnapped(double position)
{
var timingPoint = ControlPointInfo.TimingPointAt(position);