map_placements.hpp

Go to the documentation of this file.

#pragma once

 
#include <cstdint>
 
#include <welder/vocabulary.hpp>
 
#include <wowlib/formats/common/types.hpp>
 
namespace wowlib::formats::common {
  enum class [[
      =welder::weld,
      =welder::flags,
      =welder::doc("WMO placement flag bits (SMMapObjDef.flags).")
    ]] MapObjDefFlags : std::uint16_t {
    Destroyable [[=welder::doc(
      "A destroyable, server-controllable building (e.g. the "
      "DeathknightStart tower).")]] = 0x1,
    UseLod [[=
      welder::doc("Also load the _LOD1 WMO, selected by distance (WoD+).")]] =
    0x2,
    HasScale [[=welder::doc("The scale field is engaged: scale / 1024 applies "
      "(Legion+; otherwise 1.0).")]] = 0x4,
    EntryIsFdid [[=welder::doc(
      "name_id is a FileDataID to load directly, not a name-table "
      "index (Legion+).")]] = 0x8,
    UseSetsFromMwds [[=welder::doc(
      "Doodad set indices come from the ADT MWDS chunk "
      "(Shadowlands+).")]] = 0x80
  };
 
  enum class [[
      =welder::weld,
      =welder::flags,
      =welder::doc("M2 placement flag bits (SMDoodadDef.flags).")
    ]] DoodadDefFlags : std::uint16_t {
    Biodome [[=welder::doc(
      "Sets the internal WDOODADDEF 0x800 flag; meaning unknown "
      "(biodome).")]] = 0x1,
    Shrubbery [[=welder::doc("Shrubbery; not checked by 6.0.1+ clients.")]] = 0x2,
    Unk4 [[=welder::doc("Unknown (Legion+).")]] = 0x4,
    Unk8 [[=welder::doc("Unknown (Legion+).")]] = 0x8,
    Unk10 [[=
      welder::doc("Unknown (Shadowlands+); sets flag 0x4 on the PVS doodad.")]]
    = 0x10,
    LiquidKnown [[=welder::doc("SMDoodadDef::Flag_liquidKnown (Legion+).")]] = 0x20,
    EntryIsFdid [[=welder::doc(
      "name_id is a FileDataID to load directly, not an MMID "
      "index (Legion+).")]] = 0x40,
    Unk100 [[=welder::doc("Unknown (Legion+).")]] = 0x100,
    AcceptProjTextures [[=welder::doc("Accepts projected textures (Legion+).")
    ]] = 0x1000
  };
 
  struct [[
      =welder::weld,
      =welder::doc(R"(
        A WMO placement (the 64-byte MODF record of WDT, WDL and ADT): which
        object, where, and how it is instanced.)")
    ]] SMMapObjDef {
    [[=welder::doc(
      R"(The object: an MWID/MWMO name-table reference, or a FileDataID
                      when flags has EntryIsFdid (Legion+). The WDT global-WMO
                      record ignores it and uses the MWMO content.)")]]
    std::uint32_t nameId = 0;
 
    [[=welder::doc(
      "Unique instance id across the whole map (WDT global-WMO records "
      "leave it unused).")]]
    std::uint32_t uniqueId = 0;
 
    [[=welder::doc("Position, in the map's placement coordinate system.")]]
    C3Vector position{};
 
    [[=welder::doc("Rotation as Euler angles, degrees.")]]
    C3Vector rotation{};
 
    [[=welder::doc(
      "The transformed object's bounding box (position plus the rotated "
      "extents); culling and collision use it.")]]
    CAaBox extents{};
 
    [[=welder::doc("Flags; MapObjDefFlags bits.")]]
    MapObjDefFlags flags{};
 
    [[=welder::doc(
      "The WMO doodad set shown by this instance (MODS index, or MWDR when "
      "use_sets_from_mwds is set).")]]
    std::uint16_t doodadSet = 0;
 
    [[=welder::doc("The WMO name set (renames the same model per instance).")]]
    std::uint16_t nameSet = 0;
 
    [[=welder::doc(
      "Scale, 1024 = 1.0, engaged by the has_scale flag (Legion+); padding "
      "in older clients.")]]
    std::uint16_t scale = 0;
  };
 
  static_assert(sizeof(SMMapObjDef) == 0x40);
 
  struct [[
      =welder::weld,
      =welder::doc(R"(
        An M2 (doodad) placement (the 36-byte MDDF record of ADT, reused by the
        WDL MLDD low-resolution set): which model, where, and at what scale.)")
    ]] SMDoodadDef {
    [[=welder::doc(
      "The model: an MMID name-table reference, or a FileDataID when flags "
      "has entry_is_fdid (Legion+; WDL MLDD entries are always "
      "FileDataIDs).")]]
    std::uint32_t nameId = 0;
 
    [[=welder::doc("Unique instance id across the whole map.")]]
    std::uint32_t uniqueId = 0;
 
    [[=welder::doc("Position, in the map's placement coordinate system.")]]
    C3Vector position{};
 
    [[=welder::doc("Rotation as Euler angles, degrees.")]]
    C3Vector rotation{};
 
    [[=welder::doc("Scale, 1024 = 1.0.")]]
    std::uint16_t scale = 1024;
 
    [[=welder::doc("Flags; DoodadDefFlags bits.")]]
    DoodadDefFlags flags{};
  };
 
  static_assert(sizeof(SMDoodadDef) == 0x24);
}