## On this page

  

 

 # OpenTD.TdConnectConfig Class Reference

 Last update: 16.07.2025 

Controls how [ThermalDesktop](class_open_t_d_1_1_thermal_desktop.xhtml "Represents one instance of Thermal Desktop. This is the top-level class for interacting with OpenTD.") object connects to its actual TD instance when [ThermalDesktop.Connect()](class_open_t_d_1_1_thermal_desktop.xhtml#a401d066096a6c3fec2a1b893973422f1 "Connect to an instance of TD using the options specified in ConnectConfig.") is called. [More...](#details)

## <a id="nested-classes" name="nested-classes"></a>Classes

class [TimeoutProperties](class_open_t_d_1_1_td_connect_config_1_1_timeout_properties.xhtml) Data used to decide when to timeout an operation. [More...](class_open_t_d_1_1_td_connect_config_1_1_timeout_properties.xhtml#details)  
 ## <a id="pub-types" name="pub-types"></a>Public Types

enum [Types](#abd41449782efbc0f8a04a6ca43a25311) { [START\_NEW\_TD](#abd41449782efbc0f8a04a6ca43a25311a54491a722ec3f300682eb3a6711c5995), [AUTO](#abd41449782efbc0f8a04a6ca43a25311ae1f2d5134ed2543d38a0de9751cf75d9), [ATTACH\_TO\_TD](#abd41449782efbc0f8a04a6ca43a25311a2f405afd9f53967fafd96fb5c93c1b07), [INPROCESS](#abd41449782efbc0f8a04a6ca43a25311ab61d850eff77166498d04996cd33fa9b) } Determines whether [ThermalDesktop](class_open_t_d_1_1_thermal_desktop.xhtml "Represents one instance of Thermal Desktop. This is the top-level class for interacting with OpenTD.") will start a new instance of TD, attach to an existing instance, or automatically try to attach but revert to starting a new instance if attaching fails. There's also an INPROCESS option that is only used internally by TD. [More...](#abd41449782efbc0f8a04a6ca43a25311)  
 ## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

 [TdConnectConfig](#a5ec2a1c0f115c6c2888ad08bb83f7d3e) () void [Validate](#acbd50e5dfec49b664c2bb91994f4235c) () Validates this instance of [TdConnectConfig](class_open_t_d_1_1_td_connect_config.xhtml "Controls how ThermalDesktop object connects to its actual TD instance when ThermalDesktop...."). Is called automatically by [ThermalDesktop.Connect()](class_open_t_d_1_1_thermal_desktop.xhtml#a401d066096a6c3fec2a1b893973422f1 "Connect to an instance of TD using the options specified in ConnectConfig.").   
 ## <a id="pub-static-methods" name="pub-static-methods"></a>Static Public Member Functions

static string [GetRepeatableNameFromPath](#aedce10ab655bb09b891facbf9dc067bb) (string pathname, bool calledFromServer=false) ## <a id="properties" name="properties"></a>Properties

[Types](#abd41449782efbc0f8a04a6ca43a25311) [Type](#a28c9457977b0f221f72006992984df17)` [get, set]` [RootedPathname](struct_open_t_d_1_1_utility_1_1_rooted_pathname.xhtml) [AcadExePathname](#a3745daa68e8b7cd8e7686b7b850039ac)` [get, set]` Normally [ThermalDesktop.Connect()](class_open_t_d_1_1_thermal_desktop.xhtml#a401d066096a6c3fec2a1b893973422f1 "Connect to an instance of TD using the options specified in ConnectConfig.") uses the latest version of AutoCAD it finds on your machine. Set AcadExePathname to the location of another acad.exe to force it to use that version of AutoCAD. Caution: some older versions of AutoCAD may not work with [OpenTD](namespace_open_t_d.xhtml "Base Thermal Desktop functionality.").   
 string [StartDirectory](#a7abfa8cdeb05154b7bd270fce1db8297)` [get, set]` The starting directory for the acad.exe process. For the current working directory, see [ThermalDesktop.GetCurrentWorkingDirectory()](class_open_t_d_1_1_thermal_desktop.xhtml#ac15aac3c8b123edcde5b7990b3be70cb).   
 [RootedPathname](struct_open_t_d_1_1_utility_1_1_rooted_pathname.xhtml) [DwgPathname](#a3ce352790582d8ab16e16d0bcac68657)` [get, set]` Path to dwg file to open or attach to if already opened. If left blank and [TdConnectConfig.Type](#a28c9457977b0f221f72006992984df17) allows it, [ThermalDesktop.Connect()](class_open_t_d_1_1_thermal_desktop.xhtml#a401d066096a6c3fec2a1b893973422f1 "Connect to an instance of TD using the options specified in ConnectConfig.") will start a new, blank drawing. Do not use this member to find the current dwg name. Instead, use [ThermalDesktop.GetCurrentDwgPathname()](class_open_t_d_1_1_thermal_desktop.xhtml#a833b6c089e146a396188e24ea0af4cdd).   
 string [PipeEndpointName](#a48f7a2194596c21acb66c34ab7cdddc2)` [get, set]` Advanced. If not blank, specifies the name of the communications channel used by [OpenTD](namespace_open_t_d.xhtml "Base Thermal Desktop functionality.") to communicate with this instance of TD. If starting a new TD instance, [OpenTD](namespace_open_t_d.xhtml "Base Thermal Desktop functionality.") will attempt to create a channel with this name. If attaching, [OpenTD](namespace_open_t_d.xhtml "Base Thermal Desktop functionality.") will attempt to connect to a channel with this name. Leave blank for automatic channel-naming. To open a named channel in TD, use the 'RcOpenTD' AutoCAD command.   
 string [PipeEndpointNameUsed](#a230758399cd2463704f31ef622172c18)` [get]` Gets the communication channel name actually used. Set when [ThermalDesktop.Connect()](class_open_t_d_1_1_thermal_desktop.xhtml#a401d066096a6c3fec2a1b893973422f1 "Connect to an instance of TD using the options specified in ConnectConfig.") is called successfully.   
 [TimeoutProperties](class_open_t_d_1_1_td_connect_config_1_1_timeout_properties.xhtml) [StartTimeout](#a042d71ce2c38fe9f1597116bcce6da31)` [get, set]` Controls how long [OpenTD](namespace_open_t_d.xhtml "Base Thermal Desktop functionality.") will try to connect to TD before timing out.   
 bool [AcadVisible](#aec3a5664f7285fe6c7475d5998eed427)` [get, set]` Controls whether a newly-started instance of TD will be visible.   
 bool [ShowAcadSplashScreen](#af353ea627c65cde87cb566c6c2219299)` [get, set]` Controls whether the AutoCAD splash screen is displayed during startup.   
 string [AdditionalAcadCommandline](#a850c545d2aa5fdf11cb2135d58039ce5)` [get, set]` Additional arguments to use when starting acad.exe.   
 static string [PipeBaseAddress](#a381083fc528e003b3c19afd09a39ce77)` [get]` <a id="details" name="details"></a>## Detailed Description

Controls how [ThermalDesktop](class_open_t_d_1_1_thermal_desktop.xhtml "Represents one instance of Thermal Desktop. This is the top-level class for interacting with OpenTD.") object connects to its actual TD instance when [ThermalDesktop.Connect()](class_open_t_d_1_1_thermal_desktop.xhtml#a401d066096a6c3fec2a1b893973422f1 "Connect to an instance of TD using the options specified in ConnectConfig.") is called.

See also[OpenTD.ThermalDesktop](class_open_t_d_1_1_thermal_desktop.xhtml "Represents one instance of Thermal Desktop. This is the top-level class for interacting with OpenTD."), [OpenTD.ThermalDesktop.Connect()](class_open_t_d_1_1_thermal_desktop.xhtml#a401d066096a6c3fec2a1b893973422f1 "Connect to an instance of TD using the options specified in ConnectConfig.")

## Member Enumeration Documentation

<a id="abd41449782efbc0f8a04a6ca43a25311" name="abd41449782efbc0f8a04a6ca43a25311"></a>## [◆ ](#abd41449782efbc0f8a04a6ca43a25311)Types

 enum [OpenTD.TdConnectConfig.Types](#abd41449782efbc0f8a04a6ca43a25311)

Determines whether [ThermalDesktop](class_open_t_d_1_1_thermal_desktop.xhtml "Represents one instance of Thermal Desktop. This is the top-level class for interacting with OpenTD.") will start a new instance of TD, attach to an existing instance, or automatically try to attach but revert to starting a new instance if attaching fails. There's also an INPROCESS option that is only used internally by TD.

See also[OpenTD.ThermalDesktop](class_open_t_d_1_1_thermal_desktop.xhtml "Represents one instance of Thermal Desktop. This is the top-level class for interacting with OpenTD."), [OpenTD.ThermalDesktop.Connect()](class_open_t_d_1_1_thermal_desktop.xhtml#a401d066096a6c3fec2a1b893973422f1 "Connect to an instance of TD using the options specified in ConnectConfig.")Enumerator<a id="abd41449782efbc0f8a04a6ca43a25311a54491a722ec3f300682eb3a6711c5995" name="abd41449782efbc0f8a04a6ca43a25311a54491a722ec3f300682eb3a6711c5995"></a>START\_NEW\_TD <a id="abd41449782efbc0f8a04a6ca43a25311ae1f2d5134ed2543d38a0de9751cf75d9" name="abd41449782efbc0f8a04a6ca43a25311ae1f2d5134ed2543d38a0de9751cf75d9"></a>AUTO <a id="abd41449782efbc0f8a04a6ca43a25311a2f405afd9f53967fafd96fb5c93c1b07" name="abd41449782efbc0f8a04a6ca43a25311a2f405afd9f53967fafd96fb5c93c1b07"></a>ATTACH\_TO\_TD <a id="abd41449782efbc0f8a04a6ca43a25311ab61d850eff77166498d04996cd33fa9b" name="abd41449782efbc0f8a04a6ca43a25311ab61d850eff77166498d04996cd33fa9b"></a>INPROCESS 



## Constructor &amp; Destructor Documentation

<a id="a5ec2a1c0f115c6c2888ad08bb83f7d3e" name="a5ec2a1c0f115c6c2888ad08bb83f7d3e"></a>## [◆ ](#a5ec2a1c0f115c6c2888ad08bb83f7d3e)TdConnectConfig()

 OpenTD.TdConnectConfig.TdConnectConfig  ( )   inline 





## Member Function Documentation

<a id="aedce10ab655bb09b891facbf9dc067bb" name="aedce10ab655bb09b891facbf9dc067bb"></a>## [◆ ](#aedce10ab655bb09b891facbf9dc067bb)GetRepeatableNameFromPath()

 static string OpenTD.TdConnectConfig.GetRepeatableNameFromPath  ( string *pathname*,    bool *calledFromServer* = false )  inlinestatic 





<a id="acbd50e5dfec49b664c2bb91994f4235c" name="acbd50e5dfec49b664c2bb91994f4235c"></a>## [◆ ](#acbd50e5dfec49b664c2bb91994f4235c)Validate()

 void OpenTD.TdConnectConfig.Validate  ( )   inline 

Validates this instance of [TdConnectConfig](class_open_t_d_1_1_td_connect_config.xhtml "Controls how ThermalDesktop object connects to its actual TD instance when ThermalDesktop...."). Is called automatically by [ThermalDesktop.Connect()](class_open_t_d_1_1_thermal_desktop.xhtml#a401d066096a6c3fec2a1b893973422f1 "Connect to an instance of TD using the options specified in ConnectConfig.").

Exceptions [OpenTD.OpenTDException](class_open_t_d_1_1_open_t_d_exception.xhtml "General exception thrown by OpenTD.")Type ATTACH\_TO\_TD requires either a valid PipeEndpointName or DwgPathname. or Could not find DwgPathname: " + DwgPathname &lt;/exception&gt; &lt;seealso cref="[OpenTD.ThermalDesktop](class_open_t_d_1_1_thermal_desktop.xhtml "Represents one instance of Thermal Desktop. This is the top-level class for interacting with OpenTD.")"/&gt; &lt;seealso cref="[OpenTD.ThermalDesktop.Connect()](class_open_t_d_1_1_thermal_desktop.xhtml#a401d066096a6c3fec2a1b893973422f1 "Connect to an instance of TD using the options specified in ConnectConfig.")"/&gt; 



## Property Documentation

<a id="a3745daa68e8b7cd8e7686b7b850039ac" name="a3745daa68e8b7cd8e7686b7b850039ac"></a>## [◆ ](#a3745daa68e8b7cd8e7686b7b850039ac)AcadExePathname

 [RootedPathname](struct_open_t_d_1_1_utility_1_1_rooted_pathname.xhtml) OpenTD.TdConnectConfig.AcadExePathname  getset 

Normally [ThermalDesktop.Connect()](class_open_t_d_1_1_thermal_desktop.xhtml#a401d066096a6c3fec2a1b893973422f1 "Connect to an instance of TD using the options specified in ConnectConfig.") uses the latest version of AutoCAD it finds on your machine. Set AcadExePathname to the location of another acad.exe to force it to use that version of AutoCAD. Caution: some older versions of AutoCAD may not work with [OpenTD](namespace_open_t_d.xhtml "Base Thermal Desktop functionality.").

The acad executable pathname.

See also[OpenTD.ThermalDesktop](class_open_t_d_1_1_thermal_desktop.xhtml "Represents one instance of Thermal Desktop. This is the top-level class for interacting with OpenTD."), [OpenTD.ThermalDesktop.Connect()](class_open_t_d_1_1_thermal_desktop.xhtml#a401d066096a6c3fec2a1b893973422f1 "Connect to an instance of TD using the options specified in ConnectConfig.")



<a id="aec3a5664f7285fe6c7475d5998eed427" name="aec3a5664f7285fe6c7475d5998eed427"></a>## [◆ ](#aec3a5664f7285fe6c7475d5998eed427)AcadVisible

 bool OpenTD.TdConnectConfig.AcadVisible  getset 

Controls whether a newly-started instance of TD will be visible.

See also[OpenTD.ThermalDesktop](class_open_t_d_1_1_thermal_desktop.xhtml "Represents one instance of Thermal Desktop. This is the top-level class for interacting with OpenTD."), [OpenTD.ThermalDesktop.Connect()](class_open_t_d_1_1_thermal_desktop.xhtml#a401d066096a6c3fec2a1b893973422f1 "Connect to an instance of TD using the options specified in ConnectConfig.")



<a id="a850c545d2aa5fdf11cb2135d58039ce5" name="a850c545d2aa5fdf11cb2135d58039ce5"></a>## [◆ ](#a850c545d2aa5fdf11cb2135d58039ce5)AdditionalAcadCommandline

 string OpenTD.TdConnectConfig.AdditionalAcadCommandline  getset 

Additional arguments to use when starting acad.exe.

See also[OpenTD.ThermalDesktop](class_open_t_d_1_1_thermal_desktop.xhtml "Represents one instance of Thermal Desktop. This is the top-level class for interacting with OpenTD."), [OpenTD.ThermalDesktop.Connect()](class_open_t_d_1_1_thermal_desktop.xhtml#a401d066096a6c3fec2a1b893973422f1 "Connect to an instance of TD using the options specified in ConnectConfig.")



<a id="a3ce352790582d8ab16e16d0bcac68657" name="a3ce352790582d8ab16e16d0bcac68657"></a>## [◆ ](#a3ce352790582d8ab16e16d0bcac68657)DwgPathname

 [RootedPathname](struct_open_t_d_1_1_utility_1_1_rooted_pathname.xhtml) OpenTD.TdConnectConfig.DwgPathname  getset 

Path to dwg file to open or attach to if already opened. If left blank and [TdConnectConfig.Type](#a28c9457977b0f221f72006992984df17) allows it, [ThermalDesktop.Connect()](class_open_t_d_1_1_thermal_desktop.xhtml#a401d066096a6c3fec2a1b893973422f1 "Connect to an instance of TD using the options specified in ConnectConfig.") will start a new, blank drawing. Do not use this member to find the current dwg name. Instead, use [ThermalDesktop.GetCurrentDwgPathname()](class_open_t_d_1_1_thermal_desktop.xhtml#a833b6c089e146a396188e24ea0af4cdd).

See also[OpenTD.ThermalDesktop](class_open_t_d_1_1_thermal_desktop.xhtml "Represents one instance of Thermal Desktop. This is the top-level class for interacting with OpenTD."), [OpenTD.ThermalDesktop.Connect()](class_open_t_d_1_1_thermal_desktop.xhtml#a401d066096a6c3fec2a1b893973422f1 "Connect to an instance of TD using the options specified in ConnectConfig."), [OpenTD.ThermalDesktop.GetCurrentDwgPathname()](class_open_t_d_1_1_thermal_desktop.xhtml#a833b6c089e146a396188e24ea0af4cdd)///





<a id="a381083fc528e003b3c19afd09a39ce77" name="a381083fc528e003b3c19afd09a39ce77"></a>## [◆ ](#a381083fc528e003b3c19afd09a39ce77)PipeBaseAddress

 string OpenTD.TdConnectConfig.PipeBaseAddress  staticget 





<a id="a48f7a2194596c21acb66c34ab7cdddc2" name="a48f7a2194596c21acb66c34ab7cdddc2"></a>## [◆ ](#a48f7a2194596c21acb66c34ab7cdddc2)PipeEndpointName

 string OpenTD.TdConnectConfig.PipeEndpointName  getset 

Advanced. If not blank, specifies the name of the communications channel used by [OpenTD](namespace_open_t_d.xhtml "Base Thermal Desktop functionality.") to communicate with this instance of TD. If starting a new TD instance, [OpenTD](namespace_open_t_d.xhtml "Base Thermal Desktop functionality.") will attempt to create a channel with this name. If attaching, [OpenTD](namespace_open_t_d.xhtml "Base Thermal Desktop functionality.") will attempt to connect to a channel with this name. Leave blank for automatic channel-naming. To open a named channel in TD, use the 'RcOpenTD' AutoCAD command.

See also[OpenTD.ThermalDesktop](class_open_t_d_1_1_thermal_desktop.xhtml "Represents one instance of Thermal Desktop. This is the top-level class for interacting with OpenTD."), [OpenTD.ThermalDesktop.Connect()](class_open_t_d_1_1_thermal_desktop.xhtml#a401d066096a6c3fec2a1b893973422f1 "Connect to an instance of TD using the options specified in ConnectConfig.")



<a id="a230758399cd2463704f31ef622172c18" name="a230758399cd2463704f31ef622172c18"></a>## [◆ ](#a230758399cd2463704f31ef622172c18)PipeEndpointNameUsed

 string OpenTD.TdConnectConfig.PipeEndpointNameUsed  get 

Gets the communication channel name actually used. Set when [ThermalDesktop.Connect()](class_open_t_d_1_1_thermal_desktop.xhtml#a401d066096a6c3fec2a1b893973422f1 "Connect to an instance of TD using the options specified in ConnectConfig.") is called successfully.

See also[OpenTD.ThermalDesktop](class_open_t_d_1_1_thermal_desktop.xhtml "Represents one instance of Thermal Desktop. This is the top-level class for interacting with OpenTD."), [OpenTD.ThermalDesktop.Connect()](class_open_t_d_1_1_thermal_desktop.xhtml#a401d066096a6c3fec2a1b893973422f1 "Connect to an instance of TD using the options specified in ConnectConfig.")



<a id="af353ea627c65cde87cb566c6c2219299" name="af353ea627c65cde87cb566c6c2219299"></a>## [◆ ](#af353ea627c65cde87cb566c6c2219299)ShowAcadSplashScreen

 bool OpenTD.TdConnectConfig.ShowAcadSplashScreen  getset 

Controls whether the AutoCAD splash screen is displayed during startup.

See also[OpenTD.ThermalDesktop](class_open_t_d_1_1_thermal_desktop.xhtml "Represents one instance of Thermal Desktop. This is the top-level class for interacting with OpenTD."), [OpenTD.ThermalDesktop.Connect()](class_open_t_d_1_1_thermal_desktop.xhtml#a401d066096a6c3fec2a1b893973422f1 "Connect to an instance of TD using the options specified in ConnectConfig.")



<a id="a7abfa8cdeb05154b7bd270fce1db8297" name="a7abfa8cdeb05154b7bd270fce1db8297"></a>## [◆ ](#a7abfa8cdeb05154b7bd270fce1db8297)StartDirectory

 string OpenTD.TdConnectConfig.StartDirectory  getset 

The starting directory for the acad.exe process. For the current working directory, see [ThermalDesktop.GetCurrentWorkingDirectory()](class_open_t_d_1_1_thermal_desktop.xhtml#ac15aac3c8b123edcde5b7990b3be70cb).

See also[OpenTD.ThermalDesktop](class_open_t_d_1_1_thermal_desktop.xhtml "Represents one instance of Thermal Desktop. This is the top-level class for interacting with OpenTD."), [OpenTD.ThermalDesktop.Connect()](class_open_t_d_1_1_thermal_desktop.xhtml#a401d066096a6c3fec2a1b893973422f1 "Connect to an instance of TD using the options specified in ConnectConfig."), [OpenTD.ThermalDesktop.GetCurrentWorkingDirectory()](class_open_t_d_1_1_thermal_desktop.xhtml#ac15aac3c8b123edcde5b7990b3be70cb)///





<a id="a042d71ce2c38fe9f1597116bcce6da31" name="a042d71ce2c38fe9f1597116bcce6da31"></a>## [◆ ](#a042d71ce2c38fe9f1597116bcce6da31)StartTimeout

 [TimeoutProperties](class_open_t_d_1_1_td_connect_config_1_1_timeout_properties.xhtml) OpenTD.TdConnectConfig.StartTimeout  getset 

Controls how long [OpenTD](namespace_open_t_d.xhtml "Base Thermal Desktop functionality.") will try to connect to TD before timing out.

See also[OpenTD.ThermalDesktop](class_open_t_d_1_1_thermal_desktop.xhtml "Represents one instance of Thermal Desktop. This is the top-level class for interacting with OpenTD."), [OpenTD.ThermalDesktop.Connect()](class_open_t_d_1_1_thermal_desktop.xhtml#a401d066096a6c3fec2a1b893973422f1 "Connect to an instance of TD using the options specified in ConnectConfig.")



<a id="a28c9457977b0f221f72006992984df17" name="a28c9457977b0f221f72006992984df17"></a>## [◆ ](#a28c9457977b0f221f72006992984df17)Type

 [Types](#abd41449782efbc0f8a04a6ca43a25311) OpenTD.TdConnectConfig.Type  getset 





---

The documentation for this class was generated from the following file:- C:/Users/mgarrett/source/repos/BuildsTdSuite/builds/TDDEV\_ALPHA/buildXX/OpenTD/**TdConnectConfig.cs**