Skip to main content

OpenTD .NET8 reference 2025 R2

OpenTD.FloCAD.Compartment Class Reference

Last update: 16.07.2025

Client-side representation of a Compartment entity in a TD instance. More...

Inheritance diagram for OpenTD.FloCAD.Compartment:
OpenTD.TdDbEntityDataOpenTD.ITdDerivedOpenTD.DbObjectOpenTD.ITdDerivedOpenTD.OpenTDObjectOpenTD.IUpdatableOpenTD.IReassignable

Public Member Functions

 Compartment ()
 
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.
 
override string ToString ()
 
void SetFrom (TdDbEntityData x)
 
void SetFrom (DbObject x)
 
void SetFrom (OpenTDObject x)
 
override bool Equals (object obj)
 
override int GetHashCode ()
 
void UpdateIn (ThermalDesktop td)
 Updates the TD entity corresponding to this object in the specified TD instance, if possible.
 

Static Public Member Functions

static bool operator== (DbObject first, DbObject second)
 
static bool operator!= (DbObject first, DbObject second)
 

Protected Member Functions

string ToString (string Submodel, string Id, string Comment)
 
string ToString (string Submodel, int Id, string Comment)
 

Protected Attributes

ITdCommander TdProxy
 

Properties

string Comment [get, set]
 
List< Bay > Bays [get, set]
 
List< CompartmentTie > Ties [get, set]
 
bool ShowIds [get, set]
 
int CompartmentId [get, set]
 
int Enabled [get, set]
 
ExpressionData EnabledExp [get, set]
 
double PackingFactor [get, set]
 
ExpressionData PackingFactorExp [get, set]
 
int ShowLV [get, set]
 
ExpressionData ShowLVExp [get, set]
 
int ShowSelectionRing [get, set]
 
ExpressionData ShowSelectionRingExp [get, set]
 
int TwinLump [get, set]
 
int LiquidColor [get, set]
 
string LumpHandle [get]
 
string _LumpHandle [get, set]
 Do not use.
 
string Layer [get, set]
 
int ColorIndex [get, set]
 Specifies a color. See the AutoCAD Layer Properties Manager for valid values.
 
string Handle [get, set]
 
string TypeName [get, set]
 
string TdClassName [get]
 

Detailed Description

Client-side representation of a Compartment entity in a TD instance.

See also
OpenTD.ThermalDesktop

Constructor & Destructor Documentation

◆ Compartment()

OpenTD.FloCAD.Compartment.Compartment ( )
inline

Member Function Documentation

◆ CreateIn()

override void OpenTD.FloCAD.Compartment.CreateIn ( ThermalDesktop td)
inline

Creates the TD entity in the specified TD instance.

Implements OpenTD.IReassignable.

◆ Equals()

override bool OpenTD.DbObject.Equals ( object obj)
inlineinherited

◆ GetHashCode()

override int OpenTD.DbObject.GetHashCode ( )
inlineinherited

◆ operator!=()

static bool OpenTD.DbObject.operator!= ( DbObject first,
DbObject second )
inlinestaticinherited

◆ operator==()

static bool OpenTD.DbObject.operator== ( DbObject first,
DbObject second )
inlinestaticinherited

◆ SetFrom() [1/3]

void OpenTD.DbObject.SetFrom ( DbObject x)
inlineinherited

◆ SetFrom() [2/3]

void OpenTD.OpenTDObject.SetFrom ( OpenTDObject x)
inlineinherited

◆ SetFrom() [3/3]

void OpenTD.TdDbEntityData.SetFrom ( TdDbEntityData x)
inlineinherited

◆ ToString() [1/3]

override string OpenTD.FloCAD.Compartment.ToString ( )
inline

◆ ToString() [2/3]

string OpenTD.TdDbEntityData.ToString ( string Submodel,
int Id,
string Comment )
inlineprotectedinherited

◆ ToString() [3/3]

string OpenTD.TdDbEntityData.ToString ( string Submodel,
string Id,
string Comment )
inlineprotectedinherited

◆ Update()

override void OpenTD.FloCAD.Compartment.Update ( )
inline

Updates the TD entity with the latest client data.

Implements OpenTD.IUpdatable.

◆ UpdateFromTD()

override void OpenTD.FloCAD.Compartment.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

◆ _LumpHandle

string OpenTD.FloCAD.Compartment._LumpHandle
getset

Do not use.

◆ Bays

List<Bay> OpenTD.FloCAD.Compartment.Bays
getset

◆ ColorIndex

int OpenTD.TdDbEntityData.ColorIndex
getsetinherited

Specifies a color. See the AutoCAD Layer Properties Manager for valid values.

◆ Comment

string OpenTD.FloCAD.Compartment.Comment
getset

◆ CompartmentId

int OpenTD.FloCAD.Compartment.CompartmentId
getset

◆ Enabled

int OpenTD.FloCAD.Compartment.Enabled
getset

◆ EnabledExp

ExpressionData OpenTD.FloCAD.Compartment.EnabledExp
getset

◆ Handle

string OpenTD.DbObject.Handle
getsetinherited

◆ Layer

string OpenTD.TdDbEntityData.Layer
getsetinherited

◆ LiquidColor

int OpenTD.FloCAD.Compartment.LiquidColor
getset

◆ LumpHandle

string OpenTD.FloCAD.Compartment.LumpHandle
get

◆ PackingFactor

double OpenTD.FloCAD.Compartment.PackingFactor
getset

◆ PackingFactorExp

ExpressionData OpenTD.FloCAD.Compartment.PackingFactorExp
getset

◆ ShowIds

bool OpenTD.FloCAD.Compartment.ShowIds
getset

◆ ShowLV

int OpenTD.FloCAD.Compartment.ShowLV
getset

◆ ShowLVExp

ExpressionData OpenTD.FloCAD.Compartment.ShowLVExp
getset

◆ ShowSelectionRing

int OpenTD.FloCAD.Compartment.ShowSelectionRing
getset

◆ ShowSelectionRingExp

ExpressionData OpenTD.FloCAD.Compartment.ShowSelectionRingExp
getset

◆ TdClassName

string OpenTD.ITdDerived.TdClassName
getinherited

◆ Ties

List<CompartmentTie> OpenTD.FloCAD.Compartment.Ties
getset

◆ TwinLump

int OpenTD.FloCAD.Compartment.TwinLump
getset

◆ TypeName

string OpenTD.DbObject.TypeName
getsetinherited

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

Connect with Ansys