Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > NiagaraEditor > ViewModels > Stack > UNiagaraStackFunctionInput

Light Theme

Dark Theme

UNiagaraStackFunctionInput

Represents a single module input in the module stack view model.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraStackEntry

UNiagaraStackItemContent

UNiagaraStackFunctionInput

References

Module	NiagaraEditor
Header	/Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/ViewModels/Stack/NiagaraStackFunctionInput.h
Include	#include "ViewModels/Stack/NiagaraStackFunctionInput.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class UNiagaraStackFunctionInput : public UNiagaraStackItemContent

Remarks

Represents a single module input in the module stack view model.

Variables

		Name	Description
	bool	bIsVisible	If false then the stack parameter is not visible

Constructors

	Name	Description
	UNiagaraStackFunctionInput()

Functions

	Name	Description
bool	CanDeleteInput()	Returns whether or not this input can be deleted.
bool	CanReset()	Returns whether or not the value or handle of this input has been overridden and can be reset.
bool	CanResetToBase()	Whether or not this input can be reset to a base value.
void	DeleteInput()	Deletes this input
bool	EmitterHasBase()	Whether or not this input has a base value. This is true for emitter instances in systems.
void	GetAvailableDynamicInputs ( TArray< UNiagaraScript* >& Av..., bool bIncludeNonLibraryInputs )	Gets the dynamic inputs available for this input.
void	GetAvailableParameterHandles ( TArray< FNiagaraParameterHandle >&... )	Gets the current set of available parameter handles which can be assigned to this input.
FText	GetCustomExpressionText()	Gets the expression providing the value for this input, if one is available.
UNiagaraData...	GetDataValueObject()	Gets the current data object value of this input is there is one.
UNiagaraNode...	GetDefaultFunctionNode()	Gets the function node form the script graph if the current value mode is DefaultFunction.
UNiagaraNode...	GetDynamicInputNode()	Gets the dynamic input node providing the value for this input, if one is available.
bool	GetEditConditionEnabled()	Gets the enabled value of the edit condition input associated with this input.
bool	GetHasEditCondition()	Gets whether or not this input has an associated edit condition input.
bool	GetHasVisibleCondition()	Gets whether or not this input has an associated visible condition input.
UNiagaraScri...	GetInputFunctionCallInitialScript()	Gets the script that the function call node was referencing when this input was initialized.
const UNiaga...	GetInputFunctionCallNode()	Gets the function call node which owns this input.
const FNiaga...	GetInputParameterHandle()	Gets the parameter handle which defined this input in the module.
const TArray...	GetInputParameterHandlePath()	Gets the path of parameter handles from the owning module to the function call which owns this input.
const FNiaga...	GetInputType()	Gets the type of this input.
bool	GetIsDynamicInputScriptReassignmentPending()	Gets whether or not a dynamic input script reassignment is pending.
bool	GetIsInlineEditConditionToggle()	Gets whether or not this input is used as an edit condition for another input and should be hidden.
const FNiaga...	GetLinkedValueHandle()	Gets the handle to the linked value for this input if there is one.
TSharedPtr< ...	GetLocalValueStruct()	Gets the current struct value of this input is there is one.
void	GetNamespacesForNewReadParameters ( TArray< FName >& OutNamespacesForN... )	Gets the namespaces which new parameters for this input can be read from.
void	GetNamespacesForNewWriteParameters ( TArray< FName >& OutNamespacesForN... )	Gets the namespaces which new parameters for this input can write to.
bool	GetShouldPassFilterForVisibleCondition()	Gets whether or not this input is filtered from search results and appearing in stack due to visibility metadata
bool	GetShowEditConditionInline()	Gets whether or not to show a control inline for the edit condition input associated with this input.
EValueMode	GetValueMode()	Gets the current value mode
FText	GetValueToolTip()	Gets the tooltip that should be shown for the value of this input.
bool	GetVisibleConditionEnabled()	Gets the enabled value of the visible condition input associated with this input.
void	Initialize ( FRequiredEntryData InRequiredEntryD..., UNiagaraNodeFunctionCall& InModule..., UNiagaraNodeFunctionCall& InInputF..., FName InInputParameterHandle, FNiagaraTypeDefinition InInputType, EStackParameterBehavior InParameter..., FString InOwnerStackItemEditorDataK... )	Sets the input data for this entry.
bool	IsEditable()	Determine if this field is editable
bool	IsEnabled()	Is this pin editable or should it show as disabled?
bool	IsScratchDynamicInput()
bool	IsStaticParameter()	If true the parameter can only be set to local constant values
void	NotifyBeginLocalValueChange()	Called to notify the input that an ongoing change to it's value has begun.
void	NotifyEndLocalValueChange()	Called to notify the input that an ongoing change to it's value has ended.
FOnValueChan...	OnValueChanged()	Gets a multicast delegate which is called whenever the value on this input changes.
void	ReassignDynamicInputScript ( UNiagaraScript* DynamicInputSc... )	Reassigns the function script for the current dynamic input without resetting the sub-inputs.
bool	RemoveRapidIterationParametersForAffectedScripts()
void	Reset()	Resets the value and handle of this input to the value and handle defined in the module.
void	ResetToBase()	Resets this input to its base value.
FString	ResolveDisplayNameArgument ( const FString& InArg )
void	SetCustomExpression ( const FString& InCustomExpression )	Sets the dynamic custom expression script for this input.
void	SetDynamicInput ( UNiagaraScript* DynamicInput, FString SuggestedName )	Sets the dynamic input script for this input.
void	SetEditConditionEnabled ( bool bIsEnabled )	Sets the enabled value of the edit condition input associated with this input.
void	SetIsDynamicInputScriptReassignmentPending ( bool bIsPending )	Gets whether or not a dynamic input script reassignment should be be pending.
void	SetLinkedValueHandle ( const FNiagaraParameterHandle& InP... )	Sets the value of this input to a linked parameter handle.
void	SetLocalValue ( TSharedRef< FStructOnScope > InLoca... )	Sets this input's local value.
void	SetScratch()	Create a new scratch pad dynamic inputs and set this input to use it.
void	SetValueFromClipboardFunctionInput ( const UNiagaraClipboardFunctionInpu... )
const UNiaga...	ToClipboardFunctionInput ( UObject* InOuter )
bool	UpdateRapidIterationParametersForAffectedScripts ( const uint8* Data )

