diff --git a/src/content/docs/reference/FFlowActorReference.mdx b/src/content/docs/reference/FFlowActorReference.mdx deleted file mode 100644 index 56131dc..0000000 --- a/src/content/docs/reference/FFlowActorReference.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: FFlowActorReference -description: FFlowActorReference reference page ---- - -import Ref from '../../../components/Ref.astro'; -import LinkRef from '../../../components/LinkRef.astro'; - - - -### Description - -FlowActorReference is used to find actors in levels at runtime or in editor. -Finding an actor can be done in different ways using . diff --git a/src/content/docs/reference/FFlowPilotSettings.mdx b/src/content/docs/reference/FFlowPilotSettings.mdx deleted file mode 100644 index c7d0c03..0000000 --- a/src/content/docs/reference/FFlowPilotSettings.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: FFlowPilotSettings -description: FFlowPilotSettings reference page ---- - -import Ref from '../../../components/Ref.astro' - - - -### Description - -Developer Settings class that holds various properties that can be set in editor via the menu `Edit > Project Settings > FlowPilot` diff --git a/src/content/docs/reference/FPTagActorComponent.mdx b/src/content/docs/reference/FPTagActorComponent.mdx index ea0f349..bc95327 100644 --- a/src/content/docs/reference/FPTagActorComponent.mdx +++ b/src/content/docs/reference/FPTagActorComponent.mdx @@ -1,13 +1,16 @@ --- title: UFPTagActorComponent -description: Reference page for UFPTagActorComponent class +description: Reference page for UFPTagActorComponent --- ## Class Info - __Parent Class:__ `UActorComponent` - __FileName:__ `FPTagActorComponent.h` + ## Properties No properties in this class + ## Functions +No functions in this class diff --git a/src/content/docs/reference/FPTaskRunner.mdx b/src/content/docs/reference/FPTaskRunner.mdx index 44ebb24..e14d07b 100644 --- a/src/content/docs/reference/FPTaskRunner.mdx +++ b/src/content/docs/reference/FPTaskRunner.mdx @@ -1,13 +1,16 @@ --- title: UFPTaskRunner -description: Reference page for UFPTaskRunner class +description: Reference page for UFPTaskRunner --- ## Class Info - __Parent Class:__ `UFlowPilotParent` - __FileName:__ `FPTaskRunner.h` + ## Properties No properties in this class + ## Functions +No functions in this class diff --git a/src/content/docs/reference/FPTask_BlueprintBase.mdx b/src/content/docs/reference/FPTask_BlueprintBase.mdx index 7a63342..aeb4809 100644 --- a/src/content/docs/reference/FPTask_BlueprintBase.mdx +++ b/src/content/docs/reference/FPTask_BlueprintBase.mdx @@ -1,13 +1,15 @@ --- title: UFPTask_BlueprintBase -description: Reference page for UFPTask_BlueprintBase class +description: Reference page for UFPTask_BlueprintBase --- ## Class Info - __FileName:__ `FPTask_BlueprintBase.h` + ## Properties No properties in this class + ## Functions ### `ReceiveSetup` diff --git a/src/content/docs/reference/FPTask_Delay.mdx b/src/content/docs/reference/FPTask_Delay.mdx index e8e972c..108d369 100644 --- a/src/content/docs/reference/FPTask_Delay.mdx +++ b/src/content/docs/reference/FPTask_Delay.mdx @@ -1,11 +1,12 @@ --- title: UFPTask_Delay -description: Reference page for UFPTask_Delay class +description: Reference page for UFPTask_Delay --- ## Class Info - __Parent Class:__ `UFlowPilotTask` - __FileName:__ `FPTask_Delay.h` + ## Properties ```cpp @@ -14,5 +15,7 @@ UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(ClampMin=0.0f, ForceUnits= float RandomDeviation = 0.0f; ``` + ## Functions +No functions in this class diff --git a/src/content/docs/reference/FPTask_DestroyActor.mdx b/src/content/docs/reference/FPTask_DestroyActor.mdx index e968d38..16502a1 100644 --- a/src/content/docs/reference/FPTask_DestroyActor.mdx +++ b/src/content/docs/reference/FPTask_DestroyActor.mdx @@ -1,11 +1,12 @@ --- title: UFPTask_DestroyActor -description: Reference page for UFPTask_DestroyActor class +description: Reference page for UFPTask_DestroyActor --- ## Class Info - __Parent Class:__ `UFlowPilotTask` - __FileName:__ `FPTask_DestroyActor.h` + ## Properties ```cpp @@ -18,5 +19,7 @@ UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(ClampMin=0.0f, ForceUnits= float Delay = 0.0f; ``` + ## Functions +No functions in this class diff --git a/src/content/docs/reference/FPTask_FlowAsset.mdx b/src/content/docs/reference/FPTask_FlowAsset.mdx index c9bf32d..a3d9a8f 100644 --- a/src/content/docs/reference/FPTask_FlowAsset.mdx +++ b/src/content/docs/reference/FPTask_FlowAsset.mdx @@ -1,13 +1,16 @@ --- title: UFPTask_FlowAsset -description: Reference page for UFPTask_FlowAsset class +description: Reference page for UFPTask_FlowAsset --- ## Class Info - __Parent Class:__ `UFlowPilotTask` - __FileName:__ `FPTask_FlowAsset.h` + ## Properties No properties in this class + ## Functions +No functions in this class diff --git a/src/content/docs/reference/FPTask_FlowPilotControl.mdx b/src/content/docs/reference/FPTask_FlowPilotControl.mdx index 9d44e83..9e2b560 100644 --- a/src/content/docs/reference/FPTask_FlowPilotControl.mdx +++ b/src/content/docs/reference/FPTask_FlowPilotControl.mdx @@ -1,11 +1,12 @@ --- title: UFPTask_FlowPilotControl -description: Reference page for UFPTask_FlowPilotControl class +description: Reference page for UFPTask_FlowPilotControl --- ## Class Info - __Parent Class:__ `UFlowPilotTask` - __FileName:__ `FPTask_FlowPilotControl.h` + ## Properties ```cpp @@ -28,5 +29,7 @@ UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(EditCondition="ControlType EFlowControlSuccessCondition SuccessCondition = EFlowControlSuccessCondition::Instant; ``` + ## Functions +No functions in this class diff --git a/src/content/docs/reference/FPTask_LoadLevel.mdx b/src/content/docs/reference/FPTask_LoadLevel.mdx index 9d3e096..d446d24 100644 --- a/src/content/docs/reference/FPTask_LoadLevel.mdx +++ b/src/content/docs/reference/FPTask_LoadLevel.mdx @@ -1,13 +1,16 @@ --- title: UFPTask_LoadLevel -description: Reference page for UFPTask_LoadLevel class +description: Reference page for UFPTask_LoadLevel --- ## Class Info - __Parent Class:__ `UFlowPilotTask` - __FileName:__ `FPTask_LoadLevel.h` + ## Properties No properties in this class + ## Functions +No functions in this class diff --git a/src/content/docs/reference/FPTask_Loop.mdx b/src/content/docs/reference/FPTask_Loop.mdx index 4208b0b..8968d72 100644 --- a/src/content/docs/reference/FPTask_Loop.mdx +++ b/src/content/docs/reference/FPTask_Loop.mdx @@ -1,13 +1,16 @@ --- title: UFPTask_Loop -description: Reference page for UFPTask_Loop class +description: Reference page for UFPTask_Loop --- ## Class Info - __Parent Class:__ `UFlowPilotTask` - __FileName:__ `FPTask_Loop.h` + ## Properties No properties in this class + ## Functions +No functions in this class diff --git a/src/content/docs/reference/FPTask_Parallel.mdx b/src/content/docs/reference/FPTask_Parallel.mdx index 9bd9846..fed4d36 100644 --- a/src/content/docs/reference/FPTask_Parallel.mdx +++ b/src/content/docs/reference/FPTask_Parallel.mdx @@ -1,6 +1,6 @@ --- title: UFPTask_Parallel -description: Reference page for UFPTask_Parallel class +description: Reference page for UFPTask_Parallel --- import Ref from '../../../components/Ref.astro' import LinkRef from '../../../components/LinkRef.astro' @@ -10,7 +10,7 @@ import schema from '../../../assets/ufptask_parallel.png'; -### Description +## Description UFPTask_Parallel Schema @@ -26,6 +26,7 @@ There are various _Completion types_ for this task: ## Class Info - __Parent Class:__ `UFlowPilotParent` - __FileName:__ `FPTask_Parallel.h` + ## Properties ```cpp @@ -34,5 +35,7 @@ UPROPERTY(EditDefaultsOnly, Category="FlowPilot") EFlowParallelCompletionType DesiredCompletionType = EFlowParallelCompletionType::AllSucceed; ``` + ## Functions +No functions in this class diff --git a/src/content/docs/reference/FPTask_PlayAnimation.mdx b/src/content/docs/reference/FPTask_PlayAnimation.mdx index 3456a7b..f085b57 100644 --- a/src/content/docs/reference/FPTask_PlayAnimation.mdx +++ b/src/content/docs/reference/FPTask_PlayAnimation.mdx @@ -1,13 +1,16 @@ --- title: UFPTask_PlayAnimation -description: Reference page for UFPTask_PlayAnimation class +description: Reference page for UFPTask_PlayAnimation --- ## Class Info - __Parent Class:__ `UFlowPilotTask` - __FileName:__ `FPTask_PlayAnimation.h` + ## Properties No properties in this class + ## Functions +No functions in this class diff --git a/src/content/docs/reference/FPTask_PlaySound.mdx b/src/content/docs/reference/FPTask_PlaySound.mdx index e913e15..bed8284 100644 --- a/src/content/docs/reference/FPTask_PlaySound.mdx +++ b/src/content/docs/reference/FPTask_PlaySound.mdx @@ -1,11 +1,12 @@ --- title: UFPTask_PlaySound -description: Reference page for UFPTask_PlaySound class +description: Reference page for UFPTask_PlaySound --- ## Class Info - __Parent Class:__ `UFlowPilotTask` - __FileName:__ `FPTask_PlaySound.h` + ## Properties ```cpp @@ -14,5 +15,7 @@ UPROPERTY(EditAnywhere, Category = "FlowPilot") FFlowActorReference ActorReference; ``` + ## Functions +No functions in this class diff --git a/src/content/docs/reference/FPTask_PlaySound2D.mdx b/src/content/docs/reference/FPTask_PlaySound2D.mdx index 86a3d98..98f125c 100644 --- a/src/content/docs/reference/FPTask_PlaySound2D.mdx +++ b/src/content/docs/reference/FPTask_PlaySound2D.mdx @@ -1,13 +1,16 @@ --- title: UFPTask_PlaySound2D -description: Reference page for UFPTask_PlaySound2D class +description: Reference page for UFPTask_PlaySound2D --- ## Class Info - __Parent Class:__ `UFlowPilotTask` - __FileName:__ `FPTask_PlaySound2D.h` + ## Properties No properties in this class + ## Functions +No functions in this class diff --git a/src/content/docs/reference/FPTask_PossessPawn.mdx b/src/content/docs/reference/FPTask_PossessPawn.mdx index 6ac54a2..1096d06 100644 --- a/src/content/docs/reference/FPTask_PossessPawn.mdx +++ b/src/content/docs/reference/FPTask_PossessPawn.mdx @@ -1,11 +1,12 @@ --- title: UFPTask_PossessPawn -description: Reference page for UFPTask_PossessPawn class +description: Reference page for UFPTask_PossessPawn --- ## Class Info - __Parent Class:__ `UFlowPilotTask` - __FileName:__ `FPTask_PossessPawn.h` + ## Properties ```cpp @@ -22,5 +23,7 @@ UPROPERTY(EditAnywhere, Category="FlowPilot", meta=(EditCondition="!bPossessByPl TSubclassOf ControllerClass; ``` + ## Functions +No functions in this class diff --git a/src/content/docs/reference/FPTask_Selector.mdx b/src/content/docs/reference/FPTask_Selector.mdx index 02da159..9391579 100644 --- a/src/content/docs/reference/FPTask_Selector.mdx +++ b/src/content/docs/reference/FPTask_Selector.mdx @@ -1,6 +1,6 @@ --- title: UFPTask_Selector -description: Reference page for UFPTask_Selector class +description: Reference page for UFPTask_Selector --- import Ref from '../../../components/Ref.astro' import LinkRef from '../../../components/LinkRef.astro' @@ -10,7 +10,7 @@ import schema from '../../../assets/ufptask_selector.png'; -### Description +## Description UFPTask_Selector Schema @@ -26,8 +26,11 @@ If no task succeeded, then `UFPTask_Selector` will return failure. ## Class Info - __Parent Class:__ `UFPTaskRunner` - __FileName:__ `FPTask_Selector.h` + ## Properties No properties in this class + ## Functions +No functions in this class diff --git a/src/content/docs/reference/FPTask_Sequence.mdx b/src/content/docs/reference/FPTask_Sequence.mdx index c59a4be..c92c2ca 100644 --- a/src/content/docs/reference/FPTask_Sequence.mdx +++ b/src/content/docs/reference/FPTask_Sequence.mdx @@ -1,6 +1,6 @@ --- title: UFPTask_Sequence -description: Reference page for UFPTask_Sequence class +description: Reference page for UFPTask_Sequence --- import Ref from '../../../components/Ref.astro' import LinkRef from '../../../components/LinkRef.astro' @@ -10,7 +10,7 @@ import schema from '../../../assets/ufptask_sequence.png'; -### Description +## Description UFPTask_Sequence Schema @@ -21,13 +21,14 @@ The schema above explains how it should work. If one of the Tasks fail, `UFPTask_Sequence` will return failure. - - ## Class Info - __Parent Class:__ `UFPTaskRunner` - __FileName:__ `FPTask_Sequence.h` + ## Properties No properties in this class + ## Functions +No functions in this class diff --git a/src/content/docs/reference/FPTask_SpawnClass.mdx b/src/content/docs/reference/FPTask_SpawnClass.mdx index 187c924..9a0c745 100644 --- a/src/content/docs/reference/FPTask_SpawnClass.mdx +++ b/src/content/docs/reference/FPTask_SpawnClass.mdx @@ -1,11 +1,12 @@ --- title: UFPTask_SpawnClass -description: Reference page for UFPTask_SpawnClass class +description: Reference page for UFPTask_SpawnClass --- ## Class Info - __Parent Class:__ `UFlowPilotTask` - __FileName:__ `FPTask_SpawnClass.h` + ## Properties ```cpp @@ -34,5 +35,7 @@ UPROPERTY(EditAnywhere, Category = "FlowPilot") ESpawnActorCollisionHandlingMethod SpawnCollisionMethods = ESpawnActorCollisionHandlingMethod::AdjustIfPossibleButAlwaysSpawn; ``` + ## Functions +No functions in this class diff --git a/src/content/docs/reference/FPTask_TriggerDistance.mdx b/src/content/docs/reference/FPTask_TriggerDistance.mdx index 12e8bd1..a9e9d54 100644 --- a/src/content/docs/reference/FPTask_TriggerDistance.mdx +++ b/src/content/docs/reference/FPTask_TriggerDistance.mdx @@ -1,11 +1,12 @@ --- title: UFPTask_TriggerDistance -description: Reference page for UFPTask_TriggerDistance class +description: Reference page for UFPTask_TriggerDistance --- ## Class Info - __Parent Class:__ `UFlowPilotTask` - __FileName:__ `FPTask_TriggerDistance.h` + ## Properties ```cpp @@ -26,5 +27,7 @@ UPROPERTY(EditAnywhere, Category = "FlowPilot") FFlowActorReference SecondActorReference; ``` + ## Functions +No functions in this class diff --git a/src/content/docs/reference/FPTask_TriggerVolume.mdx b/src/content/docs/reference/FPTask_TriggerVolume.mdx index 92a5578..5585db1 100644 --- a/src/content/docs/reference/FPTask_TriggerVolume.mdx +++ b/src/content/docs/reference/FPTask_TriggerVolume.mdx @@ -1,14 +1,31 @@ --- title: UFPTask_TriggerVolume -description: Reference page for UFPTask_TriggerVolume class +description: Reference page for UFPTask_TriggerVolume --- ## Class Info - __Parent Class:__ `UFlowPilotTask` - __FileName:__ `FPTask_TriggerVolume.h` + ## Properties ```cpp +// Trigger to Listen to +UPROPERTY(EditAnywhere, Category = "FlowPilot") +ETriggerVolumeEvent TriggerEvent; + +// Volume Reference Actor +UPROPERTY(EditAnywhere, Category = "FlowPilot") +FFlowActorReference VolumeReference; + +// Actor References to Interact with Volume\ +// Will wait for All Actors this reference finds.\ +// Use unique actor/tag if you want only one resulting actor +UPROPERTY(EditAnywhere, Category = "FlowPilot") +FFlowActorReference ActorReferences; + ``` + ## Functions +No functions in this class diff --git a/src/content/docs/reference/FPTask_UnloadStreamedLevel.mdx b/src/content/docs/reference/FPTask_UnloadStreamedLevel.mdx index 9487e27..5203f63 100644 --- a/src/content/docs/reference/FPTask_UnloadStreamedLevel.mdx +++ b/src/content/docs/reference/FPTask_UnloadStreamedLevel.mdx @@ -1,11 +1,12 @@ --- title: UFPTask_UnloadStreamedLevel -description: Reference page for UFPTask_UnloadStreamedLevel class +description: Reference page for UFPTask_UnloadStreamedLevel --- ## Class Info - __Parent Class:__ `UFlowPilotTask` - __FileName:__ `FPTask_UnloadStreamedLevel.h` + ## Properties ```cpp @@ -18,5 +19,7 @@ UPROPERTY(EditAnywhere, Category = "FlowPilot") bool bBlockOnUnload = false; ``` + ## Functions +No functions in this class diff --git a/src/content/docs/reference/FlowPilot.mdx b/src/content/docs/reference/FlowPilot.mdx index a374e8d..c006626 100644 --- a/src/content/docs/reference/FlowPilot.mdx +++ b/src/content/docs/reference/FlowPilot.mdx @@ -1,20 +1,12 @@ --- title: UFlowPilot -description: Reference page for UFlowPilot class +description: Reference page for UFlowPilot --- -import Ref from '../../../components/Ref.astro' - - - -### Description - -`UFlowPilot` is the base data asset for FlowPilot. This is what you'll create, edit and iterate on to create your gameplay sequences. - - ## Class Info - __Parent Class:__ `UDataAsset` - __FileName:__ `FlowPilot.h` + ## Properties ```cpp @@ -27,6 +19,7 @@ UPROPERTY(meta=(DeprecatedProperty)) TArray> MainFlow_DEPRECATED; ``` + ## Functions ### `PostLoad` diff --git a/src/content/docs/reference/FlowPilotComponent.mdx b/src/content/docs/reference/FlowPilotComponent.mdx index c46d363..b73a014 100644 --- a/src/content/docs/reference/FlowPilotComponent.mdx +++ b/src/content/docs/reference/FlowPilotComponent.mdx @@ -1,6 +1,6 @@ --- title: UFlowPilotComponent -description: Reference page for UFlowPilotComponent class +description: Reference page for UFlowPilotComponent --- import Ref from '../../../components/Ref.astro' import LinkRef from '../../../components/LinkRef.astro' @@ -53,82 +53,9 @@ When a task returns a result, `UFlowPilotComponent` parses it and decides if we UFlowPilotComponent StartFlow -## API - -Set of exposed methods to Blueprint - -```cpp -// Sets FlowPilot data asset -UFUNCTION(BlueprintCallable, Category="FlowPilot") -bool SetFlowPilotAsset(UFlowPilot* InFlowPilotAsset); - -// Start Current FlowData -UFUNCTION(BlueprintCallable, Category="FlowPilot") -void StartFlow(); - -// Stops FlowPilot -UFUNCTION(BlueprintCallable, Category="FlowPilot") -void StopFlow(bool bIsSuccessful, EFPStopType StopType = EFPStopType::Normal); - -// Pauses FlowPilot. Execution must have been started first -UFUNCTION(BlueprintCallable, Category="FlowPilot") -void PauseFlow(); - -// UnPauses FlowPilot, if Paused. -UFUNCTION(BlueprintCallable, Category="FlowPilot") -void UnPauseFlow(); - -// Returns true if FlowPilot is Paused -UFUNCTION(BlueprintCallable, Category="FlowPilot") -bool IsPaused() const { return FlowState == EFlowState::Paused; } - -// Returns true is setup is valid -UFUNCTION(BlueprintCallable, Category="FlowPilot") -bool IsDataSetup() const { return FlowPilotAsset != nullptr; } - -// Returns FlowPilot state -UFUNCTION(BlueprintCallable, Category="FlowPilot") -EFlowState GetRunState() const { return FlowState; } - -// Returns true if FlowPilot is in Progress -UFUNCTION(BlueprintCallable, Category="FlowPilot") -bool IsRunning() const { return FlowState == EFlowState::InProgress; } - -// Finds single actor reference -UFUNCTION(BlueprintCallable, Category="FlowPilot") -AActor* FindSingleActor(const FFlowActorReference& ActorReference); - -// Finds all actors with reference (usually external tags on multiple actors) -UFUNCTION(BlueprintCallable, Category="FlowPilot") -TArray FindActors(const FFlowActorReference& ActorReference); - -// Finds and Caches Unique Actor via GameplayTag -UFUNCTION(BlueprintCallable, Category="FlowPilot") -AActor* FindSingleActorByTag(const FGameplayTag& Tag); - -// Find All Actors by Tag -UFUNCTION(BlueprintCallable, Category="FlowPilot") -TArray FindActorsByTag(const FGameplayTag& Tag); - -// Tracks Lifetime of Actor by FlowPilot. Will destroy when FlowPilot completes. -UFUNCTION(BlueprintCallable, Category="FlowPilot") -void AutoDespawnActorOnFlowStop(AActor* Actor); - -// Will prefect Actor Reference if Referenced via External Tag. -UFUNCTION(BlueprintCallable, Category="FlowPilot") -void PrefetchActorReference(const FFlowActorReference& ActorReference); - -UFUNCTION(BlueprintCallable, Category="FlowPilot") -FString GetFlowPilotName() const; -``` - - - - - - ## Class Info - __FileName:__ `FlowPilotComponent.h` + ## Properties ```cpp @@ -157,6 +84,7 @@ float RetryDelay = 0.0f; TArray> FlowPilotLifetimeActors; ``` + ## Functions ### `SetFlowPilotAsset` diff --git a/src/content/docs/reference/FlowPilotParent.mdx b/src/content/docs/reference/FlowPilotParent.mdx index ef5812e..9b2ca27 100644 --- a/src/content/docs/reference/FlowPilotParent.mdx +++ b/src/content/docs/reference/FlowPilotParent.mdx @@ -1,20 +1,16 @@ --- title: UFlowPilotParent -description: Reference page for UFlowPilotParent class +description: Reference page for UFlowPilotParent --- -import Ref from '../../../components/Ref.astro' - - - -### Description - - ## Class Info - __Parent Class:__ `UFlowPilotTask` - __FileName:__ `FlowPilotParent.h` + ## Properties No properties in this class + ## Functions +No functions in this class diff --git a/src/content/docs/reference/FlowPilotSettings.mdx b/src/content/docs/reference/FlowPilotSettings.mdx index ee14778..48a8c88 100644 --- a/src/content/docs/reference/FlowPilotSettings.mdx +++ b/src/content/docs/reference/FlowPilotSettings.mdx @@ -1,11 +1,12 @@ --- title: UFlowPilotSettings -description: Reference page for UFlowPilotSettings class +description: Reference page for UFlowPilotSettings --- ## Class Info - __Parent Class:__ `UDeveloperSettings` - __FileName:__ `FlowPilotSettings.h` + ## Properties ```cpp @@ -78,5 +79,7 @@ UPROPERTY(EditAnywhere, Category="Debug|Display Preferences") FLinearColor InvalidColor = FLinearColor(0.25f, 0.02f, 0.02f, 0.45f); ``` + ## Functions +No functions in this class diff --git a/src/content/docs/reference/FlowPilotSubsystem.mdx b/src/content/docs/reference/FlowPilotSubsystem.mdx index f2fa790..5a74b5b 100644 --- a/src/content/docs/reference/FlowPilotSubsystem.mdx +++ b/src/content/docs/reference/FlowPilotSubsystem.mdx @@ -1,14 +1,16 @@ --- title: UFlowPilotSubsystem -description: Reference page for UFlowPilotSubsystem class +description: Reference page for UFlowPilotSubsystem --- ## Class Info - __Parent Class:__ `UWorldSubsystem` - __FileName:__ `FlowPilotSubsystem.h` + ## Properties No properties in this class + ## Functions ### `Initialize` diff --git a/src/content/docs/reference/FlowPilotTask.mdx b/src/content/docs/reference/FlowPilotTask.mdx index 99daf18..9fc522c 100644 --- a/src/content/docs/reference/FlowPilotTask.mdx +++ b/src/content/docs/reference/FlowPilotTask.mdx @@ -1,6 +1,6 @@ --- title: UFlowPilotTask -description: Reference page for UFlowPilotTask class +description: Reference page for UFlowPilotTask --- import Ref from '../../../components/Ref.astro' @@ -8,9 +8,7 @@ import Ref from '../../../components/Ref.astro' import { Image } from 'astro:assets'; import schema from '../../../assets/uflowpilottask_executionflow.png'; - - -### Description +## Description UFlowPilotTask Schema @@ -26,36 +24,10 @@ Tasks can also be cancelled, and end directly. Each class that can be implemented need to override a couple of virtual methods exposed by this task, either in Cpp or implementing the Blueprint versions when creating a `UFlowPilotTask` via blueprint. -### Interface - -```cpp -// UFlowPilotTask -// Setups Tasks. Called once per FlowPilotExecution, even after restarts. -virtual void Setup(FFlowContext* InContext); -// Called when starting this Task. Returns true on success -virtual bool Enter(); -// Called on Tick. Will success automatically if not implemented by Child classes -virtual EFPTaskResult Tick(float DeltaTime); -// Called when Tick returns Succeeds -virtual void Exit(); -// Resets all Tasks into their Setup States -virtual void Reset(); - -#if WITH_EDITOR -// Returns true if valid. Child Tasks should implement their Validations -virtual bool IsTaskDataValid(FDataValidationContext& InContext) { return true; } -#endif - -#if !UE_BUILD_SHIPPING && !UE_BUILD_TEST -// Gathers information to display to debug view about Task. -virtual void GetRuntimeDescription(TArray& OutLines) const {}; -#endif -//~UFlowPilotTask -``` - ## Class Info - __Parent Class:__ `UObject` - __FileName:__ `FlowPilotTask.h` + ## Properties ```cpp @@ -64,6 +36,7 @@ UPROPERTY(EditDefaultsOnly, Category = "Task Options") uint8 bEnabled: 1; ``` + ## Functions ### `Setup`