This repository has been archived by the owner on Mar 4, 2024. It is now read-only.

Plugin Usage

Jump to bottom

RAMENtheNOODLES edited this page Mar 4, 2022 · 2 revisions

Plugin Usage

Commands

Plugin files share all of the commands that a regular story or area file have.

There are some unique commands as well:

Functions
- Example:
  - ```
  func example {
    text: This is an example function!
  }
```
- Usage:
  - ```
  func [function name] {
    [commands]
    ...
  }
```
- The func command allows you to create functions in a plugin file. You can run it from the run command (explained below) or run it from a prompt.
Run
- Example:
  - ```
  run > hello
  
  func hello {
    text: Hello World!
  }
```
- Usage:
  - run > [function name]
- The run command allows you to run a function within a plugin file.