Crate yareio_sys[−][src]
Expand description
Rust bindings for Yare.io bots
This crate uses wasm-bindgen to expose the objects available to
Yare.io bots to Rust.
It’s meant to be used with yareio-rust-template,
which contains custom build scripts necessary to make wasm-bindgen work with Yare.
This crate is documented with Rustdoc.
This crate is compatible with TypeScript, but you will need to use the TypeScript types from
yareio-typescript-typings.
See also yare-rust for an alternative to this crate.
Usage notes
The methods and structs this crate provides map pretty directly to what’s available in JS.
This means they won’t always be idiomatic Rust. For example, Deref-based inheritance is ued extensively;
this is an antipattern for idiomatic
Rust but it’s also the most performant way to represent JS inheritance hierarchies, and it’s what wasm-bindgen uses.
The idiomatic alternative would be to use trait objects, but this would add additional dynamic dispatch on top of what
JS already does, making it slower.
Passing values between WebAssembly and JS is slow, especially when those values aren’t numbers. Generally, any method in this crate that returns a value involves such a transfer of data (functions that return static references don’t). So be careful, and only retrieve the information you need.
For the reasons mentioned in the previous paragraphs, you may want to create you own structs and data structures to store the information you need.
Shape features
To access shape-specific methods like merge(), jump(), and explode(), you’ll need to enable the crate feature
corresponding to the shape you play with in your Cargo.toml. The available shape features are circles, squares,
and triangles.
Prelude
This crate has a prelude module that re-exports the most useful items. You can bulk-import them all with
use yareio_sys::prelude::*;
RenderService bindings
This crate optionally provides bindings for yare-code-sync’s
RenderService, under the render_service module. You will need to enable the crate’s RenderService feature to
use these bindings.
Modules
Provides access to console.log().
Provides access to the built-in graphics methods.
Bindings relating to player IDs.
The most useful items to import.
Provides access to spirits.
Provides access to structures (bases, outposts, and stars).
Macros
Calls console.log() with the given comma-separated list of Into<JsValue> arguments.
Structs
Iterator returned by EnumerateByID’s methods.
The ID of a Destructible.
The ID of an Entity.
Any Destructible that has not yet been destroyed.
The ID of a LivingDestructible.
The ID of a LivingEntity.
The sight of an outpost.
The sight of a spirit or base.
Enums
Traits
This trait is implemented for the global objects that give mappings of IDs to entities:
spirits, bases,
outposts, and stars.
It allows iterating over entities by their ID.
Functions
tick (the number of ticks since the start of the game).