Struct veloren_plugin_api::event::PluginLoadEvent

pub struct PluginLoadEvent {
    pub game_mode: GameMode,
}

This event is called when the plugin is loaded Your event should be named on_load

Example

#[event_handler]
pub fn on_load(load: PluginLoadEvent) {
    match load.game_mode {
        GameMode::Server => emit_action(Action::Print("Hello, server!".to_owned())),
        GameMode::Client => emit_action(Action::Print("Hello, client!".to_owned())),
        GameMode::Singleplayer => emit_action(Action::Print("Hello, singleplayer!".to_owned())),
    }
}

Fields

game_mode: GameMode

Trait Implementations

impl Clone for PluginLoadEvent

fn clone(&self) -> PluginLoadEvent

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PluginLoadEvent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PluginLoadEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Event for PluginLoadEvent

type Response = ()

fn get_event_name(&self) -> String

impl PartialEq<PluginLoadEvent> for PluginLoadEvent

fn eq(&self, other: &PluginLoadEvent) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PluginLoadEvent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PluginLoadEvent

impl StructuralEq for PluginLoadEvent

impl StructuralPartialEq for PluginLoadEvent