DarkflameServer/dGame/dComponents/QuickBuildComponent.h

366 lines
10 KiB
C
Raw Normal View History

#ifndef QUICKBUILDCOMPONENT_H
#define QUICKBUILDCOMPONENT_H
#include "BitStream.h"
#include <vector>
#include <string>
#include "dCommonVars.h"
#include "NiPoint3.h"
#include "ScriptedActivityComponent.h"
#include "Preconditions.h"
#include "Component.h"
#include "eReplicaComponentType.h"
#include "eQuickBuildState.h"
class Entity;
enum class eQuickBuildFailReason : uint32_t;
/**
* Component that handles entities that can be built into other entities using the quick build mechanic. Generally
* consists of an activator that shows a popup and then the actual entity that the bricks are built into. Note
* that quick builds are also scripted activities so this shared some logic with the ScriptedActivityComponent.
*/
class QuickBuildComponent final : public Component {
public:
static constexpr eReplicaComponentType ComponentType = eReplicaComponentType::QUICK_BUILD;
2022-07-28 13:39:57 +00:00
QuickBuildComponent(Entity* const entity);
~QuickBuildComponent() override;
void Serialize(RakNet::BitStream* outBitStream, bool bIsInitialUpdate) override;
void Update(float deltaTime) override;
2022-07-28 13:39:57 +00:00
/**
* Handles a OnUse event from some entity, initiating the quick build
* @param originator the entity that triggered the event
*/
void OnUse(Entity* originator) override;
2022-07-28 13:39:57 +00:00
/**
* Spawns the activator that can be used to initiate the quickbuild
2022-07-28 13:39:57 +00:00
*/
void SpawnActivator();
2022-07-28 13:39:57 +00:00
/**
* Despawns the activiator that can be used to initiate the quickbuild
2022-07-28 13:39:57 +00:00
*/
void DespawnActivator();
2022-07-28 13:39:57 +00:00
/**
* Returns the entity that acts as the activator for this quickbuild
* @return the entity that acts as the activator for this quickbuild
2022-07-28 13:39:57 +00:00
*/
[[nodiscard]] Entity* GetActivator() const;
2022-07-28 13:39:57 +00:00
/**
* Returns the spawn position of the activator for this quickbuild, if any
* @return the spawn position of the activator for this quickbuild, if any
2022-07-28 13:39:57 +00:00
*/
[[nodiscard]] NiPoint3 GetActivatorPosition() const noexcept;
2022-07-28 13:39:57 +00:00
/**
* Sets the spawn position for the activator of this quickbuild
2022-07-28 13:39:57 +00:00
* @param value the spawn position to set for the activator
*/
void SetActivatorPosition(const NiPoint3& value) noexcept;
2022-07-28 13:39:57 +00:00
/**
* Returns the time it takes for the quickbuild to reset after being built
* @return the time it takes for the quickbuild to reset after being built
2022-07-28 13:39:57 +00:00
*/
[[nodiscard]] float GetResetTime() const noexcept;
2022-07-28 13:39:57 +00:00
/**
* Sets the time it takes for the quickbuild to reset after being built
2022-07-28 13:39:57 +00:00
* @param value the reset time to set
*/
void SetResetTime(const float value) noexcept;
2022-07-28 13:39:57 +00:00
/**
* Returns the time it takes to complete the quickbuild
* @return the time it takes to complete the quickbuild
2022-07-28 13:39:57 +00:00
*/
[[nodiscard]] float GetCompleteTime() const noexcept;
2022-07-28 13:39:57 +00:00
/**
* Sets the time it takes to complete the quickbuild
2022-07-28 13:39:57 +00:00
* @param value the completion time to set
*/
void SetCompleteTime(const float value) noexcept;
2022-07-28 13:39:57 +00:00
/**
* Returns the imagination that's taken when completing the quickbuild
* @return the imagination that's taken when completing the quickbuild
2022-07-28 13:39:57 +00:00
*/
[[nodiscard]] int32_t GetTakeImagination() const noexcept;
2022-07-28 13:39:57 +00:00
/**
* Sets the imagination that's taken when completing the quickbuild
2022-07-28 13:39:57 +00:00
* @param value the imagination deduction to set
*/
void SetTakeImagination(const int32_t value) noexcept;
2022-07-28 13:39:57 +00:00
/**
* Returns if the quickbuild can be interrupted, currently unused
* @return if the quickbuild can be interrupted
2022-07-28 13:39:57 +00:00
*/
[[nodiscard]] bool GetInterruptible() const noexcept;
2022-07-28 13:39:57 +00:00
/**
* Sets whether or not the quickbuild can be interrupted, currently unused
* @param value true if the quickbuild may be interrupted, false otherwise
2022-07-28 13:39:57 +00:00
*/
void SetInterruptible(const bool value) noexcept;
2022-07-28 13:39:57 +00:00
/**
* Returns whether or not this entity contains a built-in activator
* @return whether or not this entity contains a built-in activator
*/
[[nodiscard]] bool GetSelfActivator() const noexcept;
2022-07-28 13:39:57 +00:00
/**
* Sets whether or not this entity contains a built-in activator. If set to false this will spawn activators on
* each new quickbuild.
2022-07-28 13:39:57 +00:00
* @param value whether or not this entity contains a built-in activator
*/
void SetSelfActivator(const bool value) noexcept;
2022-07-28 13:39:57 +00:00
/**
* Currently unused
*/
[[nodiscard]] std::vector<int32_t> GetCustomModules() const noexcept;
2022-07-28 13:39:57 +00:00
/**
* Currently unused
*/
void SetCustomModules(const std::vector<int32_t>& value) noexcept;
2022-07-28 13:39:57 +00:00
/**
* Returns the activity ID for participating in this quickbuild
* @return the activity ID for participating in this quickbuild
2022-07-28 13:39:57 +00:00
*/
[[nodiscard]] int32_t GetActivityId() const noexcept;
2022-07-28 13:39:57 +00:00
/**
* Sets the activity ID for participating in this quickbuild
2022-07-28 13:39:57 +00:00
* @param value the activity ID to set
*/
void SetActivityId(const int32_t value) noexcept;
2022-07-28 13:39:57 +00:00
/**
* Currently unused
*/
[[nodiscard]] int32_t GetPostImaginationCost() const noexcept;
2022-07-28 13:39:57 +00:00
/**
* Currently unused
*/
void SetPostImaginationCost(const int32_t value) noexcept;
2022-07-28 13:39:57 +00:00
/**
* Returns the time it takes for an incomplete quickbuild to be smashed automatically
* @return the time it takes for an incomplete quickbuild to be smashed automatically
2022-07-28 13:39:57 +00:00
*/
[[nodiscard]] float GetTimeBeforeSmash() const noexcept;
2022-07-28 13:39:57 +00:00
/**
* Sets the time it takes for an incomplete quickbuild to be smashed automatically
2022-07-28 13:39:57 +00:00
* @param value the time to set
*/
void SetTimeBeforeSmash(const float value) noexcept;
2022-07-28 13:39:57 +00:00
/**
* Returns the current quickbuild state
* @return the current quickbuild state
2022-07-28 13:39:57 +00:00
*/
[[nodiscard]] eQuickBuildState GetState() const noexcept;
2022-07-28 13:39:57 +00:00
/**
* Returns the player that is currently building this quickbuild
* @return the player that is currently building this quickbuild
2022-07-28 13:39:57 +00:00
*/
[[nodiscard]] Entity* GetBuilder() const;
2022-07-28 13:39:57 +00:00
/**
* Returns whether or not the player is repositioned when initiating the quickbuild
* @return whether or not the player is repositioned when initiating the quickbuild
2022-07-28 13:39:57 +00:00
*/
[[nodiscard]] bool GetRepositionPlayer() const noexcept;
2022-07-28 13:39:57 +00:00
/**
* Sets whether or not the player is repositioned when initiating the quickbuild
* @param value whether or not the player is repositioned when initiating the quickbuild
2022-07-28 13:39:57 +00:00
*/
void SetRepositionPlayer(const bool value) noexcept;
2022-07-28 13:39:57 +00:00
/**
* Adds a callback that is called when the quickbuild is completed
2022-07-28 13:39:57 +00:00
* @param callback the callback to add
*/
void AddQuickBuildCompleteCallback(const std::function<void(Entity* user)>& callback);
2022-07-28 13:39:57 +00:00
/**
* Adds a callback when the quickbuild state is updated
2022-07-28 13:39:57 +00:00
* @param callback the callback to add
*/
void AddQuickBuildStateCallback(const std::function<void(eQuickBuildState state)>& callback);
2022-07-28 13:39:57 +00:00
/**
* Resets the quickbuild
* @param failed whether or not the player failed to complete the quickbuild, triggers an extra animation
2022-07-28 13:39:57 +00:00
*/
void ResetQuickBuild(const bool failed);
2022-07-28 13:39:57 +00:00
/**
* Cancels the quickbuild if it wasn't completed
2022-07-28 13:39:57 +00:00
* @param builder the player that's currently building
* @param failReason the reason the quickbuild was cancelled
* @param skipChecks whether or not to skip the check for the quickbuild not being completed
2022-07-28 13:39:57 +00:00
*/
void CancelQuickBuild(Entity* const builder, const eQuickBuildFailReason failReason, const bool skipChecks = false);
private:
2022-07-28 13:39:57 +00:00
/**
* Whether or not the quickbuild state has been changed since we last serialized it.
*/
bool m_StateDirty = true;
/**
* The state the quickbuild is currently in
2022-07-28 13:39:57 +00:00
*/
eQuickBuildState m_State = eQuickBuildState::OPEN;
2022-07-28 13:39:57 +00:00
/**
* The time that has passed since initiating the quickbuild
2022-07-28 13:39:57 +00:00
*/
float m_Timer = 0;
2022-07-28 13:39:57 +00:00
/**
* The time that has passed before completing the quickbuild
2022-07-28 13:39:57 +00:00
*/
float m_TimerIncomplete = 0;
2022-07-28 13:39:57 +00:00
/**
* The position that the quickbuild activator is spawned at
2022-07-28 13:39:57 +00:00
*/
NiPoint3 m_ActivatorPosition = NiPoint3Constant::ZERO;
2022-07-28 13:39:57 +00:00
/**
* The entity that represents the quickbuild activator
2022-07-28 13:39:57 +00:00
*/
Entity* m_Activator = nullptr;
2022-07-28 13:39:57 +00:00
/**
* The ID of the entity that represents the quickbuild activator
2022-07-28 13:39:57 +00:00
*/
LWOOBJID m_ActivatorId = LWOOBJID_EMPTY;
2022-07-28 13:39:57 +00:00
/**
* Triggers the blinking that indicates that the quickbuild is resetting
2022-07-28 13:39:57 +00:00
*/
bool m_ShowResetEffect = false;
2022-07-28 13:39:57 +00:00
/**
* Currently unused
*/
float m_Taken = 0;
2022-07-28 13:39:57 +00:00
/**
* The callbacks that are called when the quickbuild is completed
2022-07-28 13:39:57 +00:00
*/
std::vector<std::function<void(Entity* user)>> m_QuickBuildCompleteCallbacks{};
2022-07-28 13:39:57 +00:00
/**
* The callbacks that are called when the quickbuild state is updated
2022-07-28 13:39:57 +00:00
*/
std::vector<std::function<void(eQuickBuildState state)>> m_QuickBuildStateCallbacks{};
2022-07-28 13:39:57 +00:00
/**
* The time it takes for the quickbuild to reset after being completed
2022-07-28 13:39:57 +00:00
*/
float m_ResetTime = 0;
2022-07-28 13:39:57 +00:00
/**
* The time it takes to complete the quickbuild
2022-07-28 13:39:57 +00:00
*/
float m_CompleteTime = 0;
2022-07-28 13:39:57 +00:00
/**
* The imagination that's deducted when completing the quickbuild
2022-07-28 13:39:57 +00:00
*/
int32_t m_TakeImagination = 0;
2022-07-28 13:39:57 +00:00
/**
* Currently unused
*/
bool m_Interruptible = false;
2022-07-28 13:39:57 +00:00
/**
* Whether or not this quickbuild entity also has an activator attached. If not a new one will be spawned
2022-07-28 13:39:57 +00:00
*/
bool m_SelfActivator = false;
2022-07-28 13:39:57 +00:00
/**
* Currently unused
*/
std::vector<int32_t> m_CustomModules{};
2022-07-28 13:39:57 +00:00
/**
* The activity ID that players partake in when doing this quickbuild
2022-07-28 13:39:57 +00:00
*/
int32_t m_ActivityId = 0;
2022-07-28 13:39:57 +00:00
/**
* Currently unused
*/
int32_t m_PostImaginationCost = 0;
2022-07-28 13:39:57 +00:00
/**
* The time it takes for the quickbuild to reset when it's not completed yet
2022-07-28 13:39:57 +00:00
*/
float m_TimeBeforeSmash = 0;
2022-07-28 13:39:57 +00:00
/**
* The time it takes to drain imagination
*/
float m_TimeBeforeDrain = 0;
2022-07-28 13:39:57 +00:00
/**
* The amount of imagination that was drained when building this quickbuild
2022-07-28 13:39:57 +00:00
*/
int32_t m_DrainedImagination = 0;
2022-07-28 13:39:57 +00:00
/**
* Whether to reposition the player or not when building
*/
bool m_RepositionPlayer = true;
2022-07-28 13:39:57 +00:00
/**
* Currently unused
*/
int32_t m_SoftTimer = 0;
2022-07-28 13:39:57 +00:00
/**
* The ID of the entity that's currently building the quickbuild
2022-07-28 13:39:57 +00:00
*/
LWOOBJID m_Builder = LWOOBJID_EMPTY;
2022-07-28 13:39:57 +00:00
/**
* Preconditions to be met before being able to start the quickbuild
2022-07-28 13:39:57 +00:00
*/
PreconditionExpression* m_Precondition = nullptr;
2022-07-28 13:39:57 +00:00
/**
* Starts the quickbuild for a certain entity
* @param user the entity to start the quickbuild
2022-07-28 13:39:57 +00:00
*/
void StartQuickBuild(Entity* const user);
2022-07-28 13:39:57 +00:00
/**
* Completes the quickbuild for an entity, dropping loot and despawning the activator
* @param user the entity that completed the quickbuild
2022-07-28 13:39:57 +00:00
*/
void CompleteQuickBuild(Entity* const user);
};
#endif // QUICKBUILDCOMPONENT_H