Class SceneConfig

It is the object in charge of managing the configuration for the level

Inheritance

System.Object

SceneConfig

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: SaveIsEasy

Assembly: SaveIsEasyDLL.dll

Syntax

[Serializable]
public class SceneConfig

Fields

DefaultSaveName

The default save name for the file

Declaration

public const string DefaultSaveName = "DefaultLevelName"

Field Value

Type	Description
System.String

Properties

AutoLoadOnPlay

To automatically load the game on play

Declaration

public bool AutoLoadOnPlay { get; set; }

Property Value

Type	Description
System.Boolean

AutoSaving

To active AutoSaving by time

Declaration

public bool AutoSaving { get; set; }

Property Value

Type	Description
System.Boolean

AutoSavingInterval

Time Between saves in Seconds

Declaration

public float AutoSavingInterval { get; set; }

Property Value

Type	Description
System.Single

AutoSavingRunInThread

To set that AutoSaving run In separate thread

Declaration

public bool AutoSavingRunInThread { get; set; }

Property Value

Type	Description
System.Boolean

CurrentTimeToSave

When this number is greater than or equal to "Auto Saving Interval" it will be placed in sero and an auto-save will be made. Every second in the game adds 1.

Declaration

public float CurrentTimeToSave { get; set; }

Property Value

Type	Description
System.Single

DuplicateSaveFile

This is to create a copy of the saved file, In case there is any problem, do not lose the saved (all this is handled automatically by the asset)

Declaration

public bool DuplicateSaveFile { get; set; }

Property Value

Type	Description
System.Boolean

ExclusiveFiles

It only allows loading the game when it was saved in the same scene as where it is trying to load.

Declaration

public bool ExclusiveFiles { get; set; }

Property Value

Type	Description
System.Boolean

OnExitSave

To automatically save at game exit

Declaration

public bool OnExitSave { get; set; }

Property Value

Type	Description
System.Boolean

SceneFileName

The default name of the file to save and load On set: The file, Supports absolute and relative formats, examples: 'level1.game', 'level2', 'test/level3', 'C:/Test/level4', 'C:/Test/level5.game' On get: The file in a absolute path, examples: 'C:/Test/level4', 'C:/Test/level5.game'

Declaration

public string SceneFileName { get; set; }

Property Value

Type	Description
System.String

TimeBetweenSavesInSeconds

Time Between saves in Seconds

Declaration

[Obsolete("Use AutoSavingInterval")]
public float TimeBetweenSavesInSeconds { get; set; }

Property Value

Type	Description
System.Single

Methods

SetEncrypt(Boolean)

To activate or deactivate the encryption tool

Declaration

[Obsolete("Use SetEncryptionConfig")]
public bool SetEncrypt(bool active)

Parameters

Type	Name	Description
System.Boolean	active	true = files are encrypted, false = files are not encrypted

Returns

Type	Description
System.Boolean	The operation was successful, true = yes, false = error

SetEncrypt(Boolean, String)

To activate or deactivate the encryption tool

Declaration

[Obsolete("Use SetEncryptionConfig")]
public bool SetEncrypt(bool active, string password)

Parameters

Type	Name	Description
System.Boolean	active	true = files are encrypted, false = files are not encrypted
System.String	password	The password to encrypt the files

Returns

Type	Description
System.Boolean	The operation was successful, true = yes, false = error

SetEncryptionConfig(SceneConfig.EncryptionConfig)

To activate or deactivate the encryption tool

Declaration

public bool SetEncryptionConfig(SceneConfig.EncryptionConfig newEncryptionConfig)

Parameters

Type	Name	Description
SceneConfig.EncryptionConfig	newEncryptionConfig	The encryption configuration.

Returns

Type	Description
System.Boolean	The operation was successful, true = yes, false = error

SetEncryptionConfig(SceneConfig.EncryptionConfig, String)

To activate or deactivate the encryption tool

Declaration

public bool SetEncryptionConfig(SceneConfig.EncryptionConfig newEncryptionConfig, string password)

Parameters

Type	Name	Description
SceneConfig.EncryptionConfig	newEncryptionConfig	The encryption configuration.
System.String	password	The password to encrypt the files

Returns

Type	Description
System.Boolean	The operation was successful, true = yes, false = error