Module ambient_api::prelude::entity

Manipulation, creation, removal, search and more for entities.

Structs

• RawTransforms
  Unconverted bindgen transforms

Functions

• add_child
  Adds child as a child to entity.
• add_component
  Adds the component component for entity with value. Will replace an existing component if present.
• add_component_if_required
  Adds the component with value to entity if entity does not already have that component.
• add_components
  Adds the components components for entity with value. Will replace any existing components specified in components.
• despawn
  Despawns entity from the world. entity will not work with any other functions afterwards.
• despawn_recursive
  Despawns entity and all of its children.
• exists
  Checks if the entity exists.
• get_all
  Gets all of the entities that have the given component.
• get_all_components
  Retrieves all guest-visible components for entity. Will return an empty Entity if no components are found.
• get_component
  Retrieves the component component for entity if it exists, or None if it doesn’t.
• get_components
  Retrieves the components components for entity. Will return an empty Entity if no components are found.
• get_transforms_relative_to
  Gets a list of world transforms relative to origin entity Origin can be null entity for a list of world transforms
• has_component
  Checks if the entity has a component.
• has_components
  Checks if the entity has components.
• in_area
  Gets all of the entities within radius of position.
• mutate_component
  Mutates the component component for entity using the passed in mutator, and returns its value.
• mutate_component_with_default
  Mutates the component component for entity using the passed in mutator, or sets it to default if it doesn’t exist, and returns its value.
• persisted_resources
  Gets the persisted resource entity. The components of this entity contain global state that should be networked and persisted.
• remove_child
  Removes child as a child to entity.
• remove_component
  Removes the component from entity.
• remove_components
  Removes the components from entity.
• resources
  Gets the resource entity. The components of this entity contain global state for this ECS world.
• set_component
  Sets the component component for entity with value.
• set_component_if_changed
  Sets the component component for entity with value if the new value is different from the current value
• set_components
  Sets the components components for entity with value.
• spawn
  Spawns an entity containing the components.
• synchronized_resources
  Gets the synchronized resource entity. The components of this entity contain global state that should be networked, but not persisted.
• wait_for_component
  Waits until id has the component. If the entity was deleted, the method returns None.