Overridden from UNiagaraStackEntry

	Name	Description
void	Copy ( UNiagaraClipboardContent* Clip... )
void	CopyForCut ( UNiagaraClipboardContent* Clip... )
void	FinalizeInternal()
FText	GetCutTransactionText()
FText	GetDisplayName()
UObject *...	GetExternalAsset()
bool	GetIsEnabled()
FText	GetPasteTransactionText ( const UNiagaraClipboardContent*... )
void	GetSearchItems ( TArray< FStackSearchItem >& Search... )
FText	GetTooltipText()
void	OnRenamed ( FText NewName )	Renames this input to the name specified.
void	Paste ( const UNiagaraClipboardContent*..., FText& OutPasteWarning )
void	RefreshChildrenInternal ( const TArray< UNiagaraStackEntry&#..., TArray< UNiagaraStackEntry* > ..., TArray< FStackIssue >& NewIssues )
void	RemoveForCut()
bool	SupportsCopy()
bool	SupportsCut()
bool	SupportsPaste()
bool	SupportsRename()	Returns whether or not this input can be renamed.
bool	TestCanCopyWithMessage ( FText& OutMessage )
bool	TestCanCutWithMessage ( FText& OutMessage )
bool	TestCanPasteWithMessage ( const UNiagaraClipboardContent*..., FText& OutMessage )

Enums

	Name	Description
	EValueMode	Defines different modes which are used to provide the value for this function input.

Typedefs

Name	Description
FOnValueChanged

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss