Hex Terrains Framework
Search Results for

    Show / Hide Table of Contents

    Class PaintTerrainUserToolState<TBrushTarget>

    Inheritance
    object
    SmState
    UserToolStateBase
    BrushUserToolState<TBrushTarget>
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen>
    PaintTerrainUserToolState<TBrushTarget>
    PaintGroundBiomesUserToolState
    PaintWaterBiomesUserToolState
    Implements
    ISmState
    Inherited Members
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen>.SettingsScreen
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen>.PrepareToRun()
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen>.PrepareToStop()
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen>.GetSettingsScreen()
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen>.UpdateSettingsScreen()
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>.DataSource
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>.SettingsPlayerPrefsKeyName
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>.PrepareToRun()
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>.InitSettings()
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>.InitDefaultSettings()
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>.PrepareToStop()
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>.LoadSettings()
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>.SaveSettings()
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>.SaveSettingsValue<TValue>(string, TValue)
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>.LoadSettingsValue<TValue>(string, TValue)
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>.TryLoadSettingsValue<TValue>(string, out TValue)
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>.LoadSettingsValueOrDefault<TValue>(string, TValue)
    BrushUserToolState<TBrushTarget>.PrevChangeTimeStamp
    BrushUserToolState<TBrushTarget>.TimeTreshold
    BrushUserToolState<TBrushTarget>.CanChangeBrushSize
    BrushUserToolState<TBrushTarget>.AllowRightMouseButton
    BrushUserToolState<TBrushTarget>.CursorColor
    BrushUserToolState<TBrushTarget>.ChangeModeKey
    BrushUserToolState<TBrushTarget>.ChangeBrushSizeKey
    BrushUserToolState<TBrushTarget>.IncreaseBrushSizeKey
    BrushUserToolState<TBrushTarget>.IncreaseBrushSizeKey2
    BrushUserToolState<TBrushTarget>.DecreaseBrushSizeKey
    BrushUserToolState<TBrushTarget>.DecreaseBrushSizeKey2
    BrushUserToolState<TBrushTarget>.ChangeOpacityKey
    BrushUserToolState<TBrushTarget>.IsTimeTresholdPassed
    BrushUserToolState<TBrushTarget>.BrushSize
    BrushUserToolState<TBrushTarget>.BrushOpacity
    BrushUserToolState<TBrushTarget>.ChangeOpacityMultiplier
    BrushUserToolState<TBrushTarget>.SetNewTimestamp()
    BrushUserToolState<TBrushTarget>.PrepareToRun()
    BrushUserToolState<TBrushTarget>.PrepareToStop()
    BrushUserToolState<TBrushTarget>.Tick()
    BrushUserToolState<TBrushTarget>.UpdateBrush()
    BrushUserToolState<TBrushTarget>.TryApplyBrush()
    BrushUserToolState<TBrushTarget>.ApplyToSingleCell(int, int2, int, TBrushTarget, int)
    BrushUserToolState<TBrushTarget>.ApplyBrushToAllCells(int, HexTerrainSettings, TBrushTarget, int)
    BrushUserToolState<TBrushTarget>.ApplyBrushToAllBrushPoints(int, int2, int, HexTerrainSettings, TBrushTarget, int)
    BrushUserToolState<TBrushTarget>.CanBeAppliedToManyPoints(int)
    BrushUserToolState<TBrushTarget>.GetBrushTarget()
    UserToolStateBase.Settings
    UserToolStateBase.IsSubstatesVisible
    UserToolStateBase.SubStateMachine
    UserToolStateBase.UserToolType
    UserToolStateBase.UserToolAPI
    UserToolStateBase.HasSubtools
    UserToolStateBase.IsChangeViewMode
    UserToolStateBase.RequiredViewMode
    UserToolStateBase.OriginalViewMode
    UserToolStateBase.ShowSettingsScreen<TViewData, TScreen>(TViewData)
    UserToolStateBase.GetUIScreen<TScreen>()
    UserToolStateBase.HideSettingsScreen<TScreen>()
    UserToolStateBase.SetupPlanetCursor(bool, int)
    UserToolStateBase.SetupPlanetCursor(bool, int, Color32)
    UserToolStateBase.SetupPlanetCursor(bool, int, Color32, bool)
    UserToolStateBase.SetupPlanetCursor(bool)
    UserToolStateBase.TrySetViewMode()
    UserToolStateBase.TryRestoreViewMode()
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Fwt.HexTerrains.TerrainEditors.UserTools.StateMachines.States
    Assembly: fwt.hexterrains.dll
    Syntax
    public abstract class PaintTerrainUserToolState<TBrushTarget> : BrushUserToolState<TBrushTarget, UserToolSettingsDataSource, UniversalToolSettingsScreen>, ISmState where TBrushTarget : HexSurfaceLayer
    Type Parameters
    Name Description
    TBrushTarget

    Constructors

    PaintTerrainUserToolState(IHexTerrainAPI)

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

    Fields

    ReadPropKey

    Declaration
    [Tooltip("When this key is pressed, click will read terrain item under cursor instead of applying it")]
    public KeyCode ReadPropKey
    Field Value
    Type Description
    KeyCode

    Properties

    CellColor

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

    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
    BrushUserToolState<TBrushTarget>.ApplyBrush(int, int2, int, TBrushTarget, int)

    InitDefaultSettings()

    Declaration
    protected override void InitDefaultSettings()
    Overrides
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>.InitDefaultSettings()

    IsAppliedToEveryCellOnMap(int)

    Declaration
    public override bool IsAppliedToEveryCellOnMap(int brushMode)
    Parameters
    Type Name Description
    int brushMode
    Returns
    Type Description
    bool
    Overrides
    BrushUserToolState<TBrushTarget>.IsAppliedToEveryCellOnMap(int)

    LoadSettings()

    Declaration
    protected override void LoadSettings()
    Overrides
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>.LoadSettings()

    ReadCellData(int, TBrushTarget)

    Declaration
    protected virtual bool ReadCellData(int cellIndex, TBrushTarget brushTarget)
    Parameters
    Type Name Description
    int cellIndex
    TBrushTarget brushTarget
    Returns
    Type Description
    bool

    SaveSettings()

    Declaration
    protected override void SaveSettings()
    Overrides
    BrushUserToolState<TBrushTarget, UserToolSettingsDataSource>.SaveSettings()

    Implements

    ISmState

    Extension Methods

    HashExtensions.GetHashCode_RefType<TValue>(TValue, int)
    HashExtensions.GetHashCode_RefType<TValue>(TValue, int)
    Extensions_UnityObject.SmartDestroy(object)
    Extensions_UnityObject.SmartDestroy(object)
    Extensions_UnityObject.SmartGetComponent<TComponent>(object)
    Extensions_UnityObject.SmartGetComponent<TComponent>(object)
    Extensions_UnityObject.SmartGetGameGameObject(object)
    Extensions_UnityObject.SmartGetGameGameObject(object)
    In this article
    Back to top Generated by DocFX