MoveSplineFlag.h

Go to the documentation of this file.

/*
* This file is part of Project SkyFire https://www.projectskyfire.org.
* See LICENSE.md file for Copyright information
*/
 
#ifndef SKYFIRESERVER_MOVESPLINEFLAG_H
#define SKYFIRESERVER_MOVESPLINEFLAG_H
#include "MovementTypedefs.h"
 
#include <string>
 
namespace Movement
{
#if defined( __GNUC__ )
#pragma pack(1)
#else
#pragma pack(push, 1)
#endif
 
    class MoveSplineFlag
    {
    public:
        enum eFlags
        {
            None = 0x00000000,
            // x00-x07 used as animation Ids storage in pair with Animation flag
            Unknown0 = 0x00000008,           // NOT VERIFIED
            FallingSlow = 0x00000010,
            Done = 0x00000020,
            Falling = 0x00000040,           // Affects elevation computation, can't be combined with Parabolic flag
            No_Spline = 0x00000080,
            Unknown2 = 0x00000100,           // NOT VERIFIED
            Flying = 0x00000200,           // Smooth movement(Catmullrom interpolation mode), flying animation
            OrientationFixed = 0x00000400,           // Model orientation fixed
            Catmullrom = 0x00000800,           // Used Catmullrom interpolation mode
            Cyclic = 0x00001000,           // Movement by cycled spline
            Enter_Cycle = 0x00002000,           // Everytimes appears with cyclic flag in monster move packet, erases first spline vertex after first cycle done
            Frozen = 0x00004000,           // Will never arrive
            TransportEnter = 0x00008000,
            TransportExit = 0x00010000,
            Unknown3 = 0x00020000,           // NOT VERIFIED
            Unknown4 = 0x00040000,           // NOT VERIFIED
            OrientationInversed = 0x00080000,
            SmoothGroundPath = 0x00100000,
            Walkmode = 0x00200000,
            UncompressedPath = 0x00400000,
            Unknown6 = 0x00800000,           // NOT VERIFIED
            Animation = 0x01000000,           // Plays animation after some time passed
            Parabolic = 0x02000000,           // Affects elevation computation, can't be combined with Falling flag
            Final_Point = 0x04000000,
            Final_Target = 0x08000000,
            Final_Angle = 0x10000000,
            Unknown7 = 0x20000000,           // NOT VERIFIED
            Unknown8 = 0x40000000,           // NOT VERIFIED
            Unknown9 = 0x80000000,           // NOT VERIFIED
 
            // Masks
            Mask_Final_Facing = Final_Point | Final_Target | Final_Angle,
            // animation ids stored here, see AnimType enum, used with Animation flag
            Mask_Animations = 0x7,
            // flags that shouldn't be appended into SMSG_ON_MONSTER_MOVE\SMSG_ON_MONSTER_MOVE_TRANSPORT packet, should be more probably
            Mask_No_Monster_Move = Mask_Final_Facing | Mask_Animations | Done,
            // Unused, not suported flags
            Mask_Unused = No_Spline | Enter_Cycle | Frozen | Unknown0 | Unknown2 | Unknown3 | Unknown4 | Unknown6 | Unknown7 | Unknown8 | Unknown9
        };
 
        inline uint32& raw() { return (uint32&)*this; }
        inline const uint32& raw() const { return (const uint32&)*this; }
 
        MoveSplineFlag() { raw() = 0; }
        MoveSplineFlag(uint32 f) { raw() = f; }
        MoveSplineFlag(const MoveSplineFlag& f) { raw() = f.raw(); }
 
        // Constant interface
 
        bool isSmooth() const { return raw() & Catmullrom; }
        bool isLinear() const { return !isSmooth(); }
        bool isFacing() const { return raw() & Mask_Final_Facing; }
 
        uint8 getAnimationId() const { return animId; }
        bool hasAllFlags(uint32 f) const { return (raw() & f) == f; }
        bool hasFlag(uint32 f) const { return (raw() & f) != 0; }
        uint32 operator & (uint32 f) const { return (raw() & f); }
        uint32 operator | (uint32 f) const { return (raw() | f); }
        std::string ToString() const;
 
        // Not constant interface
 
        void operator &= (uint32 f) { raw() &= f; }
        void operator |= (uint32 f) { raw() |= f; }
 
        void EnableAnimation(uint8 anim) { raw() = (raw() & ~(Mask_Animations | Falling | Parabolic | FallingSlow)) | Animation | (anim & Mask_Animations); }
        void EnableParabolic() { raw() = (raw() & ~(Mask_Animations | Falling | Animation | FallingSlow)) | Parabolic; }
        void EnableFlying() { raw() = (raw() & ~(Falling)) | Flying; }
        void EnableFalling() { raw() = (raw() & ~(Mask_Animations | Parabolic | Animation | Flying)) | Falling; }
        void EnableCatmullRom() { raw() = (raw() & ~SmoothGroundPath) | Catmullrom; }
        void EnableFacingPoint() { raw() = (raw() & ~Mask_Final_Facing) | Final_Point; }
        void EnableFacingAngle() { raw() = (raw() & ~Mask_Final_Facing) | Final_Angle; }
        void EnableFacingTarget() { raw() = (raw() & ~Mask_Final_Facing) | Final_Target; }
        void EnableTransportEnter() { raw() = (raw() & ~TransportExit) | TransportEnter; }
        void EnableTransportExit() { raw() = (raw() & ~TransportEnter) | TransportExit; }
 
        uint8 animId : 3;
        bool unknown0 : 1;
        bool fallingSlow : 1;
        bool done : 1;
        bool falling : 1;
        bool no_spline : 1;
        bool unknown2 : 1;
        bool flying : 1;
        bool orientationFixed : 1;
        bool catmullrom : 1;
        bool cyclic : 1;
        bool enter_cycle : 1;
        bool frozen : 1;
        bool transportEnter : 1;
        bool transportExit : 1;
        bool unknown3 : 1;
        bool unknown4 : 1;
        bool orientationInversed : 1;
        bool smoothGroundPath : 1;
        bool walkmode : 1;
        bool uncompressedPath : 1;
        bool unknown6 : 1;
        bool animation : 1;
        bool parabolic : 1;
        bool final_point : 1;
        bool final_target : 1;
        bool final_angle : 1;
        bool unknown7 : 1;
        bool unknown8 : 1;
        bool unknown9 : 1;
    };
#if defined( __GNUC__ )
#pragma pack()
#else
#pragma pack(pop)
#endif
}
 
#endif // SKYFIRESERVER_MOVESPLINEFLAG_H