public class SunSettingsUserToolState : BrushUserToolState<SunTerrainLayerGroup, UserToolSettingsDataSource, UniversalToolSettingsScreen, SunTerrainLayer>, ISmState

Constructors

SunSettingsUserToolState(ISmState)

Declaration

public SunSettingsUserToolState(ISmState parent)

Parameters

Type	Name	Description
ISmState	parent

Properties

CoolingIntensity

Declaration

public float CoolingIntensity { get; set; }

Property Value

Type	Description
float

CurveFactor

Declaration

public float CurveFactor { get; set; }

Property Value

Type	Description
float

CurveOutputValueOffset

Declaration

public float CurveOutputValueOffset { get; set; }

Property Value

Type	Description
float

CurveOutputValueScale

Declaration

public float CurveOutputValueScale { get; set; }

Property Value

Type	Description
float

DayLength

Declaration

public float DayLength { get; set; }

Property Value

Type	Description
float

DayProgress

Declaration

public float DayProgress { get; set; }

Property Value

Type	Description
float

HeatingIntensity

Declaration

public float HeatingIntensity { get; set; }

Property Value

Type	Description
float

IsCurveInverted

Declaration

public bool IsCurveInverted { get; set; }

Property Value

Type	Description
bool

IsEnabled

Declaration

public bool IsEnabled { get; set; }

Property Value

Type	Description
bool

MaxCurveValue

Declaration

public float MaxCurveValue { get; set; }

Property Value

Type	Description
float

MinCurveValue

Declaration

public float MinCurveValue { get; set; }

Property Value

Type	Description
float

PlanetAngle

Declaration

public float PlanetAngle { get; set; }

Property Value

Type	Description
float

SunDirection

Declaration

public SunDirection SunDirection { get; set; }

Property Value

Type	Description
SunDirection

SunRadius

Declaration

public float SunRadius { get; set; }

Property Value

Type	Description
float

SunType

Declaration

public SunType SunType { get; set; }

Property Value

Type	Description
SunType

TerrainLayerIndex

If IsGetLayerByIndex is true, this index is used to get terrain layer from terrain layers list."/>

Declaration

public override int TerrainLayerIndex { get; set; }

Property Value

Type	Description
int

Overrides

BrushUserToolState<SunTerrainLayerGroup, UserToolSettingsDataSource, UniversalToolSettingsScreen, SunTerrainLayer>.TerrainLayerIndex

UserToolType

Type identifier for the user tool. Allows state machine to change states based on tool type instead of state index.

Declaration

public override int UserToolType { get; }

Property Value

Type	Description
int

Overrides

UserToolStateBase.UserToolType

YearLengthInDays

Declaration

public int YearLengthInDays { get; set; }

Property Value

Type	Description
int

YearProgress

Declaration

public float YearProgress { get; set; }

Property Value

Type	Description
float

Methods

ApplyBrush(int, int2, int, SunTerrainLayerGroup, int)

Applies brush to the brushView. Returns true if changes were applied

Declaration

public override bool ApplyBrush(int brushMode, int2 cellCoord, int cellIndex, SunTerrainLayerGroup brushTarget, int mouseButton)

Parameters

Type	Name	Description
int	brushMode
int2	cellCoord
int	cellIndex
SunTerrainLayerGroup	brushTarget
int	mouseButton

Returns

Type	Description
bool

Overrides

BrushUserToolState<SunTerrainLayerGroup>.ApplyBrush(int, int2, int, SunTerrainLayerGroup, int)

ExtractDataFromTerrain()

Declaration

protected virtual void ExtractDataFromTerrain()

InitDefaultSettings()

Initializes the default settings for the current instance. This method is intended to be overridden in derived classes to configure initial values or options as needed.

Declaration

protected override void InitDefaultSettings()

Overrides

BrushUserToolState<SunTerrainLayerGroup, UserToolSettingsDataSource>.InitDefaultSettings()

Remarks

Override this method in a subclass to provide custom initialization logic for default settings. The base implementation does not perform any actions.

