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`](#structFRHAPI__MapConfigV2_1a9f721ff64d45f27297e71c13228a80ea)
Name of the map the instance should load into.
#### `public FString `[`Mode_Optional`](#structFRHAPI__MapConfigV2_1a36dd21033a37c427edc75373fee08257)
Game mode for the instance to spawn in.
#### `public bool `[`Mode_IsSet`](#structFRHAPI__MapConfigV2_1a098823546046b9001739b205592f4036)
true if Mode_Optional has been set to a value
#### `public float `[`MapWeight`](#structFRHAPI__MapConfigV2_1a0ffa276f20f6156cd2269302bf150719)
Chance that this map will get selected in a rotation list.
#### `public TMap< FString, FString > `[`CustomData_Optional`](#structFRHAPI__MapConfigV2_1a511a71da7c4f1ed8b128d4e3719aedd3)
Custom data to pass through to the instance.
#### `public bool `[`CustomData_IsSet`](#structFRHAPI__MapConfigV2_1a2fd0d6a9b5490204a0801d8064387dae)
true if CustomData_Optional has been set to a value
#### `public FString `[`Name_Optional`](#structFRHAPI__MapConfigV2_1ac7508987a2b899fc40294d37e1f81c5b)
Human readable name for this map.
#### `public bool `[`Name_IsSet`](#structFRHAPI__MapConfigV2_1ab7f0473ee626ee99752d7c54a444a274)
true if Name_Optional has been set to a value
#### `public FString `[`Description_Optional`](#structFRHAPI__MapConfigV2_1a6179723e642c23a19733354d2a01979c)
Description of the map.
#### `public bool `[`Description_IsSet`](#structFRHAPI__MapConfigV2_1ae98bc8edd823f8531c7881acdf57aba5)
true if Description_Optional has been set to a value
#### `public virtual bool `[`FromJson`](#structFRHAPI__MapConfigV2_1a949a198ddd86e878003045d5b425d322)`(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`](#structFRHAPI__MapConfigV2_1ae53f488100b29693510a7b85914d07fd)`(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`](#structFRHAPI__MapConfigV2_1aa60296fd483bfcaca29d9cf95445ada3)`()`
Gets the value of MapId.
#### `public inline const FString & `[`GetMapId`](#structFRHAPI__MapConfigV2_1a9ad900caf5482b0580fb1efafd693a3d)`() const`
Gets the value of MapId.
#### `public inline void `[`SetMapId`](#structFRHAPI__MapConfigV2_1a8ea16d1956764643215324f48db75683)`(FString NewValue)`
Sets the value of MapId.
#### `public inline FString & `[`GetMapName`](#structFRHAPI__MapConfigV2_1acf13a30e8dfbcee91e9d727a1362cb1d)`()`
Gets the value of MapName.
#### `public inline const FString & `[`GetMapName`](#structFRHAPI__MapConfigV2_1a4cea272276f210af5239c7f793f4567e)`() const`
Gets the value of MapName.
#### `public inline void `[`SetMapName`](#structFRHAPI__MapConfigV2_1a05a7d1ac074562fa0d6b2dc1531c97aa)`(FString NewValue)`
Sets the value of MapName.
#### `public inline FString & `[`GetMode`](#structFRHAPI__MapConfigV2_1ae67b15a2989c17859855ddaaae913b78)`()`
Gets the value of Mode_Optional, regardless of it having been set.
#### `public inline const FString & `[`GetMode`](#structFRHAPI__MapConfigV2_1af7e2f8eb21b1ce60ab151e31ade56176)`() const`
Gets the value of Mode_Optional, regardless of it having been set.
#### `public inline const FString & `[`GetMode`](#structFRHAPI__MapConfigV2_1a3180fd0cc52d054f73a6947d7096105a)`(const FString & DefaultValue) const`
Gets the value of Mode_Optional, if it has been set, otherwise it returns DefaultValue.
#### `public inline bool `[`GetMode`](#structFRHAPI__MapConfigV2_1afa12289e0ea8c931b0312b72abcc57ed)`(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`](#structFRHAPI__MapConfigV2_1a919fd2fff0c80f6405d97edf7ec1999a)`()`
Returns a pointer to Mode_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const FString * `[`GetModeOrNull`](#structFRHAPI__MapConfigV2_1a239583013306e04586f2715c3be93460)`() const`
Returns a pointer to Mode_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetMode`](#structFRHAPI__MapConfigV2_1ace9a7807872924f6bd37f6e054da476a)`(FString NewValue)`
Sets the value of Mode_Optional and also sets Mode_IsSet to true.
#### `public inline void `[`ClearMode`](#structFRHAPI__MapConfigV2_1aeb92e37deb493835c65790c73db3f7e5)`()`
Clears the value of Mode_Optional and sets Mode_IsSet to false.
#### `public inline float & `[`GetMapWeight`](#structFRHAPI__MapConfigV2_1a0a475e5f239a4a600c2025ca95c84e12)`()`
Gets the value of MapWeight.
#### `public inline const float & `[`GetMapWeight`](#structFRHAPI__MapConfigV2_1a5396c93ead6c4f31ee0728cacae5ceb6)`() const`
Gets the value of MapWeight.
#### `public inline void `[`SetMapWeight`](#structFRHAPI__MapConfigV2_1a6712131c97a0bc9f796c43fdfbb205db)`(float NewValue)`
Sets the value of MapWeight.
#### `public inline TMap< FString, FString > & `[`GetCustomData`](#structFRHAPI__MapConfigV2_1a6c9d43316b7a0f1ef15493f77eff4053)`()`
Gets the value of CustomData_Optional, regardless of it having been set.
#### `public inline const TMap< FString, FString > & `[`GetCustomData`](#structFRHAPI__MapConfigV2_1aa41a4671aa3b7d86b62bfcdf95d4fd05)`() const`
Gets the value of CustomData_Optional, regardless of it having been set.
#### `public inline const TMap< FString, FString > & `[`GetCustomData`](#structFRHAPI__MapConfigV2_1a7b3ac5cf05cdb8f888cd878c1a5a7b26)`(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`](#structFRHAPI__MapConfigV2_1a161de4441372eb4fe5def9e1f56e5296)`(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`](#structFRHAPI__MapConfigV2_1a741d93c605861a958b2917d2ad488033)`()`
Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const TMap< FString, FString > * `[`GetCustomDataOrNull`](#structFRHAPI__MapConfigV2_1af0c21202867d759e89c1e45477305b55)`() const`
Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetCustomData`](#structFRHAPI__MapConfigV2_1af68358d7baec18850a42bfd0a5a163cb)`(TMap< FString, FString > NewValue)`
Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.
#### `public inline void `[`ClearCustomData`](#structFRHAPI__MapConfigV2_1a848cefff50f876bdb052efa81cb826e3)`()`
Clears the value of CustomData_Optional and sets CustomData_IsSet to false.
#### `public inline FString & `[`GetName`](#structFRHAPI__MapConfigV2_1a3f1f5be978ca95d415ad05c86d64ec9b)`()`
Gets the value of Name_Optional, regardless of it having been set.
#### `public inline const FString & `[`GetName`](#structFRHAPI__MapConfigV2_1a411edd637c8a3428e426f1843061b69a)`() const`
Gets the value of Name_Optional, regardless of it having been set.
#### `public inline const FString & `[`GetName`](#structFRHAPI__MapConfigV2_1a6c95290add9e066a18aa2c239c2f22e6)`(const FString & DefaultValue) const`
Gets the value of Name_Optional, if it has been set, otherwise it returns DefaultValue.
#### `public inline bool `[`GetName`](#structFRHAPI__MapConfigV2_1aa513caa5969b53ab21530f5c09bb0e96)`(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`](#structFRHAPI__MapConfigV2_1a48380a95f92c6b45a06735eb4b6b0573)`()`
Returns a pointer to Name_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const FString * `[`GetNameOrNull`](#structFRHAPI__MapConfigV2_1a1261d47a8ecbc2962243a3cccef49f6f)`() const`
Returns a pointer to Name_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetName`](#structFRHAPI__MapConfigV2_1abb1ce838f3f9b44f4e99fc91a23fef07)`(FString NewValue)`
Sets the value of Name_Optional and also sets Name_IsSet to true.
#### `public inline void `[`ClearName`](#structFRHAPI__MapConfigV2_1a3c5f900f370ab93b1e86fd830f6a0064)`()`
Clears the value of Name_Optional and sets Name_IsSet to false.
#### `public inline FString & `[`GetDescription`](#structFRHAPI__MapConfigV2_1a5675fed44ed924b6c85b53b77cf4cef1)`()`
Gets the value of Description_Optional, regardless of it having been set.
#### `public inline const FString & `[`GetDescription`](#structFRHAPI__MapConfigV2_1a4f0454507ff410fcdac0507c690b0e57)`() const`
Gets the value of Description_Optional, regardless of it having been set.
#### `public inline const FString & `[`GetDescription`](#structFRHAPI__MapConfigV2_1a77e80527e4bdc8527f781256963b57a0)`(const FString & DefaultValue) const`
Gets the value of Description_Optional, if it has been set, otherwise it returns DefaultValue.
#### `public inline bool `[`GetDescription`](#structFRHAPI__MapConfigV2_1aef46009891d297dad50f0a8843dd3dad)`(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`](#structFRHAPI__MapConfigV2_1acba7df1ec4254237565fbabc26ed6a2f)`()`
Returns a pointer to Description_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const FString * `[`GetDescriptionOrNull`](#structFRHAPI__MapConfigV2_1a5464602b71bd44ec68b9f338b66433bd)`() const`
Returns a pointer to Description_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetDescription`](#structFRHAPI__MapConfigV2_1a3e9012531e91b0c7c7754980041fe5f1)`(FString NewValue)`
Sets the value of Description_Optional and also sets Description_IsSet to true.
#### `public inline void `[`ClearDescription`](#structFRHAPI__MapConfigV2_1a6887c09f5c3b4a23def578232720aede)`()`
Clears the value of Description_Optional and sets Description_IsSet to false.