• Manual
  • Scripting API
  • Asset Store
  • TycoonTerrain.Tools
  • SceneryTool
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 SceneryTool

    This is the scenery tool. This class is responsible for placing scenery objects and can snap objects to tile positions.

    Inheritance
    Object
    UnityEngine.Object
    UnityEngine.Component
    UnityEngine.Behaviour
    UnityEngine.MonoBehaviour
    ToolBase
    SceneryTool
    Inherited Members
    ToolBase.IsMouseOverUserInterface
    ToolBase.IsMouseOverTerrain
    ToolBase.Raycaster
    ToolBase.OnToolEnabledEvent
    ToolBase.OnToolDisabledEvent
    Namespace: TycoonTerrain.Tools
    Assembly: TycoonTerrainAssembly.dll
    Syntax
    [DisallowMultipleComponent]
    [AddComponentMenu("Tycoon Tile/Tools/Scenery Tool")]
    public class SceneryTool : ToolBase

    Fields

    CurrentSnappingMode

    The current snapping mode.

    Declaration
    public SnappingMode CurrentSnappingMode
    Field Value
    Type Description
    SnappingMode

    The mode.

    Prefab

    The prefab to place.

    Declaration
    [Tooltip("The prefab to spawn.")]
    public GameObject Prefab
    Field Value
    Type Description
    UnityEngine.GameObject

    The prefab to place.

    PreviewMaterial

    The material to render the preview with.

    Declaration
    [Tooltip("Material to use when rendering preview mesh.")]
    public Material PreviewMaterial
    Field Value
    Type Description
    UnityEngine.Material

    The material to render the preview with.

    RotationSpeed

    Rotation speed in degrees per second.

    Declaration
    [Tooltip("Rotation speed in degrees/s")]
    public float RotationSpeed
    Field Value
    Type Description
    Single

    Rotation speed in degrees/s.

    SubDivisions

    The number of sub divisions to use when the snapping mode is set to Grid.

    Declaration
    public int SubDivisions
    Field Value
    Type Description
    Int32

    The number of subdivisions. Must be greater than or equal to 0.

    Methods

    Awake()

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

    OnDisable()

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

    OnEnable()

    Declaration
    protected override void OnEnable()
    Overrides
    ToolBase.OnEnable()
    In This Article
    • Fields
      • CurrentSnappingMode
      • Prefab
      • PreviewMaterial
      • RotationSpeed
      • SubDivisions
    • Methods
      • Awake()
      • OnDisable()
      • OnEnable()
    Back to top Tycoon Tile documentation