unreal.NiagaraScript

class unreal.NiagaraScript(outer: Object | None = None, name: Name | str = 'None')

Bases: NiagaraScriptBase

Scripts are function graphs that define the runtime execution for a Niagara system (similar to a Blueprint).

There are three types of scripts: 1) Module: can be added as a standalone part to the emitter stack and encapsulates a single behavior, for example “Add Velocity” 2) Dynamic input: has a single output value and can be added to any input in the stack to compute such a value, for example “Random Vector” 3) Function: usually reserved for helper functions; can only be called from within modules or dynamic inputs

C++ Source:

• Plugin: Niagara

• Module: Niagara

• File: NiagaraScript.h

Editor Properties: (see get_editor_property/set_editor_property)

• category (Text): [Read-Write] Use property in struct returned from GetScriptData() instead deprecated: Property ‘Category’ is deprecated.

• collapsed_view_format (Text): [Read-Write] Deprecated, use LibraryVisibility instead. deprecated: Property ‘CollapsedViewFormat’ is deprecated.

• conversion_utility (type(Class)): [Read-Write] Use property in struct returned from GetScriptData() instead deprecated: Property ‘ConversionUtility’ is deprecated.

• deprecated (bool): [Read-Write] Use property in struct returned from GetScriptData() instead deprecated: Property ‘bDeprecated’ is deprecated.

• deprecation_message (Text): [Read-Write] Use property in struct returned from GetScriptData() instead deprecated: Property ‘DeprecationMessage’ is deprecated.

• deprecation_recommendation (NiagaraScript): [Read-Write] Use property in struct returned from GetScriptData() instead deprecated: Property ‘DeprecationRecommendation’ is deprecated.

• description (Text): [Read-Write] Use property in struct returned from GetScriptData() instead deprecated: Property ‘Description’ is deprecated.

• experimental (bool): [Read-Write] Use property in struct returned from GetScriptData() instead deprecated: Property ‘bExperimental’ is deprecated.

• experimental_message (Text): [Read-Write] Use property in struct returned from GetScriptData() instead deprecated: Property ‘ExperimentalMessage’ is deprecated.

• expose_to_library (bool): [Read-Write] Deprecated, use LibraryVisibility instead. deprecated: Property ‘bExposeToLibrary’ is deprecated.

• keywords (Text): [Read-Write] Use property in struct returned from GetScriptData() instead deprecated: Property ‘Keywords’ is deprecated.

• library_visibility (NiagaraScriptLibraryVisibility): [Read-Write] Use property in struct returned from GetScriptData() instead deprecated: Property ‘LibraryVisibility’ is deprecated.

• module_usage_bitmask (int32): [Read-Write] Use property in struct returned from GetScriptData() instead deprecated: Property ‘ModuleUsageBitmask’ is deprecated.

• note_message (Text): [Read-Write] Use property in struct returned from GetScriptData() instead deprecated: Property ‘NoteMessage’ is deprecated.

• numeric_output_type_selection_mode (NiagaraNumericOutputTypeSelectionMode): [Read-Write] Use property in struct returned from GetScriptData() instead deprecated: Property ‘NumericOutputTypeSelectionMode’ is deprecated.

• preview_movie_path (SoftObjectPath): [Read-Write]

• provided_dependencies (Array[Name]): [Read-Write] Use property in struct returned from GetScriptData() instead deprecated: Property ‘ProvidedDependencies’ is deprecated.

• required_dependencies (Array[NiagaraModuleDependency]): [Read-Write] Use property in struct returned from GetScriptData() instead deprecated: Property ‘RequiredDependencies’ is deprecated.

• script_meta_data (Map[Name, str]): [Read-Write] Deprecated, use LibraryVisibility instead. deprecated: Property ‘ScriptMetaData’ is deprecated.

• source (NiagaraScriptSourceBase): [Read-Write] ‘Source’ data/graphs for this script deprecated: Property ‘Source’ is deprecated.

