[Feature]: Pause/resume main update routine

[phoenixbf]

Problem or use case

Hi all,
in multiple scenarios it may be helpful to pause (or resume) easily the main Spark update routine (including GS sorting, etc.)

Proposed solution

add pause/resume methods on the main Spark update routine setup by the plugin? or a way to access it directly at runtime

Alternatives considered

No response

Integration context

No response

Additional context

No response

[WilliamLiu-1997]

getSparkRendererForScene function will return the SparkRenderer in the scene, then you can do any process you want. But I guess spark does not have such feature to pause/resume the main Spark update routine?

[WilliamLiu-1997]

This plugin uses SparkRenderer.updateInternal for the update, maybe you can try temporary override this function when you want to pause, and recover when you want to resume?

[phoenixbf]

One way is through SparkRenderer.autoUpdate = false and SparkRenderer.autoUpdate = true

although I cannot find a way to override SparkRenderer.updateInternal

[WilliamLiu-1997]

type SparkUpdateInternal = (options: unknown) => Promise<unknown>;
type SparkRendererDebug = NonNullable<
  ReturnType<typeof getSparkRendererForScene>
> & {
  updateInternal: SparkUpdateInternal;
};

let originalSparkUpdateInternal: SparkUpdateInternal | null = null;
const setSparkUpdateInternalEnabled = (enabled: boolean) => {
  const sparkRenderer = getSparkRendererForScene(
    scene,
  ) as SparkRendererDebug | null;

  if (!sparkRenderer) {
    return;
  }

  originalSparkUpdateInternal ??= sparkRenderer.updateInternal;
  sparkRenderer.updateInternal = enabled
    ? originalSparkUpdateInternal
    : async () => undefined;
};

Then call setSparkUpdateInternalEnabled(true/false)