Add xmldoc mention about performance overhead of PerformOnSelection()

This commit is contained in:
Bartłomiej Dach 2024-06-04 10:36:30 +02:00
parent f13ca28d5e
commit ecfcf7a2c0
No known key found for this signature in database

View File

@ -198,6 +198,11 @@ namespace osu.Game.Screens.Edit
/// Perform the provided action on every selected hitobject.
/// Changes will be grouped as one history action.
/// </summary>
/// <remarks>
/// Note that this incurs a full state save, and as such requires the entire beatmap to be encoded, etc.
/// Very frequent use of this method (e.g. once a frame) is most discouraged.
/// If there is need to do so, use local precondition checks to eliminate changes that are known to be no-ops.
/// </remarks>
/// <param name="action">The action to perform.</param>
public void PerformOnSelection(Action<HitObject> action)
{