Crate screeps

Expand description

Typed bindings to the Screeps in-game API for WASM Rust AIs.

By default, screeps-game-api assumes that the Screeps JavaScript API calls return the types that they are documented to return and bypasses instanceof checks when constructing rust wrappers for those return values.

To enable checking all types on all API calls, even ones when the screeps server reliably returns the expected type, depend on screeps-game-api with the "check-all-casts" feature flag:

[dependencies]
screeps-game-api = { version = "0.3", features = ["check-all-casts"] }

Re-exports

pub use crate::traits::FromExpectedType;

pub use crate::traits::IntoExpectedType;

pub use crate::constants::*;

pub use crate::objects::*;

Modules

constants

Constants, most copied from the game constants.

game

Get global Screeps resources.

inter_shard_memoryinter-shard-memory

An interface for communicating between shards.

js_collections

Typed JavaScript collection wrappers.

local

Pure-data structures relating to Screeps.

macros

This file groups all macros used throughout the library. Since interop with javascript often gets unwieldy, macros are used extensively to follow DRY principles.

memory

Interface with Screeps’ Memory global variable

objects

Screeps object wrappers.

pathfinder

Manually accessing the PathFinder API

prelude

Traits which implement base functionalities for Screeps types.

raw_memory

Interface for Screeps RawMemory global object.

traits

Useful traits for interacting with JavaScript beyond what stdweb provides.