Code/Engine/GameEngine/Gameplay/PlayerStartPointComponent.h - dev - redgpu/ezEngine

Code/Engine/GameEngine/Gameplay/PlayerStartPointComponent.h
64 строки3 KB
Jan Krassnigg
Fixed #1164: Made it easier to reflect resource handles (#1376)
23 авг 2024, 08:36
23 авг 2024, 08:368a46458
#pragma once

#include <Core/ResourceManager/ResourceHandle.h>
#include <Core/World/World.h>
#include <Foundation/Containers/ArrayMap.h>
#include <Foundation/Strings/HashedString.h>
#include <Foundation/Types/RangeView.h>
#include <Foundation/Types/Variant.h>
#include <GameEngine/GameEngineDLL.h>

using ezPrefabResourceHandle = ezTypedResourceHandle<class ezPrefabResource>;

using ezPlayerStartPointComponentManager = ezComponentManager<class ezPlayerStartPointComponent, ezBlockStorageType::Compact>;

/// \brief Defines a location that the player may start from.
///
/// This component specifies which prefab to use as the player object and parameters to spawn the player object with.
///
/// The component itself has no functionality. It is the ezGameState that decides how to utilize player start points.
/// The default game state searches for a start point component and spawns the prefab from there, assuming that the prefab
/// contains all the functionality to make the game playable (e.g. it should contain a main camera, input handling, movement and so on).
///
/// A game state may also ignore the prefab and on the player start point component and only use the location to spawn or relocate the player object.
///
/// It is not mandatory to use a spawn point component. A player object can also be instantiated in a scene just as a regular
/// prefab. However, the editor functionality "Play from here", that allows you to spawn the player object at any location in the
/// scene, relies on spawn points, as the spawn point defines which prefab to use for the player prefab, but the game state
/// can now override the location where to spawn the player.
class EZ_GAMEENGINE_DLL ezPlayerStartPointComponent : public ezComponent
{
  EZ_DECLARE_COMPONENT_TYPE(ezPlayerStartPointComponent, ezComponent, ezPlayerStartPointComponentManager);

  //////////////////////////////////////////////////////////////////////////
  // ezComponent

public:
  virtual void SerializeComponent(ezWorldWriter& inout_stream) const override;
  virtual void DeserializeComponent(ezWorldReader& inout_stream) override;

  //////////////////////////////////////////////////////////////////////////
  // ezPlayerStartPointComponent

public:
  ezPlayerStartPointComponent();
  ~ezPlayerStartPointComponent();

  void SetPlayerPrefab(const ezPrefabResourceHandle& hPrefab);      // [ property ]
  const ezPrefabResourceHandle& GetPlayerPrefab() const;            // [ property ]

  const ezRangeView<const char*, ezUInt32> GetParameters() const;   // [ property ] (exposed parameter)
  void SetParameter(const char* szKey, const ezVariant& value);     // [ property ] (exposed parameter)
  void RemoveParameter(const char* szKey);                          // [ property ] (exposed parameter)
  bool GetParameter(const char* szKey, ezVariant& out_value) const; // [ property ] (exposed parameter)

  ezArrayMap<ezHashedString, ezVariant> m_Parameters;

  // TODO:
  //  add properties to differentiate use cases, such as
  //  single player vs. multi-player spawn points
  //  team number

protected:
  ezPrefabResourceHandle m_hPlayerPrefab;
};