scenario.h

Go to the documentation of this file.

#pragma once
 
#include <blam/components/content/tags/tagclass.h>
#include <blam/components/content/tags/fields.h>
 
#ifndef BLAM
#define BLAM
#endif
 
struct scenario
{
    TAG_ENUM(type,
    {
        solo,
        multiplayer,
        main_menu,
        multiplayer_shared,
        singleplayer_shared
    });
 
    TAG_BLOCK(project_folders,
    {
        bitfield8 flags;
        int folder_id;
        int parent_folder_id;
        ascii folder_name;
    });
 
    TAG_BLOCK(primitives,
    {
        int folder_id;
        ascii name;
        ascii description;
 
        TAG_ENUM(type,
        {
            cuboid,
            cylinder
        });
 
        real x;
        real y;
        real z;
        real yaw;
        real pitch;
        real roll;
        real scale_x;
        real scale_y;
        real scale_z;
 
        real cylinder_radius_0;
        real cylinder_radius_1;
        int cylinder_resolution;
    });
};
 
namespace Blam::Content::Tags::Classes
{
    class ScenarioTagClass : public BlamTagClass
    {
    public:
        ScenarioTagClass()
        {
            class_name_long = "scenario";
            class_name_short = "scnr";
            version = 2;
 
            revisions = {
                {1, "haloman30", "Initial implementation."},
                {2, "haloman30", "Added 'project folders' block."}
            };
 
            tag_size = sizeof(scenario);
 
            fields =
            {
                new Enum32Field("type", "", 
                {
                    "solo",
                    "multiplayer",
                    "main menu",
                    "multiplayer shared",
                    "singleplayer shared"
                }),
                new Int32Field("unused padding", ""),
                new BlockField(sizeof(scenario::project_folders_entry), "project folders", "Contains information about project folders. Only used within the editor.", 
                {
                    new Bitfield8Field("flags", "List of flags that apply to this folder.", 
                    {
                        "has parent folder"
                    }),
                    new Int32Field("folder id", "The ID of this folder."),
                    new Int32Field("parent folder id", "The ID of this folder's parent folder, if applicable."),
                    new AsciiField("folder name", "The display name of the folder.")
                }),
                new BlockField(sizeof(scenario::primitives_entry), "primitives", "List of primitive objects contained within the scenario.", 
                {
                    new Int32Field("folder id", "the folder id that this primitive exists within. set to -1 to have no parent"),
                    new AsciiField("name", "custom display name for the object"),
                    new AsciiField("description", "custom description for the object"),
 
                    new Enum32Field("type", "The type of this primitive.",
                    {
                        "cuboid",
                        "cylinder"
                    }),
 
                    new CommentField("POSITION", ""),
                    new RealField("x", ""),
                    new RealField("y", ""),
                    new RealField("z", ""),
 
                    new CommentField("ROTATION", ""),
                    new RealField("yaw", ""),
                    new RealField("pitch", ""),
                    new RealField("roll", ""),
 
                    new CommentField("SCALE", ""),
                    new RealField("scale x", ""),
                    new RealField("scale y", ""),
                    new RealField("scale z", ""),
 
                    new CommentField("cylinder specific properties", ""),
                    new RealField("cylinder radius 0", ""),
                    new RealField("cylinder radius 1", ""),
                    new Int32Field("cylinder resolution", ""),
                })
            };
        }
    };
}