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_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


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