Enum veloren_common_net::msg::server::ServerGeneral

pub enum ServerGeneral {
    CharacterDataLoadResult(Result<UpdateCharacterMetadata, String>),
    CharacterListUpdate(Vec<CharacterItem>),
    CharacterActionError(String),
    CharacterCreated(CharacterId),
    CharacterEdited(CharacterId),
    CharacterSuccess,
    SpectatorSuccess(Vec3<f32>),
    GroupUpdate(ChangeNotification<Uid>),
    Invite {
        inviter: Uid,
        timeout: Duration,
        kind: InviteKind,
    },
    InvitePending(Uid),
    GroupInventoryUpdate(FrontendItem, Uid),
    InviteComplete {
        target: Uid,
        answer: InviteAnswer,
        kind: InviteKind,
    },
    ExitInGameSuccess,
    InventoryUpdate(Inventory, Vec<InventoryUpdateEvent>),
    SetViewDistance(u32),
    Outcomes(Vec<Outcome>),
    Knockback(Vec3<f32>),
    TerrainChunkUpdate {
        key: Vec2<i32>,
        chunk: Result<SerializedTerrainChunk, ()>,
    },
    LodZoneUpdate {
        key: Vec2<i32>,
        zone: Zone,
    },
    TerrainBlockUpdates(CompressedData<HashMap<Vec3<i32>, Block>>),
    PlayerListUpdate(PlayerListUpdate),
    ChatMsg(ChatMsg),
    ChatMode(ChatMode),
    SetPlayerEntity(Uid),
    TimeOfDay(TimeOfDay, Calendar, Time, TimeScale),
    EntitySync(EntitySyncPackage),
    CompSync(CompSyncPackage<EcsCompPacket>, u64),
    CreateEntity(EntityPackage<EcsCompPacket>),
    DeleteEntity(Uid),
    Disconnect(DisconnectReason),
    Notification(Notification),
    UpdatePendingTrade(TradeId, PendingTrade, Option<SitePrices>),
    FinishedTrade(TradeResult),
    SiteEconomy(EconomyInfo),
    MapMarker(MapMarkerUpdate),
    WeatherUpdate(SharedWeatherGrid),
    LocalWindUpdate(Vec2<f32>),
    SpectatePosition(Vec3<f32>),
    PluginData(Vec<u8>),
    UpdateRecipes,
    SetPlayerRole(Option<AdminRole>),
}

Messages sent from the server to the client

Variants

CharacterDataLoadResult(Result<UpdateCharacterMetadata, String>)

Result of loading character data

CharacterListUpdate(Vec<CharacterItem>)

A list of characters belonging to the a authenticated player was sent

CharacterActionError(String)

An error occurred while creating or deleting a character

CharacterCreated(CharacterId)

A new character was created

CharacterEdited(CharacterId)

CharacterSuccess

SpectatorSuccess(Vec3<f32>)

GroupUpdate(ChangeNotification<Uid>)

Invite

Indicate to the client that they are invited to join a group

Fields

inviter: Uid

timeout: Duration

kind: InviteKind

InvitePending(Uid)

Indicate to the client that their sent invite was not invalid and is currently pending

GroupInventoryUpdate(FrontendItem, Uid)

Update the HUD of the clients in the group

InviteComplete

Note: this could potentially include all the failure cases such as inviting yourself in which case the InvitePending message could be removed and the client could consider their invite pending until they receive this message Indicate to the client the result of their invite

Fields

target: Uid

answer: InviteAnswer

kind: InviteKind

ExitInGameSuccess

Trigger cleanup for when the client goes back to the Registered state from an ingame state

InventoryUpdate(Inventory, Vec<InventoryUpdateEvent>)

SetViewDistance(u32)

NOTE: The client can infer that entity view distance will be at most the terrain view distance that we send here (and if lower it won’t be modified). So we just need to send the terrain VD back to the client if corrections are made.

Outcomes(Vec<Outcome>)

Knockback(Vec3<f32>)

TerrainChunkUpdate

Fields

key: Vec2<i32>

chunk: Result<SerializedTerrainChunk, ()>

LodZoneUpdate

Fields

key: Vec2<i32>

zone: Zone

TerrainBlockUpdates(CompressedData<HashMap<Vec3<i32>, Block>>)

PlayerListUpdate(PlayerListUpdate)

ChatMsg(ChatMsg)

A message to go into the client chat box. The client is responsible for formatting the message and turning it into a speech bubble.

ChatMode(ChatMode)

SetPlayerEntity(Uid)

TimeOfDay(TimeOfDay, Calendar, Time, TimeScale)

EntitySync(EntitySyncPackage)

CompSync(CompSyncPackage<EcsCompPacket>, u64)

CreateEntity(EntityPackage<EcsCompPacket>)

DeleteEntity(Uid)

Disconnect(DisconnectReason)

Notification(Notification)

Send a popup notification such as “Waypoint Saved”

UpdatePendingTrade(TradeId, PendingTrade, Option<SitePrices>)

FinishedTrade(TradeResult)

SiteEconomy(EconomyInfo)

Economic information about sites

MapMarker(MapMarkerUpdate)

WeatherUpdate(SharedWeatherGrid)

LocalWindUpdate(Vec2<f32>)

SpectatePosition(Vec3<f32>)

Suggest the client to spectate a position. Called after client has requested teleport etc.

PluginData(Vec<u8>)

Plugin data requested from the server

UpdateRecipes

Update the list of available recipes. Usually called after a new recipe is acquired

SetPlayerRole(Option<AdminRole>)

Implementations

impl ServerGeneral

pub fn server_msg( chat_type: ChatType<String>, content: impl Into<Content>, ) -> Self

Trait Implementations

impl Clone for ServerGeneral

fn clone(&self) -> ServerGeneral

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ServerGeneral

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ServerGeneral

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<GenericChatMsg<String>> for ServerGeneral

fn from(v: ChatMsg) -> Self

Converts to this type from the input type.

impl From<ServerGeneral> for ServerMsg

fn from(o: ServerGeneral) -> ServerMsg

Converts to this type from the input type.

impl Serialize for ServerGeneral

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

where __S: Serializer,

Serialize this value into the given Serde serializer.