### GettingStartedWindow Class Definition Source: https://odininspector.com/documentation/sirenix.odininspector.editor.gettingstarted.gettingstartedwindow Defines the GettingStartedWindow class, inheriting from OdinEditorWindow and implementing ISerializationCallbackReceiver. This is the base structure for the Odin Inspector's getting started window. ```csharp public class GettingStartedWindow : OdinEditorWindow, ISerializationCallbackReceiver ``` -------------------------------- ### Check if Unity Package is Installed Source: https://odininspector.com/documentation/sirenix.utilities.editor.unitypackageutility Checks if a specific Unity package is installed and meets a minimum version requirement. Requires the package name and the minimum version. ```csharp public static bool HasPackageInstalled(string requiredPackage, Version minimumVersion) ``` -------------------------------- ### PostBuildAOTAutomation callbackOrder Property Source: https://odininspector.com/documentation/sirenix.serialization.internal.postbuildaotautomation Gets the callback order for the post-build automation process. ```csharp public int callbackOrder { get; } ``` -------------------------------- ### Default Field Source: https://odininspector.com/documentation/sirenix.serialization.dictionarykeyutility.keycomparer-1 Gets a default instance of the DictionaryKeyUtility.KeyComparer. ```APIDOC ## Default Field ### Description Gets a default instance of the DictionaryKeyUtility.KeyComparer. ### Field ```csharp public static readonly DictionaryKeyUtility.KeyComparer Default ``` ``` -------------------------------- ### Name Field Source: https://odininspector.com/documentation/sirenix.utilities.editor.slidepagenavigationhelper-1.page Gets or sets the name of the page. ```APIDOC ## Name Field ### Description Gets or sets the name of the page. ### Field Signature ```csharp public string Name ``` ``` -------------------------------- ### HasPackageInstalled Source: https://odininspector.com/documentation/sirenix.utilities.editor.unitypackageutility Checks if a specific Unity package is installed with a minimum version requirement. ```APIDOC ## HasPackageInstalled ### Description Checks if a specific Unity package is installed and meets the minimum version requirement. ### Method static bool ### Parameters #### Path Parameters - **requiredPackage** (string) - The name of the package to check. - **minimumVersion** (Version) - The minimum required version of the package. ### Returns #### Success Response - **bool** - True if the package is installed and meets the minimum version, false otherwise. ### Request Example ```csharp bool isInstalled = UnityPackageUtility.HasPackageInstalled("com.unity.textmeshpro", new Version(3, 0, 0)); ``` ### Response Example ```json { "isInstalled": true } ``` ``` -------------------------------- ### InheritAttributeAttributesAttributeProcessor Constructor Source: https://odininspector.com/documentation/sirenix.odininspector.editor.resolvers.inheritattributeattributesattributeprocessor Provides the default constructor for the InheritAttributeAttributesAttributeProcessor class. No specific setup is required to instantiate this processor. ```csharp public InheritAttributeAttributesAttributeProcessor() ``` -------------------------------- ### Current Property Source: https://odininspector.com/documentation/sirenix.utilities.editor.arrayslice-1.iterator Gets the current element in the iteration. ```APIDOC ## Current Property ### Description Gets the current element in the iteration. ### Property `Current` ### Returns - **T** - The current element in the iteration. ``` -------------------------------- ### BeginContainerCallback Event Source: https://odininspector.com/documentation/sirenix.reflection.editor.uielementsutility_internals An event that is invoked when a new IMGUIContainer begins its callback. Subscribers can hook into this to perform actions at the start of a container's lifecycle. ```APIDOC ## BeginContainerCallback ### Description An event that is invoked when a new IMGUIContainer begins its callback. Subscribers can hook into this to perform actions at the start of a container's lifecycle. ### Event Signature `public static event Action BeginContainerCallback` ``` -------------------------------- ### Open Method for OdinFeedbackWindow Source: https://odininspector.com/documentation/sirenix.odininspector.editor.windows.odinfeedbackwindow Opens the OdinFeedbackWindow to display feedback. It takes a product name and an array of metadata. ```csharp public static void Open(string product, params OdinFeedbackUtility.FeedbackMetaData[] metadata) ``` -------------------------------- ### GettingStartedWindow Methods Source: https://odininspector.com/documentation/sirenix.odininspector.editor.gettingstarted.gettingstartedwindow Lists the core methods of the GettingStartedWindow class: OnEnable, OnImGUI, ShowWindow, and Smoothstep. These methods handle the window's lifecycle, UI rendering, display, and utility calculations. ```csharp protected override void OnEnable() ``` ```csharp protected override void OnImGUI() ``` ```csharp public static void ShowWindow() ``` ```csharp public static float Smoothstep(float a, float b, float t) ``` -------------------------------- ### Open Source: https://odininspector.com/documentation/sirenix.odininspector.editor.windows.odinfeedbackwindow Opens the OdinFeedbackWindow to display feedback options. ```APIDOC ## Open(string product, params OdinFeedbackUtility.FeedbackMetaData[] metadata) ### Description Opens the OdinFeedbackWindow, allowing users to provide feedback for a specific product with associated metadata. ### Method Static Method ### Parameters #### Path Parameters - **product** (string) - Description of the product for which feedback is being provided. - **metadata** (OdinFeedbackUtility.FeedbackMetaData[]) - An array of metadata associated with the feedback. ``` -------------------------------- ### OdinFeedbackWindow Constructor Source: https://odininspector.com/documentation/sirenix.odininspector.editor.windows.odinfeedbackwindow Initializes a new instance of the OdinFeedbackWindow class. ```APIDOC ## OdinFeedbackWindow() ### Description Initializes a new instance of the OdinFeedbackWindow class. ### Method Constructor ### Parameters None ``` -------------------------------- ### Expressionator.ValueType Source: https://odininspector.com/documentation/sirenix.utilities.editor.expressions.internal.expressionator Gets the type of the value associated with the Expressionator. ```APIDOC ## ValueType ### Description Gets the type of the value associated with the Expressionator. This property provides information about the data type of the main value. ### Type System.Type ``` -------------------------------- ### GettingStartedWindow Methods Source: https://odininspector.com/documentation/sirenix.odininspector.editor.gettingstarted.gettingstartedwindow Public methods available on the GettingStartedWindow class. ```APIDOC ## ShowWindow() ### Description Displays the Getting Started window. ### Method `public static void ShowWindow()` ``` ```APIDOC ## Smoothstep(Single, Single, Single) ### Description Performs a smooth interpolation between two values. ### Method `public static float Smoothstep(float a, float b, float t)` ### Parameters #### Path Parameters - **a** (System.Single) - The first value. - **b** (System.Single) - The second value. - **t** (System.Single) - The interpolation factor. ``` -------------------------------- ### Expressionator.Context Source: https://odininspector.com/documentation/sirenix.utilities.editor.expressions.internal.expressionator Gets the context dictionary associated with the Expressionator. ```APIDOC ## Context ### Description Gets the context dictionary associated with the Expressionator. This dictionary can be used to store and retrieve values used in expressions. ### Type System.Collections.Generic.Dictionary ``` -------------------------------- ### GettingStartedWindow Constructors Source: https://odininspector.com/documentation/sirenix.odininspector.editor.gettingstarted.gettingstartedwindow Initializes a new instance of the GettingStartedWindow class. ```APIDOC ## GettingStartedWindow() ### Description Initializes a new instance of the `GettingStartedWindow` class. ### Method Constructor ### Endpoint N/A ``` -------------------------------- ### BeginPage Method Source: https://odininspector.com/documentation/sirenix.utilities.editor.slidepagenavigationhelper-1.page Begins the display of the page, returning true if the page should be displayed. ```APIDOC ## BeginPage Method ### Description Begins the display of the page. This method should be called before rendering the content of the page. ### Method Signature ```csharp public bool BeginPage() ``` ### Returns * **bool** - True if the page should be displayed, false otherwise. ``` -------------------------------- ### OdinImGuiElement Constructors Source: https://odininspector.com/documentation/sirenix.odininspector.editor.internal.uitoolkitintegration.odinimguielement Provides documentation for the constructors of the OdinImGuiElement class, detailing how to initialize an OdinImGuiElement with a SerializedProperty or a VisualElement. ```APIDOC ## OdinImGuiElement Constructors ### OdinImGuiElement(SerializedProperty) Initializes a new instance of the `OdinImGuiElement` class with a `SerializedProperty`. #### Parameters - **unityProperty** (SerializedProperty) - The `SerializedProperty` to associate with this element. ### OdinImGuiElement(VisualElement) Initializes a new instance of the `OdinImGuiElement` class with a `VisualElement`. #### Parameters - **element** (VisualElement) - The `VisualElement` to use for this element. ### OdinImGuiElement(VisualElement, SerializedProperty) Initializes a new instance of the `OdinImGuiElement` class with a `VisualElement` and a `SerializedProperty`. #### Parameters - **element** (VisualElement) - The `VisualElement` to use for this element. - **unityProperty** (SerializedProperty) - The `SerializedProperty` to associate with this element. ``` -------------------------------- ### Validator Property Source: https://odininspector.com/documentation/sirenix.odininspector.editor.validation.validator Gets the InspectorProperty associated with this validator. ```csharp public InspectorProperty Property { get; } ``` -------------------------------- ### StructArrayToBytes Method Signature (existing array) Source: https://odininspector.com/documentation/sirenix.utilities.unsafe.unsafeutilities Converts an array of structs to a byte array, writing into a provided byte array starting at a specified offset. This can be more efficient by reusing existing buffers. ```csharp public static byte[] StructArrayToBytes(T[] array, ref byte[] bytes, int byteOffset) where T : struct ``` -------------------------------- ### GUILayoutOptionsInstance Methods Source: https://odininspector.com/documentation/sirenix.utilities.guilayoutoptions.guilayoutoptionsinstance This section details the methods available on the GUILayoutOptionsInstance class for configuring layout properties. ```APIDOC ## Equals(GUILayoutOptions.GUILayoutOptionsInstance) ### Description Determines whether the instance is equal to another instance. ### Method public bool Equals(GUILayoutOptions.GUILayoutOptionsInstance other) ### Parameters #### Other Instance - **other** (GUILayoutOptions.GUILayoutOptionsInstance) - The instance to compare with. ### Returns System.Boolean - True if the instances are equal, false otherwise. ``` ```APIDOC ## ExpandHeight(Boolean) ### Description Option passed to a control to allow or disallow vertical expansion. ### Method public GUILayoutOptions.GUILayoutOptionsInstance ExpandHeight(bool expand = true) ### Parameters #### Expand - **expand** (Boolean) - Whether to allow vertical expansion. Defaults to true. ### Returns GUILayoutOptions.GUILayoutOptionsInstance - The current instance for fluent chaining. ``` ```APIDOC ## ExpandWidth(Boolean) ### Description Option passed to a control to allow or disallow horizontal expansion. ### Method public GUILayoutOptions.GUILayoutOptionsInstance ExpandWidth(bool expand = true) ### Parameters #### Expand - **expand** (Boolean) - Whether to allow horizontal expansion. Defaults to true. ### Returns GUILayoutOptions.GUILayoutOptionsInstance - The current instance for fluent chaining. ``` ```APIDOC ## GetHashCode() ### Description Returns a hash code for this instance. ### Method public override int GetHashCode() ### Returns System.Int32 - A hash code for this instance. ``` ```APIDOC ## Height(Single) ### Description Option passed to a control to give it an absolute height. ### Method public GUILayoutOptions.GUILayoutOptionsInstance Height(float height) ### Parameters #### Height - **height** (Single) - The absolute height for the control. ### Returns GUILayoutOptions.GUILayoutOptionsInstance - The current instance for fluent chaining. ``` ```APIDOC ## MaxHeight(Single) ### Description Option passed to a control to specify a maximum height. ### Method public GUILayoutOptions.GUILayoutOptionsInstance MaxHeight(float height) ### Parameters #### Height - **height** (Single) - The maximum height for the control. ### Returns GUILayoutOptions.GUILayoutOptionsInstance - The current instance for fluent chaining. ``` ```APIDOC ## MaxWidth(Single) ### Description Option passed to a control to specify a maximum width. ### Method public GUILayoutOptions.GUILayoutOptionsInstance MaxWidth(float width) ### Parameters #### Width - **width** (Single) - The maximum width for the control. ### Returns GUILayoutOptions.GUILayoutOptionsInstance - The current instance for fluent chaining. ``` ```APIDOC ## MinHeight(Single) ### Description Option passed to a control to specify a minimum height. ### Method public GUILayoutOptions.GUILayoutOptionsInstance MinHeight(float height) ### Parameters #### Height - **height** (Single) - The minimum height for the control. ### Returns GUILayoutOptions.GUILayoutOptionsInstance - The current instance for fluent chaining. ``` ```APIDOC ## MinWidth(Single) ### Description Option passed to a control to specify a minimum width. ### Method public GUILayoutOptions.GUILayoutOptionsInstance MinWidth(float width) ### Parameters #### Width - **width** (Single) - The minimum width for the control. ### Returns GUILayoutOptions.GUILayoutOptionsInstance - The current instance for fluent chaining. ``` ```APIDOC ## Width(Single) ### Description Option passed to a control to give it an absolute width. ### Method public GUILayoutOptions.GUILayoutOptionsInstance Width(float width) ### Parameters #### Width - **width** (Single) - The absolute width for the control. ### Returns GUILayoutOptions.GUILayoutOptionsInstance - The current instance for fluent chaining. ``` -------------------------------- ### ListIterator.GetEnumerator Method Source: https://odininspector.com/documentation/sirenix.utilities.garbagefreeiterators.listiterator-1 Gets the enumerator for the list iterator. ```APIDOC ## GetEnumerator() ### Description Gets the enumerator. ### Methods - **GetEnumerator()** - Returns the enumerator for the list iterator. ### Returns - **GarbageFreeIterators.ListIterator** - The enumerator. ``` -------------------------------- ### ListIterator.Current Property Source: https://odininspector.com/documentation/sirenix.utilities.garbagefreeiterators.listiterator-1 Gets the current element in the iteration. ```APIDOC ## Current ### Description Gets the current value. ### Properties - **Current** (T) - The current element in the iteration. ``` -------------------------------- ### BeginPage Method Source: https://odininspector.com/documentation/sirenix.utilities.editor.slidepagenavigationhelper-1.page Begins the page navigation process. Returns a boolean indicating success. ```csharp public bool BeginPage() ``` -------------------------------- ### Value Field Source: https://odininspector.com/documentation/sirenix.utilities.editor.slidepagenavigationhelper-1.page Gets or sets the value associated with the page. ```APIDOC ## Value Field ### Description Gets or sets the value associated with the page. ### Field Signature ```csharp public T Value ``` ``` -------------------------------- ### Create Method Signature Source: https://odininspector.com/documentation/sirenix.odininspector.editor.internal.uitoolkitintegration.imguielementutils.imguivisualelementlayoutentry Defines the static Create method for ImGuiVisualElementLayoutEntry, which takes an OdinImGuiElement and returns a GUILayoutEntry_Internal. ```csharp public static GUILayoutEntry_Internal Create(OdinImGuiElement element) ``` -------------------------------- ### ImmutableList Indexer Source: https://odininspector.com/documentation/sirenix.serialization.utilities.immutablelist-1 Gets the element at the specified index in the ImmutableList. ```csharp public T this[int index] { get; } ``` -------------------------------- ### ExampleAsComponentDataAttribute Constructor Source: https://odininspector.com/documentation/sirenix.odininspector.editor.examples.internal.exampleascomponentdataattribute The default constructor for the ExampleAsComponentDataAttribute class. ```csharp public ExampleAsComponentDataAttribute() ``` -------------------------------- ### Expressionator.Item[String] Source: https://odininspector.com/documentation/sirenix.utilities.editor.expressions.internal.expressionator Gets the value of an expression by its string key. ```APIDOC ## Item[String] ### Description Gets the value of an expression by its string key. This allows for retrieving evaluated expression results using a string identifier. ### Parameters - **expression** (System.String) - The string key of the expression to retrieve. ### Type System.Object ``` -------------------------------- ### TryGetSettings Method Source: https://odininspector.com/documentation/sirenix.config.typesettings Attempts to retrieve the custom settings for a given type. Returns the settings if found, otherwise null. ```csharp public TypeSettings TryGetSettings(Type type) ``` -------------------------------- ### ImmutableList.Count Property Source: https://odininspector.com/documentation/sirenix.serialization.utilities.immutablelist-1 Gets the number of elements contained in the ImmutableList. ```APIDOC ## Count Property ### Description Gets the number of elements contained in the ImmutableList. ### Returns (System.Int32) - The number of elements in the list. ``` -------------------------------- ### KeyComparer() Constructor Source: https://odininspector.com/documentation/sirenix.serialization.dictionarykeyutility.keycomparer-1 Initializes a new instance of the DictionaryKeyUtility.KeyComparer class. ```APIDOC ## KeyComparer() ### Description Initializes a new instance of the DictionaryKeyUtility.KeyComparer class. ### Method ```csharp public KeyComparer() ``` ``` -------------------------------- ### ImmutableList Count Property Source: https://odininspector.com/documentation/sirenix.serialization.utilities.immutablelist-1 Gets the number of elements contained in the ImmutableList. ```csharp public int Count { get; } ``` -------------------------------- ### Expressionator.Value Source: https://odininspector.com/documentation/sirenix.utilities.editor.expressions.internal.expressionator Gets or sets the main object value associated with the Expressionator. ```APIDOC ## Value ### Description Gets or sets the main object value associated with the Expressionator. This property holds the primary data that expressions will operate on. ### Type System.Object ``` -------------------------------- ### MetaData Constructor Source: https://odininspector.com/documentation/sirenix.odininspector.editor.validation.validator.metadata Initializes a new instance of the MetaData class. ```APIDOC ## MetaData() ### Description Initializes a new instance of the `MetaData` class. ### Method Constructor ### Endpoint N/A ``` -------------------------------- ### Expressionator ValueType Property Source: https://odininspector.com/documentation/sirenix.utilities.editor.expressions.internal.expressionator Gets the type of the Expressionator's value. ```csharp public Type ValueType { get; } ``` -------------------------------- ### Create(OdinImGuiElement) Source: https://odininspector.com/documentation/sirenix.odininspector.editor.internal.uitoolkitintegration.imguielementutils.imguivisualelementlayoutentry Creates a GUILayoutEntry_Internal for an OdinImGuiElement, facilitating its layout within the ImGui visual element system. ```APIDOC ## Create(OdinImGuiElement) ### Description Creates a layout entry for an ImGui visual element. ### Method static ### Signature public static GUILayoutEntry_Internal Create(OdinImGuiElement element) ### Parameters #### Parameters - **element** (OdinImGuiElement) - The ImGui element to create a layout entry for. ### Returns GUILayoutEntry_Internal - The created layout entry. ``` -------------------------------- ### Expressionator Value Property Source: https://odininspector.com/documentation/sirenix.utilities.editor.expressions.internal.expressionator Gets or sets the main value of the Expressionator. ```csharp public object Value { get; set; } ``` -------------------------------- ### OdinImGuiElement Constructor with VisualElement and SerializedProperty Source: https://odininspector.com/documentation/sirenix.odininspector.editor.internal.uitoolkitintegration.odinimguielement Initializes a new instance of the OdinImGuiElement class with both a VisualElement and a SerializedProperty. This constructor provides a comprehensive way to set up the element. ```csharp public OdinImGuiElement(VisualElement element, SerializedProperty unityProperty) ``` -------------------------------- ### Creator Constructor Source: https://odininspector.com/documentation/sirenix.odininspector.editor.typesearch.nestedinsamegenerictypetypematcher.creator Initializes a new instance of the Creator class. ```APIDOC ## Creator() ### Description Initializes a new instance of the `NestedInSameGenericTypeTypeMatcher.Creator` class. ### Method Constructor ### Parameters None ``` -------------------------------- ### Get Current Element in Iterator Source: https://odininspector.com/documentation/sirenix.utilities.editor.arrayslice-1.iterator Retrieves the current element during iteration. ```csharp public T Current { get; } ``` -------------------------------- ### TypeMatchCacheSignatureEqualityComparer.GetHashCode Method Source: https://odininspector.com/documentation/sirenix.odininspector.editor.typesearch.typesearchindex.typematchcachesignatureequalitycomparer Gets the hash code for the specified TypeMatchQuery object. ```APIDOC ## GetHashCode(TypeSearchIndex.TypeMatchQuery) ### Description Gets the hash code for the specified TypeMatchQuery object. ### Method Public Method ### Endpoint N/A ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Parameters - **obj** (TypeSearchIndex.TypeMatchQuery) - Description not available ### Request Example None ### Response #### Success Response (200) - **return value** (System.Int32) - Description not available #### Response Example None ``` -------------------------------- ### ExampleAsComponentDataAttribute Namespaces Field Source: https://odininspector.com/documentation/sirenix.odininspector.editor.examples.internal.exampleascomponentdataattribute Represents the Namespaces field of the ExampleAsComponentDataAttribute class. ```csharp public string[] Namespaces ``` -------------------------------- ### PostBuildAOTAutomation OnPostprocessBuild Method (BuildTarget, String) Source: https://odininspector.com/documentation/sirenix.serialization.internal.postbuildaotautomation Handles the post-build processing with build target and path information. ```csharp public void OnPostprocessBuild(BuildTarget target, string path) ``` -------------------------------- ### ExactTypeMatcher.Creator Constructors Source: https://odininspector.com/documentation/sirenix.odininspector.editor.typesearch.exacttypematcher.creator Provides documentation for the constructors available in the ExactTypeMatcher.Creator class. ```APIDOC ## Creator() ### Description Initializes a new instance of the `ExactTypeMatcher.Creator` class. ### Method Constructor ### Returns An instance of `ExactTypeMatcher.Creator`. ``` -------------------------------- ### ImmutableList.Item[Int32] Property Source: https://odininspector.com/documentation/sirenix.serialization.utilities.immutablelist-1 Gets the element at the specified index in the ImmutableList. ```APIDOC ## Item[Int32] Property ### Description Gets the element at the specified index in the ImmutableList. ### Parameters - **index** (System.Int32) - The zero-based index of the element to get. ### Returns (T) - The element at the specified index. ``` -------------------------------- ### TypeRegistryUserConfig Constructor Source: https://odininspector.com/documentation/sirenix.config.typesettings Initializes a new instance of the TypeRegistryUserConfig class. ```APIDOC ## TypeRegistryUserConfig() ### Description Initializes a new instance of the TypeRegistryUserConfig class. ### Method Constructor ### Parameters None ``` -------------------------------- ### ImmutableList.IsReadOnly Property Source: https://odininspector.com/documentation/sirenix.serialization.utilities.immutablelist-1 Gets a value indicating whether the ImmutableList is read-only. ```APIDOC ## IsReadOnly Property ### Description Gets a value indicating whether the ImmutableList is read-only. ### Returns (System.Boolean) - True if the list is read-only; otherwise, false. ``` -------------------------------- ### ImmutableList IsReadOnly Property Source: https://odininspector.com/documentation/sirenix.serialization.utilities.immutablelist-1 Gets a value indicating whether the ImmutableList is read-only. ```csharp public bool IsReadOnly { get; } ``` -------------------------------- ### GettingStartedWindow Fields Source: https://odininspector.com/documentation/sirenix.odininspector.editor.gettingstarted.gettingstartedwindow Public fields available on the GettingStartedWindow class. ```APIDOC ## HorizontalSlideT ### Description Represents the horizontal slide transition value. ### Type `float` ``` ```APIDOC ## Pages ### Description Contains the list of pages to be displayed in the Getting Started window. ### Type `List` ``` ```APIDOC ## VerticalSlideT ### Description Represents the vertical slide transition value. ### Type `float` ``` -------------------------------- ### Expressionator Item Property Source: https://odininspector.com/documentation/sirenix.utilities.editor.expressions.internal.expressionator Gets the value associated with a given expression string. ```csharp public object this[string expression] { get; } ``` -------------------------------- ### MetaData Constructor Source: https://odininspector.com/documentation/sirenix.odininspector.editor.validation.validator.metadata Initializes a new instance of the MetaData class. This is the default constructor and does not require any parameters. ```csharp public MetaData() ``` -------------------------------- ### Page Constructor Source: https://odininspector.com/documentation/sirenix.utilities.editor.slidepagenavigationhelper-1.page Initializes a new instance of the Page class with the specified object, tab, and name. ```APIDOC ## Page Constructor ### Description Initializes a new instance of the Page class with the specified object, tab, and name. ### Method Signature ```csharp public Page(T object, GUITabPage tab, string name) ``` ### Parameters * **object** (T) - The object associated with this page. * **tab** (GUITabPage) - The tab page this page belongs to. * **name** (string) - The name of the page. ``` -------------------------------- ### OdinImGuiElement Constructor with VisualElement Source: https://odininspector.com/documentation/sirenix.odininspector.editor.internal.uitoolkitintegration.odinimguielement Initializes a new instance of the OdinImGuiElement class with a specified VisualElement. This constructor is useful for creating elements that are part of a larger UI structure. ```csharp public OdinImGuiElement(VisualElement element) ``` -------------------------------- ### Validator RevalidationCriteria Source: https://odininspector.com/documentation/sirenix.odininspector.editor.validation.validator Gets the criteria for revalidating the property. Can be overridden in derived classes. ```csharp public virtual RevalidationCriteria RevalidationCriteria { get; } ``` -------------------------------- ### Handle Constructor Source: https://odininspector.com/documentation/sirenix.odininspector.editor.unitypropertyemitter.handle Initializes a new instance of the UnityPropertyEmitter.Handle class, representing a Unity property and a collection of associated objects. ```APIDOC ## Handle Constructor ### Description Initializes a new instance of the UnityPropertyEmitter.Handle class. ### Method Constructor ### Parameters #### Parameters - **unityProperty** (SerializedProperty) - Required - The unity property to represent. - **objects** (Object[]) - Required - The objects to represent. ``` -------------------------------- ### EmptyAOTEmittedFormatter Constructor Source: https://odininspector.com/documentation/sirenix.serialization.formatteremitter.emptyaotemittedformatter-1 The protected constructor for the EmptyAOTEmittedFormatter class. No specific setup is required. ```csharp protected EmptyAOTEmittedFormatter() ``` -------------------------------- ### Page Constructor Source: https://odininspector.com/documentation/sirenix.utilities.editor.slidepagenavigationhelper-1.page Initializes a new instance of the Page class with the specified object, tab, and name. ```csharp public Page(T object, GUITabPage tab, string name) ``` -------------------------------- ### Get Default KeyComparer Instance Source: https://odininspector.com/documentation/sirenix.serialization.dictionarykeyutility.keycomparer-1 Accesses the static readonly default instance of the KeyComparer. ```csharp public static readonly DictionaryKeyUtility.KeyComparer Default ``` -------------------------------- ### GUIView_Internals.Current.HasFocus Source: https://odininspector.com/documentation/sirenix.reflection.editor.guiview_internals.current Gets a boolean value indicating whether the current GUI view has focus. ```APIDOC ## GUIView_Internals.Current.HasFocus ### Description Gets a boolean value indicating whether the current GUI view has focus. ### Property `HasFocus` ### Type `bool` ### Access `public static` ``` -------------------------------- ### GettingStartedWindow Properties Source: https://odininspector.com/documentation/sirenix.odininspector.editor.gettingstarted.gettingstartedwindow Public properties of the GettingStartedWindow class. ```APIDOC ## OdinBg ### Description Gets a texture of an Odin bg symbol. ### Type `Texture2D` ### Access Static Readonly ``` -------------------------------- ### InterpolatedVector2 Reset Methods Source: https://odininspector.com/documentation/sirenix.odininspector.editor.internal.sirenixanimationutility.interpolatedvector2 Resets the interpolation, optionally setting a new starting point. ```csharp public void Reset() ``` ```csharp public void Reset(Vector2 start) ``` -------------------------------- ### ExampleAsComponentDataAttribute Class Declaration Source: https://odininspector.com/documentation/sirenix.odininspector.editor.examples.internal.exampleascomponentdataattribute Defines the ExampleAsComponentDataAttribute class, which inherits from System.Attribute. ```csharp public class ExampleAsComponentDataAttribute : Attribute, _Attribute ``` -------------------------------- ### OdinFeedbackWindow Constructor Source: https://odininspector.com/documentation/sirenix.odininspector.editor.windows.odinfeedbackwindow The default constructor for the OdinFeedbackWindow class. ```csharp public OdinFeedbackWindow() ``` -------------------------------- ### GetHashCode Method for TypeMatchQuery Source: https://odininspector.com/documentation/sirenix.odininspector.editor.typesearch.typesearchindex.typematchcachesignatureequalitycomparer Gets the hash code for a TypeMatchQuery object. This method is part of the IEqualityComparer interface implementation. ```csharp public int GetHashCode(TypeSearchIndex.TypeMatchQuery obj) ``` -------------------------------- ### GettingStartedWindow Constructor Source: https://odininspector.com/documentation/sirenix.odininspector.editor.gettingstarted.gettingstartedwindow The default constructor for the GettingStartedWindow class. It is used to initialize a new instance of the window. ```csharp public GettingStartedWindow() ``` -------------------------------- ### ImmutableList CopyTo Method Source: https://odininspector.com/documentation/sirenix.serialization.utilities.immutablelist-1 Copies the entire ImmutableList to a compatible one-dimensional array, starting at the specified index of the target array. ```csharp public void CopyTo(T[] array, int arrayIndex) ``` -------------------------------- ### GUILayoutOptionsInstance Operators Source: https://odininspector.com/documentation/sirenix.utilities.guilayoutoptions.guilayoutoptionsinstance This section details the operators available on the GUILayoutOptionsInstance class. ```APIDOC ## Implicit(GUILayoutOptions.GUILayoutOptionsInstance to GUILayoutOption[]) ### Description Gets or creates the cached GUILayoutOption array based on the layout options specified. ### Method public static implicit operator GUILayoutOption[](GUILayoutOptions.GUILayoutOptionsInstance options) ### Parameters #### Options - **options** (GUILayoutOptions.GUILayoutOptionsInstance) - The GUILayoutOptionsInstance to convert. ### Returns UnityEngine.GUILayoutOption[] - The converted GUILayoutOption array. ``` -------------------------------- ### Get Parent Value Source: https://odininspector.com/documentation/sirenix.odininspector.editor.valueresolvers.valueresolvercontext Retrieves the parent value based on the selection index. This is used to access context provided by parent resolvers. ```csharp public object GetParentValue(int selectionIndex) ``` -------------------------------- ### ModuleFile Constructors Source: https://odininspector.com/documentation/sirenix.odininspector.editor.modules.moduledata.modulefile Provides documentation for the constructors of the ModuleFile class. ```APIDOC ## ModuleFile() ### Description Initializes a new instance of the ModuleFile class. ### Method Constructor ### Parameters None ``` -------------------------------- ### StructArrayToBytes (overload 2) Source: https://odininspector.com/documentation/sirenix.utilities.unsafe.unsafeutilities Serializes an array of structs into a provided byte array, starting at a specified offset. Returns the byte array. ```APIDOC ## StructArrayToBytes(T[], ref Byte[], Int32) ### Description Serializes an array of structs into a provided byte array, starting at a specified offset. Returns the byte array. ### Method static byte[] ### Type Parameters - **T** - The struct type. ### Parameters #### Path Parameters - **array** (T[]) - The array of structs to serialize. - **bytes** (ref System.Byte[]) - The byte array to write to. This array may be resized if it's too small. - **byteOffset** (System.Int32) - The offset in the byte array where the serialization should begin. ``` -------------------------------- ### GettingStartedWindow Properties Source: https://odininspector.com/documentation/sirenix.odininspector.editor.gettingstarted.gettingstartedwindow Defines the OdinBg static property, which returns a Texture2D of the Odin background symbol. This property is used for visual elements within the editor window. ```csharp public static Texture2D OdinBg { get; } ``` -------------------------------- ### Get Valid Attribute Targets Source: https://odininspector.com/documentation/sirenix.odininspector.editor.drawerutilities.invalidattributetargetutility Retrieves a list of valid target types for a given attribute type. Use this to check compatibility before applying an attribute. ```csharp public static List GetValidTargets(Type attribute) ``` -------------------------------- ### ShowIfAttributeStateUpdater Initialize Method Source: https://odininspector.com/documentation/sirenix.odininspector.editor.stateupdaters.showifattributestateupdater Overrides the Initialize method from the base class. ```csharp protected override void Initialize() ``` -------------------------------- ### GUILayoutUtility_Internals.TopLevel.GetNext Source: https://odininspector.com/documentation/sirenix.reflection.editor.guilayoututility_internals.toplevel Retrieves the next available GUI layout entry. ```APIDOC ## GUILayoutUtility_Internals.TopLevel.GetNext() ### Description Gets the next available GUI layout entry from the internal pool. ### Method `public static GUILayoutEntry_Internal GetNext()` ### Returns - **Type**: `GUILayoutEntry_Internal` - **Description**: The next GUI layout entry. ``` -------------------------------- ### ImmutableList.CopyTo(T[] array, Int32 arrayIndex) Method Source: https://odininspector.com/documentation/sirenix.serialization.utilities.immutablelist-1 Copies the entire ImmutableList to a compatible one-dimensional array, starting at the specified index of the target array. ```APIDOC ## CopyTo(T[] array, Int32 arrayIndex) Method ### Description Copies the entire ImmutableList to a compatible one-dimensional array, starting at the specified index of the target array. ### Parameters - **array** (T[]) - The one-dimensional System.Array that is the destination of the elements copied from ImmutableList. Must have zero-based indexing. - **arrayIndex** (System.Int32) - The zero-based index in array at which copying begins. ``` -------------------------------- ### StructArrayFromBytes Method Signature (with offset) Source: https://odininspector.com/documentation/sirenix.utilities.unsafe.unsafeutilities Converts a byte array to an array of structs, starting from a specified byte offset. Useful when the struct data is not at the beginning of the byte array. ```csharp public static T[] StructArrayFromBytes(byte[] bytes, int byteLength, int byteOffset) where T : struct ``` -------------------------------- ### PostBuildAOTAutomation OnPostprocessBuild Method (BuildReport) Source: https://odininspector.com/documentation/sirenix.serialization.internal.postbuildaotautomation Handles the post-build processing when a BuildReport is available. ```csharp public void OnPostprocessBuild(BuildReport report) ``` -------------------------------- ### Handle Constructor Source: https://odininspector.com/documentation/sirenix.odininspector.editor.unitypropertyemitter.handle Initializes a new instance of the Handle class, associating it with a SerializedProperty and an array of Unity objects. ```csharp public Handle(SerializedProperty unityProperty, Object[] objects) ``` -------------------------------- ### Instantiate DictionaryKeyUtility.KeyComparer Source: https://odininspector.com/documentation/sirenix.serialization.dictionarykeyutility.keycomparer-1 Provides the default static readonly instance of the KeyComparer. ```csharp public KeyComparer() ``` -------------------------------- ### ModuleManager PackageAllModules Method Source: https://odininspector.com/documentation/sirenix.odininspector.editor.modules.modulemanager Packages all currently loaded modules. This is typically used for deployment or distribution. ```csharp public void PackageAllModules() ``` -------------------------------- ### GUILayoutOptionsInstance Class Definition Source: https://odininspector.com/documentation/sirenix.utilities.guilayoutoptions.guilayoutoptionsinstance Defines the GUILayoutOptionsInstance class, which implements IEquatable for comparing layout option instances. ```csharp public sealed class GUILayoutOptionsInstance : IEquatable ``` -------------------------------- ### PopulateGenericMenu Method Source: https://odininspector.com/documentation/sirenix.odininspector.editor.drawers.vector4drawer Implements the PopulateGenericMenu method to add custom options to the property's context menu. ```csharp public void PopulateGenericMenu(InspectorProperty property, GenericMenu genericMenu) ``` -------------------------------- ### ModuleNotFoundException Constructor Source: https://odininspector.com/documentation/sirenix.odininspector.editor.modules.modulemanager.modulenotfoundexception Initializes a new instance of the ModuleNotFoundException class with a specified module ID. ```APIDOC ## ModuleNotFoundException(String) ### Description Initializes a new instance of the ModuleNotFoundException class with a specified module ID. ### Method Constructor ### Parameters - **moduleId** (System.String) - The ID of the module that was not found. ``` -------------------------------- ### Equals Method Source: https://odininspector.com/documentation/sirenix.utilities.guilayoutoptions.guilayoutoptionsinstance Determines whether the current GUILayoutOptionsInstance is equal to another instance. This method is useful for comparing layout configurations. ```csharp public bool Equals(GUILayoutOptions.GUILayoutOptionsInstance other) ``` -------------------------------- ### ExampleAsComponentDataAttribute AttributeDeclarations Field Source: https://odininspector.com/documentation/sirenix.odininspector.editor.examples.internal.exampleascomponentdataattribute Represents the AttributeDeclarations field of the ExampleAsComponentDataAttribute class. ```csharp public string[] AttributeDeclarations ``` -------------------------------- ### Creator Constructor Source: https://odininspector.com/documentation/sirenix.odininspector.editor.typesearch.targetssatisfygenericparameterconstraintstypematcher.creator Initializes a new instance of the TargetsSatisfyGenericParameterConstraintsTypeMatcher.Creator class. ```APIDOC ## Creator() ### Description Initializes a new instance of the TargetsSatisfyGenericParameterConstraintsTypeMatcher.Creator class. ### Method Creator() ### Parameters None ``` -------------------------------- ### WrapAttributeInt16Drawer Constructor Source: https://odininspector.com/documentation/sirenix.odininspector.editor.wrapattributeint16drawer Initializes a new instance of the WrapAttributeInt16Drawer class. ```csharp public WrapAttributeInt16Drawer() ``` -------------------------------- ### SerializedData Constructor Source: https://odininspector.com/documentation/sirenix.config.serializedtypeprioritydictionary.serializeddata Initializes a new instance of the SerializedData class. ```APIDOC ## SerializedData() ### Description Initializes a new instance of the SerializedData class. ### Method Constructor ### Parameters None ### Response Initializes a new SerializedData object. ``` -------------------------------- ### PostBuildAOTAutomation Constructor Source: https://odininspector.com/documentation/sirenix.serialization.internal.postbuildaotautomation The default constructor for the PostBuildAOTAutomation class. ```csharp public PostBuildAOTAutomation() ``` -------------------------------- ### TopLevel Properties Source: https://odininspector.com/documentation/sirenix.reflection.editor.guilayoututility_internals.toplevel Provides static properties for accessing cursor, layout state, and GUI style information. ```csharp public static int Cursor { get; } ``` ```csharp public static bool HasTopLevel { get; } ``` ```csharp public static Rect Rect { get; } ``` ```csharp public static GUIStyle Style { get; } ``` ```csharp public static GUILayoutGroup_Internal TopLevelGroup { get; } ``` -------------------------------- ### MinWidth Method Source: https://odininspector.com/documentation/sirenix.utilities.guilayoutoptions.guilayoutoptionsinstance Specifies the minimum allowed width for a GUI control. This ensures the control has a certain width. ```csharp public GUILayoutOptions.GUILayoutOptionsInstance MinWidth(float width) ``` -------------------------------- ### Width Method Source: https://odininspector.com/documentation/sirenix.utilities.guilayoutoptions.guilayoutoptionsinstance Sets an absolute width for a GUI control. Use this when a fixed width is required. ```csharp public GUILayoutOptions.GUILayoutOptionsInstance Width(float width) ``` -------------------------------- ### GUILayoutUtility_Internals.TopLevel.Add Source: https://odininspector.com/documentation/sirenix.reflection.editor.guilayoututility_internals.toplevel Adds a GUI layout entry to the top-level layout. ```APIDOC ## GUILayoutUtility_Internals.TopLevel.Add(GUILayoutEntry_Internal) ### Description Adds a GUI layout entry of a specific type to the internal top-level layout. ### Method `public static void Add(GUILayoutEntry_Internal e)` ### Type Parameters - **T**: The type of the GUI layout entry, constrained to be a class. ### Parameters - **e** (`GUILayoutEntry_Internal`): The GUI layout entry to add. ``` -------------------------------- ### Create a Successful FeedbackReply Source: https://odininspector.com/documentation/sirenix.odininspector.editor.windows.odinfeedbackutility.feedbackreply Static method to create a FeedbackReply instance indicating success. ```csharp public static OdinFeedbackUtility.FeedbackReply Success() ``` -------------------------------- ### ImGuiVisualElementLayoutEntry Class Declaration Source: https://odininspector.com/documentation/sirenix.odininspector.editor.internal.uitoolkitintegration.imguielementutils.imguivisualelementlayoutentry Declares the static class ImGuiVisualElementLayoutEntry. ```csharp public static class ImGuiVisualElementLayoutEntry ``` -------------------------------- ### DerivedTypeMatcher.Creator Constructor Source: https://odininspector.com/documentation/sirenix.odininspector.editor.typesearch.derivedtypematcher.creator Initializes a new instance of the DerivedTypeMatcher.Creator class. ```APIDOC ## Creator() ### Description Initializes a new instance of the DerivedTypeMatcher.Creator class. ### Method Constructor ### Parameters None ``` -------------------------------- ### TryGetSettings(Type) Source: https://odininspector.com/documentation/sirenix.config.typesettings Attempts to retrieve the custom settings for a specific type. ```APIDOC ## TryGetSettings(Type) ### Description Attempts to retrieve the custom settings for a specific type. ### Method TryGetSettings ### Parameters - **type** (System.Type): The type for which to retrieve settings. ### Returns TypeSettings: The settings for the type, or null if no custom settings are found. ``` -------------------------------- ### Declare UnityPackageUtility Class Source: https://odininspector.com/documentation/sirenix.utilities.editor.unitypackageutility Defines the static UnityPackageUtility class. This class is part of the Sirenix.Utilities.Editor namespace. ```csharp public static class UnityPackageUtility ``` -------------------------------- ### OdinImGuiElement Constructor with SerializedProperty Source: https://odininspector.com/documentation/sirenix.odininspector.editor.internal.uitoolkitintegration.odinimguielement Initializes a new instance of the OdinImGuiElement class with a specified SerializedProperty. This constructor is used when the element needs to represent a specific Unity property. ```csharp public OdinImGuiElement(SerializedProperty unityProperty) ``` -------------------------------- ### Add Generic Entry Method Source: https://odininspector.com/documentation/sirenix.reflection.editor.guilayoututility_internals.toplevel Adds a generic GUILayoutEntry_Internal to the top-level layout. Requires the entry type to be a class. ```csharp public static void Add(GUILayoutEntry_Internal e) where T : class ``` -------------------------------- ### WeakReferenceEventListener Constructors Source: https://odininspector.com/documentation/sirenix.odininspector.editor.internal.weakreferenceeventlistener-1 Initializes a new instance of the WeakReferenceEventListener class. ```APIDOC ## WeakReferenceEventListener(Action) ### Description Initializes a new instance of the WeakReferenceEventListener class. ### Parameters - **invokeEventOnListener** (System.Action) - The action to invoke on the listener. ### Method Constructor ``` -------------------------------- ### TryCreateMatcher Source: https://odininspector.com/documentation/sirenix.odininspector.editor.typesearch.nestedinsamegenerictypetypematcher.creator Attempts to create a TypeMatcher based on the provided TypeSearchInfo. ```APIDOC ## TryCreateMatcher(TypeSearchInfo, out TypeMatcher) ### Description Attempts to create a `TypeMatcher` based on the provided `TypeSearchInfo`. This method is an override from the base `TypeMatcherCreator` class. ### Method `public override bool TryCreateMatcher(TypeSearchInfo info, out TypeMatcher matcher)` ### Parameters #### Path Parameters - **info** (TypeSearchInfo) - The search information used to create the matcher. - **matcher** (out TypeMatcher) - When this method returns, contains the created `TypeMatcher`, if the creation succeeded. This parameter is passed uninitialized. ``` -------------------------------- ### RegisterDefaultActionResolverAttribute Constructors and Fields Source: https://odininspector.com/documentation/sirenix.odininspector.editor.actionresolvers.registerdefaultactionresolverattribute Provides information about the constructors and public fields of the RegisterDefaultActionResolverAttribute class. ```APIDOC ## RegisterDefaultActionResolverAttribute ### Description An attribute used to register a default action resolver. This attribute is applied at the assembly level. ### Constructors #### RegisterDefaultActionResolverAttribute(Type resolverType, double order) Initializes a new instance of the `RegisterDefaultActionResolverAttribute` class. ##### Parameters * **resolverType** (System.Type) - The type of the action resolver to register. * **order** (System.Double) - The order in which to register the resolver. Lower values are registered first. ### Fields #### Order ```csharp public double Order ``` The order in which to register the resolver. Lower values are registered first. #### ResolverType ```csharp public Type ResolverType ``` The type of the action resolver to register. ``` -------------------------------- ### TwoDimensionalArrayDrawer Context Constructor Source: https://odininspector.com/documentation/sirenix.odininspector.editor.drawers.twodimensionalarraydrawer-2.context Initializes a new instance of the Context class. This is the default constructor. ```csharp public Context() ``` -------------------------------- ### GetNext Method Source: https://odininspector.com/documentation/sirenix.reflection.editor.guilayoututility_internals.toplevel Retrieves the next available GUILayoutEntry_Internal for layout processing. ```csharp public static GUILayoutEntry_Internal GetNext() ``` -------------------------------- ### OpenEditor() Source: https://odininspector.com/documentation/sirenix.config.typesettings Opens the editor interface for the TypeRegistryUserConfig. ```APIDOC ## OpenEditor() ### Description Opens the editor interface for the TypeRegistryUserConfig. ### Method OpenEditor ### Parameters None ``` -------------------------------- ### StringSlice.PreHashed Constructor Source: https://odininspector.com/documentation/sirenix.utilities.editor.stringslice.prehashed Initializes a new instance of the StringSlice.PreHashed struct with the specified StringSlice. ```APIDOC ## PreHashed Constructor ### Description Initializes a new instance of the StringSlice.PreHashed struct with the specified StringSlice. ### Signature ```csharp public PreHashed(StringSlice slice) ``` ### Parameters * **slice** (StringSlice) - The StringSlice to initialize the PreHashed struct with. ``` -------------------------------- ### MinHeight Method Source: https://odininspector.com/documentation/sirenix.utilities.guilayoutoptions.guilayoutoptionsinstance Specifies the minimum allowed height for a GUI control. This ensures the control has a certain height. ```csharp public GUILayoutOptions.GUILayoutOptionsInstance MinHeight(float height) ``` -------------------------------- ### GenericParameterInferenceTypeMatcher.Creator Constructors Source: https://odininspector.com/documentation/sirenix.odininspector.editor.typesearch.genericparameterinferencetypematcher.creator Provides documentation for the constructors of the Creator class. ```APIDOC ## Creator() ### Description Initializes a new instance of the `Creator` class. ### Method Constructor ### Parameters None ``` -------------------------------- ### ModuleFile Constructor Source: https://odininspector.com/documentation/sirenix.odininspector.editor.modules.moduledata.modulefile The default constructor for the ModuleFile class. Initializes a new instance. ```csharp public ModuleFile() ``` -------------------------------- ### GUILayoutUtility_Internals.TopLevel Properties Source: https://odininspector.com/documentation/sirenix.reflection.editor.guilayoututility_internals.toplevel Provides access to internal GUI layout state and elements. ```APIDOC ## GUILayoutUtility_Internals.TopLevel Properties ### Cursor - **Description**: Gets the current cursor position for GUI layout. - **Type**: `int` ### HasTopLevel - **Description**: Checks if a top-level GUI element is currently active. - **Type**: `bool` ### Rect - **Description**: Gets the rectangular area allocated for the top-level GUI element. - **Type**: `Rect` ### Style - **Description**: Gets the GUI style associated with the top-level element. - **Type**: `GUIStyle` ### TopLevelGroup - **Description**: Gets the internal GUI layout group for the top-level element. - **Type**: `GUILayoutGroup_Internal` ``` -------------------------------- ### TryCreateMatcher Method Source: https://odininspector.com/documentation/sirenix.odininspector.editor.typesearch.nestedinsamegenerictypetypematcher.creator Attempts to create a TypeMatcher based on the provided TypeSearchInfo. This is an override method from the base TypeMatcherCreator class. ```csharp public override bool TryCreateMatcher(TypeSearchInfo info, out TypeMatcher matcher) ``` -------------------------------- ### ImmutableList Constructor Source: https://odininspector.com/documentation/sirenix.serialization.utilities.immutablelist-1 Initializes a new instance of the ImmutableList class with an existing list. ```csharp public ImmutableList(IList innerList) ``` -------------------------------- ### IndexNotFoundException Constructors Source: https://odininspector.com/documentation/sirenix.odininspector.editor.drawers.multicollectionfilter-1.indexnotfoundexception Provides documentation for the constructors available for the IndexNotFoundException class. ```APIDOC ## IndexNotFoundException(InspectorProperty, Int32) ### Description Initializes a new instance of the `IndexNotFoundException` class with the specified expected property and index. ### Method Constructor ### Parameters - **expectedProperty** (InspectorProperty) - The property that was expected. - **index** (System.Int32) - The index that was not found. ``` -------------------------------- ### TabSubGroupAttribute Constructor Source: https://odininspector.com/documentation/sirenix.odininspector.tabgroupattribute.tabsubgroupattribute Initializes a new instance of the TabSubGroupAttribute class with a specified tab group, group ID, and order. ```csharp public TabSubGroupAttribute(TabGroupAttribute tab, string groupId, float order) ``` -------------------------------- ### Height Method Source: https://odininspector.com/documentation/sirenix.utilities.guilayoutoptions.guilayoutoptionsinstance Sets an absolute height for a GUI control. Use this when a fixed height is required. ```csharp public GUILayoutOptions.GUILayoutOptionsInstance Height(float height) ``` -------------------------------- ### Creator Constructor Source: https://odininspector.com/documentation/sirenix.odininspector.editor.typesearch.nestedinsamegenerictypetypematcher.creator The default constructor for the Creator class. It initializes a new instance of the Creator class. ```csharp public Creator() ``` -------------------------------- ### ScanProjectForSerializedTypes Source: https://odininspector.com/documentation/sirenix.serialization.editor.aotsupportutilities Scans the project's build scenes and resources, plus their dependencies, for serialized types to support. Progress bars are shown during the scan. ```APIDOC ## ScanProjectForSerializedTypes ### Description Scans the project's build scenes and resources, plus their dependencies, for serialized types to support. Progress bars are shown during the scan. ### Method `public static bool ScanProjectForSerializedTypes(out List serializedTypes, bool scanBuildScenes = true, bool scanAllAssetBundles = true, bool scanPreloadedAssets = true, bool scanResources = true, List resourcesToScan = null, bool scanAddressables = true)` ### Parameters - **serializedTypes** (System.Collections.Generic.List) - Output parameter. The serialized types found during the scan. - **scanBuildScenes** (System.Boolean) - Optional. Whether to scan the project's build scenes. Defaults to true. - **scanAllAssetBundles** (System.Boolean) - Optional. Whether to scan all the project's asset bundles. Defaults to true. - **scanPreloadedAssets** (System.Boolean) - Optional. Whether to scan the project's preloaded assets. Defaults to true. - **scanResources** (System.Boolean) - Optional. Whether to scan the project's resources. Defaults to true. - **resourcesToScan** (System.Collections.Generic.List) - Optional. An optional list of the resource paths to scan. Only has an effect if the scanResources argument is true. All the resources will be scanned if null. - **scanAddressables** (System.Boolean) - Optional. Whether to scan Addressables. Defaults to true. ### Returns System.Boolean - true if the scan succeeded, false if the scan failed or was cancelled. ``` -------------------------------- ### WeakQueueFormatter Constructors Source: https://odininspector.com/documentation/sirenix.serialization.weakqueueformatter Initializes a new instance of the WeakQueueFormatter class. ```APIDOC ## WeakQueueFormatter(Type serializedType) ### Description Initializes a new instance of the WeakQueueFormatter class. ### Parameters * **serializedType** (System.Type) - The type of the object to be serialized. ``` -------------------------------- ### TabSubGroupAttribute Constructors Source: https://odininspector.com/documentation/sirenix.odininspector.tabgroupattribute.tabsubgroupattribute Provides information on the constructors available for the TabSubGroupAttribute class. ```APIDOC ## TabSubGroupAttribute(TabGroupAttribute, String, Single) ### Description Initializes a new instance of the TabGroupAttribute class with a specified tab group, group ID, and order. ### Parameters #### Path Parameters - **tab** (TabGroupAttribute) - The parent TabGroupAttribute. - **groupId** (String) - The unique identifier for this subgroup. - **order** (Single) - The order in which this subgroup should be displayed within the tab. ``` -------------------------------- ### WriteDataEntries Method Source: https://odininspector.com/documentation/sirenix.serialization.formatteremitter.emptyaotemittedformatter-1 Documentation for the WriteDataEntries method, which performs no action. ```APIDOC ## WriteDataEntries(ref T value, IDataWriter writer) ### Description Does nothing at all. ### Method protected override void WriteDataEntries(ref T value, IDataWriter writer) ### Parameters #### Parameters - **value** (T) - The value to write. - **writer** (Sirenix.Serialization.IDataWriter) - The data writer. ``` -------------------------------- ### MaxWidth Method Source: https://odininspector.com/documentation/sirenix.utilities.guilayoutoptions.guilayoutoptionsinstance Specifies the maximum allowed width for a GUI control. This prevents the control from becoming too wide. ```csharp public GUILayoutOptions.GUILayoutOptionsInstance MaxWidth(float width) ``` -------------------------------- ### CreateDefault Method (Overload 1) Source: https://odininspector.com/documentation/sirenix.odininspector.editor.valueresolvers.valueresolvercontext Creates a default ValueResolverContext with specified parameters. Use this when the result type is known and no fallback value is initially provided. ```csharp public static ValueResolverContext CreateDefault(InspectorProperty property, Type resultType, string resolvedString, params NamedValue[] namedValues) ``` -------------------------------- ### HandleDefaultSettings Method Source: https://odininspector.com/documentation/sirenix.config.typesettings Handles the default settings for a type, applying them based on provided settings and item attributes. This method is called during type registration. ```csharp public void HandleDefaultSettings(Type type, TypeSettings settings, TypeRegistryItemAttribute itemAttribute) ``` -------------------------------- ### Compare(T x, T y) Method Source: https://odininspector.com/documentation/sirenix.serialization.dictionarykeyutility.keycomparer-1 Compares two keys for equality. Not yet documented. ```APIDOC ## Compare(T x, T y) Method ### Description Compares two keys for equality. Not yet documented. ### Method ```csharp public int Compare(T x, T y) ``` ### Parameters #### Path Parameters - **x** (T) - Not yet documented. - **y** (T) - Not yet documented. ### Returns System.Int32 - Not yet documented. ``` -------------------------------- ### ModuleManager Methods Source: https://odininspector.com/documentation/sirenix.odininspector.editor.modules.modulemanager Provides methods for interacting with modules. ```APIDOC ## ContainsModule(String) ### Description Checks if a module with the specified ID exists. ### Method `ContainsModule` ### Parameters #### Path Parameters * **moduleId** (string) - Description: The ID of the module to check. ### Returns System.Boolean - True if the module exists, false otherwise. ### Example ```csharp bool hasModule = moduleManager.ContainsModule("MyModuleId"); ``` ``` ```APIDOC ## CreateDefault() ### Description Creates a default instance of the ModuleManager. ### Method `CreateDefault` ### Returns ModuleManager - A new instance of ModuleManager. ### Example ```csharp ModuleManager defaultManager = ModuleManager.CreateDefault(); ``` ``` ```APIDOC ## GetModule(String) ### Description Retrieves the module definition for the specified module ID. ### Method `GetModule` ### Parameters #### Path Parameters * **moduleId** (string) - Description: The ID of the module to retrieve. ### Returns ModuleDefinition - The ModuleDefinition if found, otherwise null. ### Example ```csharp ModuleDefinition module = moduleManager.GetModule("MyModuleId"); ``` ``` ```APIDOC ## PackageAllModules() ### Description Packages all available modules. ### Method `PackageAllModules` ### Parameters None ### Returns None ``` ```APIDOC ## Refresh() ### Description Refreshes the module manager, potentially reloading modules. ### Method `Refresh` ### Returns System.Boolean - True if the refresh was successful, false otherwise. ### Example ```csharp bool success = moduleManager.Refresh(); ``` ``` -------------------------------- ### OdinFeedbackWindow Class Definition Source: https://odininspector.com/documentation/sirenix.odininspector.editor.windows.odinfeedbackwindow Defines the OdinFeedbackWindow class, inheriting from OdinEditorWindow and implementing ISerializationCallbackReceiver. ```csharp public class OdinFeedbackWindow : OdinEditorWindow, ISerializationCallbackReceiver ``` -------------------------------- ### Validator Initialize Method (Protected) Source: https://odininspector.com/documentation/sirenix.odininspector.editor.validation.validator Protected method to initialize the validator. Intended for internal use or derived classes. ```csharp protected virtual void Initialize() ``` -------------------------------- ### ModuleFile Path Field Source: https://odininspector.com/documentation/sirenix.odininspector.editor.modules.moduledata.modulefile Represents the string path of the module file. ```csharp public string Path ``` -------------------------------- ### ShowIfAttributeStateUpdater Constructor Source: https://odininspector.com/documentation/sirenix.odininspector.editor.stateupdaters.showifattributestateupdater The default constructor for the ShowIfAttributeStateUpdater class. ```csharp public ShowIfAttributeStateUpdater() ``` -------------------------------- ### SerializedData Constructor Source: https://odininspector.com/documentation/sirenix.config.serializedtypeprioritydictionary.serializeddata Provides a default constructor for the SerializedData class. No specific initialization logic is shown. ```csharp public SerializedData() ``` -------------------------------- ### Validator Initialize Method (Public) Source: https://odininspector.com/documentation/sirenix.odininspector.editor.validation.validator Initializes the validator with a specific InspectorProperty. ```csharp public void Initialize(InspectorProperty property) ``` -------------------------------- ### ModuleManager Constructors Source: https://odininspector.com/documentation/sirenix.odininspector.editor.modules.modulemanager Initializes a new instance of the ModuleManager class. ```APIDOC ## ModuleManager() ### Description Initializes a new instance of the ModuleManager class. ### Method Constructor ### Endpoint N/A ### Parameters None ### Request Example None ### Response None ``` -------------------------------- ### TypeRegistryUserConfig Constructor Source: https://odininspector.com/documentation/sirenix.config.typesettings The default constructor for the TypeRegistryUserConfig class. It initializes the configuration object. ```csharp public TypeRegistryUserConfig() ```