Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

CheckEnableThermalStateForIOS(BuildProfile, bool)

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.
Read time 1 minuteLast updated 10 days ago

Definition

public static bool CheckEnableThermalStateForIOS(BuildProfile profile = null, bool forcePrompt = false)

Parameters

profile

BuildProfile
Optional active build profile. When supplied, the profile's player settings are inspected and updated; otherwise the project-wide PlayerSettings are used.

forcePrompt

bool
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

Type

Description

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.