RHAPI_InstanceStartupParams
Summary
| Members | Descriptions |
|---|---|
struct FRHAPI_InstanceStartupParams | Parameters given to an instance to change what map and mode it loads, and other gameplay behavior. |
struct FRHAPI_InstanceStartupParams
struct FRHAPI_InstanceStartupParams : public FRHAPI_ModelParameters given to an instance to change what map and mode it loads, and other gameplay behavior.
Summary
| Members | Descriptions |
|---|---|
public FString Map | Name of the map for the instance to spawn with. |
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 FString MiscParams | Additional commandline parameters for the instance. |
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 FString & GetMap() | Gets the value of Map. |
public inline const FString & GetMap() const | Gets the value of Map. |
public inline void SetMap(FString NewValue) | Sets the value of Map. |
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 FString & GetMiscParams() | Gets the value of MiscParams. |
public inline const FString & GetMiscParams() const | Gets the value of MiscParams. |
public inline void SetMiscParams(FString NewValue) | Sets the value of MiscParams. |
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 FString Map
Name of the map for the instance to spawn with.
#### `public FString `[`Mode_Optional`](#structFRHAPI__InstanceStartupParams_1ae99ccd9106b0a17af359547a835bc983)
Game mode for the instance to spawn in.
#### `public bool `[`Mode_IsSet`](#structFRHAPI__InstanceStartupParams_1ae0321c27d0b6ce23711c72563ad863fe)
true if Mode_Optional has been set to a value
#### `public FString `[`MiscParams`](#structFRHAPI__InstanceStartupParams_1acb74f767d6ab701ca1bd6be307963742)
Additional commandline parameters for the instance.
#### `public TMap< FString, FString > `[`CustomData_Optional`](#structFRHAPI__InstanceStartupParams_1a1c84d36d36367c97c4eb24fe13b2ff43)
Custom data to pass through to the instance.
#### `public bool `[`CustomData_IsSet`](#structFRHAPI__InstanceStartupParams_1ab2cb38f8bdeb7e51625f1b7dc763b647)
true if CustomData_Optional has been set to a value
#### `public virtual bool `[`FromJson`](#structFRHAPI__InstanceStartupParams_1a77009b7faffe77948aa3e953ee6499e2)`(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__InstanceStartupParams_1abb4b33169895704a428935fc1923957a)`(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 & `[`GetMap`](#structFRHAPI__InstanceStartupParams_1aaa0604a2745b9f55c1b3dc19fe7a465e)`()`
Gets the value of Map.
#### `public inline const FString & `[`GetMap`](#structFRHAPI__InstanceStartupParams_1a20558bc02f4ca43e75d901e1f0c30e3f)`() const`
Gets the value of Map.
#### `public inline void `[`SetMap`](#structFRHAPI__InstanceStartupParams_1a1347a85de6a7f233c80bc6a343b76d1f)`(FString NewValue)`
Sets the value of Map.
#### `public inline FString & `[`GetMode`](#structFRHAPI__InstanceStartupParams_1a2ca1fec3b3005bec6bb9409f610dad0e)`()`
Gets the value of Mode_Optional, regardless of it having been set.
#### `public inline const FString & `[`GetMode`](#structFRHAPI__InstanceStartupParams_1af50805382b27551da853f645acbfdbd8)`() const`
Gets the value of Mode_Optional, regardless of it having been set.
#### `public inline const FString & `[`GetMode`](#structFRHAPI__InstanceStartupParams_1a10804234c00bec89849f3fc5eb5e8922)`(const FString & DefaultValue) const`
Gets the value of Mode_Optional, if it has been set, otherwise it returns DefaultValue.
#### `public inline bool `[`GetMode`](#structFRHAPI__InstanceStartupParams_1a01ba92277f8ad9108411ba77b443519d)`(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__InstanceStartupParams_1afc0ac3225b7dd2b26897dd34848c31f8)`()`
Returns a pointer to Mode_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const FString * `[`GetModeOrNull`](#structFRHAPI__InstanceStartupParams_1ac597354579b0ea5518fb4ac514756da9)`() const`
Returns a pointer to Mode_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetMode`](#structFRHAPI__InstanceStartupParams_1aa1b1687d4025c97029c1ae219b7ed577)`(FString NewValue)`
Sets the value of Mode_Optional and also sets Mode_IsSet to true.
#### `public inline void `[`ClearMode`](#structFRHAPI__InstanceStartupParams_1a1dde35553e47c5d1aad61150101c1989)`()`
Clears the value of Mode_Optional and sets Mode_IsSet to false.
#### `public inline FString & `[`GetMiscParams`](#structFRHAPI__InstanceStartupParams_1a79d9fa928c511b3e4f32aec23405fbeb)`()`
Gets the value of MiscParams.
#### `public inline const FString & `[`GetMiscParams`](#structFRHAPI__InstanceStartupParams_1ad392457d6aea277259c05b936e092052)`() const`
Gets the value of MiscParams.
#### `public inline void `[`SetMiscParams`](#structFRHAPI__InstanceStartupParams_1aa2aa69cd6d0f1498ced14d221c13e2f9)`(FString NewValue)`
Sets the value of MiscParams.
#### `public inline TMap< FString, FString > & `[`GetCustomData`](#structFRHAPI__InstanceStartupParams_1ab5f634770b8323a3fd94bd42d5d94daf)`()`
Gets the value of CustomData_Optional, regardless of it having been set.
#### `public inline const TMap< FString, FString > & `[`GetCustomData`](#structFRHAPI__InstanceStartupParams_1a7945142dd20f19446bdba0dd7f194c48)`() const`
Gets the value of CustomData_Optional, regardless of it having been set.
#### `public inline const TMap< FString, FString > & `[`GetCustomData`](#structFRHAPI__InstanceStartupParams_1adadac0821f574799506f8c2a6371aca9)`(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__InstanceStartupParams_1a9ab750252903baa26a8cd6cafd91a57f)`(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__InstanceStartupParams_1a543ebbec72db0c64961c808451cb2466)`()`
Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
#### `public inline const TMap< FString, FString > * `[`GetCustomDataOrNull`](#structFRHAPI__InstanceStartupParams_1a7e39b3eb0f427a48b0d39e9b2b32f6f6)`() const`
Returns a pointer to CustomData_Optional, if it has been set, otherwise returns nullptr.
#### `public inline void `[`SetCustomData`](#structFRHAPI__InstanceStartupParams_1ac68dc80a0412fc437a9b72d11ecec523)`(TMap< FString, FString > NewValue)`
Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.
#### `public inline void `[`ClearCustomData`](#structFRHAPI__InstanceStartupParams_1ad5cd20ad691851348dd54afdf981b84b)`()`
Clears the value of CustomData_Optional and sets CustomData_IsSet to false.