ScoreComponent | rawjsonbuilder

Hierarchy

BaseComponent
- ScoreComponent

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new ScoreComponent(component?: string | ScoreComponent | RawScoreComponent): ScoreComponent

Overrides BaseComponent.constructor
- Defined in components/Score.ts:16
Parameters
- Optional component: string | ScoreComponent | RawScoreComponent
Returns ScoreComponent

Properties

Optional bold

bold: boolean = ...

Optional clickEvent

clickEvent: IClickEvent = ...

Optional color

color: string = ...

extra

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

Optional font

font: string = ...

Optional hoverEvent

hoverEvent: IShowTextHoverEvent | IShowItemHoverEvent | IShowEntityHoverEvent = ...

Optional insertion

insertion: string = ...

Optional italic

italic: boolean = ...

Optional obfuscated

obfuscated: boolean = ...

score

score: IScore = ...

Optional strikethrough

strikethrough: boolean = ...

Optional underlined

underlined: boolean = ...

Accessors

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

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

isBold

get isBold(): boolean

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

Returns boolean

Component bold 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)[]): ScoreComponent

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 ScoreComponent

Current component context

addNewLine

addNewLine(): ScoreComponent

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

Returns ScoreComponent

Current component context

addSpace

addSpace(): ScoreComponent

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

Returns ScoreComponent

Current component context

clearExtra

clearExtra(): ScoreComponent

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

Returns ScoreComponent

Current component context

hasName

hasName(): boolean

- Defined in components/Score.ts:74
Get component name status

Returns boolean

Component name status

hasObjective

hasObjective(): boolean

- Defined in components/Score.ts:83
Get component objective status

Returns boolean

Component objective status

hasValue

hasValue(): boolean

- Defined in components/Score.ts:92
Get component value status

Returns boolean

Component value status

setBold

setBold(bold?: undefined | boolean): ScoreComponent

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 ScoreComponent

Current component context

setClickEvent

setClickEvent(event?: IClickEvent): ScoreComponent

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 ScoreComponent

Current component context

setColor

setColor(color?: string): ScoreComponent

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 ScoreComponent

Current component context

setFont

setFont(font?: string): ScoreComponent

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 ScoreComponent

Current component context

setHoverEvent

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

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 ScoreComponent

Current component context

setInsertion

setInsertion(insertion: undefined | string): ScoreComponent

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 ScoreComponent

Current component context

setItalic

setItalic(italic?: undefined | boolean): ScoreComponent

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 ScoreComponent

Current component context

setName

setName(name?: string): ScoreComponent

- Defined in components/Score.ts:33
Set name for component

see

Scoreboard Value

Parameters
- name: string = ""
  
  Name
Returns ScoreComponent

Current component context

setObfuscated

setObfuscated(obfuscated?: undefined | boolean): ScoreComponent

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 ScoreComponent

Current component context

setObjective

setObjective(objective?: string): ScoreComponent

- Defined in components/Score.ts:48
Set objective for component

see

Scoreboard Value

Parameters
- objective: string = ""
  
  Objective
Returns ScoreComponent

Current component context

setStrikethrough

setStrikethrough(strikethrough?: undefined | boolean): ScoreComponent

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 ScoreComponent

Current component context

setUnderlined

setUnderlined(underlined?: undefined | boolean): ScoreComponent

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 ScoreComponent

Current component context

setValue

setValue(value?: string): ScoreComponent

- Defined in components/Score.ts:63
Set value for component

see

Scoreboard Value

Parameters
- Optional value: string
  
  Value
Returns ScoreComponent

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