1. Epic GamesDeveloper
  3. INiagaraCompiler

INiagaraCompiler

Interface for Niagara compilers.

API > API/Plugins > API/Plugins/NiagaraEditor

References

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

Syntax

class INiagaraCompiler

Remarks

Interface for Niagara compilers. NOTE: the graph->hlsl translation step is now in FNiagaraHlslTranslator

Functions

  Type Name Description
Public function int32

CompileScript ( const FStringView GroupName,
const FNiagaraCompileOptions& InOptions,
const FNiagaraTranslateResults& InTranslateResults,
const FNiagaraTranslatorOutput& TranslatorOutput,
const FString& TranslatedHLSL
)

 Starts the async compilation of a script and returns the job handle to retrieve the results
Public function void

Error ( FText ErrorText
)

 Adds an error to be reported to the user. Any error will lead to compilation failure.
Public function TOptional< FNiagaraCompileResults >

GetCompileResult ( int32 JobID,
bool bWait
)

 Returns the compile result for a given job id once the job has finished compiling.
Public function void

Warning ( FText WarningText
)

 Adds a warning to be reported to the user. Warnings will not cause a compilation failure.

Deprecated Functions

  Type Name Description
Public function int32

CompileScript ( const FNiagaraCompileRequestData* InCompileRequest,
const FNiagaraCompileOptions& InOptions,
const FNiagaraTranslateResults& InTranslateResults,
FNiagaraTranslatorOutput* TranslatorOutput,
FString& TranslatedHLSL
)

 Please update to supply the GroupName directly as this will be removed in a future version.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page