API Documentation BepInEx Utility

Class Utility

Generic helper properties and methods.

Inheritance
System.Object Utility
Inherited Members
System.Object.ToString() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone()
Namespace: BepInEx
Assembly: BepInEx.Core.dll
Syntax
public static class Utility

Properties

CLRSupportsDynamicAssemblies

Improve this Doc View Source

Whether current Common Language Runtime supports dynamic method generation using System.Reflection.Emit namespace.

Declaration
public static bool CLRSupportsDynamicAssemblies { get; }
Property Value
Type Description
System.Boolean

UTF8NoBom

Improve this Doc View Source

An encoding for UTF-8 which does not emit a byte order mark (BOM).

Declaration
public static Encoding UTF8NoBom { get; }
Property Value
Type Description
System.Text.Encoding

Methods

ByteArrayToString(Byte[])

Improve this Doc View Source

Convert the given array to a hex string.

Declaration
public static string ByteArrayToString(byte[] data)
Parameters
Type Name Description
System.Byte[] data

Bytes to convert.
Returns
Type Description
System.String

Bytes reinterpreted as a hex number.

CombinePaths(String[])

Improve this Doc View Source

Combines multiple paths together, as the specific method is not available in .NET 3.5.

Declaration
public static string CombinePaths(params string[] parts)
Parameters
Type Name Description
System.String[] parts

The multiple paths to combine together.
Returns
Type Description
System.String

A combined path.

ConvertToWWWFormat(String)

Improve this Doc View Source

Converts a file path into a UnityEngine.WWW format.

Declaration
public static string ConvertToWWWFormat(string path)
Parameters
Type Name Description
System.String path

The file path to convert.
Returns
Type Description
System.String

A converted file path.

EnumerateAllMethods(TypeDefinition)

Improve this Doc View Source
Declaration
public static IEnumerable<MethodDefinition> EnumerateAllMethods(this TypeDefinition type)
Parameters
Type Name Description
TypeDefinition type
Returns
Type Description
System.Collections.Generic.IEnumerable<MethodDefinition>

GetCommandLineArgValue(String)

Improve this Doc View Source

Get a value of a command line argument

Declaration
public static string GetCommandLineArgValue(string arg)
Parameters
Type Name Description
System.String arg

Argument name
Returns
Type Description
System.String

Next argument after the given argument name. If not found, returns null.

GetUniqueFilesInDirectories(IEnumerable<String>, String)

Improve this Doc View Source

Gets unique files in all given directories. If the file with the same name exists in multiple directories, only the first occurrence is returned.

Declaration
public static IEnumerable<string> GetUniqueFilesInDirectories(IEnumerable<string> directories, string pattern = "*")
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<System.String> directories

Directories to search from.
System.String pattern

File pattern to search.
Returns
Type Description
System.Collections.Generic.IEnumerable<System.String>

Collection of all files in the directories.

HashStream(Stream)

Improve this Doc View Source

Compute a MD5 hash of the given stream.

Declaration
public static string HashStream(Stream stream)
Parameters
Type Name Description
System.IO.Stream stream

Stream to hash
Returns
Type Description
System.String

MD5 hash as a hex string

HashStrings(String[])

Improve this Doc View Source

Hash a list of strings using MD5

Declaration
public static string HashStrings(params string[] strings)
Parameters
Type Name Description
System.String[] strings

Strings to hash
Returns
Type Description
System.String

MD5 of the strings

IsNullOrWhiteSpace(String)

Improve this Doc View Source

Indicates whether a specified string is null, empty, or consists only of white-space characters.

Declaration
public static bool IsNullOrWhiteSpace(this string self)
Parameters
Type Name Description
System.String self

The string to test.
Returns
Type Description
System.Boolean

True if the value parameter is null or empty, or if value consists exclusively of white-space characters.

IsSubtypeOf(TypeDefinition, Type)

Improve this Doc View Source

Checks whether a given cecil type definition is a subtype of a provided type.

Declaration
public static bool IsSubtypeOf(this TypeDefinition self, Type td)
Parameters
Type Name Description
TypeDefinition self

Cecil type definition
System.Type td

Type to check against
Returns
Type Description
System.Boolean

Whether the given cecil type is a subtype of the type.

ParentDirectory(String, Int32)

Improve this Doc View Source

Returns the parent directory of a path, optionally specifying the amount of levels.

Declaration
public static string ParentDirectory(string path, int levels = 1)
Parameters
Type Name Description
System.String path

The path to get the parent directory of.
System.Int32 levels

The amount of levels to traverse. Defaults to 1
Returns
Type Description
System.String

The parent directory.

SafeParseBool(String, Boolean)

Improve this Doc View Source

Tries to parse a bool, with a default value if unable to parse.

Declaration
public static bool SafeParseBool(string input, bool defaultValue = false)
Parameters
Type Name Description
System.String input

