Skip to content

AddonAPI

AddonAPI is a utility class for working with plugins and themes. Instances are accessible through the BdApi.

Properties

folder

The path to the addon folder.

Type: string


Methods

disable

Disables the given addon.

ParameterTypeDescription
idOrFilestringAddon ID or filename

Returns: void


enable

Enables the given addon.

ParameterTypeDescription
idOrFilestringAddon ID or filename

Returns: void


get

Gets a particular addon.

ParameterTypeDescription
idOrFilestringAddon ID or filename

Returns: object - Addon instance


getAll

Gets all addons of this type.

Returns: Array.<object> - Array of all addon instances


isEnabled

Determines if a particular addon is enabled.

ParameterTypeDescription
idOrFilestringAddon ID or filename

Returns: boolean


reload

Reloads if a particular addon is enabled.

ParameterTypeDescription
idOrFilestringAddon ID or filename

Returns: void


toggle

Toggles if a particular addon is enabled.

ParameterTypeDescription
idOrFilestringAddon ID or filename

Returns: void