Skip to content

FSMTextGraphProperty

Module: SMExtendedRuntime

#include <SMTextGraphProperty.h>

Inherits from FSMGraphProperty_Base, FSMGraphProperty_Base_Runtime

Description

struct FSMTextGraphProperty;

For Logic Driver node classes only.

The state machine graph node which owns the class will display this property as an editable text box directly on the node and create a blueprint graph to parse the text.

Public Functions

Name
FSMTextGraphProperty()
virtual uint8 * GetResult() const override
virtual void SetResult(uint8 * Value) override
virtual FName GetResultPropertyName() const override
virtual bool ShouldAutoAssignVariable() const override
virtual bool ShouldCompileReadOnlyVariables() const override
virtual void GetVariableDetailsCustomization(FVariableDetailsCustomizationConfiguration & OutCustomizationConfiguration) const override
virtual const FSMNodeWidgetInfo * GetWidgetInfo() const override
virtual bool IsEditorThreadSafe() const override
virtual int32 GetVerticalDisplayOrder() const override
virtual bool ShouldDefaultToEditMode() const override
virtual bool AllowToggleGraphEdit() const override

Public Attributes

Name
FText Result
FSMTextSerializer TextSerializer
FSMTextNodeWidgetInfo WidgetInfo
FSMTextNodeRichTextInfo RichTextInfo

Additional inherited members

Public Classes inherited from FSMGraphProperty_Base

Name
struct FVariableDetailsCustomizationConfiguration

Public Functions inherited from FSMGraphProperty_Base

Name
FSMGraphProperty_Base()
virtual const FGuid & SetGuid(const FGuid & NewGuid) override
const FGuid & SetGuid(const FGuid & NewGuid, int32 Index, bool bCountTemplate =true)
const FGuid & GenerateNewGuid()
const FGuid & GenerateNewGuidIfNotValid()
void InvalidateGuid()
const FGuid & SetTemplateGuid(const FGuid & NewGuid, bool bRefreshGuid =false)
const FGuid & GetTemplateGuid() const
const FGuid & GetUnmodifiedGuid() const
virtual bool ShouldGenerateGuidFromVariable() const
virtual bool IsVariableReadOnly() const
virtual bool IsVariableHidden() const
virtual UClass * GetGraphClass(UObject * Outer) const
virtual UClass * GetGraphSchemaClass(UObject * Outer) const
virtual const FString & GetGraphModuleName() const
virtual UPackage * GetEditorModule() const
virtual const FString & GetPropertyDisplayName() const
FText GetDisplayName() const

Public Attributes inherited from FSMGraphProperty_Base

Name
FName VariableName
FEdGraphPinType VariableType
FMemberReference MemberReference
bool bIsInArray
bool bReadOnly
bool bHidden
FText RealDisplayName
int32 ArrayIndex

Protected Attributes inherited from FSMGraphProperty_Base

Name
FName GraphClassName
FName GraphSchemaClassName
FString GraphModuleClassName
TObjectPtr< UClass > CachedGraphClass
TObjectPtr< UClass > CachedSchemaClass
FGuid GuidUnmodified
FGuid TemplateGuid
int32 GuidIndex

Public Functions inherited from FSMGraphProperty_Base_Runtime

Name
FSMGraphProperty_Base_Runtime()
virtual ~FSMGraphProperty_Base_Runtime() =default
virtual void Initialize(FSMNode_Base * InOwningNode)
virtual void Execute(void * Params =nullptr)
virtual const FGuid & SetGuid(const FGuid & NewGuid)
const FGuid & GetGuid() const
virtual const FGuid & SetOwnerGuid(const FGuid & NewGuid)
const FGuid & GetOwnerGuid() const
void SetIsDefaultValueOnly(bool bNewValue)
bool GetIsDefaultValueOnly() const

Public Attributes inherited from FSMGraphProperty_Base_Runtime

Name
TArray< FSMExposedFunctionHandler > * GraphEvaluator
FSMGraphProperty_Base_Runtime * LinkedProperty

Protected Attributes inherited from FSMGraphProperty_Base_Runtime

Name
FGuid Guid
FGuid OwnerGuid
uint8 bIsDefaultValueOnly
FSMNode_Base * OwningNode

Public Functions Documentation

function FSMTextGraphProperty

FSMTextGraphProperty()

function GetResult

inline virtual uint8 * GetResult() const override

Reimplements: FSMGraphProperty_Base_Runtime::GetResult


function SetResult

virtual void SetResult(
    uint8 * Value
) override

Reimplements: FSMGraphProperty_Base_Runtime::SetResult


function GetResultPropertyName

inline virtual FName GetResultPropertyName() const override

Get the property name of the result field.

Reimplements: FSMGraphProperty_Base_Runtime::GetResultPropertyName


function ShouldAutoAssignVariable

inline virtual bool ShouldAutoAssignVariable() const override

Used if this class should automatically assign itself to exposed variable properties.

Reimplements: FSMGraphProperty_Base::ShouldAutoAssignVariable


function ShouldCompileReadOnlyVariables

inline virtual bool ShouldCompileReadOnlyVariables() const override

If a read only graph should be compiled into the blueprint. If false then only the default value is stored.

Reimplements: FSMGraphProperty_Base::ShouldCompileReadOnlyVariables


function GetVariableDetailsCustomization

inline virtual void GetVariableDetailsCustomization(
    FVariableDetailsCustomizationConfiguration & OutCustomizationConfiguration
) const override

Called during variable customization when a variable in a node blueprint is selected.

Reimplements: FSMGraphProperty_Base::GetVariableDetailsCustomization


function GetWidgetInfo

inline virtual const FSMNodeWidgetInfo * GetWidgetInfo() const override

Return the widget info for this property.

Reimplements: FSMGraphProperty_Base::GetWidgetInfo


function IsEditorThreadSafe

inline virtual bool IsEditorThreadSafe() const override

If this property is considered thread safe in the editor. Nodes check this during compile and will update the overall editor thread safety of the owning node.

Reimplements: FSMGraphProperty_Base::IsEditorThreadSafe


function GetVerticalDisplayOrder

inline virtual int32 GetVerticalDisplayOrder() const override

The desired vertical location on the graph node for this widget to be displayed.

Deprecated:

Use DisplayOrder metadata for native properties or adjust the blueprint variable order in blueprints.

Reimplements: FSMGraphProperty_Base::GetVerticalDisplayOrder


function ShouldDefaultToEditMode

inline virtual bool ShouldDefaultToEditMode() const override

Should property default to view or edit mode.

Reimplements: FSMGraphProperty_Base::ShouldDefaultToEditMode


function AllowToggleGraphEdit

inline virtual bool AllowToggleGraphEdit() const override

Should property be able to toggle between edit and view modes.

Reimplements: FSMGraphProperty_Base::AllowToggleGraphEdit


Public Attributes Documentation

variable Result

FText Result;

variable TextSerializer

FSMTextSerializer TextSerializer;

variable WidgetInfo

FSMTextNodeWidgetInfo WidgetInfo;

Configure the widget display properties. Only valid in the editor.


variable RichTextInfo

FSMTextNodeRichTextInfo RichTextInfo;

Configure rich text info. Applying a style may override any style defined under WidgetInfo. Only valid in the editor.