RHAPI_InstanceRequestTemplate
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_InstanceRequestTemplate | Configuration about how an instance should behave when it’s allocated. |
struct FRHAPI_InstanceRequestTemplate
struct FRHAPI_InstanceRequestTemplate : public FRHAPI_ModelConfiguration about how an instance should behave when it’s allocated.
Summary
| Members | Descriptions |
|---|---|
public FGuid InstanceRequestTemplateId | ID to uniquely identify this instance launch template. |
public FRHAPI_MapSelectionListV2 MapSelectionList | A selection list of maps that can be chosen to launch into. |
public ERHAPI_HostType DefaultHostType | Default host type for this template. Can be overriden in instance requests. |
public TMap< FString, FString > CustomData_Optional | Custom data that will be passed to the session during the instance launch request. |
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 FGuid & GetInstanceRequestTemplateId() | Gets the value of InstanceRequestTemplateId. |
public inline const FGuid & GetInstanceRequestTemplateId() const | Gets the value of InstanceRequestTemplateId. |
public inline void SetInstanceRequestTemplateId(FGuid NewValue) | Sets the value of InstanceRequestTemplateId. |
public inline FRHAPI_MapSelectionListV2&GetMapSelectionList() | Gets the value of MapSelectionList. |
public inline const FRHAPI_MapSelectionListV2&GetMapSelectionList() const | Gets the value of MapSelectionList. |
public inline void SetMapSelectionList(FRHAPI_MapSelectionListV2 NewValue) | Sets the value of MapSelectionList. |
public inline ERHAPI_HostType & GetDefaultHostType() | Gets the value of DefaultHostType. |
public inline const ERHAPI_HostType & GetDefaultHostType() const | Gets the value of DefaultHostType. |
public inline void SetDefaultHostType(ERHAPI_HostType NewValue) | Sets the value of DefaultHostType. |
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 FGuid InstanceRequestTemplateId
ID to uniquely identify this instance launch template.
#### `public `[`FRHAPI_MapSelectionListV2`](RHAPI_MapSelectionListV2.md#structFRHAPI__MapSelectionListV2)` `[`MapSelectionList`](#structFRHAPI__InstanceRequestTemplate_1a4ef0b1d2d12365b73ba57d3f17028cd1)
A selection list of maps that can be chosen to launch into.
#### `public ERHAPI_HostType `[`DefaultHostType`](#structFRHAPI__InstanceRequestTemplate_1a5ba4b7d3a1cae608a8bcbc1d47e13874)
Default host type for this template. Can be overriden in instance requests.
#### `public TMap< FString, FString > `[`CustomData_Optional`](#structFRHAPI__InstanceRequestTemplate_1ae5ca6a7369d28296f09fa18d94db571a)
Custom data that will be passed to the session during the instance launch request.
#### `public bool `[`CustomData_IsSet`](#structFRHAPI__InstanceRequestTemplate_1a64805530c4189001f0d28d7e6aef6d56)
true if CustomData_Optional has been set to a value
#### `public virtual bool `[`FromJson`](#structFRHAPI__InstanceRequestTemplate_1a942edc53656677290b7336c76a41360f)`(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__InstanceRequestTemplate_1a9d8e6599d189f3eabd67e12faa8322d4)`(TSharedRef< TJsonWriter<>> & Writer) const`
Writes the data from this object into the specified JSON Writer stream.
Parameters
WriterJSON Writer stream to push .
#### `public inline FGuid & `[`GetInstanceRequestTemplateId`](#structFRHAPI__InstanceRequestTemplate_1aacb4d163e889b32ad05a90a0c405bd75)`()`
Gets the value of InstanceRequestTemplateId.
#### `public inline const FGuid & `[`GetInstanceRequestTemplateId`](#structFRHAPI__InstanceRequestTemplate_1a0c23e7ad0bf3901d8d9b53bfda7a9696)`() const`
Gets the value of InstanceRequestTemplateId.
#### `public inline void `[`SetInstanceRequestTemplateId`](#structFRHAPI__InstanceRequestTemplate_1a3736be91713ef2e0001137d5dbc8437a)`(FGuid NewValue)`
Sets the value of InstanceRequestTemplateId.
#### `public inline `[`FRHAPI_MapSelectionListV2`](RHAPI_MapSelectionListV2.md#structFRHAPI__MapSelectionListV2)` & `[`GetMapSelectionList`](#structFRHAPI__InstanceRequestTemplate_1a94e8e368c26b057c8609ee8b8a2280e3)`()`
Gets the value of MapSelectionList.
#### `public inline const `[`FRHAPI_MapSelectionListV2`](RHAPI_MapSelectionListV2.md#structFRHAPI__MapSelectionListV2)` & `[`GetMapSelectionList`](#structFRHAPI__InstanceRequestTemplate_1ad51b5d3d03e160c9ef83ce829aaaa3cc)`() const`
Gets the value of MapSelectionList.
#### `public inline void `[`SetMapSelectionList`](#structFRHAPI__InstanceRequestTemplate_1a0e29c44f08aca64d88db0f21321002e4)`(`[`FRHAPI_MapSelectionListV2`](RHAPI_MapSelectionListV2.md#structFRHAPI__MapSelectionListV2)` NewValue)`
Sets the value of MapSelectionList.
#### `public inline ERHAPI_HostType & `[`GetDefaultHostType`](#structFRHAPI__InstanceRequestTemplate_1a72bb00a45fa50d72d01479adc7d27506)`()`
Gets the value of DefaultHostType.
#### `public inline const ERHAPI_HostType & `[`GetDefaultHostType`](#structFRHAPI__InstanceRequestTemplate_1a3860adb1ea4174d7abf5f11a62252457)`() const`
Gets the value of DefaultHostType.
#### `public inline void `[`SetDefaultHostType`](#structFRHAPI__InstanceRequestTemplate_1a554926e81ec8fbfb0ca96ce6847434f9)`(ERHAPI_HostType NewValue)`
Sets the value of DefaultHostType.
#### `public inline TMap< FString, FString > & `[`GetCustomData`](#structFRHAPI__InstanceRequestTemplate_1a79d0d4293fa8d90635ee3c31a319982e)`()`
Gets the value of CustomData_Optional, regardless of it having been set.
#### `public inline const TMap< FString, FString > & `[`GetCustomData`](#structFRHAPI__InstanceRequestTemplate_1a56d73bcd0efe05daf0de38bde5fc8de9)`() const`
Gets the value of CustomData_Optional, regardless of it having been set.
#### `public inline const TMap< FString, FString > & `[`GetCustomData`](#structFRHAPI__InstanceRequestTemplate_1a4ffff34289210075aee9f8d1d918ebed)`(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__InstanceRequestTemplate_1a4914983281b865b273142afa4b3f6ab4)`(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__InstanceRequestTemplate_1ad5ef053599f206f032395de929b55e2c)`()`
Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const TMap< FString, FString > * `[`GetCustomDataOrNull`](#structFRHAPI__InstanceRequestTemplate_1afa5b06288870d3774750cc8582d4d890)`() const`
Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetCustomData`](#structFRHAPI__InstanceRequestTemplate_1a8ba17a4f39fba30164264a41fb3bfe6f)`(TMap< FString, FString > NewValue)`
Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.
#### `public inline void `[`ClearCustomData`](#structFRHAPI__InstanceRequestTemplate_1ac216c36da42fc221390416e2cd8cb2d1)`()`
Clears the value of CustomData_Optional and sets CustomData_IsSet to false.