Class EntityBooleanProperty

Hierarchy (View Summary)

EntityProperty
- EntityBooleanProperty

Index

Constructors

Properties

compound currentValue

Methods

getIdentifier getType setIdentifier setType

Constructors

constructor

new EntityBooleanProperty(
identifier: string,
defaultValue?: boolean,
): EntityBooleanProperty
Create a new entity boolean property.
Parameters
- identifier: string
  The identifier of the property.
- OptionaldefaultValue: boolean
  The default value of the property.
Returns EntityBooleanProperty
Overrides EntityProperty.constructor
- Defined in packages/core/src/entity/identity/properties/boolean.ts:16

Properties

`Readonly`compound

compound: CompoundTag = ...

The compound tag that contains the property data.

currentValue

currentValue: boolean = false

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:39

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:56

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:31

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:48