Struct RobloxStudioOpener

Source

pub struct RobloxStudioOpener { /* private fields */ }

Expand description

A builder to open a Roblox Studio instance through the official binary, while also properly handling its CLI arguments and intricacies.

Implementations§

Source §

impl RobloxStudioOpener

Source

pub fn new() -> Self

Create a new Roblox Studio opener.

Examples found in repository ?

examples/open_file.rs (line 6)

3pub fn main() -> Result<(), Box<dyn std::error::Error>> {
4    let file_path = "my_place_file.rbxl";
5
6    RobloxStudioOpener::new().open_file(file_path)?.run()?;
7
8    Ok(())
9}

More examples

Hide additional examples

examples/start_server.rs (line 6)

3pub fn main() -> Result<(), Box<dyn std::error::Error>> {
4    let file_path = "my_place_file.rbxl";
5
6    RobloxStudioOpener::new().start_server(file_path)?.run()?;
7
8    Ok(())
9}

examples/start_client.rs (line 6)

3pub fn main() -> Result<(), Box<dyn std::error::Error>> {
4    // NOTE: A server must already be running for this to work
5
6    RobloxStudioOpener::new().start_client().run()?;
7
8    Ok(())
9}

examples/open_online_place.rs (line 7)

3pub fn main() -> Result<(), Box<dyn std::error::Error>> {
4    let universe_id: u64 = 123456789;
5    let place_id: u64 = 234567890;
6
7    RobloxStudioOpener::new()
8        .open_place(universe_id, place_id)
9        .run()?;
10
11    Ok(())
12}

examples/start_server_with_clients.rs (line 7)

3pub fn main() -> Result<(), Box<dyn std::error::Error>> {
4    let file_path = "my_place_file.rbxl";
5    let num_clients = 4;
6
7    RobloxStudioOpener::new()
8        .start_server_with_clients(file_path, num_clients)?
9        .run()?;
10
11    Ok(())
12}

Source

pub fn with_server_addr<A>(self, server_addr: A) -> Self
where A: Into<Ipv4Addr>,

Sets a custom server address to use with the start_server, start_server_with_place, or start_client methods.

Defaults to localhost (127.0.0.1).

Source

pub fn with_server_port(self, server_port: u16) -> Self

Sets a custom server port to use with the start_server, start_server_with_place, or start_client methods.

Defaults to port 50608.

Source

pub fn open_place(self, universe_id: u64, place_id: u64) -> Self

Edit an online place in Roblox Studio.

This will open the place with the given universe_id and place_id.

Examples found in repository ?

examples/open_online_place.rs (line 8)

3pub fn main() -> Result<(), Box<dyn std::error::Error>> {
4    let universe_id: u64 = 123456789;
5    let place_id: u64 = 234567890;
6
7    RobloxStudioOpener::new()
8        .open_place(universe_id, place_id)
9        .run()?;
10
11    Ok(())
12}

Source

pub fn open_file(self, file_path: P) -> RobloxStudioResult<Self>
where P: AsRef<Path>,

Edit a local place file in Roblox Studio.

This will open the place file at the given file_path.

§Errors

If the given file_path cannot be canonicalized.
If the given file_path cannot be converted to a string.

Examples found in repository ?

examples/open_file.rs (line 6)

3pub fn main() -> Result<(), Box<dyn std::error::Error>> {
4    let file_path = "my_place_file.rbxl";
5
6    RobloxStudioOpener::new().open_file(file_path)?.run()?;
7
8    Ok(())
9}

Source

pub fn start_server(self, file_path: P) -> RobloxStudioResult<Self>
where P: AsRef<Path>,

Start a server in Roblox Studio with the given place file.

This will copy the place file at the given file_path to the Roblox server file, and then start the server.

§Errors

If the local data directory cannot be found.
If the given place file cannot be copied to the local data directory.

Examples found in repository ?

examples/start_server.rs (line 6)

3pub fn main() -> Result<(), Box<dyn std::error::Error>> {
4    let file_path = "my_place_file.rbxl";
5
6    RobloxStudioOpener::new().start_server(file_path)?.run()?;
7
8    Ok(())
9}

Source

pub fn start_server_with_clients( self, file_path: P, num_clients: u8, ) -> RobloxStudioResult<Self>
where P: AsRef<Path>,

Start a server in Roblox Studio with the given place file and clients.

This will also automatically start the given number of clients.

See start_server for more information.

Examples found in repository ?

examples/start_server_with_clients.rs (line 8)

3pub fn main() -> Result<(), Box<dyn std::error::Error>> {
4    let file_path = "my_place_file.rbxl";
5    let num_clients = 4;
6
7    RobloxStudioOpener::new()
8        .start_server_with_clients(file_path, num_clients)?
9        .run()?;
10
11    Ok(())
12}

Source

pub fn start_client(self) -> Self

Starts a single client, connecting to an already launched server.

See start_server for more information.

Examples found in repository ?

examples/start_client.rs (line 6)

3pub fn main() -> Result<(), Box<dyn std::error::Error>> {
4    // NOTE: A server must already be running for this to work
5
6    RobloxStudioOpener::new().start_client().run()?;
7
8    Ok(())
9}

Source

pub fn run(self) -> RobloxStudioResult<()>

Starts Roblox Studio with all of the given arguments.

Note that this will not wait for Roblox Studio to actually open the file/server/client - it only guarantees that the process has been spawned and that it has received the necessary arguments.

§Errors

If the Roblox Studio executable cannot be found.

Examples found in repository ?

examples/open_file.rs (line 6)

3pub fn main() -> Result<(), Box<dyn std::error::Error>> {
4    let file_path = "my_place_file.rbxl";
5
6    RobloxStudioOpener::new().open_file(file_path)?.run()?;
7
8    Ok(())
9}

More examples

Hide additional examples

examples/start_server.rs (line 6)

3pub fn main() -> Result<(), Box<dyn std::error::Error>> {
4    let file_path = "my_place_file.rbxl";
5
6    RobloxStudioOpener::new().start_server(file_path)?.run()?;
7
8    Ok(())
9}

examples/start_client.rs (line 6)

3pub fn main() -> Result<(), Box<dyn std::error::Error>> {
4    // NOTE: A server must already be running for this to work
5
6    RobloxStudioOpener::new().start_client().run()?;
7
8    Ok(())
9}

examples/open_online_place.rs (line 9)

3pub fn main() -> Result<(), Box<dyn std::error::Error>> {
4    let universe_id: u64 = 123456789;
5    let place_id: u64 = 234567890;
6
7    RobloxStudioOpener::new()
8        .open_place(universe_id, place_id)
9        .run()?;
10
11    Ok(())
12}

examples/start_server_with_clients.rs (line 9)

3pub fn main() -> Result<(), Box<dyn std::error::Error>> {
4    let file_path = "my_place_file.rbxl";
5    let num_clients = 4;
6
7    RobloxStudioOpener::new()
8        .start_server_with_clients(file_path, num_clients)?
9        .run()?;
10
11    Ok(())
12}