Updated APIv5 (markdown)
parent
03218ba0ff
commit
02ec8da0b6
20
APIv5.md
20
APIv5.md
|
@ -19,6 +19,7 @@ API can be called on all platforms.
|
|||
- 📐 [Extra annotations](https://github.com/Rsl1122/Plan-PlayerAnalytics/wiki/APIv5#-extra-annotations)
|
||||
- ❕ [Preventing runtime errors](https://github.com/Rsl1122/Plan-PlayerAnalytics/wiki/APIv5#-preventing-runtime-errors)
|
||||
- Implementation violations
|
||||
- 🔬 [Internals](https://github.com/plan-player-analytics/Plan/wiki/APIv5#-extensionservice-internals)
|
||||
|
||||
## Dependency information
|
||||
|
||||
|
@ -397,4 +398,21 @@ Warnings:
|
|||
|
||||
## API in action
|
||||
|
||||
If you would like to see how the API is being used in built in plugin support, [check out implementations in repositories that start with Extension](https://github.com/plan-player-analytics)
|
||||
If you would like to see how the API is being used in built in plugin support, [check out implementations in repositories that start with Extension](https://github.com/plan-player-analytics)
|
||||
|
||||
## 🔬 ExtensionService Internals
|
||||
|
||||
This section goes into how the DataExtension API has been implemented.
|
||||
|
||||
### Player method calls
|
||||
|
||||
Player methods, the methods with `UUID` or `String` as parameter are called shortly after a player joins the server. If `updatePlayerDataOnLeave` is set to `true` in `@PluginInfo` annotation, the methods are also called when the player leaves the server.
|
||||
|
||||
![player method calls flow](https://user-images.githubusercontent.com/24460436/54934402-1f5cb900-4f27-11e9-8fe5-84642c7eba85.jpg)
|
||||
|
||||
### Server method calls
|
||||
|
||||
Server methods, the methods with no parameters are called shortly after the DataExtension has been registered.
|
||||
If `updateServerDataPeriodically` is set to `true` in `@PluginInfo` annotation, the methods are also called with a fixed interval.
|
||||
|
||||
![server method calls flow](https://user-images.githubusercontent.com/24460436/54934412-2257a980-4f27-11e9-855c-54651015efed.jpg)
|
Loading…
Reference in New Issue