• validation_rules (Array[NiagaraValidationRule]): [Read-Write] A set of rules to apply when this script is used in the stack. To create your own rules, write a custom class that extends UNiagaraValidationRule.

property category: Text

[Read-Write] Use property in struct returned from GetScriptData() instead deprecated: Property ‘Category’ is deprecated.

Type:

(Text)

property collapsed_view_format: Text

[Read-Write] Deprecated, use LibraryVisibility instead. deprecated: Property ‘CollapsedViewFormat’ is deprecated.

Type:

(Text)

property conversion_utility: Class

[Read-Write] Use property in struct returned from GetScriptData() instead deprecated: Property ‘ConversionUtility’ is deprecated.

Type:

(type(Class))

property deprecated: bool

[Read-Write] Use property in struct returned from GetScriptData() instead deprecated: Property ‘bDeprecated’ is deprecated.

Type:

(bool)

property deprecation_message: Text

[Read-Write] Use property in struct returned from GetScriptData() instead deprecated: Property ‘DeprecationMessage’ is deprecated.

Type:

(Text)

property deprecation_recommendation: NiagaraScript

[Read-Write] Use property in struct returned from GetScriptData() instead deprecated: Property ‘DeprecationRecommendation’ is deprecated.

Type:

(NiagaraScript)

property description: Text

[Read-Write] Use property in struct returned from GetScriptData() instead deprecated: Property ‘Description’ is deprecated.

Type:

(Text)

property experimental: bool

[Read-Write] Use property in struct returned from GetScriptData() instead deprecated: Property ‘bExperimental’ is deprecated.

Type:

(bool)

property experimental_message: Text

[Read-Write] Use property in struct returned from GetScriptData() instead deprecated: Property ‘ExperimentalMessage’ is deprecated.

Type:

(Text)

property expose_to_library: bool

[Read-Write] Deprecated, use LibraryVisibility instead. deprecated: Property ‘bExposeToLibrary’ is deprecated.

Type:

(bool)

property keywords: Text

[Read-Write] Use property in struct returned from GetScriptData() instead deprecated: Property ‘Keywords’ is deprecated.

Type:

(Text)

property library_visibility: NiagaraScriptLibraryVisibility

[Read-Write] Use property in struct returned from GetScriptData() instead deprecated: Property ‘LibraryVisibility’ is deprecated.

Type:

(NiagaraScriptLibraryVisibility)

property module_usage_bitmask: int

[Read-Write] Use property in struct returned from GetScriptData() instead deprecated: Property ‘ModuleUsageBitmask’ is deprecated.

Type:

(int32)

property note_message: Text

[Read-Write] Use property in struct returned from GetScriptData() instead deprecated: Property ‘NoteMessage’ is deprecated.

Type:

(Text)

property numeric_output_type_selection_mode: NiagaraNumericOutputTypeSelectionMode

[Read-Write] Use property in struct returned from GetScriptData() instead deprecated: Property ‘NumericOutputTypeSelectionMode’ is deprecated.

Type:

(NiagaraNumericOutputTypeSelectionMode)

property provided_dependencies: None

[Read-Write] Use property in struct returned from GetScriptData() instead deprecated: Property ‘ProvidedDependencies’ is deprecated.

Type:

(Array[Name])

property required_dependencies: None

[Read-Write] Use property in struct returned from GetScriptData() instead deprecated: Property ‘RequiredDependencies’ is deprecated.

Type:

(Array[NiagaraModuleDependency])

property script_meta_data: None

[Read-Write] Deprecated, use LibraryVisibility instead. deprecated: Property ‘ScriptMetaData’ is deprecated.

Type:

(Map[Name, str])

property source: NiagaraScriptSourceBase

[Read-Write] ‘Source’ data/graphs for this script deprecated: Property ‘Source’ is deprecated.

Type:

(NiagaraScriptSourceBase)