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
UVRNotificationsComponent::OnUnregister
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/VRNotificationsComponent.h
Called when a component is unregistered. Called after DestroyRenderState_Concurrent and OnDestroyPhysicsState are called.
XRBase
virtual void OnUnregister()
[]
UVRNotificationsComponent::UVRNotificationsComponent
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/VRNotificationsComponent.h
XRBase
UVRNotificationsComponent ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )
[]
UVRNotificationsComponent
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/VRNotificationsComponent.h
XRBase
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable, Meta=(BlueprintSpawnableComponent), ClassGroup=HeadMountedDisplay) class UVRNotificationsComponent : public [UActorComponent](API\Runtime\Engine\Components\UActorComponent)
[ { "type": "FVRNotification...", "name": "HMDConnectCanceledDelegate", "description": "This will be called when the user declines to connect the HMD when prompted to do so by a system dialog. (PS4 Only)" }, { "type": "FVRNotification...", "name": "HMDLostDelegate", "description": "This will be called when connection to HMD is lost." }, { "type": "FVRNotification...", "name": "HMDPutOnHeadDelegate", "description": "This will be called when the HMD detects that it has been put on by a player." }, { "type": "FVRNotification...", "name": "HMDRecenteredDelegate", "description": "This will be called when the application is asked for VR headset recenter." }, { "type": "FVRNotification...", "name": "HMDReconnectedDelegate", "description": "This will be called when connection to HMD is restored." }, { "type": "FVRNotification...", "name": "HMDRemovedFromHeadDelegate", "description": "This will be called when the HMD detects that it has been taken off by a player (disconnecting the hmd also causes it to register as taken off)." }, { "type": "FVRNotification...", "name": "HMDTrackingInitializedDelegate", "description": "This will be called on Morpheus when the HMD is done initializing and therefore reprojection will start functioning." }, { "type": "FVRNotification...", "name": "HMDTrackingInitializingAndNeedsHMDToBeTrackedDelegate", "description": "This will be called on Morpheus if the HMD starts up and is not fully initialized (in NOT_STARTED or CALIBRATING states)." }, { "type": "FVRNotification...", "name": "VRControllerRecenteredDelegate", "description": "This will be called when the VR system recenters a controller." }, { "type": "FVRNotification...", "name": "XRInteractionProfileChangedDelegate", "description": "This will be called whenever the interaction profile is altered." }, { "type": "FVRNotification...", "name": "XRPlayAreaChangedDelegate", "description": "This will be called whenever the play area is altered." }, { "type": "FVRNotification...", "name": "XRTrackingOriginChangedDelegate", "description": "This will be called whenever the tracking origin is altered." } ]
UXRAssetFunctionLibrary::AddDeviceVisualizationComponentBlocking
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRAssetFunctionLibrary.h
NOTE: The associated XR system backend has to provide a model for this to work - if one is not available for the specific device, then this will fail and return an invalid (null) object. A new component representing the specified device (invalid/null if a model for the device doesn't exist).
XRBase
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR|Devices", Meta=(DefaultToSelf="Target")) static [UPrimitiveComponent](API\Runtime\Engine\Components\UPrimitiveComponent) * AddDeviceVisualizationComponentBlocking ( [AActor](API\Runtime\Engine\GameFramework\AActor) * Target, const [FXRDeviceId](API\Runtime\HeadMountedDisplay\FXRDeviceId) & XRDeviceId, bool bManualAttachment, const FTransform & RelativeTransform )
[]
UXRAssetFunctionLibrary::AddNamedDeviceVisualizationComponentBlocking
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRAssetFunctionLibrary.h
NOTE: The associated XR system backend has to provide a model for this to work - if one is not available for the specific device, then this will fail and return an invalid (null) object. A new component representing the specified device (invalid/null if a model for the device doesn't exist).
XRBase
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR|Devices", Meta=(DefaultToSelf="Target")) static [UPrimitiveComponent](API\Runtime\Engine\Components\UPrimitiveComponent) * AddNamedDeviceVisualizationComponentBlocking ( [AActor](API\Runtime\Engine\GameFramework\AActor) * Target, const [FName](API\Runtime\Core\UObject\FName) SystemName, const [FName](API\Runtime\Core\UObject\FName) DeviceName, bool bManualAttachment, const FTransform & RelativeTransform, [FXRDeviceId](API\Runtime\HeadMountedDisplay\FXRDeviceId) & XRDeviceId )
[]
UXRAssetFunctionLibrary::UXRAssetFunctionLibrary
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRAssetFunctionLibrary.h
XRBase
UXRAssetFunctionLibrary ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )
[]
UXRAssetFunctionLibrary
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRAssetFunctionLibrary.h
UXRAssetFunctionLibrary
XRBase
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UXRAssetFunctionLibrary : public [UBlueprintFunctionLibrary](API\Runtime\Engine\Kismet\UBlueprintFunctionLibrary)
[]
UXRDeviceVisualizationComponent::BeginPlay
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRDeviceVisualizationComponent.h
Used to detach physics objects before simulation begins. This is needed because at runtime we can't have simulated objects inside the attachment hierarchy
XRBase
virtual void BeginPlay()
[]
UXRDeviceVisualizationComponent::CanDeviceBeDisplayed
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRDeviceVisualizationComponent.h
Whether this component can be displayed, depending on whether the parent MotionController has activated its rendering.
XRBase
bool CanDeviceBeDisplayed()
[]
CustomModelSourceId
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRDeviceVisualizationComponent.h
XRBase
static [FName](API\Runtime\Core\UObject\FName) CustomModelSourceId;
[]
EModelLoadStatus
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRDeviceVisualizationComponent.h
XRBase
enum EModelLoadStatus { Unloaded, Pending, InProgress, Complete, }
[]
UXRDeviceVisualizationComponent::FindParentMotionController
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRDeviceVisualizationComponent.h
XRBase
[UMotionControllerComponent](API\Runtime\HeadMountedDisplay\UMotionControllerComponent) * FindParentMotionController()
[]
UXRDeviceVisualizationComponent::OnDisplayModelLoaded
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRDeviceVisualizationComponent.h
Callback for asynchronous display model loads (to set materials, etc.)
XRBase
void OnDisplayModelLoaded ( [UPrimitiveComponent](API\Runtime\Engine\Components\UPrimitiveComponent) * DisplayComponent )
[]
UXRDeviceVisualizationComponent::OnUnregister
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRDeviceVisualizationComponent.h
Called when a component is unregistered. Called after DestroyRenderState_Concurrent and OnDestroyPhysicsState are called.
XRBase
virtual void OnUnregister()
[]
UXRDeviceVisualizationComponent::PreEditChange
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRDeviceVisualizationComponent.h
This is called when a property is about to be modified externally
XRBase
virtual void PreEditChange ( [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * PropertyAboutToChange )
[]
UXRDeviceVisualizationComponent::RefreshMesh
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRDeviceVisualizationComponent.h
XRBase
void RefreshMesh()
[]
UXRDeviceVisualizationComponent::SetCustomDisplayMesh
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRDeviceVisualizationComponent.h
XRBase
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintSetter) void SetCustomDisplayMesh ( [UStaticMesh](API\Runtime\Engine\Engine\UStaticMesh) * NewDisplayMesh )
[]
UXRDeviceVisualizationComponent::SetDisplayModelSource
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRDeviceVisualizationComponent.h
XRBase
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintSetter) void SetDisplayModelSource ( const [FName](API\Runtime\Core\UObject\FName) NewDisplayModelSource )
[]
UXRDeviceVisualizationComponent::SetIsRenderingActive
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRDeviceVisualizationComponent.h
XRBase
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintSetter, Category="MotionController") void SetIsRenderingActive ( bool bRenderingIsActive )
[]
UXRDeviceVisualizationComponent::SetIsVisualizationActive
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRDeviceVisualizationComponent.h
XRBase
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintSetter) void SetIsVisualizationActive ( bool bNewVisualizationState )
[]
UXRDeviceVisualizationComponent::SetMaterials
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRDeviceVisualizationComponent.h
XRBase
void SetMaterials ( int32 MatCount )
[]
UXRDeviceVisualizationComponent::UXRDeviceVisualizationComponent
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRDeviceVisualizationComponent.h
XRBase
UXRDeviceVisualizationComponent ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )
[]
UXRDeviceVisualizationComponent
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRDeviceVisualizationComponent.h
XRBase
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable, Meta=(BlueprintSpawnableComponent), ClassGroup=MotionController) class UXRDeviceVisualizationComponent : public [UStaticMeshComponent](API\Runtime\Engine\Components\UStaticMeshComponent)
[ { "type": "bool", "name": "bIsRenderingActive", "description": "Set by the parent MotionController once tracking kicks in." }, { "type": "bool", "name": "bIsVisualizationActive", "description": "Whether the visualization offered by this component is being used." }, { "type": "TObjectPtr<USt...", "name": "CustomDisplayMesh", "description": "A mesh override that'll be displayed attached to this MotionController." }, { "type": "FXRDeviceId", "name": "DisplayDeviceId", "description": "" }, { "type": "TArray<TObject...", "name": "DisplayMeshMaterialOverrides", "description": "Material overrides for the specified display mesh." }, { "type": "EModelLoadStatu...", "name": "DisplayModelLoadState", "description": "" }, { "type": "FName", "name": "DisplayModelSource", "description": "Determines the source of the desired model." }, { "type": "FName", "name": "MotionSource", "description": "" }, { "type": "int32", "name": "PreEditMaterialCount", "description": "" } ]
UXRLoadingScreenFunctionLibrary::AddLoadingScreenSplash
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRLoadingScreenFunctionLibrary.h
Adds a splash element to the loading screen.
XRBase
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|HeadMountedDisplay|LoadingScreen") static void AddLoadingScreenSplash ( class [UTexture](API\Runtime\Engine\Engine\UTexture) * Texture, FVector Translation, FRotator Rotation, FVector2D Size, FRotator DeltaRotation, bool bClearBeforeAdd )
[]
UXRLoadingScreenFunctionLibrary::ClearLoadingScreenSplashes
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRLoadingScreenFunctionLibrary.h
XRBase
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|HeadMountedDisplay|LoadingScreen") static void ClearLoadingScreenSplashes()
[]
UXRLoadingScreenFunctionLibrary::HideLoadingScreen
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRLoadingScreenFunctionLibrary.h
Hide the splash screen and return to normal display.
XRBase
static void HideLoadingScreen()
[]
UXRLoadingScreenFunctionLibrary::SetLoadingScreen
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRLoadingScreenFunctionLibrary.h
XRBase
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|HeadMountedDisplay|LoadingScreen") static void SetLoadingScreen ( class [UTexture](API\Runtime\Engine\Engine\UTexture) * Texture, FVector2D Scale, FVector Offset, bool bShowLoadingMovie, bool bShowOnSet )
[]
UXRLoadingScreenFunctionLibrary::ShowLoadingScreen
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRLoadingScreenFunctionLibrary.h
Show the loading screen and override the VR display
XRBase
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|HeadMountedDisplay|LoadingScreen") static void ShowLoadingScreen()
[]
UXRLoadingScreenFunctionLibrary::UXRLoadingScreenFunctionLibrary
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRLoadingScreenFunctionLibrary.h
XRBase
UXRLoadingScreenFunctionLibrary ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )
[]
UXRLoadingScreenFunctionLibrary
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRLoadingScreenFunctionLibrary.h
XR Loading Screen Function Library
XRBase
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UXRLoadingScreenFunctionLibrary : public [UBlueprintFunctionLibrary](API\Runtime\Engine\Kismet\UBlueprintFunctionLibrary)
[]
AXRCreativeAvatar::AddInputMappingContext
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
Adds an explicitly provided Input Mapping Context to the input system.
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") void AddInputMappingContext ( [UInputMappingContext](API\Plugins\EnhancedInput\UInputMappingContext) * Context, int32 Priority )
[]
AXRCreativeAvatar::BeginDestroy
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.
XRCreative
virtual void BeginDestroy()
[]
AXRCreativeAvatar::BeginPlay
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
Overridable native event for when play begins for this actor.
XRCreative
virtual void BeginPlay()
[]
AXRCreativeAvatar::ConfigureToolset
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
XRCreative
void ConfigureToolset ( [UXRCreativeToolset](API\Plugins\XRCreative\UXRCreativeToolset) * InToolset )
[]
AXRCreativeAvatar::GetEnhancedInputSubsystemInterface
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
Gets the input interface for the currently active input method. Will switch between editor and player based input as needed
XRCreative
[IEnhancedInputSubsystemInterface](API\Plugins\EnhancedInput\IEnhancedInputSubsystemInterface) * GetEnhancedInputSubsystemInterface() const
[]
AXRCreativeAvatar::GetHeadTransform
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") FTransform GetHeadTransform() const
[]
AXRCreativeAvatar::GetHeadTransformRoomSpace
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") FTransform GetHeadTransformRoomSpace() const
[]
AXRCreativeAvatar::GetLaserForHand
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
XRCreative
bool GetLaserForHand ( EControllerHand InHand, FVector & OutLaserStart, FVector & OutLaserEnd ) const
[]
AXRCreativeAvatar::HandleSessionShutdown
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
XRCreative
void HandleSessionShutdown ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IConcertClientSession](API\Plugins\Concert\IConcertClientSession) > InSession )
[]
AXRCreativeAvatar::HandleSessionStartup
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
XRCreative
void HandleSessionStartup ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IConcertClientSession](API\Plugins\Concert\IConcertClientSession) > InSession )
[]
AXRCreativeAvatar::HasLocalNetOwner
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
Does this actor have a locally controlled owner responsible for replication? (APlayerControllertypically) true if this actor can call RPCs or false if no such owner chain exists
XRCreative
virtual bool HasLocalNetOwner() const
[]
AXRCreativeAvatar::InternalSpawnTransientActor
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
Includes special handling to not dirty editor worlds.
XRCreative
[AActor](API\Runtime\Engine\GameFramework\AActor) * InternalSpawnTransientActor ( [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [AActor](API\Runtime\Engine\GameFramework\AActor) > ActorClass, const [FString](API\Runtime\Core\Containers\FString) & ActorName, [TOptional](API\Runtime\Core\IO\TOptional)< [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void([AActor](API\Runtime\Engine\GameFramework\AActor) *)>> DeferredConstructionCallback )
[]
AXRCreativeAvatar::MultiUserShutdown
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
XRCreative
void MultiUserShutdown()
[]
AXRCreativeAvatar::MultiUserStartup
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
XRCreative
void MultiUserStartup()
[]
AXRCreativeAvatar::OnConstruction
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
Called when an instance of this class is placed (in editor) or spawned.
XRCreative
virtual void OnConstruction ( const FTransform & Transform )
[]
AXRCreativeAvatar::PlayHapticEffect
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
Play haptic feedback asset on a given hand - only left and right supported
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") virtual void PlayHapticEffect ( [UHapticFeedbackEffect_Base](API\Runtime\Engine\Haptics\UHapticFeedbackEffect_Base) * HapticEffect, const int ControllerID, const EControllerHand Hand, float Scale, bool bLoop )
[]
AXRCreativeAvatar::OpenLevelSequence
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") [ALevelSequenceActor](API\Runtime\LevelSequence\ALevelSequenceActor) * OpenLevelSequence ( [ULevelSequence](API\Runtime\LevelSequence\ULevelSequence) * LevelSequence )
[]
AXRCreativeAvatar::ProcessHaptics
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
XRCreative
void ProcessHaptics ( const float DeltaTime )
[]
AXRCreativeAvatar::RegisterInputComponent
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
Utility functions for registering and unregistering our input component with the correct input system.
XRCreative
void RegisterInputComponent()
[]
AXRCreativeAvatar::RemoveInputMappingContext
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
Removes an explicitly provided Input Mapping Context to the input system.
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") void RemoveInputMappingContext ( [UInputMappingContext](API\Plugins\EnhancedInput\UInputMappingContext) * Context )
[]
AXRCreativeAvatar::RegisterObjectForInput
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
Registers the given object with the Avatar's Input Component This allows dynamic input bindings such as input events in blueprints to work correctly Note: Ensure you call UnregisterObjectForInput when you are finished with the object otherwise input events will still fire until GC actually destroys the object
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") void RegisterObjectForInput ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Object )
[]
AXRCreativeAvatar::SpawnTransientActor
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
Includes special handling to not dirty editor worlds.
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") [AActor](API\Runtime\Engine\GameFramework\AActor) * SpawnTransientActor ( [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [AActor](API\Runtime\Engine\GameFramework\AActor) > ActorClass, const [FString](API\Runtime\Core\Containers\FString) & ActorName )
[]
AXRCreativeAvatar::SetComponentTickInEditor
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") void SetComponentTickInEditor ( [UActorComponent](API\Runtime\Engine\Components\UActorComponent) * Component, bool bShouldTickInEditor )
[]
AXRCreativeAvatar::SpawnTransientActor
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
XRCreative
[AActor](API\Runtime\Engine\GameFramework\AActor) * SpawnTransientActor ( [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [AActor](API\Runtime\Engine\GameFramework\AActor) > ActorClass, const [FString](API\Runtime\Core\Containers\FString) & ActorName, [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void([AActor](API\Runtime\Engine\GameFramework\AActor) *)> DeferredConstructionCallback )
[]
AXRCreativeAvatar::StopHapticEffect
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
Instantly stop a haptic feedback for a given hand - only left and right supported
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") void StopHapticEffect ( EControllerHand Hand, const int ControllerID )
[]
AXRCreativeAvatar::Tick
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
Function called every frame on this Actor. Override this function to implement custom logic to be executed every frame. Note that Tick is disabled by default, and you will need to check PrimaryActorTick.bCanEverTick is set to true to enable it.
XRCreative
virtual void Tick ( float DeltaSeconds )
[]
AXRCreativeAvatar::UnregisterInputComponent
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
XRCreative
void UnregisterInputComponent()
[]
AXRCreativeAvatar::UnregisterObjectForInput
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
Unregisters the given object with the Avatar's Input Component
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative") void UnregisterObjectForInput ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Object )
[]
AXRCreativeAvatar::AXRCreativeAvatar
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
XRCreative
AXRCreativeAvatar ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )
[]
AXRCreativeAvatar
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
XRCreative
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class AXRCreativeAvatar : public [APawn](API\Runtime\Engine\GameFramework\APawn)
[ { "type": "TSharedPtr<FAc...", "name": "ActiveHapticEffect_Left", "description": "Currently playing haptic effects for both the left and right hand" }, { "type": "TSharedPtr<FAc...", "name": "ActiveHapticEffect_Right", "description": "" }, { "type": "bool", "name": "bIsInputRegistered", "description": "" }, { "type": "TObjectPtr<UMo...", "name": "LeftController", "description": "" }, { "type": "TObjectPtr<UMo...", "name": "LeftControllerAim", "description": "" }, { "type": "TObjectPtr<USk...", "name": "LeftControllerModel", "description": "" }, { "type": "TObjectPtr<UXR...", "name": "LeftControllerPointer", "description": "" }, { "type": "TObjectPtr<UWi...", "name": "MenuWidget", "description": "" }, { "type": "FDelegateHandle", "name": "OnSessionShutdownHandle", "description": "Delegate handle for a the callback when a session shuts down" }, { "type": "FDelegateHandle", "name": "OnSessionStartupHandle", "description": "Delegate handle for a the callback when a session starts up" }, { "type": "TObjectPtr<UMo...", "name": "RightController", "description": "" }, { "type": "TObjectPtr<UMo...", "name": "RightControllerAim", "description": "" }, { "type": "TObjectPtr<USk...", "name": "RightControllerModel", "description": "" }, { "type": "TObjectPtr<UXR...", "name": "RightControllerPointer", "description": "" }, { "type": "TArray<TObject...", "name": "Tools", "description": "" }, { "type": "TObjectPtr<UXR...", "name": "ToolsComponent", "description": "" }, { "type": "TObjectPtr<UXR...", "name": "Toolset", "description": "" }, { "type": "TWeakPtr<IConc...", "name": "WeakSession", "description": "Weak pointer to the client session with which to send events. May be null or stale." }, { "type": "TObjectPtr<UWi...", "name": "WidgetInteraction", "description": "" } ]
AXRCreativeBaseTransformGizmoActor::ConstructDefaults
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeGizmos.h
XRCreative
void ConstructDefaults ( ETransformGizmoSubElements EnableElements )
[]
AXRCreativeBaseTransformGizmoActor::SetupAxisArrow
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeGizmos.h
XRCreative
[UGizmoArrowComponent](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoArrowComponent) * SetupAxisArrow ( [UGizmoArrowComponent](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoArrowComponent) * InComponent, const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & InColor, const FVector & InAxis )
[]
AXRCreativeBaseTransformGizmoActor::SetupAxisRotateCircle
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeGizmos.h
XRCreative
[UGizmoCircleComponent](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoCircleComponent) * SetupAxisRotateCircle ( [UGizmoCircleComponent](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoCircleComponent) * InComponent, const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & InColor, const FVector & InAxis )
[]
AXRCreativeBaseTransformGizmoActor::SetupAxisScaleRect
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeGizmos.h
XRCreative
[UGizmoRectangleComponent](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoRectangleComponent) * SetupAxisScaleRect ( [UGizmoRectangleComponent](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoRectangleComponent) * InComponent, const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & InColor, const FVector & InAxis0, const FVector & InAxis1 )
[]
AXRCreativeBaseTransformGizmoActor::SetupPlaneRect
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeGizmos.h
XRCreative
[UGizmoRectangleComponent](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoRectangleComponent) * SetupPlaneRect ( [UGizmoRectangleComponent](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoRectangleComponent) * InComponent, const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & InColor, const FVector & InAxis0, const FVector & InAxis1 )
[]
AXRCreativeBaseTransformGizmoActor::SetupPlaneScaleFunc
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeGizmos.h
XRCreative
[UGizmoRectangleComponent](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoRectangleComponent) * SetupPlaneScaleFunc ( [UGizmoRectangleComponent](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoRectangleComponent) * InComponent, const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & InColor, const FVector & InAxis0, const FVector & InAxis1 )
[]
AXRCreativeBaseTransformGizmoActor::AXRCreativeBaseTransformGizmoActor
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeGizmos.h
XRCreative
AXRCreativeBaseTransformGizmoActor()
[]
AXRCreativeBaseTransformGizmoActor
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeGizmos.h
XRCreative
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable) class AXRCreativeBaseTransformGizmoActor : public [ACombinedTransformGizmoActor](API\Runtime\InteractiveToolsFramework\BaseGizmos\ACombinedTransformGizmoActor)
[ { "type": "float", "name": "GizmoLineThickness", "description": "Only used during Setup(...) component methods; set before calling those or ConstructDefaults." } ]
AXRCreativeGameMode::GetToolset
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeGameMode.h
XRCreative
[UXRCreativeToolset](API\Plugins\XRCreative\UXRCreativeToolset) * GetToolset() const
[]
AXRCreativeGameMode
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeGameMode.h
XRCreative
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class AXRCreativeGameMode : public [AGameModeBase](API\Runtime\Engine\GameFramework\AGameModeBase)
[ { "type": "TSoftObjectPtr<...", "name": "ToolsetClass", "description": "" } ]
AXRCreativeTeleporter::BeginPlay
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeTeleporter.h
Called when the game starts or when spawned.
XRCreative
virtual void BeginPlay()
[]
AXRCreativeTeleporter::HasLocalNetOwner
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeTeleporter.h
Does this actor have a locally controlled owner responsible for replication? (APlayerControllertypically) true if this actor can call RPCs or false if no such owner chain exists
XRCreative
virtual bool HasLocalNetOwner() const
[]
AXRCreativeTeleporter::AXRCreativeTeleporter
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeTeleporter.h
Sets default values for this actor's properties.
XRCreative
AXRCreativeTeleporter ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )
[]
AXRCreativeTeleporter::Tick
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeTeleporter.h
Called every frame.
XRCreative
virtual void Tick ( float DeltaTime )
[]
AXRCreativeTeleporter
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeTeleporter.h
XRCreative
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class AXRCreativeTeleporter : public [AActor](API\Runtime\Engine\GameFramework\AActor)
[ { "type": "TObjectPtr<UMo...", "name": "LeftController", "description": "" }, { "type": "TObjectPtr<UMo...", "name": "RightController", "description": "" }, { "type": "TObjectPtr<USt...", "name": "TeleportMesh", "description": "" } ]
AXRCreativeTRGizmoActor::AXRCreativeTRGizmoActor
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeGizmos.h
XRCreative
AXRCreativeTRGizmoActor()
[]
AXRCreativeTRGizmoActor
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeGizmos.h
XRCreative
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class AXRCreativeTRGizmoActor : public [AXRCreativeBaseTransformGizmoActor](API\Plugins\XRCreative\AXRCreativeBaseTransformGizmoAct-)
[]
AXRCreativeTRSGizmoActor::AXRCreativeTRSGizmoActor
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeGizmos.h
XRCreative
AXRCreativeTRSGizmoActor()
[]
AXRCreativeTRSGizmoActor
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeGizmos.h
XRCreative
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class AXRCreativeTRSGizmoActor : public [AXRCreativeBaseTransformGizmoActor](API\Plugins\XRCreative\AXRCreativeBaseTransformGizmoAct-)
[]
FXRCreativeToolEntry
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeToolset.h
XRCreative
[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)([BlueprintType](Programming/UnrealArchitecture/Reference/Structs/Specifiers/BlueprintType)) struct FXRCreativeToolEntry
[ { "type": "TSubclassOf<UX...", "name": "ToolClass", "description": "" }, { "type": "TObjectPtr<UTe...", "name": "ToolIcon", "description": "" } ]
AXRCreativeTRUSGizmoActor::AXRCreativeTRUSGizmoActor
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeGizmos.h
XRCreative
AXRCreativeTRUSGizmoActor()
[]
AXRCreativeTRUSGizmoActor
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeGizmos.h
XRCreative
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class AXRCreativeTRUSGizmoActor : public [AXRCreativeBaseTransformGizmoActor](API\Plugins\XRCreative\AXRCreativeBaseTransformGizmoAct-)
[]
UXRCreativeBlueprintableTool::GetDisplayName
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeToolset.h
XRCreative
virtual [FText](API\Runtime\Core\Internationalization\FText) GetDisplayName() const
[]
UXRCreativeBlueprintableTool::GetPaletteTabClass
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeToolset.h
XRCreative
virtual [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [UXRCreativePaletteToolTab](API\Plugins\XRCreative\UXRCreativePaletteToolTab) > GetPaletteTabClass() const
[]
UXRCreativeBlueprintableTool::GetToolName
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeToolset.h
XRCreative
virtual [FName](API\Runtime\Core\UObject\FName) GetToolName() const
[]
UXRCreativeBlueprintableTool
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeToolset.h
XRCreative
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract, Blueprintable) class UXRCreativeBlueprintableTool : public [UXRCreativeTool](API\Plugins\XRCreative\UXRCreativeTool)
[ { "type": "FText", "name": "DisplayName", "description": "" }, { "type": "TSubclassOf<UX...", "name": "PaletteTabClass", "description": "" }, { "type": "TSubclassOf<AA...", "name": "ToolActor", "description": "" }, { "type": "TObjectPtr<UIn...", "name": "ToolInputMappingContext", "description": "" }, { "type": "FName", "name": "ToolName", "description": "" } ]
UXRCreativeGizmoBuilder::UXRCreativeGizmoBuilder
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeGizmos.h
XRCreative
UXRCreativeGizmoBuilder()
[]
UXRCreativeITFComponent::CanRedo
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeITFComponent.h
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative|Tools") bool CanRedo() const
[]
UXRCreativeITFComponent::CanUndo
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeITFComponent.h
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative|Tools") bool CanUndo() const
[]
UXRCreativeGizmoBuilder
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeGizmos.h
XRCreative
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UXRCreativeGizmoBuilder : public [UCombinedTransformGizmoBuilder](API\Runtime\InteractiveToolsFramework\BaseGizmos\UCombinedTransformGizmoBuilder)
[]
UXRCreativeITFComponent::EditorToolsTick
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeITFComponent.h
XRCreative
void EditorToolsTick ( float InDeltaTime )
[]
UXRCreativeITFComponent::GetCurrentCoordinateSystem
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeITFComponent.h
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative|Tools") EToolContextCoordinateSystem GetCurrentCoordinateSystem() const
[]
UXRCreativeITFComponent::GetSelectionSet
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeITFComponent.h
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative|Tools") [UTypedElementSelectionSet](API\Runtime\TypedElementRuntime\Elements\Framework\UTypedElementSelectionSet) * GetSelectionSet() const
[]
UXRCreativeITFComponent::InitializeComponent
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeITFComponent.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()
[]
UXRCreativeITFComponent::HaveActiveTool
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeITFComponent.h
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative|Tools") bool HaveActiveTool()
[]
UXRCreativeITFComponent::IsInEditor
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeITFComponent.h
XRCreative
bool IsInEditor() const
[]
UXRCreativeITFComponent::LeftMousePressed
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeITFComponent.h
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative|Tools") void LeftMousePressed()
[]
UXRCreativeITFComponent::LeftMouseReleased
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeITFComponent.h
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative|Tools") void LeftMouseReleased()
[]
UXRCreativeITFComponent::Redo
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeITFComponent.h
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative|Tools") void Redo()
[]
UXRCreativeITFComponent::SetCurrentCoordinateSystem
/Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeITFComponent.h
XRCreative
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR Creative|Tools") void SetCurrentCoordinateSystem ( EToolContextCoordinateSystem CoordSystem )
[]