CaveNet_EnumData.h

Go to the documentation of this file.

/*
  Cavestory Multiplayer API
  Copyright (C) 2021 Johnny Ledger
 
  This software is provided 'as-is', without any express or implied
  warranty.  In no event will the authors be held liable for any damages
  arising from the use of this software.
 
  Permission is granted to anyone to use this software for any purpose,
  including commercial applications, and to alter it and redistribute it
  freely, subject to the following restrictions:
 
  1. The origin of this software must not be misrepresented; you must not
     claim that you wrote the original software. If you use this software
     in a product, an acknowledgment in the product documentation would be
     appreciated but is not required.
  2. Altered source versions must be plainly marked as such, and must not be
     misrepresented as being the original software.
  3. This notice may not be removed or altered from any source distribution.
*/
 
#pragma once
 
namespace CaveNet
{
    enum NetDisconnectReason
    {
        NET_DISCONNECT_REASON_UNKNOWN,
 
        NET_DISCONNECT_REASON_USER_LEFT,
 
        NET_DISCONNECT_REASON_KICKED,
 
        NET_DISCONNECT_REASON_BANNED,
 
        NET_DISCONNECT_REASON_TIMED_OUT,
 
        NET_DISCONNECT_REASON_MOD_CHANGED,
 
        NET_DISCONNECT_REASON_SERVER_CLOSING,
 
        NET_DISCONNECT_REASON_CUSTOM,
 
        _NET_DISCONNECT_REASON_COUNT_
    };
 
    enum NetInputFlag
    {
        NET_INPUT_FLAG_JUMP      = 0b000000001,
        NET_INPUT_FLAG_SHOOT     = 0b000000010,
        NET_INPUT_FLAG_LEFT      = 0b000000100,
        NET_INPUT_FLAG_RIGHT     = 0b000001000,
        NET_INPUT_FLAG_UP        = 0b000010000,
        NET_INPUT_FLAG_DOWN      = 0b000100000,
        NET_INPUT_FLAG_ARMS_NEXT = 0b001000000,
        NET_INPUT_FLAG_ARMS_PREV = 0b010000000,
        NET_INPUT_FLAG_COUNT     = 0b100000000
 
        // Please update this to equal the last enum
    };
    
    enum UpdateInventoryFlags : unsigned char
    {
        // Everything is included
        UPDATE_INV_ALL           = (0x01 | 0x02 | 0x04 | 0x08),
        // Weapons are included (BIT FLAG)
        UPDATE_INV_WEAPONS       = 0x01,
        // Items are included (BIT FLAG)
        UPDATE_INV_ITEM          = 0x02,
        // Permit stages are included (BIT FLAG)
        UPDATE_INV_PERMIT_STAGES = 0x04,
        // Collectables are included (BIT FLAG)
        UPDATE_INV_COLLECTABLES  = 0x08,
    };
    
    enum VersionIdentifier
    {
        // Release Mode
        RELEASE = 0,
        // Debug Mode
        DEBUG   = 1
    };
 
    enum HostServerLoadType : unsigned char
    {
        // Load into the savegame like normal.
        Normal,
        // Load into tutorial.
        Tutorial,
        // Load into Boss Rush.
        BossRush
    };
 
    // Table of version identifier strings to go along with VersionIdentifier.
    // @see CaveNet::VersionIdentifier
    static const char* VersionIdentStrings[] =
    {
        "", "_d", "_qa"
    };
};