Differences

This shows you the differences between two versions of the page.

--- en:examples:objects:get_child_object_by_name [2018/05/12 05:50 (7 years ago)] – external edit 127.0.0.1
+++ en:examples:objects:get_child_object_by_name [2024/04/20 16:47 (12 months ago)] (current) – Update to show FindChild functionality, with material from function documentation comment hcarty
@@ Line 1: / Line 1: @@
 ====== Getting a Child Object by Name from a Parent Object ======
-Starting with a parent object, get the first Child Object by name.
+Orx provides a pair of functions for finding objects in an object hierarchy by name. The two functions are ''orxObject_FindChild'' and ''orxObject_FindOwnedChild''. These functions will filter out any camera or spawner and retrieve the child matching the provided path.
-===== Code =====
+==== Paths ====
-<code=c>
+Paths are composed by object names separated by ''.''. A wildcard can be used ''*'' instead of a name to find children at any depth inside the hierarchy, using depth-first search. Lastly, C subscript syntax, ''[N]'', can be used to access the N+1th (indices are 0-based) object matching the path until there.
-orxOBJECT* GetChildObjectByName(orxOBJECT *parentObject, orxSTRING childName) {
-	for (orxOBJECT *pstChild = orxObject_GetOwnedChild(parentObject);
-		pstChild;
-		pstChild = orxObject_GetOwnedSibling(pstChild))
-		{
-			const orxSTRING name = orxObject_GetName(pstChild);
-			if (orxString_Compare(name, childName) == 0) {
-				return pstChild;
-			}
-		}
-	return orxNULL;
-}
-</code>
+For example:
+  * ''orxObject_FindChild(pstObject, "Higher.Lower");'' will find the first child named Lower of the first child named Higher of pstObject
+  * ''orxObject_FindChild(pstObject, "Higher.*.Deep");'' will find the first object named Deep at any depth (depth-first search) under the first child named Higher of pstObject
+  * ''orxObject_FindChild(pstObject, "*.Other[2]");'' will find the third object named Other at any depth under pstObject (depth-first search)
+  * ''orxObject_FindChild(pstObject, "Higher.[1]");'' will find the second child (no matter its name) of the first child named Higher of pstObject

Orx Learning

User Tools

Site Tools

Differences

Page Tools