OpenTD .NET4 reference 2025 R2

OpenTD.Symbol Class Reference

Last update: 16.07.2025

Client-side representation of a Symbol in a TD instance. More...

Inheritance diagram for OpenTD.Symbol:
OpenTD.SymbolDataOpenTD.UniqueNameObjectOpenTD.ITdDerivedOpenTD.OpenTDObjectOpenTD.IUpdatableOpenTD.IReassignable

Public Types

enum  SymbolType { DOUBLE , ARRAY , STRING }
 Type of symbol: string, array, etc. More...
 
enum  OutputType { VALUE , EXPRESSION }
 How a symbol will be output to Sinda: just the value or an expression. More...
 

Public Member Functions

override void Update ()
 Updates the TD entity with the latest client data.
 
override void UpdateFromTD ()
 Updates the client-side instance with the latest data from the TD entity.
 
override void CreateIn (ThermalDesktop td)
 Creates the TD entity in the specified TD instance.
 
virtual void Rename (string to)
 Use this method to rename the client-side object and the TD item it is linked to.
 
override string ToString ()
 
void SetFrom (OpenTDObject x)
 
void UpdateIn (ThermalDesktop td)
 Updates the TD entity corresponding to this object in the specified TD instance, if possible.
 

Protected Member Functions

override void ProxyRename (string from, string to)
 
virtual string ModifyName (string name)
 

Protected Attributes

ITdCommander TdProxy
 

Properties

string Value [get, set]
 
string Description [get, set]
 
SymbolType Type [get, set]
 
string Group [get, set]
 
bool CheckConsistentUnitsUse [get, set]
 
bool OutputAsRegister [get, set]
 
OutputType Output [get, set]
 
bool OutputInteger [get, set]
 
bool DisableWarnings [get, set]
 
bool DriveAutoCADDimension [get, set]
 
string Name [get]
 This object is uniquely-identified by this name.
 
string _n [get, set]
 Do not use.
 

Detailed Description

Client-side representation of a Symbol in a TD instance.

See also
OpenTD.ThermalDesktop

Member Enumeration Documentation

◆ OutputType

enum OpenTD.SymbolData.OutputType
inherited

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

Enumerator
VALUE 
EXPRESSION 

◆ SymbolType

enum OpenTD.SymbolData.SymbolType
inherited

Type of symbol: string, array, etc.

Enumerator
DOUBLE 
ARRAY 
STRING 

Member Function Documentation

◆ CreateIn()

override void OpenTD.Symbol.CreateIn ( ThermalDesktop td)
inline

Creates the TD entity in the specified TD instance.

Implements OpenTD.IReassignable.

◆ ModifyName()

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

Reimplemented in OpenTD.SubmodelData.

◆ ProxyRename()

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

◆ 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.

◆ SetFrom()

void OpenTD.OpenTDObject.SetFrom ( OpenTDObject x)
inlineinherited

◆ ToString()

override string OpenTD.UniqueNameObject.ToString ( )
inlineinherited

◆ Update()

override void OpenTD.Symbol.Update ( )
inline

Updates the TD entity with the latest client data.

Implements OpenTD.IUpdatable.

◆ UpdateFromTD()

override void OpenTD.Symbol.UpdateFromTD ( )
inline

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

Implements OpenTD.IUpdatable.

◆ UpdateIn()

void OpenTD.OpenTDObject.UpdateIn ( ThermalDesktop td)
inlineinherited

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

Implements OpenTD.IReassignable.

Member Data Documentation

◆ TdProxy

ITdCommander OpenTD.OpenTDObject.TdProxy
protectedinherited

Property Documentation

◆ _n

string OpenTD.UniqueNameObject._n
getsetinherited

Do not use.

◆ CheckConsistentUnitsUse

bool OpenTD.SymbolData.CheckConsistentUnitsUse
getsetinherited

◆ Description

string OpenTD.SymbolData.Description
getsetinherited

◆ DisableWarnings

bool OpenTD.SymbolData.DisableWarnings
getsetinherited

◆ DriveAutoCADDimension

bool OpenTD.SymbolData.DriveAutoCADDimension
getsetinherited

◆ Group

string OpenTD.SymbolData.Group
getsetinherited

◆ Name

string OpenTD.UniqueNameObject.Name
getinherited

This object is uniquely-identified by this name.

◆ Output

OutputType OpenTD.SymbolData.Output
getsetinherited

◆ OutputAsRegister

bool OpenTD.SymbolData.OutputAsRegister
getsetinherited

◆ OutputInteger

bool OpenTD.SymbolData.OutputInteger
getsetinherited

◆ Type

SymbolType OpenTD.SymbolData.Type
getsetinherited

◆ 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

Connect with Ansys