Table of Contents

Class ObscuredFileSettings

Namespace
CodeStage.AntiCheat.Storage
Assembly
Build.dll

Specific settings to use with ObscuredFile instance.

public class ObscuredFileSettings : IObscuredFileSettings
Inheritance
object
ObscuredFileSettings
Implements

Constructors

ObscuredFileSettings()

Creates default settings instance.

public ObscuredFileSettings()

Remarks

Default settings are:

  • LocationKind set to ObscuredFileLocation.PersistentData
  • EncryptionSettings.ObscurationMode set to ObscurationMode.Plain
  • DeviceLockSettings.Level set to DeviceLockLevel.None
  • ValidateDataIntegrity set to true
  • AutoSave set to true

ObscuredFileSettings(DeviceLockSettings)

Creates settings instance with specified DeviceLockSettings.

public ObscuredFileSettings(DeviceLockSettings deviceLockSettings)

Parameters

deviceLockSettings DeviceLockSettings

Remarks

Default settings are:

  • LocationKind set to ObscuredFileLocation.PersistentData
  • EncryptionSettings.ObscurationMode set to ObscurationMode.Plain
  • ValidateDataIntegrity set to true
  • AutoSave set to true

ObscuredFileSettings(EncryptionSettings, DeviceLockSettings, ObscuredFileLocation, bool, bool)

Creates user-specified settings instance.

public ObscuredFileSettings(EncryptionSettings encryptionSettings, DeviceLockSettings deviceLockSettings, ObscuredFileLocation locationKind = ObscuredFileLocation.PersistentData, bool validateDataIntegrity = true, bool autoSave = true)

Parameters

encryptionSettings EncryptionSettings
deviceLockSettings DeviceLockSettings
locationKind ObscuredFileLocation
validateDataIntegrity bool
autoSave bool

ObscuredFileSettings(ObscuredFileLocation)

Creates settings instance with specified LocationKind.

public ObscuredFileSettings(ObscuredFileLocation locationKind)

Parameters

locationKind ObscuredFileLocation

Remarks

Default settings are:

  • EncryptionSettings.ObscurationMode set to ObscurationMode.Plain
  • DeviceLockSettings.Level set to DeviceLockLevel.None
  • ValidateDataIntegrity set to true
  • AutoSave set to true

Properties

AutoSave

Switches Auto Save feature.

public bool AutoSave { get; set; }

Property Value

bool

Remarks

Auto Save feature allows making sure any unsaved data will persist when your app quits (on desktops) or loses the focus (on mobiles). It's enabled by default and this is the recommended setting, but you're free to turn it off at your own risk.

DeviceLockSettings

Controls DeviceLock feature settings. Read more at DeviceLockSettings docs.

public DeviceLockSettings DeviceLockSettings { get; set; }

Property Value

DeviceLockSettings

EncryptionSettings

Controls file encryption settings. Read more at EncryptionSettings docs.

public EncryptionSettings EncryptionSettings { get; set; }

Property Value

EncryptionSettings

LocationKind

Controls file location. Read more at ObscuredFileLocation docs.

public ObscuredFileLocation LocationKind { get; set; }

Property Value

ObscuredFileLocation

ValidateDataIntegrity

Controls anti-tampering setting.

public bool ValidateDataIntegrity { get; set; }

Property Value

bool

Remarks

When enabled, data integrity is validated and invokes NotGenuineDataDetected event on violation.
Disable to skip integrity validation entirely and improve performance.