Class Criterion
Base class for Criterion implementations.
Namespace: Unity.Tutorials.Core.Editor
Syntax
public abstract class Criterion : ScriptableObject
Fields
Completed
Raised when this criterion is completed.
Declaration
public CriterionEvent Completed
Field Value
| Type | Description |
|---|---|
| CriterionEvent |
CriterionCompleted
Raised when any Criterion is completed.
Declaration
public static CriterionEvent CriterionCompleted
Field Value
| Type | Description |
|---|---|
| CriterionEvent |
CriterionInvalidated
Raised when any Criterion is invalidated.
Declaration
public static CriterionEvent CriterionInvalidated
Field Value
| Type | Description |
|---|---|
| CriterionEvent |
Invalidated
Raised when this criterion is invalidated.
Declaration
public CriterionEvent Invalidated
Field Value
| Type | Description |
|---|---|
| CriterionEvent |
Properties
IsCompleted
Is the Criterion completed. Setting this raises CriterionCompleted/CriterionInvalidated.
Declaration
public bool IsCompleted { get; }
Property Value
| Type | Description |
|---|---|
| Boolean |
Methods
AutoComplete()
Auto-completes the criterion.
Declaration
public abstract bool AutoComplete()
Returns
| Type | Description |
|---|---|
| Boolean | True if the auto-completion succeeded. |
CreateFutureObjectReference()
Creates a default FutureObjectReference for this Criterion.
Declaration
protected FutureObjectReference CreateFutureObjectReference()
Returns
| Type | Description |
|---|---|
| FutureObjectReference |
CreateFutureObjectReference(String)
Creates a FutureObjectReference by specific name for this Criterion.
Declaration
protected FutureObjectReference CreateFutureObjectReference(string referenceName)
Parameters
| Type | Name | Description |
|---|---|---|
| String | referenceName |
Returns
| Type | Description |
|---|---|
| FutureObjectReference |
EvaluateCompletion()
Evaluates if the criterion is completed.
Declaration
protected virtual bool EvaluateCompletion()
Returns
| Type | Description |
|---|---|
| Boolean |
GetFutureObjectReferences()
Returns FutureObjectReference for this Criterion.
Declaration
protected virtual IEnumerable<FutureObjectReference> GetFutureObjectReferences()
Returns
| Type | Description |
|---|---|
| IEnumerable<FutureObjectReference> |
OnValidate()
Destroys unreferenced future references.
Declaration
protected virtual void OnValidate()
ResetCompletionState()
Resets the completion state.
Declaration
public void ResetCompletionState()
StartTesting()
Starts testing of the criterion.
Declaration
public virtual void StartTesting()
StopTesting()
Stops testing of the criterion.
Declaration
public virtual void StopTesting()
UpdateCompletion()
Runs update logic for the criterion.
Declaration
public virtual void UpdateCompletion()
UpdateFutureObjectReferenceNames()
Updates names of the references.
Declaration
protected void UpdateFutureObjectReferenceNames()