1. Epic GamesDeveloper
  3. AXRCreativeAvatar

AXRCreativeAvatar

API > API/Plugins > API/Plugins/XRCreative

   
Name AXRCreativeAvatar
Type class
Header File /Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
Include Path #include "XRCreativeAvatar.h"

Syntax

UCLASS ()  
class AXRCreativeAvatar : public APawn

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

AXRCreativeAvatar ( const FObjectInitializer& ObjectInitializer
)

   XRCreativeAvatar.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddInputMappingContext ( UInputMappingContext* Context,
int32 Priority,
const FModifyContextOptions Options
)

 Adds an explicitly provided Input Mapping Context to the input system. XRCreativeAvatar.h
  • BlueprintCallable
  • Category="XR Creative"

void BP_OnVRInitialize()

 Called when In-Editor VR mode is started. In-Editor equivalent to Begin Play. XRCreativeAvatar.h
  • BlueprintImplementableEvent
  • BlueprintCallable
  • Category="XR Creative"
  • Meta=(DisplayName="On Enter VR")

void ClearAllInputMappings()

   XRCreativeAvatar.h
  • BlueprintCallable
  • Category="XR Creative"

void ConfigureToolset ( UXRCreativeToolset* InToolset
)

   XRCreativeAvatar.h  

FTransform GetHeadTransform()

   XRCreativeAvatar.h
  • BlueprintCallable
  • Category="XR Creative"

FTransform GetHeadTransformRoomSpace()

   XRCreativeAvatar.h
  • BlueprintCallable
  • Category="XR Creative"

bool GetLaserForHand ( EControllerHand InHand,
FVector& OutLaserStart,
FVector& OutLaserEnd
) const

   XRCreativeAvatar.h  

const TArray< TObjectPtr< UXRCreativeTool > > & GetTools()

   XRCreativeAvatar.h  

const UXRCreativeToolset * GetToolset()

   XRCreativeAvatar.h  

ALevelSequenceActor * OpenLevelSequence ( ULevelSequence* LevelSequence
)

   XRCreativeAvatar.h
  • BlueprintCallable
  • Category="XR Creative"

virtual void PlayHapticEffect ( UHapticFeedbackEffect_Base* HapticEffect,
const int ControllerID,
const EControllerHand Hand,
float Scale,
bool bLoop
)

 Play haptic feedback asset on a given hand - only left and right supported XRCreativeAvatar.h
  • BlueprintCallable
  • Category="XR Creative"

void RegisterObjectForInput ( UObject* Object
)

 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 XRCreativeAvatar.h
  • BlueprintCallable
  • Category="XR Creative"

void RemoveInputMappingContext ( UInputMappingContext* Context,
const FModifyContextOptions Options
)

 Removes an explicitly provided Input Mapping Context to the input system. XRCreativeAvatar.h
  • BlueprintCallable
  • Category="XR Creative"

void SetComponentTickInEditor ( UActorComponent* Component,
bool bShouldTickInEditor
)

   XRCreativeAvatar.h
  • BlueprintCallable
  • Category="XR Creative"

AActor * SpawnTransientActor ( TSubclassOf< AActor > ActorClass,
const FString& ActorName
)

 Includes special handling to not dirty editor worlds. XRCreativeAvatar.h
  • BlueprintCallable
  • Category="XR Creative"

AActor * SpawnTransientActor ( TSubclassOf< AActor > ActorClass,
const FString& ActorName,
TFunctionRef< void(AActor*)> DeferredConstructionCallback
)

   XRCreativeAvatar.h  

void StopHapticEffect ( EControllerHand Hand,
const int ControllerID
)

 Instantly stop a haptic feedback for a given hand - only left and right supported XRCreativeAvatar.h
  • BlueprintCallable
  • Category="XR Creative"

void UnregisterObjectForInput ( UObject* Object
)

 Unregisters the given object with the Avatar's Input Component XRCreativeAvatar.h
  • BlueprintCallable
  • Category="XR Creative"

Overridden from AActor

Name Remarks Include Path Unreal Specifiers

virtual void BeginPlay()

   XRCreativeAvatar.h  

virtual void GetActorEyesViewPoint ( FVector& Location,
FRotator& Rotation
) const

   XRCreativeAvatar.h  

virtual bool HasLocalNetOwner()

   XRCreativeAvatar.h  

virtual void OnConstruction ( const FTransform& InTransform
)

   XRCreativeAvatar.h  

virtual void Tick ( float InDeltaSeconds
)

   XRCreativeAvatar.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   XRCreativeAvatar.h  

Protected

Name Remarks Include Path Unreal Specifiers
Gets the input interface for the currently active input method. XRCreativeAvatar.h  

void HandleSessionShutdown ( TSharedRef< IConcertClientSession > InSession
)

   XRCreativeAvatar.h  

void HandleSessionStartup ( TSharedRef< IConcertClientSession > InSession
)

   XRCreativeAvatar.h  

AActor * InternalSpawnTransientActor ( TSubclassOf< AActor > ActorClass,
const FString& ActorName,
TOptional< TFunctionRef< void(AActor*)> > DeferredConstructionCallback
)

 Includes special handling to not dirty editor worlds. XRCreativeAvatar.h  

void MultiUserShutdown()

   XRCreativeAvatar.h  

void MultiUserStartup()

   XRCreativeAvatar.h  

void ProcessHaptics ( const float DeltaTime
)

   XRCreativeAvatar.h  

void RegisterInputComponent()

 Utility functions for registering and unregistering our input component with the correct input system. XRCreativeAvatar.h  

void UnregisterInputComponent()

   XRCreativeAvatar.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page