#roblox #dom #weak

rbx_dom_weak

Weakly-typed Roblox DOM implementation for Rust

17 stable releases

2.3.0 Oct 11, 2021
2.2.0 Jul 19, 2021
2.0.0 Jun 27, 2021
2.0.0-alpha.1 Feb 16, 2021
0.3.1 Feb 26, 2019

#3 in #roblox

Download history 161/week @ 2021-07-07 235/week @ 2021-07-14 166/week @ 2021-07-21 199/week @ 2021-07-28 262/week @ 2021-08-04 244/week @ 2021-08-11 159/week @ 2021-08-18 201/week @ 2021-08-25 151/week @ 2021-09-01 192/week @ 2021-09-08 169/week @ 2021-09-15 94/week @ 2021-09-22 155/week @ 2021-09-29 235/week @ 2021-10-06 129/week @ 2021-10-13 129/week @ 2021-10-20

810 downloads per month
Used in 8 crates (6 directly)

MIT license

120KB
3K SLoC

rbx_dom_weak

rbx_dom_weak on crates.io rbx_dom_weak docs

More details about this crate are available on the rbx-dom GitHub.

Weakly-typed implementation of Roblox's DOM, used for representing instances in external tools.

Coverage

Because rbx_dom_weak is weakly-typed, it doesn't need to be updated when new instances are added to Roblox. It does, however, have to be updated when new datatypes like Vector3int16 are added.


lib.rs:

rbx_dom_weak is a common representation of the Roblox DOM for Rust. It's designed to play nicely with the borrow checker and allows accessing instances by ID in constant time.

Constructing a new tree of instances is accomplished by first creating an [InstanceBuilder] object that describes a tree of instances and then wrapping it with an [WeakDom]:

use rbx_dom_weak::{InstanceBuilder, WeakDom};

let dm = InstanceBuilder::new("DataModel");

let mut dom = WeakDom::new(dm);

println!("ID of DOM root is {:?}", dom.root_ref());

Once we have a tree, we can use [WeakDom::insert] and [WeakDom::get_by_ref] to add instances to the tree and retrieve them.

use rbx_dom_weak::{InstanceBuilder, WeakDom};

let mut dom = WeakDom::new(InstanceBuilder::new("DataModel"));

// We can define properties using any type that can be converted to an
// rbx_dom_weak::types::Variant.
let http_service = InstanceBuilder::new("HttpService")
    .with_property("HttpEnabled", true);

let http_service_id = dom.insert(dom.root_ref(), http_service);

println!("HttpService has ID {:?}", http_service_id);

To change properties on an instance that's already present in the tree, use [WeakDom::get_by_ref_mut]. Note that it isn't possible to add or remove children through this method, use [WeakDom::insert] and [WeakDom::destroy] instead.

Dependencies

~3.5MB
~86K SLoC