LoadSettings()

Loads configuration settings for the current instance. Derived classes override this method to implement custom settings initialization.

Declaration

protected override void LoadSettings()

Overrides

BrushUserToolState<SunTerrainLayerGroup, UserToolSettingsDataSource>.LoadSettings()

Remarks

Override this method in a subclass to provide specific logic for loading or initializing settings. This method is called during the setup or initialization phase and does not perform any actions in the base implementation.

OnCoolingIntensityChanged()

Declaration

protected virtual void OnCoolingIntensityChanged()

OnCurveFactorChanged()

Declaration

protected virtual void OnCurveFactorChanged()

OnCurveOutputValueOffsetChanged()

Declaration

protected virtual void OnCurveOutputValueOffsetChanged()

OnCurveOutputValueScaleChanged()

Declaration

protected virtual void OnCurveOutputValueScaleChanged()

OnDayLengthChanged()

Declaration

protected virtual void OnDayLengthChanged()

OnDayProgressChanged()

Declaration

protected virtual void OnDayProgressChanged()

OnEnableSunChanged()

Declaration

protected virtual void OnEnableSunChanged()

OnHeatingIntensityChanged()

Declaration

protected virtual void OnHeatingIntensityChanged()

OnInvertCurveChanged()

Declaration

protected virtual void OnInvertCurveChanged()

OnMaxCurveValueChanged()

Declaration

protected virtual void OnMaxCurveValueChanged()

OnMinCurveValueChanged()

Declaration

protected virtual void OnMinCurveValueChanged()

OnPlanetAngleChanged()

Declaration

protected virtual void OnPlanetAngleChanged()

OnSunDirectionChanged()

Declaration

protected virtual void OnSunDirectionChanged()

OnSunRadiusChanged()

Declaration

protected virtual void OnSunRadiusChanged()

OnSunTypeChanged()

Declaration

protected virtual void OnSunTypeChanged()

OnTerrainLayerChanged()

Invoked when the terrain layer changes to update the view mode accordingly.

Declaration

protected override void OnTerrainLayerChanged()

Overrides

BrushUserToolState<SunTerrainLayerGroup, UserToolSettingsDataSource, UniversalToolSettingsScreen, SunTerrainLayer>.OnTerrainLayerChanged()

Remarks

Derived classes can override this method to implement custom behavior when the terrain layer changes. This method is called automatically and should not be invoked directly.

OnYearLengthChanged()

Declaration

protected virtual void OnYearLengthChanged()

OnYearProgressChanged()

Declaration

protected virtual void OnYearProgressChanged()

PrepareToRun()

Performs any necessary initialization or setup required before executing the main operation. Called by state machine once when state becomes active. If state is disabled and then enabled again, this method will be called again.

Declaration

public override void PrepareToRun()

Overrides

BrushUserToolState<SunTerrainLayerGroup, UserToolSettingsDataSource, UniversalToolSettingsScreen>.PrepareToRun()

Remarks

Override this method to implement preparation logic specific to the derived class. This method should be called prior to running the core functionality to ensure all prerequisites are met.

PrepareToStop()

Performs any necessary actions to prepare the object for stopping or shutdown. Called when the state is about to be deactivated.

Declaration

public override void PrepareToStop()

Overrides

BrushUserToolState<SunTerrainLayerGroup, UserToolSettingsDataSource, UniversalToolSettingsScreen>.PrepareToStop()

Remarks

Implementations should ensure that all resources are released and any ongoing operations are safely terminated before the object is stopped. This method is typically called prior to disposing or shutting down the object to ensure a clean transition.

SaveDataToTerrain()

Declaration

protected virtual void SaveDataToTerrain()

Implements

ISmState

Extension Methods

HashExtensions.GetHashCode_RefType<TValue>(TValue, int)

Extensions_UnityObject.SmartDestroy(object)

Extensions_UnityObject.SmartGetComponent<TComponent>(object)

Extensions_UnityObject.SmartGetGameGameObject(object)