Class CustomEnumDefinition

Namespace

DotTiled

Assembly

DotTiled.dll

Represents a custom enum definition in Tiled. Refer to the documentation of custom types to understand how they work.

public class CustomEnumDefinition : ICustomTypeDefinition

Inheritance

object

CustomEnumDefinition

Implements

ICustomTypeDefinition

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ID

The ID of the custom type.

public uint ID { get; set; }

Property Value

uint

Name

The name of the custom type.

public required string Name { get; set; }

Property Value

string

StorageType

The storage type of the custom enum.

public CustomEnumStorageType StorageType { get; set; }

Property Value

CustomEnumStorageType

ValueAsFlags

Whether the value should be treated as flags.

public bool ValueAsFlags { get; set; }

Property Value

bool

Values

The values of the custom enum.

public List<string> Values { get; set; }

Property Value

List<string>

Methods

FromEnum(Type, CustomEnumStorageType)

Creates a custom enum definition from the specified enum type.

public static CustomEnumDefinition FromEnum(Type type, CustomEnumStorageType storageType = CustomEnumStorageType.String)

Parameters

type Type

The enum type to create a custom enum definition from.

storageType CustomEnumStorageType

The storage type of the custom enum. Defaults to String to be consistent with Tiled.

Returns

CustomEnumDefinition

FromEnum<T>(CustomEnumStorageType)

Creates a custom enum definition from the specified enum type.

public static CustomEnumDefinition FromEnum<T>(CustomEnumStorageType storageType = CustomEnumStorageType.String) where T : Enum

Parameters

storageType CustomEnumStorageType

The storage type of the custom enum. Defaults to String to be consistent with Tiled.

Returns

CustomEnumDefinition

Type Parameters

T