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

Update IBeatSnapProvider documentation to mention the pre-divided BeatSnap

Browse Source
This commit is contained in:
Dean Herbert 2022-12-02 17:47:29 +09:00
parent eea9bd3898
commit ba99f1288c
1 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
osu.Game/Rulesets/Edit/IBeatSnapProvider.cs
View File

@ -1,14 +1,12 @@
// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
// See the LICENCE file in the repository root for full licence text.
#nullable disable
namespace osu.Game.Rulesets.Edit
{
public interface IBeatSnapProvider
{
/// <summary>
/// Snaps a duration to the closest beat of a timing point applicable at the reference time.
/// Snaps a duration to the closest beat of a timing point applicable at the reference time, factoring in the current <see cref="BeatDivisor"/>.
/// </summary>
/// <param name="time">The time to snap.</param>
/// <param name="referenceTime">An optional reference point to use for timing point lookup.</param>
@ -16,10 +14,10 @@ namespace osu.Game.Rulesets.Edit
double SnapTime(double time, double? referenceTime = null);
/// <summary>
/// Get the most appropriate beat length at a given time.
/// Get the most appropriate beat length at a given time, pre-divided by <see cref="BeatDivisor"/>.
/// </summary>
/// <param name="referenceTime">A reference time used for lookup.</param>
/// <returns>The most appropriate beat length.</returns>
/// <returns>The most appropriate beat length, divided by <see cref="BeatDivisor"/>.</returns>
double GetBeatLengthAtTime(double referenceTime);
/// <summary>