| UObjectBase
|
Module |
|
Header |
/Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraScript.h |
Include |
#include "NiagaraScript.h" |
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(MinimalAPI)
class UNiagaraScript : public UObject
Runtime script for a Niagara system
Name | Description | ||
---|---|---|---|
|
uint32: 1 |
bDeprecated |
If this script is no longer meant to be used, this option should be set. |
|
uint32: 1 |
bExperimental |
Is this script experimental and less supported? |
|
uint32: 1 |
bExposeToLibrary |
If this script is exposed to the library. |
|
Category |
Used to break up scripts of the same Usage type in UI display. |
|
|
TSubclassOf< UN... |
ConversionUtility |
Custom logic to convert the contents of an existing script assignment to this script. |
|
DeprecationMessage |
Message to display when the script is deprecated. |
|
|
UNiagaraScript ... |
DeprecationRecommendation |
Which script to use if this is deprecated. |
|
Description |
||
|
ExperimentalMessage |
The message to display when a function is marked experimental. |
|
|
Highlights |
||
|
Keywords |
A list of space separated keywords which can be used to find this script in editor menus. |
|
|
ModuleUsageBitmask |
When used as a module, what are the appropriate script types for referencing this module? |
|
|
NumericOutputTypeSelectionMode |
The mode to use when deducing the type of numeric output pins from the types of the input pins. |
|
|
ProvidedDependencies |
Array of Ids of dependencies provided by this module to other modules on the stack (e.g. 'ProvidesNormalizedAge') |
|
|
RapidIterationParameters |
Contains all of the top-level values that are iterated on in the UI. |
|
|
RequiredDependencies |
Dependencies required by this module from other modules on the stack |
|
|
ScriptMetaData |
||
|
Usage |
How this script is to be used. cannot be private due to use of GET_MEMBER_NAME_CHECKED |
Name | Description | |
---|---|---|
|
UNiagaraScript ( |
Name | Description | |
---|---|---|
|
~UNiagaraScript() |
Name | Description | ||
---|---|---|---|
|
BeginCacheForCookedPlatformData ( |
Starts caching of platform specific data for the target platform Called when cooking before serialization so that object can prepare platform specific data Not called during normal loading of objects |
|
|
GetAssetRegistryTags ( |
Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects |
|
|
IsCachedCookedPlatformDataLoaded ( |
Have we finished loading all the cooked platform data for the target platforms requested in BeginCacheForCookedPlatformData |
|
|
IsDestructionThreadSafe() |
Called during garbage collection to determine if an object can have its destructor called on a worker thread. |
|
|
PostEditChangeProperty ( |
Called when a property on this object has been modified externally |
|
|
PostLoad() |
Do any object-specific cleanup required immediately after loading an object. |
|
|
PreSave ( |
Presave function. |
|
|
Serialize ( |
Handles reading, writing, and reference collecting using FArchive. |
Name |
Description |
---|---|
FOnPropertyChanged |
|
FOnScriptCompiled |
Name |
Description |
---|---|
NiagaraCustomVersionTagName |
Name | Description | ||
---|---|---|---|
|
UsageIndex_DEPRECATED |
Which instance of the usage in the graph to use. This is now deprecated and is handled by UsageId. |