Interface: HelpSystem

Interfaces > Core Interfaces > HelpSystem

The HelpSystem Core Interface provides access to the Online and Local Help Files of 3ds Max.

Available in 3ds Max 2012 and higher.

Interface: HelpSystem

Properties:

HelpSystem.productHelpLocation : enum:Read|WritehelpLocation enums: {#onlineHelp|#localHelp}

Get/set the Help System mode.

When set to #onlineHelp , the help will be accessed from the Autodesk Online Help servers via the Internet. This mode requires an Internet connection, but provides the latest help content available.

When set to #localHelp , the help will be accessed from the local drive. This mode does not require an Internet connection, but the help content can be potentially outdated compared to the online version.

HelpSystem.localProductHelpPath : string:Read|Write

Get/set the directory where the local help is located.

HelpSystem.defaultLocalProductHelpPath : string:Read

Get the default location of the local help files. It can be used to find the shipping help files or to set the HelpSystem.localProductHelpPath to its default value.

Methods:

<bool>HelpSystem.ShowProductHelp <integer>helpContextId

Opens the Online Help in the default web browser at the specified helpContextId, or, if the Id is not valid, at the index page.

<bool>HelpSystem.SearchProductHelp <string>searchFor

Searches the Online Help for the specified search string.

Available in 3ds Max 2013 and higher.

<bool>HelpSystem.ShowMAXScriptHelp indexstring:<string> -- default indexstring: undefined

Searches the Online MAXScript Help for the specified search string. Available in 3ds Max 2018 and higher.

-- Example 1:
HelpSystem.ShowMAXScriptHelp()

-- Example 2:
HelpSystem.ShowMAXScriptHelp indexstring:"HelpSystem"

<bool>HelpSystem.ShowPythonHelp indexstring:<string> -- default indexstring: undefined

Searches the Online Python Help for the specified search string. Available in 3ds Max 2018 and higher.

-- Example 1:
HelpSystem.ShowPythonHelp()

-- Example 2:
HelpSystem.ShowPythonHelp indexstring:"Using PySide"

<bool>HelpSystem.OpenCHMFile <filename>helpfile indexstring:<string> -- default indexstring: undefined

Searches the .CHM at the given helpfile file path for specified search string. Available in 3ds Max 2018 and higher.

-- Example:
HelpSystem.OpenCHMFile "C:\help\my_downloaded_help.chm" indexstring:"Hello World"