Navigation
API > API/Plugins > API/Plugins/NiagaraEditor
This validation rule can be used to enforce a budget on the number of simulation stages and the iterations that may execute.
| Name | UNiagaraValidationRule_SimulationStageBudget |
| Type | class |
| Header File | /Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/NiagaraValidationRules.h |
| Include Path | #include "NiagaraValidationRules.h" |
Syntax
UCLASS (Category="Validation", DisplayName="Simulation Stage Budget")
class UNiagaraValidationRule_SimulationStageBudget : public UNiagaraValidationRule
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UNiagaraValidationRule → UNiagaraValidationRule_SimulationStageBudget
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bMaxIterationsPerStageEnabled | bool | NiagaraValidationRules.h |
|
|
| bMaxSimulationStagesEnabled | bool | NiagaraValidationRules.h |
|
|
| bMaxTotalIterationsEnabled | bool | NiagaraValidationRules.h |
|
|
| MaxIterationsPerStage | int32 | Maximum number of iterations a single stage is allowed to execute. | NiagaraValidationRules.h |
|
| MaxSimulationStages | int32 | Maximum number of simulation stages allowed, where 0 means no simulation stages. | NiagaraValidationRules.h |
|
| MaxTotalIterations | int32 | Maximum total iterations across all the enabled simulation stages. | NiagaraValidationRules.h |
|
| Severity | ENiagaraValidationSeverity | How do we want to repro the error in the stack | NiagaraValidationRules.h |
|
Functions
Public
Overridden from UNiagaraValidationRule
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CheckValidity
(
const FNiagaraValidationContext& Context, |
NiagaraValidationRules.h |