decorator_set.h

Go to the documentation of this file.

// decorator_set [dctr] - Tag Definition          //
// --------                                      //
// Part of the Blamite Game Engine              //
// Copyright (c) Elaztek Studios 2013 - 2023   //
 
 
#pragma once
 
#include <string>
#include <blam/api/v1/types/tags.h>
#include <blam/api/v1/types/plugins.h>
 
#ifndef BLAM
#define BLAM
#endif
 
#define tag_dctr "dctr"
 
 
 
#pragma pack(push, 1)
struct decorator_set
{
    vector2 lod0_distance;
    vector2 lod1_distance;
    vector2 lod2_distance;
    vector2 lod3_distance;
    TAG_BLOCK(variants,
    {
        data_reference identifier; 
        struct bitfield16_flags
        {
            bool random_rotation : 1;
            bool random_scale : 1;
            bool unused2 : 1;
            bool unused3 : 1;
            bool unused4 : 1;
            bool unused5 : 1;
            bool unused6 : 1;
            bool unused7 : 1;
            bool unused8 : 1;
            bool unused9 : 1;
            bool unused10 : 1;
            bool unused11 : 1;
            bool unused12 : 1;
            bool unused13 : 1;
            bool unused14 : 1;
            bool unused15 : 1;
        };
 
        bitfield16_flags flags; 
        TAG_BLOCK(LODs,
        {
            tag_reference model;
            int8_t lod;
        });
        vector3 min_scale;
        vector3 max_scale;
        real minimum_distance_between_decorators; 
        real placement_weight; 
    });
};
#pragma pack(pop)
 
class DecoratorSetTagClass : public BlamTagClass
{
public:
    DecoratorSetTagClass()
    {
        class_name_long = "decorator_set";
        class_name_short = "dctr";
        version = 0;
 
        revisions = {
 
        };
 
        tag_size = 64;
 
        fields =
        {
            new CommentField("LOD Distances",
            "LOD levels range from 0 to 3, with 0 being the best quality model and 3 being the worst quality.\n"
            "\n"
            "All distances listed below are used to determine at which point LOD models are visible. Only one LOD level will be visible at any given time."),
            new Vector2Field("LOD0 (base) distance", ""),
            new Vector2Field("LOD1 distance", ""),
            new Vector2Field("LOD2 distance", ""),
            new Vector2Field("LOD3 distance", ""),
            new CommentField("Decorator Variants",
            "These settings specify available variants for decorators. All decorators can specify available LOD models, as well as default placement settings. The placement settings below only apply when initially placing decorators, and will not automatically re-apply."),
            new BlockField(98, "variants", "",
            {
                new DataReferenceField("identifier", "Must be unique to this decorator."),
                new Bitfield16Field("flags", "",
                {
                    "random rotation",
                    "random scale",
                }),
                new BlockField(33, "LODs", "",
                {
                    new TagReferenceField("model", "", { }),
                    new Int8Field("lod", ""),
                }),
                new Vector3Field("min scale", ""),
                new Vector3Field("max scale", ""),
                new RealField("minimum distance between decorators", "The minimum distance (in WU) allowed between placements"),
                new RealField("placement weight", "When placing a decorator set without a specific type selected, weight value is used to determine the distribution of types"),
            }),
 
        };
    }
};
 
namespace Blam::Content::Tags
{
    BLAM decorator_set* GetDecoratorSetTag(std::string tag_path);
}