Skip to main content

OpenTD .NET8 reference 2025 R2

OpenTD.UserArray Class Reference

Last update: 16.07.2025

Client-side representation of a Logic Object User Array in a TD instance. More...

Inheritance diagram for OpenTD.UserArray:
OpenTD.RcLogicUserArrayDataOpenTD.LogicObjectOpenTD.ITdDerivedOpenTD.OpenTDObjectOpenTD.ITdDerivedOpenTD.IUpdatableOpenTD.IReassignable

Public Types

enum  ArrayTypes { SINGLET = 0 , DOUBLET = 1 , BIVARIATE = 2 , PROPERTY = 3 }
 Sinda array types. More...
 
enum  ThermoPropArrayTypes { COND_X = 0 , COND_Y = 1 , COND_Z = 2 , SPECIFICHEAT = 3 }
 Thermophysical property array types. More...
 
enum  LogicType {
  TRANSLATECODE = -1 , ARRAY_INTERP , BIVAR_INTERP , PID ,
  USERCODE , DIFFEQ , DIFFEQANGULAR , DIFFEQRPM ,
  COMPAREDL , USER_ARRAY , SUBCOMPLQ , FORTRANARRAY ,
  MAXLOGICTYPE
}
 TD Logic Object types. More...
 

Public Member Functions

override void Update ()
 Updates the TD entity with the latest client data.
 
override void CreateIn (ThermalDesktop td)
 Creates the TD entity in the specified TD instance.
 
void CheckData ()
 
override void UpdateFromTD ()
 Updates the client-side instance with the latest data from the TD entity.
 
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 Attributes

ITdCommander TdProxy
 

Properties

ArrayTypes ArrayType [get, set]
 
int ArrayId [get, set]
 
ListSI SingletArray_SI [get, set]
 Note that this array is always in SI units, regardless of WorkingUnits.
 
ExpressionArrayClassData SingletArrayExp [get, set]
 
UnitsData.UnitsType SingletArrayUnitsType [get, set]
 
ListSI DoubletArrayX_SI [get, set]
 Note that this array is always in SI units, regardless of WorkingUnits.
 
ExpressionArrayClassData DoubletArrayXExp [get, set]
 
ListSI DoubletArrayY_SI [get, set]
 Note that this array is always in SI units, regardless of WorkingUnits.
 
ExpressionArrayClassData DoubletArrayYExp [get, set]
 
UnitsData.UnitsType DoubletArrayUnitsTypeX [get, set]
 
UnitsData.UnitsType DoubletArrayUnitsTypeY [get, set]
 
ListSI BivarArrayX_SI [get, set]
 Note that this array is always in SI units, regardless of WorkingUnits.
 
ExpressionArrayClassData BivarArrayXExp [get, set]
 
ListSI BivarArrayY_SI [get, set]
 Note that this array is always in SI units, regardless of WorkingUnits.
 
ExpressionArrayClassData BivarArrayYExp [get, set]
 
ListSI BivarArray_SI [get, set]
 Note that this array is always in SI units, regardless of WorkingUnits.
 
ExpressionArrayClassData BivarArrayExp [get, set]
 
UnitsData.UnitsType BivarArrayUnitsTypeX [get, set]
 
UnitsData.UnitsType BivarArrayUnitsTypeY [get, set]
 
UnitsData.UnitsType BivarArrayUnitsType [get, set]
 
ThermoPropArrayTypes ThermoPropArrayType [get, set]
 
string ThermoPropName [get, set]
 
int UseDataMultColumn0 [get, set]
 
int UseDataMultColumn1OrRow [get, set]
 
int UseDataMultBiVarData [get, set]
 
int OutputMultiplierToSINDA [get, set]
 
string DataMultColumn0 [get, set]
 
string DataMultColumn1OrRow [get, set]
 
string DataMultBiVarData [get, set]
 
string TdClassName [get]
 
string Handle [get, set]
 
string Comment [get, set]
 
SubmodelNameData Submodel [get, set]
 
ExpressionData EnabledExp [get, set]
 
string GroupName [get, set]
 
LogicType Type [get]
 

Detailed Description

Client-side representation of a Logic Object User Array in a TD instance.

See also
OpenTD.ThermalDesktop

Member Enumeration Documentation

◆ ArrayTypes

Sinda array types.

Enumerator
SINGLET 
DOUBLET 
BIVARIATE 
PROPERTY 

◆ LogicType

TD Logic Object types.

Enumerator
TRANSLATECODE 
ARRAY_INTERP 
BIVAR_INTERP 
PID 
USERCODE 
DIFFEQ 
DIFFEQANGULAR 
DIFFEQRPM 
COMPAREDL 
USER_ARRAY 
SUBCOMPLQ 
FORTRANARRAY 
MAXLOGICTYPE 

◆ ThermoPropArrayTypes

Thermophysical property array types.

Enumerator
COND_X 
COND_Y 
COND_Z 
SPECIFICHEAT 

Member Function Documentation

◆ CheckData()

void OpenTD.RcLogicUserArrayData.CheckData ( )
inlineinherited

◆ CreateIn()

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

Creates the TD entity in the specified TD instance.

Implements OpenTD.IReassignable.

◆ SetFrom()

void OpenTD.OpenTDObject.SetFrom ( OpenTDObject x)
inlineinherited

◆ ToString()

override string OpenTD.LogicObject.ToString ( )
inlineinherited

◆ Update()

override void OpenTD.UserArray.Update ( )
inline

