Class PaintCellItemsUserToolState<TBrushTarget, THexSurface>
Inheritance
PaintCellItemsUserToolState<TBrushTarget, THexSurface>
Assembly: fwt.hexterrains.dll
public abstract class PaintCellItemsUserToolState<TBrushTarget, THexSurface> : BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen>, ISmState where TBrushTarget : CellItemsLayer where THexSurface : HexSurfaceLayer
Type Parameters
| Name |
Description |
| TBrushTarget |
|
| THexSurface |
|
Constructors
Declaration
protected PaintCellItemsUserToolState(IHexTerrainAPI userToolAPI)
Parameters
Fields
Declaration
public KeyCode ReadCellKey
Field Value
Properties
Declaration
public CellItem CellItem { get; set; }
Property Value
Declaration
public int CellItemIndex { get; set; }
Property Value
Declaration
public int CellItemState { get; set; }
Property Value
Declaration
public int MaxCellHeight { get; set; }
Property Value
Declaration
public int MinCellHeight { get; set; }
Property Value
Methods
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
Overrides
Declaration
protected override void InitDefaultSettings()
Overrides
Declaration
public override bool IsAppliedToEveryCellOnMap(int brushMode)
Parameters
| Type |
Name |
Description |
| int |
brushMode |
|
Returns
Overrides
Declaration
protected override void LoadSettings()
Overrides
Declaration
protected virtual CellItem ReadCellItem(TBrushTarget brushTarget, int2 cellCoord)
Parameters
| Type |
Name |
Description |
| TBrushTarget |
brushTarget |
|
| int2 |
cellCoord |
|
Returns
Declaration
protected override void SaveSettings()
Overrides
Implements
Extension Methods