More javadoc

JamesTKhan · Sep 4, 2024 · cc97063 · cc97063
1 parent 57479c3
commit cc97063
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/commons/src/main/com/mbrlabs/mundus/commons/mapper/CustomComponentConverter.java b/commons/src/main/com/mbrlabs/mundus/commons/mapper/CustomComponentConverter.java
@@ -22,9 +22,25 @@
 
 public interface CustomComponentConverter {
 
+    /**
+     * @return The component type of custom component.
+     */
     Component.Type getComponentType();
 
+    /**
+     * Converts component into map for persisting.
+     *
+     * @param component The component.
+     * @return The map.
+     */
     OrderedMap<String, String> convert(Component component);
 
+    /**
+     * Converts map into custom component.
+     *
+     * @param gameObject The game object.
+     * @param componentProperties The properties of custom component.
+     * @return The custom component.
+     */
     Component convert(GameObject gameObject, OrderedMap<String, String> componentProperties);
 }