[][src]Module oxygengine::prelude

Modules

asset
binary
changeset

Provides a changeset that can be collected from an iterator.

database
engines
error

Specs errors

join

Joining of components for iteration over entities with specific components.

protocol
protocols
shred

Shared resource dispatcher

storage

Component storage types, implementations for component joins, etc.

system
text
world

Entities, resources, components, and general world management.

Structs

App
AppBuilder
AppLifeCycle
AppRunner
Asset
AssetsDatabase
BitSet

A BitSet is a simple set designed to track which indices are placed into it.

Dispatcher

The dispatcher struct, allowing systems to be executed in parallel.

EmptyState
Entity

Entity type, as seen by the user.

FetchProcess
ID

Universal Identifier (uuidv4).

Parent
Read

Allows to fetch a resource in a system immutably.

ReaderId

The reader id is used by readers to tell the storage where the last read ended.

Resources

A resource container, which provides methods to access to the contained resources.

SetAssetProtocol
StandardAppTimer
StaticAccessor

The static accessor that is used for SystemData.

SyncAppRunner
Tag
Write

Allows to fetch a resource in a system mutably.

Enums

AssetLoadResult
AssetVariant
FetchCancelReason
FetchStatus
LoadStatus
StateChange

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
BackendAppRunner
Component

Abstract component type. Doesn't have to be Copy or even Clone.

FetchEngine
FetchProcessReader
RunNow

Trait for fetching data and running systems. Automatically implemented for systems.

State
System

A System, executed with a set of required Resources.

SystemData

A static system data that can specify its dependencies at statically (at compile-time). Most system data is a SystemData, the DynamicSystemData type is only needed for very special setups.

Functions

bundle_installer

Type Definitions

FetchProcessID
HierarchyRes
Meta
ReadExpect

Allows to fetch a resource in a system immutably. This will panic if the resource does not exist. Usage of Read or Option<Read> is therefore recommended.

WriteExpect

Allows to fetch a resource in a system mutably. This will panic if the resource does not exist. Usage of Write or Option<Write> is therefore recommended.