UniverseLib.Mono

Contains properties used by UniverseLib to act as a "config", although it is not really a full config implementation. Changing property values in this class has a direct and immediate effect on UniverseLib.

Applies the values from the provided which are not null.

If true, disables UniverseLib from overriding the EventSystem from the game when a UniversalUI is in use.

If true, attempts to force-unlock the mouse () when a UniversalUI is in use.

For IL2CPP games, this should be the full path to a folder containing the Unhollowed assemblies. This property is only used during the intial startup process.

If the game does not use an EventSystem and you do not expect there to be any other EventSystems, set this to true.

If true, GameObjects which are not a child to a can be selected as the selected GameObject by the EventSystem.

If true, disables UniverseLib from overriding the EventSystem from the game when a UniversalUI is in use.

If true, attempts to force-unlock the mouse () when a UniversalUI is in use.

For IL2CPP games, this should be the full path to a folder containing the Unhollowed assemblies.

If the game does not use an EventSystem and you do not expect there to be any other EventSystems, set this to true.

If true, GameObjects which are not a child to a can be selected as the selected GameObject by the EventSystem.

Handles taking control of the mouse/cursor and EventSystem (depending on Config settings) when a UniversalUI is being used.

True if a UI is being displayed and is true.

Uses WaitForEndOfFrame in a Coroutine to aggressively set the Cursor state every frame.

Checks current ShouldUnlock state and sets the Cursor and EventSystem as required.

The value of "EventSystem.current", or "EventSystem.main" in some older games.

The current BaseInputModule being used for the UniverseLib UI.

Helper to call EventSystem.SetSelectedGameObject and bypass UniverseLib's override patch.

Helper to set the SelectionGuard property on the current EventSystem with safe API.

If the UniverseLib EventSystem is not enabled, this enables it and sets EventSystem.current to it, and stores the previous EventSystem.

If the UniverseLib EventSystem is enabled, this disables it and sets EventSystem.current to the previous EventSystem which was enabled.

Interface for handling Unity Input API.

A universal Input handler which works with both legacy Input and the new InputSystem.

The current Input package which is being used by the game.

The current user Cursor position, with (0,0) being the bottom-left of the game display window.

The current mouse scroll delta from this frame. x is horizontal, y is vertical.

Returns true if the provided KeyCode was pressed this frame. Translates KeyCodes into Key if InputSystem is being used.

Returns true if the provided KeyCode is being held down (not necessarily just pressed). Translates KeyCodes into Key if InputSystem is being used.

Returns true if the provided KeyCode was released this frame. Translates KeyCodes into Key if InputSystem is being used.

Returns true if the provided mouse button was pressed this frame.
0 = left, 1 = right, 2 = middle, 3 = back, 4 = forward.

Returns true if the provided mouse button is being held down (not necessarily just pressed).
0 = left, 1 = right, 2 = middle, 3 = back, 4 = forward.

Returns true if the provided mouse button was released this frame.
0 = left, 1 = right, 2 = middle, 3 = back, 4 = forward.

Calls the equivalent method for the current to reset the Input axes.

Whether anything is currently using the Rebinding feature. If no UI is showing, this will return false.

The last pressed Key during rebinding.

Begins the Rebinding process, keys pressed will be recorded. Call to finish rebinding.

Will be invoked whenever any key is pressed, even if rebinding has not finished yet. Invoked when EndRebind is called.

Call this to finish Rebinding. The onFinished Action supplied to will be invoked if we are currently Rebinding.

Get the true underlying Type of the provided object.

Attempt to cast the provided object to it's true underlying Type.

Attempt to cast the provided object to the provided Type .

Attempt to cast the provided object to Type .

Check if the two objects are reference-equal, including checking for UnityEngine.Object-equality and Il2CppSystem.Object-equality.

Helper to display a simple "{ExceptionType}: {Message}" of the exception, and optionally use the inner-most exception.

Get the inner-most exception from the provided exception, if there are any. This is recursive.

Helper class for general Reflection API.

Key: Type.FullName, Value: Type

Returns an alphabetically-ordered array of all Type names in the AppDomain.

Find a in the current AppDomain whose matches the provided .

The you want to search for - case sensitive and full matches only. The Type if found, otherwise null.

Sanitize which contains the obfuscated name of the provided . Returns the sanitized string.

