feat: partially functioning property behavior ui (no saving or loadin…

…g yet) (#1384)

* Add addstrip handling

add SendBehaviorBlocksToClient serialization
add id generation and auto updating
add behaviorlisttoclient serialization

* fix crash

happened if you added state 0 and 6 and nothing in between

* Section off code

Use proper encapsulation to hide code away and only let specific objects do certain jobs.

* Organize serialization

Section off into operational chunks
Write data at the level most appropriate

* Remove and simplify BlockDefinitions

Remove pointer usage for BlockDefinitions and move to optional.

* ControlBehaviors: Add addaction handling

* re-organization

remove const from return value
change to int from uint
use generic methods to reduce code clutter

* add strip ui position handling

* add split strip functionality

* fix issues

fix an issue where if you were on an empty state, the server would allow you to remain on that state
fix an issue where the ui would not open on the previously opened state
fix an issue where deleting strips in order caused the wrong strips to be deleted

* update how you remove behaviors from models

* Add remove actions and rename

* migrate actions

* update action and rearrange strip

* merge strips

* add and move to inventory

* Remove dead code

* simplify code

* nits and move finish MoveToInventory

constify serialize

further include path fixes

use const, comments

fix amf message

Update ModelComponent.cpp

replace operator subscript with at

* Update ModelComponent.cpp

* Update MigrateActionsMessage.h

* const

* Move to separate translation units

* include amf3

its precompiled, but just in case

dGame/dComponents/ModelComponent.cpp

@@ -1,6 +1,12 @@
 #include "ModelComponent.h"
 #include "Entity.h"
 
+#include "Game.h"
+#include "Logger.h"
+
+#include "BehaviorStates.h"
+#include "ControlBehaviorMsgs.h"
+
 ModelComponent::ModelComponent(Entity* parent) : Component(parent) {
 	m_OriginalPosition = m_Parent->GetDefaultPosition();
 	m_OriginalRotation = m_Parent->GetDefaultRotation();
@@ -29,3 +35,40 @@ void ModelComponent::Serialize(RakNet::BitStream* outBitStream, bool bIsInitialU
 	outBitStream->Write1(); // Is this model paused
 	if (bIsInitialUpdate) outBitStream->Write0(); // We are not writing model editing info
 }
+
+void ModelComponent::UpdatePendingBehaviorId(const int32_t newId) {
+	for (auto& behavior : m_Behaviors) if (behavior.GetBehaviorId() == -1) behavior.SetBehaviorId(newId);
+}
+
+void ModelComponent::SendBehaviorListToClient(AMFArrayValue& args) const {
+	args.Insert("objectID", std::to_string(m_Parent->GetObjectID()));
+
+	auto* behaviorArray = args.InsertArray("behaviors");
+	for (auto& behavior : m_Behaviors) {
+		auto* behaviorArgs = behaviorArray->PushArray();
+		behavior.SendBehaviorListToClient(*behaviorArgs);
+	}
+}
+
+void ModelComponent::VerifyBehaviors() {
+	for (auto& behavior : m_Behaviors) behavior.VerifyLastEditedState();
+}
+
+void ModelComponent::SendBehaviorBlocksToClient(int32_t behaviorToSend, AMFArrayValue& args) const {
+	args.Insert("BehaviorID", std::to_string(behaviorToSend));
+	args.Insert("objectID", std::to_string(m_Parent->GetObjectID()));
+	for (auto& behavior : m_Behaviors) if (behavior.GetBehaviorId() == behaviorToSend) behavior.SendBehaviorBlocksToClient(args);
+}
+
+void ModelComponent::AddBehavior(AddMessage& msg) {
+	// Can only have 1 of the loot behaviors
+	for (auto& behavior : m_Behaviors) if (behavior.GetBehaviorId() == msg.GetBehaviorId()) return;
+	m_Behaviors.insert(m_Behaviors.begin() + msg.GetBehaviorIndex(), PropertyBehavior());
+	m_Behaviors.at(msg.GetBehaviorIndex()).HandleMsg(msg);
+}
+
+void ModelComponent::MoveToInventory(MoveToInventoryMessage& msg) {
+	if (msg.GetBehaviorIndex() >= m_Behaviors.size() || m_Behaviors.at(msg.GetBehaviorIndex()).GetBehaviorId() != msg.GetBehaviorId()) return;
+	m_Behaviors.erase(m_Behaviors.begin() + msg.GetBehaviorIndex());
+	// TODO move to the inventory
+}

dGame/dComponents/ModelComponent.h

@@ -1,12 +1,23 @@
 #pragma once
+
+#include <map>
+
 #include "dCommonVars.h"
 #include "RakNetTypes.h"
 #include "NiPoint3.h"
 #include "NiQuaternion.h"
 #include "Component.h"
 #include "eReplicaComponentType.h"
 
+#include "Action.h"
+#include "PropertyBehavior.h"
+#include "StripUiPosition.h"
+
+class AddMessage;
+class AMFArrayValue;
+class BehaviorMessageBase;
 class Entity;
+class MoveToInventoryMessage;
 
 /**
  * Component that represents entities that are a model, e.g. collectible models and BBB models.
@@ -43,7 +54,68 @@ class ModelComponent : public Component {
 	 */
 	void SetRotation(const NiQuaternion& rot) { m_OriginalRotation = rot; }
 
+	/**
+	 * Main gateway for all behavior messages to be passed to their respective behaviors.
+	 * 
+	 * @tparam Msg The message type to pass
+	 * @param args the arguments of the message to be deserialized
+	 */
+	template<typename Msg>
+	void HandleControlBehaviorsMsg(AMFArrayValue* args) {
+		static_assert(std::is_base_of_v<BehaviorMessageBase, Msg>, "Msg must be a BehaviorMessageBase");
+		Msg msg(args);
+		for (auto& behavior : m_Behaviors) {
+			if (behavior.GetBehaviorId() == msg.GetBehaviorId()) { 
+				behavior.HandleMsg(msg);
+				return;
+			}
+		}
+
+		// If we somehow added more than 5 behaviors, resize to 5.
+		if (m_Behaviors.size() > 5) m_Behaviors.resize(5);
+
+		// Do not allow more than 5 to be added. The client UI will break if you do!
+		if (m_Behaviors.size() == 5) return;
+
+		auto newBehavior = m_Behaviors.insert(m_Behaviors.begin(), PropertyBehavior());
+		// Generally if we are inserting a new behavior, it is because the client is creating a new behavior.
+		// However if we are testing behaviors the behavior will not exist on the initial pass, so we set the ID here to that of the msg.
+		// This will either set the ID to -1 (no change in the current default) or set the ID to the ID of the behavior we are testing.
+		newBehavior->SetBehaviorId(msg.GetBehaviorId());
+		newBehavior->HandleMsg(msg);
+	};
+
+	void AddBehavior(AddMessage& msg);
+
+	void MoveToInventory(MoveToInventoryMessage& msg);
+
+	// Updates the pending behavior ID to the new ID.
+	void UpdatePendingBehaviorId(const int32_t newId);
+
+	// Sends the behavior list to the client.
+
+	/**
+	 * The behaviors AMFArray will have up to 5 elements in the dense portion.
+	 * Each element in the dense portion will be made up of another AMFArray
+	 * with the following information mapped in the associative portion
+	 * "id": Behavior ID cast to an AMFString
+	 * "isLocked": AMFTrue or AMFFalse of whether or not the behavior is locked
+	 * "isLoot": AMFTrue or AMFFalse of whether or not the behavior is a custom behavior (true if custom)
+	 * "name": The name of the behavior formatted as an AMFString
+	 */
+	void SendBehaviorListToClient(AMFArrayValue& args) const;
+
+	void SendBehaviorBlocksToClient(int32_t behaviorToSend, AMFArrayValue& args) const;
+
+	void VerifyBehaviors();
+
 private:
+	/**
+	 * The behaviors of the model
+	 * Note: This is a vector because the order of the behaviors matters when serializing to the client.
+	 * Note: No two PropertyBehaviors should have the same behavior ID.
+	 */
+	std::vector<PropertyBehavior> m_Behaviors;
 
 	/**
 	 * The original position of the model

dGame/dPropertyBehaviors/CMakeLists.txt

@@ -1,4 +1,7 @@
 set(DGAME_DPROPERTYBEHAVIORS_SOURCES
+	"PropertyBehavior.cpp"
+	"State.cpp"
+	"Strip.cpp"
 	"BlockDefinition.cpp"
 	"ControlBehaviors.cpp"
 )

dGame/dPropertyBehaviors/ControlBehaviorMessages/Action.cpp

@@ -1,4 +1,5 @@
 #include "Action.h"
+#include "Amf3.h"
 
 Action::Action() {	
 	type = "";
@@ -12,20 +13,34 @@ Action::Action(AMFArrayValue* arguments) {
 	valueParameterName = "";
 	valueParameterString = "";
 	valueParameterDouble = 0.0;
-	for (auto& typeValueMap : arguments->GetAssociative()) {
-		if (typeValueMap.first == "Type") {
-			if (typeValueMap.second->GetValueType() != eAmf::String) continue;
-			type = static_cast<AMFStringValue*>(typeValueMap.second)->GetValue();
+	for (auto& [paramName, paramValue] : arguments->GetAssociative()) {
+		if (paramName == "Type") {
+			if (paramValue->GetValueType() != eAmf::String) continue;
+			type = static_cast<AMFStringValue*>(paramValue)->GetValue();
 		} else {
-			valueParameterName = typeValueMap.first;
+			valueParameterName = paramName;
 			// Message is the only known string parameter
 			if (valueParameterName == "Message") {
-				if (typeValueMap.second->GetValueType() != eAmf::String) continue;
-				valueParameterString = static_cast<AMFStringValue*>(typeValueMap.second)->GetValue();
+				if (paramValue->GetValueType() != eAmf::String) continue;
+				valueParameterString = static_cast<AMFStringValue*>(paramValue)->GetValue();
 			} else {
-				if (typeValueMap.second->GetValueType() != eAmf::Double) continue;
-				valueParameterDouble = static_cast<AMFDoubleValue*>(typeValueMap.second)->GetValue();
+				if (paramValue->GetValueType() != eAmf::Double) continue;
+				valueParameterDouble = static_cast<AMFDoubleValue*>(paramValue)->GetValue();
 			}
 		}
 	}
 }
+
+void Action::SendBehaviorBlocksToClient(AMFArrayValue& args) const {
+	auto* actionArgs = args.PushArray();
+	actionArgs->Insert("Type", type);
+
+	auto valueParameterName = GetValueParameterName();
+	if (valueParameterName.empty()) return;
+
+	if (valueParameterName == "Message") {
+		actionArgs->Insert(valueParameterName, valueParameterString);
+	} else {
+		actionArgs->Insert(valueParameterName, valueParameterDouble);
+	}
+}

dGame/dPropertyBehaviors/ControlBehaviorMessages/Action.h

@@ -1,7 +1,9 @@
 #ifndef __ACTION__H__
 #define __ACTION__H__
 
-#include "BehaviorMessageBase.h"
+#include <string>
+
+class AMFArrayValue;
 
 /**
  * @brief Sent if a ControlBehavior message has an Action associated with it
@@ -11,10 +13,12 @@ class Action {
 public:
 	Action();
 	Action(AMFArrayValue* arguments);
-	const std::string& GetType() { return type; };
-	const std::string& GetValueParameterName() { return valueParameterName; };
-	const std::string& GetValueParameterString() { return valueParameterString; };
-	const double GetValueParameterDouble() { return valueParameterDouble; };
+	const std::string& GetType() const { return type; };
+	const std::string& GetValueParameterName() const { return valueParameterName; };
+	const std::string& GetValueParameterString() const { return valueParameterString; };
+	const double GetValueParameterDouble() const { return valueParameterDouble; };
+
+	void SendBehaviorBlocksToClient(AMFArrayValue& args) const;
 private:
 	std::string type;
 	std::string valueParameterName;

dGame/dPropertyBehaviors/ControlBehaviorMessages/ActionContext.h

@@ -14,8 +14,8 @@ class ActionContext {
 public:
 	ActionContext();
 	ActionContext(AMFArrayValue* arguments, std::string customStateKey = "stateID", std::string customStripKey = "stripID");
-	const StripId GetStripId() { return stripId; };
-	const BehaviorState GetStateId() { return stateId; };
+	const StripId GetStripId() const { return stripId; };
+	const BehaviorState GetStateId() const { return stateId; };
 private:
 	BehaviorState GetBehaviorStateFromArgument(AMFArrayValue* arguments, const std::string& key);
 	StripId GetStripIdFromArgument(AMFArrayValue* arguments, const std::string& key);

dGame/dPropertyBehaviors/ControlBehaviorMessages/AddActionMessage.h

@@ -14,11 +14,11 @@ class AMFArrayValue;
 class AddActionMessage : public BehaviorMessageBase {
 public:
 	AddActionMessage(AMFArrayValue* arguments);
-	const uint32_t GetActionIndex() { return actionIndex; };
-	Action GetAction() { return action; };
-	ActionContext GetActionContext() { return actionContext; };
+	int32_t GetActionIndex() const { return actionIndex; };
+	Action GetAction() const { return action; };
+	ActionContext GetActionContext() const { return actionContext; };
 private:
-	uint32_t actionIndex;
+	int32_t actionIndex = -1;
 	ActionContext actionContext;
 	Action action;
 };

dGame/dPropertyBehaviors/ControlBehaviorMessages/AddMessage.h

@@ -10,7 +10,7 @@
 class AddMessage : public BehaviorMessageBase {
 public:
 	AddMessage(AMFArrayValue* arguments);
-	const uint32_t GetBehaviorIndex() { return behaviorIndex; };
+	const uint32_t GetBehaviorIndex() const { return behaviorIndex; };
 private:
 	uint32_t behaviorIndex;
 };

dGame/dPropertyBehaviors/ControlBehaviorMessages/AddStripMessage.h

@@ -19,9 +19,9 @@ class AMFArrayValue;
 class AddStripMessage : public BehaviorMessageBase {
 public:
 	AddStripMessage(AMFArrayValue* arguments);
-	StripUiPosition GetPosition() { return position; };
-	ActionContext GetActionContext() { return actionContext; };
-	std::vector<Action> GetActionsToAdd() { return actionsToAdd; };
+	StripUiPosition GetPosition() const { return position; };
+	ActionContext GetActionContext() const { return actionContext; };
+	std::vector<Action> GetActionsToAdd() const { return actionsToAdd; };
 private:
 	StripUiPosition position;
 	ActionContext actionContext;

dGame/dPropertyBehaviors/ControlBehaviorMessages/BehaviorMessageBase.cpp

@@ -5,29 +5,27 @@
 #include "dCommonVars.h"
 
 BehaviorMessageBase::BehaviorMessageBase(AMFArrayValue* arguments) {
-	behaviorId = 0;
 	behaviorId = GetBehaviorIdFromArgument(arguments);
 }
 
 int32_t BehaviorMessageBase::GetBehaviorIdFromArgument(AMFArrayValue* arguments) {
 	const auto* key = "BehaviorID";
 	auto* behaviorIDValue = arguments->Get<std::string>(key);
-	int32_t behaviorID = -1;
 
 	if (behaviorIDValue && behaviorIDValue->GetValueType() == eAmf::String) {
-		behaviorID = std::stoul(behaviorIDValue->GetValue());
-	} else if (arguments->Get(key)->GetValueType() != eAmf::Undefined) {
+		GeneralUtils::TryParse(behaviorIDValue->GetValue(), behaviorId);
+	} else if (arguments->Get(key) && arguments->Get(key)->GetValueType() != eAmf::Undefined) {
 		throw std::invalid_argument("Unable to find behavior ID");
 	}
 
-	return behaviorID;
+	return behaviorId;
 }
 
-uint32_t BehaviorMessageBase::GetActionIndexFromArgument(AMFArrayValue* arguments, const std::string& keyName) {
+int32_t BehaviorMessageBase::GetActionIndexFromArgument(AMFArrayValue* arguments, const std::string& keyName) {
 	auto* actionIndexAmf = arguments->Get<double>(keyName);
 	if (!actionIndexAmf) {
 		throw std::invalid_argument("Unable to find actionIndex");
 	}
 
-	return static_cast<uint32_t>(actionIndexAmf->GetValue());
+	return static_cast<int32_t>(actionIndexAmf->GetValue());
 }

dGame/dPropertyBehaviors/ControlBehaviorMessages/BehaviorMessageBase.h

@@ -7,9 +7,6 @@
 #include "Amf3.h"
 #include "dCommonVars.h"
 
-#include "Game.h"
-#include "Logger.h"
-
 enum class BehaviorState : uint32_t;
 
 /**
@@ -18,12 +15,14 @@ enum class BehaviorState : uint32_t;
  */
 class BehaviorMessageBase {
 public:
-	const uint32_t GetBehaviorId() { return behaviorId; };
-protected:
+	static inline int32_t DefaultBehaviorId = -1;
+	const int32_t GetBehaviorId() const { return behaviorId; };
+	bool IsDefaultBehaviorId() { return behaviorId == DefaultBehaviorId; };
 	BehaviorMessageBase(AMFArrayValue* arguments);
+protected:
 	int32_t GetBehaviorIdFromArgument(AMFArrayValue* arguments);
-	uint32_t GetActionIndexFromArgument(AMFArrayValue* arguments, const std::string& keyName = "actionIndex");
-	int32_t behaviorId = -1; 
+	int32_t GetActionIndexFromArgument(AMFArrayValue* arguments, const std::string& keyName = "actionIndex");
+	int32_t behaviorId = DefaultBehaviorId;
 };
 
 #endif  //!__BEHAVIORMESSAGEBASE__H__

dGame/dPropertyBehaviors/ControlBehaviorMessages/ControlBehaviorMsgs.h

@@ -0,0 +1,23 @@
+#ifndef __CONTROLBEHAVIORMSGS__H__
+#define __CONTROLBEHAVIORMSGS__H__
+
+#include "Action.h"
+#include "ActionContext.h"
+#include "AddActionMessage.h"
+#include "AddMessage.h"
+#include "AddStripMessage.h"
+#include "BehaviorMessageBase.h"
+#include "ControlBehaviorMsgs.h"
+#include "MergeStripsMessage.h"
+#include "MigrateActionsMessage.h"
+#include "MoveToInventoryMessage.h"
+#include "RearrangeStripMessage.h"
+#include "RemoveActionsMessage.h"
+#include "RemoveStripMessage.h"
+#include "RenameMessage.h"
+#include "SplitStripMessage.h"
+#include "StripUiPosition.h"
+#include "UpdateActionMessage.h"
+#include "UpdateStripUiMessage.h"
+
+#endif  //!__CONTROLBEHAVIORMSGS__H__

dGame/dPropertyBehaviors/ControlBehaviorMessages/MergeStripsMessage.h

@@ -1,6 +1,7 @@
 #ifndef __MERGESTRIPSMESSAGE__H__
 #define __MERGESTRIPSMESSAGE__H__
 
+#include "Action.h"
 #include "ActionContext.h"
 #include "BehaviorMessageBase.h"
 
@@ -13,13 +14,16 @@ class AMFArrayValue;
 class MergeStripsMessage : public BehaviorMessageBase {
 public:
 	MergeStripsMessage(AMFArrayValue* arguments);
-	const uint32_t GetDstActionIndex() { return dstActionIndex; };
-	ActionContext GetSourceActionContext() { return sourceActionContext; };
-	ActionContext GetDestinationActionContext() { return destinationActionContext; };
+	int32_t GetDstActionIndex() const { return dstActionIndex; };
+	ActionContext GetSourceActionContext() const { return sourceActionContext; };
+	ActionContext GetDestinationActionContext() const { return destinationActionContext; };
+	const std::vector<Action>& GetMigratedActions() const { return migratedActions; };
+	void SetMigratedActions(std::vector<Action>::const_iterator start, std::vector<Action>::const_iterator end) { migratedActions.assign(start, end); };
 private:
+	std::vector<Action> migratedActions;
 	ActionContext sourceActionContext;
 	ActionContext destinationActionContext;
-	uint32_t dstActionIndex;
+	int32_t dstActionIndex;
 };
 
 #endif  //!__MERGESTRIPSMESSAGE__H__