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

• animation
  Animation functions
• animation_element
  Animation Element module
• asset
  Retrieval of assets and where to find them.
• audioclient
  [Client-only] Audio functionality, including loading sounds and playback.
• camera
  Helper functions for the camera.
• clipboardclient
  [Client-only] Manipulating the operating system’s clipboard.
• core
• 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.
• httpserver
  [Server-only] HTTP-related functionality, including sending requests and receiving responses.
• inputclient
  [Client-only] Input retrieval and manipulation.
• materialclient
  [Client-only] Procedural material generation.
• meshclient
  [Client-only] Procedural mesh generation.
• message
  Messaging to other packages and to the other side of the network boundary.
• package
  Package-related functionality.
• physicsserver
  [Server-only] Physics-related functionality, including applying forces, changing physical properties, and more.
• player
  Player-specific functionality.
• prelude
• samplerclient
  [Client-only] Procedural sampler generation.
• textureclient
  [Client-only] Procedural texture generation.
• windowclient
  [Client-only] Window-specific functionality.

Attribute Macros

• main
  Makes your main() function accessible to the WASM host, and generates a packages module that contain all packages visible to your package, including itself.