## On this page

  

 

 # OpenTD.Symbol Class Reference

 Last update: 16.07.2025 

Client-side representation of a [Symbol](class_open_t_d_1_1_symbol.xhtml "Client-side representation of a Symbol in a TD instance.") in a TD instance. [More...](#details)

Inheritance diagram for OpenTD.Symbol:

 ![](/sites/default/files/migrate-content/opentd_net4_reference_2025_r2_1/class_open_t_d_1_1_symbol.png)



## <a id="pub-types" name="pub-types"></a>Public Types

enum [SymbolType](class_open_t_d_1_1_symbol_data.xhtml#ab48489290f53f31b4e6feda5e3551821) { [DOUBLE](class_open_t_d_1_1_symbol_data.xhtml#ab48489290f53f31b4e6feda5e3551821afd3e4ece78a7d422280d5ed379482229), [ARRAY](class_open_t_d_1_1_symbol_data.xhtml#ab48489290f53f31b4e6feda5e3551821acb4fb1757fb37c43cded35d3eb857c43), [STRING](class_open_t_d_1_1_symbol_data.xhtml#ab48489290f53f31b4e6feda5e3551821a63b588d5559f64f89a416e656880b949) } Type of symbol: string, array, etc. [More...](class_open_t_d_1_1_symbol_data.xhtml#ab48489290f53f31b4e6feda5e3551821)  
 enum [OutputType](class_open_t_d_1_1_symbol_data.xhtml#a989d1ccec58297cf6d95010707fd4815) { [VALUE](class_open_t_d_1_1_symbol_data.xhtml#a989d1ccec58297cf6d95010707fd4815aecc2e9c313faddb07e7da223c1dc5c3f), [EXPRESSION](class_open_t_d_1_1_symbol_data.xhtml#a989d1ccec58297cf6d95010707fd4815aea8ec660a4ff1a0cf378ac911be7efb2) } How a symbol will be output to Sinda: just the value or an expression. [More...](class_open_t_d_1_1_symbol_data.xhtml#a989d1ccec58297cf6d95010707fd4815)  
 ## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

override void [Update](#a6d915e493de2218538ade013e9536018) () Updates the TD entity with the latest client data.   
 override void [UpdateFromTD](#ad9876d194ff044dea1b070faaaed01ec) () Updates the client-side instance with the latest data from the TD entity.   
 override void [CreateIn](#af3813ead217d7e8edcfe5135189bc003) ([ThermalDesktop](class_open_t_d_1_1_thermal_desktop.xhtml) td) Creates the TD entity in the specified TD instance.   
 virtual void [Rename](class_open_t_d_1_1_unique_name_object.xhtml#ab83691a4d2f3bd34519f9372cfc73951) (string to) Use this method to rename the client-side object and the TD item it is linked to.   
 override string [ToString](class_open_t_d_1_1_unique_name_object.xhtml#af373d173d2d75fd2b4c6edb8ee4165b2) () void [SetFrom](class_open_t_d_1_1_open_t_d_object.xhtml#aa2e0aa2793e95a56891ef59fb4843ca2) ([OpenTDObject](class_open_t_d_1_1_open_t_d_object.xhtml) x) void [UpdateIn](class_open_t_d_1_1_open_t_d_object.xhtml#a1e5228ce309c9a85ec09e8119318024d) ([ThermalDesktop](class_open_t_d_1_1_thermal_desktop.xhtml) td) Updates the TD entity corresponding to this object in the specified TD instance, if possible.   
 ## <a id="pro-methods" name="pro-methods"></a>Protected Member Functions

override void [ProxyRename](class_open_t_d_1_1_symbol_data.xhtml#aa77016ab8796565654ae64af1eb17ea3) (string from, string to) virtual string [ModifyName](class_open_t_d_1_1_unique_name_object.xhtml#a1343e99cd573893ee16d36c337fde7b1) (string name) ## <a id="pro-attribs" name="pro-attribs"></a>Protected Attributes

[ITdCommander](interface_open_t_d_1_1_internal_1_1_communication_1_1_i_td_commander.xhtml) [TdProxy](class_open_t_d_1_1_open_t_d_object.xhtml#a0da16592e6b635ca0def27b355d669b3) ## <a id="properties" name="properties"></a>Properties

string [Value](class_open_t_d_1_1_symbol_data.xhtml#a145177d582d9af48cb4569018dc8c1bf)` [get, set]` string [Description](class_open_t_d_1_1_symbol_data.xhtml#ac61bd7fe5089d57e5bd7fe8da6d7cae8)` [get, set]` [SymbolType](class_open_t_d_1_1_symbol_data.xhtml#ab48489290f53f31b4e6feda5e3551821) [Type](class_open_t_d_1_1_symbol_data.xhtml#ad98ad92aa02e822d545f3cbb03b7cd7a)` [get, set]` string [Group](class_open_t_d_1_1_symbol_data.xhtml#ab041e6befc1b2b36ea98ffc934bcc0e5)` [get, set]` bool [CheckConsistentUnitsUse](class_open_t_d_1_1_symbol_data.xhtml#a3d6184d46ceb03391517003335b4f004)` [get, set]` bool [OutputAsRegister](class_open_t_d_1_1_symbol_data.xhtml#a80b01609b0b89321e5d6d5ef5e719744)` [get, set]` [OutputType](class_open_t_d_1_1_symbol_data.xhtml#a989d1ccec58297cf6d95010707fd4815) [Output](class_open_t_d_1_1_symbol_data.xhtml#adbf80f264a38431410b60a5086fca147)` [get, set]` bool [OutputInteger](class_open_t_d_1_1_symbol_data.xhtml#a8e49998f01194ba13e0fc8ae37c7961a)` [get, set]` bool [DisableWarnings](class_open_t_d_1_1_symbol_data.xhtml#a15b823fa78609d93dbfec3673eb3598e)` [get, set]` bool [DriveAutoCADDimension](class_open_t_d_1_1_symbol_data.xhtml#adeccbc571cc2263a0a45b4ae37b9450c)` [get, set]` string [Name](class_open_t_d_1_1_unique_name_object.xhtml#a81ee04aec6314a6dd404826b41564162)` [get]` This object is uniquely-identified by this name.   
 string [\_n](class_open_t_d_1_1_unique_name_object.xhtml#a4546becfb33773b2b9d0ae2264c9dd2d)` [get, set]` Do not use.   
 <a id="details" name="details"></a>## Detailed Description

Client-side representation of a [Symbol](class_open_t_d_1_1_symbol.xhtml "Client-side representation of a Symbol in a TD instance.") in a TD instance.

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.")

## Member Enumeration Documentation

<a id="a989d1ccec58297cf6d95010707fd4815" name="a989d1ccec58297cf6d95010707fd4815"></a>## [◆ ](#a989d1ccec58297cf6d95010707fd4815)OutputType

 enum [OpenTD.SymbolData.OutputType](class_open_t_d_1_1_symbol_data.xhtml#a989d1ccec58297cf6d95010707fd4815)  inherited 

How a symbol will be output to Sinda: just the value or an expression.

Enumerator<a id="a989d1ccec58297cf6d95010707fd4815aecc2e9c313faddb07e7da223c1dc5c3f" name="a989d1ccec58297cf6d95010707fd4815aecc2e9c313faddb07e7da223c1dc5c3f"></a>VALUE <a id="a989d1ccec58297cf6d95010707fd4815aea8ec660a4ff1a0cf378ac911be7efb2" name="a989d1ccec58297cf6d95010707fd4815aea8ec660a4ff1a0cf378ac911be7efb2"></a>EXPRESSION 



<a id="ab48489290f53f31b4e6feda5e3551821" name="ab48489290f53f31b4e6feda5e3551821"></a>## [◆ ](#ab48489290f53f31b4e6feda5e3551821)SymbolType

 enum [OpenTD.SymbolData.SymbolType](class_open_t_d_1_1_symbol_data.xhtml#ab48489290f53f31b4e6feda5e3551821)  inherited 

Type of symbol: string, array, etc.

Enumerator<a id="ab48489290f53f31b4e6feda5e3551821afd3e4ece78a7d422280d5ed379482229" name="ab48489290f53f31b4e6feda5e3551821afd3e4ece78a7d422280d5ed379482229"></a>DOUBLE <a id="ab48489290f53f31b4e6feda5e3551821acb4fb1757fb37c43cded35d3eb857c43" name="ab48489290f53f31b4e6feda5e3551821acb4fb1757fb37c43cded35d3eb857c43"></a>ARRAY <a id="ab48489290f53f31b4e6feda5e3551821a63b588d5559f64f89a416e656880b949" name="ab48489290f53f31b4e6feda5e3551821a63b588d5559f64f89a416e656880b949"></a>STRING 



## Member Function Documentation

<a id="af3813ead217d7e8edcfe5135189bc003" name="af3813ead217d7e8edcfe5135189bc003"></a>## [◆ ](#af3813ead217d7e8edcfe5135189bc003)CreateIn()

 override void OpenTD.Symbol.CreateIn  ( [ThermalDesktop](class_open_t_d_1_1_thermal_desktop.xhtml) *td*)   inline 

Creates the TD entity in the specified TD instance.

Implements [OpenTD.IReassignable](interface_open_t_d_1_1_i_reassignable.xhtml#a94cbc52d002a10e44f5dc2daaf9c87db).





<a id="a1343e99cd573893ee16d36c337fde7b1" name="a1343e99cd573893ee16d36c337fde7b1"></a>## [◆ ](#a1343e99cd573893ee16d36c337fde7b1)ModifyName()

 virtual string OpenTD.UniqueNameObject.ModifyName  ( string *name*)   inlineprotectedvirtualinherited 

Reimplemented in [OpenTD.SubmodelData](class_open_t_d_1_1_submodel_data.xhtml#a607b0ad2b1e47186137ea8149940f481).





<a id="aa77016ab8796565654ae64af1eb17ea3" name="aa77016ab8796565654ae64af1eb17ea3"></a>## [◆ ](#aa77016ab8796565654ae64af1eb17ea3)ProxyRename()

 override void OpenTD.SymbolData.ProxyRename  ( string *from*,    string *to* )  inlineprotectedinherited 





<a id="ab83691a4d2f3bd34519f9372cfc73951" name="ab83691a4d2f3bd34519f9372cfc73951"></a>## [◆ ](#ab83691a4d2f3bd34519f9372cfc73951)Rename()

 virtual void OpenTD.UniqueNameObject.Rename  ( string *to*)   inlinevirtualinherited 

Use this method to rename the client-side object and the TD item it is linked to.





<a id="aa2e0aa2793e95a56891ef59fb4843ca2" name="aa2e0aa2793e95a56891ef59fb4843ca2"></a>## [◆ ](#aa2e0aa2793e95a56891ef59fb4843ca2)SetFrom()

 void OpenTD.OpenTDObject.SetFrom  ( [OpenTDObject](class_open_t_d_1_1_open_t_d_object.xhtml) *x*)   inlineinherited 





<a id="af373d173d2d75fd2b4c6edb8ee4165b2" name="af373d173d2d75fd2b4c6edb8ee4165b2"></a>## [◆ ](#af373d173d2d75fd2b4c6edb8ee4165b2)ToString()

 override string OpenTD.UniqueNameObject.ToString  ( )   inlineinherited 





<a id="a6d915e493de2218538ade013e9536018" name="a6d915e493de2218538ade013e9536018"></a>## [◆ ](#a6d915e493de2218538ade013e9536018)Update()

 override void OpenTD.Symbol.Update  ( )   inline 

Updates the TD entity with the latest client data.

Implements [OpenTD.IUpdatable](interface_open_t_d_1_1_i_updatable.xhtml#a162ef7c717f51047a1d45c7df4282470).





<a id="ad9876d194ff044dea1b070faaaed01ec" name="ad9876d194ff044dea1b070faaaed01ec"></a>## [◆ ](#ad9876d194ff044dea1b070faaaed01ec)UpdateFromTD()

 override void OpenTD.Symbol.UpdateFromTD  ( )   inline 

Updates the client-side instance with the latest data from the TD entity.

Implements [OpenTD.IUpdatable](interface_open_t_d_1_1_i_updatable.xhtml#a47f3096415cfb5694fd822df8a1eceb0).





<a id="a1e5228ce309c9a85ec09e8119318024d" name="a1e5228ce309c9a85ec09e8119318024d"></a>## [◆ ](#a1e5228ce309c9a85ec09e8119318024d)UpdateIn()

 void OpenTD.OpenTDObject.UpdateIn  ( [ThermalDesktop](class_open_t_d_1_1_thermal_desktop.xhtml) *td*)   inlineinherited 

Updates the TD entity corresponding to this object in the specified TD instance, if possible.

Implements [OpenTD.IReassignable](interface_open_t_d_1_1_i_reassignable.xhtml#a90dffde7dd442e9d940f9e5c5fabde14).





## Member Data Documentation

<a id="a0da16592e6b635ca0def27b355d669b3" name="a0da16592e6b635ca0def27b355d669b3"></a>## [◆ ](#a0da16592e6b635ca0def27b355d669b3)TdProxy

 [ITdCommander](interface_open_t_d_1_1_internal_1_1_communication_1_1_i_td_commander.xhtml) OpenTD.OpenTDObject.TdProxy  protectedinherited 





## Property Documentation

<a id="a4546becfb33773b2b9d0ae2264c9dd2d" name="a4546becfb33773b2b9d0ae2264c9dd2d"></a>## [◆ ](#a4546becfb33773b2b9d0ae2264c9dd2d)\_n

 string OpenTD.UniqueNameObject.\_n  getsetinherited 

Do not use.





<a id="a3d6184d46ceb03391517003335b4f004" name="a3d6184d46ceb03391517003335b4f004"></a>## [◆ ](#a3d6184d46ceb03391517003335b4f004)CheckConsistentUnitsUse

 bool OpenTD.SymbolData.CheckConsistentUnitsUse  getsetinherited 





<a id="ac61bd7fe5089d57e5bd7fe8da6d7cae8" name="ac61bd7fe5089d57e5bd7fe8da6d7cae8"></a>## [◆ ](#ac61bd7fe5089d57e5bd7fe8da6d7cae8)Description

 string OpenTD.SymbolData.Description  getsetinherited 





<a id="a15b823fa78609d93dbfec3673eb3598e" name="a15b823fa78609d93dbfec3673eb3598e"></a>## [◆ ](#a15b823fa78609d93dbfec3673eb3598e)DisableWarnings

 bool OpenTD.SymbolData.DisableWarnings  getsetinherited 





<a id="adeccbc571cc2263a0a45b4ae37b9450c" name="adeccbc571cc2263a0a45b4ae37b9450c"></a>## [◆ ](#adeccbc571cc2263a0a45b4ae37b9450c)DriveAutoCADDimension

 bool OpenTD.SymbolData.DriveAutoCADDimension  getsetinherited 





<a id="ab041e6befc1b2b36ea98ffc934bcc0e5" name="ab041e6befc1b2b36ea98ffc934bcc0e5"></a>## [◆ ](#ab041e6befc1b2b36ea98ffc934bcc0e5)Group

 string OpenTD.SymbolData.Group  getsetinherited 





<a id="a81ee04aec6314a6dd404826b41564162" name="a81ee04aec6314a6dd404826b41564162"></a>## [◆ ](#a81ee04aec6314a6dd404826b41564162)Name

 string OpenTD.UniqueNameObject.Name  getinherited 

This object is uniquely-identified by this name.





<a id="adbf80f264a38431410b60a5086fca147" name="adbf80f264a38431410b60a5086fca147"></a>## [◆ ](#adbf80f264a38431410b60a5086fca147)Output

 [OutputType](class_open_t_d_1_1_symbol_data.xhtml#a989d1ccec58297cf6d95010707fd4815) OpenTD.SymbolData.Output  getsetinherited 





<a id="a80b01609b0b89321e5d6d5ef5e719744" name="a80b01609b0b89321e5d6d5ef5e719744"></a>## [◆ ](#a80b01609b0b89321e5d6d5ef5e719744)OutputAsRegister

 bool OpenTD.SymbolData.OutputAsRegister  getsetinherited 





<a id="a8e49998f01194ba13e0fc8ae37c7961a" name="a8e49998f01194ba13e0fc8ae37c7961a"></a>## [◆ ](#a8e49998f01194ba13e0fc8ae37c7961a)OutputInteger

 bool OpenTD.SymbolData.OutputInteger  getsetinherited 





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

 [SymbolType](class_open_t_d_1_1_symbol_data.xhtml#ab48489290f53f31b4e6feda5e3551821) OpenTD.SymbolData.Type  getsetinherited 





<a id="a145177d582d9af48cb4569018dc8c1bf" name="a145177d582d9af48cb4569018dc8c1bf"></a>## [◆ ](#a145177d582d9af48cb4569018dc8c1bf)Value

 string OpenTD.SymbolData.Value  getsetinherited 





---

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