Click or drag to resize

UModSettings Class

The global settings used by all mod hosts.
Inheritance Hierarchy
SystemObject
  Object
    ScriptableObject
      UMod.SharedModScriptableAssetUModSettings
        UMod.SettingsUModSettings

Namespace:  UMod.Settings
Assembly:  UMod (in UMod.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
C#
[SerializableAttribute]
public sealed class UModSettings : ModScriptableAsset<UModSettings>

The UModSettings type exposes the following members.

Constructors
  NameDescription
Public methodUModSettings
Initializes a new instance of the UModSettings class
Top
Properties
  NameDescription
Public propertyAllowCommandLine
Can mods be loaded from the command line.
Public propertyAllowLoadAssets
Is the modder allowed to load assets from the mod (Prefabs).
Public propertyAllowModsCreatedByOlderUnityVersions
Should mods created with older versions of Unity be loadable by the standalone game. Note that there may be issues when loading mods created by older Unity version such as material or shader errors. We always recommend that this option is disabled however you can enable it if you understand there may be potential issues.
Public propertyAllowSceneChanges
Is the modder allowed to request scene changes.
Public propertyAutoLoadModScenes
Should mod scenes be loaded automatically when a mod is loaded. Not recommended when multiple mods are used.
Public propertyCaseSensitiveScriptNames
Should script find methods use case sensitive names.
Public propertyCleanupModObjects
Should the host cleanup all objects it created when its associated mod is unloaded.
Public propertyCommandLineFormat
The variable used when launching mods from the command line.
Public propertyDiscoverNonPublicScriptMembers
When true, uMod will locate members in mod scripts that are private, protected or internal.
Public propertyDiscoverNonPublicScriptTypes
When true, uMod will locate mod scripts that are private, protected or internal.
Public propertyLogLevel
The current log level defining the amount of detail that is logged to the console.
Public propertyLogSecurityIllegalReferenceOccurences
Public propertyLogSecurityIllegalReferences
Public propertyMemoryBudgetBytes
The maximum number of bytes per resource that uMod will allow in memory per host. If this amount is exceeded then uMod will download remote files to the file system and then stream the data from file.
Public propertyModdableNamingSettings
Public propertyModdableSettings
Public propertyPreloadSharedGameAssets
Public propertyRuntimeSecurityCheckMode
Public propertySecurityRestrictions
The security restrictions used to validate mod code.
Top
See Also