cui_screen.h

Go to the documentation of this file.

// cui_screen [cusc] - Tag Definition                //
// --------                                         //
// Author: haloman30                               //
// Revision: 2                                    //
// --------                                      //
// 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_cusc "cusc"
 
enum class cui_widget_anchor : uint8_t
{
    top_center,
    center,
    bottom_center,
    top_left,
    center_left,
    bottom_left,
    top_right,
    center_right,
    bottom_right,
    top_fill,
    left_fill,
    right_fill,
    bottom_fill,
    fill,
};
 
 
#pragma pack(push, 1)
struct cui_screen
{
    tag_reference string_reference;
    TAG_BLOCK(basic_components,
    {
        struct bitfield16_flags
        {
            bool hidden : 1;
            bool editor_only : 1;
            bool auto_update : 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; 
        int32_t parent_group_index; 
        data_reference name;
        data_reference description;
        TAG_ENUM8(type,
        {
            rectangle,
            text,
            bitmap,
            ellipse,
        });
 
        cui_widget_anchor anchor;
        vector2 position;
        vector2 size;
        real rotation;
        color _color;
        tag_reference material_override;
        TAG_BLOCK(material_exports,
        {
            data_reference parameter_name;
            field_reference input_value;
        });
        struct bitfield8_text_flags
        {
            bool auto_scale_shadow : 1;
            bool unused1 : 1;
            bool unused2 : 1;
            bool unused3 : 1;
            bool unused4 : 1;
            bool unused5 : 1;
            bool unused6 : 1;
            bool unused7 : 1;
        };
 
        bitfield8_text_flags text_flags; 
        color shadow_color;
        vector2 shadow_offset;
        int8_t character_height;
        data_reference font_name;
        data_reference text;
    });
    TAG_BLOCK(groups,
    {
        struct bitfield16_flags
        {
            bool hidden : 1;
            bool editor_only : 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; 
        cui_widget_anchor anchor;
        data_reference name;
        data_reference description;
    });
};
#pragma pack(pop)
 
class CuiScreenTagClass : public BlamTagClass
{
public:
    CuiScreenTagClass()
    {
        class_name_long = "cui_screen";
        class_name_short = "cusc";
        version = 2;
 
        revisions = {
            {1, "haloman30", "Initial implementation."},
            {2, "haloman30", "Remove unused 'templates' block, add 'components' and 'groups' blocks"},
 
        };
 
        tag_size = 96;
 
        fields =
        {
            new TagReferenceField("string reference", "", { }),
            new BlockField(238, "basic components", "",
            {
                new Bitfield16Field("flags", "",
                {
                    "hidden",
                    "editor only",
                    "auto update",
                }),
                new Int32Field("parent group index", "This index directly matches the index of an entry within the 'groups' block."),
                new DataReferenceField("name", ""),
                new DataReferenceField("description", ""),
                new Enum8Field("type", "",
                {
                    "rectangle",
                    "text",
                    "bitmap",
                    "ellipse",
                }),
                new Enum8Field("anchor", "",
                {
                    "top center",
                    "center",
                    "bottom center",
                    "top left",
                    "center left",
                    "bottom left",
                    "top right",
                    "center right",
                    "bottom right",
                    "top fill",
                    "left fill",
                    "right fill",
                    "bottom fill",
                    "fill",
                }),
                new Vector2Field("position", ""),
                new Vector2Field("size", ""),
                new RealField("rotation", ""),
                new ColorField("color", ""),
                new CommentField("MATERIALS",
                "If you only need to create basic UI elements with standard colors, then you can ignore these fields.\n"
                "\n"
                "If you need more direct control over how your UI elements are presented, then you can override the appearance with a custom material tag. You may also pass any data on to a material tag's parameters, if the material supports them.\n"
                "\n"
                "Note that if your material tag does not have the appropriate input parameters, or you do not link them correctly using the exports block, then some of the appearance data within this block (such as primary color) may not be used."),
                new TagReferenceField("material override", "", { }),
                new BlockField(52, "material exports", "",
                {
                    new DataReferenceField("parameter name", ""),
                    new FieldReferenceField("input value", ""),
                }),
                new CommentField("TEXT",
                "The fields below are only used by text widgets"),
                new Bitfield8Field("text flags", "",
                {
                    "auto scale shadow",
                }),
                new ColorField("shadow color", ""),
                new Vector2Field("shadow offset", ""),
                new Int8Field("character height", ""),
                new DataReferenceField("font name", ""),
                new DataReferenceField("text", ""),
            }),
            new BlockField(67, "groups", "",
            {
                new Bitfield16Field("flags", "",
                {
                    "hidden",
                    "editor only",
                }),
                new Enum8Field("anchor", "",
                {
                    "top center",
                    "center",
                    "bottom center",
                    "top left",
                    "center left",
                    "bottom left",
                    "top right",
                    "center right",
                    "bottom right",
                    "top fill",
                    "left fill",
                    "right fill",
                    "bottom fill",
                    "fill",
                }),
                new DataReferenceField("name", ""),
                new DataReferenceField("description", ""),
            }),
 
        };
    }
};
 
namespace Blam::Content::Tags
{
    BLAM cui_screen* GetCuiScreenTag(std::string tag_path);
}