Class UserToolStateBase

Inheritance
object
SmState
UserToolStateBase
BrushUserToolState<TBrushTarget>
CreateNewTerrainUserToolStateBase<TScreen, TViewData>
LoadTerrainUserToolStateBase<TScreen, TCallback>
PointerUserToolState
ResizeTerrainUserToolStateBase<TScreen, TCallback>
SaveTerrainUserToolStateBase<TScreen, TCallback>
ToggleTerrainVisibilityUserToolState
Implements
Inherited Members
Namespace: Fwt.HexTerrains.TerrainEditors.StateMachines
Assembly: fwt.hexterrains.dll
Syntax
public abstract class UserToolStateBase : SmState, ISmState

Constructors

UserToolStateBase(IHexTerrainAPI)

Declaration
protected UserToolStateBase(IHexTerrainAPI userToolAPI)
Parameters
Type Name Description
IHexTerrainAPI userToolAPI

Fields

IsSubstatesVisible

Declaration
public bool IsSubstatesVisible
Field Value
Type Description
bool

Settings

Declaration
public UserToolSettings Settings
Field Value
Type Description
UserToolSettings

SubStateMachine

Declaration
public UserToolStateMachine SubStateMachine
Field Value
Type Description
UserToolStateMachine

Properties

HasSubtools

Declaration
protected bool HasSubtools { get; }
Property Value
Type Description
bool

IsChangeViewMode

If true, when this user tool state becomes active it asks a terrain to switch to the RequiredViewMode view mode

Declaration
protected virtual bool IsChangeViewMode { get; }
Property Value
Type Description
bool

OriginalViewMode

Declaration
protected virtual byte OriginalViewMode { get; set; }
Property Value
Type Description
byte

RequiredViewMode

If IsChangeViewMode is true, this is the view mode that will be set when this user tool state becomes active.

Declaration
protected virtual byte RequiredViewMode { get; }
Property Value
Type Description
byte

UserToolAPI

Declaration
public IHexTerrainAPI UserToolAPI { get; set; }
Property Value
Type Description
IHexTerrainAPI

UserToolType

Declaration
public abstract int UserToolType { get; }
Property Value
Type Description
int

Methods

GetUIScreen<TScreen>()

Declaration
protected virtual TScreen GetUIScreen<TScreen>() where TScreen : UIScreen
Returns
Type Description
TScreen
Type Parameters
Name Description
TScreen

HideSettingsScreen<TScreen>()

Declaration
protected virtual void HideSettingsScreen<TScreen>() where TScreen : UIScreen
Type Parameters
Name Description
TScreen

PrepareToRun()

Declaration
public override void PrepareToRun()
Overrides

PrepareToStop()

Declaration
public override void PrepareToStop()
Overrides

SetupPlanetCursor(bool)

Declaration
protected virtual void SetupPlanetCursor(bool isCursorVisible)
Parameters
Type Name Description
bool isCursorVisible

SetupPlanetCursor(bool, int)

Declaration
protected virtual void SetupPlanetCursor(bool isCursorVisible, int size)
Parameters
Type Name Description
bool isCursorVisible
int size

SetupPlanetCursor(bool, int, Color32)

Declaration
protected virtual void SetupPlanetCursor(bool isCursorVisible, int size, Color32 color)
Parameters
Type Name Description
bool isCursorVisible
int size
Color32 color

SetupPlanetCursor(bool, int, Color32, bool)

Declaration
protected virtual void SetupPlanetCursor(bool isCursorVisible, int size, Color32 color, bool isResizable)
Parameters
Type Name Description
bool isCursorVisible
int size
Color32 color
bool isResizable

ShowSettingsScreen<TViewData, TScreen>(TViewData)

Declaration
protected virtual TScreen ShowSettingsScreen<TViewData, TScreen>(TViewData viewData) where TScreen : UIScreen, IViewDataReceiver<TViewData>
Parameters
Type Name Description
TViewData viewData
Returns
Type Description
TScreen
Type Parameters
Name Description
TViewData
TScreen

Tick()

Declaration
public override void Tick()
Overrides

TryRestoreViewMode()

Declaration
protected virtual void TryRestoreViewMode()

TrySetViewMode()

Declaration
protected virtual void TrySetViewMode()

Implements

Extension Methods