UStoryComponent Class Reference

A component responsible for managing the story progression in story actors. More...

#include <StoryComponent.h>

Inheritance diagram for UStoryComponent:

Public Member Functions
virtual void	BeginPlay () override
void	ExecuteScript ()
	UFUNCTION(BlueprintCallable, Category = "Story|Script")

Public Attributes
FText	ActiveStep
	UPROPERTY(BlueprintReadWrite)
TArray< FText >	ActiveSteps
	UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Story|Setup")
FText	ActiveSubStep
	UPROPERTY(BlueprintReadWrite)
TArray< FText >	ActiveSubSteps
	UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Story|Setup")
UGameManager *	GameManager
	UPROPERTY(BlueprintReadOnly, Category = "Story|Setup")
bool	ObjectActive { true }
	UPROPERTY(BlueprintReadWrite)
UStoryManager *	StoryManager
	UPROPERTY(BlueprintReadWrite)

Private Member Functions
	GENERATED_BODY ()
void	NewStep (FStoryStep NewStep, bool IsForward)
	Called when a new step is reached in the story.
void	NewSubStep (FStoryStep NewSubStep)
	Called when a new substep is reached in the story.
void	StoryLoaded ()
	Called when the story is loaded.

Detailed Description

A component responsible for managing the story progression in story actors.

UCLASS(ClassGroup=(Story), meta=(BlueprintSpawnableComponent))

Definition at line 17 of file StoryComponent.h.

Member Function Documentation

BeginPlay()

void UStoryComponent::BeginPlay ( )

overridevirtual

Definition at line 9 of file StoryComponent.cpp.

Here is the call graph for this function:

ExecuteScript()

void UStoryComponent::ExecuteScript ( )

BlueprintCallable

UFUNCTION(BlueprintCallable, Category = "Story|Script")

Execute story script that is specified for this active step

Definition at line 47 of file StoryComponent.cpp.

Here is the caller graph for this function:

GENERATED_BODY()

UStoryComponent::GENERATED_BODY ( )

private

NewStep()

void UStoryComponent::NewStep ( FStoryStep NewStep, bool IsForward )

private

Called when a new step is reached in the story.

Parameters

NewStep	The new step that was reached.
IsForward	Whether the story is progressing forward or backward.

UFUNCTION()

Definition at line 67 of file StoryComponent.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

NewSubStep()

void UStoryComponent::NewSubStep ( FStoryStep NewSubStep )

private

Called when a new substep is reached in the story.

Parameters

NewSubStep

The new substep that was reached.

UFUNCTION()

Definition at line 111 of file StoryComponent.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

StoryLoaded()

void UStoryComponent::StoryLoaded ( )

private

Called when the story is loaded.

UFUNCTION()

Definition at line 155 of file StoryComponent.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

ActiveStep

FText UStoryComponent::ActiveStep

BlueprintReadWrite

UPROPERTY(BlueprintReadWrite)

The currently active step in the story.

Definition at line 66 of file StoryComponent.h.

ActiveSteps

TArray<FText> UStoryComponent::ActiveSteps

BlueprintReadWriteEditAnywhere

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Story|Setup")

The active steps for actor in the story.

Definition at line 35 of file StoryComponent.h.

ActiveSubStep

FText UStoryComponent::ActiveSubStep

BlueprintReadWrite

UPROPERTY(BlueprintReadWrite)

The currently active substep in the story.

Definition at line 72 of file StoryComponent.h.

ActiveSubSteps

TArray<FText> UStoryComponent::ActiveSubSteps

BlueprintReadWriteEditAnywhere

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Story|Setup")

The active substeps for actor in the story.

Definition at line 42 of file StoryComponent.h.

GameManager

UGameManager* UStoryComponent::GameManager

BlueprintReadOnly

UPROPERTY(BlueprintReadOnly, Category = "Story|Setup")

Reference to the game manager.

Definition at line 60 of file StoryComponent.h.

ObjectActive

bool UStoryComponent::ObjectActive { true }

BlueprintReadWrite

UPROPERTY(BlueprintReadWrite)

Flag indicating whether the actor is active on current step.

Definition at line 48 of file StoryComponent.h.

StoryManager

UStoryManager* UStoryComponent::StoryManager

BlueprintReadWrite

UPROPERTY(BlueprintReadWrite)

Reference to the story manager.

Definition at line 54 of file StoryComponent.h.

---

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

• PixoCore/Source/PixoCore/Public/Story/StoryComponent.h
• PixoCore/Source/PixoCore/Private/Story/StoryComponent.cpp