Class UZagalaSpecScenarioChecker#
Defined in File ZagalaSpecScenarioChecker.h
Inheritance Relationships#
Base Types#
public UObjectpublic IZagalaSpecSubscriber(Class IZagalaSpecSubscriber)
Class Documentation#
-
class UZagalaSpecScenarioChecker : public UObject, public IZagalaSpecSubscriber#
Editor tool that runs a scenario once and keeps a text result of the run.
The checker builds an execution context for the scenario, subscribes to it (the context implements IZagalaSpecBroadcaster) and develops it. When the context succeeds or fails, the checker receives it as an IZagalaSpecSubscriber and writes the result. The scenario cannot be edited while it is checked (IZagalaSpecEditController). It only knows the scenario and the context through their interfaces.
IZagalaSpecSubscriber interface
-
virtual void HandleSuccessReceived_Implementation() override#
Called when the broadcaster reports a successful outcome.
-
virtual void HandleFailureReceived_Implementation(const FString &Reason) override#
Called when the broadcaster reports a failure.
- Parameters:
Reason – A human-readable description of why the operation failed.
Public Functions
-
void StartChecking(UObject *Scenario)#
Builds and develops an execution context for a scenario.
The result is “Checking…” until the context finishes; a context that finishes right away gives the final result before this returns. Does nothing while a check is already running.
- Parameters:
Scenario – The scenario to check; must implement IZagalaSpecScenarioInterface, IZagalaSpecDescriptor and IZagalaSpecEditController.
-
void Cancel()#
Stops waiting for the running check: the result of the context is ignored and the scenario can be edited again.
Does nothing when no check is running.
-
bool IsChecking() const#
Whether a check is waiting for its context to finish.
- Returns:
True while a check is running.
-
const FString &GetCheckResult() const#
Returns the text result of the last check.
- Returns:
The result; empty before the first check.
-
virtual void HandleSuccessReceived_Implementation() override#