Skip to content

Commit

Permalink
added documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
DavidBeh committed Dec 1, 2024
1 parent bfddf5a commit ff35f6a
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions osu.Game/Rulesets/Mods/ModHidden.cs
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,6 @@ void ScoreProcessorOnNewJudgement(JudgementResult judgement, bool revert = false
_combo = ComputeNewComboValue(_combo, judgement);
if (oldCombo == _combo)
return;
else
{

}
uint comboValue = GetHiddenComboInfluence(judgement);
if (comboValue == 0) return;
_combo = !judgement.IsHit ? 0 : _combo + comboValue;
Expand All @@ -97,14 +93,23 @@ void ScoreProcessorOnNewJudgement(JudgementResult judgement, bool revert = false
}
}

protected float GetAndUpdateDrawableHitObjectComboAlpha(DrawableHitObject dho, bool? hasStarted = null)
/// <summary>
/// Gets the alpha value for a hit object based on the current combo. And stores it internally.
/// Hitobjects that have already started will never have this value decreased.
/// </summary>
/// <param name="hasStarted">
/// An optional to use instead of computing it from drawableHitObject.
/// The default can handle objects implementing IHasTimePreempt.
/// </param>
/// <returns></returns>
protected float GetAndUpdateDrawableHitObjectComboAlpha(DrawableHitObject drawableHitObject, bool? hasStarted = null)

Check warning on line 105 in osu.Game/Rulesets/Mods/ModHidden.cs

View workflow job for this annotation

GitHub Actions / Build only (iOS)

Parameter 'drawableHitObject' has no matching param tag in the XML comment for 'ModHidden.GetAndUpdateDrawableHitObjectComboAlpha(DrawableHitObject, bool?)' (but other parameters do)

Check warning on line 105 in osu.Game/Rulesets/Mods/ModHidden.cs

View workflow job for this annotation

GitHub Actions / Build only (iOS)

Parameter 'drawableHitObject' has no matching param tag in the XML comment for 'ModHidden.GetAndUpdateDrawableHitObjectComboAlpha(DrawableHitObject, bool?)' (but other parameters do)

Check failure on line 105 in osu.Game/Rulesets/Mods/ModHidden.cs

View workflow job for this annotation

GitHub Actions / Test (Windows, windows-latest, SingleThread)

Parameter 'drawableHitObject' has no matching param tag in the XML comment for 'ModHidden.GetAndUpdateDrawableHitObjectComboAlpha(DrawableHitObject, bool?)' (but other parameters do)

Check failure on line 105 in osu.Game/Rulesets/Mods/ModHidden.cs

View workflow job for this annotation

GitHub Actions / Test (Windows, windows-latest, SingleThread)

Parameter 'drawableHitObject' has no matching param tag in the XML comment for 'ModHidden.GetAndUpdateDrawableHitObjectComboAlpha(DrawableHitObject, bool?)' (but other parameters do)

Check failure on line 105 in osu.Game/Rulesets/Mods/ModHidden.cs

View workflow job for this annotation

GitHub Actions / Code Quality

Parameter 'drawableHitObject' has no matching param tag in the XML comment for 'ModHidden.GetAndUpdateDrawableHitObjectComboAlpha(DrawableHitObject, bool?)' (but other parameters do)

Check failure on line 105 in osu.Game/Rulesets/Mods/ModHidden.cs

View workflow job for this annotation

GitHub Actions / Code Quality

Parameter 'drawableHitObject' has no matching param tag in the XML comment for 'ModHidden.GetAndUpdateDrawableHitObjectComboAlpha(DrawableHitObject, bool?)' (but other parameters do)

Check failure on line 105 in osu.Game/Rulesets/Mods/ModHidden.cs

View workflow job for this annotation

GitHub Actions / Test (Windows, windows-latest, MultiThreaded)

Parameter 'drawableHitObject' has no matching param tag in the XML comment for 'ModHidden.GetAndUpdateDrawableHitObjectComboAlpha(DrawableHitObject, bool?)' (but other parameters do)

Check failure on line 105 in osu.Game/Rulesets/Mods/ModHidden.cs

View workflow job for this annotation

GitHub Actions / Test (Windows, windows-latest, MultiThreaded)

Parameter 'drawableHitObject' has no matching param tag in the XML comment for 'ModHidden.GetAndUpdateDrawableHitObjectComboAlpha(DrawableHitObject, bool?)' (but other parameters do)

Check failure on line 105 in osu.Game/Rulesets/Mods/ModHidden.cs

View workflow job for this annotation

GitHub Actions / Test (Linux, ubuntu-latest, SingleThread)

Parameter 'drawableHitObject' has no matching param tag in the XML comment for 'ModHidden.GetAndUpdateDrawableHitObjectComboAlpha(DrawableHitObject, bool?)' (but other parameters do)

Check failure on line 105 in osu.Game/Rulesets/Mods/ModHidden.cs

View workflow job for this annotation

GitHub Actions / Test (Linux, ubuntu-latest, SingleThread)

Parameter 'drawableHitObject' has no matching param tag in the XML comment for 'ModHidden.GetAndUpdateDrawableHitObjectComboAlpha(DrawableHitObject, bool?)' (but other parameters do)

Check failure on line 105 in osu.Game/Rulesets/Mods/ModHidden.cs

View workflow job for this annotation

GitHub Actions / Test (Linux, ubuntu-latest, MultiThreaded)

Parameter 'drawableHitObject' has no matching param tag in the XML comment for 'ModHidden.GetAndUpdateDrawableHitObjectComboAlpha(DrawableHitObject, bool?)' (but other parameters do)

Check failure on line 105 in osu.Game/Rulesets/Mods/ModHidden.cs

View workflow job for this annotation

GitHub Actions / Test (Linux, ubuntu-latest, MultiThreaded)

Parameter 'drawableHitObject' has no matching param tag in the XML comment for 'ModHidden.GetAndUpdateDrawableHitObjectComboAlpha(DrawableHitObject, bool?)' (but other parameters do)
{
if (EnableAtCombo.Value == 0) return 0;
HitObject? ho = dho.HitObject;
HitObject? ho = drawableHitObject.HitObject;

hasStarted ??= ho.StartTime - ((ho as IHasTimePreempt)?.TimePreempt ?? 0) < dho.Time.Current;
hasStarted ??= ho.StartTime - ((ho as IHasTimePreempt)?.TimePreempt ?? 0) < drawableHitObject.Time.Current;

if (_opacityTable.TryGetValue(dho.HitObject, out float alpha))
if (_opacityTable.TryGetValue(drawableHitObject.HitObject, out float alpha))
{
if (_alpha > alpha || !hasStarted.Value)
{
Expand Down

0 comments on commit ff35f6a

Please sign in to comment.