Interface BedComponent

Component object.

Hierarchy

IComponent<any>
- BedComponent
  - BedGetComponent

Index

Properties

Methods

Properties

identifier

__identifier__: string

The identifier of the component, e.g., "minecraft:position", or "minecraft:nameable"

type

__type__: "component"

The type of the object

Methods

add

add(ent: IEntity | BedEntity, existsOk: boolean): void

- Defined in index.ts:71
Add the component to an entity.

Parameters
- ent: IEntity | BedEntity
- existsOk: boolean
  
  If false an error will be thrown if the component already exists on the entity.
Returns void

data

data(ent: IEntity | BedEntity, data?: object | Function): IComponent<unknown> | null | void

Overrides IComponent.data
- Defined in index.ts:84
Get or set the data of an entity.

Parameters
- ent: IEntity | BedEntity
  
  The identifier of the entity.
- Optional data: object | Function
  
  The data to change provided as an object or as a Function that takes and returns a value.
Returns IComponent<unknown> | null | void

has

has(ent: IEntity | BedEntity): boolean

- Defined in index.ts:77
Check if an entity has a component.

Parameters
- ent: IEntity | BedEntity
  
  The identifier of the entity.
Returns boolean

reload

reload(ent: IEntity | BedEntity): void

- Defined in index.ts:90
Reload the component.

Parameters
- ent: IEntity | BedEntity
  
  The identifier of the entity.
Returns void

remove

remove(ent: IEntity | BedEntity): void

- Defined in index.ts:96
Remove the component from an entity.

Parameters
- ent: IEntity | BedEntity
  
  The identifier of the entity.
Returns void

Generated using TypeDoc