Used by UnityExplorer's Singleton search. Checks all as field members (and properties in IL2CPP) for instances of the , and populates the list with non-null values.

Attempts to extract loaded Types from a ReflectionTypeLoadException.

Get all base types of the Type of the provided object, including itself.

Get all base types of the provided Type, including itself.

Get all implementations of the provided type (include itself, if not abstract) in the current AppDomain. Also works for generic parameters by analyzing the constraints.

The base type, which can optionally be abstract / interface. All implementations of the type in the current AppDomain.

Returns true if the provided type is an IEnumerable, including Il2Cpp IEnumerables.

Attempts to get the from the provided .

Attempts to get the entry type (the Type of the entries) from the provided .

Returns true if the provided type implements IDictionary, or Il2CPP IDictionary.

Try to get a DictionaryEnumerator for the provided IDictionary.

Try to get the Type of Keys and Values in the provided dictionary type.

Class to help with some differences between Mono and Il2Cpp Runtimes.

Start any as a , handled by UniverseLib's Instance.

Stop a , which needs to have been started with .

Helper to add a component of Type , and return it as Type (provided is assignable from ).

Helper to create an instance of the ScriptableObject of Type .

Helper to invoke Unity's method.

Helper to get the value of Unity's property.

Automatically sets the base, highlighted and pressed values of the 's , with * 1.2f for the highlighted color and * 0.8f for the pressed color.

Sets the to the .

Sets the provided non- colors to the .

Handles getting/setting arbitrary field/property members which may have different names or member types in different Unity versions.

The containing Type for the member. The Type of the value for the member.

Gets the value of an instance member from the provided instance.

The instance to get from. The value from the member, if successful.

Gets the value of a static member.

The value from the member, if successful.

Sets the value of an instance member to the instance.

The instance to set to. The value to set to the instance.

Sets the value of a static member.

The value to set to the instance.

Helper class for working with s, including some runtime-specific helpers and some general utility.

Returns true if it is possible to force-read non-readable Cubemaps in this game.

Helper for invoking Unity's ImageConversion.EncodeToPNG method.

Helper for creating a new .

Helper for calling Unity's method.

Helper for creating a from the provided .

Helper for checking Texture2D.isReadable.

Helper for checking Cubemap.isReadable.

Copies the provided into a readable .
Supports and individual faces.

The original Texture to copy from. Optional dimensions to use from the original Texture. If set to default, uses the entire original. If copying a Cubemap, set this to the desired face index from 0 to 5. Optional destination starting X value. Optional destination starting Y value. A new Texture2D, copied from the .

Copies the provided into the Texture.

Supports and individual faces.

The original Texture to copy from. The destination Texture to copy into. Optional dimensions to use from the original Texture. If set to default, uses the entire original. If copying a Cubemap, set this to the desired face index from 0 to 5. Optional destination starting X value. Optional destination starting Y value. The Texture, copied from the .

Unwraps the Cubemap into a Texture2D, showing the the X faces on the left, Y in the middle and Z on the right, with positive faces on the top row and negative on the bottom.

Converts the into a readable -format .

Supports non-readable Textures.

Saves the provided as a PNG file, into the provided as ".png".

To save a , use for each face, using the cubemapFace parameter to select the face.

Saves the provided as a PNG file to the provided path.

To save a , use for each face, using the cubemapFace parameter to select the face, and save each resulting Texture2D.

A simple helper class to handle a button's OnClick more effectively, along with some helpers.

Invoked when the Button is clicked.

The actual Button component this object is a reference to.

The Text component on the button.

The GameObject this Button is attached to.

The RectTransform for this Button.

Helper for Button.enabled.

A simple wrapper class for working with InputFields, with some helpers and performance improvements.

Invoked at most once per frame, if the input was changed in the previous frame.

The actual InputField component which this object is a reference to.

The placeholder Text component.

The GameObject which the InputField is attached to.

The RectTransform for this InputField.

The Text set to the InputField.

A reference to the InputField's cachedInputTextGenerator.

Returns true if the InputField's vertex count has reached the limit.

Not implemented.

A class which can be used as an abstract UI object, which does not exist as a Component but which can receive Update calls.

An abstract UI object which does not exist as an actual UI Component, but which may be a reference to one.

An object which can be pooled by a .

