[−][src]Module oxygengine::prelude
Modules
binary | |
changeset | Provides a changeset that can be collected from an iterator. |
error | Specs errors |
hibitset | hibitset |
join | Joining of components for iteration over entities with specific components. |
localization | |
pack | |
prefab | |
set | |
shred | Shared resource dispatcher |
shrev | Event channel, pull based, that use a ringbuffer for internal storage, to make it possible to do immutable reads. |
storage | Component storage types, implementations for component joins, etc. |
text | |
world | Entities, resources, components, and general world management. |
yaml |
Structs
App | |
AppBuilder | |
AppLifeCycle | |
AppRunner | |
Asset | |
AssetPackPreloader | |
AssetsDatabase | |
AssetsSystem | |
BatchAccessor | The |
BatchUncheckedWorld | The |
BinaryAsset | |
BinaryAssetProtocol | |
BitSet | A |
ChangeSet | Change set that can be collected from an iterator, and joined on for easy application to components. |
ComponentContainer | |
DefaultBatchControllerSystem | The |
DefaultLogger | |
DefaultVecStorage | Vector storage, like |
DenseVecStorage | Dense vector storage. Has a redirection 2-way table between entities and components, allowing to leave no gaps within the data. |
Dispatcher | The dispatcher struct, allowing systems to be executed in parallel. |
DispatcherBuilder | Builder for the |
Entity |
|
EntityBuilder | The entity builder, allowing to build an entity together with its components. |
EventChannel | The |
EventIterator | Iterator over a slice of data in |
FetchProcess | |
FlaggedStorage | Wrapper storage that tracks modifications, insertions, and removals of
components through an |
FsFetchEngine | |
FsStorageEngine | |
Grid2d | |
Grid2dNeighborSample | |
HashMapStorage |
|
HierarchyChangeRes | |
ID | Typed Unique Identifier (uuidv4). |
LazyUpdate | Lazy updates can be used for world updates
that need to borrow a lot of resources
and as such should better be done at the end.
They work lazily in the sense that they are
dispatched when calling |
Localization | |
LocalizationAsset | |
LocalizationAssetProtocol | |
LocalizationSystem | |
LoggerAssetsDatabaseErrorReporter | |
MapFetchEngine | |
MapStorageEngine | |
Name | |
NoiseMapGenerator | |
NonPersistent | |
NonPersistentPrefabProxy | |
NullStorage | A null storage type, used for cases where the component doesn't contain any data and instead works as a simple flag. |
PackAsset | |
PackAssetProtocol | |
Parent | |
ParentPrefabProxy | |
PrefabAsset | |
PrefabAssetProtocol | |
PrefabManager | |
PrefabNumber | Represents a YAML number, whether integer or floating point. |
PrefabScene | |
PrefabSceneEntityData | |
PrefabSystem | |
Read | Allows to fetch a resource in a system immutably. |
ReaderId | A reader ID which represents a subscription to the events pushed to the
|
SetAsset | |
SetAssetProtocol | |
StandardAppTimer | |
StaticAccessor | The static accessor that is used for |
Storage | A wrapper around the masked storage and the generations vector.
Can be used for safe lookup of components, insertions and removes.
This is what |
SyncAppRunner | |
Tag | |
TextAsset | |
TextAssetProtocol | |
VecStorage | Vector storage. Uses a simple |
World | A Resource container, which provides methods to insert, access and manage the contained resources. |
Write | Allows to fetch a resource in a system mutably. |
YamlAsset | |
YamlAssetProtocol |
Enums
AccessorCow | Either an |
AssetLoadResult | |
AssetVariant | |
FetchCancelReason | |
FetchStatus | |
Grid2dError | |
LoadStatus | |
Log | |
PrefabError | |
PrefabSceneEntity | |
PrefabValue | Represents any valid YAML value. |
Rule | |
RunningTime | |
StateChange | |
StorageError |
Traits
Accessor | A trait for accessing read/write multiple resources from a system. This can be used to create dynamic systems that don't specify what they fetch at compile-time. |
AppTimer | |
AssetProtocol | |
AssetsDatabaseErrorReporter | |
BackendAppRunner | |
BatchController | The |
Builder | A common trait for |
Component | Abstract component type. Doesn't have to be Copy or even Clone. |
ComponentContainerModify | |
Event | Marker trait for data to use with the EventChannel. |
FetchEngine | |
FetchProcessReader | |
Join | The purpose of the |
Logger | |
Prefab | |
PrefabComponent | |
PrefabProxy | |
Resource | A resource is a data slot which lives in the |
RunNow | Trait for fetching data and running systems. Automatically implemented for systems. |
State | |
StorageEngine | |
System | A |
SystemData | A static system data that can specify its dependencies at statically (at
compile-time). Most system data is a |
Tracked |
|
WorldExt | This trait provides some extension methods to make working with shred's World easier. |
Functions
bundle_installer | |
entity_find_direct | |
entity_find_world | |
hierarchy_find_direct | |
hierarchy_find_world | |
logger_log | |
logger_setup |
Type Definitions
AssetID | |
Entities | A wrapper for a read |
FetchProcessID | |
Grid2dCommonAreas | |
HierarchyRes | |
Meta | |
ReadExpect | Allows to fetch a resource in a system immutably.
This will panic if the resource does not exist.
Usage of |
ReadStorage | A storage with read access. |
Scalar | |
StateToken | |
StorageResult | |
WriteExpect | Allows to fetch a resource in a system mutably.
This will panic if the resource does not exist.
Usage of |
WriteStorage | A storage with read and write access. |
Derive Macros
Ignite | |
SystemData | Used to |