Version 3.1.1.0

ValidationSession class

Namespace: Sirenix.OdinValidator.Editor
Assembly: Sirenix.OdinValidator.Editor
public class ValidationSession : IDisposable
Inheritance
  • System.Object
  • ValidationSession

Constructors

ValidationSession(String, SessionConfig)
public ValidationSession(string sessionName, SessionConfig config)
Parameters
System.String sessionName

SessionConfig config

ValidationSession(String, ValidationItem[])
public ValidationSession(string sessionName, params ValidationItem[] include)
Parameters
System.String sessionName

ValidationItem[] include

ValidationSession(String, IList<ValidationItem>, IList<ValidationItem>)
public ValidationSession(string sessionName, IList<ValidationItem> include, IList<ValidationItem> exclude)
Parameters
System.String sessionName

System.Collections.Generic.IList<ValidationItem> include

System.Collections.Generic.IList<ValidationItem> exclude

Fields

ActiveValidationSessions
public static List<ValidationSession> ActiveValidationSessions
Config
public readonly SessionConfig Config
Name
public readonly string Name
RemovedObjectResults
public readonly Queue<ValidationSession.ValidationSessionResult> RemovedObjectResults
Runner
public OdinValidationRunner Runner
WorkDone
public readonly HashSet<ValidationWorkItem> WorkDone
WorkQueue
public readonly ValidationWorkItemQueue WorkQueue

Properties

GlobalValidationSession
public static ValidationSession GlobalValidationSession { get; }
IsValidatingInBackground
public bool IsValidatingInBackground { get; }
IsWatching
public bool IsWatching { get; }
RemainingWorkCountSample
public uint RemainingWorkCountSample { get; }
ShouldDisplayProgressBar
public bool ShouldDisplayProgressBar { get; }
WorkDoneCountSample
public uint WorkDoneCountSample { get; }

Methods

CalculateCurrentValidationProgress()
public float CalculateCurrentValidationProgress()
Returns
System.Single

Clear(Boolean, Boolean)
public void Clear(bool clearResults, bool clearQueue)
Parameters
System.Boolean clearResults

System.Boolean clearQueue

Dispose()
public void Dispose()
Dispose(Boolean)
protected virtual void Dispose(bool finalizer)
Parameters
System.Boolean finalizer

Finalize()
protected void Finalize()
OpenEditor()
public ValidationSessionEditor OpenEditor()
PopulateQueue(Boolean, Boolean)
public void PopulateQueue(bool clearCurrentQueue, bool populateUnloadedScenes)
Parameters
System.Boolean clearCurrentQueue

System.Boolean populateUnloadedScenes

RestartBackgroundValidation()
public void RestartBackgroundValidation()
StartSession(Boolean, Boolean)
public void StartSession(bool startWatching = true, bool startBackgroundValidation = true)
Parameters
System.Boolean startWatching

System.Boolean startBackgroundValidation

StopSession(Boolean, Boolean)
public void StopSession(bool stopWatching = true, bool stopBackgroundValidation = true)
Parameters
System.Boolean stopWatching

System.Boolean stopBackgroundValidation

ValidateCurrentWorkQueueEnumerator(Boolean, Boolean)
public IEnumerable<ValidationSession.ValidationSessionResult> ValidateCurrentWorkQueueEnumerator(bool populateResults, bool openClosedScenes)
Parameters
System.Boolean populateResults

System.Boolean openClosedScenes

Returns
System.Collections.Generic.IEnumerable<ValidationSession.ValidationSessionResult>

ValidateEverythingEnumerator(Boolean, Boolean)
public IEnumerable<PersistentValidationResult> ValidateEverythingEnumerator(bool openClosedScenes, bool showProgressBar)
Parameters
System.Boolean openClosedScenes

System.Boolean showProgressBar

Returns
System.Collections.Generic.IEnumerable<PersistentValidationResult>

ValidateEverythingNow(Boolean, Boolean)
public void ValidateEverythingNow(bool openClosedScenes, bool showProgressBar)
Parameters
System.Boolean openClosedScenes

System.Boolean showProgressBar

ValidateQueuedUpWorkNow(Boolean, Boolean)
public void ValidateQueuedUpWorkNow(bool showProgressBar = true, bool processResultQueue = true)
Parameters
System.Boolean showProgressBar

System.Boolean processResultQueue