INiagaraCompiler

Interface for Niagara compilers.

Choose your operating system:

Windows

macOS

Linux

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.

Functions

Name Description

Public function

int32

 

CompileScript

(
    const FNiagaraCompileRequestData&#...,
    const FNiagaraCompileOptions& InOp...,
    const FNiagaraTranslateResults& In...,
    FNiagaraTranslatorOutput* Tran...,
    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< F...

 

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.