Skip to content

Add CLEAR_ASSET_CACHE_ON_STATE_SWITCH #1083

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
HEIHUAa wants to merge 2 commits into
base: internal-merge
Choose a base branch
from
Open

Add CLEAR_ASSET_CACHE_ON_STATE_SWITCH #1083

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
39a8611
Flags.CLEAR_ASSET_CACHE_ON_STATE_SWITCH
HEIHUAa Aug 22, 2026
4b942e7
graphic.key
HEIHUAa Aug 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions source/funkin/backend/system/Flags.hx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,14 @@ class Flags {
public static var DISABLE_LANGUAGES:Bool = false;
public static var DISABLE_AUTOUPDATER:Bool = false;

/**
* DEBUG ONLY — REMEMBER TO REMOVE THIS BEFORE SHIPPING YOUR MOD!
* When enabled, every asset cache (textures, sounds, fonts, shaders)
* is cleared on every state switch/reload, forcing a re-fetch from disk as if the game just started.
* This flag exists purely for debugging stale asset issues and must be deleted from release builds.
*/
public static var CLEAR_ASSET_CACHE_ON_STATE_SWITCH:Bool = false;

@:also(funkin.backend.MusicBeatTransition.script)
public static var DEFAULT_TRANSITION_SCRIPT:String = "";
@:also(funkin.menus.PauseSubState.script)
Expand Down
46 changes: 46 additions & 0 deletions source/funkin/backend/system/modules/FunkinCache.hx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,34 @@ class FunkinCache extends AssetCache {
FlxG.signals.postStateSwitch.add(function() {
instance.clearSecondLayer();
});

FlxG.signals.preStateCreate.add(function(_) {
if (Flags.CLEAR_ASSET_CACHE_ON_STATE_SWITCH)
clearAllCaches();
});
}

/**
Clears every asset cache (textures, sounds, fonts, shader programs) so everything is re-fetched from disk, as if the game just started.
**/
public static function clearAllCaches() {
@:privateAccess
for (graphic in [for (g in FlxG.bitmap._cache) g]) {
if (graphic != null && graphic.assetsKey != null)
FlxG.bitmap.removeByKey(graphic.key);
}
if (instance != null)
instance.clearAll();
clearShaderProgramCache();
}

/**
Clears openfl's compiled shader program cache, so edited shaders get recompiled on next use.
**/
public static function clearShaderProgramCache() {
@:privateAccess
if (FlxG.stage != null && FlxG.stage.context3D != null && FlxG.stage.context3D.__programs != null)
FlxG.stage.context3D.__programs.clear();
}

public function moveToSecondLayer() {
Expand All @@ -53,6 +81,24 @@ class FunkinCache extends AssetCache {
sound = [];
}

/**
Completely clears both cache layers (including lime's own asset cache),
**/
public function clearAll() {
for (k in [for (k in bitmapData.keys()) k])
removeBitmapData(k);
for (k in [for (k in bitmapData2.keys()) k])
removeBitmapData(k);
for (k in [for (k in font.keys()) k])
removeFont(k);
for (k in [for (k in font2.keys()) k])
removeFont(k);
for (k in [for (k in sound.keys()) k])
removeSound(k);
for (k in [for (k in sound2.keys()) k])
removeSound(k);
}

public function clearSecondLayer() {
for(k=>b in bitmapData2) {
FlxG.bitmap.removeByKey(k);
Expand Down