// Copyright (c) ppy Pty Ltd . Licensed under the MIT Licence. // See the LICENCE file in the repository root for full licence text. using System; using System.Collections.Generic; using System.Linq; using osu.Framework.Graphics.Primitives; using osu.Framework.Utils; using osu.Game.Beatmaps; using osu.Game.Rulesets.Mods; using osu.Game.Rulesets.Objects; using osu.Game.Rulesets.Osu.Beatmaps; using osu.Game.Rulesets.Osu.Objects; using osu.Game.Rulesets.Osu.UI; using osu.Game.Rulesets.Osu.Utils; using osuTK; namespace osu.Game.Rulesets.Osu.Mods { /// /// Mod that randomises the positions of the s /// public class OsuModRandom : ModRandom, IApplicableToBeatmap { public override string Description => "It never gets boring!"; private static readonly float playfield_diagonal = OsuPlayfield.BASE_SIZE.LengthFast; /// /// Number of previous hit circles to be shifted together when a slider needs to be moved. /// private const int shift_object_count = 10; private Random rng; public void ApplyToBeatmap(IBeatmap beatmap) { if (!(beatmap is OsuBeatmap osuBeatmap)) return; var hitObjects = osuBeatmap.HitObjects; Seed.Value ??= RNG.Next(); rng = new Random((int)Seed.Value); RandomObjectInfo previous = null; float rateOfChangeMultiplier = 0; for (int i = 0; i < hitObjects.Count; i++) { var hitObject = hitObjects[i]; var current = new RandomObjectInfo(hitObject); // rateOfChangeMultiplier only changes every 5 iterations in a combo // to prevent shaky-line-shaped streams if (hitObject.IndexInCurrentCombo % 5 == 0) rateOfChangeMultiplier = (float)rng.NextDouble() * 2 - 1; if (hitObject is Spinner) { previous = null; continue; } applyRandomisation(rateOfChangeMultiplier, previous, current); // Move hit objects back into the playfield if they are outside of it, // which would sometimes happen during big jumps otherwise. current.PositionRandomised = clampToPlayfield(current.PositionRandomised, (float)hitObject.Radius); hitObject.Position = current.PositionRandomised; // update end position as it may have changed as a result of the position update. current.EndPositionRandomised = current.PositionRandomised; if (hitObject is Slider slider) { Vector2 shift = moveSliderIntoPlayfield(slider, current); if (shift != Vector2.Zero) { var toBeShifted = new List(); for (int j = i - 1; j >= i - shift_object_count && j >= 0; j--) { // only shift hit circles if (!(hitObjects[j] is HitCircle)) break; toBeShifted.Add(hitObjects[j]); } if (toBeShifted.Count > 0) applyDecreasingShift(toBeShifted, shift); } } previous = current; } } /// /// Returns the final position of the hit object /// /// Final position of the hit object private void applyRandomisation(float rateOfChangeMultiplier, RandomObjectInfo previous, RandomObjectInfo current) { if (previous == null) { var playfieldSize = OsuPlayfield.BASE_SIZE; current.AngleRad = (float)(rng.NextDouble() * 2 * Math.PI - Math.PI); current.PositionRandomised = new Vector2((float)rng.NextDouble() * playfieldSize.X, (float)rng.NextDouble() * playfieldSize.Y); return; } float distanceToPrev = Vector2.Distance(previous.EndPositionOriginal, current.PositionOriginal); // The max. angle (relative to the angle of the vector pointing from the 2nd last to the last hit object) // is proportional to the distance between the last and the current hit object // to allow jumps and prevent too sharp turns during streams. // Allow maximum jump angle when jump distance is more than half of playfield diagonal length var randomAngleRad = rateOfChangeMultiplier * 2 * Math.PI * Math.Min(1f, distanceToPrev / (playfield_diagonal * 0.5f)); current.AngleRad = (float)randomAngleRad + previous.AngleRad; if (current.AngleRad < 0) current.AngleRad += 2 * (float)Math.PI; var posRelativeToPrev = new Vector2( distanceToPrev * (float)Math.Cos(current.AngleRad), distanceToPrev * (float)Math.Sin(current.AngleRad) ); posRelativeToPrev = OsuHitObjectGenerationUtils.RotateAwayFromEdge(previous.EndPositionRandomised, posRelativeToPrev); current.AngleRad = (float)Math.Atan2(posRelativeToPrev.Y, posRelativeToPrev.X); current.PositionRandomised = previous.EndPositionRandomised + posRelativeToPrev; } /// /// Moves the and all necessary nested s into the if they aren't already. /// /// The that this slider has been shifted by. private Vector2 moveSliderIntoPlayfield(Slider slider, RandomObjectInfo currentObjectInfo) { var minMargin = getSliderBoundingBox(slider); var prevPosition = slider.Position; slider.Position = new Vector2( Math.Clamp(slider.Position.X, minMargin.Left, minMargin.Right), Math.Clamp(slider.Position.Y, minMargin.Top, minMargin.Bottom) ); currentObjectInfo.PositionRandomised = slider.Position; currentObjectInfo.EndPositionRandomised = slider.EndPosition; shiftNestedObjects(slider, currentObjectInfo.PositionRandomised - currentObjectInfo.PositionOriginal); return slider.Position - prevPosition; } /// /// Decreasingly shift a list of s by a specified amount. /// The first item in the list is shifted by the largest amount, while the last item is shifted by the smallest amount. /// /// The list of hit objects to be shifted. /// The amount to be shifted. private void applyDecreasingShift(IList hitObjects, Vector2 shift) { for (int i = 0; i < hitObjects.Count; i++) { var hitObject = hitObjects[i]; // The first object is shifted by a vector slightly smaller than shift // The last object is shifted by a vector slightly larger than zero Vector2 position = hitObject.Position + shift * ((hitObjects.Count - i) / (float)(hitObjects.Count + 1)); hitObject.Position = clampToPlayfield(position, (float)hitObject.Radius); } } /// /// Calculates the bounding box of a 's position for the slider to be fully inside of the playfield. /// private RectangleF getSliderBoundingBox(Slider slider) { var pathPositions = new List(); slider.Path.GetPathToProgress(pathPositions, 0, 1); var box = new RectangleF(); foreach (var pos in pathPositions) { box.X = Math.Max(box.X, -pos.X); box.Y = Math.Max(box.Y, -pos.Y); box.Width = Math.Min(box.Width, OsuPlayfield.BASE_SIZE.X - pos.X - box.X); box.Height = Math.Min(box.Height, OsuPlayfield.BASE_SIZE.Y - pos.Y - box.Y); } var radius = (float)slider.Radius; box.X += radius; box.Y += radius; box.Width -= radius * 2; box.Height -= radius * 2; // If the slider is larger than the playfield, force the slider to stay at its original position if (box.Width < 0) { box.Width = 0; box.X = slider.Position.X; } if (box.Height < 0) { box.Height = 0; box.Y = slider.Position.Y; } return box; } /// /// Shifts all nested s and s by the specified shift. /// /// whose nested s and s should be shifted /// The the 's nested s and s should be shifted by private void shiftNestedObjects(Slider slider, Vector2 shift) { foreach (var hitObject in slider.NestedHitObjects.Where(o => o is SliderTick || o is SliderRepeat)) { if (!(hitObject is OsuHitObject osuHitObject)) continue; osuHitObject.Position += shift; } } private Vector2 clampToPlayfield(Vector2 position, float radius) { position.X = MathHelper.Clamp(position.X, radius, OsuPlayfield.BASE_SIZE.X - radius); position.Y = MathHelper.Clamp(position.Y, radius, OsuPlayfield.BASE_SIZE.Y - radius); return position; } private class RandomObjectInfo { public float AngleRad { get; set; } public Vector2 PositionOriginal { get; } public Vector2 PositionRandomised { get; set; } public Vector2 EndPositionOriginal { get; } public Vector2 EndPositionRandomised { get; set; } public RandomObjectInfo(OsuHitObject hitObject) { PositionRandomised = PositionOriginal = hitObject.Position; EndPositionRandomised = EndPositionOriginal = hitObject.EndPosition; AngleRad = 0; } } } }