className
stringlengths
1
167
headerPath
stringlengths
14
166
description
stringlengths
0
1.62k
module
stringlengths
3
36
code
stringlengths
0
11.4k
variables
listlengths
0
395
UXRCreativeITFComponent::SetPointerComponent
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeITFComponent.h
XRCreative
void SetPointerComponent ( [UXRCreativePointerComponent](API\Plugins\XRCreative\UXRCreativePointerComponent) * InPointer )
[]
UXRCreativeITFComponent::TickComponent
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeITFComponent.h
Function called every frame on this ActorComponent. Override this function to implement custom logic to be executed every frame. Only executes if the component is registered, and also PrimaryComponentTick.bCanEverTick must be set to true.
XRCreative
virtual void TickComponent ( float DeltaTime, enum ELevelTick TickType, [FActorComponentTickFunction](API\Runtime\Engine\Engine\FActorComponentTickFunction) * ThisTickFunction )
[]
UXRCreativeITFComponent::ToolsTick
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeITFComponent.h
XRCreative
void ToolsTick ( float InDeltaTime )
[]
UXRCreativeITFComponent::UninitializeComponent
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeITFComponent.h
Handle this component being Uninitialized. Called fromAActor::EndPlayonly if bHasBeenInitialized is true
XRCreative
virtual void UninitializeComponent()
[]
UXRCreativeITFComponent::Undo
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeITFComponent.h
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative|Tools") void Undo()
[]
UXRCreativeITFComponent::UXRCreativeITFComponent
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeITFComponent.h
XRCreative
UXRCreativeITFComponent()
[]
UXRCreativePalette::SetOwner
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeToolset.h
XRCreative
void SetOwner ( class [AXRCreativeAvatar](API\Plugins\XRCreative\AXRCreativeAvatar) * InOwner )
[]
UXRCreativePalette
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeToolset.h
XRCreative
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UXRCreativePalette : public [UCommonUserWidget](API\Plugins\CommonUI\UCommonUserWidget)
[ { "type": "TObjectPtr<AXR...", "name": "Owner", "description": "" }, { "type": "TArray<TObject...", "name": "Tabs", "description": "" } ]
UXRCreativeITFComponent
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeITFComponent.h
XRCreative
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UXRCreativeITFComponent : public [UActorComponent](API\Runtime\Engine\Components\UActorComponent)
[ { "type": "bool", "name": "bIsShuttingDown", "description": "" }, { "type": "bool", "name": "bPendingMouseStateChange", "description": "" }, { "type": "TSharedPtr< FXR...", "name": "ContextQueriesAPI", "description": "" }, { "type": "TSharedPtr< FXR...", "name": "ContextTransactionsAPI", "description": "" }, { "type": "EToolContextCoo...", "name": "CurrentCoordinateSystem", "description": "" }, { "type": "FInputDeviceSta...", "name": "CurrentMouseState", "description": "" }, { "type": "FViewCameraStat...", "name": "CurrentViewCameraState", "description": "" }, { "type": "TSubclassOf<AX...", "name": "FullTRSGizmoActorClass", "description": "" }, { "type": "TObjectPtr< UXR...", "name": "PDIRenderComponent", "description": "" }, { "type": "TObjectPtr<UXR...", "name": "PointerComponent", "description": "" }, { "type": "FVector2D", "name": "PrevMousePosition", "description": "" }, { "type": "TObjectPtr< UXR...", "name": "SelectionInteraction", "description": "" }, { "type": "TObjectPtr<UTy...", "name": "SelectionSet", "description": "" }, { "type": "TObjectPtr<UIn...", "name": "ToolsContext", "description": "" }, { "type": "TObjectPtr< UXR...", "name": "TransformInteraction", "description": "" } ]
UXRCreativePointerComponent::GetFilteredTraceEnd
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativePointerComponent.h
If bScaledByImpact is false, this is the smoothed filter output, roughly `TraceMaxLength_ units away, roughly in the +X direction. If bScaledByImpact is true, the magnitude is shortened to match the length of a blocking hit (if any).
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") FVector GetFilteredTraceEnd ( const bool bScaledByImpact ) const
[]
UXRCreativePaletteTab
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeToolset.h
XRCreative
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UXRCreativePaletteTab : public [UCommonActivatableWidget](API\Plugins\CommonUI\UCommonActivatableWidget)
[]
UXRCreativePaletteToolTab
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeToolset.h
XRCreative
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UXRCreativePaletteToolTab : public [UXRCreativePaletteTab](API\Plugins\XRCreative\UXRCreativePaletteTab)
[ { "type": "TWeakObjectPtr<...", "name": "Tool", "description": "" } ]
UXRCreativePointerComponent::GetRawTraceEnd
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativePointerComponent.h
If bScaledByImpact is false, this returns the raw input to the smoothing filter, `TraceMaxLength_ units away the +X direction. If bScaledByImpact is true, the magnitude is shortened to the length of the blocking hit (if any).
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") FVector GetRawTraceEnd ( const bool bScaledByImpact ) const
[]
UXRCreativePointerComponent::IsEnabled
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativePointerComponent.h
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") bool IsEnabled() const
[]
UXRCreativePointerComponent::InitializeComponent
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativePointerComponent.h
Initializes the component. Occurs at level startup or actor spawn. This is before BeginPlay (Actor or Component). All Components in the level will be Initialized on load before any Actor/Component gets BeginPlay Requires component to be registered, and bWantsInitializeComponent to be true.
XRCreative
virtual void InitializeComponent()
[]
UXRCreativePointerComponent::GetHitResult
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativePointerComponent.h
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") const [FHitResult](API\Runtime\Engine\Engine\FHitResult) & GetHitResult() const
[]
UXRCreativePointerComponent::SetEnabled
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativePointerComponent.h
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") void SetEnabled ( bool bInEnabled )
[]
UXRCreativePointerComponent::UninitializeComponent
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativePointerComponent.h
Handle this component being Uninitialized. Called fromAActor::EndPlayonly if bHasBeenInitialized is true
XRCreative
virtual void UninitializeComponent()
[]
UXRCreativePointerComponent::UXRCreativePointerComponent
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativePointerComponent.h
XRCreative
UXRCreativePointerComponent()
[]
UXRCreativePointerComponent
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativePointerComponent.h
XRCreative
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UXRCreativePointerComponent : public [USceneComponent](API\Runtime\Engine\Components\USceneComponent)
[ { "type": "bool", "name": "bEnabled", "description": "" }, { "type": "FHitResult", "name": "HitResult", "description": "" }, { "type": "FVector", "name": "RawTraceEnd", "description": "" }, { "type": "TPimplPtr< UE::...", "name": "SmoothingFilter", "description": "" }, { "type": "float", "name": "SmoothingLag", "description": "" }, { "type": "float", "name": "SmoothingMinCutoff", "description": "" }, { "type": "float", "name": "TraceMaxLength", "description": "" } ]
UXRCreativeSettings::GetXRCreativeSettings
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeSettings.h
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="XR Creative") static [UXRCreativeSettings](API\Plugins\XRCreative\UXRCreativeSettings) * GetXRCreativeSettings()
[]
UXRCreativeSettings
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeSettings.h
XRCreative
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=XRCreativeSettings, DisplayName="XR Creative") class UXRCreativeSettings : public [UDeveloperSettingsBackedByCVars](API\Runtime\DeveloperSettings\Engine\UDeveloperSettingsBackedByCVars)
[ { "type": "bool", "name": "bUseImperial", "description": "" }, { "type": "TArray< float >", "name": "FloatArray", "description": "" }, { "type": "TSoftClassPtr< ...", "name": "SubsystemHelpersClass", "description": "" } ]
UXRCreativePointerComponent::TickComponent
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativePointerComponent.h
Function called every frame on this ActorComponent. Override this function to implement custom logic to be executed every frame. Only executes if the component is registered, and also PrimaryComponentTick.bCanEverTick must be set to true.
XRCreative
virtual void TickComponent ( float DeltaTime, enum ELevelTick TickType, [FActorComponentTickFunction](API\Runtime\Engine\Engine\FActorComponentTickFunction) * ThisTickFunction )
[]
UXRCreativeStyle
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeToolset.h
XRCreative
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType) class UXRCreativeStyle : public [UPrimaryDataAsset](API\Runtime\Engine\Engine\UPrimaryDataAsset)
[ { "type": "TSubclassOf<UC...", "name": "BoldTextStyle", "description": "" }, { "type": "TSubclassOf<UC...", "name": "ItalicTextStyle", "description": "" }, { "type": "TSubclassOf<UC...", "name": "LargeButtonStyle", "description": "" }, { "type": "TSubclassOf<UC...", "name": "RegularButtonStyle", "description": "" }, { "type": "TSubclassOf<UC...", "name": "RegularTextStyle", "description": "" } ]
UXRCreativeSubsystem::EnterVRMode
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeSubsystem.h
Enter VR Mode
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") static bool EnterVRMode()
[]
UXRCreativeSubsystem::Initialize
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeSubsystem.h
Implement this for initialization of instances of the system
XRCreative
virtual void Initialize ( [FSubsystemCollectionBase](API\Runtime\Engine\Subsystems\FSubsystemCollectionBase) & Collection )
[]
UXRCreativeSubsystem::ExitVRMode
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeSubsystem.h
Exit VR Mode
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") static void ExitVRMode()
[]
UXRCreativeSubsystem::OnEngineInitComplete
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeSubsystem.h
XRCreative
void OnEngineInitComplete()
[]
UXRCreativeSubsystem
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeSubsystem.h
XRCreative
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UXRCreativeSubsystem : public [UEngineSubsystem](API\Runtime\Engine\Subsystems\UEngineSubsystem)
[ { "type": "FDelegateHandle", "name": "EngineInitCompleteDelegate", "description": "" }, { "type": "TObjectPtr<UXR...", "name": "Helpers", "description": "" } ]
UXRCreativeSubsystemHelpers
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeSubsystem.h
XRCreative
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract, Blueprintable) class UXRCreativeSubsystemHelpers : public [UObject](API\Runtime\CoreUObject\UObject\UObject)
[]
UXRCreativeTool::GetDisplayName
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeToolset.h
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") virtual [FText](API\Runtime\Core\Internationalization\FText) GetDisplayName() const
[]
UXRCreativeTool::GetPaletteTabClass
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeToolset.h
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") virtual [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< class [UXRCreativePaletteToolTab](API\Plugins\XRCreative\UXRCreativePaletteToolTab) > GetPaletteTabClass() const
[]
UXRCreativeTool::GetToolName
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeToolset.h
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") virtual [FName](API\Runtime\Core\UObject\FName) GetToolName() const
[]
UXRCreativeTool
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeToolset.h
XRCreative
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract, BlueprintType) class UXRCreativeTool : public [UObject](API\Runtime\CoreUObject\UObject\UObject)
[]
UXRCreativeToolset
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeToolset.h
XRCreative
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType) class UXRCreativeToolset : public [UPrimaryDataAsset](API\Runtime\Engine\Engine\UPrimaryDataAsset)
[ { "type": "TSubclassOf<AX...", "name": "Avatar", "description": "" }, { "type": "TSubclassOf<UX...", "name": "Palette", "description": "" }, { "type": "TSoftObjectPtr<...", "name": "Style", "description": "" }, { "type": "TArray<FXRCrea...", "name": "Tools", "description": "" } ]
UXRVisualizationFunctionLibrary::RenderHMD
/Engine/Plugins/Runtime/XR/XRVisualization/Source/XRVisualization/Public/XRVisualizationFunctionLibrary.h
Renders HMD Visualization on a system that might not have that HMD as native
XRVisualization
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|XRTracking") static void RenderHMD ( const [FXRHMDData](API\Runtime\HeadMountedDisplay\FXRHMDData) & XRHMDData )
[]
UXRVisualizationFunctionLibrary::RenderMotionController
/Engine/Plugins/Runtime/XR/XRVisualization/Source/XRVisualization/Public/XRVisualizationFunctionLibrary.h
Renders Motion Controller Visualization on a system that might not have that HMD as native
XRVisualization
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|XRTracking") static void RenderMotionController ( const [FXRMotionControllerData](API\Runtime\HeadMountedDisplay\FXRMotionControllerData) & XRControllerData, bool bRight )
[]
UXRVisualizationFunctionLibrary
/Engine/Plugins/Runtime/XR/XRVisualization/Source/XRVisualization/Public/XRVisualizationFunctionLibrary.h
No destructors are accessible with public or protected access.
XRVisualization
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UXRVisualizationFunctionLibrary : public [UBlueprintFunctionLibrary](API\Runtime\Engine\Kismet\UBlueprintFunctionLibrary)
[]
UXRVisualizationLoadHelper
/Engine/Plugins/Runtime/XR/XRVisualization/Source/XRVisualization/Public/XRVisualizationFunctionLibrary.h
No constructors are accessible with public or protected access.
XRVisualization
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UXRVisualizationLoadHelper : public [UObject](API\Runtime\CoreUObject\UObject\UObject)
[ { "type": "TObjectPtr< cla...", "name": "GenericHMD", "description": "" }, { "type": "TObjectPtr< cla...", "name": "OculusControllerMesh", "description": "" }, { "type": "TObjectPtr< cla...", "name": "STEMControllerMesh", "description": "" }, { "type": "TObjectPtr< cla...", "name": "ViveControllerMesh", "description": "" } ]
EConstructMethod::Type
/Engine/Source/Runtime/XmlParser/Public/XmlFile.h
XmlParser
namespace EConstructMethod { enum Type { ConstructFromFile, ConstructFromBuffer, } }
[]
FFastXml::ParseXmlFile
/Engine/Source/Runtime/XmlParser/Public/FastXml.h
Quickly parse an XML file. Pass in your implementation of theIFastXmlCallbackinterface with code to handle parsed elements and attributes, along with either the full path to the XML file to load, or a string with the full XML file content. Returns true if loading was successful, or false if anything went wrong or the user canceled. When false is returned, an error message string will be set in the OutErrorMessage variable, along with the line number that parsing failed at in OutErrorLineNumber.
XmlParser
static bool ParseXmlFile ( class [IFastXmlCallback](API\Runtime\XmlParser\IFastXmlCallback) * Callback, const TCHAR * XmlFilePath, TCHAR * XmlFileContents, class [FFeedbackContext](API\Runtime\Core\Misc\FFeedbackContext) * FeedbackContext, const bool bShowSlowTaskDialog, const bool bShowCancelButton, [FText](API\Runtime\Core\Internationalization\FText) & OutErrorMessage, int32 & OutErrorLineNumber )
[]
FXmlAttribute::GetTag
/Engine/Source/Runtime/XmlParser/Public/XmlNode.h
Gets the tag of the attribute
XmlParser
const [FString](API\Runtime\Core\Containers\FString) & GetTag() const
[]
FFastXml
/Engine/Source/Runtime/XmlParser/Public/FastXml.h
Remember to add a module dependency on "XmlParser" in order to be able to call FFastXml::ParserXmlFile().
XmlParser
class FFastXml
[]
FXmlAttribute
/Engine/Source/Runtime/XmlParser/Public/XmlNode.h
XmlParser
class FXmlAttribute
[]
FXmlAttribute::FXmlAttribute
/Engine/Source/Runtime/XmlParser/Public/XmlNode.h
XmlParser
FXmlAttribute ( const [FString](API\Runtime\Core\Containers\FString) & InTag, const [FString](API\Runtime\Core\Containers\FString) & InValue )
[]
FXmlAttribute::GetValue
/Engine/Source/Runtime/XmlParser/Public/XmlNode.h
Gets the value of the attribute
XmlParser
const [FString](API\Runtime\Core\Containers\FString) & GetValue() const
[]
FXmlFile::Clear
/Engine/Source/Runtime/XmlParser/Public/XmlFile.h
Clears the file of all internals. Note: Makes any existing pointers toFXmlNode's INVALID
XmlParser
void Clear()
[]
FXmlFile::GetLastError
/Engine/Source/Runtime/XmlParser/Public/XmlFile.h
Gets the last error message from the class
XmlParser
[FString](API\Runtime\Core\Containers\FString) GetLastError() const
[]
FXmlFile::GetRootNode
/Engine/Source/Runtime/XmlParser/Public/XmlFile.h
Returns the root node of the loaded file. nullptr if no file loaded. It is assumed that there will always be one and only one root node. Pointer to root node
XmlParser
const [FXmlNode](API\Runtime\XmlParser\FXmlNode) * GetRootNode() const
[]
FXmlFile::GetRootNode
/Engine/Source/Runtime/XmlParser/Public/XmlFile.h
Returns the root node of the loaded file. nullptr if no file loaded. It is assumed that there will always be one and only one root node. Pointer to root node
XmlParser
[FXmlNode](API\Runtime\XmlParser\FXmlNode) * GetRootNode()
[]
FXmlFile::LoadFile
/Engine/Source/Runtime/XmlParser/Public/XmlFile.h
Loads the file with the passed path. Path is either treated as a filename to open, or as a text buffer to load.
XmlParser
bool LoadFile ( const [FString](API\Runtime\Core\Containers\FString) & Path, [EConstructMethod::Type](API\Runtime\XmlParser\EConstructMethod__Type) ConstructMethod )
[]
FXmlFile::operator=
/Engine/Source/Runtime/XmlParser/Public/XmlFile.h
XmlParser
[FXmlFile](API\Runtime\XmlParser\FXmlFile) & operator= ( const [FXmlFile](API\Runtime\XmlParser\FXmlFile) & rhs )
[]
FXmlFile::FXmlFile
/Engine/Source/Runtime/XmlParser/Public/XmlFile.h
Constructs the file without a path
XmlParser
FXmlFile()
[]
FXmlFile::Save
/Engine/Source/Runtime/XmlParser/Public/XmlFile.h
Write to disk, UTF-16 format only at the moment Whether writing the XML to a file succeeded
XmlParser
bool Save ( const [FString](API\Runtime\Core\Containers\FString) & Path )
[]
FXmlFile::IsValid
/Engine/Source/Runtime/XmlParser/Public/XmlFile.h
Checks to see if a file is loaded
XmlParser
bool IsValid() const
[]
FXmlFile::FXmlFile
/Engine/Source/Runtime/XmlParser/Public/XmlFile.h
XmlParser
FXmlFile ( const [FXmlFile](API\Runtime\XmlParser\FXmlFile) & rhs )
[]
FXmlFile::FXmlFile
/Engine/Source/Runtime/XmlParser/Public/XmlFile.h
Constructs the file with the passed path. InFile is either treated as a filename to open, or as a text buffer to load.
XmlParser
FXmlFile ( const [FString](API\Runtime\Core\Containers\FString) & InFile, [EConstructMethod::Type](API\Runtime\XmlParser\EConstructMethod__Type) ConstructMethod )
[]
FXmlFile::~FXmlFile
/Engine/Source/Runtime/XmlParser/Public/XmlFile.h
XmlParser
~FXmlFile()
[]
FXmlFile
/Engine/Source/Runtime/XmlParser/Public/XmlFile.h
Class representing an XML file
XmlParser
class FXmlFile
[]
FXmlNode::FindChildNode
/Engine/Source/Runtime/XmlParser/Public/XmlNode.h
Finds the first child node that contains the specified tag
XmlParser
const [FXmlNode](API\Runtime\XmlParser\FXmlNode) * FindChildNode ( const [FString](API\Runtime\Core\Containers\FString) & InTag ) const
[]
FXmlNode::AppendChildNode
/Engine/Source/Runtime/XmlParser/Public/XmlNode.h
Adds a child node to this node
XmlParser
void AppendChildNode ( const [FString](API\Runtime\Core\Containers\FString) & InTag, const [FString](API\Runtime\Core\Containers\FString) & InContent, const [TArray](API\Runtime\Core\Containers\TArray)< [FXmlAttribute](API\Runtime\XmlParser\FXmlAttribute) > & InAttributes )
[]
FXmlNode::FindChildNode
/Engine/Source/Runtime/XmlParser/Public/XmlNode.h
Finds the first child node that contains the specified tag
XmlParser
[FXmlNode](API\Runtime\XmlParser\FXmlNode) * FindChildNode ( const [FString](API\Runtime\Core\Containers\FString) & InTag )
[]
FXmlNode::GetAttribute
/Engine/Source/Runtime/XmlParser/Public/XmlNode.h
Gets an attribute that corresponds with the passed-in tag
XmlParser
[FString](API\Runtime\Core\Containers\FString) GetAttribute ( const [FString](API\Runtime\Core\Containers\FString) & InTag ) const
[]
FXmlNode::GetAttributes
/Engine/Source/Runtime/XmlParser/Public/XmlNode.h
Gets all of the attributes in this node List of attributes in this node
XmlParser
const [TArray](API\Runtime\Core\Containers\TArray)< [FXmlAttribute](API\Runtime\XmlParser\FXmlAttribute) > & GetAttributes() const
[]
FXmlNode::GetChildrenNodes
/Engine/Source/Runtime/XmlParser/Public/XmlNode.h
Gets a list of children nodes
XmlParser
const [TArray](API\Runtime\Core\Containers\TArray)< [FXmlNode](API\Runtime\XmlParser\FXmlNode) * > & GetChildrenNodes() const
[]
FXmlNode::GetFirstChildNode
/Engine/Source/Runtime/XmlParser/Public/XmlNode.h
Gets the first child of this node which can be iterated into with GetNextNode
XmlParser
const [FXmlNode](API\Runtime\XmlParser\FXmlNode) * GetFirstChildNode() const
[]
FXmlNode::GetContent
/Engine/Source/Runtime/XmlParser/Public/XmlNode.h
Gets the value of the node
XmlParser
const [FString](API\Runtime\Core\Containers\FString) & GetContent() const
[]
FXmlNode::GetNextNode
/Engine/Source/Runtime/XmlParser/Public/XmlNode.h
Gets the next node in a list of nodes
XmlParser
const [FXmlNode](API\Runtime\XmlParser\FXmlNode) * GetNextNode() const
[]
FXmlNode::GetTag
/Engine/Source/Runtime/XmlParser/Public/XmlNode.h
Gets the tag of the node
XmlParser
const [FString](API\Runtime\Core\Containers\FString) & GetTag() const
[]
FXmlNode::SetContent
/Engine/Source/Runtime/XmlParser/Public/XmlNode.h
Sets the new value of the node
XmlParser
void SetContent ( const [FString](API\Runtime\Core\Containers\FString) & InContent )
[]
FXmlNode::SetAttributes
/Engine/Source/Runtime/XmlParser/Public/XmlNode.h
Sets the attributes of the node
XmlParser
void SetAttributes ( const [TArray](API\Runtime\Core\Containers\TArray)< [FXmlAttribute](API\Runtime\XmlParser\FXmlAttribute) > & InAttributes )
[]
FXmlNode
/Engine/Source/Runtime/XmlParser/Public/XmlNode.h
No destructors are accessible with public or protected access.
XmlParser
class FXmlNode
[]
IFastXmlCallback::ProcessAttribute
/Engine/Source/Runtime/XmlParser/Public/FastXml.h
Called when an XML attribute is encountered for the current scope's element. You should return true to continue processing the file, or false to stop processing immediately.
XmlParser
bool ProcessAttribute ( const TCHAR * AttributeName, const TCHAR * AttributeValue )
[]
IFastXmlCallback::ProcessComment
/Engine/Source/Runtime/XmlParser/Public/FastXml.h
Called when a comment is encountered. This can happen pretty much anywhere in the file.
XmlParser
bool ProcessComment ( const TCHAR * Comment )
[]
IFastXmlCallback::ProcessClose
/Engine/Source/Runtime/XmlParser/Public/FastXml.h
Called when an element's scope ends in the XML file You should return true to continue processing the file, or false to stop processing immediately.
XmlParser
bool ProcessClose ( const TCHAR * Element )
[]
IFastXmlCallback::ProcessElement
/Engine/Source/Runtime/XmlParser/Public/FastXml.h
Called when a new XML element is encountered, starting a new scope. You'll receive a call toProcessClose()when this element's scope has ended. You should return true to continue processing the file, or false to stop processing immediately.
XmlParser
bool ProcessElement ( const TCHAR * ElementName, const TCHAR * ElementData, int32 XmlFileLineNumber )
[]
IFastXmlCallback
/Engine/Source/Runtime/XmlParser/Public/FastXml.h
Create your own class that implements theIFastXmlCallbackinterface to process the XML elements as they are loaded byFFastXml::ParseXmlFile(). You'll receive aProcessElement()call for every XML element that is encountered, along with a correspondingProcessClose()when that element's scope has ended.ProcessAttribute()will be called for any attributes found within the scope of the current element.
XmlParser
class IFastXmlCallback
[]
IFastXmlCallback::ProcessXmlDeclaration
/Engine/Source/Runtime/XmlParser/Public/FastXml.h
Called after the XML's header is parsed. This is usually the first call that you'll get back. You should return true to continue processing the file, or false to stop processing immediately.
XmlParser
bool ProcessXmlDeclaration ( const TCHAR * ElementData, int32 XmlFileLineNumber )
[]
FServiceAutoLaunchSettings
/Engine/Source/Developer/Zen/Public/Experimental/ZenServerInterface.h
Zen
struct FServiceAutoLaunchSettings
[ { "type": "bool", "name": "bIsDefaultSharedRunContext", "description": "" }, { "type": "bool", "name": "bLimitProcessLifetime", "description": "" }, { "type": "bool", "name": "bSendUnattendedBugReports", "description": "" }, { "type": "bool", "name": "bShowConsole", "description": "" }, { "type": "FString", "name": "DataPath", "description": "" }, { "type": "uint16", "name": "DesiredPort", "description": "" }, { "type": "FString", "name": "ExtraArgs", "description": "" } ]
FServiceConnectSettings
/Engine/Source/Developer/Zen/Public/Experimental/ZenServerInterface.h
Zen
struct FServiceConnectSettings
[ { "type": "FString", "name": "HostName", "description": "" }, { "type": "uint16", "name": "Port", "description": "" } ]
FServiceSettings::IsConnectExisting
/Engine/Source/Developer/Zen/Public/Experimental/ZenServerInterface.h
Zen
bool IsConnectExisting() const
[]
FServiceSettings::IsAutoLaunch
/Engine/Source/Developer/Zen/Public/Experimental/ZenServerInterface.h
Zen
bool IsAutoLaunch() const
[]
FServiceSettings::ReadFromCompactBinary
/Engine/Source/Developer/Zen/Public/Experimental/ZenServerInterface.h
Zen
void ReadFromCompactBinary ( [FCbFieldView](API\Runtime\Core\Serialization\FCbFieldView) Field )
[]
FServiceSettings::ReadFromConfig
/Engine/Source/Developer/Zen/Public/Experimental/ZenServerInterface.h
Zen
void ReadFromConfig()
[]
FServiceSettings::ReadFromURL
/Engine/Source/Developer/Zen/Public/Experimental/ZenServerInterface.h
Zen
void ReadFromURL ( FStringView InstanceURL )
[]
FServiceSettings::WriteToCompactBinary
/Engine/Source/Developer/Zen/Public/Experimental/ZenServerInterface.h
Zen
void WriteToCompactBinary ( [FCbWriter](API\Runtime\Core\Serialization\FCbWriter) & Writer ) const
[]
FServiceSettings
/Engine/Source/Developer/Zen/Public/Experimental/ZenServerInterface.h
Zen
struct FServiceSettings
[ { "type": "TVariant<FServ...", "name": "SettingsVariant", "description": "" } ]
AZoneGraphData::CanChangeIsSpatiallyLoadedFlag
/Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraph/Public/ZoneGraphData.h
Returns true if this actor allows changing the spatially loaded flag.
ZoneGraph
virtual bool CanChangeIsSpatiallyLoadedFlag() const
[]
AZoneGraphData::Destroyed
/Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraph/Public/ZoneGraphData.h
Called when this actor is explicitly being destroyed during gameplay or in the editor, not called during level streaming or gameplay ending
ZoneGraph
virtual void Destroyed()
[]
AZoneGraphData::EndPlay
/Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraph/Public/ZoneGraphData.h
Overridable function called whenever this actor is being removed from a level
ZoneGraph
virtual void EndPlay ( const [EEndPlayReason::Type](API\Runtime\Engine\Engine\EEndPlayReason__Type) EndPlayReason )
[]
AZoneGraphData::GetBounds
/Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraph/Public/ZoneGraphData.h
ZoneGraph
FBox GetBounds() const
[]
AZoneGraphData::GetCombinedShapeHash
/Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraph/Public/ZoneGraphData.h
Combined hash of all ZoneShapes that were used to build the data.
ZoneGraph
uint32 GetCombinedShapeHash() const
[]
AZoneGraphData::GetStorage
/Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraph/Public/ZoneGraphData.h
ZoneGraph
const [FZoneGraphStorage](API\Plugins\ZoneGraph\FZoneGraphStorage) & GetStorage() const
[]
AZoneGraphData::GetStorageLock
/Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraph/Public/ZoneGraphData.h
ZoneGraph
FCriticalSection & GetStorageLock() const
[]
AZoneGraphData::IsDrawingEnabled
/Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraph/Public/ZoneGraphData.h
ZoneGraph
bool IsDrawingEnabled() const
[]
AZoneGraphData::GetStorageMutable
/Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraph/Public/ZoneGraphData.h
TODO: I wonder if the storage is unnecessary indirection?
ZoneGraph
[FZoneGraphStorage](API\Plugins\ZoneGraph\FZoneGraphStorage) & GetStorageMutable()
[]
AZoneGraphData::IsRegistered
/Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraph/Public/ZoneGraphData.h
ZoneGraph
bool IsRegistered() const
[]
AZoneGraphData::OnRegistered
/Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraph/Public/ZoneGraphData.h
ZoneGraph
void OnRegistered ( const [FZoneGraphDataHandle](API\Plugins\ZoneGraph\FZoneGraphDataHandle) DataHandle )
[]
AZoneGraphData::OnUnregistered
/Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraph/Public/ZoneGraphData.h
ZoneGraph
void OnUnregistered()
[]
AZoneGraphData::PostActorCreated
/Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraph/Public/ZoneGraphData.h
Called when an actor is done spawning into the world (fromUWorld::SpawnActor), both in the editor and during gameplay For actors with a root component, the location and rotation will have already been set. This is called before calling construction scripts, but after native components have been created
ZoneGraph
virtual void PostActorCreated()
[]