Skinveil Wiki

Registration

Skinveil needs to know about custom equipment before it can give the player a visibility setting for it.

Register your equipment from your client initialization code:

SkinveilApi.registerEquipment(
    MY_EQUIPMENT_ID,
    "My Equipment",
    true
);

The arguments are:

  • Identifier id
    • An unique identifier for your equipment.
    • Use your own mod's namespace. Do not use the skinveil namespace.
  • String displayName
    • The name shown in Skinveil's configuration.
  • boolean defaultVisible
    • Whether the equipment should be visible by default.
    • true means visible, false means hidden.

Registration returns a SkinveilRegistrationResult:

  • SkinveilRegistrationResult.REGISTERED
    • The equipment was registered successfully.
  • SkinveilRegistrationResult.ALREADY_REGISTERED
    • That equipment was already registered.

A registration should normally happen once during client initialization.