-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Zer0EqualsFalse
committed
Nov 5, 2021
1 parent
1b76c2b
commit de19e37
Showing
3 changed files
with
75 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# `Actions` | ||
|
||
###### Extends `API` | ||
|
||
The actions API is meant for registering quick actions that may be useful for | ||
other plugins, or just have the ability to call on the fly. | ||
|
||
| Methods | | ||
| ----------------------------------- | | ||
| [`registerAction`](#registerAction) | | ||
| [`stop`](#stop) | | ||
|
||
## Methods | ||
|
||
### `.registerAction(actionId, executor)` | ||
|
||
Registers an action. | ||
|
||
| Parameter | Type | Description | | ||
| ---------- | -------- | --------------- | | ||
| `actionId` | string | Action ID | | ||
| `executor` | Function | Action executor | | ||
|
||
**Returns: `void`** | ||
|
||
### `.stop()` | ||
|
||
Shuts down the API, removing all listeners and stored objects. | ||
|
||
**Returns: `void`** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# `ApiManager` | ||
|
||
The plugin API. | ||
|
||
| Properties | | ||
| --------------------- | | ||
| [`Actions`](#actions) | | ||
|
||
## Properties | ||
|
||
### `.Actions` | ||
|
||
The actions API is meant for registering quick actions that may be useful for | ||
other plugins, or just have the ability to call on the fly. | ||
|
||
**Type: [`Actions`](./Actions)** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# `$vz` | ||
|
||
A global object. It is recommended to access the API through this object. | ||
|
||
| Properties | | ||
| --------------------- | | ||
| [`api`](#api) | | ||
| [`manager`](#manager) | | ||
| [`modules`](#modules) | | ||
|
||
## Properties | ||
|
||
### `.api` | ||
|
||
The plugin API. | ||
|
||
**Type: [`ApiManager`](./ApiManager)** | ||
|
||
### `.manager` | ||
|
||
An object that contains Vizality's managers. | ||
|
||
**Type: `ManagerManager`** | ||
|
||
### `.modules` | ||
|
||
Miscellaneous tools to aid in plugin development. | ||
|
||
**Type: `ModuleManager`** |