The string to parse
System.Boolean defaultValue

The value to return if parsing is unsuccessful.
Returns
Type Description
System.Boolean

Boolean value of input if able to be parsed, otherwise default value.

TopologicalSort<TNode>(IEnumerable<TNode>, Func<TNode, IEnumerable<TNode>>)

Improve this Doc View Source

Sorts a given dependency graph using a direct toposort, reporting possible cyclic dependencies.

Declaration
public static IEnumerable<TNode> TopologicalSort<TNode>(IEnumerable<TNode> nodes, Func<TNode, IEnumerable<TNode>> dependencySelector)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<TNode> nodes

Nodes to sort
System.Func<TNode, System.Collections.Generic.IEnumerable<TNode>> dependencySelector

Function that maps a node to a collection of its dependencies.
Returns
Type Description
System.Collections.Generic.IEnumerable<TNode>

Collection of nodes sorted in the order of least dependencies to the most.
Type Parameters
Name Description
TNode

Type of the node in a dependency graph.
Exceptions
Type Condition
System.Exception

Thrown when a cyclic dependency occurs.

TryDo(Action, out Exception)

Improve this Doc View Source

Try to perform an action.

Declaration
public static bool TryDo(Action action, out Exception exception)
Parameters
Type Name Description
System.Action action

Action to perform.
System.Exception exception

Possible exception that gets returned.
Returns
Type Description
System.Boolean

True, if action succeeded, false if an exception occured.

TryOpenFileStream(String, FileMode, out FileStream, FileAccess, FileShare)

Improve this Doc View Source

Tries to create a file with the given name

Declaration
public static bool TryOpenFileStream(string path, FileMode mode, out FileStream fileStream, FileAccess access = FileAccess.ReadWrite, FileShare share = FileShare.Read)
Parameters
Type Name Description
System.String path

Path of the file to create
System.IO.FileMode mode

File open mode
System.IO.FileStream fileStream

Resulting filestream
System.IO.FileAccess access

File access options
System.IO.FileShare share

File share options
Returns
Type Description
System.Boolean

TryParseAssemblyName(String, out AssemblyName)

Improve this Doc View Source

Try to parse given string as an assembly name

Declaration
public static bool TryParseAssemblyName(string fullName, out AssemblyName assemblyName)
Parameters
Type Name Description
System.String fullName

Fully qualified assembly name
System.Reflection.AssemblyName assemblyName

Resulting System.Reflection.AssemblyName instance
Returns
Type Description
System.Boolean

true, if parsing was successful, otherwise false
Remarks

On some versions of mono, using System.Reflection.Assembly.GetName fails because it runs on unmanaged side which has problems with encoding. Using System.Reflection.AssemblyName solves this by doing parsing on managed side instead.

TryResolveDllAssembly(AssemblyName, String, ReaderParameters, out AssemblyDefinition)

Improve this Doc View Source

Try to resolve and load the given assembly DLL.

Declaration
public static bool TryResolveDllAssembly(AssemblyName assemblyName, string directory, ReaderParameters readerParameters, out AssemblyDefinition assembly)
Parameters
Type Name Description
System.Reflection.AssemblyName assemblyName

Name of the assembly, of the type System.Reflection.AssemblyName.
System.String directory

Directory to search the assembly from.
ReaderParameters readerParameters

Reader parameters that contain possible custom assembly resolver.
AssemblyDefinition assembly

The loaded assembly.
Returns
Type Description
System.Boolean

True, if the assembly was found and loaded. Otherwise, false.

TryResolveDllAssembly(AssemblyName, String, out Assembly)

Improve this Doc View Source

Try to resolve and load the given assembly DLL.

Declaration
public static bool TryResolveDllAssembly(AssemblyName assemblyName, string directory, out Assembly assembly)
Parameters
Type Name Description
System.Reflection.AssemblyName assemblyName

Name of the assembly, of the type System.Reflection.AssemblyName.
System.String directory

Directory to search the assembly from.
System.Reflection.Assembly assembly

The loaded assembly.
Returns
Type Description
System.Boolean

True, if the assembly was found and loaded. Otherwise, false.

TryResolveDllAssembly<T>(AssemblyName, String, Func<String, T>, out T)

Improve this Doc View Source

Try to resolve and load the given assembly DLL.

Declaration
public static bool TryResolveDllAssembly<T>(AssemblyName assemblyName, string directory, Func<string, T> loader, out T assembly)
    where T : class
Parameters
Type Name Description
System.Reflection.AssemblyName assemblyName

Name of the assembly, of the type System.Reflection.AssemblyName.
System.String directory

Directory to search the assembly from.
System.Func<System.String, T> loader
T assembly

The loaded assembly.
Returns
Type Description
System.Boolean

True, if the assembly was found and loaded. Otherwise, false.
Type Parameters
Name Description
T