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

Base class for transitions between zones. More...

#include <AdvKitTransitionComponent.h>

Inheritance diagram for UAdvKitTransitionComponent:
UAdvKitTransitionComponentLine UAdvKitTransitionComponentPoint UAdvKitTransitionComponentRect UAdvKitTransitionComponentSpline

Public Member Functions

virtual FVector GetClosestSourcePosition (const FVector &ToWorldPosition)
 
virtual FVector GetClosestTargetPosition (const FVector &ToWorldPosition)
 
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

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

Base class for transitions between zones.

Constructor & Destructor Documentation

UAdvKitTransitionComponent::UAdvKitTransitionComponent ( const FObjectInitializer &  ObjectInitializer)

Constructor

Member Function Documentation

bool UAdvKitTransitionComponent::CanTransition ( AAdvKitCharacter Character,
const FVector &  AtLocation,
const FVector &  InDirection,
bool  bIsJump 
)
virtual

Check if the transition can be used.

Parameters
CharacterCharacter that wants to transition
AtLocationWorld location from where to start the transition if possible
InDirectionDirection in world space where to transition to
bIsJumpWhether or not the transition is done with a jump
Returns
True if transition can be used.
FVector UAdvKitTransitionComponent::GetClosestSourcePosition ( const FVector &  ToWorldPosition)
virtual

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 in UAdvKitTransitionComponentSpline, UAdvKitTransitionComponentLine, UAdvKitTransitionComponentRect, and UAdvKitTransitionComponentPoint.

FVector UAdvKitTransitionComponent::GetClosestTargetPosition ( const FVector &  ToWorldPosition)
virtual

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 in UAdvKitTransitionComponentSpline, UAdvKitTransitionComponentLine, UAdvKitTransitionComponentRect, and UAdvKitTransitionComponentPoint.

bool UAdvKitTransitionComponent::IsDynamicTransitionValid ( )
virtual

Dynamic transitions can be invalid (e.g. a transition point is too far off) and not be used during this time (think moving platforms).

Returns
True if the dynamic transition can be used.

Member Data Documentation

bool UAdvKitTransitionComponent::bDynamicTransitionActive

Flag that indicates this transition is dynamic.

bool UAdvKitTransitionComponent::bIsDynamic

Flag that indicates this transition is dynamic.

uint8 UAdvKitTransitionComponent::bNeedsJump

Character needs to jump

UAdvKitTransitionBuilderModule* UAdvKitTransitionComponent::CreatedByBuildModule

Class of build module responsible for creating this transitions, used to update

float UAdvKitTransitionComponent::MinDirectionNormal

Character's direction can differ this much from the required direction.

float UAdvKitTransitionComponent::MinLocationRadius

Character's location offset from the transition can differ this much from the closest transition source.

uint8 UAdvKitTransitionComponent::TargetCustomPhysics

Custom movement mode the character will have after this transition

EAdvKitMovementMode UAdvKitTransitionComponent::TargetPhysics

Movement mode the character will have after this transition

TWeakObjectPtr<class AAdvKitZone> UAdvKitTransitionComponent::TargetZone

Target of the transition

FVector UAdvKitTransitionComponent::TransitionDirection

Character needs to go this direction

FString UAdvKitTransitionComponent::TransitionId

Identifier given by the build module responsible for creating this transitions, used to update

TSubclassOf<AAdvKitCharacter> UAdvKitTransitionComponent::UseableBy

Which kind of character can use the transition


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