[Serializable]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.2d.tilemap.extras@latest/index.html?subfolder=/manual/GridInformation.html")]
[AddComponentMenu("Tilemap/Grid Information")]
public class GridInformation : MonoBehaviour, ISerializationCallbackReceiver

Methods

ErasePositionProperty(Vector3Int, String)

Erases information stored at the given position with the given property name

Declaration

public bool ErasePositionProperty(Vector3Int position, string name)

Parameters

Type	Name	Description
Vector3Int	position	Position to erase
String	name	Property name to erase

Returns

Type	Description
Boolean	Whether the information was erased

GetAllPositions(String)

Gets all positions with information with the given property name

Declaration

public Vector3Int[] GetAllPositions(string propertyName)

Parameters

Type	Name	Description
String	propertyName	Property name to search for

Returns

Type	Description
Vector3Int[]	An array of all positions with the property name

GetPositionProperty(Vector3Int, String, Double)

Retrieves double information stored at the given position with the given property name

Declaration

public double GetPositionProperty(Vector3Int position, string name, double defaultValue)

Parameters

Type	Name	Description
Vector3Int	position	Position to retrieve information for
String	name	Property name to retrieve information for
Double	defaultValue	Default double if property does not exist at the given position

Returns

Type	Description
Double	The double stored at the position

Exceptions

Type	Condition
InvalidCastException	Thrown when information to be retrieved is not a double

GetPositionProperty(Vector3Int, String, Int32)

Retrieves int information stored at the given position with the given property name

Declaration

public int GetPositionProperty(Vector3Int position, string name, int defaultValue)

Parameters

Type	Name	Description
Vector3Int	position	Position to retrieve information for
String	name	Property name to retrieve information for
Int32	defaultValue	Default int if property does not exist at the given position

Returns

Type	Description
Int32	The int stored at the position

Exceptions

Type	Condition
InvalidCastException	Thrown when information to be retrieved is not a int

GetPositionProperty(Vector3Int, String, Single)

Retrieves float information stored at the given position with the given property name

Declaration

public float GetPositionProperty(Vector3Int position, string name, float defaultValue)

Parameters

Type	Name	Description
Vector3Int	position	Position to retrieve information for
String	name	Property name to retrieve information for
Single	defaultValue	Default float if property does not exist at the given position

Returns

Type	Description
Single	The float stored at the position

Exceptions

Type	Condition
InvalidCastException	Thrown when information to be retrieved is not a float

GetPositionProperty(Vector3Int, String, String)

Retrieves string information stored at the given position with the given property name

Declaration

public string GetPositionProperty(Vector3Int position, string name, string defaultValue)

Parameters

Type	Name	Description
Vector3Int	position	Position to retrieve information for
String	name	Property name to retrieve information for
String	defaultValue	Default string if property does not exist at the given position

Returns

Type	Description
String	The string stored at the position

Exceptions

Type	Condition
InvalidCastException	Thrown when information to be retrieved is not a string

GetPositionProperty(Vector3Int, String, Color)

Retrieves Color information stored at the given position with the given property name

Declaration

public Color GetPositionProperty(Vector3Int position, string name, Color defaultValue)

Parameters

Type	Name	Description
Vector3Int	position	Position to retrieve information for
String	name	Property name to retrieve information for
Color	defaultValue	Default color if property does not exist at the given position

Returns

Type	Description
Color	The color stored at the position

Exceptions

Type	Condition
InvalidCastException	Thrown when information to be retrieved is not a Color

GetPositionProperty<T>(Vector3Int, String, T)

Retrieves information stored at the given position with the given property name as the given Type

Declaration

public T GetPositionProperty<T>(Vector3Int position, string name, T defaultValue)
    where T : Object

Parameters

Type	Name	Description
Vector3Int	position	Position to retrieve information for
String	name	Property name to retrieve information for
T	defaultValue	Default value if property does not exist at the given position

Returns

Type	Description
T	The information stored at the position

Type Parameters

Name	Description
T	Type of the information to retrieve

Exceptions

Type	Condition
InvalidCastException	Thrown when information to be retrieved is not the given Type

Reset()

Clears all information stored

Declaration

public virtual void Reset()

SetPositionProperty(Vector3Int, String, Double)

Stores double information at the given position with the given property name

Declaration

public bool SetPositionProperty(Vector3Int position, string name, double positionProperty)

Parameters

Type	Name	Description
Vector3Int	position	Position to store information for
String	name	Property name to store information for
Double	positionProperty	The information to be stored at the position

Returns

Type	Description
Boolean	Whether the information was set

SetPositionProperty(Vector3Int, String, Int32)

Stores int information at the given position with the given property name

Declaration

public bool SetPositionProperty(Vector3Int position, string name, int positionProperty)

Parameters

Type	Name	Description
Vector3Int	position	Position to store information for
String	name	Property name to store information for
Int32	positionProperty	The information to be stored at the position

Returns

Type	Description
Boolean	Whether the information was set

SetPositionProperty(Vector3Int, String, Single)

Stores float information at the given position with the given property name

Declaration

public bool SetPositionProperty(Vector3Int position, string name, float positionProperty)

Parameters

Type	Name	Description
Vector3Int	position	Position to store information for
String	name	Property name to store information for
Single	positionProperty	The information to be stored at the position

Returns

Type	Description
Boolean	Whether the information was set

SetPositionProperty(Vector3Int, String, String)

Stores string information at the given position with the given property name

Declaration

public bool SetPositionProperty(Vector3Int position, string name, string positionProperty)

Parameters

Type	Name	Description
Vector3Int	position	Position to store information for
String	name	Property name to store information for
String	positionProperty	The information to be stored at the position

Returns

Type	Description
Boolean	Whether the information was set

SetPositionProperty(Vector3Int, String, Color)

Stores color information at the given position with the given property name

Declaration

public bool SetPositionProperty(Vector3Int position, string name, Color positionProperty)

Parameters

Type	Name	Description
Vector3Int	position	Position to store information for
String	name	Property name to store information for
Color	positionProperty	The information to be stored at the position

Returns

Type	Description
Boolean	Whether the information was set

SetPositionProperty(Vector3Int, String, Object)

Stores UnityEngine.Object information at the given position with the given property name

Declaration

public bool SetPositionProperty(Vector3Int position, string name, Object positionProperty)

Parameters

Type	Name	Description
Vector3Int	position	Position to store information for
String	name	Property name to store information for
Object	positionProperty	The information to be stored at the position

Returns

Type	Description
Boolean	Whether the information was set

SetPositionProperty<T>(Vector3Int, String, T)

This is not supported.

Declaration

public bool SetPositionProperty<T>(Vector3Int position, string name, T positionProperty)

Parameters

Type	Name	Description
Vector3Int	position	Position to store information for
String	name	Property name to store information for
T	positionProperty	The information to be stored at the position

Returns

Type	Description
Boolean	Whether the information was set

Type Parameters

Name	Description
T	Type of the information to set

Exceptions

Type	Condition
NotImplementedException	This is not implemented as only concrete Types are supported

Explicit Interface Implementations

ISerializationCallbackReceiver.OnAfterDeserialize()

Callback after deserializing this GridInformation

Declaration

void ISerializationCallbackReceiver.OnAfterDeserialize()

Implements

ISerializationCallbackReceiver.OnAfterDeserialize()

ISerializationCallbackReceiver.OnBeforeSerialize()

Callback before serializing this GridInformation

Declaration

void ISerializationCallbackReceiver.OnBeforeSerialize()

Implements

ISerializationCallbackReceiver.OnBeforeSerialize()