Skip to content

feat: add caution admonition for plugin loading phases in Velocity #467

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 17, 2024
Merged

feat: add caution admonition for plugin loading phases in Velocity #467

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/velocity/dev/getting-started/api-basics.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,8 @@ Dependencies on other plugins are also to be specified there, but we'll get to t

### A word of caution

:::caution

In Velocity, plugin loading is split into two steps: construction and initialization. The code in
your plugin's constructor is part of the construction phase. There is very little you can do safely
during construction, especially as the API does not specify which operations are safe to run during
Expand All @@ -114,6 +116,8 @@ public void onProxyInitialization(ProxyInitializeEvent event) {
}
```

:::

## Getting your plugin's directory

At some point you may need your plugin's directory. To do this, add
Expand Down