WScript API Documentation

WScript API Documentation

The following method list is auto-generated from WolvenKit Source.

Overview

AppScriptFunctions

TODO.

Method	Description
SuspendFileWatcher	Turn on/off updates to the project tree, useful for when making lots of changes to the project structure.
SaveToProject	Add the specified CR2WFile or IGameFile file to the project.
SaveToRaw	Save the specified text to the specified path in the raw folder.
SaveToResources	Save the specified text to the specified path in the resources folder.
LoadFromResources	Loads the content of a text file from resources.
LoadGameFileFromProject	Loads the specified game file from the project files rather than game archives.
LoadRawJsonFromProject	Loads the specified json file from the project raw files rather than game archives.
GetProjectFiles	Retrieves a list of files from the project.
ClearExportFileLookup	Clears the lookup for exported depot files.
ExportFiles	Exports a list of files as you would with the export tool.
GetFileFromProject	Loads a file from the project using either a file path or hash.
GetFile	Loads a file from the project or archive (in this order) using either a file path or hash.
FileExistsInProject	Check if file exists in the project.
FileExists	Check if file exists in either the game archives or the project.
FileExistsInRaw	Check if file exists in the project Raw folder.
DeleteFile	Deletes a file from the project, if it exists.
GetRecords	Loads all records as TweakDBID paths.
GetFlats	Loads all flats as TweakDBID paths.
GetQueries	Loads all queries as TweakDBID paths.
GetGroupTags	Loads all group tags as TweakDBID paths.
GetRecord	Loads a record by its TweakDBID path.
GetFlat	Loads a flat by its TweakDBID path.
GetQuery	Loads flats of a query by its TweakDBID path.
GetGroupTag	Loads a group tag by its TweakDBID path.
HasTDBID	Whether TweakDBID path exists as a flat or a record?
GetTDBIDPath	Tries to get TweakDBID path from its hash.
ShowMessageBox	Displays a message box.
Extract	Extracts a file from the base archive and adds it to the project.
GetActiveDocument	Gets the current active document from the docking manager.
GetDocuments	Gets all documents from the docking manager.
OpenDocument	Opens a file in WolvenKit .
ExportGeometryCacheEntry	Exports an geometry_cache entry.
CreateInstanceAsJSON	Creates a new instance of the given class, and returns it converted to a JSON string.
HashString	Returns the hashcode for a given string.
Sleep	Pauses the execution of the script for the specified amount of milliseconds.
ProgramVersion	Returns the current wolvenkit version.
ShowSettings	Shows the settings dialog for the supplied data.
SaveAs	No description available.
GetBaseFolder	No description available.
ParseExportSettings	No description available.
GetGlobalExportArgs	No description available.
ConvertTDBToPath	No description available.
ConvertTDBToJson	No description available.

ScriptDocumentWrapper

TODO.

Method	Description
GetGameFile	Gets the game file.
Save	Saves the document.
Reload	Reloads the document.
Close	Closes the document without saving.

ScriptFunctions

TODO.

Method	Description
GetArchiveFiles	Gets a list of the files available in the game archives Note to myself: Don't use IEnumerable
GetFileFromBase	DEPRECATED: Please use GetFileFromArchive(path, OpenAs.GameFile) Loads a file from the base archives using either a file path or hash.
GameFileToJson	Creates a json representation of the specifed game file.
JsonToCR2W	Creates a CR2W game file from a json.
ChangeExtension	Changes the extension of the provided string path.
GetFileFromArchive	Loads a file from the base archives using either a file path or hash.
FileExistsInArchive	Check if file exists in the game archives.
YamlToJson	Converts a YAML string to a JSON string.
JsonToYaml	Converts a JSON string to a YAML string.
ConvertGameFile	No description available.

UiScriptFunctions

Method	Description
AddMenuItem	No description available.

---

Detailed Documentation

AppScriptFunctions

TODO.

SuspendFileWatcher

Turn on/off updates to the project tree, useful for when making lots of changes to the project structure.

Parameter	Description
suspend	bool for if updates are suspended

SuspendFileWatcher(suspend: bool) → void

---

SaveToProject

