Struct veloren_server::Server

pub struct Server {
    pub(crate) state: State,
    pub(crate) world: Arc<World>,
    pub(crate) index: IndexOwned,
    pub(crate) connection_handler: ConnectionHandler,
    pub(crate) runtime: Arc<Runtime>,
    pub(crate) metrics_registry: Arc<Registry>,
    pub(crate) chat_cache: ChatCache,
    pub(crate) database_settings: Arc<RwLock<DatabaseSettings>>,
    pub(crate) disconnect_all_clients_requested: bool,
    pub(crate) server_constants: ServerConstants,
    pub(crate) event_dispatcher: SendDispatcher<'static>,
}

Fields

state: State

world: Arc<World>

index: IndexOwned

connection_handler: ConnectionHandler

runtime: Arc<Runtime>

metrics_registry: Arc<Registry>

chat_cache: ChatCache

database_settings: Arc<RwLock<DatabaseSettings>>

disconnect_all_clients_requested: bool

server_constants: ServerConstants

event_dispatcher: SendDispatcher<'static>

Implementations

impl Server

fn handle_serial_events<T: Send + 'static, F: FnMut(&mut Self, T)>( &mut self, f: F, )

fn handle_all_serial_events(&mut self, frontend_events: &mut Vec<Event>)

pub fn handle_events(&mut self) -> Vec<Event>

pub fn create_event_dispatcher( pools: Arc<ThreadPool>, ) -> SendDispatcher<'static>

impl Server

pub fn new( settings: Settings, editable_settings: EditableSettings, database_settings: DatabaseSettings, data_dir: &Path, report_stage: &(dyn Fn(ServerInitStage) + Send + Sync), runtime: Arc<Runtime>, ) -> Result<Self, Error>

Create a new Server

pub fn get_server_info(&self) -> ServerInfo

pub fn settings(&self) -> impl Deref<Target = Settings> + '_

Get a reference to the server’s settings

pub fn settings_mut(&self) -> impl DerefMut<Target = Settings> + '_

Get a mutable reference to the server’s settings

pub fn editable_settings_mut( &self, ) -> impl DerefMut<Target = EditableSettings> + '_

Get a mutable reference to the server’s editable settings

pub fn editable_settings(&self) -> impl Deref<Target = EditableSettings> + '_

Get a reference to the server’s editable settings

pub fn data_dir(&self) -> impl Deref<Target = DataDir> + '_

Get path to the directory that the server info into

pub fn state(&self) -> &State

Get a reference to the server’s game state.

pub fn state_mut(&mut self) -> &mut State

Get a mutable reference to the server’s game state.

pub fn world(&self) -> &World

Get a reference to the server’s world.

pub fn metrics_registry(&self) -> &Arc<Registry>

Get a reference to the Metrics Registry

pub fn chat_cache(&self) -> &ChatCache

Get a reference to the Chat Cache

pub(crate) fn parse_locations(&self, character_list_data: &mut [CharacterItem])

pub fn tick(&mut self, _input: Input, dt: Duration) -> Result<Vec<Event>, Error>

Execute a single server tick, handle input and update the game state by the given duration.

pub fn cleanup(&mut self)

Clean up the server after a tick.

pub(crate) fn update_region_map(&mut self)

pub(crate) fn initialize_client(&mut self, client: Client) -> Entity

pub(crate) fn disconnect_all_clients_if_requested( &mut self, ) -> Option<DisconnectType>

Disconnects all clients if requested by either an admin command or due to a persistence transaction failure and returns the processed DisconnectionType

pub(crate) fn get_disconnect_all_clients_requested( &self, character_updater: &mut CharacterUpdater, ) -> Option<DisconnectType>

pub(crate) fn handle_new_connections( &mut self, frontend_events: &mut Vec<Event>, )

Handle new client connections.

pub fn notify_client<S>(&self, entity: EcsEntity, msg: S)

where S: Into<ServerMsg>,

pub fn notify_players(&mut self, msg: ServerGeneral)

pub fn generate_chunk(&mut self, entity: EcsEntity, key: Vec2<i32>)

pub(crate) fn process_command( &mut self, entity: EcsEntity, name: String, args: Vec<String>, )

pub(crate) fn entity_admin_role(&self, entity: EcsEntity) -> Option<AdminRole>

pub fn number_of_players(&self) -> i64

pub fn add_admin(&mut self, username: &str, role: AdminRole)

NOTE: Do not allow this to be called from any command that doesn’t go through the CLI!

pub fn remove_admin(&self, username: &str)

NOTE: Do not allow this to be called from any command that doesn’t go through the CLI!

pub fn create_centered_persister(&mut self, view_distance: u32)

Useful for testing without a client view_distance: distance in chunks that are persisted, this acts like the player view distance so it is actually a bit farther due to a buffer zone

pub fn chunks_pending(&mut self) -> bool

Used by benchmarking code.

pub fn set_sql_log_mode(&mut self, sql_log_mode: SqlLogMode)

Sets the SQL log mode at runtime

pub fn disconnect_all_clients(&mut self)

Trait Implementations

impl Drop for Server

fn drop(&mut self)

Executes the destructor for this type.