Adventure Kit  4.16
Public Member Functions | Protected Attributes | Friends | List of all members
UAdvKitTransitionComponentLine Class Reference

Transition that is an area between two defined lines on the source and target zone. More...

#include <AdvKitTransitionComponentLine.h>

Inheritance diagram for UAdvKitTransitionComponentLine:
UAdvKitTransitionComponent

Public Member Functions

virtual void Init (TSubclassOf< AAdvKitCharacter > ForCharacter, const FVector &MinWorldSource, const FVector &MinWorldTarget, const FVector &MaxWorldSource, const FVector &MaxWorldTarget, 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 GetMinSourceLocation () const
 
FVector GetMaxSourceLocation () const
 
FVector GetMinTargetLocation () const
 
FVector GetMaxTargetLocation () 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)
 

Protected Attributes

FBasedPosition MinSourcePosition
 
FBasedPosition MinTargetPosition
 
FBasedPosition MaxSourcePosition
 
FBasedPosition MaxTargetPosition
 

Friends

class FAdvKitTransitionComponentLineVisualizer
 

Additional Inherited Members

- 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 an area between two defined lines on the source and target zone.

Member Function Documentation

FVector UAdvKitTransitionComponentLine::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 UAdvKitTransitionComponentLine::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 UAdvKitTransitionComponentLine::GetMaxSourceLocation ( ) const
Returns
The max source location of the transition in world space
FVector UAdvKitTransitionComponentLine::GetMaxTargetLocation ( ) const
Returns
The max target location of the transition in world space
FVector UAdvKitTransitionComponentLine::GetMinSourceLocation ( ) const
Returns
The min source location of the transition in world space
FVector UAdvKitTransitionComponentLine::GetMinTargetLocation ( ) const
Returns
The min target location of the transition in world space
void UAdvKitTransitionComponentLine::Init ( TSubclassOf< AAdvKitCharacter ForCharacter,
const FVector &  MinWorldSource,
const FVector &  MinWorldTarget,
const FVector &  MaxWorldSource,
const FVector &  MaxWorldTarget,
EAdvKitMovementMode  NewTargetPhysics,
class AAdvKitZone NewTargetZone = nullptr,
uint8  NewTargetCustomPhysics = 0 
)
virtual

Initializes the transition

Parameters
ForCharacterCharacter that can use the transition
MinWorldSourceLeft start of the transition line on the source zone in world space
MinWorldTargetLeft end of the transition line on the target zone in world space
MaxWorldSourceRight start of the transition line on the source zone in world space
MaxWorldTargetRight end 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 UAdvKitTransitionComponentLine::MaxSourcePosition
protected

Right start of the transition (inside the source zone)

FBasedPosition UAdvKitTransitionComponentLine::MaxTargetPosition
protected

Right end of the transition (inside of the target zone)

FBasedPosition UAdvKitTransitionComponentLine::MinSourcePosition
protected

Left start of the transition line(inside the source zone)

FBasedPosition UAdvKitTransitionComponentLine::MinTargetPosition
protected

Left end of the transition line (inside of the target zone)


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