Add the specified CR2WFile or IGameFile file to the project.

Parameter	Description
path	The file to write to
file	CR2WFile or IGameFile to be saved

SaveToProject(path: string, file: object) → void

---

SaveToRaw

Save the specified text to the specified path in the raw folder.

Parameter	Description
path	The file to write to
content	The string to write to the file

SaveToRaw(path: string, content: string) → void

---

SaveToResources

Save the specified text to the specified path in the resources folder.

Parameter	Description
path	The file to write to
content	The string to write to the file

SaveToResources(path: string, content: string) → void

---

LoadFromResources

Loads the content of a text file from resources.

Parameter	Description
path	The relative path of the text file

Returns: The content or null

LoadFromResources(path: string) → ? string

---

LoadGameFileFromProject

Loads the specified game file from the project files rather than game archives.

Parameter	Description
path	The file to open for reading
type	The type of the object which is returned. Can be "cr2w" or "json"

LoadGameFileFromProject(path: string, type: string) → ? object

---

LoadRawJsonFromProject

Loads the specified json file from the project raw files rather than game archives.

Parameter	Description
path	The file to open for reading
type	The type of the object which is returned. Can be "cr2w" or "json"

LoadRawJsonFromProject(path: string, type: string) → ? object

---

GetProjectFiles

Retrieves a list of files from the project.

Parameter	Description
folderType	string parameter folderType = "archive" or "raw"

GetProjectFiles(folderType: string) → List< string >

---

ClearExportFileLookup

Clears the lookup for exported depot files.

ClearExportFileLookup() → void

---

ExportFiles

Exports a list of files as you would with the export tool.

Parameter	Description
fileList	—
defaultSettings	—
blocking	—

ExportFiles(fileList: IList, defaultSettings: ScriptObject? = null) → void

---

GetFileFromProject

Loads a file from the project using either a file path or hash.

Parameter	Description
path	The path of the file to retrieve
openAs	The output format (OpenAs.GameFile, OpenAs.CR2W or OpenAs.Json)

GetFileFromProject(path: string, openAs: OpenAs) → ? object

---

GetFileFromProject

Loads a file from the project using either a file path or hash.

Parameter	Description
hash	The hash of the file to retrieve
openAs	The output format (OpenAs.GameFile, OpenAs.CR2W or OpenAs.Json)

GetFileFromProject(hash: ulong, openAs: OpenAs) → ? object

---

GetFile

Loads a file from the project or archive (in this order) using either a file path or hash.

Parameter	Description
path	The path of the file to retrieve
openAs	The output format (OpenAs.GameFile, OpenAs.CR2W or OpenAs.Json)

GetFile(path: string, openAs: OpenAs) → ? object

---

GetFile

Loads a file from the project or archive (in this order) using either a file path or hash.

Parameter	Description
hash	The hash of the file to retrieve
openAs	The output format (OpenAs.GameFile, OpenAs.CR2W or OpenAs.Json)

GetFile(hash: ulong, openAs: OpenAs) → ? object

---

FileExistsInProject

Check if file exists in the project.

Parameter	Description
path	file path to check

FileExistsInProject(path: string) → bool

---

FileExistsInProject

Check if file exists in the project.

Parameter	Description
hash	hash value to be checked

FileExistsInProject(hash: ulong) → bool

---

FileExists

Check if file exists in either the game archives or the project.

Parameter	Description
path	file path to check

FileExists(path: string) → bool

---

FileExists

Check if file exists in either the game archives or the project.

Parameter	Description
hash	hash value to be checked

FileExists(hash: ulong) → bool

---

FileExistsInRaw

Check if file exists in the project Raw folder.

Parameter	Description
filepath	relative filepath to be checked

FileExistsInRaw(filepath: string) → bool

---

DeleteFile

Deletes a file from the project, if it exists.

Parameter	Description
filepath	relative filepath to be deleted
folderType	project subfolder type (archive|raw|resources)

Returns: true if the file was deleted

DeleteFile(filepath: string, folderType: string) → bool

---

GetRecords

Loads all records as TweakDBID paths.

GetRecords() → IEnumerable

---

GetFlats

Loads all flats as TweakDBID paths.

