Class Config

Project-wide configuration configurable for runtime override.

Inheritance

System.Object

Config

Namespace: GDX

Syntax

public static class Config

Remarks

Field order matters to the Config Generator.

Fields

BuildInfo

Should the BuildInfo file be written during builds?

Declaration

[OriginalValue(false)]
public static bool BuildInfo

Field Value

Type	Description
System.Boolean

BuildInfoAssemblyDefinition

Ensure that there is an assembly definition wrapping the generated content.

Declaration

[OriginalValue(true)]
public static bool BuildInfoAssemblyDefinition

Field Value

Type	Description
System.Boolean

BuildInfoBuildChangelistArgument

The argument key for the build's changelist to be passed to the BuildInfoGenerator.

Declaration

[OriginalValue("BUILD_CHANGELIST")]
public static string BuildInfoBuildChangelistArgument

Field Value

Type	Description
System.String

BuildInfoBuildDescriptionArgument

The argument key for the build description to be passed to the BuildInfoGenerator.

Declaration

[OriginalValue("BUILD_DESC")]
public static string BuildInfoBuildDescriptionArgument

Field Value

Type	Description
System.String

BuildInfoBuildNumberArgument

The argument key for the build number to be passed to the BuildInfoGenerator.

Declaration

[OriginalValue("BUILD")]
public static string BuildInfoBuildNumberArgument

Field Value

Type	Description
System.String

BuildInfoBuildStreamArgument

The argument key for the build's stream to be passed to the BuildInfoGenerator.

Declaration

[OriginalValue("BUILD_STREAM")]
public static string BuildInfoBuildStreamArgument

Field Value

Type	Description
System.String

BuildInfoBuildTaskArgument

The argument key for the build's task to be passed to the BuildInfoGenerator.

Declaration

[OriginalValue("BUILD_TASK")]
public static string BuildInfoBuildTaskArgument

Field Value

Type	Description
System.String

BuildInfoNamespace

The namespace where the BuildInfo should be placed.

Declaration

[OriginalValue("Generated.Build")]
public static string BuildInfoNamespace

Field Value

Type	Description
System.String

BuildInfoOutputPath

The path to output the BuildInfo file.

Declaration

[OriginalValue("Generated/Build/BuildInfo.cs")]
public static string BuildInfoOutputPath

Field Value

Type	Description
System.String

CommandLineParserArgumentPrefix

What should be used to denote arguments in the command line?

Declaration

[OriginalValue("--")]
public static string CommandLineParserArgumentPrefix

Field Value

Type	Description
System.String

CommandLineParserArgumentSplit

What should be used to split arguments from their values in the command line?

Declaration

[OriginalValue("=")]
public static string CommandLineParserArgumentSplit

Field Value

Type	Description
System.String

ConfigOutputPath

The asset database relative path of the GDX config override file.

Declaration

[OriginalValue("Generated/GDX.generated.cs")]
public static string ConfigOutputPath

Field Value

Type	Description
System.String

EditorTaskDirectorSystem

Should the Editor Task Director tick the Task Director.

Declaration

[OriginalValue(true)]
public static bool EditorTaskDirectorSystem

Field Value

Type	Description
System.Boolean

EditorTaskDirectorSystemTickRate

How often should the editor task director tick trigger the task director to tick?

Declaration

[OriginalValue(0.5)]
public static double EditorTaskDirectorSystemTickRate

Field Value

Type	Description
System.Double

EnvironmentDeveloperConsole

Should the GDX tools menu be added in the editor?

Declaration

[OriginalValue(true)]
public static bool EnvironmentDeveloperConsole

Field Value

Type	Description
System.Boolean

EnvironmentScriptingDefineSymbol

Should a GDX scripting define symbol be added to all target build groups.

Declaration

[OriginalValue(false)]
public static bool EnvironmentScriptingDefineSymbol

Field Value

Type	Description
System.Boolean

EnvironmentToolsMenu

Should the GDX tools menu be added in the editor?

Declaration

[OriginalValue(false)]
public static bool EnvironmentToolsMenu

Field Value

Type	Description
System.Boolean

FormatVersion

A reference number to what version the config was generated based off of.

Declaration

public const int FormatVersion = 2

Field Value

Type	Description
System.Int32

LocalizationDefaultCulture

The language to set the default thread culture too.

Declaration

[OriginalValue(Localization.Language.English)]
public static Localization.Language LocalizationDefaultCulture

Field Value

Type	Description
Localization.Language

LocalizationSetDefaultCulture

Should the default thread culture be set?

Declaration

[OriginalValue(true)]
public static bool LocalizationSetDefaultCulture

Field Value

Type	Description
System.Boolean

PlatformAutomationFolder

The project relative path where automation should store its artifacts.

Declaration

[OriginalValue("GDX_Automation")]
public static string PlatformAutomationFolder

Field Value

Type	Description
System.String

PlatformCacheFolder

The project relative path to use as a cache.

Declaration

[OriginalValue("GDX_Cache")]
public static string PlatformCacheFolder

Field Value

Type	Description
System.String

TaskDirectorSystem

Should the Task Director System be added to the player loop during playmode.

Declaration

[OriginalValue(false)]
public static bool TaskDirectorSystem

Field Value

Type	Description
System.Boolean

TaskDirectorSystemTickRate

How often should the task director tick in playmode?

Declaration

[OriginalValue(0.1F)]
public static float TaskDirectorSystemTickRate

Field Value

Type	Description
System.Single

UpdateProviderCheckForUpdates

Should GDX check for updates at editor time?

Declaration

[OriginalValue(true)]
public static bool UpdateProviderCheckForUpdates

Field Value

Type	Description
System.Boolean