• Manual
  • Scripting API
  • Asset Store
  • TycoonTerrain.Tools
  • WaterTool
Search Results for

    Show / Hide Table of Contents
    • TycoonTerrain.Components
      • TycoonTileRendererBase
    • TycoonTerrain.Core
      • BoundsContainer
      • BoundsReservationRegister
      • CallbackHandle
      • CallbacksRegister
      • CardinalDirection
      • ChunkSet
      • ConstructableDefinition
      • CornerIndex
      • Extensions
      • IChunkListener
      • IntBound
      • LandTile
      • OnBoundsChangeCallback
      • PlacementValidResult
      • SurfaceOverlayMesh
      • TerrainGrid
      • TerrainModifiedEvent
      • TerrainSelection
      • TerrainTypeCollectionAsset
      • TerrainTypeDefinition
      • TerrainTypeTable
      • TileCorner
      • TileHandle
      • TilePosition
      • TileType
      • TycoonTileMap
      • TycoonTileRaycastHit
    • TycoonTerrain.Core.Generation
      • TerrainGenerationJob
    • TycoonTerrain.Core.Rendering
      • ChunkMesh
      • IMesh
      • NativeMeshData
      • RenderTerrainCliffChunkJob
      • RenderTerrainSurfaceChunkJob
      • RenderWaterChunkJob
      • RenderWaterCliffChunkJob
      • SubMeshTriangle
    • TycoonTerrain.Core.TerrainOperations
      • ClearWaterBodyOperation
      • CopyHeightMapOperation
      • CreateWaterBodyFloodOperation
      • DecreaseHeightCliffOperation
      • DecreaseHeightCorner
      • DecreaseHeightSmoothConnectedOperation
      • GetTilesInWaterBody
      • IncreaseHeightCliffOperation
      • IncreaseHeightCorner
      • IncreaseHeightSmoothConnectedOperation
      • ITerrainOperation
      • MaxHeightSmooth
      • OperationContext
      • OperationResult
      • SetHeightOperation
      • SetTileTypeInBoundsOperation
      • SetWaterLevelOperation
    • TycoonTerrain.Previewers
      • BuildingToolPreviewer
      • PreviewMeshes
      • TerrainPainterPreviewer
      • TerrainSelectionPreviewer
      • ToolPreviewerBase<T>
    • TycoonTerrain.Tools
      • BuildingTool
      • PainterTool
      • SceneryTool
      • SelectionToolBase
      • SnappingMode
      • TerraformingTool
      • ToolBase
      • WaterTool

    Class WaterTool

    The water tool is used to create, modify and delete water bodies on the terrain.

    Inheritance
    Object
    UnityEngine.Object
    UnityEngine.Component
    UnityEngine.Behaviour
    UnityEngine.MonoBehaviour
    ToolBase
    WaterTool
    Inherited Members
    ToolBase.IsMouseOverUserInterface
    ToolBase.IsMouseOverTerrain
    ToolBase.Raycaster
    ToolBase.OnToolEnabledEvent
    ToolBase.OnToolDisabledEvent
    ToolBase.Awake()
    Namespace: TycoonTerrain.Tools
    Assembly: TycoonTerrainAssembly.dll
    Syntax
    public class WaterTool : ToolBase

    Fields

    OnWaterPlacedEvent

    Declaration
    [Tooltip("This event is fired every time a water water is created, modified or deleted.")]
    public UnityEvent OnWaterPlacedEvent
    Field Value
    Type Description
    UnityEngine.Events.UnityEvent

    SelectedWaterHeight

    Declaration
    [NonSerialized]
    public float SelectedWaterHeight
    Field Value
    Type Description
    Single

    SelectedWaterHeightIsValid

    Declaration
    [NonSerialized]
    public bool SelectedWaterHeightIsValid
    Field Value
    Type Description
    Boolean

    SelectedWaterNormal

    Declaration
    [NonSerialized]
    public Vector3 SelectedWaterNormal
    Field Value
    Type Description
    UnityEngine.Vector3

    SelectedWaterPosition

    Declaration
    [NonSerialized]
    public Vector3 SelectedWaterPosition
    Field Value
    Type Description
    UnityEngine.Vector3

    Methods

    OnDisable()

    Declaration
    protected override void OnDisable()
    Overrides
    ToolBase.OnDisable()

    OnEnable()

    Declaration
    protected override void OnEnable()
    Overrides
    ToolBase.OnEnable()
    In This Article
    • Fields
      • OnWaterPlacedEvent
      • SelectedWaterHeight
      • SelectedWaterHeightIsValid
      • SelectedWaterNormal
      • SelectedWaterPosition
    • Methods
      • OnDisable()
      • OnEnable()
    Back to top Tycoon Tile documentation