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_Model

Parameters 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(const FString & NewValue)	Sets the value of Map.
public inline void SetMap(FString && NewValue)	Sets the value of Map using move semantics.
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(const FString & NewValue)	Sets the value of Mode_Optional and also sets Mode_IsSet to true.
public inline void SetMode(FString && NewValue)	Sets the value of Mode_Optional and also sets Mode_IsSet to true using move semantics.
public inline void ClearMode()	Clears the value of Mode_Optional and sets Mode_IsSet to false.
public inline bool IsModeSet() const	Checks whether Mode_Optional has been set.
public inline FString & GetMiscParams()	Gets the value of MiscParams.
public inline const FString & GetMiscParams() const	Gets the value of MiscParams.
public inline void SetMiscParams(const FString & NewValue)	Sets the value of MiscParams.
public inline void SetMiscParams(FString && NewValue)	Sets the value of MiscParams using move semantics.
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(const TMap< FString, FString > & NewValue)	Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.
public inline void SetCustomData(TMap< FString, FString > && NewValue)	Sets the value of CustomData_Optional and also sets CustomData_IsSet to true using move semantics.
public inline void ClearCustomData()	Clears the value of CustomData_Optional and sets CustomData_IsSet to false.
public inline bool IsCustomDataSet() const	Checks whether CustomData_Optional has been set.

Members

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.

Parameters

• JsonValue Data 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

• Writer JSON Writer stream to push .

public inline FString & GetMap()

Gets the value of Map.

public inline const FString & GetMap() const

Gets the value of Map.

public inline void SetMap(const FString & NewValue)

Sets the value of Map.

public inline void SetMap(FString && NewValue)

Sets the value of Map using move semantics.

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(const FString & NewValue)

Sets the value of Mode_Optional and also sets Mode_IsSet to true.

public inline void SetMode(FString && NewValue)

Sets the value of Mode_Optional and also sets Mode_IsSet to true using move semantics.

public inline void ClearMode()

Clears the value of Mode_Optional and sets Mode_IsSet to false.

public inline bool IsModeSet() const

Checks whether Mode_Optional has been set.

public inline FString & GetMiscParams()

Gets the value of MiscParams.

public inline const FString & GetMiscParams() const

Gets the value of MiscParams.

public inline void SetMiscParams(const FString & NewValue)

Sets the value of MiscParams.

public inline void SetMiscParams(FString && NewValue)

Sets the value of MiscParams using move semantics.

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(const TMap< FString, FString > & NewValue)

Sets the value of CustomData_Optional and also sets CustomData_IsSet to true.

public inline void SetCustomData(TMap< FString, FString > && NewValue)

Sets the value of CustomData_Optional and also sets CustomData_IsSet to true using move semantics.

public inline void ClearCustomData()

Clears the value of CustomData_Optional and sets CustomData_IsSet to false.

public inline bool IsCustomDataSet() const

Checks whether CustomData_Optional has been set.