Crate ambient_api

The Ambient Rust API

Welcome to the Ambient Rust API! This API allows you to write logic for Ambient, the multiplayer game engine, in Rust.

The Ambient Book can be found here.

Ambient has first-class support for Rust. Please report any issues you encounter to the repository.

Re-exports

• pub use ambient_cb as cb;
• pub use ambient_editor_derive as editor_derive;
• pub use ambient_element as element;
• pub use ambient_ui as ui;
• pub use anyhow;
• pub use futures;
• pub use glam;
• pub use once_cell;
• pub use rand;

Modules

• asset
  Retrieval of assets and where to find them.
• audio
  [Client-only] Audio functionality, including loading sounds and playback.
• camera
  [Client-only] Helper functions for the camera.
• components
  Auto-generated component definitions. These come from ambient.toml in the root of the project.
• concepts
  Auto-generated concept definitions. Concepts are collections of components that describe some form of gameplay concept.
• ecs
  ECS-related functionality not directly related to entities.
• entity
  Manipulation, creation, removal, search and more for entities.
• global
  Global functions and types for your convenience.
• input
  [Client-only] Input retrieval and manipulation.
• message
  Messaging to other modules and to the other side of the networking.
• messages
  Auto-generated message definitions. Messages are used to communicate with the runtime, the other side of the network, and with other modules.
• physics
  [Server-only] Physics-related functionality, including applying forces, changing physical properties, and more.
• player
  Player-specific functionality.
• prelude
• window
  [Client-only] Window-specific functionality.

Attribute Macros

• main
  Makes your main() function accessible to the WASM host, and generates components and concept modules for your project.