public abstract class PaintCellItemUserToolStateBase<TBrushTarget, TTerrainLayer, TChunkMeshLayerGroup, TChunkMeshLayer> : BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen, TTerrainLayer>, ISmState where TBrushTarget : HexTerrainLayerGroup where TTerrainLayer : CellItemLayer where TChunkMeshLayerGroup : HexTerrainLayerGroup, IComponentData where TChunkMeshLayer : ChunkMeshLayer

Type Parameters

Name	Description
TBrushTarget
TTerrainLayer
TChunkMeshLayerGroup
TChunkMeshLayer

Constructors

PaintCellItemUserToolStateBase(ISmState)

Declaration

public PaintCellItemUserToolStateBase(ISmState parent)

Parameters

Type	Name	Description
ISmState	parent

Fields

ReadCellKey

Declaration

public KeyCode ReadCellKey

Field Value

Type	Description
KeyCode

Properties

ChunkMeshLayerIndex

Declaration

public virtual int ChunkMeshLayerIndex { get; set; }

Property Value

Type	Description
int

ChunkMeshLayerReference

Declaration

public virtual HexTerrainLayerReference ChunkMeshLayerReference { get; }

Property Value

Type	Description
HexTerrainLayerReference

DataSourceItemsCount

Declaration

public virtual int DataSourceItemsCount { get; }

Property Value

Type	Description
int

IsCheckBiome

Declaration

public bool IsCheckBiome { get; set; }

Property Value

Type	Description
bool

IsCheckCellHeight

Declaration

public bool IsCheckCellHeight { get; set; }

Property Value

Type	Description
bool

MaxBiomeIndex

Declaration

public int MaxBiomeIndex { get; set; }

Property Value

Type	Description
int

MaxCellHeight

Declaration

public float MaxCellHeight { get; set; }

Property Value

Type	Description
float

MinBiomeIndex

Declaration

public int MinBiomeIndex { get; set; }

Property Value

Type	Description
int

MinCellHeight

Declaration

public float MinCellHeight { get; set; }

Property Value

Type	Description
float

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<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen, TTerrainLayer>.TerrainLayerIndex

Methods

GetCellBiome(int)

Declaration

protected virtual int? GetCellBiome(int cellIndex)

Parameters

Type	Name	Description
int	cellIndex

Returns

Type	Description
int?

GetCellHeight(int)

Declaration

protected virtual float? GetCellHeight(int cellIndex)

Parameters

Type	Name	Description
int	cellIndex

Returns

Type	Description
float?

Init(UserToolStateSettings)

Initializes the tool state with the specified settings.

Declaration

public override void Init(UserToolStateSettings settings)

Parameters

Type	Name	Description
UserToolStateSettings	settings	The settings to apply to the tool state. Cannot be null.

Overrides

UserToolStateBase.Init(UserToolStateSettings)

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<TBrushTarget, 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.

Init<TInitArgs>(TInitArgs)

Initializes the tool using the specified initialization arguments.

Declaration

public override void Init<TInitArgs>(TInitArgs args)

Parameters

Type	Name	Description
TInitArgs	args	The initialization arguments used to configure the tool. If the argument implements IUserToolStateConfig, its ToolSettings are used; otherwise, default settings are applied.

Type Parameters

Name	Description
TInitArgs	The type of the initialization arguments used to configure the tool. If the type implements IUserToolStateConfig, its ToolSettings will be used; otherwise, default settings are applied.

Overrides

BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen, TTerrainLayer>.Init<TInitArgs>(TInitArgs)

IsAppliedToEveryCellOnMap(int)

Determines whether the specified brush mode applies to every cell on the map.

Declaration

public override bool IsAppliedToEveryCellOnMap(int brushMode)

Parameters

Type	Name	Description
int	brushMode	The brush mode to evaluate. Typically, a value of 1 indicates that the brush is applied to all cells.

Returns

Type	Description
bool	true if the brush mode applies to every cell on the map; otherwise, false.

Overrides

BrushUserToolState<TBrushTarget>.IsAppliedToEveryCellOnMap(int)

IsValidCellToPaint(int)

Declaration

protected virtual bool? IsValidCellToPaint(int cellIndex)

Parameters

Type	Name	Description
int	cellIndex

Returns

Type	Description
bool?

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<TBrushTarget, 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.

SaveSettings()

Saves the current settings to the underlying storage or configuration source.

Declaration

protected override void SaveSettings()

Overrides

BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>.SaveSettings()

Remarks

Override this method in a derived class to implement custom logic for persisting settings. This method does not perform any action in the base implementation.

Implements

ISmState

Extension Methods

HashExtensions.GetHashCode_RefType<TValue>(TValue, int)

Extensions_UnityObject.SmartDestroy(object)

Extensions_UnityObject.SmartGetComponent<TComponent>(object)

Extensions_UnityObject.SmartGetGameGameObject(object)