Class PluginConfiguration
Inheritance
PluginConfiguration
Syntax
public class PluginConfiguration : IPluginModule, IPluginLinked, IEnumerable<PluginConfigurationItemMetadata>, IEnumerable
Constructors
PluginConfiguration(Plugin)
Declaration
protected PluginConfiguration(Plugin plugin)
Parameters
Type |
Name |
Description |
Plugin |
plugin |
|
Fields
projectSettings
Declaration
public List<ProjectSettingMetadata> projectSettings
Field Value
Properties
deprecatedSavedVersionLoaders
Declaration
public ReadOnlyCollection<PluginDeprecatedSavedVersionLoader> deprecatedSavedVersionLoaders { get; }
Property Value
developerMode
Declaration
protected bool developerMode { get; }
Property Value
editorSetupCompleted
Whether the plugin was properly setup.
Declaration
[EditorPref(visibleCondition = "developerMode", resettable = false)]
public bool editorSetupCompleted { get; }
Property Value
Declaration
public virtual string header { get; }
Property Value
plugin
Declaration
public Plugin plugin { get; }
Property Value
Implements
projectSetupCompleted
Whether the plugin was properly setup.
Declaration
[ProjectSetting(visibleCondition = "developerMode", resettable = false)]
public bool projectSetupCompleted { get; }
Property Value
savedVersion
The last version to which the plugin successfully upgraded.
Declaration
[ProjectSetting(visibleCondition = "developerMode", resettable = false)]
public SemanticVersion savedVersion { get; }
Property Value
Methods
DeleteAllEditorPrefs()
Declaration
public static void DeleteAllEditorPrefs()
DeleteAllPlayerPrefs()
Declaration
public static void DeleteAllPlayerPrefs()
DeleteAllProjectSettings()
Declaration
public static void DeleteAllProjectSettings()
GetEnumerator()
Declaration
public IEnumerator<PluginConfigurationItemMetadata> GetEnumerator()
Returns
Declaration
public PluginConfigurationItemMetadata GetMetadata(string memberName)
Parameters
Type |
Name |
Description |
String |
memberName |
|
Returns
Initialize()
Declaration
public virtual void Initialize()
Implements
LateInitialize()
Declaration
public virtual void LateInitialize()
Implements
Reset()
Declaration
Save()
Declaration
SaveProjectSettingsAsset(Boolean)
Declaration
public void SaveProjectSettingsAsset(bool immediately = false)
Parameters
Type |
Name |
Description |
Boolean |
immediately |
|
Extension Methods
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.