xScal Scaleform API 0.4.34

SFE legacy

Old callback names kept so existing mods work without changes.

File writers take the file content as the only argument. Replace targets accept an empty string and truncate the file; the append target rejects an empty string. They copy the content into xScal's file queue and return true when the request is accepted, not when the file is written. The queue holds at most 64 requests and 20 MiB; one request is at most 5 MiB. Only a completed write is logged. A request accepted just before the game exits may not be written.

log

FCM diagnostic log

__SFCodeObj.call("log", payload:Object):Boolean

Arguments

NameTypeDescription
payloadObjectObject with vendor, message, level, category.

Returns Boolean

True when accepted, false for an invalid payload.

Writes message to xscal.log with an FCM: prefix. vendor must be FCMChatWidget and message must be a string. level and category are ignored.

writeBuffDataFile

Replace Data\BuffData.ini

__SFCodeObj.call("writeBuffDataFile", content:String):Boolean

Arguments

NameTypeDescription
contentStringComplete file content, at most 5 MiB.

Returns Boolean

True when the content was accepted and queued, false when it was rejected or the queue is full.

writeChallengeDataFile

Replace Data\ChallengeData.ini

__SFCodeObj.call("writeChallengeDataFile", content:String):Boolean

Arguments

NameTypeDescription
contentStringComplete file content, at most 5 MiB.

Returns Boolean

True when the content was accepted and queued, false when it was rejected or the queue is full.

writePerksFile

Replace Data\perkloadoutmanager.ini

__SFCodeObj.call("writePerksFile", content:String):Boolean

Arguments

NameTypeDescription
contentStringComplete file content, at most 5 MiB.

Returns Boolean

True when the content was accepted and queued, false when it was rejected or the queue is full.

writeSaveEverythingFile

Replace Data\saveeverything.ini

__SFCodeObj.call("writeSaveEverythingFile", content:String):Boolean

Arguments

NameTypeDescription
contentStringComplete file content, at most 5 MiB.

Returns Boolean

True when the content was accepted and queued, false when it was rejected or the queue is full.

writeItemsModFile

Replace Data\itemsmod.ini

__SFCodeObj.call("writeItemsModFile", content:String):Boolean

Arguments

NameTypeDescription
contentStringComplete file content, at most 5 MiB.

Returns Boolean

True when the content was accepted and queued, false when it was rejected or the queue is full.

writeLegendaryModsFile

Replace Data\LegendaryMods.ini

__SFCodeObj.call("writeLegendaryModsFile", content:String):Boolean

Arguments

NameTypeDescription
contentStringComplete file content, at most 5 MiB.

Returns Boolean

True when the content was accepted and queued, false when it was rejected or the queue is full.

writeVendorLogFile

Append to Data\vendorlog.txt

__SFCodeObj.call("writeVendorLogFile", content:String):Boolean

Arguments

NameTypeDescription
contentStringComplete file content, at most 5 MiB.

Returns Boolean

True when the content was accepted and queued, false when it was rejected or the queue is full.

writeDPSMeterFile

Replace Data\DPSMeter.txt

__SFCodeObj.call("writeDPSMeterFile", content:String):Boolean

Arguments

NameTypeDescription
contentStringComplete file content, at most 5 MiB.

Returns Boolean

True when the content was accepted and queued, false when it was rejected or the queue is full.

writeCampSearchConfigFile

Replace Data\CAMPSearch.ini

__SFCodeObj.call("writeCampSearchConfigFile", content:String):Boolean

Arguments

NameTypeDescription
contentStringComplete file content, at most 5 MiB.

Returns Boolean

True when the content was accepted and queued, false when it was rejected or the queue is full.

writeBlockFile

Replace Data\configuration\blocklist.ini

__SFCodeObj.call("writeBlockFile", content:String):Boolean

Arguments

NameTypeDescription
contentStringComplete file content, at most 5 MiB.

Returns Boolean

True when the content was accepted and queued, false when it was rejected or the queue is full.

writeCampDataFile

Replace Data\CampData.ini

__SFCodeObj.call("writeCampDataFile", content:String):Boolean

Arguments

NameTypeDescription
contentStringComplete file content, at most 5 MiB.

Returns Boolean

True when the content was accepted and queued, false when it was rejected or the queue is full.

writeCharacterDataFile

Replace Data\CharacterData.ini

__SFCodeObj.call("writeCharacterDataFile", content:String):Boolean

Arguments

NameTypeDescription
contentStringComplete file content, at most 5 MiB.

Returns Boolean

True when the content was accepted and queued, false when it was rejected or the queue is full.