From 712c98bb6b2f5ff7ee5819a47249c3db99db16d8 Mon Sep 17 00:00:00 2001 From: Sollace Date: Thu, 19 Jul 2018 22:21:41 +0200 Subject: [PATCH] Docs --- .../voxelmodpack/hdskins/ISkinCacheClearListener.java | 3 +++ .../java/com/voxelmodpack/hdskins/ISkinModifier.java | 10 +++++++++- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/src/hdskins/java/com/voxelmodpack/hdskins/ISkinCacheClearListener.java b/src/hdskins/java/com/voxelmodpack/hdskins/ISkinCacheClearListener.java index d1a21d0f..67335bee 100644 --- a/src/hdskins/java/com/voxelmodpack/hdskins/ISkinCacheClearListener.java +++ b/src/hdskins/java/com/voxelmodpack/hdskins/ISkinCacheClearListener.java @@ -1,5 +1,8 @@ package com.voxelmodpack.hdskins; +/** + * Callback to perfom additional actions when the skin cache is cleared. + */ @FunctionalInterface public interface ISkinCacheClearListener { boolean onSkinCacheCleared(); diff --git a/src/hdskins/java/com/voxelmodpack/hdskins/ISkinModifier.java b/src/hdskins/java/com/voxelmodpack/hdskins/ISkinModifier.java index a29d1d4b..b0e0cc89 100644 --- a/src/hdskins/java/com/voxelmodpack/hdskins/ISkinModifier.java +++ b/src/hdskins/java/com/voxelmodpack/hdskins/ISkinModifier.java @@ -3,8 +3,16 @@ package com.voxelmodpack.hdskins; import java.awt.Graphics; import java.awt.image.BufferedImage; +/** + * Interface for mods to convert player skins before loading. + */ @FunctionalInterface public interface ISkinModifier { - + /** + * Called to convert the given skin. + * + * @param skin The skin being converted + * @param dest Graphics for drawing onto the image + */ void convertSkin(BufferedImage skin, Graphics dest); }