This interface provides access to the Auto Backup functionality.

Available in 3ds Max 9 and higher.

Properties:

autosave.Enable : boolean : Read|Write      

Get/Set the Autobackup enabled state. Equivalent to the System Global variable autobackup.enabled . The state of this property is persisted between 3ds Max sessions. See also autosave.tempDisable below.

autosave.NumberOfFiles : integer : Read|Write   

Get/Set the number of Autobackup files. Possible values are between 1 and 99.

autosave.Interval : integer : Read|Write|Validated by Range: 0 to 480

Get/Set the Autobackup interval in minutes.

autosave.filename : string : Read|Write 

Get/Set the Autobackup filename as a string. Default is "AutoBackup".

.prependSceneName : boolean : Read|Write

Get/Set whether to prepend the scene name to the autobackup file name.

autosave.BailoutEnabled : boolean : Read|Write

When set to false, 3ds Max cannot escape out of Autobackup. In some cases setting this to false can significantly improve Autobackup performance. Available in 3ds Max 2018 and higher.

.finalCountdownInterval : float : Read|Write|Validated by Range: 0.0 to 480.0

Specifies a time (in minutes) at which the autobackup timer will pause if it detects user activity. For example, if this is set to .33 minutes/20 seconds (the default), and the user is doing something at the 20 second mark of the countdown timer, the timer pauses until the user activity ends. If This property is set to 0, user activity detection is disabled.

Alternatively, this is the amount of time needed to recover before listening to Europe's "Final Countdown" again.

.Compress : boolean : Read|Write

Specifies whether autobackup files are compressed.

.tempDisable : boolean : Read|Write

When true, temporarily disables autobackup. When .tempDisable is false, canProceed() returns true. If this property is set to true multiple times, it must be set to false an equal number of times to re-enable autobackup.

Use this property instead of autosave.enable if you do not want the setting to persist between 3ds Max sessions. Modifying this property also does not cause a UI update.

For example:

autosave.tempDisable = true
...
autosave.tempDisable = true
...
autosave.tempDisable = false
... (autobackup still disabled here)
autosave.tempDisable = false
... (autobackup is re-enabled here)

Methods:

<void>autosave.resettimer() 

Resets the Autobackup timer. After the rest, the next save will occur after the number of minutes specified by the .interval property.

<integer>secondsUntilNextAttempt()

Returns the number of seconds until the next backup attempt. When this decreases to 0, and canProceed() returns true, the backup process can proceed. When the autobackup timer is not started this function returns -1. Available in in 3ds Max 2022.2 Update and later.

<boolean>canProceed()

Returns true if autobackup can proceed based on the current state. Note that the state can change. Autobackup proceeds if secondsUntilNextAttempt() returns 0, and canProceed() returns true. Available in in 3ds Max 2022.2 Update and later.

<boolean>isRequired()

Returns true if the internal "autobackup required" flag is set. This is similar to the getSaveRequired() function. Available in in 3ds Max 2022.2 Update and later.

<boolean>autosave.isactive() 

Returns true if the Autobackup is currently saving, false otherwise.

<void>autobackupnow()

Starts the Autobackup process. Available in 3ds Max 2017 and higher.

<void>loadSettings()

Loads autobackup settings from the 3ds Max settings file (3dsmax.ini). This will overwrite any changes that have been made to the current settings.

<void>saveSettings()

Saves the current autobackup settings to the 3ds Max settings file (3dsmax.ini).