RHAPI_MapConfigV2
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_MapConfigV2 | Configuration about a specific map for an instance to load into. |
struct FRHAPI_MapConfigV2
struct FRHAPI_MapConfigV2 : public FRHAPI_ModelConfiguration about a specific map for an instance to load into.
Summary
| Members | Descriptions |
|---|---|
public FString MapId | ID to uniquely identify this map game. |
public FString MapName | Name of the map the instance should load into. |
public FString Mode_Optional | Game mode for the instance to spawn in. |
public bool Mode_IsSet | true if Mode_Optional has been set to a value |
public float MapWeight | Chance that this map will get selected in a rotation list. |
public TMap< FString, FString > CustomData_Optional | Custom data to pass through to the instance. |
public bool CustomData_IsSet | true if CustomData_Optional has been set to a value |
public FString Name_Optional | Human readable name for this map. |
public bool Name_IsSet | true if Name_Optional has been set to a value |
public FString Description_Optional | Description of the map. |
public bool Description_IsSet | true if Description_Optional has been set to a value |
public virtual bool FromJson(const TSharedPtr< FJsonValue > & JsonValue) | Fills this object with data from the passed in JSON. |
public virtual void WriteJson(TSharedRef< TJsonWriter<>> & Writer) const | Writes the data from this object into the specified JSON Writer stream. |
public inline FString & GetMapId() | Gets the value of MapId. |
public inline const FString & GetMapId() const | Gets the value of MapId. |
public inline void SetMapId(FString NewValue) | Sets the value of MapId. |
public inline FString & GetMapName() | Gets the value of MapName. |
public inline const FString & GetMapName() const | Gets the value of MapName. |
public inline void SetMapName(FString NewValue) | Sets the value of MapName. |
public inline FString & GetMode() | Gets the value of Mode_Optional, regardless of it having been set. |
public inline const FString & GetMode() const | Gets the value of Mode_Optional, regardless of it having been set. |
public inline const FString & GetMode(const FString & DefaultValue) const | Gets the value of Mode_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetMode(FString & OutValue) const | Fills OutValue with the value of Mode_Optional and returns true if it has been set, otherwise returns false. |
public inline FString * GetModeOrNull() | Returns a pointer to Mode_Optional, if it has been set, otherwise returns nullptr. |
public inline const FString * GetModeOrNull() const | Returns a pointer to Mode_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetMode(FString NewValue) | Sets the value of Mode_Optional and also sets Mode_IsSet to true. |
public inline void ClearMode() | Clears the value of Mode_Optional and sets Mode_IsSet to false. |
public inline float & GetMapWeight() | Gets the value of MapWeight. |
public inline const float & GetMapWeight() const | Gets the value of MapWeight. |
public inline void SetMapWeight(float NewValue) | Sets the value of MapWeight. |
public inline TMap< FString, FString > & GetCustomData() | Gets the value of CustomData_Optional, regardless of it having been set. |
public inline const TMap< FString, FString > & GetCustomData() const | Gets the value of CustomData_Optional, regardless of it having been set. |
public inline const TMap< FString, FString > & GetCustomData(const TMap< FString, FString > & DefaultValue) const | Gets the value of CustomData_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetCustomData(TMap< FString, FString > & OutValue) const | Fills OutValue with the value of CustomData_Optional and returns true if it has been set, otherwise returns false. |
public inline TMap< FString, FString > * GetCustomDataOrNull() | Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr. |
public inline const TMap< FString, FString > * GetCustomDataOrNull() const | Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetCustomData(TMap< FString, FString > NewValue) | Sets the value of CustomData_Optional and also sets CustomData_IsSet to true. |
public inline void ClearCustomData() | Clears the value of CustomData_Optional and sets CustomData_IsSet to false. |
public inline FString & GetName() | Gets the value of Name_Optional, regardless of it having been set. |
public inline const FString & GetName() const | Gets the value of Name_Optional, regardless of it having been set. |
public inline const FString & GetName(const FString & DefaultValue) const | Gets the value of Name_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetName(FString & OutValue) const | Fills OutValue with the value of Name_Optional and returns true if it has been set, otherwise returns false. |
public inline FString * GetNameOrNull() | Returns a pointer to Name_Optional, if it has been set, otherwise returns nullptr. |
public inline const FString * GetNameOrNull() const | Returns a pointer to Name_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetName(FString NewValue) | Sets the value of Name_Optional and also sets Name_IsSet to true. |
public inline void ClearName() | Clears the value of Name_Optional and sets Name_IsSet to false. |
public inline FString & GetDescription() | Gets the value of Description_Optional, regardless of it having been set. |
public inline const FString & GetDescription() const | Gets the value of Description_Optional, regardless of it having been set. |
public inline const FString & GetDescription(const FString & DefaultValue) const | Gets the value of Description_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetDescription(FString & OutValue) const | Fills OutValue with the value of Description_Optional and returns true if it has been set, otherwise returns false. |
public inline FString * GetDescriptionOrNull() | Returns a pointer to Description_Optional, if it has been set, otherwise returns nullptr. |
public inline const FString * GetDescriptionOrNull() const | Returns a pointer to Description_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetDescription(FString NewValue) | Sets the value of Description_Optional and also sets Description_IsSet to true. |
public inline void ClearDescription() | Clears the value of Description_Optional and sets Description_IsSet to false. |
Members
public FString MapId
ID to uniquely identify this map game.
public FString MapName
Name of the map the instance should load into.
public FString Mode_Optional
Game mode for the instance to spawn in.
public bool Mode_IsSet
true if Mode_Optional has been set to a value
public float MapWeight
Chance that this map will get selected in a rotation list.
public TMap< FString, FString > CustomData_Optional
Custom data to pass through to the instance.
public bool CustomData_IsSet
true if CustomData_Optional has been set to a value
public FString Name_Optional
Human readable name for this map.
public bool Name_IsSet
true if Name_Optional has been set to a value
public FString Description_Optional
Description of the map.
public bool Description_IsSet
true if Description_Optional has been set to a value
public virtual bool FromJson(const TSharedPtr< FJsonValue > & JsonValue)
Fills this object with data from the passed in JSON.
Parameters
JsonValueData from the API call.
Returns
true if parsing of the JSON data was successful.
public virtual void WriteJson(TSharedRef< TJsonWriter<>> & Writer) const
Writes the data from this object into the specified JSON Writer stream.
Parameters
WriterJSON Writer stream to push .
public inline FString & GetMapId()
Gets the value of MapId.
public inline const FString & GetMapId() const
Gets the value of MapId.
public inline void SetMapId(FString NewValue)
Sets the value of MapId.
public inline FString & GetMapName()
Gets the value of MapName.
public inline const FString & GetMapName() const
Gets the value of MapName.
public inline void SetMapName(FString NewValue)
Sets the value of MapName.
public inline FString & GetMode()
Gets the value of Mode_Optional, regardless of it having been set.
public inline const FString & GetMode() const
Gets the value of Mode_Optional, regardless of it having been set.
public inline const FString & GetMode(const FString & DefaultValue) const
Gets the value of Mode_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetMode(FString & OutValue) const
Fills OutValue with the value of Mode_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetModeOrNull()
Returns a pointer to Mode_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetModeOrNull() const
Returns a pointer to Mode_Optional, if it has been set, otherwise returns nullptr.
public inline void SetMode(FString NewValue)
Sets the value of Mode_Optional and also sets Mode_IsSet to true.
public inline void ClearMode()
Clears the value of Mode_Optional and sets Mode_IsSet to false.
public inline float & GetMapWeight()
Gets the value of MapWeight.
public inline const float & GetMapWeight() const
Gets the value of MapWeight.
public inline void SetMapWeight(float NewValue)
Sets the value of MapWeight.
public inline TMap< FString, FString > & GetCustomData()
Gets the value of CustomData_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetCustomData() const
Gets the value of CustomData_Optional, regardless of it having been set.
public inline const TMap< FString, FString > & GetCustomData(const TMap< FString, FString > & DefaultValue) const
Gets the value of CustomData_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetCustomData(TMap< FString, FString > & OutValue) const
Fills OutValue with the value of CustomData_Optional and returns true if it has been set, otherwise returns false.
public inline TMap< FString, FString > * GetCustomDataOrNull()
Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
public inline const TMap< FString, FString > * GetCustomDataOrNull() const
Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
public inline void SetCustomData(TMap< FString, FString > NewValue)
Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.
public inline void ClearCustomData()
Clears the value of CustomData_Optional and sets CustomData_IsSet to false.
public inline FString & GetName()
Gets the value of Name_Optional, regardless of it having been set.
public inline const FString & GetName() const
Gets the value of Name_Optional, regardless of it having been set.
public inline const FString & GetName(const FString & DefaultValue) const
Gets the value of Name_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetName(FString & OutValue) const
Fills OutValue with the value of Name_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetNameOrNull()
Returns a pointer to Name_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetNameOrNull() const
Returns a pointer to Name_Optional, if it has been set, otherwise returns nullptr.
public inline void SetName(FString NewValue)
Sets the value of Name_Optional and also sets Name_IsSet to true.
public inline void ClearName()
Clears the value of Name_Optional and sets Name_IsSet to false.
public inline FString & GetDescription()
Gets the value of Description_Optional, regardless of it having been set.
public inline const FString & GetDescription() const
Gets the value of Description_Optional, regardless of it having been set.
public inline const FString & GetDescription(const FString & DefaultValue) const
Gets the value of Description_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetDescription(FString & OutValue) const
Fills OutValue with the value of Description_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetDescriptionOrNull()
Returns a pointer to Description_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetDescriptionOrNull() const
Returns a pointer to Description_Optional, if it has been set, otherwise returns nullptr.
public inline void SetDescription(FString NewValue)
Sets the value of Description_Optional and also sets Description_IsSet to true.
public inline void ClearDescription()
Clears the value of Description_Optional and sets Description_IsSet to false.