Class HexagonalRuleTile | 2D Tilemap Extras | 1.5.0-preview
docs.unity3d.com
    Show / Hide Table of Contents

    Class HexagonalRuleTile

    Generic visual tile for creating different tilesets like terrain, pipeline, random or animated tiles. Use this for Hexagonal Grids.

    Inheritance
    Object
    Object
    ScriptableObject
    TileBase
    RuleTile
    HexagonalRuleTile
    HexagonalRuleTile<T>
    Inherited Members
    RuleTile.m_NeighborType
    RuleTile.m_DefaultSprite
    RuleTile.m_DefaultGameObject
    RuleTile.m_DefaultColliderType
    RuleTile.m_RotationCount
    RuleTile.m_TilingRules
    RuleTile.neighborPositions
    RuleTile.UpdateNeighborPositions()
    RuleTile.StartUp(Vector3Int, ITilemap, GameObject)
    RuleTile.GetTileData(Vector3Int, ITilemap, TileData)
    RuleTile.GetPerlinValue(Vector3Int, Single, Single)
    RuleTile.GetTileAnimationData(Vector3Int, ITilemap, TileAnimationData)
    RuleTile.RefreshTile(Vector3Int, ITilemap)
    RuleTile.RuleMatches(RuleTile.TilingRule, Vector3Int, ITilemap, Matrix4x4)
    RuleTile.ApplyRandomTransform(RuleTile.TilingRuleOutput.Transform, Matrix4x4, Single, Vector3Int)
    RuleTile.GetCustomFields(Boolean)
    RuleTile.RuleMatch(Int32, TileBase)
    RuleTile.RuleMatches(RuleTile.TilingRule, Vector3Int, ITilemap, Int32)
    RuleTile.RuleMatches(RuleTile.TilingRule, Vector3Int, ITilemap, Boolean, Boolean)
    ScriptableObject.SetDirty()
    ScriptableObject.CreateInstance(String)
    ScriptableObject.CreateInstance(Type)
    ScriptableObject.CreateInstance<T>()
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(Object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, Boolean)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, Boolean)
    Object.Destroy(Object, Single)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, Boolean)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, Boolean)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, Single)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
    Object.FindObjectOfType<T>()
    UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindObjectOfType(Type, Boolean)
    Object.ToString()
    Object.name
    Object.hideFlags
    Namespace: UnityEngine
    Syntax
    [Serializable]
    [CreateAssetMenu(fileName = "New Hexagonal Rule Tile", menuName = "Tiles/Hexagonal Rule Tile")]
    public class HexagonalRuleTile : RuleTile

    Fields

    m_FlatTop

    Whether this is a flat top Hexagonal Tile

    Declaration
    public bool m_FlatTop
    Field Value
    Type Description
    Boolean

    Properties

    m_RotationAngle

    Declaration
    public override int m_RotationAngle { get; }
    Property Value
    Type Description
    Int32
    Overrides
    RuleTile.m_RotationAngle

    Methods

    GetMirroredPosition(Vector3Int, Boolean, Boolean)

    Gets a mirrored position given its original position and the mirroring axii.

    Declaration
    public override Vector3Int GetMirroredPosition(Vector3Int position, bool mirrorX, bool mirrorY)
    Parameters
    Type Name Description
    Vector3Int position

    Original position of Tile.

    Boolean mirrorX

    Mirror in the X Axis.

    Boolean mirrorY

    Mirror in the Y Axis.

    Returns
    Type Description
    Vector3Int

    Mirrored position of Tile.

    Overrides
    RuleTile.GetMirroredPosition(Vector3Int, Boolean, Boolean)

    GetOffsetPosition(Vector3Int, Vector3Int)

    Declaration
    public override Vector3Int GetOffsetPosition(Vector3Int location, Vector3Int offset)
    Parameters
    Type Name Description
    Vector3Int location
    Vector3Int offset
    Returns
    Type Description
    Vector3Int
    Overrides
    RuleTile.GetOffsetPosition(Vector3Int, Vector3Int)

    GetOffsetPositionReverse(Vector3Int, Vector3Int)

    Declaration
    public override Vector3Int GetOffsetPositionReverse(Vector3Int position, Vector3Int offset)
    Parameters
    Type Name Description
    Vector3Int position
    Vector3Int offset
    Returns
    Type Description
    Vector3Int
    Overrides
    RuleTile.GetOffsetPositionReverse(Vector3Int, Vector3Int)

    GetRotatedPosition(Vector3Int, Int32)

    Gets a rotated position given its original position and the rotation in degrees.

    Declaration
    public override Vector3Int GetRotatedPosition(Vector3Int position, int rotation)
    Parameters
    Type Name Description
    Vector3Int position

    Original position of Tile.

    Int32 rotation

    Rotation in degrees.

    Returns
    Type Description
    Vector3Int

    Rotated position of Tile.

    Overrides
    RuleTile.GetRotatedPosition(Vector3Int, Int32)

    TilemapPositionToWorldPosition(Vector3Int)

    Declaration
    public static Vector3 TilemapPositionToWorldPosition(Vector3Int tilemapPosition)
    Parameters
    Type Name Description
    Vector3Int tilemapPosition
    Returns
    Type Description
    Vector3

    WorldPositionToTilemapPosition(Vector3)

    Declaration
    public static Vector3Int WorldPositionToTilemapPosition(Vector3 worldPosition)
    Parameters
    Type Name Description
    Vector3 worldPosition
    Returns
    Type Description
    Vector3Int
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023