Version: Unity 6 (6000.0)
LanguageEnglish
  • C#

QualitySettings.TryIncludePlatformAt

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

Switch to Manual

Declaration

public static bool TryIncludePlatformAt(string buildTargetGroupName, int index, out Exception error);

Parameters

buildTargetGroupName The platform name.
index The index of the Quality Level, must be positive and lower than the count of Quality Levels.
error The error found by the API.

Returns

bool If errors were found.

Description

[Editor Only] Includes a platform to be supported by the Quality Level.

public void IncludeQualityLevelForPlatform(int qualityLevelToExclude, BuildTarget platformToExclude)
{
    var activeBuildTargetGroup = BuildPipeline.GetBuildTargetGroup(platformToExclude);
    var namedBuildTarget = NamedBuildTarget.FromBuildTargetGroup(activeBuildTargetGroup);
    bool result = QualitySettings.TryIncludePlatformAt(namedBuildTarget.TargetName, qualityLevelToExclude, out var ex);
    Debug.Log(result
        ? "Successfully included the platform at the specified quality level."
        : $"Failed to include the platform. {ex.Message}");
}

Includes a platform in a given Quality Level.