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.
CloseFor 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.
ClosedialogOptOutDecisionType | The type of opt-out decision a user can make. |
dialogOptOutDecisionStorageKey | The unique key setting to store the decision under. |
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.
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.
Additional resources: DisplayDialog function.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.