Skip to main content

settings.get_cvars

Overview

  • Get current Unreal Engine console variable values as JSON. Filter by comma-separated category prefixes (e.g. --category=r,sg matches r.* and sg.*). Omit --category to return all console variables. IConsoleCommand entries (no value) are excluded.

Metadata

FieldValue
DisplayGet Console Variables
Categorysettings
AccessPublic
ScopeB1Standalone
Tags
Aliases

Parameters

NameTypeRequiredDefaultDescription
categorystringnoComma-separated category prefixes, e.g. 'r,sg,scalability'. Omit to return all cvars.

Returns

Returns a JSON object with the following fields:

FieldTypeRequiredDescription
countintyesNumber of console variables returned
categoriesarrayyesRequested category prefixes (empty when unfiltered)
cvarsarrayyesMatched console variables
cvars[].namestringyesConsole variable name
cvars[].valuestringyesConsole variable value

Usage

await inzoi.cli.execute('settings.get_cvars', {
category: '', // optional
});