Version: Unity 6.3 Beta (6000.3)
LanguageEnglish
  • C#

AdaptivePerformanceLoaderHelper

class in UnityEngine.AdaptivePerformance

/

Inherits from:AdaptivePerformance.AdaptivePerformanceLoader

/

Implemented in:UnityEngine.AdaptivePerformanceModule

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Adaptive Performance Loader abstract subclass used as a base class for specific provider implementations. Class provides some helper logic that can be used to handle subsystem handling in a typesafe manner, reducing potential boilerplate code.

Public Methods

Method Description
Deinitialize Override of Deinitialize to provide for clearing the instance map. If you override Deinitialize in your subclass, you must call the base implementation to allow the instance map tp be cleaned up correctly.
GetLoadedSubsystem Gets the loaded subsystem of the specified type. This is implementation-specific, because implementations contain data on what they have loaded and how best to get it.

Protected Methods

Method Description
CreateSubsystem Creates a subsystem with a given list of descriptors and a specific subsystem id.
DestroySubsystem Destroy a subsystem instance of a given type. Subsystem is assumed to already be loaded from a previous call to CreateSubsystem.
StartSubsystem Start a subsystem instance of a given type. Subsystem is assumed to already be loaded from a previous call to CreateSubsystem.
StopSubsystem Stop a subsystem instance of a given type. Subsystem is assumed to already be loaded from a previous call to CreateSubsystem.

Inherited Members

Properties

PropertyDescription
Initialized Returns if the provider loader was initialized successfully.
Running Returns if the provider loader is currently running.
hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameThe name of the object.

Public Methods

MethodDescription
GetDefaultSubsystem Gets the loaded default subsystem.
GetSettings Gets the Settings of the loader used to descibe the loader and subsystems.
Initialize Initialize the loader. This should initialize all subsystems to support the desired runtime setup this loader represents.
Start Ask loader to start all initialized subsystems.
Stop Ask loader to stop all initialized subsystems.
GetInstanceIDGets the instance ID of the object.
ToStringReturns the name of the object.

Static Methods

MethodDescription
DestroyRemoves a GameObject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindAnyObjectByTypeRetrieves any active loaded object of Type type.
FindFirstObjectByTypeRetrieves the first active loaded object of Type type.
FindObjectsByTypeRetrieves a list of all loaded objects of Type type.
InstantiateClones the object original and returns the clone.
InstantiateAsyncCaptures a snapshot of the original object (that must be related to some GameObject) and returns the AsyncInstantiateOperation.
CreateInstanceCreates an instance of a scriptable object.

Operators

OperatorDescription
boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.

Messages

MessageDescription
AwakeCalled when an instance of ScriptableObject is created.
OnDestroyThis function is called when the scriptable object will be destroyed.
OnDisableThis function is called when the scriptable object goes out of scope.
OnEnableThis function is called when the object is loaded.
OnValidateEditor-only function that Unity calls when the script is loaded or a value changes in the Inspector.
ResetReset to default values.