Updates the TD entity with the latest client data.

Implements OpenTD.IUpdatable.

◆ UpdateFromTD()

override void OpenTD.LogicObject.UpdateFromTD ( )
inlineinherited

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

◆ ArrayId

int OpenTD.RcLogicUserArrayData.ArrayId
getsetinherited

◆ ArrayType

ArrayTypes OpenTD.RcLogicUserArrayData.ArrayType
getsetinherited

◆ BivarArray_SI

ListSI OpenTD.RcLogicUserArrayData.BivarArray_SI
getsetinherited

Note that this array is always in SI units, regardless of WorkingUnits.

◆ BivarArrayExp

ExpressionArrayClassData OpenTD.RcLogicUserArrayData.BivarArrayExp
getsetinherited

◆ BivarArrayUnitsType

UnitsData.UnitsType OpenTD.RcLogicUserArrayData.BivarArrayUnitsType
getsetinherited

◆ BivarArrayUnitsTypeX

UnitsData.UnitsType OpenTD.RcLogicUserArrayData.BivarArrayUnitsTypeX
getsetinherited

◆ BivarArrayUnitsTypeY

UnitsData.UnitsType OpenTD.RcLogicUserArrayData.BivarArrayUnitsTypeY
getsetinherited

◆ BivarArrayX_SI

ListSI OpenTD.RcLogicUserArrayData.BivarArrayX_SI
getsetinherited

Note that this array is always in SI units, regardless of WorkingUnits.

◆ BivarArrayXExp

ExpressionArrayClassData OpenTD.RcLogicUserArrayData.BivarArrayXExp
getsetinherited

◆ BivarArrayY_SI

ListSI OpenTD.RcLogicUserArrayData.BivarArrayY_SI
getsetinherited

Note that this array is always in SI units, regardless of WorkingUnits.

◆ BivarArrayYExp

ExpressionArrayClassData OpenTD.RcLogicUserArrayData.BivarArrayYExp
getsetinherited

◆ Comment

string OpenTD.LogicObject.Comment
getsetinherited

◆ DataMultBiVarData

string OpenTD.RcLogicUserArrayData.DataMultBiVarData
getsetinherited

◆ DataMultColumn0

string OpenTD.RcLogicUserArrayData.DataMultColumn0
getsetinherited

◆ DataMultColumn1OrRow

string OpenTD.RcLogicUserArrayData.DataMultColumn1OrRow
getsetinherited

◆ DoubletArrayUnitsTypeX

UnitsData.UnitsType OpenTD.RcLogicUserArrayData.DoubletArrayUnitsTypeX
getsetinherited

◆ DoubletArrayUnitsTypeY

UnitsData.UnitsType OpenTD.RcLogicUserArrayData.DoubletArrayUnitsTypeY
getsetinherited

◆ DoubletArrayX_SI

ListSI OpenTD.RcLogicUserArrayData.DoubletArrayX_SI
getsetinherited

Note that this array is always in SI units, regardless of WorkingUnits.

◆ DoubletArrayXExp

ExpressionArrayClassData OpenTD.RcLogicUserArrayData.DoubletArrayXExp
getsetinherited

◆ DoubletArrayY_SI

ListSI OpenTD.RcLogicUserArrayData.DoubletArrayY_SI
getsetinherited

Note that this array is always in SI units, regardless of WorkingUnits.

◆ DoubletArrayYExp

ExpressionArrayClassData OpenTD.RcLogicUserArrayData.DoubletArrayYExp
getsetinherited

◆ EnabledExp

ExpressionData OpenTD.LogicObject.EnabledExp
getsetinherited

◆ GroupName

string OpenTD.LogicObject.GroupName
getsetinherited

◆ Handle

string OpenTD.LogicObject.Handle
getsetinherited

◆ OutputMultiplierToSINDA

int OpenTD.RcLogicUserArrayData.OutputMultiplierToSINDA
getsetinherited

◆ SingletArray_SI

ListSI OpenTD.RcLogicUserArrayData.SingletArray_SI
getsetinherited

Note that this array is always in SI units, regardless of WorkingUnits.

◆ SingletArrayExp

ExpressionArrayClassData OpenTD.RcLogicUserArrayData.SingletArrayExp
getsetinherited

◆ SingletArrayUnitsType

UnitsData.UnitsType OpenTD.RcLogicUserArrayData.SingletArrayUnitsType
getsetinherited

◆ Submodel

SubmodelNameData OpenTD.LogicObject.Submodel
getsetinherited

◆ TdClassName

string OpenTD.ITdDerived.TdClassName
getinherited

◆ ThermoPropArrayType

ThermoPropArrayTypes OpenTD.RcLogicUserArrayData.ThermoPropArrayType
getsetinherited

◆ ThermoPropName

string OpenTD.RcLogicUserArrayData.ThermoPropName
getsetinherited

◆ Type

LogicType OpenTD.LogicObject.Type
getinherited

◆ UseDataMultBiVarData

int OpenTD.RcLogicUserArrayData.UseDataMultBiVarData
getsetinherited

◆ UseDataMultColumn0

int OpenTD.RcLogicUserArrayData.UseDataMultColumn0
getsetinherited

◆ UseDataMultColumn1OrRow

int OpenTD.RcLogicUserArrayData.UseDataMultColumn1OrRow
getsetinherited

The documentation for this class was generated from the following file:
  • C:/Users/mgarrett/source/repos/BuildsTdSuite/builds/OpenTD/OpenTD/UserArray.cs

Connect with Ansys