41 lines
1.7 KiB
Markdown
41 lines
1.7 KiB
Markdown
|
# 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:
|
||
|
|
|
||
|
|
```C#
|
||
|
|
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:
|
||
|
|
|
||
|
|
```C#
|
||
|
|
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](https://docs.unity3d.com/Manual/Tilemap-ScriptableTiles.html) to get the right [TileData](https://docs.unity3d.com/Manual/Tilemap-ScriptableTiles-TileData.html) when creating the layout of your Tilemap.
|