Abstract base class to handle interfacing with a generic , without the generic parameter at compile time.

Borrow an object from the pool, creating a new object if none are available.

Return the object to the pool.

Handles object pooling for all objects. Each has its own instance.

Borrow an object from the pool, creating a new object if none are available.

Return the object to the pool.

Holds all returned objects in the pool.

Optional default height for the object, necessary if this object can be used by a .

How many objects are available in the pool.

Borrow an object from the pool, creating a new object if none are available.

Return the object to the pool.

Handles updating, dragging and resizing all s for the parent .

Is a panel currently being resized?

Is the resize cursor being displayed?

Force any current Resizing to immediately end.

The UIBase which created this PanelManager.

The GameObject which holds all of this PanelManager's Panels.

Invoked when the UIPanel heirarchy is reordered.

Invoked when the user clicks outside of all panels.

Determines if the PanelManager should update "focus" (ie. heirarchy order). By default, returns true if user is clicking.

The MousePosition which should be used for this PanelManager. By default, this is .

The Screen dimensions which should be used for this PanelManager. By default, this is x .

Determines if the mouse is currently in the Display used by this PanelManager. By default, this always returns true.

Invoked when panels are reordered.

Updates all PanelDraggers owned by this PanelManager.

A simple wrapper to handle a UI created with .

Whether this UI is currently being displayed or not. Disabled UIs will not receive Update calls.

Can be overridden if you want a different type of PanelManager implementation.

Set this UIBase to be on top of all others.

Helper class to create Unity uGUI UI objects at runtime, as well as use some custom UniverseLib UI classes such as ScrollPool, InputFieldScroller and AutoSliderScrollbar.

Create a simple UI object with a RectTransform. can be null.

Get and/or Add a LayoutElement component to the GameObject, and set any of the values on it.

Get and/or Add a HorizontalOrVerticalLayoutGroup (must pick one) to the GameObject, and set the values on it.

Set the values on a HorizontalOrVerticalLayoutGroup.

Create a simple UI Object with a VerticalLayoutGroup and an Image component.

See also:

The name of the panel GameObject, useful for debugging purposes The parent GameObject to attach this to The background color of your panel. Defaults to dark grey if null. The GameObject which you should add your actual content on to. The base panel GameObject (not for adding content to).

Create a VerticalLayoutGroup object with an Image component. Use SetLayoutGroup to create one without an image.

Create a HorizontalLayoutGroup object with an Image component. Use SetLayoutGroup to create one without an image.

Create a GridLayoutGroup object with an Image component.

Create a Text component.

The parent object to build onto The GameObject name of your label The default text of the label The alignment of the Text component The Text color (default is White) Should the Text support rich text? (Can be changed afterwards) The default font size Your new Text component

Create a ButtonRef wrapper and a Button component, providing only the default Color (highlighted and pressed colors generated automatically).

The parent object to build onto The GameObject name of your button The default button text The base color for your button, with the highlighted and pressed colors generated from this. A ButtonRef wrapper for your Button component.

Create a ButtonRef wrapper and a Button component.

The parent object to build onto The GameObject name of your button The default button text The ColorBlock used for your Button component A ButtonRef wrapper for your Button component.

Create a Slider control component.

The parent object to build onto The GameObject name of your slider Returns the created Slider component The root GameObject for your Slider

Create a standard Unity Scrollbar component.

The parent object to build onto The GameObject name of your scrollbar Returns the created Scrollbar component The root GameObject for your Scrollbar

Create a Toggle control component.

The parent object to build onto The GameObject name of your toggle Returns the created Toggle component Returns the Text component for your Toggle The background color of the checkbox The width of your checkbox The height of your checkbox The root GameObject for your Toggle control

Create a standard InputField control and an InputFieldRef wrapper for it.

The parent object to build onto The GameObject name of your InputField The placeholder text for your InputField component An InputFieldRef wrapper for your InputField

Create a standard DropDown control.

The parent object to build onto The GameObject name of your Dropdown Returns your created Dropdown component The default displayed text (suggested is 14) The font size of the displayed text Invoked when your Dropdown value is changed Optional default options for the dropdown The root GameObject for your Dropdown control

Create a ScrollPool for the ICell. You should call scrollPool.Initialize(handler) after this.

