Module ambient_api::ecs

ECS-related functionality not directly related to entities.

Structs

• ChangeQuery
  A partially-built ECS query that calls a callback when entities containing components marked with Self::track_change have those components change.
• Component
  A component (piece of entity data). See entity::get_component and entity::set_component.
• ConceptQuery
  Helper that lets you pass in concepts where component tuples are expected.
• Entity
  An Entity is a collection of components and associated values.
• EventQuery
  An ECS query that calls a callback when its associated event occurs.
• GeneralQuery
  An ECS query used to find entities in the world.
• GeneralQueryBuilder
  Build a GeneralQuery for the ECS. This is how you find entities in the game world.
• UntrackedChangeQuery
  An ECS query that will call a callback when entities containing components marked with Self::track_change have those components change. This type represents a query that has not had any components marked for tracking yet.

Enums

• ComponentOptionValue
  An option value that can be stored in a component.
• ComponentValue
  A value that can be stored in a component.
• ComponentVecValue
  A vector value that can be stored in a component.
• QueryEvent
  When this EventQuery should return results.
• WitComponentValue

Traits

• ComponentsTuple
  A tuple of Components.
• Concept
  Concepts are defined in the package manifest, and are used to define a collection of components that correspond to some concept in the game world.
• ConceptComponents
  Provides component tuples for this concept.
• ConceptSuggested
  Provides a helper method to get an instance of this concept with all of the fields filled in with suggested values.
• EnumComponent
  Implemented for component values that can be used as an enum
• SupportedValue
  Implemented by all types that can be used as values in components.
• UntypedComponent
  Implemented by all Components.

Functions

• change_query
  Creates a new ChangeQuery that will find entities that have the specified components that will call its bound function when components marked by ChangeQuery::track_change change.
• despawn_query
  Creates a new EventQuery that will find entities that have the specified components that will call its bound function when an entity with those components are despawned / seen for the last time by this query.
• query
  Creates a new GeneralQueryBuilder that will find entities that have the specified components and can be built to create a GeneralQuery.
• spawn_query
  Creates a new EventQuery that will find entities that have the specified components that will call its bound function when an entity with those components are spawned / seen for the first time by this query.