Skip to main content

GeneralOptions

Parameters

Snapshot of the General preference values.

Import​

import ScriptingApi as api

# Access the class
# GeneralOptions is available via api.GeneralOptions

Properties​

default_working_directory​

Directory path used as the default working directory.

Type: str

maximum_undos​

Maximum number of undos. Specify 0 to disable undos/redos and release the associated memory.

Type: int

maximum_camera_undos​

Maximum number of camera undos. Specify 0 to disable camera undos/redos and release the associated memory.

Type: int

undo_storage_location​

Store undo data in RAM for faster access or on disk in the current working directory to reduce memory usage. Use api.UndoStorageLocation.Ram

Type: UndoStorageLocation

maximum_undo_state_memory_mb​

Maximum memory in megabytes for a single undo state. Larger states are written to disk; the whole-history budget can also route smaller states there. Specify 0 for no per-state size limit. The default is derived from the memory installed on the computer.

Type: int

maximum_undo_history_memory_mb​

Memory budget in megabytes for the object undo history. Older data-heavy states are discarded when possible. Adjacent undo and redo steps are retained. Specify 0 to disable the memory budget. The default is derived from the memory installed on the computer.

Type: int

maximum_recent_files​

Maximum number of recently used files to show.

Type: int

maximum_number_of_threads​

Maximum number of hardware threads to use. Values stay in the valid range from 1 to the number of available hardware threads.

Type: int

auto_save_frequency_minutes​

Auto-save frequency in minutes. Specify 0 to disable automatic saving.

Type: int

project_file_compression_level​

Compression level for project files. Use api.ProjectFileCompressionLevel.Fastest

Type: ProjectFileCompressionLevel

help_improve_user_experience​

Help improve the quality, reliability, and performance of the application by allowing anonymous usage data and encrypted crash reports. This change may take effect the next time the application starts.

Type: bool

See Also​