ENiagaraParameterScope

Windows
MacOS
Linux

References

Module

Niagara

Header

/Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraTypes.h

Include

#include "NiagaraTypes.h"

Syntax

enum ENiagaraParameterScope
{
    Input,
    User,
    Engine,
    Owner,
    System,
    Emitter,
    Particles,
    ScriptPersistent,
    ScriptTransient,
    Local,
    Custom,
    DISPLAY_ONLY_StaticSwitch,
    Output,
    None,
    Num,
}

Values

Name

Description

Input

Parameter that is an input argument into this graph.

User

Parameter that is exposed to the owning component for editing and are read-only when used in the graph

Engine

Parameter provided by the engine.

Owner

Parameter provided by the engine focused on the owning component.

System

Parameter is an attribute of the owning system payload.

Emitter

Parameter is an attribute of the owning emitter payload.

Particles

Parameter is an attribute of the owning particle payload.

ScriptPersistent

Parameter is initialized in the appropriate spawn stage for the stack.

ScriptTransient

Parameter is initialized at the start of this stage and can be shared amongst other modules within this stack stage, but is not persistent across runs or from stack stage to stack stage.

Local

Parameter is initialized at the start of this script and is only used within the context of this script.

Custom

DISPLAY_ONLY_StaticSwitch

Output

Parameter is output to the owning stack stage from this script, but is only meaningful if bound elsewhere in the stage.

None

Insert new scopes before

Num

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