sim1222/osukey
1
1
Fork 0
mirror of https://github.com/osukey/osukey.git synced 2025-07-02 00:40:09 +09:00
Code Issues Packages Projects Releases Wiki Activity

Add doc comments to HitObjectEntryManager

Browse Source
This commit is contained in:
ekrctb
2021-06-16 15:09:01 +09:00
committed by Dean Herbert
parent bde390828b
commit 47539e2129
1 changed files with 25 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
osu.Game/Rulesets/Objects/Pooling/HitObjectEntryManager.cs
View File

@ -19,13 +19,38 @@ namespace osu.Game.Rulesets.Objects.Pooling
/// </summary> /// </summary>
public IEnumerable<HitObjectLifetimeEntry> AllEntries => entryMap.Values; public IEnumerable<HitObjectLifetimeEntry> AllEntries => entryMap.Values;
/// <summary>
/// Invoked when a new <see cref="HitObjectLifetimeEntry"/> is added to this <see cref="HitObjectEntryManager"/>..
/// The second parameter of the event is the parent hit object.
/// </summary>
public event Action<HitObjectLifetimeEntry, HitObject?>? OnEntryAdded; public event Action<HitObjectLifetimeEntry, HitObject?>? OnEntryAdded;
/// <summary>
/// Invoked when a <see cref="HitObjectLifetimeEntry"/> is removed from this <see cref="HitObjectEntryManager"/>.
/// The second parameter of the event is the parent hit object.
/// </summary>
public event Action<HitObjectLifetimeEntry, HitObject?>? OnEntryRemoved; public event Action<HitObjectLifetimeEntry, HitObject?>? OnEntryRemoved;
private readonly Func<HitObject, HitObjectLifetimeEntry> createLifetimeEntry; private readonly Func<HitObject, HitObjectLifetimeEntry> createLifetimeEntry;
/// <summary>
/// Provides the reverse mapping of <see cref="HitObjectLifetimeEntry.HitObject"/> for each entry.
/// </summary>
private readonly Dictionary<HitObject, HitObjectLifetimeEntry> entryMap = new Dictionary<HitObject, HitObjectLifetimeEntry>(); private readonly Dictionary<HitObject, HitObjectLifetimeEntry> entryMap = new Dictionary<HitObject, HitObjectLifetimeEntry>();
/// <summary>
/// Stores the parent hit object for entries of the nested hit objects.
/// A <c>null</c> is stored for entries of the top-level hit objects.
/// </summary>
/// <remarks>
/// The parent hit object of a pooled hit object may be non-pooled.
/// In that case, no corresponding <see cref="HitObjectLifetimeEntry"/> is stored in this <see cref="HitObjectEntryManager"/>.
/// </remarks>
private readonly Dictionary<HitObjectLifetimeEntry, HitObject?> parentMap = new Dictionary<HitObjectLifetimeEntry, HitObject?>(); private readonly Dictionary<HitObjectLifetimeEntry, HitObject?> parentMap = new Dictionary<HitObjectLifetimeEntry, HitObject?>();
/// <summary>
/// Stores the list of entries managed by this <see cref="HitObjectEntryManager"/> for each hit object managed by this <see cref="HitObjectEntryManager"/>.
/// </summary>
private readonly Dictionary<HitObject, List<HitObjectLifetimeEntry>> childrenMap = new Dictionary<HitObject, List<HitObjectLifetimeEntry>>(); private readonly Dictionary<HitObject, List<HitObjectLifetimeEntry>> childrenMap = new Dictionary<HitObject, List<HitObjectLifetimeEntry>>();
public HitObjectEntryManager(Func<HitObject, HitObjectLifetimeEntry> createLifetimeEntry) public HitObjectEntryManager(Func<HitObject, HitObjectLifetimeEntry> createLifetimeEntry)