unreal.NiagaraScript

class unreal.NiagaraScript(outer=None, name='None')

Bases: unreal.NiagaraScriptBase

Runtime script for a Niagara system

C++ Source:

• Plugin: Niagara

• Module: Niagara

• File: NiagaraScript.h

Editor Properties: (see get_editor_property/set_editor_property)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

property category

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

Type

(Text)

property collapsed_view_format

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

Type

(Text)

property conversion_utility

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

Type

(type(Class))

property deprecated

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

Type

(bool)

property deprecation_message

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

Type

(Text)

property deprecation_recommendation

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

Type

(NiagaraScript)

property description

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

Type

(Text)

property experimental

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

Type

(bool)

property experimental_message

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

Type

(Text)

property expose_to_library

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

Type

(bool)

property keywords

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

Type

(Text)

property library_visibility

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

Type

(NiagaraScriptLibraryVisibility)

property module_usage_bitmask

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

Type

(int32)

property note_message

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

Type

(Text)

property numeric_output_type_selection_mode

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

Type

(NiagaraNumericOutputTypeSelectionMode)

property provided_dependencies

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

Type

(Array(Name))

property required_dependencies

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

Type

(Array(NiagaraModuleDependency))

property script_meta_data

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

Type

(Map(Name, str))

property source

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

Type

(NiagaraScriptSourceBase)