From e9394f0ca1a6cfce51df513a899f406a1d43d172 Mon Sep 17 00:00:00 2001 From: Kristian Knarvik Date: Sat, 30 Oct 2021 06:27:20 +0200 Subject: [PATCH] Add 'API' --- API.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 API.md diff --git a/API.md b/API.md new file mode 100644 index 0000000..a6c88ae --- /dev/null +++ b/API.md @@ -0,0 +1,13 @@ +## API + +Stargate has an API which allows other plugins to interact with available events. +Here is an overview of how the different events can be used: +* The StargateAccessEvent is called whenever a player clicks a stargate's sign, and when a player enters a Stargate. It can be used to override whether the access should be allowed or denied. +* The StargateActivateEvent is called whenever a player activates a stargate (uses the stargate's sign). It can be used to override which destinations are available to the player. +* The StargateCloseEvent is called whenever a stargate is closed. Forcing the stargate closed can be toggled. +* The StargateCreateEvent is called whenever a new stargate is created. Its deny value can be overridden, the cost can be changed +* The StargateDeactivateEvent is called whenever a stargate is deactivated. +* The StargateDestroyEvent is called whenever a stargate is destroyed. Its deny value can be overridden or the cost can be changed. +* The StargateEntityPortalEvent is called whenever an entity teleports through a stargate. The exit location can be changed. +* The StargateOpenEvent is called whenever a stargate is opened. Forcing the stargate open can be toggled. +* The StargatePlayerPortalEvent is called whenever a player teleports through a stargate. The exit location can be changed. \ No newline at end of file