Enum Apps

pub enum Apps {
    Client {
        app: App,
        config: ClientConfig,
    },
    Server {
        app: App,
        config: ServerConfig,
    },
    ClientAndServer {
        client_app: App,
        client_config: ClientConfig,
        server_app: App,
        server_config: ServerConfig,
    },
    HostServer {
        app: App,
        client_config: ClientConfig,
        server_config: ServerConfig,
    },
}

Apps that will be returned from the build_apps function

The configs are also included so that the user can modify them if needed, before running the app.

Variants

Client

A single app that contains only the ClientPlugins

Fields

app: App

config: ClientConfig

Server

A single app that contains only the ServerPlugins

Fields

app: App

config: ServerConfig

ClientAndServer

Two apps (Client and Server) that will run in separate threads

Fields

client_app: App

client_config: ClientConfig

server_app: App

server_config: ServerConfig

HostServer

A single app that contains both the Client and Server plugins

Fields

app: App

client_config: ClientConfig

server_config: ServerConfig

Implementations

impl Apps

pub fn new(settings: Settings, cli: Cli, name: String) -> Self

Build the apps with the given settings and CLI options.

pub fn add_lightyear_plugins(&mut self) -> &mut Self

Add the lightyear [ClientPlugins] and [ServerPlugins] plugin groups to the app.

This can be called after any modifications to the ClientConfig and ServerConfig have been applied.

pub fn add_user_client_plugin( &mut self, client_plugin: impl Plugin, ) -> &mut Self

Adds plugin to the client app

pub fn add_user_server_plugin( &mut self, server_plugin: impl Plugin, ) -> &mut Self

Adds plugin to the server app

pub fn add_user_shared_plugin( &mut self, shared_plugin: impl Plugin + Clone, ) -> &mut Self

Adds plugin to both the server and client apps, if present

pub fn add_user_renderer_plugin( &mut self, renderer_plugin: impl Plugin, ) -> &mut Self

Adds to the client app, and the server app if in standalone server mode with the cargo “gui” feature. Won’t add renderer to server app if a client app also present.

pub fn update_lightyear_client_config( &mut self, f: impl FnOnce(&mut ClientConfig), ) -> &mut Self

Apply a function to update the ClientConfig

pub fn update_lightyear_server_config( &mut self, f: impl FnOnce(&mut ServerConfig), ) -> &mut Self

Apply a function to update the ServerConfig

pub fn run(self)

Start running the apps.