className
stringlengths 1
167
| headerPath
stringlengths 14
166
| description
stringlengths 0
1.62k
| module
stringlengths 0
76
| code
stringlengths 0
11.4k
| variables
listlengths 0
395
|
|---|---|---|---|---|---|
USourceControlHelpers::PackageFilename | /Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h | Helper function to get a filename for a package name.
the filename | SourceControl | static [FString](API\Runtime\Core\Containers\FString) PackageFilename ( const [FString](API\Runtime\Core\Containers\FString) & InPackageName ) | [] |
USourceControlHelpers::PackageFilename | /Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h | Helper function to get a filename for a package.
the filename | SourceControl | static [FString](API\Runtime\Core\Containers\FString) PackageFilename ( const [UPackage](API\Runtime\CoreUObject\UObject\UPackage) * InPackage ) | [] |
USourceControlHelpers::PackageFilenames | /Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h | Helper function to convert package name array into a filename array.
an array of filenames | SourceControl | static [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > PackageFilenames ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InPackageNames ) | [] |
USourceControlHelpers::PackageFilenames | /Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h | Helper function to convert package array into filename array.
an array of filenames | SourceControl | static [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > PackageFilenames ( const [TArray](API\Runtime\Core\Containers\TArray)< [UPackage](API\Runtime\CoreUObject\UObject\UPackage) * > & InPackages ) | [] |
USourceControlHelpers::QueryFileState | /Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h | Blocks until action is complete.
Source control state - see USourceControlState. It will have bIsValid set to false if it could not have its values set. | SourceControl | static [FSourceControlState](API\Developer\SourceControl\FSourceControlState) QueryFileState ( const [FString](API\Runtime\Core\Containers\FString) & InFile, bool bSilent ) | [] |
USourceControlHelpers::RevertAllChangesAndReloadWorld | /Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h | Reverts all changes and then reloads the world.
true if succeeded. | SourceControl | static bool RevertAllChangesAndReloadWorld() | [] |
USourceControlHelpers::RevertAndReloadPackages | /Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h | Reverts the provided files then reloads packages.
true if succeeded. | SourceControl | static bool RevertAndReloadPackages ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InPackagesToRevert, bool bRevertAll, bool bReloadWorld ) | [] |
USourceControlHelpers::RevertFile | /Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h | Blocks until action is complete.
true if succeeded, false if failed and can callLastErrorMsg()for more info. | SourceControl | static bool RevertFile ( const [FString](API\Runtime\Core\Containers\FString) & InFile, bool bSilent ) | [] |
USourceControlHelpers::RevertFiles | /Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h | Blocks until action is complete.
true if succeeded, false if failed and can callLastErrorMsg()for more info. | SourceControl | static bool RevertFiles ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InFiles, bool bSilent ) | [] |
USourceControlHelpers::RevertUnchangedFile | /Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h | Blocks until action is complete.
true if succeeded, false if failed and can callLastErrorMsg()for more info. | SourceControl | static bool RevertUnchangedFile ( const [FString](API\Runtime\Core\Containers\FString) & InFile, bool bSilent ) | [] |
USourceControlHelpers::RevertUnchangedFiles | /Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h | Blocks until action is complete.
true if succeeded, false if failed and can callLastErrorMsg()for more info. | SourceControl | static bool RevertUnchangedFiles ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InFiles, bool bSilent ) | [] |
USourceControlHelpers::RevertUnchangedFiles | /Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h | RevertFiles() | SourceControl | static void RevertUnchangedFiles ( [ISourceControlProvider](API\Developer\SourceControl\ISourceControlProvider) & InProvider, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InFiles ) | [] |
USourceControlHelpers::SyncFile | /Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h | Blocks until action is complete.
true if succeeded, false if failed and can callLastErrorMsg()for more info. | SourceControl | static bool SyncFile ( const [FString](API\Runtime\Core\Containers\FString) & InFile, bool bSilent ) | [] |
USourceControlHelpers::SyncFiles | /Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h | Blocks until action is complete.
true if succeeded, false if failed and can callLastErrorMsg()for more info. | SourceControl | static bool SyncFiles ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InFiles, bool bSilent ) | [] |
USourceControlHelpers | /Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h | For example: | SourceControl | class USourceControlHelpers : public [UObject](API\Runtime\CoreUObject\UObject\UObject) | [] |
USourceControlPreferences::AreUncontrolledChangelistsEnabled | /Engine/Source/Developer/SourceControl/Public/SourceControlPreferences.h | Helper to access easily Enable Uncontrolled Changelists setting | SourceControl | static bool AreUncontrolledChangelistsEnabled() | [] |
USourceControlPreferences::IsValidationTagEnabled | /Engine/Source/Developer/SourceControl/Public/SourceControlPreferences.h | Helper to access easily Enable Validation Tag setting | SourceControl | static bool IsValidationTagEnabled() | [] |
USourceControlPreferences::ShouldDeleteNewFilesOnRevert | /Engine/Source/Developer/SourceControl/Public/SourceControlPreferences.h | Helper to access easily Should Delete New Files On Revert setting | SourceControl | static bool ShouldDeleteNewFilesOnRevert() | [] |
USourceControlPreferences | /Engine/Source/Developer/SourceControl/Public/SourceControlPreferences.h | Settings for the Source Control Integration | SourceControl | class USourceControlPreferences : public [UDeveloperSettings](API\Runtime\DeveloperSettings\Engine\UDeveloperSettings) | [
{
"type": "bool",
"name": "bEnableUncontrolledChangelists",
"description": "Enables Uncontrolled Changelists features."
},
{
"type": "bool",
"name": "bEnableValidationTag",
"description": "If enabled, adds a tag in changelist descriptions when they are validated"
},
{
"type": "bool",
"name": "bShouldDeleteNewFilesOnRevert",
"description": "If enabled, deletes new files when reverted."
},
{
"type": "TArray<FString...",
"name": "CollectionChangelistTags",
"description": "List of lines to add to any collection on checkin"
},
{
"type": "TMap<FName,FS...",
"name": "SpecificCollectionChangelistTags",
"description": "Map of collection names and additional text to apply to changelist descriptions when checking them in"
}
] |
GetStandardStandaloneRenderer | /Engine/Source/Developer/StandaloneRenderer/Public/StandaloneRenderer.h | Single function to create the standalone renderer for the running platform | StandaloneRenderer | [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FSlateRenderer](API\Runtime\SlateCore\Rendering\FSlateRenderer) > GetStandardStandaloneRenderer() | [] |
FTargetDeviceClaimDenied::FTargetDeviceClaimDenied | /Engine/Source/Developer/TargetDeviceServices/Public/TargetDeviceServiceMessages.h | Default constructor. | TargetDeviceServices | FTargetDeviceClaimDenied() | [] |
FTargetDeviceClaimDenied::FTargetDeviceClaimDenied | /Engine/Source/Developer/TargetDeviceServices/Public/TargetDeviceServiceMessages.h | Creates and initializes a new instance. | TargetDeviceServices | FTargetDeviceClaimDenied ( const [FString](API\Runtime\Core\Containers\FString) & InDeviceName, const [FString](API\Runtime\Core\Containers\FString) & InHostName, const [FString](API\Runtime\Core\Containers\FString) & InHostUser ) | [] |
FTargetDeviceClaimDenied | /Engine/Source/Developer/TargetDeviceServices/Public/TargetDeviceServiceMessages.h | FTargetDeviceClaimRequest | TargetDeviceServices | struct FTargetDeviceClaimDenied | [
{
"type": "FString",
"name": "DeviceName",
"description": "Holds the identifier of the device that is already claimed."
},
{
"type": "FString",
"name": "HostName",
"description": "Holds the name of the host computer that claimed the device."
},
{
"type": "FString",
"name": "HostUser",
"description": "Holds the name of the user that claimed the device."
}
] |
FTargetDeviceClaimed::FTargetDeviceClaimed | /Engine/Source/Developer/TargetDeviceServices/Public/TargetDeviceServiceMessages.h | Default constructor. | TargetDeviceServices | FTargetDeviceClaimed() | [] |
FTargetDeviceClaimed::FTargetDeviceClaimed | /Engine/Source/Developer/TargetDeviceServices/Public/TargetDeviceServiceMessages.h | Creates and initializes a new instance. | TargetDeviceServices | FTargetDeviceClaimed ( const [FString](API\Runtime\Core\Containers\FString) & InDeviceName, const [FString](API\Runtime\Core\Containers\FString) & InHostName, const [FString](API\Runtime\Core\Containers\FString) & InHostUser ) | [] |
FTargetDeviceClaimed | /Engine/Source/Developer/TargetDeviceServices/Public/TargetDeviceServiceMessages.h | FTargetDeviceClaimDropped | TargetDeviceServices | struct FTargetDeviceClaimed | [
{
"type": "FString",
"name": "DeviceName",
"description": "Holds the identifier of the device that is being claimed."
},
{
"type": "FString",
"name": "HostName",
"description": "Holds the name of the host computer that is claiming the device."
},
{
"type": "FString",
"name": "HostUser",
"description": "Holds the name of the user that is claiming the device."
}
] |
FTargetDeviceServicePing::FTargetDeviceServicePing | /Engine/Source/Developer/TargetDeviceServices/Public/TargetDeviceServiceMessages.h | Default constructor. | TargetDeviceServices | FTargetDeviceServicePing() | [] |
FTargetDeviceServicePing::FTargetDeviceServicePing | /Engine/Source/Developer/TargetDeviceServices/Public/TargetDeviceServiceMessages.h | Creates and initializes a new instance. | TargetDeviceServices | FTargetDeviceServicePing ( const [FString](API\Runtime\Core\Containers\FString) & InHostUser ) | [] |
FTargetDeviceServicePing | /Engine/Source/Developer/TargetDeviceServices/Public/TargetDeviceServiceMessages.h | Device discovery messages Implements a message for discovering target device services on the network. | TargetDeviceServices | struct FTargetDeviceServicePing | [
{
"type": "FString",
"name": "HostUser",
"description": "Holds the name of the user who generated the ping."
}
] |
FTargetDeviceServicePong | /Engine/Source/Developer/TargetDeviceServices/Public/TargetDeviceServiceMessages.h | Implements a message that is sent in response to target device service discovery messages. | TargetDeviceServices | struct FTargetDeviceServicePong | [
{
"type": "bool",
"name": "Aggregated",
"description": "Flag for the \"All devices\" proxy."
},
{
"type": "FName",
"name": "AllDevicesDefaultVariant",
"description": "Holds the default variant name of \"All devices\" proxy."
},
{
"type": "FString",
"name": "AllDevicesName",
"description": "Holds the name of \"All devices\" proxy."
},
{
"type": "bool",
"name": "Authorized",
"description": "Holds a flag indicating whether the device is authorized."
},
{
"type": "bool",
"name": "Connected",
"description": "Holds a flag indicating whether the device is currently connected."
},
{
"type": "FString",
"name": "ConnectionType",
"description": "Holds the connection type."
},
{
"type": "FName",
"name": "DefaultVariant",
"description": "Holds the variant name of the default device."
},
{
"type": "FString",
"name": "DeviceUser",
"description": "Holds the name of the user that we log in to remote device as, i.e \"root\"."
},
{
"type": "FString",
"name": "DeviceUserPassword",
"description": "Holds the password of the user that we log in to remote device as, i.e \"12345\"."
},
{
"type": "FString",
"name": "HostName",
"description": "Holds the name of the host computer that the device is attached to."
},
{
"type": "FString",
"name": "HostUser",
"description": "Holds the name of the user under which the host computer is running."
},
{
"type": "FString",
"name": "Make",
"description": "Holds the make of the device, i.e. Microsoft or Sony."
},
{
"type": "FString",
"name": "Model",
"description": "Holds the model of the device."
},
{
"type": "FString",
"name": "Name",
"description": "Holds the human readable name of the device, i.e \"Bob's XBox'."
},
{
"type": "FString",
"name": "OSVersion",
"description": "Holds the device OS Version."
},
{
"type": "bool",
"name": "Shared",
"description": "Holds a flag indicating whether this device is shared with other users on the network."
},
{
"type": "bool",
"name": "SupportsMultiLaunch",
"description": "Holds a flag indicating whether the device supports running multiple application instances in parallel."
},
{
"type": "bool",
"name": "SupportsPowerOff",
"description": "Holds a flag indicating whether the device can be powered off."
},
{
"type": "bool",
"name": "SupportsPowerOn",
"description": "Holds a flag indicating whether the device can be powered on."
},
{
"type": "bool",
"name": "SupportsReboot",
"description": "Holds a flag indicating whether the device can be rebooted."
},
{
"type": "bool",
"name": "SupportsVariants",
"description": "Holds a flag indicating whether the device's target platform supports variants."
},
{
"type": "FString",
"name": "Type",
"description": "Holds the device type."
},
{
"type": "TArray<FTarget...",
"name": "Variants",
"description": "List of the Flavors this service supports"
}
] |
FTargetDeviceServicePowerOff::FTargetDeviceServicePowerOff | /Engine/Source/Developer/TargetDeviceServices/Public/TargetDeviceServiceMessages.h | Default constructor. | TargetDeviceServices | FTargetDeviceServicePowerOff() | [] |
FTargetDeviceServicePowerOff::FTargetDeviceServicePowerOff | /Engine/Source/Developer/TargetDeviceServices/Public/TargetDeviceServiceMessages.h | Creates and initializes a new instance. | TargetDeviceServices | FTargetDeviceServicePowerOff ( const [FString](API\Runtime\Core\Containers\FString) & InOperator, bool InForce ) | [] |
FTargetDeviceServicePowerOff | /Engine/Source/Developer/TargetDeviceServices/Public/TargetDeviceServiceMessages.h | Miscellaneous messages Implements a message for powering on a target device. | TargetDeviceServices | struct FTargetDeviceServicePowerOff | [
{
"type": "bool",
"name": "Force",
"description": "Holds a flag indicating whether the power-off should be enforced."
},
{
"type": "FString",
"name": "Operator",
"description": "Holds the name of the user that wishes to power off the device."
}
] |
FTargetDeviceServicePowerOn::FTargetDeviceServicePowerOn | /Engine/Source/Developer/TargetDeviceServices/Public/TargetDeviceServiceMessages.h | Default constructor. | TargetDeviceServices | FTargetDeviceServicePowerOn() | [] |
FTargetDeviceServicePowerOn::FTargetDeviceServicePowerOn | /Engine/Source/Developer/TargetDeviceServices/Public/TargetDeviceServiceMessages.h | Creates and initializes a new instance. | TargetDeviceServices | FTargetDeviceServicePowerOn ( const [FString](API\Runtime\Core\Containers\FString) & InOperator ) | [] |
FTargetDeviceServicePowerOn | /Engine/Source/Developer/TargetDeviceServices/Public/TargetDeviceServiceMessages.h | Implements a message for powering on a target device. | TargetDeviceServices | struct FTargetDeviceServicePowerOn | [
{
"type": "FString",
"name": "Operator",
"description": "Holds the name of the user that wishes to power on the device."
}
] |
FTargetDeviceServiceReboot::FTargetDeviceServiceReboot | /Engine/Source/Developer/TargetDeviceServices/Public/TargetDeviceServiceMessages.h | Default constructor. | TargetDeviceServices | FTargetDeviceServiceReboot() | [] |
FTargetDeviceServiceReboot::FTargetDeviceServiceReboot | /Engine/Source/Developer/TargetDeviceServices/Public/TargetDeviceServiceMessages.h | Creates and initializes a new instance. | TargetDeviceServices | FTargetDeviceServiceReboot ( const [FString](API\Runtime\Core\Containers\FString) & InOperator ) | [] |
FTargetDeviceServiceReboot | /Engine/Source/Developer/TargetDeviceServices/Public/TargetDeviceServiceMessages.h | Implements a message for rebooting a target device. | TargetDeviceServices | struct FTargetDeviceServiceReboot | [
{
"type": "FString",
"name": "Operator",
"description": "Holds the name of the user that wishes to reboot the device."
}
] |
FTargetDeviceServiceTerminateLaunchedProcess::FTargetDeviceServiceTerminateLaunchedProcess | /Engine/Source/Developer/TargetDeviceServices/Public/TargetDeviceServiceMessages.h | Default constructor. | TargetDeviceServices | FTargetDeviceServiceTerminateLaunchedProcess() | [] |
FTargetDeviceServiceTerminateLaunchedProcess::FTargetDeviceServiceTerminateLaunchedProcess | /Engine/Source/Developer/TargetDeviceServices/Public/TargetDeviceServiceMessages.h | Creates and initializes a new instance. | TargetDeviceServices | FTargetDeviceServiceTerminateLaunchedProcess ( [FName](API\Runtime\Core\UObject\FName) InVariant, const [FString](API\Runtime\Core\Containers\FString) & InAppId ) | [] |
FTargetDeviceServiceTerminateLaunchedProcess | /Engine/Source/Developer/TargetDeviceServices/Public/TargetDeviceServiceMessages.h | FTargetDeviceServiceTerminateLaunchedProcess | TargetDeviceServices | struct FTargetDeviceServiceTerminateLaunchedProcess | [
{
"type": "FString",
"name": "AppID",
"description": "Holds the identifier of the application to launch."
},
{
"type": "FName",
"name": "Variant",
"description": "Holds the variant identifier of the target device to use."
}
] |
FTargetDeviceUnclaimed::FTargetDeviceUnclaimed | /Engine/Source/Developer/TargetDeviceServices/Public/TargetDeviceServiceMessages.h | Default constructor. | TargetDeviceServices | FTargetDeviceUnclaimed() | [] |
FTargetDeviceUnclaimed::FTargetDeviceUnclaimed | /Engine/Source/Developer/TargetDeviceServices/Public/TargetDeviceServiceMessages.h | Creates and initializes a new instance. | TargetDeviceServices | FTargetDeviceUnclaimed ( const [FString](API\Runtime\Core\Containers\FString) & InDeviceName, const [FString](API\Runtime\Core\Containers\FString) & InHostName, const [FString](API\Runtime\Core\Containers\FString) & InHostUser ) | [] |
FTargetDeviceUnclaimed | /Engine/Source/Developer/TargetDeviceServices/Public/TargetDeviceServiceMessages.h | FTargetDeviceClaimRequest | TargetDeviceServices | struct FTargetDeviceUnclaimed | [
{
"type": "FString",
"name": "DeviceName",
"description": "Holds the identifier of the device that is no longer claimed."
},
{
"type": "FString",
"name": "HostName",
"description": "Holds the name of the host computer that had claimed the device."
},
{
"type": "FString",
"name": "HostUser",
"description": "Holds the name of the user that had claimed the device."
}
] |
FTargetDeviceVariant | /Engine/Source/Developer/TargetDeviceServices/Public/TargetDeviceServiceMessages.h | Struct for a flavor's information | TargetDeviceServices | struct FTargetDeviceVariant | [
{
"type": "FString",
"name": "DeviceID",
"description": ""
},
{
"type": "FString",
"name": "PlatformDisplayName",
"description": ""
},
{
"type": "FName",
"name": "TargetPlatformId",
"description": ""
},
{
"type": "FString",
"name": "TargetPlatformName",
"description": ""
},
{
"type": "FName",
"name": "VanillaPlatformId",
"description": ""
},
{
"type": "FName",
"name": "VariantName",
"description": ""
}
] |
ITargetDeviceProxy::CanMultiLaunch | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Checks whether the device can launch multiple games or applications simultaneously.
true if launching multiple instances is supported, false otherwise. | TargetDeviceServices | const bool CanMultiLaunch() const | [] |
ITargetDeviceProxy::CanPowerOff | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Checks whether this device can be powered off remotely.
true if the device can be powered off, false otherwise. | TargetDeviceServices | bool CanPowerOff() const | [] |
ITargetDeviceProxy::CanPowerOn | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Checks whether this device can be powered on remotely.
true if the device can be powered on, false otherwise. | TargetDeviceServices | bool CanPowerOn() const | [] |
ITargetDeviceProxy::CanReboot | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Checks whether this device can be rebooted remotely.
true if the device can be rebooted, false otherwise. | TargetDeviceServices | bool CanReboot() const | [] |
ITargetDeviceProxy::CanSupportVariants | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Checks whether this device's target platform supports variants.
true if the device's target platform supports variants, false otherwise. | TargetDeviceServices | bool CanSupportVariants() const | [] |
ITargetDeviceProxy::GetConnectionType | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Gets the type of connection for this device.
Device type. | TargetDeviceServices | const [FString](API\Runtime\Core\Containers\FString) & GetConnectionType() const | [] |
ITargetDeviceProxy::GetDeviceUser | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Gets the name of the (device's) user that is logged in on a device.
Device user name. | TargetDeviceServices | const [FString](API\Runtime\Core\Containers\FString) & GetDeviceUser() const | [] |
ITargetDeviceProxy::GetDeviceUserPassword | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Gets the password of the (device's) user that is logged in on a device.
Device user password. | TargetDeviceServices | const [FString](API\Runtime\Core\Containers\FString) & GetDeviceUserPassword() const | [] |
ITargetDeviceProxy::GetHostName | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Gets the name of the host machine that claimed the device.
Host name string. | TargetDeviceServices | const [FString](API\Runtime\Core\Containers\FString) & GetHostName() const | [] |
ITargetDeviceProxy::GetHostUser | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Gets the name of the user that claimed the device.
User name. | TargetDeviceServices | const [FString](API\Runtime\Core\Containers\FString) & GetHostUser() const | [] |
ITargetDeviceProxy::GetMake | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Gets the device make (i.e. Apple or Sony).
Device make. | TargetDeviceServices | const [FString](API\Runtime\Core\Containers\FString) & GetMake() const | [] |
ITargetDeviceProxy::GetModel | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Gets the device model (i.e. PS3 or XBox).
Device model. | TargetDeviceServices | const [FString](API\Runtime\Core\Containers\FString) & GetModel() const | [] |
ITargetDeviceProxy::GetName | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Gets the name of the device (i.e. network name or IP address).
Device name string. | TargetDeviceServices | const [FString](API\Runtime\Core\Containers\FString) & GetName() const | [] |
ITargetDeviceProxy::GetNumVariants | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Gets the number of variants this device supports
The number of variants supported. | TargetDeviceServices | int32 GetNumVariants() const | [] |
ITargetDeviceProxy::GetOSVersion | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Gets the OS Version of the device
Device OS VErsion. | TargetDeviceServices | const [FString](API\Runtime\Core\Containers\FString) & GetOSVersion() const | [] |
ITargetDeviceProxy::GetPlatformDisplayName | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Gets the Vanilla platform of the device variant.
Platform Display Name string. | TargetDeviceServices | [FText](API\Runtime\Core\Internationalization\FText) GetPlatformDisplayName ( [FName](API\Runtime\Core\UObject\FName) InVariant ) const | [] |
ITargetDeviceProxy::GetTargetDeviceId | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Gets the identifier of the device.
The target device identifier. | TargetDeviceServices | const [FString](API\Runtime\Core\Containers\FString) GetTargetDeviceId ( [FName](API\Runtime\Core\UObject\FName) InVariant ) const | [] |
ITargetDeviceProxy::GetTargetDeviceIds | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Gets a list of device identifiers for an aggregate (All_devices_on) proxy | TargetDeviceServices | const [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > & GetTargetDeviceIds ( [FName](API\Runtime\Core\UObject\FName) InVariant ) const | [] |
ITargetDeviceProxy::GetTargetDeviceVariant | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Gets the variant name of the target device.
The target device variant name. | TargetDeviceServices | [FName](API\Runtime\Core\UObject\FName) GetTargetDeviceVariant ( const [FString](API\Runtime\Core\Containers\FString) & InDeviceId ) const | [] |
ITargetDeviceProxy::GetTargetPlatformId | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Gets the target platform of the device variant.
Target Platform Id. | TargetDeviceServices | [FName](API\Runtime\Core\UObject\FName) GetTargetPlatformId ( [FName](API\Runtime\Core\UObject\FName) InVariant ) const | [] |
ITargetDeviceProxy::GetTargetPlatformName | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Gets the target platform of the device variant.
Target Platform Name string. | TargetDeviceServices | [FString](API\Runtime\Core\Containers\FString) GetTargetPlatformName ( [FName](API\Runtime\Core\UObject\FName) InVariant ) const | [] |
ITargetDeviceProxy::GetType | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Gets the device type (i.e. Console, PC or Mobile).
Device type. | TargetDeviceServices | const [FString](API\Runtime\Core\Containers\FString) & GetType() const | [] |
ITargetDeviceProxy::GetVanillaPlatformId | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Gets the Vanilla platform of the device variant.
Vanilla Platform Id. | TargetDeviceServices | [FName](API\Runtime\Core\UObject\FName) GetVanillaPlatformId ( [FName](API\Runtime\Core\UObject\FName) InVariant ) const | [] |
ITargetDeviceProxy::GetVariants | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Gets the list of variants this device supports
The number of variants in the list. | TargetDeviceServices | int32 GetVariants ( [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & OutVariants ) const | [] |
ITargetDeviceProxy::HasDeviceId | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Checks whether this device proxy contains a variant for the provided target device.
true if this device has a variant of the provided DeviceId. | TargetDeviceServices | bool HasDeviceId ( const [FString](API\Runtime\Core\Containers\FString) & InDeviceId ) const | [] |
ITargetDeviceProxy::HasTargetPlatform | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Checks whether this device proxy contains a variant for the provided platform.
true if this device has a variant of the provided Target Platform . | TargetDeviceServices | bool HasTargetPlatform ( [FName](API\Runtime\Core\UObject\FName) InTargetPlatformId ) const | [] |
ITargetDeviceProxy::HasVariant | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Checks whether this device proxy contains a variant
true is this variant is found. | TargetDeviceServices | bool HasVariant ( [FName](API\Runtime\Core\UObject\FName) InVariant ) const | [] |
ITargetDeviceProxy::IsAggregated | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Checks if this is an aggregate (All_devices_on) proxy.
true if the device is aggregated, false otherwise. | TargetDeviceServices | virtual bool IsAggregated() const | [] |
ITargetDeviceProxy::IsAuthorized | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Checks whether the device is authorized.
true if the device is authorized, false otherwise. | TargetDeviceServices | bool IsAuthorized() const | [] |
ITargetDeviceProxy::IsConnected | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Checks whether the device is currently connected.
true if the device is connected, false otherwise. | TargetDeviceServices | bool IsConnected() const | [] |
ITargetDeviceProxy::IsShared | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Checks whether this device is being shared with other users.
true if the device is being shared, false otherwise. | TargetDeviceServices | bool IsShared() const | [] |
ITargetDeviceProxy::PowerOff | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Reboot | TargetDeviceServices | void PowerOff ( bool Force ) | [] |
ITargetDeviceProxy::PowerOn | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Reboot | TargetDeviceServices | void PowerOn() | [] |
ITargetDeviceProxy::Reboot | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | PowerOn | TargetDeviceServices | void Reboot() | [] |
ITargetDeviceProxy::TerminateLaunchedProcess | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Cancel the application running on the device
true if the launch has been successfully terminated, false otherwise. | TargetDeviceServices | bool TerminateLaunchedProcess ( [FName](API\Runtime\Core\UObject\FName) InVariant, const [FString](API\Runtime\Core\Containers\FString) & ProcessIdentifier ) | [] |
ITargetDeviceProxy::~ITargetDeviceProxy | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Virtual destructor. | TargetDeviceServices | virtual ~ITargetDeviceProxy() | [] |
ITargetDeviceProxy | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h | Interface for target device proxies. | TargetDeviceServices | class ITargetDeviceProxy | [] |
ITargetDeviceProxyManager::FindOrAddProxy | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxyManager.h | GetProxies | TargetDeviceServices | [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ITargetDeviceProxy](API\Developer\TargetDeviceServices\ITargetDeviceProxy) > FindOrAddProxy ( const [FString](API\Runtime\Core\Containers\FString) & Name ) | [] |
ITargetDeviceProxyManager::FindProxy | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxyManager.h | GetProxies | TargetDeviceServices | [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ITargetDeviceProxy](API\Developer\TargetDeviceServices\ITargetDeviceProxy) > FindProxy ( const [FString](API\Runtime\Core\Containers\FString) & Name ) | [] |
ITargetDeviceProxyManager::FindProxyDeviceForTargetDevice | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxyManager.h | GetProxies | TargetDeviceServices | [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ITargetDeviceProxy](API\Developer\TargetDeviceServices\ITargetDeviceProxy) > FindProxyDeviceForTargetDevice ( const [FString](API\Runtime\Core\Containers\FString) & DeviceId ) | [] |
FOnTargetDeviceProxyAdded | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxyManager.h | Gets an event delegate that is executed when a target device proxy was added. | TargetDeviceServices | class FOnTargetDeviceProxyAdded : public TBaseMulticastDelegate_OneParam< void, const TSharedRef< ITargetDeviceProxy > & > | [] |
FOnTargetDeviceProxyRemoved | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxyManager.h | Gets an event delegate that is executed when a target device proxy was removed. | TargetDeviceServices | class FOnTargetDeviceProxyRemoved : public TBaseMulticastDelegate_OneParam< void, const TSharedRef< ITargetDeviceProxy > & > | [] |
ITargetDeviceProxyManager::GetAllProxies | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxyManager.h | FindProxyDeviceForTargetDevice | TargetDeviceServices | void GetAllProxies ( [FName](API\Runtime\Core\UObject\FName) TargetPlatformName, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ITargetDeviceProxy](API\Developer\TargetDeviceServices\ITargetDeviceProxy) >> & OutProxies ) | [] |
ITargetDeviceProxyManager::GetProxies | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxyManager.h | FindProxyDeviceForTargetDevice | TargetDeviceServices | void GetProxies ( [FName](API\Runtime\Core\UObject\FName) TargetPlatformName, bool IncludeUnshared, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ITargetDeviceProxy](API\Developer\TargetDeviceServices\ITargetDeviceProxy) >> & OutProxies ) | [] |
ITargetDeviceProxyManager::OnProxyAdded | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxyManager.h | TargetDeviceServices | [FOnTargetDeviceProxyAdded](API\Developer\TargetDeviceServices\ITargetDeviceProxyManager\FOnTargetDeviceP-) & OnProxyAdded() | [] |
|
ITargetDeviceProxyManager::OnProxyRemoved | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxyManager.h | TargetDeviceServices | [FOnTargetDeviceProxyRemoved](API\Developer\TargetDeviceServices\ITargetDeviceProxyManager\FOnTargetDeviceP-_1) & OnProxyRemoved() | [] |
|
ITargetDeviceProxyManager::~ITargetDeviceProxyManager | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxyManager.h | Virtual destructor. | TargetDeviceServices | virtual ~ITargetDeviceProxyManager() | [] |
ITargetDeviceProxyManager | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxyManager.h | Interface for device proxy managers. | TargetDeviceServices | class ITargetDeviceProxyManager | [] |
ITargetDeviceService::AddTargetDevice | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceService.h | Adds a flavor to this device.
true if the service can start, false otherwise. | TargetDeviceServices | void AddTargetDevice ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ITargetDevice](API\Developer\TargetPlatform\Interfaces\ITargetDevice), ESPMode::ThreadSafe > InDevice ) | [] |
ITargetDeviceService::CanStart | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceService.h | A service can be started if it has a valid device and the device is connected. This method does not take into account whether the service is already started.
true if the service can start, false otherwise. | TargetDeviceServices | bool CanStart ( [FName](API\Runtime\Core\UObject\FName) InFlavor ) const | [] |
ITargetDeviceService::GetClaimHost | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceService.h | Gets the name of the host that has a claim on the device.
Host name string. | TargetDeviceServices | const [FString](API\Runtime\Core\Containers\FString) & GetClaimHost() | [] |
ITargetDeviceService::GetClaimUser | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceService.h | Gets the name of the user that has a claim on the device.
User name string. | TargetDeviceServices | const [FString](API\Runtime\Core\Containers\FString) & GetClaimUser() | [] |
ITargetDeviceService::GetDevice | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceService.h | Gets the target device for the supplied flavor, if no flavor is specified then the default device flavor is returned.
A pointer to the target device. | TargetDeviceServices | [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ITargetDevice](API\Developer\TargetPlatform\Interfaces\ITargetDevice), ESPMode::ThreadSafe > GetDevice ( [FName](API\Runtime\Core\UObject\FName) InFlavor ) const | [] |
ITargetDeviceService::GetDeviceName | /Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceService.h | Gets the name of the device that this service exposes.
The human readable device name. | TargetDeviceServices | [FString](API\Runtime\Core\Containers\FString) GetDeviceName() const | [] |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.