Upstream
/
Plan
mirror of https://github.com/plan-player-analytics/Plan.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated APIv5 (markdown)

Risto Lahtela 2019-03-31 16:29:40 +03:00
parent 94f47c3bc8
commit 682d448dd5
1 changed files with 2 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
APIv5.md

@ -19,7 +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)
- API in Action
## Dependency information
@ -632,21 +632,4 @@ 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)
## 🔬 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)
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)