类 ThemeSettings实验性

方法

addNewTheme canThemeBeModified deleteTheme getCurrentTheme getThemeColors getThemeIdList getThemeName resolveColorKey setCurrentTheme setThemeName updateThemeColor

方法

addNewTheme

  • addNewTheme(id: string, name?: string, sourceThemeId?: string): void
  • 实验性

    参数

    • id: string
    • 可选name: string
    • 可选sourceThemeId: string

    返回 void

    备注

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

    Error

canThemeBeModified

  • canThemeBeModified(id: string): boolean
  • 实验性

    参数

    • id: string

    返回 boolean

deleteTheme

  • deleteTheme(id: string): void
  • 实验性

    参数

    • id: string

    返回 void

    备注

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

    Error

getCurrentTheme

  • getCurrentTheme(): string
  • 实验性

    返回 string

getThemeColors

  • getThemeColors(id: string): Record<string, RGBA>
  • 实验性

    参数

    • id: string

    返回 Record<string, RGBA>

getThemeIdList

  • getThemeIdList(): string[]
  • 实验性

    返回 string[]

getThemeName

  • getThemeName(id: string): string
  • 实验性

    参数

    • id: string

    返回 string

    抛出

    This function can throw errors.

    Error

resolveColorKey

setCurrentTheme

  • setCurrentTheme(id: string): void
  • 实验性

    参数

    • id: string

    返回 void

    备注

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

    Error

setThemeName

  • setThemeName(id: string, name: string): void
  • 实验性

    参数

    • id: string
    • name: string

    返回 void

    备注

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

    Error

updateThemeColor

显示设置

成员可见性

目录

方法