SimpleAppState: javadoc

capdevon · Mar 7, 2024 · 7dc6bf3 · 7dc6bf3
1 parent caf3562
commit 7dc6bf3
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/src/main/java/com/capdevon/engine/SimpleAppState.java b/src/main/java/com/capdevon/engine/SimpleAppState.java
@@ -64,10 +64,12 @@ public PhysicsSpace getPhysicsSpace() {
     }
 
     /**
-     * Finds a GameObject by name and returns it.
+     * Attempts to find a child spatial with the specified 
+     * name within the scene's root node.
      *
-     * @param childName
-     * @return
+     * @param childName The name of the child spatial to search for.
+     * @return The found child spatial if successful.
+     * @throws NullPointerException if no child with the specified name is found.
      */
     public Spatial find(String childName) {
         Spatial child = rootNode.getChild(childName);