Struct omegga::Omegga

pub struct Omegga {
    pub awaiter_txs: Arc<DashMap<RequestId, Sender<Response>>>,
    // some fields omitted
}

Fields

awaiter_txs: Arc<DashMap<RequestId, Sender<Response>>>

Implementations

impl Omegga

pub fn new() -> Self

Create a new Omegga instance.

pub fn spawn(&self) -> RpcEventReceiver

Spawn the listener.

pub fn write(&self, message: Message)

Write out an RPC message.

pub fn write_notification(
    &self,
    method: impl Into<String>,
    params: Option<Value>
)

Write out an RPC notification.

pub fn write_response(
    &self,
    id: RequestId,
    params: Option<Value>,
    error: Option<Error>
)

Write out an RPC response.

pub fn write_request(
    &self,
    id: RequestId,
    method: impl Into<String>,
    params: Option<Value>
)

Write out an RPC request.

Note: This does not internally expect a response from the server. Prefer using request over this for the ability to await a response from the RPC server.

pub fn request(
    &self,
    method: impl Into<String>,
    params: Option<Value>
) -> ResponseAwaiter

Request a response from the RPC server. This returns a ResponseAwaiter, a Future that awaits a response.

pub fn log(&self, line: impl Into<String>)

Prints a message to the Omegga console.

pub fn error(&self, line: impl Into<String>)

Prints a message to the Omegga console in error color.

pub fn info(&self, line: impl Into<String>)

Prints a message to the Omegga console in info color.

pub fn warn(&self, line: impl Into<String>)

Prints a message to the Omegga console in warn color.

pub fn trace(&self, line: impl Into<String>)

Prints a message to the Omegga console in trace color.

pub async fn store_get(
    &self,
    key: impl Into<String>
) -> Result<Option<Value>, ResponseError>

Gets an object from the store.

pub fn store_set(&self, key: impl Into<String>, value: Value)

Sets an object in the store.

pub async fn store_delete(&self, key: impl Into<String>)

Deletes an object from the store.

pub fn store_wipe(&self)

Wipes the store.

pub async fn store_keys(&self) -> Result<Vec<String>, ResponseError>

Gets a list of keys in the store.

pub fn writeln(&self, line: impl Into<String>)

Writes a line out to the Brickadia server.

pub fn broadcast(&self, line: impl Into<String>)

Broadcasts a line.

pub fn whisper(&self, username: impl Into<String>, line: impl Into<String>)

Whispers a line to a user by their name.

pub async fn get_players(&self) -> Result<Vec<Player>, ResponseError>

Gets a list of all players.

pub async fn get_all_player_positions(
    &self
) -> Result<Vec<PlayerPosition>, ResponseError>

Get all player positions.

pub async fn get_role_setup(&self) -> Result<Value, ResponseError>

Get the role setup.

pub async fn get_ban_list(&self) -> Result<Value, ResponseError>

Get the ban list.

pub async fn get_saves(&self) -> Result<Vec<String>, ResponseError>

Get a list of the server’s saves.

pub async fn get_save_path(
    &self,
    save: impl Into<String>
) -> Result<Option<String>, ResponseError>

Get the path to a specific save.

pub async fn get_save_data(&self) -> Result<SaveData, ResponseError>

Gets the server’s current save data as a brickadia-rs save object.

pub fn clear_bricks(&self, target: impl Into<String>, quiet: bool)

Clears a player’s bricks by their name.

pub fn clear_all_bricks(&self, quiet: bool)

Clear all bricks.

pub async fn save_bricks(
    &self,
    name: impl Into<String>
) -> Result<(), ResponseError>

Save bricks to a named save.

pub async fn load_bricks(
    &self,
    name: impl Into<String>,
    quiet: bool,
    offset: (i32, i32, i32)
) -> Result<(), ResponseError>

Load a save, provided an offset in the world.

pub async fn read_save_data(
    &self,
    name: impl Into<String>
) -> Result<Option<SaveData>, ResponseError>

Reads a save (from a save file), and returns its data as a brickadia-rs save object.

pub async fn load_save_data(
    &self,
    data: SaveData,
    quiet: bool,
    offset: (i32, i32, i32)
) -> Result<(), ResponseError>

Loads a save (from brickadia-rs save data) into the world, provided an offset.

pub async fn change_map(
    &self,
    map: impl Into<String>
) -> Result<(), ResponseError>

Changes the map.

pub async fn get_player(
    &self,
    target: impl Into<String>
) -> Result<Option<Player>, ResponseError>

Get a player.

pub async fn get_player_roles(
    &self,
    target: impl Into<String>
) -> Result<Option<Vec<String>>, ResponseError>

Get a player’s roles.

pub async fn get_player_permissions(
    &self,
    target: impl Into<String>
) -> Result<Value, ResponseError>

Get a player’s permissions.

pub async fn get_player_name_color(
    &self,
    target: impl Into<String>
) -> Result<Option<String>, ResponseError>

Get a player’s name color (6-digit hexadecimal).

pub async fn get_player_position(
    &self,
    target: impl Into<String>
) -> Result<Option<(f64, f64, f64)>, ResponseError>

Get a player’s position.

pub async fn get_player_ghost_brick(
    &self,
    target: impl Into<String>
) -> Result<Option<GhostBrick>, ResponseError>

Get a player’s ghost brick data.

pub async fn get_player_paint(
    &self,
    target: impl Into<String>
) -> Result<Option<PlayerPaint>, ResponseError>

Get a player’s paint data.

pub async fn get_player_template_bounds(
    &self,
    target: impl Into<String>
) -> Result<Option<TemplateBounds>, ResponseError>

Get a player’s template bounds.

pub async fn get_player_template_bounds_data(
    &self,
    target: impl Into<String>
) -> Result<Option<SaveData>, ResponseError>

Get a player’s template data as a brickadia-rs save object.

pub async fn load_data_at_ghost_brick(
    &self,
    target: impl Into<String>,
    data: SaveData,
    offset: (i32, i32, i32),
    rotate: bool,
    quiet: bool
) -> Result<(), ResponseError>

Load brickadia-rs save data at a player’s template.

Trait Implementations

impl Default for Omegga

fn default() -> Self

Returns the “default value” for a type.