// Copyright (c) ppy Pty Ltd . Licensed under the MIT Licence. // See the LICENCE file in the repository root for full licence text. #nullable disable using System; using System.Collections.Generic; using System.Collections.Immutable; using System.Threading; using JetBrains.Annotations; using Newtonsoft.Json; using osu.Framework.Bindables; using osu.Framework.Extensions.ListExtensions; using osu.Framework.Lists; using osu.Game.Audio; using osu.Game.Beatmaps; using osu.Game.Beatmaps.ControlPoints; using osu.Game.Beatmaps.Legacy; using osu.Game.Rulesets.Judgements; using osu.Game.Rulesets.Objects.Types; using osu.Game.Rulesets.Scoring; namespace osu.Game.Rulesets.Objects { /// /// A HitObject describes an object in a Beatmap. /// /// HitObjects may contain more properties for which you should be checking through the IHas* types. /// /// public class HitObject { /// /// A small adjustment to the start time of control points to account for rounding/precision errors. /// private const double control_point_leniency = 1; /// /// Invoked after has completed on this . /// public event Action DefaultsApplied; public readonly Bindable StartTimeBindable = new BindableDouble(); /// /// The time at which the HitObject starts. /// public virtual double StartTime { get => StartTimeBindable.Value; set => StartTimeBindable.Value = value; } public readonly BindableList SamplesBindable = new BindableList(); /// /// The samples to be played when this hit object is hit. /// /// In the case of types, this is the sample of the curve body /// and can be treated as the default samples for the hit object. /// /// public IList Samples { get => SamplesBindable; set { SamplesBindable.Clear(); SamplesBindable.AddRange(value); } } /// /// Any samples which may be used by this hit object that are non-standard. /// This is used only to preload these samples ahead of time. /// public virtual IList AuxiliarySamples => ImmutableList.Empty; public SampleControlPoint SampleControlPoint = SampleControlPoint.DEFAULT; public DifficultyControlPoint DifficultyControlPoint = DifficultyControlPoint.DEFAULT; /// /// Whether this is in Kiai time. /// [JsonIgnore] public bool Kiai { get; private set; } /// /// The hit windows for this . /// [JsonIgnore] public HitWindows HitWindows { get; set; } private readonly List nestedHitObjects = new List(); [JsonIgnore] public SlimReadOnlyListWrapper NestedHitObjects => nestedHitObjects.AsSlimReadOnly(); /// /// Applies default values to this HitObject. /// /// The control points. /// The difficulty settings to use. /// The cancellation token. public void ApplyDefaults(ControlPointInfo controlPointInfo, IBeatmapDifficultyInfo difficulty, CancellationToken cancellationToken = default) { var legacyInfo = controlPointInfo as LegacyControlPointInfo; if (legacyInfo != null) DifficultyControlPoint = (DifficultyControlPoint)legacyInfo.DifficultyPointAt(StartTime).DeepClone(); else if (DifficultyControlPoint == DifficultyControlPoint.DEFAULT) DifficultyControlPoint = new DifficultyControlPoint(); DifficultyControlPoint.Time = StartTime; ApplyDefaultsToSelf(controlPointInfo, difficulty); // This is done here after ApplyDefaultsToSelf as we may require custom defaults to be applied to have an accurate end time. if (legacyInfo != null) SampleControlPoint = (SampleControlPoint)legacyInfo.SamplePointAt(this.GetEndTime() + control_point_leniency).DeepClone(); else if (SampleControlPoint == SampleControlPoint.DEFAULT) SampleControlPoint = new SampleControlPoint(); SampleControlPoint.Time = this.GetEndTime() + control_point_leniency; nestedHitObjects.Clear(); CreateNestedHitObjects(cancellationToken); if (this is IHasComboInformation hasCombo) { foreach (HitObject hitObject in nestedHitObjects) { if (hitObject is IHasComboInformation n) { n.ComboIndexBindable.BindTo(hasCombo.ComboIndexBindable); n.ComboIndexWithOffsetsBindable.BindTo(hasCombo.ComboIndexWithOffsetsBindable); n.IndexInCurrentComboBindable.BindTo(hasCombo.IndexInCurrentComboBindable); } } } nestedHitObjects.Sort((h1, h2) => h1.StartTime.CompareTo(h2.StartTime)); foreach (var h in nestedHitObjects) h.ApplyDefaults(controlPointInfo, difficulty, cancellationToken); // `ApplyDefaults()` may be called multiple times on a single hitobject. // to prevent subscribing to `StartTimeBindable.ValueChanged` multiple times with the same callback, // remove the previous subscription (if present) before (re-)registering. StartTimeBindable.ValueChanged -= onStartTimeChanged; // this callback must be (re-)registered after default application // to ensure that the read of `this.GetEndTime()` within `onStartTimeChanged` doesn't return an invalid value // if `StartTimeBindable` is changed prior to default application. StartTimeBindable.ValueChanged += onStartTimeChanged; DefaultsApplied?.Invoke(this); void onStartTimeChanged(ValueChangedEvent time) { double offset = time.NewValue - time.OldValue; foreach (var nested in nestedHitObjects) nested.StartTime += offset; DifficultyControlPoint.Time = time.NewValue; SampleControlPoint.Time = this.GetEndTime() + control_point_leniency; } } protected virtual void ApplyDefaultsToSelf(ControlPointInfo controlPointInfo, IBeatmapDifficultyInfo difficulty) { Kiai = controlPointInfo.EffectPointAt(StartTime + control_point_leniency).KiaiMode; HitWindows ??= CreateHitWindows(); HitWindows?.SetDifficulty(difficulty.OverallDifficulty); } protected virtual void CreateNestedHitObjects(CancellationToken cancellationToken) { } protected void AddNested(HitObject hitObject) => nestedHitObjects.Add(hitObject); /// /// Creates the that represents the scoring information for this . /// [NotNull] public virtual Judgement CreateJudgement() => new Judgement(); /// /// Creates the for this . /// This can be null to indicate that the has no and timing errors should not be displayed to the user. /// /// This will only be invoked if hasn't been set externally (e.g. from a . /// /// [NotNull] protected virtual HitWindows CreateHitWindows() => new HitWindows(); } public static class HitObjectExtensions { /// /// Returns the end time of this object. /// /// /// This returns the where available, falling back to otherwise. /// /// The object. /// The end time of this object. public static double GetEndTime(this HitObject hitObject) => (hitObject as IHasDuration)?.EndTime ?? hitObject.StartTime; } }