Skip to content

Commit

Permalink
Update flecs.h
Browse files Browse the repository at this point in the history
  • Loading branch information
Indra-db committed Oct 3, 2023
1 parent 865c660 commit 41503cd
Showing 1 changed file with 3 additions and 28 deletions.
31 changes: 3 additions & 28 deletions flecs.h
Original file line number Diff line number Diff line change
Expand Up @@ -19784,34 +19784,9 @@ struct world {
template <typename T>
flecs::entity set_scope() const;

/**
* @brief Sets the search path for entity lookup operations.
*
* This function configures the search path used for looking up entities. The search path is an array of entity IDs that define the scopes within which lookup operations will search for entities.
*
* @section Best Practices
* - It's advisable to restore the previous search path after making temporary changes.
*
* @section Search Path Evaluation
* - The search path is evaluated starting from the last element of the array.
*
* @section Default Behavior
* - The default search path includes `flecs.core`.
*
* @section Overwriting
* - Providing a custom search path will overwrite the existing search path.
*
* @section Considerations
* - If the custom search path doesn't include `flecs.core`, operations that rely on looking up names from `flecs.core` may fail.
* - The search path array is not managed by the C++ runtime. Ensure the array remains valid for as long as it is used as the search path.
*
* @section Array Termination
* - The provided array must be terminated with a 0 element. This allows for pushing/popping elements onto/from an existing array without needing to call `ecs_set_lookup_path` again.
*
* @param search_path A 0-terminated array of entity IDs defining the new search path.
*
* @return Returns the current search path after the operation.
*/
/** Set search path.
* @see ecs_set_lookup_path
*/
flecs::entity_t* set_lookup_path(const flecs::entity_t *search_path) const {
return ecs_set_lookup_path(m_world, search_path);
}
Expand Down

0 comments on commit 41503cd

Please sign in to comment.