UNPKG

com.caffeine

Version:

Caffeine package is a collection of utility methods, design patterns, and extensions for creating, previewing, and distributing interactive courses within Unity.

784 lines 626 kB
<?xml version="1.0"?> <doc> <assembly> <name>Sirenix.OdinInspector.Editor</name> </assembly> <members> <member name="T:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver"> <summary> <para>An ActionResolver resolves a string to an action, given an InspectorProperty instance to use as context. Call <see cref="M:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver.Get(Sirenix.OdinInspector.Editor.InspectorProperty,System.String)"/> to get an instance of an ActionResolver.</para> <para>Action resolvers are a globally extendable system that can be hooked into and modified or changed by creating and registering an <see cref="T:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolverCreator"/>.</para> <para>See Odin's tutorials for details and examples of how to use ActionResolvers.</para> </summary> </member> <member name="F:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver.Context"> <summary> The context of this ActionResolver, containing all of its configurations and values it needs to function. For performance and simplicity reasons, this is a single very large struct that is passed around by ref to anything that needs it. </summary> </member> <member name="F:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver.Action"> <summary> The delegate that executes the actual action. You should not call this manually, but instead call <see cref="M:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver.DoAction(System.Int32)"/>. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver.ErrorMessage"> <summary> The current error message that the resolver has, or null if there is no error message. This is a shortcut for writing "resolver.Context.ErrorMessage". </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver.HasError"> <summary> Whether there is an error message at the moment. This is a shortcut for writing "resolver.Context.ErrorMessage != null". </summary> </member> <member name="M:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver.DrawError"> <summary> Draws an error message box if there is an error, and does nothing if there is no error. </summary> </member> <member name="M:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver.DoAction(System.Int32)"> <summary> Executes the resolved action for a given selection index. </summary> <param name="selectionIndex">The selection index to execute the action on. Defaults to 0.</param> </member> <member name="M:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver.DoActionForAllSelectionIndices"> <summary> Executes the action for all selection indices. </summary> </member> <member name="M:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver.GetFromContext(Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolverContext@)"> <summary> Creates a new action resolver instance from a pre-built context struct. This is a more advanced use that requires you to know how the context needs to be set up before action resolution happens. However, this allows you to do more advanced things like adjust various context values before string resolution happens. </summary> <param name="context">The pre-built context that should be used to get a resolver.</param> </member> <member name="M:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver.Get(Sirenix.OdinInspector.Editor.InspectorProperty,System.String)"> <summary> Creates a new action resolver instance for a given string. </summary> <param name="property">The property that is the context for the resolution to happen in.</param> <param name="resolvedString">The string that should be resolved to an action.</param> </member> <member name="M:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver.Get(Sirenix.OdinInspector.Editor.InspectorProperty,System.String,Sirenix.OdinInspector.Editor.ActionResolvers.NamedValue[])"> <summary> Creates a new action resolver instance for a given string. </summary> <param name="property">The property that is the context for the resolution to happen in.</param> <param name="resolvedString">The string that should be resolved to an action.</param> <param name="namedArgs">The extra named args that this resolver has access to. Passing in a named arg that already exists will silently override the pre-existing named arg.</param> </member> <member name="M:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver.GetCombinedErrors(Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver,Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver,Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver,Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver,Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver,Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver,Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver,Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver)"> <summary> Gets a nicely formatted string that lists all the errors in the given set of action resolvers. The returned value is null if there are no errors. </summary> </member> <member name="M:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver.GetCombinedErrors(Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver,Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver,Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver,Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver,Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver,Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver,Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver,Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver,Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver[])"> <summary> Gets a nicely formatted string that lists all the errors in the given set of action resolvers. The returned value is null if there are no errors. </summary> </member> <member name="M:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver.DrawErrors(Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver,Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver,Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver,Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver,Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver,Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver,Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver,Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver)"> <summary> Draws error boxes for all errors in the given action resolvers, or does nothing if there are no errors. This is equivalent to calling DrawError() on all resolvers passed to this method. </summary> </member> <member name="M:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver.DrawErrors(Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver,Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver,Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver,Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver,Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver,Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver,Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver,Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver,Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolver[])"> <summary> Draws error boxes for all errors in the given action resolvers, or does nothing if there are no errors. This is equivalent to calling DrawError() on all resolvers passed to this method. </summary> </member> <member name="T:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolverContext"> <summary> This struct contains all of an ActionResolver's configurations and values it needs to function. For performance and simplicity reasons, this is a single very large struct that lives on an ActionResolver instance and is passed around by ref to anything that needs it. </summary> </member> <member name="F:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolverContext.Property"> <summary> The property that *provides* the context for the action resolution. This is the instance that was passed to the resolver when it was created. Note that this is different from <see cref="P:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolverContext.ContextProperty"/>, which is based on this value, but almost always isn't the same InspectorProperty instance. </summary> </member> <member name="F:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolverContext.ErrorMessage"> <summary> The error message, if a valid action resolution wasn't found, or if creation of the action resolver failed because <see cref="P:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolverContext.ResolvedString"/> was invalid, or if the action was executed but threw an exception. (In this last case, <see cref="F:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolverContext.ErrorMessageIsDueToException"/> will be true.) </summary> </member> <member name="F:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolverContext.NamedValues"> <summary> The named values that are available to the action resolver. Use this field only to get and set named values - once the ValueResolver has been created, new named values will have no effect. </summary> </member> <member name="F:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolverContext.ErrorMessageIsDueToException"> <summary> This will be true if <see cref="F:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolverContext.ErrorMessage"/> is not null and the message was caused by an exception thrown by code invoked during execution of the resolved action. </summary> </member> <member name="F:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolverContext.LogExceptions"> <summary> Whether exceptions thrown during action execution should be logged to the console. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolverContext.ResolvedString"> <summary> The string that is resolved to perform an action. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolverContext.SyncRefParametersWithNamedValues"> <summary> Whether the action resolver should sync ref parameters of invoked methods with named values. If this is true, then if a ref or out parameter value is changed during action execution, the named value associated with that parameter will also be changed to the same value. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolverContext.IsResolved"> <summary> Whether this context has been resolved. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolverContext.ParentType"> <summary> The type that is the parent of the action resolution, ie, the type that is the context. This is the same as <see cref="P:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolverContext.ContextProperty"/>.ValueEntry.TypeOfValue. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolverContext.ContextProperty"> <summary> The property that *is* the context for the action resolution. This is not the instance that was passed to the resolver when it was created, but this value is based on that instance. This is the property that provides the actual context - for example, if <see cref="F:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolverContext.Property"/> is for a member of a type - or for an element in a collection contained by a member - this value will be the parent property for the type that contains that member. Only if <see cref="F:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolverContext.Property"/> is the tree's root property is <see cref="P:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolverContext.ContextProperty"/> the same as <see cref="F:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolverContext.Property"/>. </summary> </member> <member name="M:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolverContext.GetParentValue(System.Int32)"> <summary> Gets the parent value which provides the context of the resolver. </summary> <param name="selectionIndex">The selection index of the parent value to get.</param> </member> <member name="M:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolverContext.SetParentValue(System.Int32,System.Object)"> <summary> Sets the parent value which provides the context of the resolver. </summary> <param name="selectionIndex">The selection index of the parent value to set.</param> <param name="value">The value to set.</param> </member> <member name="M:Sirenix.OdinInspector.Editor.ActionResolvers.ActionResolverContext.AddDefaultContextValues"> <summary> Adds the default named values of "property" and "value" to the context's named values. This method is usually automatically invoked when a resolver is created, so there is no need to invoke it manually. </summary> </member> <member name="T:Sirenix.OdinInspector.Editor.ColorPalette"> <summary> A color palette. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.ColorPalette.Name"> <summary> Name of the color palette. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.ColorPalette.Colors"> <summary> The colors. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.ColorPalette.ShowAlpha"> <summary> Whether to show the alpha channel. </summary> </member> <member name="T:Sirenix.OdinInspector.Editor.ColorPaletteManager"> <summary> <para>Add, Edit or remove custom color palettes used by the <see cref="T:Sirenix.OdinInspector.ColorPaletteAttribute"/>.</para> <para> You can modify the configuration in the Odin Preferences window found in 'Tools -> Odin Inspector -> Preferences -> Drawers -> Color Palettes', or by locating the configuration file stored as a serialized object in the Sirenix folder under 'Odin Inspector/Config/Editor/ColorPaletteManager'. </para> </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.ColorPaletteManager.SwatchSpacing"> <summary> Specify the amount of spacing between each color in a color palette. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.ColorPaletteManager.SwatchSize"> <summary> Specify the width of each color in a color palette. If StretchPalette is set to true, this will become the min-width. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.ColorPaletteManager.StretchPalette"> <summary> If true, all color in a color palette is stretch so that the entire color-palette area is filled. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.ColorPaletteManager.ShowPaletteName"> <summary> If true, a toolbar with the name of the color palette is shown above each color palette. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.ColorPaletteManager.ColorPalettes"> <summary> Gives you the list of all custom color palettes. Remember to call UnityEditor.EditorUtility.SetDirty(ColorPaletteManager.Instance) after modifying the list. </summary> </member> <member name="T:Sirenix.OdinInspector.Editor.EditorOnlyModeConfig"> <summary> Editor Only Mode Utility. </summary> </member> <member name="M:Sirenix.OdinInspector.Editor.EditorOnlyModeConfig.Update"> <summary> Gaither all necessary information about the editor only state. </summary> </member> <member name="M:Sirenix.OdinInspector.Editor.EditorOnlyModeConfig.DisableEditorOnlyMode"> <summary> Disables Editor Only Mode. </summary> </member> <member name="M:Sirenix.OdinInspector.Editor.EditorOnlyModeConfig.EnableEditorOnlyMode(System.Boolean)"> <summary> Enables editor only mode. </summary> </member> <member name="M:Sirenix.OdinInspector.Editor.EditorOnlyModeConfig.IsEditorOnlyModeEnabled"> <summary> Checks to see whether Editor Only Mode is enabled. </summary> </member> <member name="M:Sirenix.OdinInspector.Editor.EditorOnlyModeConfig.IsInSourceCode"> <summary> Checks to see whether Odin Inspector is installed in Source Code mode. </summary> </member> <member name="T:Sirenix.OdinInspector.Editor.GeneralDrawerConfig"> <summary> <para>Contains general configuration for all Odin drawers.</para> <para> You can modify the configuration in the Odin Preferences window found in 'Tools -> Odin Inspector -> Preferences -> Drawers -> General', or by locating the configuration file stored as a serialized object in the Sirenix folder under 'Odin Inspector/Config/Editor/GeneralDrawerConfig'. </para> </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.EnableUIToolkitSupport"> <summary> Specify whether or not the script selector above components should be drawn. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.ShowMonoScriptInEditor"> <summary> Specify whether or not the script selector above components should be drawn. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.ShowPrefabModificationsDisabledMessage"> <summary> Specify whether or not the warning for properties that do not support prefab modifications should be shown in the inspector. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.ShowPrefabModifiedValueBar"> <summary> Specify whether or not the warning for properties that do not support prefab modifications should be shown in the inspector. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.MaxRecursiveDrawDepth"> <summary> Specifies the maximum depth to which a property can draw itself recursively before the system refuses to draw it any deeper. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.ExpandFoldoutByDefault"> <summary> If set to true, most foldouts throughout the inspector will be expanded by default. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.ShowButtonResultsByDefault"> <summary> If set to true, buttons will show the result values from invoking them in the inspector by default. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.GUIFoldoutAnimationDuration"> <summary> Specify the animation speed for most foldouts throughout the inspector. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.ShakingAnimationDuration"> <summary> Specify the shaking duration for most shaking animations throughout the inspector. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.TabPageSlideAnimationDuration"> <summary> Specify the animation speed for <see cref="T:Sirenix.OdinInspector.TabGroupAttribute"/> </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.ResponsiveVectorComponentFields"> <summary> When <c>true</c> the component labels, for vector fields, will be hidden when the field is too narrow. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.QuaternionDrawMode"> <summary> Specify how the Quaternion struct should be shown in the inspector. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.UseImprovedEnumDropDown"> <summary> Gets or sets a value indicating whether [use improved enum drop down]. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.DrawEnumTypeTitle"> <summary> Gets or sets a value indicating whether [use improved enum drop down]. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.ShowPagingInTables"> <summary> Specify whether or not a list should hide the foldout triangle when the list is empty. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.HideFoldoutWhileEmpty"> <summary> Specifies whether a list should hide the foldout triangle when the list is empty. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.HidePagingWhileCollapsed"> <summary> Specify whether or not lists should hide the paging buttons when the list is collapsed. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.HidePagingWhileOnlyOnePage"> <summary> Specify whether or not lists should hide the paging buttons when there is only one page. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.NumberOfItemsPrPage"> <summary> Specify the number of elements drawn per page. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.OpenListsByDefault"> <summary> Specify whether or not lists should be expanded or collapsed by default. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.ShowExpandButton"> <summary> Specify whether or not to include a button which expands the list, showing all pages at once. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.ShowItemCount"> <summary> Specify whether or not lists should show item count. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.ShowIndexLabels"> <summary> Specify whether or not lists should show item count. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.ListItemColorEvenDarkSkin"> <summary> Specify the color of even list elements when in the dark skin. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.ListItemColorOddDarkSkin"> <summary> Specify the color of odd list elements when in the dark skin. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.ListItemColorEvenLightSkin"> <summary> Specify the color of even list elements when in the light skin. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.ListItemColorOddLightSkin"> <summary> Specify the color of odd list elements when in the light skin. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.SquareUnityObjectFieldHeight"> <summary> Gets or sets the default size of the preview object field. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.SquareUnityObjectAlignment"> <summary> Gets or sets the default alignment of the preview object field. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.SquareUnityObjectEnableFor"> <summary> Gets or sets which types should be drawn by default by the preview object field. </summary> </member> <member name="M:Sirenix.OdinInspector.Editor.GeneralDrawerConfig.ResetToDefault"> <summary> Resets all settings to default. </summary> </member> <member name="T:Sirenix.OdinInspector.Editor.ImportSettingsConfig"> <summary> Configurations for Odin DLLs import settings. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.ImportSettingsConfig.AutomateBeforeBuild"> <summary> Gets or sets a value indicating whether or not Odin should automatically configure the import settings of its DLLs in a preprocess build step. Keep in mind that this feature is only supported by Unity version 5.6 and up. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.ImportSettingsConfig.IsAutomationSupported"> <summary> Gets a value indicating whether or not automatic configuration of Odin's DLL import settings is supported by the current Unity version. </summary> </member> <member name="T:Sirenix.OdinInspector.Editor.InspectorConfig"> <summary> <para> Tell Odin which types should be drawn or should not be drawn by Odin. </para> <para> You can modify which types should be drawn by Odin in the Preferences window found in 'Tools -> Odin Inspector -> Preferences -> Editor Types', or by locating the configuration file stored as a serialized object in the Sirenix folder under 'Odin Inspector/Config/Editor/InspectorConfig'. </para> </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.InspectorConfig.EnableOdinInInspector"> <summary> Whether Odin is enabled in the inspector or not. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.InspectorConfig.DefaultEditorBehaviour"> <summary> InspectorDefaultEditors is a bitmask used to tell which types should have an Odin Editor generated. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.InspectorConfig.DrawingConfig"> <summary> The config which contains configuration data for which types Odin should draw in the inspector. </summary> </member> <member name="M:Sirenix.OdinInspector.Editor.InspectorConfig.UpdateOdinEditors"> <summary> Updates Unity with the current Odin editor configuration. </summary> </member> <member name="T:Sirenix.OdinInspector.Editor.InspectorDefaultEditors"> <summary> InspectorDefaultEditors is a bitmask used to tell <see cref="T:Sirenix.OdinInspector.Editor.InspectorConfig"/> which types should have an Odin Editor generated. </summary> <seealso cref="T:Sirenix.OdinInspector.Editor.InspectorConfig"/> </member> <member name="F:Sirenix.OdinInspector.Editor.InspectorDefaultEditors.None"> <summary> Excludes all types. </summary> </member> <member name="F:Sirenix.OdinInspector.Editor.InspectorDefaultEditors.UserTypes"> <summary> UserTypes includes all custom user scripts that are not located in an editor or plugin folder. </summary> </member> <member name="F:Sirenix.OdinInspector.Editor.InspectorDefaultEditors.PluginTypes"> <summary> PluginTypes includes all types located in the plugins folder and are not located in an editor folder. </summary> </member> <member name="F:Sirenix.OdinInspector.Editor.InspectorDefaultEditors.UnityTypes"> <summary> UnityTypes includes all types depended on UnityEngine and from UnityEngine, except editor, plugin and user types. </summary> </member> <member name="F:Sirenix.OdinInspector.Editor.InspectorDefaultEditors.OtherTypes"> <summary> OtherTypes include all other types that are not depended on UnityEngine or UnityEditor. </summary> </member> <member name="T:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfig"> <summary> <para>Contains configuration data for which types Odin should draw in the inspector.</para> </summary> <remarks> <para>Note that this class supports assigning arbitrary editor types to inspect any Unity object type. The Editor Types GUI in preferences simply does not, as of now, support assigning editors of any other type than <see cref="T:Sirenix.OdinInspector.Editor.OdinEditor"/>. However, the API is open to further customization.</para> <para>When an editor is generated for a type, a new editor type is added to the GeneratedOdinEditors assembly, which is derived from the assigned editor type - in most cases, <see cref="T:Sirenix.OdinInspector.Editor.OdinEditor"/>.</para> <para>You can check if an editor is compatible using <see cref="M:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfig.UnityInspectorEditorIsValidBase(System.Type,System.Type)"/>.</para> </remarks> <seealso cref="T:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfigDrawer"/>. <seealso cref="!:EditorCompilation"/>. </member> <member name="F:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfig.TypeBinder"> <summary> <para>The type binder that the <see cref="T:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfig"/> uses to bind types to names, and names to types.</para> <para>This is usually an instance of <see cref="T:Sirenix.Serialization.DefaultSerializationBinder"/>.</para> </summary> </member> <member name="M:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfig.ResetToDefault"> <summary> Resets the drawing configuration to the default values. </summary> </member> <member name="M:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfig.GetAllDrawnTypesWithEntries"> <summary> Gets a list of all drawn types that have entries in the drawing config. </summary> </member> <member name="M:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfig.UpdateCaches"> <summary> Forces the config's internal drawer type to value type lookup cache to rebuild itself. </summary> </member> <member name="M:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfig.ClearEditorEntryForDrawnType(System.Type)"> <summary> Clears the editor type entry for the given drawer, so it will be set to Unity's default. </summary> <param name="drawnType">The drawn type to clear the editor for.</param> <exception cref="T:System.ArgumentNullException">drawnType is null</exception> </member> <member name="M:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfig.SetEditorType(System.Type,System.Type)"> <summary> Assigns a given editor to draw a given type. </summary> <param name="drawnType">The drawn type to assign an editor type for.</param> <param name="editorType">The editor type to assign. When generating editors, a type derived from this editor will be created and set to draw the given drawn type.</param> <exception cref="T:System.ArgumentNullException">drawnType</exception> <exception cref="T:System.ArgumentException">The type " + editorType.GetNiceName() + " is not a valid base editor for type " + drawnType.GetNiceName() + ". Check criteria using <see cref="M:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfig.UnityInspectorEditorIsValidBase(System.Type,System.Type)"/>.</exception> </member> <member name="M:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfig.HasEntryForType(System.Type)"> <summary> Determines whether an editor value has been assigned for a given drawn type. </summary> <param name="drawnType">The drawn type to check.</param> <exception cref="T:System.ArgumentNullException">drawnType is null</exception> </member> <member name="M:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfig.GetEditorType(System.Type)"> <summary> Gets which editor type would draw the given type. If the type has not been assigned a custom editor type in the config, the default editor type is returned using <see cref="M:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfig.GetDefaultEditorType(System.Type)"/>. </summary> <param name="drawnType">The drawn type to get an editor type for.</param> <returns>The editor that would draw the given type.</returns> <exception cref="T:System.ArgumentNullException">drawnType is null</exception> </member> <member name="M:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfig.GetDefaultEditorType(System.Type)"> <summary> Gets the default editor that this type would have, if no custom editor was set for this type in particular. This is calculated using the value of <see cref="P:Sirenix.OdinInspector.Editor.InspectorConfig.DefaultEditorBehaviour"/>. </summary> <param name="drawnType">The drawn type to get the default editor for.</param> <returns>The editor that would draw this type by default, or null, if there is no default Odin-defined editor for the drawn type.</returns> <exception cref="T:System.ArgumentNullException">drawnType is null</exception> </member> <member name="M:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfig.UnityInspectorEditorIsValidBase(System.Type)"> <summary> Checks whether the given editor can be assigned to draw any type using the <see cref="T:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfig"/> class. </summary> <param name="editorType">Type of the editor to check.</param> <returns>True if the editor is valid, otherwise false</returns> </member> <member name="M:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfig.UnityInspectorEditorIsValidBase(System.Type,System.Type)"> <summary> <para>Checks whether the given editor can be assigned to draw a given type using the <see cref="T:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfig" /> class.</para> <para>This method checks the <see cref="T:UnityEditor.CustomEditor"/> attribute on the type for whether the given type is compatible.</para> </summary> <param name="editorType">Type of the editor to check.</param> <param name="drawnType">Type of the drawn value to check. If this parameter is null, the drawn type is not checked for compatibility with the editor type; only the editor type itself is checked for validity.</param> <returns>True if the editor is valid, otherwise false</returns> <exception cref="T:System.ArgumentNullException">editorType</exception> </member> <member name="M:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfig.GetEditorDrawnType(System.Type,System.Boolean@)"> <summary> <para>Gets the type that an editor draws, by extracting it from the editor's <see cref="T:UnityEditor.CustomEditor"/> attribute, if it is declared.</para> <para>This method returns null for abstract editor types, as those can never draw anything.</para> </summary> <param name="editorType">Type of the editor.</param> <param name="editorForChildClasses">Whether the editor in question is also an editor for types derived from the given type.</param> <returns></returns> <exception cref="T:System.ArgumentNullException">editorType</exception> </member> <member name="T:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfig.MissingEditor"> <summary> A type that indicates that a drawer is missing. </summary> </member> <member name="T:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfigDrawer"> <summary> <para>Draws an <see cref="T:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfig"/> instance, and contains methods getting all types that should be drawn by Odin.</para> <para>Note that this class keeps a lot of static state, and is only intended to draw the instance of <see cref="T:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfig"/> that exists in the <see cref="T:Sirenix.OdinInspector.Editor.InspectorConfig"/> singleton asset. If used to draw other instances, odd behaviour may occur.</para> </summary> <seealso cref="T:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfig"/>. <seealso cref="!:EditorCompilation"/>. </member> <member name="M:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfigDrawer.OdinCanCreateEditorFor(System.Type)"> <summary> Determines whether Odin is capable of creating a custom editor for a given type. </summary> </member> <member name="M:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfigDrawer.GetEditors"> <summary> Gets an array of all assigned editor types, and the types they have to draw. </summary> </member> <member name="M:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfigDrawer.DrawPropertyLayout(UnityEngine.GUIContent)"> <summary> Draws the property. </summary> </member> <member name="T:Sirenix.OdinInspector.Editor.OdinInspectorVersion"> <summary> Installed Odin Inspector Version Info. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.OdinInspectorVersion.BuildName"> <summary> Gets the name of the current running version of Odin Inspector. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.OdinInspectorVersion.Version"> <summary> Gets the current running version of Odin Inspector. </summary> </member> <member name="P:Sirenix.OdinInspector.Editor.OdinInspectorVersion.IsEnterprise"> <summary> Whether the current version of Odin is an enterprise version. </summary> </member> <member name="T:Sirenix.OdinInspector.Editor.TypeDrawerPair"> <summary> <para>Contains information about an editor type which is assigned to draw a certain type in the inspector.</para> <para>This class uses the <see cref="F:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfig.TypeBinder"/> instance to bind types to names, and names to types.</para> </summary> <seealso cref="T:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfigDrawer"/>. <seealso cref="T:Sirenix.OdinInspector.Editor.InspectorTypeDrawingConfig"/>. <seealso cref="!:EditorCompilation"/>. </member> <member name="F:Sirenix.OdinInspector.Editor.TypeDrawerPair.Default"> <summary> A default, empty <see cref="T:Sirenix.OdinInspector.Editor.TypeDrawerPair"/> value. </summary> </member> <member name="F:Sirenix.OdinInspector.Editor.TypeDrawerPair.DrawnTypeName"> <summary> The name of the type to be drawn. </summary> </member> <member name="F:Sirenix.OdinInspector.Editor.TypeDrawerPair.EditorTypeName"> <summary> The name of the editor type. </summary> </member> <member name="M:Sirenix.OdinInspector.Editor.TypeDrawerPair.#ctor(System.Type)"> <summary> Initializes a new instance of the <see cref="T:Sirenix.OdinInspector.Editor.TypeDrawerPair"/> struct. </summary> <param name="drawnType">The drawn type.</param> <exception cref="T:System.ArgumentNullException">drawnType is null</exception> </member> <member name="M:Sirenix.OdinInspector.Editor.TypeDrawerPair.#ctor(System.Type,System.Type)"> <summary> Initializes a new instance of the <see cref="T:Sirenix.OdinInspector.Editor.TypeDrawerPair"/> struct. </summary> <param name="drawnType">The drawn type.</param> <param name="editorType">The editor type.</param> <exception cref="T:System.ArgumentNullException">drawnType is null</exception> </member> <member name="M:Sirenix.OdinInspector.Editor.TypeDrawerPair.Equals(Sirenix.OdinInspector.Editor.TypeDrawerPair)"> <summary> Determines whether the specified <see cref="T:Sirenix.OdinInspector.Editor.TypeDrawerPair" /> is equal to this instance. </summary> <param name="other">The <see cref="T:Sirenix.OdinInspector.Editor.TypeDrawerPair" /> to compare with this instance.</param> <returns> <c>true</c> if the specified <see cref="T:Sirenix.OdinInspector.Editor.TypeDrawerPair" /> is equal to this instance; otherwise, <c>false</c>. </returns> </member> <member name="M:Sirenix.OdinInspector.Editor.TypeDrawerPair.GetHashCode"> <summary> Returns a hash code for this instance. </summary> <returns> A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. </returns> </member> <member name="M:Sirenix.OdinInspector.Editor.TypeDrawerPair.Equals(System.Object)"> <summary> Determines whether the specified <see cref="T:System.Object" />, is equal to this instance. </summary> <param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param> <returns> <c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>. </returns> </member> <member name="M:Sirenix.OdinInspector.Editor.TypeDrawerPair.op_Equality(Sirenix.OdinInspector.Editor.TypeDrawerPair,Sirenix.OdinInspector.Editor.TypeDrawerPair)"> <summary> Implements the operator ==. </summary> <param name="x">The x.</param> <param name="y">The y.</param> <returns> The result of the operator. </returns> </member> <member name="M:Sirenix.OdinInspector.Editor.TypeDrawerPair.op_Inequality(Sirenix.OdinInspector.Editor.TypeDrawerPair,Sirenix.OdinInspector.Editor.TypeDrawerPair)"> <summary> Implements the operator !=. </summary> <param name="x">The x.</param> <param name="y">The y.</param> <returns> The result of the operator. </returns> </member> <member name="T:Sirenix.OdinInspector.Editor.PropertyContext`1"> <summary> <para>A contextual value attached to an <see cref="T:Sirenix.OdinInspector.Editor.InspectorProperty"/>, mapped to a key, contained in a <see cref="T:Sirenix.OdinInspector.Editor.PropertyContextContainer"/>.</para> </summary> </member> <member name="F:Sirenix.OdinInspector.Editor.PropertyContext`1.Value"> <summary> The contained value. </summary> </member> <member name="M:Sirenix.OdinInspector.Editor.PropertyContext`1.Create"> <summary> Creates a new PropertyContext. </summary> </member> <member name="M:Sirenix.OdinInspector.Editor.PropertyContext`1.op_Explicit(Sirenix.OdinInspector.Editor.PropertyContext{`0})~`0"> <summary> Performs an explicit conversion from <see cref="T:Sirenix.OdinInspector.Editor.PropertyContext`1"/> to <see cref="!:T"/>. </summary> <param name="context">The context.</param> <returns> The result of the conversion. </returns> </member> <member name="M:Sirenix.OdinInspector.Editor.PropertyContext`1.ToString"> <summary> Returns a <see cref="T:System.String" /> that represents this instance, of the format "<see cref="T:Sirenix.OdinInspector.Editor.PropertyContext`1"/>: Value.ToString()". </summary> <returns> A <see cref="T:System.String" /> that represents this instance. </returns> </member> <member name="T:Sirenix.OdinInspector.Editor.PropertyContextContainer"> <summary> <para>Contains a context for an <see cref="T:Sirenix.OdinInspector.Editor.InspectorProperty"/>, which offers the ability to address persistent values by key across several editor GUI frames.</para> <para>Use this in drawers to store contextual editor-only values such as the state of a foldout.</para> </summary> </member> <member name="M:Sirenix.OdinInspector.Editor.PropertyContextContainer.#ctor(Sirenix.OdinInspector.Editor.InspectorProperty)"> <summary> Initializes a new instance of the <see cref="T:Sirenix.OdinInspector.Editor.PropertyContextContainer"/> class. </summary> <param name="property">The property.</param> <exception cref="T:System.ArgumentNullException">property</exception> </member> <member name="M:Sirenix.OdinInspector.Editor.PropertyContextContainer.GetGlobal``1(System.String,System.Func{``0})"> <summary> <para>Gets a global context value for a given key, using a given delegate to generate a default value if the context doesn't already exist.</para> <para>Global contexts are not associated with any one specific drawer, and so are shared across all drawers for this property.</para> </summary> <typeparam name="T">The type of the context value to get.</typeparam> <param name="key">The key of the context value to get.</param> <param name="getDefaultValue">A delegate for generating a default value.</param> <returns>The found context.</returns> </member> <member name="M:Sirenix.OdinInspector.Editor.PropertyContextContainer.GetGlobal``1(System.String,``0)"> <summary> <para>Ge