docs.unity3d.com
    Show / Hide Table of Contents

    Class AdvancedRuleOverrideTile

    Rule Override Tiles are Tiles which can override a subset of Rules for a given Rule Tile to provide specialised behaviour while keeping most of the Rules originally set in the Rule Tile.

    Inheritance
    Object
    Object
    ScriptableObject
    TileBase
    RuleOverrideTile
    AdvancedRuleOverrideTile
    Inherited Members
    RuleOverrideTile.Item[Sprite]
    RuleOverrideTile.Item[GameObject]
    RuleOverrideTile.m_Tile
    RuleOverrideTile.m_Sprites
    RuleOverrideTile.m_GameObjects
    RuleOverrideTile.m_InstanceTile
    RuleOverrideTile.ApplyOverrides(IList<KeyValuePair<Sprite, Sprite>>)
    RuleOverrideTile.ApplyOverrides(IList<KeyValuePair<GameObject, GameObject>>)
    RuleOverrideTile.GetOverrides(List<KeyValuePair<Sprite, Sprite>>, Int32)
    RuleOverrideTile.GetOverrides(List<KeyValuePair<GameObject, GameObject>>, Int32)
    RuleOverrideTile.PrepareOverride()
    RuleOverrideTile.GetTileAnimationData(Vector3Int, ITilemap, TileAnimationData)
    RuleOverrideTile.GetTileData(Vector3Int, ITilemap, TileData)
    RuleOverrideTile.RefreshTile(Vector3Int, ITilemap)
    RuleOverrideTile.StartUp(Vector3Int, ITilemap, GameObject)
    RuleOverrideTile.OnEnable()
    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.Tilemaps
    Syntax
    [MovedFrom(true, "UnityEngine", null, null)]
    [Serializable]
    [HelpURL("https://docs.unity3d.com/Packages/com.unity.2d.tilemap.extras@latest/index.html?subfolder=/manual/RuleOverrideTile.html")]
    public class AdvancedRuleOverrideTile : RuleOverrideTile

    Fields

    m_DefaultColliderType

    The Default Collider Type set when creating a new Rule override.

    Declaration
    public Tile.ColliderType m_DefaultColliderType
    Field Value
    Type Description
    Tile.ColliderType

    m_DefaultGameObject

    The Default GameObject set when creating a new Rule override.

    Declaration
    public GameObject m_DefaultGameObject
    Field Value
    Type Description
    GameObject

    m_DefaultSprite

    The Default Sprite set when creating a new Rule override.

    Declaration
    public Sprite m_DefaultSprite
    Field Value
    Type Description
    Sprite

    m_OverrideTilingRules

    A list of TilingRule Overrides

    Declaration
    public List<RuleTile.TilingRuleOutput> m_OverrideTilingRules
    Field Value
    Type Description
    List<RuleTile.TilingRuleOutput>

    Properties

    Item[RuleTile.TilingRule]

    Gets the overriding TilingRuleOutput of a given TilingRule.

    Declaration
    public RuleTile.TilingRuleOutput this[RuleTile.TilingRule originalRule] { get; set; }
    Parameters
    Type Name Description
    RuleTile.TilingRule originalRule

    The original TilingRule that is overridden

    Property Value
    Type Description
    RuleTile.TilingRuleOutput

    Methods

    ApplyOverrides(IList<KeyValuePair<RuleTile.TilingRule, RuleTile.TilingRuleOutput>>)

    Applies overrides to this

    Declaration
    public void ApplyOverrides(IList<KeyValuePair<RuleTile.TilingRule, RuleTile.TilingRuleOutput>> overrides)
    Parameters
    Type Name Description
    IList<KeyValuePair<RuleTile.TilingRule, RuleTile.TilingRuleOutput>> overrides

    A list of overrides to apply

    Exceptions
    Type Condition
    ArgumentNullException

    The input overrides list is not valid

    GetOverrides(List<KeyValuePair<RuleTile.TilingRule, RuleTile.TilingRuleOutput>>, ref Int32)

    Gets overrides for this

    Declaration
    public void GetOverrides(List<KeyValuePair<RuleTile.TilingRule, RuleTile.TilingRuleOutput>> overrides, ref int validCount)
    Parameters
    Type Name Description
    List<KeyValuePair<RuleTile.TilingRule, RuleTile.TilingRuleOutput>> overrides

    A list of overrides to fill

    Int32 validCount

    Returns the number of valid overrides for Rules

    Exceptions
    Type Condition
    ArgumentNullException

    The input overrides list is not valid

    Override()

    Updates the Rules with the Overrides set for this AdvancedRuleOverrideTile

    Declaration
    public override void Override()
    Overrides
    RuleOverrideTile.Override()
    Back to top
    Terms of use
    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