Crate ambient_ecs

Source

Re-exports§

pub use component::Component;
pub use component::ComponentDesc;
pub use component::ComponentValue;
pub use component::ComponentValueBase;
pub use generated::components::core::ecs::*;

Modules§

component
generated

Macros§

components
Defines components to use within the ECS.

Structs§

Archetype
ArchetypeFilter
ArchetypeInfo
Debug information of an archetype
AttributeStore
ChangedQuery
Commands
ComponentDeserializer
ComponentEntry
Represents a type erased component and value
ComponentRegistry
ComponentSet
ComponentVTable
Holds untyped information for everything a component can do
DBEventId
DebugWorldArchetypes
Debuggable
DefaultValue
Provides a default for this component that will work with MakeDefault.
Description
A user-friendly description. (e.g. “The player’s health from 0 to 1.”)
DeserEntityDataWithWarnings
Use this struct while de-serializing an EntityData to also get warnings about missing/bad components. Only works with serde_json
DeserWorldWithWarnings
Use this struct while de-serializing a World to also get warnings about missing/bad components. Only works with json.
ECSDeserializationWarnings
Entity
EntityId
EntityIdHashBuilder
EntityIdHasher
This just pipes a u64 value through
EntityLocation
EntityMoveData
External
Indicates that this component was externally added.
ExternalComponentAttributes
ExternalComponentDesc
ExternalComponentFlagAttributes
FnSystem
FrameEvent
FramedEvents
Events packed into a FIFO frame queue
FramedEventsIterator
FramedEventsReader
Index
An ECS entity index
IndexColumns
IndexFieldValue
IndexKey
MakeDefault
Allows constructing a default value of the type
MaybeResource
Indicates that this component can be used as a resource or component.
Name
A user-friendly name annotation, as opposed to the ID. (e.g. “Player Health” vs “player_health”).
Networked
Synchronize the component over the network to the clients
PrimitiveComponent
Query
QueryState
Resource
Indicates that this component should be used as a resource only.
Serializable
Declares a component as serde::Serialize and serde::Deserialize
Store
Store the component on disk
SystemGroup
TypedReadQuery
TypedReadWriteQuery
World
WorldDiff
WorldEventsSystem
WorldStream
WorldStreamFilter

Enums§

Command
ECSError
EntityAccessor
IndexField
IndexIdField
MessageSerdeError
Error that can occur during message ser/de.
PrimitiveComponentContainerType
PrimitiveComponentType
QueryEvent
WorldChange
WorldStreamCompEvent

Statics§

COMPONENT_ENTITY_ID_MIGRATERS
TYPE_ID_TO_PRIMITIVE_TYPE

Traits§

AttributeConstructor
Initializes the attribute
ComponentAttribute
Represents a single attribute attached to a component
ComponentQuery
ComponentsTupleAppend
IndexExt
Message
Implemented on all types that can be de/serialized from/to a Vec<u8>.
MessageSerde
Implemented for all types that can be serialized in a message.
RuntimeMessage
Implemented on all messages that come from the runtime.
System
WorldEventsExt

Functions§

ensure_has_component
ensure_has_component_with_default
ensure_has_component_with_make_default
Uses the MakeDefault attribute. Will panic if this attribute is not present.
index_system
Creates and maintains an ECS Index as a resource on the world
init_components
query
query_mut
with_component_registry
world_events

Type Aliases§

ArchetypeId
AttributeGuard
AttributeStoreGuard
AttributeStoreGuardMut
DynSystem
WorldEventReader
WorldEvents