Module bones_framework::prelude

source ·
Expand description

The prelude.

Re-exports§

Modules§

Macros§

  • Shorthand for combining bitsets with bit_or.
  • Shorthand for setting bits on the bitset container.
  • Implements the BitSet trait members for your type through DerefMut.

Structs§

Enums§

Constants§

  • A fast, non-cryptographic, thread-local random number generator powered by turborand.

Statics§

Traits§

  • Let Path and PathBuf have absolutize and absolutize_virtually method.
  • AssetIo is a trait that is implemented for backends capable of loading all the games assets and returning the raw bytes stored in asset files.
  • A custom assset loader.
  • The BitSet API.
  • This trait factors out functions for iterating with bitset over component store. Separated from impl ComponentStore for usage in generic trait types that must be able to create ComponentBitsetIterator and related types.
  • Provides the context method for Result.
  • Extension trait for the Context that makes it easier to access our lua singletons.
  • A data structure that can be deserialized from any data format supported by Serde.
  • Trait implemented for types that can produce an instance of themselves from a Rust type.
  • Creates an instance of the type this trait is implemented for using data from the supplied World.
  • Trait for plugins that can be installed into a Game.
  • This trait provides the means to easily generate all integer types, provided the main method underpinning this is implemented: GenCore::gen. Once implemented, the rest of the trait provides default implementations for generating all integer types, though it is not recommended to override these.
  • Trait implemented for types that have a [Schema].
  • Converts a function into a System.
  • Helper trait to get a singleton fn pointer for the metatable for a type.
  • A type representing a component-joining entity query.
  • A data structure that can be serialized into any data format supported by Serde.
  • Trait for plugins that can be installed into a Session.
  • A session runner is in charge of advancing a Session simulation.
  • Trait for things that may be used to identify a system stage.
  • Trait implemented by systems.
  • Trait used to implement parameters for System functions.
  • Trait for system stages. A stage is a
  • Extension trait for automatically implementing all TurboRand methods, as long as the struct implements [TurboCore] & GenCore. All methods are provided as default implementations that build on top of [TurboCore] and GenCore, and thus are not recommended to be overridden, lest you potentially change the expected outcome of the methods.
  • Extension trait for Ulid.
  • Helper trait for unwraping each item in an array.
  • Extension trait on top of Value to add helper functions.

Functions§

  • Helper func to construct a OptionalQueryItem wrapping a Comp SystemParam. Used to iterate over enities optionally retrieving components from ComponentStore. Entities iterated over will not be filtered by this QueryItem.
  • Helper func to construct a OptionalQueryItemMut wrapping a CompMut SystemParam. Used to iterate over enities optionally and mutably retrieving components from ComponentStore. Entities iterated over will not be filtered by this QueryItem.
  • Helper function to return type data for a custom asset loader.
  • Creates a bitset big enough to contain the index of each entity. Mostly used to create caches.
  • An ergonomic abbreviation for Default::default() to make initializing structs easier. This is especially helpful when combined with “struct update syntax”.
  • Creates a 2x2 matrix from two column vectors.
  • Creates a 3x3 matrix from three column vectors.
  • Creates a 4x4 matrix from four column vectors.
  • Creates a quaternion from x, y, z and w values.
  • Creates a 2-dimensional vector.
  • Creates a 3-dimensional vector.
  • Creates a 4-dimensional vector.
  • Shortens a type name to remove all module paths.
  • Creates a 2-dimensional vector.
  • Creates a 3-dimensional vector.
  • Creates a 4-dimensional vector.
  • Creates a 2-dimensional vector.
  • Creates a 3-dimensional vector.
  • Creates a 4-dimensional vector.
  • Hints to the compiler that the branch condition is likely to be true. Returns the value passed to it.
  • Install the lua scripting plugin.
  • Creates a 2x2 matrix from two column vectors.
  • Creates a 3x3 matrix from three column vectors.
  • Creates a 4x4 matrix from four column vectors.
  • Creates a 3x3 matrix from three column vectors.
  • Helper function to return type data for a metadata asset.
  • Creates a quaternion from x, y, z and w values.
  • Creates a 2-dimensional vector.
  • Creates a 3-dimensional vector.
  • Creates a 4-dimensional vector.
  • Hints to the compiler that the branch condition is unlikely to be true. Returns the value passed to it.
  • Create a new Ustr from the given &str.
  • Creates a 2-dimensional vector.
  • Creates a 3-dimensional vector.
  • Creates a 4-dimensional vector.
  • Creates a 2-dimensional vector.
  • Creates a 3-dimensional vector.
  • Creates a 4-dimensional vector.
  • Creates a 3-dimensional vector.

Type Aliases§

Derive Macros§