C# Class FullInspector.fiSettings

This class contains some settings that can be used to customize the behavior of the Full Inspector.
Exibir arquivo Open project: jacobdufault/fullinspector

Public Properties

Property Type Description
AutomaticReferenceInstantation bool
DefaultCommentType CommentType
DefaultPageMinimumCollectionLength int
DisplaySingleCategory bool
EmitGraphMetadataCulls bool
EmitWarnings bool
EnableAnimation bool
EnableGlobalOrdering bool
EnableLogs bool
EnableMultiEdit bool
EnableOpenScriptButton bool
EnableSettingsProcessor bool
ForceDisableMultithreadedSerialization bool
ForceDisplayInlineObjectEditor bool
ForceRestoreAllAssetsOnRecompilation bool
ForceSaveAllAssetsOnRecompilation bool
ForceSaveAllAssetsOnSceneSave bool
InspectorAutomaticReferenceInstantation bool
InspectorRequireShowInInspector bool
LabelWidthMax float
LabelWidthMin float
LabelWidthOffset float
LabelWidthPercentage float
MinimumFoldoutHeight float
PrettyPrintSerializedJson bool
RootDirectory string
RootGeneratedDirectory string
SerializeAutoProperties bool
TypeSelectionBlacklist List
TypeSelectionDefaultFilters List

Private Methods

Method Description
EnsureRootDirectory ( ) : void

Ensures that fiSettings.RootDirectory points to a folder named "FullInspector2". If it doesn't, then this will perform a scan over all of the content inside of the Assets folder looking for that directory and will notify the user of the results.
FindDirectoryPathByName ( string currentDirectory, string targetDirectory ) : string

Locates a directory of the given name or returns null if the directory is not contained within the specificed initial currentDirectory.
FormatCustomizerForNewPath ( string path ) : string
fiSettings ( ) : System

Property Details

AutomaticReferenceInstantation public_oe static_oe property

If this is set to true, then Full Inspector will attempt to automatically instantiate all reference fields/properties in an object. This will negatively impact the performance for creating objects (lots of reflection is used).
public static bool AutomaticReferenceInstantation
return bool

DefaultCommentType public_oe static_oe property

The default type of comment that is used when you have [InspectorComment("str")]
public static CommentType DefaultCommentType
return CommentType

DefaultPageMinimumCollectionLength public_oe static_oe property

The default length of a collection before the paging interface is shown, which will let you view a subset of the collection, making it easier to manage and inspect. If you do not want the pager to *ever* activate by default, set this to a negative value (such as -1). If you want the pager to *always* activate, set this to 0. Otherwise, set this to a reasonably large value such as 20.
public static int DefaultPageMinimumCollectionLength
return int

DisplaySingleCategory public_oe static_oe property

If an inspector has only one category (see InspectorCategory), should it be displayed?
public static bool DisplaySingleCategory
return bool

EmitGraphMetadataCulls public_oe static_oe property

Should Full Inspector emit logs about graph metadata that it has culled? This may be useful if you have written a custom property editor but changes to your graph metadata are not being persisted for some reason.
public static bool EmitGraphMetadataCulls
return bool

EmitWarnings public_oe static_oe property

Should Full Inspector emit warnings when it detects a possible data loss (such as a renamed or removed variable) or general serialization issue?
public static bool EmitWarnings
return bool

EnableAnimation public_oe static_oe property

Should Full Inspector use animation when toggling and foldout and in other situations? This option is purely cosmetic.
public static bool EnableAnimation
return bool

EnableGlobalOrdering public_oe static_oe property

If true, InspectorOrder elements will be ordered globally instead of local per element.
public static bool EnableGlobalOrdering
return bool

EnableLogs public_oe static_oe property

Full Inspector will optionally log lots of data. If this is set to true, then Full Inspector will emit the logging information.
public static bool EnableLogs
return bool

EnableMultiEdit public_oe static_oe property

If true, multi-object editing will be enabled. Note that multi-object editing is still extremely experimental and has a large number of bugs.
public static bool EnableMultiEdit
return bool

EnableOpenScriptButton public_oe static_oe property

Display an "open script" button that Unity will typically display.
public static bool EnableOpenScriptButton
return bool

EnableSettingsProcessor public_oe static_oe property

If true, then fiSettingsProcessor support will be enabled. The initial fiSettingsProcessor initialization may take some time so it is sometimes desirable turn this off by setting EnableSettingsProcessor to false. If you're using a DLL, the only way to customize settings (outside of compiling a DLL with your fiSettings config options baked in) is to use a fiSettingsProcessor instance. Note that this setting will *only* be honored if modified directly here, before the static constructor is run. It cannot be modified from a fiSettingsProcessor.
public static bool EnableSettingsProcessor
return bool

