Struct EditCapability
Structure to hold the edit capability of a sprite in Sprite Editor Window.
Implements
Inherited Members
Namespace: UnityEditor.U2D.Sprites
Assembly: Unity.2D.Sprite.Editor.dll
Syntax
[Serializable]
public struct EditCapability : IEquatable<EditCapability>
Constructors
EditCapability(params EEditCapability[])
Constructor to create EditCapability with specific capabilities.
Declaration
public EditCapability(params EEditCapability[] capabilities)
Parameters
| Type | Name | Description |
|---|---|---|
| EEditCapability[] | capabilities | Capabilities allowed. |
Fields
defaultCapability
Default editing capability where all capability is allowed.
Declaration
public static EditCapability defaultCapability
Field Value
| Type | Description |
|---|---|
| EditCapability |
Methods
Equals(object)
Equality operator.
Declaration
public override bool Equals(object obj)
Parameters
| Type | Name | Description |
|---|---|---|
| object | obj | Value to compare |
Returns
| Type | Description |
|---|---|
| bool | True if equal, false otherwise. |
Overrides
Equals(EditCapability)
Equality operator.
Declaration
public bool Equals(EditCapability other)
Parameters
| Type | Name | Description |
|---|---|---|
| EditCapability | other | Value to compare |
Returns
| Type | Description |
|---|---|
| bool | True if equal, false otherwise. |
GetHashCode()
Get the hash code of the capability.
Declaration
public override int GetHashCode()
Returns
| Type | Description |
|---|---|
| int | Hash value for the data. |
Overrides
HasCapability(EEditCapability)
Check if the capability is enabled.
Declaration
public bool HasCapability(EEditCapability hasCapability)
Parameters
| Type | Name | Description |
|---|---|---|
| EEditCapability | hasCapability | Capability to check. |
Returns
| Type | Description |
|---|---|
| bool | True if capability is enabled. False otherwise. |
SetCapability(EEditCapability, bool)
Enable or disable a capability.
Declaration
public void SetCapability(EEditCapability capability, bool on)
Parameters
| Type | Name | Description |
|---|---|---|
| EEditCapability | capability | Capability to modify. |
| bool | on | True to enable. False otherwise. |