Class EntityIntProperty

Hierarchy (View Summary)

EntityProperty<EntityIntPropertyData>
- EntityIntProperty

Index

Constructors

Properties

compound currentValue

Methods

getIdentifier getMax getMin getType setIdentifier setMax setMin setType

Constructors

constructor

new EntityIntProperty(
    identifier: string,
    min: number,
    max: number,
    defaultValue?: number,
): EntityIntProperty
Create a new entity int property.
Parameters
- identifier: string
  The identifier of the property.
- min: number
  The minimum value of the property.
- max: number
  The maximum value of the property.
- OptionaldefaultValue: number
  The default value of the property.
Returns EntityIntProperty
Overrides EntityProperty.constructor
- Defined in packages/core/src/entity/identity/properties/int.ts:32

Properties

`Readonly`compound

compound: CompoundTag<EntityIntPropertyData> = ...

The compound tag that contains the property data.

currentValue

currentValue: number = 0

The current value of the property.

Methods

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

getMax

getMax(): number
Get the maximum value of the property.

Returns number
The maximum value of the property.
- Defined in packages/core/src/entity/identity/properties/int.ts:68

getMin

getMin(): number
Get the minimum value of the property.

Returns number
The minimum value of the property.
- Defined in packages/core/src/entity/identity/properties/int.ts:52

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

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

setMax

setMax(max: number): void
Set the maximum value of the property.
Parameters
- max: number
  The maximum value of the property.
Returns void
- Defined in packages/core/src/entity/identity/properties/int.ts:76

setMin

setMin(min: number): void
Set the minimum value of the property.
Parameters
- min: number
  The minimum value of the property.
Returns void
- Defined in packages/core/src/entity/identity/properties/int.ts:60

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