ForceDisableMultithreadedSerialization public_oe static_oe property

If set to true, then multithreaded serialization/deserialization will be forcibly disabled. It is **strong** recommended that you leave this as false. If set to true, object serialization will be a bit less robust w.r.t. Instantiation (you need to call SaveState()) - more importantly, performance will be worse. The only real reason to set this setting to true is if you want the serialization callbacks to execute on the main thread - however, you should probably just run that logic in Awake().
public static bool ForceDisableMultithreadedSerialization
return bool

ForceDisplayInlineObjectEditor public_oe static_oe property

Should the inline object editor be displayed even if the object does not necessarily use a FI editor? This is not directly supported but may be useful - custom inspectors that Unity themselves have written will almost certainly not render correctly.
public static bool ForceDisplayInlineObjectEditor
return bool

ForceRestoreAllAssetsOnRecompilation public_oe static_oe property

A recompilation has been detected. Should all IScriptableObjects be checked to see if they need to be restored? This is disabled by default because it causes a performance hit.
public static bool ForceRestoreAllAssetsOnRecompilation
return bool

ForceSaveAllAssetsOnRecompilation public_oe static_oe property

A recompilation has been detected. Should all IScriptableObjects be checked to see if they need to be saved? This is disabled by default because it causes a performance hit when saving and unless you have an extremely strange user scenario where you are not using the inspector to edit a BaseBehavior, everything will save correctly.
public static bool ForceSaveAllAssetsOnRecompilation
return bool

ForceSaveAllAssetsOnSceneSave public_oe static_oe property

A scene has just been saved. Should all IScriptableObjects be checked to see if they need to be saved? This is disabled by default because it causes a performance hit when saving and unless you have an extremely strange user scenario where you are not using the inspector to edit a BaseBehavior, everything will save correctly.
public static bool ForceSaveAllAssetsOnSceneSave
return bool

InspectorAutomaticReferenceInstantation public_oe static_oe property

If this is set to true, then when the reflected inspector encounters a property that is null it will attempt to create an instance of that property. This is most similar to how Unity operates. Please note that this will not instantiate fields/properties that are hidden from the inspector. Additionally, this will not instantiate fields which do not have a default constructor.
public static bool InspectorAutomaticReferenceInstantation
return bool

InspectorRequireShowInInspector public_oe static_oe property

Should public properties/fields automatically be shown in the inspector? If this is true, then only properties annotated with [ShowInInspector] will be shown. [HideInInspector] will never be necessary. *PLEASE NOTE* this does not impact how data is serialized! Public properties/fields will *still* be serialized!
public static bool InspectorRequireShowInInspector
return bool

LabelWidthMax public_oe static_oe property

public static float LabelWidthMax
return float

LabelWidthMin public_oe static_oe property

public static float LabelWidthMin
return float

LabelWidthOffset public_oe static_oe property

public static float LabelWidthOffset
return float

LabelWidthPercentage public_oe static_oe property

What percentage of an editor's width will be used for labels?
public static float LabelWidthPercentage
return float

MinimumFoldoutHeight public_oe static_oe property

The minimum height a child property editor has to be before a foldout is displayed
public static float MinimumFoldoutHeight
return float

PrettyPrintSerializedJson public_oe static_oe property

If set to true, then Full Serializer and Json.NET will serialize data using formatted JSON output. This is useful if you have multiple developers merging prefabs/assets, as it makes the data slightly more mergeable.
public static bool PrettyPrintSerializedJson
return bool

RootDirectory public_oe static_oe property

The root directory that Full Inspector resides in. Please update this value if you change the root directory -- if you don't a potentially expensive scan will be performed to locate the root directory. This has a trailing slash.
public static string RootDirectory
return string

RootGeneratedDirectory public_oe static_oe property

This is automatically configured based on RootDirectory. This has a trailing slash.
public static string RootGeneratedDirectory
return string

SerializeAutoProperties public_oe static_oe property

Should auto-properties be serialized (and thus inspected) by default? If this is set to false, then you can still serialize auto-properties by using [SerializeField].
public static bool SerializeAutoProperties
return bool

TypeSelectionBlacklist public_oe static_oe property

If this is set, any type that matches any list element will never be shown in the type selection. Also used in the ScriptableObjects inspector.
public static List TypeSelectionBlacklist
return List

TypeSelectionDefaultFilters public_oe static_oe property

If this is set, the list will be use to limit what types are shown in the type selection. Also used in the ScriptableObjects inspector.
public static List TypeSelectionDefaultFilters
return List