- Mermaids
- Mermaids API
Mermaids API
Build against Mermaids from your own mod. Added in Mermaids v1.4.0.
Ask
isMermaid(ref)isUnderwater(ref)isForcedMermaid(ref)
Change
setForcedMermaid(ref, boolean)
Server settings
ifRequireForcedMermaid()setRequireForcedMermaid(boolean)ifForcedMermaidOnlyInWater()setForcedMermaidOnlyInWater(boolean)
x2 means the call exists as both a Store and a CommandBuffer overload. Full signatures are on Functions.
In this section
- Getting StartedAdd Mermaids to your Maven or Gradle build as a provided, optional dependency.
- FunctionsEvery public MermaidsAPI call, its full signature, and what it returns.
- Source CodeThe annotated source of MermaidsAPI, and a link to it on GitHub.
- Custom Model TextureThe color key and UV layout for painting your own Mermaid tail texture.
Welcome to the Official Mermaids Mod API Docs!
API added with Mermaids v1.4.0. API last updated with Mermaids v2.7.1.
To get started check out Getting Started.
The API is still in development; but if you want to makie your own custom Mermaid model texture, it is available to do.
{ IN DEVELOPMENT }