Struct HandshakePlugin

pub struct HandshakePlugin {
    pub allow_login: bool,
}

Plugin that handles the Minecraft protocol handshake.

Fields

allow_login: bool

Whether or not to allow clients to log in.

Implementations

impl HandshakePlugin

pub fn handle_handshakes( allow_login: Res<'_, AllowLogin>, ids: Res<'_, PacketIds>, commands: Commands<'_, '_>, packets: EventReader<'_, '_, Recv<Handshake>>, clients: Query<'_, '_, (&Client, &mut ProtocolState, &mut Paused)>, )

System that handles Handshake packets.

Trait Implementations

impl Plugin for HandshakePlugin

fn build(&self, app: &mut App)

Configures the App to which this plugin is added.

fn ready(&self, _app: &App) -> bool

Has the plugin finished it’s setup? This can be useful for plugins that needs something asynchronous to happen before they can finish their setup, like renderer initialization. Once the plugin is ready, finish should be called.

fn finish(&self, _app: &mut App)

Finish adding this plugin to the App, once all plugins registered are ready. This can be useful for plugins that depends on another plugin asynchronous setup, like the renderer.

fn cleanup(&self, _app: &mut App)

Runs after all plugins are built and finished, but before the app schedule is executed. This can be useful if you have some resource that other plugins need during their build step, but after build you want to remove it and send it to another thread.

fn name(&self) -> &str

Configures a name for the Plugin which is primarily used for checking plugin uniqueness and debugging.

fn is_unique(&self) -> bool

If the plugin can be meaningfully instantiated several times in an App, override this method to return false.