The ICell type which will be used for the ScrollPool. The parent GameObject which the ScrollPool will be built on to. The GameObject name for your ScrollPool Returns the root GameObject for your ScrollPool Returns the content GameObject for your ScrollPool (where cells will be populated) The background color for your ScrollPool. If default, it will be dark grey. Your created ScrollPool instance.

Create a SliderScrollbar, using a Slider to mimic a Scrollbar. This fixes several issues with Unity's Scrollbar implementation.

Note that this will not have any actual functionality. Use this along with an to automate the functionality.

The parent to create on to. Your created Slider component The root GameObject for your SliderScrollbar.

Create a ScrollView and a SliderScrollbar for non-pooled content.

The parent GameObject to build on to. The GameObject name for your ScrollView. The GameObject for your content to be placed on. A created AutoSliderScrollbar instance for your ScrollView. The background color, defaults to grey. The root GameObject for your ScrollView.

Create a Scrollable Input Field control, using an AutoSliderScrollbar for the scroll bar.

The parent GameObject to build on to. The GameObject name for your InputField. Optional placeholder text for your InputField An InputFieldScroller, you don't need to do anything with this necessarily, it will automate itself. The font size for your InputField The text color for your InputField The root GameObject for your ScrollInputField

Handles all UIs on the UniverseLib UI canvas.

Returns true if UniverseLib is currently initializing it's UI.

Returns true if any is being displayed.

The UniverseLib global Canvas root.

The UniverseLib global EventSystem.

The GameObject used to hold returned objects.

The Consola font asset, if it was successfully loaded.

The default font asset.

The backup UI shader, if it was loaded.

The default color used by UniverseLib for enabled buttons.

The default color used by UniverseLib for disabled buttons.

A safe value for the maximum amount of characters allowed in an InputField.

The maximum amount of vertices allowed in an InputField's UI mesh.

Create and register a with the provided ID, and optional update method.

A unique ID for your UI. An optional method to receive Update calls with, invoked when your UI is displayed. Your newly created , if successful.

Create and register a with the provided ID, and optional update method.
You can use this to register a custom type instead of the default type.

A unique ID for your UI. An optional method to receive Update calls with, invoked when your UI is displayed. Your newly created , if successful.

Sets the with the corresponding to be active or disabled.

A scrollbar which automatically resizes itself (and its handle) depending on the size of the content and viewport.

Represents the base cell used by a .

A helper to create and handle a simple of Buttons, which can be backed by any data.

Create a wrapper to handle your Button ScrollPool.

The ScrollPool<ButtonCell> you have already created. A method which should return your current data values. A method which should set the data at the int index to the cell. A method which should determine if the data at the index should be displayed, with an optional string filter from CurrentFilter. A method invoked when a cell is clicked, containing the data index assigned to the cell.

A wrapper for a scrollable InputField created with .

This is otherwise a normal InputField, but which handles scrolling more nicely than a vanilla one.

Invoked whenever this InputField is scrolled through (ie,

Used to handle the underlying height data for a scroll pool, tracking which data values are at which position and how far they span.

A DataHeightCache is created and managed automatically by a ScrollPool, you do not need to use this class yourself.

Lookup table for "which data index first appears at this position"
Index: DefaultHeight * index from top of data
Value: the first data index at this position

Same as GetRangeIndexOfPosition, except this rounds up to the next division if there was remainder from the previous cell.

Get the first range (division of DefaultHeight) which the position appears in.

Get the spread of the height, starting from the start position.

The "spread" begins at the start of the next interval of the DefaultHeight, then increases for every interval beyond that.

Append a data index to the cache with the provided height value.

Remove the last (highest count) index from the height cache.

Set a given data index with the specified value.

A data source for a ScrollPool.

An object-pooled ScrollRect, attempts to support content of any size and provide a scrollbar for it.

The data source backing this scroll pool.

The cells used by this ScrollPool.

The GameObject which the ScrollRect is attached to.

The first and last pooled indices relative to the DataSource's list

The first and last indices of our CellPool in the transform heirarchy

If true, prevents the ScrollPool for writing any values, essentially making it readonly.

Invoked by UIBehaviourModel.UpdateInstances

Refresh the ScrollPool, optionally forcing a rebuild of cell data, and optionally jumping to the top.

If true, will call SetCell for the data source on each displayed cell. If true, will jump to the top of the data.

Jump to the cell at the provided index, and invoke onJumped after completion.

Should be called only once, when the scroll pool is created.

Returns true if the viewport changed height since last check.

Use

The method used to retrieve the list of GameObjects in this TransformTree

Invoked when a Transform is clicked on.

The ScrollPool used by this TransformTree.

Key: UnityEngine.Transform instance ID
Value: CachedTransform

Can set to filter the displayed Transforms in this tree. You must call RefreshData after changing the filter.

Create a new TransformTree for the provided . This constructor will call ScrollPool.Initialize(this).

The already-created which will be used by this TransformTree. Your method to provide GameObjects for this TransformTree. Your method to be invoked when a Transform cell is clicked on.

Completely reset the tree (ie. switching inspected GameObject)

Completely wipe the cached data (ie. GameObject inspector returning to pool)

Check if the given Instance ID is expanded or not

Jump to a specific Transform in the tree and highlight it.

Perform an update of all Transforms in this tree.

If true, calls ScrollPool.Refresh Should the ScrollPool reset back to the top index? If false and there is a Refresh coroutine already running, this method will abort. If true, will not yield any frames in the coroutine (will all happen instantly, now)

Called by ScrollPool, not necessary to ever call this directly.

Used for receiving Update events and starting Coroutines.

The current runtime context (Mono or IL2CPP).

The current setup state of UniverseLib.

Initialize UniverseLib with default settings, if you don't require any finer control over the startup process.

Invoked after the startupDelayand after UniverseLib has finished initializing. Should be used for printing UniverseLib's own internal logs. Your listener will only be used if no listener has yet been provided to handle it. It is not required to implement this but it may be useful to diagnose internal errors.

Initialize UniverseLib with the provided parameters.

Will be used only if it is the highest value supplied to this method compared to other assemblies. If another assembly calls this Init method with a higher startupDelay, their value will be used instead. Invoked after the and after UniverseLib has finished initializing. Should be used for printing UniverseLib's own internal logs. Your listener will only be used if no listener has yet been provided to handle it. It is not required to implement this but it may be useful to diagnose internal errors. Can be used to set certain values of UniverseLib's configuration. Null config values will be ignored.

Equivalent to new Type[0]

Equivalent to new object[0]

Equivalent to new Type[] { typeof(string) }

Ensures the path contains no invalid characters and that the containing directory exists.

Ensures the file name contains no invalid characters.

Check if a string contains another string, case-insensitive.

Just to allow Enum to do .HasFlag() in NET 3.5

Returns true if the StringBuilder ends with the provided string.

Equivalent to $"0.####".

Formats the array of float, double or decimal numbers into a formatted string.

Returns true if ParseUtility is able to parse the provided Type.

Attempt to parse the provided input into an object of the provided Type. Returns true if successful, false if not.

Returns the obj.ToString() result, formatted into the format which ParseUtility would expect for user input.

Gets a default example input which can be displayed to users, for example for Vector2 this would return "0 0".

For Unity rich-text syntax highlighting of Types and Members.

Highlight the full signature of the Type, including optionally the Namespace, and optionally combined with a MemberInfo.

Removes highlighting from the string (color and italics only, as that is all this class handles).

Highlight the provided method's signature with it's containing Type, and all arguments.

Highlight the provided constructors's signature with it's containing Type, and all arguments.

Get the color used by SignatureHighlighter for the provided member, and whether it is static or not.

Provides utility for displaying an object's ToString result in a more user-friendly format.

Constrains the provided string to a maximum length, and maximum number of lines.

Returns the ToString result with a rich-text highlighted Type in trailing brackets. If the object does not implement ToString, then only the trailing highlighted Type will be returned.

Returns true if the provided occured more than 10ms before .

Should be a value from which you stored earlier.

Returns true if the provided occured at least before .

Should be a value from which you stored earlier.

Check if an object is null, and if it's a UnityEngine.Object then also check if it was destroyed.

Get the full Transform heirarchy path for this provided Transform.

Converts Color to 6-digit RGB hex code (without # symbol). Eg, RGBA(1,0,0,1) -> FF0000

Assumes the string is a 6-digit RGB Hex color code (with optional leading #) which it will parse into a UnityEngine.Color. Eg, FF0000 -> RGBA(1,0,0,1)

Returns the onEndEdit event as a for greater compatibility with all Unity versions.