Blockbench Reference Docs
    Preparing search index...

    Class Plugin

    Index

    Constructors

    constructor

    Properties

    about about_fetched author await_loading bug_tracker cache_version changelog changelog_fetched contributes? contributors creation_date dependencies deprecation_note description details disabled has_changelog icon id installed max_version menu min_version new_repository_format oninstall? onload? onuninstall? onunload? path repository source tags title uuid variant version website menu selected

    Accessors

    name

    Methods

    download extend fetchAbout fetchChangelog getIcon getPluginDetails hasImageIcon install installDependencies isInstallable isReloadable load loadFromFile loadFromURL reload runOnLoad showContextMenu toggleDisabled uninstall unload register

    Constructors

    Properties

    about: string
    about_fetched: boolean
    author: string
    await_loading: boolean
    bug_tracker: string
    cache_version: number
    changelog: PluginChangelog
    changelog_fetched: boolean
    contributes?: { formats?: string[]; open_extensions?: string[] }

    Can be used to specify which features a plugin adds. This allows Blockbench to be aware of and suggest even plugins that are not installed.

    contributors: string[]
    creation_date: string | number
    dependencies: string[]
    deprecation_note: string
    description: string
    details: PluginDetails
    disabled: boolean
    has_changelog: boolean
    icon: string
    id: string
    installed: boolean
    max_version: string
    menu: Menu
    min_version: string
    new_repository_format: boolean
    oninstall?: () => void
    onload?: () => void
    onuninstall?: () => void
    onunload?: () => void
    path: string
    repository: string
    source: PluginSource
    tags: string[]
    title: string
    uuid: string
    variant: PluginVariant
    version: string
    website: string
    menu: Menu
    selected: Plugin

    Accessors

    • get name(): string

      Returns string

    Methods

    • Parameters

      • Optionalfirst: boolean

      Returns Promise<void>

    • Parameters

      • data: any

      Returns this

    • Parameters

      • Optionalforce: boolean

      Returns Promise<void>

    • Parameters

      • Optionalforce: boolean

      Returns Promise<void>

    • Returns string

    • Parameters

      • Optionalforce_refresh: boolean

      Returns PluginDetails

    • Returns boolean

    • Returns Promise<void>

    • Parameters

      • first: any

      Returns Promise<boolean>

    • Returns string | true

    • Returns boolean

    • Parameters

      • Optionalfirst: boolean
      • Optionalcb: (this: Plugin) => void

      Returns Promise<void>

    • Parameters

      • file: FileResult
      • Optionalfirst: boolean

      Returns Promise<Plugin>

    • Parameters

      • url: string
      • Optionalfirst: boolean

      Returns Promise<Plugin>

    • Returns this

    • Returns void

    • Parameters

      • event: MouseEvent

      Returns void

    • Returns void

    • Returns this

    • Returns this

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods