scenario.h

Go to the documentation of this file.

// scenario [scnr] - Tag Definition                  //
// --------                                         //
// Author: haloman30                               //
// Revision: 4                                    //
// --------                                      //
// 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
 
 
 
#pragma pack(push, 1)
struct scenario
{
    TAG_ENUM(type,
    {
        solo,
        multiplayer,
        main_menu,
        multiplayer_shared,
        singleplayer_shared,
    });
 
    TAG_BLOCK(project_folders,
    {
        bitfield8 flags; 
        int32_t folder_id; 
        int32_t parent_folder_id; 
        data_reference folder_name; 
    });
    TAG_BLOCK(primitives,
    {
        int32_t folder_id; 
        data_reference name; 
        data_reference description; 
 
        TAG_ENUM(type,
        {
            cuboid,
            cylinder,
        });
 
        tag_reference material_override;
        //POSITION
        
        vector3 position;
        vector3 rotation;
        vector3 scale;
        //cylinder specific properties
        
        vector2 cylinder_radius;
        int32_t cylinder_resolution;
    });
    TAG_BLOCK(render_models,
    {
        int32_t palette_index;
        int32_t folder_index;
        data_reference name;
        bitfield16 placement_flags;
        vector3 transform;
        vector3 rotation;
        vector3 scale;
    });
    TAG_BLOCK(render_models_palette,
    {
        tag_reference tag;
    });
    TAG_BLOCK(lights,
    {
        int32_t palette_index;
        int32_t folder_index;
        data_reference name;
        bitfield16 placement_flags;
        vector3 transform;
        vector3 rotation;
        vector3 scale;
    });
    TAG_BLOCK(lights_palette,
    {
        tag_reference tag;
    });
};
#pragma pack(pop)
 
class ScenarioTagClass : public BlamTagClass
{
public:
    ScenarioTagClass()
    {
        class_name_long = "scenario";
        class_name_short = "scnr";
        version = 4;
 
        revisions = {
            {1, "haloman30", "Initial implementation."},
            {2, "haloman30", "Added 'project folders' block."},
            {3, "haloman30", "Replaced several real values with vectors."},
            {4, "haloman30", "Add support for material overrides for primitives"},
 
        };
 
        tag_size = 196;
 
        fields =
        {
            new Enum32Field("type", "",
            {
                "solo",
                "multiplayer",
                "main menu",
                "multiplayer shared",
                "singleplayer shared",
            }),
            new BlockField(41, "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 DataReferenceField("folder name", "The display name of the folder."),
            }),
            new BlockField(152, "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 DataReferenceField("name", "custom display name for the object"),
                new DataReferenceField("description", "custom description for the object"),
                new Enum32Field("type", "The type of this primitive.",
                {
                    "cuboid",
                    "cylinder",
                }),
                new TagReferenceField("material override", "", { }),
                new CommentField("POSITION",
                ""),
                new Vector3Field("position", ""),
                new Vector3Field("rotation", ""),
                new Vector3Field("scale", ""),
                new CommentField("cylinder specific properties",
                ""),
                new Vector2Field("radius", ""),
                new Int32Field("cylinder resolution", ""),
            }),
            new BlockField(78, "render models", "",
            {
                new Int32Field("palette index", ""),
                new Int32Field("folder index", ""),
                new DataReferenceField("name", ""),
                new Bitfield16Field("placement flags", "",
                {
                }),
                new Vector3Field("transform", ""),
                new Vector3Field("rotation", ""),
                new Vector3Field("scale", ""),
            }),
            new BlockField(32, "render models palette", "",
            {
                new TagReferenceField("tag", "", { }),
            }),
            new BlockField(78, "lights", "",
            {
                new Int32Field("palette index", ""),
                new Int32Field("folder index", ""),
                new DataReferenceField("name", ""),
                new Bitfield16Field("placement flags", "",
                {
                }),
                new Vector3Field("transform", ""),
                new Vector3Field("rotation", ""),
                new Vector3Field("scale", ""),
            }),
            new BlockField(32, "lights palette", "",
            {
                new TagReferenceField("tag", "", { }),
            }),
 
        };
    }
};
 
namespace Blam::Content::Tags
{
    BLAM scenario* GetScenarioTag(std::string tag_path);
}