SpeedSlicer/EaglerForgeInjector
1
0
Fork 0
mirror of https://github.com/eaglerforge/EaglerForgeInjector synced 2025-07-27 15:59:26 -09:00
Code Issues Packages Projects Releases Wiki Activity

add some methods to documentation

Browse Source
This commit is contained in:
ZXMushroom63 2024-09-01 18:10:30 +08:00
parent f4fda26235
commit 232a549ea4
2 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
docs/apidoc/events.md Normal file
View File

16
docs/apidoc/index.md
View File

@ -53,3 +53,19 @@ The global object has the following properties:
- The version of ModAPI. - The version of ModAPI.
- `ModAPI.flavour: String` - `ModAPI.flavour: String`
- The flavour of ModAPI. Hardcoded to be `"injector"`. - The flavour of ModAPI. Hardcoded to be `"injector"`.
The ModAPI object has the following methods:
- `addEventListener(eventName: String, callback: Function) : void`
- More: [EventDocumentation](events.md)
- `require(componentName: String) : void`
- Import required modules, such as `player` and `network`.
- Usage: `ModAPI.require("module")`
- `displayToChat(message: String) : void`
- Displays client-side message to user's ingame chat gui.
- Usage: `ModAPI.displayToChat("Hello World.")`
- `clickMouse() : void`
- Triggers a left click ingame.
- Usage: `ModAPI.clickMouse()`
- `rightClickMouse() : void`
- Triggers a right click ingame.
- Usage: `ModAPI.rightClickMouse()`