Skip to content

Commit

Permalink
Push changes to test on website
Browse files Browse the repository at this point in the history
  • Loading branch information
Zer0EqualsFalse committed Nov 5, 2021
1 parent 1b76c2b commit de19e37
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 0 deletions.
30 changes: 30 additions & 0 deletions $vz/ApiManager/Actions.mdx
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`**
16 changes: 16 additions & 0 deletions $vz/ApiManager/index.mdx
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)**
29 changes: 29 additions & 0 deletions $vz/index.mdx
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`**

0 comments on commit de19e37

Please sign in to comment.