Version: 2022.1
LanguageEnglish
  • C#

EditorUtility.GetDialogOptOutDecision

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 GetDialogOptOutDecision(DialogOptOutDecisionType dialogOptOutDecisionType, string dialogOptOutDecisionStorageKey);

Parameters

dialogOptOutDecisionType The type of opt-out decision a user can make.
dialogOptOutDecisionStorageKey The unique key setting to store the decision under.

Returns

bool true if the user previously opted out of seeing the dialog associated with dialogOptOutDecisionStorageKey. Returns false if the user did not yet opt out.

Description

This method displays a modal dialog that lets the user opt-out of being shown the current dialog box again.

Use this method as a short-hand to query the opt-out decision a user made on a dialog displayed via DisplayDialog.

You don't need to query this before you call DisplayDialog, as Unity handles it automatically.

If the user chooses to opt-out of a dialog box, Unity stores this decision. If dialogOptOutDecisionType is set to DialogOptOutDecisionType.ForThisMachine Unity stores it via EditorPrefs.SetBool. If dialogOptOutDecisionType is set to DialogOptOutDecisionType.ForThisSession Unity stores it via SessionState.SetBool. In both cases Unity stores it under the key provided as dialogOptOutDecisionStorageKey.

This method automatically selects the storage place based on the provided dialogOptOutDecisionType.

If you want to the let the user change their decision that is stored in EditorPrefs, you can add this to the Editor Preferences with a SettingsProvider.

See Also: DisplayDialog function.