use crate::{ comp::{group::Group, BuffKind}, uid::Uid, }; use serde::{Deserialize, Serialize}; use specs::Component; use specs_idvs::IdvStorage; use std::time::{Duration, Instant}; /// A player's current chat mode. These are chat types that can only be sent by /// the player. #[derive(Clone, Debug, Serialize, Deserialize)] pub enum ChatMode { /// Private message to another player (by uuid) Tell(Uid), /// Talk to players within shouting distance Say, /// Talk to players in your region of the world Region, /// Talk to your current group of players Group(Group), /// Talk to your faction Faction(String), /// Talk to every player on the server World, } impl Component for ChatMode { type Storage = IdvStorage; } impl ChatMode { /// Create a message from your current chat mode and uuid. pub fn new_message(&self, from: Uid, message: String) -> UnresolvedChatMsg { let chat_type = match self { ChatMode::Tell(to) => ChatType::Tell(from, *to), ChatMode::Say => ChatType::Say(from), ChatMode::Region => ChatType::Region(from), ChatMode::Group(group) => ChatType::Group(from, *group), ChatMode::Faction(faction) => ChatType::Faction(from, faction.clone()), ChatMode::World => ChatType::World(from), }; UnresolvedChatMsg { chat_type, message } } } impl ChatMode { pub const fn default() -> Self { Self::World } } #[derive(Debug, Clone, Serialize, Deserialize)] pub enum KillType { Buff(BuffKind), Melee, Projectile, Explosion, Energy, Other, // Projectile(String), TODO: add projectile name when available } #[derive(Debug, Clone, Serialize, Deserialize)] pub enum KillSource { Player(Uid, KillType), NonPlayer(String, KillType), NonExistent(KillType), Environment(String), FallDamage, Suicide, Other, } /// List of chat types. Each one is colored differently and has its own icon. /// /// This is a superset of `SpeechBubbleType`, which is a superset of `ChatMode` #[derive(Debug, Clone, Serialize, Deserialize)] pub enum ChatType { /// A player came online Online(Uid), /// A player went offline Offline(Uid), /// The result of chat commands CommandInfo, /// A chat command failed CommandError, /// Inform players that someone died (Source, Victim) Source may be None /// (ex: fall damage) Kill(KillSource, Uid), /// Server notifications to a group, such as player join/leave GroupMeta(G), /// Server notifications to a faction, such as player join/leave FactionMeta(String), /// One-on-one chat (from, to) Tell(Uid, Uid), /// Chat with nearby players Say(Uid), /// Group chat Group(Uid, G), /// Factional chat Faction(Uid, String), /// Regional chat Region(Uid), /// World chat World(Uid), /// Messages sent from NPCs (Not shown in chat but as speech bubbles) /// /// The u16 field is a random number for selecting localization variants. Npc(Uid, u16), /// From NPCs but in the chat for clients in the near vicinity NpcSay(Uid, u16), /// Anything else Meta, // Looted items Loot, } impl ChatType { pub fn chat_msg(self, msg: S) -> GenericChatMsg where S: Into, { GenericChatMsg { chat_type: self, message: msg.into(), } } } // Stores chat text, type #[derive(Debug, Clone, Serialize, Deserialize)] pub struct GenericChatMsg { pub chat_type: ChatType, pub message: String, } pub type ChatMsg = GenericChatMsg; pub type UnresolvedChatMsg = GenericChatMsg; impl GenericChatMsg { pub const NPC_DISTANCE: f32 = 100.0; pub const NPC_SAY_DISTANCE: f32 = 30.0; pub const REGION_DISTANCE: f32 = 1000.0; pub const SAY_DISTANCE: f32 = 100.0; pub fn npc(uid: Uid, message: String) -> Self { let chat_type = ChatType::Npc(uid, rand::random()); Self { chat_type, message } } pub fn npc_say(uid: Uid, message: String) -> Self { let chat_type = ChatType::NpcSay(uid, rand::random()); Self { chat_type, message } } pub fn map_group(self, mut f: impl FnMut(G) -> T) -> GenericChatMsg { let chat_type = match self.chat_type { ChatType::Online(a) => ChatType::Online(a), ChatType::Offline(a) => ChatType::Offline(a), ChatType::CommandInfo => ChatType::CommandInfo, ChatType::CommandError => ChatType::CommandError, ChatType::Loot => ChatType::Loot, ChatType::FactionMeta(a) => ChatType::FactionMeta(a), ChatType::GroupMeta(g) => ChatType::GroupMeta(f(g)), ChatType::Kill(a, b) => ChatType::Kill(a, b), ChatType::Tell(a, b) => ChatType::Tell(a, b), ChatType::Say(a) => ChatType::Say(a), ChatType::Group(a, g) => ChatType::Group(a, f(g)), ChatType::Faction(a, b) => ChatType::Faction(a, b), ChatType::Region(a) => ChatType::Region(a), ChatType::World(a) => ChatType::World(a), ChatType::Npc(a, b) => ChatType::Npc(a, b), ChatType::NpcSay(a, b) => ChatType::NpcSay(a, b), ChatType::Meta => ChatType::Meta, }; GenericChatMsg { chat_type, message: self.message, } } pub fn get_group(&self) -> Option<&G> { match &self.chat_type { ChatType::GroupMeta(g) => Some(&g), ChatType::Group(_, g) => Some(&g), _ => None, } } pub fn to_bubble(&self) -> Option<(SpeechBubble, Uid)> { let icon = self.icon(); if let ChatType::Npc(from, r) | ChatType::NpcSay(from, r) = self.chat_type { Some((SpeechBubble::npc_new(&self.message, r, icon), from)) } else { self.uid() .map(|from| (SpeechBubble::player_new(&self.message, icon), from)) } } pub fn icon(&self) -> SpeechBubbleType { match &self.chat_type { ChatType::Online(_) => SpeechBubbleType::None, ChatType::Offline(_) => SpeechBubbleType::None, ChatType::CommandInfo => SpeechBubbleType::None, ChatType::CommandError => SpeechBubbleType::None, ChatType::Loot => SpeechBubbleType::None, ChatType::FactionMeta(_) => SpeechBubbleType::None, ChatType::GroupMeta(_) => SpeechBubbleType::None, ChatType::Kill(_, _) => SpeechBubbleType::None, ChatType::Tell(_u, _) => SpeechBubbleType::Tell, ChatType::Say(_u) => SpeechBubbleType::Say, ChatType::Group(_u, _s) => SpeechBubbleType::Group, ChatType::Faction(_u, _s) => SpeechBubbleType::Faction, ChatType::Region(_u) => SpeechBubbleType::Region, ChatType::World(_u) => SpeechBubbleType::World, ChatType::Npc(_u, _r) => SpeechBubbleType::None, ChatType::NpcSay(_u, _r) => SpeechBubbleType::Say, ChatType::Meta => SpeechBubbleType::None, } } pub fn uid(&self) -> Option { match &self.chat_type { ChatType::Online(_) => None, ChatType::Offline(_) => None, ChatType::CommandInfo => None, ChatType::CommandError => None, ChatType::Loot => None, ChatType::FactionMeta(_) => None, ChatType::GroupMeta(_) => None, ChatType::Kill(_, _) => None, ChatType::Tell(u, _t) => Some(*u), ChatType::Say(u) => Some(*u), ChatType::Group(u, _s) => Some(*u), ChatType::Faction(u, _s) => Some(*u), ChatType::Region(u) => Some(*u), ChatType::World(u) => Some(*u), ChatType::Npc(u, _r) => Some(*u), ChatType::NpcSay(u, _r) => Some(*u), ChatType::Meta => None, } } } /// Player factions are used to coordinate pvp vs hostile factions or segment /// chat from the world /// /// Factions are currently just an associated String (the faction's name) #[derive(Clone, Debug)] pub struct Faction(pub String); impl Component for Faction { type Storage = IdvStorage; } impl From for Faction { fn from(s: String) -> Self { Faction(s) } } /// The contents of a speech bubble pub enum SpeechBubbleMessage { /// This message was said by a player and needs no translation Plain(String), /// This message was said by an NPC. The fields are a i18n key and a random /// u16 index Localized(String, u16), } /// List of chat types for players and NPCs. Each one has its own icon. /// /// This is a subset of `ChatType`, and a superset of `ChatMode` pub enum SpeechBubbleType { // One for each chat mode Tell, Say, Region, Group, Faction, World, // For NPCs Quest, // TODO not implemented Trade, // TODO not implemented None, // No icon (default for npcs) } /// Adds a speech bubble above the character pub struct SpeechBubble { pub message: SpeechBubbleMessage, pub icon: SpeechBubbleType, pub timeout: Instant, } impl SpeechBubble { /// Default duration in seconds of speech bubbles pub const DEFAULT_DURATION: f64 = 5.0; pub fn npc_new(i18n_key: &str, r: u16, icon: SpeechBubbleType) -> Self { let message = SpeechBubbleMessage::Localized(i18n_key.to_string(), r); let timeout = Instant::now() + Duration::from_secs_f64(SpeechBubble::DEFAULT_DURATION); Self { message, icon, timeout, } } pub fn player_new(message: &str, icon: SpeechBubbleType) -> Self { let message = SpeechBubbleMessage::Plain(message.to_string()); let timeout = Instant::now() + Duration::from_secs_f64(SpeechBubble::DEFAULT_DURATION); Self { message, icon, timeout, } } pub fn message(&self, i18n_variation: F) -> String where F: Fn(&str, u16) -> String, { match &self.message { SpeechBubbleMessage::Plain(m) => m.to_string(), SpeechBubbleMessage::Localized(k, i) => i18n_variation(&k, *i), } } }