ShiftOS_TheReturn/ShiftOS.Objects/Objects.cs

/*
 * MIT License
 * 
 * Copyright (c) 2017 Michael VanOverbeek and ShiftOS devs
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace ShiftOS.Objects
{
    public class MUDMemo
    {
        public string UserFrom { get; set; }
        public string UserTo { get; set; }
        public MemoType Type { get; set; }
        public string Body { get; set; }
        public string Subject { get; set; }
    }

    public enum MemoType
    {
        Regular,
        Job,
        LegionInvite,
    }


    public class PongHighscore
    {
        public string UserName { get; set; }
        public int HighestLevel { get; set; }
        public int HighestCodepoints { get; set; }
    }

    public class GUIDRequest
    {
        public string name { get; set; }
        public string guid { get; set; }
    }

    public class OnlineUser
    {
        public string Guid { get; set; }
        public string Username { get; set; }
        public string OnlineChat { get; set; }
    }

    public class FriendlyNameAttribute : Attribute
    {
        public FriendlyNameAttribute(string name)
        {
            Name = name;
        }

        public string Name { get; private set; }
    }

    public class FriendlyDescriptionAttribute : Attribute
    {
        public FriendlyDescriptionAttribute(string desc)
        {
            Description = desc;
        }

        public string Description { get; private set; }
    }

    public class Channel
    {
        [FriendlyName("Chat name")]
        [FriendlyDescription("The human-readable name of your chat. This should be something small, possibly a one or two word description of your chat.")]
        public string Name { get; set; }

        //Don't describe this one. We want it to be hidden from the admin panel's chat editor.
        public string ID { get; set; }

        [FriendlyName("Requires Patreon?")]
        [FriendlyDescription("If checked, this chat will only be shown in the MUD Control Centre if the user's save is marked as a Patreon supporter.")]
        public bool RequiresPatreon { get; set; }

        [FriendlyName("Chat topic")]
        [FriendlyDescription("A more in-depth version of your chat name. Describe what your chat's about in a sentence.")]
        public string Topic { get; set; }

        [FriendlyName("Is it a Discord relay?")]
        [FriendlyDescription("If checked, this channel will use a Discord bot to relay messages between ShiftOS and a chosen Discord channel. Useful if you'd like to integrate your MUD with the rest of your community.")]
        public bool IsDiscordProxy { get; set; }

        [FriendlyName("Discord bot token")]
        [FriendlyDescription("If this is a discord relay chat, paste the token for your Discord bot here. Note: It MUST be a bot token, not a user token.")]
        public string DiscordBotToken { get; set; }

        [FriendlyName("Discord channel ID")]
        [FriendlyDescription("If this channel is a Discord relay, paste the ID of the channel you'd like the bot to listen to here. You can get the channel ID by enabling Developer Mode in your Discord settings, then right-clicking your channel name and clicking 'Copy ID', then paste it here.")]
        public string DiscordChannelID { get; set; }
    }

    public class ChatMessage
    {
        public ChatMessage(string uname, string sys, string message, string chan)
        {
            Username = uname;
            SystemName = sys;
            Message = message;
            Channel = chan;
        }

        public string Username { get; private set; }
        public string SystemName { get; private set; }
        public string Channel { get; private set; }
        public string Message { get; private set; } 
    }

    [Serializable]
    public class ServerMessage
    {
        public string Name { get; set; }
        public string Contents { get; set; }
        public string GUID { get; set; }
    }
}