Enhance Settings object; add Preferences object

.gitignore

@@ -1,3 +1,4 @@
 *.sublime-project
 *.sublime-workspace
 build/
+docs/_build/

docs/general/application.rst

@@ -345,6 +345,23 @@ A function name string, or null if no function is assigned; read/write.
 
 ----
 
+.. _app.preferences:
+
+app.preferences
+*********************************************
+
+``app.preferences``
+
+**Description**
+
+The currently loaded AE app preferences. See :ref:`Preferences`.
+
+**Type**
+
+Preferences object; read-only.
+
+----
+
 .. _app.project:
 
 app.project

docs/index.rst

@@ -79,6 +79,7 @@ Welcome to the After Effects Scripting Guide!
     other/keyframeease
     other/markervalue
     other/settings
+    other/preferences
     other/shape
     other/textdocument
     other/viewer

docs/other/preferences.rst

@@ -0,0 +1,352 @@
+.. highlight:: javascript
+.. _Preferences:
+
+Preferences object
+################################################
+
+``app.preferences``
+
+**Description**
+
+The Preferences object provides an easy way to manage internal AE preferences, such as you'd find in AE's Preferences menu. These are saved in the After Effects preference files, and are persistent between application sessions.
+
+Preferences are identified by section and key within the file, and each key name is associated with a value.
+
+In the preferences file, section names are enclosed in brackets and quotation marks, and key names are listing in quotation marks below the sectionname. All values are strings.
+
+You can create new preferences with this object, as well as accessing existing preferences.
+
+As of Version 12/CC, preferences and settings methods now take a third argument to specify the target preferences file if Section/Key is not in "Adobe After Effects $versionNumber.x Prefs.txt".
+
+If the third argument is not passed, default value (``PREFType.PREF_Type_MACHINE_SPECIFIC``) is used and After Effects tries to save/get from the "Adobe After Effects $versionNumber.x Prefs.txt" preferences file.
+
+The third argument is enum ``PREFType`` value, one of:
+
+- ``PREF_Type_MACHINE_SPECIFIC``: Adobe After Effects $versionNumber.x Prefs.txt
+- ``PREF_Type_MACHINE_INDEPENDENT``: Adobe After Effects $versionNumber.x Prefs-indep-general.txt
+- ``PREF_Type_MACHINE_INDEPENDENT_RENDER``: Adobe After Effects $versionNumber.x Prefs-indep-render.txt
+- ``PREF_Type_MACHINE_INDEPENDENT_OUTPUT``: Adobe After Effects $versionNumber.x Prefs-indep-output.txt
+- ``PREF_Type_MACHINE_INDEPENDENT_COMPOSITION``: Adobe After Effects $versionNumber.x Prefs-indep-composition.txt
+- ``PREF_Type_MACHINE_SPECIFIC_TEXT``: Adobe After Effects $versionNumber.x Prefs-text.txt
+- ``PREF_Type_MACHINE_SPECIFIC_PAINT``: Adobe After Effects $versionNumber.x Prefs-paint.txt
+
+----
+
+=======
+Methods
+=======
+
+.. _Preferences.deletePref:
+
+Preferences.deletePref()
+************************
+
+``app.preferences.deletePref(sectionName, keyName[, prefType])``
+
+**Description**
+
+Deletes a preference from the preference file.
+
+.. tip::
+  It's generally inadvised to delete internal AE preferences, however you can leverage this method to delete :ref:`Settings` you have saved. Note that you'll need to preprend ``"Settings_"`` to your section name.
+
+**Parameters**
+
+===============  ==============================================================
+``sectionName``  A string containing the name of a preferences section
+``keyName``      A string containing the key name of the preference
+``prefType``     Optional, an enum indicating which preference file to use
+===============  ==============================================================
+
+**Returns**
+
+Nothing.
+
+**Example**
+
+If you have saved a setting named with the key name "trimPrecomps" in a section called "Precomp Cropper", you can delete the setting by::
+
+    app.preferences.deletePref("Settings_Precomp Cropper", "trimPrecomps");
+
+----
+
+.. _Preferences.getPrefAsBool:
+
+Preferences.getPrefAsBool()
+***************************
+
+``app.preferences.getPrefAsBool(sectionName, keyName[, prefType])``
+
+**Description**
+
+Retrieves a preference value from the preferences file, and parses it as a boolean.
+
+**Parameters**
+
+===============  ==============================================================
+``sectionName``  A string containing the name of a preferences section
+``keyName``      A string containing the key name of the preference
+``prefType``     Optional, an enum indicating which preference file to use
+===============  ==============================================================
+
+**Returns**
+
+Boolean.
+
+**Example**
+
+To retrieve the value of the Flow Chart "Expand Flowchart Comps by Default" preference::
+
+    var expandByDefault = app.preferences.getPrefAsBool("Flowchart Settings", "Expand Flowchart Comps by Default");
+    alert("The setting is: " + expandByDefault);
+
+To retrieve the value of the main preference "Javascript Debugger Enabled"::
+
+    var debuggerEnabled = app.preferences.getPrefAsBool("Main Pref Section v2", "Pref_JAVASCRIPT_DEBUGGER", PREFType.PREF_Type_MACHINE_INDEPENDENT);
+    alert("The setting is: " + debuggerEnabled);
+
+----
+
+.. _Preferences.getPrefAsFloat:
+
+Preferences.getPrefAsFloat()
+****************************
+
+``app.preferences.getPrefAsFloat(sectionName, keyName[, prefType])``
+
+**Description**
+
+Retrieves a preference value from the preferences file, and parses it as a float.
+
+**Parameters**
+
+===============  ==============================================================
+``sectionName``  A string containing the name of a preferences section
+``keyName``      A string containing the key name of the preference
+``prefType``     Optional, an enum indicating which preference file to use
+===============  ==============================================================
+
+**Returns**
+
+Float.
+
+----
+
+.. _Preferences.getPrefAsLong:
+
+Preferences.getPrefAsLong()
+***************************
+
+``app.preferences.getPrefAsLong(sectionName, keyName[, prefType])``
+
+**Description**
+
+Retrieves a preference value from the preferences file, and parses it as a long (number).
+
+**Parameters**
+
+===============  ==============================================================
+``sectionName``  A string containing the name of a preferences section
+``keyName``      A string containing the key name of the preference
+``prefType``     Optional, an enum indicating which preference file to use
+===============  ==============================================================
+
+**Returns**
+
+Long.
+
+----
+
+.. _Preferences.getPrefAsString:
+
+Preferences.getPrefAsString()
+*****************************
+
+``app.preferences.getPrefAsString(sectionName, keyName[, prefType])``
+
+**Description**
+
+Retrieves a preference value from the preferences file, and parses it as a string.
+
+**Parameters**
+
+===============  ==============================================================
+``sectionName``  A string containing the name of a preferences section
+``keyName``      A string containing the key name of the preference
+``prefType``     Optional, an enum indicating which preference file to use
+===============  ==============================================================
+
+**Returns**
+
+String.
+
+----
+
+.. _Preferences.havePref:
+
+Preferences.havePref()
+**********************
+
+``app.preferences.havePref(sectionName, keyName[, prefType])``
+
+**Description**
+
+Returns true if the specified preference item exists and has a value.
+
+**Parameters**
+
+===============  ==============================================================
+``sectionName``  A string containing the name of a preferences section
+``keyName``      A string containing the key name of the preference
+``prefType``     Optional, an enum indicating which preference file to use
+===============  ==============================================================
+
+**Returns**
+
+Boolean.
+
+----
+
+.. _Preferences.reload:
+
+Preferences.reload()
+********************
+
+``app.preferences.reload()``
+
+**Description**
+
+Reloads the preferences file manually. Otherwise, changes to preferences will only be accessible by scripting after an application restart.
+
+**Parameters**
+
+None.
+
+**Returns**
+
+Nothing.
+
+----
+
+.. _Preferences.savePrefAsBool:
+
+Preferences.savePrefAsBool()
+****************************
+
+``app.preferences.savePrefAsBool(sectionName, keyName, value[, prefType])``
+
+**Description**
+
+Saves a preference item as a boolean.
+
+**Parameters**
+
+===============  ==============================================================
+``sectionName``  A string containing the name of a preferences section
+``keyName``      A string containing the key name of the preference
+``value``        A boolean containing the new value
+``prefType``     Optional, an enum indicating which preference file to use
+===============  ==============================================================
+
+**Returns**
+
+Nothing.
+
+----
+
+.. _Preferences.savePrefAsFloat:
+
+Preferences.savePrefAsFloat()
+*****************************
+
+``app.preferences.savePrefAsFloat(sectionName, keyName, value[, prefType])``
+
+**Description**
+
+Saves a preference item as a float.
+
+**Parameters**
+
+===============  ==============================================================
+``sectionName``  A string containing the name of a preferences section
+``keyName``      A string containing the key name of the preference
+``value``        A float containing the new value
+``prefType``     Optional, an enum indicating which preference file to use
+===============  ==============================================================
+
+**Returns**
+
+Nothing.
+
+----
+
+.. _Preferences.savePrefAsLong:
+
+Preferences.savePrefAsLong()
+****************************
+
+``app.preferences.savePrefAsLong(sectionName, keyName, value[, prefType])``
+
+**Description**
+
+Saves a preference item as a long.
+
+**Parameters**
+
+===============  ==============================================================
+``sectionName``  A string containing the name of a preferences section
+``keyName``      A string containing the key name of the preference
+``value``        A long containing the new value
+``prefType``     Optional, an enum indicating which preference file to use
+===============  ==============================================================
+
+**Returns**
+
+Nothing.
+
+----
+
+.. _Preferences.savePrefAsString:
+
+Preferences.savePrefAsString()
+******************************
+
+``app.preferences.savePrefAsString(sectionName, keyName, value[, prefType])``
+
+**Description**
+
+Saves a preference item as a string.
+
+**Parameters**
+
+===============  ==============================================================
+``sectionName``  A string containing the name of a preferences section
+``keyName``      A string containing the key name of the preference
+``value``        A string containing the new value
+``prefType``     Optional, an enum indicating which preference file to use
+===============  ==============================================================
+
+**Returns**
+
+Nothing.
+
+----
+
+.. _Preferences.saveToDisk:
+
+Preferences.saveToDisk()
+************************
+
+``app.preferences.saveToDisk()``
+
+**Description**
+
+Saves the preferences to disk manually. Otherwise, changes to preferences will only be accessible by scripting after an application restart.
+
+**Parameters**
+
+None.
+
+**Returns**
+
+Nothing.