Module ryot::bevy_ryot

Bevy plugins and utilities for RyOT games.

This module is intended to be used as a library dependency for RyOT games. It provides common ways of dealing with OT content, such as loading sprites and appearances, configuring the game, and handling asynchronous events.

Modules

• camera
• drawing
• elevation
• map
• perspective
  This module provides functionality for managing and processing perspectives and visibility of entities in a game environment. Perspectives are defined by sets of view points that determine what an entity can see, based on tile positions and other spatial considerations.
• sprites
  Sprite loading and drawing.
• tile_flags
  This module deals with the definition and management of TileFlags, which represent the state of tiles within the game world. These flags are crucial for determining visibility, walkability, and whether a tile blocks sight, among other properties.

Macros

• on_hold_every
  A macro that simplifies the usege of on_hold_every condition by already calling into on the time argument.

Structs

• AnimationDuration
  An optional component to override animation timers.
• Appearance
  Wrapper around the Appearances struct to make it an asset.
• AppearanceAssetLoader
  The loader for the Appearance asset. It reads the file and decodes it from protobuf. See ryot::appearances::VisualElement for more information.
• AppearanceAssetPlugin
  A plugin to register the Appearance asset and its loader.
• BaseContentPlugin
• Cache
  A generic cache structure leveraging HashMap for storing and quickly accessing data. This structure is particularly useful for caching expensive computations, assets, or other data for rapid retrieval.
• Catalog
  An asset that holds a collection of raw content configs.
• EventSender
  A resource that emits asynchronous events of a given type. It’s a bevy friendly wrapper around a std::sync::mpsc::Sender.
• GameObjectBundle
• GamePlugin
• GridView
• LoadObjects
• MetaContentPlugin
• PreparedAppearance
• PreparedAppearances
• RectMeshes
• SpriteMeshes
• TimeArg
  A wrapper for Duration that allows you to define duration from different units. It supports Duration, u64(ms), and &str (e.g. “1s”, “100ms”, “1us”, “1ns”).
• VisualContentPlugin

Enums

• AnimationSystems
• AppearanceGroup
• AppearanceLoaderError
• CacheSystems
  Defines system sets for managing cache-related systems. This enum is used to organize and control the execution order of systems that interact with caches, allowing for a structured update and clean-up process.
• GameObjectId
• InternalContentState
  The states that the content loading process can be in. This is used to track the progress of the content loading process. It’s also used to determine if the content is ready to be used. It’s internally used by the ContentPlugin and should not be manipulated directly. Can be checked by applications to perform actions that depend on the state of the content.
• SpriteSystems

Statics

• GRID_LAYER
• RYOT_ANCHOR

Traits

• AppearanceAssets
• AsyncEventApp
  A trait to add an asynchronous event to an App.
• ContentAssets
  The main ContentAssets of a Ryot game, is prepared by preparer systems during the loading process and is used by the game to access the content.
• OptionalPlugin
  Helper trait to add plugins only if they haven’t been added already. This is useful for external plugins that are used by multiple plugins or dependencies and should only be added once.
• PreloadedAssets
  A trait that represents assets that are preloaded within ryot. It contains preloaded assets and mutable preparation methods for the ContentAssets.
• PreloadedContentAssets
  A trait that represents Preloaded and Content assets. Most of the PreloadedAssets are not directly available to the game. They are only used to prepare the ContentAssets and then discarded. That’s why there is a separation between PreloadedAssets and ContentAssets.

Functions

• entitled_window
  Quick way to create WASM compatible windows with a title.
• on_hold_every
  A condition using leafwing-input-manager that runs the system if an action is pressed or if the action is held down every X duration.
• run_every
  Many times we need to run a system with a cooldown, to avoid running it every frame. Things like drawing, deleting, casting a spell, etc. This function is a helper condition that only runs your system every X duration. Keep in mind that the duration is in game time, not real world time.
• run_every_millis
• run_every_secs
• spawn_grid
  A system to spawn a grid of lines to represent the tiles in the game using a custom color.
• toggle_sprite_animation