Class EntityEnumProperty

Hierarchy (View Summary)

EntityProperty<EntityEnumPropertyData>
- EntityEnumProperty

Index

Constructors

Properties

compound currentValue

Methods

getEnum getIdentifier getType setEnum setIdentifier setType

Constructors

constructor

new EntityEnumProperty(
    identifier: string,
    values: string[],
    defaultValue?: string,
): EntityEnumProperty
Create a new entity float property.
Parameters
- identifier: string
  The identifier of the property.
- values: string[]
  The strings that the property can take.
- OptionaldefaultValue: string
  The default value of the property.
Returns EntityEnumProperty
Overrides EntityProperty.constructor
- Defined in packages/core/src/entity/identity/properties/enum.ts:25

Properties

`Readonly`compound

compound: CompoundTag<EntityEnumPropertyData> = ...

The compound tag that contains the property data.

currentValue

currentValue: string

The current value of the property.

Methods

getEnum

getEnum(): string[]
Get the enum values of the property.

Returns string[]
- Defined in packages/core/src/entity/identity/properties/enum.ts:42

getIdentifier

getIdentifier(): string
Get the identifier of the property.

Returns string
The identifier of the property.
Inherited from EntityProperty.getIdentifier
- Defined in packages/core/src/entity/identity/properties/property.ts:51

getType

getType(): EntityPropertyType
Get the type of the property.

Returns EntityPropertyType
The type of the property.
Inherited from EntityProperty.getType
- Defined in packages/core/src/entity/identity/properties/property.ts:68

setEnum

setEnum(values: string[]): void
Set the enum values of the property.
Parameters
- values: string[]
  The strings that the property can take.
Returns void
- Defined in packages/core/src/entity/identity/properties/enum.ts:54

setIdentifier

setIdentifier(identifier: string): void
Set the identifier of the property.
Parameters
- identifier: string
  The identifier of the property.
Returns void
The entity property.
Inherited from EntityProperty.setIdentifier
- Defined in packages/core/src/entity/identity/properties/property.ts:43

setType

setType(type: EntityPropertyType): void
Set the type of the property.
Parameters
- type: EntityPropertyType
  The type of the property.
Returns void
The entity property.
Inherited from EntityProperty.setType
- Defined in packages/core/src/entity/identity/properties/property.ts:60