Crate ambient_api
source ·Expand description
The Ambient Rust API
Welcome to the Ambient Rust API! This API allows you to write logic for the Ambient Runtime in Rust.
You can find the Ambient Book at: https://ambientrun.github.io/Ambient/
Ambient has first-class support for Rust. Please report any issues you encounter to the repository.
Re-exports
Modules
- Auto-generated component definitions. These come from
ambient.toml
in the root of the project. - Auto-generated concept definitions. Concepts are collections of components that describe some form of gameplay concept.
- ECS-related functionality not directly related to entities.
- Entity-related functionality, including manipulation, creation, removal, and search.
- Event-related functionality, including sending events and standard events.
- Global functions and types for your convenience.
- Physics-related functionality, including applying forces, changing physical properties, and more.
- Player-related functionality.
- Helpful imports that almost all Ambient projects will use.
Attribute Macros
- Makes your
main()
function accessible to the WASM host, and generates acomponents
module with your project’s components.