Class PaintRegionsUserToolStateBase<TBrushTarget, TTerrainLayer, THexSurfacesList, THexSurface>

Inheritance
object
SmState
UserToolStateBase
HexTerrainUserToolStateBase
BrushUserToolState<TBrushTarget>
BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>
BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen>
BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen, TTerrainLayer>
PaintRegionsUserToolStateBase<TBrushTarget, TTerrainLayer, THexSurfacesList, THexSurface>
PaintRegionsUserToolState
Implements
Inherited Members
Namespace: Fwt.HexTerrains.UserTools.SM.States
Assembly: fwt.hexterrains.dll
Syntax
public abstract class PaintRegionsUserToolStateBase<TBrushTarget, TTerrainLayer, THexSurfacesList, THexSurface> : BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen, TTerrainLayer>, ISmState where TBrushTarget : CellRegionLayerGroup where TTerrainLayer : CellRegionLayer where THexSurfacesList : HexTerrainLayerGroup, IComponentData where THexSurface : ChunkMeshLayer
Type Parameters
Name Description
TBrushTarget
TTerrainLayer
THexSurfacesList
THexSurface

Constructors

PaintRegionsUserToolStateBase(ISmState)

Declaration
protected PaintRegionsUserToolStateBase(ISmState parent)
Parameters
Type Name Description
ISmState parent

Fields

ReadValueKey

When this key is pressed, click will read terrain item under cursor instead of applying it

Declaration
public KeyCode ReadValueKey
Field Value
Type Description
KeyCode

Properties

CellRegion

Declaration
public virtual int CellRegion { get; set; }
Property Value
Type Description
int

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

IsCheckCellHeight

Declaration
public virtual bool IsCheckCellHeight { get; set; }
Property Value
Type Description
bool

MaxCellHeight

Declaration
public virtual float MaxCellHeight { get; set; }
Property Value
Type Description
float

MinCellHeight

Declaration
public virtual 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

Methods

ApplyBrush(int, int2, int, TBrushTarget, int)

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

Declaration
public override bool ApplyBrush(int brushMode, int2 cellCoord, int cellIndex, TBrushTarget brushTarget, int mouseButton)
Parameters
Type Name Description
int brushMode
int2 cellCoord
int cellIndex
TBrushTarget brushTarget
int mouseButton
Returns
Type Description
bool
Overrides

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

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
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

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

LoadSettings()

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

Declaration
protected override void LoadSettings()
Overrides
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.

ReadCellData(TTerrainLayer, int2)

Declaration
protected virtual int ReadCellData(TTerrainLayer layer, int2 cellCoord)
Parameters
Type Name Description
TTerrainLayer layer
int2 cellCoord
Returns
Type Description
int

SaveSettings()

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

Declaration
protected override void SaveSettings()
Overrides
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

Extension Methods