Cosmetic API — methods and examples
Use equip(), clear() and clearAll() for player visual selections. selected() lists active cosmetics. Do not mistake cosmetic visuals for changes to actual gameplay armor.
What methods are available?
List<CosmeticView> all();Optional<CosmeticView> find(String id);boolean equip(Player player, String id);boolean clear(Player player, String slot);int clearAll(Player player);Map<String, CosmeticView> selected(Player player);String visualProvider();
These signatures are read directly from the public ObsidrelAPI 1.0 service interface. An Optional result can be empty, boolean results can indicate failure and views are public read-only projections rather than mutable Core objects.
Practical steps
- Add ObsidrelAPI as a
provided(Maven) orcompileOnly(Gradle) dependency. 2. Check Obsidrel is running and fetchObsidrelProvider.require(1). 3. Call the matching service with an ID that is already loaded. 4. Handle missing values and failures before showing messages to players. 5. Test on a staging server with the exact Core version.
Troubleshooting
If lookup fails, check the resource ID and whether it loaded in Core. If provider lookup fails, confirm the plugin dependency, Core startup and API level. Do not link to private implementation classes; the supported contract is the public me.antzbr.obsidrel.api.* package.
See: API setup · Service catalog.