Struct veloren_server::Server

source ·
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§

source§

impl Server

source

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

source

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

source

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

source

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

source§

impl Server

source

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

source

pub fn get_server_info(&self) -> ServerInfo

source

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

Get a reference to the server’s settings

source

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

Get a mutable reference to the server’s settings

source

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

Get a mutable reference to the server’s editable settings

source

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

Get a reference to the server’s editable settings

source

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

Get path to the directory that the server info into

source

pub fn state(&self) -> &State

Get a reference to the server’s game state.

source

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

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

source

pub fn world(&self) -> &World

Get a reference to the server’s world.

source

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

Get a reference to the Metrics Registry

source

pub fn chat_cache(&self) -> &ChatCache

Get a reference to the Chat Cache

source

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

source

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.

source

pub fn cleanup(&mut self)

Clean up the server after a tick.

source

pub(crate) fn update_region_map(&mut self)

source

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

source

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

source

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

source

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

Handle new client connections.

source

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

source

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

source

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

source

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

source

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

source

pub fn number_of_players(&self) -> i64

source

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!

source

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!

source

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

source

pub fn chunks_pending(&mut self) -> bool

Used by benchmarking code.

source

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

Sets the SQL log mode at runtime

source

pub fn disconnect_all_clients(&mut self)

Trait Implementations§

source§

impl Drop for Server

source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl Freeze for Server

§

impl !RefUnwindSafe for Server

§

impl Send for Server

§

impl !Sync for Server

§

impl !Unpin for Server

§

impl !UnwindSafe for Server

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> GetSetFdFlags for T

§

fn get_fd_flags(&self) -> Result<FdFlags, Error>
where T: AsFilelike,

Query the “status” flags for the self file descriptor.
§

fn new_set_fd_flags(&self, fd_flags: FdFlags) -> Result<SetFdFlags<T>, Error>
where T: AsFilelike,

Create a new SetFdFlags value for use with set_fd_flags. Read more
§

fn set_fd_flags(&mut self, set_fd_flags: SetFdFlags<T>) -> Result<(), Error>
where T: AsFilelike,

Set the “status” flags for the self file descriptor. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Pointee for T

§

type Pointer = u32

§

fn debug( pointer: <T as Pointee>::Pointer, f: &mut Formatter<'_> ) -> Result<(), Error>

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<Context> SubContext<Context> for Context

source§

fn sub_context(self) -> Context

§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> Any for T
where T: Any,