Merge pull request #3010 from asarium/lua/cmdBriefColors

Add scripting API to access briefing color tags

Author: asarium

code/mission/missionbriefcommon.h

@@ -12,10 +12,12 @@
 #ifndef __MISSIONBRIEFCOMMON_H__
 #define __MISSIONBRIEFCOMMON_H__
 
-#include "anim/packunpack.h"
 #include "globalincs/globals.h"
+
+#include "anim/packunpack.h"
 #include "graphics/generic.h"
 #include "hud/hud.h"
+#include "utils/unicode.h"
 
 #define MAX_TEXT_STREAMS	2		// how many concurrent streams of text can be displayed
 
@@ -321,4 +323,6 @@ void cmd_brief_reset();
 
 int brief_time_to_advance(int stage_num);
 
+bool brief_verify_color_tag(unicode::codepoint_t color_tag);
+
 #endif

code/scpui/RocketRenderingInterface.cpp

@@ -143,15 +143,11 @@ bool RocketRenderingInterface::LoadTexture(TextureHandle& texture_handle, Vector
 
 	std::unique_ptr<Texture> tex(new Texture());
 	// If there is a file that ends with an animation extension, try to load that
-	if (generic_anim_exists(filename.c_str())) {
-		// Load as animation
-		generic_anim_init(&tex->animation, filename);
-		if (generic_anim_stream(&tex->animation) == 0) {
-			tex->is_animation = true;
-
-			texture_dimensions.x = tex->animation.width;
-			texture_dimensions.y = tex->animation.height;
-		}
+	if (generic_anim_init_and_stream(&tex->animation, filename.c_str(), BM_TYPE_NONE, true) == 0) {
+		tex->is_animation = true;
+
+		texture_dimensions.x = tex->animation.width;
+		texture_dimensions.y = tex->animation.height;
 	}
 
 	if (!tex->is_animation) {

code/scripting/api/libs/ui.cpp

@@ -2,19 +2,23 @@
 //
 #include "ui.h"
 
+#include "globalincs/alphacolors.h"
+
 #include "cmdline/cmdline.h"
 #include "gamesnd/eventmusic.h"
 #include "menuui/barracks.h"
 #include "menuui/mainhallmenu.h"
 #include "menuui/optionsmenu.h"
 #include "menuui/playermenu.h"
 #include "menuui/readyroom.h"
+#include "mission/missionbriefcommon.h"
 #include "mission/missioncampaign.h"
 #include "missionui/missionscreencommon.h"
 #include "playerman/managepilot.h"
 #include "scpui/SoundPlugin.h"
 #include "scpui/rocket_ui.h"
 #include "scripting/api/objs/cmd_brief.h"
+#include "scripting/api/objs/color.h"
 #include "scripting/api/objs/player.h"
 #include "scripting/lua/LuaTable.h"
 
@@ -386,6 +390,46 @@ ADE_LIB_DERIV(l_UserInterface_CmdBrief,
 	"API for the new UI system. This should not be used by other code and may be removed in the future!",
 	l_UserInterface);
 
+ADE_VIRTVAR(ColorTags,
+	l_UserInterface_CmdBrief,
+	nullptr,
+	"The available tagged colors",
+	ade_type_map("string", "color"),
+	"A mapping from tag string to color value")
+{
+	using namespace luacpp;
+
+	LuaTable mapping = LuaTable::create(L);
+
+	for (const auto& tagged : Tagged_Colors) {
+		SCP_string tag;
+		tag.resize(1, tagged.first);
+
+		mapping.addValue(tag, l_Color.Set(*tagged.second));
+	}
+
+	return ade_set_args(L, "t", mapping);
+}
+
+ADE_VIRTVAR(DefaultTextColorTag,
+	l_UserInterface_CmdBrief,
+	nullptr,
+	"Gets the default color tag string for the command briefing. Index into ColorTags.",
+	"string",
+	"The default color tag")
+{
+	SCP_string tagStr;
+
+	auto defaultColor = default_command_briefing_color;
+
+	if (defaultColor == '\0' || !brief_verify_color_tag(defaultColor)) {
+		defaultColor = Color_Tags[0];
+	}
+	tagStr.resize(1, defaultColor);
+
+	return ade_set_args(L, "s", tagStr);
+}
+
 ADE_FUNC(getBriefing,
 	l_UserInterface_CmdBrief,
 	nullptr,

code/scripting/api/objs/color.cpp

@@ -0,0 +1,73 @@
+
+#include "color.h"
+
+namespace scripting {
+namespace api {
+
+ADE_OBJ(l_Color, color, "color", "A color value");
+
+// That member syntax is pretty weird to be honest...
+static int colorVarHelper(lua_State* L, ubyte color::*member)
+{
+	color* clr = nullptr;
+	float newVal = -1.0f;
+
+	if (!ade_get_args(L, "o|f", l_Color.GetPtr(&clr), &newVal)) {
+		return ade_set_args(L, "f", -1.0f);
+	}
+
+	if (ADE_SETTING_VAR) {
+		if (newVal < 0.0f || newVal > 255.0f) {
+			LuaError(L, "Invalid color value %f!", newVal);
+			CLAMP(newVal, 0.0f, 255.0f);
+		}
+
+		clr->*member = static_cast<ubyte>(newVal);
+	}
+
+	return ade_set_args(L, "i", clr->*member);
+}
+
+ADE_VIRTVAR(Red,
+	l_Color,
+	"number",
+	"The 'red' value of the color in the range from 0 to 255",
+	"number",
+	"The 'red' value")
+{
+	return colorVarHelper(L, &color::red);
+}
+
+ADE_VIRTVAR(Green,
+	l_Color,
+	"number",
+	"The 'green' value of the color in the range from 0 to 255",
+	"number",
+	"The 'green' value")
+{
+	return colorVarHelper(L, &color::green);
+}
+
+ADE_VIRTVAR(Blue,
+	l_Color,
+	"number",
+	"The 'blue' value of the color in the range from 0 to 255",
+	"number",
+	"The 'blue' value")
+{
+	return colorVarHelper(L, &color::blue);
+}
+
+ADE_VIRTVAR(Alpha,
+	l_Color,
+	"number",
+	"The 'alpha' or opacity value of the color in the range from 0 to 255. 0 is totally transparent, 255 is completely "
+	"opaque.",
+	"number",
+	"The 'alpha' value")
+{
+	return colorVarHelper(L, &color::alpha);
+}
+
+} // namespace api
+} // namespace scripting

code/scripting/api/objs/color.h

@@ -0,0 +1,12 @@
+#pragma once
+
+#include "graphics/2d.h"
+#include "scripting/ade_api.h"
+
+namespace scripting {
+namespace api {
+
+DECLARE_ADE_OBJ(l_Color, color);
+
+}
+} // namespace scripting

code/source_groups.cmake

@@ -1197,6 +1197,8 @@ add_file_folder("Scripting\\\\Api\\\\Objs"
 	scripting/api/objs/cmd_brief.h
 	scripting/api/objs/cockpit_display.cpp
 	scripting/api/objs/cockpit_display.h
+	scripting/api/objs/color.cpp
+	scripting/api/objs/color.h
 	scripting/api/objs/control_info.cpp
 	scripting/api/objs/control_info.h
 	scripting/api/objs/controls.cpp