docs.unity3d.com
    Show / Hide Table of Contents

    Grid Information

    This is a simple component that stores and provides information based on Grid positions and keywords.

    Usage

    Add this Component to a GameObject with a Grid component. To store information on to the Grid Information component, use the following APIs:

    public bool SetPositionProperty(Vector3Int position, String name, int positionProperty)
    
    public bool SetPositionProperty(Vector3Int position, String name, string positionProperty)
    
    public bool SetPositionProperty(Vector3Int position, String name, float positionProperty)
    
    public bool SetPositionProperty(Vector3Int position, String name, double positionProperty)
    
    public bool SetPositionProperty(Vector3Int position, String name, UnityEngine.Object positionProperty)
    
    public bool SetPositionProperty(Vector3Int position, String name, Color positionProperty)
    

    To retrieve information from the Grid Information component, use the following APIs:

    public T GetPositionProperty<T>(Vector3Int position, String name, T defaultValue) where T : UnityEngine.Object
    
    public int GetPositionProperty(Vector3Int position, String name, int defaultValue)
    
    public string GetPositionProperty(Vector3Int position, String name, string defaultValue)
    
    public float GetPositionProperty(Vector3Int position, String name, float defaultValue)
    
    public double GetPositionProperty(Vector3Int position, String name, double defaultValue)
    
    public Color GetPositionProperty(Vector3Int position, String name, Color defaultValue)
    

    You can use this in combination with Scriptable Tiles to get the right TileData when creating the layout of your Tilemap.

    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