Click or drag to resize

ExportSettings Class

The settings used by the build engine when exporing a mod.
Inheritance Hierarchy
SystemObject
  Object
    ScriptableObject
      UMod.SharedModScriptableAssetExportSettings
        UMod.ModTools.ExportExportSettings

Namespace:  UMod.ModTools.Export
Assembly:  UMod-ModTools (in UMod-ModTools.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
C#
[SerializableAttribute]
public sealed class ExportSettings : ModScriptableAsset<ExportSettings>

The ExportSettings type exposes the following members.

Properties
  NameDescription
Public propertyActiveExportProfile
Get the ExportProfileSettings for the active export profile.
Public propertyActiveExportProfileIndex
Get the index of the active export profile or -1 if there are no export profiles.
Public propertyBuildAndRunInvokeMode
Public propertyClearConsoleOnBuild
Should the console window be cleared before a build starts (Just like enterning game mode).
Public propertyCommandLineExecutable
The full path to the game executable that you are building a mod for. This is used to launch the game when build and run is used.
Public propertyCompressionLevel
Public propertyExportProfileCount
Get the number of profiles that are in this project.
Public propertyExportProfiles
Represents all export profiles in the exporter project.
Public propertyLogLevel
The log level used by the build engine during export. By default, only warnings and errors are displayed to keep the console clear.
Public propertyOptimizeMode
The mode used for optimizing the mod. During development you will want to optimize for BuildTime to get the fastest build times.
Public propertyRemoteServer
Public propertyShowOutputDirectory
Should the exporter open the output directory when a build has successfully completed.
Top
Methods
  NameDescription
Public methodCreateNewExportProfile
Create a new export profile.
Public methodDeleteExportProfile(Int32)
Delete the export profile at the specified index.
Public methodDeleteExportProfile(ExportProfileSettings)
Delete the specified export profile.
Public methodRemoveDuplicateProfiles
Attempts to remove any profiles that share the same name so that only unique profile names remain.
Public methodSetActiveExportProfile(Int32)
Set the active export profile to the specified profile index.
Public methodSetActiveExportProfile(ExportProfileSettings)
Set the specified ExportProfileSettings as the active export profile.
Public methodValidateAssetPath
Checks whether the modAssetPath is a valid asset path.
Public methodValidateBuildAndRun
Checks whether the commandLineExecutable is a valid path.
Public methodValidateName
Checks whether the modName value is a valid name.
Public methodValidateRequiredValues
Checks whether all required settings have been assigned with a valid value.
Public methodValidateVersion
Checks whether the modVersion is a valid version string. The string must be formatted like : 'x.x.x' where an 'x' represents a whole number.
Top
See Also