Skip to content

Make text asset caching opt-in #273

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
NotHyper-474 wants to merge 1 commit into
base: experimental
Choose a base branch
from
+30 −8
Open

Make text asset caching opt-in #273

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 22 additions & 4 deletions polymod/PolymodConfig.hx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,12 +241,30 @@ class PolymodConfig
*
* @default `true`
*/
public static var caseInsensitiveZipLoading(get, default):Null<Bool>;
public static var caseInsensitiveZipLoading(get, default):Null<Bool>;

static function get_caseInsensitiveZipLoading():Null<Bool>
{
static function get_caseInsensitiveZipLoading():Null<Bool>
{
if (caseInsensitiveZipLoading == null)
caseInsensitiveZipLoading = DefineUtil.getDefineBool('POLYMOD_ZIP_INSENSITIVE', true);
return caseInsensitiveZipLoading;
}
}

/**
* Whether the contents of text assets are cached, so that they're loaded faster.
* Don't enable this if mods need to modify these assets.
*
* Enable this option by setting the `POLYMOD_ENABLE_TEXT_CACHE` Haxe define at compile time,
* or by setting this value in your code.
*
* @default `false`
*/
public static var enableTextCache(get, default):Null<Bool>;

static function get_enableTextCache():Null<Bool>
{
if (enableTextCache == null)
enableTextCache = DefineUtil.getDefineBool('POLYMOD_ENABLE_TEXT_CACHE', false);
return enableTextCache;
}
}
12 changes: 8 additions & 4 deletions polymod/backends/PolymodAssetLibrary.hx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,14 +184,18 @@ class PolymodAssetLibrary
public function mergeAndAppendText(id:String, modText:String):String
{
var cacheKey = PolymodConfig.mergeFolder + id;
if (_textCache.exists(cacheKey))
if (PolymodConfig.enableTextCache && _textCache.exists(cacheKey))
{
return _textCache.get(cacheKey);
}

modText = Util.mergeAndAppendText(modText, id, dirs, getTextDirectly, fileSystem, parseRules);

_textCache.set(cacheKey, modText);
if (PolymodConfig.enableTextCache)
{
_textCache.set(cacheKey, modText);
}

return modText;
}

Expand Down Expand Up @@ -249,14 +253,14 @@ class PolymodAssetLibrary

public function getText(id:String):String
{
if (_textCache.exists(id))
if (PolymodConfig.enableTextCache && _textCache.exists(id))
{
return _textCache.get(id);
}

var result = backend.getText(id);

if (result != null)
if (PolymodConfig.enableTextCache && result != null)
{
_textCache.set(id, result);
}
Expand Down