Package mcp.mobius.waila.api
package mcp.mobius.waila.api
The WTHIT API.
Plugin Definitions
To register the plugin instance, create a file called waila_plugins.json
or wthit_plugins.json
in the root of your mod.
{
// the plugin identifier, [namespace:path]
"yourmodid:plugin": {
"entrypoints" : {
// common entrypoint, will always get called
"common": "package.YourWailaCommonPlugin",
// client entrypoint, only called on client side
"client": "package.YourWailaClientPlugin"
},
// optional, decide the environment the plugin will loaded, options:
// client load plugin only on client and integrated server
// server load plugin only on dedicated server
// * load plugin on both client and dedicated server
"side": "*",
// optional, the required mods that this plugin needs
"required": {
"othermodid": "*", // match any version
"another_one": ">1.2" // match versions newer than 1.2, see below for more details
},
// optional, whether the plugin is enabled by default. defaults to true
"defaultEnabled": true
}
// register multiple plugins!
"yourmodid:another": {...}
}
Version Ranges
Waila only implements primitive operator (<, <=, >, >=, =
) alongside logical and (&&
) and or (||
)
for its version ranges.
- See Also:
-
ClassDescriptionUsed to get some basic data out of the game without having to request direct access to the game engine.Used to provide
Block
/BlockEntity
tooltip information to Waila.The registrar for client-sided objects.Used to get some basic data out of the game without having to request direct access to the game engine.The registrar for common-sided objects.A typed data for syncing complex data.IData.Type<D extends IData>Used to send server-side data to the client.Used to get data synced.Used to sync data.IDataWriter.Result<T extends IData>Used to get some basic data out of the game without having to request direct access to the game engine.Used to provideEntity
tooltip information to Waila.Used to listen to generic Waila events.Registry for attaching object instances to a type and its subtypes.IJsonConfig<T>An Interface for easy (de)serialization for config classesAdds comment for this value.A custom commenter.Used to guess the mod origin of game objects.Read-only interface for Waila internal config storage.Deprecated.no replacement.Decides where Waila will start ray casting for objects.Deprecated.useICommonRegistrar
orIClientRegistrar
instead.Filters registry object based on set of string rules.Used to redirect the targeted objet to other object.Redirection result, only here to make sure it's not called multiple times.A theme that will be used to render the Waila tooltip.IThemeType<T extends ITheme>A description of a theme.IThemeType.Builder<T extends ITheme>The tooltip object that Waila will show.The base type of all Waila tooltip components.A component that will grow in size relative to overall tooltip width.The client side entrypoint for Waila plugins.The common side entrypoint for Waila plugins.Deprecated.useIWailaCommonPlugin
orIWailaClientPlugin
instead.Deprecated.the usage on registrar are replaced with position specific position methodsDeprecated.usewaila_plugins.json
file, seemcp.mobius.waila.api
javadocs for more info.