ScoreBoardDataBase.md

sapi-pro

---

sapi-pro / ScoreBoardDataBase

Class: ScoreBoardDataBase

Extends

• DataBase<number>

Constructors

Constructor

new ScoreBoardDataBase(name, displayName?, usePrefix?): ScoreBoardDataBase

Parameters

name

string

displayName?

string

usePrefix?

boolean = true

Returns

ScoreBoardDataBase

Overrides

DataBase.constructor

Properties

name

name: string

Inherited from

DataBase.name

---

type

type: DBTypes

Inherited from

DataBase.type

---

DBMap

static DBMap: Record<string, DataBase<any>> = {}

Inherited from

DataBase.DBMap

---

maxChunkBytes

static maxChunkBytes: number = 32767

Inherited from

DataBase.maxChunkBytes

Methods

add()

add(key, value): void

Parameters

key

string | Entity | ScoreboardIdentity

value

string | number

Returns

void

---

clear()

clear(): void

清空计分板(删除并重建)

Returns

void

Overrides

DataBase.clear

---

dispose()

dispose(): void

删除这个scoreboard(下次用到会重建)

Returns

void

---

get()

get(key): number | undefined

Parameters

key

string | Entity | ScoreboardIdentity

Returns

number | undefined

Overrides

DataBase.get

---

getObj()

getObj(key): scoreboardObj

获取一个虚拟计分项对象

Parameters

key

string | Entity | ScoreboardIdentity

Returns

scoreboardObj

---

getScoreBoard()

getScoreBoard(): ScoreboardObjective

Returns

ScoreboardObjective

---

getScoreBoardName()

getScoreBoardName(): string

Returns

string

---

isDisplayAtSlot()

isDisplayAtSlot(DisplaySlotId): boolean

判断是否在正在指定Slot显示

Parameters

DisplaySlotId

DisplaySlotId

Returns

boolean

---

keys()

keys(): string[]

获取所有计分项

Returns

string[]

Overrides

DataBase.keys

---

participants()

participants(): ScoreboardIdentity[]

Returns

ScoreboardIdentity[]

---

resetAll()

resetAll(): void

重置所有积分项(调用命令)

Returns

void

---

rm()

rm(key): void

删除指定计分项

Parameters

key

string | Entity | ScoreboardIdentity

Returns

void

Overrides

DataBase.rm

---

set()

set(key, value): void

Parameters

key

string | Entity | ScoreboardIdentity

value

string | number

Returns

void

Overrides

DataBase.set

---

setDisplaySlot()

setDisplaySlot(SlotId): void

设置显示位置

Parameters

SlotId

DisplaySlotId

Returns

void

---

getDB()

static getDB(name): DataBase<any> | undefined

Parameters

name

string

Returns

DataBase<any> | undefined

Inherited from

DataBase.getDB

---

getDBs()

static getDBs(): DataBase<any>[]

Returns

DataBase<any>[]

Inherited from

DataBase.getDBs