NBTComponent | rawjsonbuilder

Hierarchy

BaseComponent
- NBTComponent

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new NBTComponent(component?: string | NBTComponent | RawNBTComponent): NBTComponent

Overrides BaseComponent.constructor
- Defined in components/NBT.ts:15
Parameters
- Optional component: string | NBTComponent | RawNBTComponent
Returns NBTComponent

Properties

Optional block

block: string = ...

Optional bold

bold: boolean = ...

Optional clickEvent

clickEvent: IClickEvent = ...

Optional color

color: string = ...

Optional entity

entity: string = ...

extra

extra: (string | RawJSON)[] = []

Optional font

font: string = ...

Optional hoverEvent

hoverEvent: IShowTextHoverEvent | IShowItemHoverEvent | IShowEntityHoverEvent = ...

Optional insertion

insertion: string = ...

Optional interpret

interpret: boolean = ...

Optional italic

italic: boolean = ...

nbt

nbt: string = ""

Optional obfuscated

obfuscated: boolean = ...

Optional separator

separator: RawJSON = ...

Optional storage

storage: string = ...

Optional strikethrough

strikethrough: boolean = ...

Optional underlined

underlined: boolean = ...

Accessors

hasBlock

get hasBlock(): boolean

- Defined in components/NBT.ts:127
Get component block status

Returns boolean

Component block status

hasClickEvent

get hasClickEvent(): boolean

- Defined in components/Base.ts:400
Get component click event status

Returns boolean

Component click event status

hasColor

get hasColor(): boolean

- Defined in components/Base.ts:337
Get component color status

Returns boolean

Component color status

hasEntity

get hasEntity(): boolean

- Defined in components/NBT.ts:136
Get component entity status

Returns boolean

Component entity status

hasFont

get hasFont(): boolean

- Defined in components/Base.ts:346
Get component font status

Returns boolean

Component font status

hasHoverEvent

get hasHoverEvent(): boolean

- Defined in components/Base.ts:409
Get component hover event status

Returns boolean

Component click event status

hasSeparator

get hasSeparator(): boolean

- Defined in components/NBT.ts:154
Get component separator status

Returns boolean

Component separator status

hasStorage

get hasStorage(): boolean

- Defined in components/NBT.ts:145
Get component storage status

Returns boolean

Component storage status

isBold

get isBold(): boolean

- Defined in components/Base.ts:355
Get component bold status

Returns boolean

Component bold status

isInterpret

get isInterpret(): boolean

- Defined in components/NBT.ts:118
Get component interpret status

Returns boolean

Component interpret status

isItalic

get isItalic(): boolean

- Defined in components/Base.ts:364
Get component italic status

Returns boolean

Component italic status

isObfuscated

get isObfuscated(): boolean

- Defined in components/Base.ts:391
Get component obfuscated status

Returns boolean

Component obfuscated status

isStrikethrough

get isStrikethrough(): boolean

- Defined in components/Base.ts:382
Get component strikethrough status

Returns boolean

Component strikethrough status

isUnderlined

get isUnderlined(): boolean

- Defined in components/Base.ts:373
Get component underlined status

Returns boolean

Component underlined status

Methods

addExtra

addExtra(extra: string | RawJSON | (string | RawJSON)[]): NBTComponent

Inherited from BaseComponent.addExtra
- Defined in components/Base.ts:422
Add extra for component

see

Raw JSON text format

Parameters
- extra: string | RawJSON | (string | RawJSON)[]
  
  Array of components or component
Returns NBTComponent

Current component context

addNewLine

addNewLine(): NBTComponent

Inherited from BaseComponent.addNewLine
- Defined in components/Base.ts:455
Add new line to the end

Returns NBTComponent

Current component context

addSpace

addSpace(): NBTComponent

Inherited from BaseComponent.addSpace
- Defined in components/Base.ts:444
Add space to the end

Returns NBTComponent

Current component context

clearExtra

clearExtra(): NBTComponent

Inherited from BaseComponent.clearExtra
- Defined in components/Base.ts:433
Clear current component extra context

Returns NBTComponent

Current component context

setBlock

setBlock(block?: string): NBTComponent

- Defined in components/NBT.ts:62
Set block coordinates for component

see

NBT Values

Parameters
- Optional block: string
  
  Block coordinates
Returns NBTComponent

Current component context

setBold

setBold(bold?: undefined | boolean): NBTComponent

Inherited from BaseComponent.setBold
- Defined in components/Base.ts:221
Set bold for component

see

Raw JSON text format

Parameters
- bold: undefined | boolean = true
  
  Bold value
Returns NBTComponent

Current component context

setClickEvent

setClickEvent(event?: IClickEvent): NBTComponent

Inherited from BaseComponent.setClickEvent
- Defined in components/Base.ts:311
Set click event for component

see

Raw JSON text format

Parameters
- Optional event: IClickEvent
  
  Event value
Returns NBTComponent

