1. Epic GamesDeveloper
  3. FSmartObjectSlotEntranceAnnotation

FSmartObjectSlotEntranceAnnotation

Annotation to define a entrance locations for a Smart Object Slot.

API > API/Plugins > API/Plugins/SmartObjectsModule

Annotation to define a entrance locations for a Smart Object Slot. This can be used to add multiple entry points to a slot, or to validate the entries against navigation data.

   
Name FSmartObjectSlotEntranceAnnotation
Type struct
Header File /Engine/Plugins/Runtime/SmartObjects/Source/SmartObjectsModule/Public/Annotations/SmartObjectSlotEntranceAnnotation.h
Include Path #include "Annotations/SmartObjectSlotEntranceAnnotation.h"

Syntax

USTRUCT (Meta=(DisplayName="Entrance"))  
struct FSmartObjectSlotEntranceAnnotation : public FSmartObjectSlotAnnotation

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

PRAGMA_DISABLE_DEPRECATION_WARNINGS FSmartObjectSlotEntranceAnnotation ()

 Macro needed to avoid deprecation errors with "Tag" being copied or created in the default methods. Annotations/SmartObjectSlotEntranceAnnotation.h  
  Annotations/SmartObjectSlotEntranceAnnotation.h  
  Annotations/SmartObjectSlotEntranceAnnotation.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bCheckTransitionTrajectory uint8 If set to true, collisions will be checked between the transition from navigation location and slot location. Annotations/SmartObjectSlotEntranceAnnotation.h
  • EditAnywhere
  • Category="Default"
bIsEntry uint8 Set to true if the entry can be used to enter the slot. Annotations/SmartObjectSlotEntranceAnnotation.h
  • EditAnywhere
  • Category="Default"
bIsExit uint8 Set to true if the entry can be used to exit the slot. Annotations/SmartObjectSlotEntranceAnnotation.h
  • EditAnywhere
  • Category="Default"
bTraceGroundLocation uint8 If set to true, ground location will be adjusted using a line trace. Annotations/SmartObjectSlotEntranceAnnotation.h
  • EditAnywhere
  • Category="Default"
Offset FVector3f Local space offset of the entry. Annotations/SmartObjectSlotEntranceAnnotation.h
  • EditAnywhere
  • Category="Default"
Rotation FRotator3f Local space rotation of the entry. Annotations/SmartObjectSlotEntranceAnnotation.h
  • EditAnywhere
  • Category="Default"
SelectionPriority ESmartObjectEntrancePriority During entrance selection, the highest priority entrance is selected. Annotations/SmartObjectSlotEntranceAnnotation.h
  • EditAnywhere
  • Category="Default"
Tags FGameplayTagContainer Tags that can be used to identify the entry. Annotations/SmartObjectSlotEntranceAnnotation.h
  • EditAnywhere
  • Category="Default"
TrajectorySlotHeightOffset float Height offset at slot location of the transition collision check. Annotations/SmartObjectSlotEntranceAnnotation.h
  • EditAnywhere
  • Category="Default"
  • Meta=(EditCondition="bCheckTransitionTrajectory")
TrajectoryStartHeightOffset float Height offset at start of the transition collision check. Annotations/SmartObjectSlotEntranceAnnotation.h
  • EditAnywhere
  • Category="Default"
  • Meta=(EditCondition="bCheckTransitionTrajectory")
TransitionCheckRadius float Radius of the transition trajectory check. Annotations/SmartObjectSlotEntranceAnnotation.h
  • EditAnywhere
  • Category="Default"
  • Meta=(EditCondition="bCheckTransitionTrajectory")

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void GetTrajectoryColliders ( const FTransform& SlotTransform,
TArray< FSmartObjectAnnotationCollider >& OutColliders
) const

   Annotations/SmartObjectSlotEntranceAnnotation.h  

virtual FVector GetWorldLocation ( const FTransform& SlotTransform
) const

   Annotations/SmartObjectSlotEntranceAnnotation.h  

virtual FRotator GetWorldRotation ( const FTransform& SlotTransform
) const

   Annotations/SmartObjectSlotEntranceAnnotation.h  

void PostSerialize ( const FArchive& Ar
)

   Annotations/SmartObjectSlotEntranceAnnotation.h  

Overridden from FSmartObjectSlotAnnotation

Name Remarks Include Path Unreal Specifiers

virtual void AdjustWorldTransform ( const FTransform& SlotTransform,
const FVector& DeltaTranslation,
const FRotator& DeltaRotation
)

 Called in editor to adjust the transform of the annotation. Annotations/SmartObjectSlotEntranceAnnotation.h  

virtual void DrawVisualization ( FSmartObjectVisualizationContext& VisContext
) const

 Methods to override to draw 3D visualization of the annotation. Annotations/SmartObjectSlotEntranceAnnotation.h  

virtual void DrawVisualizationHUD ( FSmartObjectVisualizationContext& VisContext
) const

 Methods to override to draw canvas visualization of the annotation. Annotations/SmartObjectSlotEntranceAnnotation.h  

virtual FTransform GetAnnotationWorldTransform ( const FTransform& SlotTransform
) const

 Returns the world space transform of the annotation. Annotations/SmartObjectSlotEntranceAnnotation.h  

virtual bool HasTransform()

   Annotations/SmartObjectSlotEntranceAnnotation.h  

Operators

Name Remarks Include Path Unreal Specifiers
  Annotations/SmartObjectSlotEntranceAnnotation.h  
  Annotations/SmartObjectSlotEntranceAnnotation.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
Tag_DEPRECATED FGameplayTag Tag that can be used to identify the entry. Annotations/SmartObjectSlotEntranceAnnotation.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page