Navigation
API > API/Runtime > API/Runtime/Chaos > API/Runtime/Chaos/FDebugSubstep
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Add
(
const TCHAR* Label |
Add a new potential pause point where the debug solver thread can wait until the next step/substep command. | Chaos/Framework/DebugSubstep.h | |
void Add
(
bool bInStep, |
Add a new step or substep. | Chaos/Framework/DebugSubstep.h |
Add(const TCHAR *)
Description
Add a new potential pause point where the debug solver thread can wait until the next step/substep command.
| Name | Add |
| Type | function |
| Header File | /Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/Framework/DebugSubstep.h |
| Include Path | #include "Chaos/Framework/DebugSubstep.h" |
void Add
(
const TCHAR * Label
) const
Parameters
| Name | Remarks |
|---|---|
| Label | The reference (if any) that will be used in verbose logs when this point is reached, or nullptr otherwise. Only call from the solver thread. It will fail if called from inside a parallel for loop, or any other thread. |
Add(bool, const TCHAR *)
Description
Add a new step or substep.
| Name | Add |
| Type | function |
| Header File | /Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/Framework/DebugSubstep.h |
| Include Path | #include "Chaos/Framework/DebugSubstep.h" |
| Source | /Engine/Source/Runtime/Experimental/Chaos/Private/Chaos/Framework/DebugSubstep.cpp |
void Add
(
bool bInStep,
const TCHAR * Label
) const
Parameters
| Name | Remarks |
|---|---|
| bInStep | Add a step instead of a substep when this is true (for internal use only in the solver debug thread loop). |
| Label | The reference (if any) that will be used in verbose logs when this point is reached, or nullptr otherwise. |