underscript.plugin()

by feildmaster (October 15, 2023)

---

The Plugin API is a service made to allow elevated access to UnderScript’s internals.

Syntax

underscript.plugin(name);

name

Name of plugin (See name restrictions)

Return Value

Returns Plugin object

Methods

plugin.events()

Listen to and emit events.

plugin.logger()

The logger is a way to output to console, prefixing the plugin name to the console output.

plugin.settings()

Provides access to the settings API.

plugin.toast()

Allow plugins to send toasts.

Properties

plugin.name

Output the name of the plugin.

Restrictions

Plugin names have the following restrictions:

1. No two plugins may share the same name
2. Plugin names cant be longer than 20 characters
3. Plugin names can only contain alphanumeric characters and space (A-Z0-9 )

Any plugin names outside these bounds will trigger an error and not create a plugin

---

API Documentation: | UnderScript | Plugin | EventEmitter |