Class GridBrushPickStore

A ScriptableObject that stores picks for a particular GridBrushBase type. The picks include a list of picks defined by the user and a limited list of picks which were last made by the user. The picks can be loaded onto the active Brush in the TilePalette.

Inheritance

object

Object

ScriptableObject

GridBrushPickStore

Inherited Members

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

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, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: UnityEditor.Tilemaps

Assembly: Unity.2D.Tilemap.Editor.dll

Syntax

public class GridBrushPickStore : ScriptableObject

Properties

filteredUserSavedBrushes

A list of GridBrushBases which represent the user picks made filtered by the current filter type.

Declaration

public List<GridBrushBase> filteredUserSavedBrushes { get; }

Property Value

Type	Description
List<GridBrushBase>

lastIndex

The index of the latest last pick that was made.

Declaration

public int lastIndex { get; }

Property Value

Type	Description
int

lastSavedBrushes

A list of GridBrushBases which represent the last picks made.

Declaration

public List<GridBrushBase> lastSavedBrushes { get; }

Property Value

Type	Description
List<GridBrushBase>

userSavedBrushes

A list of GridBrushBases which represent the user picks made.

Declaration

public List<GridBrushBase> userSavedBrushes { get; }

Property Value

Type	Description
List<GridBrushBase>

Methods

AddNewLastSavedBrush(GridBrushBase)

Adds the specified Brush as a new last pick.

Declaration

public void AddNewLastSavedBrush(GridBrushBase brush)

Parameters

Type	Name	Description
GridBrushBase	brush	Brush to save as a new last pick.

AddNewUserSavedBrush(GridBrushBase)

Adds the specified Brush as a new user pick.

Declaration

public void AddNewUserSavedBrush(GridBrushBase brush)

Parameters

Type	Name	Description
GridBrushBase	brush	Brush to save as a new user pick.

ClearLastSavedBrush(int)

Clears the Brush at the index of the last pick list.

Declaration

public void ClearLastSavedBrush(int index)

Parameters

Type	Name	Description
int	index	The index of the Brush of the last pick list to clear.

RemoveUserSavedBrush(int)

Removes the Brush at the index of the last pick list.

Declaration

public bool RemoveUserSavedBrush(int index)

Parameters

Type	Name	Description
int	index	The index of the Brush of the user pick list to remove.

Returns

Type	Description
bool	Whether the Brush was removed.

SaveUserSavedBrush(int, GridBrushBase)

Saves over a brush in the user pick with the given index with the specified Brush.

Declaration

public void SaveUserSavedBrush(int index, GridBrushBase brush)

Parameters

Type	Name	Description
int	index	The index of the Brush of the user pick list to save over.
GridBrushBase	brush	Brush to save over as a user pick.

SetUserBrushFilterType(Type, string)

Sets the type to filter all user brushes by.

Declaration

public void SetUserBrushFilterType(Type filterType, string filterText)

Parameters

Type	Name	Description
Type	filterType	Type to filter user brushes.
string	filterText	Text to filter user brush names.

SwapUserSavedBrushes(int, int)

Swaps the position of the specified Brush

Declaration

public void SwapUserSavedBrushes(int oldIdx, int newIdx)

Parameters

Type	Name	Description
int	oldIdx	Index of the Brush to swap.
int	newIdx	Index to swap the Brush to.