Show / Hide Table of Contents

Class WorldLayerSettings

Inheritance
System.Object
WorldLayerSettings
BiomeLayerSettings
CombineLayerSettings
DecayingLayerSettings
SpeciesHabitabilityLayerSettings
SpeciesLayerSettings
SpreadLayerSettings
SumLayerSettings
TemperatureLayerSettings
Implements
IController
IViewController
IHasUniversalID
Namespace: Eco.Simulation.WorldLayers.Layers
Assembly: Eco.Simulation.dll
Syntax
public class WorldLayerSettings : Object, IController, IViewController, IHasUniversalID

Constructors

WorldLayerSettings()

Declaration
public WorldLayerSettings()

Fields

Components

Declaration
public List<WorldLayerComponent> Components
Field Value
Type Description
System.Collections.Generic.List<WorldLayerComponent>

Properties

AreaDescription

Declaration
public string AreaDescription { get; set; }
Property Value
Type Description
System.String

Category

Declaration
public WorldLayerCategory Category { get; set; }
Property Value
Type Description
WorldLayerCategory

CategoryName

Declaration
public string CategoryName { get; }
Property Value
Type Description
System.String

ControllerID

Declaration
public ref int ControllerID { get; }
Property Value
Type Description
System.Int32

DisplayNameOverride

Declaration
public string DisplayNameOverride { get; set; }
Property Value
Type Description
System.String

InitMultiplier

Declaration
public float InitMultiplier { get; set; }
Property Value
Type Description
System.Single

LayerType

Declaration
public virtual Type LayerType { get; }
Property Value
Type Description
System.Type

MaxColor

Declaration
public Color MaxColor { get; set; }
Property Value
Type Description
Color

MinColor

Declaration
public Color MinColor { get; set; }
Property Value
Type Description
Color

MinimapName

Declaration
public string MinimapName { get; set; }
Property Value
Type Description
System.String

Name

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String

OriginalDisplayName

Added to work around a website issue. Represents the original name as defined in the Eco mods directory. Should be replaced with a real solution in 10.0

Declaration
public string OriginalDisplayName { get; }
Property Value
Type Description
System.String

OverrideRenderRange

Declaration
public Nullable<Range> OverrideRenderRange { get; set; }
Property Value
Type Description
System.Nullable<Range>

Range

Declaration
public Range Range { get; set; }
Property Value
Type Description
Range

RenderRange

Declaration
public Range RenderRange { get; }
Property Value
Type Description
Range

Subcategory

Declaration
public virtual string Subcategory { get; set; }
Property Value
Type Description
System.String

SumRelevant

Declaration
public bool SumRelevant { get; set; }
Property Value
Type Description
System.Boolean

SyncToClient

Declaration
public bool SyncToClient { get; set; }
Property Value
Type Description
System.Boolean

Unit

Declaration
public string Unit { get; set; }
Property Value
Type Description
System.String

ValueType

Declaration
public WorldLayerValueType ValueType { get; set; }
Property Value
Type Description
WorldLayerValueType

Visible

Declaration
public bool Visible { get; set; }
Property Value
Type Description
System.Boolean

VoxelsPerEntry

Declaration
public int VoxelsPerEntry { get; set; }
Property Value
Type Description
System.Int32

Methods

GenerateAnimalSubcategory(Boolean, String)

Declaration
protected string GenerateAnimalSubcategory(bool isTerrestrial, string postfix)
Parameters
Type Name Description
System.Boolean isTerrestrial
System.String postfix
Returns
Type Description
System.String

GetDisplayValue(Single, Boolean)

Returns user-friendly representation (i.e. for temperature normalized value [0; 1] it may be value in Celsius).

Declaration
public virtual float GetDisplayValue(float layerValue, bool relative = false)
Parameters
Type Name Description
System.Single layerValue
System.Boolean relative
Returns
Type Description
System.Single

SetUnit(String)

Declaration
public void SetUnit(string unit)
Parameters
Type Name Description
System.String unit

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String

Implements

IController
IViewController
IHasUniversalID

Extension Methods

WorldLayerSettingsExtensions.ValStringHtml(WorldLayerSettings, Single, Boolean)
WorldLayerSettingsExtensions.ValStringTooltip(WorldLayerSettings, Single, Boolean)
☀
☾
In This Article
Back to top
Copyright (c) Strange Loop Games 2021
☀
☾