GetFlats() → IEnumerable

---

GetQueries

Loads all queries as TweakDBID paths.

GetQueries() → IEnumerable

---

GetGroupTags

Loads all group tags as TweakDBID paths.

GetGroupTags() → IEnumerable

---

GetRecord

Loads a record by its TweakDBID path.

Parameter	Description
path	—

Returns: record as a JSON string, null when not found

GetRecord(path: string) → ? string

---

GetFlat

Loads a flat by its TweakDBID path.

Returns: flat as a JSON string, null when not found

GetFlat(path: string) → ? string

---

GetQuery

Loads flats of a query by its TweakDBID path.

Returns: a list of flats as TweakDBID paths, empty when not found

GetQuery(path: string) → IEnumerable

---

GetGroupTag

Loads a group tag by its TweakDBID path.

Returns: flat as a JSON string, null when not found

GetGroupTag(path: string) → ? byte

---

HasTDBID

Whether TweakDBID path exists as a flat or a record?

Parameter	Description
path	—

HasTDBID(path: string) → bool

---

GetTDBIDPath

Tries to get TweakDBID path from its hash.

Parameter	Description
key	—

Returns: path of the hash, null when undefined

GetTDBIDPath(key: ulong) → ? string

---

ShowMessageBox

Displays a message box.

Parameter	Description
text	A string that specifies the text to display.
caption	A string that specifies the title bar caption to display.
image	A WMessageBoxImage value that specifies the icon to display.
buttons	A WMessageBoxButtons value that specifies which buttons to display.

Returns: A WMessageBoxResult value that specifies the result the message box button that was clicked by the user returned.

ShowMessageBox(text: string, caption: string, image: WMessageBoxImage, buttons: WMessageBoxButtons) → WMessageBoxResult

---

Extract

Extracts a file from the base archive and adds it to the project.

Parameter	Description
path	Path of the game file

Extract(path: string) → void

---

GetActiveDocument

Gets the current active document from the docking manager.

GetActiveDocument() → ?  ScriptDocumentWrapper

---

GetDocuments

Gets all documents from the docking manager.

GetDocuments() → ? IList<  ScriptDocumentWrapper  >

---

OpenDocument

Opens a file in WolvenKit .

Parameter	Description
path	Path to the file

Returns: Returns true if the file was opened, otherwise it returns false

OpenDocument(path: string) → bool

---

OpenDocument

Opens an archive game file.

Parameter	Description
gameFile	The game file to open

OpenDocument(gameFile: IGameFile) → void

---

ExportGeometryCacheEntry

Exports an geometry_cache entry.

Parameter	Description
sectorHashStr	Sector hash as string
entryHashStr	Entry hash as string

ExportGeometryCacheEntry(sectorHashStr: string, entryHashStr: string) → ? string

---

CreateInstanceAsJSON

Creates a new instance of the given class, and returns it converted to a JSON string.

Parameter	Description
className	Name of the class

CreateInstanceAsJSON(className: string) → ? object

---

HashString

Returns the hashcode for a given string.

Parameter	Description
data	String to be hashed
method	Hash method to use. Can be "fnv1a64" or "default" (Uses the String objects built in hash function)

HashString(data: string, method: string) → ? ulong

---

Sleep

Pauses the execution of the script for the specified amount of milliseconds.

Parameter	Description
milliseconds	The number of milliseconds to sleep.

Sleep(milliseconds: int) → void

---

ProgramVersion

Returns the current wolvenkit version.

ProgramVersion() → string

---

ShowSettings

Shows the settings dialog for the supplied data.

Parameter	Description
data	A JavaScript object containing data

Returns: Returns true when the user changed the settings, otherwise it returns false

ShowSettings(data: ScriptObject) → bool

---

SaveAs

SaveAs(path: string, action: Action< string >) → void

---

GetBaseFolder

GetBaseFolder(folderType: string) → string?

---

ParseExportSettings

ParseExportSettings< T >(scriptSettingsObject: ScriptObject) → T

---

GetGlobalExportArgs

GetGlobalExportArgs(settings: ScriptObject) → GlobalExportArgs

---

ConvertTDBToPath

