Expand description
Message
functionality.
Structs§
- Message
Cursor - Stores the state for a
MessageReader
orMessageMutator
. - Message
Id - A
MessageId
uniquely identifies a message stored in a specificWorld
. - Message
Iterator - An iterator that yields any unread messages from a
MessageReader
orMessageCursor
. - Message
Iterator With Id - An iterator that yields any unread messages (and their IDs) from a
MessageReader
orMessageCursor
. - Message
MutIterator - An iterator that yields any unread messages from an
MessageMutator
orMessageCursor
. - Message
MutIterator With Id - An iterator that yields any unread messages (and their IDs) from an
MessageMutator
orMessageCursor
. - Message
MutPar Iter - A parallel iterator over
Message
s. - Message
Mutator - Mutably reads messages of type
T
keeping track of which messages have already been read by each system allowing multiple systems to read the same messages. Ideal for chains of systems that all want to modify the same messages. - Message
ParIter - A parallel iterator over
Message
s. - Message
Reader - Reads
Message
s of typeT
in order and tracks which messages have already been read. - Message
Registry - A registry of all of the
Messages
in theWorld
, used bymessage_update_system
to update all of the messages. - Message
Writer - Writes
Message
s of typeT
. - Messages
- A message collection that represents the messages that occurred within the last two
Messages::update
calls. Messages can be written to using aMessageWriter
and are typically cheaply read using aMessageReader
. - Write
Batch Ids Iterator
over writtenMessageIds
from a batch.
Enums§
- Should
Update Messages - Controls whether or not the messages in an
MessageRegistry
should be updated.
Traits§
- Message
- A buffered message for pull-based event handling.
Functions§
- message_
update_ condition - A run condition for
message_update_system
. - message_
update_ system - A system that calls
Messages::update
on all registeredMessages
in the world. - signal_
message_ update_ system - Signals the
message_update_system
to run afterFixedUpdate
systems.
Type Aliases§
- Event
Updates Deprecated - Deprecated alias for [
MessageUpdateSystems
]. - Send
Batch Ids Deprecated Iterator
over sentMessageIds
from a batch.
Derive Macros§
- Message
- Implement the
Message
trait.