Adventure Kit  4.16
Public Member Functions | Public Attributes | List of all members
UAdvKitTransitionComponentPoint Class Reference

Transition that is a straight line defined by a start and end point. More...

#include <AdvKitTransitionComponentPoint.h>

Inheritance diagram for UAdvKitTransitionComponentPoint:
UAdvKitTransitionComponent

Public Member Functions

virtual void Init (TSubclassOf< AAdvKitCharacter > ForCharacter, const FVector &WorldSource, const FVector &WorldTarget, EAdvKitMovementMode NewTargetPhysics, class AAdvKitZone *NewTargetZone=nullptr, uint8 NewTargetCustomPhysics=0)
 
virtual void OnComponentDestroyed (bool bDestroyingHierarchy) override
 
virtual FVector GetClosestSourcePosition (const FVector &ToWorldPosition) override
 
virtual FVector GetClosestTargetPosition (const FVector &ToWorldPosition) override
 
FVector GetSourceLocation () const
 
FVector GetTargetLocation () const
 
- Public Member Functions inherited from UAdvKitTransitionComponent
virtual bool CanTransition (AAdvKitCharacter *Character, const FVector &AtLocation, const FVector &InDirection, bool bIsJump)
 
virtual bool IsDynamicTransitionValid ()
 
virtual bool IsSupportedForNetworking () const override
 
virtual bool IsNameStableForNetworking () const override
 
 UAdvKitTransitionComponent (const FObjectInitializer &ObjectInitializer)
 

Public Attributes

FBasedPosition TargetPosition
 
FBasedPosition SourcePosition
 
- Public Attributes inherited from UAdvKitTransitionComponent
UAdvKitTransitionBuilderModuleCreatedByBuildModule
 
FString TransitionId
 
bool bIsDynamic
 
bool bDynamicTransitionActive
 
uint8 bNeedsJump: 1
 
FVector TransitionDirection
 
float MinDirectionNormal
 
float MinLocationRadius
 
TSubclassOf< AAdvKitCharacterUseableBy
 
TWeakObjectPtr< class AAdvKitZoneTargetZone
 
EAdvKitMovementMode TargetPhysics
 
uint8 TargetCustomPhysics
 

Detailed Description

Transition that is a straight line defined by a start and end point.

Member Function Documentation

FVector UAdvKitTransitionComponentPoint::GetClosestSourcePosition ( const FVector &  ToWorldPosition)
overridevirtual

Query to get the closest location where a transition can start in relation to another location.

Parameters
ToWorldPositionLocation in world space to find reference point to.
Returns
Closest location in world space to start the transition.

Reimplemented from UAdvKitTransitionComponent.

FVector UAdvKitTransitionComponentPoint::GetClosestTargetPosition ( const FVector &  ToWorldPosition)
overridevirtual

Query to get the closest location where a transition will end in relation to another location.

Parameters
ToWorldPositionLocation in world space to find reference point to.
Returns
Closest location in world space to end the transition.

Reimplemented from UAdvKitTransitionComponent.

FVector UAdvKitTransitionComponentPoint::GetSourceLocation ( ) const
Returns
The source location of the transition in world space
FVector UAdvKitTransitionComponentPoint::GetTargetLocation ( ) const
Returns
The target location of the transition in world space
void UAdvKitTransitionComponentPoint::Init ( TSubclassOf< AAdvKitCharacter ForCharacter,
const FVector &  WorldSource,
const FVector &  WorldTarget,
EAdvKitMovementMode  NewTargetPhysics,
class AAdvKitZone NewTargetZone = nullptr,
uint8  NewTargetCustomPhysics = 0 
)
virtual

Initializes the transition

Parameters
ForCharacterCharacter that can use the transition
WorldSourceStart of the transition line on the source zone in world space
WorldTargetEnd of the transition line on the target zone in world space
NewTargetPhysicsMovement mode the character will have after the transition
NewTargetZoneZone the character will be in after the transition
NewTargetCustomPhysicsCustom movement mode the character will have after the transition

Member Data Documentation

FBasedPosition UAdvKitTransitionComponentPoint::SourcePosition

Based position on the start zone

FBasedPosition UAdvKitTransitionComponentPoint::TargetPosition

Based position on the target zone


The documentation for this class was generated from the following files: