RHAPI_MapConfig
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_MapConfig | DEPRECATED Configuration about a specific map for an instance to load into. |
struct FRHAPI_MapConfig
struct FRHAPI_MapConfig
: public FRHAPI_ModelDEPRECATED Configuration about a specific map for an instance to load into.
Summary
| Members | Descriptions |
|---|---|
public int32 MapGameId_Optional | ID to uniquely identify this map game. |
public bool MapGameId_IsSet | true if MapGameId_Optional has been set to a value |
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 SelectionChance_Optional | Chance that this map will get selected in a rotation list. |
public bool SelectionChance_IsSet | true if SelectionChance_Optional has been set to a value |
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 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 int32 & GetMapGameId() | Gets the value of MapGameId_Optional, regardless of it having been set. |
public inline const int32 & GetMapGameId() const | Gets the value of MapGameId_Optional, regardless of it having been set. |
public inline const int32 & GetMapGameId(const int32 & DefaultValue) const | Gets the value of MapGameId_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetMapGameId(int32 & OutValue) const | Fills OutValue with the value of MapGameId_Optional and returns true if it has been set, otherwise returns false. |
public inline int32 * GetMapGameIdOrNull() | Returns a pointer to MapGameId_Optional, if it has been set, otherwise returns nullptr. |
public inline const int32 * GetMapGameIdOrNull() const | Returns a pointer to MapGameId_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetMapGameId(int32 NewValue) | Sets the value of MapGameId_Optional and also sets MapGameId_IsSet to true. |
public inline void ClearMapGameId() | Clears the value of MapGameId_Optional and sets MapGameId_IsSet to false. |
public inline bool IsMapGameIdDefaultValue() const | Returns true if MapGameId_Optional is set and matches the default value. |
public inline void SetMapGameIdToDefault() | Sets the value of MapGameId_Optional to its default and also sets MapGameId_IsSet to true. |
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 & GetSelectionChance() | Gets the value of SelectionChance_Optional, regardless of it having been set. |
public inline const float & GetSelectionChance() const | Gets the value of SelectionChance_Optional, regardless of it having been set. |
public inline const float & GetSelectionChance(const float & DefaultValue) const | Gets the value of SelectionChance_Optional, if it has been set, otherwise it returns DefaultValue. |
public inline bool GetSelectionChance(float & OutValue) const | Fills OutValue with the value of SelectionChance_Optional and returns true if it has been set, otherwise returns false. |
public inline float * GetSelectionChanceOrNull() | Returns a pointer to SelectionChance_Optional, if it has been set, otherwise returns nullptr. |
public inline const float * GetSelectionChanceOrNull() const | Returns a pointer to SelectionChance_Optional, if it has been set, otherwise returns nullptr. |
public inline void SetSelectionChance(float NewValue) | Sets the value of SelectionChance_Optional and also sets SelectionChance_IsSet to true. |
public inline void ClearSelectionChance() | Clears the value of SelectionChance_Optional and sets SelectionChance_IsSet to false. |
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. |
Members
public int32 MapGameId_Optional
ID to uniquely identify this map game.
public bool MapGameId_IsSet
true if MapGameId_Optional has been set to a value
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 SelectionChance_Optional
Chance that this map will get selected in a rotation list.
public bool SelectionChance_IsSet
true if SelectionChance_Optional has been set to a value
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 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 int32 & GetMapGameId()
Gets the value of MapGameId_Optional, regardless of it having been set.
public inline const int32 & GetMapGameId() const
Gets the value of MapGameId_Optional, regardless of it having been set.
public inline const int32 & GetMapGameId(const int32 & DefaultValue) const
Gets the value of MapGameId_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetMapGameId(int32 & OutValue) const
Fills OutValue with the value of MapGameId_Optional and returns true if it has been set, otherwise returns false.
public inline int32 * GetMapGameIdOrNull()
Returns a pointer to MapGameId_Optional, if it has been set, otherwise returns nullptr.
public inline const int32 * GetMapGameIdOrNull() const
Returns a pointer to MapGameId_Optional, if it has been set, otherwise returns nullptr.
public inline void SetMapGameId(int32 NewValue)
Sets the value of MapGameId_Optional and also sets MapGameId_IsSet to true.
public inline void ClearMapGameId()
Clears the value of MapGameId_Optional and sets MapGameId_IsSet to false.
public inline bool IsMapGameIdDefaultValue() const
Returns true if MapGameId_Optional is set and matches the default value.
public inline void SetMapGameIdToDefault()
Sets the value of MapGameId_Optional to its default and also sets MapGameId_IsSet to true.
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 & GetSelectionChance()
Gets the value of SelectionChance_Optional, regardless of it having been set.
public inline const float & GetSelectionChance() const
Gets the value of SelectionChance_Optional, regardless of it having been set.
public inline const float & GetSelectionChance(const float & DefaultValue) const
Gets the value of SelectionChance_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetSelectionChance(float & OutValue) const
Fills OutValue with the value of SelectionChance_Optional and returns true if it has been set, otherwise returns false.
public inline float * GetSelectionChanceOrNull()
Returns a pointer to SelectionChance_Optional, if it has been set, otherwise returns nullptr.
public inline const float * GetSelectionChanceOrNull() const
Returns a pointer to SelectionChance_Optional, if it has been set, otherwise returns nullptr.
public inline void SetSelectionChance(float NewValue)
Sets the value of SelectionChance_Optional and also sets SelectionChance_IsSet to true.
public inline void ClearSelectionChance()
Clears the value of SelectionChance_Optional and sets SelectionChance_IsSet to false.
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.