Current component context

setColor

setColor(color?: string): NBTComponent

Inherited from BaseComponent.setColor
- Defined in components/Base.ts:191
Set color for component

see

Raw JSON text format

Parameters
- Optional color: string
  
  Color type or hex value
Returns NBTComponent

Current component context

setEntity

setEntity(entity?: string): NBTComponent

- Defined in components/NBT.ts:77
Set entity selector for component

see

NBT Values

Parameters
- Optional entity: string
  
  Entity selector
Returns NBTComponent

Current component context

setFont

setFont(font?: string): NBTComponent

Inherited from BaseComponent.setFont
- Defined in components/Base.ts:206
Set font for component

see

Raw JSON text format

Parameters
- Optional font: string
  
  Font path
Returns NBTComponent

Current component context

setHoverEvent

setHoverEvent(event?: IShowTextHoverEvent | IShowItemHoverEvent | IShowEntityHoverEvent): NBTComponent

Inherited from BaseComponent.setHoverEvent
- Defined in components/Base.ts:326
Set hover event for component

see

Raw JSON text format

Parameters
- Optional event: IShowTextHoverEvent | IShowItemHoverEvent | IShowEntityHoverEvent
  
  Event value
Returns NBTComponent

Current component context

setInsertion

setInsertion(insertion: undefined | string): NBTComponent

Inherited from BaseComponent.setInsertion
- Defined in components/Base.ts:296
Set insertion for component

see

Raw JSON text format

Parameters
- insertion: undefined | string
  
  Insertion value
Returns NBTComponent

Current component context

setInterpret

setInterpret(interpret?: undefined | boolean): NBTComponent

- Defined in components/NBT.ts:47
Set interpret for component

see

NBT Values

Parameters
- interpret: undefined | boolean = true
  
  Interpret value
Returns NBTComponent

Current component context

setItalic

setItalic(italic?: undefined | boolean): NBTComponent

Inherited from BaseComponent.setItalic
- Defined in components/Base.ts:236
Set italic for component

see

Raw JSON text format

Parameters
- italic: undefined | boolean = true
  
  Italic value
Returns NBTComponent

Current component context

setNBT

setNBT(nbt?: string): NBTComponent

- Defined in components/NBT.ts:32
Set NBT path for component

see

NBT Values

Parameters
- nbt: string = ""
  
  NBT path
Returns NBTComponent

Current component context

setObfuscated

setObfuscated(obfuscated?: undefined | boolean): NBTComponent

Inherited from BaseComponent.setObfuscated
- Defined in components/Base.ts:281
Set obfuscated for component

see

Raw JSON text format

Parameters
- obfuscated: undefined | boolean = true
  
  Obfuscated value
Returns NBTComponent

Current component context

setSeparator

setSeparator(separator?: RawJSON): NBTComponent

- Defined in components/NBT.ts:107
Set separator for component

see

NBT Values

Parameters
- Optional separator: RawJSON
  
  Separator
Returns NBTComponent

Current component context

setStorage

setStorage(storage?: string): NBTComponent

- Defined in components/NBT.ts:92
Set namespaced ID or command storage for component

see

NBT Values

Parameters
- Optional storage: string
  
  Namespaced ID or command storage
Returns NBTComponent

Current component context

setStrikethrough

setStrikethrough(strikethrough?: undefined | boolean): NBTComponent

Inherited from BaseComponent.setStrikethrough
- Defined in components/Base.ts:266
Set strikethrough for component

see

Raw JSON text format

Parameters
- strikethrough: undefined | boolean = true
  
  Strikethrough value
Returns NBTComponent

Current component context

setUnderlined

setUnderlined(underlined?: undefined | boolean): NBTComponent

Inherited from BaseComponent.setUnderlined
- Defined in components/Base.ts:251
Set underlined for component

see

Raw JSON text format

Parameters
- underlined: undefined | boolean = true
  
  Underlined value
Returns NBTComponent

Current component context

Protected setup

setup(component?: string | BaseComponent | Partial<Pick<BaseComponent, "color" | "font" | "bold" | "italic" | "underlined" | "strikethrough" | "obfuscated" | "insertion" | "clickEvent" | "hoverEvent" | "extra">>): void

Inherited from BaseComponent.setup
- Defined in components/Base.ts:160
Parameters
- Optional component: string | BaseComponent | Partial<Pick<BaseComponent, "color" | "font" | "bold" | "italic" | "underlined" | "strikethrough" | "obfuscated" | "insertion" | "clickEvent" | "hoverEvent" | "extra">>
Returns void

toRawString

toRawString(): string

Inherited from BaseComponent.toRawString
- Defined in components/Base.ts:475
Get component raw string

Returns string

Raw string

toString

toString(): string

Inherited from BaseComponent.toString
- Defined in components/Base.ts:466
Get component JSON Stringify string

Returns string

JSON Stringify string

Generated using TypeDoc