ConvertTDBToPath(ids: List< TweakDBID >?) → List< string >

---

ConvertTDBToJson

ConvertTDBToJson(tdb: object?) → string?

---

ScriptDocumentWrapper

TODO.

GetGameFile

Gets the game file.

Parameter	Description
type	The output type of the game file ("cr2w" or "json")

GetGameFile(type: string) → object?

---

Save

Saves the document.

Save() → void

---

Reload

Reloads the document.

Parameter	Description
force	If force is true, any unsaved changes will be discarded

Reload(force: bool) → bool

---

Close

Closes the document without saving.

Close() → void

---

ScriptFunctions

TODO.

GetArchiveFiles

Gets a list of the files available in the game archives Note to myself: Don't use IEnumerable

GetArchiveFiles() → IEnumerable

---

GetFileFromBase

DEPRECATED: Please use GetFileFromArchive(path, OpenAs.GameFile) Loads a file from the base archives using either a file path or hash.

Parameter	Description
path	The path of the file to retrieve

GetFileFromBase(path: string) → ? IGameFile

---

GetFileFromBase

DEPRECATED: Please use GetFileFromArchive(hash, OpenAs.GameFile) Loads a file from the base archives using either a file path or hash.

Parameter	Description
hash	The hash of the file to retrieve

GetFileFromBase(hash: ulong) → ? IGameFile

---

GameFileToJson

Creates a json representation of the specifed game file.

Parameter	Description
gameFile	The gameFile which should be converted

GameFileToJson(gameFile: IGameFile) → ? string

---

JsonToCR2W

Creates a CR2W game file from a json.

Parameter	Description
json	—

JsonToCR2W(json: string) → ? CR2WFile

---

ChangeExtension

Changes the extension of the provided string path.

Parameter	Description
path	The path of the file to change
extension	—

ChangeExtension(path: string, extension: string) → string

---

GetFileFromArchive

Loads a file from the base archives using either a file path or hash.

Parameter	Description
path	The path of the file to retrieve
openAs	The output format (OpenAs.GameFile, OpenAs.CR2W or OpenAs.Json)

GetFileFromArchive(path: string, openAs: OpenAs) → ? object

---

GetFileFromArchive

Loads a file from the base archives using either a file path or hash.

Parameter	Description
hash	The hash of the file to retrieve
openAs	The output format (OpenAs.GameFile, OpenAs.CR2W or OpenAs.Json)

GetFileFromArchive(hash: ulong, openAs: OpenAs) → ? object

---

FileExistsInArchive

Check if file exists in the game archives.

Parameter	Description
path	file path to check

FileExistsInArchive(path: string) → bool

---

FileExistsInArchive

Check if file exists in the game archives.

Parameter	Description
hash	hash value to be checked

FileExistsInArchive(hash: ulong) → bool

---

YamlToJson

Converts a YAML string to a JSON string.

Parameter	Description
yamlText	The YAML string to convert

Returns: The converted JSON string

YamlToJson(yamlText: string) → string

---

JsonToYaml

Converts a JSON string to a YAML string.

Parameter	Description
jsonText	The JSON string to convert

Returns: The converted YAML string

JsonToYaml(jsonText: string) → string

---

ConvertGameFile

ConvertGameFile(gameFile: IGameFile, openAs: OpenAs) → ? object

---

UiScriptFunctions

AddMenuItem

Parameter	Description
target	—
name	—

AddMenuItem(target: string, name: string) → ScriptFunctionWrapper

---

AddMenuItem

Parameter	Description
target	—
name	—
onClick	—

AddMenuItem(target: string, name: string, onClick: ScriptObject) → ScriptFunctionWrapper

---

AddMenuItem

Parameter	Description
target	—
name	—
onClick	—
args	—

AddMenuItem(target: string, name: string, onClick: ScriptObject?, args: params object??[]) → ScriptFunctionWrapper

---

AddMenuItem

Parameter	Description
target	—
name	—
onClick	—
args	—

AddMenuItem(target: ScriptFunctionWrapper, name: string, onClick: ScriptObject? = null, args: params object??[]) → ScriptFunctionWrapper

---