.. _$:

================================================
\$
================================================


Description
-----------

The $ object provides a number of debugging facilities and informational methods.






Static Properties
^^^^^^^^^^^^^^^^^

+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`build<$.build>` readonly               | The ExtendScript build information.                                                                                                                                                                 |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`buildDate<$.buildDate>` readonly       | The ExtendScript build date.                                                                                                                                                                        |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`decimalPoint<$.decimalPoint>` readonly | The character used as the decimal point character in formatted numeric output.                                                                                                                      |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`engineName<$.engineName>` readonly     | The name of the current ExtendScript engine, if set.                                                                                                                                                |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`error<$.error>` readonly               | The most recent run-time error information.                                                                                                                                                         |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`fileName<$.fileName>` readonly         | The file name of the current script.                                                                                                                                                                |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`flags<$.flags>` readonly               | Gets or sets low-level debug output flags.                                                                                                                                                          |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`global<$.global>` readonly             | A reference to the global object, which contains the JavaScript global namespace.                                                                                                                   |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`hiresTimer<$.hiresTimer>` readonly     | A high-resolution timer, measuring the time in microseconds. The timer starts when ExtendScript is initialized during the application startup sequence. Every read access resets the timer to Zero. |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`includePath<$.includePath>` readonly   | The path for include files for the current script.                                                                                                                                                  |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`level<$.level>` readonly               | The current debugging level, which enables or disables the JavaScript debugger.                                                                                                                     |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`line<$.line>` readonly                 | The current line number of the currently executing script.                                                                                                                                          |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`locale<$.locale>` readonly             | Gets or sets the current locale.                                                                                                                                                                    |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`localize<$.localize>` readonly         | Set to true to enable the extended localization features of the built-in toString() method.                                                                                                         |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`memCache<$.memCache>` readonly         | The ExtendScript memory cache size, in bytes.                                                                                                                                                       |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`os<$.os>` readonly                     | The current operating system version information.                                                                                                                                                   |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`screens<$.screens>` readonly           | An array of objects containing information about the display screens attached to your computer.                                                                                                     |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`stack<$.stack>` readonly               | The current stack trace.                                                                                                                                                                            |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`strict<$.strict>` readonly             | Sets or clears strict mode for object modification.                                                                                                                                                 |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`version<$.version>` readonly           | The version number of the ExtendScript engine.                                                                                                                                                      |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+







Static Methods
^^^^^^^^^^^^^^

+--------------------------------------------+---------------------------------------------------------------------------------------+
| :ref:`about<$.about>` readonly             | Shows an About box for the ExtendScript component, and returns the text for the box.  |
+--------------------------------------------+---------------------------------------------------------------------------------------+
| :ref:`bp<$.bp>` readonly                   | Breaks execution at the current position.                                             |
+--------------------------------------------+---------------------------------------------------------------------------------------+
| :ref:`colorPicker<$.colorPicker>` readonly | Invokes the platform-specific color selection dialog, and returns the selected color. |
+--------------------------------------------+---------------------------------------------------------------------------------------+
| :ref:`evalFile<$.evalFile>` readonly       | Loads and evaluates a file.                                                           |
+--------------------------------------------+---------------------------------------------------------------------------------------+
| :ref:`gc<$.gc>` readonly                   | Initiates garbage collection in the ExtendScript engine.                              |
+--------------------------------------------+---------------------------------------------------------------------------------------+
| :ref:`getenv<$.getenv>` readonly           | Retrieves the value of an environment variable.                                       |
+--------------------------------------------+---------------------------------------------------------------------------------------+
| :ref:`setenv<$.setenv>` readonly           | Sets the value of an environment variable.                                            |
+--------------------------------------------+---------------------------------------------------------------------------------------+
| :ref:`sleep<$.sleep>` readonly             | Suspends the calling thread for a number of milliseconds.                             |
+--------------------------------------------+---------------------------------------------------------------------------------------+
| :ref:`toString<$.toString>` readonly       | Converts this object to a string.                                                     |
+--------------------------------------------+---------------------------------------------------------------------------------------+
| :ref:`write<$.write>` readonly             | Prints text to the Console.                                                           |
+--------------------------------------------+---------------------------------------------------------------------------------------+
| :ref:`writeln<$.writeln>` readonly         | Prints text to the Console, and adds a newline character.                             |
+--------------------------------------------+---------------------------------------------------------------------------------------+




.. container:: hide

   .. toctree::
      :hidden:
      :maxdepth: 1

      
      $/error.rst
      $/version.rst
      $/build.rst
      $/buildDate.rst
      $/global.rst
      $/stack.rst
      $/level.rst
      $/flags.rst
      $/strict.rst
      $/locale.rst
      $/localize.rst
      $/decimalPoint.rst
      $/memCache.rst
      $/screens.rst
      $/os.rst
      $/fileName.rst
      $/line.rst
      $/hiresTimer.rst
      $/engineName.rst
      $/includePath.rst
      

      
      $/about.rst
      $/toString.rst
      $/write.rst
      $/writeln.rst
      $/bp.rst
      $/getenv.rst
      $/setenv.rst
      $/sleep.rst
      $/colorPicker.rst
      $/evalFile.rst
      $/gc.rst