Class ToolBase

Inheritance

Object

UnityEngine.Object

UnityEngine.Component

UnityEngine.Behaviour

UnityEngine.MonoBehaviour

ToolBase

SceneryTool

SelectionToolBase

WaterTool

Namespace: TycoonTerrain.Tools

Assembly: TycoonTerrainAssembly.dll

Syntax

[RequireComponent(typeof(TycoonTileRaycaster))]
public abstract class ToolBase : MonoBehaviour

Fields

OnToolDisabledEvent

Called when the tool is disabled.

Declaration

[HideInInspector]
public UnityEvent OnToolDisabledEvent

Field Value

Type	Description
UnityEngine.Events.UnityEvent

OnToolEnabledEvent

Called when the tool is enabled.

Declaration

[HideInInspector]
public UnityEvent OnToolEnabledEvent

Field Value

Type	Description
UnityEngine.Events.UnityEvent

Raycaster

Reference to the raycaster.

Declaration

protected TycoonTileRaycaster Raycaster

Field Value

Type	Description
TycoonTileRaycaster	The TycoonTileRaycaster instance for this tool.

Properties

IsMouseOverTerrain

Whether the mouse cursor is currently hovering over a part of the terrain.

Declaration

public bool IsMouseOverTerrain { get; }

Property Value

Type	Description
Boolean	true if mouse cursor is hovering over a Tycoon Tile terrain component; otherwise, false.

IsMouseOverUserInterface

Whether the mouse cursor is current hovering over any UI elements.

Declaration

public bool IsMouseOverUserInterface { get; }

Property Value

Type	Description
Boolean	true if mouse cursor is hovering over UGUI component; otherwise, false.

Methods

Awake()

Unity Awake event.

Declaration

protected virtual void Awake()

OnDisable()

Unity OnDisable event.

Declaration

protected virtual void OnDisable()

OnEnable()

Unity OnEnable event.

Declaration

protected virtual void OnEnable()