Skip to main content

Class: EntityNpcComponent

Adds NPC capabilities to an entity such as custom skin, name, and dialogue interactions.

Extends​

Constructors​

new EntityNpcComponent()​

private new EntityNpcComponent(): EntityNpcComponent

Returns​

EntityNpcComponent

Overrides​

EntityComponent . constructor

Properties​

defaultScene​

defaultScene: string

Remarks​

The DialogueScene that is opened when players first interact with the NPC.

This property can't be edited in read-only mode.

entity​

Beta

readonly entity: Entity

Remarks​

The entity that owns this component. The entity will be undefined if it has been removed.

Inherited from​

EntityComponent . entity

name​

name: string

Remarks​

The name of the NPC as it is displayed to players.

This property can't be edited in read-only mode.

skinIndex​

skinIndex: number

Remarks​

The index of the skin the NPC will use.

This property can't be edited in read-only mode.

typeId​

readonly typeId: string

Remarks​

Identifier of the component.

Inherited from​

EntityComponent . typeId

componentId​

static readonly componentId: "minecraft:npc" = 'minecraft:npc'

Methods​

isValid()​

isValid(): boolean

Returns​

boolean

Whether the component is valid.

Inherited from​

EntityComponent . isValid

Remarks​

Returns whether the component is valid. A component is considered valid if its owner is valid, in addition to any addition to any additional validation required by the component.