Register a configuration option.
config key
See ConfigOption
NOTE: options.validator will only notify user about invalid value. It wouldn't stop user from saving invalid value.
Register a contributor.
Contributors will show up in WebUI.
Contributor's name
Contributor's homepage
Register a data file upload entry.
a path (with filename) where the uploaded file will be saved to.
See FileOption
Register a target game code to your plugin for checking savedata.
You should only call this from your plugin's register() function.
Model code of your target machine, usually three capital letters
Register your custom route.
You should only call this from your plugin's register() function.
Method name of your target route,
usually looks like "module.get"
Your custom route function/method following the type EamusePluginRoute.
A boolean can be passed if you don't need any processing:
- true: Sending empty response with status code 0
- false: Sending empty response with status code 1
Register all unhandled routes for a game.
You should only call this from your plugin's register() function.
Your custom route function/method following the type EamusePluginRoute. If undefined, the router will apply a default handler that prints method names.
Register a WebUI event callback
Which can be called in WebUI using emit(event) function or a post message to /emit/<event>
Callback can be async function if you want to use await for your DB operations.
Generated using TypeDoc
R stands for
RegisterThese functions can only be called in plugins'
register()function.