Version: Unity 6.6 Alpha (6000.6)
LanguageEnglish
  • C#

AdaptivePerformanceBuildUtils.CheckEnableThermalStateForIOS

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

Declaration

public static bool CheckEnableThermalStateForIOS(BuildProfile profile, bool forcePrompt);

Parameters

Parameter Description
profile Optional active build profile. When supplied, the profile's player settings are inspected and updated; otherwise the project-wide PlayerSettings are used.
forcePrompt When true, bypass the per-session "asked once" suppression and always re-display the dialog (when not in batch mode). Build-time callers should pass true so a misconfiguration is surfaced even if the user already dismissed the dialog earlier in the editor session.

Returns

bool true if the setting is still enabled (i.e. the user declined to disable it, or the dialog could not be shown in batch mode); false if the setting is already disabled or was disabled in response to the prompt.

Description

Checks the "Adjust iOS FPS based on thermal state" Player Setting and, if it is enabled, prompts the user (via dialog in interactive sessions) to disable it so the Adaptive Performance Apple provider can manage thermal mitigation.