diff --git a/.gitignore b/.gitignore index 01c5562..6fbb5be 100644 --- a/.gitignore +++ b/.gitignore @@ -3,4 +3,6 @@ obj *.userprefs bin *.zip -.vs \ No newline at end of file +.vs +/packages +/robotlegs-sharp-framework-test.sln.GhostDoc.xml diff --git a/app.config b/app.config new file mode 100644 index 0000000..df1377e --- /dev/null +++ b/app.config @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/lib/Moq.dll b/lib/Moq.dll deleted file mode 100644 index 996b8c9..0000000 Binary files a/lib/Moq.dll and /dev/null differ diff --git a/lib/Moq.xml b/lib/Moq.xml deleted file mode 100644 index 0431a9e..0000000 --- a/lib/Moq.xml +++ /dev/null @@ -1,5449 +0,0 @@ - - - - Moq - - - - - Implements the fluent API. - - - - - The expectation will be considered only in the former condition. - - - - - - - The expectation will be considered only in the former condition. - - - - - - - - Setups the get. - - The type of the property. - The expression. - - - - - Setups the set. - - The type of the property. - The setter expression. - - - - - Setups the set. - - The setter expression. - - - - - Handle interception - - the current invocation context - shared data for the interceptor as a whole - shared data among the strategies during a single interception - InterceptionAction.Continue if further interception has to be processed, otherwise InterceptionAction.Stop - - - - Covarient interface for Mock<T> such that casts between IMock<Employee> to IMock<Person> - are possible. Only covers the covariant members of Mock<T>. - - - - - Exposes the mocked object instance. - - - - - Behavior of the mock, according to the value set in the constructor. - - - - - Whether the base member virtual implementation will be called - for mocked classes if no setup is matched. Defaults to . - - - - - Specifies the behavior to use when returning default values for - unexpected invocations on loose mocks. - - - - - Get an eventInfo for a given event name. Search type ancestors depth first if necessary. - - Name of the event, with the set_ or get_ prefix already removed - - - - Get an eventInfo for a given event name. Search type ancestors depth first if necessary. - Searches also in non public events. - - Name of the event, with the set_ or get_ prefix already removed - - - - Given a type return all of its ancestors, both types and interfaces. - - The type to find immediate ancestors of - - - - Defines the Callback verb and overloads. - - - - - Helper interface used to hide the base - members from the fluent API to make it much cleaner - in Visual Studio intellisense. - - - - - - - - - - - - - - - - - Specifies a callback to invoke when the method is called. - - The callback method to invoke. - - The following example specifies a callback to set a boolean - value that can be used later: - - var called = false; - mock.Setup(x => x.Execute()) - .Callback(() => called = true); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The argument type of the invoked method. - The callback method to invoke. - - Invokes the given callback with the concrete invocation argument value. - - Notice how the specific string argument is retrieved by simply declaring - it as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute(It.IsAny<string>())) - .Callback((string command) => Console.WriteLine(command)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2) => Console.WriteLine(arg1 + arg2)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3) => Console.WriteLine(arg1 + arg2 + arg3)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4) => Console.WriteLine(arg1 + arg2 + arg3 + arg4)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11, string arg12) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11, string arg12, string arg13) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The type of the fourteenth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11, string arg12, string arg13, string arg14) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13 + arg14)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The type of the fourteenth argument of the invoked method. - The type of the fifteenth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11, string arg12, string arg13, string arg14, string arg15) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13 + arg14 + arg15)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The type of the fourteenth argument of the invoked method. - The type of the fifteenth argument of the invoked method. - The type of the sixteenth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11, string arg12, string arg13, string arg14, string arg15, string arg16) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13 + arg14 + arg15 + arg16)); - - - - - - Defines the Callback verb and overloads for callbacks on - setups that return a value. - - Mocked type. - Type of the return value of the setup. - - - - Specifies a callback to invoke when the method is called. - - The callback method to invoke. - - The following example specifies a callback to set a boolean value that can be used later: - - var called = false; - mock.Setup(x => x.Execute()) - .Callback(() => called = true) - .Returns(true); - - Note that in the case of value-returning methods, after the Callback - call you can still specify the return value. - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the argument of the invoked method. - Callback method to invoke. - - Invokes the given callback with the concrete invocation argument value. - - Notice how the specific string argument is retrieved by simply declaring - it as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute(It.IsAny<string>())) - .Callback(command => Console.WriteLine(command)) - .Returns(true); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2) => Console.WriteLine(arg1 + arg2)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3) => Console.WriteLine(arg1 + arg2 + arg3)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4) => Console.WriteLine(arg1 + arg2 + arg3 + arg4)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6, arg7) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11, arg12) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11, arg12, arg13) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The type of the fourteenth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11, arg12, arg13, arg14) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13 + arg14)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The type of the fourteenth argument of the invoked method. - The type of the fifteenth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11, arg12, arg13, arg14, arg15) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13 + arg14 + arg15)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The type of the fourteenth argument of the invoked method. - The type of the fifteenth argument of the invoked method. - The type of the sixteenth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11, arg12, arg13, arg14, arg15, arg16) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13 + arg14 + arg15 + arg16)); - - - - - - Defines the Raises verb. - - - - - Specifies the event that will be raised - when the setup is met. - - An expression that represents an event attach or detach action. - The event arguments to pass for the raised event. - - The following example shows how to raise an event when - the setup is met: - - var mock = new Mock<IContainer>(); - - mock.Setup(add => add.Add(It.IsAny<string>(), It.IsAny<object>())) - .Raises(add => add.Added += null, EventArgs.Empty); - - - - - - Specifies the event that will be raised - when the setup is matched. - - An expression that represents an event attach or detach action. - A function that will build the - to pass when raising the event. - - - - - Specifies the custom event that will be raised - when the setup is matched. - - An expression that represents an event attach or detach action. - The arguments to pass to the custom delegate (non EventHandler-compatible). - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - The type of the seventh argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - The type of the seventh argument received by the expected invocation. - The type of the eighth argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - The type of the seventh argument received by the expected invocation. - The type of the eighth argument received by the expected invocation. - The type of the nineth argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - The type of the seventh argument received by the expected invocation. - The type of the eighth argument received by the expected invocation. - The type of the nineth argument received by the expected invocation. - The type of the tenth argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - The type of the seventh argument received by the expected invocation. - The type of the eighth argument received by the expected invocation. - The type of the nineth argument received by the expected invocation. - The type of the tenth argument received by the expected invocation. - The type of the eleventh argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - The type of the seventh argument received by the expected invocation. - The type of the eighth argument received by the expected invocation. - The type of the nineth argument received by the expected invocation. - The type of the tenth argument received by the expected invocation. - The type of the eleventh argument received by the expected invocation. - The type of the twelfth argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - The type of the seventh argument received by the expected invocation. - The type of the eighth argument received by the expected invocation. - The type of the nineth argument received by the expected invocation. - The type of the tenth argument received by the expected invocation. - The type of the eleventh argument received by the expected invocation. - The type of the twelfth argument received by the expected invocation. - The type of the thirteenth argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - The type of the seventh argument received by the expected invocation. - The type of the eighth argument received by the expected invocation. - The type of the nineth argument received by the expected invocation. - The type of the tenth argument received by the expected invocation. - The type of the eleventh argument received by the expected invocation. - The type of the twelfth argument received by the expected invocation. - The type of the thirteenth argument received by the expected invocation. - The type of the fourteenth argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - The type of the seventh argument received by the expected invocation. - The type of the eighth argument received by the expected invocation. - The type of the nineth argument received by the expected invocation. - The type of the tenth argument received by the expected invocation. - The type of the eleventh argument received by the expected invocation. - The type of the twelfth argument received by the expected invocation. - The type of the thirteenth argument received by the expected invocation. - The type of the fourteenth argument received by the expected invocation. - The type of the fifteenth argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - The type of the seventh argument received by the expected invocation. - The type of the eighth argument received by the expected invocation. - The type of the nineth argument received by the expected invocation. - The type of the tenth argument received by the expected invocation. - The type of the eleventh argument received by the expected invocation. - The type of the twelfth argument received by the expected invocation. - The type of the thirteenth argument received by the expected invocation. - The type of the fourteenth argument received by the expected invocation. - The type of the fifteenth argument received by the expected invocation. - The type of the sixteenth argument received by the expected invocation. - - - - - Defines the Returns verb. - - Mocked type. - Type of the return value from the expression. - - - - Specifies the value to return. - - The value to return, or . - - Return a true value from the method call: - - mock.Setup(x => x.Execute("ping")) - .Returns(true); - - - - - - Specifies a function that will calculate the value to return from the method. - - The function that will calculate the return value. - - Return a calculated value when the method is called: - - mock.Setup(x => x.Execute("ping")) - .Returns(() => returnValues[0]); - - The lambda expression to retrieve the return value is lazy-executed, - meaning that its value may change depending on the moment the method - is executed and the value the returnValues array has at - that moment. - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the argument of the invoked method. - The function that will calculate the return value. - - Return a calculated value which is evaluated lazily at the time of the invocation. - - The lookup list can change between invocations and the setup - will return different values accordingly. Also, notice how the specific - string argument is retrieved by simply declaring it as part of the lambda - expression: - - - mock.Setup(x => x.Execute(It.IsAny<string>())) - .Returns((string command) => returnValues[command]); - - - - - - Calls the real method of the object and returns its return value. - - The value calculated by the real method of the object. - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2) => arg1 + arg2); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3) => arg1 + arg2 + arg3); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4) => arg1 + arg2 + arg3 + arg4); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5) => arg1 + arg2 + arg3 + arg4 + arg5); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11, string arg12) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11, string arg12, string arg13) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The type of the fourteenth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11, string arg12, string arg13, string arg14) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13 + arg14); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The type of the fourteenth argument of the invoked method. - The type of the fifteenth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11, string arg12, string arg13, string arg14, string arg15) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13 + arg14 + arg15); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The type of the fourteenth argument of the invoked method. - The type of the fifteenth argument of the invoked method. - The type of the sixteenth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11, string arg12, string arg13, string arg14, string arg15, string arg16) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13 + arg14 + arg15 + arg16); - - - - - - Hook used to tells Castle which methods to proxy in mocked classes. - - Here we proxy the default methods Castle suggests (everything Object's methods) - plus Object.ToString(), so we can give mocks useful default names. - - This is required to allow Moq to mock ToString on proxy *class* implementations. - - - - - Extends AllMethodsHook.ShouldInterceptMethod to also intercept Object.ToString(). - - - - - The base class used for all our interface-inheriting proxies, which overrides the default - Object.ToString() behavior, to route it via the mock by default, unless overriden by a - real implementation. - - This is required to allow Moq to mock ToString on proxy *interface* implementations. - - - This is internal to Moq and should not be generally used. - - Unfortunately it must be public, due to cross-assembly visibility issues with reflection, - see github.com/Moq/moq4/issues/98 for details. - - - - - Overrides the default ToString implementation to instead find the mock for this mock.Object, - and return MockName + '.Object' as the mocked object's ToString, to make it easy to relate - mocks and mock object instances in error messages. - - - - - Defines async extension methods on IReturns. - - - - - Allows to specify the return value of an asynchronous method. - - - - - Allows to specify the exception thrown by an asynchronous method. - - - - - Language for ReturnSequence - - - - - Returns value - - - - - Throws an exception - - - - - Throws an exception - - - - - Calls original method - - - - - The first method call or member access will be the - last segment of the expression (depth-first traversal), - which is the one we have to Setup rather than FluentMock. - And the last one is the one we have to Mock.Get rather - than FluentMock. - - - - - Base class for mocks and static helper class with methods that - apply to mocked objects, such as to - retrieve a from an object instance. - - - - - Creates an mock object of the indicated type. - - The type of the mocked object. - The mocked object created. - - - - Creates an mock object of the indicated type. - - The predicate with the specification of how the mocked object should behave. - The type of the mocked object. - The mocked object created. - - - - Initializes a new instance of the class. - - - - - Retrieves the mock object for the given object instance. - - Type of the mock to retrieve. Can be omitted as it's inferred - from the object instance passed in as the instance. - The instance of the mocked object.The mock associated with the mocked object. - The received instance - was not created by Moq. - - The following example shows how to add a new setup to an object - instance which is not the original but rather - the object associated with it: - - // Typed instance, not the mock, is retrieved from some test API. - HttpContextBase context = GetMockContext(); - - // context.Request is the typed object from the "real" API - // so in order to add a setup to it, we need to get - // the mock that "owns" it - Mock<HttpRequestBase> request = Mock.Get(context.Request); - mock.Setup(req => req.AppRelativeCurrentExecutionFilePath) - .Returns(tempUrl); - - - - - - Returns the mocked object value. - - - - - Verifies that all verifiable expectations have been met. - - This example sets up an expectation and marks it as verifiable. After - the mock is used, a Verify() call is issued on the mock - to ensure the method in the setup was invoked: - - var mock = new Mock<IWarehouse>(); - this.Setup(x => x.HasInventory(TALISKER, 50)).Verifiable().Returns(true); - ... - // other test code - ... - // Will throw if the test code has didn't call HasInventory. - this.Verify(); - - Not all verifiable expectations were met. - - - - Verifies all expectations regardless of whether they have - been flagged as verifiable. - - This example sets up an expectation without marking it as verifiable. After - the mock is used, a call is issued on the mock - to ensure that all expectations are met: - - var mock = new Mock<IWarehouse>(); - this.Setup(x => x.HasInventory(TALISKER, 50)).Returns(true); - ... - // other test code - ... - // Will throw if the test code has didn't call HasInventory, even - // that expectation was not marked as verifiable. - this.VerifyAll(); - - At least one expectation was not met. - - - - Gets the interceptor target for the given expression and root mock, - building the intermediate hierarchy of mock objects if necessary. - - - - - Raises the associated event with the given - event argument data. - - - - - Raises the associated event with the given - event argument data. - - - - - Adds an interface implementation to the mock, - allowing setups to be specified for it. - - This method can only be called before the first use - of the mock property, at which - point the runtime type has already been generated - and no more interfaces can be added to it. - - Also, must be an - interface and not a class, which must be specified - when creating the mock instead. - - - The mock type - has already been generated by accessing the property. - - The specified - is not an interface. - - The following example creates a mock for the main interface - and later adds to it to verify - it's called by the consumer code: - - var mock = new Mock<IProcessor>(); - mock.Setup(x => x.Execute("ping")); - - // add IDisposable interface - var disposable = mock.As<IDisposable>(); - disposable.Setup(d => d.Dispose()).Verifiable(); - - Type of interface to cast the mock to. - - - - - - - Behavior of the mock, according to the value set in the constructor. - - - - - Whether the base member virtual implementation will be called - for mocked classes if no setup is matched. Defaults to . - - - - - Specifies the behavior to use when returning default values for - unexpected invocations on loose mocks. - - - - - Gets the mocked object instance. - - - - - Retrieves the type of the mocked object, its generic type argument. - This is used in the auto-mocking of hierarchy access. - - - - - If this is a mock of a delegate, this property contains the method - on the autogenerated interface so that we can convert setup + verify - expressions on the delegate into expressions on the interface proxy. - - - - - Allows to check whether expression conversion to the - must be performed on the mock, without causing unnecessarily early initialization of - the mock instance, which breaks As{T}. - - - - - Specifies the class that will determine the default - value to return when invocations are made that - have no setups and need to return a default - value (for loose mocks). - - - - - Exposes the list of extra interfaces implemented by the mock. - - - - - Utility repository class to use to construct multiple - mocks when consistent verification is - desired for all of them. - - - If multiple mocks will be created during a test, passing - the desired (if different than the - or the one - passed to the repository constructor) and later verifying each - mock can become repetitive and tedious. - - This repository class helps in that scenario by providing a - simplified creation of multiple mocks with a default - (unless overriden by calling - ) and posterior verification. - - - - The following is a straightforward example on how to - create and automatically verify strict mocks using a : - - var repository = new MockRepository(MockBehavior.Strict); - - var foo = repository.Create<IFoo>(); - var bar = repository.Create<IBar>(); - - // no need to call Verifiable() on the setup - // as we'll be validating all of them anyway. - foo.Setup(f => f.Do()); - bar.Setup(b => b.Redo()); - - // exercise the mocks here - - repository.VerifyAll(); - // At this point all setups are already checked - // and an optional MockException might be thrown. - // Note also that because the mocks are strict, any invocation - // that doesn't have a matching setup will also throw a MockException. - - The following examples shows how to setup the repository - to create loose mocks and later verify only verifiable setups: - - var repository = new MockRepository(MockBehavior.Loose); - - var foo = repository.Create<IFoo>(); - var bar = repository.Create<IBar>(); - - // this setup will be verified when we verify the repository - foo.Setup(f => f.Do()).Verifiable(); - - // this setup will NOT be verified - foo.Setup(f => f.Calculate()); - - // this setup will be verified when we verify the repository - bar.Setup(b => b.Redo()).Verifiable(); - - // exercise the mocks here - // note that because the mocks are Loose, members - // called in the interfaces for which no matching - // setups exist will NOT throw exceptions, - // and will rather return default values. - - repository.Verify(); - // At this point verifiable setups are already checked - // and an optional MockException might be thrown. - - The following examples shows how to setup the repository with a - default strict behavior, overriding that default for a - specific mock: - - var repository = new MockRepository(MockBehavior.Strict); - - // this particular one we want loose - var foo = repository.Create<IFoo>(MockBehavior.Loose); - var bar = repository.Create<IBar>(); - - // specify setups - - // exercise the mocks here - - repository.Verify(); - - - - - - - Utility factory class to use to construct multiple - mocks when consistent verification is - desired for all of them. - - - If multiple mocks will be created during a test, passing - the desired (if different than the - or the one - passed to the factory constructor) and later verifying each - mock can become repetitive and tedious. - - This factory class helps in that scenario by providing a - simplified creation of multiple mocks with a default - (unless overriden by calling - ) and posterior verification. - - - - The following is a straightforward example on how to - create and automatically verify strict mocks using a : - - var factory = new MockFactory(MockBehavior.Strict); - - var foo = factory.Create<IFoo>(); - var bar = factory.Create<IBar>(); - - // no need to call Verifiable() on the setup - // as we'll be validating all of them anyway. - foo.Setup(f => f.Do()); - bar.Setup(b => b.Redo()); - - // exercise the mocks here - - factory.VerifyAll(); - // At this point all setups are already checked - // and an optional MockException might be thrown. - // Note also that because the mocks are strict, any invocation - // that doesn't have a matching setup will also throw a MockException. - - The following examples shows how to setup the factory - to create loose mocks and later verify only verifiable setups: - - var factory = new MockFactory(MockBehavior.Loose); - - var foo = factory.Create<IFoo>(); - var bar = factory.Create<IBar>(); - - // this setup will be verified when we verify the factory - foo.Setup(f => f.Do()).Verifiable(); - - // this setup will NOT be verified - foo.Setup(f => f.Calculate()); - - // this setup will be verified when we verify the factory - bar.Setup(b => b.Redo()).Verifiable(); - - // exercise the mocks here - // note that because the mocks are Loose, members - // called in the interfaces for which no matching - // setups exist will NOT throw exceptions, - // and will rather return default values. - - factory.Verify(); - // At this point verifiable setups are already checked - // and an optional MockException might be thrown. - - The following examples shows how to setup the factory with a - default strict behavior, overriding that default for a - specific mock: - - var factory = new MockFactory(MockBehavior.Strict); - - // this particular one we want loose - var foo = factory.Create<IFoo>(MockBehavior.Loose); - var bar = factory.Create<IBar>(); - - // specify setups - - // exercise the mocks here - - factory.Verify(); - - - - - - - Initializes the factory with the given - for newly created mocks from the factory. - - The behavior to use for mocks created - using the factory method if not overriden - by using the overload. - - - - Creates a new mock with the default - specified at factory construction time. - - Type to mock. - A new . - - - var factory = new MockFactory(MockBehavior.Strict); - - var foo = factory.Create<IFoo>(); - // use mock on tests - - factory.VerifyAll(); - - - - - - Creates a new mock with the default - specified at factory construction time and with the - the given constructor arguments for the class. - - - The mock will try to find the best match constructor given the - constructor arguments, and invoke that to initialize the instance. - This applies only to classes, not interfaces. - - Type to mock. - Constructor arguments for mocked classes. - A new . - - - var factory = new MockFactory(MockBehavior.Default); - - var mock = factory.Create<MyBase>("Foo", 25, true); - // use mock on tests - - factory.Verify(); - - - - - - Creates a new mock with the given . - - Type to mock. - Behavior to use for the mock, which overrides - the default behavior specified at factory construction time. - A new . - - The following example shows how to create a mock with a different - behavior to that specified as the default for the factory: - - var factory = new MockFactory(MockBehavior.Strict); - - var foo = factory.Create<IFoo>(MockBehavior.Loose); - - - - - - Creates a new mock with the given - and with the the given constructor arguments for the class. - - - The mock will try to find the best match constructor given the - constructor arguments, and invoke that to initialize the instance. - This applies only to classes, not interfaces. - - Type to mock. - Behavior to use for the mock, which overrides - the default behavior specified at factory construction time. - Constructor arguments for mocked classes. - A new . - - The following example shows how to create a mock with a different - behavior to that specified as the default for the factory, passing - constructor arguments: - - var factory = new MockFactory(MockBehavior.Default); - - var mock = factory.Create<MyBase>(MockBehavior.Strict, "Foo", 25, true); - - - - - - Implements creation of a new mock within the factory. - - Type to mock. - The behavior for the new mock. - Optional arguments for the construction of the mock. - - - - Verifies all verifiable expectations on all mocks created - by this factory. - - - One or more mocks had expectations that were not satisfied. - - - - Verifies all verifiable expectations on all mocks created - by this factory. - - - One or more mocks had expectations that were not satisfied. - - - - Invokes for each mock - in , and accumulates the resulting - that might be - thrown from the action. - - The action to execute against - each mock. - - - - Whether the base member virtual implementation will be called - for mocked classes if no setup is matched. Defaults to . - - - - - Specifies the behavior to use when returning default values for - unexpected invocations on loose mocks. - - - - - Gets the mocks that have been created by this factory and - that will get verified together. - - - - - Access the universe of mocks of the given type, to retrieve those - that behave according to the LINQ query specification. - - The type of the mocked object to query. - - - - Access the universe of mocks of the given type, to retrieve those - that behave according to the LINQ query specification. - - The predicate with the setup expressions. - The type of the mocked object to query. - - - - Creates an mock object of the indicated type. - - The type of the mocked object. - The mocked object created. - - - - Creates an mock object of the indicated type. - - The predicate with the setup expressions. - The type of the mocked object. - The mocked object created. - - - - Creates the mock query with the underlying queriable implementation. - - - - - Wraps the enumerator inside a queryable. - - - - - Method that is turned into the actual call from .Query{T}, to - transform the queryable query into a normal enumerable query. - This method is never used directly by consumers. - - - - - Initializes the repository with the given - for newly created mocks from the repository. - - The behavior to use for mocks created - using the repository method if not overriden - by using the overload. - - - - A that returns an empty default value - for invocations that do not have setups or return values, with loose mocks. - This is the default behavior for a mock. - - - - - Interface to be implemented by classes that determine the - default value of non-expected invocations. - - - - - Defines the default value to return in all the methods returning . - The type of the return value.The value to set as default. - - - - Provides a value for the given member and arguments. - - The member to provide a default value for. - - - - - The intention of is to create a more readable - string representation for the failure message. - - - - - Implements the fluent API. - - - - - Defines the Throws verb. - - - - - Specifies the exception to throw when the method is invoked. - - Exception instance to throw. - - This example shows how to throw an exception when the method is - invoked with an empty string argument: - - mock.Setup(x => x.Execute("")) - .Throws(new ArgumentException()); - - - - - - Specifies the type of exception to throw when the method is invoked. - - Type of exception to instantiate and throw when the setup is matched. - - This example shows how to throw an exception when the method is - invoked with an empty string argument: - - mock.Setup(x => x.Execute("")) - .Throws<ArgumentException>(); - - - - - - Implements the fluent API. - - - - - Defines occurrence members to constraint setups. - - - - - The expected invocation can happen at most once. - - - - var mock = new Mock<ICommand>(); - mock.Setup(foo => foo.Execute("ping")) - .AtMostOnce(); - - - - - - The expected invocation can happen at most specified number of times. - - The number of times to accept calls. - - - var mock = new Mock<ICommand>(); - mock.Setup(foo => foo.Execute("ping")) - .AtMost( 5 ); - - - - - - Defines the Verifiable verb. - - - - - Marks the expectation as verifiable, meaning that a call - to will check if this particular - expectation was met. - - - The following example marks the expectation as verifiable: - - mock.Expect(x => x.Execute("ping")) - .Returns(true) - .Verifiable(); - - - - - - Marks the expectation as verifiable, meaning that a call - to will check if this particular - expectation was met, and specifies a message for failures. - - - The following example marks the expectation as verifiable: - - mock.Expect(x => x.Execute("ping")) - .Returns(true) - .Verifiable("Ping should be executed always!"); - - - - - - Implements the fluent API. - - - - - We need this non-generics base class so that - we can use from - generic code. - - - - - Implements the fluent API. - - - - - Implements the fluent API. - - - - - Implements the fluent API. - - - - - Defines the Callback verb for property getter setups. - - - Mocked type. - Type of the property. - - - - Specifies a callback to invoke when the property is retrieved. - - Callback method to invoke. - - Invokes the given callback with the property value being set. - - mock.SetupGet(x => x.Suspended) - .Callback(() => called = true) - .Returns(true); - - - - - - Implements the fluent API. - - - - - Defines the Returns verb for property get setups. - - Mocked type. - Type of the property. - - - - Specifies the value to return. - - The value to return, or . - - Return a true value from the property getter call: - - mock.SetupGet(x => x.Suspended) - .Returns(true); - - - - - - Specifies a function that will calculate the value to return for the property. - - The function that will calculate the return value. - - Return a calculated value when the property is retrieved: - - mock.SetupGet(x => x.Suspended) - .Returns(() => returnValues[0]); - - The lambda expression to retrieve the return value is lazy-executed, - meaning that its value may change depending on the moment the property - is retrieved and the value the returnValues array has at - that moment. - - - - - Calls the real property of the object and returns its return value. - - The value calculated by the real property of the object. - - - - Implements the fluent API. - - - - - Provides additional methods on mocks. - - - Those methods are useful for Testeroids support. - - - - - Resets the calls previously made on the specified mock. - - The mock whose calls need to be reset. - - - - Helper class to setup a full trace between many mocks - - - - - Initialize a trace setup - - - - - Allow sequence to be repeated - - - - - define nice api - - - - - Perform an expectation in the trace. - - - - - Marks a method as a matcher, which allows complete replacement - of the built-in class with your own argument - matching rules. - - - This feature has been deprecated in favor of the new - and simpler . - - - The argument matching is used to determine whether a concrete - invocation in the mock matches a given setup. This - matching mechanism is fully extensible. - - - There are two parts of a matcher: the compiler matcher - and the runtime matcher. - - - Compiler matcher - Used to satisfy the compiler requirements for the - argument. Needs to be a method optionally receiving any arguments - you might need for the matching, but with a return type that - matches that of the argument. - - Let's say I want to match a lists of orders that contains - a particular one. I might create a compiler matcher like the following: - - - public static class Orders - { - [Matcher] - public static IEnumerable<Order> Contains(Order order) - { - return null; - } - } - - Now we can invoke this static method instead of an argument in an - invocation: - - var order = new Order { ... }; - var mock = new Mock<IRepository<Order>>(); - - mock.Setup(x => x.Save(Orders.Contains(order))) - .Throws<ArgumentException>(); - - Note that the return value from the compiler matcher is irrelevant. - This method will never be called, and is just used to satisfy the - compiler and to signal Moq that this is not a method that we want - to be invoked at runtime. - - - - Runtime matcher - - The runtime matcher is the one that will actually perform evaluation - when the test is run, and is defined by convention to have the - same signature as the compiler matcher, but where the return - value is the first argument to the call, which contains the - object received by the actual invocation at runtime: - - public static bool Contains(IEnumerable<Order> orders, Order order) - { - return orders.Contains(order); - } - - At runtime, the mocked method will be invoked with a specific - list of orders. This value will be passed to this runtime - matcher as the first argument, while the second argument is the - one specified in the setup (x.Save(Orders.Contains(order))). - - The boolean returned determines whether the given argument has been - matched. If all arguments to the expected method are matched, then - the setup matches and is evaluated. - - - - - - Using this extensible infrastructure, you can easily replace the entire - set of matchers with your own. You can also avoid the - typical (and annoying) lengthy expressions that result when you have - multiple arguments that use generics. - - - The following is the complete example explained above: - - public static class Orders - { - [Matcher] - public static IEnumerable<Order> Contains(Order order) - { - return null; - } - - public static bool Contains(IEnumerable<Order> orders, Order order) - { - return orders.Contains(order); - } - } - - And the concrete test using this matcher: - - var order = new Order { ... }; - var mock = new Mock<IRepository<Order>>(); - - mock.Setup(x => x.Save(Orders.Contains(order))) - .Throws<ArgumentException>(); - - // use mock, invoke Save, and have the matcher filter. - - - - - - Provides a mock implementation of . - - Any interface type can be used for mocking, but for classes, only abstract and virtual members can be mocked. - - The behavior of the mock with regards to the setups and the actual calls is determined - by the optional that can be passed to the - constructor. - - Type to mock, which can be an interface or a class. - The following example shows establishing setups with specific values - for method invocations: - - // Arrange - var order = new Order(TALISKER, 50); - var mock = new Mock<IWarehouse>(); - - mock.Setup(x => x.HasInventory(TALISKER, 50)).Returns(true); - - // Act - order.Fill(mock.Object); - - // Assert - Assert.True(order.IsFilled); - - The following example shows how to use the class - to specify conditions for arguments instead of specific values: - - // Arrange - var order = new Order(TALISKER, 50); - var mock = new Mock<IWarehouse>(); - - // shows how to expect a value within a range - mock.Setup(x => x.HasInventory( - It.IsAny<string>(), - It.IsInRange(0, 100, Range.Inclusive))) - .Returns(false); - - // shows how to throw for unexpected calls. - mock.Setup(x => x.Remove( - It.IsAny<string>(), - It.IsAny<int>())) - .Throws(new InvalidOperationException()); - - // Act - order.Fill(mock.Object); - - // Assert - Assert.False(order.IsFilled); - - - - - - Obsolete. - - - - - Obsolete. - - - - - Obsolete. - - - - - Obsolete. - - - - - Obsolete. - - - - - Ctor invoked by AsTInterface exclusively. - - - - - Initializes an instance of the mock with default behavior. - - var mock = new Mock<IFormatProvider>(); - - - - - Initializes an instance of the mock with default behavior and with - the given constructor arguments for the class. (Only valid when is a class) - - The mock will try to find the best match constructor given the constructor arguments, and invoke that - to initialize the instance. This applies only for classes, not interfaces. - - var mock = new Mock<MyProvider>(someArgument, 25); - Optional constructor arguments if the mocked type is a class. - - - - Initializes an instance of the mock with the specified behavior. - - var mock = new Mock<IFormatProvider>(MockBehavior.Relaxed); - Behavior of the mock. - - - - Initializes an instance of the mock with a specific behavior with - the given constructor arguments for the class. - - The mock will try to find the best match constructor given the constructor arguments, and invoke that - to initialize the instance. This applies only to classes, not interfaces. - - var mock = new Mock<MyProvider>(someArgument, 25); - Behavior of the mock.Optional constructor arguments if the mocked type is a class. - - - - Returns the name of the mock - - - - - Returns the mocked object value. - - - - - Specifies a setup on the mocked type for a call to - to a void method. - - If more than one setup is specified for the same method or property, - the latest one wins and is the one that will be executed. - Lambda expression that specifies the expected method invocation. - - var mock = new Mock<IProcessor>(); - mock.Setup(x => x.Execute("ping")); - - - - - - Specifies a setup on the mocked type for a call to - to a value returning method. - Type of the return value. Typically omitted as it can be inferred from the expression. - If more than one setup is specified for the same method or property, - the latest one wins and is the one that will be executed. - Lambda expression that specifies the method invocation. - - mock.Setup(x => x.HasInventory("Talisker", 50)).Returns(true); - - - - - - Specifies a setup on the mocked type for a call to - to a property getter. - - If more than one setup is set for the same property getter, - the latest one wins and is the one that will be executed. - Type of the property. Typically omitted as it can be inferred from the expression.Lambda expression that specifies the property getter. - - mock.SetupGet(x => x.Suspended) - .Returns(true); - - - - - - Specifies a setup on the mocked type for a call to - to a property setter. - - If more than one setup is set for the same property setter, - the latest one wins and is the one that will be executed. - - This overloads allows the use of a callback already - typed for the property type. - - Type of the property. Typically omitted as it can be inferred from the expression.The Lambda expression that sets a property to a value. - - mock.SetupSet(x => x.Suspended = true); - - - - - - Specifies a setup on the mocked type for a call to - to a property setter. - - If more than one setup is set for the same property setter, - the latest one wins and is the one that will be executed. - Lambda expression that sets a property to a value. - - mock.SetupSet(x => x.Suspended = true); - - - - - - Specifies that the given property should have "property behavior", - meaning that setting its value will cause it to be saved and - later returned when the property is requested. (this is also - known as "stubbing"). - - Type of the property, inferred from the property - expression (does not need to be specified). - Property expression to stub. - If you have an interface with an int property Value, you might - stub it using the following straightforward call: - - var mock = new Mock<IHaveValue>(); - mock.Stub(v => v.Value); - - After the Stub call has been issued, setting and - retrieving the object value will behave as expected: - - IHaveValue v = mock.Object; - - v.Value = 5; - Assert.Equal(5, v.Value); - - - - - - Specifies that the given property should have "property behavior", - meaning that setting its value will cause it to be saved and - later returned when the property is requested. This overload - allows setting the initial value for the property. (this is also - known as "stubbing"). - - Type of the property, inferred from the property - expression (does not need to be specified). - Property expression to stub.Initial value for the property. - If you have an interface with an int property Value, you might - stub it using the following straightforward call: - - var mock = new Mock<IHaveValue>(); - mock.SetupProperty(v => v.Value, 5); - - After the SetupProperty call has been issued, setting and - retrieving the object value will behave as expected: - - IHaveValue v = mock.Object; - // Initial value was stored - Assert.Equal(5, v.Value); - - // New value set which changes the initial value - v.Value = 6; - Assert.Equal(6, v.Value); - - - - - - Specifies that the all properties on the mock should have "property behavior", - meaning that setting its value will cause it to be saved and - later returned when the property is requested. (this is also - known as "stubbing"). The default value for each property will be the - one generated as specified by the property for the mock. - - If the mock is set to , - the mocked default values will also get all properties setup recursively. - - - - - - - - Verifies that a specific invocation matching the given expression was performed on the mock. Use - in conjuntion with the default . - - This example assumes that the mock has been used, and later we want to verify that a given - invocation with specific parameters was performed: - - var mock = new Mock<IProcessor>(); - // exercise mock - //... - // Will throw if the test code didn't call Execute with a "ping" string argument. - mock.Verify(proc => proc.Execute("ping")); - - The invocation was not performed on the mock.Expression to verify. - - - - Verifies that a specific invocation matching the given expression was performed on the mock. Use - in conjuntion with the default . - - The invocation was not call the times specified by - . - Expression to verify.The number of times a method is allowed to be called. - - - - Verifies that a specific invocation matching the given expression was performed on the mock. Use - in conjuntion with the default . - - The invocation was not call the times specified by - . - Expression to verify.The number of times a method is allowed to be called. - - - - Verifies that a specific invocation matching the given expression was performed on the mock, - specifying a failure error message. Use in conjuntion with the default - . - - This example assumes that the mock has been used, and later we want to verify that a given - invocation with specific parameters was performed: - - var mock = new Mock<IProcessor>(); - // exercise mock - //... - // Will throw if the test code didn't call Execute with a "ping" string argument. - mock.Verify(proc => proc.Execute("ping")); - - The invocation was not performed on the mock.Expression to verify.Message to show if verification fails. - - - - Verifies that a specific invocation matching the given expression was performed on the mock, - specifying a failure error message. Use in conjuntion with the default - . - - The invocation was not call the times specified by - . - Expression to verify.The number of times a method is allowed to be called.Message to show if verification fails. - - - - Verifies that a specific invocation matching the given expression was performed on the mock, - specifying a failure error message. Use in conjuntion with the default - . - - The invocation was not call the times specified by - . - Expression to verify.The number of times a method is allowed to be called.Message to show if verification fails. - - - - Verifies that a specific invocation matching the given expression was performed on the mock. Use - in conjuntion with the default . - - This example assumes that the mock has been used, and later we want to verify that a given - invocation with specific parameters was performed: - - var mock = new Mock<IWarehouse>(); - // exercise mock - //... - // Will throw if the test code didn't call HasInventory. - mock.Verify(warehouse => warehouse.HasInventory(TALISKER, 50)); - - The invocation was not performed on the mock.Expression to verify.Type of return value from the expression. - - - - Verifies that a specific invocation matching the given - expression was performed on the mock. Use in conjuntion - with the default . - - The invocation was not call the times specified by - . - Expression to verify.The number of times a method is allowed to be called.Type of return value from the expression. - - - - Verifies that a specific invocation matching the given - expression was performed on the mock. Use in conjuntion - with the default . - - The invocation was not call the times specified by - . - Expression to verify.The number of times a method is allowed to be called.Type of return value from the expression. - - - - Verifies that a specific invocation matching the given - expression was performed on the mock, specifying a failure - error message. - - This example assumes that the mock has been used, - and later we want to verify that a given invocation - with specific parameters was performed: - - var mock = new Mock<IWarehouse>(); - // exercise mock - //... - // Will throw if the test code didn't call HasInventory. - mock.Verify(warehouse => warehouse.HasInventory(TALISKER, 50), "When filling orders, inventory has to be checked"); - - The invocation was not performed on the mock.Expression to verify.Message to show if verification fails.Type of return value from the expression. - - - - Verifies that a specific invocation matching the given - expression was performed on the mock, specifying a failure - error message. - - The invocation was not call the times specified by - . - Expression to verify.The number of times a method is allowed to be called.Message to show if verification fails.Type of return value from the expression. - - - - Verifies that a property was read on the mock. - - This example assumes that the mock has been used, - and later we want to verify that a given property - was retrieved from it: - - var mock = new Mock<IWarehouse>(); - // exercise mock - //... - // Will throw if the test code didn't retrieve the IsClosed property. - mock.VerifyGet(warehouse => warehouse.IsClosed); - - The invocation was not performed on the mock.Expression to verify. - Type of the property to verify. Typically omitted as it can - be inferred from the expression's return type. - - - - - Verifies that a property was read on the mock. - - The invocation was not call the times specified by - . - The number of times a method is allowed to be called.Expression to verify. - Type of the property to verify. Typically omitted as it can - be inferred from the expression's return type. - - - - - Verifies that a property was read on the mock. - - The invocation was not call the times specified by - . - The number of times a method is allowed to be called.Expression to verify. - Type of the property to verify. Typically omitted as it can - be inferred from the expression's return type. - - - - - Verifies that a property was read on the mock, specifying a failure - error message. - - This example assumes that the mock has been used, - and later we want to verify that a given property - was retrieved from it: - - var mock = new Mock<IWarehouse>(); - // exercise mock - //... - // Will throw if the test code didn't retrieve the IsClosed property. - mock.VerifyGet(warehouse => warehouse.IsClosed); - - The invocation was not performed on the mock.Expression to verify.Message to show if verification fails. - Type of the property to verify. Typically omitted as it can - be inferred from the expression's return type. - - - - - Verifies that a property was read on the mock, specifying a failure - error message. - - The invocation was not call the times specified by - . - The number of times a method is allowed to be called.Expression to verify.Message to show if verification fails. - Type of the property to verify. Typically omitted as it can - be inferred from the expression's return type. - - - - - Verifies that a property was read on the mock, specifying a failure - error message. - - The invocation was not call the times specified by - . - The number of times a method is allowed to be called.Expression to verify.Message to show if verification fails. - Type of the property to verify. Typically omitted as it can - be inferred from the expression's return type. - - - - - Verifies that a property was set on the mock. - - This example assumes that the mock has been used, - and later we want to verify that a given property - was set on it: - - var mock = new Mock<IWarehouse>(); - // exercise mock - //... - // Will throw if the test code didn't set the IsClosed property. - mock.VerifySet(warehouse => warehouse.IsClosed = true); - - The invocation was not performed on the mock.Expression to verify. - - - - Verifies that a property was set on the mock. - - The invocation was not call the times specified by - . - The number of times a method is allowed to be called.Expression to verify. - - - - Verifies that a property was set on the mock. - - The invocation was not call the times specified by - . - The number of times a method is allowed to be called.Expression to verify. - - - - Verifies that a property was set on the mock, specifying - a failure message. - - This example assumes that the mock has been used, - and later we want to verify that a given property - was set on it: - - var mock = new Mock<IWarehouse>(); - // exercise mock - //... - // Will throw if the test code didn't set the IsClosed property. - mock.VerifySet(warehouse => warehouse.IsClosed = true, "Warehouse should always be closed after the action"); - - The invocation was not performed on the mock.Expression to verify.Message to show if verification fails. - - - - Verifies that a property was set on the mock, specifying - a failure message. - - The invocation was not call the times specified by - . - The number of times a method is allowed to be called.Expression to verify.Message to show if verification fails. - - - - Verifies that a property was set on the mock, specifying - a failure message. - - The invocation was not call the times specified by - . - The number of times a method is allowed to be called.Expression to verify.Message to show if verification fails. - - - - Raises the event referenced in using - the given argument. - - The argument is - invalid for the target event invocation, or the is - not an event attach or detach expression. - - The following example shows how to raise a event: - - var mock = new Mock<IViewModel>(); - - mock.Raise(x => x.PropertyChanged -= null, new PropertyChangedEventArgs("Name")); - - - This example shows how to invoke an event with a custom event arguments - class in a view that will cause its corresponding presenter to - react by changing its state: - - var mockView = new Mock<IOrdersView>(); - var presenter = new OrdersPresenter(mockView.Object); - - // Check that the presenter has no selection by default - Assert.Null(presenter.SelectedOrder); - - // Raise the event with a specific arguments data - mockView.Raise(v => v.SelectionChanged += null, new OrderEventArgs { Order = new Order("moq", 500) }); - - // Now the presenter reacted to the event, and we have a selected order - Assert.NotNull(presenter.SelectedOrder); - Assert.Equal("moq", presenter.SelectedOrder.ProductName); - - - - - - Raises the event referenced in using - the given argument for a non-EventHandler typed event. - - The arguments are - invalid for the target event invocation, or the is - not an event attach or detach expression. - - The following example shows how to raise a custom event that does not adhere to - the standard EventHandler: - - var mock = new Mock<IViewModel>(); - - mock.Raise(x => x.MyEvent -= null, "Name", bool, 25); - - - - - - Exposes the mocked object instance. - - - - - Allows naming of your mocks, so they can be easily identified in error messages (e.g. from failed assertions). - - - - - - - - Provides legacy API members as extensions so that - existing code continues to compile, but new code - doesn't see then. - - - - - Obsolete. - - - - - Obsolete. - - - - - Obsolete. - - - - - Provides additional methods on mocks. - - - Provided as extension methods as they confuse the compiler - with the overloads taking Action. - - - - - Specifies a setup on the mocked type for a call to - to a property setter, regardless of its value. - - - If more than one setup is set for the same property setter, - the latest one wins and is the one that will be executed. - - Type of the property. Typically omitted as it can be inferred from the expression. - Type of the mock. - The target mock for the setup. - Lambda expression that specifies the property setter. - - - mock.SetupSet(x => x.Suspended); - - - - This method is not legacy, but must be on an extension method to avoid - confusing the compiler with the new Action syntax. - - - - - Verifies that a property has been set on the mock, regarless of its value. - - - This example assumes that the mock has been used, - and later we want to verify that a given invocation - with specific parameters was performed: - - var mock = new Mock<IWarehouse>(); - // exercise mock - //... - // Will throw if the test code didn't set the IsClosed property. - mock.VerifySet(warehouse => warehouse.IsClosed); - - - The invocation was not performed on the mock. - Expression to verify. - The mock instance. - Mocked type. - Type of the property to verify. Typically omitted as it can - be inferred from the expression's return type. - - - - Verifies that a property has been set on the mock, specifying a failure - error message. - - - This example assumes that the mock has been used, - and later we want to verify that a given invocation - with specific parameters was performed: - - var mock = new Mock<IWarehouse>(); - // exercise mock - //... - // Will throw if the test code didn't set the IsClosed property. - mock.VerifySet(warehouse => warehouse.IsClosed); - - - The invocation was not performed on the mock. - Expression to verify. - Message to show if verification fails. - The mock instance. - Mocked type. - Type of the property to verify. Typically omitted as it can - be inferred from the expression's return type. - - - - Verifies that a property has been set on the mock, regardless - of the value but only the specified number of times. - - - This example assumes that the mock has been used, - and later we want to verify that a given invocation - with specific parameters was performed: - - var mock = new Mock<IWarehouse>(); - // exercise mock - //... - // Will throw if the test code didn't set the IsClosed property. - mock.VerifySet(warehouse => warehouse.IsClosed); - - - The invocation was not performed on the mock. - The invocation was not call the times specified by - . - The mock instance. - Mocked type. - The number of times a method is allowed to be called. - Expression to verify. - Type of the property to verify. Typically omitted as it can - be inferred from the expression's return type. - - - - Verifies that a property has been set on the mock, regardless - of the value but only the specified number of times, and specifying a failure - error message. - - - This example assumes that the mock has been used, - and later we want to verify that a given invocation - with specific parameters was performed: - - var mock = new Mock<IWarehouse>(); - // exercise mock - //... - // Will throw if the test code didn't set the IsClosed property. - mock.VerifySet(warehouse => warehouse.IsClosed); - - - The invocation was not performed on the mock. - The invocation was not call the times specified by - . - The mock instance. - Mocked type. - The number of times a method is allowed to be called. - Message to show if verification fails. - Expression to verify. - Type of the property to verify. Typically omitted as it can - be inferred from the expression's return type. - - - - Helper for sequencing return values in the same method. - - - - - Return a sequence of values, once per call. - - - - - Casts the expression to a lambda expression, removing - a cast if there's any. - - - - - Casts the body of the lambda expression to a . - - If the body is not a method call. - - - - Converts the body of the lambda expression into the referenced by it. - - - - - Checks whether the body of the lambda expression is a property access. - - - - - Checks whether the expression is a property access. - - - - - Checks whether the body of the lambda expression is a property indexer, which is true - when the expression is an whose - has - equal to . - - - - - Checks whether the expression is a property indexer, which is true - when the expression is an whose - has - equal to . - - - - - Creates an expression that casts the given expression to the - type. - - - - - TODO: remove this code when https://connect.microsoft.com/VisualStudio/feedback/ViewFeedback.aspx?FeedbackID=331583 - is fixed. - - - - - Extracts, into a common form, information from a - around either a (for a normal method call) - or a (for a delegate invocation). - - - - - Tests if a type is a delegate type (subclasses ). - - - - - Provides partial evaluation of subtrees, whenever they can be evaluated locally. - - Matt Warren: http://blogs.msdn.com/mattwar - Documented by InSTEDD: http://www.instedd.org - - - - Performs evaluation and replacement of independent sub-trees - - The root of the expression tree. - A function that decides whether a given expression - node can be part of the local function. - A new tree with sub-trees evaluated and replaced. - - - - Performs evaluation and replacement of independent sub-trees - - The root of the expression tree. - A new tree with sub-trees evaluated and replaced. - - - - Evaluates and replaces sub-trees when first candidate is reached (top-down) - - - - - Performs bottom-up analysis to determine which nodes can possibly - be part of an evaluated sub-tree. - - - - - Ensures the given is not null. - Throws otherwise. - - - - - Ensures the given string is not null or empty. - Throws in the first case, or - in the latter. - - - - - Checks an argument to ensure it is in the specified range including the edges. - - Type of the argument to check, it must be an type. - - The expression containing the name of the argument. - The argument value to check. - The minimun allowed value for the argument. - The maximun allowed value for the argument. - - - - Checks an argument to ensure it is in the specified range excluding the edges. - - Type of the argument to check, it must be an type. - - The expression containing the name of the argument. - The argument value to check. - The minimun allowed value for the argument. - The maximun allowed value for the argument. - - - - Implemented by all generated mock object instances. - - - - - Implemented by all generated mock object instances. - - - - - Reference the Mock that contains this as the mock.Object value. - - - - - Reference the Mock that contains this as the mock.Object value. - - - - - Implements the actual interception and method invocation for - all mocks. - - - - - Implements the fluent API. - - - - - Defines the Callback verb for property setter setups. - - Type of the property. - - - - Specifies a callback to invoke when the property is set that receives the - property value being set. - - Callback method to invoke. - - Invokes the given callback with the property value being set. - - mock.SetupSet(x => x.Suspended) - .Callback((bool state) => Console.WriteLine(state)); - - - - - - Allows the specification of a matching condition for an - argument in a method invocation, rather than a specific - argument value. "It" refers to the argument being matched. - - This class allows the setup to match a method invocation - with an arbitrary value, with a value in a specified range, or - even one that matches a given predicate. - - - - - Matches any value of the given type. - - Typically used when the actual argument value for a method - call is not relevant. - - - // Throws an exception for a call to Remove with any string value. - mock.Setup(x => x.Remove(It.IsAny<string>())).Throws(new InvalidOperationException()); - - Type of the value. - - - - Matches any value of the given type, except null. - Type of the value. - - - - Matches any value that satisfies the given predicate. - Type of the argument to check.The predicate used to match the method argument. - Allows the specification of a predicate to perform matching - of method call arguments. - - This example shows how to return the value 1 whenever the argument to the - Do method is an even number. - - mock.Setup(x => x.Do(It.Is<int>(i => i % 2 == 0))) - .Returns(1); - - This example shows how to throw an exception if the argument to the - method is a negative number: - - mock.Setup(x => x.GetUser(It.Is<int>(i => i < 0))) - .Throws(new ArgumentException()); - - - - - - Matches any value that is in the range specified. - Type of the argument to check.The lower bound of the range.The upper bound of the range. - The kind of range. See . - - The following example shows how to expect a method call - with an integer argument within the 0..100 range. - - mock.Setup(x => x.HasInventory( - It.IsAny<string>(), - It.IsInRange(0, 100, Range.Inclusive))) - .Returns(false); - - - - - - Matches any value that is present in the sequence specified. - Type of the argument to check.The sequence of possible values. - The following example shows how to expect a method call - with an integer argument with value from a list. - - var values = new List<int> { 1, 2, 3 }; - - mock.Setup(x => x.HasInventory( - It.IsAny<string>(), - It.IsIn(values))) - .Returns(false); - - - - - - Matches any value that is present in the sequence specified. - Type of the argument to check.The sequence of possible values. - The following example shows how to expect a method call - with an integer argument with a value of 1, 2, or 3. - - mock.Setup(x => x.HasInventory( - It.IsAny<string>(), - It.IsIn(1, 2, 3))) - .Returns(false); - - - - - - Matches any value that is not found in the sequence specified. - Type of the argument to check.The sequence of disallowed values. - The following example shows how to expect a method call - with an integer argument with value not found from a list. - - var values = new List<int> { 1, 2, 3 }; - - mock.Setup(x => x.HasInventory( - It.IsAny<string>(), - It.IsNotIn(values))) - .Returns(false); - - - - - - Matches any value that is not found in the sequence specified. - Type of the argument to check.The sequence of disallowed values. - The following example shows how to expect a method call - with an integer argument of any value except 1, 2, or 3. - - mock.Setup(x => x.HasInventory( - It.IsAny<string>(), - It.IsNotIn(1, 2, 3))) - .Returns(false); - - - - - - Matches a string argument if it matches the given regular expression pattern. - The pattern to use to match the string argument value. - The following example shows how to expect a call to a method where the - string argument matches the given regular expression: - - mock.Setup(x => x.Check(It.IsRegex("[a-z]+"))).Returns(1); - - - - - - Matches a string argument if it matches the given regular expression pattern. - The pattern to use to match the string argument value.The options used to interpret the pattern. - The following example shows how to expect a call to a method where the - string argument matches the given regular expression, in a case insensitive way: - - mock.Setup(x => x.Check(It.IsRegex("[a-z]+", RegexOptions.IgnoreCase))).Returns(1); - - - - - - Matcher to treat static functions as matchers. - - mock.Setup(x => x.StringMethod(A.MagicString())); - - public static class A - { - [Matcher] - public static string MagicString() { return null; } - public static bool MagicString(string arg) - { - return arg == "magic"; - } - } - - Will succeed if: mock.Object.StringMethod("magic"); - and fail with any other call. - - - - - Options to customize the behavior of the mock. - - - - - Causes the mock to always throw - an exception for invocations that don't have a - corresponding setup. - - - - - Will never throw exceptions, returning default - values when necessary (null for reference types, - zero for value types or empty enumerables and arrays). - - - - - Default mock behavior, which equals . - - - - - Exception thrown by mocks when setups are not matched, - the mock is not properly setup, etc. - - - A distinct exception type is provided so that exceptions - thrown by the mock can be differentiated in tests that - expect other exceptions to be thrown (i.e. ArgumentException). - - Richer exception hierarchy/types are not provided as - tests typically should not catch or expect exceptions - from the mocks. These are typically the result of changes - in the tested class or its collaborators implementation, and - result in fixes in the mock setup so that they dissapear and - allow the test to pass. - - - - - - Supports the serialization infrastructure. - - Serialization information. - Streaming context. - - - - Supports the serialization infrastructure. - - Serialization information. - Streaming context. - - - - Indicates whether this exception is a verification fault raised by Verify() - - - - - Made internal as it's of no use for - consumers, but it's important for - our own tests. - - - - - Used by the mock factory to accumulate verification - failures. - - - - - Supports the serialization infrastructure. - - - - - A strongly-typed resource class, for looking up localized strings, etc. - - - - - Returns the cached ResourceManager instance used by this class. - - - - - Overrides the current thread's CurrentUICulture property for all - resource lookups using this strongly typed resource class. - - - - - Looks up a localized string similar to Mock type has already been initialized by accessing its Object property. Adding interfaces must be done before that.. - - - - - Looks up a localized string similar to Value cannot be an empty string.. - - - - - Looks up a localized string similar to Can only add interfaces to the mock.. - - - - - Looks up a localized string similar to Can't set return value for void method {0}.. - - - - - Looks up a localized string similar to Constructor arguments cannot be passed for delegate mocks.. - - - - - Looks up a localized string similar to Constructor arguments cannot be passed for interface mocks.. - - - - - Looks up a localized string similar to A matching constructor for the given arguments was not found on the mocked type.. - - - - - Looks up a localized string similar to Could not locate event for attach or detach method {0}.. - - - - - Looks up a localized string similar to Expression {0} involves a field access, which is not supported. Use properties instead.. - - - - - Looks up a localized string similar to Type to mock must be an interface or an abstract or non-sealed class. . - - - - - Looks up a localized string similar to Cannot retrieve a mock with the given object type {0} as it's not the main type of the mock or any of its additional interfaces. - Please cast the argument to one of the supported types: {1}. - Remember that there's no generics covariance in the CLR, so your object must be one of these types in order for the call to succeed.. - - - - - Looks up a localized string similar to The equals ("==" or "=" in VB) and the conditional 'and' ("&&" or "AndAlso" in VB) operators are the only ones supported in the query specification expression. Unsupported expression: {0}. - - - - - Looks up a localized string similar to LINQ method '{0}' not supported.. - - - - - Looks up a localized string similar to Expression contains a call to a method which is not virtual (overridable in VB) or abstract. Unsupported expression: {0}. - - - - - Looks up a localized string similar to Member {0}.{1} does not exist.. - - - - - Looks up a localized string similar to Method {0}.{1} is public. Use strong-typed Expect overload instead: - mock.Setup(x => x.{1}()); - . - - - - - Looks up a localized string similar to {0} invocation failed with mock behavior {1}. - {2}. - - - - - Looks up a localized string similar to Expected only {0} calls to {1}.. - - - - - Looks up a localized string similar to Expected only one call to {0}.. - - - - - Looks up a localized string similar to {0} - Expected invocation on the mock at least {2} times, but was {4} times: {1}. - - - - - Looks up a localized string similar to {0} - Expected invocation on the mock at least once, but was never performed: {1}. - - - - - Looks up a localized string similar to {0} - Expected invocation on the mock at most {3} times, but was {4} times: {1}. - - - - - Looks up a localized string similar to {0} - Expected invocation on the mock at most once, but was {4} times: {1}. - - - - - Looks up a localized string similar to {0} - Expected invocation on the mock between {2} and {3} times (Exclusive), but was {4} times: {1}. - - - - - Looks up a localized string similar to {0} - Expected invocation on the mock between {2} and {3} times (Inclusive), but was {4} times: {1}. - - - - - Looks up a localized string similar to {0} - Expected invocation on the mock exactly {2} times, but was {4} times: {1}. - - - - - Looks up a localized string similar to {0} - Expected invocation on the mock should never have been performed, but was {4} times: {1}. - - - - - Looks up a localized string similar to {0} - Expected invocation on the mock once, but was {4} times: {1}. - - - - - Looks up a localized string similar to All invocations on the mock must have a corresponding setup.. - - - - - Looks up a localized string similar to Object instance was not created by Moq.. - - - - - Looks up a localized string similar to Out expression must evaluate to a constant value.. - - - - - Looks up a localized string similar to Property {0}.{1} does not have a getter.. - - - - - Looks up a localized string similar to Property {0}.{1} does not exist.. - - - - - Looks up a localized string similar to Property {0}.{1} is write-only.. - - - - - Looks up a localized string similar to Property {0}.{1} is read-only.. - - - - - Looks up a localized string similar to Property {0}.{1} does not have a setter.. - - - - - Looks up a localized string similar to Cannot raise a mocked event unless it has been associated (attached) to a concrete event in a mocked object.. - - - - - Looks up a localized string similar to Ref expression must evaluate to a constant value.. - - - - - Looks up a localized string similar to Invocation needs to return a value and therefore must have a corresponding setup that provides it.. - - - - - Looks up a localized string similar to A lambda expression is expected as the argument to It.Is<T>.. - - - - - Looks up a localized string similar to Invocation {0} should not have been made.. - - - - - Looks up a localized string similar to Expression is not a method invocation: {0}. - - - - - Looks up a localized string similar to Expression is not a property access: {0}. - - - - - Looks up a localized string similar to Expression is not a property setter invocation.. - - - - - Looks up a localized string similar to Expression references a method that does not belong to the mocked object: {0}. - - - - - Looks up a localized string similar to Invalid setup on a non-virtual (overridable in VB) member: {0}. - - - - - Looks up a localized string similar to Type {0} does not implement required interface {1}. - - - - - Looks up a localized string similar to Type {0} does not from required type {1}. - - - - - Looks up a localized string similar to To specify a setup for public property {0}.{1}, use the typed overloads, such as: - mock.Setup(x => x.{1}).Returns(value); - mock.SetupGet(x => x.{1}).Returns(value); //equivalent to previous one - mock.SetupSet(x => x.{1}).Callback(callbackDelegate); - . - - - - - Looks up a localized string similar to Unsupported expression: {0}. - - - - - Looks up a localized string similar to Only property accesses are supported in intermediate invocations on a setup. Unsupported expression {0}.. - - - - - Looks up a localized string similar to Expression contains intermediate property access {0}.{1} which is of type {2} and cannot be mocked. Unsupported expression {3}.. - - - - - Looks up a localized string similar to Setter expression cannot use argument matchers that receive parameters.. - - - - - Looks up a localized string similar to Member {0} is not supported for protected mocking.. - - - - - Looks up a localized string similar to Setter expression can only use static custom matchers.. - - - - - Looks up a localized string similar to The following setups were not matched: - {0}. - - - - - Looks up a localized string similar to Invalid verify on a non-virtual (overridable in VB) member: {0}. - - - - - Allows setups to be specified for protected members by using their - name as a string, rather than strong-typing them which is not possible - due to their visibility. - - - - - Specifies a setup for a void method invocation with the given - , optionally specifying arguments for the method call. - - The name of the void method to be invoked. - The optional arguments for the invocation. If argument matchers are used, - remember to use rather than . - - - - Specifies a setup for an invocation on a property or a non void method with the given - , optionally specifying arguments for the method call. - - The name of the method or property to be invoked. - The optional arguments for the invocation. If argument matchers are used, - remember to use rather than . - The return type of the method or property. - - - - Specifies a setup for an invocation on a property getter with the given - . - - The name of the property. - The type of the property. - - - - Specifies a setup for an invocation on a property setter with the given - . - - The name of the property. - The property value. If argument matchers are used, - remember to use rather than . - The type of the property. - - - - Specifies a verify for a void method with the given , - optionally specifying arguments for the method call. Use in conjuntion with the default - . - - The invocation was not call the times specified by - . - The name of the void method to be verified. - The number of times a method is allowed to be called. - The optional arguments for the invocation. If argument matchers are used, - remember to use rather than . - - - - Specifies a verify for an invocation on a property or a non void method with the given - , optionally specifying arguments for the method call. - - The invocation was not call the times specified by - . - The name of the method or property to be invoked. - The optional arguments for the invocation. If argument matchers are used, - remember to use rather than . - The number of times a method is allowed to be called. - The type of return value from the expression. - - - - Specifies a verify for an invocation on a property getter with the given - . - The invocation was not call the times specified by - . - - The name of the property. - The number of times a method is allowed to be called. - The type of the property. - - - - Specifies a setup for an invocation on a property setter with the given - . - - The invocation was not call the times specified by - . - The name of the property. - The number of times a method is allowed to be called. - The property value. - The type of the property. If argument matchers are used, - remember to use rather than . - - - - Allows the specification of a matching condition for an - argument in a protected member setup, rather than a specific - argument value. "ItExpr" refers to the argument being matched. - - - Use this variant of argument matching instead of - for protected setups. - This class allows the setup to match a method invocation - with an arbitrary value, with a value in a specified range, or - even one that matches a given predicate, or null. - - - - - Matches a null value of the given type. - - - Required for protected mocks as the null value cannot be used - directly as it prevents proper method overload selection. - - - - // Throws an exception for a call to Remove with a null string value. - mock.Protected() - .Setup("Remove", ItExpr.IsNull<string>()) - .Throws(new InvalidOperationException()); - - - Type of the value. - - - - Matches any value of the given type. - - - Typically used when the actual argument value for a method - call is not relevant. - - - - // Throws an exception for a call to Remove with any string value. - mock.Protected() - .Setup("Remove", ItExpr.IsAny<string>()) - .Throws(new InvalidOperationException()); - - - Type of the value. - - - - Matches any value that satisfies the given predicate. - - Type of the argument to check. - The predicate used to match the method argument. - - Allows the specification of a predicate to perform matching - of method call arguments. - - - This example shows how to return the value 1 whenever the argument to the - Do method is an even number. - - mock.Protected() - .Setup("Do", ItExpr.Is<int>(i => i % 2 == 0)) - .Returns(1); - - This example shows how to throw an exception if the argument to the - method is a negative number: - - mock.Protected() - .Setup("GetUser", ItExpr.Is<int>(i => i < 0)) - .Throws(new ArgumentException()); - - - - - - Matches any value that is in the range specified. - - Type of the argument to check. - The lower bound of the range. - The upper bound of the range. - The kind of range. See . - - The following example shows how to expect a method call - with an integer argument within the 0..100 range. - - mock.Protected() - .Setup("HasInventory", - ItExpr.IsAny<string>(), - ItExpr.IsInRange(0, 100, Range.Inclusive)) - .Returns(false); - - - - - - Matches a string argument if it matches the given regular expression pattern. - - The pattern to use to match the string argument value. - - The following example shows how to expect a call to a method where the - string argument matches the given regular expression: - - mock.Protected() - .Setup("Check", ItExpr.IsRegex("[a-z]+")) - .Returns(1); - - - - - - Matches a string argument if it matches the given regular expression pattern. - - The pattern to use to match the string argument value. - The options used to interpret the pattern. - - The following example shows how to expect a call to a method where the - string argument matches the given regular expression, in a case insensitive way: - - mock.Protected() - .Setup("Check", ItExpr.IsRegex("[a-z]+", RegexOptions.IgnoreCase)) - .Returns(1); - - - - - - Enables the Protected() method on , - allowing setups to be set for protected members by using their - name as a string, rather than strong-typing them which is not possible - due to their visibility. - - - - - Enable protected setups for the mock. - - Mocked object type. Typically omitted as it can be inferred from the mock instance. - The mock to set the protected setups on. - - - - - - - - - - - - Kind of range to use in a filter specified through - . - - - - - The range includes the to and - from values. - - - - - The range does not include the to and - from values. - - - - - Determines the way default values are generated - calculated for loose mocks. - - - - - Default behavior, which generates empty values for - value types (i.e. default(int)), empty array and - enumerables, and nulls for all other reference types. - - - - - Whenever the default value generated by - is null, replaces this value with a mock (if the type - can be mocked). - - - For sealed classes, a null value will be generated. - - - - - A default implementation of IQueryable for use with QueryProvider - - - - - The is a - static method that returns an IQueryable of Mocks of T which is used to - apply the linq specification to. - - - - - Allows creation custom value matchers that can be used on setups and verification, - completely replacing the built-in class with your own argument - matching rules. - - See also . - - - - - Provided for the sole purpose of rendering the delegate passed to the - matcher constructor if no friendly render lambda is provided. - - - - - Initializes the match with the condition that - will be checked in order to match invocation - values. - The condition to match against actual values. - - - - - - - - - This method is used to set an expression as the last matcher invoked, - which is used in the SetupSet to allow matchers in the prop = value - delegate expression. This delegate is executed in "fluent" mode in - order to capture the value being set, and construct the corresponding - methodcall. - This is also used in the MatcherFactory for each argument expression. - This method ensures that when we execute the delegate, we - also track the matcher that was invoked, so that when we create the - methodcall we build the expression using it, rather than the null/default - value returned from the actual invocation. - - - - - Allows creation custom value matchers that can be used on setups and verification, - completely replacing the built-in class with your own argument - matching rules. - Type of the value to match. - The argument matching is used to determine whether a concrete - invocation in the mock matches a given setup. This - matching mechanism is fully extensible. - - Creating a custom matcher is straightforward. You just need to create a method - that returns a value from a call to with - your matching condition and optional friendly render expression: - - [Matcher] - public Order IsBigOrder() - { - return Match<Order>.Create( - o => o.GrandTotal >= 5000, - /* a friendly expression to render on failures */ - () => IsBigOrder()); - } - - This method can be used in any mock setup invocation: - - mock.Setup(m => m.Submit(IsBigOrder()).Throws<UnauthorizedAccessException>(); - - At runtime, Moq knows that the return value was a matcher (note that the method MUST be - annotated with the [Matcher] attribute in order to determine this) and - evaluates your predicate with the actual value passed into your predicate. - - Another example might be a case where you want to match a lists of orders - that contains a particular one. You might create matcher like the following: - - - public static class Orders - { - [Matcher] - public static IEnumerable<Order> Contains(Order order) - { - return Match<IEnumerable<Order>>.Create(orders => orders.Contains(order)); - } - } - - Now we can invoke this static method instead of an argument in an - invocation: - - var order = new Order { ... }; - var mock = new Mock<IRepository<Order>>(); - - mock.Setup(x => x.Save(Orders.Contains(order))) - .Throws<ArgumentException>(); - - - - - - Tracks the current mock and interception context. - - - - - Having an active fluent mock context means that the invocation - is being performed in "trial" mode, just to gather the - target method and arguments that need to be matched later - when the actual invocation is made. - - - - - A that returns an empty default value - for non-mockeable types, and mocks for all other types (interfaces and - non-sealed classes) that can be mocked. - - - - - Allows querying the universe of mocks for those that behave - according to the LINQ query specification. - - - This entry-point into Linq to Mocks is the only one in the root Moq - namespace to ease discovery. But to get all the mocking extension - methods on Object, a using of Moq.Linq must be done, so that the - polluting of the intellisense for all objects is an explicit opt-in. - - - - - Access the universe of mocks of the given type, to retrieve those - that behave according to the LINQ query specification. - - The type of the mocked object to query. - - - - Access the universe of mocks of the given type, to retrieve those - that behave according to the LINQ query specification. - - The predicate with the setup expressions. - The type of the mocked object to query. - - - - Creates an mock object of the indicated type. - - The type of the mocked object. - The mocked object created. - - - - Creates an mock object of the indicated type. - - The predicate with the setup expressions. - The type of the mocked object. - The mocked object created. - - - - Creates the mock query with the underlying queriable implementation. - - - - - Wraps the enumerator inside a queryable. - - - - - Method that is turned into the actual call from .Query{T}, to - transform the queryable query into a normal enumerable query. - This method is never used directly by consumers. - - - - - Extension method used to support Linq-like setup properties that are not virtual but do have - a getter and a setter, thereby allowing the use of Linq to Mocks to quickly initialize Dtos too :) - - - - - Helper extensions that are used by the query translator. - - - - - Retrieves a fluent mock from the given setup expression. - - - - - Gets an autogenerated interface with a method on it that matches the signature of the specified - . - - - Such an interface can then be mocked, and a delegate pointed at the method on the mocked instance. - This is how we support delegate mocking. The factory caches such interfaces and reuses them - for repeated requests for the same delegate type. - - The delegate type for which an interface is required. - The method on the autogenerated interface. - - - - - - - - - - Defines the number of invocations allowed by a mocked method. - - - - - Specifies that a mocked method should be invoked times as minimum. - The minimun number of times.An object defining the allowed number of invocations. - - - - Specifies that a mocked method should be invoked one time as minimum. - An object defining the allowed number of invocations. - - - - Specifies that a mocked method should be invoked time as maximun. - The maximun number of times.An object defining the allowed number of invocations. - - - - Specifies that a mocked method should be invoked one time as maximun. - An object defining the allowed number of invocations. - - - - Specifies that a mocked method should be invoked between and - times. - The minimun number of times.The maximun number of times. - The kind of range. See . - An object defining the allowed number of invocations. - - - - Specifies that a mocked method should be invoked exactly times. - The times that a method or property can be called.An object defining the allowed number of invocations. - - - - Specifies that a mocked method should not be invoked. - An object defining the allowed number of invocations. - - - - Specifies that a mocked method should be invoked exactly one time. - An object defining the allowed number of invocations. - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Returns a hash code for this instance. - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Determines whether two specified objects have the same value. - - The first . - - The second . - - true if the value of left is the same as the value of right; otherwise, false. - - - - - Determines whether two specified objects have different values. - - The first . - - The second . - - true if the value of left is different from the value of right; otherwise, false. - - - - diff --git a/lib/UnityEditor.dll b/lib/UnityEditor.dll index 8591564..a08a86f 100644 Binary files a/lib/UnityEditor.dll and b/lib/UnityEditor.dll differ diff --git a/lib/UnityEditor.dll.mdb b/lib/UnityEditor.dll.mdb new file mode 100644 index 0000000..c6006fa Binary files /dev/null and b/lib/UnityEditor.dll.mdb differ diff --git a/lib/UnityEditor.xml b/lib/UnityEditor.xml new file mode 100644 index 0000000..7eabeb7 --- /dev/null +++ b/lib/UnityEditor.xml @@ -0,0 +1,43406 @@ + + + + + UnityEditor + + + + The behavior in case of unhandled .NET exception. + + + + + Crash in case of unhandled .NET exception (Crash Report will be generated). + + + + + Silent exit in case of unhandled .NET exception (no Crash Report generated). + + + + + Editor API for the Unity Services editor feature. Normally UnityAds is enabled from the Services window, but if writing your own editor extension, this API can be used. + + + + + Global boolean for enabling or disabling the advertisement feature. + + + + + Controls if the advertisement system should be initialized immediately on startup. + + + + + Controls if testing advertisements are used instead of production advertisements. + + + + + Gets the game identifier specified for a runtime platform. + + + + The platform specific game identifier. + + + + + Gets the game identifier specified for a runtime platform. + + + + The platform specific game identifier. + + + + + Returns if a specific platform is enabled. + + + + Boolean for the platform. + + + + + Sets the game identifier for the specified platform. + + + + + + + Enable the specific platform. + + + + + + + Sets the game identifier for the specified platform. + + + + + + + Navigation mesh builder interface. + + + + + Returns true if an asynchronous build is still running. (UnityEditor) + + + + + Build the Navmesh. (UnityEditor) + + + + + Build the Navmesh Asyncronously. (UnityEditor) + + + + + Builds the combined navmesh for the contents of multiple Scenes. (UnityEditor) + + Array of paths to Scenes that are used for building the navmesh. + + + + Cancel Navmesh construction. (UnityEditor) See Also: NavMeshBuilder.BuildNavMeshAsync + + + + + Cancels an asynchronous update of the specified NavMesh data. (UnityEngine) See Also: NavMeshBuilder.UpdateNavMeshDataAsync. + + The data associated with asynchronous updating. + + + + Clear all Navmeshes. (UnityEditor) + + + + + Collects renderers or physics colliders, and terrains within a volume. (UnityEditor) + + The queried objects must overlap these bounds to be included in the results. + Specifies which layers are included in the query. + Which type of geometry to collect - e.g. physics colliders. + Area type to assign to results, unless modified by NavMeshMarkup. + List of markups which allows finer control over how objects are collected. + Results are selected only from the stage to which this scene belongs. + List where results are stored, the list is cleared at the beginning of the call. + + + + Collects renderers or physics colliders, and terrains within a transform hierarchy. (UnityEditor) + + If not null, consider only root and its children in the query; if null, includes everything loaded. + Specifies which layers are included in the query. + Which type of geometry to collect - e.g. physics colliders. + Area type to assign to results, unless modified by NavMeshMarkup. + List of markups which allows finer control over how objects are collected. + Results are selected only from the stage to which this scene belongs. + List where results are stored, the list is cleared at the beginning of the call. + + + + NavMesh utility functionality effective only in the Editor. + + + + + Displays in the Editor the precise intermediate data used during the build process of the specified NavMesh. + + NavMesh object for which debug data has been deliberately collected during the build process. + Bitmask that designates the types of data to show at one time. + + + + Represents the visualization state of the navigation debug graphics. + + + + + A count of how many users requesting navigation debug graphics to be enabled. + + + + + Editor API for the Unity Services editor feature. Normally Analytics is enabled from the Services window, but if writing your own editor extension, this API can be used. + + + + + This Boolean field will cause the Analytics feature in Unity to be enabled if true, or disabled if false. + + + + + Controls whether Unity initializes Analytics immediately on startup. + + + + + Set to true for testing Analytics integration only within the Editor. + + + + + Normally performance reporting is enabled from the Services window, but if writing your own editor extension, this API can be used. + + + + + This Boolean field causes the performance reporting feature in Unity to be enabled if true, or disabled if false. + + + + + Implement this interface to receive a callback after the Android Gradle project is generated. Inherited from UnityEditor.Build.IOrderedCallback. + + + + + Implement this function to receive a callback after the Android Gradle project is generated and before building begins. It is not called when doing an Internal build. + + The path to the root of the Gradle project. Note: when exporting the project, this parameter holds the path to the folder specified for export. + + + + Android CPU architecture. + + + + + All architectures. + + + + + 64-bit ARM architecture. + + + + + 32-bit ARM architecture. + + + + + Invalid architecture. + + + + + 32-bit Intel architecture. + + + + + Describes the method for how content is displayed on the screen. + + + + + Always render offscreen and blit to the backbuffer. + + + + + Automatically determine the most appropriate method for drawing to the screen. + + + + + Never render offscreen and blit to the backbuffer. Always render directly to the backbuffer. + + + + + Type of Android build system. + + + + + Export ADT (legacy) project. This option is obsolete and no longer supported - please use AndroidBuildSystem.Gradle export instead. + + + + + Build APK using Gradle or export Gradle project. + + + + + Build APK using internal build system. + + + + + Build configurations for the generated project. + + + + + Build configuration set to Debug for the generated project. + + + + + Build configuration set to Development for the generated project. + + + + + Build configuration set to Release for the generated project. + + + + + This enumeration has values for different qualities to decompress ETC2 textures on Android devices that don't support the ETC2 texture format. + + + + + Textures are decompressed to a suitable 16-bit format. + + + + + Textures are decompressed to the TextureFormat.RGBA32 format. + + + + + Textures are decompressed to the TextureFormat.RGBA32 format and downscaled to half of the original texture width and height. + + + + + This enumeration has values for different qualities to decompress an ETC2 texture on Android devices that don't support the ETC2 texture format. + + + + + Texture is decompressed to a suitable 16-bit format. + + + + + Texture is decompressed to the TextureFormat.RGBA32 format. + + + + + Texture is decompressed to the TextureFormat.RGBA32 format and downscaled to half of the original texture width and height. + + + + + Use the value defined in Player build settings. + + + + + Gamepad support level for Android TV. + + + + + Requires a gamepad for gameplay. + + + + + Game is fully operational with a D-pad, no gamepad needed. + + + + + Works with a gamepad, but does not require it. + + + + + How to minify the java code of your binary. + + + + + Use experimental internal gradle minification. + + + + + Use no minification. + + + + + Use proguard minification. + + + + + Preferred application install location. + + + + + Let the OS decide, app doesn't have any preferences. + + + + + Force installation into internal memory. Needed for things like Live Wallpapers. + + + + + Prefer external, if possible. Install to internal otherwise. + + + + + Supported Android SDK versions. + + + + + Android 4.1, "Jelly Bean", API level 16. + + + + + Android 4.2, "Jelly Bean", API level 17. + + + + + Android 4.3, "Jelly Bean", API level 18. + + + + + Android 4.4, "KitKat", API level 19. + + + + + Android 5.0, "Lollipop", API level 21. + + + + + Android 5.1, "Lollipop", API level 22. + + + + + Android 6.0, "Marshmallow", API level 23. + + + + + Android 7.0, "Nougat", API level 24. + + + + + Android 7.1, "Nougat", API level 25. + + + + + Android 8.0, "Oreo", API level 26. + + + + + Android 8.1, "Oreo", API level 27. + + + + + Android 9.0, "Pie", API level 28. + + + + + Sets the target API level automatically, according to the latest installed SDK on your computer. + + + + + Application should show ActivityIndicator when loading. + + + + + Don't Show. + + + + + Inversed Large. + + + + + Inversed Small. + + + + + Large. + + + + + Small. + + + + + Android splash screen scale modes. + + + + + Center. + + + + + Scale to fill. + + + + + Scale to fit. + + + + + Target Android device architecture. + + + + + Intel only. + + + + + ARMv7 only. + + + + + All supported architectures. + + + + + Lerp from 0 - 1. + + + + + Retuns the float value of the tween. + + + + + Constructor. + + Start Value. + + + + + Constructor. + + Start Value. + + + + + Constructor. + + Start Value. + + + + + Constructor. + + Start Value. + + + + + Returns a value between from and to depending on the current value of the bools animation. + + Value to lerp from. + Value to lerp to. + + + + Type specific implementation of BaseAnimValue_1.GetValue. + + + Current value. + + + + + An animated float value. + + + + + Constructor. + + Start Value. + + + + + Constructor. + + Start Value. + + + + + Type specific implementation of BaseAnimValue_1.GetValue. + + + Current Value. + + + + + An animated Quaternion value. + + + + + Constructor. + + Start Value. + + + + + Constructor. + + Start Value. + + + + + Type specific implementation of BaseAnimValue_1.GetValue. + + + Current Value. + + + + + An animated Vector3 value. + + + + + Constructor. + + Start Value. + + + + + Constructor. + + Start Value. + + + + + Constructor. + + Start Value. + + + + + Type specific implementation of BaseAnimValue_1.GetValue. + + + Current Value. + + + + + Abstract base class for Animated Values. + + + + + Is the value currently animating. + + + + + Speed of the tween. + + + + + Target to tween towards. + + + + + Current value of the animation. + + + + + Callback while the value is changing. + + + + + Begin an animation moving from the start value to the target value. + + Target value. + Start value. + + + + Abstract function to be overridden in derived types. Should return the current value of the animated value. + + + Current Value. + + + + + Stop the animation and assign the given value. + + Value to assign. + + + + An AnimationClipCurveData object contains all the information needed to identify a specific curve in an AnimationClip. The curve animates a specific property of a component material attached to a game object animated bone. + + + + + The actual animation curve. + + + + + The path of the game object / bone being animated. + + + + + The name of the property being animated. + + + + + The type of the component / material being animated. + + + + + AnimationMode is used by the AnimationWindow to store properties modified + by the AnimationClip playback. + + + + + The color used to show that a property is currently being animated. + + + + + The color used to show that an animated property has been modified. + + + + + The color used to show that an animated property automatically records changes in the animation clip. + + + + + Marks a property defined by an EditorCurveBinding as currently being animated. + + The GameObject being modified. + The binding for the property being modified. + + + + Marks a property as currently being animated. + + Description of the animation clip curve being modified. + Object property being modified. + Indicates whether to retain modifications when the targeted object is an instance of a Prefab. + + + + Initialise the start of the animation clip sampling. + + + + + Finish the sampling of the animation clip. + + + + + Are we currently in AnimationMode? + + + + + Is the specified property currently in animation mode and being animated? + + The object to determine if it contained the animation. + The name of the animation to search for. + + Whether the property search is found or not. + + + + + Samples an AnimationClip on the object and also records any modified + properties in AnimationMode. + + + + + + + + Starts the animation mode. + + + + + Stops Animation mode, reverts all properties that were animated in animation mode. + + + + + Condition that is used to determine if a transition must be taken. + + + + + The mode of the condition. + + + + + The name of the parameter used in the condition. + + + + + The AnimatorParameter's threshold value for the condition to be true. + + + + + The mode of the condition. + + + + + The condition is true when parameter value is equal to the threshold. + + + + + The condition is true when parameter value is greater than the threshold. + + + + + The condition is true when the parameter value is true. + + + + + The condition is true when the parameter value is false. + + + + + The condition is true when the parameter value is less than the threshold. + + + + + The condition is true when the parameter value is not equal to the threshold. + + + + + The Animator Controller controls animation through layers with state machines, controlled by parameters. + + + + + The layers in the controller. + + + + + Parameters are used to communicate between scripting and the controller. They are used to drive transitions and blendtrees for example. + + + + + Adds a state machine behaviour class of type stateMachineBehaviourType to the AnimatorState for layer layerIndex. This function should be used when you are dealing with synchronized layer and would like to add a state machine behaviour on a synchronized layer. C# Users can use a generic version. + + + + + + + + Generic version. See the page for more details. + + + + + + + Utility function to add a layer to the controller. + + The name of the Layer. + The layer to add. + + + + Utility function to add a layer to the controller. + + The name of the Layer. + The layer to add. + + + + Utility function that creates a new state with the motion in it. + + The Motion that will be in the AnimatorState. + The layer where the Motion will be added. + + + + Utility function that creates a new state with the motion in it. + + The Motion that will be in the AnimatorState. + The layer where the Motion will be added. + + + + Utility function to add a parameter to the controller. + + The name of the parameter. + The type of the parameter. + The parameter to add. + + + + Utility function to add a parameter to the controller. + + The name of the parameter. + The type of the parameter. + The parameter to add. + + + + Creates an AnimatorController at the given path. + + The path where the AnimatorController asset will be created. + + The created AnimationController or null if an error occured. + + + + + Creates an AnimatorController at the given path, and automatically create an AnimatorLayer with an AnimatorStateMachine that will add a State with the AnimationClip in it. + + The path where the AnimatorController will be created. + The default clip that will be played by the AnimatorController. + + + + Creates a BlendTree in a new AnimatorState. + + The name of the BlendTree. + The created BlendTree. + The index where the BlendTree will be created. + + + + Creates a BlendTree in a new AnimatorState. + + The name of the BlendTree. + The created BlendTree. + The index where the BlendTree will be created. + + + + This function will create a StateMachineBehaviour instance based on the class define in this script. + + MonoScript class to instantiate. + + Returns instance id of created object, returns 0 if something is not valid. + + + + + Constructor. + + + + + Use this function to retrieve the owner of this behaviour. + + The State Machine Behaviour to get context for. + + Returns the State Machine Behaviour edition context. + + + + + Returns all StateMachineBehaviour that match type T or are derived from T. + + + + + Gets the effective state machine behaviour list for the AnimatorState. Behaviours are either stored in the AnimatorStateMachine or in the AnimatorLayer's ovverrides. Use this function to get Behaviour list that is effectively used. + + The AnimatorState which we want the Behaviour list. + The layer that is queried. + + + + Gets the effective Motion for the AnimatorState. The Motion is either stored in the AnimatorStateMachine or in the AnimatorLayer's ovverrides. Use this function to get the Motion that is effectively used. + + The AnimatorState which we want the Motion. + The layer that is queried. + + + + Gets the effective Motion for the AnimatorState. The Motion is either stored in the AnimatorStateMachine or in the AnimatorLayer's ovverrides. Use this function to get the Motion that is effectively used. + + The AnimatorState which we want the Motion. + The layer that is queried. + + + + Creates a unique name for the layers. + + The desired name of the AnimatorLayer. + + + + Creates a unique name for the parameter. + + The desired name of the AnimatorParameter. + + + + Utility function to remove a layer from the controller. + + The index of the AnimatorLayer. + + + + Utility function to remove a parameter from the controller. + + The index of the AnimatorParameter. + + + + Sets the effective state machine Behaviour list for the AnimatorState. The Behaviour list is either stored in the AnimatorStateMachine or in the AnimatorLayer's ovverrides. Use this function to set the Behaviour list that is effectively used. + + The AnimatorState which we want to set the Behaviour list. + The layer to set the Behaviour list. + The Behaviour list that will be set. + + + + Sets the effective Motion for the AnimatorState. The Motion is either stored in the AnimatorStateMachine or in the AnimatorLayer's ovverrides. Use this function to set the Motion that is effectively used. + + The AnimatorState which we want to set the Motion. + The Motion that will be set. + The layer to set the Motion. + + + + Sets the effective Motion for the AnimatorState. The Motion is either stored in the AnimatorStateMachine or in the AnimatorLayer's ovverrides. Use this function to set the Motion that is effectively used. + + The AnimatorState which we want to set the Motion. + The Motion that will be set. + The layer to set the Motion. + + + + The Animation Layer contains a state machine that controls animations of a model or part of it. + + + + + The AvatarMask that is used to mask the animation on the given layer. + + + + + The blending mode used by the layer. It is not taken into account for the first layer. + + + + + The default blending weight that the layers has. It is not taken into account for the first layer. + + + + + When active, the layer will have an IK pass when evaluated. It will trigger an OnAnimatorIK callback. + + + + + The name of the layer. + + + + + The state machine for the layer. + + + + + When active, the layer will take control of the duration of the Synced Layer. + + + + + Specifies the index of the Synced Layer. + + + + + Gets the override behaviour list for the state on the given layer. + + The state which we want to get the behaviour list. + + + + Gets the override motion for the state on the given layer. + + The state which we want to get the motion. + + + + Sets the override behaviour list for the state on the given layer. + + The state which we want to set the behaviour list. + The behaviour list that will be set. + + + + Sets the override motion for the state on the given layer. + + The state which we want to set the motion. + The motion that will be set. + + + + Specifies how the layer is blended with the previous layers. + + + + + Animations are added to the previous layers. + + + + + Animations overrides to the previous layers. + + + + + States are the basic building blocks of a state machine. Each state contains a Motion ( AnimationClip or BlendTree) which will play while the character is in that state. When an event in the game triggers a state transition, the character will be left in a new state whose animation sequence will then take over. + + + + + The Behaviour list assigned to this state. + + + + + Offset at which the animation loop starts. Useful for synchronizing looped animations. +Units is normalized time. + + + + + The animator controller parameter that drives the cycle offset value. + + + + + Define if the cycle offset value is driven by an Animator controller parameter or by the value set in the editor. + + + + + Should Foot IK be respected for this state. + + + + + Should the state be mirrored. + + + + + The animator controller parameter that drives the mirror value. + + + + + Define if the mirror value is driven by an Animator controller parameter or by the value set in the editor. + + + + + The motion assigned to this state. + + + + + The hashed name of the state. + + + + + The default speed of the motion. + + + + + The animator controller parameter that drives the speed value. + + + + + Define if the speed value is driven by an Animator controller parameter or by the value set in the editor. + + + + + A tag can be used to identify a state. + + + + + If timeParameterActive is true, the value of this Parameter will be used instead of normalized time. + + + + + If true, use value of given Parameter as normalized time. + + + + + The transitions that are going out of the state. + + + + + Whether or not the AnimatorStates writes back the default values for properties that are not animated by its Motion. + + + + + Utility function to add an outgoing transition to the exit of the state's parent state machine. + + If true, the exit time will be the equivalent of 0.25 second. + + The Animations.AnimatorStateTransition that was added. + + + + + Utility function to add an outgoing transition to the exit of the state's parent state machine. + + If true, the exit time will be the equivalent of 0.25 second. + + The Animations.AnimatorStateTransition that was added. + + + + + Adds a state machine behaviour class of type stateMachineBehaviourType to the AnimatorState. C# Users can use a generic version. + + + + + + Generic version. See the page for more details. + + + + + Utility function to add an outgoing transition to the destination state. + + If true, the exit time will be the equivalent of 0.25 second. + The destination state. + + + + Utility function to add an outgoing transition to the destination state. + + If true, the exit time will be the equivalent of 0.25 second. + The destination state. + + + + Utility function to add an outgoing transition to the destination state machine. + + If true, the exit time will be the equivalent of 0.25 second. + The destination state machine. + + + + Utility function to add an outgoing transition to the destination state machine. + + If true, the exit time will be the equivalent of 0.25 second. + The destination state machine. + + + + Utility function to add an outgoing transition. + + The transition to add. + + + + Utility function to remove a transition from the state. + + Transition to remove. + + + + A graph controlling the interaction of states. Each state references a motion. + + + + + The position of the AnyState node. + + + + + The list of AnyState transitions. + + + + + The Behaviour list assigned to this state machine. + + + + + The state that the state machine will be in when it starts. + + + + + The position of the entry node. + + + + + The list of entry transitions in the state machine. + + + + + The position of the exit node. + + + + + The position of the parent state machine node. Only valid when in a hierachic state machine. + + + + + The list of sub state machines. + + + + + The list of states. + + + + + Utility function to add an AnyState transition to the specified state or statemachine. + + The destination state. + The destination statemachine. + + + + Utility function to add an AnyState transition to the specified state or statemachine. + + The destination state. + The destination statemachine. + + + + Utility function to add an incoming transition to the exit of it's parent state machine. + + The destination Animations.AnimatorState state. + The destination Animations.AnimatorStateMachine state machine. + + + + Utility function to add an incoming transition to the exit of it's parent state machine. + + The destination Animations.AnimatorState state. + The destination Animations.AnimatorStateMachine state machine. + + + + Utility function to add a state to the state machine. + + The name of the new state. + The position of the state node. + + The AnimatorState that was created for this state. + + + + + Utility function to add a state to the state machine. + + The name of the new state. + The position of the state node. + + The AnimatorState that was created for this state. + + + + + Utility function to add a state to the state machine. + + The state to add. + The position of the state node. + + + + Utility function to add a state machine to the state machine. + + The name of the new state machine. + The position of the state machine node. + + The newly created Animations.AnimatorStateMachine state machine. + + + + + Utility function to add a state machine to the state machine. + + The name of the new state machine. + The position of the state machine node. + + The newly created Animations.AnimatorStateMachine state machine. + + + + + Utility function to add a state machine to the state machine. + + The state machine to add. + The position of the state machine node. + + + + Adds a state machine behaviour class of type stateMachineBehaviourType to the AnimatorStateMachine. C# Users can use a generic version. + + + + + + Generic version. See the page for more details. + + + + + Utility function to add an outgoing transition from the source state machine to the exit of it's parent state machine. + + The source state machine. + + + + Utility function to add an outgoing transition from the source state machine to the destination. + + The source state machine. + The destination state machine. + The destination state. + + The Animations.AnimatorTransition transition that was created. + + + + + Utility function to add an outgoing transition from the source state machine to the destination. + + The source state machine. + The destination state machine. + The destination state. + + The Animations.AnimatorTransition transition that was created. + + + + + Utility function to add an outgoing transition from the source state machine to the destination. + + The source state machine. + The destination state machine. + The destination state. + + The Animations.AnimatorTransition transition that was created. + + + + + Gets the list of all outgoing state machine transitions from given state machine. + + The source state machine. + + + + Makes a unique state machine name in the context of the parent state machine. + + Desired name for the state machine. + + + + Makes a unique state name in the context of the parent state machine. + + Desired name for the state. + + + + Utility function to remove an AnyState transition from the state machine. + + The AnyStat transition to remove. + + + + Utility function to remove an entry transition from the state machine. + + The transition to remove. + + + + Utility function to remove a state from the state machine. + + The state to remove. + + + + Utility function to remove a state machine from its parent state machine. + + The state machine to remove. + + + + Utility function to remove an outgoing transition from source state machine. + + The transition to remove. + The source state machine. + + + + Sets the list of all outgoing state machine transitions from given state machine. + + The source state machine. + The outgoing transitions. + + + + + Transitions define when and how the state machine switch from one state to another. AnimatorStateTransition always originate from an Animator State (or AnyState) and have timing parameters. + + + + + Set to true to allow or disallow transition to self during AnyState transition. + + + + + The duration of the transition. + + + + + If AnimatorStateTransition.hasExitTime is true, exitTime represents the exact time at which the transition can take effect. + +This is represented in normalized time, so for example an exit time of 0.75 means that on the first frame where 75% of the animation has played, the Exit Time condition will be true. On the next frame, the condition will be false. + +For looped animations, transitions with exit times smaller than 1 will be evaluated every loop, so you can use this to time your transition with the proper timing in the animation, every loop. + +Transitions with exit times greater than one will be evaluated only once, so they can be used to exit at a specific time, after a fixed number of loops. For example, a transition with an exit time of 3.5 will be evaluated once, after three and a half loops. + + + + + When active the transition will have an exit time condition. + + + + + Determines whether the duration of the transition is reported in a fixed duration in seconds or as a normalized time. + + + + + Which AnimatorState transitions can interrupt the Transition. + + + + + The time at which the destination state will start. + + + + + The Transition can be interrupted by a transition that has a higher priority. + + + + + Creates a new animator state transition. + + + + + Transitions define when and how the state machine switch from on state to another. AnimatorTransition always originate from a StateMachine or a StateMachine entry. They do not define timing parameters. + + + + + Creates a new animator transition. + + + + + Base class for animator transitions. Transitions define when and how the state machine switches from one state to another. + + + + + Animations.AnimatorCondition conditions that need to be met for a transition to happen. + + + + + The destination state of the transition. + + + + + The destination state machine of the transition. + + + + + Is the transition destination the exit of the current state machine. + + + + + Mutes the transition. The transition will never occur. + + + + + Mutes all other transitions in the source state. + + + + + Utility function to add a condition to a transition. + + The Animations.AnimatorCondition mode of the condition. + The threshold value of the condition. + The name of the parameter. + + + + Utility function to remove a condition from the transition. + + The condition to remove. + + + + Blend trees are used to blend continuously animation between their childs. They can either be 1D or 2D. + + + + + Parameter that is used to compute the blending weight of the childs in 1D blend trees or on the X axis of a 2D blend tree. + + + + + Parameter that is used to compute the blending weight of the childs on the Y axis of a 2D blend tree. + + + + + The Blending type can be either 1D or different types of 2D. + + + + + A copy of the list of the blend tree child motions. + + + + + Sets the maximum threshold that will be used by the ChildMotion. Only used when useAutomaticThresholds is true. + + + + + Sets the minimum threshold that will be used by the ChildMotion. Only used when useAutomaticThresholds is true. + + + + + When active, the children's thresholds are automatically spread between 0 and 1. + + + + + Utility function to add a child motion to a blend trees. + + The motion to add as child. + The position of the child. When using 2D blend trees. + The threshold of the child. When using 1D blend trees. + + + + Utility function to add a child motion to a blend trees. + + The motion to add as child. + The position of the child. When using 2D blend trees. + The threshold of the child. When using 1D blend trees. + + + + Utility function to add a child motion to a blend trees. + + The motion to add as child. + The position of the child. When using 2D blend trees. + The threshold of the child. When using 1D blend trees. + + + + Utility function to add a child blend tree to a blend tree. + + The position of the child. When using 2D blend trees. + The threshold of the child. When using 1D blend trees. + + + + Utility function to add a child blend tree to a blend tree. + + The position of the child. When using 2D blend trees. + The threshold of the child. When using 1D blend trees. + + + + Utility function to remove the child of a blend tree. + + The index of the blend tree to remove. + + + + The type of blending algorithm that the blend tree uses. + + + + + Direct control of blending weight for each node. + + + + + Best used when your motions do not represent different directions. + + + + + This blend type is used when your motions represent different directions, however you can have multiple motions in the same direction, for example "walk forward" and "run forward". + + + + + Basic blending using a single parameter. + + + + + Best used when your motions represent different directions, such as "walk forward", "walk backward", "walk left", and "walk right", or "aim up", "aim down", "aim left", and "aim right". + + + + + Structure that represents a state in the context of its parent state machine. + + + + + The position the the state node in the context of its parent state machine. + + + + + The state. + + + + + Structure that represents a state machine in the context of its parent state machine. + + + + + The position the the state machine node in the context of its parent state machine. + + + + + The state machine. + + + + + Structure that represents a motion in the context of its parent blend tree. + + + + + Normalized time offset of the child. + + + + + The parameter used by the child when used in a BlendTree of type BlendTreeType.Direct. + + + + + Mirror of the child. + + + + + The motion itself. + + + + + The position of the child. Used in 2D blend trees. + + + + + The threshold of the child. Used in 1D blend trees. + + + + + The relative speed of the child. + + + + + Records the changing properties of a GameObject as the Scene runs and saves the information into an AnimationClip. + + + + + Returns the current time of the recording. (Read Only) + + + + + Returns true when the recorder is recording. (Read Only) + + + + + The GameObject root of the animated hierarchy. (Read Only) + + + + + Binds a GameObject's property as defined by EditorCurveBinding. + + The binding definition. + + + + Adds bindings for all of target's properties, and also for all the target's children if recursive is true. + + .root or any of its children. + Binds also all the target's children properties when set to true. + + + + Adds bindings for all the properties of component. + + The component to bind. + + + + TODO. + + + + + + + + TODO. + + + + + + + + Adds bindings for all the properties of the first component of type T found in target, and also for all the target's children if recursive is true. + + .root or any of its children. + Binds also the target's children transform properties when set to true. + Type of the component. + + + + Adds bindings for all the properties of the first component of type T found in target, and also for all the target's children if recursive is true. + + .root or any of its children. + Binds also the target's children transform properties when set to true. + Type of the component. + + + + Create a new GameObjectRecorder. + + The root GameObject for the animated hierarchy. + + + + TODO. + + + + + Returns an array of all the bindings added to the recorder. + + + Array of bindings. + + + + + Reset the recording. + + + + + Saves the recorded animation into clip. + +When no frames per second is given, the default is 60 FPS. + + Destination clip. + The frames per second for the clip. + + + + Saves the recorded animation into clip. + +When no frames per second is given, the default is 60 FPS. + + Destination clip. + The frames per second for the clip. + + + + Forwards the animation by dt seconds, then record the values of the added bindings. + + Delta time. + + + + This class contains all the owner's information for this State Machine Behaviour. + + + + + The Animations.AnimatorController that owns this state machine behaviour. + + + + + The object that owns this state machine behaviour. Could be an Animations.AnimatorState or Animations.AnimatorStateMachine. + + + + + The animator's layer index that owns this state machine behaviour. + + + + + Which AnimatorState transitions can interrupt the Transition. + + + + + The Transition can be interrupted by transitions in the destination AnimatorState. + + + + + The Transition can be interrupted by transitions in the source or the destination AnimatorState. + + + + + The Transition cannot be interrupted. Formely know as Atomic. + + + + + The Transition can be interrupted by transitions in the source AnimatorState. + + + + + The Transition can be interrupted by transitions in the source or the destination AnimatorState. + + + + + Editor utility functions for modifying animation clips. + + + + + Triggered when an animation curve inside an animation clip has been modified. + + + + + Calculates path from root transform to target transform. + + + + + + + Describes the type of modification that caused OnCurveWasModified to fire. + + + + + Retrieves all curves from a specific animation clip. + + + + + + + Retrieves all curves from a specific animation clip. + + + + + + + Returns all the animatable bindings that a specific game object has. + + + + + + + Returns the animated object that the binding is pointing to. + + + + + + + Returns the array of Animation Clips associated with the GameObject or component. + + + + + + + Returns the array of Animation Clips associated with the GameObject or component. + + + + + + + Retrieves all animation events associated with the animation clip. + + + + + + Returns all the float curve bindings currently stored in the clip. + + + + + + Return the float curve that the binding is pointing to. + + + + + + + + + + Return the float curve that the binding is pointing to. + + + + + + + + + + Retrieves the current float value by sampling a curve value on a specific game object. + + + + + + + + + + Returns whether the animation clip is set to generate root motion curves. + + AnimationClip to query. + + + + Retrieve the specified keyframe broken tangent flag. + + Curve to query. + Keyframe index. + + Broken flag at specified index. + + + + + Retrieve the left tangent mode of the keyframe at specified index. + + Curve to query. + Keyframe index. + + Tangent mode at specified index. + + + + + Retrieve the right tangent mode of the keyframe at specified index. + + Curve to query. + Keyframe index. + + Tangent mode at specified index. + + + + + Return the object reference curve that the binding is pointing to. + + + + + + + Returns all the object reference curve bindings currently stored in the clip. + + + + + + Triggered when an animation curve inside an animation clip has been modified. + + + + + + + + Set the additive reference pose from referenceClip at time for animation clip clip. + + The animation clip to be used. + The animation clip containing the reference pose. + Time that defines the reference pose in referenceClip. + + + + Sets the array of AnimationClips to be referenced in the Animation component. + + + + + + + Replaces all animation events in the animation clip. + + + + + + + Adds, modifies or removes an editor float curve in a given clip. + + The animation clip to which the curve will be added. + The bindings which defines the path and the property of the curve. + The curve to add. Setting this to null will remove the curve. + + + + Sets whether the animation clip generates root motion curves. + + AnimationClip to change. + Set to true to enable generation of root motion curves. + + + + Change the specified keyframe broken tangent flag. + + The curve to modify. + Keyframe index. + Broken flag. + + + + Change the specified keyframe tangent mode. + + The curve to modify. + Keyframe index. + Tangent mode. + + + + Change the specified keyframe tangent mode. + + The curve to modify. + Keyframe index. + Tangent mode. + + + + Adds, modifies or removes an object reference curve in a given clip. + + Setting this to null will remove the curve. + + + + + + Tangent constraints on Keyframe. + + + + + The tangents are automatically set to make the curve go smoothly through the key. + + + + + The tangents are automatically set to make the curve go smoothly through the key. + + + + + The curve retains a constant value between two keys. + + + + + The tangent can be freely set by dragging the tangent handle. + + + + + The tangent points towards the neighboring key. + + + + + .NET API compatibility level. + + + + + .NET 2.0. + + + + + .NET 2.0 Subset. + + + + + .NET 4.6. + + + + + Micro profile, used by Mono scripting backend on iOS, tvOS, and Android if stripping level is set to "Use micro mscorlib". + + + + + Profile that targets the .NET Standard 2.0. + + + + + Web profile, formerly used only by Samsung TV. + + + + + Helpers for builtin arrays. + + + + + Appends item to the end of array. + + + + + + + Appends items to the end of array. + + + + + + + Compares two arrays. + + + + + True if both have the same number of elements and the contents are equal. + + + + + Compares two array references. + + + + + True if both have the same number of elements and are the same instances. + + + + + Clears the array. + + + + + + Determines if the array contains the item. + + + + + True if item is in array, false otherwise. + + + + + Find the index of the first element that satisfies the predicate. + + + + + The zero-based index of the first occurrence of the element, if found; otherwise, �1. + + + + + Index of first element with value value. + + + + + The zero-based index of the element, if found; otherwise -1. + + + + + Inserts item item at position index. + + + + + + + + Index of the last element with value value. + + + + + The zero-based index of the element, if found; otherwise -1. + + + + + Removes item from array. + + + + + + + Remove element at position index. + + + + + + + Method used for calculating a font's ascent. + + + + + Ascender method. + + + + + Bounding box method. + + + + + Legacy bounding box method. + + + + + Aspect ratio. + + + + + 16:10 aspect ratio. + + + + + 16:9 aspect ratio. + + + + + 4:3 aspect ratio. + + + + + 5:4 aspect ratio. + + + + + Undefined aspect ratios. + + + + + This class has event dispatchers for assembly reload events. + + + + + This event is dispatched just after Unity have reloaded all assemblies. + + + + + + This event is dispatched just before Unity reloads all assemblies. + + + + + + Delegate used for assembly reload events. + + + + + AssetBundle building map entry. + + + + + Addressable name used to load an asset. + + + + + AssetBundle name. + + + + + AssetBundle variant. + + + + + Asset names which belong to the given AssetBundle. + + + + + An Interface for accessing assets and performing operations on assets. + + + + + Callback raised whenever a package import is cancelled by the user. + + + + + + Callback raised whenever a package import successfully completes. + + + + + + Callback raised whenever a package import failed. + + + + + + Callback raised whenever a package import starts. + + + + + + Adds objectToAdd to an existing asset at path. + + Object to add to the existing asset. + Filesystem path to the asset. + + + + Adds objectToAdd to an existing asset identified by assetObject. + + + + + + + Get the GUID for the asset at path. + + Filesystem path for the asset. + + GUID. + + + + + Removes all labels attached to an asset. + + + + + + Is object an asset? + + + + + + + Is object an asset? + + + + + + + Duplicates the asset at path and stores it at newPath. + + Filesystem path of the source asset. + Filesystem path of the new asset to create. + + + + Creates a new asset at path. + + Object to use in creating the asset. + Filesystem path for the new asset. + + + + Create a new folder. + + The name of the parent folder. + The name of the new folder. + + The GUID of the newly created folder. + + + + + Deletes the asset file at path. + + Filesystem path of the asset to be deleted. + + + + Exports the assets identified by assetPathNames to a unitypackage file in fileName. + + + + + + + + + Exports the assets identified by assetPathNames to a unitypackage file in fileName. + + + + + + + + + Exports the assets identified by assetPathNames to a unitypackage file in fileName. + + + + + + + + + Exports the assets identified by assetPathNames to a unitypackage file in fileName. + + + + + + + + + Creates an external Asset from an object (such as a Material) by extracting it from within an imported asset (such as an FBX file). + + The sub-asset to extract. + The file path of the new Asset. + + An empty string if Unity has successfully extracted the Asset, or an error message if not. + + + + + Search the asset database using the search filter string. + + The filter string can contain search data. See below for details about this string. + The folders where the search will start. + + Array of matching asset. Note that GUIDs will be returned. + + + + + Search the asset database using the search filter string. + + The filter string can contain search data. See below for details about this string. + The folders where the search will start. + + Array of matching asset. Note that GUIDs will be returned. + + + + + Forcibly load and re-serialize the given assets, flushing any outstanding data changes to disk. + + The paths to the assets that should be reserialized. If omitted, will reserialize all assets in the project. + Specify whether you want to reserialize the assets themselves, their .meta files, or both. If omitted, defaults to both. + + + + Forcibly load and re-serialize the given assets, flushing any outstanding data changes to disk. + + The paths to the assets that should be reserialized. If omitted, will reserialize all assets in the project. + Specify whether you want to reserialize the assets themselves, their .meta files, or both. If omitted, defaults to both. + + + + Forcibly load and re-serialize the given assets, flushing any outstanding data changes to disk. + + The paths to the assets that should be reserialized. If omitted, will reserialize all assets in the project. + Specify whether you want to reserialize the assets themselves, their .meta files, or both. If omitted, defaults to both. + + + + Creates a new unique path for an asset. + + + + + + Return all the AssetBundle names in the asset database. + + + Array of asset bundle names. + + + + + Given an assetBundleName, returns the list of AssetBundles that it depends on. + + The name of the AssetBundle for which dependencies are required. + If false, returns only AssetBundles which are direct dependencies of the input; if true, includes all indirect dependencies of the input. + + The names of all AssetBundles that the input depends on. + + + + + Returns the hash of all the dependencies of an asset. + + Path to the asset. + + Aggregate hash. + + + + + Returns the path name relative to the project folder where the asset is stored. + + + + + + Returns the path name relative to the project folder where the asset is stored. + + The instance ID of the asset. + A reference to the asset. + + The asset path name, or null, or an empty string if the asset does not exist. + + + + + Returns the path name relative to the project folder where the asset is stored. + + The instance ID of the asset. + A reference to the asset. + + The asset path name, or null, or an empty string if the asset does not exist. + + + + + Gets the path to the asset file associated with a text .meta file. + + + + + + Get the paths of the assets which have been marked with the given assetBundle name. + + + + + + Get the Asset paths for all Assets tagged with assetBundleName and + named assetName. + + + + + + + Retrieves an icon for the asset at the given asset path. + + + + + + Gets the IP address of the Cache Server currently in use by the Editor. + + + Returns a string representation of the current Cache Server IP address. + + + + + Given a pathName, returns the list of all assets that it depends on. + + The path to the asset for which dependencies are required. + If false, return only assets which are direct dependencies of the input; if true, include all indirect dependencies of the input. Defaults to true. + + The paths of all assets that the input depends on. + + + + + Given a pathName, returns the list of all assets that it depends on. + + The path to the asset for which dependencies are required. + If false, return only assets which are direct dependencies of the input; if true, include all indirect dependencies of the input. Defaults to true. + + The paths of all assets that the input depends on. + + + + + Given an array of pathNames, returns the list of all assets that the input depend on. + + The path to the assets for which dependencies are required. + If false, return only assets which are direct dependencies of the input; if true, include all indirect dependencies of the input. Defaults to true. + + The paths of all assets that the input depends on. + + + + + Given an array of pathNames, returns the list of all assets that the input depend on. + + The path to the assets for which dependencies are required. + If false, return only assets which are direct dependencies of the input; if true, include all indirect dependencies of the input. Defaults to true. + + The paths of all assets that the input depends on. + + + + + Returns the name of the AssetBundle that a given asset belongs to. + + The asset's path. + + Returns the name of the AssetBundle that a given asset belongs to. See the method description for more details. + + + + + Returns the name of the AssetBundle Variant that a given asset belongs to. + + The asset's path. + + Returns the name of the AssetBundle Variant that a given asset belongs to. See the method description for more details. + + + + + Returns all labels attached to a given asset. + + + + + + Returns the type of the main asset object at assetPath. + + Filesystem path of the asset to load. + + + + Given a path to a directory in the Assets folder, relative to the project folder, this method will return an array of all its subdirectories. + + + + + + Gets the path to the text .meta file associated with an asset. + + The path to the asset. + + The path to the .meta text file or empty string if the file does not exist. + + + + + Gets the path to the text .meta file associated with an asset. + + The path to the asset. + + The path to the .meta text file or empty string if the file does not exist. + + + + + Return all the unused assetBundle names in the asset database. + + + + + Translate a GUID to its current asset path. + + + + + + Import asset at path. + + + + + + + Import asset at path. + + + + + + + Imports package at packagePath into the current project. + + + + + + + Delegate to be called from AssetDatabase.ImportPackage callbacks. packageName is the name of the package that raised the callback. + + + + + + Delegate to be called from AssetDatabase.ImportPackage callbacks. packageName is the name of the package that raised the callback. errorMessage is the reason for the failure. + + + + + + + Determines whether the Asset is a foreign Asset. + + + + + + + Determines whether the Asset is a foreign Asset. + + + + + + + Is asset a main asset in the project window? + + + + + + + Is asset a main asset in the project window? + + + + + + + Returns true if the main asset object at assetPath is loaded in memory. + + Filesystem path of the asset to load. + + + + Query whether an asset's metadata (.meta) file is open for edit in version control. + + Object representing the asset whose metadata status you wish to query. + Returns a reason for the asset metadata not being open for edit. + Options for how the version control system should be queried. These options can effect the speed and accuracy of the query. + + + True if the asset's metadata is considered open for edit by the selected version control system. + + + + + Query whether an asset's metadata (.meta) file is open for edit in version control. + + Object representing the asset whose metadata status you wish to query. + Returns a reason for the asset metadata not being open for edit. + Options for how the version control system should be queried. These options can effect the speed and accuracy of the query. + + + True if the asset's metadata is considered open for edit by the selected version control system. + + + + + Query whether an asset's metadata (.meta) file is open for edit in version control. + + Object representing the asset whose metadata status you wish to query. + Returns a reason for the asset metadata not being open for edit. + Options for how the version control system should be queried. These options can effect the speed and accuracy of the query. + + + True if the asset's metadata is considered open for edit by the selected version control system. + + + + + Query whether an asset's metadata (.meta) file is open for edit in version control. + + Object representing the asset whose metadata status you wish to query. + Returns a reason for the asset metadata not being open for edit. + Options for how the version control system should be queried. These options can effect the speed and accuracy of the query. + + + True if the asset's metadata is considered open for edit by the selected version control system. + + + + + Determines whether the Asset is a native Asset. + + + + + + + Determines whether the Asset is a native Asset. + + + + + + + Query whether an asset file is open for edit in version control. + + Object representing the asset whose status you wish to query. + Path to the asset file or its .meta file on disk, relative to project folder. + Returns a reason for the asset not being open for edit. + Options for how the version control system should be queried. These options can effect the speed and accuracy of the query. + + + True if the asset is considered open for edit by the selected version control system. + + + + + Query whether an asset file is open for edit in version control. + + Object representing the asset whose status you wish to query. + Path to the asset file or its .meta file on disk, relative to project folder. + Returns a reason for the asset not being open for edit. + Options for how the version control system should be queried. These options can effect the speed and accuracy of the query. + + + True if the asset is considered open for edit by the selected version control system. + + + + + Query whether an asset file is open for edit in version control. + + Object representing the asset whose status you wish to query. + Path to the asset file or its .meta file on disk, relative to project folder. + Returns a reason for the asset not being open for edit. + Options for how the version control system should be queried. These options can effect the speed and accuracy of the query. + + + True if the asset is considered open for edit by the selected version control system. + + + + + Query whether an asset file is open for edit in version control. + + Object representing the asset whose status you wish to query. + Path to the asset file or its .meta file on disk, relative to project folder. + Returns a reason for the asset not being open for edit. + Options for how the version control system should be queried. These options can effect the speed and accuracy of the query. + + + True if the asset is considered open for edit by the selected version control system. + + + + + Query whether an asset file is open for edit in version control. + + Object representing the asset whose status you wish to query. + Path to the asset file or its .meta file on disk, relative to project folder. + Returns a reason for the asset not being open for edit. + Options for how the version control system should be queried. These options can effect the speed and accuracy of the query. + + + True if the asset is considered open for edit by the selected version control system. + + + + + Query whether an asset file is open for edit in version control. + + Object representing the asset whose status you wish to query. + Path to the asset file or its .meta file on disk, relative to project folder. + Returns a reason for the asset not being open for edit. + Options for how the version control system should be queried. These options can effect the speed and accuracy of the query. + + + True if the asset is considered open for edit by the selected version control system. + + + + + Query whether an asset file is open for edit in version control. + + Object representing the asset whose status you wish to query. + Path to the asset file or its .meta file on disk, relative to project folder. + Returns a reason for the asset not being open for edit. + Options for how the version control system should be queried. These options can effect the speed and accuracy of the query. + + + True if the asset is considered open for edit by the selected version control system. + + + + + Query whether an asset file is open for edit in version control. + + Object representing the asset whose status you wish to query. + Path to the asset file or its .meta file on disk, relative to project folder. + Returns a reason for the asset not being open for edit. + Options for how the version control system should be queried. These options can effect the speed and accuracy of the query. + + + True if the asset is considered open for edit by the selected version control system. + + + + + Does the asset form part of another asset? + + The asset Object to query. + Instance ID of the asset Object to query. + + + + Does the asset form part of another asset? + + The asset Object to query. + Instance ID of the asset Object to query. + + + + Given a path to a folder, returns true if it exists, false otherwise. + + The path to the folder. + + Returns true if the folder exists. + + + + + Returns all sub Assets at assetPath. + + + + + + Returns an array of all Assets at assetPath. + + Filesystem path to the asset. + + + + Returns the first asset object of type type at given path assetPath. + + Path of the asset to load. + Data type of the asset. + + The asset matching the parameters. + + + + + Returns the main asset object at assetPath. + + Filesystem path of the asset to load. + + + + Move an asset file (or folder) from one folder to another. + + The path where the asset currently resides. + The path which the asset should be moved to. + + An empty string if the asset has been successfully moved, otherwise an error message. + + + + + Moves the asset at path to the trash. + + + + + + Opens the asset with associated application. + + + + + + + + Opens the asset with associated application. + + + + + + + + Opens the asset with associated application. + + + + + + + + Opens the asset with associated application. + + + + + + + + Opens the asset(s) with associated application(s). + + + + + + Import any changed assets. + + + + + + Import any changed assets. + + + + + + Calling this function will release file handles internally cached by Unity. This allows modifying asset or meta files safely thus avoiding potential file sharing IO errors. + + + + + Remove the assetBundle name from the asset database. The forceRemove flag is used to indicate if you want to remove it even it's in use. + + The assetBundle name you want to remove. + Flag to indicate if you want to remove the assetBundle name even it's in use. + + + + Removes object from its asset (See Also: AssetDatabase.AddObjectToAsset). + + + + + + Remove all the unused assetBundle names in the asset database. + + + + + Rename an asset file. + + The path where the asset currently resides. + The new name which should be given to the asset. + + An empty string, if the asset has been successfully renamed, otherwise an error message. + + + + + Writes all unsaved asset changes to disk. + + + + + Replaces that list of labels on an asset. + + + + + + + Specifies which object in the asset file should become the main object after the next import. + + The object to become the main object. + Path to the asset file. + + + + Begin Asset importing. This lets you group several asset imports together into one larger import. + + + + + Stop Asset importing. This lets you group several asset imports together into one larger import. + + + + + Warning Use the overload with a long localId parameter. Using the overload with an integer localId parameter can cause an integer overflow in localId. This can happen when the object passed to the API is part of a Prefab. + +Get the GUID and local file id from an object instance id. + + InstanceID of the object to retrieve information for. + The object to retrieve GUID and File Id for. + The GUID of the asset. + The local file identifier of this asset. + + True if the guid and file id were successfully found, false if not. + + + + + Warning Use the overload with a long localId parameter. Using the overload with an integer localId parameter can cause an integer overflow in localId. This can happen when the object passed to the API is part of a Prefab. + +Get the GUID and local file id from an object instance id. + + InstanceID of the object to retrieve information for. + The object to retrieve GUID and File Id for. + The GUID of the asset. + The local file identifier of this asset. + + True if the guid and file id were successfully found, false if not. + + + + + Warning Use the overload with a long localId parameter. Using the overload with an integer localId parameter can cause an integer overflow in localId. This can happen when the object passed to the API is part of a Prefab. + +Get the GUID and local file id from an object instance id. + + InstanceID of the object to retrieve information for. + The object to retrieve GUID and File Id for. + The GUID of the asset. + The local file identifier of this asset. + + True if the guid and file id were successfully found, false if not. + + + + + Warning Use the overload with a long localId parameter. Using the overload with an integer localId parameter can cause an integer overflow in localId. This can happen when the object passed to the API is part of a Prefab. + +Get the GUID and local file id from an object instance id. + + InstanceID of the object to retrieve information for. + The object to retrieve GUID and File Id for. + The GUID of the asset. + The local file identifier of this asset. + + True if the guid and file id were successfully found, false if not. + + + + + Checks if an asset file can be moved from one folder to another. (Without actually moving the file). + + The path where the asset currently resides. + The path which the asset should be moved to. + + An empty string if the asset can be moved, otherwise an error message. + + + + + Writes the import settings to disk. + + + + + + Result of Asset delete operation + + + + + Tells Unity that the asset was deleted by the callback. Unity will not try to delete the asset, but will delete the cached version and preview file. + + + + + Tells the internal implementation that the callback did not delete the asset. The asset will be delete by the internal implementation. + + + + + Tells Unity that the file cannot be deleted and Unity should leave it alone. + + + + + Base class from which asset importers for specific asset types derive. + + + + + Get or set the AssetBundle name. + + + + + Get or set the AssetBundle variant. + + + + + The path name of the asset for this importer. (Read Only) + + + + + The value is true when no meta file is provided with the imported asset. + + + + + Get or set any user data. + + + + + Map a sub-asset from an imported asset (such as an FBX file) to an external Asset of the same type. + + The identifier of the sub-asset. + The object to be mapped to the internal object. Can belong to another Prefab or Asset, but not the Asset that is being changed. + + + + Retrieves the asset importer for the asset at path. + + + + + + Gets a copy of the external object map used by the AssetImporter. + + + The map between a sub-asset and an external Asset. + + + + + Removes an item from the map of external objects. + + The identifier of the sub-asset. + + Returns true if an element was removed, otherwise false. + + + + + Save asset importer settings if asset importer is dirty. + + + + + Set the AssetBundle name and variant. + + AssetBundle name. + AssetBundle variant. + + + + Represents a unique identifier for a sub-asset embedded in an imported Asset (such as an FBX file). + + + + + The name of the Asset. + + + + + The type of the Asset. + + + + + Constructs a SourceAssetIdentifier. + + The the sub-asset embedded in the imported Asset. + The type of the sub-asset embedded in the imported Asset. + The name of the sub-asset embedded in the imported Asset. + + + + Constructs a SourceAssetIdentifier. + + The the sub-asset embedded in the imported Asset. + The type of the sub-asset embedded in the imported Asset. + The name of the sub-asset embedded in the imported Asset. + + + + Checks if the AssetImporter supports remapping the given asset type. + + The type of asset to check. + + Returns true if the importer supports remapping the given type. Otherwise, returns false. + + + + + AssetModificationProcessor lets you hook into saving of serialized assets and + scenes which are edited inside Unity. + + + + + Result of Asset move + + + + + Tells the internal implementation that the script moved the asset physically on disk. + + + + + Tells the internal implementation that the asset was not moved physically on disk by the script. + + + + + Tells the internal implementation that the script could not move the assets. + + + + + AssetPostprocessor lets you hook into the import pipeline and run scripts prior or after importing assets. + + + + + Reference to the asset importer. + + + + + The path name of the asset being imported. + + + + + The import context. + + + + + Override the order in which importers are processed. + + + + + Returns the version of the asset postprocessor. + + + + + Logs an import error message to the console. + + + + + + + Logs an import error message to the console. + + + + + + + Logs an import warning to the console. + + + + + + + Logs an import warning to the console. + + + + + + + Utility for fetching asset previews by instance ID of assets, See AssetPreview.GetAssetPreview. Since previews are loaded asynchronously methods are provided for requesting if all previews have been fully loaded, see AssetPreview.IsLoadingAssetPreviews. Loaded previews are stored in a cache, the size of the cache can be controlled by calling [AssetPreview.SetPreviewTextureCacheSize]. + + + + + Returns a preview texture for an asset. + + + + + + Returns a preview texture for an instanceID of an asset. + + + + + Returns the thumbnail for an object (like the ones you see in the project view). + + + + + + Returns the thumbnail for the type. + + + + + + Returns the thumbnail for the object's type. + + + + + Loading previews is asynchronous so it is useful to know if a specific asset preview is in the process of being loaded so client code e.g can repaint while waiting for the loading to finish. + + InstanceID of the assset that a preview has been requested for by: AssetPreview.GetAssetPreview(). + + + + Loading previews is asynchronous so it is useful to know if any requested previews are in the process of being loaded so client code e.g can repaint while waiting. + + + + + Set the asset preview cache to a size that can hold all visible previews on the screen at once. + + The number of previews that can be loaded into the cache before the least used previews are being unloaded. + + + + AssetSettingsProvider is a specialization of the SettingsProvider class that converts legacy settings to Unified Settings. Legacy settings include any settings that used the Inspector to modify themselves, such as the *.asset files under the ProjectSettings folder. Under the hood, AssetSettingsProvider creates an Editor for specific Assets and builds the UI for the Settings window by wrapping the Editor.OnInspectorGUI function. + +Internally we use this class to wrap our existing settings. + + + + + Editor providing UI to modify the settings. + + + + + Create an AssetSettingsProvider from an asset path. + + Path of the settings in the Settings window. Uses "/" as separator. The last token becomes the settings label if none is provided. + Path of the asset on disk. + List of keywords to compare against what the user is searching for. When the user enters values in the search box on the Settings window, SettingsProvider.HasSearchInterest tries to match those keywords to this list. + + Returns an AssetSettingsProvider that will create an Editor for this particular asset. + + + + + Create an AssetSettingsProvider from a settings object. + + Path of the settings in the Settings window. Uses "/" as separator. The last token becomes the settings label if none is provided. + Settings object to display + List of keywords to compare against what the user is searching for. When the user enters values in the search box on the Settings window, SettingsProvider.HasSearchInterest tries to match those keywords to this list. + + Returns an AssetSettingsProvider that will create an Editor for this particular asset. + + + + + Create an AssetSettingsProvider from an asset resource path. + + Path of the settings in the Settings window. Uses "/" as separator. The last token becomes the settings label if none is provided. + Path of the resource on disk. + List of keywords to compare against what the user is searching for. When the user enters values in the search box on the Settings window, SettingsProvider.HasSearchInterest tries to match those keywords to this list. + + Returns an AssetSettingsProvider that will create an Editor for this particular asset. + + + + + Creates a new AssetSettingsProvider so you can wrap legacy settings (that is, settings that previously appeared in the Inspector). + + Path of the settings in the Settings window. Uses "/" as separator. The last token becomes the settings label if none is provided. + Functor creating an Editor able to modify the settings. + List of keywords to compare against what the user is searching for. When the user enters values in the search box on the Settings window, SettingsProvider.HasSearchInterest tries to match those keywords to this list. + Functor creating or getting a settings object. + + + + Creates a new AssetSettingsProvider so you can wrap legacy settings (that is, settings that previously appeared in the Inspector). + + Path of the settings in the Settings window. Uses "/" as separator. The last token becomes the settings label if none is provided. + Functor creating an Editor able to modify the settings. + List of keywords to compare against what the user is searching for. When the user enters values in the search box on the Settings window, SettingsProvider.HasSearchInterest tries to match those keywords to this list. + Functor creating or getting a settings object. + + + + Overrides SettingsProvider.OnActivate for this AssetSettingsProvider. + + Search context in the search box on the Settings window. + Root of the UIElements tree. If you add to this root, the SettingsProvider uses UIElements instead of calling SettingsProvider.OnGUI to build the UI. If you do not add to this VisualElement, then you must use the IMGUI to build the UI. + + + + Overrides SettingsProvider.OnDeactivate for this AssetSettingsProvider. + + + + + Overrides SettingsProvider.OnFooterBarGUI for this AssetSettingsProvider. + + + + + Overrides SettingsProvider.OnGUI for this AssetSettingsProvider. + + Search context for the Settings window. Used to show or hide relevant properties. + + + + Overrides SettingsProvider.OnTitleBarGUI for this AssetSettingsProvider. This draws the button bar that contains the "add to preset" and the "help" buttons. + + + + + Antialiased curve rendering functionality used by audio tools in the editor. + + + + + Curve evaluation function that allows simultaneous evaluation of the curve y-value and a color of the curve at that point. + + Normalized x-position in the range [0; 1] at which the curve should be evaluated. + Color of the curve at the evaluated point. + + + + Curve evaluation function used to evaluate the curve y-value and at the specified point. + + Normalized x-position in the range [0; 1] at which the curve should be evaluated. + + + + Curve evaluation function that allows simultaneous evaluation of the min- and max-curves. The returned minValue and maxValue values are expected to be in the range [-1; 1] and a value of 0 corresponds to the vertical center of the rectangle that is drawn into. Values outside of this range will be clamped. Additionally the color of the curve at this point is evaluated. + + Normalized x-position in the range [0; 1] at which the min- and max-curves should be evaluated. + Color of the curve at the specified evaluation point. + Returned value of the minimum curve. Clamped to [-1; 1]. + Returned value of the maximum curve. Clamped to [-1; 1]. + + + + Renders a thin curve determined by the curve evaluation function. The solid color of the curve is set by the curveColor argument. + + Rectangle determining the size of the graph. + Curve evaluation function. + Solid fill color of the curve. The alpha-channel determines the amount of opacity. + + + + Fills the area between the curve evaluated by the AudioCurveAndColorEvaluator provided and the bottom of the rectngle with smooth gradients along the edges. + + Rectangle determining the size of the graph. + Normalized x-position in the range [0; 1] at which the curve should be evaluated. The returned value is expected to be in the range [-1; 1] and a value of 0 corresponds to the vertical center of the rectangle that is drawn into. Values outside of this range will be clamped. + Solid fill color of the curve. The alpha-channel determines the amount of opacity. + + + + Fills the area between the curve evaluated by the AudioCurveAndColorEvaluator provided and the bottom of the rectngle with smooth gradients along the edges. + + Rectangle determining the size of the graph. + Normalized x-position in the range [0; 1] at which the curve should be evaluated. The returned value is expected to be in the range [-1; 1] and a value of 0 corresponds to the vertical center of the rectangle that is drawn into. Values outside of this range will be clamped. + Solid fill color of the curve. The alpha-channel determines the amount of opacity. + + + + Fills the area between the two curves evaluated by the AudioMinMaxCurveAndColorEvaluator provided with smooth gradients along the edges. + + Rectangle determining the size of the graph. + Normalized x-position in the range [0; 1] at which the min- and max-curves should be evaluated. The returned minValue and maxValue values are expected to be in the range [-1; 1] and a value of 0 corresponds to the vertical center of the rectangle that is drawn into. Values outside of this range will be clamped. + + + + Fills the area between the curve evaluated by the AudioCurveAndColorEvaluator provided and its vertical mirror image with smooth gradients along the edges. Useful for drawing amplitude plots of audio signals. + + Rectangle determining the size of the graph. + Normalized x-position in the range [0; 1] at which the curve should be evaluated. The returned value is expected to be in the range [0; 1] and a value of 0 corresponds to the vertical center of the rectangle that is drawn into. Values outside of this range will be clamped. + + + + Audio importer lets you modify AudioClip import settings from editor scripts. + + + + + When this flag is set, the audio clip will be treated as being ambisonic. + + + + + Compression bitrate. + + + + + The default sample settings for the AudioClip importer. + + + + + Force audioclips to mono? + + + + + Corresponding to the "Load In Background" flag in the AudioClip inspector, when this flag is set, the loading of the clip will happen delayed without blocking the main thread. + + + + + Preloads audio data of the clip when the clip asset is loaded. When this flag is off, scripts have to call AudioClip.LoadAudioData() to load the data before the clip can be played. Properties like length, channels and format are available before the audio data has been loaded. + + + + + Clears the sample settings override for the given platform. + + The platform to clear the overrides for. + + Returns true if any overrides were actually cleared. + + + + + Returns whether a given build target has its sample settings currently overridden. + + The platform to query if this AudioImporter has an override for. + + Returns true if the platform is currently overriden in this AudioImporter. + + + + + Return the current override settings for the given platform. + + The platform to get the override settings for. + + The override sample settings for the given platform. + + + + + Sets the override sample settings for the given platform. + + The platform which will have the sample settings overridden. + The override settings for the given platform. + + Returns true if the settings were successfully overriden. Some setting overrides are not possible for the given platform, in which case false is returned and the settings are not registered. + + + + + This structure contains a collection of settings used to define how an AudioClip should be imported. + +This structure is used with the AudioImporter to define how the AudioClip should be imported and treated during loading within the Scene. + + + + + CompressionFormat defines the compression type that the audio file is encoded to. Different compression types have different performance and audio artifact characteristics. + + + + + LoadType defines how the imported AudioClip data should be loaded. + + + + + Audio compression quality (0-1) + +Amount of compression. The value roughly corresponds to the ratio between the resulting and the source file sizes. + + + + + Target sample rate to convert to when samplerateSetting is set to OverrideSampleRate. + + + + + Defines how the sample rate is modified (if at all) of the importer audio file. + + + + + The sample rate setting used within the AudioImporter. This defines the sample rate conversion of audio on import. + + + + + Let Unity deduce the optimal sample rate for the AudioClip being imported. The audio file will be analysed and a minimal sample rate chosen while still preserving audio quality. + + + + + Override the sample rate of the imported audio file with a custom value. + + + + + Do not change the sample rate of the imported audio file. The sample rate will be preserved for the imported AudioClip. + + + + + An exception class that represents a failed build. + + + + + Constructs a BuildFailedException object. + + A string of text describing the error that caused the build to fail. + The exception that caused the build to fail. + + + + Constructs a BuildFailedException object. + + A string of text describing the error that caused the build to fail. + The exception that caused the build to fail. + + + + Container for holding asset loading information for an AssetBundle to be built. + + + + + List of asset loading information for an AssetBundle. + + + + + Friendly AssetBundle name. + + + + + Default constructor for an empty AssetBundleInfo. + + + + + Container for holding preload information for a given serialized Asset. + + + + + Friendly name used to load the built asset. + + + + + GUID for the given asset. + + + + + List of objects that an asset contains in its source file. + + + + + List of objects that an asset references. + + + + + Default constructor for an empty AssetLoadInfo. + + + + + Struct containing settings that control the compression method of content. + + + + + Returns a BuildCompression struct set with the default values used for Lz4HC compression. + + + + + Returns a BuildCompression struct set with the default values used for LZMA compression. + + + + + Returns a BuildCompression struct set with the default values used for uncompressed. + + + + + Container for holding information about where objects will be serialized in a build. + + + + + Adds a mapping for a single Object to where it will be serialized out to the build. + + + + + + + + + Adds mappings for a set of Objects to where they will be serialized out to the build. + + + + + + + + Adds mappings for a set of Objects to where they will be serialized out to the build. + + + + + + + + Default constructor for an empty BuildReferenceMap. + + + + + Dispose the BuildReferenceMap destroying all internal state. + + + + + Returns true if the objects are equal. + + + + + + Gets the hash for the BuildReferenceMap. + + + + + Gets the hash code for the BuildReferenceMap. + + + + + ISerializable method for serialization support outside of Unity's internal serialization system. + + + + + + + Struct containing information on how to build content. + + + + + Specific build options to use when building content. + + + + + Platform group for which content will be built. + + + + + Platform target for which content will be built. + + + + + Type information to use for building content. + + + + + Caching object for the Scriptable Build Pipeline. + + + + + Default contructor. + + + + + Dispose the BuildUsageCache destroying all internal state. + + + + + Container for holding information about lighting information being used in a build. + + + + + Combines the usage data from another BuildUsageTagGlobal with this BuildUsageTagGlobal. + + + + + + + Container for holding information about how objects are being used in a build. + + + + + Default constructor for an empty BuildUsageTagSet. + + + + + Dispose the BuildUsageTagSet destroying all internal state. + + + + + Returns true if the objects are equal. + + + + + + Gets the hash for the BuildReferenceMap. + + + + + Gets the hash code for the BuildUsageTagSet. + + + The hash code of the BuildUsageTagSet. + + + + + ISerializable method for serialization support outside of Unity's internal serialization system. + + + + + + + Returns an array of ObjectIdentifiers that this BuildUsageTagSet contains usage information about. + + + + + Adds the Object usage information from another BuildUsageTagSet to this BuildUsageTagSet. + + Object usage information to be added to this BuildUsageTagSet. + + + + Enum to indicate if compression should emphasize speed or size. + + + + + Content should be compressed as fast. + + + + + Content should be compressed as fast as possible. + + + + + Content should be compressed small. + + + + + Content should be compressed as small as possible. + + + + + None. Defaults to Normal. + + + + + Content should be ballanced between size and speed. + + + + + Enum containing the types of compression supported for built content. + + + + + Chunk-based content compression. + + + + + Chunk-based content compression using the high compression variant. + + + + + Single stream content compression. + + + + + Uncompressed content. + + + + + Build options for content. + + + + + Do not include type information within the built content. + + + + + Build content with no additional options. + + + + + Low level interface for building content for Unity. + + + + + Combines resource files into a single archive and compresses them based on the passed in options. + + + + + + + + Calculates the build usage of a set of objects. + + Objects that will have their build usage calculated. + Objects that reference the Objects being calculated. + Lighting information used by the build. + The BuildUsageTagSet where the calculated usage information will be stored. + Optional cache object to use for improving performance with multiple calls to this api. + + + + Calculates the build usage of a set of objects. + + Objects that will have their build usage calculated. + Objects that reference the Objects being calculated. + Lighting information used by the build. + The BuildUsageTagSet where the calculated usage information will be stored. + Optional cache object to use for improving performance with multiple calls to this api. + + + + Returns an array of AssetBundleBuild structs that detail the current asset bundle layout set in the AssetDatabase. + + + + + Returns a list of objects referenced by an object. + + + + + + + + Returns a list of objects referenced by a set of objects. + + + + + + + + Returns a list of objects directly contained inside of an asset. + + + + + + + Gets the type of an object specified by an ObjectIdentifier. + + + + + + Gets the types of all the objects specified by ObjectIdentifiers. + + + + + + Calculates the Scene dependency information and writes a post processed Scene to disk. + + Optional cache object to use for improving performance with multiple calls to this api. + Input path of the Scene to prepare. + Settings to use for preparing the Scene. + Output usage information generated from preparing the Scene. + Output location where the post prepared Scene will be saved. + + Dependency information for the Scene. + + + + + Calculates the Scene dependency information and writes a post processed Scene to disk. + + Optional cache object to use for improving performance with multiple calls to this api. + Input path of the Scene to prepare. + Settings to use for preparing the Scene. + Output usage information generated from preparing the Scene. + Output location where the post prepared Scene will be saved. + + Dependency information for the Scene. + + + + + Writes Scene objects to a serialized file on disk. + + + + + + + + + + + + + + + Writes Scene objects to a serialized file on disk. + + + + + + + + + + + + + + + Writes Scene objects to a serialized file on disk. + + + + + + + + + + + + + + + Writes objects to a serialized file on disk. + + + + + + + + + + + + Writes objects to a serialized file on disk. + + + + + + + + + + + + Enum description of the type of file an object comes from. + + + + + Object is contained in a very old format. Currently unused. + + + + + Object is contained in the imported asset meta data located in the Library folder. + + + + + Object is contained in file not currently tracked by the AssetDatabase. + + + + + Object is contained in a standard asset file type located in the Assets folder. + + + + + Struct that identifies a specific object project wide. + + + + + The file path on disk that contains this object. (Only used for objects not known by the AssetDatabase). + + + + + Type of file that contains this object. + + + + + The specific asset that contains this object. + + + + + The index of the object inside a serialized file. + + + + + Returns true if the objects are equal. + + + + + + Gets the hash code for the ObjectIdentifier. + + + + + Returns true if the ObjectIdentifiers are the same. + + + + + + + Returns true if the first ObjectIdentifier is greater than the second ObjectIdentifier. + + + + + + + Returns true if the first ObjectIdentifier is less than the second ObjectIdentifier. + + + + + + + Returns true if the ObjectIdentifiers are different. + + + + + + + Returns a nicely formatted string for this ObjectIdentifier. + + + + + Struct containing details about how an object was serialized. + + + + + Serialized object header information. + + + + + Raw byte data of the object if it was serialized seperately from the header. + + + + + Object that was serialized. + + + + + Container for holding a list of preload objects for a Scene to be built. + + + + + List of Objects for a serialized Scene that need to be preloaded. + + + + + Default constructor for an empty PreloadInfo. + + + + + Details about a specific file written by the ContentBuildInterface.WriteSerializedFile or ContentBuildInterface.WriteSceneSerializedFile APIs. + + + + + Internal name used by the loading system for a resource file. + + + + + Path to the resource file on disk. + + + + + Bool to determine if this resource file represents serialized Unity objects (serialized file) or binary resource data. + + + + + Container for holding asset loading information for a streamed Scene AssetBundle to be built. + + + + + Friendly AssetBundle name. + + + + + List of Scene loading information for an AssetBundle. + + + + + Default constructor for an empty SceneBundleInfo. + + + + + Scene dependency information generated from the ContentBuildInterface.PrepareScene API. + + + + + Lighting information used by the Scene. + + + + + Path to the post processed version of the Scene. + + + + + List of objects referenced by the Scene. + + + + + Scene's original asset path. + + + + + Container for holding preload information for a given serialized Scene in an AssetBundle. + + + + + Friendly name used to load the built Scene from an asset bundle. + + + + + GUID for the given Scene. + + + + + Internal name used to load the built Scene from an asset bundle. + + + + + Default constructor for an empty SceneLoadInfo. + + + + + Container for holding object serialization order information for a build. + + + + + Order in which the object will be serialized to disk. + + + + + Source object to be serialzied to disk. + + + + + Default constructor for an empty SerializationInfo. + + + + + Struct containing information about where an object was serialized. + + + + + File path on disk where the object was serialized. + + + + + Byte offset for the start of the object's data. + + + + + Size of the object's data. + + + + + Container for holding information about a serialized file to be written. + + + + + Final file name on disk of the serialized file. + + + + + Internal name used by the loading system for a serialized file. + + + + + List of objects and their order contained inside a serialized file. + + + + + Default constructor for an empty WriteCommand. + + + + + Struct containing the results from the ContentBuildPipeline.WriteSerialziedFile and ContentBuildPipeline.WriteSceneSerialziedFile APIs. + + + + + Types that were included in the serialized file. + + + + + Collection of files written by the ContentBuildInterface.WriteSerializedFile or ContentBuildInterface.WriteSceneSerializedFile APIs. + + + + + Collection of objects written to the serialized file. + + + + + Implement this interface to receive a callback after the active build platform has changed. + + + + + This function is called automatically when the active build platform has changed. + + The build target before the change. + The new active build target. + + + + Implement this interface to receive a callback to filter assemblies away from the build. + + + + + Will be called after building script assemblies, but makes it possible to filter away unwanted scripts to be included. + + The current build options. + The list of assemblies that will be included. + + Returns the filtered list of assemblies that are included in the build. + + + + + Interface that provides control over callback order. + + + + + Returns the relative callback order for callbacks. Callbacks with lower values are called before ones with higher values. + + + + + Implement this interface to receive a callback just after the player scripts have been compiled. + + + + + Implement this interface to receive a callback just after the player scripts have been compiled. + + A report containing information about the build, such as its target platform and output path. + + + + Implement this interface to receive a callback after the build is complete. + + + + + Implement this function to receive a callback after the build is complete. + + + + + + + Implement this interface to receive a callback after the build is complete. + + + + + Implement this function to receive a callback after the build is complete. + + A BuildReport containing information about the build, such as the target platform and output path. + + + + Implement this interface to receive a callback before the build is started. + + + + + Implement this function to receive a callback before the build is started. + + + + + + + Implement this interface to receive a callback before the build is started. + + + + + Implement this function to receive a callback before the build is started. + + A report containing information about the build, such as its target platform and output path. + + + + Implement this interface to receive a callback before a shader is compiled. + + + + + Implement this interface to receive a callback before a shader snippet is compiled. + + Shader that is being compiled. + Details about the specific shader code being compiled. + List of variants to be compiled for the specific shader code. + + + + Implement this interface to receive a callback for each Scene during the build. + + + + + Implement this function to receive a callback for each Scene during the build. + + The current Scene being processed. + + + + Implement this interface to receive a callback for each Scene during the build. + + + + + Implement this function to receive a callback for each Scene during the build. + + The current Scene being processed. + A report containing information about the current build. When this callback is invoked for Scene loading during Editor playmode, this parameter will be null. + + + + Low level interface for building scripts for Unity. + + + + + Compiles user scripts into one or more assemblies. + + + + + + + Script compilation options. + + + + + Include assertions in the compiled scripts. By default, the assertions are only included in development builds. + + + + + Build a development version of the scripts. + + + + + Compiled the scripts without any special settings. + + + + + Struct with result information returned from the PlayerBuildInterface.CompilePlayerScripts API. + + + + + Collection of assemblies compiled. + + + + + Type information generated by the script compilation call. + + + + + Struct containing information on how to build scripts. + + + + + Platform group for which scripts will be compiled. + + + + + Specific compiler options to use when compiling scripts. + + + + + Platform group for which scripts will be compiled. + + + + + Container for holding information about script type and property data. + + + + + Dispose the TypeDB destroying all internal state. + + + + + Returns true if the objects are equal. + + + + + + Gets the hash for the BuildReferenceMap. + + + + + Gets the hash code for the TypeDB. + + + + + ISerializable method for serialization support outside of Unity's internal serialization system. + + + + + + + Contains information about a single file produced by the build process. + + + + + The absolute path of the file produced by the build process. + + + + + The role the file plays in the build output. + + + + + The total size of the file, in bytes. + + + + + The BuildReport API gives you information about the Unity build process. + + + + + An array of all the files output by the build process. + + + + + An array of all the BuildSteps that took place during the build process. + + + + + The StrippingInfo object for the build. + + + + + A BuildSummary containing overall statistics and data about the build process. + + + + + Describes the outcome of the build process. + + + + + Indicates that the build was cancelled by the user. + + + + + Indicates that the build failed. + + + + + Indicates that the build completed successfully. + + + + + Indicates that the outcome of the build is in an unknown state. + + + + + Contains information about a single step in the build process. + + + + + The nesting depth of the build step. + + + + + The total duration for this build step. + + + + + All log messages recorded during this build step, in the order of which they occurred. + + + + + The name of this build step. + + + + + Contains information about a single log message recorded during the build process. + + + + + The text content of the log message. + + + + + The LogType of the log message. + + + + + Contains overall summary information about a build. + + + + + The time the build ended. + + + + + The time the build was started. + + + + + The Application.buildGUID of the build. + + + + + The BuildOptions used for the build, as passed to BuildPipeline.BuildPlayer. + + + + + The output path for the build, as provided to BuildPipeline.BuildPlayer. + + + + + The platform that the build was created for. + + + + + The platform group the build was created for. + + + + + The outcome of the build. + + + + + The total number of errors and exceptions recorded during the build process. + + + + + The total size of the build output, in bytes. + + + + + The total time taken by the build process. + + + + + The total number of warnings recorded during the build process. + + + + + This class provides constant values for some of the common roles used by files in the build. The role of each file in the build is available in BuildFile.role. + + + + + The BuildFile.role value of the file that provides config information used in Low Integrity mode on Windows. + + + + + The BuildFile.role value of built AssetBundle files. + + + + + The BuildFile.role value of an AssetBundle manifest file, produced during the build process, that contains information about the bundle and its dependencies. + + + + + The BuildFile.role value of the file that contains configuration information for the very early stages of engine startup. + + + + + The BuildFile.role value of the file that contains built-in resources for the engine. + + + + + The BuildFile.role value of the file that contains Unity's built-in shaders, such as the Standard shader. + + + + + The BuildFile.role value of the executable that is used to capture crashes from the player. + + + + + The BuildFile.role value of files that contain information for debuggers. + + + + + The BuildFile.role value of a managed library that is present in the build due to being a dependency of a CommonRoles.managedLibrary. + + + + + The BuildFile.role value of the main Unity runtime when it is built as a separate library. + + + + + The BuildFile.role value of an executable - the file that will actually be launched on the target device. + + + + + The BuildFile.role value of the file that contains global Project Settings data for the player. + + + + + The BuildFile.role value of files that provide the managed API for Unity. + + + + + The BuildFile.role value of a managed assembly, containing compiled script code. + + + + + The BuildFile.role value of a manifest AssetBundle, which is an AssetBundle that contains information about other AssetBundles and their dependencies. + + + + + The BuildFile.role value of files that are used as configuration data by the Mono runtime. + + + + + The BuildFile.role value of files that make up the Mono runtime itself. + + + + + The BuildFile.role value of the file that contains the contents of the project's "Resources" folder, packed into a single file. + + + + + The BuildFile.role value of a file that contains the packed content of a Scene. + + + + + The BuildFile.role value of a file that contains asset objects which are shared between Scenes. Examples of asset objects are textures, models, and audio. + + + + + The BuildFile.role value of files that have been copied into the build without modification from the StreamingAssets folder in the project. + + + + + The BuildFile.role value of a file that contains streaming resource data. + + + + + The StrippingInfo object contains information about which native code modules in the engine are still present in the build, and the reasons why they are still present. + + + + + The native engine modules that were included in the build. + + + + + Returns the list of dependencies or reasons that caused the given entity to be included in the build. + + The name of an engine module, class, or other entity present in the build. + + A list of modules, classes, or other entities that caused the provided entity to be included in the build. + + + + + Asset Bundle building options. + + + + + Append the hash to the assetBundle name. + + + + + Use chunk-based LZ4 compression when creating the AssetBundle. + + + + + Includes all dependencies. + + + + + Forces inclusion of the entire asset. + + + + + Builds an asset bundle using a hash for the id of the object stored in the asset bundle. + + + + + Disables Asset Bundle LoadAsset by file name. + + + + + Disables Asset Bundle LoadAsset by file name with extension. + + + + + Do not include type information within the AssetBundle. + + + + + Do a dry run build. + + + + + Force rebuild the assetBundles. + + + + + Ignore the type tree changes when doing the incremental build check. + + + + + Build assetBundle without any special option. + + + + + Do not allow the build to succeed if any errors are reporting during it. + + + + + Don't compress the data when creating the asset bundle. + + + + + Building options. Multiple options can be combined together. + + + + + Used when building Xcode (iOS) or Eclipse (Android) projects. + + + + + Allow script debuggers to attach to the player remotely. + + + + + Run the built player. + + + + + Build a compressed asset bundle that contains streamed Scenes loadable with the UnityWebRequest class. + + + + + Only build the scripts in a Project. + + + + + Use chunk-based LZ4 compression when building the Player. + + + + + Use chunk-based LZ4 high-compression when building the Player. + + + + + Sets the Player to connect to the Editor. + + + + + Start the player with a connection to the profiler in the editor. + + + + + Build a development version of the player. + + + + + Build headless Linux standalone. + + + + + Include assertions in the build. By default, the assertions are only included in development builds. + + + + + Force full optimizations for script complilation in Development builds. + + + + + Build will include Assemblies for testing. + + + + + Perform the specified build without any special settings or extra tasks. + + + + + Will force the buildGUID to all zeros. + + + + + Show the built player. + + + + + Do not allow the build to succeed if any errors are reporting during it. + + + + + Symlink runtime libraries when generating iOS Xcode project. (Faster iteration time). + + + + + Don't compress the data when creating the asset bundle. + + + + + Copy UnityObject.js alongside Web Player so it wouldn't have to be downloaded from internet. + + + + + Lets you programmatically build players or AssetBundles which can be loaded from the web. + + + + + Is a player currently being built? + + + + + Builds an asset bundle. + + Lets you specify a specific object that can be conveniently retrieved using AssetBundle.mainAsset. + An array of assets to write into the bundle. + The filename where to write the compressed asset bundle. + Automatically include dependencies or always include complete assets instead of just the exact referenced objects. + The platform to build the bundle for. + The optional crc output parameter can be used to get a CRC checksum for the generated AssetBundle, which can be used to verify content when downloading AssetBundles using UnityWebRequestAssetBundle.GetAssetBundle. + + + + Builds an asset bundle. + + Lets you specify a specific object that can be conveniently retrieved using AssetBundle.mainAsset. + An array of assets to write into the bundle. + The filename where to write the compressed asset bundle. + Automatically include dependencies or always include complete assets instead of just the exact referenced objects. + The platform to build the bundle for. + The optional crc output parameter can be used to get a CRC checksum for the generated AssetBundle, which can be used to verify content when downloading AssetBundles using UnityWebRequestAssetBundle.GetAssetBundle. + + + + Builds an asset bundle. + + Lets you specify a specific object that can be conveniently retrieved using AssetBundle.mainAsset. + An array of assets to write into the bundle. + The filename where to write the compressed asset bundle. + Automatically include dependencies or always include complete assets instead of just the exact referenced objects. + The platform to build the bundle for. + The optional crc output parameter can be used to get a CRC checksum for the generated AssetBundle, which can be used to verify content when downloading AssetBundles using UnityWebRequestAssetBundle.GetAssetBundle. + + + + Builds an asset bundle. + + Lets you specify a specific object that can be conveniently retrieved using AssetBundle.mainAsset. + An array of assets to write into the bundle. + The filename where to write the compressed asset bundle. + Automatically include dependencies or always include complete assets instead of just the exact referenced objects. + The platform to build the bundle for. + The optional crc output parameter can be used to get a CRC checksum for the generated AssetBundle, which can be used to verify content when downloading AssetBundles using UnityWebRequestAssetBundle.GetAssetBundle. + + + + Builds an asset bundle. + + Lets you specify a specific object that can be conveniently retrieved using AssetBundle.mainAsset. + An array of assets to write into the bundle. + The filename where to write the compressed asset bundle. + Automatically include dependencies or always include complete assets instead of just the exact referenced objects. + The platform to build the bundle for. + The optional crc output parameter can be used to get a CRC checksum for the generated AssetBundle, which can be used to verify content when downloading AssetBundles using UnityWebRequestAssetBundle.GetAssetBundle. + + + + Builds an asset bundle. + + Lets you specify a specific object that can be conveniently retrieved using AssetBundle.mainAsset. + An array of assets to write into the bundle. + The filename where to write the compressed asset bundle. + Automatically include dependencies or always include complete assets instead of just the exact referenced objects. + The platform to build the bundle for. + The optional crc output parameter can be used to get a CRC checksum for the generated AssetBundle, which can be used to verify content when downloading AssetBundles using UnityWebRequestAssetBundle.GetAssetBundle. + + + + Builds an asset bundle, with custom names for the assets. + + A collection of assets to be built into the asset bundle. Asset bundles can contain any asset found in the project folder. + An array of strings of the same size as the number of assets. +These will be used as asset names, which you can then pass to AssetBundle.Load to load a specific asset. Use BuildAssetBundle to just use the asset's path names instead. + The location where the compressed asset bundle will be written to. + Automatically include dependencies or always include complete assets instead of just the exact referenced objects. + The platform where the asset bundle will be used. + An optional output parameter used to get a CRC checksum for the generated AssetBundle. (Used to verify content when downloading AssetBundles using UnityWebRequestAssetBundle.GetAssetBundle().) + + + + Builds an asset bundle, with custom names for the assets. + + A collection of assets to be built into the asset bundle. Asset bundles can contain any asset found in the project folder. + An array of strings of the same size as the number of assets. +These will be used as asset names, which you can then pass to AssetBundle.Load to load a specific asset. Use BuildAssetBundle to just use the asset's path names instead. + The location where the compressed asset bundle will be written to. + Automatically include dependencies or always include complete assets instead of just the exact referenced objects. + The platform where the asset bundle will be used. + An optional output parameter used to get a CRC checksum for the generated AssetBundle. (Used to verify content when downloading AssetBundles using UnityWebRequestAssetBundle.GetAssetBundle().) + + + + Builds an asset bundle, with custom names for the assets. + + A collection of assets to be built into the asset bundle. Asset bundles can contain any asset found in the project folder. + An array of strings of the same size as the number of assets. +These will be used as asset names, which you can then pass to AssetBundle.Load to load a specific asset. Use BuildAssetBundle to just use the asset's path names instead. + The location where the compressed asset bundle will be written to. + Automatically include dependencies or always include complete assets instead of just the exact referenced objects. + The platform where the asset bundle will be used. + An optional output parameter used to get a CRC checksum for the generated AssetBundle. (Used to verify content when downloading AssetBundles using UnityWebRequestAssetBundle.GetAssetBundle().) + + + + Builds an asset bundle, with custom names for the assets. + + A collection of assets to be built into the asset bundle. Asset bundles can contain any asset found in the project folder. + An array of strings of the same size as the number of assets. +These will be used as asset names, which you can then pass to AssetBundle.Load to load a specific asset. Use BuildAssetBundle to just use the asset's path names instead. + The location where the compressed asset bundle will be written to. + Automatically include dependencies or always include complete assets instead of just the exact referenced objects. + The platform where the asset bundle will be used. + An optional output parameter used to get a CRC checksum for the generated AssetBundle. (Used to verify content when downloading AssetBundles using UnityWebRequestAssetBundle.GetAssetBundle().) + + + + Builds an asset bundle, with custom names for the assets. + + A collection of assets to be built into the asset bundle. Asset bundles can contain any asset found in the project folder. + An array of strings of the same size as the number of assets. +These will be used as asset names, which you can then pass to AssetBundle.Load to load a specific asset. Use BuildAssetBundle to just use the asset's path names instead. + The location where the compressed asset bundle will be written to. + Automatically include dependencies or always include complete assets instead of just the exact referenced objects. + The platform where the asset bundle will be used. + An optional output parameter used to get a CRC checksum for the generated AssetBundle. (Used to verify content when downloading AssetBundles using UnityWebRequestAssetBundle.GetAssetBundle().) + + + + Builds an asset bundle, with custom names for the assets. + + A collection of assets to be built into the asset bundle. Asset bundles can contain any asset found in the project folder. + An array of strings of the same size as the number of assets. +These will be used as asset names, which you can then pass to AssetBundle.Load to load a specific asset. Use BuildAssetBundle to just use the asset's path names instead. + The location where the compressed asset bundle will be written to. + Automatically include dependencies or always include complete assets instead of just the exact referenced objects. + The platform where the asset bundle will be used. + An optional output parameter used to get a CRC checksum for the generated AssetBundle. (Used to verify content when downloading AssetBundles using UnityWebRequestAssetBundle.GetAssetBundle().) + + + + Build all AssetBundles specified in the editor. + + Output path for the AssetBundles. + AssetBundle building options. + Chosen target build platform. + + The manifest listing all AssetBundles included in this build. + + + + + Build AssetBundles from a building map. + + Output path for the AssetBundles. + AssetBundle building map. + AssetBundle building options. + Target build platform. + + The manifest listing all AssetBundles included in this build. + + + + + Builds a player. + + Provide various options to control the behavior of BuildPipeline.BuildPlayer. + + A BuildReport giving build process information. + + + + + Builds a player. These overloads are still supported, but will be replaced. Please use BuildPlayer (BuildPlayerOptions buildPlayerOptions) instead. + + The Scenes to be included in the build. If empty, the currently open Scene will be built. Paths are relative to the project folder (AssetsMyLevelsMyScene.unity). + The path where the application will be built. + The BuildTarget to build. + Additional BuildOptions, like whether to run the built player. + + An error message if an error occurred. + + + + + Builds a player. These overloads are still supported, but will be replaced. Please use BuildPlayer (BuildPlayerOptions buildPlayerOptions) instead. + + The Scenes to be included in the build. If empty, the currently open Scene will be built. Paths are relative to the project folder (AssetsMyLevelsMyScene.unity). + The path where the application will be built. + The BuildTarget to build. + Additional BuildOptions, like whether to run the built player. + + An error message if an error occurred. + + + + + Builds one or more Scenes and all their dependencies into a compressed asset bundle. + + Pathnames of levels to include in the asset bundle. + Pathname for the output asset bundle. + Runtime platform on which the asset bundle will be used. + Output parameter to receive CRC checksum of generated assetbundle. + Build options. See BuildOptions for possible values. + + String with an error message, empty on success. + + + + + Builds one or more Scenes and all their dependencies into a compressed asset bundle. + + Pathnames of levels to include in the asset bundle. + Pathname for the output asset bundle. + Runtime platform on which the asset bundle will be used. + Output parameter to receive CRC checksum of generated assetbundle. + Build options. See BuildOptions for possible values. + + String with an error message, empty on success. + + + + + Builds one or more Scenes and all their dependencies into a compressed asset bundle. + + Pathnames of levels to include in the asset bundle. + Pathname for the output asset bundle. + Runtime platform on which the asset bundle will be used. + Output parameter to receive CRC checksum of generated assetbundle. + Build options. See BuildOptions for possible values. + + String with an error message, empty on success. + + + + + Builds one or more Scenes and all their dependencies into a compressed asset bundle. + + Pathnames of levels to include in the asset bundle. + Pathname for the output asset bundle. + Runtime platform on which the asset bundle will be used. + Output parameter to receive CRC checksum of generated assetbundle. + Build options. See BuildOptions for possible values. + + String with an error message, empty on success. + + + + + Extract the crc checksum for the given AssetBundle. + + + + + + + Extract the hash for the given AssetBundle. + + + + + + + Returns true if the specified build target is currently available in the Editor. + + build target group + build target + + + + Lets you manage cross-references and dependencies between different asset bundles and player builds. + + + + + Lets you manage cross-references and dependencies between different asset bundles and player builds. + + + + + Provide various options to control the behavior of BuildPipeline.BuildPlayer. + + + + + The path to an manifest file describing all of the asset bundles used in the build (optional). + + + + + The path where the application will be built. + + + + + Additional BuildOptions, like whether to run the built player. + + + + + The Scenes to be included in the build. If empty, the currently open Scene will be built. Paths are relative to the project folder (AssetsMyLevelsMyScene.unity). + + + + + The BuildTarget to build. + + + + + The BuildTargetGroup to build. + + + + + The default build settings window. + + + + + Exceptions used to indicate abort or failure in the callbacks registered via BuildPlayerWindow.RegisterBuildPlayerHandler and BuildPlayerWindow.RegisterGetBuildPlayerOptionsHandler. + + + + + Create a new BuildMethodException. + + Display this message as an error in the editor log. + + + + Create a new BuildMethodException. + + Display this message as an error in the editor log. + + + + Default build methods for the BuildPlayerWindow. + + + + + The built-in, default handler for executing a player build. Can be used to provide default functionality in a custom build player window. + + The options to build with. + + + + The built-in, default handler for calculating build player options. Can be used to provide default functionality in a custom build player window. + + Default options. + + The calculated BuildPlayerOptions. + + + + + Register a delegate to intercept or override the build process executed with the "Build" and "Build and Run" buttons. Registering a null value will restore default behavior, which is the equivalent of calling BuildPlayerWindow.DefaultBuildMethods.BuildPlayer. + + Delegate System.Action that takes a BuildPipeline.BuildPlayerOptions parameter. + + + + Register a delegate method to calculate BuildPlayerOptions that are passed to the build player handler. Registering a null value will restore default behavior, which is the equivalent of calling BuildPlayerWindow.DefaultBuildMethods.GetBuildPlayerOptions. + + Delegate System.Func that takes a BuildPlayerOptions parameter. The value passed into the delegate will represent default options. The return value will be passed to the default build player handler, or to a custom handler set with BuildPlayerWindow.RegisterBuildPlayerHandler. + + + + Open the build settings window. + + + + + Target build platform. + + + + + Build an iOS player. + + + + + OBSOLETE: Use iOS. Build an iOS player. + + + + + Build to Apple's tvOS platform. + + + + + Build an Android .apk standalone app. + + + + + Build to Nintendo 3DS platform. + + + + + Build a PS4 Standalone. + + + + + Build a Linux standalone. + + + + + Build a Linux 64-bit standalone. + + + + + Build a Linux universal standalone. + + + + + Build a macOS standalone (Intel 64-bit). + + + + + Build a macOS Intel 32-bit standalone. (This build target is deprecated) + + + + + Build a macOS Intel 64-bit standalone. (This build target is deprecated) + + + + + Build a Windows standalone. + + + + + Build a Windows 64-bit standalone. + + + + + Build a Nintendo Switch player. + + + + + WebGL. + + + + + Build a web player. (This build target is deprecated. Building for web player will no longer be supported in future versions of Unity.) + + + + + Build a streamed web player. + + + + + Build an Windows Store Apps player. + + + + + Build a Xbox One Standalone. + + + + + Build target group. + + + + + Apple iOS target. + + + + + OBSOLETE: Use iOS. Apple iOS target. + + + + + Apple's tvOS target. + + + + + Android target. + + + + + Facebook target. + + + + + Nintendo 3DS target. + + + + + Sony Playstation 4 target. + + + + + Mac/PC standalone target. + + + + + Nintendo Switch target. + + + + + Unknown target. + + + + + WebGL. + + + + + Mac/PC webplayer target. + + + + + Windows Store Apps target. + + + + + Microsoft Xbox One target. + + + + + Base class for Attributes that require a callback index. + + + + + Add this attribute to a method to get a notification after scripts have been reloaded. + + + + + DidReloadScripts attribute. + + Order in which separate attributes will be processed. + + + + DidReloadScripts attribute. + + Order in which separate attributes will be processed. + + + + Callback attribute for opening an asset in Unity (e.g the callback is fired when double clicking an asset in the Project Browser). + + + + + Add this attribute to a method to get a notification just after building the player. + + + + + Add this attribute to a method to get a notification just after building the Scene. + + + + + Unity Camera Editor. + + + + + Settings for the camera editor. + + + + + See ScriptableObject.OnDestroy. + + + + + See ScriptableObject.OnEnable. + + + + + See Editor.OnInspectorGUI. + + + + + See Editor.OnSceneGUI. + + + + + Contains all drawable elements of the CameraEditor. + + + + + Exposed SerializedProperty for the inspected Camera. + + + + + Exposed SerializedProperty for the inspected Camera. + + + + + Exposed SerializedProperty for the inspected Camera. + + + + + Exposed SerializedProperty for the inspected Camera. + + + + + Exposed SerializedProperty for the inspected Camera. + + + + + Exposed SerializedProperty for the inspected Camera. + + + + + Exposed SerializedProperty for the inspected Camera. + + + + + Exposed SerializedProperty for the inspected Camera. + + + + + Exposed SerializedProperty for the inspected Camera. + + + + + Exposed SerializedProperty for the inspected Camera. + + + + + Exposed SerializedProperty for the inspected Camera. + + + + + Exposed SerializedProperty for the inspected Camera. + + + + + Exposed SerializedProperty for the inspected Camera. + + + + + Exposed SerializedProperty for the inspected Camera. + + + + + Exposed SerializedProperty for the inspected Camera. + + + + + Exposed SerializedProperty for the inspected Camera. + + + + + Exposed SerializedProperty for the inspected Camera. + + + + + Exposed SerializedProperty for the inspected Camera. + + + + + Exposed SerializedProperty for the inspected Camera. + + + + + Exposed SerializedProperty for the inspected Camera. + + + + + Exposed SerializedProperty for the inspected Camera. + + + + + Exposed SerializedProperty for the inspected Camera. + + + + + Exposed SerializedProperty for the inspected Camera. + + + + + See SerializedObject.ApplyModifiedProperties. + + + + + Draws the default [[CameraEditor] background color widget. + + + + + Draws the default [[CameraEditor] clear flags widget. + + + + + Draws the default [[CameraEditor] clipping planes widget. + + + + + Draws the default [[CameraEditor] culling mask widget. + + + + + Draws the default [[CameraEditor] depth widget. + + + + + Draws the default [[CameraEditor] dynamic resolution widget. + + + + + Draws the default [[CameraEditor] HDR widget. + + + + + Draws the default [[CameraEditor] MSAA widget. + + + + + Draws the default [[CameraEditor] muliple display widget. + + + + + Draws the default [[CameraEditor] viewport widget. + + + + + Draws the default [[CameraEditor] occlusion culling widget. + + + + + Draws the default [[CameraEditor] projection widget. + + + + + Draws the default [[CameraEditor] rendering path widget. + + + + + Draws the default [[CameraEditor] target eye widget. + + + + + Draws the default [[CameraEditor] target texture widget. + + + + + + Draws the default [[CameraEditor] VR widget. + + + + + Exposed SerializedProperty for the inspected Camera. + + + + + Populate the settings object with data linked to the Camera SerializedObject. + + + + + See SerializedObject.Update. + + + + + Utilities for cameras. + + + + + Draw the frustrum gizmo of a camera. + + The camera to use. + + + + The aspect ratio of the game view. + + + + + Calculate the frustrum aspect ratio of a camera. + + Camera to use. + + The frustrum aspect ratio of the provided camera. + + + + + Calculate the points of the frustrum plane facing the viewer at a specific distance. + +The points array will be filled with the calculated points in the following order: left bottom, left top, right top and right bottom. + + Clip space to world space matrix. + View position in world space. + Distance from the view position of the plane. + Calculated points. (A minimum size of 4 elements is required). + + + + Draw the frustrum handles for a camera. + + The camera to use. + + + + Check whether a viewport is valid. + + Viewport to check. + + Whether the viewport is valid. + + + + + Calculate the world space position of a point in clip space. + +The z component will be used to get the point at the distance z from the viewer. + + Clip to world matrix to use. + The viewer's position in world space. + The position in clip space. + + The corresponding world space position. + + + + + Calculate the frustrum corners. + +Corners are calculated in this order: left bottom, left top, right top, right bottom. + + Camera to use. + The corners of the near plane. (A minimum size of 4 elements is required.) + The corners of the far plane. (A minimum size of 4 elements is required.) + The aspect ratio of the frustrum. + + Whether the frustrum was calculated. + + + + + Calculate the frustrum corners from the sensor physical properties, without taking gate fitting into account. +To get the actual frustum with gate fit adjustment, use CameraEditorUtils.TryGetFrustum. +This method is equivalent to CameraEditorUtils.TryGetFrustum for non-physical cameras. + +Corners are calculated in this order: left bottom, left top, right top, right bottom. + + Camera to use. + The corners of the near plane. (A minimum size of 4 elements is required.) + The corners of the far plane. (A minimum size of 4 elements is required.) + The aspect ratio of the frustrum. + + Whether the frustrum was calculated. + + + + + Attribute used to make a custom editor support multi-object editing. + + + + + Stores a curve and its name that will be used to create additionnal curves during the import process. + + + + + The animation curve. + + + + + The name of the animation curve. + + + + + AnimationClip mask options for ModelImporterClipAnimation. + + + + + Use a mask from your project to specify which transforms animation should be imported. + + + + + A mask containing all the transform in the file will be created internally. + + + + + No Mask. All the animation will be imported. + + + + + Use this class to retrieve information about the currently selected project and the current Unity ID that is logged in. + + + + + The ID of the organization that this project belongs to. (Read Only) + + + + + The name of the organization that this project belongs to. (Read Only) + + + + + A unique cloud project identifier. It is unique for every project (Read Only). + + + + + The name of the project entry in the dashboard associated with this project (Read Only). + + + + + The user ID of the currently logged-in Unity ID account (Read Only). + + + + + The user name of the currently logged in Unity ID account (Read Only). + + + + + Used as input to ColorField to configure the HDR color ranges in the ColorPicker. + + + + + Maximum allowed color component value when using the ColorPicker. + + + + + Maximum exposure value allowed in the Color Picker. + + + + + Minimum allowed color component value when using the ColorPicker. + + + + + Minimum exposure value allowed in the Color Picker. + + + + + + + Minimum brightness value allowed when using the Color Picker. + Maximum brightness value allowed when using the Color Picker. + Minimum exposure value used in the tonemapping section of the Color Picker. + Maximum exposure value used in the tonemapping section of the Color Picker. + + + + Flags for Assembly. + + + + + Selects assemblies compiled for the editor. + + + + + Selects assemblies compiled for the player. + + + + + Class that represents an assembly compiled by Unity. + + + + + Returns Assembly.assemblyReferences and Assembly.compiledAssemblyReferences combined. + +This returns all assemblies that are passed to the compiler when building this assembly,. + + + + + Assembly references used to build this assembly. + +The references are also assemblies built as part of the Unity project. + +See Also: Assembly.compiledAssemblyReferences and Assembly.allReferences. + + + + + Assembly references to pre-compiled assemblies that used to build this assembly. + +See Also: Assembly.assemblyReferences and Assembly.allReferences. + + + + + Compiler options used to compile the assembly. + + + + + The defines used to compile this assembly. + + + + + Flags for the assembly. + +See Also: AssemblyFlags. + + + + + The name of the assembly. + + + + + The full output file path of this assembly. + + + + + All the souce files used to compile this assembly. + + + + + Constructor. + + Assembly name. + Assembly output. + Assembliy source files. + Assembly defines. + Assembly references. + Compiled assembly references. + Assembly flags. + + + + Compiles scripts outside the Assets folder into a managed assembly that can be used inside the Assets folder. + + + + + Additional #define directives passed to compilation of the assembly. + + + + + Additional assembly references passed to compilation of the assembly. + + + + + Output path of the assembly to build. (Read Only) + + + + + Event that is invoked on the main thread when the assembly build finishes. + + First parameter is the output assembly path. Second parameter are the compiler messages. + + + + Event that is invoked on the main thread when the assembly build starts. + + Parameter is the output assembly path. + + + + BuildTarget for the assembly build. + + + + + BuildTargetGroup for the assembly build. + + + + + Compiler options to use when building the assembly. + + + + + Default defines used when compiling the assembly. + + + + + Default references used when compiling the assembly. + + + + + References to exclude when compiling the assembly. + + + + + Flags to control the assembly build. + + + + + Array of script paths used as input for assembly build. (Read Only) + + + + + Current status of assembly build. (Read Only) + + + + + Starts the build of the assembly. + +While building, the small progress icon in the lower right corner of Unity's main window will spin and EditorApplication.isCompiling will return true. + + + Returns true if build was started. Returns false if the build was not started due to the editor currently compiling scripts in the Assets folder. + + + + + AssemblyBuilder constructor. + + Path of the output assembly. Relative to project root. + Array of script paths to be compiled into the output assembly. Relative to project root. + + + + Flags used by AssemblyBuilder to control assembly build. + + + + + Defines whether the output assembly is an development build. + + + + + Defines whether the output assembly is an editor assembly. + + + + + None value. Default. + + + + + Status of the AssemblyBuilder build. + + + + + Indicates the AssemblyBuilder build has finished. + + + + + Indicates the AssemblyBuilder build is compiling. + + + + + Indicates the AssemblyBuilder build has not been started. + + + + + An exception throw for Assembly Definition Files errors. + + + + + File paths of the assembly definition files that caused the exception. + + + + + Constructor. + + Exception message. + File paths for assembly definition files. + + + + Contains information about a platform supported by the assembly definition files. + + + + + BuildTarget for the AssemblyDefinitionPlatform. + + + + + Display name for the platform. + + + + + Name used in assembly definition files. + + + + + Flags for Assembly. + + + + + Indicates whether this assembly is an editor only assembly. + + + + + None value. Default. + + + + + Methods and properties for script compilation pipeline. + + + + + An event that is invoked on the main thread when compilation of an assembly finishes. + + First parameter is the output assembly path. Second parameter are the compiler messages. + + + + Event that is invoked on the main thread when the assembly build starts. + + Parameter is the output assembly path. + + + + Get all script assemblies compiled by Unity filtered by AssembliesType. + + + + Array of script assemblies compiled by Unity. + + + + + Returns the assembly definition file path from an assembly name. Returns null if there is no assembly definition file for the given assembly name. + + Assembly name. + + File path of assembly definition file. + + + + + Returns the assembly definition file path for a source (script) path. Returns null if there is no assembly definition file for the given script path. + + Source (script) file path. + + File path of assembly definition file. + + + + + Returns all the platforms supported by assembly definition files. + +See Also: AssemblyDefinitionPlatform. + + + Platforms supported by assembly definition files. + + + + + Returns the assembly name for a source (script) path. Returns null if there is no assembly name for the given script path. + + Source (script) path. + + Assembly name. + + + + + Get all precompiled assembly names. + + + Precompiled assembly names. + + + + + Returns the Assembly file path from an assembly name. Returns null if there is no Precompiled Assembly name match. + + Assembly name. + + File path of precompiled assembly. + + + + + Compiler Message. + + + + + Line column for the message. + + + + + File for the message. + + + + + File line for the message. + + + + + Compiler message. + + + + + Message type. + + + + + Compiler message type. + + + + + Error message. + + + + + Warning message. + + + + + An exception throw for Precompiled Assembly errors. + + + + + File paths for Precompiled Assemblies that caused the exception. + + + + + Constructor. + + Exception message. + File paths for Precompiled Assemblies. + + + + Compiler options passed to the script compiler. + + + + + Allow 'unsafe' code when compiling scripts. + + + + + Creates ScriptCompilerOptions with default values used for script compilation. + + + + + Editor API for the Unity Services editor feature. Normally CrashReporting is enabled from the Services window, but if writing your own editor extension, this API can be used. + + + + + This Boolean field will cause the CrashReporting feature in Unity to capture exceptions that occur in the editor while running in Play mode if true, or ignore those errors if false. + + + + + This Boolean field will cause the CrashReporting feature in Unity to be enabled if true, or disabled if false. + + + + + The Performance Reporting service will keep a buffer of up to the last X log messages (Debug.Log, etc) to send along with crash reports. The default is 10 log messages, the max is 50. Set this to 0 to disable capture of logs with your crash reports. + + + + + Tells an Editor class which run-time type it's an editor for. + + + + + If true, match this editor only if all non-fallback editors do not match. Defaults to false. + + + + + Defines which object type the custom editor class can edit. + + Type that this editor can edit. + If true, child classes of inspectedType will also show this editor. Defaults to false. + + + + Defines which object type the custom editor class can edit. + + Type that this editor can edit. + If true, child classes of inspectedType will also show this editor. Defaults to false. + + + + Tells an Editor class which run-time type it's an editor for when the given RenderPipeline is activated. + + + + + Defines which object type the custom editor class can edit. + + Type that this editor can edit. + Type of RenderPipelineAsset that that should be active for this inspector to be used. + If true, child classes of inspectedType will also show this editor. Defaults to false. + + + + Defines which object type the custom editor class can edit. + + Type that this editor can edit. + Type of RenderPipelineAsset that that should be active for this inspector to be used. + If true, child classes of inspectedType will also show this editor. Defaults to false. + + + + Adds an extra preview in the Inspector for the specified type. + + + + + Tells a DefaultPreview which class it's a preview for. + + The type you want to create a custom preview for. + + + + Tells a custom PropertyDrawer or DecoratorDrawer which run-time Serializable class or PropertyAttribute it's a drawer for. + + + + + Tells a PropertyDrawer or DecoratorDrawer class which run-time class or attribute it's a drawer for. + + If the drawer is for a custom Serializable class, the type should be that class. If the drawer is for script variables with a specific PropertyAttribute, the type should be that attribute. + If true, the drawer will be used for any children of the specified class unless they define their own drawer. + + + + Tells a PropertyDrawer or DecoratorDrawer class which run-time class or attribute it's a drawer for. + + If the drawer is for a custom Serializable class, the type should be that class. If the drawer is for script variables with a specific PropertyAttribute, the type should be that attribute. + If true, the drawer will be used for any children of the specified class unless they define their own drawer. + + + + Direct3D 11 fullscreen mode. + + + + + Exclusive mode. + + + + + Fullscreen window. + + + + + Direct3D 9 fullscreen mode. + + + + + Exclusive mode. + + + + + Fullscreen window. + + + + + Texture importer lets you modify Texture2D import settings for DDS textures from editor scripts. + + + + + Is texture data readable from scripts. + + + + + Base class to derive custom decorator drawers from. + + + + + The PropertyAttribute for the decorator. (Read Only) + + + + + Override this method to determine whether the inspector GUI for your decorator can be cached. + + + Whether the inspector GUI for your decorator can be cached. + + + + + Override this method to specify how tall the GUI for this decorator is in pixels. + + + + + Override this method to make your own GUI for the decorator. +See DecoratorDrawer for an example of how to use this. + + Rectangle on the screen to use for the decorator GUI. + + + + DefaultAsset is used for assets that do not have a specific type (yet). + + + + + Default definition for the Lighting Explorer. Can be overridden completely or partially. + + + + + Constructor. + + + + + This returns all the default tabs for the Lighting Explorer. + + + Default tabs for the Lighting Explorer. + + + + + Returns objects with an Emissive material. + + + Objects with an Emissive material. + + + + + Returns column definitions for Emissives. + + + Column definitions for Emissives. + + + + + Returns column definitions for Lights. + + + Column definitions for Lights. + + + + + Returns column definitions for Light Probes. + + + Column definitions for Light Probes. + + + + + Returns Light Probes. + + + Light Probes. + + + + + Returns Lights. + + + Lights. + + + + + Returns column definitions for Reflection Probes. + + + Column definitions for Reflection Probes. + + + + + Returns Reflection Probes. + + + Reflection Probes. + + + + + Editor drag & drop operations. + + + + + Get or set ID of currently active drag and drop control. + + + + + References to Object|objects being dragged. + + + + + The file names being dragged. + + + + + The visual indication of the drag. + + + + + Accept a drag operation. + + + + + Get data associated with current drag and drop operation. + + + + + + Clears drag & drop data. + + + + + Set data associated with current drag and drop operation. + + + + + + + Start a drag operation. + + + + + + Visual indication mode for Drag & Drop operation. + + + + + Copy dragged objects. + + + + + Generic drag operation. + + + + + Link dragged objects to target. + + + + + Move dragged objects. + + + + + No indication (drag should not be performed). + + + + + Rejected drag operation. + + + + + Drawing modes for Handles.DrawCamera. + + + + + Draw objects with the albedo component only. This value has been deprecated. Please use DrawCameraMode.RealtimeAlbedo. + + + + + The camera is set to display the alpha channel of the rendering. + + + + + Draw objects with baked GI only. This value has been deprecated. Please use DrawCameraMode.BakedLightmap. + + + + + Draw objects with the baked albedo component only. + + + + + Draw objects with different colors for each baked chart (UV island). + + + + + Draw objects with the baked directionality component only. + + + + + Draw objects with the baked emission component only. + + + + + Draw objects with baked indices only. + + + + + Draw objects with the baked lightmap only. + + + + + Draw objects with visible lightmap texels highlighted. + + + + + Draw objects with baked texel validity only. + + + + + Draw objects with overlapping lightmap texels highlighted. + + + + + Draw objects with different colors for each real-time chart (UV island). + + + + + Draw with different colors for each cluster. + + + + + Draw diffuse color of Deferred Shading g-buffer. + + + + + Draw world space normal of Deferred Shading g-buffer. + + + + + Draw smoothness value of Deferred Shading g-buffer. + + + + + Draw specular color of Deferred Shading g-buffer. + + + + + Draw objects with directionality for real-time GI. This value has been deprecated. Please use DrawCameraMode.RealtimeDirectionality. + + + + + Draw objects with the emission component only. This value has been deprecated. Please use DrawCameraMode.RealtimeEmissive. + + + + + Draw objects with real-time GI only. This value has been deprecated. Please use DrawCameraMode.RealtimeIndirect. + + + + + The camera is set to show in red static lights that fall back to 'static' because more than four light volumes are overlapping. + + + + + Draw lit clusters. + + + + + The camera is set to display the texture resolution, with a red tint indicating resolution that is too high, and a blue tint indicating texture sizes that could be higher. + + + + + Draw the camera like it would be drawn in-game. This uses the clear flags of the camera. + + + + + The camera is set to display Scene overdraw, with brighter colors indicating more overdraw. + + + + + Draw objects with the real-time GI albedo component only. + + + + + Draw objects with different colors for each real-time chart (UV island). + + + + + Draw objects with the real-time GI directionality component only. + + + + + Draw objects with the real-time GI emission component only. + + + + + Draw objects with the real-time GI indirect light only. + + + + + The camera is set to draw color coded render paths. + + + + + The camera is set to draw directional light shadow map cascades. + + + + + The camera is set to display colored ShadowMasks, coloring light gizmo with the same color. + + + + + The camera is set to display SpriteMask and SpriteRenderer with SpriteRenderer.maskInteraction set. + + + + + Draw objects with different color for each GI system. + + + + + Draw the camera textured with selection wireframe and no background clearing. + + + + + Draw the camera where all objects have a wireframe overlay. and no background clearing. + + + + + The camera is set to run in texture streaming debug mode. + + + + + A custom mode defined by the user. + + + + + The camera is set to draw a physically based, albedo validated rendering. + + + + + The camera is set to draw a physically based, metal or specular validated rendering. + + + + + Draw the camera in wireframe and no background clearing. + + + + + The DrawGizmo attribute allows you to supply a gizmo renderer for any Component. + + + + + Defines when the gizmo should be invoked for drawing. + + Flags to denote when the gizmo should be drawn. + + + + Same as above. drawnGizmoType determines of what type the object we are drawing the gizmo of has to be. + + Flags to denote when the gizmo should be drawn. + Type of object for which the gizmo should be drawn. + + + + Base class to derive custom Editors from. Use this to create your own custom inspectors and editors for your objects. + + + + + An event raised while drawing the header of the Inspector window, after the default header items have been drawn. + + + + + + A SerializedObject representing the object or objects being inspected. + + + + + The object being inspected. + + + + + An array of all the object being inspected. + + + + + On return previousEditor is an editor for targetObject or targetObjects. The function either returns if the editor is already tracking the objects, or Destroys the previous editor and creates a new one. + + The object the editor is tracking. + The requested editor type. null for the default editor for the object. + The previous editor for the object. Once CreateCachedEditor returns previousEditor is an editor for the targetObject or targetObjects. + The objects the editor is tracking. + + + + + + On return previousEditor is an editor for targetObject or targetObjects. The function either returns if the editor is already tracking the objects, or Destroys the previous editor and creates a new one. + + The object the editor is tracking. + The requested editor type. null for the default editor for the object. + The previous editor for the object. Once CreateCachedEditor returns previousEditor is an editor for the targetObject or targetObjects. + The objects the editor is tracking. + + + + + + Creates a cached editor using a context object. + + + + + + + + + + Creates a cached editor using a context object. + + + + + + + + + + Make a custom editor for targetObject or targetObjects. + + All objects must be of same exact type. + + + + + + + Make a custom editor for targetObject or targetObjects. + + All objects must be of same exact type. + + + + + + + Make a custom editor for targetObject or targetObjects. + + All objects must be of same exact type. + + + + + + + Make a custom editor for targetObject or targetObjects. + + All objects must be of same exact type. + + + + + + + Make a custom editor for targetObject or targetObjects with a context object. + + + + + + + + Draw the built-in inspector. + + + + + Call this function to draw the header of the editor. + + + + + The first entry point for Preview Drawing. + + The available area to draw the preview. + + + + + Implement this method to show asset information on top of the asset preview. + + + + + Override this method if you want to change the label of the Preview area. + + + + + Override this method in subclasses if you implement OnPreviewGUI. + + + True if this component can be Previewed in its current state. + + + + + Implement this function to make a custom inspector. + + + + + Implement to create your own interactive custom preview. Interactive custom previews are used in the preview area of the inspector and the object selector. + + Rectangle in which to draw the preview. + Background image. + + + + Implement to create your own custom preview for the preview area of the inspector, primary editor headers and the object selector. + + Rectangle in which to draw the preview. + Background image. + + + + Override this method if you want to show custom controls in the preview header. + + + + + Override this method if you want to render a static preview. + + The asset to operate on. + An array of all Assets at assetPath. + Width of the created texture. + Height of the created texture. + + Generated texture or null. + + + + + Repaint any inspectors that shows this editor. + + + + + Does this edit require to be repainted constantly in its current state? + + + + + Returns the visibility setting of the "open" button in the Inspector. + + + Return true if the button should be hidden. + + + + + Override this method in subclasses to return false if you don't want default margins. + + + + + Editor API for the EditorAnalytics feature. + + + + + Returns true when EditorAnalytics is enabled. + + + + + This API is used for registering an Editor Analytics event. It is meant for internal use only and is likely to change in the future. User code should never use this API. + + Name of the event. + Event version number. + Hourly limit for this event name. + Maximum number of items in this event. + Vendor key name. + + + + This API is used for registering an Editor Analytics event. It is meant for internal use only and is likely to change in the future. User code should never use this API. + + Name of the event. + Event version number. + Hourly limit for this event name. + Maximum number of items in this event. + Vendor key name. + + + + This API is used to send an Editor Analytics event. It is meant for internal use only and is likely to change in the future. User code should never use this API. + + Name of the event. + Additional event data. + Event version number. + + + + This API is used to send an Editor Analytics event. It is meant for internal use only and is likely to change in the future. User code should never use this API. + + Name of the event. + Additional event data. + Event version number. + + + + Provides access to Editor Analytics session information. + + + + + The total time, in milliseconds, that the user interacted with the Editor since the beginning of the current session. + + + + + The length of the current session, in milliseconds. + + + + + The total time, in milliseconds, that the Editor has been in focus during the current session. + + + + + A random, unique GUID identifying the current Editor session. + + + + + The total time, in milliseconds, that the Editor has been in playmode during the current session. + + + + + The number of Editor sessions that have occurred since the current instance of the Unity Editor was installed. + + + + + A random GUID uniquely identifying an Editor installation. + + + + + Main Application class. + + + + + Path to the Unity editor contents folder. (Read Only) + + + + + Returns the path to the Unity editor application. (Read Only) + + + + + Callback raised whenever the user contex-clicks on a property in an Inspector. + + + + + The path of the Scene that the user has currently open (Will be an empty string if no Scene is currently open). (Read Only) + + + + + Delegate which is called once after all inspectors update. + + + + + Event that is raised when an object or group of objects in the hierarchy changes. + + + + + + A callback to be raised when an object in the hierarchy changes. + +Each time an object is (or a group of objects are) created, renamed, parented, unparented or destroyed this callback is raised. + + + + + + Delegate for OnGUI events for every visible list item in the HierarchyWindow. + + + + + Is editor currently compiling scripts? (Read Only) + + + + + Is editor currently paused? + + + + + Is editor currently in play mode? + + + + + Is editor either currently in play mode, or about to switch to it? (Read Only) + + + + + Is editor currently connected to Unity Remote 4 client app. + + + + + Is true if the currently open Scene in the editor contains unsaved modifications. + + + + + Returns true if the current project was created as a temporary project. + + + + + True if the Editor is currently refreshing the AssetDatabase. + + + + + Delegate for changed keyboard modifier keys. + + + + + Event that is raised whenever the Editor's pause state changes. + + + + + + Event that is raised whenever the Editor's play mode state changes. + + + + + + Event that is raised whenever the state of the project changes. + + + + + + Callback raised whenever the state of the Project window changes. + + + + + Delegate for OnGUI events for every visible list item in the ProjectWindow. + + + + + Unity raises this event when the editor application is quitting. + + + + + + Returns the scripting runtime version currently used by the Editor. + + + + + Callback raised whenever the contents of a window's search box are changed. + + + + + The time since the editor was started. (Read Only) + + + + + Delegate for generic updates. + + + + + Unity raises this event when the editor application wants to quit. + + + + + + Plays system beep sound. + + + + + Delegate to be called from EditorApplication callbacks. + + + + + Set the hierarchy sorting method as dirty. + + + + + Invokes the menu item in the specified path. + + + + + + Exit the Unity editor application. + + + + + + Delegate to be called for every visible list item in the HierarchyWindow on every OnGUI event. + + + + + + + Load the given level additively in play mode asynchronously + + + + + + Load the given level additively in play mode. + + + + + + Load the given level in play mode asynchronously. + + + + + + Load the given level in play mode. + + + + + + Prevents loading of assemblies when it is inconvenient. + + + + + Explicitly mark the current opened Scene as modified. + + + + + Create a new absolutely empty Scene. + + + + + Create a new Scene. + + + + + Open another project. + + The path of a project to open. + Arguments to pass to command line. + + + + Opens the Scene at path. + + + + + + Opens the Scene at path additively. + + + + + + Delegate to be called for every visible list item in the ProjectWindow on every OnGUI event. + + + + + + + Normally, a player loop update will occur in the editor when the Scene has been modified. This method allows you to queue a player loop update regardless of whether the Scene has been modified. + + + + + Can be used to ensure repaint of the HierarchyWindow. + + + + + Can be used to ensure repaint of the ProjectWindow. + + + + + Saves all serializable assets that have not yet been written to disk (eg. Materials). + + + + + Ask the user if they want to save the open Scene. + + + + + Save the open Scene. + + The file path to save at. If empty, the current open Scene will be overwritten, or if never saved before, a save dialog is shown. + If set to true, the Scene will be saved without changing the currentScene and without clearing the unsaved changes marker. + + True if the save succeeded, otherwise false. + + + + + Save the open Scene. + + The file path to save at. If empty, the current open Scene will be overwritten, or if never saved before, a save dialog is shown. + If set to true, the Scene will be saved without changing the currentScene and without clearing the unsaved changes marker. + + True if the save succeeded, otherwise false. + + + + + Save the open Scene. + + The file path to save at. If empty, the current open Scene will be overwritten, or if never saved before, a save dialog is shown. + If set to true, the Scene will be saved without changing the currentScene and without clearing the unsaved changes marker. + + True if the save succeeded, otherwise false. + + + + + Delegate to be called from EditorApplication contextual inspector callbacks. + + The contextual menu which is about to be shown to the user. + The property for which the contextual menu is shown. + + + + Sets the path that Unity should store the current temporary project at, when the project is closed. + + The path that the current temporary project should be relocated to when closing it. + + + + Perform a single frame step. + + + + + Must be called after LockReloadAssemblies, to reenable loading of assemblies. + + + + + This class allows you to modify the Editor for an example of how to use this class. + +See Also: EditorBuildSettingsScene, EditorBuildSettings.scenes. + + + + + A delegate called whenever EditorBuildSettings.scenes is set. + + + + + + The list of Scenes that should be included in the build. +This is the same list of Scenes that is shown in the window. You can modify this list to set up which Scenes should be included in the build. + + + + + Store a reference to a config object by name. The object must be an asset in the project, otherwise it will not be saved when the editor is restarted or scripts are reloaded. To avoid name conflicts with other packages, it is recommended that names are qualified by a namespace, i.e. "company.package.name". + + The name of the object reference in string format. This string name must be unique within your project or the overwrite parameter must be set to true. + Object reference to be stored. This object must be persisted and not null. + Boolean parameter used to specify that you want to overwrite an entry with the same name if one already exists. + + Throws an exception if the object is null, not persisted, or if there is a name conflict and the overwrite parameter is set to false. + + + + + Return a string array containing the names of all stored config object references. + + + Returns an array of strings containing the names of all stored references. If there are no references, an empty array will be returned. + + + + + Remove a config object reference by name. + + The name in string format of the config object reference to be removed. This is the name given to the object when the reference is first created. Note: This may be different than the object name as an object can be added multiple times with different names. + + Returns true if the reference was found and removed, otherwise false. + + + + + Retrieve a config object reference by name. + + The name in string format of the config object reference to be fetched. + The config object reference where the returned object will be stored. This must be an object of type Object. + + Returns true if the config object reference was found and the type matched the result parameter. Returns false if the entry is not found, the config object reference is null, or if the type requested does not match the type stored. + + + + + This class is used for entries in the Scenes list, as displayed in the window. This class contains the Scene path of a Scene and an enabled flag that indicates wether the Scene is enabled in the BuildSettings window or not. + +You can use this class in combination with EditorBuildSettings.scenes to populate the list of Scenes included in the build via script. This is useful when creating custom editor scripts to automate your build pipeline. + +See EditorBuildSettings.scenes for an example script. + + + + + Whether this Scene is enabled in the for an example of how to use this class. + +See Also: EditorBuildSettingsScene, EditorBuildSettings.scenes. + + + + + The file path of the Scene as listed in the Editor for an example of how to use this class. + +See Also: EditorBuildSettingsScene, EditorBuildSettings.scenes. + + + + + Defines how a curve is attached to an object that it controls. + + + + + The transform path of the object that is animated. + + + + + The name of the property to be animated. + + + + + The type of the property to be animated. + + + + + Creates a preconfigured binding for a curve where values should not be interpolated. + + The transform path to the object to animate. + The type of the object to animate. + The name of the property to animate on the object. + + + + Creates a preconfigured binding for a float curve. + + The transform path to the object to animate. + The type of the object to animate. + The name of the property to animate on the object. + + + + Creates a preconfigured binding for a curve that points to an Object. + + The transform path to the object to animate. + The type of the object to animate. + The name of the property to animate on the object. + + + + These work pretty much like the normal GUI functions - and also have matching implementations in EditorGUILayout. + + + + + Is the platform-dependent "action" modifier key held down? (Read Only) + + + + + The indent level of the field labels. + + + + + Makes the following controls give the appearance of editing multiple different values. + + + + + Check if any control was changed inside a block of code. + + + + + Create a group of controls that can be disabled. + + Boolean specifying if the controls inside the group should be disabled. + + + + Create a Property wrapper, useful for making regular GUI controls work with SerializedProperty. + + Rectangle on the screen to use for the control, including label if applicable. + Optional label in front of the slider. Use null to use the name from the SerializedProperty. Use GUIContent.none to not display a label. + The SerializedProperty to use for the control. + + The actual label to use for the control. + + + + + Makes Center and Extents field for entering a Bounds. + + Rectangle on the screen to use for the field. + Optional label to display above the field. + The value to edit. + + The value entered by the user. + + + + + Makes Center and Extents field for entering a Bounds. + + Rectangle on the screen to use for the field. + Optional label to display above the field. + The value to edit. + + The value entered by the user. + + + + + Makes Position and Size field for entering a BoundsInt. + + Rectangle on the screen to use for the field. + Optional label to display above the field. + The value to edit. + + The value entered by the user. + + + + + Makes Position and Size field for entering a BoundsInt. + + Rectangle on the screen to use for the field. + Optional label to display above the field. + The value to edit. + + The value entered by the user. + + + + + Makes Position and Size field for entering a BoundsInt. + + Rectangle on the screen to use for the field. + Optional label to display above the field. + The value to edit. + + The value entered by the user. + + + + + Get whether a SerializedProperty's inspector GUI can be cached. + + The SerializedProperty in question. + + Whether the property's inspector GUI can be cached. + + + + + Check if any control was changed inside a block of code. + + + + + True if GUI.changed was set to true, otherwise false. + + + + + Begins a ChangeCheckScope. + + + + + Makes a field for selecting a Color. + + Rectangle on the screen to use for the field. + Optional label to display in front of the field. + The color to edit. + If true, the color picker should show the eyedropper control. If false, don't show it. + If true, allow the user to set an alpha value for the color. If false, hide the alpha component. + If true, treat the color as an HDR value. If false, treat it as a standard LDR value. + + + The color selected by the user. + + + + + Makes a field for selecting a Color. + + Rectangle on the screen to use for the field. + Optional label to display in front of the field. + The color to edit. + If true, the color picker should show the eyedropper control. If false, don't show it. + If true, allow the user to set an alpha value for the color. If false, hide the alpha component. + If true, treat the color as an HDR value. If false, treat it as a standard LDR value. + + + The color selected by the user. + + + + + Makes a field for selecting a Color. + + Rectangle on the screen to use for the field. + Optional label to display in front of the field. + The color to edit. + If true, the color picker should show the eyedropper control. If false, don't show it. + If true, allow the user to set an alpha value for the color. If false, hide the alpha component. + If true, treat the color as an HDR value. If false, treat it as a standard LDR value. + + + The color selected by the user. + + + + + Makes a field for selecting a Color. + + Rectangle on the screen to use for the field. + Optional label to display in front of the field. + The color to edit. + If true, the color picker should show the eyedropper control. If false, don't show it. + If true, allow the user to set an alpha value for the color. If false, hide the alpha component. + If true, treat the color as an HDR value. If false, treat it as a standard LDR value. + + + The color selected by the user. + + + + + Makes a field for selecting a Color. + + Rectangle on the screen to use for the field. + Optional label to display in front of the field. + The color to edit. + If true, the color picker should show the eyedropper control. If false, don't show it. + If true, allow the user to set an alpha value for the color. If false, hide the alpha component. + If true, treat the color as an HDR value. If false, treat it as a standard LDR value. + + + The color selected by the user. + + + + + Makes a field for editing an AnimationCurve. + + Rectangle on the screen to use for the field. + Optional label to display in front of the field. + The curve to edit. + The color to show the curve with. + Optional rectangle that the curve is restrained within. + + The curve edited by the user. + + + + + Makes a field for editing an AnimationCurve. + + Rectangle on the screen to use for the field. + Optional label to display in front of the field. + The curve to edit. + The color to show the curve with. + Optional rectangle that the curve is restrained within. + + The curve edited by the user. + + + + + Makes a field for editing an AnimationCurve. + + Rectangle on the screen to use for the field. + Optional label to display in front of the field. + The curve to edit. + The color to show the curve with. + Optional rectangle that the curve is restrained within. + + The curve edited by the user. + + + + + Makes a field for editing an AnimationCurve. + + Rectangle on the screen to use for the field. + Optional label to display in front of the field. + The curve to edit. + The color to show the curve with. + Optional rectangle that the curve is restrained within. + + The curve edited by the user. + + + + + Makes a field for editing an AnimationCurve. + + Rectangle on the screen to use for the field. + Optional label to display in front of the field. + The curve to edit. + The color to show the curve with. + Optional rectangle that the curve is restrained within. + + The curve edited by the user. + + + + + Makes a field for editing an AnimationCurve. + + Rectangle on the screen to use for the field. + Optional label to display in front of the field. + The curve to edit. + The color to show the curve with. + Optional rectangle that the curve is restrained within. + + The curve edited by the user. + + + + + Makes a field for editing an AnimationCurve. + + Rectangle on the screen to use for the field. + The curve to edit. + The color to show the curve with. + Optional rectangle that the curve is restrained within. + Optional label to display in front of the field. Pass [[GUIContent.none] to hide the label. + + + + Makes a field for editing an AnimationCurve. + + Rectangle on the screen to use for the field. + The curve to edit. + The color to show the curve with. + Optional rectangle that the curve is restrained within. + Optional label to display in front of the field. Pass [[GUIContent.none] to hide the label. + + + + Makes a delayed text field for entering doubles. + + Rectangle on the screen to use for the double field. + Optional label to display in front of the double field. + The value to edit. + Optional GUIStyle. + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the double field. + + + + + Makes a delayed text field for entering doubles. + + Rectangle on the screen to use for the double field. + Optional label to display in front of the double field. + The value to edit. + Optional GUIStyle. + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the double field. + + + + + Makes a delayed text field for entering doubles. + + Rectangle on the screen to use for the double field. + Optional label to display in front of the double field. + The value to edit. + Optional GUIStyle. + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the double field. + + + + + Makes a delayed text field for entering doubles. + + Rectangle on the screen to use for the double field. + The double property to edit. + Optional label to display in front of the double field. Pass GUIContent.none to hide label. + + + + Makes a delayed text field for entering floats. + + Rectangle on the screen to use for the float field. + Optional label to display in front of the float field. + The value to edit. + Optional GUIStyle. + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the float field. + + + + + Makes a delayed text field for entering floats. + + Rectangle on the screen to use for the float field. + Optional label to display in front of the float field. + The value to edit. + Optional GUIStyle. + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the float field. + + + + + Makes a delayed text field for entering floats. + + Rectangle on the screen to use for the float field. + Optional label to display in front of the float field. + The value to edit. + Optional GUIStyle. + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the float field. + + + + + Makes a delayed text field for entering floats. + + Rectangle on the screen to use for the float field. + The float property to edit. + Optional label to display in front of the float field. Pass GUIContent.none to hide label. + + + + Makes a delayed text field for entering integers. + + Rectangle on the screen to use for the int field. + Optional label to display in front of the int field. + The value to edit. + Optional GUIStyle. + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the int field. + + + + + Makes a delayed text field for entering integers. + + Rectangle on the screen to use for the int field. + Optional label to display in front of the int field. + The value to edit. + Optional GUIStyle. + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the int field. + + + + + Makes a delayed text field for entering integers. + + Rectangle on the screen to use for the int field. + Optional label to display in front of the int field. + The value to edit. + Optional GUIStyle. + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the int field. + + + + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the int field. + + Rectangle on the screen to use for the int field. + The int property to edit. + Optional label to display in front of the int field. Pass GUIContent.none to hide label. + + + + Makes a delayed text field. + + Rectangle on the screen to use for the text field. + Optional label to display in front of the int field. + The value to edit. + Optional GUIStyle. + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the text field. + + + + + Makes a delayed text field. + + Rectangle on the screen to use for the text field. + Optional label to display in front of the int field. + The value to edit. + Optional GUIStyle. + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the text field. + + + + + Makes a delayed text field. + + Rectangle on the screen to use for the text field. + Optional label to display in front of the int field. + The value to edit. + Optional GUIStyle. + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the text field. + + + + + Makes a delayed text field. + + Rectangle on the screen to use for the text field. + The text property to edit. + Optional label to display in front of the int field. Pass GUIContent.none to hide label. + + + + Create a group of controls that can be disabled. + + + + + Create a new DisabledGroupScope and begin the corresponding group. + + Boolean specifying if the controls inside the group should be disabled. + + + + Create a group of controls that can be disabled. + + + + + Create a new DisabledScope and begin the corresponding group. + + Boolean specifying if the controls inside the group should be disabled. + + + + Makes a text field for entering doubles. + + Rectangle on the screen to use for the double field. + Optional label to display in front of the double field. + The value to edit. + Optional GUIStyle. + + The value entered by the user. + + + + + Makes a text field for entering doubles. + + Rectangle on the screen to use for the double field. + Optional label to display in front of the double field. + The value to edit. + Optional GUIStyle. + + The value entered by the user. + + + + + Makes a text field for entering doubles. + + Rectangle on the screen to use for the double field. + Optional label to display in front of the double field. + The value to edit. + Optional GUIStyle. + + The value entered by the user. + + + + + Draws the texture within a rectangle. + + Rectangle on the screen to draw the texture within. + Texture to display. + Material to be used when drawing the texture. + How to scale the image when the aspect ratio of it doesn't fit the aspect ratio to be drawn within. + Aspect ratio to use for the source image. If 0 (the default), the aspect ratio from the image is used. + The mip-level to sample. If negative, the texture is sampled normally. +Sets material _Mip property. + Specifies which color components of image will get written. + + + + Draws the texture within a rectangle. + + Rectangle on the screen to draw the texture within. + Texture to display. + Material to be used when drawing the texture. + How to scale the image when the aspect ratio of it doesn't fit the aspect ratio to be drawn within. + Aspect ratio to use for the source image. If 0 (the default), the aspect ratio from the image is used. + The mip-level to sample. If negative, the texture is sampled normally. +Sets material _Mip property. + Specifies which color components of image will get written. + + + + Draws the texture within a rectangle. + + Rectangle on the screen to draw the texture within. + Texture to display. + Material to be used when drawing the texture. + How to scale the image when the aspect ratio of it doesn't fit the aspect ratio to be drawn within. + Aspect ratio to use for the source image. If 0 (the default), the aspect ratio from the image is used. + The mip-level to sample. If negative, the texture is sampled normally. +Sets material _Mip property. + Specifies which color components of image will get written. + + + + Draws the texture within a rectangle. + + Rectangle on the screen to draw the texture within. + Texture to display. + Material to be used when drawing the texture. + How to scale the image when the aspect ratio of it doesn't fit the aspect ratio to be drawn within. + Aspect ratio to use for the source image. If 0 (the default), the aspect ratio from the image is used. + The mip-level to sample. If negative, the texture is sampled normally. +Sets material _Mip property. + Specifies which color components of image will get written. + + + + Draws the texture within a rectangle. + + Rectangle on the screen to draw the texture within. + Texture to display. + Material to be used when drawing the texture. + How to scale the image when the aspect ratio of it doesn't fit the aspect ratio to be drawn within. + Aspect ratio to use for the source image. If 0 (the default), the aspect ratio from the image is used. + The mip-level to sample. If negative, the texture is sampled normally. +Sets material _Mip property. + Specifies which color components of image will get written. + + + + Draws the texture within a rectangle. + + Rectangle on the screen to draw the texture within. + Texture to display. + Material to be used when drawing the texture. + How to scale the image when the aspect ratio of it doesn't fit the aspect ratio to be drawn within. + Aspect ratio to use for the source image. If 0 (the default), the aspect ratio from the image is used. + The mip-level to sample. If negative, the texture is sampled normally. +Sets material _Mip property. + Specifies which color components of image will get written. + + + + Draws a filled rectangle of color at the specified position and size within the current editor window. + + The position and size of the rectangle to draw. + The color of the rectange. + + + + Draws the alpha channel of a texture within a rectangle. + + Rectangle on the screen to draw the texture within. + Texture to display. + How to scale the image when the aspect ratio of it doesn't fit the aspect ratio to be drawn within. + Aspect ratio to use for the source image. If 0 (the default), the aspect ratio from the image is used. + What mip-level to sample. If negative, texture will be sampled normally. +It sets material _Mip property. + + + + Draws the alpha channel of a texture within a rectangle. + + Rectangle on the screen to draw the texture within. + Texture to display. + How to scale the image when the aspect ratio of it doesn't fit the aspect ratio to be drawn within. + Aspect ratio to use for the source image. If 0 (the default), the aspect ratio from the image is used. + What mip-level to sample. If negative, texture will be sampled normally. +It sets material _Mip property. + + + + Draws the alpha channel of a texture within a rectangle. + + Rectangle on the screen to draw the texture within. + Texture to display. + How to scale the image when the aspect ratio of it doesn't fit the aspect ratio to be drawn within. + Aspect ratio to use for the source image. If 0 (the default), the aspect ratio from the image is used. + What mip-level to sample. If negative, texture will be sampled normally. +It sets material _Mip property. + + + + Draws the alpha channel of a texture within a rectangle. + + Rectangle on the screen to draw the texture within. + Texture to display. + How to scale the image when the aspect ratio of it doesn't fit the aspect ratio to be drawn within. + Aspect ratio to use for the source image. If 0 (the default), the aspect ratio from the image is used. + What mip-level to sample. If negative, texture will be sampled normally. +It sets material _Mip property. + + + + Makes a button that reacts to mouse down, for displaying your own dropdown content. + + Rectangle on the screen to use for the button. + Text, image and tooltip for this button. + Whether the button should be selectable by keyboard or not. + Optional style to use. + + true when the user clicks the button. + + + + + Makes a button that reacts to mouse down, for displaying your own dropdown content. + + Rectangle on the screen to use for the button. + Text, image and tooltip for this button. + Whether the button should be selectable by keyboard or not. + Optional style to use. + + true when the user clicks the button. + + + + + Draws a label with a drop shadow. + + Where to show the label. + Text to show +@style style to use. + + + + + + Draws a label with a drop shadow. + + Where to show the label. + Text to show +@style style to use. + + + + + + Draws a label with a drop shadow. + + Where to show the label. + Text to show +@style style to use. + + + + + + Draws a label with a drop shadow. + + Where to show the label. + Text to show +@style style to use. + + + + + + Ends a change check started with BeginChangeCheck (). + + + True if GUI.changed was set to true, otherwise false. + + + + + Ends a disabled group started with BeginDisabledGroup. + + + + + Ends a Property wrapper started with BeginProperty. + + + + + Displays a menu with an option for every value of the enum type when clicked. An option for the value 0 with name "Nothing" and an option for the value ~0 (that is, all bits set) with the name "Everything" are always displayed at the top of the menu. The names for the values 0 and ~0 can be overriden by defining these values in the enum type. + + Rectangle on the screen to use for the enum flags field. + Optional label to display in front of the enum flags field. + Enum flags value (Only supports enum values for enum types with int as the underlying type). + Optional GUIStyle. + Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. + + The enum flags value modified by the user. This is a selection BitMask where each bit represents an Enum value index. (Note this returned value is not itself an Enum). + + + + + Displays a menu with an option for every value of the enum type when clicked. An option for the value 0 with name "Nothing" and an option for the value ~0 (that is, all bits set) with the name "Everything" are always displayed at the top of the menu. The names for the values 0 and ~0 can be overriden by defining these values in the enum type. + + Rectangle on the screen to use for the enum flags field. + Optional label to display in front of the enum flags field. + Enum flags value (Only supports enum values for enum types with int as the underlying type). + Optional GUIStyle. + Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. + + The enum flags value modified by the user. This is a selection BitMask where each bit represents an Enum value index. (Note this returned value is not itself an Enum). + + + + + Displays a menu with an option for every value of the enum type when clicked. An option for the value 0 with name "Nothing" and an option for the value ~0 (that is, all bits set) with the name "Everything" are always displayed at the top of the menu. The names for the values 0 and ~0 can be overriden by defining these values in the enum type. + + Rectangle on the screen to use for the enum flags field. + Optional label to display in front of the enum flags field. + Enum flags value (Only supports enum values for enum types with int as the underlying type). + Optional GUIStyle. + Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. + + The enum flags value modified by the user. This is a selection BitMask where each bit represents an Enum value index. (Note this returned value is not itself an Enum). + + + + + Displays a menu with an option for every value of the enum type when clicked. An option for the value 0 with name "Nothing" and an option for the value ~0 (that is, all bits set) with the name "Everything" are always displayed at the top of the menu. The names for the values 0 and ~0 can be overriden by defining these values in the enum type. + + Rectangle on the screen to use for the enum flags field. + Optional label to display in front of the enum flags field. + Enum flags value (Only supports enum values for enum types with int as the underlying type). + Optional GUIStyle. + Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. + + The enum flags value modified by the user. This is a selection BitMask where each bit represents an Enum value index. (Note this returned value is not itself an Enum). + + + + + Displays a menu with an option for every value of the enum type when clicked. An option for the value 0 with name "Nothing" and an option for the value ~0 (that is, all bits set) with the name "Everything" are always displayed at the top of the menu. The names for the values 0 and ~0 can be overriden by defining these values in the enum type. + + Rectangle on the screen to use for the enum flags field. + Optional label to display in front of the enum flags field. + Enum flags value (Only supports enum values for enum types with int as the underlying type). + Optional GUIStyle. + Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. + + The enum flags value modified by the user. This is a selection BitMask where each bit represents an Enum value index. (Note this returned value is not itself an Enum). + + + + + Displays a menu with an option for every value of the enum type when clicked. An option for the value 0 with name "Nothing" and an option for the value ~0 (that is, all bits set) with the name "Everything" are always displayed at the top of the menu. The names for the values 0 and ~0 can be overriden by defining these values in the enum type. + + Rectangle on the screen to use for the enum flags field. + Optional label to display in front of the enum flags field. + Enum flags value (Only supports enum values for enum types with int as the underlying type). + Optional GUIStyle. + Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. + + The enum flags value modified by the user. This is a selection BitMask where each bit represents an Enum value index. (Note this returned value is not itself an Enum). + + + + + Displays a menu with an option for every value of the enum type when clicked. An option for the value 0 with name "Nothing" and an option for the value ~0 (that is, all bits set) with the name "Everything" are always displayed at the top of the menu. The names for the values 0 and ~0 can be overriden by defining these values in the enum type. + + Rectangle on the screen to use for the enum flags field. + Optional label to display in front of the enum flags field. + Enum flags value (Only supports enum values for enum types with int as the underlying type). + Optional GUIStyle. + Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. + + The enum flags value modified by the user. This is a selection BitMask where each bit represents an Enum value index. (Note this returned value is not itself an Enum). + + + + + This method is obsolete. Use EditorGUI.EnumFlagsField instead. + +Makes a field for enum based masks. + + Rectangle on the screen to use for this control. + Caption/label for the control. + Enum to use for the flags. + Optional GUIStyle. + + A selection BitMask where each bit represents an Enum value index. (Note this returned value is not itself an Enum). + + + + + This method is obsolete. Use EditorGUI.EnumFlagsField instead. + +Makes a field for enum based masks. + + Rectangle on the screen to use for this control. + Caption/label for the control. + Enum to use for the flags. + Optional GUIStyle. + + A selection BitMask where each bit represents an Enum value index. (Note this returned value is not itself an Enum). + + + + + This method is obsolete. Use EditorGUI.EnumFlagsField instead. + +Makes a field for enum based masks. + + Rectangle on the screen to use for this control. + Caption/label for the control. + Enum to use for the flags. + Optional GUIStyle. + + A selection BitMask where each bit represents an Enum value index. (Note this returned value is not itself an Enum). + + + + + This method is obsolete. Use EditorGUI.EnumFlagsField instead. + +Makes a field for enum based masks. + + Rectangle on the screen to use for this control. + Caption/label for the control. + Enum to use for the flags. + Optional GUIStyle. + + A selection BitMask where each bit represents an Enum value index. (Note this returned value is not itself an Enum). + + + + + This method is obsolete. Use EditorGUI.EnumFlagsField instead. + +Makes a field for enum based masks. + + Rectangle on the screen to use for this control. + Caption/label for the control. + Enum to use for the flags. + Optional GUIStyle. + + A selection BitMask where each bit represents an Enum value index. (Note this returned value is not itself an Enum). + + + + + This method is obsolete. Use EditorGUI.EnumFlagsField instead. + +Makes a field for enum based masks. + + Rectangle on the screen to use for this control. + Caption/label for the control. + Enum to use for the flags. + Optional GUIStyle. + + A selection BitMask where each bit represents an Enum value index. (Note this returned value is not itself an Enum). + + + + + This method is obsolete. Use EditorGUI.EnumFlagsField instead. + +Makes an enum popup selection field for a bitmask. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The enum options the field shows. + Optional GUIStyle. + + The enum options that has been selected by the user. + + + + + This method is obsolete. Use EditorGUI.EnumFlagsField instead. + +Makes an enum popup selection field for a bitmask. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The enum options the field shows. + Optional GUIStyle. + + The enum options that has been selected by the user. + + + + + This method is obsolete. Use EditorGUI.EnumFlagsField instead. + +Makes an enum popup selection field for a bitmask. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The enum options the field shows. + Optional GUIStyle. + + The enum options that has been selected by the user. + + + + + This method is obsolete. Use EditorGUI.EnumFlagsField instead. + +Makes an enum popup selection field for a bitmask. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The enum options the field shows. + Optional GUIStyle. + + The enum options that has been selected by the user. + + + + + Makes an enum popup selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The enum option the field shows. + Optional GUIStyle. + Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. + Method called for each Enum value displayed. The specified method should return true if the option can be selected, false otherwise. + + The enum option that has been selected by the user. + + + + + Makes an enum popup selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The enum option the field shows. + Optional GUIStyle. + Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. + Method called for each Enum value displayed. The specified method should return true if the option can be selected, false otherwise. + + The enum option that has been selected by the user. + + + + + Makes an enum popup selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The enum option the field shows. + Optional GUIStyle. + Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. + Method called for each Enum value displayed. The specified method should return true if the option can be selected, false otherwise. + + The enum option that has been selected by the user. + + + + + Makes an enum popup selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The enum option the field shows. + Optional GUIStyle. + Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. + Method called for each Enum value displayed. The specified method should return true if the option can be selected, false otherwise. + + The enum option that has been selected by the user. + + + + + Makes an enum popup selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The enum option the field shows. + Optional GUIStyle. + Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. + Method called for each Enum value displayed. The specified method should return true if the option can be selected, false otherwise. + + The enum option that has been selected by the user. + + + + + Makes an enum popup selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The enum option the field shows. + Optional GUIStyle. + Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. + Method called for each Enum value displayed. The specified method should return true if the option can be selected, false otherwise. + + The enum option that has been selected by the user. + + + + + Makes an enum popup selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The enum option the field shows. + Optional GUIStyle. + Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. + Method called for each Enum value displayed. The specified method should return true if the option can be selected, false otherwise. + + The enum option that has been selected by the user. + + + + + Makes a text field for entering floats. + + Rectangle on the screen to use for the float field. + Optional label to display in front of the float field. + The value to edit. + Optional GUIStyle. + + The value entered by the user. + + + + + Makes a text field for entering floats. + + Rectangle on the screen to use for the float field. + Optional label to display in front of the float field. + The value to edit. + Optional GUIStyle. + + The value entered by the user. + + + + + Makes a text field for entering floats. + + Rectangle on the screen to use for the float field. + Optional label to display in front of the float field. + The value to edit. + Optional GUIStyle. + + The value entered by the user. + + + + + Move keyboard focus to a named text field and begin editing of the content. + + Name set using GUI.SetNextControlName. + + + + Makes a label with a foldout arrow to the left of it. + + Rectangle on the screen to use for the arrow and label. + The shown foldout state. + The label to show. + Optional GUIStyle. + Should the label be a clickable part of the control? + + The foldout state selected by the user. If true, you should render sub-objects. + + + + + Makes a label with a foldout arrow to the left of it. + + Rectangle on the screen to use for the arrow and label. + The shown foldout state. + The label to show. + Optional GUIStyle. + Should the label be a clickable part of the control? + + The foldout state selected by the user. If true, you should render sub-objects. + + + + + Makes a label with a foldout arrow to the left of it. + + Rectangle on the screen to use for the arrow and label. + The shown foldout state. + The label to show. + Optional GUIStyle. + Should the label be a clickable part of the control? + + The foldout state selected by the user. If true, you should render sub-objects. + + + + + Makes a label with a foldout arrow to the left of it. + + Rectangle on the screen to use for the arrow and label. + The shown foldout state. + The label to show. + Optional GUIStyle. + Should the label be a clickable part of the control? + + The foldout state selected by the user. If true, you should render sub-objects. + + + + + Makes a label with a foldout arrow to the left of it. + + Rectangle on the screen to use for the arrow and label. + The shown foldout state. + The label to show. + Optional GUIStyle. + Should the label be a clickable part of the control? + + The foldout state selected by the user. If true, you should render sub-objects. + + + + + Makes a label with a foldout arrow to the left of it. + + Rectangle on the screen to use for the arrow and label. + The shown foldout state. + The label to show. + Optional GUIStyle. + Should the label be a clickable part of the control? + + The foldout state selected by the user. If true, you should render sub-objects. + + + + + Makes a label with a foldout arrow to the left of it. + + Rectangle on the screen to use for the arrow and label. + The shown foldout state. + The label to show. + Optional GUIStyle. + Should the label be a clickable part of the control? + + The foldout state selected by the user. If true, you should render sub-objects. + + + + + Makes a label with a foldout arrow to the left of it. + + Rectangle on the screen to use for the arrow and label. + The shown foldout state. + The label to show. + Optional GUIStyle. + Should the label be a clickable part of the control? + + The foldout state selected by the user. If true, you should render sub-objects. + + + + + Get the height needed for a PropertyField control. + + Height of the property area. + Descriptive text or image. + Should the returned height include the height of child properties? + + + + + Get the height needed for a PropertyField control. + + Height of the property area. + Descriptive text or image. + Should the returned height include the height of child properties? + + + + + Get the height needed for a PropertyField control. + + Height of the property area. + Descriptive text or image. + Should the returned height include the height of child properties? + + + + + Get the height needed for a PropertyField control. + + Height of the property area. + Descriptive text or image. + Should the returned height include the height of child properties? + + + + + Get the height needed for a PropertyField control. + + Height of the property area. + Descriptive text or image. + Should the returned height include the height of child properties? + + + + + Makes a field for editing a Gradient. + + Rectangle on the screen to use for the field. + Optional label to display in front of the field. + The gradient to edit. + Display the HDR Gradient Editor. + + The gradient edited by the user. + + + + + Makes a field for editing a Gradient. + + Rectangle on the screen to use for the field. + Optional label to display in front of the field. + The gradient to edit. + Display the HDR Gradient Editor. + + The gradient edited by the user. + + + + + Makes a field for editing a Gradient. + + Rectangle on the screen to use for the field. + Optional label to display in front of the field. + The gradient to edit. + Display the HDR Gradient Editor. + + The gradient edited by the user. + + + + + Makes a field for editing a Gradient. + + Rectangle on the screen to use for the field. + Optional label to display in front of the field. + The gradient to edit. + Display the HDR Gradient Editor. + + The gradient edited by the user. + + + + + Makes a label for some control. + + Rectangle on the screen to use in total for both the label and the control. + Rectangle on the screen to use for the label. + Label to show for the control. + The unique ID of the control. If none specified, the ID of the following control is used. + Optional GUIStyle to use for the label. + + + + Makes a label for some control. + + Rectangle on the screen to use in total for both the label and the control. + Rectangle on the screen to use for the label. + Label to show for the control. + The unique ID of the control. If none specified, the ID of the following control is used. + Optional GUIStyle to use for the label. + + + + Makes a label for some control. + + Rectangle on the screen to use in total for both the label and the control. + Rectangle on the screen to use for the label. + Label to show for the control. + The unique ID of the control. If none specified, the ID of the following control is used. + Optional GUIStyle to use for the label. + + + + Makes a help box with a message to the user. + + Rectangle on the screen to draw the help box within. + The message text. + The type of message. + + + + Scope for managing the indent level of the field labels. + + + + + Creates an IndentLevelScope and increases the EditorGUI indent level. + + The EditorGUI indent level will be increased by this amount inside the scope. + + + + Creates an IndentLevelScope and increases the EditorGUI indent level. + + The EditorGUI indent level will be increased by this amount inside the scope. + + + + Makes an inspector-window-like titlebar. + + Rectangle on the screen to use for the titlebar. + The foldout state shown with the arrow. + The object (for example a component) that the titlebar is for. + The objects that the titlebar is for. + Whether this editor should display a foldout arrow in order to toggle the display of its properties. + + The foldout state selected by the user. + + + + + Makes an inspector-window-like titlebar. + + Rectangle on the screen to use for the titlebar. + The foldout state shown with the arrow. + The object (for example a component) that the titlebar is for. + The objects that the titlebar is for. + Whether this editor should display a foldout arrow in order to toggle the display of its properties. + + The foldout state selected by the user. + + + + + Makes an inspector-window-like titlebar. + + Rectangle on the screen to use for the titlebar. + The foldout state shown with the arrow. + The object (for example a component) that the titlebar is for. + The objects that the titlebar is for. + Whether this editor should display a foldout arrow in order to toggle the display of its properties. + + The foldout state selected by the user. + + + + + Makes an inspector-window-like titlebar. + + Rectangle on the screen to use for the titlebar. + The foldout state shown with the arrow. + The object (for example a component) that the titlebar is for. + The objects that the titlebar is for. + Whether this editor should display a foldout arrow in order to toggle the display of its properties. + + The foldout state selected by the user. + + + + + Makes a text field for entering integers. + + Rectangle on the screen to use for the int field. + Optional label to display in front of the int field. + The value to edit. + Optional GUIStyle. + + The value entered by the user. + + + + + Makes a text field for entering integers. + + Rectangle on the screen to use for the int field. + Optional label to display in front of the int field. + The value to edit. + Optional GUIStyle. + + The value entered by the user. + + + + + Makes a text field for entering integers. + + Rectangle on the screen to use for the int field. + Optional label to display in front of the int field. + The value to edit. + Optional GUIStyle. + + The value entered by the user. + + + + + Makes a text field for entering integers. + + Rectangle on the screen to use for the int field. + Optional label to display in front of the int field. + The value to edit. + Optional GUIStyle. + + The value entered by the user. + + + + + Makes a text field for entering integers. + + Rectangle on the screen to use for the int field. + Optional label to display in front of the int field. + The value to edit. + Optional GUIStyle. + + The value entered by the user. + + + + + Makes a text field for entering integers. + + Rectangle on the screen to use for the int field. + Optional label to display in front of the int field. + The value to edit. + Optional GUIStyle. + + The value entered by the user. + + + + + Makes an integer popup selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The value of the option the field shows. + An array with the displayed options the user can choose from. + An array with the values for each option. If optionValues a direct mapping of selectedValue to displayedOptions is assumed. + Optional GUIStyle. + + The value of the option that has been selected by the user. + + + + + Makes an integer popup selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The value of the option the field shows. + An array with the displayed options the user can choose from. + An array with the values for each option. If optionValues a direct mapping of selectedValue to displayedOptions is assumed. + Optional GUIStyle. + + The value of the option that has been selected by the user. + + + + + Makes an integer popup selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The value of the option the field shows. + An array with the displayed options the user can choose from. + An array with the values for each option. If optionValues a direct mapping of selectedValue to displayedOptions is assumed. + Optional GUIStyle. + + The value of the option that has been selected by the user. + + + + + Makes an integer popup selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The value of the option the field shows. + An array with the displayed options the user can choose from. + An array with the values for each option. If optionValues a direct mapping of selectedValue to displayedOptions is assumed. + Optional GUIStyle. + + The value of the option that has been selected by the user. + + + + + Makes an integer popup selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The value of the option the field shows. + An array with the displayed options the user can choose from. + An array with the values for each option. If optionValues a direct mapping of selectedValue to displayedOptions is assumed. + Optional GUIStyle. + + The value of the option that has been selected by the user. + + + + + Makes an integer popup selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The value of the option the field shows. + An array with the displayed options the user can choose from. + An array with the values for each option. If optionValues a direct mapping of selectedValue to displayedOptions is assumed. + Optional GUIStyle. + + The value of the option that has been selected by the user. + + + + + Makes an integer popup selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The value of the option the field shows. + An array with the displayed options the user can choose from. + An array with the values for each option. If optionValues a direct mapping of selectedValue to displayedOptions is assumed. + Optional GUIStyle. + + The value of the option that has been selected by the user. + + + + + Makes an integer popup selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The value of the option the field shows. + An array with the displayed options the user can choose from. + An array with the values for each option. If optionValues a direct mapping of selectedValue to displayedOptions is assumed. + Optional GUIStyle. + + The value of the option that has been selected by the user. + + + + + + + Rectangle on the screen to use for the field. + The SerializedProperty to use for the control. + An array with the displayed options the user can choose from. + An array with the values for each option. If optionValues a direct mapping of selectedValue to displayedOptions is assumed. + Optional label in front of the field. + + + + + + Rectangle on the screen to use for the field. + The SerializedProperty to use for the control. + An array with the displayed options the user can choose from. + An array with the values for each option. If optionValues a direct mapping of selectedValue to displayedOptions is assumed. + Optional label in front of the field. + + + + Makes a slider the user can drag to change an integer value between a min and a max. + + Rectangle on the screen to use for the slider. + Optional label in front of the slider. + The value the slider shows. This determines the position of the draggable thumb. + The value at the left end of the slider. + The value at the right end of the slider. + + The value that has been set by the user. + + + + + Makes a slider the user can drag to change an integer value between a min and a max. + + Rectangle on the screen to use for the slider. + Optional label in front of the slider. + The value the slider shows. This determines the position of the draggable thumb. + The value at the left end of the slider. + The value at the right end of the slider. + + The value that has been set by the user. + + + + + Makes a slider the user can drag to change an integer value between a min and a max. + + Rectangle on the screen to use for the slider. + Optional label in front of the slider. + The value the slider shows. This determines the position of the draggable thumb. + The value at the left end of the slider. + The value at the right end of the slider. + + The value that has been set by the user. + + + + + Makes a slider the user can drag to change a value between a min and a max. + + Rectangle on the screen to use for the slider. + Optional label in front of the slider. + The value the slider shows. This determines the position of the draggable thumb. + The value at the left end of the slider. + The value at the right end of the slider. + + + + Makes a slider the user can drag to change a value between a min and a max. + + Rectangle on the screen to use for the slider. + Optional label in front of the slider. + The value the slider shows. This determines the position of the draggable thumb. + The value at the left end of the slider. + The value at the right end of the slider. + + + + Makes a slider the user can drag to change a value between a min and a max. + + Rectangle on the screen to use for the slider. + Optional label in front of the slider. + The value the slider shows. This determines the position of the draggable thumb. + The value at the left end of the slider. + The value at the right end of the slider. + + + + Makes a label field. (Useful for showing read-only info.) + + Rectangle on the screen to use for the label field. + Label in front of the label field. + The label to show to the right. + Style information (color, etc) for displaying the label. + + + + Makes a label field. (Useful for showing read-only info.) + + Rectangle on the screen to use for the label field. + Label in front of the label field. + The label to show to the right. + Style information (color, etc) for displaying the label. + + + + Makes a label field. (Useful for showing read-only info.) + + Rectangle on the screen to use for the label field. + Label in front of the label field. + The label to show to the right. + Style information (color, etc) for displaying the label. + + + + Makes a label field. (Useful for showing read-only info.) + + Rectangle on the screen to use for the label field. + Label in front of the label field. + The label to show to the right. + Style information (color, etc) for displaying the label. + + + + Makes a label field. (Useful for showing read-only info.) + + Rectangle on the screen to use for the label field. + Label in front of the label field. + The label to show to the right. + Style information (color, etc) for displaying the label. + + + + Makes a label field. (Useful for showing read-only info.) + + Rectangle on the screen to use for the label field. + Label in front of the label field. + The label to show to the right. + Style information (color, etc) for displaying the label. + + + + Makes a label field. (Useful for showing read-only info.) + + Rectangle on the screen to use for the label field. + Label in front of the label field. + The label to show to the right. + Style information (color, etc) for displaying the label. + + + + Makes a label field. (Useful for showing read-only info.) + + Rectangle on the screen to use for the label field. + Label in front of the label field. + The label to show to the right. + Style information (color, etc) for displaying the label. + + + + Makes a layer selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The layer shown in the field. + Optional GUIStyle. + + The layer selected by the user. + + + + + Makes a layer selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The layer shown in the field. + Optional GUIStyle. + + The layer selected by the user. + + + + + Makes a layer selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The layer shown in the field. + Optional GUIStyle. + + The layer selected by the user. + + + + + Makes a layer selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The layer shown in the field. + Optional GUIStyle. + + The layer selected by the user. + + + + + Makes a layer selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The layer shown in the field. + Optional GUIStyle. + + The layer selected by the user. + + + + + Makes a layer selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The layer shown in the field. + Optional GUIStyle. + + The layer selected by the user. + + + + + Makes a text field for entering long integers. + + Rectangle on the screen to use for the long field. + Optional label to display in front of the long field. + The value to edit. + Optional GUIStyle. + + The value entered by the user. + + + + + Makes a text field for entering long integers. + + Rectangle on the screen to use for the long field. + Optional label to display in front of the long field. + The value to edit. + Optional GUIStyle. + + The value entered by the user. + + + + + Makes a text field for entering long integers. + + Rectangle on the screen to use for the long field. + Optional label to display in front of the long field. + The value to edit. + Optional GUIStyle. + + The value entered by the user. + + + + + Makes a text field for entering long integers. + + Rectangle on the screen to use for the long field. + Optional label to display in front of the long field. + The value to edit. + Optional GUIStyle. + + The value entered by the user. + + + + + Makes a text field for entering long integers. + + Rectangle on the screen to use for the long field. + Optional label to display in front of the long field. + The value to edit. + Optional GUIStyle. + + The value entered by the user. + + + + + Makes a field for masks. + + Rectangle on the screen to use for this control. + Label for the field. + The current mask to display. + A string array containing the labels for each flag. + Optional GUIStyle. + A string array containing the labels for each flag. + + The value modified by the user. + + + + + Makes a field for masks. + + Rectangle on the screen to use for this control. + Label for the field. + The current mask to display. + A string array containing the labels for each flag. + Optional GUIStyle. + A string array containing the labels for each flag. + + The value modified by the user. + + + + + Makes a field for masks. + + Rectangle on the screen to use for this control. + Label for the field. + The current mask to display. + A string array containing the labels for each flag. + Optional GUIStyle. + A string array containing the labels for each flag. + + The value modified by the user. + + + + + Makes a field for masks. + + Rectangle on the screen to use for this control. + Label for the field. + The current mask to display. + A string array containing the labels for each flag. + Optional GUIStyle. + A string array containing the labels for each flag. + + The value modified by the user. + + + + + Makes a field for masks. + + Rectangle on the screen to use for this control. + Label for the field. + The current mask to display. + A string array containing the labels for each flag. + Optional GUIStyle. + A string array containing the labels for each flag. + + The value modified by the user. + + + + + Makes a field for masks. + + Rectangle on the screen to use for this control. + Label for the field. + The current mask to display. + A string array containing the labels for each flag. + Optional GUIStyle. + A string array containing the labels for each flag. + + The value modified by the user. + + + + + Makes a special slider the user can use to specify a range between a min and a max. + + Rectangle on the screen to use for the slider. + Optional label in front of the slider. + The lower value of the range the slider shows, passed by reference. + The upper value at the range the slider shows, passed by reference. + The limit at the left end of the slider. + The limit at the right end of the slider. + + + + Makes a special slider the user can use to specify a range between a min and a max. + + Rectangle on the screen to use for the slider. + Optional label in front of the slider. + The lower value of the range the slider shows, passed by reference. + The upper value at the range the slider shows, passed by reference. + The limit at the left end of the slider. + The limit at the right end of the slider. + + + + Makes a special slider the user can use to specify a range between a min and a max. + + Rectangle on the screen to use for the slider. + Optional label in front of the slider. + The lower value of the range the slider shows, passed by reference. + The upper value at the range the slider shows, passed by reference. + The limit at the left end of the slider. + The limit at the right end of the slider. + + + + Makes a special slider the user can use to specify a range between a min and a max. + + Rectangle on the screen to use for the slider. + Optional label in front of the slider. + The lower value of the range the slider shows, passed by reference. + The upper value at the range the slider shows, passed by reference. + The limit at the left end of the slider. + The limit at the right end of the slider. + + + + Makes a multi-control with text fields for entering multiple floats in the same line. + + Rectangle on the screen to use for the float field. + Optional label to display in front of the float field. + Array with small labels to show in front of each float field. There is room for one letter per field only. + Array with the values to edit. + + + + Makes a multi-control with text fields for entering multiple floats in the same line. + + Rectangle on the screen to use for the float field. + Optional label to display in front of the float field. + Array with small labels to show in front of each float field. There is room for one letter per field only. + Array with the values to edit. + + + + Makes a multi-control with text fields for entering multiple integers in the same line. + + Rectangle on the screen to use for the integer field. + Array with small labels to show in front of each int field. There is room for one letter per field only. + Array with the values to edit. + + + + Makes a multi-control with several property fields in the same line. + + Rectangle on the screen to use for the multi-property field. + The SerializedProperty of the first property to make a control for. + Optional label to use. If not specified the label of the property itself is used. Use GUIContent.none to not display a label at all. + Array with small labels to show in front of each float field. There is room for one letter per field only. + + + + Makes a multi-control with several property fields in the same line. + + Rectangle on the screen to use for the multi-property field. + The SerializedProperty of the first property to make a control for. + Optional label to use. If not specified the label of the property itself is used. Use GUIContent.none to not display a label at all. + Array with small labels to show in front of each float field. There is room for one letter per field only. + + + + Makes an object field. You can assign objects either by drag and drop objects or by selecting an object using the Object Picker. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The object the field shows. + The type of the objects that can be assigned. + Allow assigning Scene objects. See Description for more info. + + The object that has been set by the user. + + + + + Makes an object field. You can assign objects either by drag and drop objects or by selecting an object using the Object Picker. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The object the field shows. + The type of the objects that can be assigned. + Allow assigning Scene objects. See Description for more info. + + The object that has been set by the user. + + + + + Makes an object field. You can assign objects either by drag and drop objects or by selecting an object using the Object Picker. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The object the field shows. + The type of the objects that can be assigned. + Allow assigning Scene objects. See Description for more info. + + The object that has been set by the user. + + + + + Makes an object field. You can assign objects either by drag and drop objects or by selecting an object using the Object Picker. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The object the field shows. + The type of the objects that can be assigned. + Allow assigning Scene objects. See Description for more info. + + The object that has been set by the user. + + + + + Makes an object field. You can assign objects either by drag and drop objects or by selecting an object using the Object Picker. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The object the field shows. + The type of the objects that can be assigned. + Allow assigning Scene objects. See Description for more info. + + The object that has been set by the user. + + + + + Makes an object field. You can assign objects either by drag and drop objects or by selecting an object using the Object Picker. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The object the field shows. + The type of the objects that can be assigned. + Allow assigning Scene objects. See Description for more info. + + The object that has been set by the user. + + + + + Makes an object field. You can assign objects either by drag and drop objects or by selecting an object using the Object Picker. + + Rectangle on the screen to use for the field. + The object reference property the field shows. + The type of the objects that can be assigned. + Optional label to display in front of the field. Pass GUIContent.none to hide the label. + + + + Makes an object field. You can assign objects either by drag and drop objects or by selecting an object using the Object Picker. + + Rectangle on the screen to use for the field. + The object reference property the field shows. + The type of the objects that can be assigned. + Optional label to display in front of the field. Pass GUIContent.none to hide the label. + + + + Makes an object field. You can assign objects either by drag and drop objects or by selecting an object using the Object Picker. + + Rectangle on the screen to use for the field. + The object reference property the field shows. + The type of the objects that can be assigned. + Optional label to display in front of the field. Pass GUIContent.none to hide the label. + + + + Makes an object field. You can assign objects either by drag and drop objects or by selecting an object using the Object Picker. + + Rectangle on the screen to use for the field. + The object reference property the field shows. + The type of the objects that can be assigned. + Optional label to display in front of the field. Pass GUIContent.none to hide the label. + + + + Makes a text field where the user can enter a password. + + Rectangle on the screen to use for the password field. + Optional label to display in front of the password field. + The password to edit. + Optional GUIStyle. + + The password entered by the user. + + + + + Makes a text field where the user can enter a password. + + Rectangle on the screen to use for the password field. + Optional label to display in front of the password field. + The password to edit. + Optional GUIStyle. + + The password entered by the user. + + + + + Makes a text field where the user can enter a password. + + Rectangle on the screen to use for the password field. + Optional label to display in front of the password field. + The password to edit. + Optional GUIStyle. + + The password entered by the user. + + + + + Makes a text field where the user can enter a password. + + Rectangle on the screen to use for the password field. + Optional label to display in front of the password field. + The password to edit. + Optional GUIStyle. + + The password entered by the user. + + + + + Makes a text field where the user can enter a password. + + Rectangle on the screen to use for the password field. + Optional label to display in front of the password field. + The password to edit. + Optional GUIStyle. + + The password entered by the user. + + + + + Makes a text field where the user can enter a password. + + Rectangle on the screen to use for the password field. + Optional label to display in front of the password field. + The password to edit. + Optional GUIStyle. + + The password entered by the user. + + + + + Makes a generic popup selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The index of the option the field shows. + An array with the options shown in the popup. + Optional GUIStyle. + + The index of the option that has been selected by the user. + + + + + Makes a generic popup selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The index of the option the field shows. + An array with the options shown in the popup. + Optional GUIStyle. + + The index of the option that has been selected by the user. + + + + + Makes a generic popup selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The index of the option the field shows. + An array with the options shown in the popup. + Optional GUIStyle. + + The index of the option that has been selected by the user. + + + + + Makes a generic popup selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The index of the option the field shows. + An array with the options shown in the popup. + Optional GUIStyle. + + The index of the option that has been selected by the user. + + + + + Makes a generic popup selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The index of the option the field shows. + An array with the options shown in the popup. + Optional GUIStyle. + + The index of the option that has been selected by the user. + + + + + Makes a generic popup selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The index of the option the field shows. + An array with the options shown in the popup. + Optional GUIStyle. + + The index of the option that has been selected by the user. + + + + + Makes a generic popup selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The index of the option the field shows. + An array with the options shown in the popup. + Optional GUIStyle. + + The index of the option that has been selected by the user. + + + + + Makes a generic popup selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The index of the option the field shows. + An array with the options shown in the popup. + Optional GUIStyle. + + The index of the option that has been selected by the user. + + + + + Makes a label in front of some control. + + Rectangle on the screen to use in total for both the label and the control. + The unique ID of the control. If none specified, the ID of the following control is used. + Label to show in front of the control. + Style to use for the label. + + Rectangle on the screen to use just for the control itself. + + + + + Makes a label in front of some control. + + Rectangle on the screen to use in total for both the label and the control. + The unique ID of the control. If none specified, the ID of the following control is used. + Label to show in front of the control. + Style to use for the label. + + Rectangle on the screen to use just for the control itself. + + + + + Makes a label in front of some control. + + Rectangle on the screen to use in total for both the label and the control. + The unique ID of the control. If none specified, the ID of the following control is used. + Label to show in front of the control. + Style to use for the label. + + Rectangle on the screen to use just for the control itself. + + + + + Makes a label in front of some control. + + Rectangle on the screen to use in total for both the label and the control. + The unique ID of the control. If none specified, the ID of the following control is used. + Label to show in front of the control. + Style to use for the label. + + Rectangle on the screen to use just for the control itself. + + + + + Makes a progress bar. + + Rectangle on the screen to use in total for both the control. + Value that is shown. + + + + + + Use this to make a field for a SerializedProperty in the Editor. + + Rectangle on the screen to use for the property field. + The SerializedProperty to make a field for. + Optional label to use. If not specified the label of the property itself is used. Use GUIContent.none to not display a label at all. + If true the property including children is drawn; otherwise only the control itself (such as only a foldout but nothing below it). + + True if the property has children and is expanded and includeChildren was set to false; otherwise false. + + + + + Use this to make a field for a SerializedProperty in the Editor. + + Rectangle on the screen to use for the property field. + The SerializedProperty to make a field for. + Optional label to use. If not specified the label of the property itself is used. Use GUIContent.none to not display a label at all. + If true the property including children is drawn; otherwise only the control itself (such as only a foldout but nothing below it). + + True if the property has children and is expanded and includeChildren was set to false; otherwise false. + + + + + Create a Property wrapper, useful for making regular GUI controls work with SerializedProperty. + + + + + The actual label to use for the control. + + + + + Create a new PropertyScope and begin the corresponding property. + + Rectangle on the screen to use for the control, including label if applicable. + Label in front of the slider. Use null to use the name from the SerializedProperty. Use GUIContent.none to not display a label. + The SerializedProperty to use for the control. + + + + Makes an X, Y, W, and H field for entering a Rect. + + Rectangle on the screen to use for the field. + Optional label to display above the field. + The value to edit. + + The value entered by the user. + + + + + Makes an X, Y, W, and H field for entering a Rect. + + Rectangle on the screen to use for the field. + Optional label to display above the field. + The value to edit. + + The value entered by the user. + + + + + Makes an X, Y, W, and H field for entering a Rect. + + Rectangle on the screen to use for the field. + Optional label to display above the field. + The value to edit. + + The value entered by the user. + + + + + Makes an X, Y, W, and H for Rect using SerializedProperty (not public). + + + + + Makes an X, Y, W, and H field for entering a RectInt. + + Rectangle on the screen to use for the field. + Optional label to display above the field. + The value to edit. + + The value entered by the user. + + + + + Makes an X, Y, W, and H field for entering a RectInt. + + Rectangle on the screen to use for the field. + Optional label to display above the field. + The value to edit. + + The value entered by the user. + + + + + Makes an X, Y, W, and H field for entering a RectInt. + + Rectangle on the screen to use for the field. + Optional label to display above the field. + The value to edit. + + The value entered by the user. + + + + + Makes a selectable label field. (Useful for showing read-only info that can be copy-pasted.) + + Rectangle on the screen to use for the label. + The text to show. + Optional GUIStyle. + + + + Makes a selectable label field. (Useful for showing read-only info that can be copy-pasted.) + + Rectangle on the screen to use for the label. + The text to show. + Optional GUIStyle. + + + + Makes a slider the user can drag to change a value between a min and a max. + + Rectangle on the screen to use for the slider. + Optional label in front of the slider. + The value the slider shows. This determines the position of the draggable thumb. + The value at the left end of the slider. + The value at the right end of the slider. + + The value that has been set by the user. + + + + + Makes a slider the user can drag to change a value between a min and a max. + + Rectangle on the screen to use for the slider. + Optional label in front of the slider. + The value the slider shows. This determines the position of the draggable thumb. + The value at the left end of the slider. + The value at the right end of the slider. + + The value that has been set by the user. + + + + + Makes a slider the user can drag to change a value between a min and a max. + + Rectangle on the screen to use for the slider. + Optional label in front of the slider. + The value the slider shows. This determines the position of the draggable thumb. + The value at the left end of the slider. + The value at the right end of the slider. + + The value that has been set by the user. + + + + + Makes a slider the user can drag to change a value between a min and a max. + + Rectangle on the screen to use for the slider. + Optional label in front of the slider. + The value the slider shows. This determines the position of the draggable thumb. + The value at the left end of the slider. + The value at the right end of the slider. + + + + Makes a slider the user can drag to change a value between a min and a max. + + Rectangle on the screen to use for the slider. + Optional label in front of the slider. + The value the slider shows. This determines the position of the draggable thumb. + The value at the left end of the slider. + The value at the right end of the slider. + + + + Makes a slider the user can drag to change a value between a min and a max. + + Rectangle on the screen to use for the slider. + Optional label in front of the slider. + The value the slider shows. This determines the position of the draggable thumb. + The value at the left end of the slider. + The value at the right end of the slider. + + + + Makes a tag selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The tag the field shows. + Optional GUIStyle. + + The tag selected by the user. + + + + + Makes a tag selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The tag the field shows. + Optional GUIStyle. + + The tag selected by the user. + + + + + Makes a tag selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The tag the field shows. + Optional GUIStyle. + + The tag selected by the user. + + + + + Makes a tag selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The tag the field shows. + Optional GUIStyle. + + The tag selected by the user. + + + + + Makes a tag selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The tag the field shows. + Optional GUIStyle. + + The tag selected by the user. + + + + + Makes a tag selection field. + + Rectangle on the screen to use for the field. + Optional label in front of the field. + The tag the field shows. + Optional GUIStyle. + + The tag selected by the user. + + + + + Makes a text area. + + Rectangle on the screen to use for the text field. + The text to edit. + Optional GUIStyle. + + The text entered by the user. + + + + + Makes a text area. + + Rectangle on the screen to use for the text field. + The text to edit. + Optional GUIStyle. + + The text entered by the user. + + + + + Makes a text field. + + Rectangle on the screen to use for the text field. + Optional label to display in front of the text field. + The text to edit. + Optional GUIStyle. + + The text entered by the user. + + + + + Makes a text field. + + Rectangle on the screen to use for the text field. + Optional label to display in front of the text field. + The text to edit. + Optional GUIStyle. + + The text entered by the user. + + + + + Makes a text field. + + Rectangle on the screen to use for the text field. + Optional label to display in front of the text field. + The text to edit. + Optional GUIStyle. + + The text entered by the user. + + + + + Makes a text field. + + Rectangle on the screen to use for the text field. + Optional label to display in front of the text field. + The text to edit. + Optional GUIStyle. + + The text entered by the user. + + + + + Makes a text field. + + Rectangle on the screen to use for the text field. + Optional label to display in front of the text field. + The text to edit. + Optional GUIStyle. + + The text entered by the user. + + + + + Makes a text field. + + Rectangle on the screen to use for the text field. + Optional label to display in front of the text field. + The text to edit. + Optional GUIStyle. + + The text entered by the user. + + + + + Makes a toggle. + + Rectangle on the screen to use for the toggle. + Optional label in front of the toggle. + The shown state of the toggle. + Optional GUIStyle. + + The selected state of the toggle. + + + + + Makes a toggle. + + Rectangle on the screen to use for the toggle. + Optional label in front of the toggle. + The shown state of the toggle. + Optional GUIStyle. + + The selected state of the toggle. + + + + + Makes a toggle. + + Rectangle on the screen to use for the toggle. + Optional label in front of the toggle. + The shown state of the toggle. + Optional GUIStyle. + + The selected state of the toggle. + + + + + Makes a toggle. + + Rectangle on the screen to use for the toggle. + Optional label in front of the toggle. + The shown state of the toggle. + Optional GUIStyle. + + The selected state of the toggle. + + + + + Makes a toggle. + + Rectangle on the screen to use for the toggle. + Optional label in front of the toggle. + The shown state of the toggle. + Optional GUIStyle. + + The selected state of the toggle. + + + + + Makes a toggle. + + Rectangle on the screen to use for the toggle. + Optional label in front of the toggle. + The shown state of the toggle. + Optional GUIStyle. + + The selected state of the toggle. + + + + + Makes a toggle field where the toggle is to the left and the label immediately to the right of it. + + Rectangle on the screen to use for the toggle. + Label to display next to the toggle. + The value to edit. + Optional GUIStyle to use for the label. + + The value set by the user. + + + + + Makes a toggle field where the toggle is to the left and the label immediately to the right of it. + + Rectangle on the screen to use for the toggle. + Label to display next to the toggle. + The value to edit. + Optional GUIStyle to use for the label. + + The value set by the user. + + + + + Makes a toggle field where the toggle is to the left and the label immediately to the right of it. + + Rectangle on the screen to use for the toggle. + Label to display next to the toggle. + The value to edit. + Optional GUIStyle to use for the label. + + The value set by the user. + + + + + Makes a toggle field where the toggle is to the left and the label immediately to the right of it. + + Rectangle on the screen to use for the toggle. + Label to display next to the toggle. + The value to edit. + Optional GUIStyle to use for the label. + + The value set by the user. + + + + + Makes an X and Y field for entering a Vector2. + + Rectangle on the screen to use for the field. + Label to display above the field. + The value to edit. + + The value entered by the user. + + + + + Makes an X and Y field for entering a Vector2. + + Rectangle on the screen to use for the field. + Label to display above the field. + The value to edit. + + The value entered by the user. + + + + + Makes an X and Y integer field for entering a Vector2Int. + + Rectangle on the screen to use for the field. + Label to display above the field. + The value to edit. + + The value entered by the user. + + + + + Makes an X and Y integer field for entering a Vector2Int. + + Rectangle on the screen to use for the field. + Label to display above the field. + The value to edit. + + The value entered by the user. + + + + + Makes an X, Y, and Z field for entering a Vector3. + + Rectangle on the screen to use for the field. + Label to display above the field. + The value to edit. + + The value entered by the user. + + + + + Makes an X, Y, and Z field for entering a Vector3. + + Rectangle on the screen to use for the field. + Label to display above the field. + The value to edit. + + The value entered by the user. + + + + + Makes an X, Y, and Z integer field for entering a Vector3Int. + + Rectangle on the screen to use for the field. + Label to display above the field. + The value to edit. + + The value entered by the user. + + + + + Makes an X, Y, and Z integer field for entering a Vector3Int. + + Rectangle on the screen to use for the field. + Label to display above the field. + The value to edit. + + The value entered by the user. + + + + + Makes an X, Y, Z, and W field for entering a Vector4. + + Rectangle on the screen to use for the field. + Label to display above the field. + The value to edit. + + The value entered by the user. + + + + + Auto laid out version of EditorGUI. + + + + + Begins a group that can be be hidden/shown and the transition will be animated. + + A value between 0 and 1, 0 being hidden, and 1 being fully visible. + + If the group is visible or not. + + + + + Begin a horizontal group and get its rect back. + + Optional GUIStyle. + An optional list of layout options that specify extra layout + properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Begin a horizontal group and get its rect back. + + Optional GUIStyle. + An optional list of layout options that specify extra layout + properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Begin an automatically laid out scrollview. + + The position to use display. + Optional parameter to always show the horizontal scrollbar. If false or left out, it is only shown when the content inside the ScrollView is wider than the scrollview itself. + Optional parameter to always show the vertical scrollbar. If false or left out, it is only shown when content inside the ScrollView is taller than the scrollview itself. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + + + + + + The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. + + + + + Begin an automatically laid out scrollview. + + The position to use display. + Optional parameter to always show the horizontal scrollbar. If false or left out, it is only shown when the content inside the ScrollView is wider than the scrollview itself. + Optional parameter to always show the vertical scrollbar. If false or left out, it is only shown when content inside the ScrollView is taller than the scrollview itself. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + + + + + + The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. + + + + + Begin an automatically laid out scrollview. + + The position to use display. + Optional parameter to always show the horizontal scrollbar. If false or left out, it is only shown when the content inside the ScrollView is wider than the scrollview itself. + Optional parameter to always show the vertical scrollbar. If false or left out, it is only shown when content inside the ScrollView is taller than the scrollview itself. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + + + + + + The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. + + + + + Begin an automatically laid out scrollview. + + The position to use display. + Optional parameter to always show the horizontal scrollbar. If false or left out, it is only shown when the content inside the ScrollView is wider than the scrollview itself. + Optional parameter to always show the vertical scrollbar. If false or left out, it is only shown when content inside the ScrollView is taller than the scrollview itself. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + + + + + + The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. + + + + + Begin an automatically laid out scrollview. + + The position to use display. + Optional parameter to always show the horizontal scrollbar. If false or left out, it is only shown when the content inside the ScrollView is wider than the scrollview itself. + Optional parameter to always show the vertical scrollbar. If false or left out, it is only shown when content inside the ScrollView is taller than the scrollview itself. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + + + + + + The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. + + + + + Begin a vertical group with a toggle to enable or disable all the controls within at once. + + Label to show above the toggled controls. + Enabled state of the toggle group. + + The enabled state selected by the user. + + + + + Begin a vertical group with a toggle to enable or disable all the controls within at once. + + Label to show above the toggled controls. + Enabled state of the toggle group. + + The enabled state selected by the user. + + + + + Begin a vertical group and get its rect back. + + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. + Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Begin a vertical group and get its rect back. + + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. + Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Begin a vertical group and get its rect back. + + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. + Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make Center & Extents field for entering a Bounds. + + Label to display above the field. + The value to edit. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make Center & Extents field for entering a Bounds. + + Label to display above the field. + The value to edit. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make Center & Extents field for entering a Bounds. + + Label to display above the field. + The value to edit. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make Position & Size field for entering a BoundsInt. + + Make Position & Size field for entering a Bounds. + The value to edit. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make Position & Size field for entering a BoundsInt. + + Make Position & Size field for entering a Bounds. + The value to edit. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make Position & Size field for entering a BoundsInt. + + Make Position & Size field for entering a Bounds. + The value to edit. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make a field for selecting a Color. + + Optional label to display in front of the field. + The color to edit. + If true, the color picker should show the eyedropper control. If false, don't show it. + If true, allow the user to set an alpha value for the color. If false, hide the alpha component. + If true, treat the color as an HDR value. If false, treat it as a standard LDR value. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + The color selected by the user. + + + + + Make a field for selecting a Color. + + Optional label to display in front of the field. + The color to edit. + If true, the color picker should show the eyedropper control. If false, don't show it. + If true, allow the user to set an alpha value for the color. If false, hide the alpha component. + If true, treat the color as an HDR value. If false, treat it as a standard LDR value. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + The color selected by the user. + + + + + Make a field for selecting a Color. + + Optional label to display in front of the field. + The color to edit. + If true, the color picker should show the eyedropper control. If false, don't show it. + If true, allow the user to set an alpha value for the color. If false, hide the alpha component. + If true, treat the color as an HDR value. If false, treat it as a standard LDR value. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + The color selected by the user. + + + + + Make a field for selecting a Color. + + Optional label to display in front of the field. + The color to edit. + If true, the color picker should show the eyedropper control. If false, don't show it. + If true, allow the user to set an alpha value for the color. If false, hide the alpha component. + If true, treat the color as an HDR value. If false, treat it as a standard LDR value. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + The color selected by the user. + + + + + Make a field for selecting a Color. + + Optional label to display in front of the field. + The color to edit. + If true, the color picker should show the eyedropper control. If false, don't show it. + If true, allow the user to set an alpha value for the color. If false, hide the alpha component. + If true, treat the color as an HDR value. If false, treat it as a standard LDR value. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + The color selected by the user. + + + + + Make a field for editing an AnimationCurve. + + Optional label to display in front of the field. + The curve to edit. + The color to show the curve with. + Optional rectangle that the curve is restrained within. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The curve edited by the user. + + + + + Make a field for editing an AnimationCurve. + + Optional label to display in front of the field. + The curve to edit. + The color to show the curve with. + Optional rectangle that the curve is restrained within. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The curve edited by the user. + + + + + Make a field for editing an AnimationCurve. + + Optional label to display in front of the field. + The curve to edit. + The color to show the curve with. + Optional rectangle that the curve is restrained within. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The curve edited by the user. + + + + + Make a field for editing an AnimationCurve. + + Optional label to display in front of the field. + The curve to edit. + The color to show the curve with. + Optional rectangle that the curve is restrained within. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The curve edited by the user. + + + + + Make a field for editing an AnimationCurve. + + Optional label to display in front of the field. + The curve to edit. + The color to show the curve with. + Optional rectangle that the curve is restrained within. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The curve edited by the user. + + + + + Make a field for editing an AnimationCurve. + + Optional label to display in front of the field. + The curve to edit. + The color to show the curve with. + Optional rectangle that the curve is restrained within. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The curve edited by the user. + + + + + Make a field for editing an AnimationCurve. + + The curve to edit. + The color to show the curve with. + Optional rectangle that the curve is restrained within. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + Optional label to display in front of the field. Pass [[GUIContent.none] to hide the label. + + + + Make a field for editing an AnimationCurve. + + The curve to edit. + The color to show the curve with. + Optional rectangle that the curve is restrained within. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + Optional label to display in front of the field. Pass [[GUIContent.none] to hide the label. + + + + Make a delayed text field for entering doubles. + + Optional label to display in front of the double field. + The value to edit. + Optional GUIStyle. + + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> + See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, + GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the double field. + + + + + Make a delayed text field for entering doubles. + + Optional label to display in front of the double field. + The value to edit. + Optional GUIStyle. + + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> + See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, + GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the double field. + + + + + Make a delayed text field for entering doubles. + + Optional label to display in front of the double field. + The value to edit. + Optional GUIStyle. + + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> + See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, + GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the double field. + + + + + Make a delayed text field for entering doubles. + + Optional label to display in front of the double field. + The value to edit. + Optional GUIStyle. + + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> + See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, + GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the double field. + + + + + Make a delayed text field for entering doubles. + + Optional label to display in front of the double field. + The value to edit. + Optional GUIStyle. + + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> + See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, + GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the double field. + + + + + Make a delayed text field for entering doubles. + + Optional label to display in front of the double field. + The value to edit. + Optional GUIStyle. + + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> + See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, + GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the double field. + + + + + Make a delayed text field for entering doubles. + + The double property to edit. + Optional label to display in front of the double field. Pass GUIContent.none to hide label. + + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> + See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, + GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + + Make a delayed text field for entering doubles. + + The double property to edit. + Optional label to display in front of the double field. Pass GUIContent.none to hide label. + + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> + See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, + GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + + Make a delayed text field for entering floats. + + Optional label to display in front of the float field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the float field. + + + + + Make a delayed text field for entering floats. + + Optional label to display in front of the float field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the float field. + + + + + Make a delayed text field for entering floats. + + Optional label to display in front of the float field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the float field. + + + + + Make a delayed text field for entering floats. + + Optional label to display in front of the float field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the float field. + + + + + Make a delayed text field for entering floats. + + Optional label to display in front of the float field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the float field. + + + + + Make a delayed text field for entering floats. + + Optional label to display in front of the float field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the float field. + + + + + Make a delayed text field for entering floats. + + The float property to edit. + Optional label to display in front of the float field. Pass GUIContent.none to hide label. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make a delayed text field for entering floats. + + The float property to edit. + Optional label to display in front of the float field. Pass GUIContent.none to hide label. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make a delayed text field for entering integers. + + Optional label to display in front of the int field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the int field. + + + + + Make a delayed text field for entering integers. + + Optional label to display in front of the int field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the int field. + + + + + Make a delayed text field for entering integers. + + Optional label to display in front of the int field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the int field. + + + + + Make a delayed text field for entering integers. + + Optional label to display in front of the int field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the int field. + + + + + Make a delayed text field for entering integers. + + Optional label to display in front of the int field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the int field. + + + + + Make a delayed text field for entering integers. + + Optional label to display in front of the int field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the int field. + + + + + Make a delayed text field for entering integers. + + The int property to edit. + Optional label to display in front of the int field. Pass GUIContent.none to hide label. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make a delayed text field for entering integers. + + The int property to edit. + Optional label to display in front of the int field. Pass GUIContent.none to hide label. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make a delayed text field. + + Optional label to display in front of the int field. + The text to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the text field. + + + + + Make a delayed text field. + + Optional label to display in front of the int field. + The text to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the text field. + + + + + Make a delayed text field. + + Optional label to display in front of the int field. + The text to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the text field. + + + + + Make a delayed text field. + + Optional label to display in front of the int field. + The text to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the text field. + + + + + Make a delayed text field. + + Optional label to display in front of the int field. + The text to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the text field. + + + + + Make a delayed text field. + + Optional label to display in front of the int field. + The text to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. Note that the return value will not change until the user has pressed enter or focus is moved away from the text field. + + + + + Make a delayed text field. + + The text property to edit. + Optional label to display in front of the int field. Pass GUIContent.none to hide label. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make a delayed text field. + + The text property to edit. + Optional label to display in front of the int field. Pass GUIContent.none to hide label. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make a text field for entering double values. + + Optional label to display in front of the double field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make a text field for entering double values. + + Optional label to display in front of the double field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make a text field for entering double values. + + Optional label to display in front of the double field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make a text field for entering double values. + + Optional label to display in front of the double field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make a text field for entering double values. + + Optional label to display in front of the double field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make a text field for entering double values. + + Optional label to display in front of the double field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make a button that reacts to mouse down, for displaying your own dropdown content. + + Text, image and tooltip for this button. + Whether the button should be selectable by keyboard or not. + Optional style to use. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + true when the user clicks the button. + + + + + Make a button that reacts to mouse down, for displaying your own dropdown content. + + Text, image and tooltip for this button. + Whether the button should be selectable by keyboard or not. + Optional style to use. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + true when the user clicks the button. + + + + + Closes a group started with BeginFadeGroup. + + + + + Close a group started with BeginHorizontal. + + + + + Ends a scrollview started with a call to BeginScrollView. + + + + + Close a group started with BeginToggleGroup. + + + + + Close a group started with BeginVertical. + + + + + Displays a menu with an option for every value of the enum type when clicked. + + Optional label to display in front of the enum flags field. + Enum flags value. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. + + The enum flags value modified by the user. This is a selection BitMask where each bit represents an Enum value index. (Note this returned value is not itself an Enum). + + + + + Displays a menu with an option for every value of the enum type when clicked. + + Optional label to display in front of the enum flags field. + Enum flags value. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. + + The enum flags value modified by the user. This is a selection BitMask where each bit represents an Enum value index. (Note this returned value is not itself an Enum). + + + + + Displays a menu with an option for every value of the enum type when clicked. + + Optional label to display in front of the enum flags field. + Enum flags value. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. + + The enum flags value modified by the user. This is a selection BitMask where each bit represents an Enum value index. (Note this returned value is not itself an Enum). + + + + + Displays a menu with an option for every value of the enum type when clicked. + + Optional label to display in front of the enum flags field. + Enum flags value. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. + + The enum flags value modified by the user. This is a selection BitMask where each bit represents an Enum value index. (Note this returned value is not itself an Enum). + + + + + Displays a menu with an option for every value of the enum type when clicked. + + Optional label to display in front of the enum flags field. + Enum flags value. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. + + The enum flags value modified by the user. This is a selection BitMask where each bit represents an Enum value index. (Note this returned value is not itself an Enum). + + + + + Displays a menu with an option for every value of the enum type when clicked. + + Optional label to display in front of the enum flags field. + Enum flags value. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. + + The enum flags value modified by the user. This is a selection BitMask where each bit represents an Enum value index. (Note this returned value is not itself an Enum). + + + + + Displays a menu with an option for every value of the enum type when clicked. + + Optional label to display in front of the enum flags field. + Enum flags value. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. + + The enum flags value modified by the user. This is a selection BitMask where each bit represents an Enum value index. (Note this returned value is not itself an Enum). + + + + + Displays a menu with an option for every value of the enum type when clicked. + + Optional label to display in front of the enum flags field. + Enum flags value. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. + + The enum flags value modified by the user. This is a selection BitMask where each bit represents an Enum value index. (Note this returned value is not itself an Enum). + + + + + This method is obsolete. Use EditorGUILayout.EnumFlagsField instead. + +Make a field for enum based masks. + + Prefix label for this field. + Enum to use for the flags. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value modified by the user. + + + + + This method is obsolete. Use EditorGUILayout.EnumFlagsField instead. + +Make a field for enum based masks. + + Prefix label for this field. + Enum to use for the flags. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value modified by the user. + + + + + This method is obsolete. Use EditorGUILayout.EnumFlagsField instead. + +Make a field for enum based masks. + + Prefix label for this field. + Enum to use for the flags. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value modified by the user. + + + + + This method is obsolete. Use EditorGUILayout.EnumFlagsField instead. + +Make a field for enum based masks. + + Prefix label for this field. + Enum to use for the flags. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value modified by the user. + + + + + This method is obsolete. Use EditorGUILayout.EnumFlagsField instead. + +Make a field for enum based masks. + + Prefix label for this field. + Enum to use for the flags. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value modified by the user. + + + + + This method is obsolete. Use EditorGUILayout.EnumFlagsField instead. + +Make a field for enum based masks. + + Prefix label for this field. + Enum to use for the flags. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value modified by the user. + + + + + This method is obsolete. Use EditorGUILayout.EnumFlagsField instead. + +Make an enum popup selection field for a bitmask. + + Optional label in front of the field. + The enum options the field shows. + Optional GUIStyle. + Optional layout options. + + The enum options that has been selected by the user. + + + + + This method is obsolete. Use EditorGUILayout.EnumFlagsField instead. + +Make an enum popup selection field for a bitmask. + + Optional label in front of the field. + The enum options the field shows. + Optional GUIStyle. + Optional layout options. + + The enum options that has been selected by the user. + + + + + This method is obsolete. Use EditorGUILayout.EnumFlagsField instead. + +Make an enum popup selection field for a bitmask. + + Optional label in front of the field. + The enum options the field shows. + Optional GUIStyle. + Optional layout options. + + The enum options that has been selected by the user. + + + + + This method is obsolete. Use EditorGUILayout.EnumFlagsField instead. + +Make an enum popup selection field for a bitmask. + + Optional label in front of the field. + The enum options the field shows. + Optional GUIStyle. + Optional layout options. + + The enum options that has been selected by the user. + + + + + Make an enum popup selection field. + + Optional label in front of the field. + The enum option the field shows. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. + Method called for each Enum value displayed. The specified method should return true if the option can be selected, false otherwise. + + The enum option that has been selected by the user. + + + + + Make an enum popup selection field. + + Optional label in front of the field. + The enum option the field shows. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. + Method called for each Enum value displayed. The specified method should return true if the option can be selected, false otherwise. + + The enum option that has been selected by the user. + + + + + Make an enum popup selection field. + + Optional label in front of the field. + The enum option the field shows. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. + Method called for each Enum value displayed. The specified method should return true if the option can be selected, false otherwise. + + The enum option that has been selected by the user. + + + + + Make an enum popup selection field. + + Optional label in front of the field. + The enum option the field shows. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. + Method called for each Enum value displayed. The specified method should return true if the option can be selected, false otherwise. + + The enum option that has been selected by the user. + + + + + Make an enum popup selection field. + + Optional label in front of the field. + The enum option the field shows. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. + Method called for each Enum value displayed. The specified method should return true if the option can be selected, false otherwise. + + The enum option that has been selected by the user. + + + + + Make an enum popup selection field. + + Optional label in front of the field. + The enum option the field shows. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. + Method called for each Enum value displayed. The specified method should return true if the option can be selected, false otherwise. + + The enum option that has been selected by the user. + + + + + Make an enum popup selection field. + + Optional label in front of the field. + The enum option the field shows. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. + Method called for each Enum value displayed. The specified method should return true if the option can be selected, false otherwise. + + The enum option that has been selected by the user. + + + + + Make an enum popup selection field. + + Optional label in front of the field. + The enum option the field shows. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. + Method called for each Enum value displayed. The specified method should return true if the option can be selected, false otherwise. + + The enum option that has been selected by the user. + + + + + Begins a group that can be be hidden/shown and the transition will be animated. + + + + + Whether the group is visible. + + + + + Create a new FadeGroupScope and begin the corresponding group. + + A value between 0 and 1, 0 being hidden, and 1 being fully visible. + + + + Make a text field for entering float values. + + Optional label to display in front of the float field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make a text field for entering float values. + + Optional label to display in front of the float field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make a text field for entering float values. + + Optional label to display in front of the float field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make a text field for entering float values. + + Optional label to display in front of the float field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make a text field for entering float values. + + Optional label to display in front of the float field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make a text field for entering float values. + + Optional label to display in front of the float field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make a label with a foldout arrow to the left of it. + + The shown foldout state. + The label to show. + Optional GUIStyle. + Whether to toggle the foldout state when the label is clicked. + + The foldout state selected by the user. If true, you should render sub-objects. + + + + + Make a label with a foldout arrow to the left of it. + + The shown foldout state. + The label to show. + Optional GUIStyle. + Whether to toggle the foldout state when the label is clicked. + + The foldout state selected by the user. If true, you should render sub-objects. + + + + + Make a label with a foldout arrow to the left of it. + + The shown foldout state. + The label to show. + Optional GUIStyle. + Whether to toggle the foldout state when the label is clicked. + + The foldout state selected by the user. If true, you should render sub-objects. + + + + + Make a label with a foldout arrow to the left of it. + + The shown foldout state. + The label to show. + Optional GUIStyle. + Whether to toggle the foldout state when the label is clicked. + + The foldout state selected by the user. If true, you should render sub-objects. + + + + + Make a label with a foldout arrow to the left of it. + + The shown foldout state. + The label to show. + Optional GUIStyle. + Whether to toggle the foldout state when the label is clicked. + + The foldout state selected by the user. If true, you should render sub-objects. + + + + + Make a label with a foldout arrow to the left of it. + + The shown foldout state. + The label to show. + Optional GUIStyle. + Whether to toggle the foldout state when the label is clicked. + + The foldout state selected by the user. If true, you should render sub-objects. + + + + + Get a rect for an Editor control. + + Optional boolean to specify if the control has a label. Default is true. + The height in pixels of the control. Default is EditorGUIUtility.singleLineHeight. + Optional GUIStyle to use for the control. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style. +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Get a rect for an Editor control. + + Optional boolean to specify if the control has a label. Default is true. + The height in pixels of the control. Default is EditorGUIUtility.singleLineHeight. + Optional GUIStyle to use for the control. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style. +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Get a rect for an Editor control. + + Optional boolean to specify if the control has a label. Default is true. + The height in pixels of the control. Default is EditorGUIUtility.singleLineHeight. + Optional GUIStyle to use for the control. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style. +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Get a rect for an Editor control. + + Optional boolean to specify if the control has a label. Default is true. + The height in pixels of the control. Default is EditorGUIUtility.singleLineHeight. + Optional GUIStyle to use for the control. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style. +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make a field for editing a Gradient. + + Optional label to display in front of the field. + The gradient to edit. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + The gradient edited by the user. + + + + + Make a field for editing a Gradient. + + Optional label to display in front of the field. + The gradient to edit. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + The gradient edited by the user. + + + + + Make a field for editing a Gradient. + + Optional label to display in front of the field. + The gradient to edit. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + The gradient edited by the user. + + + + + Make a field for editing a Gradient. + + Optional label to display in front of the field. + The gradient to edit. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + The gradient edited by the user. + + + + + Make a help box with a message to the user. + + The message text. + The type of message. + If true, the box will cover the whole width of the window; otherwise it will cover the controls part only. + + + + Make a help box with a message to the user. + + The message text. + The type of message. + If true, the box will cover the whole width of the window; otherwise it will cover the controls part only. + + + + Disposable helper class for managing BeginHorizontal / EndHorizontal. + + + + + The rect of the horizontal group. + + + + + Create a new HorizontalScope and begin the corresponding horizontal group. + + The style to use for background image and padding values. If left out, the background is transparent. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Create a new HorizontalScope and begin the corresponding horizontal group. + + The style to use for background image and padding values. If left out, the background is transparent. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make an inspector-window-like titlebar. + + The foldout state shown with the arrow. + The object (for example a component) or objects that the titlebar is for. + + + The foldout state selected by the user. + + + + + Make an inspector-window-like titlebar. + + The foldout state shown with the arrow. + The object (for example a component) or objects that the titlebar is for. + + + The foldout state selected by the user. + + + + + Make a text field for entering integers. + + Optional label to display in front of the int field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make a text field for entering integers. + + Optional label to display in front of the int field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make a text field for entering integers. + + Optional label to display in front of the int field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make a text field for entering integers. + + Optional label to display in front of the int field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make a text field for entering integers. + + Optional label to display in front of the int field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make a text field for entering integers. + + Optional label to display in front of the int field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make an integer popup selection field. + + Optional label in front of the field. + The value of the option the field shows. + An array with the displayed options the user can choose from. + An array with the values for each option. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value of the option that has been selected by the user. + + + + + Make an integer popup selection field. + + Optional label in front of the field. + The value of the option the field shows. + An array with the displayed options the user can choose from. + An array with the values for each option. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value of the option that has been selected by the user. + + + + + Make an integer popup selection field. + + Optional label in front of the field. + The value of the option the field shows. + An array with the displayed options the user can choose from. + An array with the values for each option. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value of the option that has been selected by the user. + + + + + Make an integer popup selection field. + + Optional label in front of the field. + The value of the option the field shows. + An array with the displayed options the user can choose from. + An array with the values for each option. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value of the option that has been selected by the user. + + + + + Make an integer popup selection field. + + Optional label in front of the field. + The value of the option the field shows. + An array with the displayed options the user can choose from. + An array with the values for each option. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value of the option that has been selected by the user. + + + + + Make an integer popup selection field. + + Optional label in front of the field. + The value of the option the field shows. + An array with the displayed options the user can choose from. + An array with the values for each option. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value of the option that has been selected by the user. + + + + + Make an integer popup selection field. + + Optional label in front of the field. + The value of the option the field shows. + An array with the displayed options the user can choose from. + An array with the values for each option. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value of the option that has been selected by the user. + + + + + Make an integer popup selection field. + + Optional label in front of the field. + The value of the option the field shows. + An array with the displayed options the user can choose from. + An array with the values for each option. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value of the option that has been selected by the user. + + + + + Make an integer popup selection field. + + The value of the option the field shows. + An array with the displayed options the user can choose from. + An array with the values for each option. + Optional label in front of the field. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + + Make an integer popup selection field. + + The value of the option the field shows. + An array with the displayed options the user can choose from. + An array with the values for each option. + Optional label in front of the field. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + + Make an integer popup selection field. + + The value of the option the field shows. + An array with the displayed options the user can choose from. + An array with the values for each option. + Optional label in front of the field. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + + Make a slider the user can drag to change an integer value between a min and a max. + + Optional label in front of the slider. + The value the slider shows. This determines the position of the draggable thumb. + The value at the left end of the slider. + The value at the right end of the slider. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value that has been set by the user. + + + + + Make a slider the user can drag to change an integer value between a min and a max. + + Optional label in front of the slider. + The value the slider shows. This determines the position of the draggable thumb. + The value at the left end of the slider. + The value at the right end of the slider. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value that has been set by the user. + + + + + Make a slider the user can drag to change an integer value between a min and a max. + + Optional label in front of the slider. + The value the slider shows. This determines the position of the draggable thumb. + The value at the left end of the slider. + The value at the right end of the slider. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value that has been set by the user. + + + + + Make a slider the user can drag to change an integer value between a min and a max. + + Optional label in front of the slider. + The value the slider shows. This determines the position of the draggable thumb. + The value at the left end of the slider. + The value at the right end of the slider. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make a slider the user can drag to change an integer value between a min and a max. + + Optional label in front of the slider. + The value the slider shows. This determines the position of the draggable thumb. + The value at the left end of the slider. + The value at the right end of the slider. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make a slider the user can drag to change an integer value between a min and a max. + + Optional label in front of the slider. + The value the slider shows. This determines the position of the draggable thumb. + The value at the left end of the slider. + The value at the right end of the slider. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make a label field. (Useful for showing read-only info.) + + Label in front of the label field. + The label to show to the right. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + + Make a label field. (Useful for showing read-only info.) + + Label in front of the label field. + The label to show to the right. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + + Make a label field. (Useful for showing read-only info.) + + Label in front of the label field. + The label to show to the right. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + + Make a label field. (Useful for showing read-only info.) + + Label in front of the label field. + The label to show to the right. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + + Make a label field. (Useful for showing read-only info.) + + Label in front of the label field. + The label to show to the right. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + + Make a label field. (Useful for showing read-only info.) + + Label in front of the label field. + The label to show to the right. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + + Make a label field. (Useful for showing read-only info.) + + Label in front of the label field. + The label to show to the right. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + + Make a label field. (Useful for showing read-only info.) + + Label in front of the label field. + The label to show to the right. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + + Make a layer selection field. + + Optional label in front of the field. + The layer shown in the field. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The layer selected by the user. + + + + + Make a layer selection field. + + Optional label in front of the field. + The layer shown in the field. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The layer selected by the user. + + + + + Make a layer selection field. + + Optional label in front of the field. + The layer shown in the field. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The layer selected by the user. + + + + + Make a layer selection field. + + Optional label in front of the field. + The layer shown in the field. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The layer selected by the user. + + + + + Make a layer selection field. + + Optional label in front of the field. + The layer shown in the field. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The layer selected by the user. + + + + + Make a layer selection field. + + Optional label in front of the field. + The layer shown in the field. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The layer selected by the user. + + + + + Make a text field for entering long integers. + + Optional label to display in front of the long field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make a text field for entering long integers. + + Optional label to display in front of the long field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make a text field for entering long integers. + + Optional label to display in front of the long field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make a text field for entering long integers. + + Optional label to display in front of the long field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make a text field for entering long integers. + + Optional label to display in front of the long field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make a text field for entering long integers. + + Optional label to display in front of the long field. + The value to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make a field for masks. + + Prefix label of the field. + The current mask to display. + A string array containing the labels for each flag. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + The value modified by the user. + + + + + Make a field for masks. + + Prefix label of the field. + The current mask to display. + A string array containing the labels for each flag. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + The value modified by the user. + + + + + Make a field for masks. + + Prefix label of the field. + The current mask to display. + A string array containing the labels for each flag. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + The value modified by the user. + + + + + Make a field for masks. + + Prefix label of the field. + The current mask to display. + A string array containing the labels for each flag. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + The value modified by the user. + + + + + Make a field for masks. + + Prefix label of the field. + The current mask to display. + A string array containing the labels for each flag. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + The value modified by the user. + + + + + Make a field for masks. + + Prefix label of the field. + The current mask to display. + A string array containing the labels for each flag. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + The value modified by the user. + + + + + Make a special slider the user can use to specify a range between a min and a max. + + Optional label in front of the slider. + The lower value of the range the slider shows, passed by reference. + The upper value at the range the slider shows, passed by reference. + The limit at the left end of the slider. + The limit at the right end of the slider. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make a special slider the user can use to specify a range between a min and a max. + + Optional label in front of the slider. + The lower value of the range the slider shows, passed by reference. + The upper value at the range the slider shows, passed by reference. + The limit at the left end of the slider. + The limit at the right end of the slider. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make a special slider the user can use to specify a range between a min and a max. + + Optional label in front of the slider. + The lower value of the range the slider shows, passed by reference. + The upper value at the range the slider shows, passed by reference. + The limit at the left end of the slider. + The limit at the right end of the slider. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make a field to receive any object type. + + Optional label in front of the field. + The object the field shows. + The type of the objects that can be assigned. + Allow assigning Scene objects. See Description for more info. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style. +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The object that has been set by the user. + + + + + Make a field to receive any object type. + + Optional label in front of the field. + The object the field shows. + The type of the objects that can be assigned. + Allow assigning Scene objects. See Description for more info. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style. +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The object that has been set by the user. + + + + + Make a field to receive any object type. + + Optional label in front of the field. + The object the field shows. + The type of the objects that can be assigned. + Allow assigning Scene objects. See Description for more info. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style. +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The object that has been set by the user. + + + + + Make a field to receive any object type. + + The object reference property the field shows. + The type of the objects that can be assigned. + Optional label in front of the field. Pass GUIContent.none to hide the label. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make a field to receive any object type. + + The object reference property the field shows. + The type of the objects that can be assigned. + Optional label in front of the field. Pass GUIContent.none to hide the label. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make a field to receive any object type. + + The object reference property the field shows. + The type of the objects that can be assigned. + Optional label in front of the field. Pass GUIContent.none to hide the label. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make a field to receive any object type. + + The object reference property the field shows. + The type of the objects that can be assigned. + Optional label in front of the field. Pass GUIContent.none to hide the label. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make a text field where the user can enter a password. + + Optional label to display in front of the password field. + The password to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The password entered by the user. + + + + + Make a text field where the user can enter a password. + + Optional label to display in front of the password field. + The password to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The password entered by the user. + + + + + Make a text field where the user can enter a password. + + Optional label to display in front of the password field. + The password to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The password entered by the user. + + + + + Make a text field where the user can enter a password. + + Optional label to display in front of the password field. + The password to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The password entered by the user. + + + + + Make a text field where the user can enter a password. + + Optional label to display in front of the password field. + The password to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The password entered by the user. + + + + + Make a text field where the user can enter a password. + + Optional label to display in front of the password field. + The password to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The password entered by the user. + + + + + Make a generic popup selection field. + + Optional label in front of the field. + The index of the option the field shows. + An array with the options shown in the popup. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The index of the option that has been selected by the user. + + + + + Make a generic popup selection field. + + Optional label in front of the field. + The index of the option the field shows. + An array with the options shown in the popup. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The index of the option that has been selected by the user. + + + + + Make a generic popup selection field. + + Optional label in front of the field. + The index of the option the field shows. + An array with the options shown in the popup. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The index of the option that has been selected by the user. + + + + + Make a generic popup selection field. + + Optional label in front of the field. + The index of the option the field shows. + An array with the options shown in the popup. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The index of the option that has been selected by the user. + + + + + Make a generic popup selection field. + + Optional label in front of the field. + The index of the option the field shows. + An array with the options shown in the popup. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The index of the option that has been selected by the user. + + + + + Make a generic popup selection field. + + Optional label in front of the field. + The index of the option the field shows. + An array with the options shown in the popup. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The index of the option that has been selected by the user. + + + + + Make a generic popup selection field. + + Optional label in front of the field. + The index of the option the field shows. + An array with the options shown in the popup. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The index of the option that has been selected by the user. + + + + + Make a generic popup selection field. + + Optional label in front of the field. + The index of the option the field shows. + An array with the options shown in the popup. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The index of the option that has been selected by the user. + + + + + Make a label in front of some control. + + Label to show to the left of the control. + + + + + + Make a label in front of some control. + + Label to show to the left of the control. + + + + + + Make a label in front of some control. + + Label to show to the left of the control. + + + + + + Make a label in front of some control. + + Label to show to the left of the control. + + + + + + Make a label in front of some control. + + Label to show to the left of the control. + + + + + + Make a label in front of some control. + + Label to show to the left of the control. + + + + + + Make a field for SerializedProperty. + + The SerializedProperty to make a field for. + Optional label to use. If not specified the label of the property itself is used. Use GUIContent.none to not display a label at all. + If true the property including children is drawn; otherwise only the control itself (such as only a foldout but nothing below it). + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + True if the property has children and is expanded and includeChildren was set to false; otherwise false. + + + + + Make a field for SerializedProperty. + + The SerializedProperty to make a field for. + Optional label to use. If not specified the label of the property itself is used. Use GUIContent.none to not display a label at all. + If true the property including children is drawn; otherwise only the control itself (such as only a foldout but nothing below it). + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + True if the property has children and is expanded and includeChildren was set to false; otherwise false. + + + + + Make a field for SerializedProperty. + + The SerializedProperty to make a field for. + Optional label to use. If not specified the label of the property itself is used. Use GUIContent.none to not display a label at all. + If true the property including children is drawn; otherwise only the control itself (such as only a foldout but nothing below it). + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + True if the property has children and is expanded and includeChildren was set to false; otherwise false. + + + + + Make a field for SerializedProperty. + + The SerializedProperty to make a field for. + Optional label to use. If not specified the label of the property itself is used. Use GUIContent.none to not display a label at all. + If true the property including children is drawn; otherwise only the control itself (such as only a foldout but nothing below it). + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + True if the property has children and is expanded and includeChildren was set to false; otherwise false. + + + + + Make an X, Y, W & H field for entering a Rect. + + Label to display above the field. + The value to edit. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make an X, Y, W & H field for entering a Rect. + + Label to display above the field. + The value to edit. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make an X, Y, W & H field for entering a Rect. + + Label to display above the field. + The value to edit. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make an X, Y, W & H field for entering a RectInt. + + Label to display above the field. + The value to edit. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make an X, Y, W & H field for entering a RectInt. + + Label to display above the field. + The value to edit. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make an X, Y, W & H field for entering a RectInt. + + Label to display above the field. + The value to edit. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Disposable helper class for managing BeginScrollView / EndScrollView. + + + + + Whether this ScrollView should handle scroll wheel events. (default: true). + + + + + The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. + + + + + Create a new ScrollViewScope and begin the corresponding ScrollView. + + The scroll position to use. + Whether to always show the horizontal scrollbar. If false, it is only shown when the content inside the ScrollView is wider than the scrollview itself. + Whether to always show the vertical scrollbar. If false, it is only shown when the content inside the ScrollView is higher than the scrollview itself. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + + + + + + + Create a new ScrollViewScope and begin the corresponding ScrollView. + + The scroll position to use. + Whether to always show the horizontal scrollbar. If false, it is only shown when the content inside the ScrollView is wider than the scrollview itself. + Whether to always show the vertical scrollbar. If false, it is only shown when the content inside the ScrollView is higher than the scrollview itself. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + + + + + + + Create a new ScrollViewScope and begin the corresponding ScrollView. + + The scroll position to use. + Whether to always show the horizontal scrollbar. If false, it is only shown when the content inside the ScrollView is wider than the scrollview itself. + Whether to always show the vertical scrollbar. If false, it is only shown when the content inside the ScrollView is higher than the scrollview itself. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + + + + + + + Create a new ScrollViewScope and begin the corresponding ScrollView. + + The scroll position to use. + Whether to always show the horizontal scrollbar. If false, it is only shown when the content inside the ScrollView is wider than the scrollview itself. + Whether to always show the vertical scrollbar. If false, it is only shown when the content inside the ScrollView is higher than the scrollview itself. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + + + + + + + Create a new ScrollViewScope and begin the corresponding ScrollView. + + The scroll position to use. + Whether to always show the horizontal scrollbar. If false, it is only shown when the content inside the ScrollView is wider than the scrollview itself. + Whether to always show the vertical scrollbar. If false, it is only shown when the content inside the ScrollView is higher than the scrollview itself. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + + + + + + + Make a selectable label field. (Useful for showing read-only info that can be copy-pasted.) + + The text to show. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make a selectable label field. (Useful for showing read-only info that can be copy-pasted.) + + The text to show. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make a slider the user can drag to change a value between a min and a max. + + Optional label in front of the slider. + The value the slider shows. This determines the position of the draggable thumb. + The value at the left end of the slider. + The value at the right end of the slider. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value that has been set by the user. + + + + + Make a slider the user can drag to change a value between a min and a max. + + Optional label in front of the slider. + The value the slider shows. This determines the position of the draggable thumb. + The value at the left end of the slider. + The value at the right end of the slider. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value that has been set by the user. + + + + + Make a slider the user can drag to change a value between a min and a max. + + Optional label in front of the slider. + The value the slider shows. This determines the position of the draggable thumb. + The value at the left end of the slider. + The value at the right end of the slider. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value that has been set by the user. + + + + + Make a slider the user can drag to change a value between a min and a max. + + Optional label in front of the slider. + The value the slider shows. This determines the position of the draggable thumb. + The value at the left end of the slider. + The value at the right end of the slider. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make a slider the user can drag to change a value between a min and a max. + + Optional label in front of the slider. + The value the slider shows. This determines the position of the draggable thumb. + The value at the left end of the slider. + The value at the right end of the slider. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make a slider the user can drag to change a value between a min and a max. + + Optional label in front of the slider. + The value the slider shows. This determines the position of the draggable thumb. + The value at the left end of the slider. + The value at the right end of the slider. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make a small space between the previous control and the following. + + + + + Make a tag selection field. + + Optional label in front of the field. + The tag the field shows. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The tag selected by the user. + + + + + Make a tag selection field. + + Optional label in front of the field. + The tag the field shows. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The tag selected by the user. + + + + + Make a tag selection field. + + Optional label in front of the field. + The tag the field shows. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The tag selected by the user. + + + + + Make a tag selection field. + + Optional label in front of the field. + The tag the field shows. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The tag selected by the user. + + + + + Make a tag selection field. + + Optional label in front of the field. + The tag the field shows. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The tag selected by the user. + + + + + Make a tag selection field. + + Optional label in front of the field. + The tag the field shows. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The tag selected by the user. + + + + + Make a text area. + + The text to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The text entered by the user. + + + + + Make a text area. + + The text to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The text entered by the user. + + + + + Make a text field. + + Optional label to display in front of the text field. + The text to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The text entered by the user. + + + + + Make a text field. + + Optional label to display in front of the text field. + The text to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The text entered by the user. + + + + + Make a text field. + + Optional label to display in front of the text field. + The text to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The text entered by the user. + + + + + Make a text field. + + Optional label to display in front of the text field. + The text to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The text entered by the user. + + + + + Make a text field. + + Optional label to display in front of the text field. + The text to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The text entered by the user. + + + + + Make a text field. + + Optional label to display in front of the text field. + The text to edit. + Optional GUIStyle. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The text entered by the user. + + + + + Make a toggle. + + Optional label in front of the toggle. + The shown state of the toggle. + Optional GUIStyle. + An optional list of layout options that specify extra layout + properties. Any values passed in here will override settings defined by the style.<br> + +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The selected state of the toggle. + + + + + Make a toggle. + + Optional label in front of the toggle. + The shown state of the toggle. + Optional GUIStyle. + An optional list of layout options that specify extra layout + properties. Any values passed in here will override settings defined by the style.<br> + +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The selected state of the toggle. + + + + + Make a toggle. + + Optional label in front of the toggle. + The shown state of the toggle. + Optional GUIStyle. + An optional list of layout options that specify extra layout + properties. Any values passed in here will override settings defined by the style.<br> + +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The selected state of the toggle. + + + + + Make a toggle. + + Optional label in front of the toggle. + The shown state of the toggle. + Optional GUIStyle. + An optional list of layout options that specify extra layout + properties. Any values passed in here will override settings defined by the style.<br> + +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The selected state of the toggle. + + + + + Make a toggle. + + Optional label in front of the toggle. + The shown state of the toggle. + Optional GUIStyle. + An optional list of layout options that specify extra layout + properties. Any values passed in here will override settings defined by the style.<br> + +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The selected state of the toggle. + + + + + Make a toggle. + + Optional label in front of the toggle. + The shown state of the toggle. + Optional GUIStyle. + An optional list of layout options that specify extra layout + properties. Any values passed in here will override settings defined by the style.<br> + +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The selected state of the toggle. + + + + + Begin a vertical group with a toggle to enable or disable all the controls within at once. + + + + + The enabled state selected by the user. + + + + + + + Label to show above the toggled controls. + Enabled state of the toggle group. + + + + + + Label to show above the toggled controls. + Enabled state of the toggle group. + + + + Make a toggle field where the toggle is to the left and the label immediately to the right of it. + + Label to display next to the toggle. + The value to edit. + Optional GUIStyle to use for the label. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make a toggle field where the toggle is to the left and the label immediately to the right of it. + + Label to display next to the toggle. + The value to edit. + Optional GUIStyle to use for the label. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make a toggle field where the toggle is to the left and the label immediately to the right of it. + + Label to display next to the toggle. + The value to edit. + Optional GUIStyle to use for the label. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make a toggle field where the toggle is to the left and the label immediately to the right of it. + + Label to display next to the toggle. + The value to edit. + Optional GUIStyle to use for the label. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make an X & Y field for entering a Vector2. + + Label to display above the field. + The value to edit. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> + + The value entered by the user. + + + + + Make an X & Y field for entering a Vector2. + + Label to display above the field. + The value to edit. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> + + The value entered by the user. + + + + + Make an X & Y integer field for entering a Vector2Int. + + Label to display above the field. + The value to edit. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make an X & Y integer field for entering a Vector2Int. + + Label to display above the field. + The value to edit. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make an X, Y & Z field for entering a Vector3. + + Label to display above the field. + The value to edit. + An optional list of layout options that specify extra layout + properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make an X, Y & Z field for entering a Vector3. + + Label to display above the field. + The value to edit. + An optional list of layout options that specify extra layout + properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make an X, Y & Z integer field for entering a Vector3Int. + + Label to display above the field. + The value to edit. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make an X, Y & Z integer field for entering a Vector3Int. + + Label to display above the field. + The value to edit. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Make an X, Y, Z & W field for entering a Vector4. + + Label to display above the field. + The value to edit. + An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The value entered by the user. + + + + + Disposable helper class for managing BeginVertical / EndVertical. + + + + + The rect of the vertical group. + + + + + Create a new VerticalScope and begin the corresponding vertical group. + + The style to use for background image and padding values. If left out, the background is transparent. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Create a new VerticalScope and begin the corresponding vertical group. + + The style to use for background image and padding values. If left out, the background is transparent. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Miscellaneous helper stuff for EditorGUI. + + + + + The width of the GUI area for the current EditorWindow or other view. + + + + + Is a text field currently editing text? + + + + + The minimum width in pixels reserved for the fields of Editor GUI controls. + + + + + Is the Editor GUI is hierarchy mode? + + + + + Is the user currently using the pro skin? (Read Only) + + + + + The width in pixels reserved for labels of Editor GUI controls. + + + + + The scale of GUI points relative to screen pixels for the current view + +This value is the number of screen pixels per point of interface space. For instance, 2.0 on retina displays. Note that the value may differ from one view to the next if the views are on monitors with different UI scales. + + + + + Get the height used for a single Editor control such as a one-line EditorGUI.TextField or EditorGUI.Popup. + + + + + Get the height used by default for vertical spacing between controls. + + + + + The system copy buffer. + + + + + True if a text field currently has focused and the text in it is selected. + + + + + Get a white texture. + + + + + Is the Editor GUI currently in wide mode? + + + + + Add a custom mouse pointer to a control. + + The rectangle the control should be shown within. + The mouse cursor to use. + ID of a target control. + + + + Add a custom mouse pointer to a control. + + The rectangle the control should be shown within. + The mouse cursor to use. + ID of a target control. + + + + Creates an event that can be sent to another window. + + The command to be sent. + + + + Draw a color swatch. + + The rectangle to draw the color swatch within. + The color to draw. + + + + Draw a curve swatch. + + The rectangle to draw the color swatch within. + The curve to draw. + The curve to draw as a SerializedProperty. + The color to draw the curve with. + The color to draw the background with. + Optional parameter to specify the range of the curve which should be included in swatch. + + + + Draw a curve swatch. + + The rectangle to draw the color swatch within. + The curve to draw. + The curve to draw as a SerializedProperty. + The color to draw the curve with. + The color to draw the background with. + Optional parameter to specify the range of the curve which should be included in swatch. + + + + Draw swatch with a filled region between two SerializedProperty curves. + + + + + + + + + + + Draw swatch with a filled region between two curves. + + + + + + + + + + + Get a texture from its source filename. + + + + + + Get one of the built-in GUI skins, which can be the game view, inspector or Scene view skin as chosen by the parameter. + + + + + + Layout list of string items left to right, top to bottom in the given area. + + Area where to layout the items. + Style for the items. + Extra horizontal spacing between successive items. + Extra vertical spacing between item rows. + Strings to layout. + + List of rectangles for the passed items. + + + + + Get the size that has been set using SetIconSize. + + + + + The controlID of the currently showing object picker. + + + + + The object currently selected in the object picker. + + + + + Does a given class have per-object thumbnails? + + + + + + Fetch the GUIContent from the Unity builtin resources with the given name. + + Name of the desired icon. + Tooltip for hovering over the icon. + + + + Fetch the GUIContent from the Unity builtin resources with the given name. + + Name of the desired icon. + Tooltip for hovering over the icon. + + + + Disposable scope helper for GetIconSize / SetIconSize. + + + + + Begin an IconSizeScope. + + Size to be used for icons rendered as GUIContent within this scope. + + + + Check if any enabled camera can render to a particular display. + + Display index. + + True if a camera will render to the display. + + + + + Load a built-in resource. + + + + + + Load a required built-in resource. + + + + + + Make all EditorGUI look like regular controls. + + Width to use for prefixed labels. + Width of text entries. + + + + + + Make all EditorGUI look like regular controls. + + Width to use for prefixed labels. + Width of text entries. + + + + + + Make all EditorGUI look like regular controls. + + Width to use for prefixed labels. + Width of text entries. + + + + + + Make all EditorGUI look like simplified outline view controls. + + + + + Return a GUIContent object with the name and icon of an Object. + + + + + + + Ping an object in the Scene like clicking it in an inspector. + + The object to be pinged. + + + + + Ping an object in the Scene like clicking it in an inspector. + + The object to be pinged. + + + + + Convert a position from pixel to point space. + + A GUI position in pixel space. + + A vector representing the same position in point space. + + + + + Convert a Rect from pixel space to point space. + + A GUI rect measured in pixels. + + A rect representing the same area in points. + + + + + Convert a Rect from point space to pixel space. + + A GUI rect measured in points. + + A rect representing the same area in pixels. + + + + + Converts a position from point to pixel space. + + A GUI position in point space. + + The same position in pixel space. + + + + + Send an input event into the game. + + + + + + Render all ingame cameras. + + The device coordinates to render all game cameras into. + Show gizmos as well. + + + + + + Render all ingame cameras. + + The device coordinates to render all game cameras into. + Show gizmos as well. + + + + + + Set icons rendered as part of GUIContent to be rendered at a specific size. + + + + + + Show the object picker from code. + + The object to be selected by default. + Is selection of Scene objects allowed, or should it only show assets. + Default search filter to apply. + The id of the control to set. This is useful if you are showing more than one of these. You can get the value at a later time. + + + + Utility functions for working with JSON data and engine objects. + + + + + Overwrite data in an object by reading from its JSON representation. + + The JSON representation of the object. + The object to overwrite. + + + + Generate a JSON representation of an object. + + The object to convert to JSON form. + If true, format the output for readability. If false, format the output for minimum size. Default is false. + + The object's data in JSON format. + + + + + Generate a JSON representation of an object. + + The object to convert to JSON form. + If true, format the output for readability. If false, format the output for minimum size. Default is false. + + The object's data in JSON format. + + + + + Stores and accesses Unity editor preferences. + + + + + Removes all keys and values from the preferences. Use with caution. + + + + + Removes key and its corresponding value from the preferences. + + + + + + Returns the value corresponding to key in the preference file if it exists. + + + + + + + Returns the value corresponding to key in the preference file if it exists. + + + + + + + Returns the float value corresponding to key if it exists in the preference file. + + Name of key to read float from. + Float value to return if the key is not in the storage. + + The float value stored in the preference file or the defaultValue id the + requested float does not exist. + + + + + Returns the float value corresponding to key if it exists in the preference file. + + Name of key to read float from. + Float value to return if the key is not in the storage. + + The float value stored in the preference file or the defaultValue id the + requested float does not exist. + + + + + Returns the value corresponding to key in the preference file if it exists. + + Name of key to read integer from. + Integer value to return if the key is not in the storage. + + The value stored in the preference file. + + + + + Returns the value corresponding to key in the preference file if it exists. + + Name of key to read integer from. + Integer value to return if the key is not in the storage. + + The value stored in the preference file. + + + + + Returns the value corresponding to key in the preference file if it exists. + + + + + + + Returns the value corresponding to key in the preference file if it exists. + + + + + + + Returns true if key exists in the preferences file. + + Name of key to check for. + + The existence or not of the key. + + + + + Sets the value of the preference identified by key. + + + + + + + Sets the float value of the preference identified by key. + + Name of key to write float into. + Float value to write into the storage. + + + + Sets the value of the preference identified by key as an integer. + + Name of key to write integer to. + Value of the integer to write into the storage. + + + + Sets the value of the preference identified by key. Note that EditorPrefs does not support null strings and will store an empty string instead. + + + + + + + The editor selected render mode for Scene View selection. + + + + + The Renderer has no selection highlight or wireframe in the Editor. + + + + + The Renderer has selection highlight but no wireframe in the Editor. + + + + + The Renderer has wireframe but not selection highlight in the Editor. + + + + + Enum that selects which skin to return from EditorGUIUtility.GetBuiltinSkin. + + + + + The skin used for game views. + + + + + The skin used for inspectors. + + + + + The skin used for Scene views. + + + + + Common GUIStyles used for EditorGUI controls. + + + + + Bold font. + + + + + Style for bold label. + + + + + Style for label with small font which is centered and grey. + + + + + Style used for headings for Color fields. + + + + + Style used for headings for EditorGUI.Foldout. + + + + + Style used for headings for EditorGUI.Foldout. + + + + + Style used for background box for EditorGUI.HelpBox. + + + + + Wrap content in a vertical group with this style to get the default margins used in the Inspector. + + + + + Wrap content in a vertical group with this style to get full width margins in the Inspector. + + + + + Style used for the labelled on all EditorGUI overloads that take a prefix label. + + + + + Style for label with large font. + + + + + Style used for headings for Layer masks. + + + + + Mini Bold font. + + + + + Style for mini bold label. + + + + + Style used for a standalone small button. + + + + + Style used for the leftmost button in a horizontal button group. + + + + + Style used for the middle buttons in a horizontal group. + + + + + Style used for the rightmost button in a horizontal group. + + + + + Mini font. + + + + + Style for label with small font. + + + + + Style used for the drop-down controls. + + + + + Smaller text field. + + + + + Style used for field editors for numbers. + + + + + Style used for headings for object fields. + + + + + Style used for object fields that have a thumbnail (e.g Textures). + + + + + Style used for headings for the Select button in object fields. + + + + + Style used for EditorGUI.Popup, EditorGUI.EnumPopup,. + + + + + Style used for a radio button. + + + + + Standard font. + + + + + Style used for EditorGUI.TextArea. + + + + + Style used for EditorGUI.TextField. + + + + + Style used for headings for EditorGUI.Toggle. + + + + + Style used for headings for EditorGUILayout.BeginToggleGroup. + + + + + Toolbar background from top of windows. + + + + + Style for Button and Toggles in toolbars. + + + + + Toolbar Dropdown. + + + + + Toolbar Popup. + + + + + Toolbar text field. + + + + + Style for white bold label. + + + + + Style for white label. + + + + + Style for white large label. + + + + + Style for white mini label. + + + + + Style for word wrapped label. + + + + + Style for word wrapped mini label. + + + + + User build settings for the Editor + + + + + The currently active build target. + + + + + Triggered in response to SwitchActiveBuildTarget. + + + + + DEFINE directives for the compiler. + + + + + Enable source-level debuggers to connect. + + + + + Android platform options. + + + + + Set which build system to use for building the Android package. + + + + + Set to true to create a symbols.zip file in the same location as the .apk or .aab file. + + + + + ETC2 texture decompression fallback on Android devices that don't support ETC2. + + + + + Use deprecated Android SDK tools to pack application. + + + + + Set to true to build an Android App Bundle (aab file) instead of an apk. The default value is false. + + + + + Is build script only enabled. + + + + + Compress files in package. + + + + + Build data compressed with PSArc. + + + + + Start the player with a connection to the profiler. + + + + + Enables a development build. + + + + + Enables a Linux headless build. + + + + + Are array bounds actively validated? + + + + + Are divide by zero's actively validated? + + + + + Are null references actively validated? + + + + + Export Android Project for use with Android Studio/Gradle. + + + + + Force installation of package, even if error. + + + + + Force full optimizations for script complilation in Development builds. + + + + + Place the built player in the build folder. + + + + + Scheme with which the project will be run in Xcode. + + + + + Places the package on the outer edge of the disk. + + + + + Build submission materials. + + + + + PS4 Build Subtarget. + + + + + Specifies which version of PS4 hardware to target. + + + + + The currently selected build target group. + + + + + The currently selected target for a standalone build. + + + + + When building an Xbox One Streaming Install package (makepkg.exe) The layout generation code in Unity will assign each Scene and associated assets to individual chunks. Unity will mark Scene 0 as being part of the launch range, IE the set of chunks required to launch the game, you may include additional Scenes in this launch range if you desire, this specifies a range of Scenes (starting at 0) to be included in the launch set. + + + + + Symlink runtime libraries with an iOS Xcode project. + + + + + Use prebuilt JavaScript version of Unity engine. + + + + + Generate and reference C# projects from your main solution. + + + + + Enable an application to connect to a remote HoloLens device and stream holographic content. + + + + + Sets and gets target device type for the application to run on when building to Windows Store platform. + + + + + Sets and gets target UWP SDK to build Windows Store application against. + + + + + Sets and gets Visual Studio version to build Windows Store application with. + + + + + Xbox Build subtarget. + + + + + The currently selected Xbox One Deploy Drive. + + + + + The currently selected Xbox One Deploy Method. + + + + + Network shared folder path e.g. +MYCOMPUTER\SHAREDFOLDER\. + + + + + Sets the XBox to reboot and redeploy when the deployment fails. + + + + + Windows account username associated with PC share folder. + + + + + Get the current location for the build. + + + + + + Returns value for platform specifc Editor setting. + + The name of the platform. + The name of the setting. + + + + Is .NET Native enabled for specific build configuration. +More information - https:msdn.microsoft.comen-uslibrary/dn584397(v=vs.110).aspx. + + Build configuration. + + True if .NET Native is enabled for the specific build configuration. + + + + + Set a new location for the build. + + + + + + + Set platform specifc Editor setting. + + The name of the platform. + The name of the setting. + Setting value. + + + + Enables or Disables .NET Native for specific build configuration. +More information - https:msdn.microsoft.comen-uslibrary/dn584397(v=vs.110).aspx. + + Build configuration. + Is enabled? + + + + Select a new build target to be active. + + Target build platform. + Build target group. + + True if the build target was successfully switched, false otherwise (for example, if license checks fail, files are missing, or if the user has cancelled the operation via the UI). + + + + + Select a new build target to be active. + + Target build platform. + Build target group. + + True if the build target was successfully switched, false otherwise (for example, if license checks fail, files are missing, or if the user has cancelled the operation via the UI). + + + + + Select a new build target to be active during the next Editor update. + + Target build platform. + Build target group. + + True if the build target was successfully switched, false otherwise (for example, if license checks fail, files are missing, or if the user has cancelled the operation via the UI). + + + + + Editor utility functions. + + + + + True if there are any compilation error messages in the log. + + + + + Removes progress bar. + + + + + Collect all objects in the hierarchy rooted at each of the given objects. + + Array of objects where the search will start. + + Array of objects heirarchically attached to the search array. + + + + + Calculates and returns a list of all assets the assets listed in roots depend on. + + + + + + Compress a cubemap texture. + + + + + + + + Compress a cubemap texture. + + + + + + + + Compress a texture. + + + + + + + + Compress a texture. + + + + + + + + Copy all settings of a Unity Object. + + + + + + + Copy all settings of a Unity Object to a second Object if they differ. + + + + + + + Copies the serializable fields from one managed object to another. + + The object to copy data from. + The object to copy data to. + + + + Creates a game object with HideFlags and specified components. + + + + + + + + Displays or updates a progress bar that has a cancel button. + + + + + + + + Displays a modal dialog. + + The title of the message box. + The text of the message. + Label displayed on the OK dialog button. + Label displayed on the Cancel dialog button. + + + + Displays a modal dialog. + + The title of the message box. + The text of the message. + Label displayed on the OK dialog button. + Label displayed on the Cancel dialog button. + + + + Displays a modal dialog with three buttons. + + Title for dialog. + Purpose for the dialog. + Dialog function chosen. + Close dialog with no operation. + Choose alternative dialog purpose. + + The id of the chosen button. + + + + + Displays a popup menu. + + + + + + + + Displays or updates a progress bar. + + + + + + + + Saves an AudioClip or MovieTexture to a file. + + + + + + + Brings the project window to the front and focuses it. + + + + + Returns a text for a number of bytes. + + + + + + Is the object enabled (0 disabled, 1 enabled, -1 has no enabled button). + + + + + + Translates an instance ID to a reference to an object. + + + + + + Determines if an object is stored on disk. + + + + + + Human-like sorting. + + + + + + + Displays the "open file" dialog and returns the selected path name. + + + + + + + + Displays the "open file" dialog and returns the selected path name. + + Title for dialog. + Default directory. + File extensions in form { "Image files", "png,jpg,jpeg", "All files", "*" }. + + + + Displays the "open folder" dialog and returns the selected path name. + + + + + + + + Displays the "save file" dialog and returns the selected path name. + + + + + + + + + Displays the "save file" dialog in the Assets folder of the project and returns the selected path name. + + + + + + + + + Displays the "save folder" dialog and returns the selected path name. + + + + + + + + Sets this camera to allow animation of materials in the Editor. + + + + + + + Sets the global time for this camera to use when rendering. + + + + + + + Marks target object as dirty. (Only suitable for non-scene objects). + + The object to mark as dirty. + + + + Set the enabled state of the object. + + + + + + + Set the Scene View selected display mode for this Renderer. + + + + + + + Sets whether the selected Renderer's wireframe will be hidden when the GameObject it is attached to is selected. + + + + + + + Unloads assets that are not used. + + When true delete assets even if linked in scripts. + + + + Unloads assets that are not used. + + When true delete assets even if linked in scripts. + + + + Updates the global shader properties to use when rendering. + + Time to use. -1 to disable. + + + + Derive from this class to create an editor window. + + + + + Does the window automatically repaint whenever the Scene has changed? + + + + + The EditorWindow which currently has keyboard focus. (Read Only) + + + + + Is this window maximized? + + + + + The maximum size of this window. + + + + + The minimum size of this window. + + + + + The EditorWindow currently under the mouse cursor. (Read Only) + + + + + The desired position of the window in screen space. + + + + + The title of this window. + + + + + The GUIContent used for drawing the title of EditorWindows. + + + + + Checks whether MouseEnterWindow and MouseLeaveWindow events are received in the GUI in this Editor window. + + + + + Checks whether MouseMove events are received in the GUI in this Editor window. + + + + + Mark the beginning area of all popup windows. + + + + + Close the editor window. + + + + + Close a window group started with EditorWindow.BeginWindows. + + + + + Moves keyboard focus to another EditorWindow. + + + + + Focuses the first found EditorWindow of specified type if it is open. + + The type of the window. Must derive from EditorWindow. + + + + Focuses the first found EditorWindow of type T if it is open. + + The type of the window. Must derive from EditorWindow. + + + + Returns the first EditorWindow of type t which is currently on the screen. + + The type of the window. Must derive from EditorWindow. + Set this to true, to create a floating utility window, false to create a normal window. + If GetWindow creates a new window, it will get this title. If this value is null, use the class name as title. + Whether to give the window focus, if it already exists. (If GetWindow creates a new window, it will always get focus). + + + + Returns the first EditorWindow of type t which is currently on the screen. + + The type of the window. Must derive from EditorWindow. + Set this to true, to create a floating utility window, false to create a normal window. + If GetWindow creates a new window, it will get this title. If this value is null, use the class name as title. + Whether to give the window focus, if it already exists. (If GetWindow creates a new window, it will always get focus). + + + + Returns the first EditorWindow of type t which is currently on the screen. + + The type of the window. Must derive from EditorWindow. + Set this to true, to create a floating utility window, false to create a normal window. + If GetWindow creates a new window, it will get this title. If this value is null, use the class name as title. + Whether to give the window focus, if it already exists. (If GetWindow creates a new window, it will always get focus). + + + + Returns the first EditorWindow of type t which is currently on the screen. + + The type of the window. Must derive from EditorWindow. + Set this to true, to create a floating utility window, false to create a normal window. + If GetWindow creates a new window, it will get this title. If this value is null, use the class name as title. + Whether to give the window focus, if it already exists. (If GetWindow creates a new window, it will always get focus). + + + + Returns the first EditorWindow of type T which is currently on the screen. + + The type of the window. Must derive from EditorWindow. + Set this to true, to create a floating utility window, false to create a normal window. + If GetWindow creates a new window, it will get this title. If this value is null, use the class name as title. + Whether to give the window focus, if it already exists. (If GetWindow creates a new window, it will always get focus). + + + + Returns the first EditorWindow of type T which is currently on the screen. + + The type of the window. Must derive from EditorWindow. + Set this to true, to create a floating utility window, false to create a normal window. + If GetWindow creates a new window, it will get this title. If this value is null, use the class name as title. + Whether to give the window focus, if it already exists. (If GetWindow creates a new window, it will always get focus). + + + + Returns the first EditorWindow of type T which is currently on the screen. + + The type of the window. Must derive from EditorWindow. + Set this to true, to create a floating utility window, false to create a normal window. + If GetWindow creates a new window, it will get this title. If this value is null, use the class name as title. + Whether to give the window focus, if it already exists. (If GetWindow creates a new window, it will always get focus). + + + + Returns the first EditorWindow of type T which is currently on the screen. + + The type of the window. Must derive from EditorWindow. + Set this to true, to create a floating utility window, false to create a normal window. + If GetWindow creates a new window, it will get this title. If this value is null, use the class name as title. + Whether to give the window focus, if it already exists. (If GetWindow creates a new window, it will always get focus). + + + + Returns the first EditorWindow of type T which is currently on the screen. + + The type of the window. Must derive from EditorWindow. + Set this to true, to create a floating utility window, false to create a normal window. + If GetWindow creates a new window, it will get this title. If this value is null, use the class name as title. + Whether to give the window focus, if it already exists. (If GetWindow creates a new window, it will always get focus). + + + + Returns the first EditorWindow of type T which is currently on the screen. + + The type of the window. Must derive from EditorWindow. + Set this to true, to create a floating utility window, false to create a normal window. + If GetWindow creates a new window, it will get this title. If this value is null, use the class name as title. + Whether to give the window focus, if it already exists. (If GetWindow creates a new window, it will always get focus). + + + + Returns the first EditorWindow of type T which is currently on the screen. + + The type of the window. Must derive from EditorWindow. + If GetWindow creates a new window, it will get this title. If this value is null, use the class name as title. + An array of EditorWindow types that the window will attempt to dock onto. + Whether to give the window focus, if it already exists. (If GetWindow creates a new window, it will always get focus). + + + + Returns the first EditorWindow of type T which is currently on the screen. + + The type of the window. Must derive from EditorWindow. + If GetWindow creates a new window, it will get this title. If this value is null, use the class name as title. + An array of EditorWindow types that the window will attempt to dock onto. + Whether to give the window focus, if it already exists. (If GetWindow creates a new window, it will always get focus). + + + + Returns the first EditorWindow of type T which is currently on the screen. + + The type of the window. Must derive from EditorWindow. + If GetWindow creates a new window, it will get this title. If this value is null, use the class name as title. + An array of EditorWindow types that the window will attempt to dock onto. + Whether to give the window focus, if it already exists. (If GetWindow creates a new window, it will always get focus). + + + + Returns the first EditorWindow of type t which is currently on the screen. + + The type of the window. Must derive from EditorWindow. + The position on the screen where a newly created window will show. + Set this to true, to create a floating utility window, false to create a normal window. + If GetWindow creates a new window, it will get this title. If this value is null, use the class name as title. + + + + Returns the first EditorWindow of type t which is currently on the screen. + + The type of the window. Must derive from EditorWindow. + The position on the screen where a newly created window will show. + Set this to true, to create a floating utility window, false to create a normal window. + If GetWindow creates a new window, it will get this title. If this value is null, use the class name as title. + + + + Returns the first EditorWindow of type t which is currently on the screen. + + The type of the window. Must derive from EditorWindow. + The position on the screen where a newly created window will show. + Set this to true, to create a floating utility window, false to create a normal window. + If GetWindow creates a new window, it will get this title. If this value is null, use the class name as title. + + + + Returns the first EditorWindow of type t which is currently on the screen. + + The type of the window. Must derive from EditorWindow. + The position on the screen where a newly created window will show. + Set this to true, to create a floating utility window, false to create a normal window. + If GetWindow creates a new window, it will get this title. If this value is null, use the class name as title. + Whether to give the window focus, if it already exists. (If GetWindow creates a new window, it will always get focus). + + + + Returns the first EditorWindow of type t which is currently on the screen. + + The type of the window. Must derive from EditorWindow. + The position on the screen where a newly created window will show. + Set this to true, to create a floating utility window, false to create a normal window. + If GetWindow creates a new window, it will get this title. If this value is null, use the class name as title. + Whether to give the window focus, if it already exists. (If GetWindow creates a new window, it will always get focus). + + + + Returns the first EditorWindow of type t which is currently on the screen. + + The type of the window. Must derive from EditorWindow. + The position on the screen where a newly created window will show. + Set this to true, to create a floating utility window, false to create a normal window. + If GetWindow creates a new window, it will get this title. If this value is null, use the class name as title. + Whether to give the window focus, if it already exists. (If GetWindow creates a new window, it will always get focus). + + + + Returns the first EditorWindow of type t which is currently on the screen. + + The type of the window. Must derive from EditorWindow. + The position on the screen where a newly created window will show. + Set this to true, to create a floating utility window, false to create a normal window. + If GetWindow creates a new window, it will get this title. If this value is null, use the class name as title. + Whether to give the window focus, if it already exists. (If GetWindow creates a new window, it will always get focus). + + + + Stop showing notification message. + + + + + Make the window repaint. + + + + + Sends an Event to a window. + + + + + + Show the EditorWindow window. + + Immediately display Show. + + + + Show the EditorWindow window. + + Immediately display Show. + + + + Shows a window with dropdown behaviour and styling. + + The button from which the position of the window will be determined (see description). + The initial size of the window. + + + + Show the editor window in the auxiliary window. + + + + + Show a notification message. + + + + + + Shows an Editor window using popup-style framing. + + + + + Show the EditorWindow as a floating utility window. + + + + + Editor tools for working with persistent UnityEvents. + + + + + Adds a persistent, preset call to the listener. + + Event to modify. + Function to call. + Argument to use when invoking. + + + + Adds a persistent, preset call to the listener. + + Event to modify. + Function to call. + Argument to use when invoking. + + + + Adds a persistent, preset call to the listener. + + Event to modify. + Function to call. + Argument to use when invoking. + + + + Adds a persistent, preset call to the listener. + + Event to modify. + Function to call. + Argument to use when invoking. + + + + Adds a persistent, call to the listener. Will be invoked with the arguments as defined by the Event and sent from the call location. + + Event to modify. + Function to call. + + + + Adds a persistent, call to the listener. Will be invoked with the arguments as defined by the Event and sent from the call location. + + Event to modify. + Function to call. + + + + Adds a persistent, call to the listener. Will be invoked with the arguments as defined by the Event and sent from the call location. + + Event to modify. + Function to call. + + + + Adds a persistent, call to the listener. Will be invoked with the arguments as defined by the Event and sent from the call location. + + Event to modify. + Function to call. + + + + Adds a persistent, call to the listener. Will be invoked with the arguments as defined by the Event and sent from the call location. + + Event to modify. + Function to call. + + + + Adds a persistent, call to the listener. Will be invoked with the arguments as defined by the Event and sent from the call location. + + Event to modify. + Function to call. + + + + Adds a persistent, preset call to the listener. + + Event to modify. + Function to call. + Argument to use when invoking. + + + + Adds a persistent, preset call to the listener. + + Event to modify. + Function to call. + + + + Modifies the event at the given index. + + Event to modify. + Index to modify. + Function to call. + Argument to use when invoking. + + + + Modifies the event at the given index. + + Event to modify. + Index to modify. + Function to call. + Argument to use when invoking. + + + + Modifies the event at the given index. + + Event to modify. + Index to modify. + Function to call. + Argument to use when invoking. + + + + Modifies the event at the given index. + + Event to modify. + Index to modify. + Function to call. + Argument to use when invoking. + + + + Modifies the event at the given index. + + Event to modify. + Index to modify. + Function to call. + + + + Modifies the event at the given index. + + Event to modify. + Index to modify. + Function to call. + + + + Modifies the event at the given index. + + Event to modify. + Index to modify. + Function to call. + + + + Modifies the event at the given index. + + Event to modify. + Index to modify. + Function to call. + + + + Modifies the event at the given index. + + Event to modify. + Index to modify. + Function to call. + + + + Modifies the event at the given index. + + Event to modify. + Index to modify. + Function to call. + Argument to use when invoking. + + + + Modifies the event at the given index. + + Event to modify. + Index to modify. + Function to call. + + + + Removes the given function from the event. + + Event to modify. + Index to remove (if specified). + Function to remove (if specified). + + + + Removes the given function from the event. + + Event to modify. + Index to remove (if specified). + Function to remove (if specified). + + + + Removes the given function from the event. + + Event to modify. + Index to remove (if specified). + Function to remove (if specified). + + + + Removes the given function from the event. + + Event to modify. + Index to remove (if specified). + Function to remove (if specified). + + + + Removes the given function from the event. + + Event to modify. + Index to remove (if specified). + Function to remove (if specified). + + + + Removes the given function from the event. + + Event to modify. + Index to remove (if specified). + Function to remove (if specified). + + + + Unregisters the given listener at the specified index. + + Event to modify. + Index to unregister. + + + + Defines the import context for scripted importers during an import event. + + + + + The path of the source asset file to be imported. + + + + + The main object set on the AssetImportContext. + + + + + This indicates what platform the import event is targeting. + + + + + Adds an object to the result of the import operation. + + A unique identifier associated to this object. + The Unity Object to add to the asset. + An optional 2D texture to use as the thumbnail for this object. + + + + Adds an object to the result of the import operation. + + A unique identifier associated to this object. + The Unity Object to add to the asset. + An optional 2D texture to use as the thumbnail for this object. + + + + Creates dependency between the asset and a source asset. + + The path of the source dependency. + + + + Gets the list of objects set on the AssetImportContext. + + The list of objects to be filled by the context. + + + + Logs an error message encountered during import. + + The error message. + Optional Object that is targeted by the error. + + + + Logs a warning message encountered during import. + + The warning message. + Optional Object that is targeted by the warning. + + + + Sets the main object for import. + + The object to be set as the main object. This object must already be added with the AddObjectToAsset method. + + + + Default editor for all asset importer settings. + + + + + Should imported object be shown as a separate editor? + + + + + Determines if the asset preview is handled by the AssetEditor or the Importer DrawPreview + + + + + Saves any changes from the Editor's control into the asset's import settings object. + + + + + Implements the 'Apply' button of the inspector. + + Text to display on button. + + Returns true if the new settings were successfully applied + + + + + Implements the 'Apply' button of the inspector. + + Text to display on button. + + Returns true if the new settings were successfully applied + + + + + Add's the 'Apply' and 'Revert' buttons to the editor. + + + + + This function is called when the Editor script is started. + + + + + Determine if the import settings have been modified. + + + + + Process the 'Apply' and 'Revert' buttons. + + + Returns true if the new settings were successfully applied. + + + + + This function is called when the editor object goes out of scope. + + + + + This function is called when the object is loaded. + + + + + Reset the import settings to their last saved values. + + + + + Implements the 'Revert' button of the inspector. + + Text to display on button. + + + + Implements the 'Revert' button of the inspector. + + Text to display on button. + + + + Abstract base class for custom Asset importers. + + + + + This method must by overriden by the derived class and is called by the Asset pipeline to import files. + + This argument contains all the contextual information needed to process the import event and is also used by the custom importer to store the resulting Unity Asset. + + + + Override this method if your ScriptedImporter supports remapping specific asset types. + + The type of asset to check. + + Returns true if the importer supports remapping the given type. Otherwise, returns false. + + + + + Class attribute used to register a custom asset importer derived from ScriptedImporter with Unity's Asset import pipeline. + + + + + List of file extensions, without leading period character, that the scripted importer handles. + + + + + Gives control over ordering of asset import based on types. Positive values delay the processing of source asset files while Negative values place them earlier in the import process. + + + + + Importer version number that is used by the import layer to detect new version of the importer and trigger re-imports when such events occur, to apply latest changes made to the scripted imrpoter. + + + + + Use the ScriptedImporter attribute to register a custom importer derived from ScriptedImporter with Unity's Asset import pipeline. + +It is best practice to always increment a scripted importer's version number whenever the script is changed. This forces assets imported with lower version numbers to be re-imported. + +If the Unity Editor setting "Auto-Update" is set to enabled, editing a script outside of the editor and saving it will trigger both a re-import of the script and all assets of the corresponding type. + + A number that is used by the import pipeline to detect new versions of the importer script. Changing this number will trigger a re-import of all assets matching the listed extensions. + List of file extensions (without leading period character) that the scripted importer handles. + Single file extension (without leading period character) that the scripted importer handles. + Gives control over ordering of asset import based on types. Positive values delay the processing of source asset files while negative values place them earlier in the import process. + + + + Use the ScriptedImporter attribute to register a custom importer derived from ScriptedImporter with Unity's Asset import pipeline. + +It is best practice to always increment a scripted importer's version number whenever the script is changed. This forces assets imported with lower version numbers to be re-imported. + +If the Unity Editor setting "Auto-Update" is set to enabled, editing a script outside of the editor and saving it will trigger both a re-import of the script and all assets of the corresponding type. + + A number that is used by the import pipeline to detect new versions of the importer script. Changing this number will trigger a re-import of all assets matching the listed extensions. + List of file extensions (without leading period character) that the scripted importer handles. + Single file extension (without leading period character) that the scripted importer handles. + Gives control over ordering of asset import based on types. Positive values delay the processing of source asset files while negative values place them earlier in the import process. + + + + Use the ScriptedImporter attribute to register a custom importer derived from ScriptedImporter with Unity's Asset import pipeline. + +It is best practice to always increment a scripted importer's version number whenever the script is changed. This forces assets imported with lower version numbers to be re-imported. + +If the Unity Editor setting "Auto-Update" is set to enabled, editing a script outside of the editor and saving it will trigger both a re-import of the script and all assets of the corresponding type. + + A number that is used by the import pipeline to detect new versions of the importer script. Changing this number will trigger a re-import of all assets matching the listed extensions. + List of file extensions (without leading period character) that the scripted importer handles. + Single file extension (without leading period character) that the scripted importer handles. + Gives control over ordering of asset import based on types. Positive values delay the processing of source asset files while negative values place them earlier in the import process. + + + + Use the ScriptedImporter attribute to register a custom importer derived from ScriptedImporter with Unity's Asset import pipeline. + +It is best practice to always increment a scripted importer's version number whenever the script is changed. This forces assets imported with lower version numbers to be re-imported. + +If the Unity Editor setting "Auto-Update" is set to enabled, editing a script outside of the editor and saving it will trigger both a re-import of the script and all assets of the corresponding type. + + A number that is used by the import pipeline to detect new versions of the importer script. Changing this number will trigger a re-import of all assets matching the listed extensions. + List of file extensions (without leading period character) that the scripted importer handles. + Single file extension (without leading period character) that the scripted importer handles. + Gives control over ordering of asset import based on types. Positive values delay the processing of source asset files while negative values place them earlier in the import process. + + + + Default editor for source assets handled by Scripted Importers. + + + + + Implement this method to customize how Unity's Asset inspector is drawn for an Asset managed by a ScriptedImporter. + + + + + Original texture data information. + + + + + Determines if alpha channel is present in image data. + + + + + Determines if image has HDR data. + + + + + Height of the image data. + + + + + Width of the image data. + + + + + Struct that represents how Sprite asset should be generated when calling TextureGenerator.GenerateTexture. + + + + + Pivot value represented by SpriteAlignment. + + + + + Border value for the generated Sprite. + + + + + Name for the generated Sprite. + + + + + Sprite Asset creation uses this outline when it generates the Mesh for the Sprite. If this is not given, SpriteImportData.tesselationDetail will be used to determine the mesh detail. + + + + + Pivot value represented in Vector2. + + + + + Position and size of the Sprite in a given texture. + + + + + An identifier given to a Sprite. Use this to identify which data was used to generate that Sprite. + + + + + Controls mesh generation detail. This value will be ignored if SpriteImportData.ouline is provided. + + + + + Structure that represents the result from calling TextureGenerator.GenerateTexture. + + + + + Warnings that should be shown in Inspector after generating a Texture. + + + + + TextureGenerator.GenerateTexture reports warnings when you generate a Texture. + + + + + Sprites that are generated by TextureGenerator.GenerateTexture from TextureGenerationSettings.spriteSheetData. + + + + + This is a Texture2D generated by TextureGenerator.GenerateTexture from TextureGenerationSettings.imageData. + + + + + Thumbnail version of the generated texture. + + + + + Represents how a texture should be generated from calling TextureGenerator.GenerateTexture. + + + + + Path where the Asset will be placed. + + + + + When set to true, AssetPostprocessor hooks will be called during texture generation. + + + + + Platform settings for generating the texture. + + + + + Indicates if the Sprite generated can be used for atlas packing. + + + + + Texture format for the image data. + + + + + Sprite Asset generation data. + + + + + Tag used for Sprite packing. + + + + + Settings for generating texture. + + + + + The Constructor initializes to most common value based on the TetureImporterType you pass in. + + Texture type. + + + + Experimental utilities for generating Texture2D. + + + + + Generates Texture2D and Sprite Assets based on the settings provided. + + Settings use for generating Texture2D and Sprite. + Color buffer for generating Texture2D and Sprite. + + Result of the generation. + + + + + Experimental lightmapping features. + + + + + If enabled ignores the direct contribution from the environment lighting in baked probes. + + + + + Retrieve the custom bake results. + + The unnormalized amount of sky visibility for the input points (in xyz). The w component is the fraction of rays that strike backfaces. + + True if the results were retrieved. False if there is no data available or the results array does not match the number of points in the bake. + + + + + Set the custom bake inputs. + + The positions (xyz) of the points for which the amount of sky visibility is calculated. The w component is an offset that will be applied to the ray originating at the position. + The number of samples on the upper hemisphere used to calculate the sky visibility. + + + + This class contains methods to draw IMGUI Editor UI that relates to the Player Connection. + + + + + Display a drop-down button and menu for the user to choose and establish a connection to a Player. + + Where to draw the drop-down button. + The state for the connection that is used in the EditorWindow displaying this drop-down. Use Experimental.Networking.PlayerConnection.EditorGUIUtility.GetAttachToPlayerState to get a state in OnEnable and remeber to dispose of that state in OnDisable. + Define the GUIStyle the drop-down button should be drawn in. A default drop-down button will be drawn if no style is specified. + + + + This class contains methods to draw and automatically layout IMGUI Editor UI that relates to the Player Connection. + + + + + Display a drop-down button and menu for the user to choose and establish a connection to a Player. + + The state for the connection that is used in the EditorWindow displaying this drop-down. Use Experimental.Networking.PlayerConnection.EditorGUIUtility.GetAttachToPlayerState to get a state in OnEnable and remembe to dispose of that state in OnDisable. + Define the GUIStyle the drop-down button should be drawn in. A default drop-down button will be drawn if non is specified. + + + + Miscellaneous helper methods for Experimental.Networking.PlayerConnection.EditorGUI. + + + + + This method generates a state tracking object for establishing and displaying an Editor to Player Connection. + + The EditorWindow that will use the connection. + A callback that is fired whenever a user-initiated connection-attempt succeeds. + + The not serialized state of the connection to a Player, to be used in Experimental.Networking.PlayerConnection.EditorGUI.AttachToPlayerDropdown or Experimental.Networking.PlayerConnection.EditorGUILayout.AttachToPlayerDropdown. It knows what target is currently connected and what targets are available. + + + + + Defines the required members for a ScriptableBakedReflectionSystem implementation. + + + + + Number of stages of the baking process. + + + + + The hash of the current baked state of the ScriptableBakedReflectionSystem. + + + + + Implement this method to bake all of the loaded reflection probes. + + + True when the probe where baked, false when baking was not completed. + + + + + Cancel the running bake jobs. + + + + + Clear the state of the ScriptableBakedReflectionSystem. + + + + + Synchronize the baked data with the actual components and rendering settings. + + + + + This method is called every Editor update until the ScriptableBakedReflectionSystem indicates that the baking is complete, with handle.SetIsDone(true). (See IScriptableBakedReflectionSystemStageNotifier.SetIsDone). + + Current Scene state hash. + A handle to receive notifications about the status of the stages of the baking process. + + + + An implementation of this interface is provided while ticking an ScriptableBakedReflectionSystem. (See IScriptableBakedReflectionSystem.Tick). + + + + + Update the baking stage progress information. + + The current stage in progress. + The progress message to display. + The progress to report (between 0 and 1). + + + + Indicates that a stage is complete. + + The completed stage. + + + + Indicates whether the baking is complete. + + Whether the baking is complete. + + + + This class contains hashes that represents the Scene state. + + + + + A hash representing the state of the ambient probe. + + + + + A hash representing the state of Scene objects. + + + + + A hash representing the settings of the sky. + + + + + Empty implementation of IScriptableBakedReflectionSystem. + + + + + Number of stages of the baking process. + + + + + The hash of the current baked state of the ScriptableBakedReflectionSystem. + + + + + Implement this method to bake all of the loaded reflection probes. + + + True when the probe where baked, false when baking was not completed. + + + + + Cancel the running bake jobs. + + + + + Clear the state of ScriptableBakedReflectionSystem. + + + + + Synchronize the baked data with the actual components and rendering settings. + + + + + This method is called during the Editor update until the ScriptableBakedReflectionSystem indicates that the baking is complete, with handle.SetIsDone(true). (See IScriptableBakedReflectionSystemStageNotifier.SetIsDone). + + Current Scene state hash. + A handle to receive notifications about the status of the stages of the baking process. + + + + Global settings for the scriptable baked reflection system. + + + + + The currently active ScriptableBakedReflectionSystem, see IScriptableBakedReflectionSystem. + + + + + Experimental class that represents a Prefab stage. + + + + + The path of the Prefab Asset that is open in this Prefab stage. + + + + + The root GameObject of the loaded Prefab Asset contents. + + + + + Callback that is invoked whenever the contents of a Prefab stage has been saved. + + + + + + Callback that's invoked whenever the contents of a Prefab stage is about to be saved. + + + + + + Callback that's invoked whenever a Prefab stage is about to be opened. + + + + + + Callback that's invoked whenever a Prefab stage has been opened. + + + + + + The preview Scene used for the Prefab stage. + + + + + The Stage handle for the Prefab stage. + + + + + Clear the dirtyness flag for the Prefab stage. + + + + + Is this GameObject part of the loaded Prefab Asset contents in the Prefab stage? + + The GameObject to check. + + True if the GameObject is part of the Prefab contents. + + + + + Utility methods related to Prefab stages. + + + + + Get the current Prefab stage, or null if there is none. + + + The current Prefab stage or null. + + + + + Get the Prefab stage which contains the given GameObject. + + The GameObject to check. + + The containing Prefab stage. + + + + + Flags that toggle which brush controls are displayed when calling [IOnInspectorGUI.ShowBrushesGUI]. + + + + + Display all brush controls. + + + + + Display the brush inspector for the currently selected brush. + + + + + Display the brush opacity control. + + + + + Display the brush selection control. + + + + + Display the brush selection control, and the brush inspector for the currently selected brush. + + + + + Interface that provides parameters and utility functions for the OnInspectorGUI event in the terrain paint tools. + + + + + Instructs the Editor to repaint the tool UI and/or the scene view. + + What to repaint. + + + + Displays the default controls for the brush in the tool inspector. + + Pixel spacing for the brush GUI controls. + + + + Interface that provides parameters and utility functions for the OnPaint event of the terrain paint tools. + + + + + Read Only. Current brush size in terrain units (equivalent size to world units). + + + + + Read Only. Current brush strength. + + + + + Read Only. Current selected brush texture. + + + + + Read Only. The normalized position (between 0 and 1) on the active terrain. + + + + + Instructs the Editor to repaint the tool UI and/or the scene view. + + What to repaint. + + + + Instructs the Editor to repaint the inspector UI. + + + + + Interface that provides parameters and utility functions for the OnSceneGUI event of the terrain paint tools. + + + + + Read only. Current brush size in terrain units (equivalent size to world units). + + + + + Read only. Current brush strength. + + + + + Read only. Current selected brush texture. + + + + + Read only. True if the mouse is over a valid Terrain object; otherwise false. + + + + + Read only. The raycast result for the current mouse position. This is valid when hitValidTerrain is true. + + + + + Read only. SceneView object. + + + + + Instructs the Editor to repaint the tool UI and/or the scene view. + + What to repaint. + + + + Flags that indicate what to repaint on the Terrain tools. + + + + + Indicates to Unity to repaint the scene view. + + + + + Indicates to Unity to repaint the tool UI. + + + + + Base class for terrain painting tools. + + + + + Retrieves the description of the custom terrain tool. + + + Tool description. + + + + + Retrieves the name of the custom terrain tool. + + + Tool name. + + + + + Called when the tool is destroyed. + + + + + Called when the tool is created. + + + + + Called when the tool is activated. + + + + + Called when the tool becomes inactive. + + + + + Custom terrain tool OnInspectorGUI callback. + + Active Terrain object. + Interface used to communicate between Editor and Paint tools. + + + + Custom terrain tool paint callback. + + Active Terrain object. + Interface used to communicate between Editor and Paint tools. + + Return true to temporarily hide tree, grass, and detail layers on the terrain. + + + + + Custom terrain tool OnSceneGUI callback. + + Active Terrain object. + Interface used to communicate between Editor and Paint tools. + + + + Terrain paint utility editor helper functions. + + + + + Enum to specify whether DrawBrushPreview previews the source render texture or the destination render texture of a PaintContext. + + + + + Specifies that Experimental.TerrainAPI.TerrainPaintUtilityEditor.DrawBrushPreview uses the destination render texture of the PaintContext. + + + + + Specifies that Experimental.TerrainAPI.TerrainPaintUtilityEditor.DrawBrushPreview uses the source render texture of the PaintContext. + + + + + Draws a Terrain brush preview mesh from a heightmap PaintContext using the provided procedural material. + + PaintContext describing the heightmap from which to build the preview mesh. + Specifies Whether to build the mesh using the source or destination render texture in heightmapPC. + The brush texture to preview. + Describes the position and orientation of the brush. + Material used to render the preview. + Material pass to render. + + + + Returns the default brush preview material. This material supports procedural mesh generation for use with DrawBrushPreview. + + + Default brush preview material. + + + + + Helper function to display a default preview brush with no rotation or custom materials. + + Terrain object. + Brush texture. + Brush size. + + + + Data Provider interface that deals with Sprite Bone data. + + + + + Returns the list of SpriteBone for the corresponding Sprite ID. + + Sprite ID. + + + + Sets a new set of SpriteBone for the corresponding Sprite ID. + + Sprite ID. + + + + + Interface that defines the functionality available for classes that inherits SpriteEditorModuleBase. + + + + + Indicates that if Sprite data editing should be disabled; for example when the Editor is in Play Mode. + + + + + Indicates if ISpriteEditor should be interested in mouse move events. + + + + + The current selected Sprite rect data. + + + + + Sets current available Sprite rects. + + + + + Property that defines the window's current screen position and size. + + + + + The method will inform current active SpriteEditorModuleBase to apply or revert any data changes. + + + + + + Gets data provider that is supported by the current selected Assets's importer. + + + + + Returns a VisualElement for attaching child VisualElement onto the main view of a ISpriteEditor. + + + Root VisualElement for the main view. + + + + + The method updates ISpriteEditor.selectedSpriteRect based on current mouse down event and ISpriteEditor.spriteRects available. + + + Returns true when ISpriteEditor.selectedSpriteRect is changed. + + + + + Request to repaint the current view. + + + + + Indicates that there has been a change of data. In Sprite Editor Window, this enables the 'Apply' and 'Revert' button. + + + + + Sets a custom texture to be used by the ISpriteEditor during setup of the editing space. + + The custom preview texture. + The width dimension to render the preview texture. + The height dimension to render the preview texture. + + + + An interface that allows Sprite Editor Window to edit Sprite data for user custom importer. + + + + + The number of pixels in the sprite that correspond to one unit in world space. + + + + + SpriteImportMode to indicate how Sprite data will be imported. + + + + + The object that this data provider is acquiring its data from. + + + + + Applying any changed data. + + + + + Gets other data providers that might be supported by ISpriteEditorDataProvider.targetObject. + + + Data provider type. + + + + + Returns an array of SpriteRect representing Sprite data the provider has. + + + Array of SpriteRect. + + + + + Queries if ISpriteEditorDataProvider.targetObject supports the data provider type. + + Data provider type. + + True if supports, false otherwise. + + + + + Allows the data provider to initialize any data if needed. + + + + + Sets the data provider's current SpriteRect. + + Updated array of SpriteRect. + + + + Data Provider interface that deals with Sprite mesh data. + + + + + Returns the list of mesh edges for the corresponding Sprite ID. + + Sprite ID. + + + + Returns the list of mesh index for the corresponding Sprite ID. + + Sprite ID. + + + + Returns the list of vertex datas for the corresponding Sprite ID. + + Sprite ID. + + + + Sets a new list of edges for the corresponding Sprite ID. + + Sprite ID. + + + + + Sets a new list of indices for the corresponding Sprite ID. + + Sprite ID. + + + + + Sets a new list of vertices for the corresponding Sprite ID. + + Sprite ID. + + + + + Data provider that provides the outline data for SpriteRect. + + + + + Given a GUID, returns the outline data used for tessellating the SpriteRect. + + GUID of the SpriteRect. + + Outline data for the SpriteRect. + + + + + Given a GUID, returns the tessellation detail. Tessellation value should be between 0 to 1. + + GUID of the SpriteRect. + + The tessellation value. + + + + + Given a GUID, sets the outline data used for tessellating the SpriteRect. + + GUID of the SpriteRect. + Outline data for the SpriteRect. + + + + Given a GUID, sets the tessellation detail. Tessellation value should be between 0 to 1. + + GUID of the SpriteRect. + The tessellation value. + + + + Data provider that provides the Physics outline data for SpriteRect. + + + + + Given a GUID, returns the Physics outline data used for the SpriteRect. + + GUID of the SpriteRect. + + Physics outline data for the SpriteRect. + + + + + Given a GUID, returns the tessellation detail. Tessellation value should be between 0 to 1. + + GUID of the SpriteRect. + + The tessellation value. + + + + + Given a GUID, sets the Physics outline data used for the SpriteRect. + + GUID of the SpriteRect. + Physics outline data for the SpriteRect. + + + + Given a GUID, sets the tessellation detail. Tessellation value should be between 0 to 1. + + GUID of the SpriteRect. + The tessellation value. + + + + Data provider that provides texture data needed for Sprite Editor Window. + + + + + Texture2D that represents the preview for ITextureDataProvider.texture. + + + + + Texture2D representation of the data provider. + + + + + Readable version of ITextureProvider.texture. + + + Texture2D that is readable. + + + + + The actual width and height of the texture data. + + Out value for width. + Out value for height. + + + + Use this attribute on a class that inherits from SpriteEditorModuleBase to indicate what data provider it needs. + + + + + Use the attribute to indicate the custom data provider that SpriteEditorBaseModule needs. + + Data provider type. + + + + Sprite extension methods that are accessible in Editor only. + + + + + Gets the Sprite's GUID. + + The Sprite to query. + + GUID stored in the Sprite. + + + + + Sets a Sprite's Global Unique Identifier (GUID) for easy identification later. + + The Sprite to set. + The GUID to set for the Sprite. + + + + Base class the Sprite Editor Window custom module inherits from. + + + + + The module name to display in Sprite Editor Window. + + + + + The ISpriteEditor instance that instantiated the module. + + + + + This is called when user clicks on the Apply or Revert button in Sprite Editor Window. + + True when user wants to apply the data, false when user wants to revert. + + Return true to trigger a reimport. + + + + + Indicates if the module can be activated with the current ISpriteEditor state. + + + Return true if the module can be activated. + + + + + Implement this to draw on the Sprite Editor Window. + + + + + Implement this to draw widgets in Sprite Editor Window. + + + + + Implement this to create a custom toolbar. + + Area for drawing tool bar. + + + + This is called when the user activates the module. + + + + + This is called when user switches to another module. + + + + + A structure that contains meta data about vertices in a Sprite. + + + + + The BoneWeight of the vertex. + + + + + The position of the vertex. + + + + + This is the base class for the composite fields. + + + + + The container VisualElement for the field, this is null for the composite field. + + + + + Gives a way to update the focus index of the child elements of the composite field. + + + + + Method to change the value of the underlying data of the composite field. + + New value to assign to the composite field. + + + + UxmlTraits for the BaseCompositeField. + + + + + Constructor. + + + + + This is the base class for the popup fields. + + + + + This is the text displayed to the user for the current selection of the popup. + + + + + Provides VisualElement extension methods that implement data binding between INotivyValueChanged fields and SerializedObjects. + + + + + Binds a SerializedObject to fields in the element hierarchy. + + Root VisualElement containing IBindable fields. + Data object. + + + + Binds a property to a field and synchronizes their values. This method finds the property using the field's binding path. + + VisualElement field editing a property. + Root SerializedObject containing the bindable property. + + Returns the serialized object that owns the bound property. + + + + + Binds a property to a field and synchronizes their values. + + VisualElement field editing a property. + The SerializedProperty to bind. + + + + Disconnects all properties bound to fields in the element's hierarchy. + + Root VisualElement contaning IBindable fields. + + + + A Bounds editor field. + + + + + Instantiates a BoundsField using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the BoundsField. + + + + + Constructor. + + + + + Initialize BoundsField properties using values from the attribute bag. + + The object to initialize. + The attribute bag. + The creation context; unused. + + + + A BoundsInt editor field. + + + + + Instantiates a BoundsIntField using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the BoundsIntField. + + + + + Constructor. + + + + + Initializes the UxmlTraits for the BoundsIntField. + + The VisualElement to be initialized. + Bag of attributes. + CreationContext, unused. + + + + Makes a field for selecting a color. + + + + + If true, treats the color as an HDR value. If false, treats the color as a standard LDR value. + + + + + If true, allows the user to set an alpha value for the color. If false, hides the alpha component. + + + + + If true, the color picker will show the eyedropper control. If false, the color picker won't show the eyedropper control. + + + + + Constructor. + + + + + Set the value and, if different, notifies registers callbacks with a ChangeEvent<Color> + + The new value to be set. + + + + Instantiates a ColorField using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the ColorField. + + + + + Constructor. + + + + + Initialize ColorField properties using values from the attribute bag. + + The object to initialize. + The attribute bag. + The creation context; unused. + + + + Makes a field for editing an AnimationCurve. + + + + + Optional rectangle that the curve is restrained within. If the range width or height is < 0 then CurveField computes an automatic range, which encompasses the whole curve. + + + + + The RenderMode of CurveField. The default is RenderMode.Default. + + + + + The AnimationCurve currently being exposed by the field. + + + + + Constructor. + + + + + Render mode of CurveFields + + + + + Renders the curve with the default mode. Currently Texture. + + + + + Renders the curve with an anti-aliased mesh. + + + + + Renders the curve with a generated texture, like with Unity’s Immediate Mode GUI system (IMGUI). + + + + + Sets the value of the curve and, if different from the previous value, notifies the OnValueChanged event callback with a ChangeEvent<AnimationCurve> + + The new value to be set. + + + + Instantiates a CurveField using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the CurveField. + + + + + Constructor. + + + + + Speed at which the value changes for a given input device delta. + + + + + The value changes at four times the normal rate. + + + + + The value changes at the normal rate. + + + + + The value changes at one quarter of its normal rate. + + + + + Makes a text field for entering doubles. + + + + + Modify the value using a 3D delta and a speed, typically coming from an input device. + + A vector used to compute the value change. + A multiplier for the value change. + The start value. + + + + Constructor. + + Maximum number of characters the field can take. + + + + Constructor. + + Maximum number of characters the field can take. + + + + Converts the given string to a double. + + The string to convert. + + The double parsed from the string. + + + + + Instantiates a DoubleField using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the DoubleField. + + + + + Constructor. + + + + + Initialize DoubleField properties using values from the attribute bag. + + The object to initialize. + The attribute bag. + The creation context; unused. + + + + Converts the given double to a string. + + The double to be converted to string. + + The double as string. + + + + + Makes a dropdown for switching between enum values. + + + + + Return the text value of the currently selected enum. + + + + + Construct an EnumField. + + Initial value. Also used to detect Enum type. + + + + Initialize the EnumField with a default value. This also initializes its underlying type. + + Your typed enum value. + + + + Set the value and, if different, notifies registers callbacks with a ChangeEvent<Enum> + + The new value to be set. + + + + Instantiates an EnumField using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the EnumField. + + + + + Constructor. + + + + + Initialize EnumField properties using values from the attribute bag. + + The object to initialize. + The attribute bag. + The creation context; unused. + + + + Allows dragging on a numeric field's label to change the value. + + + + + Is dragging. + + + + + Start value before drag. + + + + + FieldMouseDragger's constructor. + + The field. + + + + Set drag zone. + + The drag element (like the label). + The rectangle that contains the drag zone. + + + + Set drag zone. + + The drag element (like the label). + The rectangle that contains the drag zone. + + + + Makes a text field for entering a float. + + + + + Modify the value using a 3D delta and a speed, typically coming from an input device. + + A vector used to compute the value change. + A multiplier for the value change. + The start value. + + + + Constructor. + + Maximum number of characters the field can take. + + + + Constructor. + + Maximum number of characters the field can take. + + + + Converts the given string to a float. + + The string to convert. + + The float parsed from the string. + + + + + Instantiates a FloatField using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the FloatField. + + + + + Constructor. + + + + + Initialize FloatField properties using values from the attribute bag. + + The object to initialize. + The attribute bag. + The creation context; unused. + + + + Converts the given float to a string. + + The float to be converted to string. + + The float as string. + + + + + Makes a field for editing an Gradient. + + + + + The Gradient currently being exposed by the field. + + + + + Constructor. + + + + + Sets the value of the gradient and, if different from the previous value, notifies the OnValueChanged event callback with a ChangeEvent<Gradient> + + The new value to be set. + + + + Instantiates a GradientField using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the GradientField. + + + + + Constructor. + + + + + Helper object that attaches a visual element next to its target, regarless of their respective location in the visual tree hierarchy. + + + + + Relative alignment between the attached element and the target. + + + + + The distance between the attached element and the target. + + + + + The element that is attached to the target element. + + + + + An absolute offset added to the element position after placement. + + + + + The target element. + + + + + Attaches a visual element next to its target, regarless of their respective locations in the visual tree hierarchy. + + The element that will be positioned alongside the target. + The target element. + Relative alignment between the attached element and the target. + + + + Stop monitoring the target element and postioning the attached element. + + + + + Starts monitoring target element position changes and places the attached element accordingly. + + + + + GraphElement that enables user to dynamically define members of a Graph (such as fields/properties) grouped by sections (BlackboardSection). + + + + + Called when user clicks on the Add button of this Blackboard. + + + + + The content container of this Blackboard. + + + + + Called when user has edited the text of this BlackboardField. + + + + + Called when user has dragged and dropped a BlackboardField to a new location inside its BlackboardSection. + + + + + Indicates whether the content of this Blackboard can be vertically scrolled by user. It is false by default. + + + + + The subtitle of this Blackboard. + + + + + The title of this Blackboard. + + + + + Constructs a Blackboard. + + + + + GraphElement that represents a field of a Graph. + + + + + The highlighted state of this BlackboardField. + + + + + The icon of this BlackboardField. + + + + + The text of this BlackboardField. + + + + + The text that displays the data type of this BlackboardField. + + + + + Constructs a BlackboardField. + + The icon of this BlackboardField. + The text of this BlackboardField. + The text that displays the data type of this BlackboardField. + + + + Constructs a BlackboardField. + + The icon of this BlackboardField. + The text of this BlackboardField. + The text that displays the data type of this BlackboardField. + + + + Opens a TextField to edit the text in a BlackboardField. + + + + + Collapsible GraphElement that represents a row in a BlackboardSection. + + + + + Indicates whether the BlackboardRow is expanded. + + + + + Constructs a BlackboardRow from a VisualElement and its associated property view. The VisualElement is usually a BlackboardField. + + The item that fills the content of this BlackboardRow. + The property view related to the content of this BlackboardRow. + + + + GraphElement that represents a section of members in a Blackboard. + + + + + The content container of this BlackboardSection. + + + + + Indicates whether the header of the BlackboardSection is visible. + + + + + The title of this BlackboardSection. + + + + + Indicates whether this BlackboardSection accepts the current drop event. + + The list of selected objects. + + Returns true when rows are reordered by the user. + + + + + Constructs a BlackboardSection. + + + + + Capabilities used by Manipulators to easily determine valid actions on a GraphElement. + + + + + GraphElement will be brought to the front of its layer when it is selected. + + + + + GraphElement can be collapsed. + + + + + GraphElement can be deleted. + + + + + GraphElement can be dragged and dropped (using the Drag&Drop events). + + + + + GraphElement is movable. + + + + + GraphElement is resizable. + + + + + GraphElement is selectable. + + + + + Selects element on single click. + + + + + Constructor for ClickSelector. + + + + + Called on mouse down event. + + + + + + Called to register click event callbacks on the target element. + + + + + Called to unregister event callbacks from the target element. + + + + + Manipulator that allows mouse-dragging of one or more elements. + + + + + If true, it does not allow the dragged element to exit the parent's edges. + + + + + When elements are dragged near the edges of the Graph, panning occurs. This controls the speed for said panning. + + + + + Calculate new position of the dragged element. + + New x position. + New y position. + Element width. + Element height. + + Calculated and validated position. + + + + + ContentDragger constructor. + + + + + Called on mouse down event. + + The event. + + + + Called on mouse move event. + + The event. + + + + Called on mouse up event. + + The event. + + + + Called to register click event callbacks on the target element. + + + + + Called to unregister event callbacks from the target element. + + + + + Manipulator that allows zooming in GraphView. + + + + + Optimization option to keep the old pixel cache while zooming and only updating it when zooming is finished (based on a timer). + + + + + Max zoom level. + + + + + Min zoom level. + + + + + Reference zoom level. + + + + + Zoom step: percentage of variation between a zoom level and the next. For example, with a value of 0.15, which represents 15%, a zoom level of 200% will become 230% when zooming in. + + + + + ContentZoomer constructor. + + + + + Default max zoom level. + + + + + Default min zoom level. + + + + + Default reference zoom level. + + + + + Default zoom step. + + + + + Called to register click event callbacks on the target element. + + + + + Called to unregister event callbacks from the target element. + + + + + Port direction (in or out). + + + + + Port is an input port. + + + + + Port is an output port. + + + + + Base manipulator for mouse-dragging elements. + + + + + If true, it does not allow the dragged element to exit the parent's edges. + + + + + When elements are dragged near the edges of the Graph, panning occurs. This controls the speed for said panning. + + + + + Calculate new position of the dragged element. + + New x position. + New y position. + Element width. + Element height. + + Calculated and validated position. + + + + + Dragger constructor. + + + + + Called on mouse down event. + + The event. + + + + Called on mouse move event. + + The event. + + + + Called on mouse up event. + + The event. + + + + Called to register click event callbacks on the target element. + + + + + Called to unregister event callbacks from the target element. + + + + + The GraphView edge element. + + + + + The edge's end position while it's being created. + + + + + Default edge color. + + + + + The VisualElement child of Edge that draws the lines and does the hit detection. + + + + + Edge width. + + + + + The color of the ghost edge, which is the edge that appears snapped to a nearby port while an edge is being created. + + + + + Connected input port. + + + + + Is this edge a ghost edge, which is the edge that appears snapped to a nearby port while an edge is being created. + + + + + Connected output port. + + + + + Color of edge while selected. + + + + + Checks if point is on top of edge. + + Point position. + + True if point is on top of edge. False otherwise. + + + + + Create the EdgeControl. + + + The created EdgeControl. + + + + + Edge's constructor. + + + + + Repaint the edge element. + + + + + Draw the edge's lines. + + + + + Called when a port on the edge is changed. + + True if the input port was changed. False if the output port was changed. + + + + Called when the style was updated. + + The new style. + + + + Check if edge overlaps rectangle. + + The rectangle. + + True if edge overlaps the rectangle. + + + + + The edge's points and tangents. + + + + + Update the edge's EdgeControl. + + + False if it failed to update the control. True if it succeeded. + + + + + Manipulator for creating new edges. + + + + + Reference to the edge drag helper. + + + + + Manipulator for creating new edges. + + + + + Reference to the edge drag helper. + + + + + EdgeConnector's constructor. + + The IEdgeConnectorListener that will finalize the edges. + + + + Called on mouse down event. + + The event. + + + + Called on mouse move event. + + The event. + + + + Called on mouse up event. + + The event. + + + + Called to register click event callbacks on the target element. + + + + + Called to unregister event callbacks from the target element. + + + + + VisualElement that draws the edge lines and detects if mouse is on top of edge. + + + + + Radius of the edge's end caps. + + + + + Edge's control points. + + + + + Whether or not to draw the From Cap. + + + + + Whether or not to draw the To Cap. + + + + + Edge's color. + + + + + Edge's visible width. + + + + + Edge's From postion. + + + + + The color of the cap color at the "from" end of the edge. + + + + + Color on the edge's input. + + + + + Edge input port orientation (vertical/horizontal). + + + + + Width that will be used for mouse hit detection. + + + + + Min edge width. + + + + + Color on the edge's output. + + + + + Edge output port orientation (vertical/horizontal). + + + + + Edge's To postion. + + + + + The color of the cap color at the "to" end of the edge. + + + + + Compute the edge's control points. + + + + + Check if point is on top of edge. + + The point's position. + + True if the point is on top of the edge. + + + + + EdgeControl's constructor. + + + + + Repaint the edge. + + + + + Draw the edge lines. + + + + + Check if edge overlaps rectangle. + + The rectangle. + + True if the edge overlaps the rectangle. + + + + + Check if the edge points have changed. + + + + + Update the edge layout. + + + + + Update the edge's render points. + + + + + EdgeDragHelper's constructor. + + + + + The port the edge is being dragged from. + + + + + The edge being dragged. + + + + + Handle mouse down event. + + The event. + + True if the drag has been started. False otherwise. + + + + + Handle mouse move event. + + The event. + + + + Handle mouse up event. + + The event. + + + + Reset the state of the drag helper. + + Whether the connection was successful or not. View will not reset in this case. + + + + Edge drag helper class. + + + + + The port the edge is being dragged from. + + + + + The edge being dragged. + + + + + True if it should reset position on pan if nothing is connected. + + + + + EdgeDragHelper's constructor. + + The edge connector listener. + + + + Handle mouse down event. + + The event. + + True if the drag has been started. False otherwise. + + + + + Handle mouse move event. + + The event. + + + + Handle mouse up event. + + The event. + + + + Reset the state of the drag helper. + + Whether the connection was successful or not. View will not reset in this case. + + + + Edge manipulator used to drag edges off ports and reconnect them elsewhere. + + + + + EdgeManipulator's constructor. + + + + + Handle key down event. + + The event. + + + + Handle mouse down event. + + The event. + + + + Handle mouse move event. + + The event. + + + + Handle mouse up event. + + The event. + + + + Called to register click event callbacks on the target element. + + + + + Called to unregister event callbacks from the target element. + + + + + Freehand selection tool. + + + + + FreehandSelector constructor. + + + + + Register callbacks on target VisualElement. + + + + + Unregister callbacks on target VisualElement. + + + + + Base class for main GraphView VisualElements. + + + + + Graph element's capabilities. + + + + + Color used for the MiniMap view. + + + + + Element's layer in the graph. + + + + + True if element is currently selected. + + + + + The element's title. + + + + + Get the element's center point. + + + The center point. + + + + + Get element position. + + + The position and size rect. + + + + + See if point is over element. + + The point. + + True if over element. + + + + + Checks if the Element is automatically brought to front when selected. + + + Returns true if the GraphElement is automatically brought to front when selected. Returns false otherwise + + + + + Element is drag&droppable. + + + True if droppable. + + + + + Element is movable. + + + True if movable. + + + + + Element is resizable. + + + True if resizable. + + + + + Element is selectable. + + + True if selectable. + + + + + Element is currently selected in specific container. + + The container. + + True if selected. + + + + + Called when element is selected. + + + + + Called when element is unselected. + + + + + Reset the element to its original layer. + + + + + Select element. + + Container in which element is being selected. + True if selection is additive, false otherwise. + + + + Set element position. + + New position. + + + + Deselect element. + + Container in which element was selected. + + + + Set of extension methods useful for Scope. + + + + + Returns the scope containing the specified GraphElement. + + + + + + Main GraphView class. + + + + + Ask whether or not the serialized data can be pasted. + + + + + Main content container. + + + + + Delete selection callback. + + + + + All edges in the graph. + + + + + Element resized callback. + + + + + Callback for when GraphElements are added to the group. + + + + + Callback for when GraphElements are inserted into a StackNode. + + + + + Callback for when GraphElements are removed from the group. + + + + + Callback for when GraphElements are removed from a StackNode. + + + + + All GraphElements in the graph. + + + + + Callback for when certain changes have occured in the graph. See GraphViewChange. + + + + + Callback for when a group title is changed. + + + + + Whether or not the selection is reframable. + + + + + Max zoom level. + + + + + Min zoom level. + + + + + Callback for when the user requests to display the node creation window. + + + + + All nodes currently in the graph. + + + + + All ports currently in the graph. + + + + + Reference zoom level. + + + + + Current graph zoom level. + + + + + Zoom step. See Experimental.UIElements.GraphView.ContentZoomer._scaleStep for details. + + + + + All currently selected elements in the graph. + + + + + Callback for serializing graph elements for copy/paste and other actions. + + + + + Callback for unserializing graph elements and adding them to the graph. + + + + + The graph's viewport. This is currently just itself. + + + + + Graph's view transform. + + + + + View transform changed callback. + + + + + Number of elements in the graph above which the zoom manipulator will turn off pixel cache regeneration on each tick to avoid performance drops. + + + + + Add new GraphElement. Should use this instead of Add() for adding GraphElements. + + The element to add. + + + + Adds a new layer to the GraphView. + + the index of the new layer. + + + + Add element to selection. + + Element to add to selection. + + + + Whether or not to ask the user for certain actions like deleting selection. + + + + + Ask the user before doing certain actions like deleting selection. + + + + + Don't ask the user before doing certain actions like deleting selection. + + + + + Add menu items to the contextual menu. + + The event holding the menu to populate. + + + + Calculate the view transform based on zoom level and the size of the window or parent. + + Rectangle to fit. + Parent rectangle. + Border size. + Calculated translation. + Calculated scaling. + + + + Calculate the rectangle size and position to fit all elements in graph. + + This should be the view container. + + The calculated rectangle. + + + + + Default method for checking if serialized data can be pasted. + + Serialized graph element. + + True if it can be pasted. + + + + + Delegate for checking if serialized data can be pasted. + + Serialized graph element. + + + + Clear selection. + + + + + Remove elements from the graph view. + + Elements to remove. + + + + Delete selected elements. + + + Stop if no elements were selected. Continue otherwise. + + + + + Delegate for deleting selection. + + Name of operation for undo/redo labels. + Whether or not to ask the user. + + + + Default method for deleting selection. + + Name of operation for undo/redo labels. + Whether or not to ask the user. + + + + Element resized delegate. + + Resized element. + + + + Focus view all elements in the graph. + + + Should always be Stop. + + + + + Focus view on the next element after the one currently selected. + + The predicate used to sort the list of all existing graph element. + + Continue if no elements in graph, Stop otherwise. + + + + + Focus view on the next element after the one currently selected. + + The predicate used to sort the list of all existing graph element. + + Continue if no elements in graph, Stop otherwise. + + + + + Focus view on the graph's origin. + + + Always returns Stop. + + + + + Focus view on the previous element before the one currently selected. + + The predicate used to sort the list of all existing graph element. + + Continue if no elements in graph, Stop otherwise. + + + + + Focus view on the previous element before the one currently selected. + + The predicate used to sort the list of all existing graph element. + + Continue if no elements in graph, Stop otherwise. + + + + + Focus view on currently selected elements. + + + Continue if no elements selected, Stop otherwise. + + + + + Type of framing. + + + + + Focus view on all elements. + + + + + Focus view on origin. + + + + + Focus view on selection. + + + + + Get all ports compatible with given port. + + Start port to validate against. + Node adapter. + + List of compatible ports. + + + + + Get edge by its GUID. + + The GUID. + + The first edge with given GUID. Null if none found. + + + + + Get any element with a given GUID. + + The GUID. + + The first element with the given GUID. Null if none found. + + + + + Get node with a given GUID. + + The GUID. + + The first node with the given GUID. Null if none found. + + + + + Get port by its GUID. + + The GUID. + + The first port found with given GUID. Null if none found. + + + + + Delegate used to indicate a change in GraphView usualy done by a Manipulator. + + The change struct. + + + + Called when persistent data, such as zoom level and selection, is ready to be retrieved and restored. + + + + + Remove element from the graph. + + Element to remove. + + + + Remove element from selection. + + Element to remove from selection. + + + + Default method for serializing graph elements. + + Elements to serialize. + + Serialized data. + + + + + Delegate for serializing graph elements. + + Elements to serialize. + + + + Setup zoom properties. + + Min zoom level. + Max zoom level. + Zoom step. + Reference zoom level. + + + + Setup zoom properties. + + Min zoom level. + Max zoom level. + Zoom step. + Reference zoom level. + + + + Delegate for unserializing and pasting elements. + + Name of operation for undo/redo labels. + Serialized data. + + + + Default method for unserializing elements and pasting. + + Name of operation for undo/redo labels. + Serialized data. + + + + Update the viewport transform. + + New position. + New scale. + + + + Validate the view transform. + + + + + View transform changed (zoom) delegate. + + GraphView reference. + + + + Set of changes in the graph that can be intercepted. + + + + + Edges about to be created. + + + + + Elements about to be removed. + + + + + Elements already moved. + + + + + The delta of the last move. + + + + + Default GraphView background. + + + + + GridBackground's constructor. + + + + + Repaint the background. + + + + + Recompute styles on the background. + + New style. + + + + Allows interactive insertion of elements in a named scope. + + + + + Title of the group. + + + + + Whether an element can be added to this group. + + The element to add. + The reason that indicates why the element is not accepted. + + Returns false if the specified element is a scope or group. Otherwise returns true. + + + + + Group constructor. + + + + + Called when elements are added to this group. + + The added elements. + + + + Called when elements are removed from this group. + + The removed elements. + + + + Called when this group is renamed. + + The old name of the group. + The new name of the group. + + + + A rectangular badge, usually attached to another visual element. + + + + + Relative alignment between the badge and its target. The alignment will influence icon and tip position. + + + + + Text displayed next to the badge on mouse hover. + + + + + Distance between the badge and its target element. + + + + + Target element to which this badge is attached. + + + + + Attaches this badge to another element. + + The target element to attach this badge to. + Relative alignement of the badge. + + + + Creates an IconBadge with the "comment" visual style. + + Displayed comment message. + + The created badge. + + + + + Creates an IconBadge with the "error" visual style. + + Displayed error message. + + The created badge. + + + + + Creates a basic comment badge. + + + + + + Creates a basic comment badge. + + + + + + Detaches this badge from its target. + + + + + Droppable interface. + + + + + Check if element is droppable. + + + True if droppable. False otherwise. + + + + + Drop target interface. + + + + + Indicates if the dragged source can be dropped on the target interface. + + Selected elements. + + Returns true if the dragged source can be dropped on the target interface. Returns false otherwise. + + + + + This method is automatically called when the dragged source intersects the drop target. + + The event. + The selected elements. + The drop target. + The drag source. + + Returns event propagation. + + + + + This method is automatically called when dragging ends and the drag source is not over a valid drop target. + + + Returns event propagation. + + + + + This method is automatically called when the dragged source no longer intersects the drop target. + + The event. + The selected elements. + The drop target. + The drag source. + + Returns event propagation. + + + + + "This method is automatically called when a drag is performed." + + The event. + The selected elements. + The drop target. + The drag source. + + Returns event propagation. + + + + + This method is automatically called when the drag source is updated. + + The event. + The selected elements. + The drop target. + The drag source. + + Returns event propagation. + + + + + Used by EdgeConnector manipulator to finish the actual edge creation. Its an interface the user can override and create edges in a different way. + + + + + Called when a new edge is dropped on a port. + + Reference to the GraphView. + The edge being created. + + + + Called when edge is dropped in empty space. + + The edge being dropped. + The position in empty space the edge is dropped on. + + + + This interface describes methods to manage a search session for graph nodes. + + + + + Generates data to populate the search window. + + Contextual data initially passed the window when first created. + + Returns the list of SearchTreeEntry objects displayed in the search window. + + + + + Selects an entry in the search tree list. + + The selected entry. + Contextual data to pass to the search window when it is first created. + + + + Selectable interface. + + + + + See if point is on target. + + The point. + + True if on target. + + + + + Check if element is selectable. + + + True if selectable. False otherwise. + + + + + Check if element is selected. + + Container in which the selection is tracked. + + True if selected. False otherwise. + + + + + Check if selection overlaps rectangle. + + Rectangle to check. + + True if it overlaps. False otherwise. + + + + + Select element. + + Container in which selection is tracked. + True if selection is additive. False otherwise. + + + + Deselect element. + + Container in which selection is tracked. + + + + Selection interface. + + + + + Get the selection. + + + + + Add element to selection. + + Selectable element to add. + + + + Clear selection. + + + + + Remove element from selection. + + Selectable element to remove. + + + + MiniMap. + + + + + True if the map is pinned or achored (non-movable). False if you can drag and move it around. + + + + + Max height. + + + + + Max width. + + + + + Add menu items to the mini map contextual menu. + + The event holding the menu to populate. + + + + MiniMap's constructor. + + + + + Repaint the MiniMap. + + + + + Main GraphView node class. + + + + + Is node expanded. + + + + + Empty container used to display custom elements. After adding elements, call RefreshExpandedState in order to toggle this container visibility. + + + + + Input container used for input ports. + + + + + Main container that includes all other containers. + + + + + Outputs container, used for output ports. + + + + + Node's title element. + + + + + Title bar button container. Contains the top right buttons. + + + + + Title bar container. + + + + + Entire top area containing input and output containers. + + + + + Add menu items to the node contextual menu. + + The event holding the menu to populate. + + + + Node's constructor. + + The orientation. + + + + Node's constructor. + + The orientation. + + + + Create a new port specific to this node. + + Port's orientation. + Port's direction. + Port's type. + (obsolete). + + The new port. + + + + + Create a new port specific to this node. + + Port's orientation. + Port's direction. + Port's type. + (obsolete). + + The new port. + + + + + Called when port is remove. + + The removed port. + + + + After adding custom elements to the extensionContainer, call this method in order for them to become visible. + + + + + Refresh the layout of the ports. + + + + + Set node position. + + New position. + + + + Toggle node's collapse state. + + + + + Applies the default styling of Node. This must be explicitly called by Node subclasses that use their own uxml files. + + + + + This struct represents the context when the user initiates creating a graph node. + + + + + The index where the created node will be inserted. + + + + + Position of the click that initiated the request to create a node, in the coordinate space of the screen. + + + + + The VisualElement where the created node will be added. + + + + + Graph element orientation. + + + + + Horizontal orientation used for nodes and connections flowing to the left or right. + + + + + Vertical orientation used for nodes and connections flowing up or down. + + + + + The Pill class includes methods for creating and managing a VisualElement that resembles a capsule. The Pill class includes text, an icon, and two optional child VisualElements: one to the left of the pill, and one to the right of the pill. + + + + + Returns whether the pill is highlighted. + + + + + The icon of the pill. + + + + + The VisualElement to the left of the pill. + + + + + The VisualElement to the right of the pill. + + + + + The text of the pill. + + + + + Constructs a pill with its optional left and right child VisualElements. + + + + + + + Constructs a pill with its optional left and right child VisualElements. + + + + + + + Instantiates a Pill using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the Pill. + + + + + Returns an empty enumerable, as pill elements do not have children. + + + + + Constructor. + + + + + Initialize Pill properties using values from the attribute bag. + + The object to initialize. + The attribute bag. + The creation context; unused. + + + + GraphView Port class. + + + + + Specify how many edges a port can have connected. + + + + + Port's collapsed state. + + + + + Port's connected state. + + + + + All the port's current connections. + + + + + Port's direction. + + + + + The color of the port when disabled. + + + + + Reference to the edge connector. + + + + + Is the port highlighted. + + + + + Port's node. + + + + + Port's orientation. + + + + + Is the port cap lit or not. + + + + + The color of the port. + + + + + Port name. + + + + + Port type. + + + + + Port's source. + + + + + The name of the uss class to use to style the port. + + + + + Specify how many edges a port can have connected. + + + + + Port can have multiple connections. + + + + + Port can only have a single connection. + + + + + Connect and edge to the port. + + The edge. + + + + Creates an edge between this port and the 'other' port. + + Other port to connect to. + + Newly created edge. + + + + + Creates an edge between this port and the 'other' port. + + Other port to connect to. + + Newly created edge. + + + + + Check if point is on top of port. Used for selection and hover. + + The point. + + True if the point is over the port. + + + + + Factory method for creating a port. + + (obsolete). + Orientation. + Direction. + Multi vs. Single. + Port data type. + + The new port. + + + + + Factory method for creating a port. + + (obsolete). + Orientation. + Direction. + Multi vs. Single. + Port data type. + + The new port. + + + + + Disconnect edge from port. + + The edge to disconnect. + + + + Disconnect all edges from port. + + + + + Get the port's center. + + + The center point. + + + + + Called when an edge is dragged. + + + + + Called when an edge dragging ends. + + + + + Port source. + + + + + Port source constructor. + + + + + Rectangle selection box manipulator. + + + + + Computer the axis-aligned bound rectangle. + + Rectangle to bound. + Transform. + + The axis-aligned bound. + + + + + RectangleSelector's constructor. + + + + + Called to register click event callbacks on the target element. + + + + + Called to unregister event callbacks from the target element. + + + + + Utilities for rectangle selections. + + + + + RectUtils' constructor. + + + + + Create rectangle that encompasses two rectangles. + + Rect a. + Rect b. + + New rectangle. + + + + + Creates and returns an enlarged copy of the specified rectangle. The copy is enlarged by the specified amounts. + + The original rectangle. + The amount to inflate the rectangle towards the left. + The amount to inflate the rectangle towards the top. + The amount to inflate the rectangle towards the right. + The amount to inflate the rectangle towards the bottom. + + + + Check if a line segment overlaps a rectangle. + + Rectangle to check. + Line segment point 1. + Line segment point 2. + + True if line segment overlaps rectangle. False otherwise. + + + + + Resizer manipulator element. + + + + + Mouse button to activate the resizer. + + + + + Resizer's constructor. + + Minimum element size. + + + + Resizer's constructor. + + Minimum element size. + + + + This class allows for nodes to be grouped into a common area, or Scope. This class includes methods that automatically resize and position the Scope to encompass the group of nodes. + + + + + Enables or disables the automatic resizing and positioning of the Scope. + + + + + The list of GraphElements contained by the Scope. + + + + + The rect containing the GraphElements encompassed by the Scope. The rect is expressed in local coordinates. + + + + + Returns the header container for the Scope. Use this header container to customizer the header of the Scope. + + + + + Whether the GraphElement can be added to this scope. + + The element to add. + The reason why the specified element cannot be added to the Scope. + + Returns true if the specified element is accepted by the Scope. Returns false otherwise. + + + + + Adds a GraphElement to the Scope. + + The element to add. + + + + Adds GraphElements to the Scope. + + The elements to add. + + + + + Determines if the Scope contains the specified GraphElement. + + The element. + + Returns true if the Scope contains the specified element. Returns false otherwise. + + + + + Scope constructor. + + + + + Returns the geometry of the Scope. + + + The geometry. + + + + + Determines whether the specified point is within the selectable area of the Scope. + + The point in local coordinates. + + Returns true if the point is within the selectable area of the Scope. Returns false otherwise. + + + + + Called when GraphElements are added to the Scope. + + The added elements. + + + + Called when GraphElements are removed from the Scope. + + The removed elements. + + + + Determines whether the specified rect overlaps the Scope. + + The rect. + + Returns true when the specified rect overlaps the Scope. + + + + + Removes an element from the Scope. + + The element to remove. + + + + Removes elements from the Scope. + + The elements to remove. + + + + Removes elements from the Scope but do not send a notification. + + The elements to remove. + + + + Schedules the update of the size and position of the Scope based on its contents. + + + + + Sets the geometry of the Scope. + + The new geometry. + + + + Change the position of the scope but does not move its elements. + + + + + + Updates the size and position of the Scope based on its contents. + + + + + This class describes a search tree entry. The search window displays search tree entries in the GraphView. + + + + + The text and icon of the search entry. + + + + + The level of the entry in the search tree. + + + + + The string used for string comparison against the user filter. + + + + + A user specified object for attaching application specific data to a search tree entry. + + + + + + + The text and icon of the item. + + + + This class describes group entries in the search tree. The search tree is displayed in the search window. + + + + + + + The text and icon of the group entry. + The level of the group entry. + + + + This subclass displays a searchable menu of available graph nodes. + + + + + Opens the search window above the Graph. + + Structure of parameters that configure the search window. + Reference to the object that provides the search results. + + Returns true if the window opens successfully. Returns false otherwise. + + + + + This structure includes parameters for configuring the search window. + + + + + Requested height of the window. Set to 0.0f to use the default height. + + + + + Requested width of the window. Set to 0.0f to use the default width. + + + + + The initial mouse event position that triggered opening the window, in the coordinate space of the screen. + + + + + + + Requested height of the window. Set to 0.0f to use the default height. + Requested width of the window. Set to 0.0f to use the default width. + The initial mouse event position that triggered opening the window, in the coordinate space of the screen. + + + + Selection dragger manipulator. + + + + + SelectionDragger's constructor. + + + + + Called on mouse down event. + + The event. + + + + Called on mouse move event. + + The event. + + + + Called on mouse up event. + + The event. + + + + + Called to register click event callbacks on the target element. + + + + + Called to unregister event callbacks from the target element. + + + + + Selection drag&drop manipulator. + + + + + Mouse button used to activate the manipulator. + + + + + Clamp element being dragged to the parent's (usually the graph) edges. + + + + + When elements are dragged near the edges of the Graph, panning occurs. This controls the speed for said panning. + + + + + SelectionDropper's constructor. + + The drop event. + + + + Called on mouse down event. + + The event. + + + + Called on mouse move event. + + The event. + + + + Called on mouse up event. + + The event. + + + + Called to register click event callbacks on the target element. + + + + + Called to unregister event callbacks from the target element. + + + + + Shortcut event delegate. + + + + + Shortcut handler. + + + + + ShortcutHandler's constructor. + + Dictionary of shortcuts and their actions. + + + + Called to register click event callbacks on the target element. + + + + + Called to unregister event callbacks from the target element. + + + + + Use this class to customize StackNodes and to manage dragging GraphElements over StackNodes. + + + + + The content container of this StackNode. + + + + + Indicates if items from this stack are currently being dragged. + + + + + Use this property to customize the preview that appears when GraphElements are dragged over the StackNode. + + + + + Returns true if the StackNode supports multiselection. + + + + + Use this property to customize the header for this StackNode. + + + + + Checks whether the specified GraphElement can be added to this StackNode. + + The element to add. + The index where the element would be added. This index can be overwritten. + The maximum value of the index. + + Returns true if the specified GraphElement can be added. Returns false otherwise. + + + + + Adds the specified GraphElement to the StackNode. + + The GraphElement to add. + + + + Indicates whether this StackNode accepts the current drop event. + + "The selected GraphElements to be checked. + + Returns true if this StackNode accepts the current drop event. Returns false otherwise. + + + + + StackNode constructor. + + + + + This method is automatically called when a drag leave event occurs. + + The event. + The selected elements. + The drop target. + The drag source. + + Returns event propagation. + + + + + This method is automatically called when a drag exit event occurs. + + + Returns event propagation. + + + + + This method is automatically called when a drag leave event occurs. + + The event. + The selected elements. + The drop target. + The drag source. + + Returns event propagation. + + + + + This method is automatically called when a drop event occurs. + + The event. + The selected elements. + The drop target. + The drag source. + + Returns event propagation. + + + + + This method is automatically called when a drag updated event occurs. + + The event. + The selected elements. + The drop target. + The drag source. + + Returns event propagation. + + + + + Retrieves the insertion index in the StackNode if an item is dropped at the specified world position. + + The world position to get an index from. + + Returns the insertion index. + + + + + Inserts the specified GraphElement at the specified index in this StackNode. + + The index where the specified GraphElement will be inserted. + The GraphElement to insert. + + + + This method is automatically called when a contextual menu is about to appear on a StackNode separator. + + The event. + The index of the separator on which the menu was invoked. + + + + This method is automatically called when an element of the stack is about to be dragged out of it. + + The GraphElement that is being dragged out of the stack. + + + + This method is automatically called when the style is updated. + + The new style. + + + + Removes the specified GraphElement from this StackNode. + + The GraphElement to remove. + + + + The TokenNode class includes methods for creating and managing a Node that resembles a capsule. The TokenNode class includes a title, an icon, one input Port, and one output Port. + + + + + Returns whether the TokenNode is highlighted. + + + + + The icon of the TokenNode. + + + + + The input Port of the TokenNode. + + + + + The output Port of the TokenNode. + + + + + Constructs a TokenNode with both input and output Ports. + + + + + + + Create a VisualElement inspector from a SerializedObject. + + + + + Force the InspectorElement to generate specific types of inspectors, instead of going by the normal checks that try to find a custom inspector and if that fails generates a default inspector. + + + + + InspectorElement constructor. + + Create a SerializedObject from given obj and automatically Bind() to it. + Determine whether to use normal Inspector generation or force a specific type of inspector (ie. force the default inspector). + + + + InspectorElement constructor. + + Create a SerializedObject from given obj and automatically Bind() to it. + Determine whether to use normal Inspector generation or force a specific type of inspector (ie. force the default inspector). + + + + InspectorElement constructor. + + Create a SerializedObject from given obj and automatically Bind() to it. + Determine whether to use normal Inspector generation or force a specific type of inspector (ie. force the default inspector). + + + + Force the InspectorElement to generate specific types of inspectors, instead of going by the normal checks that try to find a custom inspector and if that fails generates a default inspector. + + + + + Force generation of the custom inspector. If no custom inspector is found only a label will be generated, saying no inspector was found. + + + + + Force generation of the default inspector, even if a custom inspector exists. + + + + + Force generation of the custom IMGUI inspector. If no custom IMGUI inspector is found only a label will be generated, saying no IMGUI inspector was found. + + + + + This is the default mode. It just means: check for a custom inspector and if none is found generate the default inspector. + + + + + Instantiates a InspectorElement using the data read from a UXML file. + + + + + Constructor. + + + + + Makes a text field for entering an integer. + + + + + Modify the value using a 3D delta and a speed, typically coming from an input device. + + A vector used to compute the value change. + A multiplier for the value change. + The start value. + + + + Constructor. + + Maximum number of characters the field can take. + + + + Constructor. + + Maximum number of characters the field can take. + + + + Converts the given string to an integer. + + The string to convert. + + The integer parsed from the string. + + + + + Instantiates an IntegerField using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the IntegerField. + + + + + Constructor. + + + + + Initialize IntegerField properties using values from the attribute bag. + + The object to initialize. + The attribute bag. + The creation context; unused. + + + + Converts the given integer to a string. + + The integer to be converted to string. + + The integer as string. + + + + + An interface for toolbar items that display drop-down menus. + + + + + The drop-down menu for the element. + + + + + Base interface for UIElements text value fields. + + + + + The value of the field. + + + + + Modify the value using a 3D delta and a speed, typically coming from an input device. + + A vector used to compute the value change. + A multiplier for the value change. + The start value. + + + + A LayerField editor. + + + + + Unsuported. + + + + + Unsupported. + + + + + This is the index value of the Layer currently chosen in the LayerField. + + + + + Instantiates a LayerField using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the LayerField. + + + + + Constructor. + + + + + Initialize the traits. + + VisualElement that will be created and populated. + Bag of attributes where the data comes from. + Creation context, unused. + + + + Make a field for layer as masks. + + + + + Unsupported. + + + + + Unsupported. + + + + + Constructor. + + The mask to use for a first selection. + + + + Constructor. + + The mask to use for a first selection. + + + + Instantiates a LayerMaskField using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the LayerMaskField. + + + + + Constructor. + + + + + Makes a text field for entering long integers. + + + + + Modify the value using a 3D delta and a speed, typically coming from an input device. + + A vector used to compute the value change. + A multiplier for the value change. + The start value. + + + + Constructor. + + Maximum number of characters the field can take. + + + + Constructor. + + Maximum number of characters the field can take. + + + + Converts the given string to a long integer. + + The string to convert. + + The long integer parsed from the string. + + + + + Instantiates a LongField using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the LongField. + + + + + Constructor. + + + + + Initialize LongField properties using values from the attribute bag. + + The object to initialize. + The attribute bag. + The creation context; unused. + + + + Converts the given long integer to a string. + + The long integer to be converted to string. + + The long integer as string. + + + + + Make a field for masks. + + + + + Callback that provides a string representation used to populate the popup menu. + + + + + Callback that provides a string representation used to display the selected value. + + + + + Instantiates a MaskField using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the MaskField. + + + + + Constructor. + + + + + Initialize the UxmlTraits for MaskField. + + The VisualElement that will be populated. + The bag from which the attributes are taken. + The creation context, unused. + + + + Makes a field to receive any object type. + + + + + Allows Scene objects to be assigned to the field. + + + + + The type of the objects that can be assigned. + + + + + Constructor. + + + + + Set the value and, if different, notifies registers callbacks with a ChangeEvent<Object> + + The new value to be set. + + + + Instantiates an ObjectField using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the ObjectField. + + + + + Constructor. + + + + + Initialize ObjectField properties using values from the attribute bag. + + The object to initialize. + The attribute bag. + The creation context; unused. + + + + Generic popup selection field. + + + + + Callback that provides a string representation used to populate the popup menu. + + + + + Callback that provides a string representation used to display the selected value. + + + + + The currently selected index in the popup menu. + + + + + The currently selected value in the popup menu. + + + + + Construct a PopupField. + + + + + + + + + + Construct a PopupField. + + + + + + + + + + A SerializedProperty wrapper VisualElement that, on Bind(), will generate the correct field elements with the correct bindingPaths. + + + + + Optionally overwrite the label of the generate property field. If no label is provided the string will be taken from the SerializedProperty. + + + + + PropertyField constructor. + + Providing a SerializedProperty in the construct just sets the bindingPath. You will still have to call Bind() on the PropertyField afterwards. + Optionally overwrite the property label. + + + + PropertyField constructor. + + Providing a SerializedProperty in the construct just sets the bindingPath. You will still have to call Bind() on the PropertyField afterwards. + Optionally overwrite the property label. + + + + PropertyField constructor. + + Providing a SerializedProperty in the construct just sets the bindingPath. You will still have to call Bind() on the PropertyField afterwards. + Optionally overwrite the property label. + + + + Instantiates a PropertyField using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the PropertyField. + + + + + Constructor. + + + + + A Rect editor field. + + + + + Instantiates a RectField using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the RectField. + + + + + Constructor. + + + + + Initialize RectField properties using values from the attribute bag. + + The object to initialize. + The attribute bag. + The creation context; unused. + + + + A RectInt editor field. + + + + + Instantiates a RectIntField using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the RectIntField. + + + + + Constructor. + + + + + Initializes the UxmlTraits for the RectIntField. + + The VisualElement to be initialized. + Bags of attributes where the values come from. + Creation Context, unused. + + + + A TagField editor. + + + + + Unsupported. + + + + + Unsupported. + + + + + Name of the selected tag. + + + + + Instantiates a TagField using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the TagField. + + + + + Constructor. + + + + + Initialize the UxmlTraits for the TagField. + + The VisualElement that will be created and populated. + The bag from which the attributes will be taken. + The creation context, unused. + + + + Base class for text fields. + + + + + A string containing all characters allowed by the field. + + + + + The format string for the value. + + + + + The value held by the field. + + + + + Modify the value using a 3D delta and a speed, typically coming from an input device. + + A vector used to compute the value change. + A multiplier for the value change. + The start value. + + + + Set the value and, if different, notifies registers callbacks with a ChangeEvent. + + The new value to be set. + + + + Converts the given string to a value type. + + The string to convert. + + The value parsed from the string. + + + + + UxmlTraits for the TextValueField. + + + + + Constructor. + + + + + Converts the given value to a string. + + The value to be converted to string. + + The value as a string. + + + + + A toolbar for tool windows. + + + + + Constructor. + + + + + Instantiates a Toolbar using the data read from a UXML file. + + + + + Constructor. + + + + + A button for the toolbar. + + + + + Constructor. + + The action to be called when the button is pressed. + + + + Constructor. + + The action to be called when the button is pressed. + + + + Instantiates a ToolbarButton using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the ToolbarButton. + + + + + Constructor. + + + + + A toolbar spacer of flexible size. + + + + + Constructor. + + + + + Instantiates a ToolbarFlexSpacer using the data read from a UXML file. + + + + + Constructor. + + + + + A drop-down menu for the toolbar. + + + + + Constructor. + + + + + Instantiates a ToolbarMenu using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the ToolbarMenu. + + + + + Constructor. + + + + + Base class for menu-like toolbar elements. + + + + + The drop-down menu to be used by the toolbar menu element. + + + + + An extension class that handles menu management for elements that are implemented with the IToolbarMenuElement interface, but are identical to DropdownMenu. + + + + + Display the menu for the element. + + The element that is part of the menu to be displayed. + + + + A drop-down menu for the toolbar. + + + + + Constructor. + + + + + Instantiates a ToolbarPopup using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the ToolbarPopup. + + + + + Constructor. + + + + + The pop-up search field for the toolbar. The search field includes a menu button. + + + + + The menu used by the pop-up search field element. + + + + + Constructor. + + + + + Instantiates a ToolbarPopupSearchField using the data read from a UXML file. + + + + + Constructor. + + + + + A search field for the toolbar. + + + + + The object currently being exposed by the field. + + + + + Constructor. + + + + + Registers a callback to receive ChangeEvent events when the toolbar search field changes value. + + Callback to be notified. + + + + Unregisters this callback from receiving ChangeEvent<string> when value was changed by user input. + + The callback to unregister. + + + + This method is obsolete. Use ToolbarSearchField.value instead. + + The new value to be set. + + + + Sets the value for the toolbar search field without sending a change event. + + + + + + Instantiates a ToolbarSearchField using the data read from a UXML file. + + + + + Constructor. + + + + + A toolbar spacer of static size. + + + + + Constructor. + + + + + Instantiates a ToolbarSpacer using the data read from a UXML file. + + + + + Constructor. + + + + + A toggle for the toolbar. + + + + + Constructor. + + The action to be called when the toggle is pressed. + + + + Constructor. + + The action to be called when the toggle is pressed. + + + + Instantiates a ToolbarToggle using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the ToolbarToggle. + + + + + Constructor. + + + + + Editor helper functions for UIElements. + + + + + Creates a default CursorStyle property from the given MouseCursor. + + Default editor mouse cursor. + + A cursor style property. + + + + + Attribute that can be used on an assembly to define an XML namespace prefix for a namespace. + + + + + The namespace name. + + + + + The namespace prefix. + + + + + Constructor. + + The XML/C# namespace to which a prefix will be associated. + The prefix to associate to the namespace. + + + + A Vector2 editor field. + + + + + Constructor. + + + + + Instantiates a Vector2Field using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the Vector2Field. + + + + + Constructor. + + + + + Initialize Vector2Field properties using values from the attribute bag. + + The object to initialize. + The attribute bag. + The creation context; unused. + + + + A Vector2Int editor field. + + + + + Constructor. + + + + + Instantiates a Vector2IntField using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the Vector2IntField. + + + + + Constructor. + + + + + Initializes the UxmlTraits for the Vector2IntField. + + VisualElement to initialize. + Bag of attributes where to get them. + Creation Context, unused. + + + + A Vector3 editor field. + + + + + Constructor. + + + + + Instantiates a Vector3Field using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the Vetor3Field. + + + + + Constructor. + + + + + Initialize Vector3Field properties using values from the attribute bag. + + The object to initialize. + The attribute bag. + The creation context; unused. + + + + A Vector3Int editor field. + + + + + Constructor. + + + + + Instantiates a Vector3IntField using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the Vector3IntField. + + + + + Constructor. + + + + + Initializes the UxmlTraits for the Vector3IntField. + + [[VisualElement] to initialize. + Bag of attributes where to get them. + Context Creation, unused. + + + + A Vector4 editor field. + + + + + Constructor. + + + + + Instantiates a Vector4Field using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the Vector4Field. + + + + + Constructor. + + + + + Initialize Vector4Field properties using values from the attribute bag. + + The object to initialize. + The attribute bag. + + + + + Base class to derive custom Editors from. Use this to create your own custom inspectors and editors for your objects using UIElements. + + + + + Overwrite the default UIElements inspector with your own custom VisualElement. + + + + + Base class to derive custom property drawers from. Use this to create custom UIElements drawers for your own Serializable classes or for script variables with custom PropertyAttributes. + + + + + Overwrite default UIElements property field VisualElement with your own. + + Current property. + + Custom VisualElement property drawer. + + + + + Export package option. Multiple options can be combined together using the | operator. + + + + + Default mode. Will not include dependencies or subdirectories nor include Library assets unless specifically included in the asset list. + + + + + In addition to the assets paths listed, all dependent assets will be included as well. + + + + + The exported package will include all library assets, ie. the project settings located in the Library folder of the project. + + + + + The export operation will be run asynchronously and reveal the exported package file in a file browser window after the export is finished. + + + + + Will recurse through any subdirectories listed and include all assets inside them. + + + + + Evaluates simple math expressions; supports int float and operators: + - * % ^ ( ). + + + + + Evaluates a math expression and returns the result as a float or int. + + A string containing a mathematical expression (e.g. "4 + 3"). + + The result of the evaluation (0 for invalid expressions). + + + + + Lets you do move, copy, delete operations over files or directories. + + + + + Copies a file or a directory. + + + + + + + Copies the file or directory. + + + + + + + Deletes a file or a directory given a path. + + + + + + Returns a unique path in the Temp folder within your current project. + + + + + Moves a file or a directory from a given path to another path. + + + + + + + Replaces a directory. + + + + + + + Replaces a file. + + + + + + + Font rendering mode constants for TrueTypeFontImporter. + + + + + Use hinted font rendering without anti-aliasing. This is the crispest font rendering option, and may be most readable for small font sizes. + + + + + Use Anti-Aliased Font rendering with hinting. This forces character lines to run along pixel boundaries. + + + + + Use the OS default font rendering mode. This mode is only available for dynamic fonts, as static fonts are generated at build time. + + + + + Use Anti-Aliased Font rendering. When using dynamic fonts, this is the mode which is fastest in rendering font textures. + + + + + Texture case constants for TrueTypeFontImporter. + + + + + Import basic ASCII character set. + + + + + Only import lower case ASCII character set. + + + + + Only import upper case ASCII character set. + + + + + Custom set of characters. + + + + + Render characters into font texture at runtime as needed. + + + + + Import a set of Unicode characters common for latin scripts. + + + + + Options for AssetDatabase.ForceReserializeAssets. + + + + + Specifies that AssetDatabase.ForceReserializeAssets should load, upgrade, and save the assets at the paths passed to the function, but not their accompanying .meta files. + + + + + Specifies that AssetDatabase.ForceReserializeAssets should load, upgrade, and save both the assets at the paths passed to the function, and also their accompanying .meta files. + + + + + Specifies that AssetDatabase.ForceReserializeAssets should load, upgrade, and save the .meta files for the assets at the paths passed to the function, but not the assets themselves. + + + + + GameObject utility functions. + + + + + Returns true if the passed in StaticEditorFlags are set on the GameObject specified. + + The GameObject to check. + The flags you want to check. + + Whether the GameObject's static flags match the flags specified. + + + + + You can use this method after parenting one GameObject to another to ensure the child GameObject has a unique name compared to its siblings in the hierarchy. + + The GameObject whose name you want to ensure is unique. + + + + Get the navmesh area index for the GameObject. + + GameObject to query. + + NavMesh area index. + + + + + Get the navmesh area index from the area name. + + NavMesh area name to query. + + The NavMesh area index. If there is no NavMesh area with the requested name, the return value is -1. + + + + + Get all the navmesh area names. + + + Names of all the NavMesh areas. + + + + + Get the navmesh layer for the GameObject. + + The GameObject to check. + + The navmesh layer for the GameObject specified. + + + + + Get the navmesh layer from the layer name. + + The name of the navmesh layer. + + The layer number of the navmesh layer name specified. + + + + + Get all the navmesh layer names. + + + An array of the names of all navmesh layers. + + + + + Gets the StaticEditorFlags of the GameObject specified. + + The GameObject whose flags you are interested in. + + The static editor flags of the GameObject specified. + + + + + You can use this method before instantiating a new sibling, or before parenting one GameObject to another, to ensure the new child GameObject has a unique name compared to its siblings in the hierarchy. + + Target parent for a new GameObject. Null means root level. + Requested name for a new GameObject. + + Unique name for a new GameObject. + + + + + Set the navmesh area for the gameobject. + + GameObject to modify. + NavMesh area index to set. + + + + Set the navmesh layer for the GameObject. + + The GameObject on which to set the navmesh layer. + The layer number you want to set. + + + + Sets the parent and gives the child the same layer and position. + + The GameObject that should have a new parent set. + The GameObject that the child should get as a parent and have position and layer copied from. If null, this function does nothing. + + + + Sets the static editor flags on the specified GameObject. + + The GameObject whose static editor flags you want to set. + The flags to set on the GameObject. + + + + GenericMenu lets you create custom context menus and dropdown menus. + + + + + Allow the menu to have multiple items with the same name. + + + + + Add a disabled item to the menu. + + The GUIContent to display as a disabled menu item. + + + + Add a disabled item to the menu. + + The GUIContent to display as a disabled menu item. + Specifies whether to show that the item is currently activated (i.e. a tick next to the item in the menu). + + + + Add an item to the menu. + + The GUIContent to add as a menu item. + Specifies whether to show the item is currently activated (i.e. a tick next to the item in the menu). + The function to call when the menu item is selected. + + + + Add an item to the menu. + + The GUIContent to add as a menu item. + Specifies whether to show the item is currently activated (i.e. a tick next to the item in the menu). + The function to call when the menu item is selected. + The data to pass to the function called when the item is selected. + + + + Add a seperator item to the menu. + + The path to the submenu, if adding a separator to a submenu. When adding a separator to the top level of a menu, use an empty string as the path. + + + + Show the menu at the given screen rect. + + The position at which to show the menu. + + + + Get number of items in the menu. + + + The number of items in the menu. + + + + + Callback function, called when a menu item is selected. + + + + + Callback function with user data, called when a menu item is selected. + + The data to pass through to the callback function. + + + + Show the menu under the mouse when right-clicked. + + + + + Determines how a gizmo is drawn or picked in the Unity editor. + + + + + Draw the gizmo if it is active (shown in the inspector). + + + + + Draw the gizmo if it is selected or it is a child/descendent of the selected. + + + + + Draw the gizmo if it is not selected. + + + + + Draw the gizmo if it is not selected and also no parent/ancestor is selected. + + + + + The gizmo can be picked in the editor. + + + + + Draw the gizmo if it is selected. + + + + + Enum used to specify the graphics jobs mode to use. + + + + + Legacy graphics jobs. + + + + + Native graphics jobs. + + + + + Default built-in brush for painting or erasing tiles and/or gamobjects on a grid. + + + + + Number of brush cells in the brush. + + + + + All the brush cells the brush holds. + + + + + Pivot of the brush. + + + + + Size of the brush in cells. + + + + + Erases tiles and GameObjects from given bounds within the selected layers. + + Grid to erase data from. + Target of the erase operation. By default the currently selected GameObject. + The bounds to erase data from. + + + + Box fills tiles and GameObjects into given bounds within the selected layers. + + Grid to box fill data to. + Target of the box fill operation. By default the currently selected GameObject. + The bounds to box fill data into. + + + + Brush Cell stores the data to be painted in a grid cell. + + + + + Color to tint the tile when painting. + + + + + The transform matrix of the brush cell. + + + + + Tile to be placed when painting. + + + + + Erases tiles and GameObjects in a given position within the selected layers. + + Grid used for layout. + Target of the erase operation. By default the currently selected GameObject. + The coordinates of the cell to erase data from. + + + + Flips the brush in the given axis. + + Axis to flip by. + Cell Layout for flipping. + + + + Flood fills tiles and GameObjects starting from a given position within the selected layers. + + Grid used for layout. + Target of the flood fill operation. By default the currently selected GameObject. + Starting position of the flood fill. + + + + Gets the index to the GridBrush.BrushCell based on the position of the BrushCell. + + Position of the BrushCell. + X Position of the BrushCell. + Y Position of the BrushCell. + Z Position of the BrushCell. + X Size of Brush. + Y Size of Brush. + Z Size of Brush. + + Index to the BrushCell. + + + + + Gets the index to the GridBrush.BrushCell based on the position of the BrushCell. + + Position of the BrushCell. + X Position of the BrushCell. + Y Position of the BrushCell. + Z Position of the BrushCell. + X Size of Brush. + Y Size of Brush. + Z Size of Brush. + + Index to the BrushCell. + + + + + Gets the index to the GridBrush.BrushCell based on the position of the BrushCell. + + Position of the BrushCell. + X Position of the BrushCell. + Y Position of the BrushCell. + Z Position of the BrushCell. + X Size of Brush. + Y Size of Brush. + Z Size of Brush. + + Index to the BrushCell. + + + + + Gets the index to the GridBrush.BrushCell based on the position of the BrushCell. Wraps each coordinate if it is larger than the size of the GridBrush. + + X Position of the BrushCell. + Y Position of the BrushCell. + Z Position of the BrushCell. + + Index to the BrushCell. + + + + + Initializes the content of the GridBrush. + + Size of the GridBrush. + Pivot point of the GridBrush. + + + + Initializes the content of the GridBrush. + + Size of the GridBrush. + Pivot point of the GridBrush. + + + + MoveEnd is called when user has ended the move of the area previously selected with the selection marquee. + + Grid used for layout. + Target of the move operation. By default the currently selected GameObject. + Position where the move operation has ended. + + + + MoveEnd is called when user starts moving the area previously selected with the selection marquee. + + Grid used for layout. + Target of the move operation. By default the currently selected GameObject. + Position where the move operation has started. + + + + Paints tiles and GameObjects into a given position within the selected layers. + + Grid used for layout. + Target of the paint operation. By default the currently selected GameObject. + The coordinates of the cell to paint data to. + + + + Picks tiles from selected Tilemap|tile maps and child GameObjects, given the coordinates of the cells. + + Grid to pick data from. + Target of the picking operation. By default the currently selected GameObject. + The coordinates of the cells to paint data from. + Pivot of the picking brush. + + + + Clear all data of the brush. + + + + + Rotates the brush by 90 degrees in the given direction. + + Direction to rotate by. + Cell Layout for rotating. + + + + Sets a tint color at the position in the brush. + + Position to set the color in the brush. + Tint color to set in the brush. + + + + Sets a transform matrix at the position in the brush. This matrix is used specifically for tiles on a Tilemap and not GameObjects of the brush cell. + + Position to set the transform matrix in the brush. + Transform matrix to set in the brush. + + + + Sets a Tile at the position in the brush. + + Position to set the tile in the brush. + Tile to set in the brush. + + + + Updates the size, pivot and the number of layers of the brush. + + New size of the brush. + New pivot of the brush. + + + + Editor for GridBrush. + + + + + The GridBrush that is the target for this editor. + + + + + Returns all valid targets that the brush can edit. + + + + + Does a preview of what happens when a GridBrush.BoxFill is done with the same parameters. + + Grid to box fill data to. + Target of box fill operation. By default the currently selected GameObject. + The bounds to box fill data to. + + + + Clears any preview drawn previously by the GridBrushEditor. + + + + + Does a preview of what happens when a GridBrush.FloodFill is done with the same parameters. + + Grid to paint data to. + Target of the flood fill operation. By default the currently selected GameObject. + The coordinates of the cell to flood fill data to. + + + + Callback for painting the GUI for the GridBrush in the Scene View. + + Grid that the brush is being used on. + Target of the GridBrushBase.Tool operation. By default the currently selected GameObject. + Current selected location of the brush. + Current GridBrushBase.Tool selected. + Whether brush is being used. + + + + Callback for drawing the Inspector GUI when there is an active GridSelection made in a Tilemap. + + + + + Paints preview data into a cell of a grid given the coordinates of the cell. + + Grid to paint data to. + Target of the paint operation. By default the currently selected GameObject. + The coordinates of the cell to paint data to. + + + + Callback for registering an Undo action before the GridBrushBase does the current GridBrushBase.Tool action. + + Target of the GridBrushBase.Tool operation. By default the currently selected GameObject. + Current GridBrushBase.Tool selected. + + + + Base class for Grid Brush Editor. + + + + + Returns all valid targets that the brush can edit. + + + + + Callback when the mouse cursor enters a paintable region. + + + + + Callback when the mouse cursor leaves a paintable region. + + + + + Callback for painting the inspector GUI for the GridBrush in the tilemap palette. + + + + + Callback for painting the GUI for the GridBrush in the Scene view. + + Grid that the brush is being used on. + Target of the GridBrushBase.Tool operation. By default the currently selected GameObject. + Current selected location of the brush. + Current GridBrushBase.Tool selected. + Whether is brush is being used. + + + + Callback for drawing the Inspector GUI when there is an active GridSelection made in a GridLayout. + + + + + Callback when a GridBrushBase.Tool is activated. + + Tool that is activated. + + + + Callback when a GridBrushBase.Tool is deactivated. + + Tool that is deactivated. + + + + Callback for registering an Undo action before the GridBrushBase does the current GridBrushBase.Tool action. + + Target of the GridBrushBase.Tool operation. By default the currently selected GameObject. + Current GridBrushBase.Tool selected. + + + + Use this attribute to add an option to customize the sorting of Active Targets in the Active Tilemap list of the Tile Palette window. + + + + + GridPalette stores settings for Palette assets when shown in the Palette window. + + + + + Determines the sizing of cells for a Palette. + + + + + Controls the sizing of cells for a Palette. + + + + + Automatically resizes the Palette cells by the size of Sprites in the Palette. + + + + + Size of Palette cells will be changed manually by the user. + + + + + Stores the selection made on a GridLayout. + + + + + Whether there is an active GridSelection made on a GridLayout. + + + + + The Grid of the target of the active GridSelection. + + + + + Callback for when the active GridSelection has changed. + + Callback. + + + + The cell coordinates of the active GridSelection made on the GridLayout. + + + + + The GameObject of the GridLayout where the active GridSelection was made. + + + + + Clears the active GridSelection. + + + + + Creates a new GridSelection and sets it as the active GridSelection. + + The target GameObject for the GridSelection. + The cell coordinates of selection made. + + + + Base class for PropertyDrawer and DecoratorDrawer. + + + + + Custom 3D GUI controls and drawing in the Scene view. + + + + + Color to use for handles that represent the center of something. + + + + + Colors of the handles. + + + + + Setup viewport and stuff for a current camera. + + + + + The inverse of the matrix for all handle operations. + + + + + Are handles lit? + + + + + Matrix for all handle operations. + + + + + Color to use to highlight an unselected handle currently under the mouse pointer. + + + + + Soft color to use for for general things. + + + + + Color to use for the currently active handle. + + + + + Color to use for handles that manipulates the X coordinate of something. + + + + + Color to use for handles that manipulates the Y coordinate of something. + + + + + Color to use for handles that manipulates the Z coordinate of something. + + + + + zTest of the handles. + + + + + Draw an arrow like those used by the move tool. + + The control ID for the handle. + The position of the handle in the space of Handles.matrix. + The rotation of the handle in the space of Handles.matrix. + The size of the handle in the space of Handles.matrix. Use HandleUtility.GetHandleSize if you want a constant screen-space size. + Event type for the handle to act upon. By design it handles EventType.Layout and EventType.Repaint events. + + + + Begin a 2D GUI block inside the 3D handle GUI. + + + + + Make a 3D Button. + + The position to draw the button in the space of Handles.matrix. + The rotation of the button in the space of Handles.matrix. + The visual size of the handle. Use HandleUtility.GetHandleSize if you want a constant screen-space size. + The size of the button for the purpose of detecting a click. Use HandleUtility.GetHandleSize if you want a constant screen-space size. + The draw style of the button. + + True when the user clicks the button. + + + + + The function to use for drawing the handle e.g. Handles.RectangleCap. + + The control ID for the handle. + The position of the handle in the space of Handles.matrix. + The rotation of the handle in the space of Handles.matrix. + The size of the handle in world-space units. + Event type for the handle to act upon. By design it handles EventType.Layout and EventType.Repaint events. + + + + Draw a circle handle. Pass this into handle functions. + + The control ID for the handle. + The position of the handle in the space of Handles.matrix. + The rotation of the handle in the space of Handles.matrix. + The size of the handle in the space of Handles.matrix. Use HandleUtility.GetHandleSize if you want a constant screen-space size. + Event type for the handle to act upon. By design it handles EventType.Layout and EventType.Repaint events. + + + + Clears the camera. + + Where in the Scene to clear. + The camera to clear. + + + + Draw a cone handle. Pass this into handle functions. + + The control ID for the handle. + The position of the handle in the space of Handles.matrix. + The rotation of the handle in the space of Handles.matrix. + The size of the handle in the space of Handles.matrix. Use HandleUtility.GetHandleSize if you want a constant screen-space size. + Event type for the handle to act upon. By design it handles EventType.Layout and EventType.Repaint events. + + + + Draw a cube handle. Pass this into handle functions. + + The control ID for the handle. + The position of the handle in the space of Handles.matrix. + The rotation of the handle in the space of Handles.matrix. + The size of the handle in the space of Handles.matrix. Use HandleUtility.GetHandleSize if you want a constant screen-space size. + Event type for the handle to act upon. By design it handles EventType.Layout and EventType.Repaint events. + + + + Draw a cylinder handle. Pass this into handle functions. + + The control ID for the handle. + The position of the handle in the space of Handles.matrix. + The rotation of the handle in the space of Handles.matrix. + The size of the handle in the space of Handles.matrix. Use HandleUtility.GetHandleSize if you want a constant screen-space size. + Event type for the handle to act upon. By design it handles EventType.Layout and EventType.Repaint events. + + + + Make a 3D disc that can be dragged with the mouse. + + Control id of the handle. + The rotation of the disc. + The center of the disc. + The axis to rotate around. + The size of the disc in world space. + If true, only the front-facing half of the circle is draw / draggable. This is useful when you have many overlapping rotation axes (like in the default rotate tool) to avoid clutter. + The grid size to snap to. + + The new rotation value modified by the user's interaction with the handle. If the user has not moved the handle, it will return the same value as you passed into the function. + + + + + Make a 3D disc that can be dragged with the mouse. + + Control id of the handle. + The rotation of the disc. + The center of the disc. + The axis to rotate around. + The size of the disc in world space. + If true, only the front-facing half of the circle is draw / draggable. This is useful when you have many overlapping rotation axes (like in the default rotate tool) to avoid clutter. + The grid size to snap to. + + The new rotation value modified by the user's interaction with the handle. If the user has not moved the handle, it will return the same value as you passed into the function. + + + + + Draw a dot handle. Pass this into handle functions. + + The control ID for the handle. + The position of the handle in the space of Handles.matrix. + The rotation of the handle in the space of Handles.matrix. + The size of the handle in the space of Handles.matrix. Use HandleUtility.GetHandleSize if you want a constant screen-space size. + Event type for the handle to act upon. By design it handles EventType.Layout and EventType.Repaint events. + + + + Draw anti-aliased convex polygon specified with point array. + + List of points describing the convex polygon. + + + + Draw anti-aliased line specified with point array and width. + + The AA texture used for rendering. + The width of the line. + List of points to build the line from. + + + + + Draw anti-aliased line specified with point array and width. + + The AA texture used for rendering. + The width of the line. + List of points to build the line from. + + + + + Draw anti-aliased line specified with point array and width. + + The AA texture used for rendering. + The width of the line. + List of points to build the line from. + + + + + Draw anti-aliased line specified with point array and width. + + The AA texture used for rendering. + The width of the line. + List of points to build the line from. + + + + + Draw anti-aliased line specified with point array and width. + + The AA texture used for rendering. + The width of the line. + List of points to build the line from. + + + + + Draw textured bezier line through start and end points with the given tangents. + + The start point of the bezier line. + The end point of the bezier line. + The start tangent of the bezier line. + The end tangent of the bezier line. + The color to use for the bezier line. + The texture to use for drawing the bezier line. + The width of the bezier line. + + + + Draws a camera inside a rectangle. + + The area to draw the camera within in GUI coordinates. + The camera to draw. + How the camera is drawn (textured, wireframe, etc). + Parameters of grid drawing (can be omitted). + + + + Draws a camera inside a rectangle. + + The area to draw the camera within in GUI coordinates. + The camera to draw. + How the camera is drawn (textured, wireframe, etc.). + + + + Draws a camera inside a rectangle. + + The area to draw the camera within in GUI coordinates. + The camera to draw. + How the camera is drawn (textured, wireframe, etc.). + + + + Draw a dotted line from p1 to p2. + + The start point. + The end point. + The size in pixels for the lengths of the line segments and the gaps between them. + + + + Draw a list of dotted line segments. + + A list of pairs of points that represent the start and end of line segments. + The size in pixels for the lengths of the line segments and the gaps between them. + + + + Draw a list of indexed dotted line segments. + + A list of points. + A list of pairs of indices to the start and end points of the line segments. + The size in pixels for the lengths of the line segments and the gaps between them. + + + + Draw the Gizmos for the given camera. + + + + + + Disposable helper struct for automatically setting and reverting Handles.color and/or Handles.matrix. + + + + + The value of Handles.color at the time this DrawingScope was created. + + + + + The value of Handles.matrix at the time this DrawingScope was created. + + + + + Create a new DrawingScope and set Handles.color and/or Handles.matrix to the specified values. + + The matrix to use for displaying Handles inside the scope block. + The color to use for displaying Handles inside the scope block. + + + + Create a new DrawingScope and set Handles.color and/or Handles.matrix to the specified values. + + The matrix to use for displaying Handles inside the scope block. + The color to use for displaying Handles inside the scope block. + + + + Create a new DrawingScope and set Handles.color and/or Handles.matrix to the specified values. + + The matrix to use for displaying Handles inside the scope block. + The color to use for displaying Handles inside the scope block. + + + + Automatically reverts Handles.color and Handles.matrix to their values prior to entering the scope, when the scope is exited. You do not need to call this method manually. + + + + + Draw a line from p1 to p2. + + + + + + + Draw a list of line segments. + + A list of pairs of points that represent the start and end of line segments. + + + + Draw a list of indexed line segments. + + A list of points. + A list of pairs of indices to the start and end points of the line segments. + + + + Draw a line going through the list of points. + + + + + + Draw a camera facing selection frame. + + + + + + + + + + Draw a circular sector (pie piece) in 3D space. + + The center of the circle. + The normal of the circle. + The direction of the point on the circumference, relative to the center, where the sector begins. + The angle of the sector, in degrees. + The radius of the circle + +Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized handles. + + + + Draw a solid flat disc in 3D space. + + The center of the dics. + The normal of the disc. + The radius of the dics + +Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized handles. + + + + Draw a solid outlined rectangle in 3D space. + + The 4 vertices of the rectangle in world coordinates. + The color of the rectangle's face. + The outline color of the rectangle. + + + + Draw a circular arc in 3D space. + + The center of the circle. + The normal of the circle. + The direction of the point on the circle circumference, relative to the center, where the arc begins. + The angle of the arc, in degrees. + The radius of the circle + +Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized handles. + + + + Draw a wireframe box with center and size. + + + + + + + Draw the outline of a flat disc in 3D space. + + The center of the disc. + The normal of the disc. + The radius of the disc. + + + + End a 2D GUI block and get back to the 3D handle GUI. + + + + + Make an unconstrained movement handle. + + The position of the handle in the space of Handles.matrix. + The rotation of the handle in the space of Handles.matrix. + The size of the handle in the space of Handles.matrix. Use HandleUtility.GetHandleSize if you want a constant screen-space size. + The snap increment on all axes. See Handles.SnapValue. + The function to call for doing the actual drawing. + The control ID for the handle. + + The new value modified by the user's interaction with the handle. If the user has not moved the handle, it will return the same value as you passed into the function. + + + + + Make an unconstrained movement handle. + + The position of the handle in the space of Handles.matrix. + The rotation of the handle in the space of Handles.matrix. + The size of the handle in the space of Handles.matrix. Use HandleUtility.GetHandleSize if you want a constant screen-space size. + The snap increment on all axes. See Handles.SnapValue. + The function to call for doing the actual drawing. + The control ID for the handle. + + The new value modified by the user's interaction with the handle. If the user has not moved the handle, it will return the same value as you passed into the function. + + + + + TODO. + + + + + + + + + + Make an unconstrained rotation handle. + + Control id of the handle. + Orientation of the handle. + Center of the handle in 3D space. + The size of the handle. + +Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized handles. + + The new rotation value modified by the user's interaction with the handle. If the user has not moved the handle, it will return the same value as you passed into the function. + + + + + Make an unconstrained rotation handle. + + Control id of the handle. + Orientation of the handle. + Center of the handle in 3D space. + The size of the handle. + +Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized handles. + + The new rotation value modified by the user's interaction with the handle. If the user has not moved the handle, it will return the same value as you passed into the function. + + + + + Get the width and height of the main game view. + + + + + Make a text label positioned in 3D space. + + Position in 3D space as seen from the current handle camera. + Text to display on the label. + Texture to display on the label. + Text, image and tooltip for this label. + The style to use. If left out, the label style from the current GUISkin is used. + +Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized handles. + + + + Make a text label positioned in 3D space. + + Position in 3D space as seen from the current handle camera. + Text to display on the label. + Texture to display on the label. + Text, image and tooltip for this label. + The style to use. If left out, the label style from the current GUISkin is used. + +Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized handles. + + + + Make a text label positioned in 3D space. + + Position in 3D space as seen from the current handle camera. + Text to display on the label. + Texture to display on the label. + Text, image and tooltip for this label. + The style to use. If left out, the label style from the current GUISkin is used. + +Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized handles. + + + + Make a text label positioned in 3D space. + + Position in 3D space as seen from the current handle camera. + Text to display on the label. + Texture to display on the label. + Text, image and tooltip for this label. + The style to use. If left out, the label style from the current GUISkin is used. + +Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized handles. + + + + Make a text label positioned in 3D space. + + Position in 3D space as seen from the current handle camera. + Text to display on the label. + Texture to display on the label. + Text, image and tooltip for this label. + The style to use. If left out, the label style from the current GUISkin is used. + +Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized handles. + + + + Retuns an array of points to representing the bezier curve. + + + + + + + + + + Make a position handle. + + Center of the handle in 3D space. + Orientation of the handle in 3D space. + + The new value modified by the user's interaction with the handle. If the user has not moved the handle, it will return the same value as you passed into the function. + + + + + Make a Scene view radius handle. + + Orientation of the handle. + Center of the handle in 3D space. + Radius to modify. + Whether to omit the circular outline of the radius and only draw the point handles. + + The new value modified by the user's interaction with the handle. If the user has not moved the handle, it will return the same value as you passed into the function. + +Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized handles. + + + + + Make a Scene view radius handle. + + Orientation of the handle. + Center of the handle in 3D space. + Radius to modify. + Whether to omit the circular outline of the radius and only draw the point handles. + + The new value modified by the user's interaction with the handle. If the user has not moved the handle, it will return the same value as you passed into the function. + +Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized handles. + + + + + Draw a rectangle handle. Pass this into handle functions. + + The control ID for the handle. + The position of the handle in the space of Handles.matrix. + The rotation of the handle in the space of Handles.matrix. + The size of the handle in the space of Handles.matrix. Use HandleUtility.GetHandleSize if you want a constant screen-space size. + Event type for the handle to act upon. By design it handles EventType.Layout and EventType.Repaint events. + + + + Make a Scene view rotation handle. + + Orientation of the handle. + Center of the handle in 3D space. + + The new rotation value modified by the user's interaction with the handle. If the user has not moved the handle, it will return the same value as you passed into the function. + + + + + Make a Scene view scale handle. + + Scale to modify. + The position of the handle. + The rotation of the handle. + Allows you to scale the size of the handle on-scren. + + The new value modified by the user's interaction with the handle. If the user has not moved the handle, it will return the same value as you passed into the function. + + + + + Make a directional scale slider. + + The value the user can modify. + The position of the handle in the space of Handles.matrix. + The direction of the handle in the space of Handles.matrix. + The rotation of the handle in the space of Handles.matrix. + The size of the handle in the space of Handles.matrix. Use HandleUtility.GetHandleSize if you want a constant screen-space size. + The snap increment. See Handles.SnapValue. + + The new value modified by the user's interaction with the handle. If the user has not moved the handle, it will return the same value as you passed into the function. + + + + + Make a 3D handle that scales a single float. + + The value the user can modify. + The position of the handle in the space of Handles.matrix. + The rotation of the handle in the space of Handles.matrix. + The size of the handle in the space of Handles.matrix. Use HandleUtility.GetHandleSize if you want a constant screen-space size. + The snap increment. See Handles.SnapValue. + The function to call for doing the actual drawing. + + The new value modified by the user's interaction with the handle. If the user has not moved the handle, it will return the same value as you passed into the function. + + + + + Set the current camera so all Handles and Gizmos are draw with its settings. + + + + + + + Set the current camera so all Handles and Gizmos are draw with its settings. + + + + + + + A delegate type for getting a handle's size based on its current position. + + The current position of the handle in the space of Handles.matrix. + + + + Make a 3D slider that moves along one axis. + + The position of the current point in the space of Handles.matrix. + The direction axis of the slider in the space of Handles.matrix. + The size of the handle in the space of Handles.matrix. Use HandleUtility.GetHandleSize if you want a constant screen-space size. + The snap increment. See Handles.SnapValue. + The function to call for doing the actual drawing. By default it is Handles.ArrowHandleCap, but any function that has the same signature can be used. + + The new value modified by the user's interaction with the handle. If the user has not moved the handle, it will return the position value passed into the function. + + + + + Make a 3D slider that moves along one axis. + + The position of the current point in the space of Handles.matrix. + The direction axis of the slider in the space of Handles.matrix. + The size of the handle in the space of Handles.matrix. Use HandleUtility.GetHandleSize if you want a constant screen-space size. + The snap increment. See Handles.SnapValue. + The function to call for doing the actual drawing. By default it is Handles.ArrowHandleCap, but any function that has the same signature can be used. + + The new value modified by the user's interaction with the handle. If the user has not moved the handle, it will return the position value passed into the function. + + + + + Make a 3D slider that moves along a plane defined by two axes. + + (optional) override the default ControlID for this Slider2D instance. + The position of the current point in the space of Handles.matrix. + (optional) renders the Slider2D at handlePos, but treats the Slider2D's origin as handlePos + offset. Useful for Slider2D instances that are placed/rendered relative to another object or handle. + The direction of the handle in the space of Handles.matrix, only used for rendering of the handle. + The first axis of the slider's plane of movement in the space of Handles.matrix. + The second axis of the slider's plane of movement in the space of Handles.matrix. + The size of the handle in the space of Handles.matrix. Use HandleUtility.GetHandleSize if you want a constant screen-space size. + (float or Vector2) The snap increment along both axes, either uniform or per-axis. See Handles.SnapValue. + (default: false) render a rectangle around the handle when dragging. + The function to call for doing the actual drawing. + + The new value modified by the user's interaction with the handle. If the user has not moved the handle, it will return the position value passed into the function. + + + + + Make a 3D slider that moves along a plane defined by two axes. + + (optional) override the default ControlID for this Slider2D instance. + The position of the current point in the space of Handles.matrix. + (optional) renders the Slider2D at handlePos, but treats the Slider2D's origin as handlePos + offset. Useful for Slider2D instances that are placed/rendered relative to another object or handle. + The direction of the handle in the space of Handles.matrix, only used for rendering of the handle. + The first axis of the slider's plane of movement in the space of Handles.matrix. + The second axis of the slider's plane of movement in the space of Handles.matrix. + The size of the handle in the space of Handles.matrix. Use HandleUtility.GetHandleSize if you want a constant screen-space size. + (float or Vector2) The snap increment along both axes, either uniform or per-axis. See Handles.SnapValue. + (default: false) render a rectangle around the handle when dragging. + The function to call for doing the actual drawing. + + The new value modified by the user's interaction with the handle. If the user has not moved the handle, it will return the position value passed into the function. + + + + + Make a 3D slider that moves along a plane defined by two axes. + + (optional) override the default ControlID for this Slider2D instance. + The position of the current point in the space of Handles.matrix. + (optional) renders the Slider2D at handlePos, but treats the Slider2D's origin as handlePos + offset. Useful for Slider2D instances that are placed/rendered relative to another object or handle. + The direction of the handle in the space of Handles.matrix, only used for rendering of the handle. + The first axis of the slider's plane of movement in the space of Handles.matrix. + The second axis of the slider's plane of movement in the space of Handles.matrix. + The size of the handle in the space of Handles.matrix. Use HandleUtility.GetHandleSize if you want a constant screen-space size. + (float or Vector2) The snap increment along both axes, either uniform or per-axis. See Handles.SnapValue. + (default: false) render a rectangle around the handle when dragging. + The function to call for doing the actual drawing. + + The new value modified by the user's interaction with the handle. If the user has not moved the handle, it will return the position value passed into the function. + + + + + Make a 3D slider that moves along a plane defined by two axes. + + (optional) override the default ControlID for this Slider2D instance. + The position of the current point in the space of Handles.matrix. + (optional) renders the Slider2D at handlePos, but treats the Slider2D's origin as handlePos + offset. Useful for Slider2D instances that are placed/rendered relative to another object or handle. + The direction of the handle in the space of Handles.matrix, only used for rendering of the handle. + The first axis of the slider's plane of movement in the space of Handles.matrix. + The second axis of the slider's plane of movement in the space of Handles.matrix. + The size of the handle in the space of Handles.matrix. Use HandleUtility.GetHandleSize if you want a constant screen-space size. + (float or Vector2) The snap increment along both axes, either uniform or per-axis. See Handles.SnapValue. + (default: false) render a rectangle around the handle when dragging. + The function to call for doing the actual drawing. + + The new value modified by the user's interaction with the handle. If the user has not moved the handle, it will return the position value passed into the function. + + + + + Rounds the value val to the closest multiple of snap (snap can only be positive). + + + + + The rounded value, if snap is positive, and val otherwise. + + + + + Draw a sphere handle. Pass this into handle functions. + + The control ID for the handle. + The position of the handle in the space of Handles.matrix. + The rotation of the handle in the space of Handles.matrix. + Event type for the handle to act upon. By design it handles EventType.Layout and EventType.Repaint events. + The size of the handle in the space of Handles.matrix. Use HandleUtility.GetHandleSize if you want a constant screen-space size. + + + + Helper functions for Scene View style 3D GUI. + + + + + Get standard acceleration for dragging values (Read Only). + + + + + Get nice mouse delta to use for dragging a float value (Read Only). + + + + + Get nice mouse delta to use for zooming (Read Only). + + + + + Record a distance measurement from a handle. + + + + + + + Add the ID for a default control. This will be picked if nothing else is. + + + + + + Map a mouse drag onto a movement along a line in 3D space. + + The source point of the drag. + The destination point of the drag. + The 3D position the dragged object had at src ray. + 3D direction of constrained movement. + + The distance travelled along constraintDir. + + + + + Get the point on an arc (in 3D space) which is closest to the current mouse position. + + + + + + + + + + Get the point on an disc (in 3D space) which is closest to the current mouse position. + + + + + + + + Get the point on a polyline (in 3D space) which is closest to the current mouse position. + + + + + + Calculate distance between a point and a Bezier curve. + + + + + + + + + + Calculate distance between a point and a line. + + + + + + + + Distance from a point p in 2d to a line defined by two points a and b. + + + + + + + + Distance from a point p in 2d to a line segment defined by two points a and b. + + + + + + + + Pixel distance from mouse pointer to a 3D section of a disc. + + + + + + + + + + Pixel distance from mouse pointer to camera facing circle. + + + + + + + Pixel distance from mouse pointer to a 3D disc. + + + + + + + + Pixel distance from mouse pointer to line. + + + + + + + Pixel distance from mouse pointer to a polyline. + + + + + + Pixel distance from mouse pointer to a rectangle on screen. + + + + + + + + Get world space size of a manipulator handle at given position. + + The position of the handle in 3d space. + + A constant screen-size for the handle, based on the distance between from the supplied handle's position to the camera. + + + + + Converts a 2D GUI position to screen pixel coordinates. + + + + + + Convert 2D GUI position to a world space ray. + + + + + + Pick game object closest to specified position. + + Select Prefab. + Returns index into material array of the Renderer component that is closest to specified position. + + + + + Pick game object closest to specified position. + + Select Prefab. + Returns index into material array of the Renderer component that is closest to specified position. + + + + + Pick GameObjects that lie within a specified screen rectangle. + + An screen rectangle specified with pixel coordinates. + + + + + + + + + + + Returns the parameter for the projection of the point on the given line. + + + + + + + + Retrieve all camera settings. + + + + + + Project point onto a line. + + + + + + + + Store all camera settings. + + + + + + Casts ray against the Scene and report if an object lies in its path. + + + + A boxed RaycastHit, null if nothing hit it. + + + + + Repaint the current view. + + + + + Calculate a rectangle to display a 2D GUI element near a projected point in 3D space. + + The world-space position to use. + The content to make room for. + The style to use. The style's alignment. + + + + Convert a world space point to a 2D GUI position. + + Point in world space. + + + + Convert a world space point to a 2D GUI position. + + Point in world space. + + A Vector3 where the x and y values relate to the 2D GUI position. The z value is the distance in world units from the camera. + + + + + Helper class to access Unity documentation. + + + + + Open url in the default web browser. + + + + + + Get the URL for this object's documentation. + + The object to retrieve documentation for. + + The documentation URL for the object. Note that this could use the http: or file: schemas. + + + + + Is there a help page for this object? + + + + + + Show help page for this object. + + + + + + Show a help page. + + + + + + Use this class to highlight elements in the editor for use in in-editor tutorials and similar. + + + + + Is there currently an active highlight? + + + + + The rect in screenspace of the current active highlight. + + + + + The text of the current active highlight. + + + + + Is the current active highlight visible yet? + + + + + Highlights an element in the editor. + + The title of the window the element is inside. + The text to identify the element with. + Optional mode to specify how to search for the element. + + true if the requested element was found; otherwise false. + + + + + Highlights an element in the editor. + + The title of the window the element is inside. + The text to identify the element with. + Optional mode to specify how to search for the element. + + true if the requested element was found; otherwise false. + + + + + Call this method to create an identifiable rect that the Highlighter can find. + + The position to make highlightable. + The identifier text of the rect. + + + + Stops the active highlight. + + + + + Used to specify how to find a given element in the editor to highlight. + + + + + Highlights the first element found using any of the search modes. + + + + + Highlights an element containing text using the text as identifier. + + + + + Highlights an element with a given identifier text. + + + + + Highlights nothing. + + + + + Highlights an entire editor control using its label text as identifier. + + + + + Icon kind. + + + + + This icon can be used for any purpose in an application. + + + + + This icon is used for the main application icons. + + + + + This icon is used for push notifications. + + + + + This icon is used for settings. + + + + + This icon is used for Spotlight searches. (iOS only). + + + + + This icon is used by the iOS App Store. + + + + + Defines a method to add custom menu items to an Editor Window. + + + + + Adds your custom menu items to an Editor Window. + + + + + + Use IHVImageFormatImporter to modify Texture2D import settings for Textures in IHV (Independent Hardware Vendor) formats such as .DDS and .PVR from Editor scripts. + + + + + Filtering mode of the texture. + + + + + Is texture data readable from scripts. + + + + + Enable mipmap streaming for this texture. + + + + + Relative priority for this texture when reducing memory size in order to hit the memory budget. + + + + + Texture coordinate wrapping mode. + + + + + Texture U coordinate wrapping mode. + + + + + Texture V coordinate wrapping mode. + + + + + Texture W coordinate wrapping mode for Texture3D. + + + + + C++ compiler configuration used when compiling IL2CPP generated code. + + + + + Debug configuration turns off all optimizations, which makes the code quicker to build but slower to run. + + + + + Master configuration enables all possible optimizations, squeezing every bit of performance possible. For instance, on platforms that use the MSVC++ compiler, this option enables link-time code generation. Compiling code using this configuration can take significantly longer than it does using the Release configuration. Unity recommends building the shipping version of your game using the Master configuration if the increase in build time is acceptable. + + + + + Release configuration enables optimizations, so the compiled code runs faster and the binary size is smaller but it takes longer to compile. + + + + + Interface for when you extend the Lighting Explorer. Used in full overrides of the default behavior. + + + + + Returns the tabs that you have selected to display in the Lighting Explorer. + + + Tabs for the Lighting Explorer. + + + + + This is called when the Lighting Explorer OnDisable is called, or when you switch to another extension. + + + + + This is called when the Lighting Explorer OnEnable is called, or when you switch to another extension. + + + + + A class for a compound handle to edit an angle and a radius in the Scene view. + + + + + Returns or specifies the angle of the arc for the handle. + + + + + Returns or specifies the color of the angle control handle. + + + + + The Handles.CapFunction to use when displaying the angle control handle. + + + + + The Handles.SizeFunction to specify how large the angle control handle should be. + + + + + Returns or specifies the color of the arc shape. + + + + + Returns or specifies the radius of the arc for the handle. + + + + + Returns or specifies the color of the radius control handle. + + + + + The Handles.CapFunction to use when displaying the radius control handle. + + + + + The Handles.SizeFunction to specify how large the angle control handle should be. + + + + + Returns or specifies the color of the curved line along the outside of the arc. + + + + + Creates a new instance of the ArcHandle class. + + + + + A Handles.CapFunction that draws a line terminated with Handles.CylinderHandleCap. + + The control ID for the handle. + The position of the handle in the space of Handles.matrix. + The rotation of the handle in the space of Handles.matrix. + The size of the handle in the space of Handles.matrix. Use HandleUtility.GetHandleSize if you want a constant screen-space size. + Event type for the handle to act upon. By design it handles EventType.Layout and EventType.Repaint events. + + + + A Handles.SizeFunction that returns a fixed screen-space size. + + The current position of the handle in the space of Handles.matrix. + + The size to use for a handle at the specified position. + + + + + A Handles.SizeFunction that returns a fixed screen-space size. + + The current position of the handle in the space of Handles.matrix. + + The size to use for a handle at the specified position. + + + + + A function to display this instance in the current handle camera using its current configuration. + + + + + Sets angleHandleColor, wireframeColor, and fillColor to the same value, where fillColor will have the specified alpha value. radiusHandleColor will be set to Color.clear and the radius handle will be disabled. + + The color to use for the angle control handle and the fill shape. + The alpha value to use for fillColor. + + + + Sets angleHandleColor, radiusHandleColor, wireframeColor, and fillColor to the same value, where fillColor will have the specified alpha value. + + The color to use for the angle and radius control handles and the fill shape. + The alpha value to use for fillColor. + + + + A compound handle to edit a box-shaped bounding volume in the Scene view. + + + + + Returns or specifies the size of the bounding box. + + + + + Create a new instance of the BoxBoundsHandle class. + + An integer value used to generate consistent control IDs for each control handle on this instance. Avoid using the same value for all of your BoxBoundsHandle instances. + + + + Create a new instance of the BoxBoundsHandle class. + + An integer value used to generate consistent control IDs for each control handle on this instance. Avoid using the same value for all of your BoxBoundsHandle instances. + + + + Draw a wireframe box for this instance. + + + + + A compound handle to edit a capsule-shaped bounding volume in the Scene view. + + + + + Returns or specifies the height of the capsule bounding volume. + + + + + Returns or specifies the axis in the handle's space to which height maps. The radius maps to the remaining axes. + + + + + Returns or specifies the radius of the capsule bounding volume. + + + + + Create a new instance of the CapsuleBoundsHandle class. + + An integer value used to generate consistent control IDs for each control handle on this instance. Avoid using the same value for all of your CapsuleBoundsHandle instances. + + + + Create a new instance of the CapsuleBoundsHandle class. + + An integer value used to generate consistent control IDs for each control handle on this instance. Avoid using the same value for all of your CapsuleBoundsHandle instances. + + + + Draw a wireframe capsule for this instance. + + + + + An enumeration for specifying which axis on a CapsuleBoundsHandle object maps to the CapsuleBoundsHandle.height parameter. + + + + + X-axis. + + + + + Y-axis. + + + + + Z-axis. + + + + + A callback for when a control handle was dragged in the Scene. + + The handle that was dragged. + The raw Bounds for this instance's volume at the time the control handle was clicked. + The raw Bounds for this instance's volume based on the updated handle position. + + The bounds that should be applied to this instance, with any necessary modifications applied. + + + + + A class for a compound handle to edit multiaxial angular motion limits in the Scene view. + + + + + The Handles.CapFunction to use when displaying the angle control handle. + + + + + The Handles.SizeFunction to specify how large the angle control handle should be. + + + + + Returns or specifies the opacity to use when rendering fill shapes for the range of motion for each axis. Defaults to 0.1. + + + + + Returns or specifies the radius of the arc for the handle. Defaults to 1.0. + + + + + Returns or specifies the opacity to use for the curved lines along the outside of the arcs of motion. Defaults to 1.0. + + + + + Returns or specifies the color to use for the handle limiting motion around the x-axis. Defaults to Handles.xAxisColor. + + + + + Returns or specifies the maximum angular motion about the x-axis. + + + + + Returns or specifies the minimum angular motion about the x-axis. + + + + + Returns or specifies how angular motion is limited about the x-axis. Defaults to ConfigurableJointMotion.Limited. + + + + + Returns or specifies the range of valid values for angular motion about the x-axis. Defaults to [-180.0, 180.0]. + + + + + Returns or specifies the color to use for the handle limiting motion around the y-axis. Defaults to Handles.yAxisColor. + + + + + Returns or specifies the maximum angular motion about the y-axis. + + + + + Returns or specifies the minimum angular motion about the y-axis. + + + + + Returns or specifies how angular motion is limited about the y-axis. Defaults to ConfigurableJointMotion.Limited. + + + + + Returns or specifies the range of valid values for angular motion about the y-axis. Defaults to [-180.0, 180.0]. + + + + + Returns or specifies the color to use for the handle limiting motion around the z-axis. Defaults to Handles.zAxisColor. + + + + + Returns or specifies the maximum angular motion about the z-axis. + + + + + Returns or specifies the minimum angular motion about the z-axis. + + + + + Returns or specifies how angular motion is limited about the z-axis. Defaults to ConfigurableJointMotion.Limited. + + + + + Returns or specifies the range of valid values for angular motion about the z-axis. Defaults to [-180.0, 180.0]. + + + + + Creates a new instance of the JointAngularLimitHandle class. + + + + + A function to display this instance in the current handle camera using its current configuration. + + + + + The MultiColumnHeader is a general purpose class that e.g can be used with the TreeView to create multi-column tree views and list views. + + + + + Use this property to control whether sorting is enabled for all the columns. + + + + + Customizable height of the multi column header. + + + + + The index of the column that is set to be the primary sorting column. This is the column that shows the sorting arrow above the header text. + + + + + Subscribe to this event to get notified when sorting has changed. + + + + + + This is the state of the MultiColumnHeader. + + + + + Subscribe to this event to get notified when the number of visible columns has changed. + + + + + + Override this method to extend the default context menu items shown when context clicking the header area. + + Context menu shown. + + + + Override to customize the behavior when clicking a column header. + + Column clicked. + Column index clicked. + + + + Override to customize the GUI of a single column header. + + Column header data. + Rect for column header. + Column index. + + + + Constructor. + + Column header state and Column state. + + + + Default GUI methods and properties for the MultiColumnHeader class. + + + + + Margin that can be used by clients of the MultiColumnHeader to control spacing between content in multiple columns. + + + + + Default height of the header. + + + + + This height is the minium height the header can have and can only be used if sorting is disabled. + + + + + Default styles used by the MultiColumnHeader class. + + + + + Style used for rendering the background of the header. + + + + + Style used for left aligned header text. + + + + + Style used for centered header text. + + + + + Style used for right aligned header text. + + + + + Calculates a cell rect for a column and row using the visibleColumnIndex and rowRect parameters. + + + + + + + Returns the column data for a given column index. + + Column index. + + Column data. + + + + + Returns the header column Rect for a given visible column index. + + Index of a visible column. + + + + Convert from column index to visible column index. + + Column index. + + Visible column index. + + + + + Delegate used for events from the MultiColumnHeader. + + The MultiColumnHeader that dispatched this event. + + + + Check if a column is currently visible in the MultiColumnHeader. + + Column index. + + + + Check the sorting order state for a column. + + Column index. + + True if sorted ascending. + + + + + Render and handle input for the MultiColumnHeader at the given rect. + + Horizontal scroll offset. + Rect where the MultiColumnHeader is drawn in. + + + + Called when sorting changes and dispatches the sortingChanged event. + + + + + Called when the number of visible column changes and dispatches the visibleColumnsChanged event. + + + + + Requests the window which contains the MultiColumnHeader to repaint. + + + + + Resizes the column widths of the columns that have auto-resize enabled to make all the columns fit to the width of the MultiColumnHeader render rect. + + + + + Change sort direction for a given column. + + Column index. + Direction of the sorting. + + + + Sets the primary sorting column and its sorting order. + + Column to sort. + Sorting order for the column specified. + + + + Sets multiple sorting columns and the associated sorting orders. + + Column indices of the sorted columns. + Sorting order for the column indices specified. + + + + Provides the button logic for a column header and the rendering of the sorting arrow (if visible). + + Column data. + Column header rect. + Column index. + + + + Method for toggling the visibility of a column. + + Toggle visibility for this column. + + + + State used by the MultiColumnHeader. + + + + + The array of column states used by the MultiColumnHeader class. + + + + + This property controls the maximum number of columns returned by the sortedColumns property. + + + + + This property holds the index to the primary sorted column. + + + + + The array of column indices for multiple column sorting. + + + + + This is the array of currently visible column indices. + + + + + Returns the sum of all the widths of the visible columns in the visibleColumns array. + + + + + Checks if the source state can transfer its serialized data to the destination state. + + State that have serialized data to be transfered to the destination state. + Destination state. + + Returns true if the source state have the same number of columns as the destination state. + + + + + Column state. + + + + + Option to allow/disallow hiding the column from the context menu. + + + + + Option to allow the column to resize automatically when resizing the entire MultiColumnHeader. + + + + + Is sorting enabled for this column. If false, left-clicking this column header has no effect. + + + + + If this is set then it is used for the context menu for toggling visibility, if not set then the ::headerContent is used. + + + + + This is the GUIContent that will be rendered in the column header. + + + + + Alignment of the header content. + + + + + Maximum width of the column. + + + + + Minimum width of the column. + + + + + Value that controls if this column is sorted ascending or descending. + + + + + Alignment of the sorting arrow. + + + + + The width of the column. + + + + + Constructor. + + Column data. + + + + Overwrites the seralized fields from the source state to the destination state. + + State that have serialized data to be transfered to the destination state. + Destination state. + + + + Base class for a compound handle to edit a bounding volume in the Scene view. + + + + + Flags specifying which axes should display control handles. + + + + + Returns or specifies the center of the bounding volume for the handle. + + + + + Returns or specifies the color of the control handles. + + + + + An optional Handles.CapFunction to use when displaying the control handles. Defaults to Handles.DotHandleCap if no value is specified. + + + + + The Handles.SizeFunction to specify how large the midpoint control handles should be. + + + + + Returns or specifies the color of the wireframe shape. + + + + + A flag enumeration for specifying which axes on a PrimitiveBoundsHandle object should be enabled. + + + + + All axes. + + + + + No axes. + + + + + X-axis (bit 0). + + + + + Y-axis (bit 1). + + + + + Z-axis (bit 2). + + + + + Create a new instance of the PrimitiveBoundsHandle class. + + An integer value used to generate consistent control IDs for each control handle on this instance. Avoid using the same value for all of your PrimitiveBoundsHandle instances. + + + + Create a new instance of the PrimitiveBoundsHandle class. + + An integer value used to generate consistent control IDs for each control handle on this instance. Avoid using the same value for all of your PrimitiveBoundsHandle instances. + + + + A Handles.SizeFunction that returns a fixed screen-space size. + + The current position of the handle in the space of Handles.matrix. + + The size to use for a handle at the specified position. + + + + + A function to display this instance in the current handle camera using its current configuration. + + + + + Draw a wireframe shape for this instance. Subclasses must implement this method. + + + + + Gets the current size of the bounding volume for this instance. + + + The current size of the bounding volume for this instance. + + + + + An enumeration of directions the handle moves in. + + + + + This value corresponds to the handle moving in a negative direction away from PrimitiveBoundsHandle.center along the x-axis. + + + + + This value corresponds to the handle moving in a negative direction away from PrimitiveBoundsHandle.center along the y-axis. + + + + + This value corresponds to the handle moving in a negative direction away from PrimitiveBoundsHandle.center along the z-axis. + + + + + This value corresponds to the handle moving in a positive direction away from PrimitiveBoundsHandle.center along the x-axis. + + + + + This value corresponds to the handle moving in a positive direction away from PrimitiveBoundsHandle.center along the y-axis. + + + + + This value corresponds to the handle moving in a positive direction away from PrimitiveBoundsHandle.center along the z-axis. + + + + + Gets a value indicating whether the specified axis is enabled for the current instance. + + An Axes. + An integer corresponding to an axis on a Vector3. For example, 0 is x, 1 is y, and 2 is z. + + true if the specified axis is enabled; otherwise, false. + + + + + Gets a value indicating whether the specified axis is enabled for the current instance. + + An Axes. + An integer corresponding to an axis on a Vector3. For example, 0 is x, 1 is y, and 2 is z. + + true if the specified axis is enabled; otherwise, false. + + + + + A callback for when a control handle was dragged in the Scene. + + The handle that was dragged. + The raw Bounds for this instance's volume at the time the control handle was clicked. + The raw Bounds for this instance's volume based on the updated handle position. + + The bounds that should be applied to this instance, with any necessary modifications applied. + + + + + Sets handleColor and wireframeColor to the same value. + + The color to use for the control handles and the wireframe shape. + + + + Sets the current size of the bounding volume for this instance. + + A Vector3 specifying how large the bounding volume is along all of its axes. + + + + The SearchField control creates a text field for a user to input text that can be used for searching. + + + + + Changes the keyboard focus to the search field when the user presses ‘Ctrl/Cmd + F’ when set to true. It is true by default. + + + + + This event is dispatched when the focused search field detects that the down or up key is pressed and can be used to change keyboard focus to another control, such as the TreeView. + + + + + + This is the controlID used for the text field to obtain keyboard focus. + + + + + This function returns true if the search field has keyboard focus. + + + + + This function displays the search field with the default UI style and uses the GUILayout class to automatically calculate the position and size of the Rect it is rendered to. Pass an optional list to specify extra layout properties. + + Text string to display in the search field. + An optional list of layout options that specify extra layout properties. <br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The text entered in the search field. The original input string is returned instead if the search field text was not changed. + + + + + This function displays the search field with the default UI style in the given Rect. + + Rectangle to use for the search field. + Text string to display in the search field. + + The text entered in the search field. The original input string is returned instead if the search field text was not changed. + + + + + This function displays a search text field with the given Rect and UI style parameters. + + Rectangle to use for the search field. + Text string to display in the search field. + The text field style. + The cancel button style used when there is text in the search field. + The cancel button style used when there is no text in the search field. + + The text entered in the SearchField. The original input string is returned instead if the search field text was not changed. + + + + + This function displays the search field with the toolbar UI style and uses the GUILayout class to automatically calculate the position and size of the Rect it is rendered to. Pass an optional list to specify extra layout properties. + + Text string to display in the search field. + An optional list of layout options that specify extra layout properties. <br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The text entered in the search field. The original input string is returned instead if the search field text was not changed. + + + + + This function displays the search field with a toolbar style in the given Rect. + + Rectangle to use for the search field. + Text string to display in the search field. + + The text entered in the search field. The original input string is returned instead if the search field text was not changed. + + + + + This is a generic callback delegate for SearchField events and does not take any parameters. + + + + + This function changes keyboard focus to the search field so a user can start typing. + + + + + A compound handle to edit a sphere-shaped bounding volume in the Scene view. + + + + + Returns or specifies the radius of the sphere bounding volume. + + + + + Create a new instance of the SphereBoundsHandle class. + + An integer value used to generate consistent control IDs for each control handle on this instance. Avoid using the same value for all of your SphereBoundsHandle instances. + + + + Create a new instance of the SphereBoundsHandle class. + + An integer value used to generate consistent control IDs for each control handle on this instance. Avoid using the same value for all of your SphereBoundsHandle instances. + + + + Draw a wireframe sphere for this instance. + + + + + A callback for when a control handle was dragged in the Scene. + + The handle that was dragged. + The raw Bounds for this instance's volume at the time the control handle was clicked. + The raw Bounds for this instance's volume based on the updated handle position. + + The bounds that should be applied to this instance, with any necessary modifications applied. + + + + + The TreeView is an IMGUI control that lets you create tree views, list views and multi-column tables for Editor tools. + + + + + Indent used for all rows before the tree foldout arrows and content. + + + + + When using a MultiColumnHeader this value adjusts the cell rects provided for all columns except the tree foldout column. + + + + + When using a MultiColumnHeader this value should be set to the column index in which the foldout arrows should appear. + + + + + Custom vertical offset of the foldout arrow. + + + + + Value that returns how far the foldouts are indented for each increasing depth value. + + + + + Value to control the spacing before the default icon and label. Can be used e.g for placing a toggle button to the left of the content. + + + + + Register a callback to this property to override the Foldout button in the TreeView. + + + + + Width of the built-in foldout arrow. + + + + + Register a callback to this field to override how the TreeView handles selection changes in response to keys and mouse clicks. + + + + + The current search state of the TreeView. + + + + + True if the user is currently dragging one or more items in the TreeView, and false otherwise. + + + + + The TreeView is initialized by calling Reload(). Therefore returns false until Reload() is called the first time. + + + + + Get the MultiColumnHeader of the TreeView. Can be null if the TreeView was created without a MultiColumnHeader. + + + + + The hidden root item of the TreeView (it is never rendered). + + + + + The fixed height used for each row in the TreeView if GetCustomRowHeight have not been overridden. + + + + + Current search string of the TreeView. + + + + + Enable this to show alternating row background colors. + + + + + Enable this to show a border around the TreeView. + + + + + Returns true if the horizontal scroll bar is showing, otherwise false. + + + + + Returns true if the vertical scroll bar is showing, otherwise false. + + + + + The state of the TreeView (expanded state, selection, scroll etc.) + + + + + Returns the sum of the TreeView row heights, the MultiColumnHeader height (if used) and the border (if used). + + + + + The controlID used by the TreeView to obtain keyboard control focus. + + + + + The Rect the TreeView is being rendered to. + + + + + When drawing the TreeView contents, will it be enclosed within a ScrollView? + + + + + Adds the expanded rows of the full tree to the input list. Only use this method if a full tree was built in BuildRoot. + + Root of the TreeView. + Rows that will be refilled using the expanded state of TreeView. + + + + This is called after all rows have their RowGUI called. + + + + + This is called before any rows have their RowGUI called. + + + + + Shows the rename overlay for a TreeViewItem. + + Item to rename. + Delay in seconds until the rename overlay shows. + + Returns true if renaming was started. Returns false if renaming was already active. + + + + + Shows the rename overlay for a TreeViewItem. + + Item to rename. + Delay in seconds until the rename overlay shows. + + Returns true if renaming was started. Returns false if renaming was already active. + + + + + Abstract method that is required to be implemented. By default this method should create the full tree of TreeViewItems and return the root. + + + The root of the tree. This item can later be accessed by 'rootItem'. + + + + + Override this method to take control of how the rows are generated. + + Root item that was created in the BuildRoot method. + + The rows list shown in the TreeView. Can later be accessed using GetRows(). + + + + + Override this method to control which items are allowed to be parents. + + Can this item be a parent? + + + + Override this method to control whether an item can be expanded or collapsed by key or mouse. + + Can this item be expanded/collapsed. + + + + Override this method to control whether the item can be part of a multiselection. + + Can this item be part of a multiselection. + + + + Override this method to control whether the item can be renamed using a keyboard shortcut or when clicking an already selected item. + + Can this item be renamed? + + + + This function is called whenever a TreeViewItem is clicked and dragged. It returns false by default. + + + + + + Method arguments for the CanStartDrag virtual method. + + + + + Item about to be dragged. + + + + + The multi-selection about to be dragged. + + + + + Modifies the input rect so it is centered and have a height equal to EditorGUIUtility.singleLineHeight. + + Rect to be modified and centered. + + + + Collapse all expanded items in the TreeView. + + + + + This function is called automatically and handles the ExecuteCommand events for “SelectAll” and “FrameSelection”. Override this function to extend or avoid Command events. + + + + + Override this method to handle context clicks outside any items (but still in the TreeView rect). + + + + + Override this method to handle a context click on an item with ID TreeViewItem.id. + + TreeViewItem id. + + + + Creates a dummy TreeViewItem list. Useful when overriding BuildRows to prevent building a full tree of items. + + + + + The TreeView is always constructed with a state object and optionally a multi-column header object if a header is needed. + + TreeView state (expanded items, selection etc.) + Multi-column header for the TreeView. + + + + The TreeView is always constructed with a state object and optionally a multi-column header object if a header is needed. + + TreeView state (expanded items, selection etc.) + Multi-column header for the TreeView. + + + + Default GUI methods and properties for the TreeView class. + + + + + Draws a bold label that have correct text color when selected and/or focused. + + Rect to render the text in. + Label to render. + Selected state used for determining text color. + Focused state used for determining text color. + + + + Draws a bold right aligned label that have correct text color when selected and/or focused. + + Rect to render the text in. + Label to render. + Selected state used for determining text color. + Focused state used for determining text color. + + + + Draws a foldout label that have correct text color when selected and/or focused. + + Rect to render the text in. + Label to render. + Selected state used for determining text color. + Focused state used for determining text color. + + + + Draws a label that have correct text color when selected and/or focused. + + Rect to render the text in. + Label to render. + Selected state used for determining text color. + Focused state used for determining text color. + + + + Draws a right aligned label that have correct text color when selected and/or focused. + + Rect to render the text in. + Label to render. + Selected state used for determining text color. + Focused state used for determining text color. + + + + Default styles used by the TreeView class. + + + + + Background style used for alternating row background colors when enabling TreeView.showAlternatingRowBackgrounds. + + + + + Background style used for alternating row background colors when enabling TreeView.showAlternatingRowBackgrounds. + + + + + Bold label with alternative text color when selected and/or focused. + + + + + Right aligned bold label with alternative text color when selected and/or focused. + + + + + The label that is used for foldout label with alternative text color when selected and/or focused. + + + + + Left aligned label with alternative text color when selected and/or focused. + + + + + Right aligend label with alternative text color when selected and/or focused. + + + + + Override this function to extend or change the search behavior. + + Item used for matching against the search string. + The search string of the TreeView. + + True if item matches search string, otherwise false. + + + + + Callback signature used to override the TreeView foldout. See foldoutOverride. + + Rect to draw the foldout. + Current foldout state. + Toggle button style. + + Returns true if the foldout is still expanded. Otherwise, returns false. + + + + + Override this method to handle double click events on an item. + + ID of TreeViewItem that was double clicked. + + + + Method arguments for the HandleDragAndDrop virtual method. + + + + + When dragging items the current drag can have the following 3 positions relative to the items: Upon an item, Between two items or Outside items. + + + + + This index refers to the index in the children list of the parentItem where the current drag is positioned. + + + + + The parent item is set if the drag is either upon this item or between two of its children. + + + + + This value is false as long as the mouse button is down, when the mouse button is released it is true. + + + + + Enum describing the possible positions a drag can have relative to the items: upon a item, between two items or outside items. + + + + + This value is used when dragging between two items. + + + + + This value is used when dragging outside all items. + + + + + This value is used when the drag is upon a item. + + + + + Ends renaming if the rename overlay is shown. If called while the rename overlay is not being shown, this method does nothing. + + + + + Expand all collapsed items in the TreeView. + + + + + Override to get notified when items are expanded or collapsed. This is a general notification that the expanded state has changed. + + + + + Finds a TreeViewItem by an ID. + + Find the TreeViewItem with this ID. + Sets the search to start from an item. Use 'rootItem' to search the entire tree. + + This search method returns the TreeViewItem found and returns null if not found. + + + + + Useful for converting from TreeViewItem IDs to TreeViewItems using the current rows. + + TreeViewItem IDs. + + TreeViewItems. + + + + + This will reveal the item with ID id (by expanding the ancestors of that item) and will make sure it is visible in the ScrollView. + + TreeViewItem ID. + + + + This method is e.g. used for revealing items that are currently under a collapsed item. + + TreeViewItem ID. + + List of all the ancestors of a given item with ID id. + + + + + Utility for multi column setups. This method will clip the input rowRect against the column rect defined by columnIndexForTreeFoldouts to get the cell rect where the the foldout arrows appear. + + Rect for a row. + + Cell rect in a multi column setup. + + + + + Returns the horizontal content offset for an item. This is where the content should begin (after the foldout arrow). + + Item used to determine the indent. + + Indent. + + + + + Override to control individual row heights. + + Row index. + Item for given row. + + Height of row. + + + + + Returns all descendants for the item with ID id that have children. + + TreeViewItem ID. + + Descendants that have children. + + + + + Returns a list of TreeViewItem IDs that are currently expanded in the TreeView. + + + TreeViewItem IDs. + + + + + Returns the first and the last indices of the rows that are visible in the scroll view of the TreeView. + + First row visible. + Last row visible. + + + + Returns the horizontal foldout offset for an item. This is where the foldout arrow is rendered. + + Item used to determine the indent. + + Indent for the foldout arrow. + + + + + A callback which determines how TreeView handles selection changes in response to keys and mouse clicks. + + The item clicked, or selected via keyboard. + Should existing selection be kept? This is used to support dragging or right-clicking one item in a multi-selection. + Should the action key be treated like the shift key? If so, the action key also indicates a range selection. + + + + + Override this method if custom GUI handling are used in RowGUI. This method for controls where the rename overlay appears. + + Row rect for the item currently being renamed. + Row index for the item currently being renamed. + TreeViewItem that are currently being renamed. + + The rect where the rename overlay should appear. + + + + + Get the rect for a row. + + Row index. + + Row rect. + + + + + This is the list of TreeViewItems that have been built in BuildRows. + + + Rows. + + + + + Returns the list of TreeViewItem IDs that are currently selected. + + + + + Override this function to control the drag and drop behavior of the TreeView. + + Drag and drop arguments. + + + + Returns true if the TreeView and its EditorWindow have keyboard focus. + + + + + Returns true if the TreeView has a selection. + + + + + Utility method for checking if the childList is identical to the one returned by the CreateChildListForCollapsedParent method. + + Children list of a TreeViewItem. + + + + Returns true if the TreeViewItem with ID id is currently expanded. + + TreeViewItem ID. + + + + Returns true if the TreeViewItem with ID id is currently selected. + + TreeViewItem ID. + + + + Override this method to handle events when the TreeView has keyboard focus. + + + + + This is the main GUI method of the TreeView, where the TreeViewItems are processed and drawn. + + Rect where the TreeView is rendered. + + + + Refreshes the cache of custom row rects based on the heights returned by GetCustomRowHeight. + + + + + Call this to force the TreeView to reload its data. This in turn causes BuildRoot and BuildRows to be called. + + + + + Called when rename ends either by the user completing the renaming process, when the rename overlay loses focus or is closed using EndRename. + + + + + + Method arguments for the virtual method RenameEnded. + + + + + Is true if the rename is accepted. + + + + + Item with ID that are being renamed. + + + + + Name entered in the rename overlay. + + + + + The original name when starting the rename. + + + + + Request a repaint of the window that the TreeView is rendered in. + + + + + Override this method to add custom GUI content for the rows in the TreeView. + + Row data. + + + + Method arguments for the virtual method RowGUI. + + + + + This value is true only when the TreeView has keyboard focus and the TreeView's window has focus. + + + + + This value is true when the ::item is currently being renamed. + + + + + Item for the current row being handled in TreeView.RowGUI. + + + + + Label used for text rendering of the item displayName. Note this is an empty string when isRenaming == true. + + + + + Row index into the list of current rows. + + + + + Row rect for the current row being handled. + + + + + This value is true when the current row's item is part of the current selection. + + + + + If using a MultiColumnHeader for the TreeView this method can be used to get the cell rects of a row using the visible columns of the MultiColumnHeader. + + Index into the list of visible columns of the multi column header. + + Cell rect defined by the intersection between the row rect and the rect of the visible column. + + + + + If using a MultiColumnHeader for the TreeView this method can be used to convert an index from the visible columns list to a index into the actual columns in the MultiColumnHeaderState. + + This index is the index into the current visible columns. + + Column index into the columns array in MultiColumnHeaderState. + + + + + If using a MultiColumnHeader for the TreeView use this method to get the number of visible columns currently being shown in the MultiColumnHeader. + + + + + Override the method to get notified of search string changes. + + + + + + Selects all rows in the TreeView. + + + + + Override the method to get notified of selection changes. + + TreeViewItem IDs. + + + + Use this method in RowGUI to peform the logic of a mouse click. + + TreeViewItem clicked. + If true then keeps the multiselection when clicking on a item already part of the selection. If false then clears the selection before selecting the item clicked. For left button clicks this is usually false. For context clicks it is usually true so a context opereration can operate on the multiselection. + + + + Set a single TreeViewItem to be expanded or collapsed. + + TreeViewItem ID. + True expands item. False collapses item. + + True if item changed expanded state, false if item already had the expanded state. + + + + + Set the current expanded TreeViewItems of the TreeView. This will overwrite the previous expanded state. + + List of item IDs that should be expanded. + + + + Expand or collapse all items under item with id. + + TreeViewItem ID. + Expanded state: true expands, false collapses. + + + + Calling this function changes the keyboard focus to the TreeView. + + + + + Calling this function changes the keyboard focus to the TreeView and ensures an item is selected. Use this function to enable key navigation of the TreeView. + + + + + Set the selected items of the TreeView. + + TreeViewItem IDs. + Options for extra logic performed after the selection. See TreeViewSelectionOptions. + + + + Set the selected items of the TreeView. + + TreeViewItem IDs. + Options for extra logic performed after the selection. See TreeViewSelectionOptions. + + + + Utility method using the depth of the input TreeViewItem to set the correct depths for all its descendant TreeViewItems. + + TreeViewItem from which the descendentans should have their depth updated. + + + + This function is called when CanStartDrag returns true. + + + + + + Method arguments to the virtual method SetupDragAndDrop. + + + + + TreeViewItem IDs being dragged. + + + + + Utility method for initializing all the parent and children properties of the rows using the order and the depths values that have been set. + + The hidden root item. + TreeViewItems where only the depth property have been set. + + + + Override this method to handle single click events on an item. + + ID of TreeViewItem that was single clicked. + + + + Returns a list sorted in the order in which they are shown in the TreeView. + + TreeViewItem IDs. + + + + The TreeViewItem is used to build the tree representation of a tree data structure. + + + + + The list of child items of this TreeViewItem. + + + + + The depth refers to how many ancestors this item has, and corresponds to the number of horizontal ‘indents’ this item has. + + + + + Name shown for this item when rendered. + + + + + Returns true if children has any items. + + + + + If set, this icon will be rendered to the left of the displayName. The icon is rendered at 16x16 points by default. + + + + + Unique ID for an item. + + + + + The parent of this TreeViewItem. If it is null then it is considered the root of the TreeViewItem tree. + + + + + Helper method that adds the child TreeViewItem to the children list and sets the parent property on the child. + + TreeViewItem to be added to the children list. + + + + TreeViewItem constructor. + + Unique ID to identify this TreeViewItem with among all TreeViewItems of the TreeView. See Also id. + Depth of this TreeViewItem. See Also depth. + Rendered name of this TreeViewItem. See Also displayName. + + + + TreeViewItem constructor. + + Unique ID to identify this TreeViewItem with among all TreeViewItems of the TreeView. See Also id. + Depth of this TreeViewItem. See Also depth. + Rendered name of this TreeViewItem. See Also displayName. + + + + TreeViewItem constructor. + + Unique ID to identify this TreeViewItem with among all TreeViewItems of the TreeView. See Also id. + Depth of this TreeViewItem. See Also depth. + Rendered name of this TreeViewItem. See Also displayName. + + + + Enum used by the TreeView.SetSelection method. + + + + + If this flag is passed to TreeView.SetSelection then the TreeView will call the its TreeView.SelectionChanged method. + + + + + If this flag is passed to TreeView.SetSelection no extra logic is be performed after setting selection. + + + + + If this flag is passed to TreeView.SetSelection then the TreeView will make sure the last item in the input selection list is visible on screen. + + + + + The TreeViewState contains serializable state information for the TreeView. + + + + + This is the list of currently expanded TreeViewItem IDs. + + + + + The ID for the TreeViewItem that currently is being used for multi selection and key navigation. + + + + + The current scroll values of the TreeView's scroll view. + + + + + Search string state that can be used in the TreeView to filter the tree data when creating the TreeViewItems. + + + + + Selected TreeViewItem IDs. Use of the SetSelection and IsSelected API will access this state. + + + + + Asset importing options. + + + + + Default import options. + + + + + Force a full reimport but don't download the assets from the cache server. + + + + + Import all assets synchronously. + + + + + Forces asset import as uncompressed for edition facilities. + + + + + User initiated asset import. + + + + + When a folder is imported, import all its contents as well. + + + + + Allow an editor class to be initialized when Unity loads without action from the user. + + + + + Allow an editor class method to be initialized when Unity loads without action from the user. + + + + + The mode of interaction, user or automated, that an API method is called with. + + + + + Use this setting to prevent a method from showing any dialog boxes to the user, and to prevent it recording to the undo history. + + + + + Use this setting to allow a method to show dialog boxes to the user, and to allow it to record to the undo history. + + + + + Application behavior when entering background. + + + + + Custom background behavior, see iOSBackgroundMode for specific background modes. + + + + + Application should exit when entering background. + + + + + Application should suspend execution when entering background. + + + + + Background modes supported by the application corresponding to project settings in Xcode. + + + + + Audio, AirPlay and Picture in Picture. + + + + + Uses Bluetooth LE accessories. + + + + + Acts as a Bluetooth LE accessory. + + + + + External accessory communication. + + + + + Background fetch. + + + + + Location updates. + + + + + Newsstand downloads. + + + + + No background modes supported. + + + + + Remote notifications. + + + + + Voice over IP. + + + + + Build configurations for the generated Xcode project. + + + + + Build configuration set to Debug for the generated Xcode project. + + + + + Build configuration set to Release for the generated Xcode project with optimization enabled. + + + + + A device requirement description used for configuration of App Slicing. + + + + + The values of the device requirement description. + + + + + Constructs new device requirement description. + + + + + iOS launch screen settings. + + + + + Launch screen image on the iPad. + + + + + Landscape oriented launch screen image on the iPhone. + + + + + Portrait oriented launch screen image on the iPhone. + + + + + iOS launch screen settings. + + + + + Use a specified custom Interface Builder (.xib) file in Player Settings. + + + + + Use the default launch screen (dark blue background). + + + + + Use a custom launch screen image specified in the iOS Player Settings or with PlayerSettings.iOS.SetLaunchScreenImage and use its original dimensions. + + + + + Use a custom launch screen image specified in the iOS Player Settings or with PlayerSettings.iOS.SetLaunchScreenImage which will be scaled across the entire screen. + + + + + Generate the Xcode project without any custom launch screens. + + + + + Supported iOS SDK versions. + + + + + Device SDK. + + + + + Simulator SDK. + + + + + Activity Indicator on loading. + + + + + Don't Show. + + + + + Gray. + + + + + White. + + + + + White Large. + + + + + iOS status bar style. + + + + + Default. + + + + + A light status bar, intended for use on dark backgrounds. + + + + + Target iOS device. + + + + + iPad Only. + + + + + Universal : iPhone/iPod + iPad. + + + + + iPhone/iPod Only. + + + + + Supported iOS deployment versions. + + + + + iOS 4.0. + + + + + iOS 4.1. + + + + + iOS 4.2. + + + + + iOS 4.3. + + + + + iOS 5.0. + + + + + iOS 5.1. + + + + + iOS 6.0. + + + + + iOS 7.0. + + + + + iOS 7.1. + + + + + iOS 8.0. + + + + + iOS 8.1. + + + + + Unknown iOS version, managed by user. + + + + + Provides an interface to display a custom TerrainLayer UI in the Terrain Layers inspector. + + + + + Draws the custom GUI for the terrain layer. + + The TerrainLayer object. + The Terrain object on which the TerrainLayer object, specified by the terrainLayer parameter, is selected. + + Return false to have Unity draw the default TerrainLayer inspector. Otherwise draw the custom GUI and return true. + + + + + The class used to render the Light Editor when a Light is selected in the Unity Editor. + + + + + The settings helper that can be used for rendering a custom LightEditor. + + + + + See ScriptableObject.OnDestroy. + + + + + See ScriptableObject.OnEnable. + + + + + See Editor.OnInspectorGUI. + + + + + See Editor.OnSceneGUI. + + + + + Contains all drawable elements of the LightEditor. + + + + + Exposed SerializedProperty for the inspected Light. + + + + + Exposed SerializedProperty for the inspected Light. + + + + + Exposed SerializedProperty for the inspected Light. + + + + + Exposed SerializedProperty for the inspected Light. + + + + + Exposed SerializedProperty for the inspected Light. + + + + + Exposed SerializedProperty for the inspected Light. + + + + + Exposed SerializedProperty for the inspected Light. + + + + + The light cookie texture used by the light. + + + + + Exposed SerializedProperty for the inspected Light. + + + + + Exposed SerializedProperty for the inspected Light. + + + + + Exposed SerializedProperty for the inspected Light. + + + + + Exposed SerializedProperty for the inspected Light. + + + + + Exposed SerializedProperty for the inspected Light. + + + + + Exposed SerializedProperty for the inspected Light. + + + + + Is the current light an area light or not. Area lights include Rectangle and Disc lights. + + + + + Is the current light baked or mixed. + + + + + Is the light completely baked. + + + + + Is the current light mixed. + + + + + Is the light realtime? + + + + + The light being inspected. + + + + + Exposed SerializedProperty for the inspected Light. + + + + + Exposed SerializedProperty for the inspected Light. + + + + + Exposed SerializedProperty for the inspected Light. + + + + + Exposed SerializedProperty for the inspected Light. + + + + + Exposed SerializedProperty for the inspected Light. + + + + + Exposed SerializedProperty for the inspected Light. + + + + + Exposed SerializedProperty for the inspected Light. + + + + + Exposed SerializedProperty for the inspected Light. + + + + + Exposed SerializedProperty for the inspected Light. + + + + + Exposed SerializedProperty for the inspected Light. + + + + + Exposed SerializedProperty for the inspected Light. + + + + + Exposed SerializedProperty for the inspected Light. + + + + + See SerializedObject.ApplyModifiedProperties. + + + + + Draws the default [[LightEditor] area widget. + + + + + Draws the default [[LightEditor] baked shadow angle widget. + + + + + Draws the default [[LightEditor] baked shadow radius widget. + + + + + Draws the default [[LightEditor] bounce intensity widget. + + + + + Draws the default [[LightEditor] color widget. + + + + + Draws the default [[LightEditor] cookie widget. + + + + + Draws the default [[LightEditor] cookie size widget. + + + + + Draws the default [[LightEditor] culling mask widget. + + + + + Draws the default [[LightEditor] flare widget. + + + + + Draws the default [[LightEditor] halo widget. + + + + + Draws the default [[LightEditor] intensity widget. + + + + + Draws the default [[LightEditor] lightmapping widget. + + + + + Draws the default [[LightEditor] light type widget. + + + + + Draws the default [[LightEditor] range widget. + + + + + + Draws the default [[LightEditor] render mode widget. + + + + + Draws the default [[LightEditor] runtime shadows widget. + + + + + Draws the default [[LightEditor] shadows type widget. + + + + + Draws the default [[LightEditor] spot angle widget. + + + + + Cleanup internal settings state. + + + + + Populate the settings from the referenced SerializedObject. + + + + + See SerializedObject.Update. + + + + + The lighting data asset used by the active Scene. + + + + + An attribute to mark an extension class for the Lighting Explorer. Supports only one per render pipeline. + + + + + Constructor. + + + + + + Create custom tabs for the Lighting Explorer. + + + + + Constructor. + + The title of the tab. + The objects that the tab must contain. + How the columns should look and behave. + + + + This is used when defining how a column should look and behave in the Lighting Explorer. + + + + + A delegate for comparison of properties for sorting. + + + + + + + A delegate for copying of properties. + + + + + + + Constructor. + + Depending on what LightingExplorer.DataType we use, built-in compare and draw methods will be used. If you want to fully overload this, use LightingExplorer.DataType.Custom. + Title for the column header. + Name of the property on the object you wish to use. If you use LightingExplorer.DataType.Name, choose ‘null’. + Width of the column. The minimum width is this value divided by 2. The default value is 100. + If you want to draw a property differently than the default, provide this delegate. If you use LightingExprlorer.DataType.Custom, you must override this. + If you want to sort properties differently than the default way, provide this delegate. If you use LightingExplorer.DataType.Custom, you must override this. + If you want to copy properties differently than the default way, provide this delegate. + If you depend on another Serialized property than the one in your column, use this field to specify which indices to include. The first column is index 0. + + + + Draws a checkbox, and handles comparison for sorting. + + + + + Draws a color box, and handles comparison for sorting. + + + + + No drawing or comparison for sorting. Please use the delegates in the constructor to override these. + + + + + Draws an enum field, and handles comparison for sorting. + + + + + Draws a float field, and handles comparison for sorting. + + + + + Draws an int field, and handles comparison for sorting. + + + + + Draws a name field, and handles comparison for sorting. Also implements a search field for filtering the rows. + + + + + A delegate for how to draw the property. + + The current rect for where it will be drawn in the TableView. + The property that is specified using ‘propertyName’ in the constructor. + An array of properties specified by using ‘dependencyIndicies’ in the constructor. + + + + Bake quality setting for LightmapEditorSettings. + + + + + High quality bake for final renderings. + + + + + Low quality bake for preview renderings. + + + + + Various settings for the bake. + + + + + Ambient occlusion (AO) for direct lighting. + + + + + Ambient occlusion (AO) for indirect lighting. + + + + + Beyond this distance a ray is considered to be unoccluded. + + + + + Specifies the resolution of the Baked lightmap in texels per world unit. Specifying higher resolutions can significantly increase the time it takes to bake the lightmap. The default value is one texel per world unit. The minimum value is 0.0001. + + + + + Specifies the maximum number of bounces the lightmapper computes for indirect light. The default value is one. The range is 0 to 4. + + + + + Specifies the number of samples the Progressive lightmapper uses for direct lighting calculations. The default value is 32. The minimum value is 1. + + + + + Enable baked ambient occlusion (AO). + + + + + Specifies the threshold the Progressive lightmapper uses to filter ambient occlusion stored in the lightmap when using A-Trous filter. The default value is 1. The value range is 0 to 2. + + + + + Specifies the threshold the Progressive lightmapper uses to filter direct light stored in the lightmap when using A-Trous filter. The default value is 0.5. The value range is 0 to 2. + + + + + Specifies the threshold the Progressive lightmapper uses to filter indirect light stored in the lightmap when using A-Trous filter. The default value is 2. The value range is 0 to 2. + + + + + Specifies the radius the Progressive lightmapper uses to filter for ambient occlusion in the lightmap when using Gaussian filter. The default value is 2. The value range is 0 to 5. + + + + + Specifies the radius the Progressive lightmapper uses to filter for direct light stored in the lightmap when using Gaussian filter. The default value is one. The value range is 0 to 5. + + + + + Specifies the radius the Progressive lightmapper used to filter for indirect light stored in the lightmap when using Gaussian filter. The default value is 5. The value range is 0 to 5. + + + + + Specifies the method used by the Progressive lightmapper to reduce noise in baked lightmaps. + + + + + Configure a filter kernel for the ambient occlusion target. + + + + + Configure a filter kernel for the direct light target. + + + + + Configure a filter kernel for the indirect light target. + + + + + Determines the filtering kernel for the Progressive Lightmapper. + + + + + Specifies the number of samples the Progressive lightmapper uses for indirect lighting calculations. The default value is 500. The minimum value is 10. + + + + + Determines which backend to use for baking lightmaps. + + + + + NonDirectional or CombinedDirectional lightmaps rendering mode. + + + + + This property is now obsolete. Use maxAtlasSize instead. + + + + + The maximum size of an individual lightmap texture. + + + + + This property is now obsolete. Use maxAtlasSize instead. + + + + + Indicates the Mixed mode that is used to bake the LightmapBakeType.Mixed lights, irrelevant for realtime and baked lights. + + + + + Texel separation between shapes. + + + + + Specifies whether the Progressive lightmapper should prioritize baking texels within the Scene view. The default value is true. + + + + + Lightmap resolution in texels per world unit. Defines the resolution of Realtime GI if enabled. If Baked GI is enabled, this defines the resolution used for indirect lighting. Higher resolution may take a long time to bake. + + + + + Determines how Unity will compress baked reflection cubemap. + + + + + Determines which sampling strategy to use for baking lightmaps with the Progressive Lightmapper. + + + + + Whether to use texture compression on the generated lightmaps. + + + + + The available filtering modes for the Progressive Lightmapper. + + + + + Enables the advanced filtering mode for the Progressive Lightmapper. + + + + + The filtering is configured automatically. + + + + + Turn filtering off. + + + + + The available filter kernels for the Progressive Lightmapper. + + + + + Use an A-Trous filter for a GI texture. + + + + + Use a Gaussian filter for a GI texture. + + + + + Do not filter GI texture. + + + + + Backends available for baking lighting. + + + + + Backend for baking lighting with the Enlighten radiosity middleware. + + + + + Backend for baking lighting using the CPU. Uses a progressive path tracing algorithm. + + + + + Backend for baking lighting using the GPU. Uses a progressive path tracing algorithm. + + + + + Available sampling strategies for baking lightmaps with the Progressive Lightmapper. + + + + + Auto will automatically select the sampling settings. + + + + + Fixed sampling uses a fixed number of samples per texel. This can be used when the other strategies fail to use enough samples in some areas. It will typically be slow. + + + + + A collection of parameters that impact lightmap and realtime GI computations. + + + + + The maximum number of times to supersample a texel to reduce aliasing. + + + + + The percentage of rays shot from a ray origin that must hit front faces to be considered usable. + + + + + BakedLightmapTag is an integer that affects the assignment to baked lightmaps. Objects with different values for bakedLightmapTag are guaranteed to not be assigned to the same lightmap even if the other baking parameters are the same. + + + + + The radius (in texels) of the post-processing filter that blurs baked direct lighting. + + + + + Controls the resolution at which Enlighten stores and can transfer input light. + + + + + The number of rays used for lights with an area. Allows for accurate soft shadowing. + + + + + The amount of data used for realtime GI texels. Specifies how detailed view of the Scene a texel has. Small values mean more averaged out lighting. + + + + + The number of rays to cast for computing irradiance form factors. + + + + + If enabled, the object appears transparent during GlobalIllumination lighting calculations. + + + + + Maximum size of gaps that can be ignored for GI (multiplier on pixel size). + + + + + The texel resolution per meter used for realtime lightmaps. This value is multiplied by LightmapEditorSettings.resolution. + + + + + Whether pairs of edges should be stitched together. + + + + + System tag is an integer identifier. It lets you force an object into a different Enlighten system even though all the other parameters are the same. + + + + + The maximum number of times to supersample a texel to reduce aliasing in AO. + + + + + The number of rays to cast for computing ambient occlusion. + + + + + Allows to control the lightmapping job. + + + + + Is baked GI enabled? + + + + + Boost the albedo. + + + + + Returns the current lightmapping build progress or 0 if Lightmapping.isRunning is false. + + + + + Delegate which is called when bake job is completed. + + + + + The lightmap baking workflow mode used. Iterative mode is default, but you can switch to on demand mode which bakes only when the user presses the bake button. + + + + + Scale for indirect lighting. + + + + + Returns true when the bake job is running, false otherwise (Read Only). + + + + + The lighting data asset used by the active Scene. + + + + + Is realtime GI enabled? + + + + + Delegate which is called when bake job is started. + + + + + + Starts a synchronous bake job. + + + + + Starts an asynchronous bake job. + + + + + Starts a synchronous bake job, but only bakes light probes. + + + + + Starts an asynchronous bake job, but only bakes light probes. + + + + + Bakes an array of Scenes. + + The path of the Scenes that should be baked. + + + + Starts a synchronous bake job for the probe. + + Target probe. + The location where cubemap will be saved. + + Returns true if baking was succesful. + + + + + Starts a synchronous bake job for the selected objects. + + + + + Starts an asynchronous bake job for the selected objects. + + + + + Cancels the currently running asynchronous bake job. + + + + + Deletes all lightmap assets and makes all lights behave as if they weren't baked yet. + + + + + Clears the cache used by lightmaps, reflection probes and default reflection. + + + + + Remove the lighting data asset used by the current Scene. + + + + + Force the Progressive Path Tracer to stop baking and use the computed results as they are. + + + + + Get how many chunks the terrain is divided into for GI baking. + + The terrain. + Number of chunks in terrain width. + Number of chunks in terrain length. + + + + Workflow mode for lightmap baking. Default is Iterative. + + + + + Always run lightmapping, changes to the Scene are detected automatically. + + + + + Deprecated 4.x lightmapping support. + + + + + Run lightmapping only when the user presses the bake button. + + + + + Delegate used by Lightmapping.completed callback. + + + + + Delegate used by Lightmapping.started callback. + + + + + Calculates a Delaunay Tetrahedralization of the 'positions' point set - the same way the lightmapper. + + + + + + + + LOD Utility Helpers. + + + + + Recalculate the bounding region for the given LODGroup. + + + + + + Mac fullscreen mode. + + + + + Fullscreen window. + + + + + Fullscreen window with Dock and Menu bar. + + + + + Defines how aggressively Unity strips unused managed (C#) code. + + + + + Do not strip any code. + + + + + UnityLinker will strip as much as possible. This will further reduce code size beyond what Medium can achieve. However, this additional reduction may come with tradeoffs. Possible side effects may include, managed code debugging of some methods may no longer work. You may need to maintain a custom link.xml file, and some reflection code paths may not behave the same. + + + + + Remove unreachable managed code to reduce build size and Mono/IL2CPP build times. + + + + + Run UnityLinker in a less conservative mode than Low. This will further reduce code size beyond what Low can achieve. However, this additional reduction may come with tradeoffs. Possible side effects may include, having to maintain a custom link.xml file, and some reflection code paths may not behave the same. + + + + + The Unity Material Editor. + + + + + Is the current material expanded. + + + + + Useful for indenting shader properties that need the same indent as mini texture field. + + + + + Apply initial MaterialPropertyDrawer values. + + + + + + + Apply initial MaterialPropertyDrawer values. + + + + + + + Called when the Editor is woken up. + + + + + Creates a Property wrapper, useful for making regular GUI controls work with MaterialProperty. + + Rectangle on the screen to use for the control, including label if applicable. + The MaterialProperty to use for the control. + + + + Creates a Property wrapper, useful for making regular GUI controls work with MaterialProperty. + + Rectangle on the screen to use for the control, including label if applicable. + The MaterialProperty to use for the control. + + + + Draw a property field for a color shader property. + + Label for the property. + + + + + + Draw a property field for a color shader property. + + Label for the property. + + + + + + Default handling of preview area for materials. + + + + + + + Default toolbar for material preview area. + + + + + Handles UI for one shader property ignoring any custom drawers. + + + + + + + + Handles UI for one shader property ignoring any custom drawers. + + + + + + + + Display UI for editing a material's Double Sided Global Illumination setting. +Returns true if the UI is indeed displayed i.e. the material supports the Double Sided Global Illumination setting. ++See Also: Material.doubleSidedGI. + + + True if the UI is displayed, false otherwise. + + + + + This function will draw the UI for controlling whether emission is enabled or not on a material. + + + Returns true if enabled, or false if disabled or mixed due to multi-editing. + + + + + Display UI for editing material's render queue setting. + + + + + Display UI for editing material's render queue setting within the specified rect. + + + + + + Ends a Property wrapper started with BeginAnimatedCheck. + + + + + Returns a properly set global illlumination flag based on the passed in flag and the given color. + + Emission color. + Current global illumination flag. + + The fixed up flag. + + + + + Properly sets up the globalIllumination flag on the given Material depending on the current flag's state and the material's emission property. + + The material to be fixed up. + + + + Draw a property field for a float shader property. + + Label for the property. + + + + + + Draw a property field for a float shader property. + + Label for the property. + + + + + + Calculate height needed for the property, ignoring custom drawers. + + + + + + Utility method for GUI layouting ShaderGUI. Used e.g for the rect after a left aligned Color field. + + Field Rect. + + A sub rect of the input Rect. + + + + + Utility method for GUI layouting ShaderGUI. + + Field Rect. + + A sub rect of the input Rect. + + + + + Utility method for GUI layouting ShaderGUI. + + Field Rect. + + A sub rect of the input Rect. + + + + + Get shader property information of the passed materials. + + + + + + Get information about a single shader property. + + Selected materials. + Property name. + Property index. + + + + Get information about a single shader property. + + Selected materials. + Property name. + Property index. + + + + Calculate height needed for the property. + + + + + + + Calculate height needed for the property. + + + + + + + Utility method for GUI layouting ShaderGUI. This is the rect after the label which can be used for multiple properties. The input rect can be fetched by calling: EditorGUILayout.GetControlRect. + + Line Rect. + + A sub rect of the input Rect. + + + + + Utility method for GUI layouting ShaderGUI. + + Field Rect. + + A sub rect of the input Rect. + + + + + Get the value of a given texture offset for a given texture property. + + Name of the texture property that you wish to examine the offset of. + Does the x offset have multiple values? + Does the y offset have multiple values? + + + + Returns the free rect below the label and before the large thumb object field. Is used for e.g. tiling and offset properties. + + The total rect of the texture property. + + + + Get the value of a given texture scale for a given texture property. + + Name of the texture property that you wish to examine the scale of. + Does the x scale have multiple values? + Does the y scale have multiple values? + + + + Can this component be Previewed in its current state? + + + True if this component can be Previewed in its current state. + + + + + Make a help box with a message and button. Returns true, if button was pressed. + + The message text. + The button text. + + Returns true, if button was pressed. + + + + + Determines whether the Enable Instancing checkbox is checked. + + + Returns true if Enable Instancing checkbox is checked. + + + + + Draws the UI for setting the global illumination flag of a material. + + Level of indentation for the property. + True if emission is enabled for the material, false otherwise. + + + + This function will draw the UI for the lightmap emission property. (None, Realtime, baked) + +See Also: MaterialLightmapFlags. + + + + + This function will draw the UI for the lightmap emission property. (None, Realtime, baked) + +See Also: MaterialLightmapFlags. + + + + + This function will draw the UI for the lightmap emission property. (None, Realtime, baked) + +See Also: MaterialLightmapFlags. + + + + + Called when the editor is disabled, if overridden please call the base OnDisable() to ensure that the material inspector is set up properly. + + + + + Called when the editor is enabled, if overridden please call the base OnEnable() to ensure that the material inspector is set up properly. + + + + + Implement specific MaterialEditor GUI code here. If you want to simply extend the existing editor call the base OnInspectorGUI () before doing any custom GUI code. + + + + + Custom preview for Image component. + + Rectangle in which to draw the preview. + Background image. + + + + A callback that is invoked when a Material's Shader is changed in the Inspector. + + + + + Whenever a material property is changed call this function. This will rebuild the inspector and validate the properties. + + + + + Default rendering of shader properties. + + Array of material properties. + + + + Render the standard material properties. This method will either render properties using a IShaderGUI instance if found otherwise it uses PropertiesDefaultGUI. + + + Returns true if any value was changed. + + + + + Draw a range slider for a range shader property. + + Label for the property. + The property to edit. + Position and size of the range slider control. + + + + Draw a range slider for a range shader property. + + Label for the property. + The property to edit. + Position and size of the range slider control. + + + + Call this when you change a material property. It will add an undo for the action. + + Undo Label. + + + + Display UI for editing material's render queue setting. + + + + + + Display UI for editing material's render queue setting. + + + + + + Does this edit require to be repainted constantly in its current state? + + + + + Set EditorGUIUtility.fieldWidth and labelWidth to the default values that PropertiesGUI uses. + + + + + Set the shader of the material. + + Shader to set. + Should undo be registered. + + + + + Set the shader of the material. + + Shader to set. + Should undo be registered. + + + + + Set the offset of a given texture property. + + Name of the texture property that you wish to modify the offset of. + Scale to set. + Set the x or y component of the offset (0 for x, 1 for y). + + + + Set the scale of a given texture property. + + Name of the texture property that you wish to modify the scale of. + Scale to set. + Set the x or y component of the scale (0 for x, 1 for y). + + + + Handes UI for one shader property. + + + + + + + + Handes UI for one shader property. + + + + + + + + Checks if particular property has incorrect type of texture specified by the material, displays appropriate warning and suggests the user to automatically fix the problem. + + The texture property to check and display warning for, if necessary. + + + + Draw a property field for a texture shader property. + + Label for the field. + Draw scale / offset. + + + + + + + Draw a property field for a texture shader property. + + Label for the field. + Draw scale / offset. + + + + + + + Draw a property field for a texture shader property. + + Label for the field. + Draw scale / offset. + + + + + + + Draw a property field for a texture shader property. + + Label for the field. + Draw scale / offset. + + + + + + + Draw a property field for a texture shader property. + + Label for the field. + Draw scale / offset. + + + + + + + Draw a property field for a texture shader property that only takes up a single line height. + + Rect that this control should be rendered in. + Label for the field. + + + + Returns total height used by this control. + + + + + Method for showing a texture property control with additional inlined properites. + + The label used for the texture property. + The texture property. + First optional property inlined after the texture property. + Second optional property inlined after the extraProperty1. + + Returns the Rect used. + + + + + Method for showing a texture property control with additional inlined properites. + + The label used for the texture property. + The texture property. + First optional property inlined after the texture property. + Second optional property inlined after the extraProperty1. + + Returns the Rect used. + + + + + Method for showing a texture property control with additional inlined properites. + + The label used for the texture property. + The texture property. + First optional property inlined after the texture property. + Second optional property inlined after the extraProperty1. + + Returns the Rect used. + + + + + Method for showing a compact layout of properties. + + The label used for the texture property. + The texture property. + First extra property inlined after the texture property. + Label for the second extra property (on a new line and indented). + Second property on a new line below the texture. + + Returns the Rect used. + + + + + Method for showing a texture property control with a HDR color field and its color brightness float field. + + The label used for the texture property. + The texture property. + The color property (will be treated as a HDR color). + If false then the alpha channel information will be hidden in the GUI. + + + Return the Rect used. + + + + + Method for showing a texture property control with a HDR color field and its color brightness float field. + + The label used for the texture property. + The texture property. + The color property (will be treated as a HDR color). + If false then the alpha channel information will be hidden in the GUI. + + + Return the Rect used. + + + + + Draws tiling and offset properties for a texture. + + Rect to draw this control in. + Property to draw. + If this control should be rendered under large texture property control use 'true'. If this control should be shown seperately use 'false'. + + + + Draws tiling and offset properties for a texture. + + Rect to draw this control in. + Property to draw. + If this control should be rendered under large texture property control use 'true'. If this control should be shown seperately use 'false'. + + + + TODO. + + + + + + + + TODO. + + + + + + + + Draw a property field for a vector shader property. + + Label for the field. + + + + + + Draw a property field for a vector shader property. + + Label for the field. + + + + + + Extension methods for the Material asset type in the editor. + + + + + Iterates over all the Material properties with the MaterialProperty.PropFlags.Normal flag and checks that the textures referenced by these properties are imported as TextureImporterType.NormalMap. + + The target material. + + + + Describes information and value of a single shader property. + + + + + Color value of the property. + + + + + Display name of the property (Read Only). + + + + + Flags that control how property is displayed (Read Only). + + + + + Float vaue of the property. + + + + + Does this property have multiple different values? (Read Only) + + + + + Name of the property (Read Only). + + + + + Min/max limits of a ranged float property (Read Only). + + + + + Material objects being edited by this property (Read Only). + + + + + Texture dimension (2D, Cubemap etc.) of the property (Read Only). + + + + + Texture value of the property. + + + + + Type of the property (Read Only). + + + + + Vector value of the property. + + + + + Flags that control how a MaterialProperty is displayed. + + + + + Signifies that values of this property are in gamma space and should not be gamma corrected. + + + + + Signifies that values of this property contain High Dynamic Range (HDR) data. + + + + + Do not show the property in the Inspector. + + + + + No flags are set. + + + + + Do not allow this texture property to be edited in the Inspector. + + + + + Signifies that values of this property contain Normal (normalized vector) data. + + + + + Do not show UV scale/offset fields next to a texture. + + + + + Texture value for this property will be queried from renderer's MaterialPropertyBlock, instead of from the material. This corresponds to the "[PerRendererData]" attribute in front of a property in the shader code. + + + + + Material property type. + + + + + Color property. + + + + + Float property. + + + + + Ranged float (with min/max values) property. + + + + + Texture property. + + + + + Vector property. + + + + + Base class to derive custom material property drawers from. + + + + + Apply extra initial values to the material. + + The MaterialProperty to apply values for. + + + + Override this method to specify how tall the GUI for this property is in pixels. + + The MaterialProperty to make the custom GUI for. + The label of this property. + Current material editor. + + + + Override this method to make your own GUI for the property. + + Rectangle on the screen to use for the property GUI. + The MaterialProperty to make the custom GUI for. + The label of this property. + Current material editor. + + + + Descriptor for audio track format. + + + + + Number of channels. + + + + + Dialogue language, if applicable. Can be empty. + + + + + Audio sampling rate. + + + + + Encodes images and audio samples into an audio or movie file. + + + + + Appends a frame to the file's video track. + + Texture containing the pixels to be written into the track for the current frame. + + True if the operation succeeded. False otherwise. + + + + + Appends sample frames to the specified audio track. + + Index of the track to which sample frames will be added. + Sample frames to add. Samples are expected to be interleaved. + + True if the operation succeeded. False otherwise. + + + + + Appends sample frames to the specified audio track. + + Index of the track to which sample frames will be added. + Sample frames to add. Samples are expected to be interleaved. + + True if the operation succeeded. False otherwise. + + + + + Create a new encoder with various track arrangements. + + Path fo the media file to be written. + Attributes for the file's video track, if any. + Attributes for the file's audio tracks, if any. + + + + Create a new encoder with various track arrangements. + + Path fo the media file to be written. + Attributes for the file's video track, if any. + Attributes for the file's audio tracks, if any. + + + + Create a new encoder with various track arrangements. + + Path fo the media file to be written. + Attributes for the file's video track, if any. + Attributes for the file's audio tracks, if any. + + + + Create a new encoder with various track arrangements. + + Path fo the media file to be written. + Attributes for the file's video track, if any. + Attributes for the file's audio tracks, if any. + + + + Create a new encoder with various track arrangements. + + Path fo the media file to be written. + Attributes for the file's video track, if any. + Attributes for the file's audio tracks, if any. + + + + Finishes writing all tracks and closes the file being written. + + + + + Rational number useful for expressing fractions precisely. + + + + + Fraction denominator. + + + + + Fraction numerator. + + + + + Constructs a rational number whose denominator is 1. + + Numerator. Will also become the rational value as the denominator is set to 1. + + + + Descriptor for audio track format. + + + + + VideoBitrateMode for the encoded video. + + + + + Frames per second. + + + + + Image height in pixels. + + + + + True if the track is to include the alpha channel found in the texture passed to AddFrame. False otherwise. + + + + + Image width in pixels. + + + + + A pair of from and to indices describing what thing keeps what other thing alive. + + + + + Index into a virtual list of all GC handles, followed by all native objects. + + + + + Index into a virtual list of all GC handles, followed by all native objects. + + + + + Description of a field of a managed type. + + + + + Is this field static? + + + + + Name of this field. + + + + + Offset of this field. + + + + + The typeindex into PackedMemorySnapshot.typeDescriptions of the type this field belongs to. + + + + + A dump of a piece of memory from the player that's being profiled. + + + + + The actual bytes of the memory dump. + + + + + The start address of this piece of memory. + + + + + MemorySnapshot is a profiling tool to help diagnose memory usage. + + + + + Event that will be fired when a new memory snapshot comes in through the profiler connection. Its argument will be a PackedMemorySnapshot. + + + + + + Requests a new snapshot from the currently connected target of the profiler. Memory snapshots are supported on IL2CPP and Mono .NET 3.5/4.0 scripting backends, although .NET 3.5 has been deprecated as of 2018.3. + + +NOTE: Each snapshot consists of approximately one managed object per recorded managed object. Snapshots taken from the editor will contain the objects in all previous snapshots that have not yet been garbage-collected. Therefore, repeated snapshots of the editor may grow exponentially. If you no longer need an old snapshot it is therefore advisable to null all references to it and call GC.Collect() before taking another one. + + + + + A description of a GC handle used by the virtual machine. + + + + + The address of the managed object that the GC handle is referencing. + + + + + PackedMemorySnapshot is a compact representation of a memory snapshot. + + + + + Connections is an array of from,to pairs that describe which things are keeping which other things alive. + + + + + All GC handles in use in the memorysnapshot. + + + + + Array of actual managed heap memory sections. + + + + + All native C++ objects that were loaded at time of the snapshot. + + + + + Descriptions of all the C++ unity types the profiled player knows about. + + + + + Descriptions of all the managed types that were known to the virtual machine when the snapshot was taken. + + + + + Information about the virtual machine running executing the managade code inside the player. + + + + + A description of a C++ unity type. + + + + + Name of this C++ unity type. + + + + + The index used to obtain the native C++ base class description from the PackedMemorySnapshot.nativeTypes array. + + + + + Description of a C++ unity object in memory. + + + + + The hideFlags this native object has. + + + + + InstanceId of this object. + + + + + Has this object has been marked as DontDestroyOnLoad? + + + + + Is this native object an internal Unity manager object? + + + + + Is this object persistent? (Assets are persistent, objects stored in Scenes are persistent, dynamically created objects are not) + + + + + Name of this object. + + + + + The memory address of the native C++ object. This matches the "m_CachedPtr" field of UnityEngine.Object. + + + + + The index used to obtain the native C++ type description from the PackedMemorySnapshot.nativeTypes array. + + + + + Size in bytes of this object. + + + + + Equivalent of Profiling.PackedNativeUnityEngineObject.ObjectFlags in the old memory profiler API. + + + + + Equivalent of Profiling.PackedNativeUnityEngineObject.ObjectFlags.IsDontDestroyOnLoad in the old memory profiler API. + + + + + Equivalent of Profiling.PackedNativeUnityEngineObject.ObjectFlags.IsManager in the old memory profiler API. + + + + + Equivalent of Profiling.PackedNativeUnityEngineObject.ObjectFlags.IsPersistent in the old memory profiler API. + + + + + Description of a managed type. + + + + + If this is an arrayType, this will return the rank of the array. (1 for a 1-dimensional array, 2 for a 2-dimensional array, etc) + + + + + Name of the assembly this type was loaded from. + + + + + The base type for this type, pointed to by an index into PackedMemorySnapshot.typeDescriptions. + + + + + An array containing descriptions of all fields of this type. + + + + + Is this type an array? + + + + + Is this type a value type? (if it's not a value type, it's a reference type) + + + + + Name of this type. + + + + + Size in bytes of an instance of this type. If this type is an arraytype, this describes the amount of bytes a single element in the array will take up. + + + + + The actual contents of the bytes that store this types static fields, at the point of time when the snapshot was taken. + + + + + The typeIndex of this type. This index is an index into the PackedMemorySnapshot.typeDescriptions array. + + + + + The address in memory that contains the description of this type inside the virtual machine. This can be used to match managed objects in the heap to their corresponding TypeDescription, as the first pointer of a managed object points to its type description. + + + + + Equivalent of Profiling.TypeFlags in the old memory profiler API. + + + + + Equivalent of Profiling.TypeFlags.kArray in the old memory profiler API. + + + + + Equivalent of Profiling.TypeFlags.kArrayRankMask in the old memory profiler API. + + + + + Equivalent of Profiling.TypeFlags.kValueType in the old memory profiler API. + + + + + Information about the virtual machine running executing the managed code inside the player. + + + + + Allocation granularity in bytes used by the virtual machine allocator. + + + + + Offset in bytes inside the object header of an array object where the bounds of the array is stored. + + + + + Size in bytes of the header of an array object. + + + + + Offset in bytes inside the object header of an array object where the size of the array is stored. + + + + + A version number that will change when the object layout inside the managed heap will change. + + + + + Size in bytes of the header of each managed object. + + + + + Size in bytes of a pointer. + + + + + Menu class to manipulate the menu item. + + + + + Default constructor. + + + + + Get the check status of the given menu. + + + + + + Set the check status of the given menu. + + + + + + + Used to extract the context for a MenuItem. + + + + + Context is the object that is the target of a menu command. + + + + + An integer for passing custom information to a menu item. + + + + + Creates a new MenuCommand object. + + + + + + + Creates a new MenuCommand object. + + + + + + The MenuItem attribute allows you to add menu items to the main menu and inspector context menus. + + + + + Creates a menu item and invokes the static function following it, when the menu item is selected. + + The itemName is the menu item represented like a pathname. + For example the menu item could be "GameObject/Do Something". + If isValidateFunction is true, this is a validation + function and will be called before invoking the menu function with the same itemName. + The order by which the menu items are displayed. + + + + Creates a menu item and invokes the static function following it, when the menu item is selected. + + The itemName is the menu item represented like a pathname. + For example the menu item could be "GameObject/Do Something". + If isValidateFunction is true, this is a validation + function and will be called before invoking the menu function with the same itemName. + The order by which the menu items are displayed. + + + + Creates a menu item and invokes the static function following it, when the menu item is selected. + + The itemName is the menu item represented like a pathname. + For example the menu item could be "GameObject/Do Something". + If isValidateFunction is true, this is a validation + function and will be called before invoking the menu function with the same itemName. + The order by which the menu items are displayed. + + + + Various utilities for mesh manipulation. + + + + + Returns the mesh compression setting for a Mesh. + + The mesh to get information on. + + + + Optimizes the mesh for GPU access. + + + + + + Change the mesh compression setting for a mesh. + + The mesh to set the compression mode for. + The compression mode to set. + + + + Will insert per-triangle uv2 in mesh and handle vertex splitting etc. + + + + + + + User message types. + + + + + Error message. + + + + + Info message. + + + + + Neutral message. + + + + + Warning message. + + + + + Compressed texture format for target build platform. + + + + + ASTC texture compression. + + + + + S3 texture compression. Supported on devices with NVidia Tegra, Vivante and Intel GPUs. + + + + + ETC1 texture compression (or ETC2 for textures with alpha). ETC1 is supported by all devices. ETC2 is available on devices which support OpenGL ES 3.0; on OpenGL ES 2 devices the texture is decompressed on CPU. + + + + + ETC2 texture compression. Available on devices which support OpenGL ES 3.0; on OpenGL ES 2 devices the texture is decompressed on CPU. + + + + + Don't override texture compression. + + + + + PowerVR texture compression. Available on devices with PowerVR GPU. + + + + + Model importer lets you modify import settings from editor scripts. + + + + + Add to imported meshes. + + + + + Animation compression setting. + + + + + Allowed error of animation position compression. + + + + + Allowed error of animation rotation compression. + + + + + Allowed error of animation scale compression. + + + + + Animator generation mode. + + + + + The default wrap mode for the generated animation clips. + + + + + Bake Inverse Kinematics (IK) when importing. + + + + + Animation clips to split animation into. See Also: ModelImporterClipAnimation. + + + + + Generate a list of all default animation clip based on TakeInfo. + + + + + Animation optimization setting. + + + + + Additional properties to treat as user properties. + + + + + Animation generation options. + + + + + Material generation options. + + + + + Generate secondary UV set for lightmapping. + + + + + Global scale factor for importing. + + + + + The human description that is used to generate an Avatar during the import process. + + + + + Controls how much oversampling is used when importing humanoid animations for retargeting. + + + + + Import animated custom properties from file. + + + + + Import animation from file. + + + + + Blend shape normal import options. + + + + + Controls import of BlendShapes. + + + + + Controls import of cameras. Basic properties like field of view, near plane distance and far plane distance can be animated. + + + + + Import animation constraints. + + + + + Generates the list of all imported take. + + + + + Controls import of lights. Note that because light are defined differently in DCC tools, some light types or properties may not be exported. Basic properties like color and intensity can be animated. + + + + + Import materials from file. + + + + + Vertex normal import options. + + + + + Vertex tangent import options. + + + + + Use visibility properties to enable or disable MeshRenderer components. + + + + + Format of the imported mesh index buffer data. + + + + + Is Bake Inverse Kinematics (IK) supported by this importer. + + + + + Is FileScale used when importing. + + + + + Are mesh vertices and indices accessible from script? + + + + + Is import of tangents supported by this importer. + + + + + Is useFileUnits supported for this asset. + + + + + If this is true, any quad faces that exist in the mesh data before it is imported are kept as quads instead of being split into two triangles, for the purposes of tessellation. Set this to false to disable this behavior. + + + + + Material import location options. + + + + + Material naming setting. + + + + + Existing material search setting. + + + + + Mesh compression setting. + + + + + The path of the transform used to generation the motion of the animation. + + + + + Normal generation options for ModelImporter. + + + + + Normals import mode. + + + + + Smoothing angle (in degrees) for calculating normals. + + + + + Source of smoothing information for calculation of normals. + + + + + Animation optimization setting. + + + + + Vertex optimization setting. + + + + + If true, always create an explicit Prefab root. Otherwise, if the model has a single root, it is reused as the Prefab root. + + + + + Generates the list of all imported Animations. + + + + + If set to false, the importer will not resample curves when possible. +Read more about. + +Notes: + +- Some unsupported FBX features (such as PreRotation or PostRotation on transforms) will override this setting. In these situations, animation curves will still be resampled even if the setting is disabled. For best results, avoid using PreRotation, PostRotation and GetRotationPivot. + +- This option was introduced in Version 5.3. Prior to this version, Unity's import behaviour was as if this option was always enabled. Therefore enabling the option gives the same behaviour as pre-5.3 animation import. + + + + + + Threshold for angle distortion (in degrees) when generating secondary UV. + + + + + Threshold for area distortion when generating secondary UV. + + + + + Hard angle (in degrees) for generating secondary UV. + + + + + Margin to be left between charts when packing secondary UV. + + + + + Imports the HumanDescription from the given Avatar. + + + + + Should tangents be split across UV seams. + + + + + Swap primary and secondary UV channels when importing. + + + + + Tangents import mode. + + + + + Generates the list of all imported Transforms. + + + + + Use FileScale when importing. + + + + + Detect file units and import as 1FileUnit=1UnityUnit, otherwise it will import as 1cm=1UnityUnit. + + + + + When disabled, imported material albedo colors are converted to gamma space. This property should be disabled when using linear color space in Player rendering settings. +The default value is true. + + + + + Combine vertices that share the same position in space. + + + + + Creates a mask that matches the model hierarchy, and applies it to the provided ModelImporterClipAnimation. + + Clip to which the mask will be applied. + + + + Extracts the embedded textures from a model file (such as FBX or SketchUp). + + The directory where the textures will be extracted. + + Returns true if the textures are extracted successfully, otherwise false. + + + + + Search the project for matching materials and use them instead of the internal materials. + + The name matching option. + The search type option. + + Returns true if the materials have been successfly remapped, otherwise false. + + + + + Animation compression options for ModelImporter. + + + + + Perform keyframe reduction. + + + + + Perform keyframe reduction and compression. + + + + + No animation compression. + + + + + Perform keyframe reduction and choose the best animation curve representation at runtime to reduce memory footprint (default). + + + + + Animation mode for ModelImporter. + + + + + Generate a generic animator. + + + + + Generate a human animator. + + + + + Generate a legacy animation type. + + + + + Generate no animation data. + + + + + Animation clips to split animation into. + + + + + The additive reference pose frame. + + + + + Additionnal curves that will be that will be added during the import process. + + + + + Offset to the cycle of a looping animation, if a different time in it is desired to be the start. + + + + + AnimationEvents that will be added during the import process. + + + + + First frame of the clip. + + + + + Enable to defines an additive reference pose. + + + + + Keeps the feet aligned with the root transform position. + + + + + Offset to the vertical root position. + + + + + Keeps the vertical position as it is authored in the source file. + + + + + Keeps the vertical position as it is authored in the source file. + + + + + Keeps the vertical position as it is authored in the source file. + + + + + Last frame of the clip. + + + + + Enable to make vertical root motion be baked into the movement of the bones. Disable to make vertical root motion be stored as root motion. + + + + + Enable to make horizontal root motion be baked into the movement of the bones. Disable to make horizontal root motion be stored as root motion. + + + + + Enable to make root rotation be baked into the movement of the bones. Disable to make root rotation be stored as root motion. + + + + + Is the clip a looping animation? + + + + + Enable to make the motion loop seamlessly. + + + + + Enable to make the clip loop. + + + + + Returns true when the source AvatarMask has changed. This only happens when ModelImporterClipAnimation.maskType is set to ClipAnimationMaskType.CopyFromOther +To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource to the desired AvatarMask. + + + + + The AvatarMask used to mask transforms during the import process. + + + + + Define mask type. + + + + + Mirror left and right in this clip. + + + + + Clip name. + + + + + Offset in degrees to the root rotation. + + + + + Take name. + + + + + The wrap mode of the animation. + + + + + Copy the mask settings from an AvatarMask to the clip configuration. + + AvatarMask from which the mask settings will be imported. + + + + Copy the current masking settings from the clip to an AvatarMask. + + AvatarMask to which the masking values will be saved. + + + + Animation generation options for ModelImporter. These options relate to the legacy Animation system, they should only be used when ModelImporter.animationType==ModelImporterAnimationType.Legacy. + + + + + Default animation import mode (All animations are stored in the root object). + + + + + Generate animations in the objects that animate. + + + + + Generate animations in the root objects of the animation package. + + + + + Generate animations in the transform root objects. + + + + + Do not generate animations. + + + + + Material generation options for ModelImporter. + + + + + Do not generate materials. + + + + + Generate a material for each material in the source asset. + + + + + Generate a material for each texture used. + + + + + Humanoid Oversampling available multipliers. + + + + + Default Humanoid Oversampling multiplier = 1 which is equivalent to no oversampling. + + + + + Humanoid Oversampling samples at 2 times the sampling rate found in the imported file. + + + + + Humanoid Oversampling samples at 4 times the sampling rate found in the imported file. + + + + + Humanoid Oversampling samples at 8 times the sampling rate found in the imported file. + + + + + Format of the imported mesh index buffer data. + + + + + Use 16 or 32 bit index buffer depending on mesh size. + + + + + Use 16 bit index buffer. + + + + + Use 32 bit index buffer. + + + + + Material import options for ModelImporter. + + + + + Extract the materials and textures from the model. + + + + + Unity imports materials as sub-assets. + + + + + Material naming options for ModelImporter. + + + + + Use a material name of the form <materialName>.mat. + + + + + Use material names in the form <modelFileName>-<materialName>.mat. + + + + + Use material names in the form <textureName>.mat. + + + + + <textureName>.mat or <modelFileName>-<materialName>.mat material name. + + + + + Material search options for ModelImporter. + + + + + Search in all project. + + + + + Search in local Materials folder. + + + + + Recursive-up search in Materials folders. + + + + + Mesh compression options for ModelImporter. + + + + + High amount of mesh compression. + + + + + Low amount of mesh compression. + + + + + Medium amount of mesh compression. + + + + + No mesh compression (default). + + + + + Normal generation options for ModelImporter. + + + + + The normals are weighted by the vertex angle on each face. + + + + + The normals are weighted by both the face area and the vertex angle on each face. + + + + + The normals are weighted by the face area. + + + + + The normals are not weighted. + + + + + The normals are unweighted. This option uses the legacy algorithm for handling hard edges. + + + + + Normal generation options for ModelImporter. + + + + + Calculate vertex normals. + + + + + Import vertex normals from model file (default). + + + + + Do not import vertex normals. + + + + + Source of smoothing information for calculation of normals in ModelImporter. + + + + + Use the angle between adjacent faces to determine if an edge is smooth or hard. + + + + + Use smoothing groups to determine which edges are smooth and which are hard. + + + + + Do not create hard edges. + + + + + Use smoothing groups if they are present in the Model file, otherwise use angle (default). + + + + + Vertex tangent generation options for ModelImporter. + + + + + Calculate tangents with legacy algorithm. + + + + + Calculate tangents with legacy algorithm, with splits across UV charts. + + + + + Calculate tangents using MikkTSpace (default). + + + + + Import vertex tangents from model file. + + + + + Do not import vertex tangents. + + + + + Tangent space generation options for ModelImporter. + + + + + Calculate tangents. + + + + + Import normals/tangents from file. + + + + + Strip normals/tangents. + + + + + Representation of Script assets. + + + + + Returns the MonoScript object containing specified MonoBehaviour. + + The MonoBehaviour whose MonoScript should be returned. + + + + Returns the MonoScript object containing specified ScriptableObject. + + The ScriptableObject whose MonoScript should be returned. + + + + Returns the System.Type object of the class implemented by this script. + + + + + Custom mouse cursor shapes used with EditorGUIUtility.AddCursorRect. + + + + + Normal pointer arrow. + + + + + Arrow with the minus symbol next to it. + + + + + Arrow with the plus symbol next to it. + + + + + The current user defined cursor. + + + + + Cursor with an eye and stylized arrow keys for FPS navigation. + + + + + Arrow with a Link badge (for assigning pointers). + + + + + Arrow with the move symbol next to it for the sceneview. + + + + + Cursor with an eye for orbit. + + + + + Cursor with a dragging hand for pan. + + + + + Horizontal resize arrows. + + + + + Resize up-Left for window edges. + + + + + Resize up-right for window edges. + + + + + Vertical resize arrows. + + + + + Arrow with the rotate symbol next to it for the sceneview. + + + + + Arrow with the scale symbol next to it for the sceneview. + + + + + Arrow with small arrows for indicating sliding at number fields. + + + + + Left-Right resize arrows for window splitters. + + + + + Up-Down resize arrows for window splitters. + + + + + Text cursor. + + + + + Cursor with a magnifying glass for zoom. + + + + + AssetImporter for importing MovieTextures. + + + + + Duration of the Movie to be imported in seconds. + + + + + Is the movie texture storing non-color data? + + + + + Quality setting to use when importing the movie. This is a float value from 0 to 1. + + + + + Information of the connected player. + + + + + The name of the connected player. + + + + + The ID of the player connected. + + + + + Handles the connection from the Editor to the Player. + + + + + A list of the connected Players. + + + + + Disconnects all of the active connections between the Editor and the Players. + + + + + Initializes the EditorConnection. + + + + + Registers a callback on a certain message ID. + + The message ID that invokes the callback when received by the Editor. + Action that is executed when a message with ID messageId is received by the Editor. +The callback includes the data that is sent from the Player, and the Player's ID. +The Player ID is used to distinguish between multiple Players connected to the same Editor. + + + + Registers a callback, executed when a new Player connects to the Editor. + + Action called when a new Player connects, with the Player ID of the Player. + + + + Registers a callback on a Player when that Player disconnects. + + The Action that is called when the Player with the given Player ID disconnects. + + + + Sends data to the connected Players. + + The type ID of the message to send to the connected Players. + The ID of the Player that you want to sent this message to. If you want to send it to all Players, set this to 0. + + + + + Sends data to the connected Players. + + The type ID of the message to send to the connected Players. + The ID of the Player that you want to sent this message to. If you want to send it to all Players, set this to 0. + + + + + Deregisters a registered callback. + + Message ID associated with the callback that you wish to deregister. + The Action callback you wish to deregister. + + + + Use the DefaultObject to create a new UnityEngine.Object in the editor. + + + + + This is invoked every time a new Component or MonoBehaviour is added to a GameObject using the ObjectFactory. + + The callback to be added to the invocation list. + + + + Creates a new component and adds it to the specified GameObject. + + The GameObject to add the new component to. + The type of component to create and add to the GameObject. + + Returns the component that was created and added to the GameObject. + + + + + Creates a new component and adds it to the specified GameObject. + + The GameObject to add the new component to. + The type of component to create and add to the GameObject. + + Returns the component that was created and added to the GameObject. + + + + + Creates a new GameObject. + + Name of the GameObject. + The optional types to add to the GameObject when created. + + + + Create a new instance of the given type. + + The type of instance to create. + + + + Create a new instance of the given type. + + The type of instance to create. + + + + Creates a GameObject primitive. + + The type of primitive to create. + + + + Helper class for constructing displayable names for objects. + + + + + Class name of an object. + + + + + + Drag and drop title for an object. + + + + + + Inspector title for an object. + + + + + + Make a unique name using the provided name as a base. + +If the target name is in the provided list of existing names, a unique name is generated by appending the next available numerical increment. + + A list of pre-existing names. + Desired name to be used as is, or as a base. + + A name not found in the list of pre-existing names. + + + + + Make a displayable name for a variable. + + + + + + Sets the name of an Object. + + + + + + + Base Class to derive from when creating Custom Previews. + + + + + The object currently being previewed. + + + + + This is the first entry point for Preview Drawing. + + The available area to draw the preview. + + + + Implement this method to show object information on top of the object preview. + + + + + Override this method if you want to change the label of the Preview area. + + + + + Can this component be Previewed in its current state? + + + True if this component can be Previewed in its current state. + + + + + Called when the Preview gets created with the objects being previewed. + + The objects being previewed. + + + + Called to iterate through the targets, this will be used when previewing more than one target. + + + True if there is another target available. + + + + + Implement to create your own interactive custom preview. Interactive custom previews are used in the preview area of the inspector and the object selector. + + Rectangle in which to draw the preview. + Background image. + + + + Implement to create your own custom preview for the preview area of the inspector, primary editor headers and the object selector. + + Rectangle in which to draw the preview. + Background image. + + + + Override this method if you want to show custom controls in the preview header. + + + + + Called to Reset the target before iterating through them. + + + + + Identifies the author of a package. + + + + + The email address of the author (optional). + + + + + The name of the author. + + + + + The url address of the author (optional). + + + + + Utility class that allows packages to register build callbacks with the Unity Package Manager. + + + + + Register a callback object for a package. + + Object of a class that implements the IShouldIncludeInBuildCallback interface. + + + + Unity Package Manager client class. + + + + + Adds a package dependency to the project. + + The name or ID of the package to add. If only the name is specified, the latest version of the package is installed. + + An AddRequest instance, which you can use to monitor the asynchronous operation, and when complete, get the result. + + + + + Lists the packages the project depends on. + + Specifies whether or not the Package Manager requests the latest information about the project's packages from the remote Unity package registry. When offlineMode is true, the PackageManager.PackageInfo objects in the PackageCollection returned by the Package Manager contain information obtained from the local package cache, which could be out of date. + + A ListRequest instance, which you can use to monitor the asynchronous operation, and when complete, get the result. + + + + + Removes a previously added package from the project. + + The name or the ID of the package to remove from the project. If only the name is specified, the package is removed regardless of the installed version. + + A RemoveRequest instance, which you can use to monitor the status of the asynchronous operation. + + + + + Resets the list of packages installed for this project to the editor's default configuration. This operation will clear all packages added to the project and keep only the packages set for the current editor default configuration. + + + A ResetToEditorDefaultsRequest instance, which you can use to monitor the status of the asynchronous operation. + + + + + Searches the Unity package registry for the given package. + + The name or ID of the package. + + A SearchRequest instance, which you can use to monitor the asynchronous operation, and when complete, get the result. + + + + + Searches the Unity package registry for all packages compatible with the current Unity version. + + + A SearchRequest instance, which you can use to monitor the asynchronous operation, and when complete, get the result. + + + + + Structure describing dependencies to other packages in PackageInfo. + + + + + The name of the dependency. + + + + + The version of the dependency. + + + + + Structure describing the error of a package operation. + + + + + Numerical error code. + + + + + Error message or description. + + + + + Package operation Error. + + + + + Conflicting package versions were found. + + + + + Operation was not allowed. + + + + + Operation had invalid parameters. + + + + + A package required to fulfill the operation was not found. + + + + + Operation resulted in an unknown error. + + + + + Interface used by the Package Manager to request build information about packages. + + + + + The package name. + + + + + Defines the signature for the function invoked by the Package Manager to determine whether a package file should be included or excluded from a project build. + + The absolute path of the file to be included or excluded. + + Return true if the file given by path should be included in the build; otherwise, return false. + + + + + A collection of PackageInfo objects. + + + + + The error associated with the package collection. + + + + + Structure describing a Unity Package. + + + + + The asset path of the package in the AssetDatabase. + + + + + An AuthorInfo instance of the author of the package. + + + + + Category of the package. + + + + + An array of DependencyInfos listing all the packages this package directly depends on. + + + + + Detailed description of the package. + + + + + Friendly display name of the package. + + + + + The errors associated with the package. + + + + + An array of keywords associated with the package. + + + + + Unique name of the package. + + + + + Identifier of the package. + + + + + An array of DependencyInfos listing all the packages this package directly or indirectly depends to and the versions they resolved to. + + + + + The local path of the project on disk. + + + + + Source of the package contents. + + + + + The status of the package. + + + + + Version of the package. + + + + + A VersionsInfo instance containing information about the available versions of the package. + + + + + Source of packages. + + + + + The package is built-in and part of Unity. + + + + + The package is embedded in the Unity project. + + + + + The package is referenced directly by a Git URL. + + + + + The package is referenced by a local path. + + + + + The package is from a registry. + + + + + The package source is unknown. + + + + + Unity Package Manager package status. + + + + + The package and its dependencies are available on the local file system. + + + + + An error occurred while transfering the package or one of its dependencies to the local file system. + + + + + The package is being transferred into the local file system. + + + + + The package or one of its dependencies cannot be found on the local file system. + + + + + The status of the package is unknown. + + + + + Represents an asynchronous request to add a package to the project. + + + + + Represents an asynchronous request to list the packages in the project. + + + + + Represents an asynchronous request to remove a package from the project. + + + + + The package being removed by this request. + + + + + Tracks the state of an asynchronous Unity Package Manager (Upm) server operation. + + + + + The error returned by the request, if any. + + + + + Whether the request is complete. + + + + + The request status. + + + + + Tracks the state of an asynchronous Unity Package Manager (Upm) server operation that returns a non-empty response. + + + + + The response to the request. + + + + + Represents an asynchronous request to reset the project packages to the current Editor default configuration. + + + + + Represents an asynchronous request to find a package. + + + + + The package id or name used in this search operation. + + + + + Unity Package Manager operation status. + + + + + Package manager operation failed. + + + + + Package manager operation is in progress. + + + + + Package manager operation completed successfully. + + + + + Identifies the available versions of a package and which are the compatible, latest, and recommended versions. + + + + + All available versions of the package. + + + + + Versions of the package compatible with the current version of Unity. + + + + + Latest version of the package. + + + + + Latest version of the package compatible with the current version of Unity. + + + + + The recommended version of the package. If the recommended version is not available, then this property is an empty string. + + + + + Enumeration specifying the current pause state of the Editor. + +See Also: PlayModeStateChange, EditorApplication.pauseStateChanged, EditorApplication.isPaused. + + + + + Occurs as soon as the Editor is paused, which may occur during either edit mode or play mode. + + + + + Occurs as soon as the Editor is unpaused, which may occur during either edit mode or play mode. + + + + + Displays the Physics Debug Visualization options. + +The Physics Debug Visualization is only displayed if this window is visible. + +See Also: PhysicsVisualizationSettings. + + + + + This class contains the settings controlling the Physics Debug Visualization. + + + + + Alpha amount used for transparency blending. + + + + + Used to disinguish neighboring Colliders. + + + + + Shows extra options used to develop and debug the physics visualization. + + + + + Dirty marker used for refreshing the GUI. + + + + + Enables the mouse-over highlighting and mouse selection modes. + + + + + See PhysicsVisualizationSettings.FilterWorkflow. + + + + + Forcing the drawing of Colliders on top of any other geometry, regardless of depth. + + + + + Color for kinematic Rigidbodies. + + + + + Color for Rigidbodies, primarily active ones. + + + + + Should the PhysicsDebugWindow display the collision geometry. + + + + + Color for Rigidbodies that are controlled by the physics simulator, but are not currently being simulated. + + + + + Color for Colliders that do not have a Rigidbody component. + + + + + Maximum number of mesh tiles available to draw all Terrain Colliders. + + + + + Color for Colliders that are Triggers. + + + + + Controls whether the SceneView or the GameView camera is used. Not shown in the UI. + + + + + Colliders within this distance will be displayed. + + + + + Clears the highlighted Collider. + + + + + Deinitializes the physics debug visualization system and tracking of changes Colliders. + + + + + Decides whether the Workflow in the Physics Debug window should be inclusive + (<a href="PhysicsVisualizationSettings.FilterWorkflow.ShowSelectedItems.html">ShowSelectedItems<a>) or exclusive (<a href="PhysicsVisualizationSettings.FilterWorkflow.HideSelectedItems.html">HideSelectedItems<a>). + + + + + With HideSelectedItems you can hide selected filter items in order to easily discard uninteresting Collider properties thereby making overview and navigation easier. + + + + + With ShowSelectedItems and the Select None button is it easy to monitor very specific Colliders. + + + + + Should BoxColliders be shown. + + + + + + Should CapsuleColliders be shown. + + + + + + Should the given layer for the given filterWorkflow be considered by the display filter. + + + + + + + Should the mask representing the layers for the given filterWorkflow be considered by the display filter. + + + + + + Should the kinematic Rigidbodies for the given filterWorkflow be considered by the display filter. + + + + + + Should MeshColliders be shown. + + + + + + + Should any Rigidbodies for the given filterWorkflow be considered by the display filter. + + + + + + Should the sleeping Rigidbodies for the given filterWorkflow be considered by the display filter. + + + + + + Should SphereColliders be shown. + + + + + + Should the Colliders without a Rigidbody component be considered by the display filter for the given filterWorkflow. + + + + + + Should TerrainColliders be shown. + + + + + + Should the triggers for the given filterWorkflow be considered by the display filter. + + + + + + Returns true if there currently is any kind of physics object highlighted. + + + + + Initializes the physics debug visualization system. The system must be initialized for any physics objects to be visualized. It is normally initialized by the PhysicsDebugWindow. + + + + + Is a MeshCollider convex. + + + + + Corresponds to MeshCollider.convex is true. + + + + + Corresponds to MeshCollider.convex is false. + + + + + Resets the visualization options to their default state. + + + + + Should BoxColliders be shown. + + + + + + + Should CapsuleColliders be shown. + + + + + + + Should the given layer for the given filterWorkflow be considered by the display filter. + + + + + + + + Should the mask representing the layers for the given filterWorkflow be considered by the display filter. + + + + + + + Enables or disables all filtering items for the current filterWorkflow. + + + + + + + Should the kinematic Rigidbodies for the given filterWorkflow be considered by the display filter. + + + + + + + Should MeshColliders be shown. + + + + + + + + Should any Rigidbodies for the given filterWorkflow be considered by the display filter. + + + + + + + Should the sleeping Rigidbodies for the given filterWorkflow be considered by the display filter. + + + + + + + Should SphereColliders be shown. + + + + + + + Should the Colliders without a Rigidbody component be considered by the display filter for the given filterWorkflow. + + + + + + + Should TerrainColliders be shown. + + + + + + + Should the triggers for the given filterWorkflow be considered by the display filter. + + + + + + + Updates the mouse-over highlight at the given mouse position in screen space. + + + + + + Where is the tool handle placed. + + + + + The tool handle is at the graphical center of the selection. + + + + + The tool handle is on the pivot point of the active object. + + + + + How is the tool handle oriented. + + + + + The tool handle is aligned along the global axes. + + + + + The tool handle is oriented from the active object. + + + + + Icon slot container. + + + + + The height of the icon in pixels. + + + + + The PlatformIconKind is specific to the target platform. + + + + + The number of texture layers the icon slot currently contains. + + + + + The maximum number of texture layers required by the icon slot. + + + + + The minimum number of texture layers required by the icon slot. + + + + + The width of the icon in pixels. + + + + + Retrieve the texture which is currently assigned to the specified layer. + + Cannot be larger than PlatformIcon.maxLayerCount. + + + + Retrieve an array of all textures which are currently assigned to the icon slot. + + + + + Assign a texture to the specified layer. + + Cannot be larger than PlatformIcon.maxLayerCount. + + + + + Assign all available icon layers. + + Must be an array of size PlatformIcon.maxLayerCount. + + + + Icon kind wrapper. + + + + + Editor utility functions for the Playable graph and its nodes. + + + + + Event triggered whenever a PlayableGraph is being destroyed. + + + + + + Event triggered whenever a new PlayableGraph is created. + + + + + + Returns all existing PlayableGraphs. + + + + + Player Settings is where you define various parameters for the final game that you will build in Unity. Some of these values are used in the Resolution Dialog that launches when you open a standalone game. + + + + + Accelerometer update frequency. + + + + + Sets the crash behavior on .NET unhandled exception. + + + + + Is the advanced version being used? + + + + + Is auto-rotation to landscape left supported? + + + + + Is auto-rotation to landscape right supported? + + + + + Is auto-rotation to portrait supported? + + + + + Is auto-rotation to portrait upside-down supported? + + + + + If enabled, allows the user to switch between full screen and windowed mode using OS specific keyboard short cuts. + + + + + Allow 'unsafe' C# code code to be compiled for predefined assemblies. + + + + + Additional AOT compilation options. Shared by AOT platforms. + + + + + Deprecated. Use PlayerSettings.GetApiCompatibilityLevel and PlayerSettings.SetApiCompatibilityLevel instead. + + + + + The application identifier for the currently selected build target. + + + + + Pre bake collision meshes on player build. + + + + + Application bundle version shared between iOS & Android platforms. + + + + + Defines if fullscreen games should darken secondary displays. + + + + + A unique cloud project identifier. It is unique for every project (Read Only). + + + + + Set the rendering color space for the current project. + + + + + The name of your company. + + + + + Default cursor's click position in pixels from the top left corner of the cursor image. + + + + + Define how to handle fullscreen mode in Windows standalones (Direct3D 11 mode). + + + + + Define how to handle fullscreen mode in Windows standalones (Direct3D 9 mode). + + + + + The default cursor for your application. + + + + + Default screen orientation for mobiles. + + + + + If enabled, the game will default to fullscreen mode. + + + + + Default vertical dimension of stand-alone player window. + + + + + Default horizontal dimension of stand-alone player window. + + + + + Default vertical dimension of web player window. + + + + + Default horizontal dimension of web player window. + + + + + Defines the behaviour of the Resolution Dialog on product launch. + + + + + Enable 360 Stereo Capture support on the current build target. + + + + + Enables CrashReport API. + + + + + Enable frame timing statistics. + + + + + Enables internal profiler. + + + + + Enables Metal API validation in the Editor. + + + + + First level to have access to all Resources.Load assets in Streamed Web Players. + + + + + Restrict standalone players to a single concurrent running instance. + + + + + Platform agnostic setting to define fullscreen behavior. Not all platforms support all modes. + + + + + Enable GPU skinning on capable platforms. + + + + + Selects the graphics job mode to use on platforms that support both Native and Legacy graphics jobs. + + + + + Enable graphics jobs (multi threaded rendering). + + + + + The bundle identifier of the iPhone application. + + + + + Password for the key used for signing an Android application. + + + + + Password used for interacting with the Android Keystore. + + + + + Defines whether the BlendShape weight range in SkinnedMeshRenderers is clamped. + + + + + Describes the reason for access to the user's location data. + + + + + Are ObjC uncaught exceptions logged? + + + + + Define how to handle fullscreen mode in macOS standalones. + + + + + Enable Retina support for macOS. + + + + + Stops or allows audio from other applications to play in the background while your Unity application is running. + + + + + When enabled, preserves the alpha value in the framebuffer to support rendering over native UI on Android. + + + + + The name of your product. + + + + + Protect graphics memory. + + + + + Which rendering path is enabled? + + + + + Use resizable window in standalone player builds. + + + + + The image to display in the Resolution Dialog window. + + + + + If enabled, your game will continue to run after lost focus. + + + + + The scripting runtime version setting. Change this to set the version the Editor uses and restart the Editor to apply the change. + + + + + Should the builtin Unity splash screen be shown? + + + + + Should Unity support single-pass stereo rendering? + + + + + The style to use for the builtin Unity splash screen. + + + + + Returns if status bar should be hidden. Supported on iOS only; on Android, the status bar is always hidden. + + + + + Active stereo rendering path + + + + + Should player render in stereoscopic 3d on supported hardware? + + + + + Remove unused Engine code from your build (IL2CPP-only). + + + + + Deprecated. Use PlayerSettings.GetManagedStrippingLevel and PlayerSettings.SetManagedStrippingLevel instead. + + + + + Should unused Mesh components be excluded from game build? + + + + + 32-bit Display Buffer is used. + + + + + Let the OS autorotate the screen as the device orientation changes. + + + + + Should Direct3D 11 be used when available? + + + + + Switch display to HDR mode (if available). + + + + + Enable receipt validation for the Mac App Store. + + + + + Write a log file with debugging information. + + + + + Virtual Reality specific splash screen. + + + + + Enable Virtual Reality support on the current build target. + + + + + On Windows, show the application in the background if Fullscreen Windowed mode is used. + + + + + Enables Graphics.SetSRGBWrite() on Vulkan renderer. + + + + + Use software command buffers for building rendering commands on Vulkan. + + + + + Xbox 360 Avatars. + + + + + Android specific player settings. + + + + + Publish the build as a game rather than a regular application. This option affects devices running Android 5.0 Lollipop and later + + + + + Provide a build that is Android TV compatible. + + + + + Choose how content is drawn to the screen. + + + + + Create a separate APK for each CPU architecture. + + + + + Android bundle version code. + + + + + Disable Depth and Stencil Buffers. + + + + + Force internet permission flag. + + + + + Force SD card permission. + + + + + Android key alias name. + + + + + Android key alias password. + + + + + Android keystore name. + + + + + Android keystore password. + + + + + License verification flag. + + + + + Maximum aspect ratio which is supported by the application. + + + + + The minimum API level required for your application to run. + + + + + Preferred application install location. + + + + + Extends rendering layout into display cutout area, utilizing all of the available screen space. + + + + + Application should show ActivityIndicator when loading. + + + + + Android splash screen scale mode. + + + + + Start in fullscreen mode. + + + + + A set of CPU architectures for the Android build target. + + + + + Android target device. + + + + + The target API level of your application. + + + + + 24-bit Depth Buffer is used. + + + + + Use APK Expansion Files. + + + + + Enable support for Google ARCore on supported devices. + + + + + Facebook specific Player settings. + + + + + Facebook application identifier to use for this project. + + + + + Version of Facebook SDK to use for this project. + + + + + Sets a cookie which your server-side code can use to validate a user's Facebook session. + + + + + Use frictionless app requests, as described in their own documentation. + + + + + If 'true', attempts to initialize the Facebook object with valid session data. + + + + + IL2CPP build arguments. + + + + + Gets .NET API compatibility level for specified BuildTargetGroup. + + + + + + Get the application identifier for the specified platform. + + + + + + Gets the BuildTargetPlatformGroup architecture. + + + + + + Returns a list of the available Virtual Reality SDKs that are supported on a given BuildTargetGroup. + + The BuildTargetGroup to return the list for. + + List of available Virtual Reality SDKs. + + + + + Returns the default ScriptingImplementation used for the given platform group. + + The platform group to retrieve the scripting backend for. + + A ScriptingImplementation object that describes the default scripting backend used on that platform. + + + + + Get graphics APIs to be used on a build platform. + + Platform to get APIs for. + + Array of graphics APIs. + + + + + Returns the list of assigned icons for the specified platform. + + + + + + + Returns the list of assigned icons for the specified platform. + + + + + + + Returns a list of icon sizes for the specified platform. + + + + + + + Returns a list of icon sizes for the specified platform. + + + + + + + Gets compiler configuration used when compiling generated C++ code for a particular BuildTargetGroup. + + Build target group. + + Compiler configuration. + + + + + Does IL2CPP platform use incremental build? + + + + + + Returns the ManagedStrippingLevel used for the given platform group. + + The target platform group whose code stripping level you want to retrieve. + + The managed code stripping level set for the specified build target platform group. + + + + + Check if multithreaded rendering option for mobile platform is enabled. + + Mobile platform (Only iOS, tvOS and Android). + + Return true if multithreaded rendering option for targetGroup platform is enabled. + + + + + Returns the list of available icon slots for the specified platform and PlatformIconKind|kind. + + The full list of platforms that support this API and the supported icon kinds can be found in PlatformIconKind|icon kinds. + Each platform supports a different set of PlatformIconKind|icon kinds. These can be found in the specific platform namespace (for example iOSPlatformIconKind. + + + + Gets the current value of the Vuforia AR checkbox in the Player Settings for the specified buildTargetGroup. + + The BuildTargetGroup you wish to get the value for. + + True if Vuforia AR is enabled, false otherwise. + + + + + Returns the assets that will be loaded at start up in the player and be kept alive until the player terminates. + + + The assets to be preloaded. + + + + + Returns a PlayerSettings named bool property (with an optional build target it should apply to). + + Name of the property. + BuildTarget for which the property should apply (use default value BuildTargetGroup.Unknown to apply to all targets). + + The current value of the property. + + + + + Returns a PlayerSettings named int property (with an optional build target it should apply to). + + Name of the property. + BuildTarget for which the property should apply (use default value BuildTargetGroup.Unknown to apply to all targets). + + The current value of the property. + + + + + Searches for property and assigns it's value to given variable. + + Name of the property. + Variable, to which to store the value of the property, if set. + An optional build target group, to which the property applies. + + True if property was set and it's value assigned to given variable. + + + + + Searches for property and assigns it's value to given variable. + + Name of the property. + Variable, to which to store the value of the property, if set. + An optional build target group, to which the property applies. + + True if property was set and it's value assigned to given variable. + + + + + Searches for property and assigns it's value to given variable. + + Name of the property. + Variable, to which to store the value of the property, if set. + An optional build target group, to which the property applies. + + True if property was set and it's value assigned to given variable. + + + + + Returns a PlayerSettings named string property (with an optional build target it should apply to). + + Name of the property. + BuildTarget for which the property should apply (use default value BuildTargetGroup.Unknown to apply to all targets). + + The current value of the property. + + + + + Gets the scripting framework for a BuildTargetPlatformGroup. + + + + + + Get user-specified symbols for script compilation for the given build target group. + + + + + + Get stack trace logging options. + + + + + + Retrieve all icon kinds supported by the specified platform. + + + + + + Is a build platform using automatic graphics API choice? + + Platform to get the flag for. + + Should best available graphics API be used. + + + + + Get the List of Virtual Reality SDKs for a given BuildTargetGroup. + + The BuildTargetGroup to return the SDK list for. + + Ordered list of Virtual Reality SDKs. + + + + + Returns whether or not Virtual Reality Support is enabled for a given BuildTargetGroup. + + The BuildTargetGroup to return the value for. + + True if Virtual Reality Support is enabled. + + + + + Returns true if Holographic Remoting is enabled. + + + + + Returns whether or not the specified aspect ratio is enabled. + + + + + + iOS specific player settings. + + + + + Should insecure HTTP downloads be allowed? + + + + + Application behavior when entering background. + + + + + Set this property with your Apple Developer Team ID. You can find this on the Apple Developer website under <a href="https:developer.apple.comaccount#membership"> Account > Membership </a> . This sets the Team ID for the generated Xcode project, allowing developers to use the Build and Run functionality. An Apple Developer Team ID must be set here for automatic signing of your app. + + + + + Set this property to true for Xcode to attempt to automatically sign your app based on your appleDeveloperTeamID. + + + + + iOS application display name. + + + + + Supported background execution modes (when appInBackgroundBehavior is set to iOSAppInBackgroundBehavior.Custom). + + + + + The build number of the bundle + + + + + Describes the reason for access to the user's camera. + + + + + Defer system gestures until the second swipe on specific edges. + + + + + Defer system gestures until the second swipe on specific edges. + + + + + Disable Depth and Stencil Buffers. + + + + + Application should exit when suspended to background. + + + + + Should hard shadows be enforced when running on (mobile) Metal. + + + + + Specifies whether the home button should be hidden in the iOS build of this application. + + + + + A provisioning profile Universally Unique Identifier (UUID) that Xcode will use to build your iOS app in Manual Signing mode. + + + + + A ProvisioningProfileType that will be set when building an iOS Xcode project. + + + + + Describes the reason for access to the user's location data. + + + + + Describes the reason for access to the user's microphone. + + + + + Determines iPod playing behavior. + + + + + Icon is prerendered. + + + + + RequiresFullScreen maps to Apple's plist build setting UIRequiresFullScreen, which is used to opt out of being eligible to participate in Slide Over and Split View for iOS 9.0 multitasking. + + + + + Application requires persistent WiFi. + + + + + Script calling optimization. + + + + + Active iOS SDK version used for build. + + + + + Application should show ActivityIndicator when loading. + + + + + Status bar style. + + + + + Targeted device. + + + + + Deployment minimal version of iOS. + + + + + Deployment minimal version of iOS. + + + + + A provisioning profile Universally Unique Identifier (UUID) that Xcode will use to build your tvOS app in Manual Signing mode. + + + + + A ProvisioningProfileType that will be set when building a tvOS Xcode project. + + + + + Indicates whether application will use On Demand Resources (ODR) API. + + + + + Sets the mode which will be used to generate the app's launch screen Interface Builder (.xib) file for iPad. + + + + + + Sets the mode which will be used to generate the app's launch screen Interface Builder (.xib) file for iPhone. + + + + + + Sets the image to display on screen when the game launches for the specified iOS device. + + + + + + + Is multi-threaded rendering enabled? + + + + + PS4 application category. + + + + + Application. + + + + + PS4 enter button assignment. + + + + + Circle button. + + + + + Cross button. + + + + + Remote Play key assignment. + + + + + No Remote play key assignment. + + + + + Remote Play key layout configuration A. + + + + + Remote Play key layout configuration B. + + + + + Remote Play key layout configuration C. + + + + + Remote Play key layout configuration D. + + + + + Remote Play key layout configuration E. + + + + + Remote Play key layout configuration F. + + + + + Remote Play key layout configuration G. + + + + + Remote Play key layout configuration H. + + + + + IL2CPP build arguments. + + + + + + Sets .NET API compatibility level for specified BuildTargetGroup. + + + + + + + Set the application identifier for the specified platform. + + + + + + + Sets the BuildTargetPlatformGroup architecture. + + + + + + + Enables the specified aspect ratio. + + + + + + + Sets the graphics APIs used on a build platform. + + Platform to set APIs for. + Array of graphics APIs. + + + + Assign a list of icons for the specified platform. + + + + + + + + Assign a list of icons for the specified platform. + + + + + + + + Sets compiler configuration used when compiling generated C++ code for a particular BuildTargetGroup. + + Build target group. + Compiler configuration. + + + + Sets incremental build flag. + + + + + + + Sets the managed code stripping level for specified BuildTargetGroup. + + The platform build target group whose stripping level you want to set. + The desired managed code stripping level. + + + + + + Enable or disable multithreaded rendering option for mobile platform. + + Mobile platform (Only iOS, tvOS and Android). + + + + + Assign a list of icons for the specified platform and icon kind. + + Each platform supports a different set of PlatformIconKind|icon kinds. These can be found in the specific platform namespace (for example iOSPlatformIconKind). + The full list of platforms that support this API the supported kinds can be found in PlatformIconKind|icon kinds. + All available PlatformIcon slots must be retrieved with GetPlatformIcons. + + + + + Sets the value of the Vuforia AR checkbox in the Player Settings for the specified buildTargetGroup. + + The BuildTargetGroup you wish to set the value for. + True to enable Vuforia AR, false otherwise. + + + + Assigns the assets that will be loaded at start up in the player and be kept alive until the player terminates. + + + + + + Sets a PlayerSettings named bool property. + + Name of the property. + Value of the property (bool). + BuildTarget for which the property should apply (use default value BuildTargetGroup.Unknown to apply to all targets). + + + + Sets a PlayerSettings named int property. + + Name of the property. + Value of the property (int). + BuildTarget for which the property should apply (use default value BuildTargetGroup.Unknown to apply to all targets). + + + + Sets a PlayerSettings named string property. + + Name of the property. + Value of the property (string). + BuildTarget for which the property should apply (use default value BuildTargetGroup.Unknown to apply to all targets). + + + + Sets the scripting framework for a BuildTargetPlatformGroup. + + + + + + + Set user-specified symbols for script compilation for the given build target group. + + The name of the group of devices. + Symbols for this group separated by semicolons. + + + + Set stack trace logging options. +Note: calling this function will implicitly call Application.SetStackTraceLogType. + + + + + + + Should a build platform use automatic graphics API choice. + + Platform to set the flag for. + Should best available graphics API be used? + + + + Set the List of Virtual Reality SDKs for a given BuildTargetGroup. + + The BuildTargetGroup to set the SDK list for. + List of Virtual Reality SDKs. + + + + Sets whether or not Virtual Reality Support is enabled for a given BuildTargetGroup. + + The BuildTargetGroup to set the value for. + The value to set, true to enable, false to disable. + + + + Enables Holographic Remoting. + + + + + Interface to splash screen player settings. + + + + + The target zoom (from 0 to 1) for the background when it reaches the end of the SplashScreen animation's total duration. Only used when animationMode is PlayerSettings.SplashScreen.AnimationMode.Custom|AnimationMode.Custom. + + + + + The target zoom (from 0 to 1) for the logo when it reaches the end of the logo animation's total duration. Only used when animationMode is PlayerSettings.SplashScreen.AnimationMode.Custom|AnimationMode.Custom. + + + + + The type of animation applied during the splash screen. + + + + + The background Sprite that is shown in landscape mode. Also shown in portrait mode if backgroundPortrait is null. + + + + + The background color shown if no background Sprite is assigned. Default is a dark blue RGB(34.44,54). + + + + + The background Sprite that is shown in portrait mode. + + + + + Determines how the Unity logo should be drawn, if it is enabled. If no Unity logo exists in [logos] then the draw mode defaults to PlayerSettings.SplashScreen.DrawMode.UnityLogoBelow|DrawMode.UnityLogoBelow. + + + + + The collection of logos that is shown during the splash screen. Logos are drawn in ascending order, starting from index 0, followed by 1, etc etc. + + + + + In order to increase contrast between the background and the logos, an overlay color modifier is applied. The overlay opacity is the strength of this effect. Note: Reducing the value below 0.5 requires a Plus/Pro license. + + + + + Set this to true to display the Splash Screen be shown when the application is launched. Set it to false to disable the Splash Screen. Note: Disabling the Splash Screen requires a Plus/Pro license. + + + + + Set this to true to show the Unity logo during the Splash Screen. Set it to false to disable the Unity logo. Note: Disabling the Unity logo requires a Plus/Pro license. + + + + + The style to use for the Unity logo during the Splash Screen. + + + + + The type of animation applied during the Splash Screen. + + + + + Animates the Splash Screen using custom values from PlayerSettings.SplashScreen.animationBackgroundZoom and PlayerSettings.SplashScreen.animationLogoZoom. + + + + + Animates the Splash Screen with a simulated dolly effect. + + + + + No animation is applied to the Splash Screen logo or background. + + + + + Determines how the Unity logo should be drawn, if it is enabled. + + + + + The Unity logo is shown sequentially providing it exists in the PlayerSettings.SplashScreen.logos collection. + + + + + The Unity logo is drawn in the lower portion of the screen for the duration of the Splash Screen, while the PlayerSettings.SplashScreen.logos are shown in the centre. + + + + + The style to use for the Unity logo during the Splash Screen. + + + + + A dark Unity logo with a light background. + + + + + A white Unity logo with a dark background. + + + + + A single logo that is shown during the Splash Screen. Controls the Sprite that is displayed and its duration. + + + + + The total time in seconds for which the logo is shown. The minimum duration is 2 seconds. + + + + + The Sprite that is shown during this logo. If this is null, then no logo will be displayed for the duration. + + + + + The Unity logo Sprite. + + + + + Creates a new Splash Screen logo with the provided duration and logo Sprite. + + The total time in seconds that the logo will be shown. Note minimum time is 2 seconds. + The logo Sprite to display. + + The new logo. + + + + + Creates a new Splash Screen logo with the provided duration and the unity logo. + + The total time in seconds that the logo will be shown. Note minimum time is 2 seconds. + + The new logo. + + + + + tvOS specific player settings. + + + + + The build number of the bundle + + + + + Application requires extended game controller. + + + + + Active tvOS SDK version used for build. + + + + + Deployment minimal version of tvOS. + + + + + Deployment minimal version of tvOS. + + + + + Google Cardboard-specific Player Settings. + + + + + Set the requested depth format for the Depth and Stencil Buffers. Options are 16bit Depth, 24bit Depth and 24bit Depth + 8bit Stencil. + + + + + Google VR-specific Player Settings. + + + + + Foreground image for the Daydream Launcher Home Screen. + + + + + Background image for the Daydream Launcher Home Screen. + + + + + Set the requested depth format for the Depth and Stencil Buffers. Options are 16bit Depth, 24bit Depth and 24bit Depth + 8bit Stencil. + + + + + Enable Google VR Asynchronous Video Re-Projection when running in Daydream. + +NOTE: Only takes effect if set before initializing VR. + + + + + Enable Protected Memory support when running with Google VR Asynchronous Video Re-Projection (AVR). + +Protected memory support is currently an all or nothing feature. When enabled only DRM protected content can be played using AVR. Clear content will fail to play. + +NOTE: Only takes effect if set before initializing VR. + + + + + Set the highest level of head tracking required to run your application. + +Set this property to limit your application to only run on devices that support this maximum level of head tracking. On devices that support higher levels of head tracking, your application is limited to using the maximum level. + + + + + Set the lowest level of head tracking required to run your application. + +Set this property to limit your application to only run on devices that support this minimum level of head tracking. + + + + + Class used to access properties of the Oculus VR device. + + + + + Enable Oculus Dash support for the application. + + + + + Enable Low Overhead driver optimizations for Oculus. + + + + + Enable protected graphics context for Oculus. + + + + + Enable Shared Depth Buffer support with Oculus. + + + + + Enable application signing with the Android Package (APK) Signature Scheme v2. + + + + + WebGL specific player settings. + + + + + CompressionFormat defines the compression type that the WebGL resources are encoded to. + + + + + Enables automatic caching of unityweb files. + + + + + Enables generation of debug symbols file in the build output directory. + + + + + Exception support for WebGL builds. + + + + + Allows you to specify the WebGLLinkerTarget|web build format that is used when you build your project. + + + + + Memory size for WebGL builds in Megabyte. + + + + + Enables using MD5 hash of the uncompressed file contents as a filename for each file in the build. + + + + + Path to the WebGL template asset. + + + + + Windows Store Apps specific player settings. + + + + + Specify how to compile C# files when building to Windows Store Apps. + + + + + Enable/Disable independent input source feature. + + + + + Enable/Disable low latency presentation API. + + + + + Where Unity gets input from. + + + + + Sets AlphaMode on the swap chain to DXGI_ALPHA_MODE_PREMULTIPLIED. + + + + + Windows Store Apps declarations. + + + + + Set information for file type associations. + +For more information - https:msdn.microsoft.comlibrarywindowsappshh779671https:msdn.microsoft.comlibrarywindowsappshh779671. + + + + + + Registers this application to be a default handler for specified URI scheme name. + + For example: if you specify myunitygame, your application can be run from other applications via the URI scheme myunitygame:. You can also test this using the Windows "Run" dialog box (invoked with Windows + R key). + + For more information https:msdn.microsoft.comlibrarywindowsappshh779670https:msdn.microsoft.comlibrarywindowsappshh779670. + + + + + Get path for image, that will be populated to the Visual Studio solution and the package manifest. + + + + + + + Set path for image, that will be populated to the Visual Studio solution and the package manifest. + + + + + + + + Compilation overrides for C# files. + + + + + C# files are compiled using Mono compiler. + + + + + C# files are compiled using Microsoft compiler and .NET Core, you can use Windows Runtime API, but classes implemented in C# files aren't accessible from JS or Boo languages. + + + + + C# files not located in Plugins, Standard Assets, Pro Standard Assets folders are compiled using Microsoft compiler and .NET Core, all other C# files are compiled using Mono compiler. The advantage is that classes implemented in C# are accessible from JS and Boo languages. + + + + + Describes File Type Association declaration. + + + + + Localizable string that will be displayed to the user as associated file handler. + + + + + Supported file types for this association. + + + + + Various image scales, supported by Windows Store Apps. + + + + + Image types, supported by Windows Store Apps. + + + + + Where Unity takes input from (subscripbes to events). + + + + + Subscribe to CoreWindow events. + + + + + Create Independent Input Source and receive input from it. + + + + + Subscribe to SwapChainPanel events. + + + + + Describes supported file type for File Type Association declaration. + + + + + The 'Content Type' value for the file type's MIME content type. For example: 'image/jpeg'. Can also be left blank. + + + + + File type extension. For ex., .myUnityGame + + + + + Enumeration specifying a change in the Editor's play mode state. + +See Also: PauseState, EditorApplication.playModeStateChanged, EditorApplication.isPlaying. + + + + + Occurs during the next update of the Editor application if it is in edit mode and was previously in play mode. + + + + + Occurs during the next update of the Editor application if it is in play mode and was previously in edit mode. + + + + + Occurs when exiting edit mode, before the Editor is in play mode. + + + + + Occurs when exiting play mode, before the Editor is in edit mode. + + + + + Represents plugin importer. + + + + + Is plugin native or managed? Note: C++ libraries with CLR support are treated as native plugins, because Unity cannot load such libraries. You can still access them via P/Invoke. + + + + + Clear all plugin settings and set the compatability with Any Platform to true. + + + + + Constructor. + + + + + Allows you to specify a list of #define directives which controls whether your plug-in should be included. + + + + + Returns all plugin importers for all platforms. + + + + + Checks whether a plugin is flagged as being compatible with Any Platform. + + + True if the plugin is flagged as being compatible with Any Platform, otherwise returns false. + + + + + Is plugin compatible with editor. + + + + + Is plugin compatible with specified platform. + + Target platform. + + + + + Is plugin compatible with specified platform. + + Target platform. + + + + + Returns editor specific data for specified key. + + Key value for data. + + + + Is Editor excluded when Any Platform is set to true. + + + + + Is platform excluded when Any Platform set to true. + + Target platform. + + + + + Is platform excluded when Any Platform set to true. + + Target platform. + + + + + Returns all plugin importers for specfied platform. + + Target platform. + Name of the target platform. + + + + Returns all plugin importers for specfied platform. + + Target platform. + Name of the target platform. + + + + Identifies whether or not this plugin will be overridden if a plugin of the same name is placed in your project folder. + + + + + Get platform specific data. + + Target platform. + Key value for data. + + + + + Get platform specific data. + + Target platform. + Key value for data. + + + + + Delegate to be used with SetIncludeInBuildDelegate. + + + + + + Sets compatibility with Any Platform. + + Determines whether the plugin is compatible with Any Platform. + + + + Sets compatibility with any editor. + + Is plugin compatible with editor. + + + + Sets compatibility with the specified platform. + + Target platform. + Is plugin compatible with specified platform. + Target platform. + + + + Sets compatibility with the specified platform. + + Target platform. + Is plugin compatible with specified platform. + Target platform. + + + + Sets editor specific data. + + Key value for data. + Data. + + + + Exclude Editor from compatible platforms when Any Platform is set to true. + + + + + + Exclude platform from compatible platforms when Any Platform is set to true. + + Target platform. + + + + + + Exclude platform from compatible platforms when Any Platform is set to true. + + Target platform. + + + + + + Setting the delegate function to be called by ShouldIncludeInBuild. + + + + + + Sets platform specific data. + + Target platform. + Key value for data. + Data. + + + + + Sets platform specific data. + + Target platform. + Key value for data. + Data. + + + + + Identifies whether or not this plugin should be included in the current build target. + + + + + See ScriptableObject.OnEnable. + + + + + Show a popup with the given PopupWindowContent. + + The rect of the button that opens the popup. + The content to show in the popup window. + + + + Class used to implement content for a popup window. + + + + + The EditorWindow that contains the popup content. + + + + + The size of the popup window. + + + The size of the Popup window. + + + + + Callback when the popup window is closed. + + + + + Callback for drawing GUI controls for the popup window. + + The rectangle to draw the GUI inside. + + + + Callback when the popup window is opened. + + + + + Enum indicating the type of Prefab Asset, such as Regular, Model and Variant. + + + + + The object being queried is part of a Prefab instance, but because the asset it missing the actual type of Prefab can’t be determined. + + + + + The object being queried is part of a Model Prefab. + + + + + The object being queried is not part of a Prefab at all. + + + + + The object being queried is part of a regular Prefab. + + + + + The object being queried is part of a Prefab Variant. + + + + + Enum with status about whether a Prefab instance is properly connected to its asset. + + + + + The Prefab instance is connected to its Prefab Asset. + + + + + The Prefab instance is not connected to its Prefab Asset. + + + + + The Prefab instance is missing its Prefab Asset. + + + + + The object is not part of a Prefab instance. + + + + + The type of a Prefab object as returned by PrefabUtility.GetPrefabType. + + + + + The object is an instance of an imported 3D model, but the connection is broken. + + + + + The object is an instance of a user created Prefab, but the connection is broken. + + + + + The object was an instance of a Prefab, but the original Prefab could not be found. + + + + + The object is an imported 3D model asset. + + + + + The object is an instance of an imported 3D model. + + + + + The object is not a Prefab nor an instance of a Prefab. + + + + + The object is a user created Prefab asset. + + + + + The object is an instance of a user created Prefab. + + + + + Enum used to determine how a Prefab should be unpacked. + + + + + Use this to strip away all Prefab information from a Prefab instance. + + + + + Use this mode to only unpack the outermost layer of a Prefab. + + + + + Utility class for any Prefab related operations. + + + + + Called after Prefab instances in the Scene have been updated. + + + + + Applies the added component to the Prefab Asset at the given asset path. + + The interaction mode for this action. + The path of the Prefab Asset to apply to. + The added component on the Prefab instance to apply. + + + + Applies the added GameObject to the Prefab Asset at the given asset path. + + The added GameObject on the Prefab instance to apply. + The path of the Prefab Asset to apply to. + The interaction mode for this action. + + + + Applies all overridden properties on a Prefab instance component or GameObject to the Prefab Asset at the given asset path. + + The object on the Prefab instance to apply. + The path of the Prefab Asset to apply to. + The interaction mode for this action. + + + + Applies all overrides on a Prefab instance to its Prefab Asset. + + The root of the given Prefab instance. + The interaction mode for this action. + + + + Applies a single overridden property on a Prefab instance to the Prefab Asset at the given asset path. + + The SerializedProperty representing the property to apply. + The path of the Prefab Asset to apply to. + The interaction mode for this action. + + + + Removes the component from the Prefab Asset which has the component on it. + + The GameObject on the Prefab instance which the component has been removed from. + The component on the Prefab Asset corresponding to the removed component on the instance. + The interaction mode for this action. + + + + Connects the source Prefab to the game object. + + The disconnected GameObject that you want to reconnect. + The source Prefab to connect to the GameObject. + + + + Creates an empty Prefab at given path. + + The asset path to use for the new empty Prefab. + + A reference to the new Prefab Asset. + + + + + Creates a Prefab from a game object hierarchy. + + The path where the Prefab is saved. + The GameObject that you want to create a Prefab from. + + + A reference to the created Prefab. + + + + + Creates a Prefab from a game object hierarchy. + + The path where the Prefab is saved. + The GameObject that you want to create a Prefab from. + + + A reference to the created Prefab. + + + + + Deprecated. As of 2018.3 this method does nothing. + + + + + + Returns the root GameObject of the Prefab that the supplied GameObject is part of. + + The object to check. + + The Prefab root. + + + + + Returns the topmost GameObject that has the same Prefab parent as target. + + The GameObject to use in the search. + + The GameObject at the root of the Prefab. + + + + + Returns the root GameObject of the Prefab instance if that root Prefab instance is a parent of the Prefab. + + GameObject to process. + + Return the root game object of the Prefab Asset. + + + + + Returns a list of PrefabUtility.AddedComponent objects which contain information about added component overrides on the Prefab instance. + + The Prefab instance to get information about. + + List of objects with information about added components. + + + + + Returns a list of PrefabUtility.AddedGameObject objects which contain information about added GameObjects on the Prefab instance. + + The Prefab instance to get information about. + + List of objects with information about added GameObjects. + + + + + Returns the object of origin for the given object. + + The object to find the corresponding original object from. + + The corresponding object from the original source or null. + + + + + Returns the corresponding asset object of source, or null if it can't be found. + + The object to find the corresponding object from. + + The corresponding object or null. + + + + + Returns the corresponding object of the given object from a given Prefab Asset path. + + The object to find the corresponding object from. + The asset path of the Prefab Asset to get the corresponding object from. + + The corresponding object or null. + + + + + Returns the icon for the given GameObject. + + The GameObject to get an icon for. + + The icon for the GameObject. + + + + + Return the GameObject that is the root of the nearest Prefab instance the object is part of. + + The object to check. Must be a component or GameObject. + + The nearest Prefab instance root. + + + + + Returns a list of objects with information about object overrides on the Prefab instance. + + The Prefab instance to get information about. + If true, components will also be included even if they only contain overrides that are PrefabUtility.IsDefaultOverride|default overrides. False by default. + + List of objects with information about object overrides. + + + + + Returns the GameObject that is the root of the outermost Prefab instance the object is part of. + + The object to check. Must be a component or GameObject. + + The outermost Prefab instance root. + + + + + Returns the asset path of the nearest Prefab instance root the specified object is part of. + + An object in the Prefab instance to get the asset path of. + + The asset path. + + + + + Enum value indicating the type of Prefab Asset, such as Regular Prefab, Model Prefab and Prefab Variant. + + An object that is part of a Prefab Asset or Prefab instance. + + The type of Prefab. + + + + + This function will give you the PrefabInstance object for the outermost Prefab instance the provided object is part of. + + An object from the Prefab instance. + + The Prefab instance handle. + + + + + Enum value with status about whether a Prefab instance is properly connected to its asset. + + An object that is part of a Prefab instance. + + The status of the Prefab instance. + + + + + Retrieves the enclosing Prefab for any object contained within. + + An object contained within a Prefab object. + + The Prefab the object is contained in. + + + + + Returns the parent asset object of source, or null if it can't be found. + + + + + + Given an object, returns its Prefab type (None, if it's not a Prefab). + + + + + + Extract all modifications that are applied to the Prefab instance compared to the parent Prefab. + + + + + + Returns a list of objects with information about removed component overrides on the Prefab instance. + + The Prefab instance to get information about. + + List of objects with information about removed components. + + + + + Returns true if the given Prefab instance has any overrides. + + The root GameObject of the Prefab instance to check. + Set to true to consider default overrides as overrides too. + + Returns true if there are any overrides. + + + + + Instantiate an asset that is referenced by a Prefab and use it on the Prefab instance. + + + + + + Instantiates the given Prefab in a given Scene. + + Prefab Asset to instantiate. + Scene to instantiate the Prefab in. + The parent Transform to be assigned. + + The GameObject at the root of the Prefab. + + + + + Instantiates the given Prefab in a given Scene. + + Prefab Asset to instantiate. + Scene to instantiate the Prefab in. + The parent Transform to be assigned. + + The GameObject at the root of the Prefab. + + + + + Instantiates the given Prefab in a given Scene. + + Prefab Asset to instantiate. + Scene to instantiate the Prefab in. + The parent Transform to be assigned. + + The GameObject at the root of the Prefab. + + + + + Is this component added to a Prefab instance as an override? + + The component to check. + + True if the component is an added component. + + + + + Is this GameObject added as a child to a Prefab instance as an override? + + The GameObject to check. + + True if the GameObject is an added GameObject. + + + + + Is the GameObject the root of any Prefab instance? + + The GameObject to check. + + True if the GameObject is the root GameObject of any Prefab instance. + + + + + Returns true if the given modification is considered a PrefabUtility.IsDefaultOverride|default override. + + The modification for the property in question. + + True if the property is a default override. + + + + + Returns true if the given object is part of an instance where the PrefabInstance object is missing but the given object has a valid corresponding object. + + The object to check. Must be a GameObject or component. + + True if the instance is disconnected. + + + + + Is the GameObject the root of a Prefab instance, excluding nested Prefabs? + + The GameObject to check. + + True if the GameObject is an outermost Prefab instance root. + + + + + Returns true if the given object is part of any kind of Prefab. + + The object to check. Must be a component or GameObject. + + True if the object s part of a Prefab. + + + + + Is this object part of a Prefab that cannot be edited? + + The object to check. Must be a component or GameObject. + + + True if the object is part of a Prefab that cannot be edited. + + + + + Returns true if the given object is part of a Model Prefab Asset or Model Prefab instance. + + The object to check. Must be a component or GameObject. + + True if the given object is part of a Model Prefab. + + + + + Returns true if the given object is part of a Prefab instance and not part of an asset. + + The object to check. Must be a component or GameObject. + + True if the object is part of a Prefab instance that's not inside a Prefab Asset. + + + + + Returns true if the given object is part of a Prefab Asset. + + The object to check. Must be a component or GameObject. + + True is the object is part of a Prefab Asset. + + + + + Returns true if the given object is part of a Prefab instance. + + The object to check. Must be a component or GameObject. + + True if the object is part of a Prefab instance. + + + + + Is this object part of a Prefab that cannot be applied to? + + The object to check. Must be a component or GameObject. + + True if the object is part of a Prefab that cannot be applied to. + + + + + Returns true if the given object is part of a regular Prefab instance or Prefab Asset. + + The object to check. Must be a component or GameObject. + + True if the given object is part of a regular Prefab instance or Prefab Asset. + + + + + Returns true if the given object is part of a Prefab Variant Asset or Prefab Variant instance. + + The object to check. Must be a component or GameObject. + + True if the given object is part of a Prefab Variant. + + + + + Returns true if the given object is part of a Prefab instance but the source asset is missing. + + The object to check. Must be a component or GameObject. + + True if the given object is part of a Prefab instance but the source asset is missing. + + + + + Loads a Prefab Asset at a given path into an isolated Scene and returns the root GameObject of the Prefab. + + The path of the Prefab Asset to load the contents of. + + The root of the loaded contents. + + + + + Loads a Prefab Asset at a given path into a given preview Scene and returns the root GameObject of the Prefab. + + The Scene to load the contents into. + The path of the Prefab Asset to load the contents of. + + + + Force re-merging all Prefab instances of this Prefab. + + + + + + Delegate for method that is called after Prefab instances in the Scene have been updated. + + + + + + Connects the game object to the Prefab that it was last connected to. + + + + + + Causes modifications made to the Prefab instance to be recorded. + + Object to process. + + + + Replaces the targetPrefab with a copy of the game object hierarchy go. + + + + + + + + Replaces the targetPrefab with a copy of the game object hierarchy go. + + + + + + + + Resets the properties of the component or game object to the parent Prefab state. + + + + + + Removes this added component on a Prefab instance. + + The added component on the Prefab instance to revert. + The interaction mode for this action. + + + + Removes this added GameObject from a Prefab instance. + + The interaction mode for this action. + The added GameObject on the Prefab instance to revert. + + + + Reverts all overridden properties on a Prefab instance component or GameObject. + + The interaction mode for this action. + The object on the Prefab instance to revert. + + + + Reverts all overrides on a Prefab instance. + + The root of the Prefab instance. + The interaction mode for this action. + + + + + Reverts all overrides on a Prefab instance. + + The root of the Prefab instance. + The interaction mode for this action. + + + + + Revert a single property override on a Prefab instance. + + The interaction mode for this action. + The SerializedProperty representing the property to revert. + + + + Adds this removed component back on the Prefab instance. + + The removed component on the Prefab instance to revert. + The interaction mode for this action. + The GameObject on the Prefab instance which the component has been removed from. + + + + Use this function to create a Prefab Asset at the given path from the given GameObject, including any childen in the Scene without modifying the input objects. + + The GameObject to save as a Prefab Asset. + The path to save the Prefab at. + The result of the save action, either successful or unsuccessful. Use this together with the console log to get more insight into the save process. + + The root GameObject of the saved Prefab Asset, if available. + + + + + Use this function to create a Prefab Asset at the given path from the given GameObject, including any childen in the Scene without modifying the input objects. + + The GameObject to save as a Prefab Asset. + The path to save the Prefab at. + The result of the save action, either successful or unsuccessful. Use this together with the console log to get more insight into the save process. + + The root GameObject of the saved Prefab Asset, if available. + + + + + Use this function to create a Prefab Asset at the given path from the given GameObject including any childen in the Scene and at the same make the given GameObject into an instance of the new Prefab. + + The GameObject to save as a Prefab and make into a Prefab instance. + The path to save the Prefab at. + The interaction mode to use for this action. + The result of the save action, either successful or unsuccessful. Use this together with the console log to get more insight into the save process. + + The root GameObject of the saved Prefab Asset, if available. + + + + + Use this function to create a Prefab Asset at the given path from the given GameObject including any childen in the Scene and at the same make the given GameObject into an instance of the new Prefab. + + The GameObject to save as a Prefab and make into a Prefab instance. + The path to save the Prefab at. + The interaction mode to use for this action. + The result of the save action, either successful or unsuccessful. Use this together with the console log to get more insight into the save process. + + The root GameObject of the saved Prefab Asset, if available. + + + + + Use this function to save the version of an existing Prefab Asset that exists in memory back to disk. + + Any GameObject that is part of the Prefab Asset to save. + The result of the save action, either successful or unsuccessful. Use this together with the console log to get more insight into the save process. + + The root GameObject of the saved Prefab Asset. + + + + + Use this function to save the version of an existing Prefab Asset that exists in memory back to disk. + + Any GameObject that is part of the Prefab Asset to save. + The result of the save action, either successful or unsuccessful. Use this together with the console log to get more insight into the save process. + + The root GameObject of the saved Prefab Asset. + + + + + Assigns all modifications that are applied to the Prefab instance compared to the parent Prefab. + + + + + + + Releases the content from a Prefab previously loaded with LoadPrefabContents from memory. + + The root of the loaded Prefab contents. + + + + Unpacks a given Prefab instance so that it is replaced with the contents of the Prefab Asset while retaining all override values. + + The root of the Prefab instance to unpack. + Whether to unpack the outermost root or unpack completely. + The interaction mode to use for this action. + + + + This function will unpack the given Prefab instance using the behaviour specified by unpackMode. + + Root GameObject of the Prefab instance. + The unpack mode to use. + + Array of GameObjects representing roots of unpacked Prefab instances. + + + + + (Obsolete: use the SettingsProvider class instead) The PreferenceItem attribute allows you to add preferences sections to the Preferences window. + + + + + Creates a section in the Settings Window called name and invokes the static function following it for the section's GUI. + + + + + + Basic implementation of the PresetSelectorReceiver. + + + + + Applies the Preset to each target. If Preset is null, this method reverts the value of each target. + + + + + + Applies the current selection and then destroys itself. + + + + + + A Preset contains default values for an Object. + + + + + Applies this Preset to the target object. + + The target object that will be updated with the Preset serialized values. + Optional list of property names that are applied to the target. + + Returns true if the target object was successfully updated by the Preset, false otherwise. + + + + + Applies this Preset to the target object. + + The target object that will be updated with the Preset serialized values. + Optional list of property names that are applied to the target. + + Returns true if the target object was successfully updated by the Preset, false otherwise. + + + + + Returns true if this Preset can be applied to the target Object. + + + + + + Constructs a new Preset from a given Object. + + Used by the Preset to know its target type and serialized values. + + + + Determines if the target object has the same serialized values as the Preset. + + The target object to be compared against the Preset. + + Returns true when the target object has the same serialized values as the Preset. Otherwise, returns false. + + + + + Returns the current default Preset assigned to the same Object type. Returns null if there is no matching default. + + + + + + Returns the current default Preset assigned to the same Preset type. Returns null if there is no matching default. + + + + + + Returns a human readable string of this Preset's target fulltype, including namespace. + + + Fullname of the Preset's target type. + + + + + Returns a human readable string of this Preset's target type. + + + Fullname of the Preset's target type. + + + + + Returns true if this Object cannot have a default Preset. + + + + + + Returns true if this Object is not available in the Preset system. + + + + + + Returns true if this Preset cannot be set as the default. + + + + + + Returns true if the Preset type of this Preset is valid. + + + + + Returns a copy of the PropertyModification array owned by this Preset. + + + + + Remove the Preset type from having default values in the project. + + + + + + Sets the Preset as the default for its target type in the project. + + The Preset asset to set as the default. + + Returns true if the Preset is successfully set as the default, or false otherwise. + + + + + Updates this Preset's properties from the given Object's values. The given Object's type must match this Preset's type. + + Used by the Preset to get its new serialized values. + + Returns true if the Preset was updated, false otherwise. + + + + + This class implements a modal window that selects a Preset asset from the Project. + + + + + Draw a Preset button that opens the default PresetSelector using the targets array. + + The Rect where the PresetSelector icon is drawn. + List of objects to which the selected Preset is applied. + + + + Opens a modal window for selecting a Preset. + + List of objects to which the selected Preset is applied. DefaultPresetSelectorReceiver applies the Preset selection. + The selected Preset when the window is opened. Set to 'null' for no selection. + Set to true to show the 'Save current to...' button. Set to false to hide this button. + Object that identifies the type of Preset asset being selected. The modal window filters the selector view based on this object. + The PresetSelectorReceiver instance that the PresetSelector uses to send events. + + + + Opens a modal window for selecting a Preset. + + List of objects to which the selected Preset is applied. DefaultPresetSelectorReceiver applies the Preset selection. + The selected Preset when the window is opened. Set to 'null' for no selection. + Set to true to show the 'Save current to...' button. Set to false to hide this button. + Object that identifies the type of Preset asset being selected. The modal window filters the selector view based on this object. + The PresetSelectorReceiver instance that the PresetSelector uses to send events. + + + + Implement this class to control the selection change when selecting a Preset in the PresetSelector. + + + + + When a new Preset is selected in the modal window, this method is called by PresetSelector. + + This parameter is set to null when 'None' is the new selection in the PresetSelector. + + + + This method is called by the PresetSelector when the modal window is closed. + + + + + + An abstract helper class that provides methods to retrieve arrays of data elements of a generic type. + + + + + Retrieves a subset of entries in an array. + + Index to start indexing the entries. + Number of elements to retrieve. + An array to store the returned data in. + + + + Gets the number of entries in the source array. + + + Number of entries. + + + + + A class that houses data entries related to Connection data, returned by PackedMemorySnapshot.connections. + + + + + An array of indexes into the object array of GC handles referenced by the to property. + + + + + An array of GC handle objects. + + + + + Gets the number of connection entries. + + + The number of entries. + + + + + A class that houses Field Description entry data, returned by PackedMemorySnapshot.fieldDescriptions. + + + + + An array of field names. + + + + + True if this field is static; otherwise false. + + + + + An array of offset values from the start of the class for the fields referenced by the fieldDescriptionName property. + + + + + The typeIndex into PackedMemorySnapshot.typeDescriptions of the type this field belongs to. + + + + + Gets the number of field description entries. + + + The number of entries. + + + + + A class that houses GCHandle data. Returned by PackedMemorySnapshot.gcHandles. + + + + + An array of addresses for the managed objects that the GC handles are referencing. + + + + + Gets the number of GCHandle entries. + + + The number of entries. + + + + + A class that houses MemorySection data, returned by PackedMemorySnapshot.managedHeapSections and PackedMemorySnapshot.managedStacks. + + + + + An array of byte arrays that contain memory dumps. + + + + + An array of addresses of the start location in memory of the memory dumps referenced by the startAddress property. + + + + + Gets the number of managed memory section entries. + + + The number of entries. + + + + + A class that houses native allocation entry data, returned by PackedMemorySnapshot.nativeAllocations. + + + + + An array that contains addresses of native memory allocations. + + + + + The allocation site id of the allocation, used by NativeAllocationSiteEntries.id. + + + + + An array of indexes that indicate which memory region, beginning region, inside region, or end region, that the memory allocation represents. + + + + + An array that specifies, in bytes, how much of the memory in the returned native allocation is not part of your request. The overhead memory is used for allocation headers and other metadata describing the allocation. + + + + + An array specifying, in bytes, the amount of padding used to align the returned native allocation. + + + + + An array of root reference IDs for the allocation. Corresponds to entries in NativeRootReferenceEntries.id array. + + + + + An array containing the total size, in bytes, of the native allocation. + + + + + Gets the number allocation entries. + + + The number of entries. + + + + + A class that houses native allocation site entries, returned by PackedMemorySnapshot.nativeAllocationSites. + + + + + An array of callstack symbols corresponding to this allocation site, referring to NativeCallstackSymbolEntries.symbol. + + + + + An array containing allocation site IDs. + + + + + An array containing memory labels attached to allocation sites. Referenced by index into PackedMemorySnapshot.nativeMemoryLabels. + + + + + Gets the number of native allocation site entries. + + + The number of entries. + + + + + A class housing native callstack symbol data, returned by PackedMemorySnapshot.nativeCallstackSymbols. + + + + + An array of readable stack traces of the callback symbols. + + + + + An array of addresses to the callback symbols, referenced by the NativeAllocationSiteEntries.callstackSymbols property. + + + + + Gets the number of callstack symbol entries. + + + The number of entries. + + + + + A class that houses native memory label data, returned by PackedMemorySnapshot.nativeMemoryLabels. + + + + + An array containing the names of the memory labels. + + + + + Gets the number of memory label entries. + + + The number of entries. + + + + + A class housing native memory region data, returned by PackedMemorySnapshot.nativeMemoryRegions. + + + + + An array containing addresses of the memory regions. Non-leaf entries containing child memory regions are set to 0. + + + + + An array that contains the accumulated size, in bytes, including all of its children, of the memory region. + + + + + An array that contains indexes into the PackedMemorySnapshot.nativeAllocations array that identify the first allocation that the memory region contains. + + + + + An array containing the names of the memory regions. + + + + + An array that contains the number of allocations, including children, that the memory regions contain. + + + + + The parent of this memory region, referenced by index into this entry array. The root memory region contains parent index of -1. + + + + + Gets the number of memory region entries. + + + The number of entries. + + + + + A class that houses native object data, returned by PackedMemorySnapshot.nativeObjects. + + + + + An array the contains the flags attached to the native memory objects referenced in the NativeObjectEntries.nativeObjectAddress array. + + + + + The hide flags attached to this native object. + + + + + The instance id of this native object. + + + + + An array of memory addresses that point to native C++ objects. This matches the "m_CachePtr" field of a UnityEngine.Object. + + + + + An array of indexes into the PackedMemorySnapshot.nativeTypes array used to retrieve the the native C++ type description. + + + + + An array containing the names of the native objects. + + + + + An array containing the root reference ids of the native objects. Corresponds to entries in NativeRootReferenceEntries.id array. + + + + + The size in bytes of this object. + + + + + Gets the number of native object entries. + + + The number of entries. + + + + + A class that houses native root reference data, returned by PackedMemorySnapshot.rootReferences. + + + + + An array that contains the accumulated sizes of all allocations registered for the root references. + + + + + An array that contains the area names of the root references. + + + + + An array that contains the IDs of the root references. + + + + + An array containing the object names of the root references. + + + + + Gets the number of root reference entries. + + + The number of entries. + + + + + A class that houses native type entries, returned by PackedMemorySnapshot.nativeTypes. + + + + + An array of indexes into the PackedMemorySnapshot.nativeTypes array used to retrieve native C++ base class description. + + + + + An array of names of the C++ unity type. + + + + + Gets the number of native type entries. + + + The number of entries. + + + + + Flags that can be set on a Native Object. + + + + + Specifies that the object is marked as DontDestroyOnLoad. + + + + + Specifies that the object is marked as a manager. + + + + + Specifies that the object is set as persistent. + + + + + An extension class that contains member functions to ObjectFlags. + + + + + True if the object is marked as DontDestroyOnLoad; otherwise false. + + The ObjectFlags to compute from (accessible via this). + + Returns true if the object associated with this ObjectFlags is marked as DontDestroyOnLoad. + + + + + True if the object is a manager, otherwise false. + + The ObjectFlags to compute from (accessible via this). + + Returns true if the object associated with this ObjectFlags is a manager. + + + + + True if the object is marked as Persistent, otherwise false. + + The ObjectFlags to operate on (accessible via this). + + Returns true if the object associated with this ObjectFlags is marked as Persistent. + + + + + PackedMemorySnapshot is a compact representation of a memory snapshot that a player has sent through the profiler connection. + + + + + Flags corresponding to the fields present in a returned memory snapshot. + + + + + Connections is an array of from,to pairs that describe which things are keeping which other things alive. + + + + + Array of Field Descriptions, referenced by Type Description entries by array index. + + + + + Path to the memory snapshot file. + + + + + All GC handles in use in the memorysnapshot. + + + + + Array of actual managed heap memory sections. + + + + + Array of managed stacks in a memory snapshot. + + + + + Meta data that was collected during memory snapshot capture. + + + + + Array of native allocation data, captured in C++. + + + + + Array of native allocation site data, captured in C++. + + + + + Array of callstack symbols, used by native allocation site data. + + + + + Array of memory labels, used by native allocation site data. + + + + + Array of native memory regions, which houses native allocations. + + + + + All native C++ objects that were loaded at time of the snapshot. + + + + + Array of native root references, which represent ownership of native allocation data. + + + + + Descriptions of all the C++ unity types the profiled player knows about. + + + + + The time and date at which the snapshot was recorded. + + + + + An array of indexes into PackedMemorySnapshot.typeDescriptions indetifying the type this field belongs to. + + + + + The current snapshot format version. + + + + + Information about the virtual machine running executing the managed code inside the player. + + + + + Converts the specified old format MemoryProfiler.PackedMemorySnapshot object to a new PackedMemorySnapshot format object and writes it to the location and file name specified the the write path. + + The old format snapshot object. + Destination path and file name for the file containing the converted snapshot. + + True if the conversion was successful; otherwise false. + + + + + Disposes of an existing PackedMemorySnapshot object and closes the file reader. + + + + + Load memory snapshot from given file path. + + An absolute file path to load a snapshot file from. + + Memory snapshot. + + + + + Copy the memory snapshot file to the given file path. + + Source memory snapshot. + Where to create copy of memory snapshot. + + + + A class that houses type description entries, returned from PackedMemorySnapshot.typeDescriptions. + + + + + Name of the assembly this type was loaded from. + + + + + The base type for this type, pointed to by an index into PackedMemorySnapshot.typeDescriptions. + + + + + An array containing indices pointing to descriptions of all fields of this type, accessible from PackedMemorySnapshot.fieldDescriptions. + + + + + Flags set for this type description, that define whether this type is an array or a value type, and the array rank of the type. + + + + + Size in bytes of an instance of this type. If this type is an array type, this describes the amount of bytes a single element in the array will take up. + + + + + The actual contents of the bytes that store this types static fields, at the point of time when the snapshot was taken. + + + + + The name of this type. + + + + + The type index of this type. This index is an index into the PackedMemorySnapshot.typeDescriptions array. + + + + + The address in memory that contains the description of this type inside the virtual machine. This can be used to match managed objects in the heap to their corresponding TypeDescription, as the first pointer of a managed object points to its type description. + + + + + The number of type description entries. + + + The number of entries. + + + + + An enum encoding information for a type description about whether it is a value type or an array type, and the rank of the array if the type is an array. Returned by TypeDescriptionEntries.flags. + + + + + Set if this type is an array. + + + + + If TypeFlags.kArray is set, the enum masked by this value will return the rank of the array (1 for a 1-dimensional array, 2 for a 2-dimensional array, etc). + + + + + Set if this value is a value type. If not set, the type is a reference type. + + + + + An extension class that contains member functions to TypeFlags. + + + + + If the type is an array type, retrieves the array rank of the type flags. + + The TypeFlags to compute the array rank of (assessible via this). + + The array rank encoded in the Type Flags. + + + + + Returns whether the flag describes an array type. + + The TypeFlags to compute from (accessible via this). + + Returns true if the Type associated with this TypeFlags is an array. + + + + + Returns whether the type describes a value type. + + The TypeFlags to compute from (accessible via this). + + Returns true if the type associated with this TypeFlags is a value type (as opposed to a reference type). + + + + + Information about a virtual machine that provided a memory snapshot. + + + + + Allocation granularity in bytes used by the virtual machine allocator. + + + + + Offset in bytes inside the object header of an array object where the bounds of the array is stored. + + + + + Size in bytes of the header of an array object. + + + + + Offset in bytes inside the object header of an array object where the size of the array is stored. + + + + + Size in bytes of the header of each managed object. + + + + + Size in bytes of a pointer. + + + + + Base class to derive custom property drawers from. Use this to create custom drawers for your own Serializable classes or for script variables with custom PropertyAttributes. + + + + + The PropertyAttribute for the property. Not applicable for custom class drawers. (Read Only) + + + + + The reflection FieldInfo for the member this property represents. (Read Only) + + + + + Override this method to determine whether the inspector GUI for your property can be cached. + + The SerializedProperty to make the custom GUI for. + + Whether the drawer's UI can be cached. + + + + + Override this method to specify how tall the GUI for this field is in pixels. + + The SerializedProperty to make the custom GUI for. + The label of this property. + + The height in pixels. + + + + + Override this method to make your own GUI for the property. + + Rectangle on the screen to use for the property GUI. + The SerializedProperty to make the custom GUI for. + The label of this property. + + + + Defines a single modified property. + + + + + The value being applied when it is a object reference (which can not be represented as a string). + + + + + Property path of the property being modified (Matches as SerializedProperty.propertyPath). + + + + + Object that will be modified. + + + + + The value being applied. + + + + + The type of the iOS provisioning profile if manual signing is used. + + + + + The provisioning profile type will be determined automatically when building the Xcode project. + + + + + Development provisioning profiles are used to install development apps on test devices. + + + + + Distribution provisioning profiles can be used when uploading the app to the App Store or for Ad Hoc and in house distribution. + + + + + Type of build to generate. + + + + + Package build for installation on either a dev or test kit. + + + + + Build hosted on a PC, for file serving to a dev or test kit. + + + + + Editor API for the Unity Services editor feature. Normally Purchasing is enabled from the Services window, but if writing your own editor extension, this API can be used. + + + + + This Boolean field will cause the Purchasing feature in Unity to be enabled if true, or disabled if false. + + + + + Options for removing assets + + + + + Delete the asset without moving it to the trash. + + + + + The asset should be moved to trash. + + + + + Contains the custom albedo swatch data. + + + + + Color of the albedo swatch that is shown in the physically based rendering validator user interface. + + + + + The maximum luminance value used to validate the albedo for the physically based rendering albedo validator. + + + + + The minimum luminance value used to validate the albedo for the physically based rendering albedo validator. + + + + + Name of the albedo swatch to show in the physically based renderer validator user interface. + + + + + Editor-specific script interface for. + + + + + Returns an array of Rendering.AlbedoSwatchInfo. + + + + + Will return PlatformShaderSettings for given platform and shader hardware tier. + + + + + + + Returns TierSettings for the target build platform and shader hardware tier. + + + + + + + TODO. + + + + + + + Allows you to set the PlatformShaderSettings for the specified platform and shader hardware tier. + + + + + + + + Allows you to set the PlatformShaderSettings for the specified platform and shader hardware tier. + + + + + + + + TODO. + + + + + + + + Used to set up shader settings, per-platform and per-shader-hardware-tier. + + + + + Allows you to specify whether cascaded shadow maps should be used. + + + + + Allows you to specify whether Reflection Probes Blending should be enabled. + + + + + Allows you to specify whether Reflection Probes Box Projection should be used. + + + + + Allows you to select Standard Shader Quality. + + + + + Collection of data used for shader variants generation, including targeted platform data and the keyword set representing a specific shader variant. + + + + + Identifier to classify low, medium and high performance hardware. + + + + + A collection of Rendering.ShaderKeyword that represents a specific platform shader variant. + + + + + Shader compiler used to generate player data shader variants. + + + + + A collection of Rendering.ShaderKeyword that represents a specific shader variant. + + + + + Required shader features by a specific shader. + + + + + Shader compiler used to generate player data shader variants. + + + + + Compiler used with Direct3D 11 and Direct3D 12 graphics API on Windows platforms. + + + + + Compiler used with OpenGL ES 2.0 and WebGL 1.0 graphics APIs on Android, iOS, Windows and WebGL platforms. + + + + + Compiler used with OpenGL ES 3.x and WebGL 2.0 graphics APIs on Android, iOS, Windows and WebGL platforms. + + + + + Compiler used with Metal graphics API on macOS, iOS and tvOS platforms. + + + + + Provide a reasonable value for non initialized variables. + + + + + Compiler used with OpenGL core graphics API on macOS, Linux and Windows platforms. + + + + + Compiler used on PlayStation 4. + + + + + Compiler used on Nintendo Switch. + + + + + Compiler used with Vulkan graphics API on Android, Linux and Windows platforms. + + + + + Compiler used with Direct3D 11 graphics API on XBox One. + + + + + Compiler used with Direct3D 12 graphics API on XBox One. + + + + + Shader quality preset. + + + + + High quality shader preset. + + + + + Low quality shader preset. + + + + + Medium quality shader preset. + + + + + Required shader features for some particular shader. Features are bit flags. + + + + + Indicates that basic shader capability, Shader Model 2.0 level is required. + + + + + + Indicates that compute shader support is required. + + + + + + Indicates the shader requires cubemap array support. + + + + + Indicates that derivative (ddx/ddy) instructions support is required in the fragment shader. + + + + + Indicates that pixel position (SV_Position) input support is required in the fragment shader. + + + + + Indicates the shader must support framebuffer fetch, which is the ability to have in+out fragment shader color params. + + + + + Indicates that geometry shader support is required. + + + + + Indicates the shader must support SV_InstanceID shader input. + + + + + Indicates the shader must have 10 interpolators. + + + + + Indicates the shader must have 15 integers and interpolators in total. Unity bundles them together because it is extremely unlikely a GPU/API will ever exist that only has part of that. + + + + + Indicates the shader must have 32 interpolators + + + + + Indicates the shader must have multiple render targets (at least 4), as in support a fragment shader that can output up to 4 values. + + + + + Indicates the shader must have multiple render targets (at least 8), as in support a fragment shader that can output up to 4 values. + + + + + Indicates the shader requires access to MSAA texture samples. + + + + + No shader requirements. + + + + + Indicates the shader requires have random-write textures (UAVs) support. + + + + + Indicates the shader requires the support of texture sampling in a fragment shader with an explicit mipmap level. + + + + + Indicates the shader requires the support of sparse textures with sampling instructions that return residency information. + + + + + Indicates the shader requires the support of tessellation using a compute shader for control points processing. Metal graphics API requires this feature for tessellation. + + + + + Indicates the shader requires the support of tessellation using the hull and domain shader stages. + + + + + Indicates the shader requires 2D array textures. + + + + + Collection of properties about the specific shader code being compiled. + + + + + Shader. + + + + + Shader pass type for Unity's lighting pipeline. + + + + + Shader stage in the rendering the pipeline. + + + + + Identifies the stage in the rendering pipeline. + + + + + Identifier for the domain shader stage. + + + + + Identifier for the fragment shader stage. + + + + + Identifier for the geometry shader stage. + + + + + Identifier for the hull shader stage. + + + + + Identifier for the vertex shader stage. + + + + + Used to set up per-platorm per-shader-hardware-tier graphics settings. + + + + + Allows you to specify whether cascaded shadow maps should be used. + + + + + Allows you to specify whether Detail Normal Map should be sampled if assigned. + + + + + Allows you to specify whether Light Probe Proxy Volume should be used. + + + + + Setting this field to true enables HDR rendering for this tier. Setting it to false disables HDR rendering for this tier. +See Also: + + + + + The CameraHDRMode to use for this tier. + + + + + Allows you to specify whether Unity should try to use 32-bit shadow maps, where possible. + + + + + The RealtimeGICPUUsage to use for this tier. + + + + + Allows you to specify whether Reflection Probes Blending should be enabled. + + + + + Allows you to specify whether Reflection Probes Box Projection should be used. + + + + + The rendering path that should be used. + + + + + Allows you to specify whether Semitransparent Shadows should be enabled. + + + + + Allows you to select Standard Shader Quality. + + + + + Flags for the PrefabUtility.ReplacePrefab function. + + + + + Connects the passed objects to the Prefab after uploading the Prefab. + + + + + Replaces Prefabs by matching pre-existing connections to the Prefab. + + + + + Replaces the Prefab using name based lookup in the transform hierarchy. + + + + + Resolution dialog setting. + + + + + Never show the resolution dialog. + + + + + Show the resolution dialog on first launch. + + + + + Hide the resolution dialog on first launch. + + + + + SceneAsset is used to reference Scene objects in the Editor. + + + + + Class with information about a component that has been added to a Prefab instance. + + + + + The added component on the Prefab instance. + + + + + See PrefabOverride.Apply. + + + + + + See PrefabOverride.GetAssetObject. + + + + + See PrefabOverride.Revert. + + + + + Class with information about a GameObject that has been added as a child under a Prefab instance. + + + + + The added GameObject on the Prefab instance. + + + + + The sibling index of the added GameObject. + + + + + See PrefabOverride.Apply. + + + + + + See PrefabOverride.GetAssetObject. + + + + + See PrefabOverride.Revert. + + + + + Scene management in the Editor. + + + + + Subscribe to this event to get notified when the active Scene has changed in Edit mode in the Editor. + + Previous active Scene and the new active Scene. + + + + The number of loaded Scenes. + + + + + This event is called after a new Scene has been created. + + + + + + Loads this SceneAsset when you start Play Mode. + + + + + Controls whether cross-Scene references are allowed in the Editor. + + + + + The current amount of active preview Scenes. + + + + + This event is called after a Scene has been closed in the editor. + + + + + + This event is called before closing an open Scene after you have requested that the Scene is closed. + + + + + + This event is called after a Scene has been opened in the editor. + + + + + + This event is called before opening an existing Scene. + + + + + + This event is called after a Scene has been saved. + + + + + + This event is called before a Scene is saved disk after you have requested the Scene to be saved. + + + + + + Closes a preview Scene created by NewPreviewScene. + + The preview Scene to close. + + True if the Scene was successfully closed. + + + + + Close the Scene. If removeScene flag is true, the closed Scene will also be removed from EditorSceneManager. + + The Scene to be closed/removed. + Bool flag to indicate if the Scene should be removed after closing. + + Returns true if the Scene is closed/removed. + + + + + Detects cross-Scene references in a Scene. + + Scene to check for cross-Scene references. + + Was any cross-Scene references found. + + + + + Shows a save dialog if an Untitled Scene exists in the current Scene manager setup. + + Text shown in the save dialog. + + True if the Scene is saved or if there is no Untitled Scene. + + + + + Returns the current setup of the SceneManager. + + + An array of SceneSetup classes - one item for each Scene. + + + + + Is the Scene a preview Scene? + + The Scene to check. + + True if the Scene is a preview Scene. + + + + + Is this object part of a preview Scene? + + The object to check. + + True if this object is part of a preview Scene. + + + + + This method allows you to load a Scene during playmode in the editor, without requiring the Scene to be included in the Scene list. + + Path to Scene to load. + Parameters to apply to loading. See SceneManagement.LoadSceneParameters. + + Use the AsyncOperation to determine if the operation has completed. + + + + + This method allows you to load a Scene during playmode in the editor, without requiring the Scene to be included in the Scene list. + + Path to Scene to load. + Parameters used to load the Scene SceneManagement.LoadSceneParameters. + + Scene that is loading. + + + + + Mark all the loaded Scenes as modified. + + + + + Mark the specified Scene as modified. + + The Scene to be marked as modified. + + Whether the Scene was successfully marked as dirty. + + + + + Allows you to reorder the Scenes currently open in the Hierarchy window. Moves the source Scene so it comes after the destination Scene. + + The Scene to move. + The Scene which should come directly before the source Scene in the hierarchy. + + + + Allows you to reorder the Scenes currently open in the Hierarchy window. Moves the source Scene so it comes before the destination Scene. + + The Scene to move. + The Scene which should come directly after the source Scene in the hierarchy. + + + + Creates a new preview Scene. Any object added to a preview Scene will only be rendered in that Scene. + + + The new preview Scene. + + + + + Create a new Scene. + + Whether the new Scene should use the default set of GameObjects. + Whether to keep existing Scenes open. + + A reference to the new Scene. + + + + + Callbacks of this type which have been added to the newSceneCreated event are called after a new Scene has been created. + + The Scene that was created. + The setup mode used when creating the Scene. + The mode used for creating the Scene. + + + + Open a Scene in the Editor. + + The path of the Scene. This should be relative to the Project folder; for example, "AssetsMyScenesMyScene.unity". + Allows you to select how to open the specified Scene, and whether to keep existing Scenes in the Hierarchy. See SceneManagement.OpenSceneMode for more information about the options. + + A reference to the opened Scene. + + + + + Restore the setup of the SceneManager. + + In this array, at least one Scene should be loaded, and there must be one active Scene. + + + + Asks you if you want to save the modified Scene or Scenes. + + + This returns true if you chose to save the Scene or Scenes, and returns false if you pressed Cancel. + + + + + Asks whether the modfied input Scenes should be saved. + + Scenes that should be saved if they are modified. + + Your choice of whether to save or not save the Scenes. + + + + + Save all open Scenes. + + + Returns true if all open Scenes are successfully saved. + + + + + Save a Scene. + + The Scene to be saved. + The file path to save the Scene to. If the path is empty, the current open Scene is overwritten. If it has not yet been saved at all, a save dialog is shown. + If set to true, the Scene is saved without changing the current Scene, and without clearing the unsaved changes marker. + + True if the save succeeded, otherwise false. + + + + + Save a list of Scenes. + + List of Scenes that should be saved. + + True if the save succeeded. Otherwise false. + + + + + Callbacks of this type which have been added to the sceneClosed event are called immediately after the Scene has been closed. + + The Scene that was closed. + + + + Callbacks of this type which have been added to the sceneClosing event are called just before a Scene is closed. + + The Scene that is going to be closed. + Whether or not the Scene is also going to be removed from the Scene Manager after closing. If true the Scene is removed after closing. + + + + Callbacks of this type which have been added to the sceneOpened event are called after a Scene has been opened. + + The Scene that was opened. + The mode used to open the Scene. + + + + Callbacks of this type which have been added to the sceneOpening event are called just before opening a Scene. + + Path of the Scene to be opened. This is relative to the Project path. + Mode that is used when opening the Scene. + + + + Callbacks of this type which have been added to the sceneSaved event are called after a Scene has been saved. + + The Scene that was saved. + + + + Callbacks of this type which have been added to the sceneSaving event are called just before the Scene is saved. + + The Scene to be saved. + The path to which the Scene is saved. + + + + Used when creating a new Scene in the Editor. + + + + + The newly created Scene is added to the current open Scenes. + + + + + All current open Scenes are closed and the newly created Scene are opened. + + + + + Used when creating a new Scene in the Editor. + + + + + Adds default game objects to the new Scene (a light and camera). + + + + + No game objects are added to the new Scene. + + + + + Class with information about an object on a Prefab instance with overridden properties. + + + + + The object on the Prefab instance. + + + + + See PrefabOverride.Apply. + + + + + + See PrefabOverride.GetAssetObject. + + + + + See PrefabOverride.Revert. + + + + + Used when opening a Scene in the Editor to specify how a Scene should be opened. + + + + + Adds a Scene to the current open Scenes and loads it. + + + + + Adds a Scene to the current open Scenes without loading it. It will show up as 'unloaded' in the Hierarchy Window. + + + + + Closes all current open Scenes and loads a Scene. + + + + + Class with information about a given override on a Prefab instance. + + + + + Applies the override to the Prefab Asset at the given path. + + The path of the Prefab Asset to apply to. + + + + Applies the override to the Prefab Asset at the given path. + + The path of the Prefab Asset to apply to. + + + + Finds the object in the Prefab Asset at the given path which will be applied to. + + The asset path of the Prefab Asset to apply to. + + The object inside the Prefab Asset affected by the override. + + + + + Returns the asset object of the override in the outermost Prefab that the Prefab instance comes from. + + + The object inside the Prefab Asset affected by the override. + + + + + Reverts the override on the Prefab instance. + + + + + Class with information about a component that has been removed from a Prefab instance. + + + + + The components on the Prefab Asset which has been removed on the Prefab instance. + + + + + The GameObject on the Prefab instance that the component has been removed from. + + + + + See PrefabOverride.Apply. + + + + + + See PrefabOverride.GetAssetObject. + + + + + See PrefabOverride.Revert. + + + + + The setup information for a Scene in the SceneManager. This cannot be used in Play Mode. + + + + + If the Scene is active. + + + + + If the Scene is loaded. + + + + + Path of the Scene. Should be relative to the project folder. Like: "AssetsMyScenesMyScene.unity". + + + + + Struct that represents a stage handle. + + + + + Does the stage contain the given GameObject? + + The GameObject to check. + + True if the stage contains the given GameObject. + + + + + Returns the first active loaded object of the given type. + + + This returns the object that matches the specified type. It returns null if no object matches the type. + + + + + Returns a list of all active loaded objects of the given type. + + + An array of objects found matching the type specified. + + + + + Is this stage handle valid? + + + True if the stage handle is valid. + + + + + Utility methods related to stages. + + + + + Get the current stage being edited. + + + The current stage. + + + + + Get the main stage which contains all the currently open regular Scenes. + + + The main stage. + + + + + Get the stage in which the given GameObject exists. + + The GameObject to find the stage of. + + The stage of the GameObject. + + + + + Get the stage in which the given Scene exists. + + The Scene to find the stage of. + + The stage of the Scene. + + + + + Navigate the Editor to the previous stage. + + + + + Navigate the Editor to the main stage. + + + + + Is the given GameObject rendered by the given Camera? + + The GameObject to check. + The camera to check. + + True if the GameObject is rendered by the camera. + + + + + Place the given GameObject in the current stage being edited. + + The GameObject to be placed in the current stage. + + + + SceneView class. + + + + + The current draw mode for the Scene view camera. + + + + + Is the Scene view in 2D mode? + + + + + Event that is fired when the selected camera mode changes. + + + + + + Event that is fired when validating camera modes for the Scene view camera. + + + + + + Gets the current SceneViewState which can be used to modify the Scene view debug options. + + + + + Add a custom camera mode to the Scene view camera mode list. + + The name for the new mode. + The section in which the new mode will be added. This can be an existing or new section. + + A CameraMode with the provided name and section. + + + + + Describes a built in Scene view mode. + + + + + The draw mode associated with the CameraMode. + + + + + The name of the CameraMode. + + + + + The section the CameraMode belongs to. + + + + + Remove all user-defined camera modes. + + + + + Frames the given bounds in the Scene view. + + The bounds to frame in the Scene view. + + + True if the given bounds can be encompassed in the Scene view, otherwise false. + + + + + Frame the object selection in the Scene view. + + Whether the view should be locked to the selection. + + True if the selection can be encompassed in the Scene view, otherwise false. + + + + + Frame the object selection in the Scene view. + + Whether the view should be locked to the selection. + + True if the selection can be encompassed in the Scene view, otherwise false. + + + + + Returns a CameraMode corresponding to a builtin DrawCameraMode. + + The mode to look up. + + + + + Returns true if mode is enabled in the current rendering setup, including custom validators. + + A CameraMode to check. + + + + Returns true if mode is enabled in the current rendering setup, including custom validators. + + A CameraMode to check. + + + + Override this method to control whether the Scene view should change when you switch from one stage to another stage. + + + True if the Scene view automatically reacts to stage changes. + + + + + Derive from this class to create an editor wizard. + + + + + Allows you to set the text shown on the create button of the wizard. + + + + + Allows you to set the error text of the wizard. + + + + + Allows you to set the help text of the wizard. + + + + + Allows you to enable and disable the wizard create button, so that the user can not click it. + + + + + Allows you to set the text shown on the optional other button of the wizard. Leave this parameter out to leave the button out. + + + + + Creates a wizard. + + The title shown at the top of the wizard window. + + The wizard. + + + + + Creates a wizard. + + The title shown at the top of the wizard window. + The text shown on the create button. + The text shown on the optional other button. Leave this parameter out to leave the button out. + + The wizard. + + + + + Creates a wizard. + + The title shown at the top of the wizard window. + The text shown on the create button. + The text shown on the optional other button. Leave this parameter out to leave the button out. + + The wizard. + + + + + Creates a wizard. + + The title shown at the top of the wizard window. + The class implementing the wizard. It has to derive from ScriptableWizard. + The text shown on the create button. + The text shown on the optional other button. Leave this parameter out to leave the button out. + + The wizard. + + + + + Will be called for drawing contents when the ScriptableWizard needs to update its GUI. + + + Returns true if any property has been modified. + + + + + Script call optimization level. + + + + + Script method call overhead decreased at the expense of limited compatibility. + + + + + Default setting. + + + + + Represents different C# compilers that can be used to compile C# scripts. + + + + + Mono C# Compiler. + + + + + Roslyn C# Compiler. + + + + + Scripting implementation (backend). + + + + + Unity's .NET runtime. + + + + + The standard Mono 2.6 runtime. + + + + + Microsoft's .NET runtime. + + + + + Available scripting runtimes to be used by the Editor and Players. + + + + + Use the most recent version of the scripting runtime available. + + + + + Use the stable version of the scripting runtime. + + + + + Access to the selection in the editor. + + + + + Returns the current context object, as was set via SetActiveObjectWithContext. + + + + + Returns the active game object. (The one shown in the inspector). + + + + + Returns the instanceID of the actual object selection. Includes Prefabs, non-modifiable objects. + + + + + Returns the actual object selection. Includes Prefabs, non-modifiable objects. + + + + + Returns the active transform. (The one shown in the inspector). + + + + + Returns the guids of the selected assets. + + + + + Returns the actual game object selection. Includes Prefabs, non-modifiable objects. + + + + + The actual unfiltered selection from the Scene returned as instance ids instead of objects. + + + + + The actual unfiltered selection from the Scene. + + + + + Delegate callback triggered when currently active/selected item has changed. + + + + + Returns the top level selection, excluding Prefabs. + + + + + Returns whether an object is contained in the current selection. + + + + + + + Returns whether an object is contained in the current selection. + + + + + + + Returns the current selection filtered by type and mode. + + Only objects of this type will be retrieved. + Further options to refine the selection. + + + + Allows for fine grained control of the selection type using the SelectionMode bitmask. + + Options for refining the selection. + + + + Selects an object with a context. + + Object being selected (will be equal activeObject). + Context object. + + + + SelectionMode can be used to tweak the selection returned by Selection.GetTransforms. + + + + + Only return objects that are assets in the Asset directory. + + + + + Return the selection and all child transforms of the selection. + + + + + If the selection contains folders, also include all assets and subfolders within that folder in the file hierarchy. + + + + + Excludes any objects which shall not be modified. + + + + + Excludes any Prefabs from the selection. + + + + + Only return the topmost selected transform. A selected child of another selected transform will be filtered out. + + + + + Return the whole selection. + + + + + Behavior of semantic merge. + + + + + Disable use of semantic merging. + + + + + SerializedObject and SerializedProperty are classes for editing serialized fields on Object|Unity objects in a completely generic way. These classes automatically handle dirtying individual serialized fields so they will be processed by the Undo system and styled correctly for Prefab overrides when drawn in the Inspector. + + + + + The context used to store and resolve ExposedReference types. This is set by the SerializedObject constructor. + + + + + Is true when the SerializedObject has a modified property that has not been applied. + + + + + Does the serialized object represents multiple objects due to multi-object editing? (Read Only) + + + + + Defines the maximum size beyond which arrays cannot be edited when multiple objects are selected. + + + + + The inspected object (Read Only). + + + + + The inspected objects (Read Only). + + + + + Apply property modifications. + + + + + Applies property modifications without registering an undo operation. + + + + + Copies a value from a SerializedProperty to the corresponding serialized property on the serialized object. + + + + + + Copies a changed value from a SerializedProperty to the corresponding serialized property on the serialized object. + + + + + + Create SerializedObject for inspected object. + + + + + + Create SerializedObject for inspected object. + + + + + + Create SerializedObject for inspected object by specifying a context to be used to store and resolve ExposedReference types. + + + + + + + Create SerializedObject for inspected object by specifying a context to be used to store and resolve ExposedReference types. + + + + + + + Find serialized property by name. + + + + + + Get the first serialized property. + + + + + Update hasMultipleDifferentValues cache on the next Update() call. + + + + + Update serialized object's representation. + + + + + This has been made obsolete. See SerializedObject.UpdateIfRequiredOrScript instead. + + + + + Update serialized object's representation, only if the object has been modified since the last call to Update or if it is a script. + + + + + SerializedProperty and SerializedObject are classes for editing properties on objects in a completely generic way that automatically handles undo and styling UI for Prefabs. + + + + + Value of a animation curve property. + + + + + Type name of the element in an array property. (Read Only) + + + + + The number of elements in the array. If the SerializedObject contains multiple objects it will return the smallest number of elements. So it is always possible to iterate through the SerializedObject and only get properties found in all objects. + + + + + Value of a boolean property. + + + + + Value of bounds with integer values property. + + + + + Value of bounds property. + + + + + Value of a color property. + + + + + Nesting depth of the property. (Read Only) + + + + + Nice display name of the property. (Read Only) + + + + + Value of a float property as a double. + + + + + Is this property editable? (Read Only) + + + + + Display-friendly names of enumeration of an enum property. + + + + + Names of enumeration of an enum property. + + + + + Enum index of an enum property. + + + + + A reference to another Object in the Scene. This reference is resolved in the context of the SerializedObject containing the SerializedProperty. + + + + + The number of elements in the fixed buffer. (Read Only) + + + + + Value of a float property. + + + + + Does it have child properties? (Read Only) + + + + + Does this property represent multiple different values due to multi-object editing? (Read Only) + + + + + Does it have visible child properties? (Read Only) + + + + + Value of an integer property. + + + + + Is this property an array? (Read Only) + + + + + Allows you to check whether his property is a PrefabUtility.IsDefaultOverride|default override. + +Certain properties on Prefab instances are default overrides. + +See PrefabUtility.IsDefaultOverride for more information. + + + + + Is this property expanded in the inspector? + + + + + Is this property a fixed buffer? (Read Only) + + + + + Is property part of a Prefab instance? (Read Only) + + + + + Value of a integer property as a long. + + + + + Name of the property. (Read Only) + + + + + Value of an object reference property. + + + + + Allows you to check whether a property's value is overriden (i.e. different to the Prefab it belongs to). + + + + + Full path of the property. (Read Only) + + + + + Type of this property (Read Only). + + + + + Value of a quaternion property. + + + + + Value of a rectangle with integer values property. + + + + + Value of a rectangle property. + + + + + SerializedObject this property belongs to (Read Only). + + + + + Value of a string property. + + + + + Tooltip of the property. (Read Only) + + + + + Type name of the property. (Read Only) + + + + + Value of a 2D integer vector property. + + + + + Value of a 2D vector property. + + + + + Value of a 3D integer vector property. + + + + + Value of a 3D vector property. + + + + + Value of a 4D vector property. + + + + + Remove all elements from the array. + + + + + Returns a copy of the SerializedProperty iterator in its current state. This is useful if you want to keep a reference to the current property but continue with the iteration. + + + + + Count visible children of this property, including this property itself. + + + + + Count remaining visible properties. + + + + + Compares the data for two SerializedProperties. This method ignores paths and SerializedObjects. + + + + + + + Delete the element at the specified index in the array. + + + + + + Deletes the serialized property. + + + + + Duplicates the serialized property. + + + + + See if contained serialized properties are equal. + + + + + + + Retrieves the SerializedProperty at a relative path to the current property. + + + + + + Returns the element at the specified index in the array. + + + + + + Retrieves the SerializedProperty that defines the end range of this property. + + + + + + Retrieves the SerializedProperty that defines the end range of this property. + + + + + + Retrieves an iterator that allows you to iterator over the current nexting of a serialized property. + + + + + Returns the element at the specified index in the fixed buffer. + + + + + + Insert an empty element at the specified index in the array. + + + + + + Move an array element from srcIndex to dstIndex. + + + + + + + Move to next property. + + + + + + Move to next visible property. + + + + + + Move to first property of the object. + + + + + Type of a SerializedProperty. + + + + + AnimationCurve property. + + + + + Array size property. + + + + + Boolean property. + + + + + Bounds property. + + + + + Bounds with Integer values property. + + + + + Character property. + + + + + Color property. + + + + + Enumeration property. + + + + + A reference to another Object in the Scene. This is done via an ExposedReference type and resolves to a reference to an Object that exists in the context of the SerializedObject containing the SerializedProperty. + + + + + Fixed buffer size property. + + + + + Float property. + + + + + Gradient property. + + + + + Integer property. + + + + + LayerMask property. + + + + + Reference to another object. + + + + + Quaternion property. + + + + + Rectangle property. + + + + + Rectangle with Integer values property. + + + + + String property. + + + + + 2D vector property. + + + + + 2D integer vector property. + + + + + 3D vector property. + + + + + 3D integer vector property. + + + + + 4D vector property. + + + + + SessionState is a Key-Value Store intended for storing and retrieving Editor session state that should survive assembly reloading. + + + + + Erase a Boolean entry in the key-value store. + + + + + + Erase a Float entry in the key-value store. + + + + + + Erase an Integer entry in the key-value store. + + + + + + Erase an Integer array entry in the key-value store. + + + + + + Erase a String entry in the key-value store. + + + + + + Erase a Vector3 entry in the key-value store. + + + + + + Retrieve a Boolean value. + + + + + + + Retrieve a Float value. + + + + + + + Retrieve an Integer value. + + + + + + + Retrieve an Integer array. + + + + + + + Retrieve a String value. + + + + + + + Retrieve a Vector3. + + + + + + + Store a Boolean value. + + + + + + + Store a Float value. + + + + + + + Store an Integer value. + + + + + + + Store an Integer array. + + + + + + + Store a String value. + + + + + + + Store a Vector3. + + + + + + + SettingsProvider is the configuration class that specifies how a Project setting or a preference should appear in the Settings or Preferences window. + + + + + Overrides SettingsProvider.OnActivate. + + + + + Overrides SettingsProvider.OnDeactivate. + + + + + Overrides SettingsProvider.OnFooterBarGUI. + + + + + Overrides SettingsProvider.OnGUI. + + + + + Overrides SettingsProvider.HasSearchInterest. + + + + + Gets or sets the list of keywords to compare against what the user is searching for. When the user enters values in the search box on the Settings window, SettingsProvider.HasSearchInterest tries to match those keywords to this list. + + + + + Gets or sets the display name of the SettingsProvider as it appears in the Settings window. If not set, the Settings window uses last token of SettingsProvider.settingsPath instead. + + + + + Gets the Scope of the SettingsProvider. The Scope determines whether the SettingsProvider appears in the Preferences window (SettingsScope.User) or the Settings window (SettingsScope.Project). + + + + + Gets Path used to place the SettingsProvider in the tree view of the Settings window. The path should be unique among all other settings paths and should use "/" as its separator. + + + + + Overrides SettingsProvider.OnTitleBarGUI. + + + + + Creates a new SettingsProvider. + + Path of the settings in the Settings window. Uses "/" as separator. The last token becomes the settings label if none is provided. + Scope of the Settings. The Scope determines where the setting appears: in the Settings or the Preferences windows. + List of keywords to compare against what the user is searching for. When the user enters values in the search box on the Settings window, SettingsProvider.HasSearchInterest tries to match those keywords to this list. + + + + + Extract search keywords from all public static memebers in a specific Type. + + + Returns the list of keywords extracted from the static GUIContent. + + + + + Extract search keywords from the serialized properties of an Asset at a specific path. + + Path of the Asset on disk. + + Returns the list of keywords. + + + + + Extract search keywords from from the serialized properties of a SerializedObject. + + Object to extract properties from. + + Returns the list of keywords. + + + + + Checks whether the SettingsProvider should appear when the user types something in the Settings window search box. SettingsProvider tries to match the search terms (even partially) to any of the SettingsProvider.keywords. The search is case insensitive. + + Search terms that the user entered in the search box on the Settings window. + + True if the SettingsProvider matched the search term and if it should appear. + + + + + Use this function to implement a handler for when the user clicks on the Settings in the Settings window. You can fetch a settings Asset or set up UIElements UI from this function. + + Search context in the search box on the Settings window. + Root of the UIElements tree. If you add to this root, the SettingsProvider uses UIElements instead of calling SettingsProvider.OnGUI to build the UI. If you do not add to this VisualElement, then you must use the IMGUI to build the UI. + + + + Use this function to implement a handler for when the user clicks on another setting or when the Settings window closes. + + + + + Use this function to override drawing the footer for the SettingsProvider using IMGUI. + + + + + Use this function to draw the UI based on IMGUI. This assumes you haven't added any children to the rootElement passed to the OnActivate function. + + Search context for the Settings window. Used to show or hide relevant properties. + + + + Use this function to override drawing the title for the SettingsProvider using IMGUI. This allows you to add custom UI (such as a toolbar button) next to the title. AssetSettingsProvider uses this mecanism to display the "add to preset" and the "help" buttons. + + + + + Request the SettingsWindow for a repaint. + + + + + Attribute used to register a new SettingsProvider. Use this attribute to decorate a function that returns an instance of a SettingsProvider. If the function returns null, no SettingsProvider appears in the Settings window. + + + + + Creates a new SettingsProviderAttribute used to register new SettingsProvider. + + + + + Attribute used to register multiple SettingsProvider items. Use this attribute to decorate a function that returns an array of SettingsProvider instances. If the function returns null, no SettingsProvider appears in the Settings window. + + + + + Creates a SettingsProviderGroupAttribute used to register multiple SettingsProviders. + + + + + Sets the scope of a SettingsProvider. The Scope determines where it appears in the UI. For example, whether it appears with the Project settings in the Settings window, or in the Preferences window, or in both windows. + + + + + The SettingsProvider appears only in the Project Settings window. + + + + + The SettingsProvider appears only in the Preferences window. + + + + + This class provides global APIs to interact with the Settings window. + + + + + Use this function to notify the SettingsService that a SettingsProvider changed. + + + + + Open the Project Settings window with the specified settings item already selected. + + Settings paths of the item to select (for example, 'ProjectPlayer' or 'ProjectQuality'). + + Returns an instance to the Settings window. + + + + + Open the Preferences window with the specified settings item already selected. + + Settings path of the item to select (for example, 'PreferencesKeys' or 'Preferences2D'). + + Returns an instance to the Settings window. + + + + + This class describes a shader. + + + + + Returns the active subshader or null if none is currently active. + + + + + Returns the index of the active subshader or -1 if none is currently active. + + + + + Get a subshader. + + The index of the subshader. + + The associated subshader or null if none exists. + + + + + This class describes a pass of a subshader. + + + + + The name of this pass (may be empty). + + + + + The source code for this pass. + + + + + The shader attached to this data set. + + + + + This class describes a subshader. + + + + + Get a pass of a subshader. + + The index of the pass. + + The specified pass or null, if none exists. + + + + + The number of passes for this subshader. + + + + + The number of subshaders used by this shader. + + + + + Abstract class to derive from for defining custom GUI for shader properties and for extending the material preview. + + + + + This method is called when a new shader has been selected for a Material. + + The material the newShader should be assigned to. + Previous shader. + New shader to assign to the material. + + + + Find shader properties. + + Name of the material property. + The array of available properties. + If true then this method will throw an exception if a property with propertyName was not found. + + The material property found, otherwise null. + + + + + Find shader properties. + + Name of the material property. + The array of available properties. + If true then this method will throw an exception if a property with propertyName was not found. + + The material property found, otherwise null. + + + + + This method is called when the ShaderGUI is being closed. + + + + + + To define a custom shader GUI use the methods of materialEditor to render controls for the properties array. + + The MaterialEditor that are calling this OnGUI (the 'owner'). + Material properties of the current selected shader. + + + + Override for extending the rendering of the Preview area or completly replace the preview (by not calling base.OnMaterialPreviewGUI). + + The MaterialEditor that are calling this method (the 'owner'). + Preview rect. + Style for the background. + + + + Override for extending the functionality of the toolbar of the preview area or completly replace the toolbar by not calling base.OnMaterialPreviewSettingsGUI. + + The MaterialEditor that are calling this method (the 'owner'). + + + + Shader importer lets you modify shader import settings from Editor scripts. + + + + + Gets the default texture assigned to the shader importer for the shader property with given name. + + + + + + Gets the non-modifiable texture assigned to the shader importer for the shader property with given name. + + + + + + Gets the reference to the shader imported by this importer. + + + + + Sets the default textures for each texture material property. + + + + + + + Sets the non-modifiable textures for each texture material property. + + + + + + + This attribute is no longer supported. + + + + + Contains the following information about a shader: +-If the shader has compilation errors. +-If the shader is supported on the currently selected platform. +-The name of the shader. + + + + + True if the shader has compilation errors. + + + + + The name of the shader. + + + + + True if the shader is supported on the currently selected platform. + + + + + Utility functions to assist with working with shaders from the editor. + + + + + Does the current hardware support render textues. + + + + + Clear compile time errors for the given shader. + + + + + + Returns an array of ShaderInfo of all available shaders. That includes built-in shaders. + + + ShaderInfo array of all available shaders. + + + + + Get the number of properties in Shader s. + + The shader to check against. + + + + Get the description of the shader propery at index propertyIdx of Shader s. + + The shader to check against. + The property index to use. + + + + Get the name of the shader propery at index propertyIdx of Shader s. + + The shader to check against. + The property index to use. + + + + Get the ShaderProperyType of the shader propery at index propertyIdx of Shader s. + + The shader to check against. + The property index to use. + + + + Get Limits for a range property at index propertyIdx of Shader s. + + Which value to get: 0 = default, 1 = min, 2 = max. + The shader to check against. + The property index to use. + + + + Get the shader data for a specific shader. + + The shader to get data from. + + The shader data for the provided shader. + + + + + Gets texture dimension of a shader property. + + The shader to get the property from. + The property index to use. + + Texture dimension. + + + + + Is the shader propery at index propertyIdx of Shader s hidden? + + The shader to check against. + The property index to use. + + + + Is the shader propery at index propertyIdx of Shader s a NonModifiableTextureProperty? + + The shader to check against. + The property index to use. + + + + Register a user created shader. + + + + + + Type of a given texture property. + + + + + Color Property. + + + + + Float Property. + + + + + Range Property. + + + + + Texture Property. + + + + + Vector Property. + + + + + Structure to hold camera data extracted from a SketchUp file. + + + + + Aspect ratio of the camera. + + + + + Field of view of the camera. + + + + + Indicate if the camera is using a perspective or orthogonal projection. + + + + + The position the camera is looking at. + + + + + The orthogonal projection size of the camera. This value only make sense if SketchUpImportCamera.isPerspective is false. + + + + + The position of the camera. + + + + + Up vector of the camera. + + + + + Derives from AssetImporter to handle importing of SketchUp files. + + + + + Retrieves the latitude Geo Coordinate imported from the SketchUp file. + + + + + Retrieves the longitude Geo Coordinate imported from the SketchUp file. + + + + + Retrieves the north correction value imported from the SketchUp file. + + + + + The default camera or the camera of the active Scene which the SketchUp file was saved with. + + + The default camera. + + + + + The method returns an array of SketchUpImportScene which represents SketchUp scenes. + + + Array of scenes extracted from a SketchUp file. + + + + + Structure to hold scene data extracted from a SketchUp file. + + + + + The camera data of the SketchUp scene. + + + + + The name of the SketchUp scene. + + + + + AssetImportor for importing SpeedTree model assets. + + + + + Gets and sets a default alpha test reference values. + + + + + Indicates if the cross-fade LOD transition, applied to the last mesh LOD and the billboard, should be animated. + + + + + Returns the best-possible wind quality on this asset (configured in SpeedTree modeler). + + + + + Proportion of the last 3D mesh LOD region width which is used for cross-fading to billboard tree. + + + + + Gets and sets an array of booleans to enable shadow casting for each LOD. + + + + + Gets and sets an array of booleans to enable normal mapping for each LOD. + + + + + Gets and sets an array of booleans to enable Hue variation effect for each LOD. + + + + + Enables smooth LOD transitions. + + + + + Gets and sets an array of booleans to enable Subsurface effect for each LOD (affects only SpeedTree v8 assets). + + + + + Proportion of the billboard LOD region width which is used for fading out the billboard. + + + + + Tells if there is a billboard LOD. + + + + + Tells if the SPM file has been previously imported. + + + + + Gets and sets a default Hue variation color and amount (in alpha). + + + + + Returns true if the asset is a SpeedTree v8 asset. + + + + + Gets and sets a default main color. + + + + + Returns the folder path where generated materials will be placed in. + + + + + Material import location options. + + + + + Gets and sets an array of booleans to enable shadow receiving for each LOD. + + + + + How much to scale the tree model compared to what is in the .spm file. + + + + + Gets and sets a default Shininess value. + + + + + Gets and sets a default specular color. + + + + + Gets and sets an array of booleans to enable Light Probe lighting for each LOD. + + + + + Gets and sets an array of integers of the wind qualities on each LOD. Values will be clampped by bestWindQuality internally. + + + + + Gets an array of name strings for wind quality value. + + + + + Construct a new SpeedTreeImporter object. + + + + + Generates all necessary materials under materialFolderPath. If Version Control is enabled please first check out the folder. + + + + + Gets and sets an array of floats of each LOD's screen height value. + + + + + Material import location options. + + + + + Extract the materials and textures from the model. + + + + + Unity imports materials as sub-assets. + + + + + Search the project for matching materials and use them instead of the internal materials. + + The path to search for matching materials. + + Returns true if any materials have been remapped, otherwise false. + + + + + The style of builtin splash screen to use. + + + + + Dark background with light logo and text. + + + + + White background with dark logo and text. + + + + + Texture importer modes for Sprite import. + + + + + Sprites are multiple image sections extracted from the texture. + + + + + Graphic is not a Sprite. + + + + + Sprite has it own mesh outline defined. + + + + + Sprite is a single image section extracted automatically from the texture. + + + + + Editor data used in producing a Sprite. + + + + + Edge-relative alignment of the sprite graphic. + + + + + Edge border size for a sprite (in pixels). + + + + + Name of the Sprite. + + + + + The pivot point of the Sprite, relative to its bounding rectangle. + + + + + Bounding rectangle of the sprite's graphic within the atlas image. + + + + + Sprite Packer mode for the current project. + + + + + Always maintain an up-to-date sprite atlas cache for Sprite with packing tag (legacy). + + + + + Always pack all the SpriteAtlas. + + + + + Updates the sprite atlas cache when the Player or bundles builds containing Sprite with the legacy packing tag. + + + + + Pack all the SpriteAtlas when building player/bundles. + + + + + Doesn't pack sprites. + + + + + Abstract class that is used by systems to encapsulate Sprite data representation. Currently this is used by Sprite Editor Window. + + + + + SpriteAlignment that represents the pivot value for the Sprite data. + + + + + Returns a Vector4 that represents the border of the Sprite data. + + + + + The name of the Sprite data. + + + + + Vector2 value representing the pivot for the Sprite data. + + + + + Rect value that represents the position and size of the Sprite data. + + + + + GUID to uniquely identify the SpriteRect data. This will be populated to Sprite.spriteID to identify the SpriteRect used to generate the Sprite. + + + + + Helper method to get SpriteRect.spriteID from a SerializedProperty. + + The SerializedProperty to acquire from. + + GUID for the SpriteRect. + + + + + Describes the final atlas texture. + + + + + Marks this atlas so that it contains textures that have been flagged for Alpha splitting when needed (for example ETC1 compression for textures with transparency). + + + + + Anisotropic filtering level of the atlas texture. + + + + + Desired color space of the atlas. + + + + + Quality of atlas texture compression in the range [0..100]. + + + + + Allows Sprite Packer to rotate/flip the Sprite to ensure optimal Packing. + + + + + Filtering mode of the atlas texture. + + + + + The format of the atlas texture. + + + + + Should sprite atlas textures generate mip maps? + + + + + Maximum height of the atlas texture. + + + + + Maximum width of the atlas texture. + + + + + The amount of extra padding between packed sprites. + + + + + Sprite packing policy interface. Provide a custom implementation to control which Sprites go into which atlases. + + + + + Specifies whether sequential processing of atlas tags is enabled. If enabled, sprite packing tags are processed one by one to reduce memory usage. + + + + + Return the version of your policy. Sprite Packer needs to know if atlas grouping logic changed. + + + + + Implement custom atlas grouping here. + + + + + + + + Sprite Packer helpers. + + + + + Array of Sprite atlas names found in the current atlas cache. + + + + + Name of the default Sprite Packer policy. + + + + + Sprite Packer execution mode. + + + + + Will always trigger IPackerPolicy.OnGroupAtlases. + + + + + Normal execution. Will not trigger IPackerPolicy.OnGroupAtlases unless IPackerPolicy, IPackerPolicy version or TextureImporter settings have changed. + + + + + Returns all alpha atlas textures generated for the specified atlas. + + Name of the atlas. + + + + Returns atlasing data for the specified Sprite. + + Sprite to query. + Gets set to the name of the atlas containing the specified Sprite. + Gets set to the Texture containing the specified Sprite. + + + + Returns all atlas textures generated for the specified atlas. + + Atlas name. + + + + Available Sprite Packer policies for this project. + + + + + Rebuilds the Sprite atlas cache. + + + + + + + + The active Sprite Packer policy for this project. + + + + + Current Sprite Packer job definition. + + + + + Registers a new atlas. + + + + + + + Assigns a Sprite to an already registered atlas. + + + + + + + + + Helper utilities for accessing Sprite data. + + + + + Returns the generated Sprite mesh indices. + + If Sprite is packed, it is possible to access data as if it was on the atlas texture. + + + + + Returns the generated Sprite mesh positions. + + If Sprite is packed, it is possible to access data as if it was on the atlas texture. + + + + + Returns the generated Sprite texture. If Sprite is packed, it is possible to query for both source and atlas textures. + + If Sprite is packed, it is possible to access data as if it was on the atlas texture. + + + + + Returns the generated Sprite mesh uvs. + + If Sprite is packed, it is possible to access data as if it was on the atlas texture. + + + + + Static Editor Flags. + + + + + Consider for static batching. + + + + + Considered static for lightmapping. + + + + + Considered static for navigation. + + + + + Considered static for occlusion. + + + + + Considered static for occlusion. + + + + + Auto-generate OffMeshLink. + + + + + Consider static for reflection probe. + + + + + StaticOcclusionCulling lets you perform static occlusion culling operations. + + + + + Does the Scene contain any occlusion portals that were added manually rather than automatically? + + + + + Used to check if asynchronous generation of static occlusion culling data is still running. + + + + + Returns the size in bytes that the PVS data is currently taking up in this Scene on disk. + + + + + Used to cancel asynchronous generation of static occlusion culling data. + + + + + Clears the PVS of the opened Scene. + + + + + Used to generate static occlusion culling data. + + + + + Used to compute static occlusion culling data asynchronously. + + + + + Used to visualize static occlusion culling at development time in Scene view. + + + + + If set to true, culling of geometry is enabled. + + + + + If set to true, visualization of target volumes is enabled. + + + + + If set to true, visualization of portals is enabled. + + + + + If set to true, the visualization lines of the PVS volumes will show all cells rather than cells after culling. + + + + + If set to true, visualization of view volumes is enabled. + + + + + If set to true, visualization of portals is enabled. + + + + + Options for querying the version control system status of a file. + + + + + Force a refresh of the version control system status of the file. This is slow but accurate. + +See Also: AssetDatabase.IsOpenForEdit, AssetDatabase.IsMetaFileOpenForEdit. + + + + + This option sets the status query to first use the latest valid version control system status of the file and query for a valid status asynchronously if otherwise. + + + + + This option sets the status query to first use the latest valid version control system status of the file and query for a valid status synchronously if otherwise. + + + + + Enum used to specify what stereo rendering path to use. + + + + + Single pass VR rendering ( via instanced rendering ). + + + + + Multiple pass VR rendering. + + + + + Single pass VR rendering ( via double-wide render texture ). + + + + + Managed code stripping level. + + + + + Deprecated. See ManagedStrippingLevel. + + + + + Deprecated. See ManagedStrippingLevel. + + + + + Deprecated. See ManagedStrippingLevel. + + + + + Deprecated. See ManagedStrippingLevel. + + + + + A Takeinfo object contains all the information needed to describe a take. + + + + + Start time in second. + + + + + Stop time in second. + + + + + This is the default clip name for the clip generated for this take. + + + + + Take name as define from imported file. + + + + + Sample rate of the take. + + + + + Start time in second. + + + + + Stop time in second. + + + + + A set of helper functions for using terrain layers. + + + + + Checks whether the texture is correctly imported as a normal map texture. + + The texture to check. + + True if texture is correctly imported, otherwise false. + + + + + Helper function to show the layer selection window for selecting terrain layers in inspector. + + Terrain tile. + Currently selected terrain layer index. + + Newly selected terrain layer index. + + + + + Displays the tiling settings UI. + + The terrain layer that contains the tiling settings to display. + The tile size property to display. + The tile offset property to display. + + + + Displays the tiling settings UI. + + The terrain layer that contains the tiling settings to display. + The tile size property to display. + The tile offset property to display. + + + + Checks whether the texture is a valid TerrainLayer diffuse texture. If it detects that the texture is not valid, it displays a warning message that identifies the issue. + + The texture to validate. + + + + Checks whether the texture is a valid TerrainLayer mask map texture. If it detects that the texture is not valid, it displays a warning message that identifies the issue. + + The texture to validate. + + + + Checks whether the texture is a valid TerrainLayer normal map texture. If it detects that the texture is not valid, it displays a warning message that identifies the issue. + + The texture to validate. + The return value from the CheckNormalMapTextureType method indicating whether the texture is imported as a normal map. + + + + Compression Quality. + + + + + Best compression. + + + + + Fast compression. + + + + + Normal compression (default). + + + + + Texture importer lets you modify Texture2D import settings from editor scripts. + + + + + Allows alpha splitting on relevant platforms for this texture. + + + + + If the provided alpha channel is transparency, enable this to prefilter the color to avoid filtering artifacts. + + + + + Select how the alpha of the imported texture is generated. + + + + + Returns or assigns the alpha test reference value. + + + + + ETC2 texture decompression fallback override on Android devices that don't support ETC2. + + + + + Anisotropic filtering level of the texture. + + + + + Keep texture borders the same when generating mipmaps? + + + + + Quality of Texture Compression in the range [0..100]. + + + + + Convert heightmap to normal map? + + + + + Use crunched compression when available. + + + + + Fade out mip levels to gray color? + + + + + Filtering mode of the texture. + + + + + Cubemap generation mode. + + + + + Should mip maps be generated with gamma correction? + + + + + Generate alpha channel from intensity? + + + + + Amount of bumpyness in the heightmap. + + + + + Set this to true if you want texture data to be readable from scripts. Set it to false to prevent scripts from reading texture data. + + + + + Is this texture a lightmap? + + + + + Is texture storing non-color data? + + + + + Maximum texture size. + + + + + Mip map bias of the texture. + + + + + Generate Mip Maps. + + + + + Mip level where texture is faded out completely. + + + + + Mip level where texture begins to fade out. + + + + + Mipmap filtering mode. + + + + + Enables or disables coverage-preserving alpha MIP mapping. + + + + + Is this texture a normal map? + + + + + Normal map filtering mode. + + + + + Scaling mode for non power of two textures. + + + + + Returns true if this TextureImporter is setup for Sprite packing. + + + + + Border sizes of the generated sprites. + + + + + Selects Single or Manual import mode for Sprite textures. + + + + + Selects the Sprite packing tag. + + + + + The point in the Sprite object's coordinate space where the graphic is located. + + + + + The number of pixels in the sprite that correspond to one unit in world space. + + + + + Scale factor for mapping pixels in the graphic to units in world space. + + + + + Array representing the sections of the atlas corresponding to individual sprite graphics. + + + + + Is texture storing color data? + + + + + Enable mipmap streaming for this texture. + + + + + Relative priority for this texture when reducing memory size in order to hit the memory budget. + + + + + Compression of imported texture. + + + + + Format of imported texture. + + + + + Shape of imported texture. + + + + + Which type of texture are we dealing with here. + + + + + Texture coordinate wrapping mode. + + + + + Texture U coordinate wrapping mode. + + + + + Texture V coordinate wrapping mode. + + + + + Texture W coordinate wrapping mode for Texture3D. + + + + + Clear specific target platform settings. + + The platform whose settings are to be cleared (see below). + + + + Does textures source image have alpha channel. + + + + + Does textures source image have RGB channels. + + + + + Getter for the flag that allows Alpha splitting on the imported texture when needed (for example ETC1 compression for textures with transparency). + + + True if the importer allows alpha split on the imported texture, False otherwise. + + + + + Returns the TextureImporterFormat that would be automatically chosen for this platform. + + + + Format chosen by the system for the provided platform, TextureImporterFormat.Automatic if the platform does not exist. + + + + + Get the default platform specific texture settings. + + + A TextureImporterPlatformSettings structure containing the default platform parameters. + + + + + Get platform specific texture settings. + + The platform for which settings are required (see options below). + Maximum texture width/height in pixels. + Format of the texture for the given platform. + Value from 0..100, equivalent to the standard JPEG quality setting. + Status of the ETC1 and alpha split flag. + + True if the platform override was found, false if no override was found. + + + + + Get platform specific texture settings. + + The platform whose settings are required (see below). + Maximum texture width/height in pixels. + Format of the texture. + Value from 0..100, equivalent to the standard JPEG quality setting. + + True if the platform override was found, false if no override was found. + + + + + Get platform specific texture settings. + + The platform whose settings are required (see below). + Maximum texture width/height in pixels. + Format of the texture. + + True if the platform override was found, false if no override was found. + + + + + Get platform specific texture settings. + + The platform whose settings are required (see below). + + A TextureImporterPlatformSettings structure containing the platform parameters. + + + + + Reads the active texture output instructions of this TextureImporter. + + + + + Read texture settings into TextureImporterSettings class. + + + + + + Setter for the flag that allows Alpha splitting on the imported texture when needed (for example ETC1 compression for textures with transparency). + + + + + + Set specific target platform settings. + + The platforms whose settings are to be changed (see below). + Maximum texture width/height in pixels. + Data format for the texture. + Value from 0..100, with 0, 50 and 100 being respectively Fast, Normal, Best quality options in the texture importer UI. For Crunch texture formats, this roughly corresponds to JPEG quality levels. + Allows splitting of imported texture into RGB+A so that ETC1 compression can be applied (Android only, and works only on textures that are a part of some atlas). + + + + Set specific target platform settings. + + The platforms whose settings are to be changed (see below). + Maximum texture width/height in pixels. + Data format for the texture. + Value from 0..100, with 0, 50 and 100 being respectively Fast, Normal, Best quality options in the texture importer UI. For Crunch texture formats, this roughly corresponds to JPEG quality levels. + Allows splitting of imported texture into RGB+A so that ETC1 compression can be applied (Android only, and works only on textures that are a part of some atlas). + + + + Set specific target platform settings. + + Structure containing the platform settings. + + + + Set texture importers settings from TextureImporterSettings class. + + + + + + Select how the alpha of the imported texture is generated. + + + + + Generate Alpha from image gray scale. + + + + + Use Alpha from the input texture if one is provided. + + + + + No Alpha will be used. + + + + + Select the kind of compression you want for your texture. + + + + + Texture will be compressed using a standard format depending on the platform (DXT, ASTC, ...). + + + + + Texture will be compressed using a high quality format depending on the platform and availability (BC7, ASTC4x4, ...). + + + + + Texture will be compressed using a low quality but high performance, high compression format depending on the platform and availability (2bpp PVRTC, ASTC8x8, ...). + + + + + Texture will not be compressed. + + + + + Defines Cubemap convolution mode. + + + + + Diffuse convolution (aka irradiance Cubemap). + + + + + No convolution needed. This Cubemap texture represents mirror reflection or Skybox. + + + + + Specular convolution (aka Prefiltered Environment Map). + + + + + Imported texture format for TextureImporter. + + + + + TextureFormat.Alpha8 texture format. + + + + + TextureFormat.ARGB4444 texture format. + + + + + TextureFormat.ARGB32 texture format. + + + + + ASTC compressed RGB texture format, 10x10 block size. + + + + + ASTC compressed RGB texture format, 12x12 block size. + + + + + ASTC compressed RGB texture format, 4x4 block size. + + + + + ASTC compressed RGB texture format, 5x5 block size. + + + + + ASTC compressed RGB texture format, 6x6 block size. + + + + + ASTC compressed RGB texture format, 8x8 block size. + + + + + ASTC compressed RGBA texture format, 10x10 block size. + + + + + ASTC compressed RGBA texture format, 12x12 block size. + + + + + ASTC compressed RGBA texture format, 4x4 block size. + + + + + ASTC compressed RGBA texture format, 5x5 block size. + + + + + ASTC compressed RGBA texture format, 6x6 block size. + + + + + ASTC compressed RGBA texture format, 8x8 block size. + + + + + Choose texture format automatically based on the texture parameters. + + + + + Choose a 16 bit format automatically. + + + + + Choose a compressed format automatically. + + + + + Choose a compressed HDR format automatically. + + + + + Choose a crunched format automatically. + + + + + Choose an HDR format automatically. + + + + + Choose a Truecolor format automatically. + + + + + TextureFormat.BC4 compressed texture format. + + + + + TextureFormat.BC5 compressed texture format. + + + + + TextureFormat.BC6H compressed HDR texture format. + + + + + TextureFormat.BC7 compressed texture format. + + + + + TextureFormat.DXT1 compressed texture format. + + + + + DXT1 compressed texture format using Crunch compression for smaller storage sizes. + + + + + TextureFormat.DXT5 compressed texture format. + + + + + DXT5 compressed texture format using Crunch compression for smaller storage sizes. + + + + + ETC2EAC compressed 4 bits pixel unsigned R texture format. + + + + + ETC2EAC compressed 4 bits pixel signed R texture format. + + + + + ETC2EAC compressed 8 bits pixel unsigned RG texture format. + + + + + ETC2EAC compressed 4 bits pixel signed RG texture format. + + + + + ETC (GLES2.0) 4 bits/pixel compressed RGB texture format. + + + + + ETC (Nintendo 3DS) 4 bits/pixel compressed RGB texture format. + + + + + ETC_RGB4 compressed texture format using Crunch compression for smaller storage sizes. + + + + + ETC (Nintendo 3DS) 8 bits/pixel compressed RGBA texture format. + + + + + ETC2 compressed 4 bits / pixel RGB texture format. + + + + + ETC2 compressed 4 bits / pixel RGB + 1-bit alpha texture format. + + + + + ETC2 compressed 8 bits / pixel RGBA texture format. + + + + + ETC2_RGBA8 compressed color with alpha channel texture format using Crunch compression for smaller storage sizes. + + + + + PowerVR/iOS TextureFormat.PVRTC_RGB2 compressed texture format. + + + + + PowerVR/iOS TextureFormat.PVRTC_RGB4 compressed texture format. + + + + + PowerVR/iOS TextureFormat.PVRTC_RGBA2 compressed texture format. + + + + + PowerVR/iOS TextureFormat.PVRTC_RGBA4 compressed texture format. + + + + + TextureFormat.R16 texture format. + + + + + TextureFormat.R8 texture format. + + + + + TextureFormat.RFloat floating point texture format. + + + + + TextureFormat.RG16 texture format. + + + + + TextureFormat.RGB565 texture format. + + + + + TextureFormat.RGB24 texture format. + + + + + TextureFormat.RGB9e5Float packed unsigned floating point texture format with shared exponent. + + + + + TextureFormat.RGBA4444 texture format. + + + + + TextureFormat.RGBA32 texture format. + + + + + TextureFormat.RGBAFloat floating point RGBA texture format. + + + + + TextureFormat.RGBAHalf half-precision floating point texture format. + + + + + TextureFormat.RGFloat floating point texture format. + + + + + TextureFormat.RGHalf half-precision floating point texture format. + + + + + TextureFormat.RHalf half-precision floating point texture format. + + + + + Cubemap generation mode for TextureImporter. + + + + + Automatically determine type of cubemap generation from the source image. + + + + + Generate cubemap from cylindrical texture. + + + + + Generate cubemap from vertical or horizontal cross texture. + + + + + Do not generate cubemap (default). + + + + + Generate cubemap from spheremap texture. + + + + + Mip map filter for TextureImporter. + + + + + Box mipmap filter. + + + + + Kaiser mipmap filter. + + + + + Normal map filtering mode for TextureImporter. + + + + + Sobel normal map filter. + + + + + Standard normal map filter. + + + + + Scaling mode for non power of two textures in TextureImporter. + + + + + Keep non power of two textures as is. + + + + + Scale to larger power of two. + + + + + Scale to nearest power of two. + + + + + Scale to smaller power of two. + + + + + Stores platform specifics settings of a TextureImporter. + + + + + Allows Alpha splitting on the imported texture when needed (for example ETC1 compression for textures with transparency). + + + + + Override for ETC2 decompression fallback on Android devices that don't support ETC2. + + + + + Quality of texture compression in the range [0..100]. + + + + + Use crunch compression when available. + + + + + Format of imported texture. + + + + + Maximum texture size. + + + + + Name of the build target. + + + + + Set to true in order to override the Default platform parameters by those provided in the TextureImporterPlatformSettings structure. + + + + + For Texture to be scaled down choose resize algorithm. ( Applyed only when Texture dimension is bigger than Max Size ). + + + + + Compression of imported texture. + + + + + Copy parameters into another TextureImporterPlatformSettings object. + + TextureImporterPlatformSettings object to copy settings to. + + + + RGBM encoding mode for HDR textures in TextureImporter. + + + + + Do RGBM encoding when source data is HDR in TextureImporter. + + + + + Source texture is already RGBM encoded in TextureImporter. + + + + + Do not perform RGBM encoding in TextureImporter. + + + + + Do RGBM encoding in TextureImporter. + + + + + Stores settings of a TextureImporter. + + + + + If the provided alpha channel is transparency, enable this to dilate the color to avoid filtering artifacts on the edges. + + + + + Select how the alpha of the imported texture is generated. + + + + + Returns or assigns the alpha test reference value. + + + + + Anisotropic filtering level of the texture. + + + + + Enable this to avoid colors seeping out to the edge of the lower Mip levels. Used for light cookies. + + + + + Convert heightmap to normal map? + + + + + Convolution mode. + + + + + Defines how fast Phong exponent wears off in mip maps. Higher value will apply less blur to high resolution mip maps. + + + + + Defines how many different Phong exponents to store in mip maps. Higher value will give better transition between glossy and rough reflections, but will need higher texture resolution. + + + + + Fade out mip levels to gray color? + + + + + Filtering mode of the texture. + + + + + Cubemap generation mode. + + + + + Generate alpha channel from intensity? + + + + + Amount of bumpyness in the heightmap. + + + + + Mip map bias of the texture. + + + + + Generate mip maps for the texture? + + + + + Mip level where texture is faded out to gray completely. + + + + + Mip level where texture begins to fade out to gray. + + + + + Mipmap filtering mode. + + + + + Enables or disables coverage-preserving alpha MIP mapping. + + + + + Normal map filtering mode. + + + + + Scaling mode for non power of two textures. + + + + + Is texture data readable from scripts. + + + + + RGBM encoding mode for HDR textures in TextureImporter. + + + + + Color or Alpha component TextureImporterType|Single Channel Textures uses. + + + + + Edge-relative alignment of the sprite graphic. + + + + + Border sizes of the generated sprites. + + + + + The number of blank pixels to leave between the edge of the graphic and the mesh. + + + + + Generates a default physics shape for a Sprite if a physics shape has not been set by the user. + + + + + Sprite texture import mode. + + + + + Pivot point of the Sprite relative to its graphic's rectangle. + + + + + The number of pixels in the sprite that correspond to one unit in world space. + + + + + Scale factor between pixels in the sprite graphic and world space units. + + + + + The tessellation detail to be used for generating the mesh for the associated sprite if the SpriteMode is set to Single. For Multiple sprites, use the SpriteEditor to specify the value per sprite. +Valid values are in the range [0-1], with higher values generating a tighter mesh. A default of -1 will allow Unity to determine the value automatically. + + + + + Is texture storing color data? + + + + + Enable mipmap streaming for this texture. + + + + + Relative priority for this texture when reducing memory size in order to hit the memory budget. + + + + + Shape of imported texture. + + + + + Which type of texture are we dealing with here. + + + + + Texture coordinate wrapping mode. + + + + + Texture U coordinate wrapping mode. + + + + + Texture V coordinate wrapping mode. + + + + + Texture W coordinate wrapping mode for Texture3D. + + + + + Configure parameters to import a texture for a purpose of type, as described TextureImporterType|here. + + Texture type. See TextureImporterType. + If false, change only specific properties. Exactly which, depends on type. + + + + Copy parameters into another TextureImporterSettings object. + + TextureImporterSettings object to copy settings to. + + + + Test texture importer settings for equality. + + + + + + + Select the kind of shape of your texture. + + + + + Texture is 2D. + + + + + Texture is a Cubemap. + + + + + Selects which Color/Alpha channel TextureImporterType|Single Channel Textures uses. + + + + + Use the Alpha channel. + + + + + Use the red Color channel. + + + + + Select this to set basic parameters depending on the purpose of your texture. + + + + + This sets up your texture with the basic parameters used for the Cookies of your lights. + + + + + Use this if your texture is going to be used as a cursor. + + + + + This is the most common setting used for all the textures in general. + + + + + Use this if your texture is going to be used on any HUD/GUI Controls. + + + + + This is the most common setting used for all the textures in general. + + + + + This sets up your texture with the parameters used by the lightmap. + + + + + Select this to turn the color channels into a format suitable for real-time normal mapping. + + + + + Use this for texture containing a single channel. + + + + + Select this if you will be using your texture for Sprite graphics. + + + + + For Texture to be scaled down choose resize algorithm. ( Applyed only when Texture dimension is bigger than Max Size ). + + + + + Might provide better result than Mitchell for some noise textures preserving more sharp details. + + + + + Default high quality resize algorithm. + + + + + Which tool is active in the editor. + + + + + The move tool is active. + + + + + No tool is active. Set this to implement your own in-inspector toolbar (like the terrain editor does). + + + + + The rect tool is active. + + + + + The rotate tool is active. + + + + + The scale tool is active. + + + + + The transform tool is active. + + + + + The view tool is active - Use Tools.viewTool to find out which view tool we're talking about. + + + + + Class used to manipulate the tools used in Unity's Scene View. + + + + + The tool that is currently selected for the Scene View. + + + + + The position of the tool handle in world space. + + + + + The rectangle used for the rect tool. + + + + + The rotation of the rect tool handle in world space. + + + + + The rotation of the tool handle in world space. + + + + + Hides the Tools(Move, Rotate, Resize) on the Scene view. + + + + + Are we in Center or Pivot mode. + + + + + What's the rotation of the tool handle. + + + + + Is the rect handle in blueprint mode? + + + + + The option that is currently active for the View tool in the Scene view. + + + + + Which layers are visible in the Scene view. + + + + + Editor Transform Utility Class. + + + + + Returns the rotation of a transform as it is shown in the Transform Inspector window. + + Transform to get the rotation from. + + Rotation as it is shown in the Transform Inspector window. + + + + + Sets the rotation of a transform as it would be set by the Transform Inspector window. + + Transform to set the rotation on. + Rotation as it would be set by the Transform Inspector window. + + + + AssetImporter for importing Fonts. + + + + + Calculation mode for determining font's ascent. + + + + + Border pixels added to character images for padding. This is useful if you want to render text using a shader which needs to render outside of the character area (like an outline shader). + + + + + Spacing between character images in the generated texture in pixels. This is useful if you want to render text using a shader which samples pixels outside of the character area (like an outline shader). + + + + + A custom set of characters to be included in the Font Texture. + + + + + An array of font names, to be used when includeFontData is set to false. + + + + + References to other fonts to be used looking for fallbacks. + + + + + Font rendering mode to use for this font. + + + + + Font size to use for importing the characters. + + + + + Use this to adjust which characters should be imported. + + + + + The internal font name of the TTF file. + + + + + If this is enabled, the actual font will be embedded into the asset for Dynamic fonts. + + + + + Set this property to true if you want to round the internal advance width of the font to the nearest integer. + + + + + Create an editable copy of the font asset at path. + + + + + + Supported tvOS SDK versions. + + + + + Device SDK. + + + + + Simulator SDK. + + + + + Supported tvOS deployment versions. + + + + + Target tvOS 9.0. + + + + + Target tvOS 9.1. + + + + + Unknown tvOS version, managed by user. + + + + + Method extensions for SpriteAtlas in Editor. + + + + + Add an array of Assets to the packable objects list. + + Array of Object to be packed into the atlas. + + + + + Return all the current packed packables in the atlas. + + + + + + Current SpriteAtlasPackingSettings to use when packing this SpriteAtlas. + + + + + + Returns the platform settings of the build target you specify. + + The name of the build target. + + + + + Current SpriteAtlasTextureSettings of the packed texture generated by this SpriteAtlas. + + + + + + Remove objects from the atlas's packable objects list. + + Object in the array you wish to remove. + + + + + Define if this sprite atlas's packed texture is included in the build with the Sprite after packing is done. + + + + + + + Sets whether this Sprite Atlas is a variant or not. + + + + + + + Set an atlas to be the master atlas. + + + + + + + Set the SpriteAtlasPackingSettings to use when packing this SpriteAtlas + + + + + + + Set the platform specific settings. + + + + + + + Set the SpriteAtlasTextureSettings for the packed texture generated by this SpriteAtlas. + + + + + + + Set the value used to downscale the master's texture. + + Recommended value is [0.1 ~ 0.99]. + + + + + Settings to use during the packing process for this SpriteAtlas. + + + + + Block offset to use while packing. + + + + + Determines if rotating a sprite is possible during packing. + + + + + Determines if sprites should be packed tightly during packing. + + + + + Value to add boundary (padding) to sprites when packing into the atlas. + + + + + Texture settings for the packed texture generated by SpriteAtlas. + + + + + Packed texture's Anisotropic filtering level. + + + + + Filter mode of the packed texture. + + + + + Set whether mipmaps should be generated for the packed texture. + + + + + Readable state of the packed texture. + + + + + Checks if the packed texture uses sRGB read/write conversions (Read Only). + + + + + Utility methods to pack atlases in the Project. + + + + + Pack all the SpriteAtlas Assets in the Project for the particular BuildTarget. + + + + + + + Pack all the provided SpriteAtlas for the particular BuildTarget. + + + + + + + + Default mobile device orientation. + + + + + Auto Rotation Enabled. + + + + + Landscape : counter-clockwise from Portrait. + + + + + Landscape: clockwise from Portrait. + + + + + Portrait. + + + + + Portrait upside down. + + + + + Lets you register undo operations on specific objects you are about to perform changes on. + + + + + Callback that is triggered after an undo or redo was executed. + + + + + Invoked before the Undo system performs a flush. + + + + + Adds a component to the game object and registers an undo operation for this action. + + The game object you want to add the component to. + The type of component you want to add. + + The newly added component. + + + + + Generic version. + + The game object you want to add the component to. + + The newly added component. + + + + + Removes all undo and redo operations from respectively the undo and redo stacks. + + + + + Removes all Undo operation for the identifier object registered using Undo.RegisterCompleteObjectUndo from the undo stack. + + + + + + Collapses all undo operation up to group index together into one step. + + + + + + Destroys the object and records an undo operation so that it can be recreated. + + The object that will be destroyed. + + + + Ensure objects recorded using RecordObject or ::ref:RecordObjects are registered as an undoable action. In most cases there is no reason to invoke FlushUndoRecordObjects since it's automatically done right after mouse-up and certain other events that conventionally marks the end of an action. + + + + + Unity automatically groups undo operations by the current group index. + + + + + Get the name that will be shown in the UI for the current undo group. + + + Name of the current group or an empty string if the current group is empty. + + + + + Unity automatically groups undo operations by the current group index. + + + + + Move a GameObject from its current Scene to a new Scene. +It is required that the GameObject is at the root of its current Scene. + + GameObject to move. + Scene to move the GameObject into. + Name of the undo action. + + + + Perform an Redo operation. + + + + + Perform an Undo operation. + + + + + Records any changes done on the object after the RecordObject function. + + The reference to the object that you will be modifying. + The title of the action to appear in the undo history (i.e. visible in the undo menu). + + + + Records multiple undoable objects in a single call. This is the same as calling Undo.RecordObject multiple times. + + + + + + + Stores a copy of the object states on the undo stack. + + The object whose state changes need to be undone. + The name of the undo operation. + + + + This is equivalent to calling the first overload mutiple times, save for the fact that only one undo operation will be generated for this one. + + An array of objects whose state changes need to be undone. + The name of the undo operation. + + + + Register an undo operations for a newly created object. + + The object that was created. + The name of the action to undo. Think "Undo ...." in the main menu. + + + + Copy the states of a hierarchy of objects onto the undo stack. + + The object used to determine a hierarchy of objects whose state changes need to be undone. + The name of the undo operation. + + + + This overload is deprecated. Use Undo.RegisterFullObjectHierarchyUndo(Object, string) instead. + + + + + + Performs all undo operations up to the group index without storing a redo operation in the process. + + + + + + Performs the last undo operation but does not record a redo operation. + + + + + Set the name of the current undo group. + + New name of the current undo group. + + + + Sets the parent of transform to the new parent and records an undo operation. + + The Transform component whose parent is to be changed. + The parent Transform to be assigned. + The name of this action, to be stored in the Undo history buffer. + + + + Delegate used for undoRedoPerformed. + + + + + Delegate used for willFlushUndoRecord. + + + + + See Also: Undo.postprocessModifications. + + + + + The UnityEditor assembly implements the editor-specific APIs in Unity. It cannot be referenced by runtime code compiled into players. + + + + + Unwrapping settings. + + + + + Maximum allowed angle distortion (0..1). + + + + + Maximum allowed area distortion (0..1). + + + + + This angle (in degrees) or greater between triangles will cause seam to be created. + + + + + How much uv-islands will be padded. + + + + + Will set default values for params. + + + + + + This class holds everything you may need in regard to uv-unwrapping. + + + + + Will generate per-triangle uv (3 UVs for each triangle) with default settings. + + The source mesh to generate UVs for. + + The list of UVs generated. + + + + + Will generate per-triangle uv (3 UVs for each triangle) with provided settings. + + The source mesh to generate UVs for. + Allows you to specify custom parameters to control the unwrapping. + + The list of UVs generated. + + + + + Will auto generate uv2 with default settings for provided mesh, and fill them in. + + + + + + Will auto generate uv2 with provided settings for provided mesh, and fill them in. + + + + + + + This class containes information about the version control state of an asset. + + + + + Gets the full name of the asset including extension. + + + + + Returns true if the asset is a folder. + + + + + Returns true if the asset file exists and is in the current project. + + + + + Returns true if the instance of the Asset class actually refers to a .meta file. + + + + + Returns true if the asset is locked by the version control system. + + + + + Get the name of the asset. + + + + + Gets the path of the asset. + + + + + Returns true is the asset is read only. + + + + + Gets the version control state of the asset. + + + + + Opens the assets in an associated editor. + + + + + Returns true if the version control state of the assets is one of the input states. + + Array of states to test for. + + + + Returns true if the version control state of the asset exactly matches the input state. + + State to check for. + + + + Loads the asset to memory. + + + + + Describes the various version control states an asset can have. + + + + + The asset was locally added to version control. + + + + + Remotely this asset was added to version control. + + + + + The asset has been checked out on the local machine. + + + + + The asset has been checked out on a remote machine. + + + + + There is a conflict with the asset that needs to be resolved. + + + + + The asset has been deleted locally. + + + + + The asset has been deleted on a remote machine. + + + + + The asset is not under version control. + + + + + The asset is locked by the local machine. + + + + + The asset is locked by a remote machine. + + + + + This instance of the class actaully refers to a .meta file. + + + + + The asset exists in version control but is missing on the local machine. + + + + + The asset has been moved locally. + + + + + The asset has been moved on a remote machine. + + + + + The version control state is unknown. + + + + + A newer version of the asset is available on the version control server. + + + + + The asset is read only. + + + + + The asset is up to date. + + + + + This asset is either ignored or doesn't exist in version control. + + + + + The state of the asset is currently being queried from the version control server. + + + + + A list of version control information about assets. + + + + + Based on the current list and the states a new list is returned which only contains the assets with the requested states. + + Whether or not folders should be included. + Which states to filter by. + + + + Create an optimised list of assets by removing children of folders in the same list. + + + + + Count the list of assets by given a set of states. + + Whether or not to include folders. + Which states to include in the count. + + + + Wrapper around a changeset description and ID. + + + + + The ID of the default changeset. + + + + + Description of a changeset. + + + + + Version control specific ID of a changeset. + + + + + Simply a list of changetsets. + + + + + What to checkout when starting the Checkout task through the version control Provider. + + + + + Checkout the asset only. + + + + + Checkout both asset and .meta file. + + + + + Checkout. + + + + + Checkout .meta file only. + + + + + Different actions a version control task can do upon completion. + + + + + Refresh windows upon task completion. + + + + + Update the content of a pending changeset with the result of the task upon completion. + + + + + Update the pending changesets with the result of the task upon completion. + + + + + Show or update the checkout failure window. + + + + + Refreshes the incoming and pensing changes window upon task completion. + + + + + Update incoming changes window with the result of the task upon completion. + + + + + Refresh the submit window with the result of the task upon completion. + + + + + Update the list of pending changes when a task completes. + + + + + This class describes the. + + + + + Descrition of the configuration field. + + + + + This is true if the configuration field is a password field. + + + + + This is true if the configuration field is required for the version control plugin to function correctly. + + + + + Label that is displayed next to the configuration field in the editor. + + + + + Name of the configuration field. + + + + + Mode of the file. + + + + + Binary file. + + + + + No mode set. + + + + + Text file. + + + + + Which method to use when merging. + + + + + Merge all changes. + + + + + Merge non-conflicting changes. + + + + + Don't merge any changes. + + + + + Messages from the version control system. + + + + + The message text. + + + + + The severity of the message. + + + + + Severity of a version control message. + + + + + Error message. + + + + + Informational message. + + + + + Verbose message. + + + + + Warning message. + + + + + Write the message to the console. + + + + + Represent the connection state of the version control provider. + + + + + Connection to the version control server could not be established. + + + + + Connection to the version control server has been established. + + + + + The version control provider is currently trying to connect to the version control server. + + + + + The plugin class describes a version control plugin and which configuratin options it has. + + + + + Configuration fields of the plugin. + + + + + This class provides acces to the version control API. + + + + + Gets the currently executing task. + + + + + Returns true if the version control provider is enabled and a valid Unity Pro License was found. + + + + + Returns true if a version control plugin has been selected and configured correctly. + + + + + Returns the reason for the version control provider being offline (if it is offline). + + + + + Returns the OnlineState of the version control provider. + + + + + This is true if a network connection is required by the currently selected version control plugin to perform any action. + + + + + Adds an assets or list of assets to version control. + + List of assets to add to version control system. + Set this true if adding should be done recursively into subfolders. + Single asset to add to version control system. + + + + Adds an assets or list of assets to version control. + + List of assets to add to version control system. + Set this true if adding should be done recursively into subfolders. + Single asset to add to version control system. + + + + Given a list of assets this function returns true if Add is a valid task to perform. + + List of assets to test. + + + + Given a changeset only containing the changeset ID, this will start a task for quering the description of the changeset. + + Changeset to query description of. + + + + Move an asset or list of assets from their current changeset to a new changeset. + + List of asset to move to changeset. + Changeset to move asset to. + Asset to move to changeset. + ChangesetID to move asset to. + + + + Move an asset or list of assets from their current changeset to a new changeset. + + List of asset to move to changeset. + Changeset to move asset to. + Asset to move to changeset. + ChangesetID to move asset to. + + + + Move an asset or list of assets from their current changeset to a new changeset. + + List of asset to move to changeset. + Changeset to move asset to. + Asset to move to changeset. + ChangesetID to move asset to. + + + + Move an asset or list of assets from their current changeset to a new changeset. + + List of asset to move to changeset. + Changeset to move asset to. + Asset to move to changeset. + ChangesetID to move asset to. + + + + Get a list of pending changesets owned by the current user. + + + + + Retrieves the list of assets belonging to a changeset. + + Changeset to query for assets. + ChangesetID to query for assets. + + + + Retrieves the list of assets belonging to a changeset. + + Changeset to query for assets. + ChangesetID to query for assets. + + + + Checkout an asset or list of asset from the version control system. + + List of assets to checkout. + Tell the Provider to checkout the asset, the .meta file or both. + Asset to checkout. + + + + Checkout an asset or list of asset from the version control system. + + List of assets to checkout. + Tell the Provider to checkout the asset, the .meta file or both. + Asset to checkout. + + + + Checkout an asset or list of asset from the version control system. + + List of assets to checkout. + Tell the Provider to checkout the asset, the .meta file or both. + Asset to checkout. + + + + Checkout an asset or list of asset from the version control system. + + List of assets to checkout. + Tell the Provider to checkout the asset, the .meta file or both. + Asset to checkout. + + + + Checkout an asset or list of asset from the version control system. + + List of assets to checkout. + Tell the Provider to checkout the asset, the .meta file or both. + Asset to checkout. + + + + Checkout an asset or list of asset from the version control system. + + List of assets to checkout. + Tell the Provider to checkout the asset, the .meta file or both. + Asset to checkout. + + + + Given an asset or a list of assets this function returns true if Checkout is a valid task to perform. + + List of assets. + Single asset. + + + + Given an asset or a list of assets this function returns true if Checkout is a valid task to perform. + + List of assets. + Single asset. + + + + This will invalidate the cached state information for all assets. + + + + + This will statt a task for deleting an asset or assets both from disk and from version control system. + + Project path of asset. + List of assets to delete. + Asset to delete. + + + + This will statt a task for deleting an asset or assets both from disk and from version control system. + + Project path of asset. + List of assets to delete. + Asset to delete. + + + + This will statt a task for deleting an asset or assets both from disk and from version control system. + + Project path of asset. + List of assets to delete. + Asset to delete. + + + + Starts a task that will attempt to delete the given changeset. + + List of changetsets. + + + + Test if deleting a changeset is a valid task to perform. + + Changeset to test. + + + + Starts a task for showing a diff of the given assest versus their head revision. + + List of assets. + Whether or not to include .meta. + + + + Return true is starting a Diff task is a valid operation. + + List of assets. + + + + Returns the configuration fields for the currently active version control plugin. + + + + + Gets the currently user selected verson control plugin. + + + + + Returns version control information about an asset. + + GUID of asset. + + + + Returns version control information about an asset. + + Path to asset. + + + + Return version control information about the currently selected assets. + + + + + Start a task for getting the latest version of an asset from the version control server. + + List of assets to update. + Asset to update. + + + + Start a task for getting the latest version of an asset from the version control server. + + List of assets to update. + Asset to update. + + + + Returns true if getting the latest version of an asset is a valid operation. + + List of assets to test. + Asset to test. + + + + Returns true if getting the latest version of an asset is a valid operation. + + List of assets to test. + Asset to test. + + + + Start a task for quering the version control server for incoming changes. + + + + + Given an incoming changeset this will start a task to query the version control server for which assets are part of the changeset. + + Incoming changeset. + Incoming changesetid. + + + + Given an incoming changeset this will start a task to query the version control server for which assets are part of the changeset. + + Incoming changeset. + Incoming changesetid. + + + + Returns true if an asset can be edited. + + Asset to test. + + + + Attempt to lock an asset for exclusive editing. + + List of assets to lock/unlock. + True to lock assets, false to unlock assets. + Asset to lock/unlock. + + + + Attempt to lock an asset for exclusive editing. + + List of assets to lock/unlock. + True to lock assets, false to unlock assets. + Asset to lock/unlock. + + + + Return true if the task can be executed. + + List of assets to test. + Asset to test. + + + + Return true if the task can be executed. + + List of assets to test. + Asset to test. + + + + This method will initiate a merge task handle merging of the conflicting assets. + + The list of conflicting assets to be merged. + How to merge the assets. + + + + Uses the version control plugin to move an asset from one path to another. + + Path to source asset. + Path to destination. + + + + Start a task that will resolve conflicting assets in version control. + + The list of asset to mark as resolved. + How the assets should be resolved. + + + + Tests if any of the assets in the list is resolvable. + + The list of asset to be resolved. + + + + Reverts the specified assets by undoing any changes done since last time you synced. + + The list of assets to be reverted. + How to revert the assets. + The asset to be reverted. + + + + Reverts the specified assets by undoing any changes done since last time you synced. + + The list of assets to be reverted. + How to revert the assets. + The asset to be reverted. + + + + Return true if Revert is a valid task to perform. + + List of assets to test. + Revert mode to test for. + Asset to test. + + + + Return true if Revert is a valid task to perform. + + List of assets to test. + Revert mode to test for. + Asset to test. + + + + Start a task that will fetch the most recent status from revision control system. + + The assets fetch new state for. + The asset path to fetch new state for. + If any assets specified are folders this flag will get status for all descendants of the folder as well. + + + + Start a task that will fetch the most recent status from revision control system. + + The assets fetch new state for. + The asset path to fetch new state for. + If any assets specified are folders this flag will get status for all descendants of the folder as well. + + + + Start a task that will fetch the most recent status from revision control system. + + The assets fetch new state for. + The asset path to fetch new state for. + If any assets specified are folders this flag will get status for all descendants of the folder as well. + + + + Start a task that will fetch the most recent status from revision control system. + + The assets fetch new state for. + The asset path to fetch new state for. + If any assets specified are folders this flag will get status for all descendants of the folder as well. + + + + Start a task that will fetch the most recent status from revision control system. + + The assets fetch new state for. + The asset path to fetch new state for. + If any assets specified are folders this flag will get status for all descendants of the folder as well. + + + + Start a task that will fetch the most recent status from revision control system. + + The assets fetch new state for. + The asset path to fetch new state for. + If any assets specified are folders this flag will get status for all descendants of the folder as well. + + + + Start a task that will fetch the most recent status from revision control system. + + The assets fetch new state for. + The asset path to fetch new state for. + If any assets specified are folders this flag will get status for all descendants of the folder as well. + + + + Start a task that will fetch the most recent status from revision control system. + + The assets fetch new state for. + The asset path to fetch new state for. + If any assets specified are folders this flag will get status for all descendants of the folder as well. + + + + Start a task that submits the assets to version control. + + The changeset to submit. + The list of assets to submit. + The description of the changeset. + If true then only save the changeset to be submitted later. + + + + Returns true if submitting the assets is a valid operation. + + The changeset to submit. + The asset to submit. + + + + Returns true if locking the assets is a valid operation. + + The assets to lock. + The asset to lock. + + + + Returns true if locking the assets is a valid operation. + + The assets to lock. + The asset to lock. + + + + Start a task that sends the version control settings to the version control system. + + + + + How assets should be resolved. + + + + + Use merged version. + + + + + Use "mine" (local version). + + + + + Use "theirs" (other/remote version). + + + + + Defines the behaviour of the version control revert methods. + + + + + Revert files but keep locally changed ones. + + + + + Use the version control regular revert approach. + + + + + Revert only unchanged files. + + + + + The status of an operation returned by the VCS. + + + + + Files conflicted. + + + + + An error was returned. + + + + + Submission worked. + + + + + Files were unable to be added. + + + + + A UnityEditor.VersionControl.Task is created almost everytime UnityEditor.VersionControl.Provider is ask to perform an action. + + + + + The result of some types of tasks. + + + + + List of changesets returned by some tasks. + + + + + A short description of the current task. + + + + + May contain messages from the version control plugins. + + + + + Progress of current task in precent. + + + + + Some task return result codes, these are stored here. + + + + + Total time spent in task since the task was started. + + + + + Get whether or not the task was completed succesfully. + + + + + Will contain the result of the Provider.ChangeSetDescription task. + + + + + Upon completion of a task a completion task will be performed if it is set. + + Which completion action to perform. + + + + A blocking wait for the task to complete. + + + + + Use these enum flags to specify which elements of a vertex to compress. + + + + + Color compression enabled. + + + + + Vertex compression disabled. + + + + + Normal compression enabled. + + + + + Position compression enabled. + + + + + Tangent compression enabled. + + + + + Texture coordinate 0 compression enabled. + + + + + Texture coordinate 1 compression enabled. + + + + + Texture coordinate 2 compression enabled. + + + + + Texture coordinate 3 compression enabled. + + + + + Bit rate after the clip is transcoded. + + + + + High value, possibly exceeding typical internet connection capabilities. + + + + + Low value, safe for slower internet connections or clips where visual quality is not critical. + + + + + Typical bit rate supported by internet connections. + + + + + VideoClipImporter lets you modify Video.VideoClip import settings from Editor scripts. + + + + + Default values for the platform-specific import settings. + + + + + Images are deinterlaced during transcode. This tells the importer how to interpret fields in the source, if any. + + + + + Apply a horizontal flip during import. + + + + + Apply a vertical flip during import. + + + + + Number of frames in the clip. + + + + + Frame rate of the clip. + + + + + Import audio tracks from source file. + + + + + Whether the preview is currently playing. + + + + + Whether to keep the alpha from the source into the transcoded clip. + + + + + Used in legacy import mode. Same as MovieImport.linearTexture. + + + + + Size in bytes of the file once imported. + + + + + Denominator of the pixel aspect ratio (num:den). + + + + + Numerator of the pixel aspect ratio (num:den). + + + + + Used in legacy import mode. Same as MovieImport.quality. + + + + + Number of audio tracks in the source file. + + + + + Size in bytes of the file before importing. + + + + + True if the source file has a channel for per-pixel transparency. + + + + + Returns true if transcoding was skipped during import, false otherwise. (Read Only) + +When VideoImporterTargetSettings.enableTranscoding is set to true, the resulting transcoding operation done at import time may be quite long, up to many hours depending on source resolution and content duration. An option to skip this process is offered in the asset import progress bar. When skipped, the transcoding instead provides a non-transcoded verision of the asset. However, the importer settings stay intact so this property can be inspected to detect the incoherence with the generated artifact. + +Re-importing without stopping the transcode process, or with transcode turned off, causes this property to become false. + + + + + True to import a MovieTexture (deprecated), false for a VideoClip (preferred). + + + + + Clear the platform-specific import settings for the specified platform, causing them to go back to the default settings. + + Platform name. + + + + Performs a value comparison with another VideoClipImporter. + + The importer to compare with. + + Returns true if the settings for both VideoClipImporters match. Returns false otherwise. + + + + + Returns a texture with the transcoded clip's current frame. +Returns frame 0 when not playing, and frame at current time when playing. + + + Texture containing the current frame. + + + + + Get the resulting height of the resize operation for the specified resize mode. + + Mode for which the height is queried. + + Height for the specified resize mode. + + + + + Get the full name of the resize operation for the specified resize mode. + + Mode for which the width is queried. + + Name for the specified resize mode. + + + + + Get the resulting width of the resize operation for the specified resize mode. + + Mode for which the width is queried. + + Width for the specified resize mode. + + + + + Number of audio channels in the specified source track. + + Index of the audio track to query. + + Number of channels. + + + + + Sample rate of the specified audio track. + + Index of the audio track to query. + + Sample rate in Hertz. + + + + + Returns the platform-specific import settings for the specified platform. + + Platform name. + + The platform-specific import settings. Throws an exception if the platform is unknown. + + + + + Starts preview playback. + + + + + Sets the platform-specific import settings for the specified platform. + + Platform name. + The new platform-specific import settings. + + + + Stops preview playback. + + + + + Video codec to use when importing video clips. + + + + + Choose the codec that supports hardware decoding on the target platform. + + + + + Encode video with the H.264 codec. + + + + + Encode video using the vp8 codec. + + + + + Describes how the fields in the image, if any, should be interpreted. + + + + + First field is in the even lines. + + + + + First field is in the odd lines. + + + + + Clip is not interlaced. + + + + + Methods to compensate for aspect ratio discrepancies between the source resolution and the wanted encoding size. + + + + + Perform no operation. + + + + + Stretch the source to fill the target resolution without preserving the aspect ratio. + + + + + Importer settings that can have platform-specific values. + + + + + How the aspect ratio discrepancies, if any, will be handled if the chosen import resolution has a different ratio than the source. + + + + + Bit rate type for the transcoded clip. + + + + + Codec that the resulting VideoClip will use. + + + + + Height of the transcoded clip when the resizeMode is set to custom. + + + + + Width of the transcoded clip when the resizeMode is set to custom. + + + + + Controls whether the movie file will be transcoded during import. When transcoding is not enabled, the file will be imported in its original format. + + + + + How to resize the images when going into the imported clip. + + + + + Controls an internal image resize, resulting in blurrier images but smaller image dimensions and file size. + + + + + Constructs an object with all members initialized with the default value inherent to their type. + + + + + How the video clip's images will be resized during transcoding. + + + + + Resulting size will be driven by VideoClipImporter.customWidth and VideoClipImporter.customHeight. + + + + + Half width and height. + + + + + Same width and height as the source. + + + + + Quarter width and height. + + + + + Fit source in a 1024x1024 rectangle. + + + + + Fit source in a 256x256 rectangle. + + + + + Fit source in a 512x512 rectangle. + + + + + 3/4 width and height. + + + + + Controls the imported clip's internal resize to save space at the cost of blurrier images. + + + + + No resize performed. + + + + + Scales width and height by 1/2. + + + + + Scales width and height by 3/4. + + + + + Enum for Tools.viewTool. + + + + + The FPS tool is selected. + + + + + View tool is not selected. + + + + + The orbit tool is selected. + + + + + The pan tool is selected. + + + + + The zoom tool is selected. + + + + + An enum containing different compression types. + + + + + WebGL resources are stored using Brotli compression. + + + + + WebGL resources are uncompressed. + + + + + WebGL resources are stored using Gzip compression. + + + + + Options for Exception support in WebGL. + + + + + Enable throw support. + + + + + Enable exception support for all exceptions, without stack trace information. + + + + + Enable exception support for all exceptions, including stack trace information. + + + + + Disable exception support. + + + + + The build format options available when building to WebGL. + + + + + Only asm.js output will be generated. + + + + + Both asm.js and WebAssembly output will be generated. The WebAssembly version of the generated content will be used if supported by the browser, otherwise, the asm.js version will be used. + + + + + Only WebAssembly output will be generated. This will require a browser with WebAssembly support to run the generated content. + + + + + Build configurations for Windows Store Visual Studio solutions. + + + + + Debug configuation. +No optimizations, profiler code enabled. + + + + + Master configuation. +Optimizations enabled, profiler code disabled. This configuration is used when submitting the application to Windows Store. + + + + + Release configuration. +Optimization enabled, profiler code enabled. + + + + + Target device type for a Windows Store application to run on. + + + + + The application targets all devices that run Windows Store applications. + + + + + The application targets HoloLens. + + + + + Application targets mobile devices. + + + + + Application targets PCs. + + + + + Target Xbox build type. + + + + + Debug player (for building with source code). + + + + + Development player. + + + + + Master player (submission-proof). + + + + + Resolution dialog setting. + + + + + Devices that support 6 Degrees of Freedom head tracking. + + + + + Devices that support 3 Degrees of Freedom head tracking. + + + + diff --git a/lib/UnityEngine.dll b/lib/UnityEngine.dll index 6d3c1e0..c91ce42 100644 Binary files a/lib/UnityEngine.dll and b/lib/UnityEngine.dll differ diff --git a/lib/UnityEngine.dll.mdb b/lib/UnityEngine.dll.mdb new file mode 100644 index 0000000..6249529 Binary files /dev/null and b/lib/UnityEngine.dll.mdb differ diff --git a/lib/UnityEngine.xml b/lib/UnityEngine.xml new file mode 100644 index 0000000..435df38 --- /dev/null +++ b/lib/UnityEngine.xml @@ -0,0 +1,88827 @@ + + + + + UnityEngine + + + + Structure describing acceleration status of the device. + + + + + Value of acceleration. + + + + + Amount of time passed since last accelerometer measurement. + + + + + A class containing methods to assist with accessibility for users with different vision capabilities. + + + + + Gets a palette of colors that should be distinguishable for normal vision, deuteranopia, protanopia, and tritanopia. + + An array of colors to populate with a palette. + Minimum allowable perceived luminance from 0 to 1. A value of 0.2 or greater is recommended for dark backgrounds. + Maximum allowable perceived luminance from 0 to 1. A value of 0.8 or less is recommended for light backgrounds. + + The number of unambiguous colors in the palette. + + + + + The AddComponentMenu attribute allows you to place a script anywhere in the "Component" menu, instead of just the "Component->Scripts" menu. + + + + + The order of the component in the component menu (lower is higher to the top). + + + + + Add an item in the Component menu. + + The path to the component. + Where in the component menu to add the new item. + + + + Add an item in the Component menu. + + The path to the component. + Where in the component menu to add the new item. + + + + Enum mask of possible shader channel properties that can also be included when the Canvas mesh is created. + + + + + No additional shader parameters are needed. + + + + + Include the normals on the mesh vertices. + + + + + Include the Tangent on the mesh vertices. + + + + + Include UV1 on the mesh vertices. + + + + + Include UV2 on the mesh vertices. + + + + + Include UV3 on the mesh vertices. + + + + + Singleton class to access the baked NavMesh. + + + + + Describes how far in the future the agents predict collisions for avoidance. + + + + + Set a function to be called before the NavMesh is updated during the frame update execution. + + + + + The maximum amount of nodes processed each frame in the asynchronous pathfinding process. + + + + + Adds a link to the NavMesh. The link is described by the NavMeshLinkData struct. + + Describing the properties of the link. + + Representing the added link. + + + + + Adds a link to the NavMesh. The link is described by the NavMeshLinkData struct. + + Describing the properties of the link. + Translate the link to this position. + Rotate the link to this orientation. + + Representing the added link. + + + + + Adds the specified NavMeshData to the game. + + Contains the data for the navmesh. + + Representing the added navmesh. + + + + + Adds the specified NavMeshData to the game. + + Contains the data for the navmesh. + Translate the navmesh to this position. + Rotate the navmesh to this orientation. + + Representing the added navmesh. + + + + + Area mask constant that includes all NavMesh areas. + + + + + Calculate a path between two points and store the resulting path. + + The initial position of the path requested. + The final position of the path requested. + A bitfield mask specifying which NavMesh areas can be passed when calculating a path. + The resulting path. + + True if a either a complete or partial path is found and false otherwise. + + + + + Calculates a path between two positions mapped to the NavMesh, subject to the constraints and costs defined by the filter argument. + + The initial position of the path requested. + The final position of the path requested. + A filter specifying the cost of NavMesh areas that can be passed when calculating a path. + The resulting path. + + True if a either a complete or partial path is found and false otherwise. + + + + + Calculates triangulation of the current navmesh. + + + + + Creates and returns a new entry of NavMesh build settings available for runtime NavMesh building. + + + The created settings. + + + + + Locate the closest NavMesh edge from a point on the NavMesh. + + The origin of the distance query. + Holds the properties of the resulting location. + A bitfield mask specifying which NavMesh areas can be passed when finding the nearest edge. + + True if a nearest edge is found. + + + + + Locate the closest NavMesh edge from a point on the NavMesh, subject to the constraints of the filter argument. + + The origin of the distance query. + Holds the properties of the resulting location. + A filter specifying which NavMesh areas can be passed when finding the nearest edge. + + True if a nearest edge is found. + + + + + Gets the cost for path finding over geometry of the area type. + + Index of the area to get. + + + + Returns the area index for a named NavMesh area type. + + Name of the area to look up. + + Index if the specified are, or -1 if no area found. + + + + + Gets the cost for traversing over geometry of the layer type on all agents. + + + + + + Returns the layer index for a named layer. + + + + + + Returns an existing entry of NavMesh build settings. + + The ID to look for. + + The settings found. + + + + + Returns an existing entry of NavMesh build settings by its ordered index. + + The index to retrieve from. + + The found settings. + + + + + Returns the number of registered NavMesh build settings. + + + The number of registered entries. + + + + + Returns the name associated with the NavMesh build settings matching the provided agent type ID. + + The ID to look for. + + The name associated with the ID found. + + + + + A delegate which can be used to register callback methods to be invoked before the NavMesh system updates. + + + + + Trace a line between two points on the NavMesh. + + The origin of the ray. + The end of the ray. + Holds the properties of the ray cast resulting location. + A bitfield mask specifying which NavMesh areas can be passed when tracing the ray. + + True if the ray is terminated before reaching target position. Otherwise returns false. + + + + + Traces a line between two positions on the NavMesh, subject to the constraints defined by the filter argument. + + The origin of the ray. + The end of the ray. + Holds the properties of the ray cast resulting location. + A filter specifying which NavMesh areas can be passed when tracing the ray. + + True if the ray is terminated before reaching target position. Otherwise returns false. + + + + + Removes all NavMesh surfaces and links from the game. + + + + + Removes a link from the NavMesh. + + The instance of a link to remove. + + + + Removes the specified NavMeshDataInstance from the game, making it unavailable for agents and queries. + + The instance of a NavMesh to remove. + + + + Removes the build settings matching the agent type ID. + + The ID of the entry to remove. + + + + Finds the closest point on NavMesh within specified range. + + The origin of the sample query. + Holds the properties of the resulting location. + Sample within this distance from sourcePosition. + A mask specifying which NavMesh areas are allowed when finding the nearest point. + + True if a nearest point is found. + + + + + Samples the position closest to sourcePosition - on any NavMesh built for the agent type specified by the filter. + + The origin of the sample query. + Holds the properties of the resulting location. + Sample within this distance from sourcePosition. + A filter specifying which NavMesh areas are allowed when finding the nearest point. + + True if a nearest point is found. + + + + + Sets the cost for finding path over geometry of the area type on all agents. + + Index of the area to set. + New cost. + + + + Sets the cost for traversing over geometry of the layer type on all agents. + + + + + + + Navigation mesh agent. + + + + + The maximum acceleration of an agent as it follows a path, given in units / sec^2. + + + + + The type ID for the agent. + + + + + Maximum turning speed in (deg/s) while following a path. + + + + + Specifies which NavMesh areas are passable. Changing areaMask will make the path stale (see isPathStale). + + + + + Should the agent brake automatically to avoid overshooting the destination point? + + + + + Should the agent attempt to acquire a new path if the existing path becomes invalid? + + + + + Should the agent move across OffMeshLinks automatically? + + + + + The avoidance priority level. + + + + + The relative vertical displacement of the owning GameObject. + + + + + The current OffMeshLinkData. + + + + + The desired velocity of the agent including any potential contribution from avoidance. (Read Only) + + + + + Gets or attempts to set the destination of the agent in world-space units. + + + + + Does the agent currently have a path? (Read Only) + + + + + The height of the agent for purposes of passing under obstacles, etc. + + + + + Is the agent currently bound to the navmesh? (Read Only) + + + + + Is the agent currently positioned on an OffMeshLink? (Read Only) + + + + + Is the current path stale. (Read Only) + + + + + This property holds the stop or resume condition of the NavMesh agent. + + + + + Returns the owning object of the NavMesh the agent is currently placed on (Read Only). + + + + + The next OffMeshLinkData on the current path. + + + + + Gets or sets the simulation position of the navmesh agent. + + + + + The level of quality of avoidance. + + + + + Property to get and set the current path. + + + + + Is a path in the process of being computed but not yet ready? (Read Only) + + + + + The status of the current path (complete, partial or invalid). + + + + + The avoidance radius for the agent. + + + + + The distance between the agent's position and the destination on the current path. (Read Only) + + + + + Maximum movement speed when following a path. + + + + + Get the current steering target along the path. (Read Only) + + + + + Stop within this distance from the target position. + + + + + Gets or sets whether the transform position is synchronized with the simulated agent position. The default value is true. + + + + + Should the agent update the transform orientation? + + + + + Allows you to specify whether the agent should be aligned to the up-axis of the NavMesh or link that it is placed on. + + + + + Access the current velocity of the NavMeshAgent component, or set a velocity to control the agent manually. + + + + + Specifies which NavMesh layers are passable (bitfield). Changing walkableMask will make the path stale (see isPathStale). + + + + + Enables or disables the current off-mesh link. + + Is the link activated? + + + + Calculate a path to a specified point and store the resulting path. + + The final position of the path requested. + The resulting path. + + True if a path is found. + + + + + Completes the movement on the current OffMeshLink. + + + + + Locate the closest NavMesh edge. + + Holds the properties of the resulting location. + + True if a nearest edge is found. + + + + + Gets the cost for path calculation when crossing area of a particular type. + + Area Index. + + Current cost for specified area index. + + + + + Gets the cost for crossing ground of a particular type. + + Layer index. + + Current cost of specified layer. + + + + + Apply relative movement to current position. + + The relative movement vector. + + + + Trace a straight path towards a target postion in the NavMesh without moving the agent. + + The desired end position of movement. + Properties of the obstacle detected by the ray (if any). + + True if there is an obstacle between the agent and the target position, otherwise false. + + + + + Clears the current path. + + + + + Resumes the movement along the current path after a pause. + + + + + Sample a position along the current path. + + A bitfield mask specifying which NavMesh areas can be passed when tracing the path. + Terminate scanning the path at this distance. + Holds the properties of the resulting location. + + True if terminated before reaching the position at maxDistance, false otherwise. + + + + + Sets the cost for traversing over areas of the area type. + + Area cost. + New cost for the specified area index. + + + + Sets or updates the destination thus triggering the calculation for a new path. + + The target point to navigate to. + + True if the destination was requested successfully, otherwise false. + + + + + Sets the cost for traversing over geometry of the layer type. + + Layer index. + New cost for the specified layer. + + + + Assign a new path to this agent. + + New path to follow. + + True if the path is succesfully assigned. + + + + + Stop movement of this agent along its current path. + + + + + Warps agent to the provided position. + + New position to warp the agent to. + + True if agent is successfully warped, otherwise false. + + + + + Bitmask used for operating with debug data from the NavMesh build process. + + + + + All debug data from the NavMesh build process is taken into consideration. + + + + + The triangles of all the geometry that is used as a base for computing the new NavMesh. + + + + + No debug data from the NavMesh build process is taken into consideration. + + + + + Meshes of convex polygons constructed within the unified contours of adjacent regions. + + + + + The triangulated meshes with height details that better approximate the source geometry. + + + + + The contours that follow precisely the edges of each surface region. + + + + + The segmentation of the traversable surfaces into smaller areas necessary for producing simple polygons. + + + + + Contours bounding each of the surface regions, described through fewer vertices and straighter edges compared to RawContours. + + + + + The voxels produced by rasterizing the source geometry into walkable and unwalkable areas. + + + + + Specify which of the temporary data generated while building the NavMesh should be retained in memory after the process has completed. + + + + + Specify which types of debug data to collect when building the NavMesh. + + + + + Navigation mesh builder interface. + + + + + Builds a NavMesh data object from the provided input sources. (UnityEngine) + + Settings for the bake process, see NavMeshBuildSettings. + List of input geometry used for baking, they describe the surfaces to walk on or obstacles to avoid. + Bounding box relative to position and rotation which describes the volume where the NavMesh should be built. Empty bounds is treated as no bounds, i.e. the NavMesh will cover all the inputs. + Center of the NavMeshData. This specifies the origin for the NavMesh tiles (See Also: NavMeshBuildSettings.tileSize). + Orientation of the NavMeshData, you can use this to generate NavMesh with an arbitrary up-vector – e.g. for walkable vertical surfaces. + + Returns a newly built NavMeshData, or null if the NavMeshData was empty or an error occurred. +The newly built NavMeshData, or null if the NavMeshData was empty or an error occurred. + + + + + Cancel Navmesh construction. (UnityEditor) See Also: NavMeshBuilder.BuildNavMeshAsync + + + + + Cancels an asynchronous update of the specified NavMesh data. (UnityEngine) See Also: NavMeshBuilder.UpdateNavMeshDataAsync. + + The data associated with asynchronous updating. + + + + Collects renderers or physics colliders, and terrains within a volume. (UnityEngine) + + The queried objects must overlap these bounds to be included in the results. + Specifies which layers are included in the query. + Which type of geometry to collect - e.g. physics colliders. + Area type to assign to results, unless modified by NavMeshMarkup. + List of markups which allows finer control over how objects are collected. + List where results are stored, the list is cleared at the beginning of the call. + + + + Collects renderers or physics colliders, and terrains within a transform hierarchy. (UnityEngine) + + If not null, consider only root and its children in the query; if null, includes everything loaded. + Specifies which layers are included in the query. + Which type of geometry to collect - e.g. physics colliders. + Area type to assign to results, unless modified by NavMeshMarkup. + List of markups which allows finer control over how objects are collected. + List where results are stored, the list is cleared at the beginning of the call. + + + + Incrementally updates the NavMeshData based on the sources. (UnityEngine) + + The NavMeshData to update. + The build settings which is used to update the NavMeshData. The build settings is also hashed along with the data, so changing settings will cause a full rebuild. + List of input geometry used for baking, they describe the surfaces to walk on or obstacles to avoid. + Bounding box relative to position and rotation which describes the volume where the NavMesh should be built. + + Returns true if the update was successful. + + + + + Asynchronously and incrementally updates the NavMeshData based on the sources. (UnityEngine) + + The NavMeshData to update. + The build settings which is used to update the NavMeshData. The build settings is also hashed along with the data, so changing settings will likely to cause full rebuild. + List of input geometry used for baking, they describe the surfaces to walk on or obstacles to avoid. + Bounding box relative to position and rotation which describes to volume where the NavMesh should be built. + + Can be used to check the progress of the update. + + + + + The NavMesh build markup allows you to control how certain objects are treated during the NavMesh build process, specifically when collecting sources for building. + + + + + The area type to use when override area is enabled. + + + + + Use this to specify whether the GameObject and its children should be ignored. + + + + + Use this to specify whether the area type of the GameObject and its children should be overridden by the area type specified in this struct. + + + + + Use this to specify which GameObject (including the GameObject’s children) the markup should be applied to. + + + + + The NavMeshBuildSettings struct allows you to specify a collection of settings which describe the dimensions and limitations of a particular agent type. + + + + + The maximum vertical step size an agent can take. + + + + + The height of the agent for baking in world units. + + + + + The radius of the agent for baking in world units. + + + + + The maximum slope angle which is walkable (angle in degrees). + + + + + The agent type ID the NavMesh will be baked for. + + + + + Options for collecting debug data during the build process. + + + + + The approximate minimum area of individual NavMesh regions. + + + + + Enables overriding the default tile size. See Also: tileSize. + + + + + Enables overriding the default voxel size. See Also: voxelSize. + + + + + Sets the tile size in voxel units. + + + + + Sets the voxel size in world length units. + + + + + Validates the properties of NavMeshBuildSettings. + + Describes the volume to build NavMesh for. + + The list of violated constraints. + + + + + The input to the NavMesh builder is a list of NavMesh build sources. + + + + + Describes the area type of the NavMesh surface for this object. + + + + + Points to the owning component - if available, otherwise null. + + + + + The type of the shape this source describes. See Also: NavMeshBuildSourceShape. + + + + + Describes the dimensions of the shape. + + + + + Describes the object referenced for Mesh and Terrain types of input sources. + + + + + Describes the local to world transformation matrix of the build source. That is, position and orientation and scale of the shape. + + + + + Used with NavMeshBuildSource to define the shape for building NavMesh. + + + + + Describes a box primitive for use with NavMeshBuildSource. + + + + + Describes a capsule primitive for use with NavMeshBuildSource. + + + + + Describes a Mesh source for use with NavMeshBuildSource. + + + + + Describes a ModifierBox source for use with NavMeshBuildSource. + + + + + Describes a sphere primitive for use with NavMeshBuildSource. + + + + + Describes a TerrainData source for use with NavMeshBuildSource. + + + + + Used for specifying the type of geometry to collect. Used with NavMeshBuilder.CollectSources. + + + + + Collect geometry from the 3D physics collision representation. + + + + + Collect meshes form the rendered geometry. + + + + + Contains and represents NavMesh data. + + + + + Gets or sets the world space position of the NavMesh data. + + + + + Gets or sets the orientation of the NavMesh data. + + + + + Returns the bounding volume of the input geometry used to build this NavMesh (Read Only). + + + + + Constructs a new object for representing a NavMesh for the default agent type. + + + + + Constructs a new object representing a NavMesh for the specified agent type. + + The agent type ID to create a NavMesh for. + + + + The instance is returned when adding NavMesh data. + + + + + Get or set the owning Object. + + + + + True if the NavMesh data is added to the navigation system - otherwise false (Read Only). + + + + + Removes this instance from the NavMesh system. + + + + + Result information for NavMesh queries. + + + + + Distance to the point of hit. + + + + + Flag set when hit. + + + + + Mask specifying NavMesh area at point of hit. + + + + + Normal at the point of hit. + + + + + Position of hit. + + + + + Used for runtime manipulation of links connecting polygons of the NavMesh. + + + + + Specifies which agent type this link is available for. + + + + + Area type of the link. + + + + + If true, the link can be traversed in both directions, otherwise only from start to end position. + + + + + If positive, overrides the pathfinder cost to traverse the link. + + + + + End position of the link. + + + + + Start position of the link. + + + + + If positive, the link will be rectangle aligned along the line from start to end. + + + + + An instance representing a link available for pathfinding. + + + + + Get or set the owning Object. + + + + + True if the NavMesh link is added to the navigation system - otherwise false (Read Only). + + + + + Removes this instance from the game. + + + + + An obstacle for NavMeshAgents to avoid. + + + + + Should this obstacle be carved when it is constantly moving? + + + + + Should this obstacle make a cut-out in the navmesh. + + + + + Threshold distance for updating a moving carved hole (when carving is enabled). + + + + + Time to wait until obstacle is treated as stationary (when carving and carveOnlyStationary are enabled). + + + + + The center of the obstacle, measured in the object's local space. + + + + + Height of the obstacle's cylinder shape. + + + + + Radius of the obstacle's capsule shape. + + + + + The shape of the obstacle. + + + + + The size of the obstacle, measured in the object's local space. + + + + + Velocity at which the obstacle moves around the NavMesh. + + + + + Shape of the obstacle. + + + + + Box shaped obstacle. + + + + + Capsule shaped obstacle. + + + + + A path as calculated by the navigation system. + + + + + Corner points of the path. (Read Only) + + + + + Status of the path. (Read Only) + + + + + Erase all corner points from path. + + + + + NavMeshPath constructor. + + + + + Calculate the corners for the path. + + Array to store path corners. + + The number of corners along the path - including start and end points. + + + + + Status of path. + + + + + The path terminates at the destination. + + + + + The path is invalid. + + + + + The path cannot reach the destination. + + + + + Specifies which agent type and areas to consider when searching the NavMesh. + + + + + The agent type ID, specifying which navigation meshes to consider for the query functions. + + + + + A bitmask representing the traversable area types. + + + + + Returns the area cost multiplier for the given area type for this filter. + + Index to retreive the cost for. + + The cost multiplier for the supplied area index. + + + + + Sets the pathfinding cost multiplier for this filter for a given area type. + + The area index to set the cost for. + The cost for the supplied area index. + + + + Contains data describing a triangulation of a navmesh. + + + + + NavMesh area indices for the navmesh triangulation. + + + + + Triangle indices for the navmesh triangulation. + + + + + NavMeshLayer values for the navmesh triangulation. + + + + + Vertices for the navmesh triangulation. + + + + + Level of obstacle avoidance. + + + + + Good avoidance. High performance impact. + + + + + Enable highest precision. Highest performance impact. + + + + + Enable simple avoidance. Low performance impact. + + + + + Medium avoidance. Medium performance impact. + + + + + Disable avoidance. + + + + + Link allowing movement outside the planar navigation mesh. + + + + + Is link active. + + + + + NavMesh area index for this OffMeshLink component. + + + + + Automatically update endpoints. + + + + + Can link be traversed in both directions. + + + + + Modify pathfinding cost for the link. + + + + + The transform representing link end position. + + + + + NavMeshLayer for this OffMeshLink component. + + + + + Is link occupied. (Read Only) + + + + + The transform representing link start position. + + + + + Explicitly update the link endpoints. + + + + + State of OffMeshLink. + + + + + Is link active (Read Only). + + + + + Link end world position (Read Only). + + + + + Link type specifier (Read Only). + + + + + The OffMeshLink if the link type is a manually placed Offmeshlink (Read Only). + + + + + Link start world position (Read Only). + + + + + Is link valid (Read Only). + + + + + Link type specifier. + + + + + Vertical drop. + + + + + Horizontal jump. + + + + + Manually specified type of link. + + + + + Unity Analytics provides insight into your game users e.g. DAU, MAU. + + + + + Controls whether the sending of device stats at runtime is enabled. + + + + + Controls whether the Analytics service is enabled at runtime. + + + + + Reports whether Unity is set to initialize Analytics on startup. + + + + + Controls whether to limit user tracking at runtime. + + + + + Reports whether the player has opted out of data collection. + + + + + Custom Events (optional). + + Name of custom event. Name cannot include the prefix "unity." - This is a reserved keyword. + Additional parameters sent to Unity Analytics at the time the custom event was triggered. Dictionary key cannot include the prefix "unity." - This is a reserved keyword. + + + + Custom Events (optional). + + + + + + Custom Events (optional). + + + + + + + Attempts to flush immediately all queued analytics events to the network and filesystem cache if possible (optional). + + + + + This API is used for registering a Runtime Analytics event. It is meant for internal use only and is likely to change in the future. User code should never use this API. + + Name of the event. + Hourly limit for this event name. + Maximum number of items in this event. + Vendor key name. + Optional event name prefix value. + Event version number. + + + + This API is used for registering a Runtime Analytics event. It is meant for internal use only and is likely to change in the future. User code should never use this API. + + Name of the event. + Hourly limit for this event name. + Maximum number of items in this event. + Vendor key name. + Optional event name prefix value. + Event version number. + + + + Resume Analytics initialization. + + + + + This API is used to send a Runtime Analytics event. It is meant for internal use only and is likely to change in the future. User code should never use this API. + + Name of the event. + Event version number. + Optional event name prefix value. + Additional event data. + + + + User Demographics (optional). + + Birth year of user. Must be 4-digit year format, only. + + + + User Demographics (optional). + + Gender of user can be "Female", "Male", or "Unknown". + + + + User Demographics (optional). + + User id. + + + + Tracking Monetization (optional). + + The id of the purchased item. + The price of the item. + Abbreviation of the currency used for the transaction. For example “USD” (United States Dollars). See http:en.wikipedia.orgwikiISO_4217 for a standardized list of currency abbreviations. + Receipt data (iOS) receipt ID (android) for in-app purchases to verify purchases with Apple iTunes / Google Play. Use null in the absence of receipts. + Android receipt signature. If using native Android use the INAPP_DATA_SIGNATURE string containing the signature of the purchase data that was signed with the private key of the developer. The data signature uses the RSASSA-PKCS1-v1_5 scheme. Pass in null in absence of a signature. + Set to true when using UnityIAP. + + + + Tracking Monetization (optional). + + The id of the purchased item. + The price of the item. + Abbreviation of the currency used for the transaction. For example “USD” (United States Dollars). See http:en.wikipedia.orgwikiISO_4217 for a standardized list of currency abbreviations. + Receipt data (iOS) receipt ID (android) for in-app purchases to verify purchases with Apple iTunes / Google Play. Use null in the absence of receipts. + Android receipt signature. If using native Android use the INAPP_DATA_SIGNATURE string containing the signature of the purchase data that was signed with the private key of the developer. The data signature uses the RSASSA-PKCS1-v1_5 scheme. Pass in null in absence of a signature. + Set to true when using UnityIAP. + + + + Tracking Monetization (optional). + + The id of the purchased item. + The price of the item. + Abbreviation of the currency used for the transaction. For example “USD” (United States Dollars). See http:en.wikipedia.orgwikiISO_4217 for a standardized list of currency abbreviations. + Receipt data (iOS) receipt ID (android) for in-app purchases to verify purchases with Apple iTunes / Google Play. Use null in the absence of receipts. + Android receipt signature. If using native Android use the INAPP_DATA_SIGNATURE string containing the signature of the purchase data that was signed with the private key of the developer. The data signature uses the RSASSA-PKCS1-v1_5 scheme. Pass in null in absence of a signature. + Set to true when using UnityIAP. + + + + Analytics API result. + + + + + Analytics API result: Analytics is disabled. + + + + + Analytics API result: Invalid argument value. + + + + + Analytics API result: Analytics not initialized. + + + + + Analytics API result: Success. + + + + + Analytics API result: Argument size limit. + + + + + Analytics API result: Too many parameters. + + + + + Analytics API result: Too many requests. + + + + + Analytics API result: This platform doesn't support Analytics. + + + + + Provides access to the Analytics session information for the current game instance. + + + + + The number of sessions played since the app was installed. + + + + + The time elapsed, in milliseconds, since the beginning of the current game session. + + + + + Reports whether the current session is the first session since the player installed the game or application. + + + + + A random, unique GUID identifying the current game or app session. + + + + + The current state of the session. + + + + + Dispatched when the Analytics session state changes. + + + + + + A random GUID uniquely identifying sessions played on the same instance of your game or app. + + + + + Dispatched when the Analytics session state changes. + + Current session state. + Current session id. + Length of the current session in milliseconds. + True, if the sessionId has changed; otherwise false. + + + + Session tracking states. + + + + + Session tracking has paused. + + + + + Session tracking has resumed. + + + + + Session tracking has started. + + + + + Session tracking has stopped. + + + + + User Demographics: Gender of a user. + + + + + User Demographics: Female Gender of a user. + + + + + User Demographics: Male Gender of a user. + + + + + User Demographics: Unknown Gender of a user. + + + + + Unity Performace provides insight into your game performace. + + + + + Controls whether the Performance Reporting service is enabled at runtime. + + + + + Time taken to initialize graphics in microseconds, measured from application startup. + + + + + Parent class for all joints that have anchor points. + + + + + The joint's anchor point on the object that has the joint component. + + + + + Should the connectedAnchor be calculated automatically? + + + + + The joint's anchor point on the second object (ie, the one which doesn't have the joint component). + + + + + Structure describing a permission that requires user authorization. + + + + + Used when requesting permission or checking if permission has been granted to use the camera. + + + + + Used when requesting permission or checking if permission has been granted to use the users location with coarse granularity. + + + + + Used when requesting permission or checking if permission has been granted to read from external storage such as a SD card. + + + + + Used when requesting permission or checking if permission has been granted to write to external storage such as a SD card. + + + + + Used when requesting permission or checking if permission has been granted to use the users location with high precision. + + + + + Check if the user has granted access to a device resource or information that requires authorization. + + A string representing the permission to request. For permissions which Unity has not predefined you may also manually provide the constant value obtained from the Android documentation here: https:developer.android.comguidetopicspermissionsoverview#permission-groups such as "android.permission.READ_CONTACTS". + + Whether the requested permission has been granted. + + + + + Used when requesting permission or checking if permission has been granted to use the microphone. + + + + + Request that the user grant access to a device resource or information that requires authorization. + + A string that describes the permission to request. For permissions which Unity has not predefined you may also manually provide the constant value obtained from the Android documentation here: https:developer.android.comguidetopicspermissionsoverview#permission-groups such as "android.permission.READ_CONTACTS". + + + + ActivityIndicator Style (Android Specific). + + + + + Do not show ActivityIndicator. + + + + + Large Inversed (android.R.attr.progressBarStyleLargeInverse). + + + + + Small Inversed (android.R.attr.progressBarStyleSmallInverse). + + + + + Large (android.R.attr.progressBarStyleLarge). + + + + + Small (android.R.attr.progressBarStyleSmall). + + + + + AndroidInput provides support for off-screen touch input, such as a touchpad. + + + + + Property indicating whether the system provides secondary touch input. + + + + + Property indicating the height of the secondary touchpad. + + + + + Property indicating the width of the secondary touchpad. + + + + + Number of secondary touches. Guaranteed not to change throughout the frame. (Read Only). + + + + + Returns object representing status of a specific touch on a secondary touchpad (Does not allocate temporary variables). + + + + + + AndroidJavaClass is the Unity representation of a generic instance of java.lang.Class. + + + + + Construct an AndroidJavaClass from the class name. + + Specifies the Java class name (e.g. <tt>java.lang.String</tt>). + + + + AndroidJavaObject is the Unity representation of a generic instance of java.lang.Object. + + + + + Calls a Java method on an object (non-static). + + Specifies which method to call. + An array of parameters passed to the method. + + + + Call a Java method on an object. + + Specifies which method to call. + An array of parameters passed to the method. + + + + Call a static Java method on a class. + + Specifies which method to call. + An array of parameters passed to the method. + + + + Call a static Java method on a class. + + Specifies which method to call. + An array of parameters passed to the method. + + + + Construct an AndroidJavaObject based on the name of the class. + + Specifies the Java class name (e.g. "<tt>java.lang.String<tt>" or "<tt>javalangString<tt>"). + An array of parameters passed to the constructor. + + + + IDisposable callback. + + + + + Get the value of a field in an object (non-static). + + The name of the field (e.g. int counter; would have fieldName = "counter"). + + + + Retrieves the raw <tt>jclass</tt> pointer to the Java class. + +Note: Using raw JNI functions requires advanced knowledge of the Android Java Native Interface (JNI). Please take note. + + + + + Retrieves the raw <tt>jobject</tt> pointer to the Java object. + +Note: Using raw JNI functions requires advanced knowledge of the Android Java Native Interface (JNI). Please take note. + + + + + Get the value of a static field in an object type. + + The name of the field (e.g. <i>int counter;</i> would have fieldName = "counter"). + + + + Set the value of a field in an object (non-static). + + The name of the field (e.g. int counter; would have fieldName = "counter"). + The value to assign to the field. It has to match the field type. + + + + Set the value of a static field in an object type. + + The name of the field (e.g. int counter; would have fieldName = "counter"). + The value to assign to the field. It has to match the field type. + + + + This class can be used to implement any java interface. Any java vm method invocation matching the interface on the proxy object will automatically be passed to the c# implementation. + + + + + The equivalent of the java.lang.Object equals() method. + + + + Returns true when the objects are equal and false if otherwise. + + + + + The equivalent of the java.lang.Object hashCode() method. + + + Returns the hash code of the java proxy object. + + + + + Java interface implemented by the proxy. + + + + + The equivalent of the java.lang.Object toString() method. + + + Returns C# class name + " <c# proxy java object>". + + + + + + + Java interface to be implemented by the proxy. + + + + + + Java interface to be implemented by the proxy. + + + + Called by the java vm whenever a method is invoked on the java proxy interface. You can override this to run special code on method invokation, or you can leave the implementation as is, and leave the default behavior which is to look for c# methods matching the signature of the java method. + + Name of the invoked java method. + Arguments passed from the java vm - converted into AndroidJavaObject, AndroidJavaClass or a primitive. + Arguments passed from the java vm - all objects are represented by AndroidJavaObject, int for instance is represented by a java.lang.Integer object. + + + + Called by the java vm whenever a method is invoked on the java proxy interface. You can override this to run special code on method invokation, or you can leave the implementation as is, and leave the default behavior which is to look for c# methods matching the signature of the java method. + + Name of the invoked java method. + Arguments passed from the java vm - converted into AndroidJavaObject, AndroidJavaClass or a primitive. + Arguments passed from the java vm - all objects are represented by AndroidJavaObject, int for instance is represented by a java.lang.Integer object. + + + + AndroidJavaRunnable is the Unity representation of a java.lang.Runnable object. + + + + + 'Raw' JNI interface to Android Dalvik (Java) VM from Mono (CS/JS). + +Note: Using raw JNI functions requires advanced knowledge of the Android Java Native Interface (JNI). Please take note. + + + + + Allocates a new Java object without invoking any of the constructors for the object. + + + + + + Attaches the current thread to a Java (Dalvik) VM. + + + + + Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + + + + + + Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + + + + + + Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + + + + + + Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + + + + + + Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + + + + + + Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + + + + + + Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + + + + + + Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + + + + + + Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + + + + + + Invokes a static method on a Java object, according to the specified <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + + + + + + Invokes a static method on a Java object, according to the specified <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + + + + + + Invokes a static method on a Java object, according to the specified <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + + + + + + Invokes a static method on a Java object, according to the specified <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + + + + + + Invokes a static method on a Java object, according to the specified <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + + + + + + Invokes a static method on a Java object, according to the specified <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + + + + + + Invokes a static method on a Java object, according to the specified <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + + + + + + Invokes a static method on a Java object, according to the specified <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + + + + + + Invokes a static method on a Java object, according to the specified <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + + + + + + Invokes a static method on a Java object, according to the specified <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + + + + + + Invokes a static method on a Java object, according to the specified <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + + + + + + Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + + + + + + Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + + + + + + Deletes the global reference pointed to by <tt>obj</tt>. + + + + + + Deletes the local reference pointed to by <tt>obj</tt>. + + + + + + Detaches the current thread from a Java (Dalvik) VM. + + + + + Ensures that at least a given number of local references can be created in the current thread. + + + + + + Clears any exception that is currently being thrown. + + + + + Prints an exception and a backtrace of the stack to the <tt>logcat</tt> + + + + + Determines if an exception is being thrown. + + + + + Raises a fatal error and does not expect the VM to recover. This function does not return. + + + + + + This function loads a locally-defined class. + + + + + + Convert a Java array of <tt>boolean</tt> to a managed array of System.Boolean. + + + + + + Convert a Java array of <tt>byte</tt> to a managed array of System.Byte. + + + + + + Convert a Java array of <tt>char</tt> to a managed array of System.Char. + + + + + + Convert a Java array of <tt>double</tt> to a managed array of System.Double. + + + + + + Convert a Java array of <tt>float</tt> to a managed array of System.Single. + + + + + + Convert a Java array of <tt>int</tt> to a managed array of System.Int32. + + + + + + Convert a Java array of <tt>long</tt> to a managed array of System.Int64. + + + + + + Convert a Java array of <tt>java.lang.Object</tt> to a managed array of System.IntPtr, representing Java objects. + + + + + + Converts a <tt>java.lang.reflect.Field</tt> to a field ID. + + + + + + Converts a <tt>java.lang.reflect.Method<tt> or <tt>java.lang.reflect.Constructor<tt> object to a method ID. + + + + + + Convert a Java array of <tt>short</tt> to a managed array of System.Int16. + + + + + + Returns the number of elements in the array. + + + + + + Returns the value of one element of a primitive array. + + + + + + + This function returns the value of an instance (nonstatic) field of an object. + + + + + + + Returns the value of one element of a primitive array. + + + + + + + This function returns the value of an instance (nonstatic) field of an object. + + + + + + + Returns the value of one element of a primitive array. + + + + + + + This function returns the value of an instance (nonstatic) field of an object. + + + + + + + Returns the value of one element of a primitive array. + + + + + + + This function returns the value of an instance (nonstatic) field of an object. + + + + + + + Returns the field ID for an instance (nonstatic) field of a class. + + + + + + + + Returns the value of one element of a primitive array. + + + + + + + This function returns the value of an instance (nonstatic) field of an object. + + + + + + + Returns the value of one element of a primitive array. + + + + + + + This function returns the value of an instance (nonstatic) field of an object. + + + + + + + Returns the value of one element of a primitive array. + + + + + + + This function returns the value of an instance (nonstatic) field of an object. + + + + + + + Returns the method ID for an instance (nonstatic) method of a class or interface. + + + + + + + + Returns an element of an <tt>Object</tt> array. + + + + + + + Returns the class of an object. + + + + + + This function returns the value of an instance (nonstatic) field of an object. + + + + + + + Returns the value of one element of a primitive array. + + + + + + + This function returns the value of an instance (nonstatic) field of an object. + + + + + + + This function returns the value of a static field of an object. + + + + + + + This function returns the value of a static field of an object. + + + + + + + This function returns the value of a static field of an object. + + + + + + + This function returns the value of a static field of an object. + + + + + + + Returns the field ID for a static field of a class. + + + + + + + + This function returns the value of a static field of an object. + + + + + + + This function returns the value of a static field of an object. + + + + + + + This function returns the value of a static field of an object. + + + + + + + Returns the method ID for a static method of a class. + + + + + + + + This function returns the value of a static field of an object. + + + + + + + This function returns the value of a static field of an object. + + + + + + + This function returns the value of a static field of an object. + + + + + + + This function returns the value of an instance (nonstatic) field of an object. + + + + + + + Returns a managed string object representing the string in modified UTF-8 encoding. + + + + + + Returns the length in bytes of the modified UTF-8 representation of a string. + + + + + + If <tt>clazz<tt> represents any class other than the class <tt>Object<tt>, then this function returns the object that represents the superclass of the class specified by <tt>clazz</tt>. + + + + + + Returns the version of the native method interface. + + + + + Determines whether an object of <tt>clazz1<tt> can be safely cast to <tt>clazz2<tt>. + + + + + + + Tests whether an object is an instance of a class. + + + + + + + Tests whether two references refer to the same Java object. + + + + + + + Construct a new primitive array object. + + + + + + Construct a new primitive array object. + + + + + + Construct a new primitive array object. + + + + + + Construct a new primitive array object. + + + + + + Construct a new primitive array object. + + + + + + Creates a new global reference to the object referred to by the <tt>obj</tt> argument. + + + + + + Construct a new primitive array object. + + + + + + Creates a new local reference that refers to the same object as <tt>obj</tt>. + + + + + + Construct a new primitive array object. + + + + + + Constructs a new Java object. The method ID indicates which constructor method to invoke. This ID must be obtained by calling GetMethodID() with <init> as the method name and void (V) as the return type. + + + + + + + + Constructs a new array holding objects in class <tt>clazz<tt>. All elements are initially set to <tt>obj<tt>. + + + + + + + + Construct a new primitive array object. + + + + + + Constructs a new <tt>java.lang.String</tt> object from an array of characters in modified UTF-8 encoding. + + + + + + Pops off the current local reference frame, frees all the local references, and returns a local reference in the previous local reference frame for the given <tt>result</tt> object. + + + + + + Creates a new local reference frame, in which at least a given number of local references can be created. + + + + + + Sets the value of one element in a primitive array. + + The array of native booleans. + Index of the array element to set. + The value to set - for 'true' use 1, for 'false' use 0. + + + + This function sets the value of an instance (nonstatic) field of an object. + + + + + + + + Sets the value of one element in a primitive array. + + + + + + + + This function sets the value of an instance (nonstatic) field of an object. + + + + + + + + Sets the value of one element in a primitive array. + + + + + + + + This function sets the value of an instance (nonstatic) field of an object. + + + + + + + + Sets the value of one element in a primitive array. + + + + + + + + This function sets the value of an instance (nonstatic) field of an object. + + + + + + + + Sets the value of one element in a primitive array. + + + + + + + + This function sets the value of an instance (nonstatic) field of an object. + + + + + + + + Sets the value of one element in a primitive array. + + + + + + + + This function sets the value of an instance (nonstatic) field of an object. + + + + + + + + Sets the value of one element in a primitive array. + + + + + + + + This function sets the value of an instance (nonstatic) field of an object. + + + + + + + + Sets an element of an <tt>Object</tt> array. + + + + + + + + This function sets the value of an instance (nonstatic) field of an object. + + + + + + + + Sets the value of one element in a primitive array. + + + + + + + + This function sets the value of an instance (nonstatic) field of an object. + + + + + + + + This function ets the value of a static field of an object. + + + + + + + + This function ets the value of a static field of an object. + + + + + + + + This function ets the value of a static field of an object. + + + + + + + + This function ets the value of a static field of an object. + + + + + + + + This function ets the value of a static field of an object. + + + + + + + + This function ets the value of a static field of an object. + + + + + + + + This function ets the value of a static field of an object. + + + + + + + + This function ets the value of a static field of an object. + + + + + + + + This function ets the value of a static field of an object. + + + + + + + + This function ets the value of a static field of an object. + + + + + + + + This function sets the value of an instance (nonstatic) field of an object. + + + + + + + + Causes a <tt>java.lang.Throwable</tt> object to be thrown. + + + + + + Constructs an exception object from the specified class with the <tt>message</tt> specified by message and causes that exception to be thrown. + + + + + + + Convert a managed array of System.Boolean to a Java array of <tt>boolean</tt>. + + + + + + Convert a managed array of System.Byte to a Java array of <tt>byte</tt>. + + + + + + Convert a managed array of System.Char to a Java array of <tt>char</tt>. + + + + + + Convert a managed array of System.Double to a Java array of <tt>double</tt>. + + + + + + Convert a managed array of System.Single to a Java array of <tt>float</tt>. + + + + + + Convert a managed array of System.Int32 to a Java array of <tt>int</tt>. + + + + + + Convert a managed array of System.Int64 to a Java array of <tt>long</tt>. + + + + + + Convert a managed array of System.IntPtr, representing Java objects, to a Java array of <tt>java.lang.Object</tt>. + + + + + + Converts a field ID derived from cls to a <tt>java.lang.reflect.Field</tt> object. + + + + + + + + Converts a method ID derived from clazz to a <tt>java.lang.reflect.Method<tt> or <tt>java.lang.reflect.Constructor<tt> object. + + + + + + + + Convert a managed array of System.Int16 to a Java array of <tt>short</tt>. + + + + + + Helper interface for JNI interaction; signature creation and method lookups. + +Note: Using raw JNI functions requires advanced knowledge of the Android Java Native Interface (JNI). Please take note. + + + + + Set debug to true to log calls through the AndroidJNIHelper. + + + + + Creates a managed array from a Java array. + + Java array object to be converted into a managed array. + + + + Creates a Java array from a managed array. + + Managed array to be converted into a Java array object. + + + + Creates a java proxy object which connects to the supplied proxy implementation. + + An implementatinon of a java interface in c#. + + + + Creates a UnityJavaRunnable object (implements java.lang.Runnable). + + A delegate representing the java.lang.Runnable. + + + + + Creates the parameter array to be used as argument list when invoking Java code through CallMethod() in AndroidJNI. + + An array of objects that should be converted to Call parameters. + + + + Deletes any local jni references previously allocated by CreateJNIArgArray(). + + The array of arguments used as a parameter to CreateJNIArgArray(). + The array returned by CreateJNIArgArray(). + + + + Scans a particular Java class for a constructor method matching a signature. + + Raw JNI Java class object (obtained by calling AndroidJNI.FindClass). + Constructor method signature (e.g. obtained by calling AndroidJNIHelper.GetSignature). + + + + Scans a particular Java class for a constructor method matching a signature. + + Raw JNI Java class object (obtained by calling AndroidJNI.FindClass). + Constructor method signature (e.g. obtained by calling AndroidJNIHelper.GetSignature). + + + + Get a JNI method ID for a constructor based on calling arguments. + + Raw JNI Java class object (obtained by calling AndroidJNI.FindClass). + Array with parameters to be passed to the constructor when invoked. + + + + + Scans a particular Java class for a field matching a name and a signature. + + Raw JNI Java class object (obtained by calling AndroidJNI.FindClass). + Name of the field as declared in Java. + Field signature (e.g. obtained by calling AndroidJNIHelper.GetSignature). + Set to <tt>true<tt> for static fields; <tt>false<tt> for instance (nonstatic) fields. + + + + Scans a particular Java class for a field matching a name and a signature. + + Raw JNI Java class object (obtained by calling AndroidJNI.FindClass). + Name of the field as declared in Java. + Field signature (e.g. obtained by calling AndroidJNIHelper.GetSignature). + Set to <tt>true<tt> for static fields; <tt>false<tt> for instance (nonstatic) fields. + + + + Scans a particular Java class for a field matching a name and a signature. + + Raw JNI Java class object (obtained by calling AndroidJNI.FindClass). + Name of the field as declared in Java. + Field signature (e.g. obtained by calling AndroidJNIHelper.GetSignature). + Set to <tt>true<tt> for static fields; <tt>false<tt> for instance (nonstatic) fields. + + + + Get a JNI field ID based on type detection. Generic parameter represents the field type. + + Raw JNI Java class object (obtained by calling AndroidJNI.FindClass). + Name of the field as declared in Java. + Set to <tt>true<tt> for static fields; <tt>false<tt> for instance (nonstatic) fields. + + + + + Scans a particular Java class for a method matching a name and a signature. + + Raw JNI Java class object (obtained by calling AndroidJNI.FindClass). + Name of the method as declared in Java. + Method signature (e.g. obtained by calling AndroidJNIHelper.GetSignature). + Set to <tt>true<tt> for static methods; <tt>false<tt> for instance (nonstatic) methods. + + + + Scans a particular Java class for a method matching a name and a signature. + + Raw JNI Java class object (obtained by calling AndroidJNI.FindClass). + Name of the method as declared in Java. + Method signature (e.g. obtained by calling AndroidJNIHelper.GetSignature). + Set to <tt>true<tt> for static methods; <tt>false<tt> for instance (nonstatic) methods. + + + + Scans a particular Java class for a method matching a name and a signature. + + Raw JNI Java class object (obtained by calling AndroidJNI.FindClass). + Name of the method as declared in Java. + Method signature (e.g. obtained by calling AndroidJNIHelper.GetSignature). + Set to <tt>true<tt> for static methods; <tt>false<tt> for instance (nonstatic) methods. + + + + Get a JNI method ID based on calling arguments. + + Raw JNI Java class object (obtained by calling AndroidJNI.FindClass). + Name of the method as declared in Java. + Array with parameters to be passed to the method when invoked. + Set to <tt>true<tt> for static methods; <tt>false<tt> for instance (nonstatic) methods. + + + + + Get a JNI method ID based on calling arguments. + + Raw JNI Java class object (obtained by calling AndroidJNI.FindClass). + Name of the method as declared in Java. + Array with parameters to be passed to the method when invoked. + Set to <tt>true<tt> for static methods; <tt>false<tt> for instance (nonstatic) methods. + + + + + Creates the JNI signature string for particular object type. + + Object for which a signature is to be produced. + + + + Creates the JNI signature string for an object parameter list. + + Array of object for which a signature is to be produced. + + + + Creates the JNI signature string for an object parameter list. + + Array of object for which a signature is to be produced. + + + + The animation component is used to play back animations. + + + + + When turned on, Unity might stop animating if it thinks that the results of the animation won't be visible to the user. + + + + + When turned on, animations will be executed in the physics loop. This is only useful in conjunction with kinematic rigidbodies. + + + + + The default animation. + + + + + Controls culling of this Animation component. + + + + + Is an animation currently being played? + + + + + AABB of this Animation animation component in local space. + + + + + Should the default animation clip (the Animation.clip property) automatically start playing on startup? + + + + + How should time beyond the playback range of the clip be treated? + + + + + Adds a clip to the animation with name newName. + + + + + + + Adds clip to the only play between firstFrame and lastFrame. The new clip will also be added to the animation with name newName. + + Should an extra frame be inserted at the end that matches the first frame? Turn this on if you are making a looping animation. + + + + + + + + Adds clip to the only play between firstFrame and lastFrame. The new clip will also be added to the animation with name newName. + + Should an extra frame be inserted at the end that matches the first frame? Turn this on if you are making a looping animation. + + + + + + + + Blends the animation named animation towards targetWeight over the next time seconds. + + + + + + + + Blends the animation named animation towards targetWeight over the next time seconds. + + + + + + + + Blends the animation named animation towards targetWeight over the next time seconds. + + + + + + + + Fades the animation with name animation in over a period of time seconds and fades other animations out. + + + + + + + + Fades the animation with name animation in over a period of time seconds and fades other animations out. + + + + + + + + Fades the animation with name animation in over a period of time seconds and fades other animations out. + + + + + + + + Cross fades an animation after previous animations has finished playing. + + + + + + + + + Cross fades an animation after previous animations has finished playing. + + + + + + + + + Cross fades an animation after previous animations has finished playing. + + + + + + + + + Cross fades an animation after previous animations has finished playing. + + + + + + + + + Get the number of clips currently assigned to this animation. + + + + + Is the animation named name playing? + + + + + + Plays an animation without blending. + + + + + + + Plays an animation without blending. + + + + + + + Plays an animation without blending. + + + + + + + Plays an animation without blending. + + + + + + + Plays an animation after previous animations has finished playing. + + + + + + + + Plays an animation after previous animations has finished playing. + + + + + + + + Plays an animation after previous animations has finished playing. + + + + + + + + Remove clip from the animation list. + + + + + + Remove clip from the animation list. + + + + + + Rewinds the animation named name. + + + + + + Rewinds all animations. + + + + + Samples animations at the current state. + + + + + Stops all playing animations that were started with this Animation. + + + + + Stops an animation named name. + + + + + + Returns the animation state named name. + + + + + Used by Animation.Play function. + + + + + Animations will be added. + + + + + Animations will be blended. + + + + + Stores keyframe based animations. + + + + + Returns true if the animation clip has no curves and no events. + + + + + Animation Events for this animation clip. + + + + + Frame rate at which keyframes are sampled. (Read Only) + + + + + Returns true if the Animation has animation on the root transform. + + + + + Returns true if the AnimationClip has root motion curves. + + + + + Returns true if the AnimationClip has editor curves for its root motion. + + + + + Returns true if the AnimationClip has root Curves. + + + + + Returns true if the animation contains curve that drives a humanoid rig. + + + + + Set to true if the AnimationClip will be used with the Legacy Animation component ( instead of the Animator ). + + + + + Animation length in seconds. (Read Only) + + + + + AABB of this Animation Clip in local space of Animation component that it is attached too. + + + + + Sets the default wrap mode used in the animation state. + + + + + Adds an animation event to the clip. + + AnimationEvent to add. + + + + Clears all curves from the clip. + + + + + Creates a new animation clip. + + + + + Realigns quaternion keys to ensure shortest interpolation paths. + + + + + Samples an animation at a given time for any animated properties. + + The animated game object. + The time to sample an animation. + + + + Assigns the curve to animate a specific property. + + Path to the game object this curve applies to. The relativePath + is formatted similar to a pathname, e.g. "rootspineleftArm". If relativePath + is empty it refers to the game object the animation clip is attached to. + The class type of the component that is animated. + The name or path to the property being animated. + The animation curve. + + + + This class defines a pair of clips used by AnimatorOverrideController. + + + + + The original clip from the controller. + + + + + The override animation clip. + + + + + This enum controlls culling of Animation component. + + + + + Animation culling is disabled - object is animated even when offscreen. + + + + + Animation is disabled when renderers are not visible. + + + + + Store a collection of Keyframes that can be evaluated over time. + + + + + All keys defined in the animation curve. + + + + + The number of keys in the curve. (Read Only) + + + + + The behaviour of the animation after the last keyframe. + + + + + The behaviour of the animation before the first keyframe. + + + + + Add a new key to the curve. + + The time at which to add the key (horizontal axis in the curve graph). + The value for the key (vertical axis in the curve graph). + + The index of the added key, or -1 if the key could not be added. + + + + + Add a new key to the curve. + + The key to add to the curve. + + The index of the added key, or -1 if the key could not be added. + + + + + Creates a constant "curve" starting at timeStart, ending at timeEnd and with the value value. + + The start time for the constant curve. + The start time for the constant curve. + The value for the constant curve. + + The constant curve created from the specified values. + + + + + Creates an animation curve from an arbitrary number of keyframes. + + An array of Keyframes used to define the curve. + + + + Creates an empty animation curve. + + + + + Creates an ease-in and out curve starting at timeStart, valueStart and ending at timeEnd, valueEnd. + + The start time for the ease curve. + The start value for the ease curve. + The end time for the ease curve. + The end value for the ease curve. + + The ease-in and out curve generated from the specified values. + + + + + Evaluate the curve at time. + + The time within the curve you want to evaluate (the horizontal axis in the curve graph). + + The value of the curve, at the point in time specified. + + + + + A straight Line starting at timeStart, valueStart and ending at timeEnd, valueEnd. + + The start time for the linear curve. + The start value for the linear curve. + The end time for the linear curve. + The end value for the linear curve. + + The linear curve created from the specified values. + + + + + Removes the keyframe at index and inserts key. + + The index of the key to move. + The key (with its new time) to insert. + + The index of the keyframe after moving it. + + + + + Removes a key. + + The index of the key to remove. + + + + Smooth the in and out tangents of the keyframe at index. + + The index of the keyframe to be smoothed. + The smoothing weight to apply to the keyframe's tangents. + + + + Retrieves the key at index. (Read Only) + + + + + AnimationEvent lets you call a script function similar to SendMessage as part of playing back an animation. + + + + + The animation state that fired this event (Read Only). + + + + + The animator clip info related to this event (Read Only). + + + + + The animator state info related to this event (Read Only). + + + + + Float parameter that is stored in the event and will be sent to the function. + + + + + The name of the function that will be called. + + + + + Int parameter that is stored in the event and will be sent to the function. + + + + + Returns true if this Animation event has been fired by an Animator component. + + + + + Returns true if this Animation event has been fired by an Animation component. + + + + + Function call options. + + + + + Object reference parameter that is stored in the event and will be sent to the function. + + + + + String parameter that is stored in the event and will be sent to the function. + + + + + The time at which the event will be fired off. + + + + + Creates a new animation event. + + + + + Information about what animation clips is played and its weight. + + + + + Animation clip that is played. + + + + + The weight of the animation clip. + + + + + Constrains the orientation of an object relative to the position of one or more source objects, such that the object is facing the average position of the sources. + + + + + The axis towards which the constrained object orients. + + + + + Activates or deactivates the constraint. + + + + + Locks the offset and rotation at rest. + + + + + The rotation used when the sources have a total weight of 0. + + + + + The axes affected by the AimConstraint. + + + + + Represents an offset from the constrained orientation. + + + + + The number of sources set on the component (read-only). + + + + + The up vector. + + + + + The weight of the constraint component. + + + + + The world up object, used to calculate the world up vector when the world up Type is AimConstraint.WorldUpType.ObjectUp or AimConstraint.WorldUpType.ObjectRotationUp. + + + + + The type of the world up vector. + + + + + The world up Vector used when the world up type is AimConstraint.WorldUpType.Vector or AimConstraint.WorldUpType.ObjectRotationUp. + + + + + Adds a constraint source. + + The source object and its weight. + + Returns the index of the added source. + + + + + Gets a constraint source by index. + + The index of the source. + + The source object and its weight. + + + + + Gets the list of sources. + + The list of sources to be filled by the component. + + + + Removes a source from the component. + + The index of the source to remove. + + + + Sets a source at a specified index. + + The index of the source to set. + The source object and its weight. + + + + Sets the list of sources on the component. + + The list of sources to set. + + + + Specifies how the world up vector used by the aim constraint is defined. + + + + + Neither defines nor uses a world up vector. + + + + + Uses and defines the world up vector as relative to the local space of the object. + + + + + Uses and defines the world up vector as a vector from the constrained object, in the direction of the up object. + + + + + Uses and defines the world up vector as the Unity Scene up vector (the Y axis). + + + + + Uses and defines the world up vector as a vector specified by the user. + + + + + A Playable that controls an AnimationClip. + + + + + Creates an AnimationClipPlayable in the PlayableGraph. + + The PlayableGraph object that will own the AnimationClipPlayable. + The AnimationClip that will be added in the PlayableGraph. + + A AnimationClipPlayable linked to the PlayableGraph. + + + + + Returns the AnimationClip stored in the AnimationClipPlayable. + + + + + Returns the state of the ApplyFootIK flag. + + + + + Returns the state of the ApplyPlayableIK flag. + + + + + Sets the value of the ApplyFootIK flag. + + The new value of the ApplyFootIK flag. + + + + Requests OnAnimatorIK to be called on the animated GameObject. + + + + + + An implementation of IPlayable that controls an animation layer mixer. + + + + + Creates an AnimationLayerMixerPlayable in the PlayableGraph. + + The PlayableGraph that will contain the new AnimationLayerMixerPlayable. + The number of layers. + + A new AnimationLayerMixerPlayable linked to the PlayableGraph. + + + + + Returns true if the layer is additive, false otherwise. + + The layer index. + + True if the layer is additive, false otherwise. + + + + + Returns an invalid AnimationLayerMixerPlayable. + + + + + Specifies whether a layer is additive or not. Additive layers blend with previous layers. + + The layer index. + Whether the layer is additive or not. Set to true for an additive blend, or false for a regular blend. + + + + Sets the mask for the current layer. + + The layer index. + The AvatarMask used to create the new LayerMask. + + + + An implementation of IPlayable that controls an animation mixer. + + + + + Creates an AnimationMixerPlayable in the PlayableGraph. + + The PlayableGraph that will contain the new AnimationMixerPlayable. + The number of inputs that the mixer will update. + True to force a weight normalization of the inputs. + + A new AnimationMixerPlayable linked to the PlayableGraph. + + + + + Returns an invalid AnimationMixerPlayable. + + + + + A PlayableBinding that contains information representing an AnimationPlayableOutput. + + + + + Creates a PlayableBinding that contains information representing an AnimationPlayableOutput. + + The name of the AnimationPlayableOutput. + A reference to a UnityEngine.Object that acts as a key for this binding. + + Returns a PlayableBinding that contains information that is used to create an AnimationPlayableOutput. + + + + + A IPlayableOutput implementation that connects the PlayableGraph to an Animator in the Scene. + + + + + Creates an AnimationPlayableOutput in the PlayableGraph. + + The PlayableGraph that will contain the AnimationPlayableOutput. + The name of the output. + The Animator that will process the PlayableGraph. + + A new AnimationPlayableOutput attached to the PlayableGraph. + + + + + Returns the Animator that plays the animation graph. + + + The targeted Animator. + + + + + Sets the Animator that plays the animation graph. + + The targeted Animator. + + + + An implementation of IPlayable that controls an animation RuntimeAnimatorController. + + + + + Creates an AnimatorControllerPlayable in the PlayableGraph. + + The PlayableGraph object that will own the AnimatorControllerPlayable. + The RuntimeAnimatorController that will be added in the graph. + + A AnimatorControllerPlayable. + + + + + Returns an invalid AnimatorControllerPlayable. + + + + + Represents the axes used in 3D space. + + + + + Represents the case when no axis is specified. + + + + + Represents the X axis. + + + + + Represents the Y axis. + + + + + Represents the Z axis. + + + + + Represents a source for the constraint. + + + + + The transform component of the source object. + + + + + The weight of the source in the evaluation of the constraint. + + + + + The common interface for constraint components. + + + + + Activate or deactivate the constraint. + + + + + Lock or unlock the offset and position at rest. + + + + + Gets the number of sources currently set on the component. + + + + + The weight of the constraint component. + + + + + Add a constraint source. + + The source object and its weight. + + Returns the index of the added source. + + + + + Gets a constraint source by index. + + The index of the source. + + The source object and its weight. + + + + + Gets the list of sources. + + The list of sources to be filled by the component. + + + + Removes a source from the component. + + The index of the source to remove. + + + + Sets a source at a specified index. + + The index of the source to set. + The source object and its weight. + + + + Sets the list of sources on the component. + + The list of sources to set. + + + + + Constrains the orientation of an object relative to the position of one or more source objects, such that the object is facing the average position of the sources. + The LookAtConstraint is a simplified Animations.AimConstraint typically used with a Camera. + + + + + + Activates or deactivates the constraint. + + + + + Locks the offset and rotation at rest. + + + + + The rotation angle along the z axis of the object. The constraint uses this property to calculate the world up vector when Animations.LookAtConstraint.UseUpObject is false. + + + + + The rotation used when the sources have a total weight of 0. + + + + + Represents an offset from the constrained orientation. + + + + + The number of sources set on the component (Read Only). + + + + + Determines how the up vector is calculated. + + + + + The weight of the constraint component. + + + + + The world up object, used to calculate the world up vector when Animations.LookAtConstraint.UseUpObject is true. + + + + + Adds a constraint source. + + The source object and its weight. + + Returns the index of the added source. + + + + + Gets a constraint source by index. + + The index of the source. + + Returns the source object and its weight. + + + + + Gets the list of sources. + + The list of sources to be filled by the component. + + + + Removes a source from the component. + + The index of the source to remove. + + + + Sets a source at a specified index. + + The index of the source to set. + The source object and its weight. + + + + Sets the list of sources on the component. + + The list of sources to set. + + + + Constrains the orientation and translation of an object to one or more source objects. The constrained object behaves as if it is in the hierarchy of the sources. + + + + + Activates or deactivates the constraint. + + + + + Locks the offsets and position (translation and rotation) at rest. + + + + + The rotation used when the sources have a total weight of 0. + + + + + The rotation axes affected by the ParentConstraint. + + + + + The rotation offsets from the constrained orientation. + + + + + The number of sources set on the component (read-only). + + + + + The position of the object in local space, used when the sources have a total weight of 0. + + + + + The translation axes affected by the ParentConstraint. + + + + + The translation offsets from the constrained orientation. + + + + + The weight of the constraint component. + + + + + Adds a constraint source. + + The source object and its weight. + + Returns the index of the added source. + + + + + Gets the rotation offset associated with a source by index. + + The index of the constraint source. + + The rotation offset, as Euler angles. + + + + + Gets a constraint source by index. + + The index of the source. + + The source object and its weight. + + + + + Gets the list of sources. + + The list of sources filled by the component. + + + + Gets the rotation offset associated with a source by index. + + The index of the constraint source. + + The translation offset. + + + + + Removes a source from the component. + + The index of the source to remove. + + + + Sets the rotation offset associated with a source by index. + + The index of the constraint source. + The new rotation offset. + + + + Sets a source at a specified index. + + The index of the source to set. + The source object and its weight. + + + + Sets the list of sources on the component. + + The list of sources to set. + + + + Sets the translation offset associated with a source by index. + + The index of the constraint source. + The new translation offset. + + + + Constrains the position of an object relative to the position of one or more source objects. + + + + + Activates or deactivates the constraint. + + + + + Locks the offset and position at rest. + + + + + The number of sources set on the component (read-only). + + + + + The translation used when the sources have a total weight of 0. + + + + + The axes affected by the PositionConstraint. + + + + + The offset from the constrained position. + + + + + The weight of the constraint component. + + + + + Adds a constraint source. + + The source object and its weight. + + Returns the index of the added source. + + + + + Gets a constraint source by index. + + The index of the source. + + The source object and its weight. + + + + + Gets the list of sources. + + The list of sources to be filled by the component. + + + + Removes a source from the component. + + The index of the source to remove. + + + + Sets a source at a specified index. + + The index of the source to set. + The source object and its weight. + + + + Sets the list of sources on the component. + + The list of sources to set. + + + + Constrains the rotation of an object relative to the rotation of one or more source objects. + + + + + Activates or deactivates the constraint. + + + + + Locks the offset and rotation at rest. + + + + + The rotation used when the sources have a total weight of 0. + + + + + The axes affected by the RotationConstraint. + + + + + The offset from the constrained rotation. + + + + + The number of sources set on the component (read-only). + + + + + The weight of the constraint component. + + + + + Adds a constraint source. + + The source object and its weight. + + Returns the index of the added source. + + + + + Gets a constraint source by index. + + The index of the source. + + The source object and its weight. + + + + + Gets the list of sources. + + The list of sources to be filled by the component. + + + + Removes a source from the component. + + The index of the source to remove. + + + + Sets a source at a specified index. + + The index of the source to set. + The source object and its weight. + + + + Sets the list of sources on the component. + + The list of sources to set. + + + + Constrains the scale of an object relative to the scale of one or more source objects. + + + + + Activates or deactivates the constraint. + + + + + Locks the offset and scale at rest. + + + + + The scale used when the sources have a total weight of 0. + + + + + The offset from the constrained scale. + + + + + The axes affected by the ScaleConstraint. + + + + + The number of sources set on the component (read-only). + + + + + The weight of the constraint component. + + + + + Adds a constraint source. + + The source object and its weight. + + Returns the index of the added source. + + + + + Gets a constraint source by index. + + The index of the source. + + The source object and its weight. + + + + + Gets the list of sources. + + The list of sources to be filled by the component. + + + + Removes a source from the component. + + The index of the source to remove. + + + + Sets a source at a specified index. + + The index of the source to set. + The source object and its weight. + + + + Sets the list of sources on the component. + + The list of sources to set. + + + + The AnimationState gives full control over animation blending. + + + + + Which blend mode should be used? + + + + + The clip that is being played by this animation state. + + + + + Enables / disables the animation. + + + + + The length of the animation clip in seconds. + + + + + The name of the animation. + + + + + The normalized playback speed. + + + + + The normalized time of the animation. + + + + + The playback speed of the animation. 1 is normal playback speed. + + + + + The current time of the animation. + + + + + The weight of animation. + + + + + Wrapping mode of the animation. + + + + + Adds a transform which should be animated. This allows you to reduce the number of animations you have to create. + + The transform to animate. + Whether to also animate all children of the specified transform. + + + + Adds a transform which should be animated. This allows you to reduce the number of animations you have to create. + + The transform to animate. + Whether to also animate all children of the specified transform. + + + + Removes a transform which should be animated. + + + + + + Interface to control the Mecanim animation system. + + + + + Gets the avatar angular velocity for the last evaluated frame. + + + + + When turned on, animations will be executed in the physics loop. This is only useful in conjunction with kinematic rigidbodies. + + + + + Should root motion be applied? + + + + + Gets/Sets the current Avatar. + + + + + The position of the body center of mass. + + + + + The rotation of the body center of mass. + + + + + Controls culling of this Animator component. + + + + + Gets the avatar delta position for the last evaluated frame. + + + + + Gets the avatar delta rotation for the last evaluated frame. + + + + + Blends pivot point between body center of mass and feet pivot. + + + + + Sets whether the Animator sends events of type AnimationEvent. + + + + + The current gravity weight based on current animations that are played. + + + + + Returns true if Animator has any playables assigned to it. + + + + + Returns true if the current rig has root motion. + + + + + Returns true if the object has a transform hierarchy. + + + + + Returns the scale of the current Avatar for a humanoid rig, (1 by default if the rig is generic). + + + + + Returns true if the current rig is humanoid, false if it is generic. + + + + + Returns whether the animator is initialized successfully. + + + + + If automatic matching is active. + + + + + Returns true if the current rig is optimizable with AnimatorUtility.OptimizeTransformHierarchy. + + + + + Controls the behaviour of the Animator component when a GameObject is disabled. + + + + + Returns the number of layers in the controller. + + + + + Additional layers affects the center of mass. + + + + + Get left foot bottom height. + + + + + When linearVelocityBlending is set to true, the root motion velocity and angular velocity will be blended linearly. + + + + + Returns the number of parameters in the controller. + + + + + The AnimatorControllerParameter list used by the animator. (Read Only) + + + + + Get the current position of the pivot. + + + + + Gets the pivot weight. + + + + + The PlayableGraph created by the Animator. + + + + + Sets the playback position in the recording buffer. + + + + + Gets the mode of the Animator recorder. + + + + + Start time of the first frame of the buffer relative to the frame at which StartRecording was called. + + + + + End time of the recorded clip relative to when StartRecording was called. + + + + + Get right foot bottom height. + + + + + The root position, the position of the game object. + + + + + The root rotation, the rotation of the game object. + + + + + The runtime representation of AnimatorController that controls the Animator. + + + + + The playback speed of the Animator. 1 is normal playback speed. + + + + + Automatic stabilization of feet during transition and blending. + + + + + Returns the position of the target specified by SetTarget. + + + + + Returns the rotation of the target specified by SetTarget. + + + + + Specifies the update mode of the Animator. + + + + + Gets the avatar velocity for the last evaluated frame. + + + + + Apply the default Root Motion. + + + + + Creates a crossfade from the current state to any other state using normalized times. + + The name of the state. + The hash name of the state. + The duration of the transition (normalized). + The layer where the crossfade occurs. + The time of the state (normalized). + The time of the transition (normalized). + + + + Creates a crossfade from the current state to any other state using normalized times. + + The name of the state. + The hash name of the state. + The duration of the transition (normalized). + The layer where the crossfade occurs. + The time of the state (normalized). + The time of the transition (normalized). + + + + Creates a crossfade from the current state to any other state using times in seconds. + + The name of the state. + The hash name of the state. + The duration of the transition (in seconds). + The layer where the crossfade occurs. + The time of the state (in seconds). + The time of the transition (normalized). + + + + Creates a crossfade from the current state to any other state using times in seconds. + + The name of the state. + The hash name of the state. + The duration of the transition (in seconds). + The layer where the crossfade occurs. + The time of the state (in seconds). + The time of the transition (normalized). + + + + Returns an AnimatorTransitionInfo with the informations on the current transition. + + The layer's index. + + An AnimatorTransitionInfo with the informations on the current transition. + + + + + Returns the first StateMachineBehaviour that matches type T or is derived from T. Returns null if none are found. + + + + + Returns all StateMachineBehaviour that match type T or are derived from T. Returns null if none are found. + + + + + Returns Transform mapped to this human bone id. + + The human bone that is queried, see enum HumanBodyBones for a list of possible values. + + + + Returns the value of the given boolean parameter. + + The parameter name. + The parameter ID. + + The value of the parameter. + + + + + Returns the value of the given boolean parameter. + + The parameter name. + The parameter ID. + + The value of the parameter. + + + + + Gets the list of AnimatorClipInfo currently played by the current state. + + The layer's index. + + + + Returns an array of all the AnimatorClipInfo in the current state of the given layer. + + The layer index. + + An array of all the AnimatorClipInfo in the current state. + + + + + Fills clips with the list of all the AnimatorClipInfo in the current state of the given layer. + + The layer index. + The list of AnimatorClipInfo to fill. + + + + Returns the number of AnimatorClipInfo in the current state. + + The layer index. + + The number of AnimatorClipInfo in the current state. + + + + + Returns an AnimatorStateInfo with the information on the current state. + + The layer index. + + An AnimatorStateInfo with the information on the current state. + + + + + Returns the value of the given float parameter. + + The parameter name. + The parameter ID. + + The value of the parameter. + + + + + Returns the value of the given float parameter. + + The parameter name. + The parameter ID. + + The value of the parameter. + + + + + Gets the position of an IK hint. + + The AvatarIKHint that is queried. + + Return the current position of this IK hint in world space. + + + + + Gets the translative weight of an IK Hint (0 = at the original animation before IK, 1 = at the hint). + + The AvatarIKHint that is queried. + + Return translative weight. + + + + + Gets the position of an IK goal. + + The AvatarIKGoal that is queried. + + Return the current position of this IK goal in world space. + + + + + Gets the translative weight of an IK goal (0 = at the original animation before IK, 1 = at the goal). + + The AvatarIKGoal that is queried. + + + + Gets the rotation of an IK goal. + + The AvatarIKGoal that is is queried. + + + + Gets the rotational weight of an IK goal (0 = rotation before IK, 1 = rotation at the IK goal). + + The AvatarIKGoal that is queried. + + + + Returns the value of the given integer parameter. + + The parameter name. + The parameter ID. + + The value of the parameter. + + + + + Returns the value of the given integer parameter. + + The parameter name. + The parameter ID. + + The value of the parameter. + + + + + Returns the index of the layer with the given name. + + The layer name. + + The layer index. + + + + + Returns the layer name. + + The layer index. + + The layer name. + + + + + Returns the weight of the layer at the specified index. + + The layer index. + + The layer weight. + + + + + Gets the list of AnimatorClipInfo currently played by the next state. + + The layer's index. + + + + Returns an array of all the AnimatorClipInfo in the next state of the given layer. + + The layer index. + + An array of all the AnimatorClipInfo in the next state. + + + + + Fills clips with the list of all the AnimatorClipInfo in the next state of the given layer. + + The layer index. + The list of AnimatorClipInfo to fill. + + + + Returns the number of AnimatorClipInfo in the next state. + + The layer index. + + The number of AnimatorClipInfo in the next state. + + + + + Returns an AnimatorStateInfo with the information on the next state. + + The layer index. + + An AnimatorStateInfo with the information on the next state. + + + + + See AnimatorController.parameters. + + + + + + Gets the value of a quaternion parameter. + + The name of the parameter. + + + + Gets the value of a quaternion parameter. + + The id of the parameter. The id is generated using Animator::StringToHash. + + + + Gets the value of a vector parameter. + + The name of the parameter. + + + + Gets the value of a vector parameter. + + The id of the parameter. The id is generated using Animator::StringToHash. + + + + Returns true if the state exists in this layer, false otherwise. + + The layer index. + The state ID. + + True if the state exists in this layer, false otherwise. + + + + + Interrupts the automatic target matching. + + + + + + Interrupts the automatic target matching. + + + + + + Returns true if the transform is controlled by the Animator\. + + The transform that is queried. + + + + Returns true if there is a transition on the given layer, false otherwise. + + The layer index. + + True if there is a transition on the given layer, false otherwise. + + + + + Returns true if the parameter is controlled by a curve, false otherwise. + + The parameter name. + The parameter ID. + + True if the parameter is controlled by a curve, false otherwise. + + + + + Returns true if the parameter is controlled by a curve, false otherwise. + + The parameter name. + The parameter ID. + + True if the parameter is controlled by a curve, false otherwise. + + + + + Automatically adjust the GameObject position and rotation. + + The position we want the body part to reach. + The rotation in which we want the body part to be. + The body part that is involved in the match. + Structure that contains weights for matching position and rotation. + Start time within the animation clip (0 - beginning of clip, 1 - end of clip). + End time within the animation clip (0 - beginning of clip, 1 - end of clip), values greater than 1 can be set to trigger a match after a certain number of loops. Ex: 2.3 means at 30% of 2nd loop. + + + + Plays a state. + + The state name. + The state hash name. If stateNameHash is 0, it changes the current state time. + The layer index. If layer is -1, it plays the first state with the given state name or hash. + The time offset between zero and one. + + + + Plays a state. + + The state name. + The state hash name. If stateNameHash is 0, it changes the current state time. + The layer index. If layer is -1, it plays the first state with the given state name or hash. + The time offset between zero and one. + + + + Plays a state. + + The state name. + The state hash name. If stateNameHash is 0, it changes the current state time. + The layer index. If layer is -1, it plays the first state with the given state name or hash. + The time offset (in seconds). + + + + Plays a state. + + The state name. + The state hash name. If stateNameHash is 0, it changes the current state time. + The layer index. If layer is -1, it plays the first state with the given state name or hash. + The time offset (in seconds). + + + + Rebind all the animated properties and mesh data with the Animator. + + + + + Resets the value of the given trigger parameter. + + The parameter name. + The parameter ID. + + + + Resets the value of the given trigger parameter. + + The parameter name. + The parameter ID. + + + + Sets local rotation of a human bone during a IK pass. + + The human bone Id. + The local rotation. + + + + Sets the value of the given boolean parameter. + + The parameter name. + The parameter ID. + The new parameter value. + + + + Sets the value of the given boolean parameter. + + The parameter name. + The parameter ID. + The new parameter value. + + + + Send float values to the Animator to affect transitions. + + The parameter name. + The parameter ID. + The new parameter value. + The damper total time. + The delta time to give to the damper. + + + + Send float values to the Animator to affect transitions. + + The parameter name. + The parameter ID. + The new parameter value. + The damper total time. + The delta time to give to the damper. + + + + Send float values to the Animator to affect transitions. + + The parameter name. + The parameter ID. + The new parameter value. + The damper total time. + The delta time to give to the damper. + + + + Send float values to the Animator to affect transitions. + + The parameter name. + The parameter ID. + The new parameter value. + The damper total time. + The delta time to give to the damper. + + + + Sets the position of an IK hint. + + The AvatarIKHint that is set. + The position in world space. + + + + Sets the translative weight of an IK hint (0 = at the original animation before IK, 1 = at the hint). + + The AvatarIKHint that is set. + The translative weight. + + + + Sets the position of an IK goal. + + The AvatarIKGoal that is set. + The position in world space. + + + + Sets the translative weight of an IK goal (0 = at the original animation before IK, 1 = at the goal). + + The AvatarIKGoal that is set. + The translative weight. + + + + Sets the rotation of an IK goal. + + The AvatarIKGoal that is set. + The rotation in world space. + + + + Sets the rotational weight of an IK goal (0 = rotation before IK, 1 = rotation at the IK goal). + + The AvatarIKGoal that is set. + The rotational weight. + + + + Sets the value of the given integer parameter. + + The parameter name. + The parameter ID. + The new parameter value. + + + + Sets the value of the given integer parameter. + + The parameter name. + The parameter ID. + The new parameter value. + + + + Sets the weight of the layer at the given index. + + The layer index. + The new layer weight. + + + + Sets the look at position. + + The position to lookAt. + + + + Set look at weights. + + (0-1) the global weight of the LookAt, multiplier for other parameters. + (0-1) determines how much the body is involved in the LookAt. + (0-1) determines how much the head is involved in the LookAt. + (0-1) determines how much the eyes are involved in the LookAt. + (0-1) 0.0 means the character is completely unrestrained in motion, 1.0 means he's completely clamped (look at becomes impossible), and 0.5 means he'll be able to move on half of the possible range (180 degrees). + + + + Set look at weights. + + (0-1) the global weight of the LookAt, multiplier for other parameters. + (0-1) determines how much the body is involved in the LookAt. + (0-1) determines how much the head is involved in the LookAt. + (0-1) determines how much the eyes are involved in the LookAt. + (0-1) 0.0 means the character is completely unrestrained in motion, 1.0 means he's completely clamped (look at becomes impossible), and 0.5 means he'll be able to move on half of the possible range (180 degrees). + + + + Set look at weights. + + (0-1) the global weight of the LookAt, multiplier for other parameters. + (0-1) determines how much the body is involved in the LookAt. + (0-1) determines how much the head is involved in the LookAt. + (0-1) determines how much the eyes are involved in the LookAt. + (0-1) 0.0 means the character is completely unrestrained in motion, 1.0 means he's completely clamped (look at becomes impossible), and 0.5 means he'll be able to move on half of the possible range (180 degrees). + + + + Set look at weights. + + (0-1) the global weight of the LookAt, multiplier for other parameters. + (0-1) determines how much the body is involved in the LookAt. + (0-1) determines how much the head is involved in the LookAt. + (0-1) determines how much the eyes are involved in the LookAt. + (0-1) 0.0 means the character is completely unrestrained in motion, 1.0 means he's completely clamped (look at becomes impossible), and 0.5 means he'll be able to move on half of the possible range (180 degrees). + + + + Set look at weights. + + (0-1) the global weight of the LookAt, multiplier for other parameters. + (0-1) determines how much the body is involved in the LookAt. + (0-1) determines how much the head is involved in the LookAt. + (0-1) determines how much the eyes are involved in the LookAt. + (0-1) 0.0 means the character is completely unrestrained in motion, 1.0 means he's completely clamped (look at becomes impossible), and 0.5 means he'll be able to move on half of the possible range (180 degrees). + + + + Sets the value of a quaternion parameter. + + The name of the parameter. + The new value for the parameter. + + + + Sets the value of a quaternion parameter. + + Of the parameter. The id is generated using Animator::StringToHash. + The new value for the parameter. + + + + Sets an AvatarTarget and a targetNormalizedTime for the current state. + + The avatar body part that is queried. + The current state Time that is queried. + + + + Sets the value of the given trigger parameter. + + The parameter name. + The parameter ID. + + + + Sets the value of the given trigger parameter. + + The parameter name. + The parameter ID. + + + + Sets the value of a vector parameter. + + The name of the parameter. + The new value for the parameter. + + + + Sets the value of a vector parameter. + + The id of the parameter. The id is generated using Animator::StringToHash. + The new value for the parameter. + + + + Sets the animator in playback mode. + + + + + Sets the animator in recording mode, and allocates a circular buffer of size frameCount. + + The number of frames (updates) that will be recorded. If frameCount is 0, the recording will continue until the user calls StopRecording. The maximum value for frameCount is 10000. + + + + Stops the animator playback mode. When playback stops, the avatar resumes getting control from game logic. + + + + + Stops animator record mode. + + + + + Generates an parameter id from a string. + + The string to convert to Id. + + + + Evaluates the animator based on deltaTime. + + The time delta. + + + + Forces a write of the default values stored in the animator. + + + + + Information about clip being played and blended by the Animator. + + + + + Returns the animation clip played by the Animator. + + + + + Returns the blending weight used by the Animator to blend this clip. + + + + + Used to communicate between scripting and the controller. Some parameters can be set in scripting and used by the controller, while other parameters are based on Custom Curves in Animation Clips and can be sampled using the scripting API. + + + + + The default bool value for the parameter. + + + + + The default float value for the parameter. + + + + + The default int value for the parameter. + + + + + The name of the parameter. + + + + + Returns the hash of the parameter based on its name. + + + + + The type of the parameter. + + + + + The type of the parameter. + + + + + Boolean type parameter. + + + + + Float type parameter. + + + + + Int type parameter. + + + + + Trigger type parameter. + + + + + Culling mode for the Animator. + + + + + Always animate the entire character. Object is animated even when offscreen. + + + + + Animation is completely disabled when renderers are not visible. + + + + + Retarget, IK and write of Transforms are disabled when renderers are not visible. + + + + + Interface to control Animator Override Controller. + + + + + Returns the list of orignal Animation Clip from the controller and their override Animation Clip. + + + + + Returns the count of overrides. + + + + + The Runtime Animator Controller that the Animator Override Controller overrides. + + + + + Applies the list of overrides on this Animator Override Controller. + + Overrides list to apply. + + + + Creates an empty Animator Override Controller. + + + + + Creates an Animator Override Controller that overrides controller. + + Runtime Animator Controller to override. + + + + Gets the list of Animation Clip overrides currently defined in this Animator Override Controller. + + Array to receive results. + + + + Returns either the overriding Animation Clip if set or the original Animation Clip named name. + + + + + Returns either the overriding Animation Clip if set or the original Animation Clip named name. + + + + + The mode of the Animator's recorder. + + + + + The Animator recorder is offline. + + + + + The Animator recorder is in Playback. + + + + + The Animator recorder is in Record. + + + + + Information about the current or next state. + + + + + The full path hash for this state. + + + + + Current duration of the state. + + + + + Is the state looping. + + + + + The hashed name of the State. + + + + + Normalized time of the State. + + + + + The hash is generated using Animator.StringToHash. The hash does not include the name of the parent layer. + + + + + The playback speed of the animation. 1 is the normal playback speed. + + + + + The speed multiplier for this state. + + + + + The Tag of the State. + + + + + Does name match the name of the active state in the statemachine? + + + + + + Does tag match the tag of the active state in the statemachine. + + + + + + Information about the current transition. + + + + + Returns true if the transition is from an AnyState node, or from Animator.CrossFade. + + + + + Duration of the transition. + + + + + The unit of the transition duration. + + + + + The hash name of the Transition. + + + + + The simplified name of the Transition. + + + + + Normalized time of the Transition. + + + + + The user-specified name of the Transition. + + + + + Does name match the name of the active Transition. + + + + + + Does userName match the name of the active Transition. + + + + + + The update mode of the Animator. + + + + + Updates the animator during the physic loop in order to have the animation system synchronized with the physics engine. + + + + + Normal update of the animator. + + + + + Animator updates independently of Time.timeScale. + + + + + Various utilities for animator manipulation. + + + + + This function will recreate all transform hierarchy under GameObject. + + GameObject to Deoptimize. + + + + This function will remove all transform hierarchy under GameObject, the animator will write directly transform matrices into the skin mesh matrices saving alot of CPU cycles. + + GameObject to Optimize. + List of transform name to expose. + + + + Anisotropic filtering mode. + + + + + Disable anisotropic filtering for all textures. + + + + + Enable anisotropic filtering, as set for each texture. + + + + + Enable anisotropic filtering for all textures. + + + + + ReplayKit is only available on certain iPhone, iPad and iPod Touch devices running iOS 9.0 or later. + + + + + A Boolean that indicates whether ReplayKit broadcasting API is available (true means available) (Read Only). +Check the value of this property before making ReplayKit broadcasting API calls. On iOS versions prior to iOS 10, this property will have a value of false. + + + + + A string property that contains an URL used to redirect the user to an on-going or completed broadcast (Read Only). + + + + + Camera enabled status, true, if camera enabled, false otherwise. + + + + + Boolean property that indicates whether a broadcast is currently in progress (Read Only). + + + + + A boolean that indicates whether ReplayKit is making a recording (where True means a recording is in progress). (Read Only) + + + + + A string value of the last error incurred by the ReplayKit: Either 'Failed to get Screen Recorder' or 'No recording available'. (Read Only) + + + + + Microphone enabled status, true, if microhone enabled, false otherwise. + + + + + A boolean value that indicates that a new recording is available for preview (where True means available). (Read Only) + + + + + A boolean that indicates whether the ReplayKit API is available (where True means available). (Read Only) + + + + + Function called at the completion of broadcast startup. + + This parameter will be true if the broadcast started successfully and false in the event of an error. + In the event of failure to start a broadcast, this parameter contains the associated error message. + + + + Discard the current recording. + + + A boolean value of True if the recording was discarded successfully or False if an error occurred. + + + + + Hide the camera preview view. + + + + + Preview the current recording + + + A boolean value of True if the video preview window opened successfully or False if an error occurred. + + + + + Shows camera preview at coordinates posX and posY. + + + + + + + Initiates and starts a new broadcast +When StartBroadcast is called, user is presented with a broadcast provider selection screen, and then a broadcast setup screen. Once it is finished, a broadcast will be started, and the callback will be invoked. +It will also be invoked in case of any error. + + + A callback for getting the status of broadcast initiation. + Enable or disable the microphone while broadcasting. Enabling the microphone allows you to include user commentary while broadcasting. The default value is false. + Enable or disable the camera while broadcasting. Enabling camera allows you to include user camera footage while broadcasting. The default value is false. To actually include camera footage in your broadcast, you also have to call ShowCameraPreviewAt as well to position the preview view. + + + + Start a new recording. + + Enable or disable the microphone while making a recording. Enabling the microphone allows you to include user commentary while recording. The default value is false. + Enable or disable the camera while making a recording. Enabling camera allows you to include user camera footage while recording. The default value is false. To actually include camera footage in your recording, you also have to call ShowCameraPreviewAt as well to position the preview view. + + A boolean value of True if recording started successfully or False if an error occurred. + + + + + Stops current broadcast. +Will terminate currently on-going broadcast. If no broadcast is in progress, does nothing. + + + + + Stop the current recording. + + + A boolean value of True if recording stopped successfully or False if an error occurred. + + + + + Access to application run-time data. + + + + + The URL of the document (what is shown in a browser's address bar) for WebGL (Read Only). + + + + + Priority of background loading thread. + + + + + Returns a GUID for this build (Read Only). + + + + + A unique cloud project identifier. It is unique for every project (Read Only). + + + + + Return application company name (Read Only). + + + + + Returns the path to the console log file, or an empty string if the current platform does not support log files. + + + + + Contains the path to the game data folder (Read Only). + + + + + Delegate method used to register for when focus is either gained or lost. + +The passed in value is the new focus state of the application. In the editor, this corresponds to whether the game view has focus (regardless of whether the editor is in play mode or not). +This is called at the same time as MonoBehaviour.OnApplicationFocus. + + + + + + Returns false if application is altered in any way after it was built. + + + + + Returns true if application integrity can be confirmed. + + + + + Returns application identifier at runtime. On Apple platforms this is the 'bundleIdentifier' saved in the info.plist file, on Android it's the 'package' from the AndroidManifest.xml. + + + + + Returns the name of the store or package that installed the application (Read Only). + + + + + Returns application install mode (Read Only). + + + + + Returns the type of Internet reachability currently possible on the device. + + + + + Returns true when Unity is launched with the -batchmode flag from the command line (Read Only). + + + + + Is the current Runtime platform a known console platform. + + + + + Are we running inside the Unity editor? (Read Only) + + + + + Whether the player currently has focus. Read-only. + + + + + Is some level being loaded? (Read Only) (Obsolete). + + + + + Is the current Runtime platform a known mobile platform. + + + + + Returns true when called in any kind of built Player, or when called in the Editor in Play Mode (Read Only). + + + + + Checks whether splash screen is being shown. + + + + + The total number of levels available (Read Only). + + + + + Note: This is now obsolete. Use SceneManager.GetActiveScene instead. (Read Only). + + + + + The name of the level that was last loaded (Read Only). + + + + + Event that is fired if a log message is received. + + + + + + Event that is fired if a log message is received. + + + + + + This event occurs when an iOS or Android device notifies of low memory while the app is running in the foreground. You can release non-critical assets from memory (such as, textures or audio clips) in response to this in order to avoid the app being terminated. You can also load smaller versions of such assets. Furthermore, you should serialize any transient data to permanent storage to avoid data loss if the app is terminated. + +This event corresponds to the following callbacks on the different platforms: + +- iOS: [UIApplicationDelegate applicationDidReceiveMemoryWarning] + +- Android: onLowMemory() and onTrimMemory(level == TRIM_MEMORY_RUNNING_CRITICAL) + +Here is an example of handling the callback: + + + + + + Delegate method used to register for "Just Before Render" input updates for VR devices. + + + + + + Contains the path to a persistent data directory (Read Only). + + + + + Returns the platform the game is running on (Read Only). + + + + + Returns application product name (Read Only). + + + + + Unity raises this event when the player application is qutting. + + + + + + Should the player be running when the application is in the background? + + + + + Returns application running in sandbox (Read Only). + + + + + Obsolete. Use Application.SetStackTraceLogType. + + + + + How many bytes have we downloaded from the main unity web stream (Read Only). + + + + + The path to the StreamingAssets folder (Read Only). + + + + + The language the user's operating system is running in. + + + + + Instructs game to try to render at a specified frame rate. + + + + + Contains the path to a temporary data / cache directory (Read Only). + + + + + The version of the Unity runtime used to play the content. + + + + + Returns application version number (Read Only). + + + + + Unity raises this event when the player application wants to quit. + + + + + + Indicates whether Unity's webplayer security model is enabled. + + + + + Delegate method for fetching advertising ID. + + Advertising ID. + Indicates whether user has chosen to limit ad tracking. + Error message. + + + + Cancels quitting the application. This is useful for showing a splash screen at the end of a game. + + + + + Can the streamed level be loaded? + + + + + + Can the streamed level be loaded? + + + + + + Captures a screenshot at path filename as a PNG file. + + Pathname to save the screenshot file to. + Factor by which to increase resolution. + + + + Captures a screenshot at path filename as a PNG file. + + Pathname to save the screenshot file to. + Factor by which to increase resolution. + + + + Calls a function in the web page that contains the WebGL Player. + + Name of the function to call. + Array of arguments passed in the call. + + + + Execution of a script function in the contained web page. + + The Javascript function to call. + + + + Returns an array of feature tags in use for this build. + + + + + Get stack trace logging options. The default value is StackTraceLogType.ScriptOnly. + + + + + + How far has the download progressed? [0...1]. + + + + + + How far has the download progressed? [0...1]. + + + + + + Is Unity activated with the Pro license? + + + + + Check if the user has authorized use of the webcam or microphone in the Web Player. + + + + + + Returns true if the given object is part of the playing world either in any kind of built Player or in Play Mode. + + The object to test. + + True if the object is part of the playing world. + + + + + Note: This is now obsolete. Use SceneManager.LoadScene instead. + + The level to load. + The name of the level to load. + + + + Note: This is now obsolete. Use SceneManager.LoadScene instead. + + The level to load. + The name of the level to load. + + + + Loads a level additively. + + + + + + + Loads a level additively. + + + + + + + Loads the level additively and asynchronously in the background. + + + + + + + Loads the level additively and asynchronously in the background. + + + + + + + Loads the level asynchronously in the background. + + + + + + + Loads the level asynchronously in the background. + + + + + + + Use this delegate type with Application.logMessageReceived or Application.logMessageReceivedThreaded to monitor what gets logged. + + + + + + + + This is the delegate function when a mobile device notifies of low memory. + + + + + Opens the url in a browser. + + + + + + Quits the player application. + + An optional exit code to return when the player application terminates on Windows, Mac and Linux. Defaults to 0. + + + + Request advertising ID for iOS, Android and Windows Store. + + Delegate method. + + Returns true if successful, or false for platforms which do not support Advertising Identifiers. In this case, the delegate method is not invoked. + + + + + Request authorization to use the webcam or microphone on iOS. + + + + + + Set an array of feature tags for this build. + + + + + + Set stack trace logging options. The default value is StackTraceLogType.ScriptOnly. + + + + + + + Unloads the Unity runtime. + + + + + Unloads all GameObject associated with the given Scene. Note that assets are currently not unloaded, in order to free up asset memory call Resources.UnloadAllUnusedAssets. + + Index of the Scene in the PlayerSettings to unload. + Name of the Scene to Unload. + + Return true if the Scene is unloaded. + + + + + Unloads all GameObject associated with the given Scene. Note that assets are currently not unloaded, in order to free up asset memory call Resources.UnloadAllUnusedAssets. + + Index of the Scene in the PlayerSettings to unload. + Name of the Scene to Unload. + + Return true if the Scene is unloaded. + + + + + Application installation mode (Read Only). + + + + + Application installed via ad hoc distribution. + + + + + Application installed via developer build. + + + + + Application running in editor. + + + + + Application installed via enterprise distribution. + + + + + Application installed via online store. + + + + + Application install mode unknown. + + + + + Application sandbox type. + + + + + Application not running in a sandbox. + + + + + Application is running in broken sandbox. + + + + + Application is running in a sandbox. + + + + + Application sandbox type is unknown. + + + + + Applies forces within an area. + + + + + The angular drag to apply to rigid-bodies. + + + + + The linear drag to apply to rigid-bodies. + + + + + The angle of the force to be applied. + + + + + The magnitude of the force to be applied. + + + + + The target for where the effector applies any force. + + + + + The variation of the magnitude of the force to be applied. + + + + + Should the forceAngle use global space? + + + + + Enumeration of all the muscles in an arm. + + + + + The arm down-up muscle. + + + + + The arm front-back muscle. + + + + + The arm roll in-out muscle. + + + + + The forearm close-open muscle. + + + + + The forearm roll in-out muscle. + + + + + The hand down-up muscle. + + + + + The hand in-out muscle. + + + + + The last value of the ArmDof enum. + + + + + The shoulder down-up muscle. + + + + + The shoulder front-back muscle. + + + + + Assembly level attribute. Any classes in an assembly with this attribute will be considered to be Editor Classes. + + + + + Constructor. + + + + + The Assert class contains assertion methods for setting invariants in the code. + + + + + Whether Unity should throw an exception on a failure. + + + + + Assert the values are approximately equal. + + Tolerance of approximation. + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + + + + Assert the values are approximately equal. + + Tolerance of approximation. + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + + + + Assert the values are approximately equal. + + Tolerance of approximation. + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + + + + Assert the values are approximately equal. + + Tolerance of approximation. + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + + + + Assert that the values are equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Asserts that the values are approximately not equal. + + Tolerance of approximation. + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + + + + Asserts that the values are approximately not equal. + + Tolerance of approximation. + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + + + + Asserts that the values are approximately not equal. + + Tolerance of approximation. + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + + + + Asserts that the values are approximately not equal. + + Tolerance of approximation. + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + + + + Assert that the values are not equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are not equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are not equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are not equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are not equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are not equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are not equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are not equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are not equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are not equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are not equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are not equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are not equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are not equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are not equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are not equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are not equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are not equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are not equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are not equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are not equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Assert that the values are not equal. + + The assumed Assert value. + The exact Assert value. + The string used to describe the Assert. + Method to compare expected and actual arguments have the same value. + + + + Return true when the condition is false. Otherwise return false. + + true or false. + The string used to describe the result of the Assert. + + + + Return true when the condition is false. Otherwise return false. + + true or false. + The string used to describe the result of the Assert. + + + + Assert that the value is not null. + + The Object or type being checked for. + The string used to describe the Assert. + + + + Assert that the value is not null. + + The Object or type being checked for. + The string used to describe the Assert. + + + + Assert that the value is not null. + + The Object or type being checked for. + The string used to describe the Assert. + + + + Assert the value is null. + + The Object or type being checked for. + The string used to describe the Assert. + + + + Assert the value is null. + + The Object or type being checked for. + The string used to describe the Assert. + + + + Assert the value is null. + + The Object or type being checked for. + The string used to describe the Assert. + + + + Asserts that the condition is true. + + The string used to describe the Assert. + true or false. + + + + Asserts that the condition is true. + + The string used to describe the Assert. + true or false. + + + + An exception that is thrown on a failure. Assertions.Assert._raiseExceptions needs to be set to true. + + + + + A float comparer used by Assertions.Assert performing approximate comparison. + + + + + Default epsilon used by the comparer. + + + + + Default instance of a comparer class with deafult error epsilon and absolute error check. + + + + + Performs equality check with absolute error check. + + Expected value. + Actual value. + Comparison error. + + Result of the comparison. + + + + + Performs equality check with relative error check. + + Expected value. + Actual value. + Comparison error. + + Result of the comparison. + + + + + Creates an instance of the comparer. + + Should a relative check be used when comparing values? By default, an absolute check will be used. + Allowed comparison error. By default, the FloatComparer.kEpsilon is used. + + + + Creates an instance of the comparer. + + Should a relative check be used when comparing values? By default, an absolute check will be used. + Allowed comparison error. By default, the FloatComparer.kEpsilon is used. + + + + Creates an instance of the comparer. + + Should a relative check be used when comparing values? By default, an absolute check will be used. + Allowed comparison error. By default, the FloatComparer.kEpsilon is used. + + + + Creates an instance of the comparer. + + Should a relative check be used when comparing values? By default, an absolute check will be used. + Allowed comparison error. By default, the FloatComparer.kEpsilon is used. + + + + An extension class that serves as a wrapper for the Assert class. + + + + + An extension method for Assertions.Assert.AreApproximatelyEqual. + + + + + + + + + An extension method for Assertions.Assert.AreApproximatelyEqual. + + + + + + + + + An extension method for Assertions.Assert.AreApproximatelyEqual. + + + + + + + + + An extension method for Assertions.Assert.AreApproximatelyEqual. + + + + + + + + + An extension method for Assertions.Assert.AreEqual. + + + + + + + + An extension method for Assertions.Assert.AreEqual. + + + + + + + + An extension method for Assertions.Assert.IsFalse. + + + + + + + An extension method for Assertions.Assert.IsFalse. + + + + + + + An extension method for Assertions.Assert.IsNull. + + + + + + + An extension method for Assertions.Assert.IsNull. + + + + + + + An extension method for Assertions.Assert.IsTrue. + + + + + + + An extension method for Assertions.Assert.IsTrue. + + + + + + + An extension method for Assertions.Assert.AreNotApproximatelyEqual. + + + + + + + + + An extension method for Assertions.Assert.AreNotApproximatelyEqual. + + + + + + + + + An extension method for Assertions.Assert.AreNotApproximatelyEqual. + + + + + + + + + An extension method for Assertions.Assert.AreNotApproximatelyEqual. + + + + + + + + + An extension method for Assertions.Assert.AreNotEqual. + + + + + + + + An extension method for Assertions.Assert.AreNotEqual. + + + + + + + + An extension method for Assertions.Assert.AreNotNull. + + + + + + + An extension method for Assertions.Assert.AreNotNull. + + + + + + + AssetBundles let you stream additional assets via the UnityWebRequest class and instantiate them at runtime. AssetBundles are created via BuildPipeline.BuildAssetBundle. + + + + + Return true if the AssetBundle is a streamed Scene AssetBundle. + + + + + Check if an AssetBundle contains a specific object. + + + + + + Loads an asset bundle from a disk. + + Path of the file on disk + +See Also: UnityWebRequestAssetBundle.GetAssetBundle, DownloadHandlerAssetBundle. + + + + Asynchronously create an AssetBundle from a memory region. + + + + + + Synchronously create an AssetBundle from a memory region. + + Array of bytes with the AssetBundle data. + + + + Return all asset names in the AssetBundle. + + + + + To use when you need to get a list of all the currently loaded Asset Bundles. + + + Returns IEnumerable<AssetBundle> of all currently loaded Asset Bundles. + + + + + Return all the Scene asset paths (paths to *.unity assets) in the AssetBundle. + + + + + Loads all assets contained in the asset bundle that inherit from type. + + + + + + Loads all assets contained in the asset bundle. + + + + + Loads all assets contained in the asset bundle that inherit from type T. + + + + + Loads all assets contained in the asset bundle asynchronously. + + + + + Loads all assets contained in the asset bundle that inherit from T asynchronously. + + + + + Loads all assets contained in the asset bundle that inherit from type asynchronously. + + + + + + Loads asset with name from the bundle. + + + + + + Loads asset with name of a given type from the bundle. + + + + + + + Loads asset with name of type T from the bundle. + + + + + + Asynchronously loads asset with name from the bundle. + + + + + + Asynchronously loads asset with name of a given T from the bundle. + + + + + + Asynchronously loads asset with name of a given type from the bundle. + + + + + + + Loads asset and sub assets with name from the bundle. + + + + + + Loads asset and sub assets with name of a given type from the bundle. + + + + + + + Loads asset and sub assets with name of type T from the bundle. + + + + + + Loads asset with sub assets with name from the bundle asynchronously. + + + + + + Loads asset with sub assets with name of type T from the bundle asynchronously. + + + + + + Loads asset with sub assets with name of a given type from the bundle asynchronously. + + + + + + + Synchronously loads an AssetBundle from a file on disk. + + Path of the file on disk. + An optional CRC-32 checksum of the uncompressed content. If this is non-zero, then the content will be compared against the checksum before loading it, and give an error if it does not match. + An optional byte offset. This value specifies where to start reading the AssetBundle from. + + Loaded AssetBundle object or null if failed. + + + + + Synchronously loads an AssetBundle from a file on disk. + + Path of the file on disk. + An optional CRC-32 checksum of the uncompressed content. If this is non-zero, then the content will be compared against the checksum before loading it, and give an error if it does not match. + An optional byte offset. This value specifies where to start reading the AssetBundle from. + + Loaded AssetBundle object or null if failed. + + + + + Asynchronously loads an AssetBundle from a file on disk. + + Path of the file on disk. + An optional CRC-32 checksum of the uncompressed content. If this is non-zero, then the content will be compared against the checksum before loading it, and give an error if it does not match. + An optional byte offset. This value specifies where to start reading the AssetBundle from. + + Asynchronous create request for an AssetBundle. Use AssetBundleCreateRequest.assetBundle property to get an AssetBundle once it is loaded. + + + + + Synchronously create an AssetBundle from a memory region. + + Array of bytes with the AssetBundle data. + An optional CRC-32 checksum of the uncompressed content. If this is non-zero, then the content will be compared against the checksum before loading it, and give an error if it does not match. + + Loaded AssetBundle object or null if failed. + + + + + Asynchronously create an AssetBundle from a memory region. + + Array of bytes with the AssetBundle data. + An optional CRC-32 checksum of the uncompressed content. If this is non-zero, then the content will be compared against the checksum before loading it, and give an error if it does not match. + + Asynchronous create request for an AssetBundle. Use AssetBundleCreateRequest.assetBundle property to get an AssetBundle once it is loaded. + + + + + Synchronously loads an AssetBundle from a managed Stream. + + The managed Stream object. Unity calls Read(), Seek() and the Length property on this object to load the AssetBundle data. + An optional CRC-32 checksum of the uncompressed content. + You can use this to override the size of the read buffer Unity uses while loading data. The default size is 32KB. + + The loaded AssetBundle object or null when the object fails to load. + + + + + Asynchronously loads an AssetBundle from a managed Stream. + + The managed Stream object. Unity calls Read(), Seek() and the Length property on this object to load the AssetBundle data. + An optional CRC-32 checksum of the uncompressed content. + You can use this to override the size of the read buffer Unity uses while loading data. The default size is 32KB. + + Asynchronous create request for an AssetBundle. Use AssetBundleCreateRequest.assetBundle property to get an AssetBundle once it is loaded. + + + + + Asynchronously recompress a downloaded/stored AssetBundle from one BuildCompression to another. + + Path to the AssetBundle to recompress. + Path to the recompressed AssetBundle to be generated. Can be the same as inputPath. + The compression method, level and blocksize to use during recompression. Only some BuildCompression types are supported (see note). + CRC of the AssetBundle to test against. Testing this requires additional file reading and computation. Pass in 0 to skip this check. + The priority at which the recompression operation should run. This sets thread priority during the operation and does not effect the order in which operations are performed. Recompression operations run on a background worker thread. + + + + Unloads all assets in the bundle. + + + + + + Unloads all currently loaded Asset Bundles. + + Determines whether the current instances of objects loaded from Asset Bundles will also be unloaded. + + + + Asynchronous create request for an AssetBundle. + + + + + Asset object being loaded (Read Only). + + + + + The result of an Asset Bundle Load or Recompress Operation. + + + + + The Asset Bundle is already loaded. + + + + + The operation was cancelled. + + + + + The Asset Bundle was not successfully cached. + + + + + Failed to decompress the Asset Bundle. + + + + + The target path given for the Recompression operation could not be deleted for swap with recompressed bundle file. + + + + + Failed to read the Asset Bundle file. + + + + + Failed to write to the file system. + + + + + The Asset Bundle does not contain any serialized data. It may be empty, or corrupt. + + + + + The AssetBundle is incompatible with this version of Unity. + + + + + The decompressed Asset data did not match the precomputed CRC. This may suggest that the AssetBundle did not download correctly. + + + + + This does not appear to be a valid Asset Bundle. + + + + + The target path given for the Recompression operation exists but is not an Archive container. + + + + + The target path given for the Recompression operation is an Archive that is currently loaded. + + + + + The operation completed successfully. + + + + + Manifest for all the AssetBundles in the build. + + + + + Get all the AssetBundles in the manifest. + + + An array of asset bundle names. + + + + + Get all the AssetBundles with variant in the manifest. + + + An array of asset bundle names. + + + + + Get all the dependent AssetBundles for the given AssetBundle. + + Name of the asset bundle. + + + + Get the hash for the given AssetBundle. + + Name of the asset bundle. + + The 128-bit hash for the asset bundle. + + + + + Get the direct dependent AssetBundles for the given AssetBundle. + + Name of the asset bundle. + + Array of asset bundle names this asset bundle depends on. + + + + + Asynchronous AssetBundle recompression from one compression method and level to another. + + + + + A string describing the recompression operation result (Read Only). + + + + + Path of the AssetBundle being recompressed (Read Only). + + + + + Path of the resulting recompressed AssetBundle (Read Only). + + + + + Result of the recompression operation. + + + + + True if the recompress operation is complete and was successful, otherwise false (Read Only). + + + + + Asynchronous load request from an AssetBundle. + + + + + Asset objects with sub assets being loaded. (Read Only) + + + + + Asset object being loaded (Read Only). + + + + + Asynchronous operation coroutine. + + + + + Allow Scenes to be activated as soon as it is ready. + + + + + Event that is invoked upon operation completion. An event handler that is registered in the same frame as the call that creates it will be invoked next frame, even if the operation is able to complete synchronously. If a handler is registered after the operation has completed and has already invoked the complete event, the handler will be called synchronously. + + Action<AsyncOperation> handler - function signature for completion event handler. + + + + Has the operation finished? (Read Only) + + + + + Priority lets you tweak in which order async operation calls will be performed. + + + + + What's the operation's progress. (Read Only) + + + + + An implementation of IPlayable that controls an AudioClip. + + + + + Creates an AudioClipPlayable in the PlayableGraph. + + The PlayableGraph that will contain the new AnimationLayerMixerPlayable. + The AudioClip that will be added in the PlayableGraph. + True if the clip should loop, false otherwise. + + A AudioClipPlayable linked to the PlayableGraph. + + + + + AudioMixer asset. + + + + + Routing target. + + + + + How time should progress for this AudioMixer. Used during Snapshot transitions. + + + + + Resets an exposed parameter to its initial value. + + Exposed parameter. + + Returns false if the parameter was not found or could not be set. + + + + + Connected groups in the mixer form a path from the mixer's master group to the leaves. This path has the format "Master GroupChild of Master GroupGrandchild of Master Group", so to find the grandchild group in this example, a valid search string would be for instance "randchi" which would return exactly one group while "hild" or "oup/" would return 2 different groups. + + Sub-string of the paths to be matched. + + Groups in the mixer whose paths match the specified search path. + + + + + The name must be an exact match. + + Name of snapshot object to be returned. + + The snapshot identified by the name. + + + + + Returns the value of the exposed parameter specified. If the parameter doesn't exist the function returns false. Prior to calling SetFloat and after ClearFloat has been called on this parameter the value returned will be that of the current snapshot or snapshot transition. + + Name of exposed parameter. + Return value of exposed parameter. + + Returns false if the exposed parameter specified doesn't exist. + + + + + Sets the value of the exposed parameter specified. When a parameter is exposed, it is not controlled by mixer snapshots and can therefore only be changed via this function. + + Name of exposed parameter. + New value of exposed parameter. + + Returns false if the exposed parameter was not found or snapshots are currently being edited. + + + + + Transitions to a weighted mixture of the snapshots specified. This can be used for games that specify the game state as a continuum between states or for interpolating snapshots from a triangulated map location. + + The set of snapshots to be mixed. + The mix weights for the snapshots specified. + Relative time after which the mixture should be reached from any current state. + + + + Object representing a group in the mixer. + + + + + An implementation of IPlayable that controls an audio mixer. + + + + + Object representing a snapshot in the mixer. + + + + + Performs an interpolated transition towards this snapshot over the time interval specified. + + Relative time after which this snapshot should be reached from any current state. + + + + The mode in which an AudioMixer should update its time. + + + + + Update the AudioMixer with scaled game time. + + + + + Update the AudioMixer with unscaled realtime. + + + + + A PlayableBinding that contains information representing an AudioPlayableOutput. + + + + + Creates a PlayableBinding that contains information representing an AudioPlayableOutput. + + A reference to a UnityEngine.Object that acts as a key for this binding. + The name of the AudioPlayableOutput. + + Returns a PlayableBinding that contains information that is used to create an AudioPlayableOutput. + + + + + A IPlayableOutput implementation that will be used to play audio. + + + + + Creates an AudioPlayableOutput in the PlayableGraph. + + The PlayableGraph that will contain the AnimationPlayableOutput. + The name of the output. + The AudioSource that will play the AudioPlayableOutput source Playable. + + A new AudioPlayableOutput attached to the PlayableGraph. + + + + + Gets the state of output playback when seeking. + + + Returns true if the output plays when seeking. Returns false otherwise. + + + + + Returns an invalid AudioPlayableOutput. + + + + + Controls whether the output should play when seeking. + + Set to true to play the output when seeking. Set to false to disable audio scrubbing on this output. Default is true. + + + + The Audio Chorus Filter takes an Audio Clip and processes it creating a chorus effect. + + + + + Chorus delay in ms. 0.1 to 100.0. Default = 40.0 ms. + + + + + Chorus modulation depth. 0.0 to 1.0. Default = 0.03. + + + + + Volume of original signal to pass to output. 0.0 to 1.0. Default = 0.5. + + + + + Chorus feedback. Controls how much of the wet signal gets fed back into the chorus buffer. 0.0 to 1.0. Default = 0.0. + + + + + Chorus modulation rate in hz. 0.0 to 20.0. Default = 0.8 hz. + + + + + Volume of 1st chorus tap. 0.0 to 1.0. Default = 0.5. + + + + + Volume of 2nd chorus tap. This tap is 90 degrees out of phase of the first tap. 0.0 to 1.0. Default = 0.5. + + + + + Volume of 3rd chorus tap. This tap is 90 degrees out of phase of the second tap. 0.0 to 1.0. Default = 0.5. + + + + + A container for audio data. + + + + + Returns true if this audio clip is ambisonic (read-only). + + + + + The number of channels in the audio clip. (Read Only) + + + + + The sample frequency of the clip in Hertz. (Read Only) + + + + + Returns true if the AudioClip is ready to play (read-only). + + + + + The length of the audio clip in seconds. (Read Only) + + + + + Corresponding to the "Load In Background" flag in the inspector, when this flag is set, the loading will happen delayed without blocking the main thread. + + + + + Returns the current load state of the audio data associated with an AudioClip. + + + + + The load type of the clip (read-only). + + + + + Preloads audio data of the clip when the clip asset is loaded. When this flag is off, scripts have to call AudioClip.LoadAudioData() to load the data before the clip can be played. Properties like length, channels and format are available before the audio data has been loaded. + + + + + The length of the audio clip in samples. (Read Only) + + + + + Creates a user AudioClip with a name and with the given length in samples, channels and frequency. + + Name of clip. + Number of sample frames. + Number of channels per frame. + Sample frequency of clip. + Audio clip is played back in 3D. + True if clip is streamed, that is if the pcmreadercallback generates data on the fly. + This callback is invoked to generate a block of sample data. Non-streamed clips call this only once at creation time while streamed clips call this continuously. + This callback is invoked whenever the clip loops or changes playback position. + + A reference to the created AudioClip. + + + + + Creates a user AudioClip with a name and with the given length in samples, channels and frequency. + + Name of clip. + Number of sample frames. + Number of channels per frame. + Sample frequency of clip. + Audio clip is played back in 3D. + True if clip is streamed, that is if the pcmreadercallback generates data on the fly. + This callback is invoked to generate a block of sample data. Non-streamed clips call this only once at creation time while streamed clips call this continuously. + This callback is invoked whenever the clip loops or changes playback position. + + A reference to the created AudioClip. + + + + + Creates a user AudioClip with a name and with the given length in samples, channels and frequency. + + Name of clip. + Number of sample frames. + Number of channels per frame. + Sample frequency of clip. + Audio clip is played back in 3D. + True if clip is streamed, that is if the pcmreadercallback generates data on the fly. + This callback is invoked to generate a block of sample data. Non-streamed clips call this only once at creation time while streamed clips call this continuously. + This callback is invoked whenever the clip loops or changes playback position. + + A reference to the created AudioClip. + + + + + Creates a user AudioClip with a name and with the given length in samples, channels and frequency. + + Name of clip. + Number of sample frames. + Number of channels per frame. + Sample frequency of clip. + Audio clip is played back in 3D. + True if clip is streamed, that is if the pcmreadercallback generates data on the fly. + This callback is invoked to generate a block of sample data. Non-streamed clips call this only once at creation time while streamed clips call this continuously. + This callback is invoked whenever the clip loops or changes playback position. + + A reference to the created AudioClip. + + + + + Creates a user AudioClip with a name and with the given length in samples, channels and frequency. + + Name of clip. + Number of sample frames. + Number of channels per frame. + Sample frequency of clip. + Audio clip is played back in 3D. + True if clip is streamed, that is if the pcmreadercallback generates data on the fly. + This callback is invoked to generate a block of sample data. Non-streamed clips call this only once at creation time while streamed clips call this continuously. + This callback is invoked whenever the clip loops or changes playback position. + + A reference to the created AudioClip. + + + + + Creates a user AudioClip with a name and with the given length in samples, channels and frequency. + + Name of clip. + Number of sample frames. + Number of channels per frame. + Sample frequency of clip. + Audio clip is played back in 3D. + True if clip is streamed, that is if the pcmreadercallback generates data on the fly. + This callback is invoked to generate a block of sample data. Non-streamed clips call this only once at creation time while streamed clips call this continuously. + This callback is invoked whenever the clip loops or changes playback position. + + A reference to the created AudioClip. + + + + + Fills an array with sample data from the clip. + + + + + + + Loads the audio data of a clip. Clips that have "Preload Audio Data" set will load the audio data automatically. + + + Returns true if loading succeeded. + + + + + Delegate called each time AudioClip reads data. + + Array of floats containing data read from the clip. + + + + Delegate called each time AudioClip changes read position. + + New position in the audio clip. + + + + Set sample data in a clip. + + + + + + + Unloads the audio data associated with the clip. This works only for AudioClips that are based on actual sound file assets. + + + Returns false if unloading failed. + + + + + Determines how the audio clip is loaded in. + + + + + The audio data of the clip will be kept in memory in compressed form. + + + + + The audio data is decompressed when the audio clip is loaded. + + + + + Streams audio data from disk. + + + + + An enum containing different compression types. + + + + + AAC Audio Compression. + + + + + Adaptive differential pulse-code modulation. + + + + + Sony proprietary hardware format. + + + + + Nintendo ADPCM audio compression format. + + + + + Sony proprietory hardware codec. + + + + + MPEG Audio Layer III. + + + + + Uncompressed pulse-code modulation. + + + + + Sony proprietary hardware format. + + + + + Vorbis compression format. + + + + + Xbox One proprietary hardware format. + + + + + Specifies the current properties or desired properties to be set for the audio system. + + + + + The length of the DSP buffer in samples determining the latency of sounds by the audio output device. + + + + + The current maximum number of simultaneously audible sounds in the game. + + + + + The maximum number of managed sounds in the game. Beyond this limit sounds will simply stop playing. + + + + + The current sample rate of the audio output device used. + + + + + The current speaker mode used by the audio output device. + + + + + Value describing the current load state of the audio data associated with an AudioClip. + + + + + Value returned by AudioClip.loadState for an AudioClip that has failed loading its audio data. + + + + + Value returned by AudioClip.loadState for an AudioClip that has succeeded loading its audio data. + + + + + Value returned by AudioClip.loadState for an AudioClip that is currently loading audio data. + + + + + Value returned by AudioClip.loadState for an AudioClip that has no audio data loaded and where loading has not been initiated yet. + + + + + The Audio Distortion Filter distorts the sound from an AudioSource or sounds reaching the AudioListener. + + + + + Distortion value. 0.0 to 1.0. Default = 0.5. + + + + + The Audio Echo Filter repeats a sound after a given Delay, attenuating the repetitions based on the Decay Ratio. + + + + + Echo decay per delay. 0 to 1. 1.0 = No decay, 0.0 = total decay (i.e. simple 1 line delay). Default = 0.5. + + + + + Echo delay in ms. 10 to 5000. Default = 500. + + + + + Volume of original signal to pass to output. 0.0 to 1.0. Default = 1.0. + + + + + Volume of echo signal to pass to output. 0.0 to 1.0. Default = 1.0. + + + + + The Audio High Pass Filter passes high frequencies of an AudioSource, and cuts off signals with frequencies lower than the Cutoff Frequency. + + + + + Highpass cutoff frequency in hz. 10.0 to 22000.0. Default = 5000.0. + + + + + Determines how much the filter's self-resonance isdampened. + + + + + Representation of a listener in 3D space. + + + + + The paused state of the audio system. + + + + + This lets you set whether the Audio Listener should be updated in the fixed or dynamic update. + + + + + Controls the game sound volume (0.0 to 1.0). + + + + + Provides a block of the listener (master)'s output data. + + The array to populate with audio samples. Its length must be a power of 2. + The channel to sample from. + + + + Deprecated Version. Returns a block of the listener (master)'s output data. + + + + + + + Provides a block of the listener (master)'s spectrum data. + + The array to populate with audio samples. Its length must be a power of 2. + The channel to sample from. + The FFTWindow type to use when sampling. + + + + Deprecated Version. Returns a block of the listener (master)'s spectrum data. + + Number of values (the length of the samples array). Must be a power of 2. Min = 64. Max = 8192. + The channel to sample from. + The FFTWindow type to use when sampling. + + + + The Audio Low Pass Filter passes low frequencies of an AudioSource or all sounds reaching an AudioListener, while removing frequencies higher than the Cutoff Frequency. + + + + + Returns or sets the current custom frequency cutoff curve. + + + + + Lowpass cutoff frequency in hz. 10.0 to 22000.0. Default = 5000.0. + + + + + Determines how much the filter's self-resonance is dampened. + + + + + Allow recording the main output of the game or specific groups in the AudioMixer. + + + + + Returns the number of samples available since the last time AudioRenderer.Render was called. This is dependent on the frame capture rate. + + + Number of samples available since last recorded frame. + + + + + Performs the recording of the main output as well as any optional mixer groups that have been registered via AudioRenderer.AddMixerGroupSink. + + The buffer to write the sample data to. + + True if the recording succeeded. + + + + + Enters audio recording mode. After this Unity will output silence until AudioRenderer.Stop is called. + + + True if the engine was switched into output recording mode. False if it is already recording. + + + + + Exits audio recording mode. After this audio output will be audible again. + + + True if the engine was recording when this function was called. + + + + + The Audio Reverb Filter takes an Audio Clip and distorts it to create a custom reverb effect. + + + + + Decay HF Ratio : High-frequency to low-frequency decay time ratio. Ranges from 0.1 to 2.0. Default is 0.5. + + + + + Reverberation decay time at low-frequencies in seconds. Ranges from 0.1 to 20.0. Default is 1.0. + + + + + Reverberation density (modal density) in percent. Ranges from 0.0 to 100.0. Default is 100.0. + + + + + Reverberation diffusion (echo density) in percent. Ranges from 0.0 to 100.0. Default is 100.0. + + + + + Mix level of dry signal in output in millibels (mB). Ranges from -10000.0 to 0.0. Default is 0. + + + + + Reference high frequency in hertz (Hz). Ranges from 1000.0 to 20000.0. Default is 5000.0. + + + + + Reference low-frequency in hertz (Hz). Ranges from 20.0 to 1000.0. Default is 250.0. + + + + + Late reverberation level relative to room effect in millibels (mB). Ranges from -10000.0 to 2000.0. Default is 0.0. + + + + + Early reflections level relative to room effect in millibels (mB). Ranges from -10000.0 to 1000.0. Default is -10000.0. + + + + + Late reverberation delay time relative to first reflection in seconds. Ranges from 0.0 to 0.1. Default is 0.04. + + + + + Late reverberation level relative to room effect in millibels (mB). Ranges from -10000.0 to 2000.0. Default is 0.0. + + + + + Set/Get reverb preset properties. + + + + + Room effect level at low frequencies in millibels (mB). Ranges from -10000.0 to 0.0. Default is 0.0. + + + + + Room effect high-frequency level re. low frequency level in millibels (mB). Ranges from -10000.0 to 0.0. Default is 0.0. + + + + + Room effect low-frequency level in millibels (mB). Ranges from -10000.0 to 0.0. Default is 0.0. + + + + + Reverb presets used by the Reverb Zone class and the audio reverb filter. + + + + + Alley preset. + + + + + Arena preset. + + + + + Auditorium preset. + + + + + Bathroom preset. + + + + + Carpeted hallway preset. + + + + + Cave preset. + + + + + City preset. + + + + + Concert hall preset. + + + + + Dizzy preset. + + + + + Drugged preset. + + + + + Forest preset. + + + + + Generic preset. + + + + + Hallway preset. + + + + + Hangar preset. + + + + + Livingroom preset. + + + + + Mountains preset. + + + + + No reverb preset selected. + + + + + Padded cell preset. + + + + + Parking Lot preset. + + + + + Plain preset. + + + + + Psychotic preset. + + + + + Quarry preset. + + + + + Room preset. + + + + + Sewer pipe preset. + + + + + Stone corridor preset. + + + + + Stoneroom preset. + + + + + Underwater presset. + + + + + User defined preset. + + + + + Reverb Zones are used when you want to create location based ambient effects in the Scene. + + + + + High-frequency to mid-frequency decay time ratio. + + + + + Reverberation decay time at mid frequencies. + + + + + Value that controls the modal density in the late reverberation decay. + + + + + Value that controls the echo density in the late reverberation decay. + + + + + The distance from the centerpoint that the reverb will not have any effect. Default = 15.0. + + + + + The distance from the centerpoint that the reverb will have full effect at. Default = 10.0. + + + + + Early reflections level relative to room effect. + + + + + Initial reflection delay time. + + + + + Late reverberation level relative to room effect. + + + + + Late reverberation delay time relative to initial reflection. + + + + + Set/Get reverb preset properties. + + + + + Room effect level (at mid frequencies). + + + + + Relative room effect level at high frequencies. + + + + + Relative room effect level at low frequencies. + + + + + Like rolloffscale in global settings, but for reverb room size effect. + + + + + Reference high frequency (hz). + + + + + Reference low frequency (hz). + + + + + Rolloff modes that a 3D sound can have in an audio source. + + + + + Use this when you want to use a custom rolloff. + + + + + Use this mode when you want to lower the volume of your sound over the distance. + + + + + Use this mode when you want a real-world rolloff. + + + + + Controls the global audio settings from script. + + + + + Returns the speaker mode capability of the current audio driver. (Read Only) + + + + + Returns the current time of the audio system. + + + + + Get the mixer's current output rate. + + + + + Gets the current speaker mode. Default is 2 channel stereo. + + + + + A delegate called whenever the global audio settings are changed, either by AudioSettings.Reset or by an external device change such as the OS control panel changing the sample rate or because the default output device was changed, for example when plugging in an HDMI monitor or a USB headset. + + True if the change was caused by an device change. + + + + Returns the current configuration of the audio device and system. The values in the struct may then be modified and reapplied via AudioSettings.Reset. + + + The new configuration to be applied. + + + + + Get the mixer's buffer size in samples. + + Is the length of each buffer in the ringbuffer. + Is number of buffers. + + + + Returns the name of the spatializer selected on the currently-running platform. + + + The spatializer plugin name. + + + + + Returns an array with the names of all the available spatializer plugins. + + + An array of spatializer names. + + + + + A delegate called whenever the global audio settings are changed, either by AudioSettings.Reset or by an external factor such as the OS control panel changing the sample rate or because the default output device was changed, for example when plugging in an HDMI monitor or a USB headset. + + True if the change was caused by an device change. + + + + Performs a change of the device configuration. In response to this the AudioSettings.OnAudioConfigurationChanged delegate is invoked with the argument deviceWasChanged=false. It cannot be guaranteed that the exact settings specified can be used, but the an attempt is made to use the closest match supported by the system. + + The new configuration to be used. + + True if all settings could be successfully applied. + + + + + Sets the spatializer plugin for all platform groups. If a null or empty string is passed in, the existing spatializer plugin will be cleared. + + The spatializer plugin name. + + + + A representation of audio sources in 3D. + + + + + Bypass effects (Applied from filter components or global listener filters). + + + + + When set global effects on the AudioListener will not be applied to the audio signal generated by the AudioSource. Does not apply if the AudioSource is playing into a mixer group. + + + + + When set doesn't route the signal from an AudioSource into the global reverb associated with reverb zones. + + + + + The default AudioClip to play. + + + + + Sets the Doppler scale for this AudioSource. + + + + + Allows AudioSource to play even though AudioListener.pause is set to true. This is useful for the menu element sounds or background music in pause menus. + + + + + This makes the audio source not take into account the volume of the audio listener. + + + + + Is the clip playing right now (Read Only)? + + + + + True if all sounds played by the AudioSource (main sound started by Play() or playOnAwake as well as one-shots) are culled by the audio system. + + + + + Is the audio clip looping? + + + + + (Logarithmic rolloff) MaxDistance is the distance a sound stops attenuating at. + + + + + Within the Min distance the AudioSource will cease to grow louder in volume. + + + + + Un- / Mutes the AudioSource. Mute sets the volume=0, Un-Mute restore the original volume. + + + + + The target group to which the AudioSource should route its signal. + + + + + Pan has been deprecated. Use panStereo instead. + + + + + PanLevel has been deprecated. Use spatialBlend instead. + + + + + Pans a playing sound in a stereo way (left or right). This only applies to sounds that are Mono or Stereo. + + + + + The pitch of the audio source. + + + + + If set to true, the audio source will automatically start playing on awake. + + + + + Sets the priority of the AudioSource. + + + + + The amount by which the signal from the AudioSource will be mixed into the global reverb associated with the Reverb Zones. + + + + + Sets/Gets how the AudioSource attenuates over distance. + + + + + Sets how much this AudioSource is affected by 3D spatialisation calculations (attenuation, doppler etc). 0.0 makes the sound full 2D, 1.0 makes it full 3D. + + + + + Enables or disables spatialization. + + + + + Determines if the spatializer effect is inserted before or after the effect filters. + + + + + Sets the spread angle (in degrees) of a 3d stereo or multichannel sound in speaker space. + + + + + Playback position in seconds. + + + + + Playback position in PCM samples. + + + + + Whether the Audio Source should be updated in the fixed or dynamic update. + + + + + The volume of the audio source (0.0 to 1.0). + + + + + Reads a user-defined parameter of a custom ambisonic decoder effect that is attached to an AudioSource. + + Zero-based index of user-defined parameter to be read. + Return value of the user-defined parameter that is read. + + True, if the parameter could be read. + + + + + Get the current custom curve for the given AudioSourceCurveType. + + The curve type to get. + + The custom AnimationCurve corresponding to the given curve type. + + + + + Provides a block of the currently playing source's output data. + + The array to populate with audio samples. Its length must be a power of 2. + The channel to sample from. + + + + Deprecated Version. Returns a block of the currently playing source's output data. + + + + + + + Reads a user-defined parameter of a custom spatializer effect that is attached to an AudioSource. + + Zero-based index of user-defined parameter to be read. + Return value of the user-defined parameter that is read. + + True, if the parameter could be read. + + + + + Provides a block of the currently playing audio source's spectrum data. + + The array to populate with audio samples. Its length must be a power of 2. + The channel to sample from. + The FFTWindow type to use when sampling. + + + + Deprecated Version. Returns a block of the currently playing source's spectrum data. + + The number of samples to retrieve. Must be a power of 2. + The channel to sample from. + The FFTWindow type to use when sampling. + + + + Pauses playing the clip. + + + + + Plays the clip. + + Deprecated. Delay in number of samples, assuming a 44100Hz sample rate (meaning that Play(44100) will delay the playing by exactly 1 sec). + + + + Plays the clip. + + Deprecated. Delay in number of samples, assuming a 44100Hz sample rate (meaning that Play(44100) will delay the playing by exactly 1 sec). + + + + Plays an AudioClip at a given position in world space. + + Audio data to play. + Position in world space from which sound originates. + Playback volume. + + + + Plays an AudioClip at a given position in world space. + + Audio data to play. + Position in world space from which sound originates. + Playback volume. + + + + Plays the clip with a delay specified in seconds. Users are advised to use this function instead of the old Play(delay) function that took a delay specified in samples relative to a reference rate of 44.1 kHz as an argument. + + Delay time specified in seconds. + + + + Plays an AudioClip, and scales the AudioSource volume by volumeScale. + + The clip being played. + The scale of the volume (0-1). + + + + Plays an AudioClip, and scales the AudioSource volume by volumeScale. + + The clip being played. + The scale of the volume (0-1). + + + + Plays the clip at a specific time on the absolute time-line that AudioSettings.dspTime reads from. + + Time in seconds on the absolute time-line that AudioSettings.dspTime refers to for when the sound should start playing. + + + + Sets a user-defined parameter of a custom ambisonic decoder effect that is attached to an AudioSource. + + Zero-based index of user-defined parameter to be set. + New value of the user-defined parameter. + + True, if the parameter could be set. + + + + + Set the custom curve for the given AudioSourceCurveType. + + The curve type that should be set. + The curve that should be applied to the given curve type. + + + + Changes the time at which a sound that has already been scheduled to play will end. Notice that depending on the timing not all rescheduling requests can be fulfilled. + + Time in seconds. + + + + Changes the time at which a sound that has already been scheduled to play will start. + + Time in seconds. + + + + Sets a user-defined parameter of a custom spatializer effect that is attached to an AudioSource. + + Zero-based index of user-defined parameter to be set. + New value of the user-defined parameter. + + True, if the parameter could be set. + + + + + Stops playing the clip. + + + + + Unpause the paused playback of this AudioSource. + + + + + This defines the curve type of the different custom curves that can be queried and set within the AudioSource. + + + + + Custom Volume Rolloff. + + + + + Reverb Zone Mix. + + + + + The Spatial Blend. + + + + + The 3D Spread. + + + + + These are speaker types defined for use with AudioSettings.speakerMode. + + + + + Channel count is set to 6. 5.1 speaker setup. This includes front left, front right, center, rear left, rear right and a subwoofer. + + + + + Channel count is set to 8. 7.1 speaker setup. This includes front left, front right, center, rear left, rear right, side left, side right and a subwoofer. + + + + + Channel count is set to 1. The speakers are monaural. + + + + + Channel count is set to 2. Stereo output, but data is encoded in a way that is picked up by a Prologic/Prologic2 decoder and split into a 5.1 speaker setup. + + + + + Channel count is set to 4. 4 speaker setup. This includes front left, front right, rear left, rear right. + + + + + Channel count is unaffected. + + + + + Channel count is set to 2. The speakers are stereo. This is the editor default. + + + + + Channel count is set to 5. 5 speaker setup. This includes front left, front right, center, rear left, rear right. + + + + + Type of the imported(native) data. + + + + + Acc - not supported. + + + + + Aiff. + + + + + iPhone hardware decoder, supports AAC, ALAC and MP3. Extracodecdata is a pointer to an FMOD_AUDIOQUEUE_EXTRACODECDATA structure. + + + + + Impulse tracker. + + + + + Protracker / Fasttracker MOD. + + + + + MP2/MP3 MPEG. + + + + + Ogg vorbis. + + + + + ScreamTracker 3. + + + + + 3rd party / unknown plugin format. + + + + + VAG. + + + + + Microsoft WAV. + + + + + FastTracker 2 XM. + + + + + Xbox360 XMA. + + + + + Describes when an AudioSource or AudioListener is updated. + + + + + Updates the source or listener in the MonoBehaviour.FixedUpdate loop if it is attached to a Rigidbody, dynamic MonoBehaviour.Update otherwise. + + + + + Updates the source or listener in the dynamic MonoBehaviour.Update loop. + + + + + Updates the source or listener in the MonoBehaviour.FixedUpdate loop. + + + + + Avatar definition. + + + + + Return true if this avatar is a valid human avatar. + + + + + Return true if this avatar is a valid mecanim avatar. It can be a generic avatar or a human avatar. + + + + + Class to build avatars from user scripts. + + + + + Create a new generic avatar. + + Root object of your transform hierarchy. + Transform name of the root motion transform. If empty no root motion is defined and you must take care of avatar movement yourself. + + + + Create a humanoid avatar. + + Root object of your transform hierachy. It must be the top most gameobject when you create the avatar. + Humanoid description of the avatar. + + Returns the Avatar, you must always always check the avatar is valid before using it with Avatar.isValid. + + + + + IK Goal. + + + + + The left foot. + + + + + The left hand. + + + + + The right foot. + + + + + The right hand. + + + + + IK Hint. + + + + + The left elbow IK hint. + + + + + The left knee IK hint. + + + + + The right elbow IK hint. + + + + + The right knee IK hint. + + + + + AvatarMask is used to mask out humanoid body parts and transforms. + + + + + The number of humanoid body parts. + + + + + Number of transforms. + + + + + Adds a transform path into the AvatarMask. + + The transform to add into the AvatarMask. + Whether to also add all children of the specified transform. + + + + Creates a new AvatarMask. + + + + + Returns true if the humanoid body part at the given index is active. + + The index of the humanoid body part. + + + + Returns true if the transform at the given index is active. + + The index of the transform. + + + + Returns the path of the transform at the given index. + + The index of the transform. + + + + Removes a transform path from the AvatarMask. + + The Transform that should be removed from the AvatarMask. + Whether to also remove all children of the specified transform. + + + + Sets the humanoid body part at the given index to active or not. + + The index of the humanoid body part. + Active or not. + + + + Sets the tranform at the given index to active or not. + + The index of the transform. + Active or not. + + + + Sets the path of the transform at the given index. + + The index of the transform. + The path of the transform. + + + + Avatar body part. + + + + + The Body. + + + + + The Head. + + + + + Total number of body parts. + + + + + The Left Arm. + + + + + Left Fingers. + + + + + Left Foot IK. + + + + + Left Hand IK. + + + + + The Left Leg. + + + + + The Right Arm. + + + + + Right Fingers. + + + + + Right Foot IK. + + + + + Right Hand IK. + + + + + The Right Leg. + + + + + The Root. + + + + + Target. + + + + + The body, center of mass. + + + + + The left foot. + + + + + The left hand. + + + + + The right foot. + + + + + The right hand. + + + + + The root, the position of the game object. + + + + + Enumeration for SystemInfo.batteryStatus which represents the current status of the device's battery. + + + + + Device is plugged in and charging. + + + + + Device is unplugged and discharging. + + + + + Device is plugged in and the battery is full. + + + + + Device is plugged in, but is not charging. + + + + + The device's battery status cannot be determined. If battery status is not available on your target platform, SystemInfo.batteryStatus will return this value. + + + + + Use this BeforeRenderOrderAttribute when you need to specify a custom callback order for Application.onBeforeRender. + + + + + The order, lowest to highest, that the Application.onBeforeRender event recievers will be called in. + + + + + When applied to methods, specifies the order called during Application.onBeforeRender events. + + The sorting order, sorted lowest to highest. + + + + Behaviours are Components that can be enabled or disabled. + + + + + Enabled Behaviours are Updated, disabled Behaviours are not. + + + + + Has the Behaviour had active and enabled called? + + + + + BillboardAsset describes how a billboard is rendered. + + + + + Height of the billboard that is below ground. + + + + + Height of the billboard. + + + + + Number of pre-rendered images that can be switched when the billboard is viewed from different angles. + + + + + Number of indices in the billboard mesh. + + + + + The material used for rendering. + + + + + Number of vertices in the billboard mesh. + + + + + Width of the billboard. + + + + + Constructs a new BillboardAsset. + + + + + Get the array of billboard image texture coordinate data. + + The list that receives the array. + + + + Get the array of billboard image texture coordinate data. + + The list that receives the array. + + + + Get the indices of the billboard mesh. + + The list that receives the array. + + + + Get the indices of the billboard mesh. + + The list that receives the array. + + + + Get the vertices of the billboard mesh. + + The list that receives the array. + + + + Get the vertices of the billboard mesh. + + The list that receives the array. + + + + Set the array of billboard image texture coordinate data. + + The array of data to set. + + + + Set the array of billboard image texture coordinate data. + + The array of data to set. + + + + Set the indices of the billboard mesh. + + The array of data to set. + + + + Set the indices of the billboard mesh. + + The array of data to set. + + + + Set the vertices of the billboard mesh. + + The array of data to set. + + + + Set the vertices of the billboard mesh. + + The array of data to set. + + + + Renders a billboard from a BillboardAsset. + + + + + The BillboardAsset to render. + + + + + Constructor. + + + + + The BitStream class represents seralized variables, packed into a stream. + + + + + Is the BitStream currently being read? (Read Only) + + + + + Is the BitStream currently being written? (Read Only) + + + + + Serializes different types of variables. + + + + + + + + Serializes different types of variables. + + + + + + + + Serializes different types of variables. + + + + + + + + Serializes different types of variables. + + + + + + + + Serializes different types of variables. + + + + + + + + Serializes different types of variables. + + + + + + + + Serializes different types of variables. + + + + + + + + Serializes different types of variables. + + + + + + + + Serializes different types of variables. + + + + + + + + Serializes different types of variables. + + + + + + + + Serializes different types of variables. + + + + + + + + Serializes different types of variables. + + + + + + + + Blend weights. + + + + + Four bones affect each vertex. + + + + + One bone affects each vertex. + + + + + Two bones affect each vertex. + + + + + Enumeration of all the muscles in the body. + + + + + The chest front-back muscle. + + + + + The chest left-right muscle. + + + + + The chest roll left-right muscle. + + + + + The last value of the BodyDof enum. + + + + + The spine front-back muscle. + + + + + The spine left-right muscle. + + + + + The spine roll left-right muscle. + + + + + The upper chest front-back muscle. + + + + + The upper chest left-right muscle. + + + + + The upper chest roll left-right muscle. + + + + + Skinning bone weights of a vertex in the mesh. + + + + + Index of first bone. + + + + + Index of second bone. + + + + + Index of third bone. + + + + + Index of fourth bone. + + + + + Skinning weight for first bone. + + + + + Skinning weight for second bone. + + + + + Skinning weight for third bone. + + + + + Skinning weight for fourth bone. + + + + + Describes a single bounding sphere for use by a CullingGroup. + + + + + The position of the center of the BoundingSphere. + + + + + The radius of the BoundingSphere. + + + + + Initializes a BoundingSphere. + + The center of the sphere. + The radius of the sphere. + A four-component vector containing the position (packed into the XYZ components) and radius (packed into the W component). + + + + Initializes a BoundingSphere. + + The center of the sphere. + The radius of the sphere. + A four-component vector containing the position (packed into the XYZ components) and radius (packed into the W component). + + + + Represents an axis aligned bounding box. + + + + + The center of the bounding box. + + + + + The extents of the Bounding Box. This is always half of the size of the Bounds. + + + + + The maximal point of the box. This is always equal to center+extents. + + + + + The minimal point of the box. This is always equal to center-extents. + + + + + The total size of the box. This is always twice as large as the extents. + + + + + The closest point on the bounding box. + + Arbitrary point. + + The point on the bounding box or inside the bounding box. + + + + + Is point contained in the bounding box? + + + + + + Creates a new Bounds. + + The location of the origin of the Bounds. + The dimensions of the Bounds. + + + + Grows the Bounds to include the point. + + + + + + Grow the bounds to encapsulate the bounds. + + + + + + Expand the bounds by increasing its size by amount along each side. + + + + + + Expand the bounds by increasing its size by amount along each side. + + + + + + Does ray intersect this bounding box? + + + + + + Does ray intersect this bounding box? + + + + + + + Does another bounding box intersect with this bounding box? + + + + + + Sets the bounds to the min and max value of the box. + + + + + + + The smallest squared distance between the point and this bounding box. + + + + + + Returns a nicely formatted string for the bounds. + + + + + + Returns a nicely formatted string for the bounds. + + + + + + Represents an axis aligned bounding box with all values as integers. + + + + + A BoundsInt.PositionCollection that contains all positions within the BoundsInt. + + + + + The center of the bounding box. + + + + + The maximal point of the box. + + + + + The minimal point of the box. + + + + + The position of the bounding box. + + + + + The total size of the box. + + + + + X value of the minimal point of the box. + + + + + The maximal x point of the box. + + + + + The minimal x point of the box. + + + + + Y value of the minimal point of the box. + + + + + The maximal y point of the box. + + + + + The minimal y point of the box. + + + + + Z value of the minimal point of the box. + + + + + The maximal z point of the box. + + + + + The minimal z point of the box. + + + + + Clamps the position and size of this bounding box to the given bounds. + + Bounds to clamp to. + + + + Is point contained in the bounding box? + + Point to check. + Whether the max limits are included in the check. + + Is point contained in the bounding box? + + + + + Is point contained in the bounding box? + + Point to check. + Whether the max limits are included in the check. + + Is point contained in the bounding box? + + + + + An iterator that allows you to iterate over all positions within the BoundsInt. + + + + + Current position of the enumerator. + + + + + Returns this as an iterator that allows you to iterate over all positions within the BoundsInt. + + + This BoundsInt.PositionEnumerator. + + + + + Moves the enumerator to the next position. + + + Whether the enumerator has successfully moved to the next position. + + + + + Resets this enumerator to its starting state. + + + + + Sets the bounds to the min and max value of the box. + + + + + + + Returns a nicely formatted string for the bounds. + + + + + Use this struct to set up a box cast command to be performed asynchronously during a job. + + + + + Center of the box. + + + + + The direction in which to sweep the box. + + + + + The maximum distance of the sweep. + + + + + Half the size of the box in each dimension. + + + + + A LayerMask that is used to selectively ignore Colliders when casting a box. + + + + + Rotation of the box. + + + + + Creates a BoxcastCommand. + + Center of the box. + Half the size of the box in each dimension. + Rotation of the box. + The direction in which to sweep the box. + The maximum length of the cast. + A that is used to selectively ignore colliders when casting a box. + + + + + Schedules a batch of boxcasts to be performed in a job. + + A NativeArray of the BoxcastCommand to perform. + A NativeArray of RaycastHit where the result of commands are stored. + The minimum number of jobs which should be performed in a single job. + A JobHandle of a job that must be completed before performing the box casts. + + Returns a JobHandle of the job that will perform the box casts. + + + + + A box-shaped primitive collider. + + + + + The center of the box, measured in the object's local space. + + + + + The size of the box, measured in the object's local space. + + + + + Collider for 2D physics representing an axis-aligned rectangle. + + + + + Determines whether the BoxCollider2D's shape is automatically updated based on a SpriteRenderer's tiling properties. + + + + + The center point of the collider in local space. + + + + + Controls the radius of all edges created by the collider. + + + + + The width and height of the rectangle. + + + + + Contains information about compression methods, compression levels and block sizes that are supported by Asset Bundle compression at build time and recompression at runtime. + + + + + LZ4HC "Chunk Based" Compression. + + + + + LZ4 Compression for runtime recompression. + + + + + LZMA Compression. + + + + + Uncompressed Asset Bundle. + + + + + Uncompressed Asset Bundle. + + + + + Applies forces to simulate buoyancy, fluid-flow and fluid drag. + + + + + A force applied to slow angular movement of any Collider2D in contact with the effector. + + + + + The density of the fluid used to calculate the buoyancy forces. + + + + + The angle of the force used to similate fluid flow. + + + + + The magnitude of the force used to similate fluid flow. + + + + + The random variation of the force used to similate fluid flow. + + + + + A force applied to slow linear movement of any Collider2D in contact with the effector. + + + + + Defines an arbitrary horizontal line that represents the fluid surface level. + + + + + Data structure for cache. Please refer to See Also:Caching.AddCache for more information. + + + + + The number of seconds that an AssetBundle may remain unused in the cache before it is automatically deleted. + + + + + Returns the index of the cache in the cache list. + + + + + Allows you to specify the total number of bytes that can be allocated for the cache. + + + + + Returns the path of the cache. + + + + + Returns true if the cache is readonly. + + + + + Returns true if the cache is ready. + + + + + Returns the number of currently unused bytes in the cache. + + + + + Returns the used disk space in bytes. + + + + + Returns true if the cache is valid. + + + + + Removes all cached content in the cache that has been cached by the current application. + + The number of seconds that AssetBundles may remain unused in the cache. + + Returns True when cache clearing succeeded. + + + + + Removes all cached content in the cache that has been cached by the current application. + + The number of seconds that AssetBundles may remain unused in the cache. + + Returns True when cache clearing succeeded. + + + + + Data structure for downloading AssetBundles to a customized cache path. See Also:UnityWebRequestAssetBundle.GetAssetBundle for more information. + + + + + Hash128 which is used as the version of the AssetBundle. + + + + + AssetBundle name which is used as the customized cache path. + + + + + The Caching class lets you manage cached AssetBundles, downloaded using UnityWebRequestAssetBundle.GetAssetBundle(). + + + + + Returns the cache count in the cache list. + + + + + Controls compression of cache data. Enabled by default. + + + + + Gets or sets the current cache in which AssetBundles should be cached. + + + + + Returns the default cache which is added by Unity internally. + + + + + Returns true if Caching system is ready for use. + + + + + Add a cache with the given path. + + Path to the cache folder. + + + + Removes all the cached versions of the given AssetBundle from the cache. + + The AssetBundle name. + + Returns true when cache clearing succeeded. + + + + + Removes all AssetBundle content that has been cached by the current application. + + The number of seconds that AssetBundles may remain unused in the cache. + + True when cache clearing succeeded, false if cache was in use. + + + + + Removes all AssetBundle content that has been cached by the current application. + + The number of seconds that AssetBundles may remain unused in the cache. + + True when cache clearing succeeded, false if cache was in use. + + + + + Removes the given version of the AssetBundle. + + The AssetBundle name. + Version needs to be cleaned. + + Returns true when cache clearing succeeded. Can return false if any cached bundle is in use. + + + + + Removes all the cached versions of the AssetBundle from the cache, except for the specified version. + + The AssetBundle name. + Version needs to be kept. + + Returns true when cache clearing succeeded. + + + + + Returns all paths of the cache in the cache list. + + List of all the cache paths. + + + + Returns the Cache at the given position in the cache list. + + Index of the cache to get. + + A reference to the Cache at the index specified. + + + + + Returns the Cache that has the given cache path. + + The cache path. + + A reference to the Cache with the given path. + + + + + Returns all cached versions of the given AssetBundle. + + The AssetBundle name. + List of all the cached version. + + + + Checks if an AssetBundle is cached. + + Url The filename of the AssetBundle. Domain and path information are stripped from this string automatically. + Version The version number of the AssetBundle to check for. Negative values are not allowed. + + + + True if an AssetBundle matching the url and version parameters has previously been loaded using UnityWebRequestAssetBundle.GetAssetBundle() and is currently stored in the cache. Returns false if the AssetBundle is not in cache, either because it has been flushed from the cache or was never loaded using the Caching API. + + + + + Bumps the timestamp of a cached file to be the current time. + + + + + + + Moves the source Cache after the destination Cache in the cache list. + + The Cache to move. + The Cache which should come before the source Cache in the cache list. + + + + Moves the source Cache before the destination Cache in the cache list. + + The Cache to move. + The Cache which should come after the source Cache in the cache list. + + + + Removes the Cache from cache list. + + The Cache to be removed. + + Returns true if the Cache is removed. + + + + + A Camera is a device through which the player views the world. + + + + + Gets the temporary RenderTexture target for this Camera. + + + + + The rendering path that is currently being used (Read Only). + + + + + Returns all enabled cameras in the Scene. + + + + + The number of cameras in the current Scene. + + + + + Dynamic Resolution Scaling. + + + + + High dynamic range rendering. + + + + + MSAA rendering. + + + + + Determines whether the stereo view matrices are suitable to allow for a single pass cull. + + + + + The aspect ratio (width divided by height). + + + + + The color with which the screen will be cleared. + + + + + Matrix that transforms from camera space to world space (Read Only). + + + + + Identifies what kind of camera this is. + + + + + How the camera clears the background. + + + + + Should the camera clear the stencil buffer after the deferred light pass? + + + + + Number of command buffers set up on this camera (Read Only). + + + + + This is used to render parts of the Scene selectively. + + + + + Sets a custom matrix for the camera to use for all culling queries. + + + + + The camera we are currently rendering with, for low-level render control only (Read Only). + + + + + Camera's depth in the camera rendering order. + + + + + How and if camera generates a depth texture. + + + + + Mask to select which layers can trigger events on the camera. + + + + + The far clipping plane distance. + + + + + The field of view of the camera in degrees. + + + + + The camera focal length, expressed in millimeters. To use this property, enable UsePhysicalProperties. + + + + + Should camera rendering be forced into a RenderTexture. + + + + + There are two gates for a camera, the sensor gate and the resolution gate. The physical camera sensor gate is defined by the sensorSize property, the resolution gate is defined by the render target area. + + + + + High dynamic range rendering. + + + + + Per-layer culling distances. + + + + + How to perform per-layer culling for a Camera. + + + + + The lens offset of the camera. The lens shift is relative to the sensor size. For example, a lens shift of 0.5 offsets the sensor by half its horizontal size. + + + + + The first enabled camera tagged "MainCamera" (Read Only). + + + + + The near clipping plane distance. + + + + + Get or set the raw projection matrix with no camera offset (no jittering). + + + + + Event that is fired after any camera finishes rendering. + + + + + Event that is fired before any camera starts culling. + + + + + Event that is fired before any camera starts rendering. + + + + + Opaque object sorting mode. + + + + + Is the camera orthographic (true) or perspective (false)? + + + + + Camera's half-size when in orthographic mode. + + + + + How tall is the camera in pixels (not accounting for dynamic resolution scaling) (Read Only). + + + + + Where on the screen is the camera rendered in pixel coordinates. + + + + + How wide is the camera in pixels (not accounting for dynamic resolution scaling) (Read Only). + + + + + Get the view projection matrix used on the last frame. + + + + + Set a custom projection matrix. + + + + + Where on the screen is the camera rendered in normalized coordinates. + + + + + The rendering path that should be used, if possible. + + + + + How tall is the camera in pixels (accounting for dynamic resolution scaling) (Read Only). + + + + + How wide is the camera in pixels (accounting for dynamic resolution scaling) (Read Only). + + + + + If not null, the camera will only render the contents of the specified Scene. + + + + + The size of the camera sensor, expressed in millimeters. + + + + + Returns the eye that is currently rendering. +If called when stereo is not enabled it will return Camera.MonoOrStereoscopicEye.Mono. + +If called during a camera rendering callback such as OnRenderImage it will return the currently rendering eye. + +If called outside of a rendering callback and stereo is enabled, it will return the default eye which is Camera.MonoOrStereoscopicEye.Left. + + + + + Distance to a point where virtual eyes converge. + + + + + Stereoscopic rendering. + + + + + Render only once and use resulting image for both eyes. + + + + + The distance between the virtual eyes. Use this to query or set the current eye separation. Note that most VR devices provide this value, in which case setting the value will have no effect. + + + + + Defines which eye of a VR display the Camera renders into. + + + + + Set the target display for this Camera. + + + + + Destination render texture. + + + + + An axis that describes the direction along which the distances of objects are measured for the purpose of sorting. + + + + + Transparent object sorting mode. + + + + + Should the jittered matrix be used for transparency rendering? + + + + + Whether or not the Camera will use occlusion culling during rendering. + + + + + Enable [UsePhysicalProperties] to use physical camera properties to compute the field of view and the frustum. + + + + + Get the world-space speed of the camera (Read Only). + + + + + Matrix that transforms from world to camera space. + + + + + Add a command buffer to be executed at a specified place. + + When to execute the command buffer during rendering. + The buffer to execute. + + + + Adds a command buffer to the GPU's async compute queues and executes that command buffer when graphics processing reaches a given point. + + The point during the graphics processing at which this command buffer should commence on the GPU. + The buffer to execute. + The desired async compute queue type to execute the buffer on. + + + + Given viewport coordinates, calculates the view space vectors pointing to the four frustum corners at the specified camera depth. + + Normalized viewport coordinates to use for the frustum calculation. + Z-depth from the camera origin at which the corners will be calculated. + Camera eye projection matrix to use. + Output array for the frustum corner vectors. Cannot be null and length must be >= 4. + + + + Calculates and returns oblique near-plane projection matrix. + + Vector4 that describes a clip plane. + + Oblique near-plane projection matrix. + + + + + + Calculates the projection matrix from focal length, sensor size, lens shift, near plane distance, far plane distance, and Gate fit parameters. + To calculate the projection matrix without taking Gate fit into account, use Camera.GateFitMode.None . See Also: Camera.GateFitParameters + + + The calculated matrix. + Focal length in millimeters. + Sensor dimensions in Millimeters. + Lens offset relative to the sensor size. + Near plane distance. + Far plane distance. + Gate fit parameters to use. See Camera.GateFitParameters. + + + + Delegate type for camera callbacks. + + + + + + Makes this camera's settings match other camera. + + Copy camera settings to the other camera. + + + + Sets the non-jittered projection matrix, sourced from the VR SDK. + + Specifies the stereoscopic eye whose non-jittered projection matrix will be sourced from the VR SDK. + + + + Converts focal length to field of view. + + Focal length in millimeters. + Sensor size in millimeters. Use the sensor height to get the vertical field of view. Use the sensor width to get the horizontal field of view. + + field of view in degrees. + + + + + Converts field of view to focal length. Use either sensor height and vertical field of view or sensor width and horizontal field of view. + + field of view in degrees. + Sensor size in millimeters. + + Focal length in millimeters. + + + + + Enum used to specify how the sensor gate (sensor frame) defined by Camera.sensorSize fits into the resolution gate (render frame). + + + + + + Automatically selects a horizontal or vertical fit so that the sensor gate fits completely inside the resolution gate. + + + + + + + Fit the resolution gate horizontally within the sensor gate. + + + + + + + Stretch the sensor gate to fit exactly into the resolution gate. + + + + + + + Automatically selects a horizontal or vertical fit so that the render frame fits completely inside the resolution gate. + + + + + + + Fit the resolution gate vertically within the sensor gate. + + + + + + Wrapper for gate fit parameters + + + + + Aspect ratio of the resolution gate. + + + + + GateFitMode to use. See Camera.GateFitMode. + + + + + Wrapper for gate fit parameters. + + + + + + + Fills an array of Camera with the current cameras in the Scene, without allocating a new array. + + An array to be filled up with cameras currently in the Scene. + + + + Get command buffers to be executed at a specified place. + + When to execute the command buffer during rendering. + + Array of command buffers. + + + + + Gets the non-jittered projection matrix of a specific left or right stereoscopic eye. + + Specifies the stereoscopic eye whose non-jittered projection matrix needs to be returned. + + The non-jittered projection matrix of the specified stereoscopic eye. + + + + + Gets the projection matrix of a specific left or right stereoscopic eye. + + Specifies the stereoscopic eye whose projection matrix needs to be returned. + + The projection matrix of the specified stereoscopic eye. + + + + + Gets the left or right view matrix of a specific stereoscopic eye. + + Specifies the stereoscopic eye whose view matrix needs to be returned. + + The view matrix of the specified stereoscopic eye. + + + + + A Camera eye corresponding to the left or right human eye for stereoscopic rendering, or neither for non-stereoscopic rendering. + +A single Camera can render both left and right views in a single frame. Therefore, this enum describes which eye the Camera is currently rendering when returned by Camera.stereoActiveEye during a rendering callback (such as Camera.OnRenderImage), or which eye to act on when passed into a function. + +The default value is Camera.MonoOrStereoscopicEye.Left, so Camera.MonoOrStereoscopicEye.Left may be returned by some methods or properties when called outside of rendering if stereoscopic rendering is enabled. + + + + + Camera eye corresponding to stereoscopic rendering of the left eye. + + + + + Camera eye corresponding to non-stereoscopic rendering. + + + + + Camera eye corresponding to stereoscopic rendering of the right eye. + + + + + Remove all command buffers set on this camera. + + + + + Remove command buffer from execution at a specified place. + + When to execute the command buffer during rendering. + The buffer to execute. + + + + Remove command buffers from execution at a specified place. + + When to execute the command buffer during rendering. + + + + Render the camera manually. + + + + + Render into a static cubemap from this camera. + + The cube map to render to. + A bitmask which determines which of the six faces are rendered to. + + False if rendering fails, else true. + + + + + Render into a cubemap from this camera. + + A bitfield indicating which cubemap faces should be rendered into. + The texture to render to. + + False if rendering fails, else true. + + + + + Render one side of a stereoscopic 360-degree image into a cubemap from this camera. + + The texture to render to. + A bitfield indicating which cubemap faces should be rendered into. Set to the integer value 63 to render all faces. + A Camera eye corresponding to the left or right eye for stereoscopic rendering, or neither for non-stereoscopic rendering. + + False if rendering fails, else true. + + + + + Render the camera with shader replacement. + + + + + + + Revert all camera parameters to default. + + + + + Revert the aspect ratio to the screen's aspect ratio. + + + + + Make culling queries reflect the camera's built in parameters. + + + + + Reset to the default field of view. + + + + + Make the projection reflect normal camera's parameters. + + + + + Remove shader replacement from camera. + + + + + Reset the camera to using the Unity computed projection matrices for all stereoscopic eyes. + + + + + Reset the camera to using the Unity computed view matrices for all stereoscopic eyes. + + + + + Resets this Camera's transparency sort settings to the default. Default transparency settings are taken from GraphicsSettings instead of directly from this Camera. + + + + + Make the rendering position reflect the camera's position in the Scene. + + + + + Returns a ray going from camera through a screen point. + + Optional argument that can be used to specify which eye transform to use. Default is Mono. + + + + + Returns a ray going from camera through a screen point. + + Optional argument that can be used to specify which eye transform to use. Default is Mono. + + + + + Transforms position from screen space into viewport space. + + + + + + Transforms position from screen space into world space. + + + + + + Make the camera render with shader replacement. + + + + + + + Sets custom projection matrices for both the left and right stereoscopic eyes. + + Projection matrix for the stereoscopic left eye. + Projection matrix for the stereoscopic right eye. + + + + Sets a custom projection matrix for a specific stereoscopic eye. + + Specifies the stereoscopic eye whose projection matrix needs to be set. + The matrix to be set. + + + + Set custom view matrices for both eyes. + + View matrix for the stereo left eye. + View matrix for the stereo right eye. + + + + Sets a custom view matrix for a specific stereoscopic eye. + + Specifies the stereoscopic view matrix to set. + The matrix to be set. + + + + Sets the Camera to render to the chosen buffers of one or more RenderTextures. + + The RenderBuffer(s) to which color information will be rendered. + The RenderBuffer to which depth information will be rendered. + + + + Sets the Camera to render to the chosen buffers of one or more RenderTextures. + + The RenderBuffer(s) to which color information will be rendered. + The RenderBuffer to which depth information will be rendered. + + + + Enum used to specify either the left or the right eye of a stereoscopic camera. + + + + + Specifies the target to be the left eye. + + + + + Specifies the target to be the right eye. + + + + + Returns a ray going from camera through a viewport point. + + Optional argument that can be used to specify which eye transform to use. Default is Mono. + + + + + Returns a ray going from camera through a viewport point. + + Optional argument that can be used to specify which eye transform to use. Default is Mono. + + + + + Transforms position from viewport space into screen space. + + + + + + Transforms position from viewport space into world space. + + The 3d vector in Viewport space. + + The 3d vector in World space. + + + + + Transforms position from world space into screen space. + + Optional argument that can be used to specify which eye transform to use. Default is Mono. + + + + + Transforms position from world space into screen space. + + Optional argument that can be used to specify which eye transform to use. Default is Mono. + + + + + Transforms position from world space into viewport space. + + Optional argument that can be used to specify which eye transform to use. Default is Mono. + + + + + Transforms position from world space into viewport space. + + Optional argument that can be used to specify which eye transform to use. Default is Mono. + + + + + Values for Camera.clearFlags, determining what to clear when rendering a Camera. + + + + + Clear only the depth buffer. + + + + + Don't clear anything. + + + + + Clear with the skybox. + + + + + Clear with a background color. + + + + + Describes different types of camera. + + + + + Used to indicate a regular in-game camera. + + + + + Used to indicate a camera that is used for rendering previews in the Editor. + + + + + Used to indicate a camera that is used for rendering reflection probes. + + + + + Used to indicate that a camera is used for rendering the Scene View in the Editor. + + + + + Used to indicate that a camera is used for rendering VR (in edit mode) in the Editor. + + + + + Element that can be used for screen rendering. + + + + + Get or set the mask of additional shader channels to be used when creating the Canvas mesh. + + + + + Cached calculated value based upon SortingLayerID. + + + + + Is this the root Canvas? + + + + + The normalized grid size that the canvas will split the renderable area into. + + + + + Allows for nested canvases to override pixelPerfect settings inherited from parent canvases. + + + + + Override the sorting of canvas. + + + + + Force elements in the canvas to be aligned with pixels. Only applies with renderMode is Screen Space. + + + + + Get the render rect for the Canvas. + + + + + How far away from the camera is the Canvas generated. + + + + + The number of pixels per unit that is considered the default. + + + + + Is the Canvas in World or Overlay mode? + + + + + The render order in which the canvas is being emitted to the Scene. (Read Only) + + + + + Returns the Canvas closest to root, by checking through each parent and returning the last canvas found. If no other canvas is found then the canvas will return itself. + + + + + Used to scale the entire canvas, while still making it fit the screen. Only applies with renderMode is Screen Space. + + + + + The normalized grid size that the canvas will split the renderable area into. + + + + + Unique ID of the Canvas' sorting layer. + + + + + Name of the Canvas' sorting layer. + + + + + Canvas' order within a sorting layer. + + + + + For Overlay mode, display index on which the UI canvas will appear. + + + + + Event that is called just before Canvas rendering happens. + + + + + + Camera used for sizing the Canvas when in Screen Space - Camera. Also used as the Camera that events will be sent through for a World Space [[Canvas]. + + + + + Force all canvases to update their content. + + + + + Returns the default material that can be used for rendering normal elements on the Canvas. + + + + + Returns the default material that can be used for rendering text elements on the Canvas. + + + + + Gets or generates the ETC1 Material. + + + The generated ETC1 Material from the Canvas. + + + + + A Canvas placable element that can be used to modify children Alpha, Raycasting, Enabled state. + + + + + Set the alpha of the group. + + + + + Does this group block raycasting (allow collision). + + + + + Should the group ignore parent groups? + + + + + Is the group interactable (are the elements beneath the group enabled). + + + + + Returns true if the Group allows raycasts. + + + + + + + A component that will render to the screen after all normal rendering has completed when attached to a Canvas. Designed for GUI application. + + + + + Depth of the renderer relative to the root canvas. + + + + + Indicates whether geometry emitted by this renderer is ignored. + + + + + Indicates whether geometry emitted by this renderer can be ignored when the vertex color alpha is close to zero for every vertex of the mesh. + + + + + True if any change has occured that would invalidate the positions of generated geometry. + + + + + Enable 'render stack' pop draw call. + + + + + True if rect clipping has been enabled on this renderer. +See Also: CanvasRenderer.EnableRectClipping, CanvasRenderer.DisableRectClipping. + + + + + Is the UIRenderer a mask component. + + + + + The number of materials usable by this renderer. + + + + + (Editor Only) Event that gets fired whenever the data in the CanvasRenderer gets invalidated and needs to be rebuilt. + + + + + + The number of materials usable by this renderer. Used internally for masking. + + + + + Depth of the renderer realative to the parent canvas. + + + + + Take the Vertex steam and split it corrisponding arrays (positions, colors, uv0s, uv1s, normals and tangents). + + The UIVertex list to split. + The destination list for the verts positions. + The destination list for the verts colors. + The destination list for the verts uv0s. + The destination list for the verts uv1s. + The destination list for the verts normals. + The destination list for the verts tangents. + + + + Remove all cached vertices. + + + + + Convert a set of vertex components into a stream of UIVertex. + + + + + + + + + + + + + Disables rectangle clipping for this CanvasRenderer. + + + + + Enables rect clipping on the CanvasRendered. Geometry outside of the specified rect will be clipped (not rendered). + + + + + + Get the current alpha of the renderer. + + + + + Get the current color of the renderer. + + + + + Get the final inherited alpha calculated by including all the parent alphas from included parent CanvasGroups. + + + The calculated inherited alpha. + + + + + Gets the current Material assigned to the CanvasRenderer. + + The material index to retrieve (0 if this parameter is omitted). + + Result. + + + + + Gets the current Material assigned to the CanvasRenderer. + + The material index to retrieve (0 if this parameter is omitted). + + Result. + + + + + Gets the current Material assigned to the CanvasRenderer. Used internally for masking. + + + + + + Set the alpha of the renderer. Will be multiplied with the UIVertex alpha and the Canvas alpha. + + Alpha. + + + + The Alpha Texture that will be passed to the Shader under the _AlphaTex property. + + The Texture to be passed. + + + + Set the color of the renderer. Will be multiplied with the UIVertex color and the Canvas color. + + Renderer multiply color. + + + + Set the material for the canvas renderer. If a texture is specified then it will be used as the 'MainTex' instead of the material's 'MainTex'. +See Also: CanvasRenderer.SetMaterialCount, CanvasRenderer.SetTexture. + + Material for rendering. + Material texture overide. + Material index. + + + + Set the material for the canvas renderer. If a texture is specified then it will be used as the 'MainTex' instead of the material's 'MainTex'. +See Also: CanvasRenderer.SetMaterialCount, CanvasRenderer.SetTexture. + + Material for rendering. + Material texture overide. + Material index. + + + + Sets the Mesh used by this renderer. + + + + + + Set the material for the canvas renderer. Used internally for masking. + + + + + + + Sets the texture used by this renderer's material. + + + + + + Set the vertices for the UIRenderer. + + Array of vertices to set. + Number of vertices to set. + + + + Set the vertices for the UIRenderer. + + Array of vertices to set. + Number of vertices to set. + + + + Given a list of UIVertex, split the stream into it's component types. + + + + + + + + + + + + + Use this struct to set up a capsule cast command that is performed asynchronously during a job. + + + + + The direction of the capsule cast. + + + + + The maximum distance the capsule cast checks for collision. + + + + + A LayerMask that selectively ignores Colliders when casting a capsule. + + + + + The center of the sphere at the start of the capsule. + + + + + The center of the sphere at the end of the capsule. + + + + + The radius of the capsule. + + + + + Creates a CapsulecastCommand. + + The center of the sphere at the start of the capsule. + The center of the sphere at the end of the capsule. + The radius of the capsule. + The direction of the capsule cast + The maximum length of the sweep. + The LayerMask that selectively ignores Colliders when casting a capsule. + + + + Schedules a batch of capsule casts which are performed in a job. + + A NaviveArray of CapsulecastCommands to perform. + A NavtiveArray of RaycastHit where the result of commands are stored. + The minimum number of jobs which should be performed in a single job. + A jobHandle of a job that must be completed before performing capsule casts. + + Returns a JobHandle of the job that will performs the capsule casts. + + + + + A capsule-shaped primitive collider. + + + + + The center of the capsule, measured in the object's local space. + + + + + The direction of the capsule. + + + + + The height of the capsule measured in the object's local space. + + + + + The radius of the sphere, measured in the object's local space. + + + + + A capsule-shaped primitive collider. + + + + + The direction that the capsule sides can extend. + + + + + The width and height of the capsule area. + + + + + The direction that the capsule sides can extend. + + + + + The capsule sides extend horizontally. + + + + + The capsule sides extend vertically. + + + + + A CharacterController allows you to easily do movement constrained by collisions without having to deal with a rigidbody. + + + + + The center of the character's capsule relative to the transform's position. + + + + + What part of the capsule collided with the environment during the last CharacterController.Move call. + + + + + Determines whether other rigidbodies or character controllers collide with this character controller (by default this is always enabled). + + + + + Enables or disables overlap recovery. + Enables or disables overlap recovery. Used to depenetrate character controllers from static objects when an overlap is detected. + + + + + The height of the character's capsule. + + + + + Was the CharacterController touching the ground during the last move? + + + + + Gets or sets the minimum move distance of the character controller. + + + + + The radius of the character's capsule. + + + + + The character's collision skin width. + + + + + The character controllers slope limit in degrees. + + + + + The character controllers step offset in meters. + + + + + The current relative velocity of the Character (see notes). + + + + + A more complex move function taking absolute movement deltas. + + + + + + Moves the character with speed. + + + + + + Specification for how to render a character from the font texture. See Font.characterInfo. + + + + + The horizontal distance, rounded to the nearest integer, from the origin of this character to the origin of the next character. + + + + + The horizontal distance from the origin of this glyph to the begining of the glyph image. + + + + + Is the character flipped? + + + + + The height of the glyph image. + + + + + The width of the glyph image. + + + + + Unicode value of the character. + + + + + The maximum extend of the glyph image in the x-axis. + + + + + The maximum extend of the glyph image in the y-axis. + + + + + The minium extend of the glyph image in the x-axis. + + + + + The minimum extend of the glyph image in the y-axis. + + + + + The size of the character or 0 if it is the default font size. + + + + + The style of the character. + + + + + UV coordinates for the character in the texture. + + + + + The uv coordinate matching the bottom left of the glyph image in the font texture. + + + + + The uv coordinate matching the bottom right of the glyph image in the font texture. + + + + + The uv coordinate matching the top left of the glyph image in the font texture. + + + + + The uv coordinate matching the top right of the glyph image in the font texture. + + + + + Screen coordinates for the character in generated text meshes. + + + + + How far to advance between the beginning of this charcater and the next. + + + + + Character Joints are mainly used for Ragdoll effects. + + + + + Brings violated constraints back into alignment even when the solver fails. + + + + + The upper limit around the primary axis of the character joint. + + + + + The lower limit around the primary axis of the character joint. + + + + + Set the angular tolerance threshold (in degrees) for projection. + + + + + Set the linear tolerance threshold for projection. + + + + + The angular limit of rotation (in degrees) around the primary axis of the character joint. + + + + + The angular limit of rotation (in degrees) around the primary axis of the character joint. + + + + + The secondary axis around which the joint can rotate. + + + + + The configuration of the spring attached to the swing limits of the joint. + + + + + The configuration of the spring attached to the twist limits of the joint. + + + + + Collider for 2D physics representing an circle. + + + + + The center point of the collider in local space. + + + + + Radius of the circle. + + + + + The Cloth class provides an interface to cloth simulation physics. + + + + + Bending stiffness of the cloth. + + + + + An array of CapsuleColliders which this Cloth instance should collide with. + + + + + Number of cloth solver iterations per second. + + + + + The cloth skinning coefficients used to set up how the cloth interacts with the skinned mesh. + + + + + How much to increase mass of colliding particles. + + + + + Damp cloth motion. + + + + + Enable continuous collision to improve collision stability. + + + + + Is this cloth enabled? + + + + + A constant, external acceleration applied to the cloth. + + + + + The friction of the cloth when colliding with the character. + + + + + The current normals of the cloth object. + + + + + A random, external acceleration applied to the cloth. + + + + + Minimum distance at which two cloth particles repel each other (default: 0.0). + + + + + Self-collision stiffness defines how strong the separating impulse should be for colliding particles. + + + + + Cloth's sleep threshold. + + + + + An array of ClothSphereColliderPairs which this Cloth instance should collide with. + + + + + Sets the stiffness frequency parameter. + + + + + Stretching stiffness of the cloth. + + + + + Should gravity affect the cloth simulation? + + + + + Use Tether Anchors. + + + + + Add one virtual particle per triangle to improve collision stability. + + + + + The current vertex positions of the cloth object. + + + + + How much world-space acceleration of the character will affect cloth vertices. + + + + + How much world-space movement of the character will affect cloth vertices. + + + + + Clear the pending transform changes from affecting the cloth simulation. + + + + + Get list of particles to be used for self and inter collision. + + List to be populated with cloth particle indices that are used for self and/or inter collision. + + + + Get list of indices to be used when generating virtual particles. + + List to be populated with virtual particle indices. + + + + Get weights to be used when generating virtual particles for cloth. + + List to populate with virtual particle weights. + + + + Fade the cloth simulation in or out. + + Fading enabled or not. + + + + + This allows you to set the cloth indices used for self and inter collision. + + List of cloth particles indices to use for cloth self and/or inter collision. + + + + Set indices to use when generating virtual particles. + + List of cloth particle indices to use when generating virtual particles. + + + + Sets weights to be used when generating virtual particles for cloth. + + List of weights to be used when setting virutal particles for cloth. + + + + The ClothSkinningCoefficient struct is used to set up how a Cloth component is allowed to move with respect to the SkinnedMeshRenderer it is attached to. + + + + + Definition of a sphere a vertex is not allowed to enter. This allows collision against the animated cloth. + + + + + Distance a vertex is allowed to travel from the skinned mesh vertex position. + + + + + A pair of SphereColliders used to define shapes for Cloth objects to collide against. + + + + + The first SphereCollider of a ClothSphereColliderPair. + + + + + The second SphereCollider of a ClothSphereColliderPair. + + + + + Creates a ClothSphereColliderPair. If only one SphereCollider is given, the ClothSphereColliderPair will define a simple sphere. If two SphereColliders are given, the ClothSphereColliderPair defines a conic capsule shape, composed of the two spheres and the cone connecting the two. + + The first SphereCollider of a ClothSphereColliderPair. + The second SphereCollider of a ClothSphereColliderPair. + + + + Creates a ClothSphereColliderPair. If only one SphereCollider is given, the ClothSphereColliderPair will define a simple sphere. If two SphereColliders are given, the ClothSphereColliderPair defines a conic capsule shape, composed of the two spheres and the cone connecting the two. + + The first SphereCollider of a ClothSphereColliderPair. + The second SphereCollider of a ClothSphereColliderPair. + + + + Interface for reading and writing inputs in a Unity Cluster. + + + + + Add a new VRPN input entry. + + Name of the input entry. This has to be unique. + Device name registered to VRPN server. + URL to the vrpn server. + Index of the Input entry, refer to vrpn.cfg if unsure. + Type of the input. + + True if the operation succeed. + + + + + Check the connection status of the device to the VRPN server it connected to. + + Name of the input entry. + + + + Edit an input entry which added via ClusterInput.AddInput. + + Name of the input entry. This has to be unique. + Device name registered to VRPN server. + URL to the vrpn server. + Index of the Input entry, refer to vrpn.cfg if unsure. + Type of the ClusterInputType as follow. + + + + Returns the axis value as a continous float. + + Name of input to poll.c. + + + + Returns the binary value of a button. + + Name of input to poll. + + + + Return the position of a tracker as a Vector3. + + Name of input to poll. + + + + Returns the rotation of a tracker as a Quaternion. + + Name of input to poll. + + + + Sets the axis value for this input. Only works for input typed Custom. + + Name of input to modify. + Value to set. + + + + Sets the button value for this input. Only works for input typed Custom. + + Name of input to modify. + Value to set. + + + + Sets the tracker position for this input. Only works for input typed Custom. + + Name of input to modify. + Value to set. + + + + Sets the tracker rotation for this input. Only works for input typed Custom. + + Name of input to modify. + Value to set. + + + + Values to determine the type of input value to be expect from one entry of ClusterInput. + + + + + Device is an analog axis that provides continuous value represented by a float. + + + + + Device that return a binary result of pressed or not pressed. + + + + + A user customized input. + + + + + Device that provide position and orientation values. + + + + + A helper class that contains static method to inquire status of Unity Cluster. + + + + + Check whether the current instance is disconnected from the cluster network. + + + + + Check whether the current instance is a master node in the cluster network. + + + + + To acquire or set the node index of the current machine from the cluster network. + + + + + A base class of all colliders. + + + + + The rigidbody the collider is attached to. + + + + + The world space bounding volume of the collider (Read Only). + + + + + Contact offset value of this collider. + + + + + Enabled Colliders will collide with other Colliders, disabled Colliders won't. + + + + + Is the collider a trigger? + + + + + The material used by the collider. + + + + + The shared physic material of this collider. + + + + + Returns a point on the collider that is closest to a given location. + + Location you want to find the closest point to. + + The point on the collider that is closest to the specified location. + + + + + The closest point to the bounding box of the attached collider. + + + + + + Casts a Ray that ignores all Colliders except this one. + + The starting point and direction of the ray. + If true is returned, hitInfo will contain more information about where the collider was hit. + The max length of the ray. + + True when the ray intersects the collider, otherwise false. + + + + + Parent class for collider types used with 2D gameplay. + + + + + The Rigidbody2D attached to the Collider2D. + + + + + Get the bounciness used by the collider. + + + + + The world space bounding area of the collider. + + + + + Get the CompositeCollider2D that is available to be attached to the collider. + + + + + The density of the collider used to calculate its mass (when auto mass is enabled). + + + + + Get the friction used by the collider. + + + + + Is this collider configured as a trigger? + + + + + The local offset of the collider geometry. + + + + + The number of separate shaped regions in the collider. + + + + + The PhysicsMaterial2D that is applied to this collider. + + + + + Sets whether the Collider will be used or not used by a CompositeCollider2D. + + + + + Whether the collider is used by an attached effector or not. + + + + + Casts the collider shape into the Scene starting at the collider position ignoring the collider itself. + + Vector representing the direction to cast the shape. + Array to receive results. + Maximum distance over which to cast the shape. + Should colliders attached to the same Rigidbody2D (known as sibling colliders) be ignored? + + The number of results returned. + + + + + Casts the collider shape into the Scene starting at the collider position ignoring the collider itself. + + Vector representing the direction to cast the shape. + Filter results defined by the contact filter. + Array to receive results. + Maximum distance over which to cast the shape. + Should colliders attached to the same Rigidbody2D (known as sibling colliders) be ignored? + + The number of results returned. + + + + + Calculates the minimum separation of this collider against another collider. + + A collider used to calculate the minimum separation against this collider. + + The minimum separation of collider and this collider. + + + + + Retrieves all contact points for this collider. + + An array of ContactPoint2D used to receive the results. + + Returns the number of contacts placed in the contacts array. + + + + + Retrieves all colliders in contact with this collider. + + An array of Collider2D used to receive the results. + + Returns the number of contacts placed in the colliders array. + + + + + Retrieves all contact points for this collider, with the results filtered by the ContactFilter2D. + + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + An array of ContactPoint2D used to receive the results. + + Returns the number of contacts placed in the contacts array. + + + + + Retrieves all colliders in contact with this collider, with the results filtered by the ContactFilter2D. + + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + An array of Collider2D used to receive the results. + + Returns the number of collidersplaced in the colliders array. + + + + + Check whether this collider is touching the collider or not. + + The collider to check if it is touching this collider. + + Whether this collider is touching the collider or not. + + + + + Check whether this collider is touching the collider or not with the results filtered by the ContactFilter2D. + + The collider to check if it is touching this collider. + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + + Whether this collider is touching the collider or not. + + + + + Check whether this collider is touching other colliders or not with the results filtered by the ContactFilter2D. + + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + + Whether this collider is touching the collider or not. + + + + + Checks whether this collider is touching any colliders on the specified layerMask or not. + + Any colliders on any of these layers count as touching. + + Whether this collider is touching any collider on the specified layerMask or not. + + + + + Get a list of all colliders that overlap this collider. + + The contact filter used to filter the results differently, such as by layer mask, Z depth. Note that normal angle is not used for overlap testing. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + + Returns the number of results placed in the results array. + + + + + Check if a collider overlaps a point in space. + + A point in world space. + + Does point overlap the collider? + + + + + Casts a ray into the Scene starting at the collider position ignoring the collider itself. + + Vector representing the direction of the ray. + Array to receive results. + Maximum distance over which to cast the ray. + Filter to check objects only on specific layers. + Only include objects with a Z coordinate (depth) greater than this value. + Only include objects with a Z coordinate (depth) less than this value. + Filter results defined by the contact filter. + + The number of results returned. + + + + + Casts a ray into the Scene starting at the collider position ignoring the collider itself. + + Vector representing the direction of the ray. + Array to receive results. + Maximum distance over which to cast the ray. + Filter to check objects only on specific layers. + Only include objects with a Z coordinate (depth) greater than this value. + Only include objects with a Z coordinate (depth) less than this value. + Filter results defined by the contact filter. + + The number of results returned. + + + + + Represents the separation or overlap of two Collider2D. + + + + + Gets the distance between two colliders. + + + + + Gets whether the distance represents an overlap or not. + + + + + Gets whether the distance is valid or not. + + + + + A normalized vector that points from pointB to pointA. + + + + + A point on a Collider2D that is a specific distance away from pointB. + + + + + A point on a Collider2D that is a specific distance away from pointA. + + + + + Describes a collision. + + + + + The Collider we hit (Read Only). + + + + + Gets the number of contacts for this collision. + + + + + The contact points generated by the physics engine. You should avoid using this as it produces memory garbage. Use GetContact or GetContacts instead. + + + + + The GameObject whose collider you are colliding with. (Read Only). + + + + + The total impulse applied to this contact pair to resolve the collision. + + + + + The relative linear velocity of the two colliding objects (Read Only). + + + + + The Rigidbody we hit (Read Only). This is null if the object we hit is a collider with no rigidbody attached. + + + + + The Transform of the object we hit (Read Only). + + + + + Gets the contact point at the specified index. + + The index of the contact to retrieve. + + The contact at the specified index. + + + + + Retrieves all contact points for this collision. + + An array of ContactPoint used to receive the results. + + Returns the number of contacts placed in the contacts array. + + + + + Collision details returned by 2D physics callback functions. + + + + + The incoming Collider2D involved in the collision with the otherCollider. + + + + + Gets the number of contacts for this collision. + + + + + The specific points of contact with the incoming Collider2D. You should avoid using this as it produces memory garbage. Use GetContact or GetContacts instead. + + + + + Indicates whether the collision response or reaction is enabled or disabled. + + + + + The incoming GameObject involved in the collision. + + + + + The other Collider2D involved in the collision with the collider. + + + + + The other Rigidbody2D involved in the collision with the rigidbody. + + + + + The relative linear velocity of the two colliding objects (Read Only). + + + + + The incoming Rigidbody2D involved in the collision with the otherRigidbody. + + + + + The Transform of the incoming object involved in the collision. + + + + + Gets the contact point at the specified index. + + The index of the contact to retrieve. + + The contact at the specified index. + + + + + Retrieves all contact points for contacts between collider and otherCollider. + + An array of ContactPoint2D used to receive the results. + + Returns the number of contacts placed in the contacts array. + + + + + The collision detection mode constants used for Rigidbody.collisionDetectionMode. + + + + + Continuous collision detection is on for colliding with static mesh geometry. + + + + + Continuous collision detection is on for colliding with static and dynamic geometry. + + + + + Speculative continuous collision detection is on for static and dynamic geometries + + + + + Continuous collision detection is off for this Rigidbody. + + + + + Controls how collisions are detected when a Rigidbody2D moves. + + + + + Ensures that all collisions are detected when a Rigidbody2D moves. + + + + + When a Rigidbody2D moves, only collisions at the new position are detected. + + + + + This mode is obsolete. You should use Discrete mode. + + + + + CollisionFlags is a bitmask returned by CharacterController.Move. + + + + + CollisionFlags is a bitmask returned by CharacterController.Move. + + + + + CollisionFlags is a bitmask returned by CharacterController.Move. + + + + + CollisionFlags is a bitmask returned by CharacterController.Move. + + + + + CollisionFlags is a bitmask returned by CharacterController.Move. + + + + + Representation of RGBA colors. + + + + + Alpha component of the color (0 is transparent, 1 is opaque). + + + + + Blue component of the color. + + + + + Solid black. RGBA is (0, 0, 0, 1). + + + + + Solid blue. RGBA is (0, 0, 1, 1). + + + + + Completely transparent. RGBA is (0, 0, 0, 0). + + + + + Cyan. RGBA is (0, 1, 1, 1). + + + + + Green component of the color. + + + + + A version of the color that has had the gamma curve applied. + + + + + Gray. RGBA is (0.5, 0.5, 0.5, 1). + + + + + The grayscale value of the color. (Read Only) + + + + + Solid green. RGBA is (0, 1, 0, 1). + + + + + English spelling for gray. RGBA is the same (0.5, 0.5, 0.5, 1). + + + + + A linear value of an sRGB color. + + + + + Magenta. RGBA is (1, 0, 1, 1). + + + + + Returns the maximum color component value: Max(r,g,b). + + + + + Red component of the color. + + + + + Solid red. RGBA is (1, 0, 0, 1). + + + + + Solid white. RGBA is (1, 1, 1, 1). + + + + + Yellow. RGBA is (1, 0.92, 0.016, 1), but the color is nice to look at! + + + + + Constructs a new Color with given r,g,b,a components. + + Red component. + Green component. + Blue component. + Alpha component. + + + + Constructs a new Color with given r,g,b components and sets a to 1. + + Red component. + Green component. + Blue component. + + + + Creates an RGB colour from HSV input. + + Hue [0..1]. + Saturation [0..1]. + Brightness value [0..1]. + Output HDR colours. If true, the returned colour will not be clamped to [0..1]. + + An opaque colour with HSV matching the input. + + + + + Creates an RGB colour from HSV input. + + Hue [0..1]. + Saturation [0..1]. + Brightness value [0..1]. + Output HDR colours. If true, the returned colour will not be clamped to [0..1]. + + An opaque colour with HSV matching the input. + + + + + Colors can be implicitly converted to and from Vector4. + + + + + + Colors can be implicitly converted to and from Vector4. + + + + + + Linearly interpolates between colors a and b by t. + + Color a. + Color b. + Float for combining a and b. + + + + Linearly interpolates between colors a and b by t. + + + + + + + + Divides color a by the float b. Each color component is scaled separately. + + + + + + + Subtracts color b from color a. Each component is subtracted separately. + + + + + + + Multiplies two colors together. Each component is multiplied separately. + + + + + + + Multiplies color a by the float b. Each color component is scaled separately. + + + + + + + Multiplies color a by the float b. Each color component is scaled separately. + + + + + + + Adds two colors together. Each component is added separately. + + + + + + + Calculates the hue, saturation and value of an RGB input color. + + An input color. + Output variable for hue. + Output variable for saturation. + Output variable for value. + + + + Access the r, g, b,a components using [0], [1], [2], [3] respectively. + + + + + Returns a nicely formatted string of this color. + + + + + + Returns a nicely formatted string of this color. + + + + + + Representation of RGBA colors in 32 bit format. + + + + + Alpha component of the color. + + + + + Blue component of the color. + + + + + Green component of the color. + + + + + Red component of the color. + + + + + Constructs a new Color32 with given r, g, b, a components. + + + + + + + + + Color32 can be implicitly converted to and from Color. + + + + + + Color32 can be implicitly converted to and from Color. + + + + + + Linearly interpolates between colors a and b by t. + + + + + + + + Linearly interpolates between colors a and b by t. + + + + + + + + Returns a nicely formatted string of this color. + + + + + + Returns a nicely formatted string of this color. + + + + + + Represents a color gamut. + + + + + sRGB color gamut. + + + + + Display-P3 color gamut. + + + + + DolbyHDR high dynamic range color gamut. + + + + + HDR10 high dynamic range color gamut. + + + + + Rec. 2020 color gamut. + + + + + Rec. 709 color gamut. + + + + + Color space for player settings. + + + + + Gamma color space. + + + + + Linear color space. + + + + + Uninitialized color space. + + + + + Attribute used to configure the usage of the ColorField and Color Picker for a color. + + + + + If set to true the Color is treated as a HDR color. + + + + + Maximum allowed HDR color component value when using the HDR Color Picker. + + + + + Maximum exposure value allowed in the HDR Color Picker. + + + + + Minimum allowed HDR color component value when using the Color Picker. + + + + + Minimum exposure value allowed in the HDR Color Picker. + + + + + If false then the alpha bar is hidden in the ColorField and the alpha value is not shown in the Color Picker. + + + + + Attribute for Color fields. Used for configuring the GUI for the color. + + If false then the alpha channel info is hidden both in the ColorField and in the Color Picker. + Set to true if the color should be treated as a HDR color (default value: false). + Minimum allowed HDR color component value when using the HDR Color Picker (default value: 0). + Maximum allowed HDR color component value when using the HDR Color Picker (default value: 8). + Minimum exposure value allowed in the HDR Color Picker (default value: 1/8 = 0.125). + Maximum exposure value allowed in the HDR Color Picker (default value: 3). + + + + Attribute for Color fields. Used for configuring the GUI for the color. + + If false then the alpha channel info is hidden both in the ColorField and in the Color Picker. + Set to true if the color should be treated as a HDR color (default value: false). + Minimum allowed HDR color component value when using the HDR Color Picker (default value: 0). + Maximum allowed HDR color component value when using the HDR Color Picker (default value: 8). + Minimum exposure value allowed in the HDR Color Picker (default value: 1/8 = 0.125). + Maximum exposure value allowed in the HDR Color Picker (default value: 3). + + + + Attribute for Color fields. Used for configuring the GUI for the color. + + If false then the alpha channel info is hidden both in the ColorField and in the Color Picker. + Set to true if the color should be treated as a HDR color (default value: false). + Minimum allowed HDR color component value when using the HDR Color Picker (default value: 0). + Maximum allowed HDR color component value when using the HDR Color Picker (default value: 8). + Minimum exposure value allowed in the HDR Color Picker (default value: 1/8 = 0.125). + Maximum exposure value allowed in the HDR Color Picker (default value: 3). + + + + A collection of common color functions. + + + + + Returns the color as a hexadecimal string in the format "RRGGBB". + + The color to be converted. + + Hexadecimal string representing the color. + + + + + Returns the color as a hexadecimal string in the format "RRGGBBAA". + + The color to be converted. + + Hexadecimal string representing the color. + + + + + Attempts to convert a html color string. + + Case insensitive html string to be converted into a color. + The converted color. + + True if the string was successfully converted else false. + + + + + Struct used to describe meshes to be combined using Mesh.CombineMeshes. + + + + + The baked lightmap UV scale and offset applied to the Mesh. + + + + + Mesh to combine. + + + + + The realtime lightmap UV scale and offset applied to the Mesh. + + + + + Sub-Mesh index of the Mesh. + + + + + Matrix to transform the Mesh with before combining. + + + + + Interface into compass functionality. + + + + + Used to enable or disable compass. Note, that if you want Input.compass.trueHeading property to contain a valid value, you must also enable location updates by calling Input.location.Start(). + + + + + Accuracy of heading reading in degrees. + + + + + The heading in degrees relative to the magnetic North Pole. (Read Only) + + + + + The raw geomagnetic data measured in microteslas. (Read Only) + + + + + Timestamp (in seconds since 1970) when the heading was last time updated. (Read Only) + + + + + The heading in degrees relative to the geographic North Pole. (Read Only) + + + + + Base class for everything attached to GameObjects. + + + + + The Animation attached to this GameObject. (Null if there is none attached). + + + + + The AudioSource attached to this GameObject. (Null if there is none attached). + + + + + The Camera attached to this GameObject. (Null if there is none attached). + + + + + The Collider attached to this GameObject. (Null if there is none attached). + + + + + The Collider2D component attached to the object. + + + + + The ConstantForce attached to this GameObject. (Null if there is none attached). + + + + + The game object this component is attached to. A component is always attached to a game object. + + + + + The GUIText attached to this GameObject. (Null if there is none attached). + + + + + The GUITexture attached to this GameObject (Read Only). (null if there is none attached). + + + + + The HingeJoint attached to this GameObject. (Null if there is none attached). + + + + + The Light attached to this GameObject. (Null if there is none attached). + + + + + The NetworkView attached to this GameObject (Read Only). (null if there is none attached). + + + + + The ParticleSystem attached to this GameObject. (Null if there is none attached). + + + + + The Renderer attached to this GameObject. (Null if there is none attached). + + + + + The Rigidbody attached to this GameObject. (Null if there is none attached). + + + + + The Rigidbody2D that is attached to the Component's GameObject. + + + + + The tag of this game object. + + + + + The Transform attached to this GameObject. + + + + + Calls the method named methodName on every MonoBehaviour in this game object or any of its children. + + Name of the method to call. + Optional parameter to pass to the method (can be any value). + Should an error be raised if the method does not exist for a given target object? + + + + Calls the method named methodName on every MonoBehaviour in this game object or any of its children. + + Name of the method to call. + Optional parameter to pass to the method (can be any value). + Should an error be raised if the method does not exist for a given target object? + + + + Calls the method named methodName on every MonoBehaviour in this game object or any of its children. + + Name of the method to call. + Optional parameter to pass to the method (can be any value). + Should an error be raised if the method does not exist for a given target object? + + + + Calls the method named methodName on every MonoBehaviour in this game object or any of its children. + + Name of the method to call. + Optional parameter to pass to the method (can be any value). + Should an error be raised if the method does not exist for a given target object? + + + + Is this game object tagged with tag ? + + The tag to compare. + + + + Returns the component of Type type if the game object has one attached, null if it doesn't. + + The type of Component to retrieve. + + + + Generic version. See the page for more details. + + + + + Returns the component with name type if the game object has one attached, null if it doesn't. + + + + + + Returns the component of Type type in the GameObject or any of its children using depth first search. + + The type of Component to retrieve. + + A component of the matching type, if found. + + + + + Generic version. See the page for more details. + + + + A component of the matching type, if found. + + + + + Returns the component of Type type in the GameObject or any of its parents. + + The type of Component to retrieve. + + A component of the matching type, if found. + + + + + Generic version. See the page for more details. + + + A component of the matching type, if found. + + + + + Returns all components of Type type in the GameObject. + + The type of Component to retrieve. + + + + Generic version. See the page for more details. + + + + + Returns all components of Type type in the GameObject or any of its children. + + The type of Component to retrieve. + Should Components on inactive GameObjects be included in the found set? includeInactive decides which children of the GameObject will be searched. The GameObject that you call GetComponentsInChildren on is always searched regardless. + + + + Returns all components of Type type in the GameObject or any of its children. + + The type of Component to retrieve. + Should Components on inactive GameObjects be included in the found set? includeInactive decides which children of the GameObject will be searched. The GameObject that you call GetComponentsInChildren on is always searched regardless. + + + + Generic version. See the page for more details. + + Should Components on inactive GameObjects be included in the found set? includeInactive decides which children of the GameObject will be searched. The GameObject that you call GetComponentsInChildren on is always searched regardless. + + A list of all found components matching the specified type. + + + + + Generic version. See the page for more details. + + + A list of all found components matching the specified type. + + + + + Returns all components of Type type in the GameObject or any of its parents. + + The type of Component to retrieve. + Should inactive Components be included in the found set? + + + + Generic version. See the page for more details. + + Should inactive Components be included in the found set? + + + + Generic version. See the page for more details. + + Should inactive Components be included in the found set? + + + + Calls the method named methodName on every MonoBehaviour in this game object. + + Name of the method to call. + Optional parameter for the method. + Should an error be raised if the target object doesn't implement the method for the message? + + + + Calls the method named methodName on every MonoBehaviour in this game object. + + Name of the method to call. + Optional parameter for the method. + Should an error be raised if the target object doesn't implement the method for the message? + + + + Calls the method named methodName on every MonoBehaviour in this game object. + + Name of the method to call. + Optional parameter for the method. + Should an error be raised if the target object doesn't implement the method for the message? + + + + Calls the method named methodName on every MonoBehaviour in this game object. + + Name of the method to call. + Optional parameter for the method. + Should an error be raised if the target object doesn't implement the method for the message? + + + + Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour. + + Name of method to call. + Optional parameter value for the method. + Should an error be raised if the method does not exist on the target object? + + + + Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour. + + Name of method to call. + Optional parameter value for the method. + Should an error be raised if the method does not exist on the target object? + + + + Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour. + + Name of method to call. + Optional parameter value for the method. + Should an error be raised if the method does not exist on the target object? + + + + Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour. + + Name of method to call. + Optional parameter value for the method. + Should an error be raised if the method does not exist on the target object? + + + + A Collider that can merge other Colliders together. + + + + + Controls the radius of all edges created by the Collider. + + + + + Specifies when to generate the Composite Collider geometry. + + + + + Specifies the type of geometry the Composite Collider should generate. + + + + + The number of paths in the Collider. + + + + + Gets the total number of points in all the paths within the Collider. + + + + + Controls the minimum distance allowed between generated vertices. + + + + + Regenerates the Composite Collider geometry. + + + + + Specifies when to generate the Composite Collider geometry. + + + + + Sets the Composite Collider geometry to not automatically update when a Collider used by the Composite Collider changes. + + + + + Sets the Composite Collider geometry to update synchronously immediately when a Collider used by the Composite Collider changes. + + + + + Specifies the type of geometry the Composite Collider generates. + + + + + Sets the Composite Collider to generate closed outlines for the merged Collider geometry consisting of only edges. + + + + + Sets the Composite Collider to generate closed outlines for the merged Collider geometry consisting of convex polygon shapes. + + + + + Gets a path from the Collider by its index. + + The index of the path from 0 to pathCount. + An ordered array of the vertices or points in the selected path. + + Returns the number of points placed in the points array. + + + + + Gets the number of points in the specified path from the Collider by its index. + + The index of the path from 0 to pathCount. + + Returns the number of points in the path specified by index. + + + + + Compression Levels relate to how much time should be spent compressing Assets into an Asset Bundle. + + + + + No compression. + + + + + Compression Method for Asset Bundles. + + + + + LZ4 compression results in larger compressed files than LZMA, but does not require the entire bundle to be decompressed before use. + + + + + LZ4HC is a high compression variant of LZ4. LZ4HC compression results in larger compressed files than LZMA, but does not require the entire bundle to be decompressed before use. + + + + + LZMA compression results in smaller compressed Asset Bundles but they must be entirely decompressed before use. + + + + + Uncompressed Asset Bundles are larger than compressed Asset Bundles, but they are the fastest to access once downloaded. + + + + + GPU data buffer, mostly for use with compute shaders. + + + + + Number of elements in the buffer (Read Only). + + + + + Size of one element in the buffer (Read Only). + + + + + Copy counter value of append/consume buffer into another buffer. + + Append/consume buffer to copy the counter from. + A buffer to copy the counter to. + Target byte offset in dst. + + + + Create a Compute Buffer. + + Number of elements in the buffer. + Size of one element in the buffer. Has to match size of buffer type in the shader. See for cross-platform compatibility information. + Type of the buffer, default is ComputeBufferType.Default (structured buffer). + + + + Create a Compute Buffer. + + Number of elements in the buffer. + Size of one element in the buffer. Has to match size of buffer type in the shader. See for cross-platform compatibility information. + Type of the buffer, default is ComputeBufferType.Default (structured buffer). + + + + Read data values from the buffer into an array. The array can only use <a href="https:docs.microsoft.comen-usdotnetframeworkinteropblittable-and-non-blittable-types">blittable<a> types. + + An array to receive the data. + + + + Partial read of data values from the buffer into an array. + + An array to receive the data. + The first element index in data where retrieved elements are copied. + The first element index of the compute buffer from which elements are read. + The number of elements to retrieve. + + + + Retrieve a native (underlying graphics API) pointer to the buffer. + + + Pointer to the underlying graphics API buffer. + + + + + Returns true if this compute buffer is valid and false otherwise. + + + + + Release a Compute Buffer. + + + + + Sets counter value of append/consume buffer. + + Value of the append/consume counter. + + + + Set the buffer with values from an array. + + Array of values to fill the buffer. + + + + Partial copy of data values from an array into the buffer. + + Array of values to fill the buffer. + The first element index in data to copy to the compute buffer. + The first element index in compute buffer to receive the data. + The number of elements to copy. + + + + ComputeBuffer type. + + + + + Append-consume ComputeBuffer type. + + + + + ComputeBuffer with a counter. + + + + + Default ComputeBuffer type (structured buffer). + + + + + ComputeBuffer used for Graphics.DrawProceduralIndirect, ComputeShader.DispatchIndirect or Graphics.DrawMeshInstancedIndirect arguments. + + + + + Raw ComputeBuffer type (byte address buffer). + + + + + Compute Shader asset. + + + + + Execute a compute shader. + + Which kernel to execute. A single compute shader asset can have multiple kernel entry points. + Number of work groups in the X dimension. + Number of work groups in the Y dimension. + Number of work groups in the Z dimension. + + + + Execute a compute shader. + + Which kernel to execute. A single compute shader asset can have multiple kernel entry points. + Buffer with dispatch arguments. + The byte offset into the buffer, where the draw arguments start. + + + + Find ComputeShader kernel index. + + Name of kernel function. + + The Kernel index, or logs a "FindKernel failed" error message if the kernel is not found. + + + + + Get kernel thread group sizes. + + Which kernel to query. A single compute shader asset can have multiple kernel entry points. + Thread group size in the X dimension. + Thread group size in the Y dimension. + Thread group size in the Z dimension. + + + + Checks whether a shader contains a given kernel. + + The name of the kernel to look for. + + True if the kernel is found, false otherwise. + + + + + Set a bool parameter. + + Variable name in shader code. + Property name ID, use Shader.PropertyToID to get it. + Value to set. + + + + Set a bool parameter. + + Variable name in shader code. + Property name ID, use Shader.PropertyToID to get it. + Value to set. + + + + Sets an input or output compute buffer. + + For which kernel the buffer is being set. See FindKernel. + Property name ID, use Shader.PropertyToID to get it. + Name of the buffer variable in shader code. + Buffer to set. + + + + Sets an input or output compute buffer. + + For which kernel the buffer is being set. See FindKernel. + Property name ID, use Shader.PropertyToID to get it. + Name of the buffer variable in shader code. + Buffer to set. + + + + Set a float parameter. + + Variable name in shader code. + Property name ID, use Shader.PropertyToID to get it. + Value to set. + + + + Set a float parameter. + + Variable name in shader code. + Property name ID, use Shader.PropertyToID to get it. + Value to set. + + + + Set multiple consecutive float parameters at once. + + Array variable name in the shader code. + Property name ID, use Shader.PropertyToID to get it. + Value array to set. + + + + Set multiple consecutive float parameters at once. + + Array variable name in the shader code. + Property name ID, use Shader.PropertyToID to get it. + Value array to set. + + + + Set an integer parameter. + + Variable name in shader code. + Property name ID, use Shader.PropertyToID to get it. + Value to set. + + + + Set an integer parameter. + + Variable name in shader code. + Property name ID, use Shader.PropertyToID to get it. + Value to set. + + + + Set multiple consecutive integer parameters at once. + + Array variable name in the shader code. + Property name ID, use Shader.PropertyToID to get it. + Value array to set. + + + + Set multiple consecutive integer parameters at once. + + Array variable name in the shader code. + Property name ID, use Shader.PropertyToID to get it. + Value array to set. + + + + Set a Matrix parameter. + + Variable name in shader code. + Property name ID, use Shader.PropertyToID to get it. + Value to set. + + + + Set a Matrix parameter. + + Variable name in shader code. + Property name ID, use Shader.PropertyToID to get it. + Value to set. + + + + Set a Matrix array parameter. + + Variable name in shader code. + Property name ID, use Shader.PropertyToID to get it. + Value to set. + + + + Set a Matrix array parameter. + + Variable name in shader code. + Property name ID, use Shader.PropertyToID to get it. + Value to set. + + + + Set a texture parameter. + + For which kernel the texture is being set. See FindKernel. + Property name ID, use Shader.PropertyToID to get it. + Name of the buffer variable in shader code. + Texture to set. + Optional mipmap level of the read-write texture. + + + + Set a texture parameter. + + For which kernel the texture is being set. See FindKernel. + Property name ID, use Shader.PropertyToID to get it. + Name of the buffer variable in shader code. + Texture to set. + Optional mipmap level of the read-write texture. + + + + Set a texture parameter. + + For which kernel the texture is being set. See FindKernel. + Property name ID, use Shader.PropertyToID to get it. + Name of the buffer variable in shader code. + Texture to set. + Optional mipmap level of the read-write texture. + + + + Set a texture parameter. + + For which kernel the texture is being set. See FindKernel. + Property name ID, use Shader.PropertyToID to get it. + Name of the buffer variable in shader code. + Texture to set. + Optional mipmap level of the read-write texture. + + + + Set a texture parameter from a global texture property. + + For which kernel the texture is being set. See FindKernel. + Property name ID, use Shader.PropertyToID to get it. + Name of the buffer variable in shader code. + Global texture property to assign to shader. + Property name ID, use Shader.PropertyToID to get it. + + + + Set a texture parameter from a global texture property. + + For which kernel the texture is being set. See FindKernel. + Property name ID, use Shader.PropertyToID to get it. + Name of the buffer variable in shader code. + Global texture property to assign to shader. + Property name ID, use Shader.PropertyToID to get it. + + + + Set a vector parameter. + + Variable name in shader code. + Property name ID, use Shader.PropertyToID to get it. + Value to set. + + + + Set a vector parameter. + + Variable name in shader code. + Property name ID, use Shader.PropertyToID to get it. + Value to set. + + + + Set a vector array parameter. + + Variable name in shader code. + Property name ID, use Shader.PropertyToID to get it. + Value to set. + + + + Set a vector array parameter. + + Variable name in shader code. + Property name ID, use Shader.PropertyToID to get it. + Value to set. + + + + The configurable joint is an extremely flexible joint giving you complete control over rotation and linear motion. + + + + + Definition of how the joint's rotation will behave around its local X axis. Only used if Rotation Drive Mode is Swing & Twist. + + + + + The configuration of the spring attached to the angular X limit of the joint. + + + + + Allow rotation around the X axis to be Free, completely Locked, or Limited according to Low and High Angular XLimit. + + + + + Boundary defining rotation restriction, based on delta from original rotation. + + + + + Allow rotation around the Y axis to be Free, completely Locked, or Limited according to Angular YLimit. + + + + + Definition of how the joint's rotation will behave around its local Y and Z axes. Only used if Rotation Drive Mode is Swing & Twist. + + + + + The configuration of the spring attached to the angular Y and angular Z limits of the joint. + + + + + Boundary defining rotation restriction, based on delta from original rotation. + + + + + Allow rotation around the Z axis to be Free, completely Locked, or Limited according to Angular ZLimit. + + + + + If enabled, all Target values will be calculated in world space instead of the object's local space. + + + + + Boundary defining upper rotation restriction, based on delta from original rotation. + + + + + Boundary defining movement restriction, based on distance from the joint's origin. + + + + + The configuration of the spring attached to the linear limit of the joint. + + + + + Boundary defining lower rotation restriction, based on delta from original rotation. + + + + + Set the angular tolerance threshold (in degrees) for projection. + +If the joint deviates by more than this angle around its locked angular degrees of freedom, +the solver will move the bodies to close the angle. + +Setting a very small tolerance may result in simulation jitter or other artifacts. + +Sometimes it is not possible to project (for example when the joints form a cycle). + + + + + Set the linear tolerance threshold for projection. + +If the joint separates by more than this distance along its locked degrees of freedom, the solver +will move the bodies to close the distance. + +Setting a very small tolerance may result in simulation jitter or other artifacts. + +Sometimes it is not possible to project (for example when the joints form a cycle). + + + + + Brings violated constraints back into alignment even when the solver fails. Projection is not a physical process and does not preserve momentum or respect collision geometry. It is best avoided if practical, but can be useful in improving simulation quality where joint separation results in unacceptable artifacts. + + + + + Control the object's rotation with either X & YZ or Slerp Drive by itself. + + + + + The joint's secondary axis. + + + + + Definition of how the joint's rotation will behave around all local axes. Only used if Rotation Drive Mode is Slerp Only. + + + + + If enabled, the two connected rigidbodies will be swapped, as if the joint was attached to the other body. + + + + + This is a Vector3. It defines the desired angular velocity that the joint should rotate into. + + + + + The desired position that the joint should move into. + + + + + This is a Quaternion. It defines the desired rotation that the joint should rotate into. + + + + + The desired velocity that the joint should move along. + + + + + Definition of how the joint's movement will behave along its local X axis. + + + + + Allow movement along the X axis to be Free, completely Locked, or Limited according to Linear Limit. + + + + + Definition of how the joint's movement will behave along its local Y axis. + + + + + Allow movement along the Y axis to be Free, completely Locked, or Limited according to Linear Limit. + + + + + Definition of how the joint's movement will behave along its local Z axis. + + + + + Allow movement along the Z axis to be Free, completely Locked, or Limited according to Linear Limit. + + + + + Constrains movement for a ConfigurableJoint along the 6 axes. + + + + + Motion along the axis will be completely free and completely unconstrained. + + + + + Motion along the axis will be limited by the respective limit. + + + + + Motion along the axis will be locked. + + + + + The various test results the connection tester may return with. + + + + + A force applied constantly. + + + + + The force applied to the rigidbody every frame. + + + + + The force - relative to the rigid bodies coordinate system - applied every frame. + + + + + The torque - relative to the rigid bodies coordinate system - applied every frame. + + + + + The torque applied to the rigidbody every frame. + + + + + Applies both linear and angular (torque) forces continuously to the rigidbody each physics update. + + + + + The linear force applied to the rigidbody each physics update. + + + + + The linear force, relative to the rigid-body coordinate system, applied each physics update. + + + + + The torque applied to the rigidbody each physics update. + + + + + A set of parameters for filtering contact results. + + + + + Given the current state of the contact filter, determine whether it would filter anything. + + + + + Sets the contact filter to filter the results that only include Collider2D on the layers defined by the layer mask. + + + + + Sets the contact filter to filter the results to only include Collider2D with a Z coordinate (depth) less than this value. + + + + + Sets the contact filter to filter the results to only include contacts with collision normal angles that are less than this angle. + + + + + Sets the contact filter to filter the results to only include Collider2D with a Z coordinate (depth) greater than this value. + + + + + Sets the contact filter to filter the results to only include contacts with collision normal angles that are greater than this angle. + + + + + Sets the contact filter to filter the results by depth using minDepth and maxDepth. + + + + + Sets the contact filter to filter results by layer mask. + + + + + Sets the contact filter to filter the results by the collision's normal angle using minNormalAngle and maxNormalAngle. + + + + + Sets the contact filter to filter within the minDepth and maxDepth range, or outside that range. + + + + + Sets the contact filter to filter within the minNormalAngle and maxNormalAngle range, or outside that range. + + + + + Sets to filter contact results based on trigger collider involvement. + + + + + Turns off depth filtering by setting useDepth to false. The associated values of minDepth and maxDepth are not changed. + + + + + Turns off layer mask filtering by setting useLayerMask to false. The associated value of layerMask is not changed. + + + + + Turns off normal angle filtering by setting useNormalAngle to false. The associated values of minNormalAngle and maxNormalAngle are not changed. + + + + + Checks if the Transform for obj is within the depth range to be filtered. + + The GameObject used to check the z-position (depth) of Transform.position. + + Returns true when obj is excluded by the filter and false if otherwise. + + + + + Checks if the GameObject.layer for obj is included in the layerMask to be filtered. + + The GameObject used to check the GameObject.layer. + + Returns true when obj is excluded by the filter and false if otherwise. + + + + + Checks if the angle of normal is within the normal angle range to be filtered. + + The normal used to calculate an angle. + + Returns true when normal is excluded by the filter and false if otherwise. + + + + + Checks if the angle is within the normal angle range to be filtered. + + The angle used for comparison in the filter. + + Returns true when angle is excluded by the filter and false if otherwise. + + + + + Checks if the collider is a trigger and should be filtered by the useTriggers to be filtered. + + The Collider2D used to check for a trigger. + + Returns true when collider is excluded by the filter and false if otherwise. + + + + + Sets the contact filter to not filter any ContactPoint2D. + + + A copy of the contact filter set to not filter any ContactPoint2D. + + + + + Sets the minDepth and maxDepth filter properties and turns on depth filtering by setting useDepth to true. + + The value used to set minDepth. + The value used to set maxDepth. + + + + Sets the layerMask filter property using the layerMask parameter provided and also enables layer mask filtering by setting useLayerMask to true. + + The value used to set the layerMask. + + + + Sets the minNormalAngle and maxNormalAngle filter properties and turns on normal angle filtering by setting useNormalAngle to true. + + The value used to set the minNormalAngle. + The value used to set the maxNormalAngle. + + + + Describes a contact point where the collision occurs. + + + + + Normal of the contact point. + + + + + The other collider in contact at the point. + + + + + The point of contact. + + + + + The distance between the colliders at the contact point. + + + + + The first collider in contact at the point. + + + + + Details about a specific point of contact involved in a 2D physics collision. + + + + + The incoming Collider2D involved in the collision with the otherCollider. + + + + + Indicates whether the collision response or reaction is enabled or disabled. + + + + + Surface normal at the contact point. + + + + + Gets the impulse force applied at the contact point along the ContactPoint2D.normal. + + + + + The other Collider2D involved in the collision with the collider. + + + + + The other Rigidbody2D involved in the collision with the rigidbody. + + + + + The point of contact between the two colliders in world space. + + + + + Gets the relative velocity of the two colliders at the contact point (Read Only). + + + + + The incoming Rigidbody2D involved in the collision with the otherRigidbody. + + + + + Gets the distance between the colliders at the contact point. + + + + + Gets the impulse force applied at the contact point which is perpendicular to the ContactPoint2D.normal. + + + + + The ContextMenu attribute allows you to add commands to the context menu. + + + + + Adds the function to the context menu of the component. + + The name of the context menu item. + Whether this is a validate function (defaults to false). + Priority used to override the ordering of the menu items (defaults to 1000000). The lower the number the earlier in the menu it will appear. + + + + Adds the function to the context menu of the component. + + The name of the context menu item. + Whether this is a validate function (defaults to false). + Priority used to override the ordering of the menu items (defaults to 1000000). The lower the number the earlier in the menu it will appear. + + + + Adds the function to the context menu of the component. + + The name of the context menu item. + Whether this is a validate function (defaults to false). + Priority used to override the ordering of the menu items (defaults to 1000000). The lower the number the earlier in the menu it will appear. + + + + Use this attribute to add a context menu to a field that calls a named method. + + + + + The name of the function that should be called. + + + + + The name of the context menu item. + + + + + Use this attribute to add a context menu to a field that calls a named method. + + The name of the context menu item. + The name of the function that should be called. + + + + ControllerColliderHit is used by CharacterController.OnControllerColliderHit to give detailed information about the collision and how to deal with it. + + + + + The collider that was hit by the controller. + + + + + The controller that hit the collider. + + + + + The game object that was hit by the controller. + + + + + The direction the CharacterController was moving in when the collision occured. + + + + + How far the character has travelled until it hit the collider. + + + + + The normal of the surface we collided with in world space. + + + + + The impact point in world space. + + + + + The rigidbody that was hit by the controller. + + + + + The transform that was hit by the controller. + + + + + MonoBehaviour.StartCoroutine returns a Coroutine. Instances of this class are only used to reference these coroutines, and do not hold any exposed properties or functions. + + + + + Holds data for a single application crash event and provides access to all gathered crash reports. + + + + + Returns last crash report, or null if no reports are available. + + + + + Returns all currently available reports in a new array. + + + + + Crash report data as formatted text. + + + + + Time, when the crash occured. + + + + + Remove report from available reports list. + + + + + Remove all reports from available reports list. + + + + + Engine API for CrashReporting Service. + + + + + This Boolean field will cause CrashReportHandler to capture exceptions when set to true. By default enable capture exceptions is true. + + + + + The Performance Reporting service will keep a buffer of up to the last X log messages (Debug.Log, etc) to send along with crash reports. The default is 10 log messages, the max is 50. Set this to 0 to disable capture of logs with your crash reports. + + + + + Get a custom crash report metadata field that has been set. + + + + Value that was previously set for the key, or null if no value was found. + + + + + Set a custom metadata key-value pair to be included with crash reports. + + + + + + + Mark a ScriptableObject-derived type to be automatically listed in the Assets/Create submenu, so that instances of the type can be easily created and stored in the project as ".asset" files. + + + + + The default file name used by newly created instances of this type. + + + + + The display name for this type shown in the Assets/Create menu. + + + + + The position of the menu item within the Assets/Create menu. + + + + + Class for handling cube maps, Use this to create or modify existing. + + + + + The format of the pixel data in the texture (Read Only). + + + + + How many mipmap levels are in this texture (Read Only). + + + + + Actually apply all previous SetPixel and SetPixels changes. + + When set to true, mipmap levels are recalculated. + When set to true, system memory copy of a texture is released. + + + + Creates a Unity cubemap out of externally created native cubemap object. + + The width and height of each face of the cubemap should be the same. + Format of underlying cubemap object. + Does the cubemap have mipmaps? + Native cubemap texture object. + + + + + Create a new empty cubemap texture. + + Width/height of a cube face in pixels. + Pixel data format to be used for the Cubemap. + Should mipmaps be created? + + + + + + + Returns pixel color at coordinates (face, x, y). + + + + + + + + Returns pixel colors of a cubemap face. + + The face from which pixel data is taken. + Mipmap level for the chosen face. + + + + Sets pixel color at coordinates (face, x, y). + + + + + + + + + Sets pixel colors of a cubemap face. + + Pixel data for the Cubemap face. + The face to which the new data should be applied. + The mipmap level for the face. + + + + Performs smoothing of near edge regions. + + Pixel distance at edges over which to apply smoothing. + + + + Class for handling Cubemap arrays. + + + + + Number of cubemaps in the array (Read Only). + + + + + Texture format (Read Only). + + + + + Actually apply all previous SetPixels changes. + + When set to true, mipmap levels are recalculated. + When set to true, system memory copy of a texture is released. + + + + Create a new cubemap array. + + Cubemap face size in pixels. + Number of elements in the cubemap array. + Format of the pixel data. + Should mipmaps be created? + Does the texture contain non-color data (i.e. don't do any color space conversions when sampling)? Default is false. + + + + + + + Create a new cubemap array. + + Cubemap face size in pixels. + Number of elements in the cubemap array. + Format of the pixel data. + Should mipmaps be created? + Does the texture contain non-color data (i.e. don't do any color space conversions when sampling)? Default is false. + + + + + + + Returns pixel colors of a single array slice/face. + + Cubemap face to read pixels from. + Array slice to read pixels from. + Mipmap level to read pixels from. + + Array of pixel colors. + + + + + Returns pixel colors of a single array slice/face. + + Cubemap face to read pixels from. + Array slice to read pixels from. + Mipmap level to read pixels from. + + Array of pixel colors in low precision (8 bits/channel) format. + + + + + Set pixel colors for a single array slice/face. + + An array of pixel colors. + Cubemap face to set pixels for. + Array element index to set pixels for. + Mipmap level to set pixels for. + + + + Set pixel colors for a single array slice/face. + + An array of pixel colors in low precision (8 bits/channel) format. + Cubemap face to set pixels for. + Array element index to set pixels for. + Mipmap level to set pixels for. + + + + Cubemap face. + + + + + Left facing side (-x). + + + + + Downward facing side (-y). + + + + + Backward facing side (-z). + + + + + Right facing side (+x). + + + + + Upwards facing side (+y). + + + + + Forward facing side (+z). + + + + + Cubemap face is unknown or unspecified. + + + + + Describes a set of bounding spheres that should have their visibility and distances maintained. + + + + + Pauses culling group execution. + + + + + Sets the callback that will be called when a sphere's visibility and/or distance state has changed. + + + + + Locks the CullingGroup to a specific camera. + + + + + Create a CullingGroup. + + + + + Clean up all memory used by the CullingGroup immediately. + + + + + Erase a given bounding sphere by moving the final sphere on top of it. + + The index of the entry to erase. + + + + Erase a given entry in an arbitrary array by copying the final entry on top of it, then decrementing the number of entries used by one. + + The index of the entry to erase. + An array of entries. + The number of entries in the array that are actually used. + + + + Get the current distance band index of a given sphere. + + The index of the sphere. + + The sphere's current distance band index. + + + + + Returns true if the bounding sphere at index is currently visible from any of the contributing cameras. + + The index of the bounding sphere. + + True if the sphere is visible; false if it is invisible. + + + + + Retrieve the indices of spheres that have particular visibility and/or distance states. + + True if only visible spheres should be retrieved; false if only invisible spheres should be retrieved. + The distance band that retrieved spheres must be in. + An array that will be filled with the retrieved sphere indices. + The index of the sphere to begin searching at. + + The number of sphere indices found and written into the result array. + + + + + Retrieve the indices of spheres that have particular visibility and/or distance states. + + True if only visible spheres should be retrieved; false if only invisible spheres should be retrieved. + The distance band that retrieved spheres must be in. + An array that will be filled with the retrieved sphere indices. + The index of the sphere to begin searching at. + + The number of sphere indices found and written into the result array. + + + + + Retrieve the indices of spheres that have particular visibility and/or distance states. + + True if only visible spheres should be retrieved; false if only invisible spheres should be retrieved. + The distance band that retrieved spheres must be in. + An array that will be filled with the retrieved sphere indices. + The index of the sphere to begin searching at. + + The number of sphere indices found and written into the result array. + + + + + Set bounding distances for 'distance bands' the group should compute, as well as options for how spheres falling into each distance band should be treated. + + An array of bounding distances. The distances should be sorted in increasing order. + An array of CullingDistanceBehaviour settings. The array should be the same length as the array provided to the distances parameter. It can also be omitted or passed as null, in which case all distances will be given CullingDistanceBehaviour.Normal behaviour. + + + + Sets the number of bounding spheres in the bounding spheres array that are actually being used. + + The number of bounding spheres being used. + + + + Sets the array of bounding sphere definitions that the CullingGroup should compute culling for. + + The BoundingSpheres to cull. + + + + Set the reference point from which distance bands are measured. + + A fixed point to measure the distance from. + A transform to measure the distance from. The transform's position will be automatically tracked. + + + + Set the reference point from which distance bands are measured. + + A fixed point to measure the distance from. + A transform to measure the distance from. The transform's position will be automatically tracked. + + + + This delegate is used for recieving a callback when a sphere's distance or visibility state has changed. + + A CullingGroupEvent that provides information about the sphere that has changed. + + + + Provides information about the current and previous states of one sphere in a CullingGroup. + + + + + The current distance band index of the sphere, after the most recent culling pass. + + + + + Did this sphere change from being visible to being invisible in the most recent culling pass? + + + + + Did this sphere change from being invisible to being visible in the most recent culling pass? + + + + + The index of the sphere that has changed. + + + + + Was the sphere considered visible by the most recent culling pass? + + + + + The distance band index of the sphere before the most recent culling pass. + + + + + Was the sphere visible before the most recent culling pass? + + + + + Cursor API for setting the cursor (mouse pointer). + + + + + Determines whether the hardware pointer is locked to the center of the view, constrained to the window, or not constrained at all. + + + + + Determines whether the hardware pointer is visible or not. + + + + + Sets the mouse cursor to the given texture. + + + + + Specify a custom cursor that you wish to use as a cursor. + + The texture to use for the cursor. To use a texture, you must first import it with `Read/Write`enabled. Alternatively, you can use the default cursor import setting. If you created your cursor texture from code, it must be in RGBA32 format, have alphaIsTransparency enabled, and have no mip chain. To use the default cursor, set the texture to `Null`. + The offset from the top left of the texture to use as the target point (must be within the bounds of the cursor). + Allow this cursor to render as a hardware cursor on supported platforms, or force software cursor. + + + + How the cursor should behave. + + + + + Confine cursor to the game window. + + + + + Lock cursor to the center of the game window. + + + + + Cursor behavior is unmodified. + + + + + Determines whether the mouse cursor is rendered using software rendering or, on supported platforms, hardware rendering. + + + + + Use hardware cursors on supported platforms. + + + + + Force the use of software cursors. + + + + + Attribute to define the class as a grid brush and to make it available in the palette window. + + + + + If set to true, brush will replace Unity built-in brush as the default brush in palette window. + +Only one class at any one time should set defaultBrush to true. + + + + + Name of the default instance of this brush. + + + + + Hide all asset instances of this brush in the tile palette window. + + + + + Hide the default instance of brush in the tile palette window. + + + + + Attribute to define the class as a grid brush and to make it available in the palette window. + + If set to true, brush will replace Unity built-in brush as the default brush in palette window. + Name of the default instance of this brush. + Hide all asset instances of this brush in the tile palette window. + Hide the default instance of brush in the tile palette window. + + + + + Attribute to define the class as a grid brush and to make it available in the palette window. + + If set to true, brush will replace Unity built-in brush as the default brush in palette window. + Name of the default instance of this brush. + Hide all asset instances of this brush in the tile palette window. + Hide the default instance of brush in the tile palette window. + + + + + Custom Render Textures are an extension to Render Textures, enabling you to render directly to the Texture using a Shader. + + + + + Bitfield that allows to enable or disable update on each of the cubemap faces. Order from least significant bit is +X, -X, +Y, -Y, +Z, -Z. + + + + + If true, the Custom Render Texture is double buffered so that you can access it during its own update. otherwise the Custom Render Texture will be not be double buffered. + + + + + Color with which the Custom Render Texture is initialized. This parameter will be ignored if an initializationMaterial is set. + + + + + Material with which the Custom Render Texture is initialized. Initialization texture and color are ignored if this parameter is set. + + + + + Specify how the texture should be initialized. + + + + + Specify if the texture should be initialized with a Texture and a Color or a Material. + + + + + Texture with which the Custom Render Texture is initialized (multiplied by the initialization color). This parameter will be ignored if an initializationMaterial is set. + + + + + Material with which the content of the Custom Render Texture is updated. + + + + + Shader Pass used to update the Custom Render Texture. + + + + + Specify how the texture should be updated. + + + + + Space in which the update zones are expressed (Normalized or Pixel space). + + + + + If true, Update zones will wrap around the border of the Custom Render Texture. Otherwise, Update zones will be clamped at the border of the Custom Render Texture. + + + + + Clear all Update Zones. + + + + + Create a new Custom Render Texture. + + + + + + + + + Create a new Custom Render Texture. + + + + + + + + + Create a new Custom Render Texture. + + + + + + + + + Returns the list of Update Zones. + + Output list of Update Zones. + + + + Triggers an initialization of the Custom Render Texture. + + + + + Setup the list of Update Zones for the Custom Render Texture. + + + + + + Triggers the update of the Custom Render Texture. + + Number of upate pass to perform. + + + + Specify the source of a Custom Render Texture initialization. + + + + + Custom Render Texture is initalized with a Material. + + + + + Custom Render Texture is initialized by a Texture multiplied by a Color. + + + + + Frequency of update or initialization of a Custom Render Texture. + + + + + Initialization/Update will only occur when triggered by the script. + + + + + Initialization/Update will occur once at load time and then can be triggered again by script. + + + + + Initialization/Update will occur at every frame. + + + + + Structure describing an Update Zone. + + + + + If true, and if the texture is double buffered, a request is made to swap the buffers before the next update. Otherwise, the buffers will not be swapped. + + + + + Shader Pass used to update the Custom Render Texture for this Update Zone. + + + + + Rotation of the Update Zone. + + + + + Position of the center of the Update Zone within the Custom Render Texture. + + + + + Size of the Update Zone. + + + + + Space in which coordinates are provided for Update Zones. + + + + + Coordinates are normalized. (0, 0) is top left and (1, 1) is bottom right. + + + + + Coordinates are expressed in pixels. (0, 0) is top left (width, height) is bottom right. + + + + + Base class for custom yield instructions to suspend coroutines. + + + + + Indicates if coroutine should be kept suspended. + + + + + Class containing methods to ease debugging while developing a game. + + + + + Reports whether the development console is visible. The development console cannot be made to appear using: + + + + + In the Build Settings dialog there is a check box called "Development Build". + + + + + Get default debug logger. + + + + + Assert a condition and logs an error message to the Unity console on failure. + + Condition you expect to be true. + Object to which the message applies. + String or object to be converted to string representation for display. + + + + Assert a condition and logs an error message to the Unity console on failure. + + Condition you expect to be true. + Object to which the message applies. + String or object to be converted to string representation for display. + + + + Assert a condition and logs an error message to the Unity console on failure. + + Condition you expect to be true. + Object to which the message applies. + String or object to be converted to string representation for display. + + + + Assert a condition and logs an error message to the Unity console on failure. + + Condition you expect to be true. + Object to which the message applies. + String or object to be converted to string representation for display. + + + + Assert a condition and logs a formatted error message to the Unity console on failure. + + Condition you expect to be true. + A composite format string. + Format arguments. + Object to which the message applies. + + + + Assert a condition and logs a formatted error message to the Unity console on failure. + + Condition you expect to be true. + A composite format string. + Format arguments. + Object to which the message applies. + + + + Pauses the editor. + + + + + Clears errors from the developer console. + + + + + Draws a line between specified start and end points. + + Point in world space where the line should start. + Point in world space where the line should end. + Color of the line. + How long the line should be visible for. + Should the line be obscured by objects closer to the camera? + + + + Draws a line between specified start and end points. + + Point in world space where the line should start. + Point in world space where the line should end. + Color of the line. + How long the line should be visible for. + Should the line be obscured by objects closer to the camera? + + + + Draws a line between specified start and end points. + + Point in world space where the line should start. + Point in world space where the line should end. + Color of the line. + How long the line should be visible for. + Should the line be obscured by objects closer to the camera? + + + + Draws a line between specified start and end points. + + Point in world space where the line should start. + Point in world space where the line should end. + Color of the line. + How long the line should be visible for. + Should the line be obscured by objects closer to the camera? + + + + Draws a line from start to start + dir in world coordinates. + + Point in world space where the ray should start. + Direction and length of the ray. + Color of the drawn line. + How long the line will be visible for (in seconds). + Should the line be obscured by other objects closer to the camera? + + + + Draws a line from start to start + dir in world coordinates. + + Point in world space where the ray should start. + Direction and length of the ray. + Color of the drawn line. + How long the line will be visible for (in seconds). + Should the line be obscured by other objects closer to the camera? + + + + Draws a line from start to start + dir in world coordinates. + + Point in world space where the ray should start. + Direction and length of the ray. + Color of the drawn line. + How long the line will be visible for (in seconds). + Should the line be obscured by other objects closer to the camera? + + + + Draws a line from start to start + dir in world coordinates. + + Point in world space where the ray should start. + Direction and length of the ray. + Color of the drawn line. + How long the line will be visible for (in seconds). + Should the line be obscured by other objects closer to the camera? + + + + Log a message to the Unity Console. + + String or object to be converted to string representation for display. + Object to which the message applies. + + + + Log a message to the Unity Console. + + String or object to be converted to string representation for display. + Object to which the message applies. + + + + A variant of Debug.Log that logs an assertion message to the console. + + String or object to be converted to string representation for display. + Object to which the message applies. + + + + A variant of Debug.Log that logs an assertion message to the console. + + String or object to be converted to string representation for display. + Object to which the message applies. + + + + Logs a formatted assertion message to the Unity console. + + A composite format string. + Format arguments. + Object to which the message applies. + + + + Logs a formatted assertion message to the Unity console. + + A composite format string. + Format arguments. + Object to which the message applies. + + + + A variant of Debug.Log that logs an error message to the console. + + String or object to be converted to string representation for display. + Object to which the message applies. + + + + A variant of Debug.Log that logs an error message to the console. + + String or object to be converted to string representation for display. + Object to which the message applies. + + + + Logs a formatted error message to the Unity console. + + A composite format string. + Format arguments. + Object to which the message applies. + + + + Logs a formatted error message to the Unity console. + + A composite format string. + Format arguments. + Object to which the message applies. + + + + A variant of Debug.Log that logs an error message to the console. + + Object to which the message applies. + Runtime Exception. + + + + A variant of Debug.Log that logs an error message to the console. + + Object to which the message applies. + Runtime Exception. + + + + Logs a formatted message to the Unity Console. + + A composite format string. + Format arguments. + Object to which the message applies. + + + + Logs a formatted message to the Unity Console. + + A composite format string. + Format arguments. + Object to which the message applies. + + + + A variant of Debug.Log that logs a warning message to the console. + + String or object to be converted to string representation for display. + Object to which the message applies. + + + + A variant of Debug.Log that logs a warning message to the console. + + String or object to be converted to string representation for display. + Object to which the message applies. + + + + Logs a formatted warning message to the Unity Console. + + A composite format string. + Format arguments. + Object to which the message applies. + + + + Logs a formatted warning message to the Unity Console. + + A composite format string. + Format arguments. + Object to which the message applies. + + + + Attribute used to make a float, int, or string variable in a script be delayed. + + + + + Attribute used to make a float, int, or string variable in a script be delayed. + + + + + Depth texture generation mode for Camera. + + + + + Generate a depth texture. + + + + + Generate a depth + normals texture. + + + + + Specifies whether motion vectors should be rendered (if possible). + + + + + Do not generate depth texture (Default). + + + + + Detail prototype used by the Terrain GameObject. + + + + + Bend factor of the detailPrototype. + + + + + Color when the DetailPrototypes are "dry". + + + + + Color when the DetailPrototypes are "healthy". + + + + + Maximum height of the grass billboards (if render mode is GrassBillboard). + + + + + Maximum width of the grass billboards (if render mode is GrassBillboard). + + + + + Minimum height of the grass billboards (if render mode is GrassBillboard). + + + + + Minimum width of the grass billboards (if render mode is GrassBillboard). + + + + + How spread out is the noise for the DetailPrototype. + + + + + GameObject used by the DetailPrototype. + + + + + Texture used by the DetailPrototype. + + + + + Render mode for the DetailPrototype. + + + + + Render mode for detail prototypes. + + + + + The detail prototype will use the grass shader. + + + + + The detail prototype will be rendered as billboards that are always facing the camera. + + + + + Will show the prototype using diffuse shading. + + + + + Describes physical orientation of the device as determined by the OS. + + + + + The device is held parallel to the ground with the screen facing downwards. + + + + + The device is held parallel to the ground with the screen facing upwards. + + + + + The device is in landscape mode, with the device held upright and the home button on the right side. + + + + + The device is in landscape mode, with the device held upright and the home button on the left side. + + + + + The device is in portrait mode, with the device held upright and the home button at the bottom. + + + + + The device is in portrait mode but upside down, with the device held upright and the home button at the top. + + + + + The orientation of the device cannot be determined. + + + + + Enumeration for SystemInfo.deviceType, denotes a coarse grouping of kinds of devices. + + + + + A stationary gaming console. + + + + + Desktop or laptop computer. + + + + + A handheld device like mobile phone or a tablet. + + + + + Device type is unknown. You should never see this in practice. + + + + + Specifies the category of crash to cause when calling ForceCrash(). + + + + + Cause a crash by calling the abort() function. + + + + + Cause a crash by performing an invalid memory access. + +The invalid memory access is performed on each platform as follows: + + + + + Cause a crash using Unity's native fatal error implementation. + + + + + Cause a crash by calling a pure virtual function to raise an exception. + + + + + A utility class that you can use for diagnostic purposes. + + + + + Manually causes an application crash in the specified category. + + + + + + Manually causes an assert that outputs the specified message to the log and registers an error. + + + + + + Manually causes a native error that outputs the specified message to the log and registers an error. + + + + + + Manually causes a warning that outputs the specified message to the log and registers an error. + + + + + + Prevents MonoBehaviour of same type (or subtype) to be added more than once to a GameObject. + + + + + Provides access to a display / screen for rendering operations. + + + + + Gets the state of the display and returns true if the display is active and false if otherwise. + + + + + Color RenderBuffer. + + + + + Depth RenderBuffer. + + + + + The list of currently connected Displays. Contains at least one (main) display. + + + + + Main Display. + + + + + Vertical resolution that the display is rendering at. + + + + + Horizontal resolution that the display is rendering at. + + + + + Vertical native display resolution. + + + + + Horizontal native display resolution. + + + + + Activate an external display. Eg. Secondary Monitors connected to the System. + + + + + This overloaded function available for Windows allows specifying desired Window Width, Height and Refresh Rate. + + Desired Width of the Window (for Windows only. On Linux and Mac uses Screen Width). + Desired Height of the Window (for Windows only. On Linux and Mac uses Screen Height). + Desired Refresh Rate. + + + + Query relative mouse coordinates. + + Mouse Input Position as Coordinates. + + + + Set rendering size and position on screen (Windows only). + + Change Window Width (Windows Only). + Change Window Height (Windows Only). + Change Window Position X (Windows Only). + Change Window Position Y (Windows Only). + + + + Sets rendering resolution for the display. + + Rendering width in pixels. + Rendering height in pixels. + + + + Joint that keeps two Rigidbody2D objects a fixed distance apart. + + + + + Should the distance be calculated automatically? + + + + + The distance separating the two ends of the joint. + + + + + Whether to maintain a maximum distance only or not. If not then the absolute distance will be maintained instead. + + + + + A component can be designed to drive a RectTransform. The DrivenRectTransformTracker struct is used to specify which RectTransforms it is driving. + + + + + Add a RectTransform to be driven. + + The object to drive properties. + The RectTransform to be driven. + The properties to be driven. + + + + Clear the list of RectTransforms being driven. + + + + + Resume recording undo of driven RectTransforms. + + + + + Stop recording undo actions from driven RectTransforms. + + + + + An enumeration of transform properties that can be driven on a RectTransform by an object. + + + + + Selects all driven properties. + + + + + Selects driven property RectTransform.anchoredPosition. + + + + + Selects driven property RectTransform.anchoredPosition3D. + + + + + Selects driven property RectTransform.anchoredPosition.x. + + + + + Selects driven property RectTransform.anchoredPosition.y. + + + + + Selects driven property RectTransform.anchoredPosition3D.z. + + + + + Selects driven property combining AnchorMaxX and AnchorMaxY. + + + + + Selects driven property RectTransform.anchorMax.x. + + + + + Selects driven property RectTransform.anchorMax.y. + + + + + Selects driven property combining AnchorMinX and AnchorMinY. + + + + + Selects driven property RectTransform.anchorMin.x. + + + + + Selects driven property RectTransform.anchorMin.y. + + + + + Selects driven property combining AnchorMinX, AnchorMinY, AnchorMaxX and AnchorMaxY. + + + + + Deselects all driven properties. + + + + + Selects driven property combining PivotX and PivotY. + + + + + Selects driven property RectTransform.pivot.x. + + + + + Selects driven property RectTransform.pivot.y. + + + + + Selects driven property Transform.localRotation. + + + + + Selects driven property combining ScaleX, ScaleY && ScaleZ. + + + + + Selects driven property Transform.localScale.x. + + + + + Selects driven property Transform.localScale.y. + + + + + Selects driven property Transform.localScale.z. + + + + + Selects driven property combining SizeDeltaX and SizeDeltaY. + + + + + Selects driven property RectTransform.sizeDelta.x. + + + + + Selects driven property RectTransform.sizeDelta.y. + + + + + Status of the menu item. + + + + + The item is displayed with a checkmark. + + + + + The item is disabled and is not be selectable by the user. + + + + + The item is not displayed. + + + + + The item is displayed normally. + + + + + Describe the unit of a duration. + + + + + A fixed duration is a duration expressed in seconds. + + + + + A normalized duration is a duration expressed in percentage. + + + + + Allows to control the dynamic Global Illumination. + + + + + Allows for scaling the contribution coming from realtime & baked lightmaps. + +Note: this value can be set in the Lighting Window UI and it is serialized, that is not the case for other properties in this class. + + + + + Is precomputed realtime Global Illumination output converged? + + + + + The number of milliseconds that can be spent on material updates. + + + + + When enabled, new dynamic Global Illumination output is shown in each frame. + + + + + Threshold for limiting updates of realtime GI. The unit of measurement is "percentage intensity change". + + + + + Allows to set an emissive color for a given renderer quickly, without the need to render the emissive input for the entire system. + + The Renderer that should get a new color. + The emissive Color. + + + + Allows overriding the distant environment lighting for Realtime GI, without changing the Skybox Material. + + Array of float values to be used for Realtime GI environment lighting. + + + + Schedules an update of the environment texture. + + + + + Schedules an update of the albedo and emissive textures of a system that contains the renderer or the terrain. + + The Renderer to use when searching for a system to update. + The Terrain to use when searching for systems to update. + + + + Schedules an update of the albedo and emissive textures of a system that contains the renderer or the terrain. + + The Renderer to use when searching for a system to update. + The Terrain to use when searching for systems to update. + + + + Schedules an update of the albedo and emissive textures of a system that contains the renderer or the terrain. + + The Renderer to use when searching for a system to update. + The Terrain to use when searching for systems to update. + + + + Collider for 2D physics representing an arbitrary set of connected edges (lines) defined by its vertices. + + + + + Gets the number of edges. + + + + + Controls the radius of all edges created by the collider. + + + + + Gets the number of points. + + + + + Get or set the points defining multiple continuous edges. + + + + + Reset to a single edge consisting of two points. + + + + + A base class for all 2D effectors. + + + + + The mask used to select specific layers allowed to interact with the effector. + + + + + Should the collider-mask be used or the global collision matrix? + + + + + The mode used to apply Effector2D forces. + + + + + The force is applied at a constant rate. + + + + + The force is applied inverse-linear relative to a point. + + + + + The force is applied inverse-squared relative to a point. + + + + + Selects the source and/or target to be used by an Effector2D. + + + + + The source/target is defined by the Collider2D. + + + + + The source/target is defined by the Rigidbody2D. + + + + + A UnityGUI event. + + + + + Is Alt/Option key held down? (Read Only) + + + + + Which mouse button was pressed. + + + + + Is Caps Lock on? (Read Only) + + + + + The character typed. + + + + + How many consecutive mouse clicks have we received. + + + + + Is Command/Windows key held down? (Read Only) + + + + + The name of an ExecuteCommand or ValidateCommand Event. + + + + + Is Control key held down? (Read Only) + + + + + The current event that's being processed right now. + + + + + The relative movement of the mouse compared to last event. + + + + + Index of display that the event belongs to. + + + + + Is the current keypress a function key? (Read Only) + + + + + Is this event a keyboard event? (Read Only) + + + + + Is this event a mouse event? (Read Only) + + + + + The raw key code for keyboard events. + + + + + Which modifier keys are held down. + + + + + The mouse position. + + + + + Is the current keypress on the numeric keyboard? (Read Only) + + + + + Is Shift held down? (Read Only) + + + + + The type of event. + + + + + Returns the current number of events that are stored in the event queue. + + + Current number of events currently in the event queue. + + + + + Get a filtered event type for a given control ID. + + The ID of the control you are querying from. + + + + Create a keyboard event. + + + + + + Get the next queued [Event] from the event system. + + Next Event. + + + + Use this event. + + + + + Types of modifier key that can be active during a keystroke event. + + + + + Alt key. + + + + + Caps lock key. + + + + + Command key (Mac). + + + + + Control key. + + + + + Function key. + + + + + No modifier key pressed during a keystroke event. + + + + + Num lock key. + + + + + Shift key. + + + + + THe mode that a listener is operating in. + + + + + The listener will bind to one argument bool functions. + + + + + The listener will use the function binding specified by the even. + + + + + The listener will bind to one argument float functions. + + + + + The listener will bind to one argument int functions. + + + + + The listener will bind to one argument Object functions. + + + + + The listener will bind to one argument string functions. + + + + + The listener will bind to zero argument functions. + + + + + Zero argument delegate used by UnityEvents. + + + + + One argument delegate used by UnityEvents. + + + + + + Two argument delegate used by UnityEvents. + + + + + + + Three argument delegate used by UnityEvents. + + + + + + + + Four argument delegate used by UnityEvents. + + + + + + + + + A zero argument persistent callback that can be saved with the Scene. + + + + + Add a non persistent listener to the UnityEvent. + + Callback function. + + + + Constructor. + + + + + Invoke all registered callbacks (runtime and persistent). + + + + + Remove a non persistent listener from the UnityEvent. + + Callback function. + + + + One argument version of UnityEvent. + + + + + Two argument version of UnityEvent. + + + + + Three argument version of UnityEvent. + + + + + Four argument version of UnityEvent. + + + + + Abstract base class for UnityEvents. + + + + + Get the number of registered persistent listeners. + + + + + Get the target method name of the listener at index index. + + Index of the listener to query. + + + + Get the target component of the listener at index index. + + Index of the listener to query. + + + + Given an object, function name, and a list of argument types; find the method that matches. + + Object to search for the method. + Function name to search for. + Argument types for the function. + + + + Remove all non-persisent (ie created from script) listeners from the event. + + + + + Modify the execution state of a persistent listener. + + Index of the listener to query. + State to set. + + + + Controls the scope of UnityEvent callbacks. + + + + + Callback is always issued. + + + + + Callback is not issued. + + + + + Callback is only issued in the Runtime and Editor playmode. + + + + + Types of UnityGUI input and processing events. + + + + + An event that is called when the mouse is clicked. + + + + + An event that is called when the mouse is clicked and dragged. + + + + + An event that is called when the mouse is no longer being clicked. + + + + + User has right-clicked (or control-clicked on the mac). + + + + + Editor only: drag & drop operation exited. + + + + + Editor only: drag & drop operation performed. + + + + + Editor only: drag & drop operation updated. + + + + + Execute a special command (eg. copy & paste). + + + + + Event should be ignored. + + + + + A keyboard key was pressed. + + + + + A keyboard key was released. + + + + + A layout event. + + + + + Mouse button was pressed. + + + + + Mouse was dragged. + + + + + Mouse entered a window (Editor views only). + + + + + Mouse left a window (Editor views only). + + + + + Mouse was moved (Editor views only). + + + + + Mouse button was released. + + + + + A repaint event. One is sent every frame. + + + + + The scroll wheel was moved. + + + + + Already processed event. + + + + + Validates a special command (e.g. copy & paste). + + + + + Add this attribute to a class to prevent the class and its inherited classes from being created with ObjectFactory methods. + + + + + Default constructor. + + + + + Add this attribute to a class to prevent creating a Preset from the instances of the class. + + + + + Makes instances of a script always execute, both as part of Play Mode and when editing. + + + + + Makes all instances of a script execute in Edit Mode. + + + + + An exception that will prevent all subsequent immediate mode GUI functions from evaluating for the remainder of the GUI loop. + + + + + A world position that is guaranteed to be on the surface of the NavMesh. + + + + + Unique identifier for the node in the NavMesh to which the world position has been mapped. + + + + + A world position that sits precisely on the surface of the NavMesh or along its links. + + + + + The types of nodes in the navigation data. + + + + + Type of node in the NavMesh representing one surface polygon. + + + + + Type of node in the NavMesh representing a point-to-point connection between two positions on the NavMesh surface. + + + + + Object used for doing navigation operations in a NavMeshWorld. + + + + + Initiates a pathfinding operation between two locations on the NavMesh. + + Array of custom cost values for all of the 32 possible area types. Each value must be at least 1.0f. This parameter is optional and defaults to the area costs configured in the project settings. See Also: NavMesh.GetAreaCost. + Bitmask with values of 1 set at the indices for areas that can be traversed, and values of 0 for areas that are not traversable. This parameter is optional and defaults to NavMesh.AllAreas, if omitted. See Also:. + The start location on the NavMesh for the path. + The location on the NavMesh where the path ends. + + InProgress if the operation was successful and the query is ready to search for a path. + +Failure if the query's NavMeshWorld or any of the received parameters are no longer valid. + + + + + Returns a valid NavMeshLocation for a position and a polygon provided by the user. + + World position of the NavMeshLocation to be created. + Valid identifier for the NavMesh node. + + Object containing the desired position and NavMesh node. + + + + + Creates the NavMeshQuery object and allocates memory to store NavMesh node information, if required. + + NavMeshWorld object used as an entry point to the collection of NavMesh objects. This object that can be used by query operations. + Label indicating the desired life time of the object. (Known issue: Currently allocator has no effect). + The number of nodes that can be temporarily stored in the query during search operations. This value defaults to 0 if no other value is specified. + + + + Destroys the NavMeshQuery and deallocates all memory used by it. + + + + + Obtains the number of nodes in the path that has been computed during a successful NavMeshQuery.UpdateFindPath operation. + + A reference to an int which will be set to the number of NavMesh nodes in the found path. + + Success when the number of nodes in the path was retrieved correctly. + +PartialPath when a path was found but it falls short of the desired end location. + +Failure when the path size can not be evaluated because the preceding call to UpdateFindPath was not successful. + + + + + Returns the identifier of the agent type the NavMesh was baked for or for which the link has been configured. + + Identifier of a node from a NavMesh surface or link. + + Agent type identifier. + + + + + Copies into the provided array the list of NavMesh nodes that form the path found by the NavMeshQuery operation. + + Data array to be filled with the sequence of NavMesh nodes that comprises the found path. + + Number of path nodes successfully copied into the provided array. + + + + + Returns whether the NavMesh node is a polygon or a link. + + Identifier of a node from a NavMesh surface or link. + + Ground when the node is a polygon on a NavMesh surface. + +OffMeshConnection when the node is a. + + + + + Obtains the end points of the line segment common to two adjacent NavMesh nodes. + + First NavMesh node. + Second NavMesh node. + One of the world points for the resulting separation edge which must be passed through when traversing between the two specified nodes. This point is the left side of the edge when traversing from the first node to the second. + One of the world points for the resulting separation edge which must be passed through when traversing between the two specified nodes. This point is the right side of the edge when traversing from the first node to the second. + + True if a connection exists between the two NavMesh nodes. +False if no connection exists between the two NavMesh nodes. + + + + + Returns true if the node referenced by the specified PolygonId is active in the NavMesh. + + Identifier of the NavMesh node to be checked. + + + + Returns true if the node referenced by the PolygonId contained in the NavMeshLocation is active in the NavMesh. + + Location on the NavMesh to be checked. Same as checking location.polygon directly. + + + + Finds the closest point and PolygonId on the NavMesh for a given world position. + + World position for which the closest point on the NavMesh needs to be found. + Maximum distance, from the specified position, expanding along all three axes, within which NavMesh surfaces are searched. + Identifier for the agent type whose NavMesh surfaces should be selected for this operation. The Humanoid agent type exists for all NavMeshes and has an ID of 0. Other agent types can be defined manually through the Editor. A separate NavMesh surface needs to be baked for each agent type. + Bitmask used to represent areas of the NavMesh that should (value of 1) or shouldn't (values of 0) be sampled. This parameter is optional and defaults to NavMesh.AllAreas if unspecified. See Also:. + + An object with position and valid PolygonId - when a point on the NavMesh has been found. + +An invalid object - when no NavMesh surface with the desired features has been found within the search area. See Also: NavMeshQuery.IsValid. + + + + + Translates a NavMesh location to another position without losing contact with the surface. + + Position to be moved across the NavMesh surface. + World position you require the agent to move to. + Bitmask with values of 1 set at the indices corresponding to areas that can be traversed, and with values of 0 for areas that should not be traversed. This parameter can be omitted, in which case it defaults to NavMesh.AllAreas. See Also:. + + A new location on the NavMesh placed as closely as possible to the specified target position. + +The start location is returned when that start is inside an area which is not allowed by the areaMask. + + + + + Translates a series of NavMesh locations to other positions without losing contact with the surface. + + Array of positions to be moved across the NavMesh surface. At the end of the method call this array contains the resulting locations. + World positions to be used as movement targets by the agent. + Filters for the areas which can be traversed during the movement to each of the locations. + + + + Translates a series of NavMesh locations to other positions without losing contact with the surface, given one common area filter for all of them. + + Array of positions to be moved across the NavMesh surface. At the end of the method call this array contains the resulting locations. + World positions you want the agent to reach when moving to each of the locations. + Filters for the areas which can be traversed during the movement to each of the locations. + + + + Returns the transformation matrix of the NavMesh surface that contains the specified NavMesh node (Read Only). + + NavMesh node for which its owner's transform must be determined. + + Transformation matrix for the surface owning the specified polygon. + +Matrix4x4.identity when the NavMesh node is a. + + + + + Returns the inverse transformation matrix of the NavMesh surface that contains the specified NavMesh node (Read Only). + + NavMesh node for which its owner's inverse transform must be determined. + + Inverse transformation matrix of the surface owning the specified polygon. + +Matrix4x4.identity when the NavMesh node is a. + + + + + Trace a line between two points on the NavMesh. + + Holds the properties of the raycast resulting location. + The start location of the ray on the NavMesh. start.polygon must be of the type NavMeshPolyTypes.Ground. + The desired end of the ray, in world coordinates. + Bitmask that correlates index positions with area types. The index goes from 0 to 31. In each relevant index position, you have to set the value to either 1 or 0. 1 indicates area types that the ray can pass through. 0 indicates area types that block the ray. This parameter is optional. If you leave out this parameter, it defaults to NavMesh.AllAreas. To learn more, see:. + Array of custom cost values for all of the 32 possible area types. They act as multipliers to the distance reported by the ray when crossing various areas. This parameter is optional. If you omit it, it defaults to the area costs that you configured in the Project settings. To learn more, see NavMesh.GetAreaCost. + + Success if the ray can be correctly traced using the provided arguments. + +Failure if the start location is not valid in the query's NavMeshWorld, or if it is inside an area not permitted by the areaMask argument, or when it is on a. + + + + + Trace a line between two points on the NavMesh, and return the list of polygons through which it passed. + + Holds the properties of the raycast resulting location. + A buffer that will be filled with the sequence of polygons through which the ray passes. + The reported number of polygons through which the ray has passed, all stored in the path buffer. It will not be greater than path.Length. + The start location of the ray on the NavMesh. start.polygon must be of the type NavMeshPolyTypes.Ground. + The desired end of the ray, in world coordinates. + A bitfield that specifies which NavMesh areas can be traversed when the ray is traced. This parameter is optional. If you do not fill out this parameter, it defaults to NavMesh.AllAreas. + Cost multipliers that affect the distance reported by the ray over different area types. This parameter is optional. If you omit it, it defaults to the area costs that you configured in the Project settings. + + Success if the ray can be correctly traced using the provided arguments. + +Failure if the start location is not valid in the query's NavMeshWorld, or if it is inside an area not permitted by the areaMask argument, or when it is on a. + +BufferTooSmall is part of the returned flags when the provided path buffer is not large enough to hold all the polygons that the ray passed through. + + + + + Continues a path search that is in progress. + + Maximum number of nodes to be traversed by the search algorithm during this call. + Outputs the actual number of nodes that have been traversed during this call. + + InProgress if the search needs to continue further by calling UpdateFindPath again. + +Success if the search is completed and a path has been found or not. + +Failure if the search for the desired position could not be completed because the NavMesh has changed significantly since the search was initiated. + +Additionally the returned value can contain the OutOfNodes flag when the pathNodePoolSize parameter for the NavMeshQuery initialization was not large enough to accommodate the search space. + + + + + Assembles together a collection of NavMesh surfaces and links that are used as a whole for performing navigation operations. + + + + + Tells the NavMesh world to halt any changes until the specified job is completed. + + The job that needs to be completed before the NavMesh world can be modified in any way. + + + + Returns a reference to the single NavMeshWorld that can currently exist and be used in Unity. + + + + + Returns true if the NavMeshWorld has been properly initialized. + + + + + Bit flags representing the resulting state of NavMeshQuery operations. + + + + + The node buffer of the query was too small to store all results. + + + + + The operation has failed. + + + + + The operation is in progress. + + + + + A parameter did not contain valid information, useful for carring out the NavMesh query. + + + + + Operation ran out of memory. + + + + + Query ran out of node stack space during a search. + + + + + Query did not reach the end location, returning best guess. + + + + + Bitmask that has 0 set for the Success, Failure and InProgress bits and 1 set for all the other flags. + + + + + The operation was successful. + + + + + Data in the NavMesh cannot be recognized and used. + + + + + Data in the NavMesh world has a wrong version. + + + + + Represents a compact identifier for the data of a NavMesh node. + + + + + Returns true if two PolygonId objects refer to the same NavMesh node. + + + + + + + Returns true if two PolygonId objects refer to the same NavMesh node. + + + + + + + Returns the hash code for use in collections. + + + + + Returns true if the PolygonId has been created empty and has never pointed to any node in the NavMesh. + + + + + Returns true if two PolygonId objects refer to the same NavMesh node or if they are both null. + + + + + + + Returns true if two PolygonId objects refer to different NavMesh nodes or if only one of them is null. + + + + + + + The humanoid stream of animation data passed from one Playable to another. + + + + + The position of the body center of mass relative to the root. + + + + + The rotation of the body center of mass relative to the root. + + + + + The position of the body center of mass in world space. + + + + + The rotation of the body center of mass in world space. + + + + + The scale of the Avatar. (Read Only) + + + + + Returns true if the stream is valid; false otherwise. (Read Only) + + + + + The left foot height from the floor. (Read Only) + + + + + The left foot velocity from the last evaluated frame. (Read Only) + + + + + The right foot height from the floor. (Read Only) + + + + + The right foot velocity from the last evaluated frame. (Read Only) + + + + + Returns the position of this IK goal relative to the root. + + The AvatarIKGoal that is queried. + + The position of this IK goal. + + + + + Returns the rotation of this IK goal relative to the root. + + The AvatarIKGoal that is queried. + + The rotation of this IK goal. + + + + + Returns the position of this IK goal in world space. + + The AvatarIKGoal that is queried. + + The position of this IK goal. + + + + + Returns the position of this IK goal in world space computed from the stream current pose. + + The AvatarIKGoal that is queried. + + The position of this IK goal. + + + + + Returns the rotation of this IK goal in world space. + + The AvatarIKGoal that is queried. + + The rotation of this IK goal. + + + + + Returns the rotation of this IK goal in world space computed from the stream current pose. + + The AvatarIKGoal that is queried. + + The rotation of this IK goal. + + + + + Returns the position weight of the IK goal. + + The AvatarIKGoal that is queried. + + The position weight of the IK goal. + + + + + Returns the rotation weight of the IK goal. + + The AvatarIKGoal that is queried. + + The rotation weight of the IK goal. + + + + + Returns the position of this IK Hint in world space. + + The AvatarIKHint that is queried. + + The position of this IK Hint. + + + + + Returns the position weight of the IK Hint. + + The AvatarIKHint that is queried. + + The position weight of the IK Hint. + + + + + Returns the muscle value. + + The Muscle that is queried. + + The muscle value. + + + + + Reset the current pose to the stance pose (T Pose). + + + + + Sets the position of this IK goal relative to the root. + + The AvatarIKGoal that is queried. + The position of this IK goal. + + + + Sets the rotation of this IK goal relative to the root. + + The AvatarIKGoal that is queried. + The rotation of this IK goal. + + + + Sets the position of this IK goal in world space. + + The AvatarIKGoal that is queried. + The position of this IK goal. + + + + Sets the rotation of this IK goal in world space. + + The AvatarIKGoal that is queried. + The rotation of this IK goal. + + + + Sets the position weight of the IK goal. + + The AvatarIKGoal that is queried. + The position weight of the IK goal. + + + + Sets the rotation weight of the IK goal. + + The AvatarIKGoal that is queried. + The rotation weight of the IK goal. + + + + Sets the position of this IK hint in world space. + + The AvatarIKHint that is queried. + The position of this IK hint. + + + + Sets the position weight of the IK Hint. + + The AvatarIKHint that is queried. + The position weight of the IK Hint. + + + + Sets the LookAt body weight. + + The LookAt body weight. + + + + Sets the LookAt clamp weight. + + The LookAt clamp weight. + + + + Sets the LookAt eyes weight. + + The LookAt eyes weight. + + + + Sets the LookAt head weight. + + The LookAt head weight. + + + + Sets the look at position in world space. + + The look at position. + + + + Sets the muscle value. + + The Muscle that is queried. + The muscle value. + + + + Execute the IK solver. + + + + + A Playable that can run a custom, multi-threaded animation job. + + + + + Creates an AnimationScriptPlayable in the PlayableGraph. + + The PlayableGraph object that will own the AnimationScriptPlayable. + The IAnimationJob to execute when processing the playable. + The number of inputs on the playable. + + + A new AnimationScriptPlayable linked to the PlayableGraph. + + + + + Gets the job data contained in the playable. + + + Returns the IAnimationJob data contained in the playable. + + + + + Returns whether the playable inputs will be processed or not. + + + true if the inputs will be processed; false otherwise. + + + + + Sets a new job data in the playable. + + The new IAnimationJob data to set in the playable. + + + + Sets the new value for processing the inputs or not. + + The new value for processing the inputs or not. + + + + The stream of animation data passed from one Playable to another. + + + + + Gets or sets the avatar angular velocity for the evaluated frame. + + + + + Gets the delta time for the evaluated frame. (Read Only) + + + + + Gets the number of input streams. (Read Only) + + + + + Returns true if the stream is from a humanoid avatar; false otherwise. (Read Only) + + + + + Returns true if the stream is valid; false otherwise. (Read Only) + + + + + Gets the root motion position for the evaluated frame. (Read Only) + + + + + Gets the root motion rotation for the evaluated frame. (Read Only) + + + + + Gets or sets the avatar velocity for the evaluated frame. + + + + + Gets the same stream, but as an AnimationHumanStream. + + + Returns the same stream, but as an AnimationHumanStream. + + + + + Gets the AnimationStream of the playable input at index. + + The input index. + + Returns the AnimationStream of the playable input at index. Returns an invalid stream if the input is not an animation Playable. + + + + + Static class providing extension methods for Animator and the animation C# jobs. + + + + + Create a PropertySceneHandle representing the new binding on the Component property of a Transform in the Scene. + + The Animator instance the method is called on. + The Transform to target. + The Component type. + The property to bind. + isObjectReference need to be set to true if the property to bind does access an Object like SpriteRenderer.sprite. + + The PropertySceneHandle representing the new binding. + + + + + Create a PropertySceneHandle representing the new binding on the Component property of a Transform in the Scene. + + The Animator instance the method is called on. + The Transform to target. + The Component type. + The property to bind. + isObjectReference need to be set to true if the property to bind does access an Object like SpriteRenderer.sprite. + + The PropertySceneHandle representing the new binding. + + + + + Create a TransformSceneHandle representing the new binding between the Animator and a Transform in the Scene. + + The Animator instance the method is called on. + The Transform to bind. + + The TransformSceneHandle representing the new binding. + + + + + Create a PropertyStreamHandle representing the new binding on the Component property of a Transform already bound to the Animator. + + The Animator instance the method is called on. + The Transform to target. + The Component type. + The property to bind. + isObjectReference need to be set to true if the property to bind does animate an Object like SpriteRenderer.sprite. + + The PropertyStreamHandle representing the new binding. + + + + + Create a PropertyStreamHandle representing the new binding on the Component property of a Transform already bound to the Animator. + + The Animator instance the method is called on. + The Transform to target. + The Component type. + The property to bind. + isObjectReference need to be set to true if the property to bind does animate an Object like SpriteRenderer.sprite. + + The PropertyStreamHandle representing the new binding. + + + + + Create a TransformStreamHandle representing the new binding between the Animator and a Transform already bound to the Animator. + + The Animator instance the method is called on. + The Transform to bind. + + The TransformStreamHandle representing the new binding. + + + + + Close a stream that has been opened using OpenAnimationStream. + + The Animator instance the method is called on. + The stream to close. + + + + Open a new stream on the Animator. + + The Animator instance the method is called on. + The new stream. + + Whether or not the stream have been opened. + + + + + Newly created handles are always resolved lazily on the next access when the jobs are run. To avoid a cpu spike while evaluating the jobs you can manually resolve all handles from the main thread. + + The Animator instance the method is called on. + + + + Newly created handles are always resolved lazily on the next access when the jobs are run. To avoid a cpu spike while evaluating the jobs you can manually resolve all handles from the main thread. + + The Animator instance the method is called on. + + + + The interface defining an animation job to use with an IAnimationJobPlayable. + + + + + Defines what to do when processing the animation. + + The animation stream to work on. + + + + Defines what to do when processing the root motion. + + The animation stream to work on. + + + + The interface defining an animation playable that uses IAnimationJob. + + + + + Gets the job data contained in the playable. + + + Returns the IAnimationJob data contained in the playable. + + + + + Sets a new job data in the playable. + + The new IAnimationJob data to set in the playable. + + + + Handle for a muscle in the AnimationHumanStream. + + + + + The muscle human sub-part. (Read Only) + + + + + The muscle human part. (Read Only) + + + + + The total number of DoF parts in a humanoid. (Read Only) + + + + + The name of the muscle. (Read Only) + + + + + The different constructors that creates the muscle handle. + + The muscle body sub-part. + The muscle head sub-part. + The muscle human part. + The muscle leg sub-part. + The muscle arm sub-part. + The muscle finger sub-part. + + + + The different constructors that creates the muscle handle. + + The muscle body sub-part. + The muscle head sub-part. + The muscle human part. + The muscle leg sub-part. + The muscle arm sub-part. + The muscle finger sub-part. + + + + The different constructors that creates the muscle handle. + + The muscle body sub-part. + The muscle head sub-part. + The muscle human part. + The muscle leg sub-part. + The muscle arm sub-part. + The muscle finger sub-part. + + + + The different constructors that creates the muscle handle. + + The muscle body sub-part. + The muscle head sub-part. + The muscle human part. + The muscle leg sub-part. + The muscle arm sub-part. + The muscle finger sub-part. + + + + The different constructors that creates the muscle handle. + + The muscle body sub-part. + The muscle head sub-part. + The muscle human part. + The muscle leg sub-part. + The muscle arm sub-part. + The muscle finger sub-part. + + + + The different constructors that creates the muscle handle. + + The muscle body sub-part. + The muscle head sub-part. + The muscle human part. + The muscle leg sub-part. + The muscle arm sub-part. + The muscle finger sub-part. + + + + The different constructors that creates the muscle handle. + + The muscle body sub-part. + The muscle head sub-part. + The muscle human part. + The muscle leg sub-part. + The muscle arm sub-part. + The muscle finger sub-part. + + + + Fills the array with all the possible muscle handles on a humanoid. + + An array of MuscleHandle. + + + + Handle for a Component property on an object in the Scene. + + + + + Gets the boolean property value from an object in the Scene. + + The AnimationStream managing this handle. + + The boolean property value. + + + + + Gets the float property value from an object in the Scene. + + The AnimationStream managing this handle. + + The float property value. + + + + + Gets the integer property value from an object in the Scene. + + The AnimationStream managing this handle. + + The integer property value. + + + + + Returns whether or not the handle is resolved. + + The AnimationStream managing this handle. + + Returns true if the handle is resolved, false otherwise. + + + + + Returns whether or not the handle is valid. + + The AnimationStream managing this handle. + + Whether or not the handle is valid. + + + + + Resolves the handle. + + The AnimationStream managing this handle. + + + + Sets the boolean property value to an object in the Scene. + + The AnimationStream managing this handle. + The new boolean property value. + + + + Sets the float property value to an object in the Scene. + + The AnimationStream managing this handle. + The new float property value. + + + + Sets the integer property value to an object in the Scene. + + The AnimationStream managing this handle. + The new integer property value. + + + + Handle for a Component property on an object in the AnimationStream. + + + + + Gets the boolean property value from a stream. + + The AnimationStream holding the animated values. + + The boolean property value. + + + + + Gets the float property value from a stream. + + The AnimationStream holding the animated values. + + The float property value. + + + + + Gets the integer property value from a stream. + + The AnimationStream holding the animated values. + + The integer property value. + + + + + Returns whether or not the handle is resolved. + + The AnimationStream holding the animated values. + + Returns true if the handle is resolved, false otherwise. + + + + + Returns whether or not the handle is valid. + + The AnimationStream holding the animated values. + + Whether or not the handle is valid. + + + + + Resolves the handle. + + The AnimationStream holding the animated values. + + + + Sets the boolean property value into a stream. + + The AnimationStream holding the animated values. + The new boolean property value. + + + + Sets the float property value into a stream. + + The AnimationStream holding the animated values. + The new float property value. + + + + Sets the integer property value into a stream. + + The AnimationStream holding the animated values. + The new integer property value. + + + + Position, rotation and scale of an object in the Scene. + + + + + Gets the position of the transform relative to the parent. + + The AnimationStream that manage this handle. + + The position of the transform relative to the parent. + + + + + Gets the rotation of the transform relative to the parent. + + The AnimationStream that manage this handle. + + The rotation of the transform relative to the parent. + + + + + Gets the scale of the transform relative to the parent. + + The AnimationStream that manage this handle. + + The scale of the transform relative to the parent. + + + + + Gets the position of the transform in world space. + + The AnimationStream that manage this handle. + + The position of the transform in world space. + + + + + Gets the rotation of the transform in world space. + + The AnimationStream that manage this handle. + + The rotation of the transform in world space. + + + + + Returns whether this is a valid handle. + + The AnimationStream that manage this handle. + + Whether this is a valid handle. + + + + + Sets the position of the transform relative to the parent. + + The AnimationStream that manage this handle. + The position of the transform relative to the parent. + + + + Sets the rotation of the transform relative to the parent. + + The AnimationStream that manage this handle. + The rotation of the transform relative to the parent. + + + + Sets the scale of the transform relative to the parent. + + The AnimationStream that manage this handle. + The scale of the transform relative to the parent. + + + + Sets the position of the transform in world space. + + The AnimationStream that manage this handle. + The position of the transform in world space. + + + + Sets the rotation of the transform in world space. + + The AnimationStream that manage this handle. + The rotation of the transform in world space. + + + + Position, rotation and scale of an object in the AnimationStream. + + + + + Gets the position of the transform relative to the parent. + + The AnimationStream that hold the animated values. + + The position of the transform relative to the parent. + + + + + Gets the rotation of the transform relative to the parent. + + The AnimationStream that hold the animated values. + + The rotation of the transform relative to the parent. + + + + + Gets the scale of the transform relative to the parent. + + The AnimationStream that hold the animated values. + + The scale of the transform relative to the parent. + + + + + Gets the position of the transform in world space. + + The AnimationStream that hold the animated values. + + The position of the transform in world space. + + + + + Gets the rotation of the transform in world space. + + The AnimationStream that hold the animated values. + + The rotation of the transform in world space. + + + + + Returns whether this handle is resolved. + + The AnimationStream that hold the animated values. + + Returns true if the handle is resolved, false otherwise. + + + + + Returns whether this is a valid handle. + + The AnimationStream that hold the animated values. + + Whether this is a valid handle. + + + + + Bind this handle with an animated values from the AnimationStream. + + The AnimationStream that hold the animated values. + + + + Sets the position of the transform relative to the parent. + + The AnimationStream that hold the animated values. + The position of the transform relative to the parent. + + + + Sets the rotation of the transform relative to the parent. + + The AnimationStream that hold the animated values. + The rotation of the transform relative to the parent. + + + + Sets the scale of the transform relative to the parent. + + The scale of the transform relative to the parent. + The AnimationStream that hold the animated values. + + + + Sets the position of the transform in world space. + + The position of the transform in world space. + The AnimationStream that hold the animated values. + + + + Sets the rotation of the transform in world space. + + The AnimationStream that hold the animated values. + The rotation of the transform in world space. + + + + Provides access to the audio samples generated by Unity objects such as VideoPlayer. + + + + + Number of sample frames available for consuming with Experimental.Audio.AudioSampleProvider.ConsumeSampleFrames. + + + + + The number of audio channels per sample frame. + + + + + Pointer to the native function that provides access to audio sample frames. + + + + + Enables the Experimental.Audio.AudioSampleProvider.sampleFramesAvailable events. + + + + + If true, buffers produced by ConsumeSampleFrames will get padded when silence if there are less available than asked for. Otherwise, the extra sample frames in the buffer will be left unchanged. + + + + + Number of sample frames that can still be written to by the sample producer before overflowing. + + + + + Then the free sample count falls below this threshold, the Experimental.Audio.AudioSampleProvider.sampleFramesAvailable event and associated native is emitted. + + + + + Unique identifier for this instance. + + + + + The maximum number of sample frames that can be accumulated inside the internal buffer before an overflow event is emitted. + + + + + Object where this provider came from. + + + + + Invoked when the number of available sample frames goes beyond the threshold set with Experimental.Audio.AudioSampleProvider.freeSampleFrameCountLowThreshold. + + Number of available sample frames. + + + + Invoked when the number of available sample frames goes beyond the maximum that fits in the internal buffer. + + The number of sample frames that were dropped due to the overflow. + + + + The expected playback rate for the sample frames produced by this class. + + + + + Index of the track in the object that created this provider. + + + + + True if the object is valid. + + + + + Clear the native handler set with Experimental.Audio.AudioSampleProvider.SetSampleFramesAvailableNativeHandler. + + + + + Clear the native handler set with Experimental.Audio.AudioSampleProvider.SetSampleFramesOverflowNativeHandler. + + + + + Consume sample frames from the internal buffer. + + Buffer where the consumed samples will be transferred. + + How many sample frames were written into the buffer passed in. + + + + + Type that represents the native function pointer for consuming sample frames. + + Id of the provider. See Experimental.Audio.AudioSampleProvider.id. + Pointer to the sample frames buffer to fill. The actual C type is float*. + Number of sample frames that can be written into interleavedSampleFrames. + + + + Release internal resources. Inherited from IDisposable. + + + + + Type that represents the native function pointer for handling sample frame events. + + User data specified when the handler was set. The actual C type is void*. + Id of the provider. See Experimental.Audio.AudioSampleProvider.id. + Number of sample frames available or overflowed, depending on event type. + + + + Delegate for sample frame events. + + Provider emitting the event. + How many sample frames are available, or were dropped, depending on the event. + + + + Set the native event handler for events emitted when the number of available sample frames crosses the threshold. + + Pointer to the function to invoke when the event is emitted. + User data to be passed to the handler when invoked. The actual C type is void*. + + + + Set the native event handler for events emitted when the internal sample frame buffer overflows. + + Pointer to the function to invoke when the event is emitted. + User data to be passed to the handler when invoked. The actual C type is void*. + + + + A helper structure used to initialize a LightDataGI structure as a directional light. + + + + + The direct light color. + + + + + The direction of the light. + + + + + The indirect light color. + + + + + The light's instanceID. + + + + + The lightmode. + + + + + The penumbra width for soft shadows in radians. + + + + + True if the light casts shadows, otherwise False. + + + + + A helper structure used to initialize a LightDataGI structure as a disc light. + + + + + The direct light color. + + + + + The indirect light color. + + + + + The light's instanceID. + + + + + The lightmode. + + + + + The light's orientation. + + + + + The light's position. + + + + + The radius of the disc light. + + + + + The light's range. + + + + + True if the light casts shadows, otherwise False. + + + + + Available falloff models for baking. + + + + + Inverse squared distance falloff model. + + + + + Inverse squared distance falloff model (without smooth range attenuation). + + + + + Quadratic falloff model. + + + + + Linear falloff model. + + + + + Falloff model is undefined. + + + + + The interop structure to pass light information to the light baking backends. There are helper structures for Directional, Point, Spot and Rectangle lights to correctly initialize this structure. + + + + + The color of the light. + + + + + The cone angle for spot lights. + + + + + The falloff model to use for baking point and spot lights. + + + + + The indirect color of the light. + + + + + The inner cone angle for spot lights. + + + + + The light's instanceID. + + + + + The lightmap mode for the light. + + + + + The orientation of the light. + + + + + The position of the light. + + + + + The range of the light. Unused for directional lights. + + + + + Set to 1 for shadow casting lights, 0 otherwise. + + + + + The light's sphere radius for point and spot lights, or the width for rectangle lights. + + + + + The height for rectangle lights. + + + + + The type of the light. + + + + + Initialize the struct with the parameters from the given light type. + + + + + + Initialize the struct with the parameters from the given light type. + + + + + + Initialize the struct with the parameters from the given light type. + + + + + + Initialize the struct with the parameters from the given light type. + + + + + + Initialize a light so that the baking backends ignore it. + + + + + + Utility class for converting Unity Lights to light types recognized by the baking backends. + + + + + Extracts informations from Lights. + + The lights baketype. + + Returns the light's light mode. + + + + + Extract type specific information from Lights. + + The input light. + Extracts directional light information. + Extracts point light information. + Extracts spot light information. + Extracts rectangle light information. + + + + Extract type specific information from Lights. + + The input light. + Extracts directional light information. + Extracts point light information. + Extracts spot light information. + Extracts rectangle light information. + + + + Extract type specific information from Lights. + + The input light. + Extracts directional light information. + Extracts point light information. + Extracts spot light information. + Extracts rectangle light information. + + + + Extract type specific information from Lights. + + The input light. + Extracts directional light information. + Extracts point light information. + Extracts spot light information. + Extracts rectangle light information. + + + + Extracts the indirect color from a light. + + + + + + Extracts the inner cone angle of spot lights. + + + + + + Interface to the light baking backends. + + + + + Get the currently set conversion delegate. + + + Returns the currently set conversion delegate. + + + + + Delegate called when converting lights into a form that the baking backends understand. + + The list of lights to be converted. + The output generated by the delegate function. Lights that should be skipped must be added to the output, initialized with InitNoBake on the LightDataGI structure. + + + + Resets the light conversion delegate to Unity's default conversion function. + + + + + Set a delegate that converts a list of lights to a list of LightDataGI structures that are passed to the baking backends. Must be reset by calling ResetDelegate again. + + + + + + The lightmode. A light can be realtime, mixed, baked or unknown. Unknown lights will be ignored by the baking backends. + + + + + The light is fully baked and has no realtime component. + + + + + The light is mixed. Mixed lights are interpreted based on the global light mode setting in the lighting window. + + + + + The light is realtime. No contribution will be baked in lightmaps or light probes. + + + + + The light should be ignored by the baking backends. + + + + + The light type. + + + + + An infinite directional light. + + + + + A light shaped like a disc emitting light into the hemisphere that it is facing. + + + + + A point light emitting light in all directions. + + + + + A light shaped like a rectangle emitting light into the hemisphere that it is facing. + + + + + A spot light emitting light in a direction with a cone shaped opening angle. + + + + + Contains normalized linear color values for red, green, blue in the range of 0 to 1, and an additional intensity value. + + + + + The blue color value in the range of 0.0 to 1.0. + + + + + The green color value in the range of 0.0 to 1.0. + + + + + The intensity value used to scale the red, green and blue values. + + + + + The red color value in the range of 0.0 to 1.0. + + + + + Returns a black color. + + + Returns a black color. + + + + + Converts a Light's color value to a normalized linear color value, automatically handling gamma conversion if necessary. + + Light color. + Light intensity. + + Returns the normalized linear color value. + + + + + A helper structure used to initialize a LightDataGI structure as a point light. + + + + + The direct light color. + + + + + The falloff model to use for baking the point light. + + + + + The indirect light color. + + + + + The light's instanceID. + + + + + The lightmode. + + + + + The light's position. + + + + + The light's range. + + + + + True if the light casts shadows, otherwise False. + + + + + The light's sphere radius, influencing soft shadows. + + + + + A helper structure used to initialize a LightDataGI structure as a rectangle light. + + + + + The direct light color. + + + + + The height of the rectangle light. + + + + + The indirect light color. + + + + + The light's instanceID. + + + + + The lightmode. + + + + + The light's orientation. + + + + + The light's position. + + + + + The light's range. + + + + + True if the light casts shadows, otherwise False. + + + + + The width of the rectangle light. + + + + + A helper structure used to initialize a LightDataGI structure as a spot light. + + + + + The direct light color. + + + + + The outer angle for the spot light. + + + + + The falloff model to use for baking the spot light. + + + + + The indirect light color. + + + + + The inner angle for the spot light. + + + + + The light's instanceID. + + + + + The lightmode. + + + + + The light's orientation. + + + + + The light's position. + + + + + The light's range. + + + + + True if the light casts shadows, otherwise False. + + + + + The light's sphere radius, influencing soft shadows. + + + + + An IntegratedSubsystem is initialized from an IntegratedSubsystemDescriptor for a given Subsystem (Example, Input, Environment, Display, etc.) and provides an interface to interact with that given IntegratedSubsystem until it is Destroyed. After an IntegratedSubsystem is created it can be Started or Stopped to turn on and off functionality (and preserve performance). The base type for IntegratedSubsystem only exposes this functionality; this class is designed to be a base class for derived classes that expose more functionality specific to a given IntegratedSubsystem. + + Note: initializing a second IntegratedSubsystem from the same IntegratedSubsystemDescriptor will return a reference to the existing IntegratedSubsystem as only one IntegratedSubsystem is currently allowed for a single IntegratedSubsystem provider. + + + + + + Destroys this instance of a subsystem. + + + + + Starts an instance of a subsystem. + + + + + Stops an instance of a subsystem. + + + + + Information about a subsystem that can be queried before creating a subsystem instance. + + + + + A unique string that identifies the subsystem that this Descriptor can create. + + + + + Interface implemented by both Subsystem and IntegratedSubsystem which provides control over the state of either. + + + + + + Destroys this instance of a subsystem. + + + + + Starts an instance of a subsystem. + + + + + Stops an instance of a subsystem. + + + + + A subsystem descriptor is metadata about a subsystem which can be inspected before loading / initializing a subsystem. + + + + + + The class representing the player loop in Unity. + + + + + Returns the default update order of all engine systems in Unity. + + + + + Set a new custom update order of all engine systems in Unity. + + + + + The representation of a single system being updated by the player loop in Unity. + + + + + The loop condition for a native engine system. To get a valid value for this, you must copy it from one of the PlayerLoopSystems returned by PlayerLoop.GetDefaultPlayerLoop. + + + + + A list of sub systems which run as part of this item in the player loop. + + + + + This property is used to identify which native system this belongs to, or to get the name of the managed system to show in the profiler. + + + + + A managed delegate. You can set this to create a new C# entrypoint in the player loop. + + + + + A native engine system. To get a valid value for this, you must copy it from one of the PlayerLoopSystems returned by PlayerLoop.GetDefaultPlayerLoop. + + + + + The type of the connected target. + + + + + The connected target is an Editor. + + + + + No target is connected, this is only possible in a Player. + + + + + The connected target is a Player. + + + + + The state of an Editor-to-Player or Editor-to-Editor connection to be used in Experimental.Networking.PlayerConnection.EditorGUI.AttachToPlayerDropdown or Experimental.Networking.PlayerConnection.EditorGUILayout.AttachToPlayerDropdown. + + + + + Supplies the type of the established connection, as in whether the target is a Player or an Editor. + + + + + The name of the connected target. + + + + + An implementation of IPlayable that produces a Camera texture. + + + + + Creates a CameraPlayable in the PlayableGraph. + + The PlayableGraph object that will own the CameraPlayable. + Camera used to produce a texture in the PlayableGraph. + + A CameraPlayable linked to the PlayableGraph. + + + + + An implementation of IPlayable that allows application of a Material shader to one or many texture inputs to produce a texture output. + + + + + Creates a MaterialEffectPlayable in the PlayableGraph. + + The PlayableGraph object that will own the MaterialEffectPlayable. + Material used to modify linked texture playable inputs. + Shader pass index.(Note: -1 for all passes). + + A MaterialEffectPlayable linked to the PlayableGraph. + + + + + An implementation of IPlayable that allows mixing two textures. + + + + + Creates a TextureMixerPlayable in the PlayableGraph. + + The PlayableGraph object that will own the TextureMixerPlayable. + + A TextureMixerPlayable linked to the PlayableGraph. + + + + + A PlayableBinding that contains information representing a TexturePlayableOutput. + + + + + Creates a PlayableBinding that contains information representing a TexturePlayableOutput. + + A reference to a UnityEngine.Object that acts as a key for this binding. + The name of the TexturePlayableOutput. + + Returns a PlayableBinding that contains information that is used to create a TexturePlayableOutput. + + + + + An IPlayableOutput implementation that will be used to manipulate textures. + + + + + Returns an invalid TexturePlayableOutput. + + + + + Update phase in the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Update phase in the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Update phase in the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Update phase in the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Update phase in the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Update phase in the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Update phase in the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Native engine system updated by the native player loop. + + + + + Values for the blend state. + + + + + Turns on alpha-to-coverage. + + + + + Blend state for render target 0. + + + + + Blend state for render target 1. + + + + + Blend state for render target 2. + + + + + Blend state for render target 3. + + + + + Blend state for render target 4. + + + + + Blend state for render target 5. + + + + + Blend state for render target 6. + + + + + Blend state for render target 7. + + + + + Determines whether each render target uses a separate blend state. + + + + + Creates a new blend state with the specified values. + + Determines whether each render target uses a separate blend state. + Turns on alpha-to-coverage. + + + + Default values for the blend state. + + + + + Camera related properties in CullingParameters. + + + + + Get a camera culling plane. + + Plane index (up to 5). + + Camera culling plane. + + + + + Get a shadow culling plane. + + Plane index (up to 5). + + Shadow culling plane. + + + + + Set a camera culling plane. + + Plane index (up to 5). + Camera culling plane. + + + + Set a shadow culling plane. + + Plane index (up to 5). + Shadow culling plane. + + + + Core Camera related properties in CullingParameters. + + + + + Culling results (visible objects, lights, reflection probes). + + + + + Array of visible lights. + + + + + Off screen lights that still effect visible Scene vertices. + + + + + Array of visible reflection probes. + + + + + Visible renderers. + + + + + Calculates the view and projection matrices and shadow split data for a directional light. + + The index into the active light array. + The cascade index. + The number of cascades. + The cascade ratios. + The resolution of the shadowmap. + The near plane offset for the light. + The computed view matrix. + The computed projection matrix. + The computed cascade data. + + If false, the shadow map for this cascade does not need to be rendered this frame. + + + + + Calculates the view and projection matrices and shadow split data for a point light. + + The index into the active light array. + The cubemap face to be rendered. + The amount by which to increase the camera FOV above 90 degrees. + The computed view matrix. + The computed projection matrix. + The computed split data. + + If false, the shadow map for this light and cubemap face does not need to be rendered this frame. + + + + + Calculates the view and projection matrices and shadow split data for a spot light. + + The index into the active light array. + The computed view matrix. + The computed projection matrix. + The computed split data. + + If false, the shadow map for this light does not need to be rendered this frame. + + + + + Perform culling for a Camera. + + Camera to cull for. + Render loop the culling results will be used with. + Culling results. + + Flag indicating whether culling succeeded. + + + + + Perform culling with custom CullingParameters. + + Parameters for culling. + Render loop the culling results will be used with. + + Culling results. + + + + + Fills a compute buffer with per-object light indices. + + The compute buffer object to fill. + + + + Get culling parameters for a camera. + + Camera to get parameters for. + Resultant culling parameters. + Generate single-pass stereo aware culling parameters. + + Flag indicating whether culling parameters are valid. + + + + + Get culling parameters for a camera. + + Camera to get parameters for. + Resultant culling parameters. + Generate single-pass stereo aware culling parameters. + + Flag indicating whether culling parameters are valid. + + + + + If a RenderPipeline sorts or otherwise modifies the VisibleLight list, an index remap will be necessary to properly make use of per-object light lists. + + + Array of indices that map from VisibleLight indices to internal per-object light list indices. + + + + + Gets the number of per-object light indices. + + + The number of per-object light indices. + + + + + Returns the bounding box that encapsulates the visible shadow casters. Can be used to, for instance, dynamically adjust cascade ranges. + + The index of the shadow-casting light. + The bounds to be computed. + + True if the light affects at least one shadow casting object in the Scene. + + + + + If a RenderPipeline sorts or otherwise modifies the VisibleLight list, an index remap will be necessary to properly make use of per-object light lists. +If an element of the array is set to -1, the light corresponding to that element will be disabled. + + Array with light indices that map from VisibleLight to internal per-object light lists. + + + + Values for the depth state. + + + + + How should depth testing be performed. + + + + + Controls whether pixels from this object are written to the depth buffer. + + + + + Creates a new depth state with the given values. + + Controls whether pixels from this object are written to the depth buffer. + How should depth testing be performed. + + + + Default values for the depth state. + + + + + Flags controlling RenderLoop.DrawRenderers. + + + + + When set, enables dynamic batching. + + + + + When set, enables GPU instancing. + + + + + No flags are set. + + + + + Settings for ScriptableRenderContext.DrawRenderers. + + + + + Other flags controlling object rendering. + + + + + The maxiumum number of passes that can be rendered in 1 DrawRenderers call. + + + + + What kind of per-object data to setup during rendering. + + + + + How to sort objects during rendering. + + + + + Create a draw settings struct. + + Camera to use. Camera's transparency sort mode is used to determine whether to use orthographic or distance based sorting. + Shader pass to use. + + + + Set the Material to use for all drawers that would render in this group. + + Override material. + Pass to use in the material. + + + + Set the shader passes that this draw call can render. + + Index of the shader pass to use. + Name of the shader pass. + + + + Type of sorting to use while rendering. + + + + + Sort objects based on distance along a custom axis. + + + + + Orthographic sorting mode. + + + + + Perspective sorting mode. + + + + + This struct describes the methods to sort objects during rendering. + + + + + Used to calculate distance to objects, by comparing the positions of objects to this axis. + + + + + Used to calculate the distance to objects. + + + + + What kind of sorting to do while rendering. + + + + + Type of sorting to use while rendering. + + + + + Should orthographic sorting be used? + + + + + Used to calculate the distance to objects. + + + + + Settings for ScriptableRenderContext.DrawShadows. + + + + + Culling results to use. + + + + + The index of the shadow-casting light to be rendered. + + + + + The split data. + + + + + Create a shadow settings object. + + The cull results for this light. + The light index. + + + + Filter settings for ScriptableRenderContext.DrawRenderers. + + + + + Set to true to exclude objects that are currently in motion from rendering. The default value is false. + + + + + Only render objects in the given layer mask. + + + + + The rendering layer mask to use when filtering available renderers for drawing. + + + + + Render objects whose material render queue in inside this range. + + + + + + + Specifies whether the values of the struct should be initialized. + + + + Describes a subset of objects to be rendered. + +See Also: ScriptableRenderContext.DrawRenderers. + + + + + Use this format usages to figure out the capabilities of specific GraphicsFormat + + + + + To blend on a rendertexture. + + + + + To sample textures with a linear filter + + + + + To perform resource load and store on a texture + + + + + To create and render to a MSAA 2X rendertexture. + + + + + To create and render to a MSAA 4X rendertexture. + + + + + To create and render to a MSAA 8X rendertexture. + + + + + To create and render to a rendertexture. + + + + + To create and sample textures. + + + + + Use this format to create either Textures or RenderTextures from scripts. + + + + + A four-component, 64-bit packed unsigned normalized format that has a 10-bit A component in bits 30..39, a 10-bit R component in bits 20..29, a 10-bit G component in bits 10..19, and a 10-bit B component in bits 0..9. The components are gamma encoded and their values range from -0.5271 to 1.66894. The alpha component is clamped to either 0.0 or 1.0 on sampling, rendering, and writing operations. + + + + + A four-component, 64-bit packed unsigned normalized format that has a 10-bit A component in bits 30..39, a 10-bit R component in bits 20..29, a 10-bit G component in bits 10..19, and a 10-bit B component in bits 0..9. The components are linearly encoded and their values range from -0.752941 to 1.25098 (pre-expansion). The alpha component is clamped to either 0.0 or 1.0 on sampling, rendering, and writing operations. + + + + + A four-component, 16-bit packed unsigned normalized format that has a 1-bit A component in bit 15, a 5-bit R component in bits 10..14, a 5-bit G component in bits 5..9, and a 5-bit B component in bits 0..4. + + + + + A four-component, 32-bit packed signed integer format that has a 2-bit A component in bits 30..31, a 10-bit B component in bits 20..29, a 10-bit G component in bits 10..19, and a 10-bit R component in bits 0..9. + + + + + A four-component, 32-bit packed unsigned integer format that has a 2-bit A component in bits 30..31, a 10-bit B component in bits 20..29, a 10-bit G component in bits 10..19, and a 10-bit R component in bits 0..9. + + + + + A four-component, 32-bit packed unsigned normalized format that has a 2-bit A component in bits 30..31, a 10-bit B component in bits 20..29, a 10-bit G component in bits 10..19, and a 10-bit R component in bits 0..9. + + + + + A four-component, 32-bit packed signed integer format that has a 2-bit A component in bits 30..31, a 10-bit R component in bits 20..29, a 10-bit G component in bits 10..19, and a 10-bit B component in bits 0..9. + + + + + A four-component, 32-bit packed unsigned integer format that has a 2-bit A component in bits 30..31, a 10-bit R component in bits 20..29, a 10-bit G component in bits 10..19, and a 10-bit B component in bits 0..9. + + + + + A four-component, 32-bit packed unsigned normalized format that has a 2-bit A component in bits 30..31, a 10-bit R component in bits 20..29, a 10-bit G component in bits 10..19, and a 10-bit B component in bits 0..9. + + + + + A four-component, 32-bit packed unsigned normalized format that has a 2-bit A component in bits 30..31, a 10-bit R component in bits 20..29, a 10-bit G component in bits 10..19, and a 10-bit B component in bits 0..9. The components are gamma encoded and their values range from -0.5271 to 1.66894. The alpha component is clamped to either 0.0 or 1.0 on sampling, rendering, and writing operations. + + + + + A four-component, 32-bit packed unsigned normalized format that has a 2-bit A component in bits 30..31, a 10-bit R component in bits 20..29, a 10-bit G component in bits 10..19, and a 10-bit B component in bits 0..9. The components are linearly encoded and their values range from -0.752941 to 1.25098 (pre-expansion). The alpha component is clamped to either 0.0 or 1.0 on sampling, rendering, and writing operations. + + + + + A three-component, 32-bit packed unsigned floating-point format that has a 10-bit B component in bits 22..31, an 11-bit G component in bits 11..21, an 11-bit R component in bits 0..10. + + + + + A four-component, 16-bit packed unsigned normalized format that has a 4-bit B component in bits 12..15, a 4-bit G component in bits 8..11, a 4-bit R component in bits 4..7, and a 4-bit A component in bits 0..3. + + + + + A four-component, 16-bit packed unsigned normalized format that has a 5-bit B component in bits 11..15, a 5-bit G component in bits 6..10, a 5-bit R component in bits 1..5, and a 1-bit A component in bit 0. + + + + + A three-component, 16-bit packed unsigned normalized format that has a 5-bit B component in bits 11..15, a 6-bit G component in bits 5..10, and a 5-bit R component in bits 0..4. + + + + + A three-component, 24-bit signed integer format that has an 8-bit B component in byte 0, an 8-bit G component in byte 1, and an 8-bit R component in byte 2. + + + + + A three-component, 24-bit signed normalized format that has an 8-bit B component in byte 0, an 8-bit G component in byte 1, and an 8-bit R component in byte 2. + + + + + A three-component, 24-bit unsigned normalized format that has an 8-bit R component stored with sRGB nonlinear encoding in byte 0, an 8-bit G component stored with sRGB nonlinear encoding in byte 1, and an 8-bit B component stored with sRGB nonlinear encoding in byte 2. + + + + + A three-component, 24-bit unsigned integer format that has an 8-bit B component in byte 0, an 8-bit G component in byte 1, and an 8-bit R component in byte 2 + + + + + A three-component, 24-bit unsigned normalized format that has an 8-bit B component in byte 0, an 8-bit G component in byte 1, and an 8-bit R component in byte 2. + + + + + A four-component, 32-bit signed integer format that has an 8-bit B component in byte 0, an 8-bit G component in byte 1, an 8-bit R component in byte 2, and an 8-bit A component in byte 3. + + + + + A four-component, 32-bit signed normalized format that has an 8-bit B component in byte 0, an 8-bit G component in byte 1, an 8-bit R component in byte 2, and an 8-bit A component in byte 3. + + + + + A four-component, 32-bit unsigned normalized format that has an 8-bit B component stored with sRGB nonlinear encoding in byte 0, an 8-bit G component stored with sRGB nonlinear encoding in byte 1, an 8-bit R component stored with sRGB nonlinear encoding in byte 2, and an 8-bit A component in byte 3. + + + + + A four-component, 32-bit unsigned integer format that has an 8-bit B component in byte 0, an 8-bit G component in byte 1, an 8-bit R component in byte 2, and an 8-bit A component in byte 3. + + + + + A four-component, 32-bit unsigned normalized format that has an 8-bit B component in byte 0, an 8-bit G component in byte 1, an 8-bit R component in byte 2, and an 8-bit A component in byte 3. + + + + + A one-component, 16-bit unsigned normalized format that has a single 16-bit depth component. + + + + + A two-component, 32-bit format that has 24 unsigned normalized bits in the depth component and, optionally: 8 bits that are unused. + + + + + A two-component, 32-bit packed format that has 8 unsigned integer bits in the stencil component, and 24 unsigned normalized bits in the depth component. + + + + + A one-component, 32-bit signed floating-point format that has 32-bits in the depth component. + + + + + A two-component format that has 32 signed float bits in the depth component and 8 unsigned integer bits in the stencil component. There are optionally: 24-bits that are unused. + + + + + A three-component, 32-bit packed unsigned floating-point format that has a 5-bit shared exponent in bits 27..31, a 9-bit B component mantissa in bits 18..26, a 9-bit G component mantissa in bits 9..17, and a 9-bit R component mantissa in bits 0..8. + + + + + The format is not specified. + + + + + A one-component, block-compressed format where each 64-bit compressed texel block encodes a 4×4 rectangle of signed normalized red texel data. + + + + + A one-component, block-compressed format where each 64-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized red texel data. + + + + + A one-component, ETC2 compressed format where each 64-bit compressed texel block encodes a 4×4 rectangle of signed normalized red texel data. + + + + + A one-component, ETC2 compressed format where each 64-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized red texel data. + + + + + A four-component, 32-bit packed unsigned normalized format that has a 10-bit R component in bits 20..29, a 10-bit G component in bits 10..19, and a 10-bit B component in bits 0..9. The components are gamma encoded and their values range from -0.5271 to 1.66894. The alpha component is clamped to either 0.0 or 1.0 on sampling, rendering, and writing operations. + + + + + A four-component, 32-bit packed unsigned normalized format that has a 10-bit R component in bits 20..29, a 10-bit G component in bits 10..19, and a 10-bit B component in bits 0..9. The components are linearly encoded and their values range from -0.752941 to 1.25098 (pre-expansion). + + + + + A one-component, 16-bit signed floating-point format that has a single 16-bit R component. + + + + + A one-component, 16-bit signed integer format that has a single 16-bit R component. + + + + + A one-component, 16-bit signed normalized format that has a single 16-bit R component. + + + + + A one-component, 16-bit unsigned integer format that has a single 16-bit R component. + + + + + A one-component, 16-bit unsigned normalized format that has a single 16-bit R component. + + + + + A two-component, 32-bit signed floating-point format that has a 16-bit R component in bytes 0..1, and a 16-bit G component in bytes 2..3. + + + + + A two-component, 32-bit signed integer format that has a 16-bit R component in bytes 0..1, and a 16-bit G component in bytes 2..3. + + + + + A two-component, 32-bit signed normalized format that has a 16-bit R component in bytes 0..1, and a 16-bit G component in bytes 2..3. + + + + + A two-component, 32-bit unsigned integer format that has a 16-bit R component in bytes 0..1, and a 16-bit G component in bytes 2..3. + + + + + A two-component, 32-bit unsigned normalized format that has a 16-bit R component in bytes 0..1, and a 16-bit G component in bytes 2..3. + + + + + A three-component, 48-bit signed floating-point format that has a 16-bit R component in bytes 0..1, a 16-bit G component in bytes 2..3, and a 16-bit B component in bytes 4..5. + + + + + A three-component, 48-bit signed integer format that has a 16-bit R component in bytes 0..1, a 16-bit G component in bytes 2..3, and a 16-bit B component in bytes 4..5. + + + + + A three-component, 48-bit signed normalized format that has a 16-bit R component in bytes 0..1, a 16-bit G component in bytes 2..3, and a 16-bit B component in bytes 4..5. + + + + + A three-component, 48-bit unsigned integer format that has a 16-bit R component in bytes 0..1, a 16-bit G component in bytes 2..3, and a 16-bit B component in bytes 4..5. + + + + + A three-component, 48-bit unsigned normalized format that has a 16-bit R component in bytes 0..1, a 16-bit G component in bytes 2..3, and a 16-bit B component in bytes 4..5. + + + + + A four-component, 64-bit signed floating-point format that has a 16-bit R component in bytes 0..1, a 16-bit G component in bytes 2..3, a 16-bit B component in bytes 4..5, and a 16-bit A component in bytes 6..7. + + + + + A four-component, 64-bit signed integer format that has a 16-bit R component in bytes 0..1, a 16-bit G component in bytes 2..3, a 16-bit B component in bytes 4..5, and a 16-bit A component in bytes 6..7. + + + + + A four-component, 64-bit signed normalized format that has a 16-bit R component in bytes 0..1, a 16-bit G component in bytes 2..3, a 16-bit B component in bytes 4..5, and a 16-bit A component in bytes 6..7. + + + + + A four-component, 64-bit unsigned integer format that has a 16-bit R component in bytes 0..1, a 16-bit G component in bytes 2..3, a 16-bit B component in bytes 4..5, and a 16-bit A component in bytes 6..7. + + + + + A four-component, 64-bit unsigned normalized format that has a 16-bit R component in bytes 0..1, a 16-bit G component in bytes 2..3, a 16-bit B component in bytes 4..5, and a 16-bit A component in bytes 6..7. + + + + + A one-component, 32-bit signed floating-point format that has a single 32-bit R component. + + + + + A one-component, 32-bit signed integer format that has a single 32-bit R component. + + + + + A one-component, 32-bit unsigned integer format that has a single 32-bit R component. + + + + + A two-component, 64-bit signed floating-point format that has a 32-bit R component in bytes 0..3, and a 32-bit G component in bytes 4..7. + + + + + A two-component, 64-bit signed integer format that has a 32-bit R component in bytes 0..3, and a 32-bit G component in bytes 4..7. + + + + + A two-component, 64-bit unsigned integer format that has a 32-bit R component in bytes 0..3, and a 32-bit G component in bytes 4..7. + + + + + A three-component, 96-bit signed floating-point format that has a 32-bit R component in bytes 0..3, a 32-bit G component in bytes 4..7, and a 32-bit B component in bytes 8..11. + + + + + A three-component, 96-bit signed integer format that has a 32-bit R component in bytes 0..3, a 32-bit G component in bytes 4..7, and a 32-bit B component in bytes 8..11. + + + + + A three-component, 96-bit unsigned integer format that has a 32-bit R component in bytes 0..3, a 32-bit G component in bytes 4..7, and a 32-bit B component in bytes 8..11. + + + + + A four-component, 128-bit signed floating-point format that has a 32-bit R component in bytes 0..3, a 32-bit G component in bytes 4..7, a 32-bit B component in bytes 8..11, and a 32-bit A component in bytes 12..15. + + + + + A four-component, 128-bit signed integer format that has a 32-bit R component in bytes 0..3, a 32-bit G component in bytes 4..7, a 32-bit B component in bytes 8..11, and a 32-bit A component in bytes 12..15. + + + + + A four-component, 128-bit unsigned integer format that has a 32-bit R component in bytes 0..3, a 32-bit G component in bytes 4..7, a 32-bit B component in bytes 8..11, and a 32-bit A component in bytes 12..15. + + + + + A four-component, 16-bit packed unsigned normalized format that has a 4-bit R component in bits 12..15, a 4-bit G component in bits 8..11, a 4-bit B component in bits 4..7, and a 4-bit A component in bits 0..3. + + + + + A four-component, 16-bit packed unsigned normalized format that has a 5-bit R component in bits 11..15, a 5-bit G component in bits 6..10, a 5-bit B component in bits 1..5, and a 1-bit A component in bit 0. + + + + + A three-component, 16-bit packed unsigned normalized format that has a 5-bit R component in bits 11..15, a 6-bit G component in bits 5..10, and a 5-bit B component in bits 0..4. + + + + + A one-component, 8-bit signed integer format that has a single 8-bit R component. + + + + + A one-component, 8-bit signed normalized format that has a single 8-bit R component. + + + + + A one-component, 8-bit unsigned normalized format that has a single 8-bit R component stored with sRGB nonlinear encoding. + + + + + A one-component, 8-bit unsigned integer format that has a single 8-bit R component. + + + + + A one-component, 8-bit unsigned normalized format that has a single 8-bit R component. + + + + + A two-component, 16-bit signed integer format that has an 8-bit R component in byte 0, and an 8-bit G component in byte 1. + + + + + A two-component, 16-bit signed normalized format that has an 8-bit R component stored with sRGB nonlinear encoding in byte 0, and an 8-bit G component stored with sRGB nonlinear encoding in byte 1. + + + + + A two-component, 16-bit unsigned normalized format that has an 8-bit R component stored with sRGB nonlinear encoding in byte 0, and an 8-bit G component stored with sRGB nonlinear encoding in byte 1. + + + + + A two-component, 16-bit unsigned integer format that has an 8-bit R component in byte 0, and an 8-bit G component in byte 1. + + + + + A two-component, 16-bit unsigned normalized format that has an 8-bit R component stored with sRGB nonlinear encoding in byte 0, and an 8-bit G component stored with sRGB nonlinear encoding in byte 1. + + + + + A three-component, 24-bit signed integer format that has an 8-bit R component in byte 0, an 8-bit G component in byte 1, and an 8-bit B component in byte 2. + + + + + A three-component, 24-bit signed normalized format that has an 8-bit R component in byte 0, an 8-bit G component in byte 1, and an 8-bit B component in byte 2. + + + + + A three-component, 24-bit unsigned normalized format that has an 8-bit R component stored with sRGB nonlinear encoding in byte 0, an 8-bit G component stored with sRGB nonlinear encoding in byte 1, and an 8-bit B component stored with sRGB nonlinear encoding in byte 2. + + + + + A three-component, 24-bit unsigned integer format that has an 8-bit R component in byte 0, an 8-bit G component in byte 1, and an 8-bit B component in byte 2. + + + + + A three-component, 24-bit unsigned normalized format that has an 8-bit R component in byte 0, an 8-bit G component in byte 1, and an 8-bit B component in byte 2. + + + + + A four-component, 32-bit signed integer format that has an 8-bit R component in byte 0, an 8-bit G component in byte 1, an 8-bit B component in byte 2, and an 8-bit A component in byte 3. + + + + + A four-component, 32-bit signed normalized format that has an 8-bit R component in byte 0, an 8-bit G component in byte 1, an 8-bit B component in byte 2, and an 8-bit A component in byte 3. + + + + + A four-component, 32-bit unsigned normalized format that has an 8-bit R component stored with sRGB nonlinear encoding in byte 0, an 8-bit G component stored with sRGB nonlinear encoding in byte 1, an 8-bit B component stored with sRGB nonlinear encoding in byte 2, and an 8-bit A component in byte 3. + + + + + A four-component, 32-bit unsigned integer format that has an 8-bit R component in byte 0, an 8-bit G component in byte 1, an 8-bit B component in byte 2, and an 8-bit A component in byte 3. + + + + + A four-component, 32-bit unsigned normalized format that has an 8-bit R component in byte 0, an 8-bit G component in byte 1, an 8-bit B component in byte 2, and an 8-bit A component in byte 3. + + + + + A two-component, block-compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of signed normalized RG texel data with the first 64 bits encoding red values followed by 64 bits encoding green values. + + + + + A two-component, block-compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RG texel data with the first 64 bits encoding red values followed by 64 bits encoding green values. + + + + + A two-component, ETC2 compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of signed normalized RG texel data with the first 64 bits encoding red values followed by 64 bits encoding green values. + + + + + A two-component, ETC2 compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RG texel data with the first 64 bits encoding red values followed by 64 bits encoding green values. + + + + + A four-component, ETC2 compressed format where each 64-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGB texel data with sRGB nonlinear encoding, and provides 1 bit of alpha. + + + + + A four-component, ETC2 compressed format where each 64-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGB texel data, and provides 1 bit of alpha. + + + + + A three-component, block-compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of signed floating-point RGB texel data. + + + + + A three-component, block-compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of unsigned floating-point RGB texel data. + + + + + A three-component, ETC compressed format where each 64-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGB texel data. This format has no alpha and is considered opaque. + + + + + A three-component, ETC2 compressed format where each 64-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGB texel data with sRGB nonlinear encoding. This format has no alpha and is considered opaque. + + + + + A three-component, ETC2 compressed format where each 64-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGB texel data. This format has no alpha and is considered opaque. + + + + + A three-component, PVRTC compressed format where each 64-bit compressed texel block encodes a 8×4 rectangle of unsigned normalized RGB texel data with sRGB nonlinear encoding. This format has no alpha and is considered opaque. + + + + + A three-component, PVRTC compressed format where each 64-bit compressed texel block encodes a 8×4 rectangle of unsigned normalized RGB texel data. This format has no alpha and is considered opaque. + + + + + A three-component, PVRTC compressed format where each 64-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGB texel data with sRGB nonlinear encoding. This format has no alpha and is considered opaque. + + + + + A three-component, PVRTC compressed format where each 64-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGB texel data. This format has no alpha and is considered opaque. + + + + + A four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 10×10 rectangle of unsigned normalized RGBA texel data with sRGB nonlinear encoding applied to the RGB components. + + + + + A four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 10×10 rectangle of unsigned normalized RGBA texel data. + + + + + A four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 12×12 rectangle of unsigned normalized RGBA texel data with sRGB nonlinear encoding applied to the RGB components. + + + + + A four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 12×12 rectangle of unsigned normalized RGBA texel data. + + + + + A four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGBA texel data with sRGB nonlinear encoding applied to the RGB components. + + + + + A four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGBA texel data. + + + + + A four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 5×5 rectangle of unsigned normalized RGBA texel data with sRGB nonlinear encoding applied to the RGB components. + + + + + A four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 5×5 rectangle of unsigned normalized RGBA texel data. + + + + + A four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 6×6 rectangle of unsigned normalized RGBA texel data with sRGB nonlinear encoding applied to the RGB components. + + + + + A four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 6×6 rectangle of unsigned normalized RGBA texel data. + + + + + A four-component, ASTC compressed format where each 128-bit compressed texel block encodes an 8×8 rectangle of unsigned normalized RGBA texel data with sRGB nonlinear encoding applied to the RGB components. + + + + + A four-component, ASTC compressed format where each 128-bit compressed texel block encodes an 8×8 rectangle of unsigned normalized RGBA texel data. + + + + + A four-component, block-compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGBA texel data with sRGB nonlinear encoding applied to the RGB components. + + + + + A four-component, block-compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGBA texel data. + + + + + A three-component, block-compressed format. Each 64-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGB texel data with sRGB nonlinear encoding. This format has a 1 bit alpha channel. + + + + + A three-component, block-compressed format. Each 64-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGB texel data. This format has a 1 bit alpha channel. + + + + + A four-component, block-compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGBA texel data with the first 64 bits encoding alpha values followed by 64 bits encoding RGB values with sRGB nonlinear encoding. + + + + + A four-component, block-compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGBA texel data with the first 64 bits encoding alpha values followed by 64 bits encoding RGB values. + + + + + A four-component, block-compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGBA texel data with the first 64 bits encoding alpha values followed by 64 bits encoding RGB values with sRGB nonlinear encoding. + + + + + A four-component, block-compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGBA texel data with the first 64 bits encoding alpha values followed by 64 bits encoding RGB values. + + + + + A four-component, ETC2 compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGBA texel data with the first 64 bits encoding alpha values followed by 64 bits encoding RGB values with sRGB nonlinear encoding applied. + + + + + A four-component, ETC2 compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGBA texel data with the first 64 bits encoding alpha values followed by 64 bits encoding RGB values. + + + + + A four-component, PVRTC compressed format where each 64-bit compressed texel block encodes a 8×4 rectangle of unsigned normalized RGBA texel data with the first 32 bits encoding alpha values followed by 32 bits encoding RGB values with sRGB nonlinear encoding applied. + + + + + A four-component, PVRTC compressed format where each 64-bit compressed texel block encodes a 8×4 rectangle of unsigned normalized RGBA texel data with the first 32 bits encoding alpha values followed by 32 bits encoding RGB values. + + + + + A four-component, PVRTC compressed format where each 64-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGBA texel data with the first 32 bits encoding alpha values followed by 32 bits encoding RGB values with sRGB nonlinear encoding applied. + + + + + A four-component, PVRTC compressed format where each 64-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGBA texel data with the first 32 bits encoding alpha values followed by 32 bits encoding RGB values. + + + + + A one-component, 8-bit unsigned integer format that has 8-bits in the stencil component. + + + + + Defines a series of commands and settings that describes how Unity renders a frame. + + + + + When the IRenderPipeline is invalid or destroyed this returns true. + + + + + Defines custom rendering for this RenderPipeline. + + Structure that holds the rendering commands for this loop. + Cameras to render. + + + + An asset that produces a specific IRenderPipeline. + + + + + Create a IRenderPipeline specific to this asset. + + + Created pipeline. + + + + + Override this method to destroy RenderPipeline cached state. + + + + + The render index for the terrain brush in the editor. + + + Queue index. + + + + + Defines the required members for a Runtime Reflection Systems. + + + + + Update the reflection probes. + + + Whether a reflection probe was updated. + + + + + LODGroup culling parameters. + + + + + Rendering view height in pixels. + + + + + Camera position. + + + + + Camera's field of view. + + + + + Indicates whether camera is orthographic. + + + + + Orhographic camera size. + + + + + Values for the raster state. + + + + + Controls which sides of polygons should be culled (not drawn). + + + + + Enable clipping based on depth. + + + + + Scales the maximum Z slope. + + + + + Scales the minimum resolvable depth buffer value. + + + + + Creates a new raster state with the given values. + + Controls which sides of polygons should be culled (not drawn). + Scales the minimum resolvable depth buffer value. + Scales the maximum Z slope. + + + + + Default values for the raster state. + + + + + Visible reflection probes sorting options. + + + + + Sort probes by importance. + + + + + Sort probes by importance, then by size. + + + + + Do not sort reflection probes. + + + + + Sort probes from largest to smallest. + + + + + What kind of per-object data to setup during rendering. + + + + + Do not setup any particular per-object data besides the transformation matrix. + + + + + Setup per-object lightmaps. + + + + + Setup per-object light probe SH data. + + + + + Setup per-object light probe proxy volume data. + + + + + Setup per-object motion vectors. + + + + + Setup per-object occlusion probe data. + + + + + Setup per-object occlusion probe proxy volume data (occlusion in alpha channels). + + + + + Setup per-object reflection probe data. + + + + + Setup per-object shadowmask. + + + + + Setup per-object light indices. + + + + + Object encapsulating the duration of a single renderpass that contains one or more subpasses. + +The RenderPass object provides a new way to switch rendertargets in the context of a Scriptable Rendering Pipeline. As opposed to the SetRenderTargets function, the RenderPass object specifies a clear beginning and an end for the rendering, alongside explicit load/store actions on the rendering surfaces. + +The RenderPass object also allows running multiple subpasses within the same renderpass, where the pixel shaders have a read access to the current pixel value within the renderpass. This allows for efficient implementation of various rendering methods on tile-based GPUs, such as deferred rendering. + +RenderPasses are natively implemented on Metal (iOS) and Vulkan, but the API is fully functional on all rendering backends via emulation (using legacy SetRenderTargets calls and reading the current pixel values via texel fetches). + +A quick example on how to use the RenderPass API within the Scriptable Render Pipeline to implement deferred rendering: + +The RenderPass mechanism has the following limitations: +- All attachments must have the same resolution and MSAA sample count +- The rendering results of previous subpasses are only available within the same screen-space pixel + coordinate via the UNITY_READ_FRAMEBUFFER_INPUT(x) macro in the shader; the attachments cannot be bound + as textures or otherwise accessed until the renderpass has ended +- iOS Metal does not allow reading from the Z-Buffer, so an additional render target is needed to work around that +- The maximum amount of attachments allowed per RenderPass is currently 8 + depth, but note that various GPUs may + have stricter limits. + + + + + Read only: array of RenderPassAttachment objects currently bound into this RenderPass. + + + + + Read only: The ScriptableRenderContext object this RenderPass was created for. + + + + + Read only: The depth/stencil attachment used in this RenderPass, or null if none. + + + + + Read only: The height of the RenderPass surfaces in pixels. + + + + + Read only: MSAA sample count for this RenderPass. + + + + + Read only: The width of the RenderPass surfaces in pixels. + + + + + Create a RenderPass and start it within the ScriptableRenderContext. + + The ScriptableRenderContext object currently being rendered. + The width of the RenderPass surfaces in pixels. + The height of the RenderPass surfaces in pixels. + MSAA sample count; set to 1 to disable antialiasing. + Array of color attachments to use within this RenderPass. + The attachment to be used as the depthstencil buffer for this RenderPass, or null to disable depthstencil. + + + + End the RenderPass. + + + + + This class encapsulates a single subpass within a RenderPass. RenderPasses can never be standalone, they must always contain at least one SubPass. See Also: RenderPass. + + + + + Create a subpass and start it. + + The RenderPass object this subpass is part of. + Array of attachments to be used as the color render targets in this subpass. All attachments in this array must also be declared in the RenderPass constructor. + Array of attachments to be used as input attachments in this subpass. All attachments in this array must also be declared in the RenderPass constructor. + If true, the depth attachment is read-only in this subpass. Some renderers require this in order to be able to use the depth attachment as input. + + + + End the subpass. + + + + + A declaration of a single color or depth rendering surface to be attached into a RenderPass. + + + + + The currently assigned clear color for this attachment. Default is black. + + + + + Currently assigned depth clear value for this attachment. Default value is 1.0. + + + + + Currently assigned stencil clear value for this attachment. Default is 0. + + + + + The RenderTextureFormat of this attachment. + + + + + The load action to be used on this attachment when the RenderPass starts. + + + + + The store action to use with this attachment when the RenderPass ends. Only used when either BindSurface or BindResolveSurface has been called. + + + + + When the renderpass that uses this attachment ends, resolve the MSAA surface into the given target. + + The target surface to receive the MSAA-resolved pixels. + + + + Binds this RenderPassAttachment to the given target surface. + + The surface to use as the backing storage for this RenderPassAttachment. + Whether to read in the existing contents of the surface when the RenderPass starts. + Whether to store the rendering results of the attachment when the RenderPass ends. + + + + When the RenderPass starts, clear this attachment into the color or depth/stencil values given (depending on the format of this attachment). Changes loadAction to RenderBufferLoadAction.Clear. + + Color clear value. Ignored on depth/stencil attachments. + Depth clear value. Ignored on color surfaces. + Stencil clear value. Ignored on color or depth-only surfaces. + + + + Create a RenderPassAttachment to be used with RenderPass. + + The format of this attachment. + + + + Defines a series of commands and settings that describes how Unity renders a frame. + + + + + Call that should be issued by an SRP when the SRP begins to render a Camera so that other systems can inject per camera render logic. + + + + + + Call that should be issued by an SRP when the SRP begins to render so that other systems can inject 'pre render' logic. + + + + + + When the IRenderPipeline is invalid or destroyed this returns true. + + + + + Call the delegate used during SRP rendering before a single camera starts rendering. + + + + + + Call the delegate used during SRP rendering before a render begins. + + + + + + Dispose the Renderpipeline destroying all internal state. + + + + + Defines custom rendering for this RenderPipeline. + + + + + + + An asset that produces a specific IRenderPipeline. + + + + + Returns the list of current IRenderPipeline's created by the asset. + + + Enumerable of created pipelines. + + + + + Create a IRenderPipeline specific to this asset. + + + Created pipeline. + + + + + Destroys all cached data and created IRenderLoop's. + + + + + Retrieves the default Autodesk Interactive masked Shader for this pipeline. + + + Returns the default shader. + + + + + Retrieves the default Autodesk Interactive Shader for this pipeline. + + + Returns the default shader. + + + + + Retrieves the default Autodesk Interactive transparent Shader for this pipeline. + + + Returns the default shader. + + + + + Return the default 2D Material for this pipeline. + + + Default material. + + + + + Return the default Line Material for this pipeline. + + + Default material. + + + + + Return the default Material for this pipeline. + + + Default material. + + + + + Return the default particle Material for this pipeline. + + + Default material. + + + + + Return the default Shader for this pipeline. + + + Default shader. + + + + + Return the default Terrain Material for this pipeline. + + + Default material. + + + + + Return the default UI ETC1 Material for this pipeline. + + + Default material. + + + + + Return the default UI Material for this pipeline. + + + Default material. + + + + + Return the default UI overdraw Material for this pipeline. + + + Default material. + + + + + Returns the list of names used to display Rendering Layer Mask UI for this pipeline. + + + Array of 32 Rendering Layer Mask names. + + + + + The render index for the terrain brush in the editor. + + + Queue index. + + + + + Create a IRenderPipeline specific to this asset. + + + Created pipeline. + + + + + Default implementation of OnDisable for RenderPipelineAsset. See ScriptableObject.OnDisable + + + + + Default implementation of OnValidate for RenderPipelineAsset. See MonoBehaviour.OnValidate + + + + + Render Pipeline manager. + + + + + Returns the instance of the currently used Render Pipeline. + + + + + Describes a material render queue range. + + + + + A range that includes all objects. + + + + + Inclusive upper bound for the range. + + + + + Inclusive lower bound for the range. + + + + + A range that includes only opaque objects. + + + + + A range that includes only transparent objects. + + + + + A set of values used to override the render state. Note that it is not enough to set e.g. blendState, but that mask must also include RenderStateMask.Blend for the override to occur. + + + + + Specifies the new blend state. + + + + + Specifies the new depth state. + + + + + Specifies which parts of the render state that is overriden. + + + + + Specifies the new raster state. + + + + + The value to be compared against and/or the value to be written to the buffer based on the stencil state. + + + + + Specifies the new stencil state. + + + + + Creates a new render state block with the specified mask. + + Specifies which parts of the render state that is overriden. + + + + Maps a RenderType to a specific render state override. + + + + + Specifices the RenderType to override the render state for. + + + + + Specifies the values to override the render state with. + + + + + Creates a new render state mapping with the specified values. + + Specifices the RenderType to override the render state for. + Specifies the values to override the render state with. + + + + Creates a new render state mapping with the specified values. + + Specifices the RenderType to override the render state for. + Specifies the values to override the render state with. + + + + Specifies which parts of the render state that is overriden. + + + + + When set, the blend state is overridden. + + + + + When set, the depth state is overridden. + + + + + When set, all render states are overridden. + + + + + No render states are overridden. + + + + + When set, the raster state is overridden. + + + + + When set, the stencil state and reference value is overridden. + + + + + Values for the blend state. + + + + + Operation used for blending the alpha (A) channel. + + + + + Operation used for blending the color (RGB) channel. + + + + + Blend factor used for the alpha (A) channel of the destination. + + + + + Blend factor used for the color (RGB) channel of the destination. + + + + + Blend factor used for the alpha (A) channel of the source. + + + + + Blend factor used for the color (RGB) channel of the source. + + + + + Specifies which color components will get written into the target framebuffer. + + + + + Creates a new blend state with the given values. + + Specifies which color components will get written into the target framebuffer. + Blend factor used for the color (RGB) channel of the source. + Blend factor used for the color (RGB) channel of the destination. + Blend factor used for the alpha (A) channel of the source. + Blend factor used for the alpha (A) channel of the destination. + Operation used for blending the color (RGB) channel. + Operation used for blending the alpha (A) channel. + + + + Default values for the blend state. + + + + + Parameters controlling culling process in CullResults. + + + + + This parameter determines query distance for occlusion culling. The accurateOcclusionThreshold controls the distance where the level of detail (LOD) changes. + +The default value of this parameter is -1, and any value less than 0 has the same effect. Default values result in automatic calculation of the LOD. + +When you use occlusion culling, the occlusion data of the world varies in level of detail. In the occlusion data, there are tiles of various sizes. Each tile contains a cells-and-portals graph. In each cell, visibility is the same. This means that any two points are visible within the cell. Portals are the openings between the cells, which determine the visibility between them. + +The tiles are in a k-d tree. The tree contains different sized tiles, where each tile represents a level of detail. When you query a small tile, you get accurate culling results at the price of query time. + +During the culling, the tile size varies with the distance from the camera. This gives finer detail closer to the camera, and coarser detail at further distance. + +The higher the value is, the higher the accuracy is far away form the camera. High values can have a negative impact on performance. + + + + + Camera Properties used for culling. + + + + + Culling Flags for the culling. + + + + + CullingMask used for culling. + + + + + CullingMatrix used for culling. + + + + + Number of culling planes to use. + + + + + The projection matrix generated for single-pass stereo culling. + + + + + Distance between the virtual eyes. + + + + + The view matrix generated for single-pass stereo culling. + + + + + Is the cull orthographic. + + + + + Layers to cull. + + + + + LODParameters for culling. + + + + + Position for the origin of th cull. + + + + + Reflection Probe Sort options for the cull. + + + + + Scene Mask to use for the cull. + + + + + Shadow distance to use for the cull. + + + + + Fetch the culling plane at the given index. + + + + + + Get the distance for the culling of a specific layer. + + + + + + Set the culling plane at a given index. + + + + + + + Set the distance for the culling of a specific layer. + + + + + + + Defines state and drawing commands used in a custom render pipelines. + + + + + Draw subset of visible objects. + + Specifies parts of the render state to override. + Specifies parts of the render state to override for specific render types. + Specifies which set of visible objects to draw. + Specifies how to draw the objects. + Specifies how the renderers should be further filtered. + + + + Draw subset of visible objects. + + Specifies parts of the render state to override. + Specifies parts of the render state to override for specific render types. + Specifies which set of visible objects to draw. + Specifies how to draw the objects. + Specifies how the renderers should be further filtered. + + + + Draw subset of visible objects. + + Specifies parts of the render state to override. + Specifies parts of the render state to override for specific render types. + Specifies which set of visible objects to draw. + Specifies how to draw the objects. + Specifies how the renderers should be further filtered. + + + + Draw shadow casters for a single light. + + Specifies which set of shadow casters to draw, and how to draw them. + + + + Draw skybox. + + Camera to draw the skybox for. + + + + Emit UI geometry into the Scene view for rendering. + + Camera to emit the geometry for. + + + + Execute a custom graphics command buffer. + + Command buffer to execute. + + + + Executes a command buffer on an async compute queue with the queue selected based on the ComputeQueueType parameter passed. + +It is required that all of the commands within the command buffer be of a type suitable for execution on the async compute queues. If the buffer contains any commands that are not appropriate then an error will be logged and displayed in the editor window. Specifically the following commands are permitted in a CommandBuffer intended for async execution: + +CommandBuffer.BeginSample + +CommandBuffer.CopyCounterValue + +CommandBuffer.CopyTexture + +CommandBuffer.CreateGPUFence + +CommandBuffer.DispatchCompute + +CommandBuffer.EndSample + +CommandBuffer.IssuePluginEvent + +CommandBuffer.SetComputeBufferParam + +CommandBuffer.SetComputeFloatParam + +CommandBuffer.SetComputeFloatParams + +CommandBuffer.SetComputeTextureParam + +CommandBuffer.SetComputeVectorParam + +CommandBuffer.WaitOnGPUFence + +All of the commands within the buffer are guaranteed to be executed on the same queue. If the target platform does not support async compute queues then the work is dispatched on the graphics queue. + + The CommandBuffer to be executed. + Describes the desired async compute queue the supplied CommandBuffer should be executed on. + + + + Setup camera specific global shader variables. + + Camera to setup shader variables for. + Set up the stereo shader variables and state. + + + + Setup camera specific global shader variables. + + Camera to setup shader variables for. + Set up the stereo shader variables and state. + + + + Fine-grain control to begin stereo rendering on the scriptable render context. + + Camera to enable stereo rendering on. + + + + Indicate completion of stereo rendering on a single frame. + + Camera to indicate completion of stereo rendering. + + + + Stop stereo rendering on the scriptable render context. + + Camera to disable stereo rendering on. + + + + Submit rendering loop for execution. + + + + + Empty implementation of IScriptableRuntimeReflectionSystem. + + + + + Update the reflection probes. + + + Whether a reflection probe was updated. + + + + + Global settings for the scriptable runtime reflection system. + + + + + The current scriptable runtime reflection system instance. + + + + + Shader pass name identifier. + + + + + Create shader pass name identifier. + + Pass name. + + + + Describes the culling information for a given shadow split (e.g. directional cascade). + + + + + The number of culling planes. + + + + + The culling sphere. The first three components of the vector describe the sphere center, and the last component specifies the radius. + + + + + Gets a culling plane. + + The culling plane index. + + The culling plane. + + + + + Sets a culling plane. + + The index of the culling plane to set. + The culling plane. + + + + How to sort objects during rendering. + + + + + Sort objects back to front. + + + + + Sort renderers taking canvas order into account. + + + + + Typical sorting for opaque objects. + + + + + Typical sorting for transparencies. + + + + + Do not sort objects. + + + + + Sort objects to reduce draw state changes. + + + + + Sort objects in rough front-to-back buckets. + + + + + Sorts objects by renderer priority. + + + + + Sort by material render queue. + + + + + Sort by renderer sorting layer. + + + + + Values for the stencil state. + + + + + The function used to compare the reference value to the current contents of the buffer. + + + + + The function used to compare the reference value to the current contents of the buffer for back-facing geometry. + + + + + The function used to compare the reference value to the current contents of the buffer for front-facing geometry. + + + + + Controls whether the stencil buffer is enabled. + + + + + What to do with the contents of the buffer if the stencil test fails. + + + + + What to do with the contents of the buffer if the stencil test fails for back-facing geometry. + + + + + What to do with the contents of the buffer if the stencil test fails for front-facing geometry. + + + + + What to do with the contents of the buffer if the stencil test (and the depth test) passes. + + + + + What to do with the contents of the buffer if the stencil test (and the depth test) passes for back-facing geometry. + + + + + What to do with the contents of the buffer if the stencil test (and the depth test) passes for front-facing geometry. + + + + + An 8 bit mask as an 0–255 integer, used when comparing the reference value with the contents of the buffer. + + + + + An 8 bit mask as an 0–255 integer, used when writing to the buffer. + + + + + What to do with the contents of the buffer if the stencil test passes, but the depth test fails. + + + + + What to do with the contents of the buffer if the stencil test passes, but the depth test fails for back-facing geometry. + + + + + What to do with the contents of the buffer if the stencil test passes, but the depth test fails for front-facing geometry. + + + + + Creates a new stencil state with the given values. + + An 8 bit mask as an 0–255 integer, used when comparing the reference value with the contents of the buffer. + An 8 bit mask as an 0–255 integer, used when writing to the buffer. + Controls whether the stencil buffer is enabled. + The function used to compare the reference value to the current contents of the buffer for front-facing geometry. + What to do with the contents of the buffer if the stencil test (and the depth test) passes for front-facing geometry. + What to do with the contents of the buffer if the stencil test fails for front-facing geometry. + What to do with the contents of the buffer if the stencil test passes, but the depth test fails for front-facing geometry. + The function used to compare the reference value to the current contents of the buffer for back-facing geometry. + What to do with the contents of the buffer if the stencil test (and the depth test) passes for back-facing geometry. + What to do with the contents of the buffer if the stencil test fails for back-facing geometry. + What to do with the contents of the buffer if the stencil test passes, but the depth test fails for back-facing geometry. + The function used to compare the reference value to the current contents of the buffer. + What to do with the contents of the buffer if the stencil test (and the depth test) passes. + What to do with the contents of the buffer if the stencil test fails. + What to do with the contents of the buffer if the stencil test passes, but the depth test. + + + + Creates a new stencil state with the given values. + + An 8 bit mask as an 0–255 integer, used when comparing the reference value with the contents of the buffer. + An 8 bit mask as an 0–255 integer, used when writing to the buffer. + Controls whether the stencil buffer is enabled. + The function used to compare the reference value to the current contents of the buffer for front-facing geometry. + What to do with the contents of the buffer if the stencil test (and the depth test) passes for front-facing geometry. + What to do with the contents of the buffer if the stencil test fails for front-facing geometry. + What to do with the contents of the buffer if the stencil test passes, but the depth test fails for front-facing geometry. + The function used to compare the reference value to the current contents of the buffer for back-facing geometry. + What to do with the contents of the buffer if the stencil test (and the depth test) passes for back-facing geometry. + What to do with the contents of the buffer if the stencil test fails for back-facing geometry. + What to do with the contents of the buffer if the stencil test passes, but the depth test fails for back-facing geometry. + The function used to compare the reference value to the current contents of the buffer. + What to do with the contents of the buffer if the stencil test (and the depth test) passes. + What to do with the contents of the buffer if the stencil test fails. + What to do with the contents of the buffer if the stencil test passes, but the depth test. + + + + Default values for the stencil state. + + + + + Describes the rendering features supported by a given render pipeline. + + + + + Get / Set a SupportedRenderingFeatures. + + + + + This is the fallback mode if the mode the user had previously selected is no longer available. See SupportedRenderingFeatures.supportedMixedLightingModes. + + + + + Flags for supported reflection probes. + + + + + Determines if the renderer will override the Environment Lighting and will no longer need the built-in UI for it. + + + + + Determines if the renderer will override the fog settings in the Lighting Panel and will no longer need the built-in UI for it. + + + + + Determines if the renderer will override halo and flare settings in the Lighting Panel and will no longer need the built-in UI for it. + + + + + Are light probe proxy volumes supported? + + + + + Are motion vectors supported? + + + + + Can renderers support receiving shadows? + + + + + Are reflection probes supported? + + + + + Determines if the renderer supports renderer priority sorting. + + + + + What baking types are supported. The unsupported ones will be hidden from the UI. See LightmapBakeType. + + + + + Specifies what modes are supported. Has to be at least one. See LightmapsMode. + + + + + Specifies what LightmapMixedBakeMode that are supported. Please define a SupportedRenderingFeatures.defaultMixedLightingMode in case multiple modes are supported. + + + + + Same as MixedLightingMode for baking, but is used to determine what is supported by the pipeline. + + + + + Same as MixedLightingMode.IndirectOnly but determines if it is supported by the pipeline. + + + + + No mode is supported. + + + + + Determines what is supported by the rendering pipeline. This enum is similar to MixedLightingMode. + + + + + Same as MixedLightingMode.Subtractive but determines if it is supported by the pipeline. + + + + + Supported modes for ReflectionProbes. + + + + + Default reflection probe support. + + + + + Rotated reflection probes are supported. + + + + + Holds data of a visible light. + + + + + Light color multiplied by intensity. + + + + + Light flags, see VisibleLightFlags. + + + + + Accessor to Light component. + + + + + Light type. + + + + + Light transformation matrix. + + + + + Light range. + + + + + Light's influence rectangle on screen. + + + + + Spot light angle. + + + + + Flags for VisibleLight. + + + + + Light intersects far clipping plane. + + + + + Light intersects near clipping plane. + + + + + No flags are set. + + + + + Holds data of a visible reflection probe. + + + + + Probe blending distance. + + + + + Probe bounding box. + + + + + Should probe use box projection. + + + + + Probe projection center. + + + + + Shader data for probe HDR texture decoding. + + + + + Probe importance. + + + + + Probe transformation matrix. + + + + + Accessor to ReflectionProbe component. + + + + + Probe texture. + + + + + Experimental render settings features. + + + + + If enabled, ambient trilight will be sampled using the old radiance sampling method. + + + + + A Subsystem is initialized from a SubsystemDescriptor for a given Subsystem (Example, Input, Environment, Display, etc.) and provides an interface to interact with that given Subsystem until it is Destroyed. After a Subsystem is created it can be Started or Stopped to turn on and off functionality (and preserve performance). The base type for Subsystem only exposes this functionality; this class is designed to be a base class for derived classes that expose more functionality specific to a given Subsystem. + + Note: initializing a second Subsystem from the same SubsystemDescriptor will return a reference to the existing Subsystem as only one Subsystem is currently allowed for a single Subsystem provider. + + + + + + Destroys this instance of a subsystem. + + + + + Starts an instance of a subsystem. + + + + + Stops an instance of a subsystem. + + + + + Information about a subsystem that can be queried before creating a subsystem instance. + + + + + A unique string that identifies the subsystem that this Descriptor can create. + + + + + The System.Type of the subsystem implementation associated with this descriptor. + + + + + Gives access to subsystems which provide additional functionality through plugins. + + + + + Returns active Subsystems of a specific instance type. + + Active instances. + + + + Returns a list of SubsystemDescriptors which describe additional functionality that can be enabled. + + Subsystem specific descriptors. + + + + Represents a linear 2D transformation between brush UV space and a target XY space (typically this is a Terrain-local object space.) + + + + + (Read Only) Brush UV origin, in XY space. + + + + + (Read Only) Brush U vector, in XY space. + + + + + (Read Only) Brush V vector, in XY space. + + + + + (Read Only) Target XY origin, in Brush UV space. + + + + + (Read Only) Target X vector, in Brush UV space. + + + + + (Read Only) Target Y vector, in Brush UV space. + + + + + Creates a BrushTransform. + + Origin of the brush, in target XY space. + Brush U vector, in target XY space. + Brush V vector, in target XY space. + + + + Applies the transform to convert a Brush UV coordinate to the target XY space. + + Brush UV coordinate to transform. + + Target XY coordinate. + + + + + Creates an axis-aligned BrushTransform from a rectangle. + + Brush rectangle, in target XY coordinates. + + BrushTransform describing the brush. + + + + + Get the axis-aligned bounding rectangle of the brush, in target XY space. + + + Bounding rectangle in target XY space. + + + + + Applies the transform to convert a target XY coordinate to Brush UV space. + + Point in target XY space. + + Point transformed to Brush UV space. + + + + + The context for a paint operation that may span multiple connected Terrains. + + + + + (Read Only) RenderTexture that an edit operation writes to modify the data. + + + + + (Read Only) The value of RenderTexture.active at the time CreateRenderTargets is called. + + + + + (Read Only) The Terrain used to build the PaintContext. + + + + + (Read Only) The pixel rectangle that this PaintContext represents. + + + + + (Read Only) The size of a PaintContext pixel in terrain units (as defined by originTerrain.) + + + + + (Read Only) Render target that stores the original data from the Terrains. + + + + + (Read Only) The height of the target terrain texture. This is the resolution for a single Terrain. + + + + + (Read Only) The width of the target terrain texture. This is the resolution for a single Terrain. + + + + + (Read Only) The number of Terrains in this PaintContext. + + + + + Flushes the delayed actions created by PaintContext heightmap and alphamap modifications. + + + + + Releases the allocated resources of this PaintContext. + + When true, indicates that this function restores RenderTexture.active + + + + Constructs a PaintContext that you can use to edit a texture on a Terrain, in the region defined by boundsInTerrainSpace and extraBorderPixels. + + Terrain that defines terrain space for this PaintContext. + Terrain space bounds to edit in the target terrain texture. + Width of the target terrain texture (per Terrain). + Height of the target terrain texture (per Terrain). + Number of extra border pixels required. + + + + + + Creates the sourceRenderTexture and destinationRenderTexture. + + Render Texture format. + + + + Creates a new PaintContext, to edit a target texture on a Terrain, in a region defined by pixelRect. + + Terrain that defines terrain space for this PaintContext. + Pixel rectangle to edit in the target terrain texture. + Width of the target terrain texture (per Terrain). + Height of the target terrain texture (per Terrain). + + + + Gathers the alphamap information into sourceRenderTexture. + + TerrainLayer used for painting. + Set to true to specify that the inputLayer is added to the terrain if it does not already exist. Set to false to specify that terrain layers are not added to the terrain. + + + + Gathers the heightmap information into sourceRenderTexture. + + + + + Gathers the normal information into sourceRenderTexture. + + + + + Retrieves the clipped pixel rectangle for a Terrain, relative to the PaintContext render textures. + + Index of the Terrain. + + Returns the clipped pixel rectangle. + + + + + Retrieves the clipped pixel rectangle for a Terrain. + + Index of the Terrain. + + Returns the clipped pixel rectangle. + + + + + Retrieves a Terrain from the PaintContext. + + Index of the terrain. + + Returns the Terrain object. + + + + + Applies an edited alphamap PaintContext by copying modifications back to the source Terrains. + + Unique name used for the undo stack. + + + + Applies an edited heightmap PaintContext by copying modifications back to the source Terrains. + + Unique name used for the undo stack. + + + + A set of utility functions for custom terrain paint tools. + + + + + Helper function to set up a PaintContext for modifying the heightmap of one or more Terrain tiles. + + Reference Terrain tile. Defines terrain space and heightmap resolution. + The region in terrain space to edit. + Number of extra border pixels required. + + PaintContext containing the combined heightmap data for the specified region. + + + + + Helper function to set up a PaintContext for modifying the heightmap of one or more Terrain tiles. + + Reference Terrain tile. Defines terrain space and heightmap resolution. + The region in terrain space to edit. + Number of extra border pixels required. + + PaintContext containing the combined heightmap data for the specified region. + + + + + Helper function to set up a PaintContext for modifying the alphamap of one or more Terrain tiles. + + Reference Terrain tile. Defines terrain space and alphamap resolution. + Selects the alphamap to paint. + The region in terrain space to edit. + Number of extra border pixels required. + + PaintContext containing the combined alphamap data for the specified region. + + + + + Helper function to set up a PaintContext for modifying the alphamap of one or more Terrain tiles. + + Reference Terrain tile. Defines terrain space and alphamap resolution. + Selects the alphamap to paint. + The region in terrain space to edit. + Number of extra border pixels required. + + PaintContext containing the combined alphamap data for the specified region. + + + + + Builds a Scale & Offset transform to convert between one PaintContext's UV space and another PaintContext's UV space. + + Source PaintContext. + Destination PaintContext. + ScaleOffset transform. + + + + Enumeration of the render passes in the built-in paint material. + + + + + Built-in render pass for painting the splatmap texture. + + + + + Built-in render pass for raising and lowering terrain height. + + + + + Built-in render pass for setting terrain height. + + + + + Built-in render pass for smoothing the terrain height. + + + + + Built-in render pass for stamping heights on the terrain. + + + + + Creates a BrushTransform from the input parameters. + + Reference terrain, defines terrain UV and object space. + Center point of the brush, in terrain UV space (0-1 across the terrain tile). + Size of the brush, in terrain space. + Brush rotation in degrees (clockwise). + + Transform from terrain space to Brush UVs. + + + + + Helper function to set up a PaintContext that collects mesh normal data from one or more Terrain tiles. + + Reference Terrain tile. Defines terrain space and heightmap resolution. + The region in terrain space from which to collect normals. + Number of extra border pixels required. + + PaintContext containing the combined normalmap data for the specified region. + + + + + Helper function to set up a PaintContext that collects mesh normal data from one or more Terrain tiles. + + Reference Terrain tile. Defines terrain space and heightmap resolution. + The region in terrain space from which to collect normals. + Number of extra border pixels required. + + PaintContext containing the combined normalmap data for the specified region. + + + + + Helper function for completing a heightmap modification. + + The heightmap paint context to complete. + Unique name used for the undo stack. + + + + Helper function for completing a texture alphamap modification. + + The texture paint context to complete. + Unique name used for the undo stack. + + + + Finds the index of a TerrainLayer in a Terrain tile. + + Terrain tile. + Terrain layer to search for. + + Returns the index of the terrain layer if it exists or -1 if it doesn't exist. + + + + + Returns the default material for blitting operations. + + + Built in "Hidden/BlitCopy" material. + + + + + Returns the built-in in paint material used by the built-in tools. + + + Built-in terrain paint material. + + + + + Returns the default copy terrain layer material. + + + Built in "HiddenTerrainTerrainLayerUtils" material. + + + + + Returns the alphamap texture at mapIndex. + + Terrain tile. + Index to retrieve. + + Alphamap texture at mapIndex. + + + + + Releases the allocated resources of the specified PaintContext. + + The PaintContext containing the resources to release. + + + + Sets up all of the material properties used by functions in TerrainTool.cginc. + + PaintContext describing the area we are editing, and the terrain space. + BrushTransform from terrain space to Brush UVs. + Material to populate with transform properties. + + + + Provides a set of utility functions that are used by the terrain tools. + + + + + Automatically connects neighboring terrains. + + + + + Type for mapping Terrain.groupingID coordinates to TerrainMap. + + + + + Type for mapping 2D (X,Y) coordinates to a Terrain object. + + + + + Indicates the error status of the TerrainMap. + + + + + Mapping from TileCoord to Terrain. + + + + + Creates a TerrainMap. + + Defines the grid origin and size, as well as group id if no filter is specified. + Origin of the grid. + Size of the grid. Typically takes the terrain size.x and size.z. + Filter to be applied when populating the map. See Also: TerrainFilter. If null, the filter will fall back to matching terrains in the same group as the origin. + Validate the terrain map. Default is true. + + The resulting terrain map. Can return null when no terrains pass the filter. + + + + + Creates a TerrainMap. + + Defines the grid origin and size, as well as group id if no filter is specified. + Origin of the grid. + Size of the grid. Typically takes the terrain size.x and size.z. + Filter to be applied when populating the map. See Also: TerrainFilter. If null, the filter will fall back to matching terrains in the same group as the origin. + Validate the terrain map. Default is true. + + The resulting terrain map. Can return null when no terrains pass the filter. + + + + + Retrieves the Terrain object corresponding to the tile coordinates (tileX,tileZ). + + Tile X coordinate. + Tile Z coordinate. + + Returns a valid Terrain object if successful, null otherwise. + + + + + Describes the information about the edge and how to tessellate it. + + + + + The maximum angle to be considered within this range. + + + + + The render order of the edges that belong in this range. + + + + + The list of Sprites that are associated with this range. + + + + + The minimum angle to be considered within this range. + + + + + A collection of APIs that facilitate pixel perfect rendering of sprite-based renderers. + + + + + To achieve a pixel perfect render, Sprites must be displaced to discrete positions at render time. This value defines the minimum distance between these positions. This doesn’t affect the GameObject's transform position. + + + + + Data that describes the important points of the shape. + + + + + The position of the left tangent in local space. + + + + + The various modes of the tangent handles. They could be continuous or broken. + + + + + The position of this point in the object's local space. + + + + + The position of the right tangent point in the local space. + + + + + A struct that holds a rich set of information that describes the bind pose of this Sprite. + + + + + The length of the bone. This is important for the leaf bones to describe their length without needing another bone as the terminal bone. + + + + + The name of the bone. This is useful when recreating bone hierarchy at editor or runtime. You can also use this as a way of resolving the bone path when a Sprite is bound to a more complex or richer hierarchy. + + + + + The ID of the parent of this bone. + + + + + The position in local space of this bone. + + + + + The rotation of this bone in local space. + + + + + A list of methods designed for reading and writing to the rich internal data of a Sprite. + + + + + Returns an array of BindPoses. + + The sprite to retrieve the bind pose from. + + A list of bind poses for this sprite. There is no need to dispose the returned NativeArray. + + + + + Returns a list of SpriteBone in this Sprite. + + The sprite to get the list of SpriteBone from. + + An array of SpriteBone that belongs to this Sprite. + + + + + Returns a list of BoneWeight that corresponds to each and every vertice in this Sprite. + + The Sprite to get the BoneWeights from. + + The list of BoneWeight. The length should equal the number of vertices. There is no need to call dispose on this NativeArray. + + + + + Returns a list of indices. This is the same as Sprite.triangle. + + + + A read-only list of indices indicating how the triangles are formed between the vertices. The array is marked as undisposable. + + + + + Retrieves a strided accessor to the internal vertex attributes. + + + + + A read-only list of. + + + + + Returns the number of vertices in this Sprite. + + + + + + Checks if a specific channel exists for this Sprite. + + + + + True if the channel exists. + + + + + Sets the bind poses for this Sprite. + + The list of bind poses for this Sprite. The array must be disposed of by the caller. + + + + + Sets the SpriteBones for this Sprite. + + + + + + + Sets the BoneWeight for this Sprite. The length of the input array must match the number of vertices. + + The list of BoneWeight for this Sprite. The array must be disposed of by the caller. + + + + + Set the indices for this Sprite. This is the same as Sprite.triangle. + + The list of indices for this Sprite. The array must be disposed of by the caller. + + + + + Sets a specific channel of the VertexAttribute. + + The list of values for this specific VertexAttribute channel. The array must be disposed of by the caller. + + + + + + Sets the vertex count. This resizes the internal buffer. It also preserves any configurations of VertexAttributes. + + + + + + + A list of methods that allow the caller to override what the SpriteRenderer renders. + + + + + Stop using the deformable buffer to render the Sprite and use the original mesh instead. + + + + + + Returns an array of vertices to be deformed by the caller. + + + + + + Provides the JobHandle that updates the deform buffer to the SpriteRenderer. + + + + + + + Additional data about the shape's control point. This is useful during tessellation of the shape. + + + + + The threshold of the angle that decides if it should be tessellated as a curve or a corner. + + + + + The radius of the curve to be tessellated. + + + + + True will indicate that this point should be tessellated as a corner or a continuous line otherwise. + + + + + The height of the tessellated edge. + + + + + The Sprite to be used for a particular edge. + + + + + Input parameters for the SpriteShape tessellator. + + + + + If enabled, the tessellator will adapt the size of the quads based on the height of the edge. + + + + + The threshold of the angle that indicates whether it is a corner or not. + + + + + The threshold of the angle that decides if it should be tessellated as a curve or a corner. + + + + + The radius of the curve to be tessellated. + + + + + The local displacement of the Sprite when tessellated. + + + + + If true, the Shape will be tessellated as a closed form. + + + + + The scale to be used to calculate the UVs of the fill texture. + + + + + The texture to be used for the fill of the SpriteShape. + + + + + If enabled the tessellator will consider creating corners based on the various input parameters. + + + + + The tessellation quality of the input Spline that determines the complexity of the mesh. + + + + + The borders to be used for calculating the uv of the edges based on the border info found in Sprites. + + + + + The world space transform of the game object used for calculating the UVs of the fill texture. + + + + + Renders SpriteShapes defined through the SpriteShapeUtility.GenerateSpriteShape API. + + + + + A static class that helps tessellate a SpriteShape mesh. + + + + + Generate a mesh based on input parameters. + + The output mesh. + Input parameters for the SpriteShape tessellator. + A list of control points that describes the shape. + Additional data about the shape's control point. This is useful during tessellation of the shape. + The list of Sprites that could be used for the edges. + The list of Sprites that could be used for the corners. + A parameter that determins how to tessellate each of the edge. + + + + Generate a mesh based on input parameters. + + SpriteShapeRenderer to which the generated geometry is fed to. + Input parameters for the SpriteShape tessellator. + A list of control points that describes the shape. + Additional data about the shape's control point. This is useful during tessellation of the shape. + The list of Sprites that could be used for the edges. + The list of Sprites that could be used for the corners. + A parameter that determins how to tessellate each of the edge. + + + + Event sent after an element is added to an element that is a descendent of a panel. + + + + + Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. + + + + + Abstract base class for controls. + + + + + The value associated with the field. + + + + + Allow to set a value without being of the change, if any. + + New Value to set. + + + + UxmlTraits for the BaseField. + + + + + Enumerator to get the child elements of the UxmlTraits of BaseField. + + + + + Constructor. + + + + + This is a base class for the Slider fields. + + + + + This is the actual property to contain the direction of the slider. + + + + + This is the maximum value that the slider encodes. + + + + + This is the minimum value that the slider encodes. + + + + + This is a generic page size used to change the value when clicking in the slider. + + + + + This is the range from the minimum value to the maximum value of the slider. + + + + + The actual value of the slider. + + + + + Method used to adjust the dragelement. Mainly used in a scroller. + + The factor used to adjust the drag element, where a value > 1 will make it invisible. + + + + Element that can be bound to a property. + + + + + Binding object that will be updated. + + + + + Path of the target property to be bound. + + + + + Constructor. + + + + + Instantiates a BindableElement using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the BindableElement. + + + + + Constructor. + + + + + Initialize EnumField properties using values from the attribute bag. + + + + + + + + Event sent immediately after an element has lost focus. This event trickles down, it does not bubble up, and it cannot be cancelled. + + + + + Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. + + + + + Styled visual element to match the IMGUI Box Style. + + + + + Instantiates a Box using the data read from a UXML file. + + + + + Constructor. + + + + + A clickable button. + + + + + Clickable MouseManipulator for this Button. + + + + + Constructs a Button. + + Action triggered when the button is clicked. + + + + Constructs a Button. + + Action triggered when the button is clicked. + + + + Instantiates a Button using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the UI.Button. + + + + + Constructor. + + + + + Interface for classes capable of having callbacks to handle events. + + + + + Handle an event, most often by executing the callbacks associated with the event. + + The event to handle. + + + + Return true if event handlers for the event propagation BubbleUp phase have been attached on this object. + + + True if object has event handlers for the BubbleUp phase. + + + + + Returns true if event handlers, for the event propagation TrickleDown phase, are attached to this object. + + + True if object has event handlers for the TrickleDown phase. + + + + + Adds an event handler to the instance. If the event handler has already been registered for the same phase (either TrickleDown or BubbleUp) then this method has no effect. + + The event handler to add. + By default, this callback is called during the BubbleUp phase. Pass TrickleDown.TrickleDown to call this callback during the TrickleDown phase. + Data to pass to the callback. + + + + Adds an event handler to the instance. If the event handler has already been registered for the same phase (either TrickleDown or BubbleUp) then this method has no effect. + + The event handler to add. + By default, this callback is called during the BubbleUp phase. Pass TrickleDown.TrickleDown to call this callback during the TrickleDown phase. + Data to pass to the callback. + + + + Sends an event to the event handler. + + The event to send. + + + + Remove callback from the instance. + + The callback to remove. + Set this parameter to true to remove the callback from the TrickleDown phase. Set this parameter to false to remove the callback from the BubbleUp phase. + + + + Remove callback from the instance. + + The callback to remove. + Set this parameter to true to remove the callback from the TrickleDown phase. Set this parameter to false to remove the callback from the BubbleUp phase. + + + + Sends an event when a value in a field changes. + + + + + The new value. + + + + + The value before the change occured. + + + + + Constructor. + + + + + Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose(). + + The previous value. + The new value. + + Returns an initialized event. + + + + + Sets the event to its initial state. + + + + + Enum which describes the various types of changes that can occur on a VisualElement. + + + + + All change types have been flagged. + + + + + Persistence key or parent has changed on the current VisualElement. + + + + + Persistence key or parent has changed on some child of the current VisualElement. + + + + + Base class for command events. + + + + + Name of the command. + + + + + Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose(). + + The command name. + An IMGUI command event. + + Returns an initialized event. + + + + + Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose(). + + The command name. + An IMGUI command event. + + Returns an initialized event. + + + + + Resets the event members to their initial values. + + + + + The event sent when clicking the right mouse button. + + + + + Constructor. + + + + + Use this class to display a contextual menu. + + + + + Displays the contextual menu. + + The event that triggered the display of the menu. + The element for which the menu is displayed. + + + + Checks if the event triggers the display of the contextual menu. This method also displays the menu. + + The element for which the menu is displayed. + The event to inspect. + + + + Manipulator that displays a contextual menu when the user clicks the right mouse button or presses the menu key on the keyboard. + + + + + Constructor. + + + + + + Register the event callbacks on the manipulator target. + + + + + Unregister the event callbacks from the manipulator target. + + + + + The event sent when a contextual menu requires menu items. + + + + + The menu to populate. + + + + + The event that triggered the ContextualMenuPopulateEvent. + + + + + Constructor. + + + + + Retrieves an event from the event pool. Use this method to retrieve a mouse event and initialize the event, instead of creating a new mouse event. Events obtained from this method should be released back to the pool using Dispose(). + + The event that triggered the display of the contextual menu. + The menu to populate. + The element that triggered the display of the contextual menu. + + Returns an initialized event. + + + + + Resets the event members to their initial values. + + + + + This class is used during UXML template instantiation. + + + + + Script interface for VisualElement cursor style property IStyle.cursor. + + + + + The offset from the top left of the texture to use as the target point (must be within the bounds of the cursor). + + + + + The texture to use for the cursor style. To use a texture as a cursor, import the texture with "Read/Write enabled" in the texture importer (or using the "Cursor" defaults). + + + + + Event sent just before an element is detach from its parent, if the parent is the descendant of a panel. + + + + + Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. + + + + + Base class for drag and drop events. + + + + + Use the DragEnterEvent class to manage events that occur when dragging enters an element or one of its descendants. The DragEnterEvent is cancellable, it does not trickle down, and it does not bubble up. + + + + + Constructor. Avoid renewing events. Instead, use GetPooled() to get an event from a pool of reusable events. + + + + + Resets the event members to their initial values. + + + + + The event sent to a dragged element when the drag and drop process ends. + + + + + Constructor. + + + + + Resets the event members to their initial values. + + + + + Use the DragLeaveEvent class to manage events sent when dragging leaves an element or one of its descendants. The DragLeaveEvent is cancellable, it does not trickle down, and it does not bubble up. + + + + + Constructor. Avoid renewing events. Instead, use GetPooled() to get an event from a pool of reusable events. + + + + + Resets the event members to their initial values. + + + + + The event sent to an element when another element is dragged and dropped on the element. + + + + + Constructor. + + + + + The event sent when the element being dragged enters a possible drop target. + + + + + Constructor. + + + + + A drop-down menu. + + + + + Add an item that will execute an action in the drop-down menu. The item is added at the end of the current item list. + + Name of the item. This name will be displayed in the drop-down menu. + Callback to execute when the user selects this item in the menu. + Callback to execute to determine the status of the item. + An object that will be stored in the userData property of the MenuAction item. + + + + Add a separator line in the menu. The separator is added at the end of the current item list. + + The submenu path where the separator will be added. Path components are delimited by forward slashes ('/'). + + + + Add a separator line in the menu. The separator is added at the end of the current item list. + + The submenu path where the separator will be added. Path components are delimited by forward slashes ('/'). + + + + Constructor. + + + + + A class holding information about the event that triggered the display of the drop-down menu. + + + + + If the triggering event was a mouse event, this property is the mouse position. The position is expressed using the coordinate system of the element that received the mouse event. Otherwise this property is zero. + + + + + If modifier keys (Alt, Control, Shift, Windows/Command) were pressed to trigger the display of the dropdown menu, this property lists the modifier keys. + + + + + If the triggering event was a mouse event, this property is the mouse position expressed using the global coordinate system. Otherwise this property is zero. + + + + + Constructor. + + + + + + Add an item that will execute an action in the drop-down menu. The item is added at the end of the specified index in the list. + + Name of the item. This name will be displayed in the drop-down menu. + Callback to execute when the user selects this item in the menu. + Callback to execute to determine the status of the item. + Index where the item should be inserted. + An object that will be stored in the userData property of the MenuAction item. This object is accessible through the action callback. + + + + Add a separator line in the menu. The separator is added at the end of the specified index in the list. + + Index where the separator should be inserted. + The submenu path where the separator is added. Path components are delimited by forward slashes ('/'). + + + + A menu action item. + + + + + Provides information on the event that triggered the drop-down menu. + + + + + The name of the item. The name can be prefixed by its submenu path. Path components are delimited by forward slashes ('/'). + + + + + The status of the item. + + + + + The userData object stored by the constructor. + + + + + Status callback that always returns StatusFlags.Disabled. + + Unused parameter. + + Always return StatusFlags.Disabled. + + + + + Status callback that always returns StatusFlags.Enabled. + + Unused parameter. + + Always return StatusFlags.Enabled. + + + + + Constructor. + + The path and name of the menu item. Use the path, delimited by forward slashes ('/'), to place the menu item within a submenu. + Action to be executed when the menu item is selected. + Function called to determine if the menu item is enabled. + An object that will be stored in the userData property. + + + + Execute the callback associated with this item. + + + + + Update the status flag of this item by calling the item status callback. + + Information about the event that triggered the display of the drop-down menu, such as the mouse position or the key pressed. + + + + An item in a drop-down menu. + + + + + Get the list of menu items. + + + The list of items in the menu. + + + + + Update the status of all items by calling their status callback and remove the separators in excess. This is called just before displaying the menu. + + + + + + Remove the menu item at index. + + The index of the item to remove. + + + + A separator menu item. + + + + + The submenu path where the separator will be added. Path components are delimited by forward slashes ('/'). + + + + + Constructor. + + The path for the submenu. Path components are delimited by forward slashes ('/'). + + + + The base class for all UIElements events. + + + + + Whether this event type bubbles up in the event propagation path. + + + + + The current target of the event. The current target is the element in the propagation path for which event handlers are currently being executed. + + + + + Whether the event is being dispatched to a visual element. An event cannot be redispatched while it being dispatched. If you need to recursively dispatch an event, it is recommended that you use a copy of the event. + + + + + Flags for the event. + + + + + The IMGUIEvent at the source of this event. The source can be null since not all events are generated by IMGUI. + + + + + Return true if the default actions should not be executed for this event. + + + + + Whether StopImmediatePropagation() was called for this event. + + + + + Whether StopPropagation() was called for this event. + + + + + The original mouse position of the IMGUI event, before it is transformed to the current target local coordinates. + + + + + Whether the event is allocated from a pool of events. + + + + + The current propagation phase. + + + + + The target visual element that received this event. Unlike currentTarget, this target does not change when the event is sent to other elements along the propagation path. + + + + + The time when the event was created. + + + + + Whether this event is sent down the event propagation path during the TrickleDown phase. + + + + + Implementation of IDisposable. + + + + + Retrieves the type id for this event instance. + + + The type ID. + + + + + Resets all event members to their initial values. + + + + + Whether the default actions are prevented from being executed for this event. + + + + + Registers an event class to the event type system. + + + The type ID. + + + + + Immediately stops the propagation of the event. The event is not sent to other elements along the propagation path. This method prevents other event handlers from executing on the current target. + + + + + Stops propagating this event. The event is not sent to other elements along the propagation path. This method does not prevent other event handlers from executing on the current target. + + + + + Generic base class for events, implementing event pooling and automatic registration to the event type system. + + + + + Implementation of IDispose. + + + + + Retrieves the type id for this event instance. + + + The type ID. + + + + + Gets an event from the event pool. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose(). + + + Returns an initialized event. + + + + + Resets all event members to their initial values. + + + + + Gets the type id for the event class. + + + The event class type id. + + + + + Dispatches events to a IPanel. + + + + + Gates control when the dispatcher processes events. + + + + + Constructor. + + The dispatcher controlled by this gate. + + + + Implementation of IDisposable.Dispose. Opens the gate. If all gates are open, events in the queue are processed. + + + + + The event sent when an element should execute a command. + + + + + Constructor. + + + + + Use this structure to set the IStyle.Flex shorthand property which sets the IStyle.flexGrow, IStyle.flexShrink, and IStyle.flexBasis properties. + + + + + The value for the IStyle.flexBasis property. + + + + + The value for the IStyle.flexBasis property. + + + + + The value for the IStyle.flexBasis property. + + + + + Constructor. + + + + + + + + Base class for objects that can get the focus. + + + + + Return true if the element can be focused. + + + + + Return the focus controller for this element. + + + + + An integer used to sort focusables in the focus ring. A negative value means that the element can not be focused. + + + + + Tell the element to release the focus. + + + + + Attempt to give the focus to this element. + + + + + Base class for defining in which direction the focus moves in a focus ring. + + + + + Last value for the direction defined by this class. + + + + + The null direction. This is usually used when the focus stays on the same element. + + + + + Focus came from an unspecified direction, for example after a mouse down. + + + + + The underlying integer value for this direction. + + + + + + Class in charge of managing the focus inside a Panel. + + + + + The currently focused element. + + + + + Constructor. + + + + + Ask the controller to change the focus according to the event. The focus controller will use its focus ring to choose the next element to be focused. + + + + + + Event sent immediately after an element has gained focus. This event trickles down, it does not bubble up, and it cannot be cancelled. + + + + + Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. + + + + + Base class for focus related events. + + + + + Direction of the focus change. + + + + + For FocusOut and Blur events, contains the element that gains the focus. For FocusIn and Focus events, contains the element that loses the focus. + + + + + Gets an event from the event pool and initializes the event with the given values. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose(). + + The event target. + The related target. + The direction of the focus change. + + Returns an initialized event. + + + + + Resets the event members to their initial values. + + + + + Event sent immediately before an element gains focus. This event trickles down and bubbles up. This event cannot be cancelled. + + + + + Constructor. + + + + + Resets the event members to their initial values. + + + + + Event sent immediately before an element loses focus. This event trickles down and bubbles up. This event cannot be cancelled. + + + + + Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. + + + + + Resets the event members to their initial values. + + + + + Collapsable section of UI. + + + + + Contains the collapse state. True if the Foldout is open and the contents are visible. False if it's collapsed. + + + + + Instantiates a Foldout using the data read from a UXML file. + + + + + Constructor. + + + + + Event sent after layout calculations, when the position or the dimension of an element changes. This event cannot be cancelled, it does not trickle down, and it does not bubble up. + + + + + The new dimensions of the element. + + + + + The old dimensions of the element. + + + + + Constructor. + + + + + Gets an event from the event pool and initializes the event with the specified values. Use this method instead of instancing new events. Use Dispose() to release events back to the event pool. + + The old dimensions of the element. + The new dimensions of the element. + + Returns an initialized event. + + + + + Resets the event values to their initial values. + + + + + Interface for all bindable fields. + + + + + Binding object that will be updated. + + + + + Path of the target property to be bound. + + + + + Base interface for Binding objects. + + + + + Called at regular intervals to synchronize bound properties to their IBindable counterparts. Called before the Update() method. + + + + + Disconnects the field from its bound property + + + + + Called at regular intervals to synchronize bound properties to their IBindable counterparts. + + + + + Extensions methods to provide additional IBindable functionality. + + + + + Checks if a IBindable is bound to a property. + + This Bindable object. + + Returns true if this IBindable is bound to a property. + + + + + Base interface for ChangeEvent. + + + + + Interface for Command events. + + + + + Name of the command. + + + + + Interface for drag and drop events. + + + + + Interface for class capable of handling events. + + + + + Handle an event. + + The event to handle. + + + + Return true if event handlers for the event propagation BubbleUp phase have been attached on this object. + + + True if object has event handlers for the BubbleUp phase. + + + + + Returns true if event handlers, for the event propagation TrickleDown phase, are attached to this object. + + + Returns true if the object already has event handlers for the TrickleDown phase. + + + + + Sends an event to the event handler. + + The event to send. + + + + Interface for focus events. + + + + + Direction of the focus change. + + + + + Related target. See implementation for specific meaning. + + + + + Interface for classes implementing focus rings. + + + + + Get the direction of the focus change for the given event. For example, when the Tab key is pressed, focus should be given to the element to the right. + + + + + + + Get the next element in the given direction. + + + + + + + Interface for keyboard events. + + + + + Returns true if the platform specific action key is pressed. This key is Command on macOS and Control otherwise. + + + + + Return true if the Alt key is pressed. + + + + + The character. + + + + + Return true if the Windows/Command key is pressed. + + + + + Return true if the Control key is pressed. + + + + + The key code. + + + + + Flag set holding the pressed modifier keys (Alt, Control, Shift, Windows/Command). + + + + + Return true if the Shift key is pressed. + + + + + A VisualElement representing a source texture. + + + + + The source texture of the Image element. + + + + + The source rectangle inside the texture relative to the top left corner. + + + + + The base texture coordinates of the Image relative to the bottom left corner. + + + + + Instantiates an Image using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the Image. + + + + + Returns an empty enumerable, as images generally do not have children. + + + + + Constructor. + + + + + An interface for Manipulator classes. + + + + + The element that handles the interaction. + + + + + Element that draws IMGUI content. + + + + + Indicate whether this element can be focused. + + + + + Indicate the type of context this element is associated with. See ContextType. + + + + + Construct an element used to draw IMGUI elements. + + The function called when drawing is in-progress. + + + + Construct an element used to draw IMGUI elements. + + The function called when drawing is in-progress. + + + + This method is called whenever a Repaint is required from the VisualElement. + + + + + + This method is called as part of the IEventHandler interface. + + EventBase representing the event to be handled. + + + + Marks layout as dirty to trigger a redraw. + + + + + Instantiates an IMGUIContainer using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the IMGUIContainer. + + + + + Returns an empty enumerable, as IMGUIContainer cannot have VisualElement children. + + + + + Constructor. + + + + + Class used to send a IMGUI event that has no equivalent UIElements event. + + + + + Constructor. Use GetPooled() to get an event from a pool of reusable events. + + + + + Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose(). + + The IMGUI event used to initialize the event. + + Returns an initialized event. + + + + + Resets the event members to their initial values. + + + + + Interface for mouse capture events. + + + + + Interface for mouse events. + + + + + Returns true if the platform specific action key is pressed. This key is Command on macOS and Control otherwise. + + + + + Return true if the Alt key is pressed. + + + + + Integer representing the pressed mouse button: 0 is left, 1 is right, 2 is center. + + + + + Number of clicks. + + + + + Return true if the Windows/Command key is pressed. + + + + + Return true if the Control key is pressed. + + + + + The mouse position in the current target coordinate system. + + + + + Flag set holding the pressed modifier keys (Alt, Control, Shift, Windows/Command). + + + + + Mouse position difference between the last mouse event and this one. + + + + + The mouse position in the panel coordinate system. + + + + + Return true if the Shift key is pressed. + + + + + Interface for controls that hold a value and can notify when it is changed by user input. + + + + + The Value held by the control. + + + + + Registers this callback to receive ChangeEvent<T> when value is changed by user input. + + + + + + Unregisters this callback from receiving ChangeEvent<T> when value is changed by user input. + + + + + + Set the value and, if different, notifies registers callbacks with a ChangeEvent<T> + + The new value to be set. + + + + Set the value and, even if different, does not notify registers callbacks with a ChangeEvent<T> + + The new value to be set. + + + + Sends an event when text from a TextField changes. + + + + + The new text. + + + + + The text before the change occured. + + + + + Constructor. + + + + + Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose(). + + The new text. + The text before the change occured. + + Returns an initialized event. + + + + + Resets the event members to their initial values. + + + + + Interface for classes implementing UI panels. + + + + + Return the focus controller for this panel. + + + + + Interface for panel change events. + + + + + A reference to a scheduled action. + + + + + A scheduler allows you to register actions to be executed at a later point. + + + + + Add this item to the list of scheduled tasks. + + The item to register. + + + + Schedule this action to be executed later. The item will be automatically unscheduled after it has ran for the amount of time specified with the durationMs parameter. + + Action to be executed. + The minimum delay in milliseconds before executing the action. + The minimum interval in milliseconds between each execution. + The total duration in milliseconds where this item will be active. + + Internal reference to the scheduled action. + + + + + Schedule this action to be executed later. After the execution, the item will be automatically unscheduled. + + Action to be executed. + The minimum delay in milliseconds before executing the action. + + Internal reference to the scheduled action. + + + + + Schedule this action to be executed later. Item will be unscheduled when condition is met. + + Action to be executed. + The minimum delay in milliseconds before executing the action. + The minimum interval in milliseconds bettwen each execution. + When condition returns true, the item will be unscheduled. + + Internal reference to the scheduled action. + + + + + Manually unschedules a previously scheduled action. + + The item to be removed from this scheduler. + + + + This interface provides access to a VisualElement style data. + + + + + Alignment of the whole area of children on the cross axis if they span over multiple lines in this container. + + + + + Alignment of children on the cross axis of this container. + + + + + Similar to align-items, but only for this specific element. + + + + + Background color to paint in the element's box. + + + + + Background image to paint in the element's box. + + + + + Background image scaling in the element's box. + + + + + Space reserved for the bottom edge of the border during the layout phase. + + + + + This is the radius of the bottom-left corner when a rounded rectangle is drawn in the element's box. + + + + + This is the radius of the bottom-right corner when a rounded rectangle is drawn in the element's box. + + + + + Space reserved for the bottom edge of the border during the layout phase. + + + + + Color of the border to paint inside the element's box. + + + + + Space reserved for the left edge of the border during the layout phase. + + + + + Space reserved for the left edge of the border during the layout phase. + + + + + This is the radius of every corner when a rounded rectangle is drawn in the element's box. + + + + + Space reserved for the right edge of the border during the layout phase. + + + + + Space reserved for the right edge of the border during the layout phase. + + + + + Space reserved for the top edge of the border during the layout phase. + + + + + This is the radius of the top-left corner when a rounded rectangle is drawn in the element's box. + + + + + This is the radius of the top-right corner when a rounded rectangle is drawn in the element's box. + + + + + Space reserved for the top edge of the border during the layout phase. + + + + + Color to use when drawing the text of an element. + + + + + Mouse cursor to display when the mouse pointer is over an element. + + + + + Ration of this element in its parent during the layout phase. + + + + + Initial main size of a flex item, on the main flex axis. The final layout mught be smaller or larger, according to the flex shrinking and growing determined by the flex property. + + + + + Direction of the main axis to layout children in a container. + + + + + Specifies how much the item will grow relative to the rest of the flexible items inside the same container. + + + + + Specifies how the item will shrink relative to the rest of the flexible items inside the same container. + + + + + Placement of children over multiple lines if not enough space is available in this container. + + + + + Font to draw the element's text. + + + + + Font size to draw the element's text. + + + + + Font style and weight (normal, bold, italic) to draw the element's text. + + + + + Fixed height of an element for the layout. + + + + + Justification of children on the main axis of this container. + + + + + Space reserved for the bottom edge of the margin during the layout phase. + + + + + Space reserved for the left edge of the margin during the layout phase. + + + + + Space reserved for the right edge of the margin during the layout phase. + + + + + Space reserved for the top edge of the margin during the layout phase. + + + + + Maximum height for an element, when it is flexible or measures its own size. + + + + + Maximum width for an element, when it is flexible or measures its own size. + + + + + Minimum height for an element, when it is flexible or measures its own size. + + + + + Minimum height for an element, when it is flexible or measures its own size. + + + + + Space reserved for the bottom edge of the padding during the layout phase. + + + + + Space reserved for the left edge of the padding during the layout phase. + + + + + Space reserved for the right edge of the padding during the layout phase. + + + + + Space reserved for the top edge of the padding during the layout phase. + + + + + Bottom distance from the element's box during layout. + + + + + Left distance from the element's box during layout. + + + + + Right distance from the element's box during layout. + + + + + Top distance from the element's box during layout. + + + + + Element's positioning in its parent container. + + + + + Size of the 9-slice's bottom edge when painting an element's background image. + + + + + Size of the 9-slice's left edge when painting an element's background image. + + + + + Size of the 9-slice's right edge when painting an element's background image. + + + + + Size of the 9-slice's top edge when painting an element's background image. + + + + + Clipping if the text does not fit in the element's box. + + + + + Horizontal and vertical text alignment in the element's box. + + + + + Specifies whether or not an element is visible. + + + + + Fixed width of an element for the layout. + + + + + Word wrapping over multiple lines if not enough space is available to draw the text of an element. + + + + + This interface provides access to a VisualElement transform data. + + + + + Transformation matrix calculated from the position, rotation and scale of the transform (Read Only). + + + + + The position of the VisualElement's transform. + + + + + The rotation of the VisualElement's transform stored as a Quaternion. + + + + + The scale of the VisualElement's transform. + + + + + Interface allowing access to this elements datawatch. + + + + + Starts watching an object. When watched, all changes on an object will trigger the callback to be invoked. + + The object to watch. + Callback. + + A reference to this datawatch request. Disposing it will ensure any native resources will also be released. + + + + + Unregisters a previously watched request. + + The registered request. + + + + An internal reference to a data watch request. + + + + + This type allows UXML attribute value retrieval during the VisualElement instantiation. An instance will be provided to the factory method - see UXMLFactoryAttribute. + + + + + Get the value of an attribute as a string. + + Attribute name. + The attribute value or null if not found. + + True if the attribute was found, false otherwise. + + + + + Interface for UXML factories. While it is not strictly required, concrete factories should derive from the generic class UxmlFactory. + + + + + Must return true if the UXML element attributes are not restricted to the values enumerated by uxmlAttributesDescription. + + + + + The type of element for which this element type can substitute for. + + + + + The UXML namespace for the type returned by substituteForTypeName. + + + + + The fully qualified XML name for the type returned by substituteForTypeName. + + + + + Describes the UXML attributes expected by the element. The attributes enumerated here will appear in the UXML schema. + + + + + Describes the types of element that can appear as children of this element in a UXML file. + + + + + The name of the UXML element read by the factory. + + + + + The namespace of the UXML element read by the factory. + + + + + The fully qualified name of the UXML element read by the factory. + + + + + Returns true if the factory accepts the content of the attribute bag. + + The attribute bag. + + True if the factory accepts the content of the attribute bag. False otherwise. + + + + + Instanciate and initialize an object of type T0. + + A bag of name-value pairs, one for each attribute of the UXML element. This can be used to initialize the properties of the created object. + When the element is created as part of a template instance inserted in another document, this contains information about the insertion point. + + The created object. + + + + + Represents a scheduled task created with a VisualElement's schedule interface. + + + + + Returns the VisualElement this object is associated with. + + + + + Will be true when this item is scheduled. Note that an item's callback will only be executed when it's VisualElement is attached to a panel. + + + + + Repeats this action after a specified time. + + Minimum amount of time in milliseconds between each action execution. + + This ScheduledItem. + + + + + Cancels any previously scheduled execution of this item and re-schedules the item. + + Minimum time in milliseconds before this item will be executed. + + + + After specified duration, the item will be automatically unscheduled. + + The total duration in milliseconds where this item will be active. + + This ScheduledItem. + + + + + Removes this item from its VisualElement's scheduler. + + + + + If not already active, will schedule this item on its VisualElement's scheduler. + + + + + Adds a delay to the first invokation. + + The minimum number of milliseconds after activation where this item's action will be executed. + + This ScheduledItem. + + + + + Item will be unscheduled automatically when specified condition is met. + + When condition returns true, the item will be unscheduled. + + This ScheduledItem. + + + + + A scheduler allows you to register actions to be executed at a later point. + + + + + Schedule this action to be executed later. + + The action to be executed. + The action to be executed. + + Reference to the scheduled action. + + + + + Schedule this action to be executed later. + + The action to be executed. + The action to be executed. + + Reference to the scheduled action. + + + + + Base class for keyboard events. + + + + + Returns true if the platform specific action key is pressed. This key is Command on macOS and Control otherwise. + + + + + Returns true if the Alt key is pressed. + + + + + The character. + + + + + Returns true if the Windows/Command key is pressed. + + + + + Returns true if the Control key is pressed. + + + + + The key code. + + + + + Flags holding the pressed modifier keys (Alt, Control, Shift, Windows/Command). + + + + + Returns true if the Shift key is pressed. + + + + + Gets a keyboard event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose(). + + The character for this event. + The keyCode for this event. + Event modifier keys that are active for this event. + A keyboard IMGUI event. + + Returns an initialized event. + + + + + Gets a keyboard event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose(). + + The character for this event. + The keyCode for this event. + Event modifier keys that are active for this event. + A keyboard IMGUI event. + + Returns an initialized event. + + + + + Resets the event members to their initial values. + + + + + Event sent when a key is pressed on the keyboard. This event trickles down and bubbles up. This event is cancellable. + + + + + Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. + + + + + Event sent when a key is released on the keyboard. This event trickles down and bubbles up. This event is cancellable. + + + + + Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. + + + + + Provides an Element displaying text. + + + + + Constructs a label. + + The text to be displayed. + + + + Constructs a label. + + The text to be displayed. + + + + Instantiates a Label using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the Label. + + + + + Constructor. + + + + + A vertically scrollable area that only creates visual elements for visible items while allowing the binding of many more items. As the user scrolls, visual elements are recycled and re-bound to new data items. + + + + + Callback for binding a data item to the visual element. + + + + + ListView requires all visual elements to have the same height so that it can calculate a sensible scroller size. This property must be set for the list view to function. + + + + + The items data source. This property must be set for the list view to function. + + + + + Callback for constructing the VisualElement that will serve as the template for each recycled and re-bound element in the list. This property must be set for the list view to function. + + + + + Callback for when an item is chosen (double-click). This is different from just a selection. + + The chosen item. + + + + Callback for a selection change. + + List of selected items. + + + + Currently selected item index in the items source. If multiple items are selected, this will return the first selected item's index. + + + + + The currently selected item from the items source. If multiple items are selected, this will return the first selected item. + + + + + Controls the selection state, whether: selections are disabled, there is only one selectable item, or if there are multiple selectable items. + + + + + Clear, recreate all visible visual elements, and rebind all items. This should be called whenever the items source changes. + + + + + Scroll to a specific visual element. + + Element to scroll to. + + + + Scroll so that a specific item index from the items source is visible. + + Item index to scroll to. + + + + Instantiates a ListView using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the ListView. + + + + + Returns an empty enumerable, as list views generally do not have children. + + + + + Constructor. + + + + + Initialize ListView properties using values from the attribute bag. + + The object to initialize. + The attribute bag. + The creation context; unused. + + + + Base class for objects that define user interaction with a VisualElement. Most often manipulators hold state for complex interactions, for example interactions that require a mouse down, mouse move mouse up sequence. + + + + + The element that handles the interaction. + + + + + Register event callbacks on the target visual element. + + + + + Unregister event callbacks on the target visual element. + + + + + Used by manipulators to match events against their requirements. + + + + + The button that activates the manipulation. + + + + + Number of mouse clicks required to activate the manipulator. + + + + + Any modifier keys (ie. ctrl, alt, ...) that are needed to activate the manipulation. + + + + + Returns true if the current mouse event satisfies the activation requirements. + + The mouse event. + + True if the event matches the requirements. + + + + + A min/max slider containing a representation of a range. + + + + + This is the high limit of the slider. + + + + + This is the low limit of the slider. + + + + + This is the high value of the range represented on the slider. + + + + + This is the low value of the range represented on the slider. + + + + + Returns the range of the low/high limits of the slider. + + + + + This is the value of the slider. This is a Vector2 where the x is the lower bound and the y is the higher bound. + + + + + Constructor. + + The minimum value in the range to be represented. + The maximum value in the range to be represented. + The minimum value of the slider limit. + The maximum value of the slider limit. + This is the sldier direction, for now, only Horizontal is supported. + + + + Constructor. + + The minimum value in the range to be represented. + The maximum value in the range to be represented. + The minimum value of the slider limit. + The maximum value of the slider limit. + This is the sldier direction, for now, only Horizontal is supported. + + + + Instantiates a MinMaxSlider using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the MinMaxSlider. + + + + + Constructor. + + + + + Initialize MinMaxSlider properties using values from the attribute bag. + + The element to initialize. + The bag of attributes. + Creation Context, unused. + + + + Class that manages capturing mouse events. + + + + + Assigns an event handler to capture mouse events. + + The event handler that captures mouse events. + + + + Checks if the event handler is capturing the mouse. + + Event handler to check. + + True if the handler captures the mouse. + + + + + Checks if there is a handler capturing the mouse. + + + Returns true if a handler is capturing the mouse, false otherwise. + + + + + Stops an event handler from capturing the mouse. + + The event handler to stop capturing the mouse. If this handler is not assigned to capturing the mouse, nothing happens. + + + + Stops an event handler from capturing the mouse. + + The event handler to stop capturing the mouse. If this handler is not assigned to capturing the mouse, nothing happens. + + + + Event sent after a handler starts capturing the mouse. + + + + + Constructor. + + + + + Event sent when the handler capturing the mouse changes. + + + + + In the case of a MouseCaptureEvent, this property is the IEventHandler that loses the capture. In the case of a MouseCaptureOutEvent, this property is the IEventHandler that gains the capture. + + + + + Retrieves an event from the event pool. Use this method to retrieve a mouse event and initialize the event, instead of creating a new mouse event. Events obtained from this method should be released back to the pool using Dispose(). + + The handler taking or releasing the mouse capture. + The related target. + + Returns an initialized event. + + + + + Resets the event members to their initial values. + + + + + Event sent before a handler stops capturing the mouse. + + + + + Constructor. + + + + + Mouse down event. + + + + + Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. + + + + + Event sent when the mouse pointer enters an element or one of its descendent elements. The event is cancellable, it does not trickle down, and it does not bubble up. + + + + + Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. + + + + + Resets the event members to their initial values. + + + + + Event sent when the mouse pointer enters a window. The event is cancellable, it does not trickle down, and it does not bubble up. + + + + + Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. + + + + + Resets the event members to their initial values. + + + + + The base class for mouse events. + + + + + Returns true if the platform specific action key is pressed. This key is Command on macOS and Control otherwise. + + + + + Returns true if the Alt key is pressed. + + + + + Integer representing the pressed mouse button: 0 is left, 1 is right, 2 is center. + + + + + Number of clicks. + + + + + Returns true if the Windows/Command key is pressed. + + + + + Returns true if the Control key is pressed. + + + + + The current target of the event. The current target is the element in the propagation path for which event handlers are currently being executed. + + + + + The mouse position in the current target coordinate system. + + + + + Flags holding the pressed modifier keys (Alt, Control, Shift, Windows/Command). + + + + + The difference of the mouse position between the previous mouse event and the current mouse event. + + + + + The mouse position in the screen coordinate system. + + + + + Returns true if the Shift key is pressed. + + + + + Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose(). + + A mouse IMGUI event. + + Returns an initialized event. + + + + + Resets the event members to their initial values. + + + + + Event sent when the mouse pointer exits an element and all its descendent elements. The event is cancellable, it does not trickle down, and it does not bubble up. + + + + + Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. + + + + + Resets the event members to their initial values. + + + + + Event sent when the mouse pointer exits a window. The event is cancellable, it does not trickle down, and it does not bubble up. + + + + + Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. + + + + + Resets the event members to their initial values. + + + + + Mouse move event. + + + + + Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. + + + + + Event sent when the mouse pointer exits an element. The event trickles down, it bubbles up, and it is cancellable. + + + + + Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. + + + + + Event sent when the mouse pointer enters an element. The event trickles down, it bubbles up, and it is cancellable. + + + + + Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. + + + + + Mouse up event. + + + + + Constructor. Avoid newing events. Instead, use GetPooled() to get an event from a pool of reusable events. + + + + + Abstract base class for events notifying of a panel change. + + + + + In the case of AttachToPanelEvent, the panel to which the event target element is now attached. In the case of DetachFromPanelEvent, the panel to which the event target element will be attached. + + + + + In the case of AttachToPanelEvent, the panel to which the event target element was attached. In the case of DetachFromPanelEvent, the panel from which the event target element is detached. + + + + + Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose(). + + Sets the originPanel property of the event. + Sets the destinationPanel property of the event. + + Returns an initialized event. + + + + + Resets the event members to their initial values. + + + + + Styled visual element that matches the EditorGUILayout.Popup IMGUI element. + + + + + Instantiates a PopupWindow using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the PopupWindow. + + + + + Returns an empty enumerable, as popup windows generally do not have children. + + + + + Constructor. + + + + + The propagation phases of an event. + + + + + The event is being sent to the event target. + + + + + The event is being sent to the event target parent element up to the root element. + + + + + The event is being sent to the target element for it to execute its default actions for this event. Event handlers do not get the events in this phase. Instead, ExecuteDefaultAction is called on the target. + + + + + The event is not being propagated. + + + + + The event is being sent from the root element to the target parent element. + + + + + A button that executes an action repeatedly while it is pressed. + + + + + Constructor. + + The action to execute when the button is pressed. + The initial delay before the action is executed for the first time. + The interval between each execution of the action. + + + + Constructor. + + The action to execute when the button is pressed. + The initial delay before the action is executed for the first time. + The interval between each execution of the action. + + + + Set the action that should be executed when the button is pressed. + + The action to execute. + The initial delay before the action is executed for the first time. + The interval between each execution of the action. + + + + Instantiates a RepeatButton using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the RepeatButton. + + + + + Constructor. + + + + + Initialize RepeatButton properties using values from the attribute bag. + + The object to initialize. + The attribute bag. + The creation context; unused. + + + + A vertical or horizontal scrollbar. + + + + + Direction of this scrollbar. + + + + + Top or right scroll button. + + + + + Maximum value. + + + + + Bottom or left scroll button. + + + + + Minimum value. + + + + + The slider used by this scroller. + + + + + Value that defines the slider position. It lies between lowValue and highValue. + + + + + Event sent when the slider value has changed. + + + + + + Updates the slider element size as a ratio of the total range. A value greater than 1 disables the Scroller. + + Slider size ratio. + + + + Constructor for this element. + + The minimum value represented by lowValue. + The maximum value represented by highValue. + The event method that is called when the value changes. + The slider direction. See SliderDirection. + + + + Constructor for this element. + + The minimum value represented by lowValue. + The maximum value represented by highValue. + The event method that is called when the value changes. + The slider direction. See SliderDirection. + + + + Changes the value according to the current slider pageSize. + + The factor that applies to the scroll down action. Set to 1 to scroll down by 1 page. Set to a value greater than 1 to scroll down by over a page. + + + + Changes the value according to the current slider pageSize. + + The factor that applies to the scroll down action. Set to 1 to scroll down by 1 page. Set to a value greater than 1 to scroll down by over a page. + + + + Changes the value according to the current slider pageSize. + + The factor that applies to the scroll up action. Set to 1 to scroll up by 1 page. Set to a value greater than 1 to scroll up by over a page. + + + + Changes the value according to the current slider pageSize. + + The factor that applies to the scroll up action. Set to 1 to scroll up by 1 page. Set to a value greater than 1 to scroll up by over a page. + + + + Instantiates a Scroller using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the Scroller. + + + + + Returns an empty enumerable, as scrollers do not have children. + + + + + Constructor. + + + + + Initialize Scroller properties using values from the attribute bag. + + The object to initialize. + The attribute bag. + The creation context; unused. + + + + For internal use only. The button used by the Scroller. + + + + + Clickable manipulator. + + + + + Constructor. + + The method called when a click event occurs. + Sets a delay for when the event begins. The delay is only applied if the specified value is greater than 0. + Determines the time delta between event repetitions. The interval is only applied if the specified value is greater than 0. + + + + Constructor. + + The method called when a click event occurs. + Sets a delay for when the event begins. The delay is only applied if the specified value is greater than 0. + Determines the time delta between event repetitions. The interval is only applied if the specified value is greater than 0. + + + + Instantiates a ScrollerButton using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the ScrollerButton. + + + + + Returns an empty enumerable, as buttons generally do not have children. + + + + + Constructor. + + + + + Initialize ScrollerButton properties using values from the attribute bag. + + The object to initialize. + The attribute bag. + The creation context; unused. + + + + Displays its contents inside a scrollable frame. + + + + + Contains the full content that could be partially visible. + + + + + Obsolete. Use contentContainer instead. + + + + + Represents the visible area of contentContainer. + + + + + This property is controlling the scrolling speed of the horizontal scroller. + + + + + Horizontal scrollbar. + + + + + Whether the view contents fit the horizontal area. + + + + + Whether the view contents fit the vertical area. + + + + + The current scrolling position. + + + + + Whether the horizontal scroller is visible. + + + + + Whether the vertical scroller is visible. + + + + + Indicates whether the content of ScrollView should fill the width of its viewport. The default value is false. + + + + + This property is controlling the scrolling speed of the vertical scroller. + + + + + Vertical Scrollbar. + + + + + Constructor. + + + + + Scroll to a specific child element. + + The child to scroll to. + + + + Replaces the contentContainer with this element. The previous contents container will be removed the hierarchy + + The element to display in this ScrollView + + + + Instantiates a ScrollView using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the ScrollView. + + + + + Constructor. + + + + + Initialize ScrollView properties using values from the attribute bag. + + The object to initialize. + The attribute bag. + The creation context; unused. + + + + Controls how many items can be selected at once. + + + + + Multiple items are selectable at once. + + + + + Selections are disabled. + + + + + Only one item is selectable. + + + + + Experimental.UIElements.Slider is a controller allowing the selection of a value from a range (min, max, value). + + + + + Instantiates a Slider using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the Slider. + + + + + Returns an empty enumerable, as sliders generally do not have children. + + + + + Constructor. + + + + + Initialize Slider properties using values from the attribute bag. + + The object to initialize. + The attribute bag. + The creation context; unused. + + + + This is the direction of the Slider and SliderInt. + + + + + An horizontal slider is made with a SliderDirection Horizontal. + + + + + An vertical slider is made with a SliderDirection Vertical. + + + + + A slider containing Integer discrete values. + + + + + The value to add or remove to the SliderInt.value when it is clicked. + + + + + Constructors for the SliderInt. + + This is the low value of the slider. + This is the high value of the slider. + This is the slider direction, horizontal or vertical. + This is the number of values to change when the slider is clicked. + + + + Constructors for the SliderInt. + + This is the low value of the slider. + This is the high value of the slider. + This is the slider direction, horizontal or vertical. + This is the number of values to change when the slider is clicked. + + + + Instantiates a SliderInt using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the SliderInt. + + + + + Returns an empty enumerable, as sliders generally do not have children. + + + + + Constructor. + + + + + Initialize SliderInt properties using values from the attribute bag. + + The object to initialize. + The bag of attributes. + The creation context; unused. + + + + This enumeration contains values to control how an element is aligned in its parent during the layout phase. + + + + + Default value (currently FlexStart). + + + + + Items are centered on the cross axis. + + + + + Items are aligned at the end on the cross axis. + + + + + Items are aligned at the beginning on the cross axis. + + + + + Stretches items on the cross axis. + + + + + This enumeration defines values used to control in which direction a container will place its children during layout. + + + + + Vertical layout. + + + + + Vertical layout in reverse order. + + + + + Horizontal layout. + + + + + Horizontal layout in reverse order. + + + + + This enumeration contains values to control how children are justified during layout. + + + + + Items are centered. + + + + + Items are justified towards the end of the layout direction. + + + + + Items are justified towards the beginning of the main axis. + + + + + Items are evenly distributed in the line with extra space on each end of the line. + + + + + Items are evenly distributed in the line; first item is at the beginning of the line, last item is at the end. + + + + + This enumeration contains values to control how an element is positioned in its parent container. + + + + + The element is positioned in relation to its parent box and does not contribute to the layout anymore. + + + + + The element is positioned in relation to its default box as calculated by layout. + + + + + This enumeration contains values to specify whether or not an element is visible. + + + + + The picking and rendering of this element is skipped. It still takes space in the layout. + + + + + The element is drawn normally (default). + + + + + This enumeration contains values to control how elements are placed in a container if not enough space is available. + + + + + All elements are placed on the same line. + + + + + Elements are placed over multiple lines. + + + + + Elements are placed over multiple lines with new lines occuring in the reverse order set in the container. + + + + + This interface exposes methods to read custom style properties applied from USS files to visual elements. + + + + + Read a style property value into the specified StyleValue<T>. + + Name of the property in USS. + Target StyleValue<T> field or variable to write to. + + + + Read a style property value into the specified StyleValue<T>. + + Name of the property in USS. + Target StyleValue<T> field or variable to write to. + + + + Read a style property value into the specified StyleValue<T>. + + Name of the property in USS. + Target StyleValue<T> field or variable to write to. + + + + Read a style property value into the specified StyleValue<T>. + + Name of the property in USS. + Target StyleValue<T> field or variable to write to. + + + + Read a style property value into the specified StyleValue<T>. + + Name of the property in USS. + Target StyleValue<T> field or variable to write to. + + + + Read a style property value into the specified StyleValue<T>. + + Name of the property in USS. + Target StyleValue<T> field or variable to write to. + + + + This generic structure encodes a value type that can come from USS or be specified programmatically. + + + + + This represents the default value for a StyleValue<T> of the according generic type. + + + + + The actual value of the StyleValue<T>. + + + + + Creates a StyleValue of the according generic type directly from a value. + + Value to be used as inline style. + + The result StyleValue<T> + + + + + This constructor can be used to specified an alternate default value but it is recommended to use StyleValue<T>.nil. + + Default starting value. + + + + Utility function to be used when reading custom styles values and provide a default value in one step. + + Default value to be returned if no value is set. + + The value to be used for the custom style. + + + + + Template Container. + + + + + Instantiates and clones a TemplateContainer using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the TemplateContainer. + + + + + Returns an empty enumerable, as template instance do not have children. + + + + + Constructor. + + + + + Initialize TemplateContainer properties using values from the attribute bag. + + The object to initialize. + The attribute bag. + The creation context; unused. + + + + Abstract base class for VisualElement containing text. + + + + + The text associated with the element. + + + + + Computes the size needed to display a text string based on element style values such as font, font-size, word-wrap, and so on. + + The text to measure. + Suggested width. Can be zero. + Width restrictions. + Suggested height. + Height restrictions. + + Returns the horizontal and vertical size needed to display the text string. + + + + + Instantiates a TextElement using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the TextElement. + + + + + Enumerator to get the child elements of the UxmlTraits of TextElement. + + + + + Constructor. + + + + + Initializer for the UxmlTraits for the TextElement. + + VisualElement to initialize. + Bag of attributes where to get the value from. + Creation Context, not used. + + + + A textfield is a rectangular area where the user can edit a string. + + + + + Set this to true to mask the characters and false if otherwise. + + + + + Set this to true to allow multiple lines in the textfield and false if otherwise. + + + + + The string currently being exposed by the field. + + + + + Creates a new textfield. + + The maximum number of characters this textfield can hold. If 0, there is no limit. + Set this to true to allow multiple lines in the textfield and false if otherwise. + Set this to true to mask the characters and false if otherwise. + The character used for masking in a password field. + + + + Creates a new textfield. + + The maximum number of characters this textfield can hold. If 0, there is no limit. + Set this to true to allow multiple lines in the textfield and false if otherwise. + Set this to true to mask the characters and false if otherwise. + The character used for masking in a password field. + + + + Called when the persistent data is accessible and/or when the data or persistence key have changed (VisualElement is properly parented). + + + + + Selects text in the textfield between cursorIndex and selectionIndex. + + The caret and selection start position. + The selection end position. + + + + Instantiates a TextField using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the TextField. + + + + + Constructor. + + + + + Initialize TextField properties using values from the attribute bag. + + The object to initialize. + The attribute bag. + The creation context; unused. + + + + Abstract base class used for all text-based fields. + + + + + Color of the cursor. + + + + + The current cursor position index in the text input field. + + + + + Controls whether double clicking selects the word under the mouse pointer or not. + + + + + If set to true, the value property is not updated until either the user presses Enter or the text field loses focus. + + + + + Returns true if the field is used to edit a password. + + + + + The character used for masking in a password field. + + + + + Maximum number of characters for the field. + + + + + The current selection position index in the text input field. + + + + + Background color of selected text. + + + + + Controls whether triple clicking selects the entire line under the mouse pointer or not. + + + + + Add menu items to the text field contextual menu. + + The event holding the menu to populate. + + + + Constructor. + + Maximum number of characters for the field. + The character used for masking in a password field. + + + + Selects all the text. + + + + + UxmlTraits for the TextInputFieldBase. + + + + + Constructor. + + + + + Initialize TextInputFieldBase properties using values from the attribute bag. + + The object to initialize. + The attribute bag. + The creation context; unused. + + + + This is the Toggle field. + + + + + Optional text after the toggle. + + + + + (Obsolete) Sets the event callback for this toggle button. Use OnValueChanged() instead. + + The action to be called when this Toggle is clicked. + + + + Instantiates a Toggle using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the Toggle. + + + + + Constructor. + + + + + Initialize Toggle properties using values from the attribute bag. + + The object to initialize. + The attribute bag. + The creation context; unused. + + + + Event sent to find the first element that displays a tooltip. + + + + + Rectangle of the hovered element in the panel coordinate system. + + + + + Text to display inside the tooltip box. + + + + + Resets the event members to their initial values. + + + + + Use this enum to specify during which phases the event handler is executed. + + + + + The event handler should be executed during the AtTarget and BubbleUp phases. + + + + + The event handler should be executed during the TrickleDown and AtTarget phases. + + + + + UQuery is a set of extension methods allowing you to select individual or collection of visualElements inside a complex hierarchy. + + + + + Utility Object that contructs a set of selection rules to be ran on a root visual element. + + + + + Selects all elements that are active. + + + A QueryBuilder with the selection rules. + + + + + Convenience overload, shorthand for Build().AtIndex(). + + + + + + Compiles the selection rules into a QueryState object. + + + + + Selects all elements that are checked. + + + + + Selects all direct child elements of elements matching the previous rules. + + + + + + + + Selects all direct child elements of elements matching the previous rules. + + + + + + + + Selects all elements with the given class. Not to be confused with Type (see OfType<>()). + + + + + + Initializes a QueryBuilder. + + The root element on which to condfuct the search query. + + + + Selects all elements that are descendants of currently matching ancestors. + + + + + + + + Selects all elements that are descendants of currently matching ancestors. + + + + + + + + Selects all elements that are enabled. + + + + + Convenience overload, shorthand for Build().First(). + + + The first element matching all the criteria, or null if none was found. + + + + + Selects all elements that are enabled. + + + + + Convenience overload, shorthand for Build().ForEach(). + + The function to be invoked with each matching element. + + + + Convenience overload, shorthand for Build().ForEach(). + + The function to be invoked with each matching element. + Each return value will be added to this list. + + + + Convenience overload, shorthand for Build().ForEach(). + + The function to be invoked with each matching element. + + Returns a list of all the results of the function calls. + + + + + Selects all elements that are hovered. + + + + + Convenience overload, shorthand for Build().Last(). + + + The last element matching all the criteria, or null if none was found. + + + + + Selects element with this name. + + + + + + Selects all elements that are not active. + + + + + Selects all elements that npot checked. + + + + + Selects all elements that are not enabled. + + + + + Selects all elements that don't currently own the focus. + + + + + Selects all elements that are not hovered. + + + + + Selects all elements that are not selected. + + + + + Selects all elements that are not visible. + + + + + Selects all elements of the specified Type (eg: Label, Button, ScrollView, etc). + + If specified, will select elements with this name. + If specified, will select elements with the given class (not to be confused with Type). + If specified, will select elements with the given class (not to be confused with Type). + + QueryBuilder configured with the associated selection rules. + + + + + Selects all elements of the specified Type (eg: Label, Button, ScrollView, etc). + + If specified, will select elements with this name. + If specified, will select elements with the given class (not to be confused with Type). + If specified, will select elements with the given class (not to be confused with Type). + + QueryBuilder configured with the associated selection rules. + + + + + Selects all elements that are selected. + + + + + Convenience method. shorthand for Build().ToList. + + + Returns a list containing elements satisfying selection rules. + + + + + Convenience method. Shorthand gor Build().ToList(). + + Adds all elements satisfying selection rules to the list. + + + + Selects all elements that are visible. + + + + + Selects all elements satifying the predicate. + + Predicate that must return true for selected elements. + + QueryBuilder configured with the associated selection rules. + + + + + Query object containing all the selection rules. Can be saved and rerun later without re-allocating memory. + + + + + Selects the n th element matching all the criteria, or null if not enough elements were found. + + The index of the matched element. + + The match element at the specified index. + + + + + The first element matching all the criteria, or null if none was found. + + + The first element matching all the criteria, or null if none was found. + + + + + Invokes function on all elements matching the query. + + The action to be invoked with each matching element. + + + + Invokes function on all elements matching the query. + + Each return value will be added to this list. + The function to be invoked with each matching element. + + + + Invokes function on all elements matching the query. Overloaded for convenience. + + The function to be invoked with each matching element. + + Returns a list of all the results of the function calls. + + + + + The last element matching all the criteria, or null if none was found. + + + The last element matching all the criteria, or null if none was found. + + + + + Creates a new QueryState with the same selection rules, applied on another VisualElement. + + The element on which to apply the selection rules. + + A new QueryState with the same selection rules, applied on this element. + + + + + Returns a list containing elements satisfying selection rules. + + + Returns a list containing elements satisfying selection rules. + + + + + Adds all elements satisfying selection rules to the list. + + Adds all elements satisfying selection rules to the list. + + + + UQuery is a set of extension methods allowing you to select individual or collection of visualElements inside a complex hierarchy. + + + + + Convenience overload, shorthand for Query<T>.Build().First(). + + Root VisualElement on which the selector will be applied. + If specified, will select elements with this name. + If specified, will select elements with the given class (not to be confused with Type). + If specified, will select elements with the given class (not to be confused with Type). + + The first element matching all the criteria, or null if none was found. + + + + + Convenience overload, shorthand for Query<T>.Build().First(). + + Root VisualElement on which the selector will be applied. + If specified, will select elements with this name. + If specified, will select elements with the given class (not to be confused with Type). + If specified, will select elements with the given class (not to be confused with Type). + + The first element matching all the criteria, or null if none was found. + + + + + Initializes a QueryBuilder with the specified selection rules. + + Root VisualElement on which the selector will be applied. + If specified, will select elements with this name. + If specified, will select elements with the given class (not to be confused with Type). + If specified, will select elements with the given class (not to be confused with Type). + + QueryBuilder configured with the associated selection rules. + + + + + Initializes a QueryBuilder with the specified selection rules. + + Root VisualElement on which the selector will be applied. + If specified, will select elements with this name. + If specified, will select elements with the given class (not to be confused with Type). + If specified, will select elements with the given class (not to be confused with Type). + + QueryBuilder configured with the associated selection rules. + + + + + Initializes a QueryBuilder with the specified selection rules. Template parameter specifies the type of elements the selector applies to (ie: Label, Button, etc). + + Root VisualElement on which the selector will be applied. + If specified, will select elements with this name. + If specified, will select elements with the given class (not to be confused with Type). + If specified, will select elements with the given class (not to be confused with Type). + + QueryBuilder configured with the associated selection rules. + + + + + Initializes a QueryBuilder with the specified selection rules. Template parameter specifies the type of elements the selector applies to (ie: Label, Button, etc). + + Root VisualElement on which the selector will be applied. + If specified, will select elements with this name. + If specified, will select elements with the given class (not to be confused with Type). + If specified, will select elements with the given class (not to be confused with Type). + + QueryBuilder configured with the associated selection rules. + + + + + Initializes an empty QueryBuilder on a specified root element. + + Root VisualElement on which the selector will be applied. + + An empty QueryBuilder on a specified root element. + + + + + Base class for describing an XML attribute. + + + + + The default value for the attribute, as a string. + + + + + The attribute name. + + + + + A list of obsolete names for this attribute. + + + + + Restrictions on the possible values of the attribute. + + + + + Attribute type. + + + + + Attribute namespace. + + + + + Whether the attribute is optional, required or prohibited. + + + + + Get the attribute value from the attribute bag. + + A bag containg attributes and their values as strings. + The context in which the values are retrieved. + A function to convert a string value to type T. + The value to return if the attribute is not found in the bag. + + The attribute value from the bag, or defaultValue if the attribute is not found. + + + + + An enum to describe attribute use. + + + + + There is no restriction on the use of this attribute with the element. + + + + + The attribute is optional for the element. + + + + + The attribute should not appear for the element. + + + + + The attribute must appear in the element tag. + + + + + Describes a XML bool attribute. + + + + + The default value for the attribute. + + + + + The default value for the attribute, as a string. + + + + + Constructor. + + + + + Retrieves the value of this attribute from the attribute bag. Returns it if it is found, otherwise return defaultValue. + + The bag of attributes. + + The value of the attribute. + + + + + Describe an allowed child element for an element. + + + + + The name of the allowed child element. + + + + + The namespace name of the allowed child element. + + + + + Constructor. + + + + + + Describes a XML attribute representing a Color as a string. + + + + + The default value for the attribute. + + + + + The default value for the attribute, as a string. + + + + + Constructor. + + + + + Retrieves the value of this attribute from the attribute bag. Returns it if it is found, otherwise return defaultValue. + + The bag of attributes. + + The value of the attribute. + + + + + Describes a XML double attribute. + + + + + The default value for the attribute. + + + + + The default value for the attribute, as a string. + + + + + Constructor. + + + + + Retrieves the value of this attribute from the attribute bag. Returns it if it is found, otherwise return defaultValue. + + The bag of attributes. + + The value of the attribute. + + + + + Describes a XML attribute representing an enum as a string. + + + + + The default value for the attribute. + + + + + The default value for the attribute, as a string. + + + + + Constructor. + + + + + Retrieves the value of this attribute from the attribute bag. Returns it if it is found, otherwise return defaultValue. + + The bag of attributes. + + The value of the attribute. + + + + + Restricts the value of an attribute to be taken from a list of values. + + + + + The list of values the attribute can take. + + + + + Constructor. + + + + + Indicates whether the current UxmlEnumeration object is equal to another object of the same type. + + The object to compare with. + + True if the otheer object is equal to this one. + + + + + UxmlFactory specialization for classes that derive from VisualElement and that shares its traits, VisualElementTraits. + + + + + Constructor. + + + + + Generic base class for UXML factories, which instantiate a VisualElement using the data read from a UXML file. + + + + + Returns UxmlTraits.canHaveAnyAttribute (where UxmlTraits is the argument for T1). + + + + + Returns an empty string if T0 is not VisualElement; otherwise, returns "VisualElement". + + + + + Returns the namespace for substituteForTypeName. + + + + + Returns the fully qualified name for substituteForTypeName. + + + + + Returns an empty enumerable. + + + + + Returns an empty enumerable. + + + + + Returns the type name of T0. + + + + + Returns the namespace name of T0. + + + + + Returns the typefully qualified name of T0. + + + + + Returns true. + + The attribute bag. + + Always true. + + + + + Instantiate an object of type T0 and initialize it by calling T1 UxmlTraits.Init method. + + A bag of name-value pairs, one for each attribute of the UXML element. This can be used to initialize the properties of the created object. + When the element is created as part of a template instance inserted in another document, this contains information about the insertion point. + + The created element. + + + + + Returns the Type of the objects created by this factory. + + + + + If implemented by your factory, this function will be called to instantiate an object of type T0. Otherwise, the default constructor of T0 will be used. + + A bag of name-value pairs, one for each attribute of the UXML element. This can be used to initialize the properties of the created object. + When the element is created as part of a template instance inserted in another document, this contains information about the insertion point. + + The created element. + + + + + Describes a XML float attribute. + + + + + The default value for the attribute. + + + + + The default value for the attribute, as a string. + + + + + Constructor. + + + + + Retrieves the value of this attribute from the attribute bag. Returns it if it is found, otherwise return defaultValue. + + The bag of attributes. + + The value of the attribute. + + + + + Describes a XML int attribute. + + + + + The default value for the attribute. + + + + + The default value for the attribute, as a string. + + + + + Constructor. + + + + + Retrieves the value of this attribute from the attribute bag. Returns it if it is found, otherwise return defaultValue. + + The bag of attributes. + + The value of the attribute. + + + + + Describes a XML long attribute. + + + + + The default value for the attribute. + + + + + The default value for the attribute, as a string. + + + + + Constructor. + + + + + Retrieves the value of this attribute from the attribute bag. Returns it if it is found, otherwise return defaultValue. + + The bag of attributes. + + The value of the attribute. + + + + + Factory for the root UXML element. + + + + + Returns the empty string, as the root element can not appear anywhere else bit at the root of the document. + + + + + Returns the empty string, as the root element can not appear anywhere else bit at the root of the document. + + + + + Returns the empty string, as the root element can not appear anywhere else bit at the root of the document. + + + + + Returns "UXML". + + + + + Returns the qualified name for this element. + + + + + Returns null. + + + + + + + Constructor. + + + + + UxmlTraits for the UXML root element. + + + + + Returns an enumerable containing UxmlChildElementDescription(typeof(VisualElement)), since the root element can contain VisualElements. + + + + + Constructor. + + + + + Describes a XML string attribute. + + + + + The default value for the attribute. + + + + + The default value for the attribute, as a string. + + + + + Constructor. + + + + + Retrieves the value of this attribute from the attribute bag. Returns it if it is found, otherwise return defaultValue. + + The bag of attributes. + + The value of the attribute. + + + + + Describes a VisualElement derived class for the parsing of UXML files and the generation of UXML schema definition. + + + + + Must return true if the UXML element attributes are not restricted to the values enumerated by UxmlTraits.uxmlAttributesDescription. + + + + + Describes the UXML attributes expected by the element. The attributes enumerated here will appear in the UXML schema. + + + + + Describes the types of element that can appear as children of this element in a UXML file. + + + + + Initialize a VisualElement instance with values from the UXML element attributes. + + The VisualElement to initialize. + A bag of name-value pairs, one for each attribute of the UXML element. + When the element is created as part of a template instance inserted in another document, this contains information about the insertion point. + + + + Base class to restricts the value of an attribute. + + + + + Indicates whether the current UxmlTypeRestriction object is equal to another object of the same type. + + The object to compare with. + + True if the otheer object is equal to this one. + + + + + Restricts the value of an attribute to be within the specified bounds. + + + + + True if the bounds exclude max. + + + + + True if the bounds exclude min. + + + + + The maximum value for the attribute. + + + + + The minimum value for the attribute. + + + + + Constructor. + + + + + Indicates whether the current UxmlValueBounds object is equal to another object of the same type. + + The object to compare with. + + True if the otheer object is equal to this one. + + + + + Restricts the value of an attribute to match a regular expression. + + + + + The regular expression that should be matched by the value. + + + + + Constructor. + + + + + Indicates whether the current UxmlValueMatches object is equal to another object of the same type. + + The object to compare with. + + True if the otheer object is equal to this one. + + + + + The event sent to probe which elements accepts a command. + + + + + Constructor. + + + + + Obsolete. Use VisualElement instead. + + + + + Obsolete. VisualContainer.AddChild will be removed. Use VisualElement.Add or VisualElement.shadow.Add instead. + + + + + + VisualContainer.ClearChildren will be removed. Use VisualElement.Clear or VisualElement.shadow.Clear instead. + + + + + Obsolete. Use VisualElement instead. + + + + + Obsolete. VisualContainer.GetChildAt will be removed. Use VisualElement.ElementAt or VisualElement.shadow.ElementAt instead. + + + + + + Obsolete. VisualContainer.InsertChild will be removed. Use VisualElement.Insert or VisualElement.shadow.Insert instead. + + + + + + + Obsolete. VisualContainer.RemoveChild will be removed. Use VisualElement.Remove or VisualElement.shadow.Remove instead. + + + + + + Obsolete. VisualContainer.RemoveChildAt will be removed. Use VisualElement.RemoveAt or VisualElement.shadow.RemoveAt instead. + + + + + + Instantiates a VisualElement using the data read from a UXML file. + + + + + Returns the VisualElement type name. + + + + + Returns the VisualElement type namespace. + + + + + Returns the VisualElement qualified name. + + + + + Returns VisualContainer type name. + + + + + Returns VisualContainer namespace name. + + + + + Returns VisualContainer full name. + + + + + Constructor. + + + + + Base class for objects that are part of the UIElements visual tree. + + + + + Number of child elements in this object's contentContainer + + + + + + Should this element clip painting to its boundaries. + + + + + child elements are added to this element, usually this + + + + + + Access to this element data watch interface. + + + + + The default focus index for newly created elements. + + + + + Returns true if the VisualElement is enabled in its own hierarchy. + + + + + Returns true if the VisualElement is enabled locally. + + + + + Used for view data persistence (ie. tree expanded states, scroll position, zoom level). + + + + + Retrieves this VisualElement's IVisualElementScheduler + + + + + Access to this element physical hierarchy + + + + + + Reference to the style object of this element. + + + + + Text to display inside an information box after the user hovers the element for a small amount of time. + + + + + This property can be used to associate application-specific user data with this VisualElement. + + + + + Add an element to this element's contentContainer + + + + + + Adds this stylesheet file to this element list of applied styles + + + + + + Checks if any of the ChangeTypes have been marked dirty. + + The ChangeType(s) to check. + + True if at least one of the checked ChangeTypes have been marked dirty. + + + + + Brings this element to the end of its parent children list. The element will be visually in front of any overlapping sibling elements. + + + + + Returns the elements from its contentContainer + + + + + Remove all child elements from this element's contentContainer + + + + + Options to select clipping strategy. + + + + + Enables clipping and renders contents to a cache texture. + + + + + Will enable clipping. This VisualElement and its children's content will be limited to this element's bounds. + + + + + Will disable clipping and let children VisualElements paint outside its bounds. + + + + + Returns true if the element is a direct child of this VisualElement + + + + + + Retrieves the child element at position + + + + + + Enables or disables the class with the given name. + + The name of the class to enable or disable. + A boolean flag that adds or removes the class name from the class list. If true, EnableInClassList adds the class name to the class list. If false, EnableInClassList removes the class name from the class list. + + + + Searchs up the hierachy of this VisualElement and retrieves stored userData, if any is found. + + + + + Finds the lowest commont ancestor between two VisualElements inside the VisualTree hierarchy + + + + + + Allows to iterate into this elements children + + + + + Walks up the hierarchy, starting from this element's parent, and returns the first VisualElement of this type + + + + + Walks up the hierarchy, starting from this element, and returns the first VisualElement of this type + + + + + Combine this VisualElement's VisualElement.persistenceKey with those of its parents to create a more unique key for use with VisualElement.GetOrCreatePersistentData. + + + Full hierarchical persistence key. + + + + + Takes a reference to an existing persisted object and a key and returns the object either filled with the persisted state or as-is. + + An existing object to be persisted, or null to create a new object. If no persisted state is found, a non-null object will be returned as-is. + The key for the current VisualElement to be used with the persistence store on the EditorWindow. + + The same object being passed in (or a new one if null was passed in), but possibly with its persistent state restored. + + + + + Takes a reference to an existing persisted object and a key and returns the object either filled with the persisted state or as-is. + + An existing object to be persisted, or null to create a new object. If no persisted state is found, a non-null object will be returned as-is. + The key for the current VisualElement to be used with the persistence store on the EditorWindow. + + The same object being passed in (or a new one if null was passed in), but possibly with its persistent state restored. + + + + + Checks if this stylesheet file is in this element list of applied styles + + + + + Hierarchy is a sctuct allowing access to the shadow hierarchy of visual elements + + + + + Number of child elements in this object's contentContainer + + + + + + Access the physical parent of this element in the hierarchy + + + + + + Add an element to this element's contentContainer + + + + + + Returns the elements from its contentContainer + + + + + Remove all child elements from this element's contentContainer + + + + + Retrieves the child element at position + + + + + + Retrieves the index of the specified VisualElement in the Hierarchy. + + The element to return the index for. + + Returns the index of the element, or -1 if the element is not found. + + + + + Insert an element into this element's contentContainer + + + + + Removes this child from the hierarchy + + + + + + Remove the child element located at this position from this element's contentContainer + + + + + + Reorders child elements from this VisualElement contentContainer. + + Sorting criteria. + + + + Access to this element physical hierarchy + + + + + + Retrieves the child index of the specified VisualElement. + + The child to return the index for. + + Returns the index of the child, or -1 if the child is not found. + + + + + Insert an element into this element's contentContainer + + + + + Triggers a repaint of the VisualElement on the next frame. + + + + + The modes available to measure VisualElement sizes. + + + + + At Most. The element should give its preferred width/height but no more than the value passed. + + + + + The element should give the width/height that is passed in and derive the opposite site from this value (for example, calculate text size from a fixed width). + + + + + The element should give its preferred width/height without any constraint. + + + + + Called when the persistent data is accessible and/or when the data or persistence key have changed (VisualElement is properly parented). + + + + + Callback when the styles of an object have changed. + + + + + + Overwrite object from the persistent data store. + + The key for the current VisualElement to be used with the persistence store on the EditorWindow. + Object to overwrite. + + + + Places this element right before the sibling element in their parent children list. If the element and the sibling position overlap, the element will be visually behind of its sibling. + + The sibling element. + + + + Places this element right after the sibling element in their parent children list. If the element and the sibling position overlap, the element will be visually in front of its sibling. + + The sibling element. + + + + Removes this child from the hierarchy + + + + + + Remove the child element located at this position from this element's contentContainer + + + + + + Removes this element from its parent hierarchy + + + + + Removes this stylesheet file from this element list of applied styles + + + + + + Write persistence data to file. + + + + + Sends an event to the event handler. + + The event to send. + + + + Sends this element to the beginning of its parent children list. The element will be visually behind any overlapping sibling elements. + + + + + Changes whether the current VisualElement is enabled or not. When disabled, a VisualElement does not receive most events. + + New enabled state. + + + + Reorders child elements from this VisualElement contentContainer. + + Sorting criteria. + + + + Access to this element physical hierarchy + + + + + + Toggles between adding and removing the given class name from the class list. + + The class name to add or remove from the class list. + + + + Instantiates a VisualElement using the data read from a UXML file. + + + + + Constructor. + + + + + UxmlTraits for the VisualElement. + + + + + Returns an enumerable containing UxmlChildElementDescription(typeof(VisualElement)), since VisualElements can contain other VisualElements. + + + + + Constructor. + + + + + Initialize VisualElement properties using values from the attribute bag. + + The object to initialize. + The attribute bag. + The creation context; unused. + + + + VisualElementExtensions is a set of extension methods useful for VisualElement. + + + + + Add a manipulator associated to a VisualElement. + + VisualElement associated to the manipulator. + Manipulator to be added to the VisualElement. + + + + Remove a manipulator associated to a VisualElement. + + VisualElement associated to the manipulator. + Manipulator to be removed from the VisualElement. + + + + The given VisualElement's left and right edges will be aligned with the corresponding edges of the parent element. + + + + + + Define focus change directions for the VisualElementFocusRing. + + + + + Last value for the direction defined by this class. + + + + + The focus is moving to the left. + + + + + The focus is moving to the right. + + + + + Implementation of a linear focus ring. Elements are sorted according to their focusIndex. + + + + + The focus order for elements having 0 has a focusIndex. + + + + + Constructor. + + The root of the element tree for which we want to build a focus ring. + Default ordering of the elements in the ring. + + + + Ordering of elements in the focus ring. + + + + + Order elements using a depth-first pre-order traversal of the element tree. + + + + + Order elements according to their position, first by X, then by Y. + + + + + Order elements according to their position, first by Y, then by X. + + + + + Get the direction of the focus change for the given event. For example, when the Tab key is pressed, focus should be given to the element to the right in the focus ring. + + + + + + + Get the next element in the given direction. + + + + + + + Instances of this class hold a tree of `VisualElementAsset`s. It is created from an UXML file, and each `VisualElementAsset` represents a UXML node inside this file. A `VisualTreeAsset` can be Cloned to yield a tree of `VisualElement`s. + + + + + Build a tree of VisualElements from the asset. + + A mapping of slot names to the VisualElements at their root. + Path of the target property to be bound to the cloned tree root. + + The root of the tree of VisualElements that was just cloned. + + + + + Build a tree of VisualElements from the asset. + + A mapping of slot names to the VisualElements at their root. + Path of the target property to be bound to the cloned tree root. + + The root of the tree of VisualElements that was just cloned. + + + + + Build a tree of VisualElements from the asset. + + A VisualElement that will act as the root of the cloned tree. + A mapping of slot names to the VisualElements at their root. + + + + Constructor. + + + + + Mouse wheel event. + + + + + The amount of scrolling applied with the mouse wheel. + + + + + Constructor. Use GetPooled() to get an event from a pool of reusable events. + + + + + Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose(). + + A wheel IMGUI event. + + Returns an initialized event. + + + + + Resets the event members to their initial values. + + + + + The class VFXEventAttribute handles properties transmitted to a system with a Experimental.VFX.VisualEffect.SendEvent. + + + + + Copy stored values from another event attribute. + + The source event attribute. + + + + Copy constructor. + + Source event attribute. + + + + Gets a named stored boolean. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The stored boolean value (or false if Experimental.VFX.VFXEventAttribute.HasBool returns false). + + + + + Gets a named stored boolean. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The stored boolean value (or false if Experimental.VFX.VFXEventAttribute.HasBool returns false). + + + + + Gets a named stored float. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The stored float (or 0.0f if Experimental.VFX.VFXEventAttribute.HasFloat returns false). + + + + + Gets a named stored float. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The stored float (or 0.0f if Experimental.VFX.VFXEventAttribute.HasFloat returns false). + + + + + Gets a named stored integer. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The stored integer value (or 0 if Experimental.VFX.VFXEventAttribute.HasInt returns false). + + + + + Gets a named stored integer. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The stored integer value (or 0 if Experimental.VFX.VFXEventAttribute.HasInt returns false). + + + + + Gets a named stored Matrix4x4. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The stored Matrix4x4 (or Matrix4x4.identity if Experimental.VFX.VFXEventAttribute.HasMatrix4x4 returns false). + + + + + Gets a named stored Matrix4x4. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The stored Matrix4x4 (or Matrix4x4.identity if Experimental.VFX.VFXEventAttribute.HasMatrix4x4 returns false). + + + + + Gets a named stored unsigned integer. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The stored unsigned integer value (or 0 if Experimental.VFX.VFXEventAttribute.HasUint returns false). + + + + + Gets a named stored unsigned integer. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The stored unsigned integer value (or 0 if Experimental.VFX.VFXEventAttribute.HasUint returns false). + + + + + Gets a named stored Vector2. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The stored Vector2 (or Vector2.zero if Experimental.VFX.VFXEventAttribute.HasVector2 returns false). + + + + + Gets a named stored Vector2. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The stored Vector2 (or Vector2.zero if Experimental.VFX.VFXEventAttribute.HasVector2 returns false). + + + + + Gets a named stored Vector3. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The stored Vector3 (or Vector3.zero if Experimental.VFX.VFXEventAttribute.HasVector3 returns false). + + + + + Gets a named stored Vector3. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The stored Vector3 (or Vector3.zero if Experimental.VFX.VFXEventAttribute.HasVector3 returns false). + + + + + Gets a named stored Vector4. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The stored Vector4 (or Vector4.zero if Experimental.VFX.VFXEventAttribute.HasVector4 returns false). + + + + + Gets a named stored Vector4. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The stored Vector4 (or Vector4.zero if Experimental.VFX.VFXEventAttribute.HasVector4 returns false). + + + + + Returns true if event attribute stores this named boolean. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if event attribute stores this named boolean. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if event attribute stores this named float. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if event attribute stores this named float. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if event attribute stores this named integer. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if event attribute stores this named integer. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if event attribute stores this named Matrix4x4. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if event attribute stores this named Matrix4x4. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if event attribute stores this named unsigned integer. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if event attribute stores this named unsigned integer. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if event attribute stores this named Vector2. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if event attribute stores this named Vector2. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if event attribute stores this named Vector3. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if event attribute stores this named Vector3. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if event attribute stores this named Vector4. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if event attribute stores this named Vector4. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Sets a named boolean value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new boolean value. + + + + Sets a named boolean value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new boolean value. + + + + Sets a named float value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new float value. + + + + Sets a named float value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new float value. + + + + Sets a named integer value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new integer value. + + + + Sets a named integer value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new integer value. + + + + Sets a named Matrix4x4 value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new Matrix4x4 value. + + + + Sets a named Matrix4x4 value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new Matrix4x4 value. + + + + Sets a named unsigned integer value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new unsigned integer value. + + + + Sets a named unsigned integer value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new unsigned integer value. + + + + Sets a named Vector2 value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new Vector2 value. + + + + Sets a named Vector2 value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new Vector2 value. + + + + Sets a named Vector3 value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new Vector3 value. + + + + Sets a named Vector3 value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new Vector3 value. + + + + Sets a named Vector4 value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new Vector4 value. + + + + Sets a named Vector4 value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new Vector4 value. + + + + This class is a wrapper to the set of expression values. + + + + + Returns a an animation curve that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns a an animation curve that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns a boolean that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns a boolean that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns a float that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns a float that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns a gradient that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns a gradient that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns an integer that corresponds to the bound named expression. IF this entry is not available, or the type doesn't match, an exception is thrown. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns an integer that corresponds to the bound named expression. IF this entry is not available, or the type doesn't match, an exception is thrown. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns a Matrix4 that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns a Matrix4 that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns a mesh that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns a mesh that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns a texture that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns a texture that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns an unsigned integer that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns an unsigned integer that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns a Vector2 that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns a Vector2 that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns a Vector3 that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns a Vector3 that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns a Vector4 that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns a Vector4 that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + The VFX Manager lets you set a number of properties that control VisualEffect behavior within your game. + + + + + The fixed interval in which the frame rate updates. The tick rate is in seconds. + + + + + The maximum allowed delta time for an update interval. This limit affects fixedDeltaTime and deltaTime. The tick rate is in seconds. + + + + + This abstract class provides a way to implement custom spawner block in C#. + + + + + This method is invoked when Play is triggered on parent spawner system. + + The spawner state. + The values of expression (input properties for a spawner block). + The visual effect. + + + + This method is invoked when stop is triggered on parent spawner system. + + The spawner state. + The values of expression (input properties for a spawner block). + The visual effect. + + + + This method is invoked when update is triggered on parent spawner system. + + The spawner state. + The values of expression (input properties for a spawner block). + The visual effect. + + + + The spawn state of a Spawn system. + + + + + The current delta time. + + + + + The current playing state. + + + + + The current Spawn count. + + + + + The accumulated delta time since the last Play event. + + + + + Gets the modifiable current event attribute (Read Only). + + + + + The visual effect class that references an Experimental.VFX.VisualEffectAsset instance within the Scene. + + + + + Returns the sum of all alive particles within the visual effect. + + + + + Is this visual effect culled (not visible) from any camera ? (Read Only) + + + + + The paused state of visual effect. + + + + + A multiplier applied to the delta time when updating the VisualEffect. The default value is 1.0f. + + + + + Controls whether the visual effect generates a new random number to seed the random number generator for each call to Experimental.VFX.VisualEffect.Play function. + + + + + The initial seed used used for internal random number generator. + + + + + The visual effect asset used by the visual effect. + + + + + If Experimental.VFX.VisualEffect._pause is true, the method processes the next visual effect update for exactly one frame with the current delta time. + + + + + Create a new event attribute class. + + + + + The visual effect constructor. + + + + + Gets a named exposed animation curve. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The exposed animation curve value (or empty animation curve if Experimental.VFX.VisualEffect.HasAnimationCurve returns false). + + + + + Gets a named exposed animation curve. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The exposed animation curve value (or empty animation curve if Experimental.VFX.VisualEffect.HasAnimationCurve returns false). + + + + + Get a named exposed boolean. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The exposed boolean value (or false if Experimental.VFX.VisualEffect.HasBool returns false). + + + + + Get a named exposed boolean. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The exposed boolean value (or false if Experimental.VFX.VisualEffect.HasBool returns false). + + + + + Gets a named exposed float (o. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The exposed float value (or 0.0f if Experimental.VFX.VisualEffect.HasFloat returns false). + + + + + Gets a named exposed float (o. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The exposed float value (or 0.0f if Experimental.VFX.VisualEffect.HasFloat returns false). + + + + + Gets a named exposed gradient. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The exposed gradient value (or empty gradient if Experimental.VFX.VisualEffect.HasGradient returns false). + + + + + Gets a named exposed gradient. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The exposed gradient value (or empty gradient if Experimental.VFX.VisualEffect.HasGradient returns false). + + + + + Get named exposed integer. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The exposed integer value (or 0 if Experimental.VFX.VisualEffect.HasInt returns false). + + + + + Get named exposed integer. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The exposed integer value (or 0 if Experimental.VFX.VisualEffect.HasInt returns false). + + + + + Gets named exposed Matrix4x4. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The exposed Matrix4x4 value (or Matrix4x4.zero if Experimental.VFX.VisualEffect.HasMatrix4x4 returns false). + + + + + Gets named exposed Matrix4x4. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The exposed Matrix4x4 value (or Matrix4x4.zero if Experimental.VFX.VisualEffect.HasMatrix4x4 returns false). + + + + + Gets named exposed mesh. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The exposed mesh value (or null if Experimental.VFX.VisualEffect.HasMesh returns false). + + + + + Gets named exposed mesh. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The exposed mesh value (or null if Experimental.VFX.VisualEffect.HasMesh returns false). + + + + + Gets named exposed texture. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The exposed texture value (or null if Experimental.VFX.VisualEffect.HasTexture returns false). + + + + + Gets named exposed texture. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The exposed texture value (or null if Experimental.VFX.VisualEffect.HasTexture returns false). + + + + + Get expected texture dimension for a named exposed texture. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get expected texture dimension for a named exposed texture. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get named exposed unsigned integer. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The exposed unsigned integer value (or 0 if Experimental.VFX.VisualEffect.HasUInt returns false). + + + + + Get named exposed unsigned integer. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The exposed unsigned integer value (or 0 if Experimental.VFX.VisualEffect.HasUInt returns false). + + + + + Gets named exposed Vector2. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The exposed Vector2 value (or Vector2.zero if Experimental.VFX.VisualEffect.HasVector2 returns false). + + + + + Gets named exposed Vector2. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The exposed Vector2 value (or Vector2.zero if Experimental.VFX.VisualEffect.HasVector2 returns false). + + + + + Gets named exposed Vector3. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The exposed Vector3 value (or Vector3.zero if Experimental.VFX.VisualEffect.HasVector3 returns false). + + + + + Gets named exposed Vector3. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The exposed Vector3 value (or Vector3.zero if Experimental.VFX.VisualEffect.HasVector3 returns false). + + + + + Gets named exposed Vector4. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The exposed Vector4 value (or Vector4.zero if Experimental.VFX.VisualEffect.HasVector4 returns false). + + + + + Gets named exposed Vector4. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + The exposed Vector4 value (or Vector4.zero if Experimental.VFX.VisualEffect.HasVector4 returns false). + + + + + Returns true if visual effect can override this named animation curve. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if visual effect can override this named animation curve. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if the visual effect can override the boolean. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if the visual effect can override the boolean. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if the visual effect can override this named float. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if the visual effect can override this named float. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if visual effect can override this named gradient. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if visual effect can override this named gradient. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if the visual effect can override this named integer. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if the visual effect can override this named integer. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if visual effect can override this named Matrix4x4. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if visual effect can override this named Matrix4x4. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if visual effect can override this named mesh. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if visual effect can override this named mesh. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if visual effect can override this named texture. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if visual effect can override this named texture. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if the visual effect can override this named unsigned integer. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if the visual effect can override this named unsigned integer. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if visual effect can override this named Vector2. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if visual effect can override this named Vector2. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if visual effect can override this named Vector3. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if visual effect can override this named Vector3. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if visual effect can override this named Vector4. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Returns true if visual effect can override this named Vector4. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Sends a stop event to all Spawn systems. If Experimental.VFX.VisualEffect._resetSeedOnPlay is true, this methods recomputes a new random seed for the random value generator and resets internal total time to zero. + + Can be null or eventAttribute instantiated with Experimental.VFX.VisualEffect.CreateVFXEventAttribute. + + + + Sends a stop event to all Spawn systems. If Experimental.VFX.VisualEffect._resetSeedOnPlay is true, this methods recomputes a new random seed for the random value generator and resets internal total time to zero. + + Can be null or eventAttribute instantiated with Experimental.VFX.VisualEffect.CreateVFXEventAttribute. + + + + Reintialize visual effect. + + + + + Sets the overridden state to false, and restores the default value that is specified in the visual effect Asset. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Sets the overridden state to false, and restores the default value that is specified in the visual effect Asset. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Send a custom named event. + + The name of the event. + The name ID of the event retrieved by Shader.PropertyToID. + Can be null or eventAttribute instantiated with Experimental.VFX.VisualEffect.CreateVFXEventAttribute. + + + + Send a custom named event. + + The name of the event. + The name ID of the event retrieved by Shader.PropertyToID. + Can be null or eventAttribute instantiated with Experimental.VFX.VisualEffect.CreateVFXEventAttribute. + + + + Send a custom named event. + + The name of the event. + The name ID of the event retrieved by Shader.PropertyToID. + Can be null or eventAttribute instantiated with Experimental.VFX.VisualEffect.CreateVFXEventAttribute. + + + + Send a custom named event. + + The name of the event. + The name ID of the event retrieved by Shader.PropertyToID. + Can be null or eventAttribute instantiated with Experimental.VFX.VisualEffect.CreateVFXEventAttribute. + + + + Sets a named animation curve value. + + The name ID of the property retrieved by Shader.PropertyToID. + The new animation curve. + The name of the property. + + + + Sets a named animation curve value. + + The name ID of the property retrieved by Shader.PropertyToID. + The new animation curve. + The name of the property. + + + + Sets the value for a named boolean. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new boolean value. + + + + Sets the value for a named boolean. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new boolean value. + + + + Sets the value for a named float. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new float value. + + + + Sets the value for a named float. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new float value. + + + + Sets a named gradient value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new gradient value. + + + + Sets a named gradient value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new gradient value. + + + + Sets the value for a named integer. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new integer value. + + + + Sets the value for a named integer. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new integer value. + + + + Sets a named Matrix4x4 value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new Matrix4x4 value. + + + + Sets a named Matrix4x4 value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new Matrix4x4 value. + + + + Sets a named mesh value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new mesh value. + + + + Sets a named mesh value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new mesh value. + + + + Sets a named texture value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new texture value. + + + + Sets a named texture value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new texture value. + + + + Sets the value for a named unsigned integer. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new unsigned integer value. + + + + Sets the value for a named unsigned integer. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new unsigned integer value. + + + + Sets the value for a named Vector2. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new Vector2 value. + + + + Sets the value for a named Vector2. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new Vector2 value. + + + + Sets the value for a named Vector3. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new Vector3 value. + + + + Sets the value for a named Vector3. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new Vector3 value. + + + + Sets a named Vector4 value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new Vector4 value. + + + + Sets a named Vector4 value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The new Vector4 value. + + + + Send a stop event to all Spawn systems. + + Can be null or eventAttribute instantiated with Experimental.VFX.VisualEffect.CreateVFXEventAttribute. + + + + Send a stop event to all Spawn systems. + + Can be null or eventAttribute instantiated with Experimental.VFX.VisualEffect.CreateVFXEventAttribute. + + + + This class contains a graph of the elements needed to describe a visual effect. These include: the visual effects system, generated shaders, and compiled data. + + + + + The visual effect Asset constructor. + + + + + An implementation of IPlayable that controls playback of a VideoClip. + + + + + Creates a VideoClipPlayable in the PlayableGraph. + + The PlayableGraph object that will own the VideoClipPlayable. + Indicates if VideoClip loops when it reaches the end. + VideoClip used to produce textures in the PlayableGraph. + + A VideoClipPlayable linked to the PlayableGraph. + + + + + Extension methods for the Video.VideoPlayer class. + + + + + Return the Experimental.Audio.AudioSampleProvider for the specified track, used to receive audio samples during playback. + + The "this" pointer for the extension method. + The audio track index for which the sample provider is queried. + + The sample provider for the specified track. + + + + + Structure describing a bounded plane representing a real-world surface. + + + + + The alignment of the plane, e.g., horizontal or vertical. + + + + + Center point of the plane in device space. + + + + + Outputs four points, in device space, representing the four corners of the plane. The corners are in clockwise order. + + The vertex of the first corner. + The vertex of the second corner. + The vertex of the third corner. + The vertex of the fourth corner. + + + + Current height of the plane. + + + + + A session-unique identifier for the plane. + + + + + Normal vector of the plane in device space. + + + + + Returns the infinite Plane associated with this BoundedPlane. + + + + + Pose of the plane in device space. + + + + + Current size of the plane. + + + + + A session-unique identifier for the BoundedPlane that subsumed this plane. + + + + + Try to retrieve a list of positions in device space describing current plane boundary. + + A list of vertices representing the boundary. + + True if the plane exists (i.e., is still being tracked), otherwise false. + + + + + Current width of the plane. + + + + + Structure containing data passed during Frame Received Event. + + + + + Reference to the XRCameraSubsystem associated with this event. + + + + + The state of a tracked mesh since the last query. + + + + + The mesh has been added since the last call to XRMeshSubsystem.TryGetMeshInfos. + + + + + The mesh has been removed since the last call to XRMeshSubsystem.TryGetMeshInfos. + + + + + The mesh has not changed since the last call to XRMeshSubsystem.TryGetMeshInfos. + + + + + The mesh has been updated since the last call to XRMeshSubsystem.TryGetMeshInfos. + + + + + Contains event information related to a generated mesh. + + + + + The MeshVertexAttributes that were written to the MeshGenerationResult.Mesh. + + + + + If the generation was successful, data has been written to this Mesh. + + + + + If the generation was successful, physics data has been written to this MeshCollider. + + + + + The TrackableId of the tracked mesh that was generated. + + + + + The MeshGenerationStatus of the mesh generation task. + + + + + The status of a XRMeshSubsystem.GenerateMeshAsync. + + + + + The mesh generation was canceled. + + + + + The XRMeshSubsystem was already generating the requested mesh. + + + + + The mesh generation failed because the mesh does not exist. + + + + + The mesh generation was successful. + + + + + The mesh generation failed for unknown reasons. + + + + + Contains state information related to a tracked mesh. + + + + + The change state (e.g., Added, Removed) of the tracked mesh. + + + + + The TrackableId of the tracked mesh. + + + + + A hint that can be used to determine when this mesh should be processed. + + + + + A set of vertex attributes. + + + + + Vertex normals + + + + + No vertex attributes + + + + + Vertex normals + + + + + Vertex tangents + + + + + Vertex UVs + + + + + Contains data supplied to a XRPlaneSubsystem.PlaneAdded event. + + + + + The BoundedPlane that was added. + + + + + A reference to the PlaneSubsystem object from which the event originated. + + + + + Describes current plane alignment in mixed reality space. + + + + + Plane has horizontal alignment. + + + + + Plane is not alligned along cardinal (X, Y or Z) axis. + + + + + Plane has vertical alignment. + + + + + Contains data supplied to a XRPlaneSubsystem.PlaneRemoved event. + + + + + The BoundedPlane that was removed. + + + + + A reference to the XRPlaneSubsystem object from which the event originated. + + + + + Contains data supplied to a XRPlaneSubsystem.PlaneUpdated event. + + + + + The BoundedPlane that was updated. + + + + + A reference to the XRPlaneSubsystem object from which the event originated. + + + + + Contains data supplied to a XRDepth.PointCloudUpdated event. + + + + + A reference to the XRDepthSubsystem object from which the event originated. + + + + + Describes the transform data of a real-world point. + + + + + ID for the reference point that is unique across the session. + + + + + The pose (position and rotation) of the reference point. Respond to changes in this pose to correct for changes in the device's understanding of where this point is in the real world. + + + + + The TrackingState of the reference point. + + + + + Data to be passed to the user when the device corrects its understanding of the world enough that the ReferencePoint's position or rotation has changed. + + + + + The previous Pose of the ReferencePoint, prior to this event. + + + + + The previous TrackingState of the ReferencePoint, prior to this event. + + + + + The reference point that has the value of its position, rotation, or both changed enough through the device correcting its understanding of where this point should be located in device space. + + + + + Structure defining Tracking State Changed event arguments passed when tracking state changes. + + + + + New Tracking State. + + + + + Reference to the XRSessionSubsystem object associated with the event. + + + + + A session-unique identifier for trackables in the environment, e.g., planes and feature points. + + + + + Represents an invalid id. + + + + + Generates a nicely formatted version of the id. + + + A string unique to this id + + + + + A trackable is feature in the physical environment that a device is able to track, such as a plane. + + + + + All trackables (planes and point cloud) + + + + + A feature point. + + + + + No trackable. + + + + + An estimated plane. + + + + + Any of the plane types. + + + + + Within the BoundedPlane.Size of a BoundedPlane + + + + + The infinite plane of a BoundedPlane + + + + + The boundary of a BoundedPlane + + + + + Current tracking state of the device. + + + + + Tracking is currently working. + + + + + Tracking is not available. + + + + + Tracking state is unknown. + + + + + Provides access to a device's camera. + + + + + Set current Camera component within the app to be used by this XRCameraInstance. + + + + + Event raised when a new camera frame is received. + + + + + + Fills the provided texturesOut with the texture(s) associated with the XRCameraSubsystem. + + A List of Texture2D to be filled. Passing null will throw an ArgumentNullException. + + + + The frame during which the camera subsystem was last successfully updated. + + + + + True if the XRCameraSubsystem should try to provide light estimation. + + + + + Set current Material to be used while rendering to the render target. + + + + + Provides brightness for the whole image as an average of all pixels' brightness. + + An estimated average brightness for the environment. + + Returns true if average brigthness was provided. + + + + + Provides color temperature for the whole image as an average of all pixels' color temperature. + + An estimated color temperature. + + Return true if succesful. + + + + + Provides display matrix defining how texture is being rendered on the screen. + + + + + + Provides projection matrix used by camera subsystem. + + + + + + Provides shader name used by Camera subsystem to render texture. + + + + + + Provides timestamp. + + + + + + Class providing information about XRCameraSubsystem registration. + + + + + Specifies if current subsystem is allowed to provide average brightness. + + + + + Specifies if current subsystem is allowed to provide average camera temperature. + + + + + Specifies if current subsystem is allowed to provide display matrix. + + + + + Specifies if current subsystem is allowed to provide projection matrix. + + + + + Specifies if current subsystem is allowed to provide timestamp. + + + + + Provides access to depth data of the physical environment, such as a point cloud. + + + + + Retrieves the confidence values for each point in the point cloud. + + A list of floats containing all confidence values for the point cloud. + + + + Retrieves the point cloud points. + + A list of Vector3s containing all points in the point cloud. + + + + The frame during which the point cloud was last updated. + + + + + Raised once during each frame in which the point cloud is updated. + + + + + + Class providing information about XRDepthSubsystem registration. + + + + + When true, XRDepthSubsystem will provide list of feature points detected so far. + + + + + An XRDisplaySubsystem controls rendering to a head tracked display. + + + + + Class providing information about XRDisplaySubsystem registration. + + + + + XRInputSubsystem +Instance is used to enable and disable the inputs coming from a specific plugin. + + + + + Information about an Input subsystem. + + + + + When true, will suppress legacy support for Daydream, Oculus, OpenVR, and Windows MR built directly into the Unity runtime from generating input. This is useful when adding an XRInputSubsystem that supports these devices. + + + + + Allows external systems to provide dynamic meshes to Unity. + + + + + Request that the mesh with TrackableId meshId gets generated. onMeshGenerationComplete is called when generation is complete. + + The TrackableId of the mesh you wish to generate. + The Mesh to write the results into. + (Optional) The MeshCollider to populate with physics data. This may be null. + The vertex attributes you'd like to use. + The delegate to invoke when the generation completes. + + + + Get information about every mesh tracked by the system. + + A List of MeshInfos to be filled. Passing null will throw an ArgumentNullException. + + True if the List was populated. + + + + + Information about an XRMeshSubsystem. + + + + + Provides methods, events, and properties that provides information about planes detected in the environment. + + + + + Get all the BoundedPlanes currently tracked by the system. + + A list of BoundedPlanes containing all planes currently tracked by the system. + + + + The frame during which the planes were last updated. + + + + + Raised for each BoundedPlane that has been added in the current frame. + + + + + + Raised for each BoundedPlane that has been removed in the current frame. + + + + + + Raised for each plane that has been updated in the current frame. + + + + + + Get a BoundedPlane by TrackableId + + The session-unique TrackableId of the plane to get. + The BoundedPlane with the supplied planeId + + True if the BoundedPlane with planeId exists, false otherwise. + + + + + Try to retrieve a list of positions in device space describing the current plane boundary. + + The session-unique TrackableId of the plane. + A list of vertices representing the plane's boundary. + + True if the plane exists (i.e., is still being tracked), otherwise false. + + + + + Class providing information about XRPlaneSubsystem registration. + + + + + Structure describing the result of a XRRaycastSubsystem.Raycast hit. + + + + + The distance, in meters, from the screen to the hit's XRRaycastSubsystemHit.Position. + + + + + The TrackableType(s) that were hit. + + + + + The position and rotation of the hit result in device space where the ray hit the trackable. + + + + + The TrackableId of the trackable that was hit by the raycast. + + + + + Provides methods and properties that allow for querying portions of the physical environment that are near a provided specified ray. These trackables include planes and depth data. + + + + + Casts a ray from a screen point against selected trackables (e.g., planes and feature points). + + The screen point from which to cast. + The resulting list of XRRaycastHit. + An optional mask of TrackableType to raycast against. + + + + Casts a ray using ray against selected trackables (e.g., planes and feature points). + + The Ray to use. + The XRDepthSubsystem to raycast against. May be null. + The XRPlaneSubsystem to raycast against. May be null. + The resulting list of XRRaycastHit. + An optional mask of TrackableType to raycast against. + When raycasting against feature points, cast a cone with this angle. + + + + Class providing information about XRRaycastSubsystem registration. + + + + + Provides methods and properties that allow for querying, creating, and removing of reference points. These reference points are cues to the XRSessionSubsystem that indicate areas of interest in the environment which helps assure that tracking of these points remains accurate. + + + + + Retrieves all ReferencePoints added by calls to XRReferencePointSubsystem.TryAddReferencePoint. + + A list of ReferencePoints containing all reference points. + + + + The frame during which the reference points were last updated. + + + + + Raised each frame for each ReferencePoint that had the values of its position, rotation, or both changed enough by the device correcting its understanding of where the point should be located in Unity space. + + + + + + Attempt to add a ReferencePoint that gets tracked by the device. + + Current position, in device space, of a point you want the device to track. + Current rotation, in device space, of a point you want the device to track. + If this method returns true, this is filled out with the ID (unique to the session) of the point. + + If the ReferencePoint was added successfully, this method returns true. Otherwise, it returns false. + + + + + Attempt to add a ReferencePoint that gets tracked by the device. + + Current pose, in device space, of a point you want the device to track. + If this method returns true, this is filled out with the ID (unique to the session) of the point. + + If the ReferencePoint was added successfully, this method returns true. Otherwise, it returns false. + + + + + Attempt to retrieve a ReferencePoint. + + The ID of the ReferencePoint that TryAddReferencePoint filled out when you added this point. + The ReferencePoint to be filled out that matches the ID passed in. + + If the ReferencePoint was found and filled out successfully, this method returns true. Otherwise, it return false. + + + + + Attempt to remove a ReferencePoint getting tracked by the device. + + ID of the ReferencePoint you wish to remove so the device no longer tries to track it. + + If the ReferencePoint was removed successfully, this method returns true. Otherwise, it returns false. + + + + + Class providing information about XRReferencePointSubsystem registration. + + + + + A collection of methods and properties used to interact with and configure an XR session. + + + + + The frame during which the tracking state was last updated. + + + + + Get current tracking status of the device. + + + + + Raised when the TrackingState changes. + + + + + + Class providing information about XRSessionSubsystem registration. + + + + + Object that is used to resolve references to an ExposedReference field. + + + + + Creates a type whos value is resolvable at runtime. + + + + + The default value, in case the value cannot be resolved. + + + + + The name of the ExposedReference. + + + + + Gets the value of the reference by resolving it given the ExposedPropertyResolver context object. + + The ExposedPropertyResolver context object. + + The resolved reference value. + + + + + Spectrum analysis windowing types. + + + + + W[n] = 0.42 - (0.5 * COS(nN) ) + (0.08 * COS(2.0 * nN) ). + + + + + W[n] = 0.35875 - (0.48829 * COS(1.0 * nN)) + (0.14128 * COS(2.0 * nN)) - (0.01168 * COS(3.0 * n/N)). + + + + + W[n] = 0.54 - (0.46 * COS(n/N) ). + + + + + W[n] = 0.5 * (1.0 - COS(n/N) ). + + + + + W[n] = 1.0. + + + + + W[n] = TRI(2n/N). + + + + + Filtering mode for textures. Corresponds to the settings in a. + + + + + Bilinear filtering - texture samples are averaged. + + + + + Point filtering - texture pixels become blocky up close. + + + + + Trilinear filtering - texture samples are averaged and also blended between mipmap levels. + + + + + Enumeration of all the muscles in a finger. + + + + + The distal close-open muscle. + + + + + The intermediate close-open muscle. + + + + + The last value of the FingerDof enum. + + + + + The proximal down-up muscle. + + + + + The proximal in-out muscle. + + + + + The Fixed joint groups together 2 rigidbodies, making them stick together in their bound position. + + + + + Connects two Rigidbody2D together at their anchor points using a configurable spring. + + + + + The amount by which the spring force is reduced in proportion to the movement speed. + + + + + The frequency at which the spring oscillates around the distance between the objects. + + + + + The angle referenced between the two bodies used as the constraint for the joint. + + + + + A flare asset. Read more about flares in the. + + + + + FlareLayer component. + + + + + Used by GUIUtility.GetControlID to inform the IMGUI system if a given control can get keyboard focus. This allows the IMGUI system to give focus appropriately when a user presses tab for cycling between controls. + + + + + This control can receive keyboard focus. + + + + + This control can not receive keyboard focus. + + + + + Fog mode to use. + + + + + Exponential fog. + + + + + Exponential squared fog (default). + + + + + Linear fog. + + + + + Script interface for. + + + + + The ascent of the font. + + + + + Access an array of all characters contained in the font texture. + + + + + Is the font a dynamic font. + + + + + The default size of the font. + + + + + The line height of the font. + + + + + The material used for the font display. + + + + + Set a function to be called when the dynamic font texture is rebuilt. + + + + + + Creates a Font object which lets you render a font installed on the user machine. + + The name of the OS font to use for this font object. + The default character size of the generated font. + Am array of names of OS fonts to use for this font object. When rendering characters using this font object, the first font which is installed on the machine, which contains the requested character will be used. + + The generate Font object. + + + + + Creates a Font object which lets you render a font installed on the user machine. + + The name of the OS font to use for this font object. + The default character size of the generated font. + Am array of names of OS fonts to use for this font object. When rendering characters using this font object, the first font which is installed on the machine, which contains the requested character will be used. + + The generate Font object. + + + + + Create a new Font. + + The name of the created Font object. + + + + Create a new Font. + + The name of the created Font object. + + + + Get rendering info for a specific character. + + The character you need rendering information for. + Returns the CharacterInfo struct with the rendering information for the character (if available). + The size of the character (default value of zero will use font default size). + The style of the character. + + + + Get rendering info for a specific character. + + The character you need rendering information for. + Returns the CharacterInfo struct with the rendering information for the character (if available). + The size of the character (default value of zero will use font default size). + The style of the character. + + + + Get rendering info for a specific character. + + The character you need rendering information for. + Returns the CharacterInfo struct with the rendering information for the character (if available). + The size of the character (default value of zero will use font default size). + The style of the character. + + + + Returns the maximum number of verts that the text generator may return for a given string. + + Input string. + + + + Get names of fonts installed on the machine. + + + An array of the names of all fonts installed on the machine. + + + + + Get the paths of OS installed fonts. + + + An array of the pathes of all fonts installed on the machine. + + + + + Does this font have a specific character? + + The character to check for. + + Whether or not the font has the character specified. + + + + + Request characters to be added to the font texture (dynamic fonts only). + + The characters which are needed to be in the font texture. + The size of the requested characters (the default value of zero will use the font's default size). + The style of the requested characters. + + + + Font Style applied to GUI Texts, Text Meshes or GUIStyles. + + + + + Bold style applied to your texts. + + + + + Bold and Italic styles applied to your texts. + + + + + Italic style applied to your texts. + + + + + No special style is applied. + + + + + Use ForceMode to specify how to apply a force using Rigidbody.AddForce. + + + + + Add a continuous acceleration to the rigidbody, ignoring its mass. + + + + + Add a continuous force to the rigidbody, using its mass. + + + + + Add an instant force impulse to the rigidbody, using its mass. + + + + + Add an instant velocity change to the rigidbody, ignoring its mass. + + + + + Option for how to apply a force using Rigidbody2D.AddForce. + + + + + Add a force to the Rigidbody2D, using its mass. + + + + + Add an instant force impulse to the rigidbody2D, using its mass. + + + + + Struct containing basic FrameTimings and accompanying relevant data. + + + + + The CPU time for a given frame, in ms. + + + + + This is the CPU clock time at the point GPU finished rendering the frame and interrupted the CPU. + + + + + This is the CPU clock time at the point Present was called for the current frame. + + + + + The GPU time for a given frame, in ms. + + + + + This was the height scale factor of the Dynamic Resolution system(if used) for the given frame and the linked frame timings. + + + + + This was the vsync mode for the given frame and the linked frame timings. + + + + + This was the width scale factor of the Dynamic Resolution system(if used) for the given frame and the linked frame timings. + + + + + The FrameTimingManager allows the user to capture and access FrameTiming data for multple frames. + + + + + This function triggers the FrameTimingManager to capture a snapshot of FrameTiming's data, that can then be accessed by the user. + + + + + This returns the frequency of CPU timer on the current platform, used to interpret timing results. If the platform does not support returning this value it will return 0. + + + CPU timer frequency for current platform. + + + + + This returns the frequency of GPU timer on the current platform, used to interpret timing results. If the platform does not support returning this value it will return 0. + + + GPU timer frequency for current platform. + + + + + Allows the user to access the currently captured FrameTimings. + + User supplies a desired number of frames they would like FrameTimings for. This should be equal to or less than the maximum FrameTimings the platform can capture. + An array of FrameTiming structs that is passed in by the user and will be filled with data as requested. It is the users job to make sure the array that is passed is large enough to hold the requested number of FrameTimings. + + Returns the number of FrameTimings it actually was able to get. This will always be equal to or less than the requested numFrames depending on availability of captured FrameTimings. + + + + + This returns the number of vsyncs per second on the current platform, used to interpret timing results. If the platform does not support returning this value it will return 0. + + + Number of vsyncs per second of the current platform. + + + + + Applies both force and torque to reduce both the linear and angular velocities to zero. + + + + + The maximum force that can be generated when trying to maintain the friction joint constraint. + + + + + The maximum torque that can be generated when trying to maintain the friction joint constraint. + + + + + This struct contains the view space coordinates of the near projection plane. + + + + + Position in view space of the bottom side of the near projection plane. + + + + + Position in view space of the left side of the near projection plane. + + + + + Position in view space of the right side of the near projection plane. + + + + + Position in view space of the top side of the near projection plane. + + + + + Z distance from the origin of view space to the far projection plane. + + + + + Z distance from the origin of view space to the near projection plane. + + + + + Platform agnostic fullscreen mode. Not all platforms support all modes. + + + + + Exclusive Mode. + + + + + Fullscreen window. + + + + + Maximized window. + + + + + Windowed. + + + + + Describes options for displaying movie playback controls. + + + + + Do not display any controls, but cancel movie playback if input occurs. + + + + + Display the standard controls for controlling movie playback. + + + + + Do not display any controls. + + + + + Display minimal set of controls controlling movie playback. + + + + + Describes scaling modes for displaying movies. + + + + + Scale the movie until the movie fills the entire screen. + + + + + Scale the movie until one dimension fits on the screen exactly. + + + + + Scale the movie until both dimensions fit the screen exactly. + + + + + Do not scale the movie. + + + + + Base class for all entities in Unity Scenes. + + + + + Defines whether the GameObject is active in the Scene. + + + + + The local active state of this GameObject. (Read Only) + + + + + The Animation attached to this GameObject (Read Only). (Null if there is none attached). + + + + + The AudioSource attached to this GameObject (Read Only). (Null if there is none attached). + + + + + The Camera attached to this GameObject (Read Only). (Null if there is none attached). + + + + + The Collider attached to this GameObject (Read Only). (Null if there is none attached). + + + + + The Collider2D component attached to this object. + + + + + The ConstantForce attached to this GameObject (Read Only). (Null if there is none attached). + + + + + The GUIText attached to this GameObject (Read Only). (Null if there is none attached). + + + + + The GUITexture attached to this GameObject (Read Only). (Null if there is none attached). + + + + + The HingeJoint attached to this GameObject (Read Only). (Null if there is none attached). + + + + + Editor only API that specifies if a game object is static. + + + + + The layer the game object is in. + + + + + The Light attached to this GameObject (Read Only). (Null if there is none attached). + + + + + The NetworkView attached to this GameObject (Read Only). (Null if there is none attached). + + + + + The ParticleSystem attached to this GameObject (Read Only). (Null if there is none attached). + + + + + The Renderer attached to this GameObject (Read Only). (Null if there is none attached). + + + + + The Rigidbody attached to this GameObject (Read Only). (Null if there is none attached). + + + + + The Rigidbody2D component attached to this GameObject. (Read Only) + + + + + Scene that the GameObject is part of. + + + + + The tag of this game object. + + + + + The Transform attached to this GameObject. + + + + + Adds a component class named className to the game object. + + + + + + Adds a component class of type componentType to the game object. C# Users can use a generic version. + + + + + + Generic version. See the page for more details. + + + + + Calls the method named methodName on every MonoBehaviour in this game object or any of its children. + + + + + + + + Calls the method named methodName on every MonoBehaviour in this game object or any of its children. + + + + + + + + Calls the method named methodName on every MonoBehaviour in this game object or any of its children. + + + + + + + + + + + + + + + Is this game object tagged with tag ? + + The tag to compare. + + + + Creates a game object with a primitive mesh renderer and appropriate collider. + + The type of primitive object to create. + + + + Creates a new game object, named name. + + The name that the GameObject is created with. + A list of Components to add to the GameObject on creation. + + + + Creates a new game object, named name. + + The name that the GameObject is created with. + A list of Components to add to the GameObject on creation. + + + + Creates a new game object, named name. + + The name that the GameObject is created with. + A list of Components to add to the GameObject on creation. + + + + Finds a GameObject by name and returns it. + + + + + + Returns a list of active GameObjects tagged tag. Returns empty array if no GameObject was found. + + The name of the tag to search GameObjects for. + + + + Returns one active GameObject tagged tag. Returns null if no GameObject was found. + + The tag to search for. + + + + Returns the component of Type type if the game object has one attached, null if it doesn't. + + The type of Component to retrieve. + + + + Generic version. See the page for more details. + + + + + Returns the component with name type if the game object has one attached, null if it doesn't. + + The type of Component to retrieve. + + + + Returns the component of Type type in the GameObject or any of its children using depth first search. + + The type of Component to retrieve. + + + A component of the matching type, if found. + + + + + Returns the component of Type type in the GameObject or any of its children using depth first search. + + The type of Component to retrieve. + + + A component of the matching type, if found. + + + + + Generic version. See the page for more details. + + + + A component of the matching type, if found. + + + + + Generic version. See the page for more details. + + + + A component of the matching type, if found. + + + + + Returns the component of Type type in the GameObject or any of its parents. + + Type of component to find. + + + + Returns the component <T> in the GameObject or any of its parents. + + + + + Returns all components of Type type in the GameObject. + + The type of Component to retrieve. + + + + Generic version. See the page for more details. + + + + + Returns all components of Type type in the GameObject into List results. Note that results is of type Component, not the type of the component retrieved. + + The type of Component to retrieve. + List to receive the results. + + + + Returns all components of Type type in the GameObject into List results. + + List of type T to receive the results. + + + + Returns all components of Type type in the GameObject or any of its children. + + The type of Component to retrieve. + Should Components on inactive GameObjects be included in the found set? + + + + Returns all components of Type type in the GameObject or any of its children. + + The type of Component to retrieve. + Should Components on inactive GameObjects be included in the found set? + + + + Generic version. See the page for more details. + + Should inactive GameObjects be included in the found set? + + A list of all found components matching the specified type. + + + + + Generic version. See the page for more details. + + Should inactive GameObjects be included in the found set? + + A list of all found components matching the specified type. + + + + + Return all found Components into List results. + + List to receive found Components. + Should inactive GameObjects be included in the found set? + + + + Return all found Components into List results. + + List to receive found Components. + Should inactive GameObjects be included in the found set? + + + + Returns all components of Type type in the GameObject or any of its parents. + + The type of Component to retrieve. + Should inactive Components be included in the found set? + + + + Generic version. See the page for more details. + + Should inactive Components be included in the found set? + + + + Generic version. See the page for more details. + + Should inactive Components be included in the found set? + + + + Find Components in GameObject or parents, and return them in List results. + + Should inactive Components be included in the found set? + List holding the found Components. + + + + Calls the method named methodName on every MonoBehaviour in this game object. + + The name of the method to call. + An optional parameter value to pass to the called method. + Should an error be raised if the method doesn't exist on the target object? + + + + Calls the method named methodName on every MonoBehaviour in this game object. + + The name of the method to call. + An optional parameter value to pass to the called method. + Should an error be raised if the method doesn't exist on the target object? + + + + Calls the method named methodName on every MonoBehaviour in this game object. + + The name of the method to call. + An optional parameter value to pass to the called method. + Should an error be raised if the method doesn't exist on the target object? + + + + + + + + + + + Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour. + + The name of the method to call. + An optional parameter value to pass to the called method. + Should an error be raised if the method doesn't exist on the target object? + + + + Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour. + + The name of the method to call. + An optional parameter value to pass to the called method. + Should an error be raised if the method doesn't exist on the target object? + + + + Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour. + + The name of the method to call. + An optional parameter value to pass to the called method. + Should an error be raised if the method doesn't exist on the target object? + + + + + + + + + + + ActivatesDeactivates the GameObject, depending on the given true or false/ value. + + Activate or deactivate the object, where true activates the GameObject and false deactivates the GameObject. + + + + Utility class for common geometric functions. + + + + + Calculates the bounding box from the given array of positions and the transformation matrix. + + An array that stores the location of 3d positions. + A matrix that changes the position, rotation and size of the bounds calculation. + + Calculates the axis-aligned bounding box. + + + + + Calculates frustum planes. + + The camera with the view frustum that you want to calculate planes from. + + The planes that form the camera's view frustum. + + + + + Calculates frustum planes. + + The camera with the view frustum that you want to calculate planes from. + An array of 6 Planes that will be overwritten with the calculated plane values. + + + + Calculates frustum planes. + + A matrix that transforms from world space to projection space, from which the planes will be calculated. + + The planes that enclose the projection space described by the matrix. + + + + + Calculates frustum planes. + + A matrix that transforms from world space to projection space, from which the planes will be calculated. + An array of 6 Planes that will be overwritten with the calculated plane values. + + + + Returns true if bounds are inside the plane array. + + + + + + + Creates a plane from a given list of vertices. Works for concave polygons and polygons that have multiple aligned vertices. + + An array of vertex positions that define the shape of a polygon. + If successful, a valid plane that goes through all the vertices. + + Returns true on success, false if the algorithm failed to create a plane from the given vertices. + + + + + Gizmos are used to give visual debugging or setup aids in the Scene view. + + + + + Sets the color for the gizmos that will be drawn next. + + + + + Sets the Matrix4x4 that the Unity Editor uses to draw Gizmos. + + + + + Draw a solid box with center and size. + + + + + + + Draw a camera frustum using the currently set Gizmos.matrix for it's location and rotation. + + The apex of the truncated pyramid. + Vertical field of view (ie, the angle at the apex in degrees). + Distance of the frustum's far plane. + Distance of the frustum's near plane. + Width/height ratio. + + + + Draw a texture in the Scene. + + The size and position of the texture on the "screen" defined by the XY plane. + The texture to be displayed. + An optional material to apply the texture. + Inset from the rectangle's left edge. + Inset from the rectangle's right edge. + Inset from the rectangle's top edge. + Inset from the rectangle's bottom edge. + + + + Draw a texture in the Scene. + + The size and position of the texture on the "screen" defined by the XY plane. + The texture to be displayed. + An optional material to apply the texture. + Inset from the rectangle's left edge. + Inset from the rectangle's right edge. + Inset from the rectangle's top edge. + Inset from the rectangle's bottom edge. + + + + Draw a texture in the Scene. + + The size and position of the texture on the "screen" defined by the XY plane. + The texture to be displayed. + An optional material to apply the texture. + Inset from the rectangle's left edge. + Inset from the rectangle's right edge. + Inset from the rectangle's top edge. + Inset from the rectangle's bottom edge. + + + + Draw a texture in the Scene. + + The size and position of the texture on the "screen" defined by the XY plane. + The texture to be displayed. + An optional material to apply the texture. + Inset from the rectangle's left edge. + Inset from the rectangle's right edge. + Inset from the rectangle's top edge. + Inset from the rectangle's bottom edge. + + + + Draw an icon at a position in the Scene view. + + + + + + + + Draw an icon at a position in the Scene view. + + + + + + + + Draws a line starting at from towards to. + + + + + + + Draws a mesh. + + Mesh to draw as a gizmo. + Position (default is zero). + Rotation (default is no rotation). + Scale (default is no scale). + Submesh to draw (default is -1, which draws whole mesh). + + + + Draws a mesh. + + Mesh to draw as a gizmo. + Position (default is zero). + Rotation (default is no rotation). + Scale (default is no scale). + Submesh to draw (default is -1, which draws whole mesh). + + + + Draws a ray starting at from to from + direction. + + + + + + + + Draws a ray starting at from to from + direction. + + + + + + + + Draws a solid sphere with center and radius. + + + + + + + Draw a wireframe box with center and size. + + + + + + + Draws a wireframe mesh. + + Mesh to draw as a gizmo. + Position (default is zero). + Rotation (default is no rotation). + Scale (default is no scale). + Submesh to draw (default is -1, which draws whole mesh). + + + + Draws a wireframe mesh. + + Mesh to draw as a gizmo. + Position (default is zero). + Rotation (default is no rotation). + Scale (default is no scale). + Submesh to draw (default is -1, which draws whole mesh). + + + + Draws a wireframe sphere with center and radius. + + + + + + + Low-level graphics library. + + + + + Select whether to invert the backface culling (true) or not (false). + + + + + The current modelview matrix. + + + + + Controls whether Linear-to-sRGB color conversion is performed while rendering. + + + + + Should rendering be done in wireframe? + + + + + Begin drawing 3D primitives. + + Primitives to draw: can be TRIANGLES, TRIANGLE_STRIP, QUADS or LINES. + + + + Clear the current render buffer. + + Should the depth buffer be cleared? + Should the color buffer be cleared? + The color to clear with, used only if clearColor is true. + The depth to clear Z buffer with, used only if clearDepth is true. + + + + Clear the current render buffer with camera's skybox. + + Should the depth buffer be cleared? + Camera to get projection parameters and skybox from. + + + + Sets current vertex color. + + + + + + End drawing 3D primitives. + + + + + Sends queued-up commands in the driver's command buffer to the GPU. + + + + + Compute GPU projection matrix from camera's projection matrix. + + Source projection matrix. + Will this projection be used for rendering into a RenderTexture? + + Adjusted projection matrix for the current graphics API. + + + + + Invalidate the internally cached render state. + + + + + Send a user-defined event to a native code plugin. + + User defined id to send to the callback. + Native code callback to queue for Unity's renderer to invoke. + + + + Send a user-defined event to a native code plugin. + + User defined id to send to the callback. + Native code callback to queue for Unity's renderer to invoke. + + + + Mode for Begin: draw line strip. + + + + + Mode for Begin: draw lines. + + + + + Load the identity matrix to the current modelview matrix. + + + + + Helper function to set up an ortho perspective transform. + + + + + Setup a matrix for pixel-correct rendering. + + + + + Setup a matrix for pixel-correct rendering. + + + + + + + + + Load an arbitrary matrix to the current projection matrix. + + + + + + Sets current texture coordinate (v.x,v.y,v.z) to the actual texture unit. + + + + + + + Sets current texture coordinate (x,y) for the actual texture unit. + + + + + + + + Sets current texture coordinate (x,y,z) to the actual texture unit. + + + + + + + + + Sets the current modelview matrix to the one specified. + + + + + + Restores both projection and modelview matrices off the top of the matrix stack. + + + + + Saves both projection and modelview matrices to the matrix stack. + + + + + Mode for Begin: draw quads. + + + + + Resolves the render target for subsequent operations sampling from it. + + + + + Sets current texture coordinate (v.x,v.y,v.z) for all texture units. + + + + + + Sets current texture coordinate (x,y) for all texture units. + + + + + + + Sets current texture coordinate (x,y,z) for all texture units. + + + + + + + + Mode for Begin: draw triangle strip. + + + + + Mode for Begin: draw triangles. + + + + + Submit a vertex. + + + + + + Submit a vertex. + + + + + + + + Set the rendering viewport. + + + + + + Gradient used for animating colors. + + + + + All alpha keys defined in the gradient. + + + + + All color keys defined in the gradient. + + + + + Control how the gradient is evaluated. + + + + + Create a new Gradient object. + + + + + Calculate color at a given time. + + Time of the key (0 - 1). + + + + Setup Gradient with an array of color keys and alpha keys. + + Color keys of the gradient (maximum 8 color keys). + Alpha keys of the gradient (maximum 8 alpha keys). + + + + Alpha key used by Gradient. + + + + + Alpha channel of key. + + + + + Time of the key (0 - 1). + + + + + Gradient alpha key. + + Alpha of key (0 - 1). + Time of the key (0 - 1). + + + + Color key used by Gradient. + + + + + Color of key. + + + + + Time of the key (0 - 1). + + + + + Gradient color key. + + Color of key. + Time of the key (0 - 1). + + + + + Select how gradients will be evaluated. + + + + + Find the 2 keys adjacent to the requested evaluation time, and linearly interpolate between them to obtain a blended color. + + + + + Return a fixed color, by finding the first key whose time value is greater than the requested evaluation time. + + + + + Attribute used to configure the usage of the GradientField and Gradient Editor for a gradient. + + + + + If set to true the Gradient uses HDR colors. + + + + + Attribute for Gradient fields. Used for configuring the GUI for the Gradient Editor. + + Set to true if the colors should be treated as HDR colors (default value: false). + + + + Raw interface to Unity's drawing functions. + + + + + Currently active color buffer (Read Only). + + + + + Returns the currently active color gamut. + + + + + Currently active depth/stencil buffer (Read Only). + + + + + Graphics Tier classification for current device. +Changing this value affects any subsequently loaded shaders. Initially this value is auto-detected from the hardware in use. + + + + + Copies source texture into destination render texture with a shader. + + Source texture. + The destination RenderTexture. Set this to null to blit directly to screen. See description for more information. + Material to use. Material's shader could do some post-processing effect, for example. + If -1 (default), draws all passes in the material. Otherwise, draws given pass only. + Offset applied to the source texture coordinate. + Scale applied to the source texture coordinate. + + + + Copies source texture into destination render texture with a shader. + + Source texture. + The destination RenderTexture. Set this to null to blit directly to screen. See description for more information. + Material to use. Material's shader could do some post-processing effect, for example. + If -1 (default), draws all passes in the material. Otherwise, draws given pass only. + Offset applied to the source texture coordinate. + Scale applied to the source texture coordinate. + + + + Copies source texture into destination render texture with a shader. + + Source texture. + The destination RenderTexture. Set this to null to blit directly to screen. See description for more information. + Material to use. Material's shader could do some post-processing effect, for example. + If -1 (default), draws all passes in the material. Otherwise, draws given pass only. + Offset applied to the source texture coordinate. + Scale applied to the source texture coordinate. + + + + Copies source texture into destination render texture with a shader. + + Source texture. + The destination RenderTexture. Set this to null to blit directly to screen. See description for more information. + Material to use. Material's shader could do some post-processing effect, for example. + If -1 (default), draws all passes in the material. Otherwise, draws given pass only. + Offset applied to the source texture coordinate. + Scale applied to the source texture coordinate. + + + + Copies source texture into destination, for multi-tap shader. + + Source texture. + Destination RenderTexture, or null to blit directly to screen. + Material to use for copying. Material's shader should do some post-processing effect. + Variable number of filtering offsets. Offsets are given in pixels. + + + + Clear random write targets for level pixel shaders. + + + + + This function provides an efficient way to convert between textures of different formats and dimensions. +The destination texture format should be uncompressed and correspond to a supported RenderTextureFormat. + + Source texture. + Destination texture. + Source element (e.g. cubemap face). Set this to 0 for 2d source textures. + Destination element (e.g. cubemap face or texture array element). + + True if the call succeeded. + + + + + This function provides an efficient way to convert between textures of different formats and dimensions. +The destination texture format should be uncompressed and correspond to a supported RenderTextureFormat. + + Source texture. + Destination texture. + Source element (e.g. cubemap face). Set this to 0 for 2d source textures. + Destination element (e.g. cubemap face or texture array element). + + True if the call succeeded. + + + + + Copy texture contents. + + Source texture. + Destination texture. + Source texture element (cubemap face, texture array layer or 3D texture depth slice). + Source texture mipmap level. + Destination texture element (cubemap face, texture array layer or 3D texture depth slice). + Destination texture mipmap level. + X coordinate of source texture region to copy (left side is zero). + Y coordinate of source texture region to copy (bottom is zero). + Width of source texture region to copy. + Height of source texture region to copy. + X coordinate of where to copy region in destination texture (left side is zero). + Y coordinate of where to copy region in destination texture (bottom is zero). + + + + Copy texture contents. + + Source texture. + Destination texture. + Source texture element (cubemap face, texture array layer or 3D texture depth slice). + Source texture mipmap level. + Destination texture element (cubemap face, texture array layer or 3D texture depth slice). + Destination texture mipmap level. + X coordinate of source texture region to copy (left side is zero). + Y coordinate of source texture region to copy (bottom is zero). + Width of source texture region to copy. + Height of source texture region to copy. + X coordinate of where to copy region in destination texture (left side is zero). + Y coordinate of where to copy region in destination texture (bottom is zero). + + + + Copy texture contents. + + Source texture. + Destination texture. + Source texture element (cubemap face, texture array layer or 3D texture depth slice). + Source texture mipmap level. + Destination texture element (cubemap face, texture array layer or 3D texture depth slice). + Destination texture mipmap level. + X coordinate of source texture region to copy (left side is zero). + Y coordinate of source texture region to copy (bottom is zero). + Width of source texture region to copy. + Height of source texture region to copy. + X coordinate of where to copy region in destination texture (left side is zero). + Y coordinate of where to copy region in destination texture (bottom is zero). + + + + Creates a GPUFence which will be passed after the last Blit, Clear, Draw, Dispatch or Texture Copy command prior to this call has been completed on the GPU. + + On some platforms there is a significant gap between the vertex processing completing and the pixel processing begining for a given draw call. This parameter allows for the fence to be passed after either the vertex or pixel processing for the proceeding draw has completed. If a compute shader dispatch was the last task submitted then this parameter is ignored. + + Returns a new GPUFence. + + + + + Draw a mesh. + + The Mesh to draw. + Position of the mesh. + Rotation of the mesh. + Transformation matrix of the mesh (combines position, rotation and other transformations). + Material to use. + to use. + If null (default), the mesh will be drawn in all cameras. Otherwise it will be rendered in the given camera only. + Which subset of the mesh to draw. This applies only to meshes that are composed of several materials. + Additional material properties to apply onto material just before this mesh will be drawn. See MaterialPropertyBlock. + Determines whether the mesh can cast shadows. + Determines whether the mesh can receive shadows. + Should the mesh use light probes? + If used, the mesh will use this Transform's position to sample light probes and find the matching reflection probe. + LightProbeUsage for the mesh. + + + + + Draw a mesh. + + The Mesh to draw. + Position of the mesh. + Rotation of the mesh. + Transformation matrix of the mesh (combines position, rotation and other transformations). + Material to use. + to use. + If null (default), the mesh will be drawn in all cameras. Otherwise it will be rendered in the given camera only. + Which subset of the mesh to draw. This applies only to meshes that are composed of several materials. + Additional material properties to apply onto material just before this mesh will be drawn. See MaterialPropertyBlock. + Determines whether the mesh can cast shadows. + Determines whether the mesh can receive shadows. + Should the mesh use light probes? + If used, the mesh will use this Transform's position to sample light probes and find the matching reflection probe. + LightProbeUsage for the mesh. + + + + + Draw a mesh. + + The Mesh to draw. + Position of the mesh. + Rotation of the mesh. + Transformation matrix of the mesh (combines position, rotation and other transformations). + Material to use. + to use. + If null (default), the mesh will be drawn in all cameras. Otherwise it will be rendered in the given camera only. + Which subset of the mesh to draw. This applies only to meshes that are composed of several materials. + Additional material properties to apply onto material just before this mesh will be drawn. See MaterialPropertyBlock. + Determines whether the mesh can cast shadows. + Determines whether the mesh can receive shadows. + Should the mesh use light probes? + If used, the mesh will use this Transform's position to sample light probes and find the matching reflection probe. + LightProbeUsage for the mesh. + + + + + Draw a mesh. + + The Mesh to draw. + Position of the mesh. + Rotation of the mesh. + Transformation matrix of the mesh (combines position, rotation and other transformations). + Material to use. + to use. + If null (default), the mesh will be drawn in all cameras. Otherwise it will be rendered in the given camera only. + Which subset of the mesh to draw. This applies only to meshes that are composed of several materials. + Additional material properties to apply onto material just before this mesh will be drawn. See MaterialPropertyBlock. + Determines whether the mesh can cast shadows. + Determines whether the mesh can receive shadows. + Should the mesh use light probes? + If used, the mesh will use this Transform's position to sample light probes and find the matching reflection probe. + LightProbeUsage for the mesh. + + + + + Draw a mesh. + + The Mesh to draw. + Position of the mesh. + Rotation of the mesh. + Transformation matrix of the mesh (combines position, rotation and other transformations). + Material to use. + to use. + If null (default), the mesh will be drawn in all cameras. Otherwise it will be rendered in the given camera only. + Which subset of the mesh to draw. This applies only to meshes that are composed of several materials. + Additional material properties to apply onto material just before this mesh will be drawn. See MaterialPropertyBlock. + Determines whether the mesh can cast shadows. + Determines whether the mesh can receive shadows. + Should the mesh use light probes? + If used, the mesh will use this Transform's position to sample light probes and find the matching reflection probe. + LightProbeUsage for the mesh. + + + + + Draw the same mesh multiple times using GPU instancing. + + The Mesh to draw. + Which subset of the mesh to draw. This applies only to meshes that are composed of several materials. + Material to use. + The array of object transformation matrices. + The number of instances to be drawn. + Additional material properties to apply. See MaterialPropertyBlock. + Should the meshes cast shadows? + Should the meshes receive shadows? + to use. + If null (default), the mesh will be drawn in all cameras. Otherwise it will be drawn in the given camera only. + LightProbeUsage for the instances. + + + + + Draw the same mesh multiple times using GPU instancing. + + The Mesh to draw. + Which subset of the mesh to draw. This applies only to meshes that are composed of several materials. + Material to use. + The array of object transformation matrices. + The number of instances to be drawn. + Additional material properties to apply. See MaterialPropertyBlock. + Should the meshes cast shadows? + Should the meshes receive shadows? + to use. + If null (default), the mesh will be drawn in all cameras. Otherwise it will be drawn in the given camera only. + LightProbeUsage for the instances. + + + + + Draw the same mesh multiple times using GPU instancing. + + The Mesh to draw. + Which subset of the mesh to draw. This applies only to meshes that are composed of several materials. + Material to use. + The bounding volume surrounding the instances you intend to draw. + The GPU buffer containing the arguments for how many instances of this mesh to draw. + The byte offset into the buffer, where the draw arguments start. + Additional material properties to apply. See MaterialPropertyBlock. + Determines whether the mesh can cast shadows. + Determines whether the mesh can receive shadows. + to use. + If null (default), the mesh will be drawn in all cameras. Otherwise it will be drawn in the given camera only. + LightProbeUsage for the instances. + + + + + Draw a mesh immediately. + + The Mesh to draw. + Position of the mesh. + Rotation of the mesh. + Transformation matrix of the mesh (combines position, rotation and other transformations). Note that the mesh will not be displayed correctly if matrix has negative scale. + Subset of the mesh to draw. + + + + Draw a mesh immediately. + + The Mesh to draw. + Position of the mesh. + Rotation of the mesh. + Transformation matrix of the mesh (combines position, rotation and other transformations). Note that the mesh will not be displayed correctly if matrix has negative scale. + Subset of the mesh to draw. + + + + Draw a mesh immediately. + + The Mesh to draw. + Position of the mesh. + Rotation of the mesh. + Transformation matrix of the mesh (combines position, rotation and other transformations). Note that the mesh will not be displayed correctly if matrix has negative scale. + Subset of the mesh to draw. + + + + Draw a mesh immediately. + + The Mesh to draw. + Position of the mesh. + Rotation of the mesh. + Transformation matrix of the mesh (combines position, rotation and other transformations). Note that the mesh will not be displayed correctly if matrix has negative scale. + Subset of the mesh to draw. + + + + Draws a fully procedural geometry on the GPU. + + + + + + + + Draws a fully procedural geometry on the GPU. + + Topology of the procedural geometry. + Buffer with draw arguments. + Byte offset where in the buffer the draw arguments are. + + + + Draw a texture in screen coordinates. + + Rectangle on the screen to use for the texture. In pixel coordinates with (0,0) in the upper-left corner. + Texture to draw. + Region of the texture to use. In normalized coordinates with (0,0) in the bottom-left corner. + Number of pixels from the left that are not affected by scale. + Number of pixels from the right that are not affected by scale. + Number of pixels from the top that are not affected by scale. + Number of pixels from the bottom that are not affected by scale. + Color that modulates the output. The neutral value is (0.5, 0.5, 0.5, 0.5). Set as vertex color for the shader. + Custom Material that can be used to draw the texture. If null is passed, a default material with the Internal-GUITexture.shader is used. + If -1 (default), draws all passes in the material. Otherwise, draws given pass only. + + + + Draw a texture in screen coordinates. + + Rectangle on the screen to use for the texture. In pixel coordinates with (0,0) in the upper-left corner. + Texture to draw. + Region of the texture to use. In normalized coordinates with (0,0) in the bottom-left corner. + Number of pixels from the left that are not affected by scale. + Number of pixels from the right that are not affected by scale. + Number of pixels from the top that are not affected by scale. + Number of pixels from the bottom that are not affected by scale. + Color that modulates the output. The neutral value is (0.5, 0.5, 0.5, 0.5). Set as vertex color for the shader. + Custom Material that can be used to draw the texture. If null is passed, a default material with the Internal-GUITexture.shader is used. + If -1 (default), draws all passes in the material. Otherwise, draws given pass only. + + + + Draw a texture in screen coordinates. + + Rectangle on the screen to use for the texture. In pixel coordinates with (0,0) in the upper-left corner. + Texture to draw. + Region of the texture to use. In normalized coordinates with (0,0) in the bottom-left corner. + Number of pixels from the left that are not affected by scale. + Number of pixels from the right that are not affected by scale. + Number of pixels from the top that are not affected by scale. + Number of pixels from the bottom that are not affected by scale. + Color that modulates the output. The neutral value is (0.5, 0.5, 0.5, 0.5). Set as vertex color for the shader. + Custom Material that can be used to draw the texture. If null is passed, a default material with the Internal-GUITexture.shader is used. + If -1 (default), draws all passes in the material. Otherwise, draws given pass only. + + + + Draw a texture in screen coordinates. + + Rectangle on the screen to use for the texture. In pixel coordinates with (0,0) in the upper-left corner. + Texture to draw. + Region of the texture to use. In normalized coordinates with (0,0) in the bottom-left corner. + Number of pixels from the left that are not affected by scale. + Number of pixels from the right that are not affected by scale. + Number of pixels from the top that are not affected by scale. + Number of pixels from the bottom that are not affected by scale. + Color that modulates the output. The neutral value is (0.5, 0.5, 0.5, 0.5). Set as vertex color for the shader. + Custom Material that can be used to draw the texture. If null is passed, a default material with the Internal-GUITexture.shader is used. + If -1 (default), draws all passes in the material. Otherwise, draws given pass only. + + + + Draw a texture in screen coordinates. + + Rectangle on the screen to use for the texture. In pixel coordinates with (0,0) in the upper-left corner. + Texture to draw. + Region of the texture to use. In normalized coordinates with (0,0) in the bottom-left corner. + Number of pixels from the left that are not affected by scale. + Number of pixels from the right that are not affected by scale. + Number of pixels from the top that are not affected by scale. + Number of pixels from the bottom that are not affected by scale. + Color that modulates the output. The neutral value is (0.5, 0.5, 0.5, 0.5). Set as vertex color for the shader. + Custom Material that can be used to draw the texture. If null is passed, a default material with the Internal-GUITexture.shader is used. + If -1 (default), draws all passes in the material. Otherwise, draws given pass only. + + + + Draw a texture in screen coordinates. + + Rectangle on the screen to use for the texture. In pixel coordinates with (0,0) in the upper-left corner. + Texture to draw. + Region of the texture to use. In normalized coordinates with (0,0) in the bottom-left corner. + Number of pixels from the left that are not affected by scale. + Number of pixels from the right that are not affected by scale. + Number of pixels from the top that are not affected by scale. + Number of pixels from the bottom that are not affected by scale. + Color that modulates the output. The neutral value is (0.5, 0.5, 0.5, 0.5). Set as vertex color for the shader. + Custom Material that can be used to draw the texture. If null is passed, a default material with the Internal-GUITexture.shader is used. + If -1 (default), draws all passes in the material. Otherwise, draws given pass only. + + + + Draw a texture in screen coordinates. + + Rectangle on the screen to use for the texture. In pixel coordinates with (0,0) in the upper-left corner. + Texture to draw. + Region of the texture to use. In normalized coordinates with (0,0) in the bottom-left corner. + Number of pixels from the left that are not affected by scale. + Number of pixels from the right that are not affected by scale. + Number of pixels from the top that are not affected by scale. + Number of pixels from the bottom that are not affected by scale. + Color that modulates the output. The neutral value is (0.5, 0.5, 0.5, 0.5). Set as vertex color for the shader. + Custom Material that can be used to draw the texture. If null is passed, a default material with the Internal-GUITexture.shader is used. + If -1 (default), draws all passes in the material. Otherwise, draws given pass only. + + + + Draw a texture in screen coordinates. + + Rectangle on the screen to use for the texture. In pixel coordinates with (0,0) in the upper-left corner. + Texture to draw. + Region of the texture to use. In normalized coordinates with (0,0) in the bottom-left corner. + Number of pixels from the left that are not affected by scale. + Number of pixels from the right that are not affected by scale. + Number of pixels from the top that are not affected by scale. + Number of pixels from the bottom that are not affected by scale. + Color that modulates the output. The neutral value is (0.5, 0.5, 0.5, 0.5). Set as vertex color for the shader. + Custom Material that can be used to draw the texture. If null is passed, a default material with the Internal-GUITexture.shader is used. + If -1 (default), draws all passes in the material. Otherwise, draws given pass only. + + + + Execute a command buffer. + + The buffer to execute. + + + + Executes a command buffer on an async compute queue with the queue selected based on the ComputeQueueType parameter passed. + +It is required that all of the commands within the command buffer be of a type suitable for execution on the async compute queues. If the buffer contains any commands that are not appropriate then an error will be logged and displayed in the editor window. Specifically the following commands are permitted in a CommandBuffer intended for async execution: + +CommandBuffer.BeginSample + +CommandBuffer.CopyCounterValue + +CommandBuffer.CopyTexture + +CommandBuffer.CreateGPUFence + +CommandBuffer.DispatchCompute + +CommandBuffer.EndSample + +CommandBuffer.IssuePluginEvent + +CommandBuffer.SetComputeBufferParam + +CommandBuffer.SetComputeFloatParam + +CommandBuffer.SetComputeFloatParams + +CommandBuffer.SetComputeTextureParam + +CommandBuffer.SetComputeVectorParam + +CommandBuffer.WaitOnGPUFence + +All of the commands within the buffer are guaranteed to be executed on the same queue. If the target platform does not support async compute queues then the work is dispatched on the graphics queue. + + The CommandBuffer to be executed. + Describes the desired async compute queue the suuplied CommandBuffer should be executed on. + + + + Set random write target for level pixel shaders. + + Index of the random write target in the shader. + RenderTexture to set as write target. + Whether to leave the append/consume counter value unchanged. + + + + Set random write target for level pixel shaders. + + Index of the random write target in the shader. + RenderTexture to set as write target. + Whether to leave the append/consume counter value unchanged. + + + + Sets current render target. + + RenderTexture to set as active render target. + Mipmap level to render into (use 0 if not mipmapped). + Cubemap face to render into (use Unknown if not a cubemap). + Depth slice to render into (use 0 if not a 3D or 2DArray render target). + Color buffer to render into. + Depth buffer to render into. + Color buffers to render into (for multiple render target effects). + Full render target setup information. + + + + Sets current render target. + + RenderTexture to set as active render target. + Mipmap level to render into (use 0 if not mipmapped). + Cubemap face to render into (use Unknown if not a cubemap). + Depth slice to render into (use 0 if not a 3D or 2DArray render target). + Color buffer to render into. + Depth buffer to render into. + Color buffers to render into (for multiple render target effects). + Full render target setup information. + + + + Sets current render target. + + RenderTexture to set as active render target. + Mipmap level to render into (use 0 if not mipmapped). + Cubemap face to render into (use Unknown if not a cubemap). + Depth slice to render into (use 0 if not a 3D or 2DArray render target). + Color buffer to render into. + Depth buffer to render into. + Color buffers to render into (for multiple render target effects). + Full render target setup information. + + + + Sets current render target. + + RenderTexture to set as active render target. + Mipmap level to render into (use 0 if not mipmapped). + Cubemap face to render into (use Unknown if not a cubemap). + Depth slice to render into (use 0 if not a 3D or 2DArray render target). + Color buffer to render into. + Depth buffer to render into. + Color buffers to render into (for multiple render target effects). + Full render target setup information. + + + + Instructs the GPU's processing of the graphics queue to wait until the given GPUFence is passed. + + The GPUFence that the GPU will be instructed to wait upon before proceeding with its processing of the graphics queue. + On some platforms there is a significant gap between the vertex processing completing and the pixel processing begining for a given draw call. This parameter allows for requested wait to be before the next items vertex or pixel processing begins. If a compute shader dispatch is the next item to be submitted then this parameter is ignored. + + + + Grid is the base class for plotting a layout of uniformly spaced points and lines. + + + + + The size of the gap between each cell in the Grid. + + + + + The layout of the cells in the Grid. + + + + + The size of each cell in the Grid. + + + + + The cell swizzle for the Grid. + + + + + Get the logical center coordinate of a grid cell in local space. + + Grid cell position. + + Center of the cell transformed into local space coordinates. + + + + + Get the logical center coordinate of a grid cell in world space. + + Grid cell position. + + Center of the cell transformed into world space coordinates. + + + + + Does the inverse swizzle of the given position for given swizzle order. + + Determines the rearrangement order for the inverse swizzle. + Position to inverse swizzle. + + The inversed swizzled position. + + + + + Swizzles the given position with the given swizzle order. + + Determines the rearrangement order for the swizzle. + Position to swizzle. + + The swizzled position. + + + + + Base class for authoring data on a grid with grid painting tools like paint, erase, pick, select and fill. + + + + + Erases data on a grid within the given bounds. + + Grid used for layout. + Target of the erase operation. By default the currently selected GameObject. + The bounds to erase data from. + + + + Box fills tiles and GameObjects into given bounds within the selected layers. + + Grid used for layout. + Target of box fill operation. By default the currently selected GameObject. + The bounds to box fill data to. + + + + Changes the Z position of the GridBrushBase. + + Modify the Z position of GridBrushBase by this value. + + + + Erases data on a grid within the given bounds. + + Grid used for layout. + Target of the erase operation. By default the currently selected GameObject. + The coordinates of the cell to erase data from. + + + + + Flips the grid brush in the given FlipAxis. + + Axis to flip by. + CellLayout for flipping. + + + + Axis to flip tiles in the GridBrushBase by. + + + + + Flip the brush in the X Axis. + + + + + Flip the brush in the Y Axis. + + + + + Flood fills data onto a grid given the starting coordinates of the cell. + + Grid used for layout. + Targets of flood fill operation. By default the currently selected GameObject. + Starting position of the flood fill. + + + + Move is called when user moves the area previously selected with the selection marquee. + + Grid used for layout. + Target of the move operation. By default the currently selected GameObject. + Source bounds of the move. + Target bounds of the move. + + + + + MoveEnd is called when user has ended the move of the area previously selected with the selection marquee. + + Layers affected by the move operation. + Target of the move operation. By default the currently selected GameObject. + Grid used for layout. + + + + + MoveEnd is called when user starts moving the area previously selected with the selection marquee. + + Grid used for layout. + Target of the move operation. By default the currently selected GameObject. + Position where the move operation has started. + + + + + Paints data into a grid within the given bounds. + + Grid used for layout. + Target of the paint operation. By default the currently selected GameObject. + The coordinates of the cell to paint data to. + + + + + Picks data from a grid given the coordinates of the cells. + + Grid used for layout. + Target of the paint operation. By default the currently selected GameObject. + The coordinates of the cells to paint data from. + Pivot of the picking brush. + + + + + Resets Z position changes of the GridBrushBase. + + + + + Rotates all tiles on the grid brush with the given RotationDirection. + + Direction to rotate by. + CellLayout for rotating. + + + + Direction to rotate tiles in the GridBrushBase by. + + + + + Rotates tiles clockwise. + + + + + Rotates tiles counter-clockwise. + + + + + Select an area of a grid. + + Grid used for layout. + Targets of paint operation. By default the currently selected GameObject. + Area to get selected. + + + + + Tool mode for the GridBrushBase. + + + + + Box Fill. + + + + + Erase. + + + + + Flood Fill. + + + + + Move. + + + + + Paint. + + + + + Pick. + + + + + Select. + + + + + An abstract class that defines a grid layout. + + + + + The size of the gap between each cell in the layout. + + + + + The layout of the cells. + + + + + The size of each cell in the layout. + + + + + The cell swizzle for the layout. + + + + + The layout of the GridLayout. + + + + + Hexagonal layout for cells in the GridLayout. + + + + + Isometric layout for cells in the GridLayout. + + + + + Isometric layout for cells in the GridLayout where any Z cell value set will be added as a Y value. + + + + + Rectangular layout for cells in the GridLayout. + + + + + Swizzles cell positions to other positions. + + + + + Keeps the cell positions at XYZ. + + + + + Swizzles the cell positions from XYZ to XZY. + + + + + Swizzles the cell positions from XYZ to YXZ. + + + + + Swizzles the cell positions from XYZ to YZX. + + + + + Swizzles the cell positions from XYZ to ZXY. + + + + + Swizzles the cell positions from XYZ to ZYX. + + + + + Converts a cell position to local position space. + + Cell position to convert. + + Local position of the cell position. + + + + + Converts an interpolated cell position in floats to local position space. + + Interpolated cell position to convert. + + Local position of the cell position. + + + + + Converts a cell position to world position space. + + Cell position to convert. + + World position of the cell position. + + + + + Returns the local bounds for a cell at the location. + + Location of the cell. + + Local bounds of cell at the location. + + + + + Returns the local bounds for the groups of cells at the location. + + Origin of the group of cells. + Size of the group of cells. + + Local bounds of the group of cells at the location. + + + + + Get the default center coordinate of a cell for the set layout of the Grid. + + + Cell Center coordinate. + + + + + Converts a local position to cell position. + + Local Position to convert. + + Cell position of the local position. + + + + + Converts a local position to cell position. + + Local Position to convert. + + Interpolated cell position of the local position. + + + + + Converts a local position to world position. + + Local Position to convert. + + World position of the local position. + + + + + Converts a world position to cell position. + + World Position to convert. + + Cell position of the world position. + + + + + Converts a world position to local position. + + World Position to convert. + + Local position of the world position. + + + + + The GUI class is the interface for Unity's GUI with manual positioning. + + + + + Global tinting color for all background elements rendered by the GUI. + + + + + Returns true if any controls changed the value of the input data. + + + + + Global tinting color for the GUI. + + + + + Tinting color for all text rendered by the GUI. + + + + + The sorting depth of the currently executing GUI behaviour. + + + + + Is the GUI enabled? + + + + + The GUI transform matrix. + + + + + The global skin to use. + + + + + The tooltip of the control the mouse is currently over, or which has keyboard focus. (Read Only). + + + + + Begin a group. Must be matched with a call to EndGroup. + + Rectangle on the screen to use for the group. + Text to display on the group. + Texture to display on the group. + Text, image and tooltip for this group. If supplied, any mouse clicks are "captured" by the group and not If left out, no background is rendered, and mouse clicks are passed. + The style to use for the background. + + + + Begin a group. Must be matched with a call to EndGroup. + + Rectangle on the screen to use for the group. + Text to display on the group. + Texture to display on the group. + Text, image and tooltip for this group. If supplied, any mouse clicks are "captured" by the group and not If left out, no background is rendered, and mouse clicks are passed. + The style to use for the background. + + + + Begin a group. Must be matched with a call to EndGroup. + + Rectangle on the screen to use for the group. + Text to display on the group. + Texture to display on the group. + Text, image and tooltip for this group. If supplied, any mouse clicks are "captured" by the group and not If left out, no background is rendered, and mouse clicks are passed. + The style to use for the background. + + + + Begin a group. Must be matched with a call to EndGroup. + + Rectangle on the screen to use for the group. + Text to display on the group. + Texture to display on the group. + Text, image and tooltip for this group. If supplied, any mouse clicks are "captured" by the group and not If left out, no background is rendered, and mouse clicks are passed. + The style to use for the background. + + + + Begin a group. Must be matched with a call to EndGroup. + + Rectangle on the screen to use for the group. + Text to display on the group. + Texture to display on the group. + Text, image and tooltip for this group. If supplied, any mouse clicks are "captured" by the group and not If left out, no background is rendered, and mouse clicks are passed. + The style to use for the background. + + + + Begin a group. Must be matched with a call to EndGroup. + + Rectangle on the screen to use for the group. + Text to display on the group. + Texture to display on the group. + Text, image and tooltip for this group. If supplied, any mouse clicks are "captured" by the group and not If left out, no background is rendered, and mouse clicks are passed. + The style to use for the background. + + + + Begin a group. Must be matched with a call to EndGroup. + + Rectangle on the screen to use for the group. + Text to display on the group. + Texture to display on the group. + Text, image and tooltip for this group. If supplied, any mouse clicks are "captured" by the group and not If left out, no background is rendered, and mouse clicks are passed. + The style to use for the background. + + + + Begin a group. Must be matched with a call to EndGroup. + + Rectangle on the screen to use for the group. + Text to display on the group. + Texture to display on the group. + Text, image and tooltip for this group. If supplied, any mouse clicks are "captured" by the group and not If left out, no background is rendered, and mouse clicks are passed. + The style to use for the background. + + + + Begin a scrolling view inside your GUI. + + Rectangle on the screen to use for the ScrollView. + The pixel distance that the view is scrolled in the X and Y directions. + The rectangle used inside the scrollview. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + Optional parameter to always show the horizontal scrollbar. If false or left out, it is only shown when viewRect is wider than position. + Optional parameter to always show the vertical scrollbar. If false or left out, it is only shown when viewRect is taller than position. + + The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. + + + + + Begin a scrolling view inside your GUI. + + Rectangle on the screen to use for the ScrollView. + The pixel distance that the view is scrolled in the X and Y directions. + The rectangle used inside the scrollview. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + Optional parameter to always show the horizontal scrollbar. If false or left out, it is only shown when viewRect is wider than position. + Optional parameter to always show the vertical scrollbar. If false or left out, it is only shown when viewRect is taller than position. + + The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. + + + + + Begin a scrolling view inside your GUI. + + Rectangle on the screen to use for the ScrollView. + The pixel distance that the view is scrolled in the X and Y directions. + The rectangle used inside the scrollview. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + Optional parameter to always show the horizontal scrollbar. If false or left out, it is only shown when viewRect is wider than position. + Optional parameter to always show the vertical scrollbar. If false or left out, it is only shown when viewRect is taller than position. + + The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. + + + + + Begin a scrolling view inside your GUI. + + Rectangle on the screen to use for the ScrollView. + The pixel distance that the view is scrolled in the X and Y directions. + The rectangle used inside the scrollview. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + Optional parameter to always show the horizontal scrollbar. If false or left out, it is only shown when viewRect is wider than position. + Optional parameter to always show the vertical scrollbar. If false or left out, it is only shown when viewRect is taller than position. + + The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. + + + + + Create a Box on the GUI Layer. + + Rectangle on the screen to use for the box. + Text to display on the box. + Texture to display on the box. + Text, image and tooltip for this box. + The style to use. If left out, the box style from the current GUISkin is used. + + + + Create a Box on the GUI Layer. + + Rectangle on the screen to use for the box. + Text to display on the box. + Texture to display on the box. + Text, image and tooltip for this box. + The style to use. If left out, the box style from the current GUISkin is used. + + + + Create a Box on the GUI Layer. + + Rectangle on the screen to use for the box. + Text to display on the box. + Texture to display on the box. + Text, image and tooltip for this box. + The style to use. If left out, the box style from the current GUISkin is used. + + + + Create a Box on the GUI Layer. + + Rectangle on the screen to use for the box. + Text to display on the box. + Texture to display on the box. + Text, image and tooltip for this box. + The style to use. If left out, the box style from the current GUISkin is used. + + + + Create a Box on the GUI Layer. + + Rectangle on the screen to use for the box. + Text to display on the box. + Texture to display on the box. + Text, image and tooltip for this box. + The style to use. If left out, the box style from the current GUISkin is used. + + + + Create a Box on the GUI Layer. + + Rectangle on the screen to use for the box. + Text to display on the box. + Texture to display on the box. + Text, image and tooltip for this box. + The style to use. If left out, the box style from the current GUISkin is used. + + + + Bring a specific window to back of the floating windows. + + The identifier used when you created the window in the Window call. + + + + Bring a specific window to front of the floating windows. + + The identifier used when you created the window in the Window call. + + + + Make a single press button. The user clicks them and something happens immediately. + + Rectangle on the screen to use for the button. + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the button style from the current GUISkin is used. + + true when the users clicks the button. + + + + + Make a single press button. The user clicks them and something happens immediately. + + Rectangle on the screen to use for the button. + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the button style from the current GUISkin is used. + + true when the users clicks the button. + + + + + Make a single press button. The user clicks them and something happens immediately. + + Rectangle on the screen to use for the button. + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the button style from the current GUISkin is used. + + true when the users clicks the button. + + + + + Make a single press button. The user clicks them and something happens immediately. + + Rectangle on the screen to use for the button. + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the button style from the current GUISkin is used. + + true when the users clicks the button. + + + + + Make a single press button. The user clicks them and something happens immediately. + + Rectangle on the screen to use for the button. + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the button style from the current GUISkin is used. + + true when the users clicks the button. + + + + + Make a single press button. The user clicks them and something happens immediately. + + Rectangle on the screen to use for the button. + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the button style from the current GUISkin is used. + + true when the users clicks the button. + + + + + Make a window draggable. + + The part of the window that can be dragged. This is clipped to the actual window. + + + + If you want to have the entire window background to act as a drag area, use the version of DragWindow that takes no parameters and put it at the end of the window function. + + + + + Draw a texture within a rectangle. + + Rectangle on the screen to draw the texture within. + Texture to display. + How to scale the image when the aspect ratio of it doesn't fit the aspect ratio to be drawn within. + Whether to apply alpha blending when drawing the image (enabled by default). + Aspect ratio to use for the source image. If 0 (the default), the aspect ratio from the image is used. Pass in w/h for the desired aspect ratio. This allows the aspect ratio of the source image to be adjusted without changing the pixel width and height. + + + + Draw a texture within a rectangle. + + Rectangle on the screen to draw the texture within. + Texture to display. + How to scale the image when the aspect ratio of it doesn't fit the aspect ratio to be drawn within. + Whether to apply alpha blending when drawing the image (enabled by default). + Aspect ratio to use for the source image. If 0 (the default), the aspect ratio from the image is used. Pass in w/h for the desired aspect ratio. This allows the aspect ratio of the source image to be adjusted without changing the pixel width and height. + + + + Draw a texture within a rectangle. + + Rectangle on the screen to draw the texture within. + Texture to display. + How to scale the image when the aspect ratio of it doesn't fit the aspect ratio to be drawn within. + Whether to apply alpha blending when drawing the image (enabled by default). + Aspect ratio to use for the source image. If 0 (the default), the aspect ratio from the image is used. Pass in w/h for the desired aspect ratio. This allows the aspect ratio of the source image to be adjusted without changing the pixel width and height. + + + + Draw a texture within a rectangle. + + Rectangle on the screen to draw the texture within. + Texture to display. + How to scale the image when the aspect ratio of it doesn't fit the aspect ratio to be drawn within. + Whether to apply alpha blending when drawing the image (enabled by default). + Aspect ratio to use for the source image. If 0 (the default), the aspect ratio from the image is used. Pass in w/h for the desired aspect ratio. This allows the aspect ratio of the source image to be adjusted without changing the pixel width and height. + + + + Draws a border with rounded corners within a rectangle. The texture is used to pattern the border. Note that this method only works on shader model 2.5 and above. + + Rectangle on the screen to draw the texture within. + Texture to display. + How to scale the image when the aspect ratio of it doesn't fit the aspect ratio to be drawn within. + Whether to apply alpha blending when drawing the image (enabled by default). + Aspect ratio to use for the source image. If 0 (the default), the aspect ratio from the image is used. Pass in w/h for the desired aspect ratio. This allows the aspect ratio of the source image to be adjusted without changing the pixel width and height. + A tint color to apply on the texture. + The width of the border. If 0, the full texture is drawn. + The width of the borders (left, top, right and bottom). If Vector4.zero, the full texture is drawn. + The radius for rounded corners. If 0, corners will not be rounded. + The radiuses for rounded corners (top-left, top-right, bottom-right and bottom-left). If Vector4.zero, corners will not be rounded. + + + + Draws a border with rounded corners within a rectangle. The texture is used to pattern the border. Note that this method only works on shader model 2.5 and above. + + Rectangle on the screen to draw the texture within. + Texture to display. + How to scale the image when the aspect ratio of it doesn't fit the aspect ratio to be drawn within. + Whether to apply alpha blending when drawing the image (enabled by default). + Aspect ratio to use for the source image. If 0 (the default), the aspect ratio from the image is used. Pass in w/h for the desired aspect ratio. This allows the aspect ratio of the source image to be adjusted without changing the pixel width and height. + A tint color to apply on the texture. + The width of the border. If 0, the full texture is drawn. + The width of the borders (left, top, right and bottom). If Vector4.zero, the full texture is drawn. + The radius for rounded corners. If 0, corners will not be rounded. + The radiuses for rounded corners (top-left, top-right, bottom-right and bottom-left). If Vector4.zero, corners will not be rounded. + + + + Draw a texture within a rectangle with the given texture coordinates. + + Rectangle on the screen to draw the texture within. + Texture to display. + How to scale the image when the aspect ratio of it doesn't fit the aspect ratio to be drawn within. + Whether to alpha blend the image on to the display (the default). If false, the picture is drawn on to the display. + + + + Draw a texture within a rectangle with the given texture coordinates. + + Rectangle on the screen to draw the texture within. + Texture to display. + How to scale the image when the aspect ratio of it doesn't fit the aspect ratio to be drawn within. + Whether to alpha blend the image on to the display (the default). If false, the picture is drawn on to the display. + + + + End a group. + + + + + Ends a scrollview started with a call to BeginScrollView. + + + + + + Ends a scrollview started with a call to BeginScrollView. + + + + + + Move keyboard focus to a named control. + + Name set using SetNextControlName. + + + + Make a window become the active window. + + The identifier used when you created the window in the Window call. + + + + Get the name of named control that has focus. + + + + + Disposable helper class for managing BeginGroup / EndGroup. + + + + + Create a new GroupScope and begin the corresponding group. + + Rectangle on the screen to use for the group. + Text to display on the group. + Texture to display on the group. + Text, image and tooltip for this group. If supplied, any mouse clicks are "captured" by the group and not If left out, no background is rendered, and mouse clicks are passed. + The style to use for the background. + + + + Create a new GroupScope and begin the corresponding group. + + Rectangle on the screen to use for the group. + Text to display on the group. + Texture to display on the group. + Text, image and tooltip for this group. If supplied, any mouse clicks are "captured" by the group and not If left out, no background is rendered, and mouse clicks are passed. + The style to use for the background. + + + + Create a new GroupScope and begin the corresponding group. + + Rectangle on the screen to use for the group. + Text to display on the group. + Texture to display on the group. + Text, image and tooltip for this group. If supplied, any mouse clicks are "captured" by the group and not If left out, no background is rendered, and mouse clicks are passed. + The style to use for the background. + + + + Create a new GroupScope and begin the corresponding group. + + Rectangle on the screen to use for the group. + Text to display on the group. + Texture to display on the group. + Text, image and tooltip for this group. If supplied, any mouse clicks are "captured" by the group and not If left out, no background is rendered, and mouse clicks are passed. + The style to use for the background. + + + + Create a new GroupScope and begin the corresponding group. + + Rectangle on the screen to use for the group. + Text to display on the group. + Texture to display on the group. + Text, image and tooltip for this group. If supplied, any mouse clicks are "captured" by the group and not If left out, no background is rendered, and mouse clicks are passed. + The style to use for the background. + + + + Create a new GroupScope and begin the corresponding group. + + Rectangle on the screen to use for the group. + Text to display on the group. + Texture to display on the group. + Text, image and tooltip for this group. If supplied, any mouse clicks are "captured" by the group and not If left out, no background is rendered, and mouse clicks are passed. + The style to use for the background. + + + + Create a new GroupScope and begin the corresponding group. + + Rectangle on the screen to use for the group. + Text to display on the group. + Texture to display on the group. + Text, image and tooltip for this group. If supplied, any mouse clicks are "captured" by the group and not If left out, no background is rendered, and mouse clicks are passed. + The style to use for the background. + + + + Make a horizontal scrollbar. Scrollbars are what you use to scroll through a document. Most likely, you want to use scrollViews instead. + + Rectangle on the screen to use for the scrollbar. + The position between min and max. + How much can we see? + The value at the left end of the scrollbar. + The value at the right end of the scrollbar. + The style to use for the scrollbar background. If left out, the horizontalScrollbar style from the current GUISkin is used. + + The modified value. This can be changed by the user by dragging the scrollbar, or clicking the arrows at the end. + + + + + Make a horizontal scrollbar. Scrollbars are what you use to scroll through a document. Most likely, you want to use scrollViews instead. + + Rectangle on the screen to use for the scrollbar. + The position between min and max. + How much can we see? + The value at the left end of the scrollbar. + The value at the right end of the scrollbar. + The style to use for the scrollbar background. If left out, the horizontalScrollbar style from the current GUISkin is used. + + The modified value. This can be changed by the user by dragging the scrollbar, or clicking the arrows at the end. + + + + + A horizontal slider the user can drag to change a value between a min and a max. + + Rectangle on the screen to use for the slider. + The value the slider shows. This determines the position of the draggable thumb. + The value at the left end of the slider. + The value at the right end of the slider. + The GUIStyle to use for displaying the dragging area. If left out, the horizontalSlider style from the current GUISkin is used. + The GUIStyle to use for displaying draggable thumb. If left out, the horizontalSliderThumb style from the current GUISkin is used. + + The value that has been set by the user. + + + + + A horizontal slider the user can drag to change a value between a min and a max. + + Rectangle on the screen to use for the slider. + The value the slider shows. This determines the position of the draggable thumb. + The value at the left end of the slider. + The value at the right end of the slider. + The GUIStyle to use for displaying the dragging area. If left out, the horizontalSlider style from the current GUISkin is used. + The GUIStyle to use for displaying draggable thumb. If left out, the horizontalSliderThumb style from the current GUISkin is used. + + The value that has been set by the user. + + + + + Make a text or texture label on screen. + + Rectangle on the screen to use for the label. + Text to display on the label. + Texture to display on the label. + Text, image and tooltip for this label. + The style to use. If left out, the label style from the current GUISkin is used. + + + + Make a text or texture label on screen. + + Rectangle on the screen to use for the label. + Text to display on the label. + Texture to display on the label. + Text, image and tooltip for this label. + The style to use. If left out, the label style from the current GUISkin is used. + + + + Make a text or texture label on screen. + + Rectangle on the screen to use for the label. + Text to display on the label. + Texture to display on the label. + Text, image and tooltip for this label. + The style to use. If left out, the label style from the current GUISkin is used. + + + + Make a text or texture label on screen. + + Rectangle on the screen to use for the label. + Text to display on the label. + Texture to display on the label. + Text, image and tooltip for this label. + The style to use. If left out, the label style from the current GUISkin is used. + + + + Make a text or texture label on screen. + + Rectangle on the screen to use for the label. + Text to display on the label. + Texture to display on the label. + Text, image and tooltip for this label. + The style to use. If left out, the label style from the current GUISkin is used. + + + + Make a text or texture label on screen. + + Rectangle on the screen to use for the label. + Text to display on the label. + Texture to display on the label. + Text, image and tooltip for this label. + The style to use. If left out, the label style from the current GUISkin is used. + + + + Show a Modal Window. + + A unique id number. + Position and size of the window. + A function which contains the immediate mode GUI code to draw the contents of your window. + Text to appear in the title-bar area of the window, if any. + An image to appear in the title bar of the window, if any. + GUIContent to appear in the title bar of the window, if any. + Style to apply to the window. + + + + Show a Modal Window. + + A unique id number. + Position and size of the window. + A function which contains the immediate mode GUI code to draw the contents of your window. + Text to appear in the title-bar area of the window, if any. + An image to appear in the title bar of the window, if any. + GUIContent to appear in the title bar of the window, if any. + Style to apply to the window. + + + + Show a Modal Window. + + A unique id number. + Position and size of the window. + A function which contains the immediate mode GUI code to draw the contents of your window. + Text to appear in the title-bar area of the window, if any. + An image to appear in the title bar of the window, if any. + GUIContent to appear in the title bar of the window, if any. + Style to apply to the window. + + + + Show a Modal Window. + + A unique id number. + Position and size of the window. + A function which contains the immediate mode GUI code to draw the contents of your window. + Text to appear in the title-bar area of the window, if any. + An image to appear in the title bar of the window, if any. + GUIContent to appear in the title bar of the window, if any. + Style to apply to the window. + + + + Show a Modal Window. + + A unique id number. + Position and size of the window. + A function which contains the immediate mode GUI code to draw the contents of your window. + Text to appear in the title-bar area of the window, if any. + An image to appear in the title bar of the window, if any. + GUIContent to appear in the title bar of the window, if any. + Style to apply to the window. + + + + Show a Modal Window. + + A unique id number. + Position and size of the window. + A function which contains the immediate mode GUI code to draw the contents of your window. + Text to appear in the title-bar area of the window, if any. + An image to appear in the title bar of the window, if any. + GUIContent to appear in the title bar of the window, if any. + Style to apply to the window. + + + + Show a Modal Window. + + A unique id number. + Position and size of the window. + A function which contains the immediate mode GUI code to draw the contents of your window. + Text to appear in the title-bar area of the window, if any. + An image to appear in the title bar of the window, if any. + GUIContent to appear in the title bar of the window, if any. + Style to apply to the window. + + + + Show a Modal Window. + + A unique id number. + Position and size of the window. + A function which contains the immediate mode GUI code to draw the contents of your window. + Text to appear in the title-bar area of the window, if any. + An image to appear in the title bar of the window, if any. + GUIContent to appear in the title bar of the window, if any. + Style to apply to the window. + + + + Make a text field where the user can enter a password. + + Rectangle on the screen to use for the text field. + Password to edit. The return value of this function should be assigned back to the string as shown in the example. + Character to mask the password with. + The maximum length of the string. If left out, the user can type for ever and ever. + The style to use. If left out, the textField style from the current GUISkin is used. + + The edited password. + + + + + Make a text field where the user can enter a password. + + Rectangle on the screen to use for the text field. + Password to edit. The return value of this function should be assigned back to the string as shown in the example. + Character to mask the password with. + The maximum length of the string. If left out, the user can type for ever and ever. + The style to use. If left out, the textField style from the current GUISkin is used. + + The edited password. + + + + + Make a text field where the user can enter a password. + + Rectangle on the screen to use for the text field. + Password to edit. The return value of this function should be assigned back to the string as shown in the example. + Character to mask the password with. + The maximum length of the string. If left out, the user can type for ever and ever. + The style to use. If left out, the textField style from the current GUISkin is used. + + The edited password. + + + + + Make a text field where the user can enter a password. + + Rectangle on the screen to use for the text field. + Password to edit. The return value of this function should be assigned back to the string as shown in the example. + Character to mask the password with. + The maximum length of the string. If left out, the user can type for ever and ever. + The style to use. If left out, the textField style from the current GUISkin is used. + + The edited password. + + + + + Make a button that is active as long as the user holds it down. + + Rectangle on the screen to use for the button. + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the button style from the current GUISkin is used. + + True when the users clicks the button. + + + + + Make a button that is active as long as the user holds it down. + + Rectangle on the screen to use for the button. + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the button style from the current GUISkin is used. + + True when the users clicks the button. + + + + + Make a button that is active as long as the user holds it down. + + Rectangle on the screen to use for the button. + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the button style from the current GUISkin is used. + + True when the users clicks the button. + + + + + Make a button that is active as long as the user holds it down. + + Rectangle on the screen to use for the button. + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the button style from the current GUISkin is used. + + True when the users clicks the button. + + + + + Make a button that is active as long as the user holds it down. + + Rectangle on the screen to use for the button. + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the button style from the current GUISkin is used. + + True when the users clicks the button. + + + + + Make a button that is active as long as the user holds it down. + + Rectangle on the screen to use for the button. + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the button style from the current GUISkin is used. + + True when the users clicks the button. + + + + + Scrolls all enclosing scrollviews so they try to make position visible. + + + + + + Disposable helper class for managing BeginScrollView / EndScrollView. + + + + + Whether this ScrollView should handle scroll wheel events. (default: true). + + + + + The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. + + + + + Create a new ScrollViewScope and begin the corresponding ScrollView. + + Rectangle on the screen to use for the ScrollView. + The pixel distance that the view is scrolled in the X and Y directions. + The rectangle used inside the scrollview. + Optional parameter to always show the horizontal scrollbar. If false or left out, it is only shown when clientRect is wider than position. + Optional parameter to always show the vertical scrollbar. If false or left out, it is only shown when clientRect is taller than position. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + + + + Create a new ScrollViewScope and begin the corresponding ScrollView. + + Rectangle on the screen to use for the ScrollView. + The pixel distance that the view is scrolled in the X and Y directions. + The rectangle used inside the scrollview. + Optional parameter to always show the horizontal scrollbar. If false or left out, it is only shown when clientRect is wider than position. + Optional parameter to always show the vertical scrollbar. If false or left out, it is only shown when clientRect is taller than position. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + + + + Create a new ScrollViewScope and begin the corresponding ScrollView. + + Rectangle on the screen to use for the ScrollView. + The pixel distance that the view is scrolled in the X and Y directions. + The rectangle used inside the scrollview. + Optional parameter to always show the horizontal scrollbar. If false or left out, it is only shown when clientRect is wider than position. + Optional parameter to always show the vertical scrollbar. If false or left out, it is only shown when clientRect is taller than position. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + + + + Create a new ScrollViewScope and begin the corresponding ScrollView. + + Rectangle on the screen to use for the ScrollView. + The pixel distance that the view is scrolled in the X and Y directions. + The rectangle used inside the scrollview. + Optional parameter to always show the horizontal scrollbar. If false or left out, it is only shown when clientRect is wider than position. + Optional parameter to always show the vertical scrollbar. If false or left out, it is only shown when clientRect is taller than position. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + + + + Make a grid of buttons. + + Rectangle on the screen to use for the grid. + The index of the selected grid button. + An array of strings to show on the grid buttons. + An array of textures on the grid buttons. + An array of text, image and tooltips for the grid button. + How many elements to fit in the horizontal direction. The controls will be scaled to fit unless the style defines a fixedWidth to use. + The style to use. If left out, the button style from the current GUISkin is used. + + + The index of the selected button. + + + + + Make a grid of buttons. + + Rectangle on the screen to use for the grid. + The index of the selected grid button. + An array of strings to show on the grid buttons. + An array of textures on the grid buttons. + An array of text, image and tooltips for the grid button. + How many elements to fit in the horizontal direction. The controls will be scaled to fit unless the style defines a fixedWidth to use. + The style to use. If left out, the button style from the current GUISkin is used. + + + The index of the selected button. + + + + + Make a grid of buttons. + + Rectangle on the screen to use for the grid. + The index of the selected grid button. + An array of strings to show on the grid buttons. + An array of textures on the grid buttons. + An array of text, image and tooltips for the grid button. + How many elements to fit in the horizontal direction. The controls will be scaled to fit unless the style defines a fixedWidth to use. + The style to use. If left out, the button style from the current GUISkin is used. + + + The index of the selected button. + + + + + Make a grid of buttons. + + Rectangle on the screen to use for the grid. + The index of the selected grid button. + An array of strings to show on the grid buttons. + An array of textures on the grid buttons. + An array of text, image and tooltips for the grid button. + How many elements to fit in the horizontal direction. The controls will be scaled to fit unless the style defines a fixedWidth to use. + The style to use. If left out, the button style from the current GUISkin is used. + + + The index of the selected button. + + + + + Make a grid of buttons. + + Rectangle on the screen to use for the grid. + The index of the selected grid button. + An array of strings to show on the grid buttons. + An array of textures on the grid buttons. + An array of text, image and tooltips for the grid button. + How many elements to fit in the horizontal direction. The controls will be scaled to fit unless the style defines a fixedWidth to use. + The style to use. If left out, the button style from the current GUISkin is used. + + + The index of the selected button. + + + + + Make a grid of buttons. + + Rectangle on the screen to use for the grid. + The index of the selected grid button. + An array of strings to show on the grid buttons. + An array of textures on the grid buttons. + An array of text, image and tooltips for the grid button. + How many elements to fit in the horizontal direction. The controls will be scaled to fit unless the style defines a fixedWidth to use. + The style to use. If left out, the button style from the current GUISkin is used. + + + The index of the selected button. + + + + + Set the name of the next control. + + + + + + Make a Multi-line text area where the user can edit a string. + + Rectangle on the screen to use for the text field. + Text to edit. The return value of this function should be assigned back to the string as shown in the example. + The maximum length of the string. If left out, the user can type for ever and ever. + The style to use. If left out, the textArea style from the current GUISkin is used. + + The edited string. + + + + + Make a Multi-line text area where the user can edit a string. + + Rectangle on the screen to use for the text field. + Text to edit. The return value of this function should be assigned back to the string as shown in the example. + The maximum length of the string. If left out, the user can type for ever and ever. + The style to use. If left out, the textArea style from the current GUISkin is used. + + The edited string. + + + + + Make a Multi-line text area where the user can edit a string. + + Rectangle on the screen to use for the text field. + Text to edit. The return value of this function should be assigned back to the string as shown in the example. + The maximum length of the string. If left out, the user can type for ever and ever. + The style to use. If left out, the textArea style from the current GUISkin is used. + + The edited string. + + + + + Make a Multi-line text area where the user can edit a string. + + Rectangle on the screen to use for the text field. + Text to edit. The return value of this function should be assigned back to the string as shown in the example. + The maximum length of the string. If left out, the user can type for ever and ever. + The style to use. If left out, the textArea style from the current GUISkin is used. + + The edited string. + + + + + Make a single-line text field where the user can edit a string. + + Rectangle on the screen to use for the text field. + Text to edit. The return value of this function should be assigned back to the string as shown in the example. + The maximum length of the string. If left out, the user can type for ever and ever. + The style to use. If left out, the textField style from the current GUISkin is used. + + The edited string. + + + + + Make a single-line text field where the user can edit a string. + + Rectangle on the screen to use for the text field. + Text to edit. The return value of this function should be assigned back to the string as shown in the example. + The maximum length of the string. If left out, the user can type for ever and ever. + The style to use. If left out, the textField style from the current GUISkin is used. + + The edited string. + + + + + Make a single-line text field where the user can edit a string. + + Rectangle on the screen to use for the text field. + Text to edit. The return value of this function should be assigned back to the string as shown in the example. + The maximum length of the string. If left out, the user can type for ever and ever. + The style to use. If left out, the textField style from the current GUISkin is used. + + The edited string. + + + + + Make a single-line text field where the user can edit a string. + + Rectangle on the screen to use for the text field. + Text to edit. The return value of this function should be assigned back to the string as shown in the example. + The maximum length of the string. If left out, the user can type for ever and ever. + The style to use. If left out, the textField style from the current GUISkin is used. + + The edited string. + + + + + Make an on/off toggle button. + + Rectangle on the screen to use for the button. + Is this button on or off? + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the toggle style from the current GUISkin is used. + + The new value of the button. + + + + + Make an on/off toggle button. + + Rectangle on the screen to use for the button. + Is this button on or off? + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the toggle style from the current GUISkin is used. + + The new value of the button. + + + + + Make an on/off toggle button. + + Rectangle on the screen to use for the button. + Is this button on or off? + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the toggle style from the current GUISkin is used. + + The new value of the button. + + + + + Make an on/off toggle button. + + Rectangle on the screen to use for the button. + Is this button on or off? + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the toggle style from the current GUISkin is used. + + The new value of the button. + + + + + Make an on/off toggle button. + + Rectangle on the screen to use for the button. + Is this button on or off? + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the toggle style from the current GUISkin is used. + + The new value of the button. + + + + + Make an on/off toggle button. + + Rectangle on the screen to use for the button. + Is this button on or off? + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the toggle style from the current GUISkin is used. + + The new value of the button. + + + + + Make a toolbar. + + Rectangle on the screen to use for the toolbar. + The index of the selected button. + An array of strings to show on the toolbar buttons. + An array of textures on the toolbar buttons. + An array of text, image and tooltips for the toolbar buttons. + The style to use. If left out, the button style from the current GUISkin is used. + Determines how toolbar button size is calculated. + + The index of the selected button. + + + + + Make a toolbar. + + Rectangle on the screen to use for the toolbar. + The index of the selected button. + An array of strings to show on the toolbar buttons. + An array of textures on the toolbar buttons. + An array of text, image and tooltips for the toolbar buttons. + The style to use. If left out, the button style from the current GUISkin is used. + Determines how toolbar button size is calculated. + + The index of the selected button. + + + + + Make a toolbar. + + Rectangle on the screen to use for the toolbar. + The index of the selected button. + An array of strings to show on the toolbar buttons. + An array of textures on the toolbar buttons. + An array of text, image and tooltips for the toolbar buttons. + The style to use. If left out, the button style from the current GUISkin is used. + Determines how toolbar button size is calculated. + + The index of the selected button. + + + + + Make a toolbar. + + Rectangle on the screen to use for the toolbar. + The index of the selected button. + An array of strings to show on the toolbar buttons. + An array of textures on the toolbar buttons. + An array of text, image and tooltips for the toolbar buttons. + The style to use. If left out, the button style from the current GUISkin is used. + Determines how toolbar button size is calculated. + + The index of the selected button. + + + + + Make a toolbar. + + Rectangle on the screen to use for the toolbar. + The index of the selected button. + An array of strings to show on the toolbar buttons. + An array of textures on the toolbar buttons. + An array of text, image and tooltips for the toolbar buttons. + The style to use. If left out, the button style from the current GUISkin is used. + Determines how toolbar button size is calculated. + + The index of the selected button. + + + + + Make a toolbar. + + Rectangle on the screen to use for the toolbar. + The index of the selected button. + An array of strings to show on the toolbar buttons. + An array of textures on the toolbar buttons. + An array of text, image and tooltips for the toolbar buttons. + The style to use. If left out, the button style from the current GUISkin is used. + Determines how toolbar button size is calculated. + + The index of the selected button. + + + + + Make a toolbar. + + Rectangle on the screen to use for the toolbar. + The index of the selected button. + An array of strings to show on the toolbar buttons. + An array of textures on the toolbar buttons. + An array of text, image and tooltips for the toolbar buttons. + The style to use. If left out, the button style from the current GUISkin is used. + Determines how toolbar button size is calculated. + + The index of the selected button. + + + + + Determines how toolbar button size is calculated. + + + + + The width of each toolbar button is calculated based on the width of its content. + + + + + Calculates the button size by dividing the available width by the number of buttons. The minimum size is the maximum content width. + + + + + Remove focus from all windows. + + + + + Make a vertical scrollbar. Scrollbars are what you use to scroll through a document. Most likely, you want to use scrollViews instead. + + Rectangle on the screen to use for the scrollbar. + The position between min and max. + How much can we see? + The value at the top of the scrollbar. + The value at the bottom of the scrollbar. + The style to use for the scrollbar background. If left out, the horizontalScrollbar style from the current GUISkin is used. + + The modified value. This can be changed by the user by dragging the scrollbar, or clicking the arrows at the end. + + + + + Make a vertical scrollbar. Scrollbars are what you use to scroll through a document. Most likely, you want to use scrollViews instead. + + Rectangle on the screen to use for the scrollbar. + The position between min and max. + How much can we see? + The value at the top of the scrollbar. + The value at the bottom of the scrollbar. + The style to use for the scrollbar background. If left out, the horizontalScrollbar style from the current GUISkin is used. + + The modified value. This can be changed by the user by dragging the scrollbar, or clicking the arrows at the end. + + + + + A vertical slider the user can drag to change a value between a min and a max. + + Rectangle on the screen to use for the slider. + The value the slider shows. This determines the position of the draggable thumb. + The value at the top end of the slider. + The value at the bottom end of the slider. + The GUIStyle to use for displaying the dragging area. If left out, the horizontalSlider style from the current GUISkin is used. + The GUIStyle to use for displaying draggable thumb. If left out, the horizontalSliderThumb style from the current GUISkin is used. + + The value that has been set by the user. + + + + + A vertical slider the user can drag to change a value between a min and a max. + + Rectangle on the screen to use for the slider. + The value the slider shows. This determines the position of the draggable thumb. + The value at the top end of the slider. + The value at the bottom end of the slider. + The GUIStyle to use for displaying the dragging area. If left out, the horizontalSlider style from the current GUISkin is used. + The GUIStyle to use for displaying draggable thumb. If left out, the horizontalSliderThumb style from the current GUISkin is used. + + The value that has been set by the user. + + + + + Make a popup window. + + An optional style to use for the window. If left out, the window style from the current GUISkin is used. + ID number for the window (can be any value as long as it is unique). + Onscreen rectangle denoting the window's position and size. + Script function to display the window's contents. + Text to render inside the window. + Image to render inside the window. + GUIContent to render inside the window. + Style information for the window. + Text displayed in the window's title bar. + + Onscreen rectangle denoting the window's position and size. + + + + + Make a popup window. + + An optional style to use for the window. If left out, the window style from the current GUISkin is used. + ID number for the window (can be any value as long as it is unique). + Onscreen rectangle denoting the window's position and size. + Script function to display the window's contents. + Text to render inside the window. + Image to render inside the window. + GUIContent to render inside the window. + Style information for the window. + Text displayed in the window's title bar. + + Onscreen rectangle denoting the window's position and size. + + + + + Make a popup window. + + An optional style to use for the window. If left out, the window style from the current GUISkin is used. + ID number for the window (can be any value as long as it is unique). + Onscreen rectangle denoting the window's position and size. + Script function to display the window's contents. + Text to render inside the window. + Image to render inside the window. + GUIContent to render inside the window. + Style information for the window. + Text displayed in the window's title bar. + + Onscreen rectangle denoting the window's position and size. + + + + + Make a popup window. + + An optional style to use for the window. If left out, the window style from the current GUISkin is used. + ID number for the window (can be any value as long as it is unique). + Onscreen rectangle denoting the window's position and size. + Script function to display the window's contents. + Text to render inside the window. + Image to render inside the window. + GUIContent to render inside the window. + Style information for the window. + Text displayed in the window's title bar. + + Onscreen rectangle denoting the window's position and size. + + + + + Make a popup window. + + An optional style to use for the window. If left out, the window style from the current GUISkin is used. + ID number for the window (can be any value as long as it is unique). + Onscreen rectangle denoting the window's position and size. + Script function to display the window's contents. + Text to render inside the window. + Image to render inside the window. + GUIContent to render inside the window. + Style information for the window. + Text displayed in the window's title bar. + + Onscreen rectangle denoting the window's position and size. + + + + + Make a popup window. + + An optional style to use for the window. If left out, the window style from the current GUISkin is used. + ID number for the window (can be any value as long as it is unique). + Onscreen rectangle denoting the window's position and size. + Script function to display the window's contents. + Text to render inside the window. + Image to render inside the window. + GUIContent to render inside the window. + Style information for the window. + Text displayed in the window's title bar. + + Onscreen rectangle denoting the window's position and size. + + + + + Callback to draw GUI within a window (used with GUI.Window). + + + + + + The contents of a GUI element. + + + + + The icon image contained. + + + + + Shorthand for empty content. + + + + + The text contained. + + + + + The tooltip of this element. + + + + + Constructor for GUIContent in all shapes and sizes. + + + + + Build a GUIContent object containing only text. + + + + + + Build a GUIContent object containing only an image. + + + + + + Build a GUIContent object containing both text and an image. + + + + + + + Build a GUIContent containing some text. When the user hovers the mouse over it, the global GUI.tooltip is set to the tooltip. + + + + + + + Build a GUIContent containing an image. When the user hovers the mouse over it, the global GUI.tooltip is set to the tooltip. + + + + + + + Build a GUIContent that contains both text, an image and has a tooltip defined. When the user hovers the mouse over it, the global GUI.tooltip is set to the tooltip. + + + + + + + + Build a GUIContent as a copy of another GUIContent. + + + + + + Base class for images & text strings displayed in a GUI. + + + + + Returns bounding rectangle of GUIElement in screen coordinates. + + + + + + Returns bounding rectangle of GUIElement in screen coordinates. + + + + + + Is a point on screen inside the element? + + + + + + + Is a point on screen inside the element? + + + + + + + Component added to a camera to make it render 2D GUI elements. + + + + + Get the GUI element at a specific screen position. + + + + + + The GUILayout class is the interface for Unity gui with automatic layout. + + + + + Disposable helper class for managing BeginArea / EndArea. + + + + + Create a new AreaScope and begin the corresponding Area. + + Optional text to display in the area. + Optional texture to display in the area. + Optional text, image and tooltip top display for this area. + The style to use. If left out, the empty GUIStyle (GUIStyle.none) is used, giving a transparent background. + + + + + Create a new AreaScope and begin the corresponding Area. + + Optional text to display in the area. + Optional texture to display in the area. + Optional text, image and tooltip top display for this area. + The style to use. If left out, the empty GUIStyle (GUIStyle.none) is used, giving a transparent background. + + + + + Create a new AreaScope and begin the corresponding Area. + + Optional text to display in the area. + Optional texture to display in the area. + Optional text, image and tooltip top display for this area. + The style to use. If left out, the empty GUIStyle (GUIStyle.none) is used, giving a transparent background. + + + + + Create a new AreaScope and begin the corresponding Area. + + Optional text to display in the area. + Optional texture to display in the area. + Optional text, image and tooltip top display for this area. + The style to use. If left out, the empty GUIStyle (GUIStyle.none) is used, giving a transparent background. + + + + + Create a new AreaScope and begin the corresponding Area. + + Optional text to display in the area. + Optional texture to display in the area. + Optional text, image and tooltip top display for this area. + The style to use. If left out, the empty GUIStyle (GUIStyle.none) is used, giving a transparent background. + + + + + Create a new AreaScope and begin the corresponding Area. + + Optional text to display in the area. + Optional texture to display in the area. + Optional text, image and tooltip top display for this area. + The style to use. If left out, the empty GUIStyle (GUIStyle.none) is used, giving a transparent background. + + + + + Create a new AreaScope and begin the corresponding Area. + + Optional text to display in the area. + Optional texture to display in the area. + Optional text, image and tooltip top display for this area. + The style to use. If left out, the empty GUIStyle (GUIStyle.none) is used, giving a transparent background. + + + + + Begin a GUILayout block of GUI controls in a fixed screen area. + + Optional text to display in the area. + Optional texture to display in the area. + Optional text, image and tooltip top display for this area. + The style to use. If left out, the empty GUIStyle (GUIStyle.none) is used, giving a transparent background. + + + + + Begin a GUILayout block of GUI controls in a fixed screen area. + + Optional text to display in the area. + Optional texture to display in the area. + Optional text, image and tooltip top display for this area. + The style to use. If left out, the empty GUIStyle (GUIStyle.none) is used, giving a transparent background. + + + + + Begin a GUILayout block of GUI controls in a fixed screen area. + + Optional text to display in the area. + Optional texture to display in the area. + Optional text, image and tooltip top display for this area. + The style to use. If left out, the empty GUIStyle (GUIStyle.none) is used, giving a transparent background. + + + + + Begin a GUILayout block of GUI controls in a fixed screen area. + + Optional text to display in the area. + Optional texture to display in the area. + Optional text, image and tooltip top display for this area. + The style to use. If left out, the empty GUIStyle (GUIStyle.none) is used, giving a transparent background. + + + + + Begin a GUILayout block of GUI controls in a fixed screen area. + + Optional text to display in the area. + Optional texture to display in the area. + Optional text, image and tooltip top display for this area. + The style to use. If left out, the empty GUIStyle (GUIStyle.none) is used, giving a transparent background. + + + + + Begin a GUILayout block of GUI controls in a fixed screen area. + + Optional text to display in the area. + Optional texture to display in the area. + Optional text, image and tooltip top display for this area. + The style to use. If left out, the empty GUIStyle (GUIStyle.none) is used, giving a transparent background. + + + + + Begin a GUILayout block of GUI controls in a fixed screen area. + + Optional text to display in the area. + Optional texture to display in the area. + Optional text, image and tooltip top display for this area. + The style to use. If left out, the empty GUIStyle (GUIStyle.none) is used, giving a transparent background. + + + + + Begin a GUILayout block of GUI controls in a fixed screen area. + + Optional text to display in the area. + Optional texture to display in the area. + Optional text, image and tooltip top display for this area. + The style to use. If left out, the empty GUIStyle (GUIStyle.none) is used, giving a transparent background. + + + + + Begin a Horizontal control group. + + Text to display on group. + Texture to display on group. + Text, image, and tooltip for this group. + The style to use for background image and padding values. If left out, the background is transparent. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Begin a Horizontal control group. + + Text to display on group. + Texture to display on group. + Text, image, and tooltip for this group. + The style to use for background image and padding values. If left out, the background is transparent. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Begin a Horizontal control group. + + Text to display on group. + Texture to display on group. + Text, image, and tooltip for this group. + The style to use for background image and padding values. If left out, the background is transparent. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Begin a Horizontal control group. + + Text to display on group. + Texture to display on group. + Text, image, and tooltip for this group. + The style to use for background image and padding values. If left out, the background is transparent. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Begin a Horizontal control group. + + Text to display on group. + Texture to display on group. + Text, image, and tooltip for this group. + The style to use for background image and padding values. If left out, the background is transparent. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Begin an automatically laid out scrollview. + + The position to use display. + Optional parameter to always show the horizontal scrollbar. If false or left out, it is only shown when the content inside the ScrollView is wider than the scrollview itself. + Optional parameter to always show the vertical scrollbar. If false or left out, it is only shown when content inside the ScrollView is taller than the scrollview itself. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + + + + + + + The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. + + + + + Begin an automatically laid out scrollview. + + The position to use display. + Optional parameter to always show the horizontal scrollbar. If false or left out, it is only shown when the content inside the ScrollView is wider than the scrollview itself. + Optional parameter to always show the vertical scrollbar. If false or left out, it is only shown when content inside the ScrollView is taller than the scrollview itself. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + + + + + + + The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. + + + + + Begin an automatically laid out scrollview. + + The position to use display. + Optional parameter to always show the horizontal scrollbar. If false or left out, it is only shown when the content inside the ScrollView is wider than the scrollview itself. + Optional parameter to always show the vertical scrollbar. If false or left out, it is only shown when content inside the ScrollView is taller than the scrollview itself. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + + + + + + + The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. + + + + + Begin an automatically laid out scrollview. + + The position to use display. + Optional parameter to always show the horizontal scrollbar. If false or left out, it is only shown when the content inside the ScrollView is wider than the scrollview itself. + Optional parameter to always show the vertical scrollbar. If false or left out, it is only shown when content inside the ScrollView is taller than the scrollview itself. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + + + + + + + The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. + + + + + Begin an automatically laid out scrollview. + + The position to use display. + Optional parameter to always show the horizontal scrollbar. If false or left out, it is only shown when the content inside the ScrollView is wider than the scrollview itself. + Optional parameter to always show the vertical scrollbar. If false or left out, it is only shown when content inside the ScrollView is taller than the scrollview itself. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + + + + + + + The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. + + + + + Begin an automatically laid out scrollview. + + The position to use display. + Optional parameter to always show the horizontal scrollbar. If false or left out, it is only shown when the content inside the ScrollView is wider than the scrollview itself. + Optional parameter to always show the vertical scrollbar. If false or left out, it is only shown when content inside the ScrollView is taller than the scrollview itself. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + + + + + + + The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. + + + + + Begin an automatically laid out scrollview. + + The position to use display. + Optional parameter to always show the horizontal scrollbar. If false or left out, it is only shown when the content inside the ScrollView is wider than the scrollview itself. + Optional parameter to always show the vertical scrollbar. If false or left out, it is only shown when content inside the ScrollView is taller than the scrollview itself. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + + + + + + + The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. + + + + + Begin a vertical control group. + + Text to display on group. + Texture to display on group. + Text, image, and tooltip for this group. + The style to use for background image and padding values. If left out, the background is transparent. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Begin a vertical control group. + + Text to display on group. + Texture to display on group. + Text, image, and tooltip for this group. + The style to use for background image and padding values. If left out, the background is transparent. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Begin a vertical control group. + + Text to display on group. + Texture to display on group. + Text, image, and tooltip for this group. + The style to use for background image and padding values. If left out, the background is transparent. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Begin a vertical control group. + + Text to display on group. + Texture to display on group. + Text, image, and tooltip for this group. + The style to use for background image and padding values. If left out, the background is transparent. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Begin a vertical control group. + + Text to display on group. + Texture to display on group. + Text, image, and tooltip for this group. + The style to use for background image and padding values. If left out, the background is transparent. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make an auto-layout box. + + Text to display on the box. + Texture to display on the box. + Text, image and tooltip for this box. + The style to use. If left out, the box style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make an auto-layout box. + + Text to display on the box. + Texture to display on the box. + Text, image and tooltip for this box. + The style to use. If left out, the box style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make an auto-layout box. + + Text to display on the box. + Texture to display on the box. + Text, image and tooltip for this box. + The style to use. If left out, the box style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make an auto-layout box. + + Text to display on the box. + Texture to display on the box. + Text, image and tooltip for this box. + The style to use. If left out, the box style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make an auto-layout box. + + Text to display on the box. + Texture to display on the box. + Text, image and tooltip for this box. + The style to use. If left out, the box style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make an auto-layout box. + + Text to display on the box. + Texture to display on the box. + Text, image and tooltip for this box. + The style to use. If left out, the box style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make a single press button. + + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + true when the users clicks the button. + + + + + Make a single press button. + + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + true when the users clicks the button. + + + + + Make a single press button. + + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + true when the users clicks the button. + + + + + Make a single press button. + + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + true when the users clicks the button. + + + + + Make a single press button. + + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + true when the users clicks the button. + + + + + Make a single press button. + + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + true when the users clicks the button. + + + + + Close a GUILayout block started with BeginArea. + + + + + Close a group started with BeginHorizontal. + + + + + End a scroll view begun with a call to BeginScrollView. + + + + + Close a group started with BeginVertical. + + + + + Option passed to a control to allow or disallow vertical expansion. + + + + + + Option passed to a control to allow or disallow horizontal expansion. + + + + + + Insert a flexible space element. + + + + + Option passed to a control to give it an absolute height. + + + + + + Disposable helper class for managing BeginHorizontal / EndHorizontal. + + + + + Create a new HorizontalScope and begin the corresponding horizontal group. + + Text to display on group. + Texture to display on group. + Text, image, and tooltip for this group. + The style to use for background image and padding values. If left out, the background is transparent. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Create a new HorizontalScope and begin the corresponding horizontal group. + + Text to display on group. + Texture to display on group. + Text, image, and tooltip for this group. + The style to use for background image and padding values. If left out, the background is transparent. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Create a new HorizontalScope and begin the corresponding horizontal group. + + Text to display on group. + Texture to display on group. + Text, image, and tooltip for this group. + The style to use for background image and padding values. If left out, the background is transparent. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Create a new HorizontalScope and begin the corresponding horizontal group. + + Text to display on group. + Texture to display on group. + Text, image, and tooltip for this group. + The style to use for background image and padding values. If left out, the background is transparent. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Create a new HorizontalScope and begin the corresponding horizontal group. + + Text to display on group. + Texture to display on group. + Text, image, and tooltip for this group. + The style to use for background image and padding values. If left out, the background is transparent. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make a horizontal scrollbar. + + The position between min and max. + How much can we see? + The value at the left end of the scrollbar. + The value at the right end of the scrollbar. + The style to use for the scrollbar background. If left out, the horizontalScrollbar style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style. + + The modified value. This can be changed by the user by dragging the scrollbar, or clicking the arrows at the end. + + + + + Make a horizontal scrollbar. + + The position between min and max. + How much can we see? + The value at the left end of the scrollbar. + The value at the right end of the scrollbar. + The style to use for the scrollbar background. If left out, the horizontalScrollbar style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style. + + The modified value. This can be changed by the user by dragging the scrollbar, or clicking the arrows at the end. + + + + + A horizontal slider the user can drag to change a value between a min and a max. + + The value the slider shows. This determines the position of the draggable thumb. + The value at the left end of the slider. + The value at the right end of the slider. + The GUIStyle to use for displaying the dragging area. If left out, the horizontalSlider style from the current GUISkin is used. + The GUIStyle to use for displaying draggable thumb. If left out, the horizontalSliderThumb style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style. + + The value that has been set by the user. + + + + + A horizontal slider the user can drag to change a value between a min and a max. + + The value the slider shows. This determines the position of the draggable thumb. + The value at the left end of the slider. + The value at the right end of the slider. + The GUIStyle to use for displaying the dragging area. If left out, the horizontalSlider style from the current GUISkin is used. + The GUIStyle to use for displaying draggable thumb. If left out, the horizontalSliderThumb style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style. + + The value that has been set by the user. + + + + + Make an auto-layout label. + + Text to display on the label. + Texture to display on the label. + Text, image and tooltip for this label. + The style to use. If left out, the label style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make an auto-layout label. + + Text to display on the label. + Texture to display on the label. + Text, image and tooltip for this label. + The style to use. If left out, the label style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make an auto-layout label. + + Text to display on the label. + Texture to display on the label. + Text, image and tooltip for this label. + The style to use. If left out, the label style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make an auto-layout label. + + Text to display on the label. + Texture to display on the label. + Text, image and tooltip for this label. + The style to use. If left out, the label style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make an auto-layout label. + + Text to display on the label. + Texture to display on the label. + Text, image and tooltip for this label. + The style to use. If left out, the label style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make an auto-layout label. + + Text to display on the label. + Texture to display on the label. + Text, image and tooltip for this label. + The style to use. If left out, the label style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Option passed to a control to specify a maximum height. + + + + + + Option passed to a control to specify a maximum width. + + + + + + Option passed to a control to specify a minimum height. + + + + + + Option passed to a control to specify a minimum width. + + + + + + + Make a text field where the user can enter a password. + + Password to edit. The return value of this function should be assigned back to the string as shown in the example. + Character to mask the password with. + The maximum length of the string. If left out, the user can type for ever and ever. + The style to use. If left out, the textField style from the current GUISkin is used. + + + The edited password. + + + + + Make a text field where the user can enter a password. + + Password to edit. The return value of this function should be assigned back to the string as shown in the example. + Character to mask the password with. + The maximum length of the string. If left out, the user can type for ever and ever. + The style to use. If left out, the textField style from the current GUISkin is used. + + + The edited password. + + + + + Make a text field where the user can enter a password. + + Password to edit. The return value of this function should be assigned back to the string as shown in the example. + Character to mask the password with. + The maximum length of the string. If left out, the user can type for ever and ever. + The style to use. If left out, the textField style from the current GUISkin is used. + + + The edited password. + + + + + Make a text field where the user can enter a password. + + Password to edit. The return value of this function should be assigned back to the string as shown in the example. + Character to mask the password with. + The maximum length of the string. If left out, the user can type for ever and ever. + The style to use. If left out, the textField style from the current GUISkin is used. + + + The edited password. + + + + + Make a repeating button. The button returns true as long as the user holds down the mouse. + + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + true when the holds down the mouse. + + + + + Make a repeating button. The button returns true as long as the user holds down the mouse. + + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + true when the holds down the mouse. + + + + + Make a repeating button. The button returns true as long as the user holds down the mouse. + + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + true when the holds down the mouse. + + + + + Make a repeating button. The button returns true as long as the user holds down the mouse. + + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + true when the holds down the mouse. + + + + + Make a repeating button. The button returns true as long as the user holds down the mouse. + + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + true when the holds down the mouse. + + + + + Make a repeating button. The button returns true as long as the user holds down the mouse. + + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + true when the holds down the mouse. + + + + + Disposable helper class for managing BeginScrollView / EndScrollView. + + + + + Whether this ScrollView should handle scroll wheel events. (default: true). + + + + + The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. + + + + + Create a new ScrollViewScope and begin the corresponding ScrollView. + + The position to use display. + Optional parameter to always show the horizontal scrollbar. If false or left out, it is only shown when the content inside the ScrollView is wider than the scrollview itself. + Optional parameter to always show the vertical scrollbar. If false or left out, it is only shown when content inside the ScrollView is taller than the scrollview itself. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + + + + + + + Create a new ScrollViewScope and begin the corresponding ScrollView. + + The position to use display. + Optional parameter to always show the horizontal scrollbar. If false or left out, it is only shown when the content inside the ScrollView is wider than the scrollview itself. + Optional parameter to always show the vertical scrollbar. If false or left out, it is only shown when content inside the ScrollView is taller than the scrollview itself. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + + + + + + + Create a new ScrollViewScope and begin the corresponding ScrollView. + + The position to use display. + Optional parameter to always show the horizontal scrollbar. If false or left out, it is only shown when the content inside the ScrollView is wider than the scrollview itself. + Optional parameter to always show the vertical scrollbar. If false or left out, it is only shown when content inside the ScrollView is taller than the scrollview itself. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + + + + + + + Create a new ScrollViewScope and begin the corresponding ScrollView. + + The position to use display. + Optional parameter to always show the horizontal scrollbar. If false or left out, it is only shown when the content inside the ScrollView is wider than the scrollview itself. + Optional parameter to always show the vertical scrollbar. If false or left out, it is only shown when content inside the ScrollView is taller than the scrollview itself. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + + + + + + + Create a new ScrollViewScope and begin the corresponding ScrollView. + + The position to use display. + Optional parameter to always show the horizontal scrollbar. If false or left out, it is only shown when the content inside the ScrollView is wider than the scrollview itself. + Optional parameter to always show the vertical scrollbar. If false or left out, it is only shown when content inside the ScrollView is taller than the scrollview itself. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + + + + + + + Create a new ScrollViewScope and begin the corresponding ScrollView. + + The position to use display. + Optional parameter to always show the horizontal scrollbar. If false or left out, it is only shown when the content inside the ScrollView is wider than the scrollview itself. + Optional parameter to always show the vertical scrollbar. If false or left out, it is only shown when content inside the ScrollView is taller than the scrollview itself. + Optional GUIStyle to use for the horizontal scrollbar. If left out, the horizontalScrollbar style from the current GUISkin is used. + Optional GUIStyle to use for the vertical scrollbar. If left out, the verticalScrollbar style from the current GUISkin is used. + + + + + + + Make a Selection Grid. + + The index of the selected button. + An array of strings to show on the buttons. + An array of textures on the buttons. + An array of text, image and tooltips for the button. + How many elements to fit in the horizontal direction. The elements will be scaled to fit unless the style defines a fixedWidth to use. The height of the control will be determined from the number of elements. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + The index of the selected button. + + + + + Make a Selection Grid. + + The index of the selected button. + An array of strings to show on the buttons. + An array of textures on the buttons. + An array of text, image and tooltips for the button. + How many elements to fit in the horizontal direction. The elements will be scaled to fit unless the style defines a fixedWidth to use. The height of the control will be determined from the number of elements. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + The index of the selected button. + + + + + Make a Selection Grid. + + The index of the selected button. + An array of strings to show on the buttons. + An array of textures on the buttons. + An array of text, image and tooltips for the button. + How many elements to fit in the horizontal direction. The elements will be scaled to fit unless the style defines a fixedWidth to use. The height of the control will be determined from the number of elements. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + The index of the selected button. + + + + + Make a Selection Grid. + + The index of the selected button. + An array of strings to show on the buttons. + An array of textures on the buttons. + An array of text, image and tooltips for the button. + How many elements to fit in the horizontal direction. The elements will be scaled to fit unless the style defines a fixedWidth to use. The height of the control will be determined from the number of elements. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + The index of the selected button. + + + + + Make a Selection Grid. + + The index of the selected button. + An array of strings to show on the buttons. + An array of textures on the buttons. + An array of text, image and tooltips for the button. + How many elements to fit in the horizontal direction. The elements will be scaled to fit unless the style defines a fixedWidth to use. The height of the control will be determined from the number of elements. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + The index of the selected button. + + + + + Make a Selection Grid. + + The index of the selected button. + An array of strings to show on the buttons. + An array of textures on the buttons. + An array of text, image and tooltips for the button. + How many elements to fit in the horizontal direction. The elements will be scaled to fit unless the style defines a fixedWidth to use. The height of the control will be determined from the number of elements. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + The index of the selected button. + + + + + Insert a space in the current layout group. + + + + + + Make a multi-line text field where the user can edit a string. + + Text to edit. The return value of this function should be assigned back to the string as shown in the example. + The maximum length of the string. If left out, the user can type for ever and ever. + The style to use. If left out, the textField style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.&amp;lt;br&amp;gt; +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The edited string. + + + + + Make a multi-line text field where the user can edit a string. + + Text to edit. The return value of this function should be assigned back to the string as shown in the example. + The maximum length of the string. If left out, the user can type for ever and ever. + The style to use. If left out, the textField style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.&amp;lt;br&amp;gt; +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The edited string. + + + + + Make a multi-line text field where the user can edit a string. + + Text to edit. The return value of this function should be assigned back to the string as shown in the example. + The maximum length of the string. If left out, the user can type for ever and ever. + The style to use. If left out, the textField style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.&amp;lt;br&amp;gt; +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The edited string. + + + + + Make a multi-line text field where the user can edit a string. + + Text to edit. The return value of this function should be assigned back to the string as shown in the example. + The maximum length of the string. If left out, the user can type for ever and ever. + The style to use. If left out, the textField style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.&amp;lt;br&amp;gt; +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The edited string. + + + + + Make a single-line text field where the user can edit a string. + + Text to edit. The return value of this function should be assigned back to the string as shown in the example. + The maximum length of the string. If left out, the user can type for ever and ever. + The style to use. If left out, the textArea style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The edited string. + + + + + Make a single-line text field where the user can edit a string. + + Text to edit. The return value of this function should be assigned back to the string as shown in the example. + The maximum length of the string. If left out, the user can type for ever and ever. + The style to use. If left out, the textArea style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The edited string. + + + + + Make a single-line text field where the user can edit a string. + + Text to edit. The return value of this function should be assigned back to the string as shown in the example. + The maximum length of the string. If left out, the user can type for ever and ever. + The style to use. If left out, the textArea style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The edited string. + + + + + Make a single-line text field where the user can edit a string. + + Text to edit. The return value of this function should be assigned back to the string as shown in the example. + The maximum length of the string. If left out, the user can type for ever and ever. + The style to use. If left out, the textArea style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The edited string. + + + + + Make an on/off toggle button. + + Is the button on or off? + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The new value of the button. + + + + + Make an on/off toggle button. + + Is the button on or off? + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The new value of the button. + + + + + Make an on/off toggle button. + + Is the button on or off? + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The new value of the button. + + + + + Make an on/off toggle button. + + Is the button on or off? + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The new value of the button. + + + + + Make an on/off toggle button. + + Is the button on or off? + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The new value of the button. + + + + + Make an on/off toggle button. + + Is the button on or off? + Text to display on the button. + Texture to display on the button. + Text, image and tooltip for this button. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The new value of the button. + + + + + Make a toolbar. + + The index of the selected button. + An array of strings to show on the buttons. + An array of textures on the buttons. + An array of text, image and tooltips for the button. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + Determines how toolbar button size is calculated. + + The index of the selected button. + + + + + Make a toolbar. + + The index of the selected button. + An array of strings to show on the buttons. + An array of textures on the buttons. + An array of text, image and tooltips for the button. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + Determines how toolbar button size is calculated. + + The index of the selected button. + + + + + Make a toolbar. + + The index of the selected button. + An array of strings to show on the buttons. + An array of textures on the buttons. + An array of text, image and tooltips for the button. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + Determines how toolbar button size is calculated. + + The index of the selected button. + + + + + Make a toolbar. + + The index of the selected button. + An array of strings to show on the buttons. + An array of textures on the buttons. + An array of text, image and tooltips for the button. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + Determines how toolbar button size is calculated. + + The index of the selected button. + + + + + Make a toolbar. + + The index of the selected button. + An array of strings to show on the buttons. + An array of textures on the buttons. + An array of text, image and tooltips for the button. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + Determines how toolbar button size is calculated. + + The index of the selected button. + + + + + Make a toolbar. + + The index of the selected button. + An array of strings to show on the buttons. + An array of textures on the buttons. + An array of text, image and tooltips for the button. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + Determines how toolbar button size is calculated. + + The index of the selected button. + + + + + Make a toolbar. + + The index of the selected button. + An array of strings to show on the buttons. + An array of textures on the buttons. + An array of text, image and tooltips for the button. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + Determines how toolbar button size is calculated. + + The index of the selected button. + + + + + Make a toolbar. + + The index of the selected button. + An array of strings to show on the buttons. + An array of textures on the buttons. + An array of text, image and tooltips for the button. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + Determines how toolbar button size is calculated. + + The index of the selected button. + + + + + Make a toolbar. + + The index of the selected button. + An array of strings to show on the buttons. + An array of textures on the buttons. + An array of text, image and tooltips for the button. + The style to use. If left out, the button style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + Determines how toolbar button size is calculated. + + The index of the selected button. + + + + + Disposable helper class for managing BeginVertical / EndVertical. + + + + + Create a new VerticalScope and begin the corresponding vertical group. + + Text to display on group. + Texture to display on group. + Text, image, and tooltip for this group. + The style to use for background image and padding values. If left out, the background is transparent. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Create a new VerticalScope and begin the corresponding vertical group. + + Text to display on group. + Texture to display on group. + Text, image, and tooltip for this group. + The style to use for background image and padding values. If left out, the background is transparent. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Create a new VerticalScope and begin the corresponding vertical group. + + Text to display on group. + Texture to display on group. + Text, image, and tooltip for this group. + The style to use for background image and padding values. If left out, the background is transparent. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Create a new VerticalScope and begin the corresponding vertical group. + + Text to display on group. + Texture to display on group. + Text, image, and tooltip for this group. + The style to use for background image and padding values. If left out, the background is transparent. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Create a new VerticalScope and begin the corresponding vertical group. + + Text to display on group. + Texture to display on group. + Text, image, and tooltip for this group. + The style to use for background image and padding values. If left out, the background is transparent. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + + + Make a vertical scrollbar. + + The position between min and max. + How much can we see? + The value at the top end of the scrollbar. + The value at the bottom end of the scrollbar. + The style to use for the scrollbar background. If left out, the horizontalScrollbar style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style. + + The modified value. This can be changed by the user by dragging the scrollbar, or clicking the arrows at the end. + + + + + Make a vertical scrollbar. + + The position between min and max. + How much can we see? + The value at the top end of the scrollbar. + The value at the bottom end of the scrollbar. + The style to use for the scrollbar background. If left out, the horizontalScrollbar style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style. + + The modified value. This can be changed by the user by dragging the scrollbar, or clicking the arrows at the end. + + + + + A vertical slider the user can drag to change a value between a min and a max. + + The value the slider shows. This determines the position of the draggable thumb. + The value at the top end of the slider. + The value at the bottom end of the slider. + The GUIStyle to use for displaying the dragging area. If left out, the horizontalSlider style from the current GUISkin is used. + The GUIStyle to use for displaying draggable thumb. If left out, the horizontalSliderThumb style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style. + + + + The value that has been set by the user. + + + + + A vertical slider the user can drag to change a value between a min and a max. + + The value the slider shows. This determines the position of the draggable thumb. + The value at the top end of the slider. + The value at the bottom end of the slider. + The GUIStyle to use for displaying the dragging area. If left out, the horizontalSlider style from the current GUISkin is used. + The GUIStyle to use for displaying draggable thumb. If left out, the horizontalSliderThumb style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style. + + + + The value that has been set by the user. + + + + + Option passed to a control to give it an absolute width. + + + + + + Make a popup window that layouts its contents automatically. + + A unique ID to use for each window. This is the ID you'll use to interface to it. + Rectangle on the screen to use for the window. The layouting system will attempt to fit the window inside it - if that cannot be done, it will adjust the rectangle to fit. + The function that creates the GUI inside the window. This function must take one parameter - the id of the window it's currently making GUI for. + Text to display as a title for the window. + Texture to display an image in the titlebar. + Text, image and tooltip for this window. + An optional style to use for the window. If left out, the window style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style or the screenRect you pass in.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The rectangle the window is at. This can be in a different position and have a different size than the one you passed in. + + + + + Make a popup window that layouts its contents automatically. + + A unique ID to use for each window. This is the ID you'll use to interface to it. + Rectangle on the screen to use for the window. The layouting system will attempt to fit the window inside it - if that cannot be done, it will adjust the rectangle to fit. + The function that creates the GUI inside the window. This function must take one parameter - the id of the window it's currently making GUI for. + Text to display as a title for the window. + Texture to display an image in the titlebar. + Text, image and tooltip for this window. + An optional style to use for the window. If left out, the window style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style or the screenRect you pass in.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The rectangle the window is at. This can be in a different position and have a different size than the one you passed in. + + + + + Make a popup window that layouts its contents automatically. + + A unique ID to use for each window. This is the ID you'll use to interface to it. + Rectangle on the screen to use for the window. The layouting system will attempt to fit the window inside it - if that cannot be done, it will adjust the rectangle to fit. + The function that creates the GUI inside the window. This function must take one parameter - the id of the window it's currently making GUI for. + Text to display as a title for the window. + Texture to display an image in the titlebar. + Text, image and tooltip for this window. + An optional style to use for the window. If left out, the window style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style or the screenRect you pass in.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The rectangle the window is at. This can be in a different position and have a different size than the one you passed in. + + + + + Make a popup window that layouts its contents automatically. + + A unique ID to use for each window. This is the ID you'll use to interface to it. + Rectangle on the screen to use for the window. The layouting system will attempt to fit the window inside it - if that cannot be done, it will adjust the rectangle to fit. + The function that creates the GUI inside the window. This function must take one parameter - the id of the window it's currently making GUI for. + Text to display as a title for the window. + Texture to display an image in the titlebar. + Text, image and tooltip for this window. + An optional style to use for the window. If left out, the window style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style or the screenRect you pass in.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The rectangle the window is at. This can be in a different position and have a different size than the one you passed in. + + + + + Make a popup window that layouts its contents automatically. + + A unique ID to use for each window. This is the ID you'll use to interface to it. + Rectangle on the screen to use for the window. The layouting system will attempt to fit the window inside it - if that cannot be done, it will adjust the rectangle to fit. + The function that creates the GUI inside the window. This function must take one parameter - the id of the window it's currently making GUI for. + Text to display as a title for the window. + Texture to display an image in the titlebar. + Text, image and tooltip for this window. + An optional style to use for the window. If left out, the window style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style or the screenRect you pass in.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The rectangle the window is at. This can be in a different position and have a different size than the one you passed in. + + + + + Make a popup window that layouts its contents automatically. + + A unique ID to use for each window. This is the ID you'll use to interface to it. + Rectangle on the screen to use for the window. The layouting system will attempt to fit the window inside it - if that cannot be done, it will adjust the rectangle to fit. + The function that creates the GUI inside the window. This function must take one parameter - the id of the window it's currently making GUI for. + Text to display as a title for the window. + Texture to display an image in the titlebar. + Text, image and tooltip for this window. + An optional style to use for the window. If left out, the window style from the current GUISkin is used. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style or the screenRect you pass in.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The rectangle the window is at. This can be in a different position and have a different size than the one you passed in. + + + + + Class internally used to pass layout options into GUILayout functions. You don't use these directly, but construct them with the layouting functions in the GUILayout class. + + + + + Utility functions for implementing and extending the GUILayout class. + + + + + Reserve layout space for a rectangle with a specific aspect ratio. + + The aspect ratio of the element (width / height). + An optional style. If specified, the style's padding value will be added to the sizes of the returned rectangle & the style's margin values will be used for spacing. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The rect for the control. + + + + + Reserve layout space for a rectangle with a specific aspect ratio. + + The aspect ratio of the element (width / height). + An optional style. If specified, the style's padding value will be added to the sizes of the returned rectangle & the style's margin values will be used for spacing. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The rect for the control. + + + + + Reserve layout space for a rectangle with a specific aspect ratio. + + The aspect ratio of the element (width / height). + An optional style. If specified, the style's padding value will be added to the sizes of the returned rectangle & the style's margin values will be used for spacing. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The rect for the control. + + + + + Reserve layout space for a rectangle with a specific aspect ratio. + + The aspect ratio of the element (width / height). + An optional style. If specified, the style's padding value will be added to the sizes of the returned rectangle & the style's margin values will be used for spacing. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The rect for the control. + + + + + Get the rectangle last used by GUILayout for a control. + + + The last used rectangle. + + + + + Reserve layout space for a rectangle for displaying some contents with a specific style. + + The content to make room for displaying. + The GUIStyle to layout for. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + A rectangle that is large enough to contain content when rendered in style. + + + + + Reserve layout space for a rectangle for displaying some contents with a specific style. + + The content to make room for displaying. + The GUIStyle to layout for. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + A rectangle that is large enough to contain content when rendered in style. + + + + + Reserve layout space for a rectangle with a fixed content area. + + The width of the area you want. + The height of the area you want. + An optional GUIStyle to layout for. If specified, the style's padding value will be added to your sizes & its margin value will be used for spacing. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The rectanlge to put your control in. + + + + + Reserve layout space for a rectangle with a fixed content area. + + The width of the area you want. + The height of the area you want. + An optional GUIStyle to layout for. If specified, the style's padding value will be added to your sizes & its margin value will be used for spacing. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The rectanlge to put your control in. + + + + + Reserve layout space for a rectangle with a fixed content area. + + The width of the area you want. + The height of the area you want. + An optional GUIStyle to layout for. If specified, the style's padding value will be added to your sizes & its margin value will be used for spacing. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The rectanlge to put your control in. + + + + + Reserve layout space for a rectangle with a fixed content area. + + The width of the area you want. + The height of the area you want. + An optional GUIStyle to layout for. If specified, the style's padding value will be added to your sizes & its margin value will be used for spacing. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + The rectanlge to put your control in. + + + + + Reserve layout space for a flexible rect. + + The minimum width of the area passed back. + The maximum width of the area passed back. + The minimum width of the area passed back. + The maximum width of the area passed back. + An optional style. If specified, the style's padding value will be added to the sizes requested & the style's margin values will be used for spacing. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + A rectangle with size between minWidth & maxWidth on both axes. + + + + + Reserve layout space for a flexible rect. + + The minimum width of the area passed back. + The maximum width of the area passed back. + The minimum width of the area passed back. + The maximum width of the area passed back. + An optional style. If specified, the style's padding value will be added to the sizes requested & the style's margin values will be used for spacing. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + A rectangle with size between minWidth & maxWidth on both axes. + + + + + Reserve layout space for a flexible rect. + + The minimum width of the area passed back. + The maximum width of the area passed back. + The minimum width of the area passed back. + The maximum width of the area passed back. + An optional style. If specified, the style's padding value will be added to the sizes requested & the style's margin values will be used for spacing. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + A rectangle with size between minWidth & maxWidth on both axes. + + + + + Reserve layout space for a flexible rect. + + The minimum width of the area passed back. + The maximum width of the area passed back. + The minimum width of the area passed back. + The maximum width of the area passed back. + An optional style. If specified, the style's padding value will be added to the sizes requested & the style's margin values will be used for spacing. + An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, +GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. + + A rectangle with size between minWidth & maxWidth on both axes. + + + + + General settings for how the GUI behaves. + + + + + The color of the cursor in text fields. + + + + + The speed of text field cursor flashes. + + + + + Should double-clicking select words in text fields. + + + + + The color of the selection rect in text fields. + + + + + Should triple-clicking select whole text in text fields. + + + + + Defines how GUI looks and behaves. + + + + + Style used by default for GUI.Box controls. + + + + + Style used by default for GUI.Button controls. + + + + + Array of GUI styles for specific needs. + + + + + The default font to use for all styles. + + + + + Style used by default for the background part of GUI.HorizontalScrollbar controls. + + + + + Style used by default for the left button on GUI.HorizontalScrollbar controls. + + + + + Style used by default for the right button on GUI.HorizontalScrollbar controls. + + + + + Style used by default for the thumb that is dragged in GUI.HorizontalScrollbar controls. + + + + + Style used by default for the background part of GUI.HorizontalSlider controls. + + + + + Style used by default for the thumb that is dragged in GUI.HorizontalSlider controls. + + + + + Style used by default for GUI.Label controls. + + + + + Style used by default for the background of ScrollView controls (see GUI.BeginScrollView). + + + + + Generic settings for how controls should behave with this skin. + + + + + Style used by default for GUI.TextArea controls. + + + + + Style used by default for GUI.TextField controls. + + + + + Style used by default for GUI.Toggle controls. + + + + + Style used by default for the background part of GUI.VerticalScrollbar controls. + + + + + Style used by default for the down button on GUI.VerticalScrollbar controls. + + + + + Style used by default for the thumb that is dragged in GUI.VerticalScrollbar controls. + + + + + Style used by default for the up button on GUI.VerticalScrollbar controls. + + + + + Style used by default for the background part of GUI.VerticalSlider controls. + + + + + Style used by default for the thumb that is dragged in GUI.VerticalSlider controls. + + + + + Style used by default for Window controls (SA GUI.Window). + + + + + Try to search for a GUIStyle. This functions returns NULL and does not give an error. + + + + + + Get a named GUIStyle. + + + + + + Styling information for GUI elements. + + + + + Rendering settings for when the control is pressed down. + + + + + Text alignment. + + + + + The borders of all background images. + + + + + What to do when the contents to be rendered is too large to fit within the area given. + + + + + Pixel offset to apply to the content of this GUIstyle. + + + + + If non-0, any GUI elements rendered with this style will have the height specified here. + + + + + If non-0, any GUI elements rendered with this style will have the width specified here. + + + + + Rendering settings for when the element has keyboard focus. + + + + + The font to use for rendering. If null, the default font for the current GUISkin is used instead. + + + + + The font size to use (for dynamic fonts). + + + + + The font style to use (for dynamic fonts). + + + + + Rendering settings for when the mouse is hovering over the control. + + + + + How image and text of the GUIContent is combined. + + + + + The height of one line of text with this style, measured in pixels. (Read Only) + + + + + The margins between elements rendered in this style and any other GUI elements. + + + + + The name of this GUIStyle. Used for getting them based on name. + + + + + Shortcut for an empty GUIStyle. + + + + + Rendering settings for when the component is displayed normally. + + + + + Rendering settings for when the element is turned on and pressed down. + + + + + Rendering settings for when the element has keyboard and is turned on. + + + + + Rendering settings for when the control is turned on and the mouse is hovering it. + + + + + Rendering settings for when the control is turned on. + + + + + Extra space to be added to the background image. + + + + + Space from the edge of GUIStyle to the start of the contents. + + + + + Enable HTML-style tags for Text Formatting Markup. + + + + + Can GUI elements of this style be stretched vertically for better layout? + + + + + Can GUI elements of this style be stretched horizontally for better layouting? + + + + + Should the text be wordwrapped? + + + + + How tall this element will be when rendered with content and a specific width. + + + + + + + Calculate the minimum and maximum widths for this style rendered with content. + + + + + + + + Calculate the size of an element formatted with this style, and a given space to content. + + + + + + Calculate the size of some content if it is rendered with this style. + + + + + + Constructor for empty GUIStyle. + + + + + Constructs GUIStyle identical to given other GUIStyle. + + + + + + Draw this GUIStyle on to the screen, internal version. + + + + + + + + + + Draw the GUIStyle with a text string inside. + + + + + + + + + + + Draw the GUIStyle with an image inside. If the image is too large to fit within the content area of the style it is scaled down. + + + + + + + + + + + Draw the GUIStyle with text and an image inside. If the image is too large to fit within the content area of the style it is scaled down. + + + + + + + + + + + + Draw the GUIStyle with text and an image inside. If the image is too large to fit within the content area of the style it is scaled down. + + + + + + + + + + + + Draw the GUIStyle with text and an image inside. If the image is too large to fit within the content area of the style it is scaled down. + + + + + + + + + + + + Draw this GUIStyle with selected content. + + + + + + + + + Draw this GUIStyle with selected content. + + + + + + + + + + Get the pixel position of a given string index. + + + + + + + + Get the cursor position (indexing into contents.text) when the user clicked at cursorPixelPosition. + + + + + + + + Get a named GUI style from the current skin. + + + + + + Specialized values for the given states used by GUIStyle objects. + + + + + The background image used by GUI elements in this given state. + + + + + Background images used by this state when on a high-resolution screen. It should either be left empty, or contain a single image that is exactly twice the resolution of background. This is only used by the editor. The field is not copied to player data, and is not accessible from player code. + + + + + The text color used by GUI elements in this state. + + + + + Allows to control for which display the OnGUI is called. + + + + + Default constructor initializes the attribute for OnGUI to be called for all available displays. + + Display index. + Display index. + Display index list. + + + + Default constructor initializes the attribute for OnGUI to be called for all available displays. + + Display index. + Display index. + Display index list. + + + + Default constructor initializes the attribute for OnGUI to be called for all available displays. + + Display index. + Display index. + Display index list. + + + + Default constructor initializes the attribute for OnGUI to be called for all available displays. + + Display index. + Display index. + Display index list. + + + + A text string displayed in a GUI. + + + + + The alignment of the text. + + + + + The anchor of the text. + + + + + The color used to render the text. + + + + + The font used for the text. + + + + + The font size to use (for dynamic fonts). + + + + + The font style to use (for dynamic fonts). + + + + + The line spacing multiplier. + + + + + The Material to use for rendering. + + + + + The pixel offset of the text. + + + + + Enable HTML-style tags for Text Formatting Markup. + + + + + The tab width multiplier. + + + + + The text to display. + + + + + A texture image used in a 2D GUI. + + + + + The border defines the number of pixels from the edge that are not affected by scale. + + + + + The color of the GUI texture. + + + + + Pixel inset used for pixel adjustments for size and position. + + + + + The texture used for drawing. + + + + + Utility class for making new GUI controls. + + + + + A global property, which is true if a ModalWindow is being displayed, false otherwise. + + + + + The controlID of the current hot control. + + + + + The controlID of the control that has keyboard focus. + + + + + Get access to the system-wide clipboard. + + + + + Align a local space rectangle to the pixel grid. + + The local space rectangle that needs to be processed. + Width, in pixel units, of the axis-aligned bounding box that encompasses the aligned points. + Height, in pixel units, of the axis-aligned bounding box that encompasses the aligned points. + + + The aligned rectangle in local space. + + + + + Align a local space rectangle to the pixel grid. + + The local space rectangle that needs to be processed. + Width, in pixel units, of the axis-aligned bounding box that encompasses the aligned points. + Height, in pixel units, of the axis-aligned bounding box that encompasses the aligned points. + + + The aligned rectangle in local space. + + + + + Puts the GUI in a state that will prevent all subsequent immediate mode GUI functions from evaluating for the remainder of the GUI loop by throwing an ExitGUIException. + + + + + Get a unique ID for a control. + + + + + + + Get a unique ID for a control. + + + + + + + Get a unique ID for a control, using an integer as a hint to help ensure correct matching of IDs to controls. + + + + + + + + + Get a unique ID for a control, using an integer as a hint to help ensure correct matching of IDs to controls. + + + + + + + + + Get a unique ID for a control, using a the label content as a hint to help ensure correct matching of IDs to controls. + + + + + + + + Get a unique ID for a control, using a the label content as a hint to help ensure correct matching of IDs to controls. + + + + + + + + Get a state object from a controlID. + + + + + + + Convert a point from GUI position to screen space. + + + + + + Get an existing state object from a controlID. + + + + + + + Helper function to rotate the GUI around a point. + + + + + + + Helper function to scale the GUI around a point. + + + + + + + Convert a point from screen space to GUI position. + + + + + + Interface into the Gyroscope. + + + + + Returns the attitude (ie, orientation in space) of the device. + + + + + Sets or retrieves the enabled status of this gyroscope. + + + + + Returns the gravity acceleration vector expressed in the device's reference frame. + + + + + Returns rotation rate as measured by the device's gyroscope. + + + + + Returns unbiased rotation rate as measured by the device's gyroscope. + + + + + Sets or retrieves gyroscope interval in seconds. + + + + + Returns the acceleration that the user is giving to the device. + + + + + Interface into functionality unique to handheld devices. + + + + + Determines whether or not a 32-bit display buffer will be used. + + + + + Gets the current activity indicator style. + + + + + Plays a full-screen movie. + + Filesystem path to the movie file. + Background color. + How the playback controls are to be displayed. + How the movie is to be scaled to fit the screen. + + + + Plays a full-screen movie. + + Filesystem path to the movie file. + Background color. + How the playback controls are to be displayed. + How the movie is to be scaled to fit the screen. + + + + Plays a full-screen movie. + + Filesystem path to the movie file. + Background color. + How the playback controls are to be displayed. + How the movie is to be scaled to fit the screen. + + + + Plays a full-screen movie. + + Filesystem path to the movie file. + Background color. + How the playback controls are to be displayed. + How the movie is to be scaled to fit the screen. + + + + Sets the desired activity indicator style. + + + + + + Sets the desired activity indicator style. + + + + + + Starts os activity indicator. + + + + + Stops os activity indicator. + + + + + Triggers device vibration. + + + + + Represent the hash value. + + + + + Get if the hash value is valid or not. (Read Only) + + + + + Compute a hash of the input string. + + + + + + Construct the Hash128. + + + + + + + + + Convert the input string to Hash128. + + + + + + Convert Hash128 to string. + + + + + Utilities to compute hashes with unsafe code. + + + + + Compute a 128 bit hash based on a data. + + Pointer to the data to hash. + The number of bytes to hash. + A pointer to store the low 64 bits of the computed hash. + A pointer to store the high 64 bits of the computed hash. + A pointer to the Hash128 to updated with the computed hash. + + + + Compute a 128 bit hash based on a data. + + Pointer to the data to hash. + The number of bytes to hash. + A pointer to store the low 64 bits of the computed hash. + A pointer to store the high 64 bits of the computed hash. + A pointer to the Hash128 to updated with the computed hash. + + + + Utilities to compute hashes. + + + + + Append inHash in outHash. + + Hash to append. + Hash that will be updated. + + + + Compute a 128 bit hash based on a value. the type of the value must be a value type. + + A reference to the value to hash. + A reference to the Hash128 to updated with the computed hash. + + + + Compute a Hash128 of a Matrix4x4. + + The Matrix4x4 to hash. + The computed hash. + + + + Compute a Hash128 of a Vector3. + + The Vector3 to hash. + The computed hash. + + + + Enumeration of all the muscles in the head. + + + + + The head front-back muscle. + + + + + The head left-right muscle. + + + + + The head roll left-right muscle. + + + + + The jaw down-up muscle. + + + + + The jaw left-right muscle. + + + + + The last value of the HeadDof enum. + + + + + The left eye down-up muscle. + + + + + The left eye in-out muscle. + + + + + The neck front-back muscle. + + + + + The neck left-right muscle. + + + + + The neck roll left-right muscle. + + + + + The right eye down-up muscle. + + + + + The right eye in-out muscle. + + + + + Use this PropertyAttribute to add a header above some fields in the Inspector. + + + + + The header text. + + + + + Add a header above some fields in the Inspector. + + The header text. + + + + Provide a custom documentation URL for a class. + + + + + Initialize the HelpURL attribute with a documentation url. + + The custom documentation URL for this class. + + + + The documentation URL specified for this class. + + + + + Bit mask that controls object destruction, saving and visibility in inspectors. + + + + + The object will not be saved to the Scene. It will not be destroyed when a new Scene is loaded. It is a shortcut for HideFlags.DontSaveInBuild | HideFlags.DontSaveInEditor | HideFlags.DontUnloadUnusedAsset. + + + + + The object will not be saved when building a player. + + + + + The object will not be saved to the Scene in the editor. + + + + + The object will not be unloaded by Resources.UnloadUnusedAssets. + + + + + The GameObject is not shown in the Hierarchy, not saved to to Scenes, and not unloaded by Resources.UnloadUnusedAssets. + + + + + The object will not appear in the hierarchy. + + + + + It is not possible to view it in the inspector. + + + + + A normal, visible object. This is the default. + + + + + The object is not be editable in the inspector. + + + + + Makes a variable not show up in the inspector but be serialized. + + + + + The HingeJoint groups together 2 rigid bodies, constraining them to move like connected by a hinge. + + + + + The current angle in degrees of the joint relative to its rest position. (Read Only) + + + + + Limit of angular rotation (in degrees) on the hinge joint. + + + + + The motor will apply a force up to a maximum force to achieve the target velocity in degrees per second. + + + + + The spring attempts to reach a target angle by adding spring and damping forces. + + + + + Enables the joint's limits. Disabled by default. + + + + + Enables the joint's motor. Disabled by default. + + + + + Enables the joint's spring. Disabled by default. + + + + + The angular velocity of the joint in degrees per second. (Read Only) + + + + + Joint that allows a Rigidbody2D object to rotate around a point in space or a point on another object. + + + + + The current joint angle (in degrees) with respect to the reference angle. + + + + + The current joint speed. + + + + + Limit of angular rotation (in degrees) on the joint. + + + + + Gets the state of the joint limit. + + + + + Parameters for the motor force applied to the joint. + + + + + The angle (in degrees) referenced between the two bodies used as the constraint for the joint. + + + + + Should limits be placed on the range of rotation? + + + + + Should the joint be rotated automatically by a motor torque? + + + + + Gets the motor torque of the joint given the specified timestep. + + The time to calculate the motor torque for. + + + + Wrapping modes for text that reaches the horizontal boundary. + + + + + Text can exceed the horizontal boundary. + + + + + Text will word-wrap when reaching the horizontal boundary. + + + + + This is the data structure for holding individual host information. + + + + + A miscellaneous comment (can hold data). + + + + + Currently connected players. + + + + + The name of the game (like John Doe's Game). + + + + + The type of the game (like "MyUniqueGameType"). + + + + + The GUID of the host, needed when connecting with NAT punchthrough. + + + + + Server IP address. + + + + + Does the server require a password? + + + + + Maximum players limit. + + + + + Server port. + + + + + Does this server require NAT punchthrough? + + + + + Human Body Bones. + + + + + This is the Chest bone. + + + + + This is the Head bone. + + + + + This is the Hips bone. + + + + + This is the Jaw bone. + + + + + This is the Last bone index delimiter. + + + + + This is the Left Eye bone. + + + + + This is the Left Ankle bone. + + + + + This is the Left Wrist bone. + + + + + This is the left index 3rd phalange. + + + + + This is the left index 2nd phalange. + + + + + This is the left index 1st phalange. + + + + + This is the left little 3rd phalange. + + + + + This is the left little 2nd phalange. + + + + + This is the left little 1st phalange. + + + + + This is the Left Elbow bone. + + + + + This is the Left Knee bone. + + + + + This is the left middle 3rd phalange. + + + + + This is the left middle 2nd phalange. + + + + + This is the left middle 1st phalange. + + + + + This is the left ring 3rd phalange. + + + + + This is the left ring 2nd phalange. + + + + + This is the left ring 1st phalange. + + + + + This is the Left Shoulder bone. + + + + + This is the left thumb 3rd phalange. + + + + + This is the left thumb 2nd phalange. + + + + + This is the left thumb 1st phalange. + + + + + This is the Left Toes bone. + + + + + This is the Left Upper Arm bone. + + + + + This is the Left Upper Leg bone. + + + + + This is the Neck bone. + + + + + This is the Right Eye bone. + + + + + This is the Right Ankle bone. + + + + + This is the Right Wrist bone. + + + + + This is the right index 3rd phalange. + + + + + This is the right index 2nd phalange. + + + + + This is the right index 1st phalange. + + + + + This is the right little 3rd phalange. + + + + + This is the right little 2nd phalange. + + + + + This is the right little 1st phalange. + + + + + This is the Right Elbow bone. + + + + + This is the Right Knee bone. + + + + + This is the right middle 3rd phalange. + + + + + This is the right middle 2nd phalange. + + + + + This is the right middle 1st phalange. + + + + + This is the right ring 3rd phalange. + + + + + This is the right ring 2nd phalange. + + + + + This is the right ring 1st phalange. + + + + + This is the Right Shoulder bone. + + + + + This is the right thumb 3rd phalange. + + + + + This is the right thumb 2nd phalange. + + + + + This is the right thumb 1st phalange. + + + + + This is the Right Toes bone. + + + + + This is the Right Upper Arm bone. + + + + + This is the Right Upper Leg bone. + + + + + This is the first Spine bone. + + + + + This is the Upper Chest bone. + + + + + The mapping between a bone in the model and the conceptual bone in the Mecanim human anatomy. + + + + + The name of the bone to which the Mecanim human bone is mapped. + + + + + The name of the Mecanim human bone to which the bone from the model is mapped. + + + + + The rotation limits that define the muscle for this bone. + + + + + Class that holds humanoid avatar parameters to pass to the AvatarBuilder.BuildHumanAvatar function. + + + + + Amount by which the arm's length is allowed to stretch when using IK. + + + + + Modification to the minimum distance between the feet of a humanoid model. + + + + + True for any human that has a translation Degree of Freedom (DoF). It is set to false by default. + + + + + Mapping between Mecanim bone names and bone names in the rig. + + + + + Amount by which the leg's length is allowed to stretch when using IK. + + + + + Defines how the lower arm's roll/twisting is distributed between the elbow and wrist joints. + + + + + Defines how the lower leg's roll/twisting is distributed between the knee and ankle. + + + + + List of bone Transforms to include in the model. + + + + + Defines how the upper arm's roll/twisting is distributed between the shoulder and elbow joints. + + + + + Defines how the upper leg's roll/twisting is distributed between the thigh and knee joints. + + + + + This class stores the rotation limits that define the muscle for a single human bone. + + + + + Length of the bone to which the limit is applied. + + + + + The default orientation of a bone when no muscle action is applied. + + + + + The maximum rotation away from the initial value that this muscle can apply. + + + + + The maximum negative rotation away from the initial value that this muscle can apply. + + + + + Should this limit use the default values? + + + + + Enumeration of all the parts in a human. + + + + + The human body part. + + + + + The human head part. + + + + + The human left arm part. + + + + + The human left index finger part. + + + + + The human left leg part. + + + + + The human left little finger part. + + + + + The human left middle finger part. + + + + + The human left ring finger part. + + + + + The human left thumb finger part. + + + + + The human right arm part. + + + + + The human right index finger part. + + + + + The human right leg part. + + + + + The human right little finger part. + + + + + The human right middle finger part. + + + + + The human right ring finger part. + + + + + The human right thumb finger part. + + + + + Retargetable humanoid pose. + + + + + The human body position for that pose. + + + + + The human body orientation for that pose. + + + + + The array of muscle values for that pose. + + + + + A handler that lets you read or write a HumanPose from or to a humanoid avatar skeleton hierarchy. + + + + + Creates a human pose handler from an avatar and a root transform. + + The avatar that defines the humanoid rig on skeleton hierarchy with root as the top most parent. + The top most node of the skeleton hierarchy defined in humanoid avatar. + + + + Gets a human pose from the handled avatar skeleton. + + The output human pose. + + + + Sets a human pose on the handled avatar skeleton. + + The human pose to be set. + + + + Details of all the human bone and muscle types defined by Mecanim. + + + + + The number of human bone types defined by Mecanim. + + + + + Return the bone to which a particular muscle is connected. + + Muscle index. + + + + Array of the names of all human bone types defined by Mecanim. + + + + + Gets the bone hierarchy mass. + + The humanoid bone index. + + The bone hierarchy mass. + + + + + Get the default maximum value of rotation for a muscle in degrees. + + Muscle index. + + + + Get the default minimum value of rotation for a muscle in degrees. + + Muscle index. + + + + Returns parent humanoid bone index of a bone. + + Humanoid bone index to get parent from. + + Humanoid bone index of parent. + + + + + The number of human muscle types defined by Mecanim. + + + + + Obtain the muscle index for a particular bone index and "degree of freedom". + + Bone index. + Number representing a "degree of freedom": 0 for X-Axis, 1 for Y-Axis, 2 for Z-Axis. + + + + Array of the names of all human muscle types defined by Mecanim. + + + + + Is the bone a member of the minimal set of bones that Mecanim requires for a human model? + + Index of the bone to test. + + + + The number of bone types that are required by Mecanim for any human model. + + + + + Use this interface to have a class provide its own list of Animation Clips to the Animation Window. The class must inherit from MonoBehaviour. + + + + + Returns a list of Animation Clips. + + + + + + This element can filter raycasts. If the top level element is hit it can further 'check' if the location is valid. + + + + + Given a point and a camera is the raycast valid. + + Screen position. + Raycast camera. + + Valid. + + + + + Interface for objects used as resolvers on ExposedReferences. + + + + + Remove a value for the given reference. + + Identifier of the ExposedReference. + + + + Retrieves a value for the given identifier. + + Identifier of the ExposedReference. + Is the identifier valid? + + The value stored in the table. + + + + + Assigns a value for an ExposedReference. + + Identifier of the ExposedReference. + The value to assigned to the ExposedReference. + + + + Interface for custom logger implementation. + + + + + To selective enable debug log message. + + + + + To runtime toggle debug logging [ON/OFF]. + + + + + Set Logger.ILogHandler. + + + + + Check logging is enabled based on the LogType. + + + + Retrun true in case logs of LogType will be logged otherwise returns false. + + + + + Logs message to the Unity Console using default logger. + + + + + + + + + Logs message to the Unity Console using default logger. + + + + + + + + + Logs message to the Unity Console using default logger. + + + + + + + + + Logs message to the Unity Console using default logger. + + + + + + + + + Logs message to the Unity Console using default logger. + + + + + + + + + Logs message to the Unity Console using default logger. + + + + + + + + + Logs message to the Unity Console using default logger. + + + + + + + + + A variant of ILogger.Log that logs an error message. + + + + + + + + A variant of ILogger.Log that logs an error message. + + + + + + + + A variant of ILogger.Log that logs an exception message. + + + + + + Logs a formatted message. + + + + + + + + A variant of Logger.Log that logs an warning message. + + + + + + + + A variant of Logger.Log that logs an warning message. + + + + + + + + Interface for custom log handler implementation. + + + + + A variant of ILogHandler.LogFormat that logs an exception message. + + Runtime Exception. + Object to which the message applies. + + + + Logs a formatted message. + + The type of the log message. + Object to which the message applies. + A composite format string. + Format arguments. + + + + This class provides utility and extension methods to convert image data from or to PNG, EXR, TGA, and JPEG formats. + + + + + Encodes this texture into the EXR format. + + The texture to convert. + Flags used to control compression and the output format. + + + + Encodes this texture into JPG format. + + Text texture to convert. + JPG quality to encode with, 1..100 (default 75). + + + + Encodes this texture into JPG format. + + Text texture to convert. + JPG quality to encode with, 1..100 (default 75). + + + + Encodes this texture into PNG format. + + The texture to convert. + + + + Encodes the specified texture in TGA format. + + The texture to encode. + + + + Loads PNG/JPG image byte array into a texture. + + The byte array containing the image data to load. + Set to false by default, pass true to optionally mark the texture as non-readable. + The texture to load the image into. + + Returns true if the data can be loaded, false otherwise. + + + + + Any Image Effect with this attribute will be rendered after Dynamic Resolution stage. + + + + + Any Image Effect with this attribute can be rendered into the Scene view camera. + + + + + Any Image Effect with this attribute will be rendered after opaque geometry but before transparent geometry. + + + + + When using HDR rendering it can sometime be desirable to switch to LDR rendering during ImageEffect rendering. + + + + + How image and text is placed inside GUIStyle. + + + + + Image is above the text. + + + + + Image is to the left of the text. + + + + + Only the image is displayed. + + + + + Only the text is displayed. + + + + + Controls IME input. + + + + + Enable IME input only when a text field is selected (default). + + + + + Disable IME input. + + + + + Enable IME input. + + + + + Interface into the Input system. + + + + + Last measured linear acceleration of a device in three-dimensional space. (Read Only) + + + + + Number of acceleration measurements which occurred during last frame. + + + + + Returns list of acceleration measurements which occurred during the last frame. (Read Only) (Allocates temporary variables). + + + + + Is any key or mouse button currently held down? (Read Only) + + + + + Returns true the first frame the user hits any key or mouse button. (Read Only) + + + + + Should Back button quit the application? + +Only usable on Android, Windows Phone or Windows Tablets. + + + + + Property for accessing compass (handheld devices only). (Read Only) + + + + + This property controls if input sensors should be compensated for screen orientation. + + + + + The current text input position used by IMEs to open windows. + + + + + The current IME composition string being typed by the user. + + + + + Device physical orientation as reported by OS. (Read Only) + + + + + Property indicating whether keypresses are eaten by a textinput if it has focus (default true). + + + + + Returns default gyroscope. + + + + + Controls enabling and disabling of IME input composition. + + + + + Does the user have an IME keyboard input source selected? + + + + + Returns the keyboard input entered this frame. (Read Only) + + + + + Property for accessing device location (handheld devices only). (Read Only) + + + + + The current mouse position in pixel coordinates. (Read Only) + + + + + Indicates if a mouse device is detected. + + + + + The current mouse scroll delta. (Read Only) + + + + + Property indicating whether the system handles multiple touches. + + + + + Enables/Disables mouse simulation with touches. By default this option is enabled. + + + + + Returns true when Stylus Touch is supported by a device or platform. + + + + + Number of touches. Guaranteed not to change throughout the frame. (Read Only) + + + + + Returns list of objects representing status of all touches during last frame. (Read Only) (Allocates temporary variables). + + + + + Bool value which let's users check if touch pressure is supported. + + + + + Returns whether the device on which application is currently running supports touch input. + + + + + Returns specific acceleration measurement which occurred during last frame. (Does not allocate temporary variables). + + + + + + Returns the value of the virtual axis identified by axisName. + + + + + + Returns the value of the virtual axis identified by axisName with no smoothing filtering applied. + + + + + + Returns true while the virtual button identified by buttonName is held down. + + The name of the button such as Jump. + + True when an axis has been pressed and not released. + + + + + Returns true during the frame the user pressed down the virtual button identified by buttonName. + + + + + + Returns true the first frame the user releases the virtual button identified by buttonName. + + + + + + Returns an array of strings describing the connected joysticks. + + + + + Returns true while the user holds down the key identified by name. + + + + + + Returns true while the user holds down the key identified by the key KeyCode enum parameter. + + + + + + Returns true during the frame the user starts pressing down the key identified by name. + + + + + + Returns true during the frame the user starts pressing down the key identified by the key KeyCode enum parameter. + + + + + + Returns true during the frame the user releases the key identified by name. + + + + + + Returns true during the frame the user releases the key identified by the key KeyCode enum parameter. + + + + + + Returns whether the given mouse button is held down. + + + + + + Returns true during the frame the user pressed the given mouse button. + + + + + + Returns true during the frame the user releases the given mouse button. + + + + + + Call Input.GetTouch to obtain a Touch struct. + + The touch input on the device screen. + + Touch details in the struct. + + + + + Determine whether a particular joystick model has been preconfigured by Unity. (Linux-only). + + The name of the joystick to check (returned by Input.GetJoystickNames). + + True if the joystick layout has been preconfigured; false otherwise. + + + + + Resets all input. After ResetInputAxes all axes return to 0 and all buttons return to 0 for one frame. + + + + + ActivityIndicator Style (iOS Specific). + + + + + Do not show ActivityIndicator. + + + + + The standard gray style of indicator (UIActivityIndicatorViewStyleGray). + + + + + The standard white style of indicator (UIActivityIndicatorViewStyleWhite). + + + + + The large white style of indicator (UIActivityIndicatorViewStyleWhiteLarge). + + + + + ADBannerView is a wrapper around the ADBannerView class found in the Apple iAd framework and is only available on iOS. + + + + + Banner layout. + + + + + Checks if banner contents are loaded. + + + + + The position of the banner view. + + + + + The size of the banner view. + + + + + Banner visibility. Initially banner is not visible. + + + + + Will be fired when banner ad failed to load. + + + + + Will be fired when banner was clicked. + + + + + Will be fired when banner loaded new ad. + + + + + Creates a banner view with given type and auto-layout params. + + + + + + + Checks if the banner type is available (e.g. MediumRect is available only starting with ios6). + + + + + + Specifies how banner should be layed out on screen. + + + + + Traditional Banner: align to screen bottom. + + + + + Rect Banner: align to screen bottom, placing at the center. + + + + + Rect Banner: place in bottom-left corner. + + + + + Rect Banner: place in bottom-right corner. + + + + + Rect Banner: place exactly at screen center. + + + + + Rect Banner: align to screen left, placing at the center. + + + + + Rect Banner: align to screen right, placing at the center. + + + + + Completely manual positioning. + + + + + Traditional Banner: align to screen top. + + + + + Rect Banner: align to screen top, placing at the center. + + + + + Rect Banner: place in top-left corner. + + + + + Rect Banner: place in top-right corner. + + + + + The type of the banner view. + + + + + Traditional Banner (it takes full screen width). + + + + + Rect Banner (300x250). + + + + + ADInterstitialAd is a wrapper around the ADInterstitialAd class found in the Apple iAd framework and is only available on iPad. + + + + + Checks if InterstitialAd is available (it is available on iPad since iOS 4.3, and on iPhone since iOS 7.0). + + + + + Has the interstitial ad object downloaded an advertisement? (Read Only) + + + + + Creates an interstitial ad. + + + + + + Creates an interstitial ad. + + + + + + Will be called when ad is ready to be shown. + + + + + Will be called when user viewed ad contents: i.e. they went past the initial screen. Please note that it is impossible to determine if they clicked on any links in ad sequences that follows the initial screen. + + + + + Reload advertisement. + + + + + Shows full-screen advertisement to user. + + + + + Specify calendar types. + + + + + Identifies the Buddhist calendar. + + + + + Identifies the Chinese calendar. + + + + + Identifies the Gregorian calendar. + + + + + Identifies the Hebrew calendar. + + + + + Identifies the Indian calendar. + + + + + Identifies the Islamic calendar. + + + + + Identifies the Islamic civil calendar. + + + + + Identifies the ISO8601. + + + + + Identifies the Japanese calendar. + + + + + Identifies the Persian calendar. + + + + + Identifies the Republic of China (Taiwan) calendar. + + + + + Specify calendrical units. + + + + + Specifies the day unit. + + + + + Specifies the era unit. + + + + + Specifies the hour unit. + + + + + Specifies the minute unit. + + + + + Specifies the month unit. + + + + + Specifies the quarter of the calendar. + + + + + Specifies the second unit. + + + + + Specifies the week unit. + + + + + Specifies the weekday unit. + + + + + Specifies the ordinal weekday unit. + + + + + Specifies the year unit. + + + + + Interface into iOS specific functionality. + + + + + Advertising ID. + + + + + Is advertising tracking enabled. + + + + + Defer system gestures until the second swipe on specific edges. + + + + + The generation of the device. (Read Only) + + + + + Specifies whether the home button should be hidden in the iOS build of this application. + + + + + iOS version. + + + + + Vendor ID. + + + + + Request App Store rating and review from the user. + + + Value indicating whether the underlying API is available or not. False indicates that the iOS version isn't recent enough or that the StoreKit framework is not linked with the app. + + + + + Reset "no backup" file flag: file will be synced with iCloud/iTunes backup and can be deleted by OS in low storage situations. + + + + + + Set file flag to be excluded from iCloud/iTunes backup. + + + + + + iOS device generation. + + + + + iPad, first generation. + + + + + iPad, second generation. + + + + + iPad, third generation. + + + + + iPad, fourth generation. + + + + + iPad Air, fifth generation. + + + + + iPad Air. + + + + + iPad Air 2. + + + + + iPadMini, first generation. + + + + + iPadMini Retina, second generation. + + + + + iPad Mini 3. + + + + + iPad Mini, fourth generation. + + + + + iPad Pro 9.7", first generation. + + + + + iPad Pro 10.5", second generation 10" iPad. + + + + + iPad Pro 11". + + + + + iPad Pro 12.9", first generation. + + + + + iPad Pro 12.9", second generation. + + + + + iPad Pro 12.9", third generation. + + + + + Yet unknown iPad. + + + + + iPhone, first generation. + + + + + iPhone 11. + + + + + iPhone 11 Pro. + + + + + iPhone 11 Pro Max. + + + + + iPhone, second generation. + + + + + iPhone, third generation. + + + + + iPhone, fourth generation. + + + + + iPhone, fifth generation. + + + + + iPhone5. + + + + + iPhone 5C. + + + + + iPhone 5S. + + + + + iPhone 6. + + + + + iPhone 6 plus. + + + + + iPhone 6S. + + + + + iPhone 6S Plus. + + + + + iPhone 7. + + + + + iPhone 7 Plus. + + + + + iPhone 8. + + + + + iPhone 8 Plus. + + + + + iPhone SE, first generation. + + + + + Yet unknown iPhone. + + + + + iPhone X. + + + + + iPhone XR. + + + + + iPhone XS. + + + + + iPhone XSMax. + + + + + iPod Touch, first generation. + + + + + iPod Touch, second generation. + + + + + iPod Touch, third generation. + + + + + iPod Touch, fourth generation. + + + + + iPod Touch, fifth generation. + + + + + iPod Touch, sixth generation. + + + + + Yet unknown iPod Touch. + + + + + iOS.LocalNotification is a wrapper around the UILocalNotification class found in the Apple UIKit framework and is only available on iPhoneiPadiPod Touch. + + + + + The title of the action button or slider. + + + + + The message displayed in the notification alert. + + + + + Identifies the image used as the launch image when the user taps the action button. + + + + + A short description of the reason for the alert. + + + + + The number to display as the application's icon badge. + + + + + The default system sound. (Read Only) + + + + + The date and time when the system should deliver the notification. + + + + + A boolean value that controls whether the alert action is visible or not. + + + + + The calendar type (Gregorian, Chinese, etc) to use for rescheduling the notification. + + + + + The calendar interval at which to reschedule the notification. + + + + + The name of the sound file to play when an alert is displayed. + + + + + The time zone of the notification's fire date. + + + + + A dictionary for passing custom information to the notified application. + + + + + Creates a new local notification. + + + + + NotificationServices is only available on iPhoneiPadiPod Touch. + + + + + Device token received from Apple Push Service after calling NotificationServices.RegisterForRemoteNotificationTypes. (Read Only) + + + + + Enabled local and remote notification types. + + + + + The number of received local notifications. (Read Only) + + + + + The list of objects representing received local notifications. (Read Only) + + + + + Returns an error that might occur on registration for remote notifications via NotificationServices.RegisterForRemoteNotificationTypes. (Read Only) + + + + + The number of received remote notifications. (Read Only) + + + + + The list of objects representing received remote notifications. (Read Only) + + + + + All currently scheduled local notifications. + + + + + Cancels the delivery of all scheduled local notifications. + + + + + Cancels the delivery of the specified scheduled local notification. + + + + + + Discards of all received local notifications. + + + + + Discards of all received remote notifications. + + + + + Returns an object representing a specific local notification. (Read Only) + + + + + + Returns an object representing a specific remote notification. (Read Only) + + + + + + Presents a local notification immediately. + + + + + + Register to receive local and remote notifications of the specified types from a provider via Apple Push Service. + + Notification types to register for. + Specify true to also register for remote notifications. + + + + Register to receive local and remote notifications of the specified types from a provider via Apple Push Service. + + Notification types to register for. + Specify true to also register for remote notifications. + + + + Schedules a local notification. + + + + + + Unregister for remote notifications. + + + + + Specifies local and remote notification types. + + + + + Notification is an alert message. + + + + + Notification is a badge shown above the application's icon. + + + + + No notification types specified. + + + + + Notification is an alert sound. + + + + + On Demand Resources API. + + + + + Indicates whether player was built with "Use On Demand Resources" player setting enabled. + + + + + Creates an On Demand Resources (ODR) request. + + Tags for On Demand Resources that should be included in the request. + + Object representing ODR request. + + + + + Represents a request for On Demand Resources (ODR). It's an AsyncOperation and can be yielded in a coroutine. + + + + + Returns an error after operation is complete. + + + + + Sets the priority for request. + + + + + Release all resources kept alive by On Demand Resources (ODR) request. + + + + + Gets file system's path to the resource available in On Demand Resources (ODR) request. + + Resource name. + + + + RemoteNotification is only available on iPhoneiPadiPod Touch. + + + + + The message displayed in the notification alert. (Read Only) + + + + + A short description of the reason for the alert. (Read Only) + + + + + The number to display as the application's icon badge. (Read Only) + + + + + A boolean value that controls whether the alert action is visible or not. (Read Only) + + + + + The name of the sound file to play when an alert is displayed. (Read Only) + + + + + A dictionary for passing custom information to the notified application. (Read Only) + + + + + Bit-mask used to control the deferring of system gestures on iOS. + + + + + Identifies all screen edges. + + + + + Identifies bottom screen edge. + + + + + Identifies left screen edge. + + + + + Disables gesture deferring on all edges. + + + + + Identifies right screen edge. + + + + + Identifies top screen edge. + + + + + Interface to receive callbacks upon serialization and deserialization. + + + + + Implement this method to receive a callback after Unity deserializes your object. + + + + + Implement this method to receive a callback before Unity serializes your object. + + + + + IJobParallelForTransform. + + + + + Execute. + + Index. + TransformAccessArray. + + + + Extension methods for IJobParallelForTransform. + + + + + Schedule. + + Job data. + TransformAccessArray. + Job handle dependency. + + Job handle. + + + + + Position, rotation and scale of an object. + + + + + The position of the transform relative to the parent. + + + + + The rotation of the transform relative to the parent transform's rotation. + + + + + The scale of the transform relative to the parent. + + + + + The position of the transform in world space. + + + + + The rotation of the transform in world space stored as a Quaternion. + + + + + TransformAccessArray. + + + + + Returns array capacity. + + + + + isCreated. + + + + + Length. + + + + + Add. + + Transform. + + + + Allocate. + + Capacity. + Desired job count. + TransformAccessArray. + + + + Constructor. + + Transforms. + Desired job count. + Capacity. + + + + Constructor. + + Transforms. + Desired job count. + Capacity. + + + + Dispose. + + + + + Remove item at index. + + Index. + + + + Set transforms. + + Transforms. + + + + Array indexer. + + + + + Joint is the base class for all joints. + + + + + The Position of the anchor around which the joints motion is constrained. + + + + + Should the connectedAnchor be calculated automatically? + + + + + The Direction of the axis around which the body is constrained. + + + + + The force that needs to be applied for this joint to break. + + + + + The torque that needs to be applied for this joint to break. To be able to break, a joint must be _Locked_ or _Limited_ on the axis of rotation where the torque is being applied. This means that some joints cannot break, such as an unconstrained Configurable Joint. + + + + + Position of the anchor relative to the connected Rigidbody. + + + + + A reference to another rigidbody this joint connects to. + + + + + The scale to apply to the inverse mass and inertia tensor of the connected body prior to solving the constraints. + + + + + The force applied by the solver to satisfy all constraints. + + + + + The torque applied by the solver to satisfy all constraints. + + + + + Enable collision between bodies connected with the joint. + + + + + Toggle preprocessing for this joint. + + + + + The scale to apply to the inverse mass and inertia tensor of the body prior to solving the constraints. + + + + + Parent class for joints to connect Rigidbody2D objects. + + + + + The Rigidbody2D attached to the Joint2D. + + + + + The force that needs to be applied for this joint to break. + + + + + The torque that needs to be applied for this joint to break. + + + + + Can the joint collide with the other Rigidbody2D object to which it is attached? + + + + + The Rigidbody2D object to which the other end of the joint is attached (ie, the object without the joint component). + + + + + Should the two rigid bodies connected with this joint collide with each other? + + + + + Gets the reaction force of the joint. + + + + + Gets the reaction torque of the joint. + + + + + Gets the reaction force of the joint given the specified timeStep. + + The time to calculate the reaction force for. + + The reaction force of the joint in the specified timeStep. + + + + + Gets the reaction torque of the joint given the specified timeStep. + + The time to calculate the reaction torque for. + + The reaction torque of the joint in the specified timeStep. + + + + + Angular limits on the rotation of a Rigidbody2D object around a HingeJoint2D. + + + + + Upper angular limit of rotation. + + + + + Lower angular limit of rotation. + + + + + How the joint's movement will behave along its local X axis. + + + + + Amount of force applied to push the object toward the defined direction. + + + + + Whether the drive should attempt to reach position, velocity, both or nothing. + + + + + Resistance strength against the Position Spring. Only used if mode includes Position. + + + + + Strength of a rubber-band pull toward the defined direction. Only used if mode includes Position. + + + + + The ConfigurableJoint attempts to attain position / velocity targets based on this flag. + + + + + Don't apply any forces to reach the target. + + + + + Try to reach the specified target position. + + + + + Try to reach the specified target position and velocity. + + + + + Try to reach the specified target velocity. + + + + + JointLimits is used by the HingeJoint to limit the joints angle. + + + + + The minimum impact velocity which will cause the joint to bounce. + + + + + Determines the size of the bounce when the joint hits it's limit. Also known as restitution. + + + + + Distance inside the limit value at which the limit will be considered to be active by the solver. + + + + + The upper angular limit (in degrees) of the joint. + + + + + The lower angular limit (in degrees) of the joint. + + + + + Represents the state of a joint limit. + + + + + Represents a state where the joint limit is at the specified lower and upper limits (they are identical). + + + + + Represents a state where the joint limit is inactive. + + + + + Represents a state where the joint limit is at the specified lower limit. + + + + + Represents a state where the joint limit is at the specified upper limit. + + + + + The JointMotor is used to motorize a joint. + + + + + The motor will apply a force. + + + + + If freeSpin is enabled the motor will only accelerate but never slow down. + + + + + The motor will apply a force up to force to achieve targetVelocity. + + + + + Parameters for the optional motor force applied to a Joint2D. + + + + + The maximum force that can be applied to the Rigidbody2D at the joint to attain the target speed. + + + + + The desired speed for the Rigidbody2D to reach as it moves with the joint. + + + + + Determines how to snap physics joints back to its constrained position when it drifts off too much. + + + + + Don't snap at all. + + + + + Snap both position and rotation. + + + + + Snap Position only. + + + + + JointSpring is used add a spring force to HingeJoint and PhysicMaterial. + + + + + The damper force uses to dampen the spring. + + + + + The spring forces used to reach the target position. + + + + + The target position the joint attempts to reach. + + + + + Joint suspension is used to define how suspension works on a WheelJoint2D. + + + + + The world angle (in degrees) along which the suspension will move. + + + + + The amount by which the suspension spring force is reduced in proportion to the movement speed. + + + + + The frequency at which the suspension spring oscillates. + + + + + Motion limits of a Rigidbody2D object along a SliderJoint2D. + + + + + Maximum distance the Rigidbody2D object can move from the Slider Joint's anchor. + + + + + Minimum distance the Rigidbody2D object can move from the Slider Joint's anchor. + + + + + Utility functions for working with JSON data. + + + + + Create an object from its JSON representation. + + The JSON representation of the object. + + An instance of the object. + + + + + Create an object from its JSON representation. + + The JSON representation of the object. + The type of object represented by the Json. + + An instance of the object. + + + + + Overwrite data in an object by reading from its JSON representation. + + The JSON representation of the object. + The object that should be overwritten. + + + + Generate a JSON representation of the public fields of an object. + + The object to convert to JSON form. + If true, format the output for readability. If false, format the output for minimum size. Default is false. + + The object's data in JSON format. + + + + + Generate a JSON representation of the public fields of an object. + + The object to convert to JSON form. + If true, format the output for readability. If false, format the output for minimum size. Default is false. + + The object's data in JSON format. + + + + + Key codes returned by Event.keyCode. These map directly to a physical key on the keyboard. + + + + + 'a' key. + + + + + The '0' key on the top of the alphanumeric keyboard. + + + + + The '1' key on the top of the alphanumeric keyboard. + + + + + The '2' key on the top of the alphanumeric keyboard. + + + + + The '3' key on the top of the alphanumeric keyboard. + + + + + The '4' key on the top of the alphanumeric keyboard. + + + + + The '5' key on the top of the alphanumeric keyboard. + + + + + The '6' key on the top of the alphanumeric keyboard. + + + + + The '7' key on the top of the alphanumeric keyboard. + + + + + The '8' key on the top of the alphanumeric keyboard. + + + + + The '9' key on the top of the alphanumeric keyboard. + + + + + Alt Gr key. + + + + + Ampersand key '&'. + + + + + Asterisk key '*'. + + + + + At key '@'. + + + + + 'b' key. + + + + + Back quote key '`'. + + + + + Backslash key '\'. + + + + + The backspace key. + + + + + Break key. + + + + + 'c' key. + + + + + Capslock key. + + + + + Caret key '^'. + + + + + The Clear key. + + + + + Colon ':' key. + + + + + Comma ',' key. + + + + + 'd' key. + + + + + The forward delete key. + + + + + Dollar sign key '$'. + + + + + Double quote key '"'. + + + + + Down arrow key. + + + + + 'e' key. + + + + + End key. + + + + + Equals '=' key. + + + + + Escape key. + + + + + Exclamation mark key '!'. + + + + + 'f' key. + + + + + F1 function key. + + + + + F10 function key. + + + + + F11 function key. + + + + + F12 function key. + + + + + F13 function key. + + + + + F14 function key. + + + + + F15 function key. + + + + + F2 function key. + + + + + F3 function key. + + + + + F4 function key. + + + + + F5 function key. + + + + + F6 function key. + + + + + F7 function key. + + + + + F8 function key. + + + + + F9 function key. + + + + + 'g' key. + + + + + Greater than '>' key. + + + + + 'h' key. + + + + + Hash key '#'. + + + + + Help key. + + + + + Home key. + + + + + 'i' key. + + + + + Insert key key. + + + + + 'j' key. + + + + + Button 0 on first joystick. + + + + + Button 1 on first joystick. + + + + + Button 10 on first joystick. + + + + + Button 11 on first joystick. + + + + + Button 12 on first joystick. + + + + + Button 13 on first joystick. + + + + + Button 14 on first joystick. + + + + + Button 15 on first joystick. + + + + + Button 16 on first joystick. + + + + + Button 17 on first joystick. + + + + + Button 18 on first joystick. + + + + + Button 19 on first joystick. + + + + + Button 2 on first joystick. + + + + + Button 3 on first joystick. + + + + + Button 4 on first joystick. + + + + + Button 5 on first joystick. + + + + + Button 6 on first joystick. + + + + + Button 7 on first joystick. + + + + + Button 8 on first joystick. + + + + + Button 9 on first joystick. + + + + + Button 0 on second joystick. + + + + + Button 1 on second joystick. + + + + + Button 10 on second joystick. + + + + + Button 11 on second joystick. + + + + + Button 12 on second joystick. + + + + + Button 13 on second joystick. + + + + + Button 14 on second joystick. + + + + + Button 15 on second joystick. + + + + + Button 16 on second joystick. + + + + + Button 17 on second joystick. + + + + + Button 18 on second joystick. + + + + + Button 19 on second joystick. + + + + + Button 2 on second joystick. + + + + + Button 3 on second joystick. + + + + + Button 4 on second joystick. + + + + + Button 5 on second joystick. + + + + + Button 6 on second joystick. + + + + + Button 7 on second joystick. + + + + + Button 8 on second joystick. + + + + + Button 9 on second joystick. + + + + + Button 0 on third joystick. + + + + + Button 1 on third joystick. + + + + + Button 10 on third joystick. + + + + + Button 11 on third joystick. + + + + + Button 12 on third joystick. + + + + + Button 13 on third joystick. + + + + + Button 14 on third joystick. + + + + + Button 15 on third joystick. + + + + + Button 16 on third joystick. + + + + + Button 17 on third joystick. + + + + + Button 18 on third joystick. + + + + + Button 19 on third joystick. + + + + + Button 2 on third joystick. + + + + + Button 3 on third joystick. + + + + + Button 4 on third joystick. + + + + + Button 5 on third joystick. + + + + + Button 6 on third joystick. + + + + + Button 7 on third joystick. + + + + + Button 8 on third joystick. + + + + + Button 9 on third joystick. + + + + + Button 0 on forth joystick. + + + + + Button 1 on forth joystick. + + + + + Button 10 on forth joystick. + + + + + Button 11 on forth joystick. + + + + + Button 12 on forth joystick. + + + + + Button 13 on forth joystick. + + + + + Button 14 on forth joystick. + + + + + Button 15 on forth joystick. + + + + + Button 16 on forth joystick. + + + + + Button 17 on forth joystick. + + + + + Button 18 on forth joystick. + + + + + Button 19 on forth joystick. + + + + + Button 2 on forth joystick. + + + + + Button 3 on forth joystick. + + + + + Button 4 on forth joystick. + + + + + Button 5 on forth joystick. + + + + + Button 6 on forth joystick. + + + + + Button 7 on forth joystick. + + + + + Button 8 on forth joystick. + + + + + Button 9 on forth joystick. + + + + + Button 0 on fifth joystick. + + + + + Button 1 on fifth joystick. + + + + + Button 10 on fifth joystick. + + + + + Button 11 on fifth joystick. + + + + + Button 12 on fifth joystick. + + + + + Button 13 on fifth joystick. + + + + + Button 14 on fifth joystick. + + + + + Button 15 on fifth joystick. + + + + + Button 16 on fifth joystick. + + + + + Button 17 on fifth joystick. + + + + + Button 18 on fifth joystick. + + + + + Button 19 on fifth joystick. + + + + + Button 2 on fifth joystick. + + + + + Button 3 on fifth joystick. + + + + + Button 4 on fifth joystick. + + + + + Button 5 on fifth joystick. + + + + + Button 6 on fifth joystick. + + + + + Button 7 on fifth joystick. + + + + + Button 8 on fifth joystick. + + + + + Button 9 on fifth joystick. + + + + + Button 0 on sixth joystick. + + + + + Button 1 on sixth joystick. + + + + + Button 10 on sixth joystick. + + + + + Button 11 on sixth joystick. + + + + + Button 12 on sixth joystick. + + + + + Button 13 on sixth joystick. + + + + + Button 14 on sixth joystick. + + + + + Button 15 on sixth joystick. + + + + + Button 16 on sixth joystick. + + + + + Button 17 on sixth joystick. + + + + + Button 18 on sixth joystick. + + + + + Button 19 on sixth joystick. + + + + + Button 2 on sixth joystick. + + + + + Button 3 on sixth joystick. + + + + + Button 4 on sixth joystick. + + + + + Button 5 on sixth joystick. + + + + + Button 6 on sixth joystick. + + + + + Button 7 on sixth joystick. + + + + + Button 8 on sixth joystick. + + + + + Button 9 on sixth joystick. + + + + + Button 0 on seventh joystick. + + + + + Button 1 on seventh joystick. + + + + + Button 10 on seventh joystick. + + + + + Button 11 on seventh joystick. + + + + + Button 12 on seventh joystick. + + + + + Button 13 on seventh joystick. + + + + + Button 14 on seventh joystick. + + + + + Button 15 on seventh joystick. + + + + + Button 16 on seventh joystick. + + + + + Button 17 on seventh joystick. + + + + + Button 18 on seventh joystick. + + + + + Button 19 on seventh joystick. + + + + + Button 2 on seventh joystick. + + + + + Button 3 on seventh joystick. + + + + + Button 4 on seventh joystick. + + + + + Button 5 on seventh joystick. + + + + + Button 6 on seventh joystick. + + + + + Button 7 on seventh joystick. + + + + + Button 8 on seventh joystick. + + + + + Button 9 on seventh joystick. + + + + + Button 0 on eighth joystick. + + + + + Button 1 on eighth joystick. + + + + + Button 10 on eighth joystick. + + + + + Button 11 on eighth joystick. + + + + + Button 12 on eighth joystick. + + + + + Button 13 on eighth joystick. + + + + + Button 14 on eighth joystick. + + + + + Button 15 on eighth joystick. + + + + + Button 16 on eighth joystick. + + + + + Button 17 on eighth joystick. + + + + + Button 18 on eighth joystick. + + + + + Button 19 on eighth joystick. + + + + + Button 2 on eighth joystick. + + + + + Button 3 on eighth joystick. + + + + + Button 4 on eighth joystick. + + + + + Button 5 on eighth joystick. + + + + + Button 6 on eighth joystick. + + + + + Button 7 on eighth joystick. + + + + + Button 8 on eighth joystick. + + + + + Button 9 on eighth joystick. + + + + + Button 0 on any joystick. + + + + + Button 1 on any joystick. + + + + + Button 10 on any joystick. + + + + + Button 11 on any joystick. + + + + + Button 12 on any joystick. + + + + + Button 13 on any joystick. + + + + + Button 14 on any joystick. + + + + + Button 15 on any joystick. + + + + + Button 16 on any joystick. + + + + + Button 17 on any joystick. + + + + + Button 18 on any joystick. + + + + + Button 19 on any joystick. + + + + + Button 2 on any joystick. + + + + + Button 3 on any joystick. + + + + + Button 4 on any joystick. + + + + + Button 5 on any joystick. + + + + + Button 6 on any joystick. + + + + + Button 7 on any joystick. + + + + + Button 8 on any joystick. + + + + + Button 9 on any joystick. + + + + + 'k' key. + + + + + Numeric keypad 0. + + + + + Numeric keypad 1. + + + + + Numeric keypad 2. + + + + + Numeric keypad 3. + + + + + Numeric keypad 4. + + + + + Numeric keypad 5. + + + + + Numeric keypad 6. + + + + + Numeric keypad 7. + + + + + Numeric keypad 8. + + + + + Numeric keypad 9. + + + + + Numeric keypad '/'. + + + + + Numeric keypad Enter. + + + + + Numeric keypad '='. + + + + + Numeric keypad '-'. + + + + + Numeric keypad '*'. + + + + + Numeric keypad '.'. + + + + + Numeric keypad '+'. + + + + + 'l' key. + + + + + Left Alt key. + + + + + Left Command key. + + + + + Left arrow key. + + + + + Left square bracket key '['. + + + + + Left Command key. + + + + + Left Control key. + + + + + Left curly bracket key '{'. + + + + + Left Parenthesis key '('. + + + + + Left shift key. + + + + + Left Windows key. + + + + + Less than '<' key. + + + + + 'm' key. + + + + + Menu key. + + + + + Minus '-' key. + + + + + The Left (or primary) mouse button. + + + + + Right mouse button (or secondary mouse button). + + + + + Middle mouse button (or third button). + + + + + Additional (fourth) mouse button. + + + + + Additional (fifth) mouse button. + + + + + Additional (or sixth) mouse button. + + + + + Additional (or seventh) mouse button. + + + + + 'n' key. + + + + + Not assigned (never returned as the result of a keystroke). + + + + + Numlock key. + + + + + 'o' key. + + + + + 'p' key. + + + + + Page down. + + + + + Page up. + + + + + Pause on PC machines. + + + + + Percent '%' key. + + + + + Period '.' key. + + + + + Pipe '|' key. + + + + + Plus key '+'. + + + + + Print key. + + + + + 'q' key. + + + + + Question mark '?' key. + + + + + Quote key '. + + + + + 'r' key. + + + + + Return key. + + + + + Right Alt key. + + + + + Right Command key. + + + + + Right arrow key. + + + + + Right square bracket key ']'. + + + + + Right Command key. + + + + + Right Control key. + + + + + Right curly bracket key '}'. + + + + + Right Parenthesis key ')'. + + + + + Right shift key. + + + + + Right Windows key. + + + + + 's' key. + + + + + Scroll lock key. + + + + + Semicolon ';' key. + + + + + Slash '/' key. + + + + + Space key. + + + + + Sys Req key. + + + + + 't' key. + + + + + The tab key. + + + + + Tilde '~' key. + + + + + 'u' key. + + + + + Underscore '_' key. + + + + + Up arrow key. + + + + + 'v' key. + + + + + 'w' key. + + + + + 'x' key. + + + + + 'y' key. + + + + + 'z' key. + + + + + A single keyframe that can be injected into an animation curve. + + + + + Sets the incoming tangent for this key. The incoming tangent affects the slope of the curve from the previous key to this key. + + + + + Sets the incoming weight for this key. The incoming weight affects the slope of the curve from the previous key to this key. + + + + + Sets the outgoing tangent for this key. The outgoing tangent affects the slope of the curve from this key to the next key. + + + + + Sets the outgoing weight for this key. The outgoing weight affects the slope of the curve from this key to the next key. + + + + + TangentMode is deprecated. Use AnimationUtility.SetKeyLeftTangentMode or AnimationUtility.SetKeyRightTangentMode instead. + + + + + The time of the keyframe. + + + + + The value of the curve at keyframe. + + + + + Weighted mode for the keyframe. + + + + + Create a keyframe. + + + + + + + Create a keyframe. + + + + + + + + + Create a keyframe. + + + + + + + + + + + Specifies Layers to use in a Physics.Raycast. + + + + + Converts a layer mask value to an integer value. + + + + + Given a set of layer names as defined by either a Builtin or a User Layer in the, returns the equivalent layer mask for all of them. + + List of layer names to convert to a layer mask. + + The layer mask created from the layerNames. + + + + + Implicitly converts an integer to a LayerMask. + + + + + + Given a layer number, returns the name of the layer as defined in either a Builtin or a User Layer in the. + + + + + + Given a layer name, returns the layer index as defined by either a Builtin or a User Layer in the. + + + + + + Enumeration of all the muscles in a leg. + + + + + The foot close-open muscle. + + + + + The foot in-out muscle. + + + + + The last value of the LegDof enum. + + + + + The leg close-open muscle. + + + + + The leg roll in-out muscle. + + + + + The toes up-down muscle. + + + + + The upper leg front-back muscle. + + + + + The upper leg in-out muscle. + + + + + The upper leg roll in-out muscle. + + + + + Script interface for a. + + + + + The strength of the flare. + + + + + The color of the flare. + + + + + The fade speed of the flare. + + + + + The to use. + + + + + Script interface for. + + + + + The size of the area light. + + + + + This property describes the output of the last Global Illumination bake. + + + + + The multiplier that defines the strength of the bounce lighting. + + + + + The color of the light. + + + + + + The color temperature of the light. + Correlated Color Temperature (abbreviated as CCT) is multiplied with the color filter when calculating the final color of a light source. The color temperature of the electromagnetic radiation emitted from an ideal black body is defined as its surface temperature in Kelvin. White is 6500K according to the D65 standard. Candle light is 1800K. + If you want to use lightsUseCCT, lightsUseLinearIntensity has to be enabled to ensure physically correct output. + See Also: GraphicsSettings.lightsUseLinearIntensity, GraphicsSettings.lightsUseCCT. + + + + + + Number of command buffers set up on this light (Read Only). + + + + + The cookie texture projected by the light. + + + + + The size of a directional light's cookie. + + + + + This is used to light certain objects in the Scene selectively. + + + + + The to use for this light. + + + + + The Intensity of a light is multiplied with the Light color. + + + + + Is the light contribution already stored in lightmaps and/or lightprobes (Read Only). Obsolete; replaced by Light-lightmapBakeType. + + + + + Per-light, per-layer shadow culling distances. + + + + + This property describes what part of a light's contribution can be baked. + + + + + Allows you to override the global Shadowmask Mode per light. Only use this with render pipelines that can handle per light Shadowmask modes. Incompatible with the legacy renderers. + + + + + The range of the light. + + + + + How to render the light. + + + + + Controls the amount of artificial softening applied to the edges of shadows cast by directional lights. + + + + + Shadow mapping constant bias. + + + + + The custom resolution of the shadow map. + + + + + Near plane value to use for shadow frustums. + + + + + Shadow mapping normal-based bias. + + + + + Controls the amount of artificial softening applied to the edges of shadows cast by the Point or Spot light. + + + + + The resolution of the shadow map. + + + + + How this light casts shadows + + + + + Strength of light's shadows. + + + + + The angle of the light's spotlight cone in degrees. + + + + + The type of the light. + + + + + Add a command buffer to be executed at a specified place. + + When to execute the command buffer during rendering. + The buffer to execute. + A mask specifying which shadow passes to execute the buffer for. + + + + Add a command buffer to be executed at a specified place. + + When to execute the command buffer during rendering. + The buffer to execute. + A mask specifying which shadow passes to execute the buffer for. + + + + Adds a command buffer to the GPU's async compute queues and executes that command buffer when graphics processing reaches a given point. + + The point during the graphics processing at which this command buffer should commence on the GPU. + The buffer to execute. + The desired async compute queue type to execute the buffer on. + A mask specifying which shadow passes to execute the buffer for. + + + + Adds a command buffer to the GPU's async compute queues and executes that command buffer when graphics processing reaches a given point. + + The point during the graphics processing at which this command buffer should commence on the GPU. + The buffer to execute. + The desired async compute queue type to execute the buffer on. + A mask specifying which shadow passes to execute the buffer for. + + + + Get command buffers to be executed at a specified place. + + When to execute the command buffer during rendering. + + Array of command buffers. + + + + + Remove all command buffers set on this light. + + + + + Remove command buffer from execution at a specified place. + + When to execute the command buffer during rendering. + The buffer to execute. + + + + Remove command buffers from execution at a specified place. + + When to execute the command buffer during rendering. + + + + Revert all light parameters to default. + + + + + Sets a light dirty to notify the light baking backends to update their internal light representation. + + + + + Struct describing the result of a Global Illumination bake for a given light. + + + + + Is the light contribution already stored in lightmaps and/or lightprobes? + + + + + This property describes what part of a light's contribution was baked. + + + + + In case of a LightmapBakeType.Mixed light, describes what Mixed mode was used to bake the light, irrelevant otherwise. + + + + + In case of a LightmapBakeType.Mixed light, contains the index of the occlusion mask channel to use if any, otherwise -1. + + + + + In case of a LightmapBakeType.Mixed light, contains the index of the light as seen from the occlusion probes point of view if any, otherwise -1. + + + + + Enum describing what part of a light contribution can be baked. + + + + + Baked lights cannot move or change in any way during run time. All lighting for static objects gets baked into lightmaps. Lighting and shadows for dynamic objects gets baked into Light Probes. + + + + + Mixed lights allow a mix of realtime and baked lighting, based on the Mixed Lighting Mode used. These lights cannot move, but can change color and intensity at run time. Changes to color and intensity only affect direct lighting as indirect lighting gets baked. If using Subtractive mode, changes to color or intensity are not calculated at run time on static objects. + + + + + Realtime lights cast run time light and shadows. They can change position, orientation, color, brightness, and many other properties at run time. No lighting gets baked into lightmaps or light probes.. + + + + + Data of a lightmap. + + + + + Lightmap storing color of incoming light. + + + + + Lightmap storing dominant direction of incoming light. + + + + + Texture storing occlusion mask per light (ShadowMask, up to four lights). + + + + + Stores lightmaps of the Scene. + + + + + Lightmap array. + + + + + NonDirectional or CombinedDirectional Specular lightmaps rendering mode. + + + + + Holds all data needed by the light probes. + + + + + Lightmap (and lighting) configuration mode, controls how lightmaps interact with lighting and what kind of information they store. + + + + + Directional information for direct light is combined with directional information for indirect light, encoded as 2 lightmaps. + + + + + Light intensity (no directional information), encoded as 1 lightmap. + + + + + Directional information for direct light is stored separately from directional information for indirect light, encoded as 4 lightmaps. + + + + + Single, dual, or directional lightmaps rendering mode, used only in GIWorkflowMode.Legacy + + + + + Directional rendering mode. + + + + + Dual lightmap rendering mode. + + + + + Single, traditional lightmap rendering mode. + + + + + Light Probe Group. + + + + + Removes ringing from probes if enabled. + + + + + Editor only function to access and modify probe positions. + + + + + The Light Probe Proxy Volume component offers the possibility to use higher resolution lighting for large non-static GameObjects. + + + + + The bounding box mode for generating the 3D grid of interpolated Light Probes. + + + + + The world-space bounding box in which the 3D grid of interpolated Light Probes is generated. + + + + + The 3D grid resolution on the z-axis. + + + + + The 3D grid resolution on the y-axis. + + + + + The 3D grid resolution on the z-axis. + + + + + Checks if Light Probe Proxy Volumes are supported. + + + + + The local-space origin of the bounding box in which the 3D grid of interpolated Light Probes is generated. + + + + + Interpolated Light Probe density. + + + + + The mode in which the interpolated Light Probe positions are generated. + + + + + Determines how many Spherical Harmonics bands will be evaluated to compute the ambient color. + + + + + Sets the way the Light Probe Proxy Volume refreshes. + + + + + The resolution mode for generating the grid of interpolated Light Probes. + + + + + The size of the bounding box in which the 3D grid of interpolated Light Probes is generated. + + + + + The bounding box mode for generating a grid of interpolated Light Probes. + + + + + The bounding box encloses the current Renderer and all the relevant Renderers down the hierarchy, in local space. + + + + + The bounding box encloses the current Renderer and all the relevant Renderers down the hierarchy, in world space. + + + + + A custom local-space bounding box is used. The user is able to edit the bounding box. + + + + + The mode in which the interpolated Light Probe positions are generated. + + + + + Divide the volume in cells based on resolution, and generate interpolated Light Probe positions in the center of the cells. + + + + + Divide the volume in cells based on resolution, and generate interpolated Light Probes positions in the corner/edge of the cells. + + + + + An enum describing the Quality option used by the Light Probe Proxy Volume component. + + + + + This option will use only two SH coefficients bands: L0 and L1. The coefficients are sampled from the Light Probe Proxy Volume 3D Texture. Using this option might increase the draw call batch sizes by not having to change the L2 coefficients per Renderer. + + + + + This option will use L0 and L1 SH coefficients from the Light Probe Proxy Volume 3D Texture. The L2 coefficients are constant per Renderer. By having to provide the L2 coefficients, draw call batches might be broken. + + + + + An enum describing the way a Light Probe Proxy Volume refreshes in the Player. + + + + + Automatically detects updates in Light Probes and triggers an update of the Light Probe volume. + + + + + Causes Unity to update the Light Probe Proxy Volume every frame. + + + + + Use this option to indicate that the Light Probe Proxy Volume is never to be automatically updated by Unity. + + + + + The resolution mode for generating a grid of interpolated Light Probes. + + + + + The automatic mode uses a number of interpolated Light Probes per unit area, and uses the bounding volume size to compute the resolution. The final resolution value is a power of 2. + + + + + The custom mode allows you to specify the 3D grid resolution. + + + + + Triggers an update of the Light Probe Proxy Volume. + + + + + Stores light probes for the Scene. + + + + + Coefficients of baked light probes. + + + + + The number of cells space is divided into (Read Only). + + + + + The number of light probes (Read Only). + + + + + Positions of the baked light probes (Read Only). + + + + + Calculate light probes and occlusion probes at the given world space positions. + + The array of world space positions used to evaluate the probes. + The array where the resulting light probes are written to. + The array where the resulting occlusion probes are written to. + + + + Calculate light probes and occlusion probes at the given world space positions. + + The array of world space positions used to evaluate the probes. + The array where the resulting light probes are written to. + The array where the resulting occlusion probes are written to. + + + + Returns an interpolated probe for the given position for both realtime and baked light probes combined. + + + + + + + + How the Light is rendered. + + + + + Automatically choose the render mode. + + + + + Force the Light to be a pixel light. + + + + + Force the Light to be a vertex light. + + + + + Allows mixed lights to control shadow caster culling when Shadowmasks are present. + + + + + Use the global Shadowmask Mode from the quality settings. + + + + + Render all shadow casters into the shadow map. This corresponds with the distance Shadowmask mode. + + + + + Render only non-lightmapped objects into the shadow map. This corresponds with the Shadowmask mode. + + + + + Shadow casting options for a Light. + + + + + Cast "hard" shadows (with no shadow filtering). + + + + + Do not cast shadows (default). + + + + + Cast "soft" shadows (with 4x PCF filtering). + + + + + The type of a Light. + + + + + The light is a directional light. + + + + + The light is a disc shaped area light. It affects only baked lightmaps and lightprobes. + + + + + The light is a point light. + + + + + The light is a rectangle shaped area light. It affects only baked lightmaps and lightprobes. + + + + + The light is a spot light. + + + + + Control the direction lines face, when using the LineRenderer or TrailRenderer. + + + + + Lines face the direction of the Transform Component. + + + + + Lines face the Z axis of the Transform Component. + + + + + Lines face the camera. + + + + + The line renderer is used to draw free-floating lines in 3D space. + + + + + Select whether the line will face the camera, or the orientation of the Transform Component. + + + + + Set the color gradient describing the color of the line at various points along its length. + + + + + Set the color at the end of the line. + + + + + Set the width at the end of the line. + + + + + Configures a line to generate Normals and Tangents. With this data, Scene lighting can affect the line via Normal Maps and the Unity Standard Shader, or your own custom-built Shaders. + + + + + Connect the start and end positions of the line together to form a continuous loop. + + + + + Set this to a value greater than 0, to get rounded corners on each end of the line. + + + + + Set this to a value greater than 0, to get rounded corners between each segment of the line. + + + + + Set the number of line segments. + + + + + Set/get the number of vertices. + + + + + Apply a shadow bias to prevent self-shadowing artifacts. The specified value is the proportion of the line width at each segment. + + + + + Set the color at the start of the line. + + + + + Set the width at the start of the line. + + + + + Choose whether the U coordinate of the line texture is tiled or stretched. + + + + + If enabled, the lines are defined in world space. + + + + + Set the curve describing the width of the line at various points along its length. + + + + + Set an overall multiplier that is applied to the LineRenderer.widthCurve to get the final width of the line. + + + + + Creates a snapshot of LineRenderer and stores it in mesh. + + A static mesh that will receive the snapshot of the line. + The camera used for determining which way camera-space lines will face. + Include the rotation and scale of the Transform in the baked mesh. + + + + Creates a snapshot of LineRenderer and stores it in mesh. + + A static mesh that will receive the snapshot of the line. + The camera used for determining which way camera-space lines will face. + Include the rotation and scale of the Transform in the baked mesh. + + + + Creates a snapshot of LineRenderer and stores it in mesh. + + A static mesh that will receive the snapshot of the line. + The camera used for determining which way camera-space lines will face. + Include the rotation and scale of the Transform in the baked mesh. + + + + Creates a snapshot of LineRenderer and stores it in mesh. + + A static mesh that will receive the snapshot of the line. + The camera used for determining which way camera-space lines will face. + Include the rotation and scale of the Transform in the baked mesh. + + + + Get the position of a vertex in the line. + + The index of the position to retrieve. + + The position at the specified index in the array. + + + + + Get the positions of all vertices in the line. + + The array of positions to retrieve. The array passed should be of at least positionCount in size. + + How many positions were actually stored in the output array. + + + + + Set the line color at the start and at the end. + + + + + + + Set the position of a vertex in the line. + + Which position to set. + The new position. + + + + Set the positions of all vertices in the line. + + The array of positions to set. + + + + Set the number of line segments. + + + + + + Set the line width at the start and at the end. + + + + + + + Generates a simplified version of the original line by removing points that fall within the specified tolerance. + + This value is used to evaluate which points should be removed from the line. A higher value results in a simpler line (less points). A positive value close to zero results in a line with little to no reduction. A value of zero or less has no effect. + + + + Choose how textures are applied to Lines and Trails. + + + + + Map the texture once along the entire length of the line, assuming all vertices are evenly spaced. + + + + + Repeat the texture along the line, repeating at a rate of once per line segment. To adjust the tiling rate, use Material.SetTextureScale. + + + + + Map the texture once along the entire length of the line. + + + + + Repeat the texture along the line, based on its length in world units. To set the tiling rate, use Material.SetTextureScale. + + + + + A collection of common line functions. + + + + + Generates a simplified version of the original line by removing points that fall within the specified tolerance. + + The points that make up the original line. + This value is used to evaluate which points should be removed from the line. A higher value results in a simpler line (less points). A positive value close to zero results in a line with little to no reduction. A value of zero or less has no effect. + Populated by this function. Contains the indexes of the points that should be generate a simplified version.. + Populated by this function. Contains the points that form the simplified line. + + + + Generates a simplified version of the original line by removing points that fall within the specified tolerance. + + The points that make up the original line. + This value is used to evaluate which points should be removed from the line. A higher value results in a simpler line (less points). A positive value close to zero results in a line with little to no reduction. A value of zero or less has no effect. + Populated by this function. Contains the indexes of the points that should be generate a simplified version.. + Populated by this function. Contains the points that form the simplified line. + + + + Generates a simplified version of the original line by removing points that fall within the specified tolerance. + + The points that make up the original line. + This value is used to evaluate which points should be removed from the line. A higher value results in a simpler line (less points). A positive value close to zero results in a line with little to no reduction. A value of zero or less has no effect. + Populated by this function. Contains the indexes of the points that should be generate a simplified version.. + Populated by this function. Contains the points that form the simplified line. + + + + Generates a simplified version of the original line by removing points that fall within the specified tolerance. + + The points that make up the original line. + This value is used to evaluate which points should be removed from the line. A higher value results in a simpler line (less points). A positive value close to zero results in a line with little to no reduction. A value of zero or less has no effect. + Populated by this function. Contains the indexes of the points that should be generate a simplified version.. + Populated by this function. Contains the points that form the simplified line. + + + + An asset to represent a table of localized strings for one specific locale. + + + + + Is this asset used to localize UI components of the Unity Editor + + + + + ISO Code used to identify the locale. ex: en-uk, zh-hans, ja + + + + + Creates a new empty LocalizationAsset object. + + + + + Get the localized string for the specified key. + + Original string acting as key. + + Localized string matching the original in the LocalizationAsset locale + + + + + Set the localized string for the specified key + + Original string acting as key. + Localized string matching the original in the LocalizationAsset locale + + + + Structure describing device location. + + + + + Geographical device location altitude. + + + + + Horizontal accuracy of the location. + + + + + Geographical device location latitude. + + + + + Geographical device location latitude. + + + + + Timestamp (in seconds since 1970) when location was last time updated. + + + + + Vertical accuracy of the location. + + + + + Interface into location functionality. + + + + + Specifies whether location service is enabled in user settings. + + + + + Last measured device geographical location. + + + + + Returns location service status. + + + + + Starts location service updates. Last location coordinates could be. + + + + + + + Starts location service updates. Last location coordinates could be. + + + + + + + Starts location service updates. Last location coordinates could be. + + + + + + + Stops location service updates. This could be useful for saving battery life. + + + + + Describes location service status. + + + + + Location service failed (user denied access to location service). + + + + + Location service is initializing, some time later it will switch to. + + + + + Location service is running and locations could be queried. + + + + + Location service is stopped. + + + + + Structure for building a LOD for passing to the SetLODs function. + + + + + Width of the cross-fade transition zone (proportion to the current LOD's whole length) [0-1]. Only used if it's not animated. + + + + + List of renderers for this LOD level. + + + + + The screen relative height to use for the transition [0-1]. + + + + + Construct a LOD. + + The screen relative height to use for the transition [0-1]. + An array of renderers to use for this LOD level. + + + + The LOD fade modes. Modes other than LODFadeMode.None will result in Unity calculating a blend factor for blending/interpolating between two neighbouring LODs and pass it to your shader. + + + + + Perform cross-fade style blending between the current LOD and the next LOD if the distance to camera falls in the range specified by the LOD.fadeTransitionWidth of each LOD. + + + + + Indicates the LOD fading is turned off. + + + + + By specifying this mode, your LODGroup will perform a SpeedTree-style LOD fading scheme: + + +* For all the mesh LODs other than the last (most crude) mesh LOD, the fade factor is calculated as the percentage of the object's current screen height, compared to the whole range of the LOD. It is 1, if the camera is right at the position where the previous LOD switches out and 0, if the next LOD is just about to switch in. + + +* For the last mesh LOD and the billboard LOD, the cross-fade mode is used. + + + + + LODGroup lets you group multiple Renderers into LOD levels. + + + + + Specify if the cross-fading should be animated by time. The animation duration is specified globally as crossFadeAnimationDuration. + + + + + The cross-fading animation duration in seconds. ArgumentException will be thrown if it is set to zero or a negative value. + + + + + Enable / Disable the LODGroup - Disabling will turn off all renderers. + + + + + The LOD fade mode used. + + + + + The local reference point against which the LOD distance is calculated. + + + + + The number of LOD levels. + + + + + The size of the LOD object in local space. + + + + + + + The LOD level to use. Passing index < 0 will return to standard LOD processing. + + + + Returns the array of LODs. + + + The LOD array. + + + + + Recalculate the bounding region for the LODGroup (Relatively slow, do not call often). + + + + + Set the LODs for the LOD group. This will remove any existing LODs configured on the LODGroup. + + The LODs to use for this group. + + + + Initializes a new instance of the Logger. + + + + + To selective enable debug log message. + + + + + To runtime toggle debug logging [ON/OFF]. + + + + + Set Logger.ILogHandler. + + + + + Create a custom Logger. + + Pass in default log handler or custom log handler. + + + + Check logging is enabled based on the LogType. + + The type of the log message. + + Retrun true in case logs of LogType will be logged otherwise returns false. + + + + + Logs message to the Unity Console using default logger. + + The type of the log message. + Used to identify the source of a log message. It usually identifies the class where the log call occurs. + String or object to be converted to string representation for display. + Object to which the message applies. + + + + Logs message to the Unity Console using default logger. + + The type of the log message. + Used to identify the source of a log message. It usually identifies the class where the log call occurs. + String or object to be converted to string representation for display. + Object to which the message applies. + + + + Logs message to the Unity Console using default logger. + + The type of the log message. + Used to identify the source of a log message. It usually identifies the class where the log call occurs. + String or object to be converted to string representation for display. + Object to which the message applies. + + + + Logs message to the Unity Console using default logger. + + The type of the log message. + Used to identify the source of a log message. It usually identifies the class where the log call occurs. + String or object to be converted to string representation for display. + Object to which the message applies. + + + + Logs message to the Unity Console using default logger. + + The type of the log message. + Used to identify the source of a log message. It usually identifies the class where the log call occurs. + String or object to be converted to string representation for display. + Object to which the message applies. + + + + Logs message to the Unity Console using default logger. + + The type of the log message. + Used to identify the source of a log message. It usually identifies the class where the log call occurs. + String or object to be converted to string representation for display. + Object to which the message applies. + + + + Logs message to the Unity Console using default logger. + + The type of the log message. + Used to identify the source of a log message. It usually identifies the class where the log call occurs. + String or object to be converted to string representation for display. + Object to which the message applies. + + + + A variant of Logger.Log that logs an error message. + + Used to identify the source of a log message. It usually identifies the class where the log call occurs. + String or object to be converted to string representation for display. + Object to which the message applies. + + + + A variant of Logger.Log that logs an error message. + + Used to identify the source of a log message. It usually identifies the class where the log call occurs. + String or object to be converted to string representation for display. + Object to which the message applies. + + + + A variant of Logger.Log that logs an exception message. + + Runtime Exception. + Object to which the message applies. + + + + A variant of Logger.Log that logs an exception message. + + Runtime Exception. + Object to which the message applies. + + + + Logs a formatted message. + + The type of the log message. + Object to which the message applies. + A composite format string. + Format arguments. + + + + Logs a formatted message. + + The type of the log message. + Object to which the message applies. + A composite format string. + Format arguments. + + + + A variant of Logger.Log that logs an warning message. + + Used to identify the source of a log message. It usually identifies the class where the log call occurs. + String or object to be converted to string representation for display. + Object to which the message applies. + + + + A variant of Logger.Log that logs an warning message. + + Used to identify the source of a log message. It usually identifies the class where the log call occurs. + String or object to be converted to string representation for display. + Object to which the message applies. + + + + The type of the log message in Debug.unityLogger.Log or delegate registered with Application.RegisterLogCallback. + + + + + LogType used for Asserts. (These could also indicate an error inside Unity itself.) + + + + + LogType used for Errors. + + + + + LogType used for Exceptions. + + + + + LogType used for regular log messages. + + + + + LogType used for Warnings. + + + + + The Master Server is used to make matchmaking between servers and clients easy. + + + + + Report this machine as a dedicated server. + + + + + The IP address of the master server. + + + + + The connection port of the master server. + + + + + Set the minimum update rate for master server host information update. + + + + + Clear the host list which was received by MasterServer.PollHostList. + + + + + Check for the latest host list received by using MasterServer.RequestHostList. + + + + + Register this server on the master server. + + + + + + + + Register this server on the master server. + + + + + + + + Request a host list from the master server. + + + + + + Unregister this server from the master server. + + + + + Describes status messages from the master server as returned in MonoBehaviour.OnMasterServerEvent|OnMasterServerEvent. + + + + + Use this struct to specify the position and rotation weight mask for Animator.MatchTarget. + + + + + Position XYZ weight. + + + + + Rotation weight. + + + + + MatchTargetWeightMask contructor. + + Position XYZ weight. + Rotation weight. + + + + The material class. + + + + + The main material's color. + + + + + Gets and sets whether the Double Sided Global Illumination setting is enabled for this material. + + + + + Gets and sets whether GPU instancing is enabled for this material. + + + + + Defines how the material should interact with lightmaps and lightprobes. + + + + + The material's texture. + + + + + The texture offset of the main texture. + + + + + The texture scale of the main texture. + + + + + How many passes are in this material (Read Only). + + + + + Render queue of this material. + + + + + The shader used by the material. + + + + + Additional shader keywords set by this material. + + + + + Copy properties from other material into this material. + + + + + + + + + + + + Create a temporary Material. + + Create a material with a given Shader. + Create a material by copying all properties from another material. + + + + Create a temporary Material. + + Create a material with a given Shader. + Create a material by copying all properties from another material. + + + + Unset a shader keyword. + + + + + + Sets a shader keyword that is enabled by this material. + + + + + + Returns the index of the pass passName. + + + + + + Get a named color value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get a named color value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get a named color array. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get a named color array. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Fetch a named color array into a list. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The list to hold the returned array. + + + + Fetch a named color array into a list. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The list to hold the returned array. + + + + Get a named float value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get a named float value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get a named float array. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + + + + Get a named float array. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + + + + Fetch a named float array into a list. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The list to hold the returned array. + + + + Fetch a named float array into a list. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The list to hold the returned array. + + + + Get a named integer value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get a named integer value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get a named matrix value from the shader. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get a named matrix value from the shader. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get a named matrix array. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + + + + Get a named matrix array. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + + + + Fetch a named matrix array into a list. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The list to hold the returned array. + + + + Fetch a named matrix array into a list. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The list to hold the returned array. + + + + Returns the name of the shader pass at index pass. + + + + + + Checks whether a given Shader pass is enabled on this Material. + + Shader pass name (case insensitive). + + True if the Shader pass is enabled. + + + + + Get the value of material's shader tag. + + + + + + + + Get the value of material's shader tag. + + + + + + + + Get a named texture. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get a named texture. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Gets the placement offset of texture propertyName. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Gets the placement offset of texture propertyName. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Return the name IDs of all texture properties exposed on this material. + + IDs of all texture properties exposed on this material. + + IDs of all texture properties exposed on this material. + + + + + Return the name IDs of all texture properties exposed on this material. + + IDs of all texture properties exposed on this material. + + IDs of all texture properties exposed on this material. + + + + + Returns the names of all texture properties exposed on this material. + + Names of all texture properties exposed on this material. + + Names of all texture properties exposed on this material. + + + + + Returns the names of all texture properties exposed on this material. + + Names of all texture properties exposed on this material. + + Names of all texture properties exposed on this material. + + + + + Gets the placement scale of texture propertyName. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Gets the placement scale of texture propertyName. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get a named vector value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get a named vector value. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get a named vector array. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + + + + Get a named vector array. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + + + + Fetch a named vector array into a list. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The list to hold the returned array. + + + + Fetch a named vector array into a list. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The list to hold the returned array. + + + + Checks if material's shader has a property of a given name. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Checks if material's shader has a property of a given name. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Is the shader keyword enabled on this material? + + + + + + Interpolate properties between two materials. + + + + + + + + Sets a named ComputeBuffer value. + + Property name ID, use Shader.PropertyToID to get it. + Property name. + The ComputeBuffer value to set. + + + + Sets a named ComputeBuffer value. + + Property name ID, use Shader.PropertyToID to get it. + Property name. + The ComputeBuffer value to set. + + + + Sets a named color value. + + Property name ID, use Shader.PropertyToID to get it. + Property name, e.g. "_Color". + Color value to set. + + + + Sets a named color value. + + Property name ID, use Shader.PropertyToID to get it. + Property name, e.g. "_Color". + Color value to set. + + + + Sets a color array property. + + Property name. + Property name ID, use Shader.PropertyToID to get it. + Array of values to set. + + + + Sets a color array property. + + Property name. + Property name ID, use Shader.PropertyToID to get it. + Array of values to set. + + + + Sets a color array property. + + Property name. + Property name ID, use Shader.PropertyToID to get it. + Array of values to set. + + + + Sets a color array property. + + Property name. + Property name ID, use Shader.PropertyToID to get it. + Array of values to set. + + + + Sets a named float value. + + Property name ID, use Shader.PropertyToID to get it. + Float value to set. + Property name, e.g. "_Glossiness". + + + + Sets a named float value. + + Property name ID, use Shader.PropertyToID to get it. + Float value to set. + Property name, e.g. "_Glossiness". + + + + Sets a float array property. + + Property name. + Property name ID. Use Shader.PropertyToID to get this ID. + Array of values to set. + + + + Sets a float array property. + + Property name. + Property name ID. Use Shader.PropertyToID to get this ID. + Array of values to set. + + + + Sets a float array property. + + Property name. + Property name ID. Use Shader.PropertyToID to get this ID. + Array of values to set. + + + + Sets a float array property. + + Property name. + Property name ID. Use Shader.PropertyToID to get this ID. + Array of values to set. + + + + Sets a named integer value. + + Property name ID, use Shader.PropertyToID to get it. + Integer value to set. + Property name, e.g. "_SrcBlend". + + + + Sets a named integer value. + + Property name ID, use Shader.PropertyToID to get it. + Integer value to set. + Property name, e.g. "_SrcBlend". + + + + Sets a named matrix for the shader. + + Property name ID, use Shader.PropertyToID to get it. + Property name, e.g. "_CubemapRotation". + Matrix value to set. + + + + Sets a named matrix for the shader. + + Property name ID, use Shader.PropertyToID to get it. + Property name, e.g. "_CubemapRotation". + Matrix value to set. + + + + Sets a matrix array property. + + Property name. + Array of values to set. + Property name ID, use Shader.PropertyToID to get it. + + + + Sets a matrix array property. + + Property name. + Array of values to set. + Property name ID, use Shader.PropertyToID to get it. + + + + Sets a matrix array property. + + Property name. + Array of values to set. + Property name ID, use Shader.PropertyToID to get it. + + + + Sets a matrix array property. + + Property name. + Array of values to set. + Property name ID, use Shader.PropertyToID to get it. + + + + Sets an override tag/value on the material. + + Name of the tag to set. + Name of the value to set. Empty string to clear the override flag. + + + + Activate the given pass for rendering. + + Shader pass number to setup. + + If false is returned, no rendering should be done. + + + + + Enables or disables a Shader pass on a per-Material level. + + Shader pass name (case insensitive). + Flag indicating whether this Shader pass should be enabled. + + + + Sets a named texture. + + Property name ID, use Shader.PropertyToID to get it. + Property name, e.g. "_MainTex". + Texture to set. + + + + Sets a named texture. + + Property name ID, use Shader.PropertyToID to get it. + Property name, e.g. "_MainTex". + Texture to set. + + + + Sets the placement offset of texture propertyName. + + Property name ID, use Shader.PropertyToID to get it. + Property name, for example: "_MainTex". + Texture placement offset. + + + + Sets the placement offset of texture propertyName. + + Property name ID, use Shader.PropertyToID to get it. + Property name, for example: "_MainTex". + Texture placement offset. + + + + Sets the placement scale of texture propertyName. + + Property name ID, use Shader.PropertyToID to get it. + Property name, e.g. "_MainTex". + Texture placement scale. + + + + Sets the placement scale of texture propertyName. + + Property name ID, use Shader.PropertyToID to get it. + Property name, e.g. "_MainTex". + Texture placement scale. + + + + Sets a named vector value. + + Property name ID, use Shader.PropertyToID to get it. + Property name, e.g. "_WaveAndDistance". + Vector value to set. + + + + Sets a named vector value. + + Property name ID, use Shader.PropertyToID to get it. + Property name, e.g. "_WaveAndDistance". + Vector value to set. + + + + Sets a vector array property. + + Property name. + Array of values to set. + Property name ID, use Shader.PropertyToID to get it. + + + + Sets a vector array property. + + Property name. + Array of values to set. + Property name ID, use Shader.PropertyToID to get it. + + + + Sets a vector array property. + + Property name. + Array of values to set. + Property name ID, use Shader.PropertyToID to get it. + + + + Sets a vector array property. + + Property name. + Array of values to set. + Property name ID, use Shader.PropertyToID to get it. + + + + How the material interacts with lightmaps and lightprobes. + + + + + Helper Mask to be used to query the enum only based on whether realtime GI or baked GI is set, ignoring all other bits. + + + + + The emissive lighting affects baked Global Illumination. It emits lighting into baked lightmaps and baked lightprobes. + + + + + The emissive lighting is guaranteed to be black. This lets the lightmapping system know that it doesn't have to extract emissive lighting information from the material and can simply assume it is completely black. + + + + + The emissive lighting does not affect Global Illumination at all. + + + + + The emissive lighting will affect realtime Global Illumination. It emits lighting into realtime lightmaps and realtime lightprobes. + + + + + A block of material values to apply. + + + + + Is the material property block empty? (Read Only) + + + + + Clear material property values. + + + + + This function copies the entire source array into a Vector4 property array named unity_ProbesOcclusion for use with instanced rendering. + + The array of probe occlusion values to copy from. + + + + This function copies the entire source array into a Vector4 property array named unity_ProbesOcclusion for use with instanced rendering. + + The array of probe occlusion values to copy from. + + + + This function copies the source array into a Vector4 property array named unity_ProbesOcclusion with the specified source and destination range for use with instanced rendering. + + The array of probe occlusion values to copy from. + The index of the first element in the source array to copy from. + The index of the first element in the destination MaterialPropertyBlock array to copy to. + The number of elements to copy. + + + + This function copies the source array into a Vector4 property array named unity_ProbesOcclusion with the specified source and destination range for use with instanced rendering. + + The array of probe occlusion values to copy from. + The index of the first element in the source array to copy from. + The index of the first element in the destination MaterialPropertyBlock array to copy to. + The number of elements to copy. + + + + This function converts and copies the entire source array into 7 Vector4 property arrays named unity_SHAr, unity_SHAg, unity_SHAb, unity_SHBr, unity_SHBg, unity_SHBb and unity_SHC for use with instanced rendering. + + The array of SH values to copy from. + + + + This function converts and copies the entire source array into 7 Vector4 property arrays named unity_SHAr, unity_SHAg, unity_SHAb, unity_SHBr, unity_SHBg, unity_SHBb and unity_SHC for use with instanced rendering. + + The array of SH values to copy from. + + + + This function converts and copies the source array into 7 Vector4 property arrays named unity_SHAr, unity_SHAg, unity_SHAb, unity_SHBr, unity_SHBg, unity_SHBb and unity_SHC with the specified source and destination range for use with instanced rendering. + + The array of SH values to copy from. + The index of the first element in the source array to copy from. + The index of the first element in the destination MaterialPropertyBlock array to copy to. + The number of elements to copy. + + + + This function converts and copies the source array into 7 Vector4 property arrays named unity_SHAr, unity_SHAg, unity_SHAb, unity_SHBr, unity_SHBg, unity_SHBb and unity_SHC with the specified source and destination range for use with instanced rendering. + + The array of SH values to copy from. + The index of the first element in the source array to copy from. + The index of the first element in the destination MaterialPropertyBlock array to copy to. + The number of elements to copy. + + + + Get a color from the property block. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get a color from the property block. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get a float from the property block. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get a float from the property block. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get a float array from the property block. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get a float array from the property block. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Fetch a float array from the property block into a list. + + The list to hold the returned array. + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Fetch a float array from the property block into a list. + + The list to hold the returned array. + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get an int from the property block. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get an int from the property block. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get a matrix from the property block. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get a matrix from the property block. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get a matrix array from the property block. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get a matrix array from the property block. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Fetch a matrix array from the property block into a list. + + The list to hold the returned array. + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Fetch a matrix array from the property block into a list. + + The list to hold the returned array. + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get a texture from the property block. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get a texture from the property block. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get a vector from the property block. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get a vector from the property block. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get a vector array from the property block. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Get a vector array from the property block. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Fetch a vector array from the property block into a list. + + The list to hold the returned array. + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Fetch a vector array from the property block into a list. + + The list to hold the returned array. + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Set a ComputeBuffer property. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The ComputeBuffer to set. + + + + Set a ComputeBuffer property. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The ComputeBuffer to set. + + + + Set a color property. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The Color value to set. + + + + Set a color property. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The Color value to set. + + + + Set a float property. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The float value to set. + + + + Set a float property. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The float value to set. + + + + Set a float array property. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The array to set. + + + + Set a float array property. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The array to set. + + + + Set a float array property. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The array to set. + + + + Set a float array property. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The array to set. + + + + Adds a property to the block. If an int property with the given name already exists, the old value is replaced. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The int value to set. + + + + Adds a property to the block. If an int property with the given name already exists, the old value is replaced. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The int value to set. + + + + Set a matrix property. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The matrix value to set. + + + + Set a matrix property. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The matrix value to set. + + + + Set a matrix array property. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The array to set. + + + + Set a matrix array property. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The array to set. + + + + Set a matrix array property. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The array to set. + + + + Set a matrix array property. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The array to set. + + + + Set a texture property. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The Texture to set. + + + + Set a texture property. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The Texture to set. + + + + Set a vector property. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The Vector4 value to set. + + + + Set a vector property. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The Vector4 value to set. + + + + Set a vector array property. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The array to set. + + + + Set a vector array property. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The array to set. + + + + Set a vector array property. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The array to set. + + + + Set a vector array property. + + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The array to set. + + + + A collection of common math functions. + + + + + Returns the absolute value of f. + + + + + + Returns the absolute value of value. + + + + + + Returns the arc-cosine of f - the angle in radians whose cosine is f. + + + + + + Compares two floating point values and returns true if they are similar. + + + + + + + Returns the arc-sine of f - the angle in radians whose sine is f. + + + + + + Returns the arc-tangent of f - the angle in radians whose tangent is f. + + + + + + Returns the angle in radians whose Tan is y/x. + + + + + + + Returns the smallest integer greater to or equal to f. + + + + + + Returns the smallest integer greater to or equal to f. + + + + + + Clamps the given value between the given minimum float and maximum float values. Returns the given value if it is within the min and max range. + + The floating point value to restrict inside the range defined by the min and max values. + The minimum floating point value to compare against. + The maximum floating point value to compare against. + + The float result between the min and max values. + + + + + Clamps the given value between a range defined by the given minimum integer and maximum integer values. Returns the given value if it is within min and max. + + The integer point value to restrict inside the min-to-max range + The minimum integer point value to compare against. + The maximum integer point value to compare against. + + The int result between min and max values. + + + + + Clamps value between 0 and 1 and returns value. + + + + + + Returns the closest power of two value. + + + + + + Convert a color temperature in Kelvin to RGB color. + + Temperature in Kelvin. Range 1000 to 40000 Kelvin. + + Correlated Color Temperature as floating point RGB color. + + + + + Returns the cosine of angle f. + + The input angle, in radians. + + The return value between -1 and 1. + + + + + Degrees-to-radians conversion constant (Read Only). + + + + + Calculates the shortest difference between two given angles given in degrees. + + + + + + + A tiny floating point value (Read Only). + + + + + Returns e raised to the specified power. + + + + + + Returns the largest integer smaller than or equal to f. + + + + + + Returns the largest integer smaller to or equal to f. + + + + + + Converts the given value from gamma (sRGB) to linear color space. + + + + + + A representation of positive infinity (Read Only). + + + + + Calculates the linear parameter t that produces the interpolant value within the range [a, b]. + + Start value. + End value. + Value between start and end. + + Percentage of value between start and end. + + + + + Returns true if the value is power of two. + + + + + + Linearly interpolates between a and b by t. + + The start value. + The end value. + The interpolation value between the two floats. + + The interpolated float result between the two float values. + + + + + Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees. + + + + + + + + Linearly interpolates between a and b by t with no limit to t. + + The start value. + The end value. + The interpolation between the two floats. + + The float value as a result from the linear interpolation. + + + + + Converts the given value from linear to gamma (sRGB) color space. + + + + + + Returns the logarithm of a specified number in a specified base. + + + + + + + Returns the natural (base e) logarithm of a specified number. + + + + + + Returns the base 10 logarithm of a specified number. + + + + + + Returns largest of two or more values. + + + + + + + + Returns largest of two or more values. + + + + + + + + Returns the largest of two or more values. + + + + + + + + Returns the largest of two or more values. + + + + + + + + Returns the smallest of two or more values. + + + + + + + + Returns the smallest of two or more values. + + + + + + + + Returns the smallest of two or more values. + + + + + + + + Returns the smallest of two or more values. + + + + + + + + Moves a value current towards target. + + The current value. + The value to move towards. + The maximum change that should be applied to the value. + + + + Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees. + + + + + + + + A representation of negative infinity (Read Only). + + + + + Returns the next power of two that is equal to, or greater than, the argument. + + + + + + Generate 2D Perlin noise. + + X-coordinate of sample point. + Y-coordinate of sample point. + + Value between 0.0 and 1.0. (Return value might be slightly beyond 1.0.) + + + + + The well-known 3.14159265358979... value (Read Only). + + + + + PingPongs the value t, so that it is never larger than length and never smaller than 0. + + + + + + + Returns f raised to power p. + + + + + + + Radians-to-degrees conversion constant (Read Only). + + + + + Loops the value t, so that it is never larger than length and never smaller than 0. + + + + + + + Returns f rounded to the nearest integer. + + + + + + Returns f rounded to the nearest integer. + + + + + + Returns the sign of f. + + + + + + Returns the sine of angle f. + + The input angle, in radians. + + The return value between -1 and +1. + + + + + Gradually changes a value towards a desired goal over time. + + The current position. + The position we are trying to reach. + The current velocity, this value is modified by the function every time you call it. + Approximately the time it will take to reach the target. A smaller value will reach the target faster. + Optionally allows you to clamp the maximum speed. + The time since the last call to this function. By default Time.deltaTime. + + + + Gradually changes a value towards a desired goal over time. + + The current position. + The position we are trying to reach. + The current velocity, this value is modified by the function every time you call it. + Approximately the time it will take to reach the target. A smaller value will reach the target faster. + Optionally allows you to clamp the maximum speed. + The time since the last call to this function. By default Time.deltaTime. + + + + Gradually changes a value towards a desired goal over time. + + The current position. + The position we are trying to reach. + The current velocity, this value is modified by the function every time you call it. + Approximately the time it will take to reach the target. A smaller value will reach the target faster. + Optionally allows you to clamp the maximum speed. + The time since the last call to this function. By default Time.deltaTime. + + + + Gradually changes an angle given in degrees towards a desired goal angle over time. + + The current position. + The position we are trying to reach. + The current velocity, this value is modified by the function every time you call it. + Approximately the time it will take to reach the target. A smaller value will reach the target faster. + Optionally allows you to clamp the maximum speed. + The time since the last call to this function. By default Time.deltaTime. + + + + Gradually changes an angle given in degrees towards a desired goal angle over time. + + The current position. + The position we are trying to reach. + The current velocity, this value is modified by the function every time you call it. + Approximately the time it will take to reach the target. A smaller value will reach the target faster. + Optionally allows you to clamp the maximum speed. + The time since the last call to this function. By default Time.deltaTime. + + + + Gradually changes an angle given in degrees towards a desired goal angle over time. + + The current position. + The position we are trying to reach. + The current velocity, this value is modified by the function every time you call it. + Approximately the time it will take to reach the target. A smaller value will reach the target faster. + Optionally allows you to clamp the maximum speed. + The time since the last call to this function. By default Time.deltaTime. + + + + Interpolates between min and max with smoothing at the limits. + + + + + + + + Returns square root of f. + + + + + + Returns the tangent of angle f in radians. + + + + + + A standard 4x4 transformation matrix. + + + + + This property takes a projection matrix and returns the six plane coordinates that define a projection frustum. + + + + + The determinant of the matrix. + + + + + Returns the identity matrix (Read Only). + + + + + The inverse of this matrix (Read Only). + + + + + Is this the identity matrix? + + + + + Attempts to get a scale value from the matrix. + + + + + Attempts to get a rotation quaternion from this matrix. + + + + + Returns the transpose of this matrix (Read Only). + + + + + Returns a matrix with all elements set to zero (Read Only). + + + + + This function returns a projection matrix with viewing frustum that has a near plane defined by the coordinates that were passed in. + + The X coordinate of the left side of the near projection plane in view space. + The X coordinate of the right side of the near projection plane in view space. + The Y coordinate of the bottom side of the near projection plane in view space. + The Y coordinate of the top side of the near projection plane in view space. + Z distance to the near plane from the origin in view space. + Z distance to the far plane from the origin in view space. + Frustum planes struct that contains the view space coordinates of that define a viewing frustum. + + + A projection matrix with a viewing frustum defined by the plane coordinates passed in. + + + + + This function returns a projection matrix with viewing frustum that has a near plane defined by the coordinates that were passed in. + + The X coordinate of the left side of the near projection plane in view space. + The X coordinate of the right side of the near projection plane in view space. + The Y coordinate of the bottom side of the near projection plane in view space. + The Y coordinate of the top side of the near projection plane in view space. + Z distance to the near plane from the origin in view space. + Z distance to the far plane from the origin in view space. + Frustum planes struct that contains the view space coordinates of that define a viewing frustum. + + + A projection matrix with a viewing frustum defined by the plane coordinates passed in. + + + + + Get a column of the matrix. + + + + + + Returns a row of the matrix. + + + + + + Given a source point, a target point, and an up vector, computes a transformation matrix that corresponds to a camera viewing the target from the source, such that the right-hand vector is perpendicular to the up vector. + + The source point. + The target point. + The vector describing the up direction (typically Vector3.up). + + The resulting transformation matrix. + + + + + Transforms a position by this matrix (generic). + + + + + + Transforms a position by this matrix (fast). + + + + + + Transforms a direction by this matrix. + + + + + + Multiplies two matrices. + + + + + + + Transforms a Vector4 by a matrix. + + + + + + + Creates an orthogonal projection matrix. + + + + + + + + + + + Creates a perspective projection matrix. + + + + + + + + + Creates a rotation matrix. + + + + + + Creates a scaling matrix. + + + + + + Sets a column of the matrix. + + + + + + + Sets a row of the matrix. + + + + + + + Sets this matrix to a translation, rotation and scaling matrix. + + + + + + + + Access element at [row, column]. + + + + + Access element at sequential index (0..15 inclusive). + + + + + Returns a nicely formatted string for this matrix. + + + + + + Returns a nicely formatted string for this matrix. + + + + + + Returns a plane that is transformed in space. + + + + + + Creates a translation matrix. + + + + + + Creates a translation, rotation and scaling matrix. + + + + + + + + Checks if this matrix is a valid transform matrix. + + + + + A class that allows creating or modifying meshes from scripts. + + + + + The bind poses. The bind pose at each index refers to the bone with the same index. + + + + + Returns BlendShape count on this mesh. + + + + + The bone weights of each vertex. + + + + + The bounding volume of the mesh. + + + + + Vertex colors of the Mesh. + + + + + Vertex colors of the Mesh. + + + + + Format of the mesh index buffer data. + + + + + Returns true if the Mesh is read/write enabled, or false if it is not. + + + + + The normals of the Mesh. + + + + + The number of sub-meshes inside the Mesh object. + + + + + The tangents of the Mesh. + + + + + An array containing all triangles in the Mesh. + + + + + The base texture coordinates of the Mesh. + + + + + The second texture coordinate set of the mesh, if present. + + + + + The third texture coordinate set of the mesh, if present. + + + + + The fourth texture coordinate set of the mesh, if present. + + + + + The fifth texture coordinate set of the mesh, if present. + + + + + The sixth texture coordinate set of the mesh, if present. + + + + + The seventh texture coordinate set of the mesh, if present. + + + + + The eighth texture coordinate set of the mesh, if present. + + + + + Gets the number of vertex buffers present in the Mesh. (Read Only) + + + + + Returns the number of vertices in the Mesh (Read Only). + + + + + Returns a copy of the vertex positions or assigns a new vertex positions array. + + + + + Adds a new blend shape frame. + + Name of the blend shape to add a frame to. + Weight for the frame being added. + Delta vertices for the frame being added. + Delta normals for the frame being added. + Delta tangents for the frame being added. + + + + Clears all vertex data and all triangle indices. + + + + + + Clears all blend shapes from Mesh. + + + + + Combines several Meshes into this Mesh. + + Descriptions of the Meshes to combine. + Defines whether Meshes should be combined into a single sub-mesh. + Defines whether the transforms supplied in the CombineInstance array should be used or ignored. + + + + + Creates an empty Mesh. + + + + + Gets the base vertex index of the given sub-mesh. + + The sub-mesh index. See subMeshCount. + + The offset applied to all vertex indices of this sub-mesh. + + + + + Gets the bind poses for this instance. + + A list of bind poses to populate. + + + + Returns the frame count for a blend shape. + + The shape index to get frame count from. + + + + Retreives deltaVertices, deltaNormals and deltaTangents of a blend shape frame. + + The shape index of the frame. + The frame index to get the weight from. + Delta vertices output array for the frame being retreived. + Delta normals output array for the frame being retreived. + Delta tangents output array for the frame being retreived. + + + + Returns the weight of a blend shape frame. + + The shape index of the frame. + The frame index to get the weight from. + + + + Returns index of BlendShape by given name. + + + + + + Returns name of BlendShape by given index. + + + + + + Gets the bone weights for this instance. + + A list of bone weights to populate. + + + + Gets the vertex colors for this instance. + + A list of vertex colors to populate. + + + + Gets the vertex colors for this instance. + + A list of vertex colors to populate. + + + + Gets the index count of the given sub-mesh. + + + + + + Gets the starting index location within the Mesh's index buffer, for the given sub-mesh. + + + + + + Fetches the index list for the specified sub-mesh. + + A list of indices to populate. + The sub-mesh index. See subMeshCount. + True (default value) will apply base vertex offset to returned indices. + + + + Fetches the index list for the specified sub-mesh. + + A list of indices to populate. + The sub-mesh index. See subMeshCount. + True (default value) will apply base vertex offset to returned indices. + + + + Retrieves a native (underlying graphics API) pointer to the index buffer. + + + Pointer to the underlying graphics API index buffer. + + + + + Retrieves a native (underlying graphics API) pointer to the vertex buffer. + + Which vertex buffer to get (some Meshes might have more than one). See vertexBufferCount. + + + Pointer to the underlying graphics API vertex buffer. + + + + + Gets the vertex normals for this instance. + + A list of vertex normals to populate. + + + + Gets the tangents for this instance. + + A list of tangents to populate. + + + + Gets the topology of a sub-mesh. + + + + + + Fetches the triangle list for the specified sub-mesh on this object. + + A list of vertex indices to populate. + The sub-mesh index. See subMeshCount. + True (default value) will apply base vertex offset to returned indices. + + + + Fetches the triangle list for the specified sub-mesh on this object. + + A list of vertex indices to populate. + The sub-mesh index. See subMeshCount. + True (default value) will apply base vertex offset to returned indices. + + + + Fetches the triangle list for the specified sub-mesh on this object. + + A list of vertex indices to populate. + The sub-mesh index. See subMeshCount. + True (default value) will apply base vertex offset to returned indices. + + + + Fetches the triangle list for the specified sub-mesh on this object. + + A list of vertex indices to populate. + The sub-mesh index. See subMeshCount. + True (default value) will apply base vertex offset to returned indices. + + + + The UV distribution metric can be used to calculate the desired mipmap level based on the position of the camera. + + UV set index to return the UV distibution metric for. 0 for first. + + Average of triangle area / uv area. + + + + + Gets the UVs of the Mesh. + + The UV channel. Indices start at 0, which corresponds to uv. Note that 1 corresponds to uv2. + A list of UVs to populate. + + + + Gets the UVs of the Mesh. + + The UV channel. Indices start at 0, which corresponds to uv. Note that 1 corresponds to uv2. + A list of UVs to populate. + + + + Gets the UVs of the Mesh. + + The UV channel. Indices start at 0, which corresponds to uv. Note that 1 corresponds to uv2. + A list of UVs to populate. + + + + Gets the vertex positions for this instance. + + A list of vertex positions to populate. + + + + Optimize mesh for frequent updates. + + + + + Optimizes the Mesh for display. + + + + + Recalculate the bounding volume of the Mesh from the vertices. + + + + + Recalculates the normals of the Mesh from the triangles and vertices. + + + + + Recalculates the tangents of the Mesh from the normals and texture coordinates. + + + + + Vertex colors of the Mesh. + + Per-Vertex Colours. + + + + Vertex colors of the Mesh. + + Per-Vertex Colours. + + + + Sets the index buffer for the sub-mesh. + + The array of indices that define the Mesh. + The topology of the Mesh, e.g: Triangles, Lines, Quads, Points, etc. See MeshTopology. + The sub-mesh to modify. + Calculate the bounding box of the Mesh after setting the indices. This is done by default. +Use false when you want to use the existing bounding box and reduce the CPU cost of setting the indices. + Optional vertex offset that is added to all triangle vertex indices. + + + + Sets the index buffer for the sub-mesh. + + The array of indices that define the Mesh. + The topology of the Mesh, e.g: Triangles, Lines, Quads, Points, etc. See MeshTopology. + The sub-mesh to modify. + Calculate the bounding box of the Mesh after setting the indices. This is done by default. +Use false when you want to use the existing bounding box and reduce the CPU cost of setting the indices. + Optional vertex offset that is added to all triangle vertex indices. + + + + Sets the index buffer for the sub-mesh. + + The array of indices that define the Mesh. + The topology of the Mesh, e.g: Triangles, Lines, Quads, Points, etc. See MeshTopology. + The sub-mesh to modify. + Calculate the bounding box of the Mesh after setting the indices. This is done by default. +Use false when you want to use the existing bounding box and reduce the CPU cost of setting the indices. + Optional vertex offset that is added to all triangle vertex indices. + + + + Set the normals of the Mesh. + + Per-vertex normals. + + + + Set the tangents of the Mesh. + + Per-vertex tangents. + + + + Sets the triangle list for the sub-mesh. + + The list of indices that define the triangles. + The sub-mesh to modify. + Calculate the bounding box of the Mesh after setting the triangles. This is done by default. +Use false when you want to use the existing bounding box and reduce the CPU cost of setting the triangles. + Optional vertex offset that is added to all triangle vertex indices. + + + + Sets the triangle list for the sub-mesh. + + The list of indices that define the triangles. + The sub-mesh to modify. + Calculate the bounding box of the Mesh after setting the triangles. This is done by default. +Use false when you want to use the existing bounding box and reduce the CPU cost of setting the triangles. + Optional vertex offset that is added to all triangle vertex indices. + + + + Sets the triangle list for the sub-mesh. + + The list of indices that define the triangles. + The sub-mesh to modify. + Calculate the bounding box of the Mesh after setting the triangles. This is done by default. +Use false when you want to use the existing bounding box and reduce the CPU cost of setting the triangles. + Optional vertex offset that is added to all triangle vertex indices. + + + + Sets the triangle list for the sub-mesh. + + The list of indices that define the triangles. + The sub-mesh to modify. + Calculate the bounding box of the Mesh after setting the triangles. This is done by default. +Use false when you want to use the existing bounding box and reduce the CPU cost of setting the triangles. + Optional vertex offset that is added to all triangle vertex indices. + + + + Sets the UVs of the Mesh. + + The UV channel. Indices start at 0, which corresponds to uv. Note that 1 corresponds to uv2. + List of UVs to set for the given index. + + + + Sets the UVs of the Mesh. + + The UV channel. Indices start at 0, which corresponds to uv. Note that 1 corresponds to uv2. + List of UVs to set for the given index. + + + + Sets the UVs of the Mesh. + + The UV channel. Indices start at 0, which corresponds to uv. Note that 1 corresponds to uv2. + List of UVs to set for the given index. + + + + Assigns a new vertex positions array. + + Per-vertex position. + + + + Upload previously done Mesh modifications to the graphics API. + + Frees up system memory copy of mesh data when set to true. + + + + A mesh collider allows you to do between meshes and primitives. + + + + + Use a convex collider from the mesh. + + + + + Options used to enable or disable certain features in mesh cooking. + + + + + Allow the physics engine to increase the volume of the input mesh in attempt to generate a valid convex mesh. + + + + + The mesh object used for collision detection. + + + + + Used when set to inflateMesh to determine how much inflation is acceptable. + + + + + Uses interpolated normals for sphere collisions instead of flat polygonal normals. + + + + + Cooking options that are available with MeshCollider. + + + + + Toggle between cooking for faster simulation or faster cooking time. + + + + + Toggle cleaning of the mesh. + + + + + Allow the physics engine to increase the volume of the input mesh in attempt to generate a valid convex mesh. + + + + + No optional cooking steps will be run. + + + + + Toggle the removal of equal vertices. + + + + + A class to access the Mesh of the. + + + + + Returns the instantiated Mesh assigned to the mesh filter. + + + + + Returns the shared mesh of the mesh filter. + + + + + Renders meshes inserted by the MeshFilter or TextMesh. + + + + + Vertex attributes in this mesh will override or add attributes of the primary mesh in the MeshRenderer. + + + + + Index of the first sub-mesh to use from the Mesh associated with this MeshRenderer (Read Only). + + + + + Topology of Mesh faces. + + + + + Mesh is made from lines. + + + + + Mesh is a line strip. + + + + + Mesh is made from points. + + + + + Mesh is made from quads. + + + + + Mesh is made from triangles. + + + + + Use this class to record to an AudioClip using a connected microphone. + + + + + A list of available microphone devices, identified by name. + + + + + Stops recording. + + The name of the device. + + + + Get the frequency capabilities of a device. + + The name of the device. + Returns the minimum sampling frequency of the device. + Returns the maximum sampling frequency of the device. + + + + Get the position in samples of the recording. + + The name of the device. + + + + Query if a device is currently recording. + + The name of the device. + + + + Start Recording with device. + + The name of the device. + Indicates whether the recording should continue recording if lengthSec is reached, and wrap around and record from the beginning of the AudioClip. + Is the length of the AudioClip produced by the recording. + The sample rate of the AudioClip produced by the recording. + + The function returns null if the recording fails to start. + + + + + Attribute used to make a float or int variable in a script be restricted to a specific minimum value. + + + + + The minimum allowed value. + + + + + Attribute used to make a float or int variable in a script be restricted to a specific minimum value. + + The minimum allowed value. + + + + Enum describing what lighting mode to be used with Mixed lights. + + + + + Mixed lights provide realtime direct lighting while indirect light is baked into lightmaps and light probes. + + + + + Mixed lights provide realtime direct lighting. Indirect lighting gets baked into lightmaps and light probes. Shadowmasks and light probe occlusion get generated for baked shadows. The Shadowmask Mode used at run time can be set in the Quality Settings panel. + + + + + Mixed lights provide baked direct and indirect lighting for static objects. Dynamic objects receive realtime direct lighting and cast shadows on static objects using the main directional light in the Scene. + + + + + MonoBehaviour is the base class from which every Unity script derives. + + + + + Logs message to the Unity Console (identical to Debug.Log). + + + + + + Allow a specific instance of a MonoBehaviour to run in edit mode (only available in the editor). + + + + + Disabling this lets you skip the GUI layout phase. + + + + + Cancels all Invoke calls on this MonoBehaviour. + + + + + Cancels all Invoke calls with name methodName on this behaviour. + + + + + + Invokes the method methodName in time seconds. + + + + + + + Invokes the method methodName in time seconds, then repeatedly every repeatRate seconds. + + + + + + + + Is any invoke on methodName pending? + + + + + + Is any invoke pending on this MonoBehaviour? + + + + + Starts a coroutine. + + + + + + Starts a coroutine named methodName. + + + + + + + Starts a coroutine named methodName. + + + + + + + Starts a Coroutine named coroutine. + + Name of the created Coroutine. + + + + Stops all coroutines running on this behaviour. + + + + + Stops the first coroutine named methodName, or the coroutine stored in routine running on this behaviour. + + Name of coroutine. + Name of the function in code, including coroutines. + + + + Stops the first coroutine named methodName, or the coroutine stored in routine running on this behaviour. + + Name of coroutine. + Name of the function in code, including coroutines. + + + + Stops the first coroutine named methodName, or the coroutine stored in routine running on this behaviour. + + Name of coroutine. + Name of the function in code, including coroutines. + + + + Base class for AnimationClips and BlendTrees. + + + + + The type of motion vectors that should be generated. + + + + + Use only camera movement to track motion. + + + + + Do not track motion. Motion vectors will be 0. + + + + + Use a specific pass (if required) to track motion. + + + + + MovieTexture has been deprecated. Refer to the new movie playback solution VideoPlayer. + + + + + MovieTexture has been deprecated. Refer to the new movie playback solution VideoPlayer. + + + + + MovieTexture has been deprecated. Refer to the new movie playback solution VideoPlayer. + + + + + MovieTexture has been deprecated. Refer to the new movie playback solution VideoPlayer. + + + + + MovieTexture has been deprecated. Refer to the new movie playback solution VideoPlayer. + + + + + MovieTexture has been deprecated. Refer to the new movie playback solution VideoPlayer. + + + + + MovieTexture has been deprecated. Refer to the new movie playback solution VideoPlayer. + + + + + MovieTexture has been deprecated. Refer to the new movie playback solution VideoPlayer. + + + + + MovieTexture has been deprecated. Refer to the new movie playback solution VideoPlayer. + + + + + Attribute to make a string be edited with a multi-line textfield. + + + + + Attribute used to make a string value be shown in a multiline textarea. + + How many lines of text to make room for. Default is 3. + + + + Attribute used to make a string value be shown in a multiline textarea. + + How many lines of text to make room for. Default is 3. + + + + The network class is at the heart of the network implementation and provides the core functions. + + + + + All connected players. + + + + + The IP address of the connection tester used in Network.TestConnection. + + + + + The port of the connection tester used in Network.TestConnection. + + + + + Set the password for the server (for incoming connections). + + + + + Returns true if your peer type is client. + + + + + Enable or disable the processing of network messages. + + + + + Returns true if your peer type is server. + + + + + Set the log level for network messages (default is Off). + + + + + Set the maximum amount of connections/players allowed. + + + + + Get or set the minimum number of ViewID numbers in the ViewID pool given to clients by the server. + + + + + The IP address of the NAT punchthrough facilitator. + + + + + The port of the NAT punchthrough facilitator. + + + + + The status of the peer type, i.e. if it is disconnected, connecting, server or client. + + + + + Get the local NetworkPlayer instance. + + + + + The IP address of the proxy server. + + + + + Set the proxy server password. + + + + + The port of the proxy server. + + + + + The default send rate of network updates for all Network Views. + + + + + Get the current network time (seconds). + + + + + Indicate if proxy support is needed, in which case traffic is relayed through the proxy server. + + + + + Query for the next available network view ID number and allocate it (reserve). + + + + + Close the connection to another system. + + + + + + + Connect to the specified host (ip or domain name) and server port. + + + + + + + + Connect to the specified host (ip or domain name) and server port. + + + + + + + + This function is exactly like Network.Connect but can accept an array of IP addresses. + + + + + + + + This function is exactly like Network.Connect but can accept an array of IP addresses. + + + + + + + + Connect to a server GUID. NAT punchthrough can only be performed this way. + + + + + + + Connect to a server GUID. NAT punchthrough can only be performed this way. + + + + + + + Connect to the host represented by a HostData structure returned by the Master Server. + + + + + + + Connect to the host represented by a HostData structure returned by the Master Server. + + + + + + + Destroy the object associated with this view ID across the network. + + + + + + Destroy the object across the network. + + + + + + Destroy all the objects based on view IDs belonging to this player. + + + + + + Close all open connections and shuts down the network interface. + + + + + + Close all open connections and shuts down the network interface. + + + + + + The last average ping time to the given player in milliseconds. + + + + + + The last ping time to the given player in milliseconds. + + + + + + Check if this machine has a public IP address. + + + + + Initializes security layer. + + + + + Initialize the server. + + + + + + + + Initialize the server. + + + + + + + + Network instantiate a Prefab. + + + + + + + + + Remove all RPC functions which belong to this player ID. + + + + + + Remove all RPC functions which belong to this player ID and were sent based on the given group. + + + + + + + Remove the RPC function calls accociated with this view ID number. + + + + + + Remove all RPC functions which belong to given group number. + + + + + + Set the level prefix which will then be prefixed to all network ViewID numbers. + + + + + + Enable or disables the reception of messages in a specific group number from a specific player. + + + + + + + + Enables or disables transmission of messages and RPC calls on a specific network group number. + + + + + + + Enable or disable transmission of messages and RPC calls based on target network player as well as the network group. + + + + + + + + Test this machines network connection. + + + + + + Test this machines network connection. + + + + + + Test the connection specifically for NAT punch-through connectivity. + + + + + + Test the connection specifically for NAT punch-through connectivity. + + + + + + Possible status messages returned by Network.Connect and in MonoBehaviour.OnFailedToConnect|OnFailedToConnect in case the error was not immediate. + + + + + The reason a disconnect event occured, like in MonoBehaviour.OnDisconnectedFromServer|OnDisconnectedFromServer. + + + + + Responsible for rejecting or accepting certificates received on https requests. + + + + + Signals that this [CertificateHandler] is no longer being used, and should clean up any resources it is using. + + + + + Callback, invoked for each leaf certificate sent by the remote server. + + Certificate data in PEM or DER format. If certificate data contains multiple certificates, the first one is the leaf certificate. + + true if the certificate should be accepted, false if not. + + + + + Defines parameters of channels. + + + + + Returns true if the channel belongs to a shared group. + + + + + UnderlyingModel.MemDoc.MemDocModel. + + Requested type of quality of service (default Unreliable). + Copy constructor. + + + + UnderlyingModel.MemDoc.MemDocModel. + + Requested type of quality of service (default Unreliable). + Copy constructor. + + + + UnderlyingModel.MemDoc.MemDocModel. + + Requested type of quality of service (default Unreliable). + Copy constructor. + + + + Channel quality of service. + + + + + Defines size of the buffer holding reliable messages, before they will be acknowledged. + + + + + Ack buffer can hold 128 messages. + + + + + Ack buffer can hold 32 messages. + + + + + Ack buffer can hold 64 messages. + + + + + Ack buffer can hold 96 messages. + + + + + This class defines parameters of connection between two peers, this definition includes various timeouts and sizes as well as channel configuration. + + + + + Defines the duration in milliseconds that the receiver waits for before it sends an acknowledgement back without waiting for any data payload. Default value = 33. + +Network clients that send data to a server may do so using many different quality of service (QOS) modes, some of which (reliable modes) expect the server to send back acknowledgement of receipt of data sent. + +Servers must periodically acknowledge data packets received over channels with reliable QOS modes by sending packets containing acknowledgement data (also known as "acks") back to the client. If the server were to send an acknowledgement immediately after receiving each packet from the client there would be significant overhead (the acknowledgement is a 32 or 64 bit integer, which is very small compared to the whole size of the packet which also contains the IP and the UDP header). AckDelay allows the server some time to accumulate a list of received reliable data packets to acknowledge, and decreases traffic overhead by combining many acknowledgements into a single packet. + + + + + Determines the size of the buffer used to store reliable messages that are waiting for acknowledgement. It can be set to Acks32, Acks64, Acks96, or Acks128. Depends of this setting buffer can hold 32, 64, 96, or 128 messages. Default value = Ack32. + +Messages sent on reliable quality of service channels are stored in a special buffer while they wait for acknowledgement from the peer. This buffer can be either 32, 64, 96 or 128 positions long. It is recommended to begin with this value set to Ack32, which defines a buffer up to 32 messages in size. If you receive NoResources errors often when you send reliable messages, change this value to the next possible size. + + + + + Adds a new channel to the configuration and returns the unique id of that channel. + +Channels are logical delimiters of traffic between peers. Every time you send data to a peer, you should use two ids: connection id and channel id. Channels are not only logically separate traffic but could each be configured with a different quality of service (QOS). In the example below, a configuration is created containing two channels with Unreliable and Reliable QOS types. This configuration is then used for sending data. + + Add new channel to configuration. + + Channel id, user can use this id to send message via this channel. + + + + + Defines the timeout in milliseconds after which messages sent via the AllCost channel will be re-sent without waiting for acknowledgement. Default value = 20 ms. + +AllCost delivery quality of service (QOS) is a special QOS for delivering game-critical information, such as when the game starts, or when bullets are shot. + +Due to packets dropping, sometimes reliable messages cannot be delivered and need to be re-sent. Reliable messages will re-sent after RTT+Delta time, (RTT is round trip time) where RTT is a dynamic value and can reach couple of hundred milliseconds. For the AllCost delivery channel this timeout can be user-defined to force game critical information to be re-sent. + + + + + Defines, when multiplied internally by InitialBandwidth, the maximum bandwidth that can be used under burst conditions. + + + + + (Read Only) The number of channels in the current configuration. + + + + + The list of channels belonging to the current configuration. + +Note: any ConnectionConfig passed as a parameter to a function in Unity Multiplayer is deep copied (that is, an entirely new copy is made, with no references to the original). + + + + + Timeout in ms which library will wait before it will send another connection request. + + + + + Will create default connection config or will copy them from another. + + Connection config. + + + + Will create default connection config or will copy them from another. + + Connection config. + + + + Defines the timeout in milliseconds before a connection is considered to have been disconnected. Default value = 2000. + +Unity Multiplayer defines conditions under which a connection is considered as disconnected. Disconnection can happen for the following reasons: + +(1) A disconnection request was received. + +(2) The connection has not received any traffic at all for a time longer than DisconnectTimeout (Note that live connections receive regular keep-alive packets, so in this case "no traffic" means not only no user traffic but also absence of any keep-alive traffic as well). + +(3) Flow control determines that the time between sending packets is longer than DisconnectTimeout. Keep-alive packets are regularly delivered from peers and contain statistical information. This information includes values of packet loss due to network and peer overflow conditions. Setting NetworkDropThreshold and OverflowDropThreshold defines thresholds for flow control which can decrease packet frequency. When the time before sending the next packet is longer than DisconnectTimeout, the connection will be considered as disconnected and a disconnect event is received. + + + + + Defines the fragment size for fragmented messages (for QOS: ReliableFragmented and UnreliableFragmented). Default value = 500. + +Under fragmented quality of service modes, the original message is split into fragments (up to 64) of up to FragmentSize bytes each. The fragment size depends on the frequency and size of reliable messages sent. Each reliable message potentially could be re-sent, so you need to choose a fragment size less than the remaining free space in a UDP packet after retransmitted reliable messages are added to the packet. For example, if Networking.ConnectionConfig.PacketSize is 1440 bytes, and a reliable message's average size is 200 bytes, it would be wise to set this parameter to 900 – 1000 bytes. + + + + + Return the QoS set for the given channel or throw an out of range exception. + + Index in array. + + Channel QoS. + + + + + Return IList<byte> of channel IDs which belong to the group. + + Group id. + + List of channel IDs belonging to the group. + + + + + Gets or sets the bandwidth in bytes per second that can be used by Unity Multiplayer. No traffic over this limit is allowed. Unity Multiplayer may internally reduce the bandwidth it uses due to flow control. The default value is 1.5MB/sec (1,536,000 bytes per second). The default value is intentionally a large number to allow all traffic to pass without delay. + + + + + Allows you to combine multiple channels into a single group, so those channels share a common receiving order. + + The list of channel indices which should be grouped together. The list can include both reliable and unreliable channels. + + + + Defines the maximum number of small reliable messages that can be included in one combined message. Default value = 10. + +Since each message sent to a server contains IP information and a UDP header, duplicating this information for every message sent can be inefficient in the case where there are many small messages being sent frequently. Many small reliable messages can be combined into one longer reliable message, saving space in the waiting buffer. Unity Multiplayer will automatically combine up to MaxCombinedReliableMessageCount small messages into one message. To qualify as a small message, the data payload of the message should not be greater than MaxCombinedReliableMessageSize. + + + + + Defines the maximum size in bytes of a reliable message which is considered small enough to include in a combined message. Default value = 100. + +Since each message sent to a server contains IP information and a UDP header, duplicating this information for every message sent can be inefficient in the case where there are many small messages being sent frequently. Many small reliable messages can be combined into one longer reliable message, saving space in the waiting buffer. Unity Multiplayer will automatically combine up to MaxCombinedReliableMessageCount small messages into one message. To qualify as a small message, the data payload of the message should not be greater than MaxCombinedReliableMessageSize. + + + + + Defines the maximum number of times Unity Multiplayer will attempt to send a connection request without receiving a response before it reports that it cannot establish a connection. Default value = 10. + + + + + Defines maximum number of messages that can be held in the queue for sending. Default value = 128. + +This buffer serves to smooth spikes in traffic and decreases network jitter. If the queue is full, a NoResources error will result from any calls to Send(). Setting this value greater than around 300 is likely to cause significant delaying of message delivering and can make game unplayable. + + + + + Defines minimum time in milliseconds between sending packets. This duration may be automatically increased if required by flow control. Default value = 10. + +When Send() is called, Unity Multiplayer won’t send the message immediately. Instead, once every SendTimeout milliseconds each connection is checked to see if it has something to send. While initial and minimal send timeouts can be set, these may be increased internally due to network conditions or buffer overflows. + + + + + Defines the percentage (from 0 to 100) of packets that need to be dropped due to network conditions before the SendUpdate timeout is automatically increased (and send rate is automatically decreased). Default value = 5. + +To avoid receiver overflow, Unity Multiplayer supports flow control. Each ping packet sent between connected peers contains two values: + +(1) Packets lost due to network conditions. + +(2) Packets lost because the receiver does not have free space in its incoming buffers. + +Like OverflowDropThreshold, both values are reported in percent. Use NetworkDropThreshold and OverflowDropThreshold to set thresholds for these values. If a value reported in the ping packet exceeds the corresponding threshold, Unity Multiplayer increases the sending timeout for packets up to a maximum value of DisconnectTimeout. + +Note: wireless networks usually exhibit 5% or greater packet loss. For wireless networks it is advisable to use a NetworkDropThreshold of 40-50%. + + + + + Defines the percentage (from 0 to 100) of packets that need to be dropped due to lack of space in internal buffers before the SendUpdate timeout is automatically increased (and send rate is automatically decreased). Default value = 5. + +To avoid receiver overflow, Unity Multiplayer supports flow control. Each ping packet sent between connected peers contains two values: + +(1) Packets lost due to network conditions. + +(2) Packets lost because the receiver does not have free space in its incoming buffers. + +Like NetworkDropThreshold, both values are reported in percent. Use NetworkDropThreshold and OverflowDropThreshold to set thresholds for these values. If a value reported in the ping packet exceeds the corresponding threshold, Unity Multiplayer increases the sending timeout for packets up to a maximum value of DisconnectTimeout. + +Note: wireless networks usually exhibit 5% or greater packet loss. For wireless networks it is advisable to use a NetworkDropThreshold of 40-50%. + + + + + Defines maximum packet size (in bytes) (including payload and all header). Packet can contain multiple messages inside. Default value = 1500. + +Note that this default value is suitable for local testing only. Usually you should change this value; a recommended setting for PC or mobile is 1470. For games consoles this value should probably be less than ~1100. Wrong size definition can cause packet dropping. + + + + + Defines the duration in milliseconds between keep-alive packets, also known as pings. Default value = 500. + +The ping frequency should be long enough to accumulate good statistics and short enough to compare with DisconnectTimeout. A good guideline is to have more than 3 pings per disconnect timeout, and more than 5 messages per ping. For example, with a DisconnectTimeout of 2000ms, a PingTimeout of 500ms works well. + + + + + Defines the maximum wait time in milliseconds before the "not acknowledged" message is re-sent. Default value = 1200. + +It does not make a lot of sense to wait for acknowledgement forever. This parameter sets an upper time limit at which point reliable messages are re-sent. + + + + + Gets or sets the delay in milliseconds after a call to Send() before packets are sent. During this time, new messages may be combined in queued packets. Default value: 10ms. + + + + + (Read Only) The number of shared order groups in current configuration. + + + + + Defines the path to the file containing the certification authority (CA) certificate for WebSocket via SSL communication. + + + + + Defines path to SSL certificate file, for WebSocket via SSL communication. + + + + + Defines the path to the file containing the private key for WebSocket via SSL communication. + + + + + Defines the size in bytes of the receiving buffer for UDP sockets. It is useful to set this parameter equal to the maximum size of a fragmented message. Default value is OS specific (usually 8kb). + + + + + When starting a server use protocols that make use of platform specific optimisations where appropriate rather than cross-platform protocols. (Sony consoles only). + + + + + Validate parameters of connection config. Will throw exceptions if parameters are incorrect. + + + + + + WebSocket only. Defines the buffer size in bytes for received frames on a WebSocket host. If this value is 0 (the default), a 4 kilobyte buffer is used. Any other value results in a buffer of that size, in bytes. + +WebSocket message fragments are called "frames". A WebSocket host has a buffer to store incoming message frames. Therefore this buffer should be set to the largest legal frame size supported. If an incoming frame exceeds the buffer size, no error is reported. However, the buffer will invoke the user callback in order to create space for the overflow. + + + + + Create configuration for network simulator; You can use this class in editor and developer build only. + + + + + Will create object describing network simulation parameters. + + Minimal simulation delay for outgoing traffic in ms. + Average simulation delay for outgoing traffic in ms. + Minimal simulation delay for incoming traffic in ms. + Average simulation delay for incoming traffic in ms. + Probability of packet loss 0 <= p <= 1. + + + + Destructor. + + + + + Manage and process HTTP response body data received from a remote server. + + + + + Returns the raw bytes downloaded from the remote server, or null. (Read Only) + + + + + Returns true if this DownloadHandler has been informed by its parent UnityWebRequest that all data has been received, and this DownloadHandler has completed any necessary post-download processing. (Read Only) + + + + + Convenience property. Returns the bytes from data interpreted as a UTF8 string. (Read Only) + + + + + Callback, invoked when all data has been received from the remote server. + + + + + Signals that this DownloadHandler is no longer being used, and should clean up any resources it is using. + + + + + Callback, invoked when the data property is accessed. + + + Byte array to return as the value of the data property. + + + + + Callback, invoked when UnityWebRequest.downloadProgress is accessed. + + + The return value for UnityWebRequest.downloadProgress. + + + + + Callback, invoked when the text property is accessed. + + + String to return as the return value of the text property. + + + + + Callback, invoked with a Content-Length header is received. + + The value of the received Content-Length header. + + + + Callback, invoked as data is received from the remote server. + + A buffer containing unprocessed data, received from the remote server. + The number of bytes in data which are new. + + True if the download should continue, false to abort. + + + + + A DownloadHandler subclass specialized for downloading AssetBundles. + + + + + Returns the downloaded AssetBundle, or null. (Read Only) + + + + + Standard constructor for non-cached asset bundles. + + The nominal (pre-redirect) URL at which the asset bundle is located. + A checksum to compare to the downloaded data for integrity checking, or zero to skip integrity checking. + + + + Simple versioned constructor. Caches downloaded asset bundles. + + The nominal (pre-redirect) URL at which the asset bundle is located. + A checksum to compare to the downloaded data for integrity checking, or zero to skip integrity checking. + Current version number of the asset bundle at url. Increment to redownload. + + + + Versioned constructor. Caches downloaded asset bundles. + + The nominal (pre-redirect) URL at which the asset bundle is located. + A checksum to compare to the downloaded data for integrity checking, or zero to skip integrity checking. + A hash object defining the version of the asset bundle. + + + + Versioned constructor. Caches downloaded asset bundles to a customized cache path. + + The nominal (pre-redirect) URL at which the asset bundle is located. + A hash object defining the version of the asset bundle. + A checksum to compare to the downloaded data for integrity checking, or zero to skip integrity checking. + A structure used to download a given version of AssetBundle to a customized cache path. + AssetBundle name which is used as the customized cache path. + + + + Versioned constructor. Caches downloaded asset bundles to a customized cache path. + + The nominal (pre-redirect) URL at which the asset bundle is located. + A hash object defining the version of the asset bundle. + A checksum to compare to the downloaded data for integrity checking, or zero to skip integrity checking. + A structure used to download a given version of AssetBundle to a customized cache path. + AssetBundle name which is used as the customized cache path. + + + + Returns the downloaded AssetBundle, or null. + + A finished UnityWebRequest object with DownloadHandlerAssetBundle attached. + + The same as DownloadHandlerAssetBundle.assetBundle + + + + + Not implemented. Throws <a href="http:msdn.microsoft.comen-uslibrarysystem.notsupportedexception">NotSupportedException<a>. + + + Not implemented. + + + + + Not implemented. Throws <a href="http:msdn.microsoft.comen-uslibrarysystem.notsupportedexception">NotSupportedException<a>. + + + Not implemented. + + + + + A DownloadHandler subclass specialized for downloading audio data for use as AudioClip objects. + + + + + Returns the downloaded AudioClip, or null. (Read Only) + + + + + Create AudioClip that is compressed in memory. + + + + + Create streaming AudioClip. + + + + + Constructor, specifies what kind of audio data is going to be downloaded. + + The nominal (pre-redirect) URL at which the audio clip is located. + Value to set for AudioClip type. + + + + Returns the downloaded AudioClip, or null. + + A finished UnityWebRequest object with DownloadHandlerAudioClip attached. + + The same as DownloadHandlerAudioClip.audioClip + + + + + Called by DownloadHandler.data. Returns a copy of the downloaded clip data as raw bytes. + + + A copy of the downloaded data. + + + + + A general-purpose DownloadHandler implementation which stores received data in a native byte buffer. + + + + + Default constructor. + + + + + Returns a copy of the native-memory buffer interpreted as a UTF8 string. + + A finished UnityWebRequest object with DownloadHandlerBuffer attached. + + The same as DownloadHandlerBuffer.text + + + + + Returns a copy of the contents of the native-memory data buffer as a byte array. + + + A copy of the data which has been downloaded. + + + + + Download handler for saving the downloaded data to file. + + + + + Should the created file be removed if download is aborted (manually or due to an error). Default: false. + + + + + Creates a new instance and a file on disk where downloaded data will be written to. + + Path to file to be written. + + + + MovieTexture has been deprecated. Refer to the new movie playback solution VideoPlayer. + + + + + MovieTexture has been deprecated. Refer to the new movie playback solution VideoPlayer. + + + + + MovieTexture has been deprecated. Refer to the new movie playback solution VideoPlayer. + + + + + MovieTexture has been deprecated. Refer to the new movie playback solution VideoPlayer. + + A UnityWebRequest with attached DownloadHandlerMovieTexture. + + A MovieTexture created out of downloaded bytes. + + + + + MovieTexture has been deprecated. Refer to the new movie playback solution VideoPlayer. + + + Raw downloaded bytes. + + + + + An abstract base class for user-created scripting-driven DownloadHandler implementations. + + + + + Create a DownloadHandlerScript which allocates new buffers when passing data to callbacks. + + + + + Create a DownloadHandlerScript which reuses a preallocated buffer to pass data to callbacks. + + A byte buffer into which data will be copied, for use by DownloadHandler.ReceiveData. + + + + A DownloadHandler subclass specialized for downloading images for use as Texture objects. + + + + + Returns the downloaded Texture, or null. (Read Only) + + + + + Default constructor. + + + + + Constructor, allows TextureImporter.isReadable property to be set. + + Value to set for TextureImporter.isReadable. + + + + Returns the downloaded Texture, or null. + + A finished UnityWebRequest object with DownloadHandlerTexture attached. + + The same as DownloadHandlerTexture.texture + + + + + Called by DownloadHandler.data. Returns a copy of the downloaded image data as raw bytes. + + + A copy of the downloaded data. + + + + + Defines global paramters for network library. + + + + + Defines the callback delegate which you can use to get a notification when a connection is ready to send data. + + + + + Create new global config object. + + + + + Defines how many hosts you can use. Default Value = 16. Max value = 128. + + + + + Deprecated. Defines maximum delay for network simulator. See Also: MaxTimerTimeout. + + + + + Defines maximum possible packet size in bytes for all network connections. + + + + + Defines the maximum timeout in milliseconds for any configuration. The default value is 12 seconds (12000ms). + + + + + Deprecated. Defines the minimal timeout for network simulator. You cannot set up any delay less than this value. See Also: MinTimerTimeout. + + + + + Defines the minimum timeout in milliseconds recognised by the system. The default value is 1 ms. + + + + + Defines the callback delegate which you can use to get a notification when the host (defined by hostID) has a network event. The callback is called for all event types except Networking.NetworkEventType.Nothing. + +See Also: Networking.NetworkEventType + + + + + This property determines the initial size of the queue that holds messages received by Unity Multiplayer before they are processed. + + + + + Defines the initial size of the send queue. Messages are placed in this queue ready to be sent in packets to their destination. + + + + + Defines reactor model for the network library. + + + + + Defines (1) for select reactor, minimum time period, when system will check if there are any messages for send (2) for fixrate reactor, minimum interval of time, when system will check for sending and receiving messages. + + + + + Defines how many worker threads are available to handle incoming and outgoing messages. + + + + + Class defines network topology for host (socket opened by Networking.NetworkTransport.AddHost function). This topology defines: (1) how many connection with default config will be supported and (2) what will be special connections (connections with config different from default). + + + + + Add special connection to topology (for example if you need to keep connection to standalone chat server you will need to use this function). Returned id should be use as one of parameters (with ip and port) to establish connection to this server. + + Connection config for special connection. + + Id of this connection. You should use this id when you call Networking.NetworkTransport.Connect. + + + + + Create topology. + + Default config. + Maximum default connections. + + + + Defines config for default connections in the topology. + + + + + Return reference to special connection config. Parameters of this config can be changed. + + Config id. + + Connection config. + + + + + Defines how many connection with default config be permitted. + + + + + Defines the maximum number of messages that each host can hold in its pool of received messages. The default size is 128. + + + + + Defines the maximum number of messages that each host can hold in its pool of messages waiting to be sent. The default size is 128. + + + + + List of special connection configs. + + + + + Returns count of special connection added to topology. + + + + + An interface for composition of data into multipart forms. + + + + + Returns the value to use in the Content-Type header for this form section. + + + The value to use in the Content-Type header, or null. + + + + + Returns a string denoting the desired filename of this section on the destination server. + + + The desired file name of this section, or null if this is not a file section. + + + + + Returns the raw binary data contained in this section. Must not return null or a zero-length array. + + + The raw binary data contained in this section. Must not be null or empty. + + + + + Returns the name of this section, if any. + + + The section's name, or null. + + + + + Details about a UNET MatchMaker match. + + + + + The binary access token this client uses to authenticate its session for future commands. + + + + + IP address of the host of the match,. + + + + + The numeric domain for the match. + + + + + The unique ID of this match. + + + + + NodeID for this member client in the match. + + + + + Port of the host of the match. + + + + + This flag indicates whether or not the match is using a Relay server. + + + + + A class describing the match information as a snapshot at the time the request was processed on the MatchMaker. + + + + + The average Elo score of the match. + + + + + The current number of players in the match. + + + + + The collection of direct connect info classes describing direct connection information supplied to the MatchMaker. + + + + + The NodeID of the host for this match. + + + + + Describes if the match is private. Private matches are unlisted in ListMatch results. + + + + + The collection of match attributes on this match. + + + + + The maximum number of players this match can grow to. + + + + + The text name for this match. + + + + + The network ID for this match. + + + + + A class describing one member of a match and what direct connect information other clients have supplied. + + + + + The host priority for this direct connect info. Host priority describes the order in which this match member occurs in the list of clients attached to a match. + + + + + NodeID of the match member this info refers to. + + + + + The private network address supplied for this direct connect info. + + + + + The public network address supplied for this direct connect info. + + + + + A component for communicating with the Unity Multiplayer Matchmaking service. + + + + + The base URI of the MatchMaker that this NetworkMatch will communicate with. + + + + + A delegate that can handle MatchMaker responses that return basic response types (generally only indicating success or failure and extended information if a failure did happen). + + Indicates if the request succeeded. + A text description of the failure if success is false. + + + + Use this function to create a new match. The client which calls this function becomes the host of the match. + + The text string describing the name for this match. + When creating a match, the matchmaker will use either this value, or the maximum size you have configured online at https:multiplayer.unity3d.com, whichever is lower. This way you can specify different match sizes for a particular game, but still maintain an overall size limit in the online control panel. + A bool indicating if this match should be available in NetworkMatch.ListMatches results. + A text string indicating if this match is password protected. If it is, all clients trying to join this match must supply the correct match password. + The optional public client address. This value is stored on the matchmaker and given to clients listing matches. It is intended to be a network address for connecting to this client directly over the internet. This value will only be present if a publicly available address is known, and direct connection is supported by the matchmaker. + The optional private client address. This value is stored on the matchmaker and given to clients listing matches. It is intended to be a network address for connecting to this client directly on a local area network. This value will only be present if direct connection is supported by the matchmaker. This may be an empty string and it will not affect the ability to interface with matchmaker or use relay server. + The Elo score for the client hosting the match being created. If this number is set on all clients to indicate relative skill level, this number is used to return matches ordered by those that are most suitable for play given a listing player's skill level. This may be 0 on all clients, which would disable any Elo calculations in the MatchMaker. + The request domain for this request. Only requests in the same domain can interface with each other. For example if a NetworkMatch.CreateMatch is made with domain 1, only ListMatches that also specify domain 1 will find that match. Use this value to silo different (possibly incompatible) client versions. + The callback to be called when this function completes. This will be called regardless of whether the function succeeds or fails. + + This function is asynchronous and will complete at some point in the future, when the coroutine has finished communicating with the service backend. + + + + + Response delegate containing basic information plus a data member. This is used on a subset of MatchMaker callbacks that require data passed in along with the success/failure information of the call itself. + + Indicates if the request succeeded. + If success is false, this will contain a text string indicating the reason. + The generic passed in containing data required by the callback. This typically contains data returned from a call to the service backend. + + + + This function is used to tell MatchMaker to destroy a match in progress, regardless of who is connected. + + The NetworkID of the match to terminate. + The request domain for this request. Only requests in the same domain can interface with each other. For example if a NetworkMatch.CreateMatch is made with domain 1, only ListMatches that also specify domain 1 will find that match. Use this value to silo different (possibly incompatible) client versions. + The callback to be called when the request completes. + + This function is asynchronous and will complete at some point in the future, when the coroutine has finished communicating with the service backend. + + + + + A function to allow an individual client to be dropped from a match. + + The NetworkID of the match the client to drop belongs to. + The NodeID of the client to drop inside the specified match. + The request domain for this request. Only requests in the same domain can interface with each other. For example if a NetworkMatch.CreateMatch is made with domain 1, only ListMatches that also specify domain 1 will find that match. Use this value to silo different (possibly incompatible) client versions. + The callback to invoke when the request completes. + + This function is asynchronous and will complete at some point in the future, when the coroutine has finished communicating with the service backend. + + + + + The function used to tell MatchMaker the current client wishes to join a specific match. + + The NetworkID of the match to join. This is found through calling NetworkMatch.ListMatches and picking a result from the returned list of matches. + The password of the match. Leave empty if there is no password for the match, and supply the text string password if the match was configured to have one of the NetworkMatch.CreateMatch request. + The optional public client address. This value will be stored on the matchmaker and given to other clients listing matches. You should send this value if you want your players to be able to connect directly with each other over the internet. Alternatively you can pass an empty string and it will not affect the ability to interface with matchmaker or use relay server. + The optional private client address. This value will be stored on the matchmaker and given to other clients listing matches. You should send this value if you want your players to be able to connect directly with each other over a Local Area Network. Alternatively you can pass an empty string and it will not affect the ability to interface with matchmaker or use relay server. + The Elo score for the client joining the match being created. If this number is set on all clients to indicate relative skill level, this number is used to return matches ordered by those that are most suitable for play given a listing player's skill level. This may be 0 on all clients, which would disable any Elo calculations in the MatchMaker. + The request domain for this request. Only requests in the same domain can interface with each other. For example if a NetworkMatch.CreateMatch is made with domain 1, only ListMatches that also specify domain 1 will find that match. Use this value to silo different (possibly incompatible) client versions. + The callback to be invoked when this call completes. + + This function is asynchronous and will complete at some point in the future, when the coroutine has finished communicating with the service backend. + + + + + The function to list ongoing matches in the MatchMaker. + + The current page to list in the return results. + The size of the page requested. This determines the maximum number of matches contained in the list of matches passed into the callback. + The text string name filter. This is a partial wildcard search against match names that are currently active, and can be thought of as matching equivalent to *<matchNameFilter>* where any result containing the entire string supplied here will be in the result set. + Boolean that indicates if the response should contain matches that are private (meaning matches that are password protected). + The Elo score target for the match list results to be grouped around. If used, this should be set to the Elo level of the client listing the matches so results will more closely match that player's skill level. If not used this can be set to 0 along with all other Elo refereces in funcitons like NetworkMatch.CreateMatch or NetworkMatch.JoinMatch. + The request domain for this request. Only requests in the same domain can interface with each other. For example if a NetworkMatch.CreateMatch is made with domain 1, only ListMatches that also specify domain 1 will find that match. Use this value to silo different (possibly incompatible) client versions. + The callback invoked when this call completes on the MatchMaker. + + This function is asynchronous and will complete at some point in the future, when the coroutine has finished communicating with the service backend. + + + + + This function allows the caller to change attributes on a match in progress. + + The NetworkID of the match to set attributes on. + A bool indicating whether the match should be listed in NetworkMatch.ListMatches results after this call is complete. + The request domain for this request. Only requests in the same domain can interface with each other. For example if a NetworkMatch.CreateMatch is made with domain 1, only ListMatches that also specify domain 1 will find that match. Use this value to silo different (possibly incompatible) client versions. + The callback invoked after the call has completed, indicating if it was successful or not. + + This function is asynchronous and will complete at some point in the future, when the coroutine has finished communicating with the service backend. + + + + + This method is deprecated. Please instead log in through the editor services panel and setup the project under the Unity Multiplayer section. This will populate the required infomation from the cloud site automatically. + + Deprecated, see description. + + + + A helper object for form sections containing generic, non-file data. + + + + + Returns the value to use in this section's Content-Type header. + + + The Content-Type header for this section, or null. + + + + + Returns a string denoting the desired filename of this section on the destination server. + + + The desired file name of this section, or null if this is not a file section. + + + + + Returns the raw binary data contained in this section. Will not return null or a zero-length array. + + + The raw binary data contained in this section. Will not be null or empty. + + + + + Returns the name of this section, if any. + + + The section's name, or null. + + + + + Raw data section, unnamed and no Content-Type header. + + Data payload of this section. + + + + Raw data section with a section name, no Content-Type header. + + Section name. + Data payload of this section. + + + + A raw data section with a section name and a Content-Type header. + + Section name. + Data payload of this section. + The value for this section's Content-Type header. + + + + A named raw data section whose payload is derived from a string, with a Content-Type header. + + Section name. + String data payload for this section. + The value for this section's Content-Type header. + An encoding to marshal data to or from raw bytes. + + + + A named raw data section whose payload is derived from a UTF8 string, with a Content-Type header. + + Section name. + String data payload for this section. + C. + + + + A names raw data section whose payload is derived from a UTF8 string, with a default Content-Type. + + Section name. + String data payload for this section. + + + + An anonymous raw data section whose payload is derived from a UTF8 string, with a default Content-Type. + + String data payload for this section. + + + + A helper object for adding file uploads to multipart forms via the [IMultipartFormSection] API. + + + + + Returns the value of the section's Content-Type header. + + + The Content-Type header for this section, or null. + + + + + Returns a string denoting the desired filename of this section on the destination server. + + + The desired file name of this section, or null if this is not a file section. + + + + + Returns the raw binary data contained in this section. Will not return null or a zero-length array. + + + The raw binary data contained in this section. Will not be null or empty. + + + + + Returns the name of this section, if any. + + + The section's name, or null. + + + + + Contains a named file section based on the raw bytes from data, with a custom Content-Type and file name. + + Name of this form section. + Raw contents of the file to upload. + Name of the file uploaded by this form section. + The value for this section's Content-Type header. + + + + Contains an anonymous file section based on the raw bytes from data, assigns a default Content-Type and file name. + + Raw contents of the file to upload. + + + + Contains an anonymous file section based on the raw bytes from data with a specific file name. Assigns a default Content-Type. + + Raw contents of the file to upload. + Name of the file uploaded by this form section. + + + + Contains a named file section with data drawn from data, as marshaled by dataEncoding. Assigns a specific file name from fileName and a default Content-Type. + + Name of this form section. + Contents of the file to upload. + A string encoding. + Name of the file uploaded by this form section. + + + + An anonymous file section with data drawn from data, as marshaled by dataEncoding. Assigns a specific file name from fileName and a default Content-Type. + + Contents of the file to upload. + A string encoding. + Name of the file uploaded by this form section. + + + + An anonymous file section with data drawn from the UTF8 string data. Assigns a specific file name from fileName and a default Content-Type. + + Contents of the file to upload. + Name of the file uploaded by this form section. + + + + Possible Networking.NetworkTransport errors. + + + + + Not a data message. + + + + + The Networking.ConnectionConfig does not match the other endpoint. + + + + + The address supplied to connect to was invalid or could not be resolved. + + + + + The message is too long to fit the buffer. + + + + + Not enough resources are available to process this request. + + + + + The operation completed successfully. + + + + + Connection timed out. + + + + + This error will occur if any function is called with inappropriate parameter values. + + + + + The protocol versions are not compatible. Check your library versions. + + + + + The specified channel doesn't exist. + + + + + The specified connectionId doesn't exist. + + + + + The specified host not available. + + + + + Operation is not supported. + + + + + Event that is returned when calling the Networking.NetworkTransport.Receive and Networking.NetworkTransport.ReceiveFromHost functions. + + + + + Broadcast discovery event received. +To obtain sender connection info and possible complimentary message from them, call Networking.NetworkTransport.GetBroadcastConnectionInfo() and Networking.NetworkTransport.GetBroadcastConnectionMessage() functions. + + + + + Connection event received. Indicating that a new connection was established. + + + + + Data event received. Indicating that data was received. + + + + + Disconnection event received. + + + + + No new event was received. + + + + + Transport Layer API. + + + + + Creates a host based on Networking.HostTopology. + + The Networking.HostTopology associated with the host. + Port to bind to (when 0 is selected, the OS will choose a port at random). + IP address to bind to. + + Returns the ID of the host that was created. + + + + + Create a host and configure them to simulate Internet latency (works on Editor and development build only). + + The Networking.HostTopology associated with the host. + Minimum simulated delay in milliseconds. + Maximum simulated delay in milliseconds. + Port to bind to (when 0 is selected, the OS will choose a port at random). + IP address to bind to. + + Returns host ID just created. + + + + + Created web socket host. + + Port to bind to. + The Networking.HostTopology associated with the host. + IP address to bind to. + + Web socket host id. + + + + + Created web socket host. + + Port to bind to. + The Networking.HostTopology associated with the host. + IP address to bind to. + + Web socket host id. + + + + + Tries to establish a connection to another peer. + + Host ID associated with this connection (retrieved when calling Networking.NetworkTransport.AddHost). + IPv4 address of the other peer. + Port of the other peer. + Set to 0 in the case of a default connection. + Error (can be cast to Networking.NetworkError for more information). + + + A unique connection identifier on success (otherwise zero). + + + + + Create dedicated connection to Relay server. + + Host ID associated with this connection (Retrieved when calling Networking.NetworkTransport.AddHost). + IPv4 address of the relay. + Port of the relay. + GUID for the relay match, retrieved by calling Networking.Match.NetworkMatch.CreateMatch and using the Networking.Match.MatchInfo.networkId. + GUID for the source, can be retrieved by calling Utility.GetSourceID. + Error (can be cast to Networking.NetworkError for more information). + Slot ID for this user, retrieved by calling Networking.Match.NetworkMatch.CreateMatch and using the Networking.Match.MatchInfo.nodeId. + + + + Try to establish connection to other peer, where the peer is specified using a C# System.EndPoint. + + Host ID associated with this connection (Retrieved when calling Networking.NetworkTransport.AddHost). + Error (can be cast to Networking.NetworkError for more information). + A valid System.EndPoint. + Set to 0 in the case of a default connection. + + + A unique connection identifier on success (otherwise zero). + + + + + Create a connection to another peer in the Relay group. + + Host ID associated with this connection (retrieved when calling Networking.NetworkTransport.AddHost). + IP address of the peer, retrieved by calling Networking.Match.NetworkMatch.JoinMatch and using the Networking.Match.MatchInfo.address. + Port of the peer, retrieved by calling Networking.Match.NetworkMatch.JoinMatch and using the Networking.Match.MatchInfo.port. + Set to 0 in the case of a default connection. + ID of the remote peer in relay. + GUID for the relay match, retrieved by calling Networking.Match.NetworkMatch.JoinMatch and using the Networking.Match.MatchInfo.networkId. + GUID for the source, can be retrieved by calling Utility.GetSourceID. + Error (can be cast to Networking.NetworkError for more information). + Slot ID reserved for the user, retrieved by calling Networking.Match.NetworkMatch.JoinMatch and using the Networking.Match.MatchInfo.nodeId. + Allowed peak bandwidth (peak bandwidth = factor*bytesPerSec, recommended value is 2.0) If data has not been sent for a long time, it is allowed to send more data, with factor 2 it is allowed send 2*bytesPerSec bytes per sec. + Average bandwidth (bandwidth will be throttled on this level). + + A unique connection identifier on success (otherwise zero). + + + + + Create a connection to another peer in the Relay group. + + Host ID associated with this connection (retrieved when calling Networking.NetworkTransport.AddHost). + IP address of the peer, retrieved by calling Networking.Match.NetworkMatch.JoinMatch and using the Networking.Match.MatchInfo.address. + Port of the peer, retrieved by calling Networking.Match.NetworkMatch.JoinMatch and using the Networking.Match.MatchInfo.port. + Set to 0 in the case of a default connection. + ID of the remote peer in relay. + GUID for the relay match, retrieved by calling Networking.Match.NetworkMatch.JoinMatch and using the Networking.Match.MatchInfo.networkId. + GUID for the source, can be retrieved by calling Utility.GetSourceID. + Error (can be cast to Networking.NetworkError for more information). + Slot ID reserved for the user, retrieved by calling Networking.Match.NetworkMatch.JoinMatch and using the Networking.Match.MatchInfo.nodeId. + Allowed peak bandwidth (peak bandwidth = factor*bytesPerSec, recommended value is 2.0) If data has not been sent for a long time, it is allowed to send more data, with factor 2 it is allowed send 2*bytesPerSec bytes per sec. + Average bandwidth (bandwidth will be throttled on this level). + + A unique connection identifier on success (otherwise zero). + + + + + Connect with simulated latency. + + Host ID associated with this connection (Retrieved when calling Networking.NetworkTransport.AddHost). + IPv4 address of the other peer. + Port of the other peer. + Set to 0 in the case of a default connection. + Error (can be cast to Networking.NetworkError for more information). + A Networking.ConnectionSimulatorConfig defined for this connection. + + A unique connection identifier on success (otherwise zero). + + + + + Send a disconnect signal to the connected peer and close the connection. Poll Networking.NetworkTransport.Receive() to be notified that the connection is closed. This signal is only sent once (best effort delivery). If this packet is dropped for some reason, the peer closes the connection by timeout. + + Host ID associated with this connection. + The connection ID of the connection you want to close. + Error (can be cast to Networking.NetworkError for more information). + + + + This will disconnect the host and disband the group. +DisconnectNetworkHost can only be called by the group owner on the relay server. + + Host ID associated with this connection. + Error (can be cast to Networking.NetworkError for more information). + + + + Finalizes sending of a message to a group of connections. Only one multicast message at a time is allowed per host. + + Host ID associated with this connection (retrieved when calling Networking.NetworkTransport.AddHost). + Error (can be cast to Networking.NetworkError for more information). + + + + Returns size of reliable buffer. + + Host ID associated with this connection. + ID of the connection. + Error (can be cast to Networking.NetworkError for more information). + + Size of ack buffer. + + + + + The Unity Multiplayer spawning system uses assetIds to identify what remote objects to spawn. This function allows you to get the assetId for the Prefab associated with an object. + + Target GameObject to get assetId for. + + The assetId of the game object's Prefab. + + + + + After Networking.NetworkTransport.Receive() returns Networking.NetworkEventType.BroadcastEvent, this function will return the connection information of the broadcast sender. This information can then be used for connecting to the broadcast sender. + + ID of the broadcast receiver. + IPv4 address of broadcast sender. + Port of broadcast sender. + Error (can be cast to Networking.NetworkError for more information). + + + + After Networking.NetworkTransport.Receive() returns Networking.NetworkEventType.BroadcastEvent, this function returns a complimentary message from the broadcast sender. + + ID of broadcast receiver. + Message buffer provided by caller. + Buffer size. + Received size (if received size > bufferSize, corresponding error will be set). + Error (can be cast to Networking.NetworkError for more information). + + + + Returns the connection parameters for the specified connectionId. These parameters can be sent to other users to establish a direct connection to this peer. If this peer is connected to the host via Relay, the Relay-related parameters are set. + + Host ID associated with this connection. + ID of connection. + IP address. + Port. + Relay network guid. + Error (can be cast to Networking.NetworkError for more information). + Destination slot id. + + + + Returns the number of unread messages in the read-queue. + + + + + Returns the total number of messages still in the write-queue. + + + + + Return the round trip time for the given connectionId. + + Error (can be cast to Networking.NetworkError for more information). + Host ID associated with this connection. + ID of the connection. + + Current round trip time in ms. + + + + + Returns the port number assigned to the host. + + Host ID. + + The UDP port number, or -1 if an error occurred. + + + + + Returns the number of received messages waiting in the queue for processing. + + Host ID associated with this queue. + Error code. Cast this value to Networking.NetworkError for more information. + + The number of messages in the queue. + + + + + Returns how many packets have been received from start for connection. + + Host ID associated with this connection. + ID of the connection. + Error (can be cast to Networking.NetworkError for more information). + + The absolute number of packets received since the connection was established. + + + + + Returns how many packets have been received from start. (from Networking.NetworkTransport.Init call). + + + Packets count received from start for all hosts. + + + + + How many packets have been dropped due lack space in incoming queue (absolute value, countinf from start). + + + Dropping packet count. + + + + + Returns how many incoming packets have been lost due transmitting (dropped by network). + + Host ID associated with this connection. + ID of the connection. + Error (can be cast to Networking.NetworkError for more information). + + The absolute number of packets that have been lost since the connection was established. + + + + + Gets the currently-allowed network bandwidth in bytes per second. The value returned can vary because bandwidth can be throttled by flow control. If the bandwidth is throttled to zero, the connection is disconnected.ted. + + Host ID associated with this connection. + ID of the connection. + Error (can be cast to Networking.NetworkError for more information). + + Currently-allowed bandwidth in bytes per second. + + + + + Function returns time spent on network I/O operations in microseconds. + + + Time in micro seconds. + + + + + Return the total number of packets that has been lost. + + Host ID associated with this connection. + ID of the connection. + Error (can be cast to Networking.NetworkError for more information). + + + + Get a network timestamp. Can be used in your messages to investigate network delays together with Networking.GetRemoteDelayTimeMS. + + + Timestamp. + + + + + Returns how much raw data (in bytes) have been sent from start for all hosts (from Networking.NetworkTransport.Init call). + + + Total data (user payload, protocol specific data, ip and udp headers) (in bytes) sent from start for all hosts. + + + + + Returns how much raw data (in bytes) have been sent from start for connection (from call Networking.NetworkTransport.Connect for active connect or from connection request receiving for passive connect). + + Host ID associated with this connection. + ID of the connection. + Error (can be cast to Networking.NetworkError for more information). + + Total data (user payload, protocol specific data, ip and udp headers) (in bytes) sent from start for connection. + + + + + Returns how much raw data (in bytes) have been sent from start for the host (from call Networking.NetworkTransport.AddHost). + + ID of the host. + Error (can be cast to Networking.NetworkError for more information). + + Total data (user payload, protocol specific data, ip and udp headers) (in bytes) sent from start for the host. + + + + + Returns how many messages have been sent from start (from Networking.NetworkTransport.Init call). + + + Messages count sent from start (from call Networking.NetworkTransport.Init) for all hosts. + + + + + Returns how many packets have been sent from start for connection (from call Networking.NetworkTransport.Connect for active connect or from connection request receiving for passive connect). + + Host ID associated with this connection. + ID of the connection. + Error (can be cast to Networking.NetworkError for more information). + + Messages count sending from start for connection. + + + + + Returns how many messages have been sent from start for host (from call Networking.NetworkTransport.AddHost). + + ID of the host. + Error (can be cast to Networking.NetworkError for more information). + + Messages count sending from start for the host. + + + + + Returns the number of messages waiting in the outgoing message queue to be sent. + + Host ID associated with this queue. + Error code. Cast this value to Networking.NetworkError for more information. + + The number of messages waiting in the outgoing message queue to be sent. + + + + + Returns how many packets have been sent from start (from call Networking.NetworkTransport.Init) for all hosts. + + + Packets count sent from networking library start (from call Networking.NetworkTransport.Init) for all hosts. + + + + + Returns how many packets have been sent for connection from it start (from call Networking.NetworkTransport.Connect for active connect or from connection request receiving for passive connect). + + Host ID associated with this connection. + ID of the connection. + Error (can be cast to Networking.NetworkError for more information). + + Packets count sent for connection from it start. + + + + + Returns how many packets have been sent for host from it start (from call Networking.NetworkTransport.AddHost). + + ID of the host. + Error (can be cast to Networking.NetworkError for more information). + + Count packets have been sent from host start. + + + + + Returns the value in percent of the number of sent packets that were dropped by the network and not received by the peer. + + Host ID associated with this connection. + ID of the connection. + Error (can be cast to Networking.NetworkError for more information). + + The number of packets dropped by the network in the last ping timeout period expressed as an integer percentage from 0 to 100. + + + + + Returns the value in percent of the number of sent packets that were dropped by the peer. + + Host ID associated with this connection. + ID of the connection. + Error (can be cast to Networking.NetworkError for more information). + + The number of packets dropped by the peer in the last ping timeout period expressed as an integer percentage from 0 to 100. + + + + + Returns how much user payload and protocol system headers (in bytes) have been sent from start (from Networking.NetworkTransport.Init call). + + + Total payload and protocol system headers (in bytes) sent from start for all hosts. + + + + + Returns how much payload and protocol system headers (in bytes) have been sent from start for connection (from call Networking.NetworkTransport.Connect for active connect or from connection request receiving for passive connect). + + Host ID associated with this connection. + ID of the connection. + Error (can be cast to Networking.NetworkError for more information). + + Total user payload and protocol system headers (in bytes) sent from start for connection. + + + + + Returns how much payload and protocol system headers (in bytes) have been sent from start for the host (from call Networking.NetworkTransport.AddHost). + + ID of the host. + Error (can be cast to Networking.NetworkError for more information). + + Total user payload and protocol system headers (in bytes) sent from start for the host. + + + + + Returns how much payload (user) bytes have been sent from start (from Networking.NetworkTransport.Init call). + + + Total payload (in bytes) sent from start for all hosts. + + + + + Returns how much payload (user) bytes have been sent from start for connection (from call Networking.NetworkTransport.Connect for active connect or from connection request receiving for passive connect). + + Host ID associated with this connection. + ID of the connection. + Error (can be cast to Networking.NetworkError for more information). + + Total payload (in bytes) sent from start for connection. + + + + + Returns how much payload (user) bytes have been sent from start for the host (from call Networking.NetworkTransport.AddHost). + + ID of the host. + Error (can be cast to Networking.NetworkError for more information). + + Total payload (in bytes) sent from start for the host. + + + + + Return the current receive rate in bytes per second. + + Host ID associated with this connection. + ID of the connection. + Error (can be cast to Networking.NetworkError for more information). + + + + Return the current send rate in bytes per second. + + Host ID associated with this connection. + ID of the connection. + Error (can be cast to Networking.NetworkError for more information). + + + + Returns the delay for the timestamp received. + + Host ID associated with this connection. + ID of the connection. + Timestamp delivered from peer. + Error (can be cast to Networking.NetworkError for more information). + + + + Deprecated. Use Networking.NetworkTransport.GetNetworkLostPacketNum() instead. + + Host ID associated with this connection. + ID of the connection. + Error (can be cast to Networking.NetworkError for more information). + + + + Initializes the NetworkTransport. Should be called before any other operations on the NetworkTransport are done. + + + + + Check if the broadcast discovery sender is running. + + + True if it is running. False if it is not running. + + + + + Deprecated. + + + + + This method allows you to specify that notifications callbacks should be called when Unity's networking can send more messages than defined in notificationLevel. + + Host ID. + Connection ID. + Defines how many free slots in the incoming queue should be available before [GlobalConfig.ConnectionReadyForSend] callback is triggered. + Error code. + + Result, if false error will show error code. + + + + + Function is queueing but not sending messages. + + Host ID associated with this connection. + ID of the connection. + Error (can be cast to Networking.NetworkError for more information). + The channel ID to send on. + Buffer containing the data to send. + Size of the buffer. + + True if success. + + + + + Called to poll the underlying system for events. + + Host ID associated with the event. + The connectionID that received the event. + The channel ID associated with the event. + The buffer that will hold the data received. + Size of the buffer supplied. + The actual receive size of the data. + Error (can be cast to Networking.NetworkError for more information). + + Type of event returned. + + + + + Similar to Networking.NetworkTransport.Receive but will only poll for the provided hostId. + + The host ID to check for events. + The connection ID that received the event. + The channel ID associated with the event. + The buffer that will hold the data received. + Size of the buffer supplied. + The actual receive size of the data. + Error (can be cast to Networking.NetworkError for more information). + + Type of event returned. + + + + + Polls the host for the following events: Networking.NetworkEventType.ConnectEvent and Networking.NetworkEventType.DisconnectEvent. +Can only be called by the relay group owner. + + The host ID to check for events. + Error (can be cast to Networking.NetworkError for more information). + + Type of event returned. + + + + + Closes the opened socket, and closes all connections belonging to that socket. + + Host ID to remove. + + + + Send data to peer. + + Host ID associated with this connection. + ID of the connection. + The channel ID to send on. + Buffer containing the data to send. + Size of the buffer. + Error (can be cast to Networking.NetworkError for more information). + + + + Add a connection for the multicast send. + + Host ID associated with this connection. + ID of the connection. + Error (can be cast to Networking.NetworkError for more information). + + + + Sends messages, previously queued by NetworkTransport.QueueMessageForSending function. + + Host ID associated with this connection. + ID of the connection. + Error (can be cast to Networking.NetworkError for more information). + + True if hostId and connectioId are valid. + + + + + Sets the credentials required for receiving broadcast messages. Should any credentials of a received broadcast message not match, the broadcast discovery message is dropped. + + Host ID associated with this broadcast. + Key part of the credentials associated with this broadcast. + Version part of the credentials associated with this broadcast. + Subversion part of the credentials associated with this broadcast. + Error (can be cast to Networking.NetworkError for more information). + + + + Used to inform the profiler of network packet statistics. + + The ID of the message being reported. + Number of messages being reported. + Number of bytes used by reported messages. + Whether the packet is outgoing (-1) or incoming (0). + + + + Shut down the NetworkTransport. + + + + + Starts sending a broadcasting message in all local subnets. + + Host ID which should be reported via broadcast (broadcast receivers will connect to this host). + Port used for the broadcast message. + Key part of the credentials associated with this broadcast. + Version part of the credentials associated with this broadcast. + Subversion part of the credentials associated with this broadcast. + Complimentary message. This message will delivered to the receiver with the broadcast event. + Size of message. + Specifies how often the broadcast message should be sent in milliseconds. + Error (can be cast to Networking.NetworkError for more information). + + Return true if broadcasting request has been submitted. + + + + + Start to multicast send. + + Host ID associated with this connection. + The channel ID. + Buffer containing the data to send. + Size of the buffer. + Error (can be cast to Networking.NetworkError for more information). + + + + Stop sending the broadcast discovery message. + + + + + Arguments passed to Action callbacks registered in PlayerConnection. + + + + + Data that is received. + + + + + The Player ID that the data is received from. + + + + + Used for handling the network connection from the Player to the Editor. + + + + + Returns a singleton instance of a PlayerConnection. + + + + + Returns true when the Editor is connected to the Player. + + + + + Blocks the calling thread until either a message with the specified messageId is received or the specified time-out elapses. + + The type ID of the message that is sent to the Editor. + The time-out specified in milliseconds. + + Returns true when the message is received and false if the call timed out. + + + + + This disconnects all of the active connections. + + + + + Registers a listener for a specific message ID, with an Action to be executed whenever that message is received by the Editor. +This ID must be the same as for messages sent from EditorConnection.Send(). + + The message ID that should cause the Action callback to be executed when received. + Action that is executed when a message with ID messageId is received by the Editor. +The callback includes the data that is sent from the Player, and the Player ID. +The Player ID is always 1, because only one Editor can be connected. + + + + Registers a callback that is invoked when the Editor connects to the Player. + + The action that is called when the Player connects to the Editor, with the Player ID of the Editor. + + + + Registers a callback to be called when Editor disconnects. + + The Action that is called when a Player disconnects from the Editor. + + + + Sends data to the Editor. + + The type ID of the message that is sent to the Editor. + + + + + Deregisters a message listener. + + Message ID associated with the callback that you wish to deregister. + The associated callback function you wish to deregister. + + + + Enumeration of all supported quality of service channel modes. + + + + + A reliable message that will be re-sent with a high frequency until it is acknowledged. + + + + + Each message is guaranteed to be delivered but not guaranteed to be in order. + + + + + Each message is guaranteed to be delivered, also allowing fragmented messages with up to 32 fragments per message. + + + + + Each message is guaranteed to be delivered in order, also allowing fragmented messages with up to 32 fragments per message. + + + + + Each message is guaranteed to be delivered and in order. + + + + + A reliable message. Note: Only the last message in the send buffer is sent. Only the most recent message in the receive buffer will be delivered. + + + + + An unreliable message. Only the last message in the send buffer is sent. Only the most recent message in the receive buffer will be delivered. + + + + + There is no guarantee of delivery or ordering. + + + + + There is no guarantee of delivery or ordering, but allowing fragmented messages with up to 32 fragments per message. + + + + + There is garantee of ordering, no guarantee of delivery, but allowing fragmented messages with up to 32 fragments per message. + + + + + There is no guarantee of delivery and all unordered messages will be dropped. Example: VoIP. + + + + + Define how unet will handle network io operation. + + + + + Network thread will sleep up to threadawake timeout, after that it will try receive up to maxpoolsize amount of messages and then will try perform send operation for connection whihc ready to send. + + + + + Network thread will sleep up to threadawake timeout, or up to receive event on socket will happened. Awaked thread will try to read up to maxpoolsize packets from socket and will try update connections ready to send (with fixing awaketimeout rate). + + + + + The AppID identifies the application on the Unity Cloud or UNET servers. + + + + + Invalid AppID. + + + + + An Enum representing the priority of a client in a match, starting at 0 and increasing. + + + + + The Invalid case for a HostPriority. An Invalid host priority is not a valid host. + + + + + Describes the access levels granted to this client. + + + + + Administration access level, generally describing clearence to perform game altering actions against anyone inside a particular match. + + + + + Invalid access level, signifying no access level has been granted/specified. + + + + + Access level Owner, generally granting access for operations key to the peer host server performing it's work. + + + + + User access level. This means you can do operations which affect yourself only, like disconnect yourself from the match. + + + + + Access token used to authenticate a client session for the purposes of allowing or disallowing match operations requested by that client. + + + + + Binary field for the actual token. + + + + + Accessor to get an encoded string from the m_array data. + + + + + Checks if the token is a valid set of data with respect to default values (returns true if the values are not default, does not validate the token is a current legitimate token with respect to the server's auth framework). + + + + + Network ID, used for match making. + + + + + Invalid NetworkID. + + + + + The NodeID is the ID used in Relay matches to track nodes in a network. + + + + + The invalid case of a NodeID. + + + + + Identifies a specific game instance. + + + + + Invalid SourceID. + + + + + The UnityWebRequest object is used to communicate with web servers. + + + + + Holds a reference to a CertificateHandler object, which manages certificate validation for this UnityWebRequest. + + + + + Indicates whether the UnityWebRequest system should employ the HTTP/1.1 chunked-transfer encoding method. + + + + + If true, any CertificateHandler attached to this UnityWebRequest will have CertificateHandler.Dispose called automatically when UnityWebRequest.Dispose is called. + + + + + If true, any DownloadHandler attached to this UnityWebRequest will have DownloadHandler.Dispose called automatically when UnityWebRequest.Dispose is called. + + + + + If true, any UploadHandler attached to this UnityWebRequest will have UploadHandler.Dispose called automatically when UnityWebRequest.Dispose is called. + + + + + Returns the number of bytes of body data the system has downloaded from the remote server. (Read Only) + + + + + Holds a reference to a DownloadHandler object, which manages body data received from the remote server by this UnityWebRequest. + + + + + Returns a floating-point value between 0.0 and 1.0, indicating the progress of downloading body data from the server. (Read Only) + + + + + A human-readable string describing any system errors encountered by this UnityWebRequest object while handling HTTP requests or responses. (Read Only) + + + + + Returns true after the UnityWebRequest has finished communicating with the remote server. (Read Only) + + + + + Returns true after this UnityWebRequest receives an HTTP response code indicating an error. (Read Only) + + + + + Returns true while a UnityWebRequest’s configuration properties can be altered. (Read Only) + + + + + Returns true after this UnityWebRequest encounters a system error. (Read Only) + + + + + The string "CREATE", commonly used as the verb for an HTTP CREATE request. + + + + + The string "DELETE", commonly used as the verb for an HTTP DELETE request. + + + + + The string "GET", commonly used as the verb for an HTTP GET request. + + + + + The string "HEAD", commonly used as the verb for an HTTP HEAD request. + + + + + The string "POST", commonly used as the verb for an HTTP POST request. + + + + + The string "PUT", commonly used as the verb for an HTTP PUT request. + + + + + Defines the HTTP verb used by this UnityWebRequest, such as GET or POST. + + + + + Indicates the number of redirects which this UnityWebRequest will follow before halting with a “Redirect Limit Exceeded” system error. + + + + + The numeric HTTP response code returned by the server, such as 200, 404 or 500. (Read Only) + + + + + Sets UnityWebRequest to attempt to abort after the number of seconds in timeout have passed. + + + + + Returns the number of bytes of body data the system has uploaded to the remote server. (Read Only) + + + + + Holds a reference to the UploadHandler object which manages body data to be uploaded to the remote server. + + + + + Returns a floating-point value between 0.0 and 1.0, indicating the progress of uploading body data to the server. + + + + + Defines the target URI for the UnityWebRequest to communicate with. + + + + + Defines the target URL for the UnityWebRequest to communicate with. + + + + + Determines whether this UnityWebRequest will include Expect: 100-Continue in its outgoing request headers. (Default: true). + + + + + If in progress, halts the UnityWebRequest as soon as possible. + + + + + Clears stored cookies from the cache. + + An optional URL to define which cookies are removed. Only cookies that apply to this URL will be removed from the cache. + + + + Clears stored cookies from the cache. + + An optional URL to define which cookies are removed. Only cookies that apply to this URL will be removed from the cache. + + + + Creates a UnityWebRequest with the default options and no attached DownloadHandler or UploadHandler. Default method is GET. + + The target URL with which this UnityWebRequest will communicate. Also accessible via the url property. + The target URI to which form data will be transmitted. + HTTP GET, POST, etc. methods. + Replies from the server. + Upload data to the server. + + + + Creates a UnityWebRequest with the default options and no attached DownloadHandler or UploadHandler. Default method is GET. + + The target URL with which this UnityWebRequest will communicate. Also accessible via the url property. + The target URI to which form data will be transmitted. + HTTP GET, POST, etc. methods. + Replies from the server. + Upload data to the server. + + + + Creates a UnityWebRequest with the default options and no attached DownloadHandler or UploadHandler. Default method is GET. + + The target URL with which this UnityWebRequest will communicate. Also accessible via the url property. + The target URI to which form data will be transmitted. + HTTP GET, POST, etc. methods. + Replies from the server. + Upload data to the server. + + + + Creates a UnityWebRequest with the default options and no attached DownloadHandler or UploadHandler. Default method is GET. + + The target URL with which this UnityWebRequest will communicate. Also accessible via the url property. + The target URI to which form data will be transmitted. + HTTP GET, POST, etc. methods. + Replies from the server. + Upload data to the server. + + + + Creates a UnityWebRequest with the default options and no attached DownloadHandler or UploadHandler. Default method is GET. + + The target URL with which this UnityWebRequest will communicate. Also accessible via the url property. + The target URI to which form data will be transmitted. + HTTP GET, POST, etc. methods. + Replies from the server. + Upload data to the server. + + + + Creates a UnityWebRequest with the default options and no attached DownloadHandler or UploadHandler. Default method is GET. + + The target URL with which this UnityWebRequest will communicate. Also accessible via the url property. + The target URI to which form data will be transmitted. + HTTP GET, POST, etc. methods. + Replies from the server. + Upload data to the server. + + + + Creates a UnityWebRequest with the default options and no attached DownloadHandler or UploadHandler. Default method is GET. + + The target URL with which this UnityWebRequest will communicate. Also accessible via the url property. + The target URI to which form data will be transmitted. + HTTP GET, POST, etc. methods. + Replies from the server. + Upload data to the server. + + + + Creates a UnityWebRequest configured for HTTP DELETE. + + The URI to which a DELETE request should be sent. + + A UnityWebRequest configured to send an HTTP DELETE request. + + + + + Signals that this UnityWebRequest is no longer being used, and should clean up any resources it is using. + + + + + Escapes characters in a string to ensure they are URL-friendly. + + A string with characters to be escaped. + The text encoding to use. + + + + Escapes characters in a string to ensure they are URL-friendly. + + A string with characters to be escaped. + The text encoding to use. + + + + Generate a random 40-byte array for use as a multipart form boundary. + + + 40 random bytes, guaranteed to contain only printable ASCII values. + + + + + Create a UnityWebRequest for HTTP GET. + + The URI of the resource to retrieve via HTTP GET. + + An object that retrieves data from the uri. + + + + + Create a UnityWebRequest for HTTP GET. + + The URI of the resource to retrieve via HTTP GET. + + An object that retrieves data from the uri. + + + + + Deprecated. Replaced by UnityWebRequestAssetBundle.GetAssetBundle. + + + + + + + + + + Deprecated. Replaced by UnityWebRequestAssetBundle.GetAssetBundle. + + + + + + + + + + Deprecated. Replaced by UnityWebRequestAssetBundle.GetAssetBundle. + + + + + + + + + + Deprecated. Replaced by UnityWebRequestAssetBundle.GetAssetBundle. + + + + + + + + + + OBSOLETE. Use UnityWebRequestMultimedia.GetAudioClip(). + + + + + + + Retrieves the value of a custom request header. + + Name of the custom request header. Case-insensitive. + + The value of the custom request header. If no custom header with a matching name has been set, returns an empty string. + + + + + Retrieves the value of a response header from the latest HTTP response received. + + The name of the HTTP header to retrieve. Case-insensitive. + + The value of the HTTP header from the latest HTTP response. If no header with a matching name has been received, or no responses have been received, returns null. + + + + + Retrieves a dictionary containing all the response headers received by this UnityWebRequest in the latest HTTP response. + + + A dictionary containing all the response headers received in the latest HTTP response. If no responses have been received, returns null. + + + + + Creates a UnityWebRequest intended to download an image via HTTP GET and create a Texture based on the retrieved data. + + The URI of the image to download. + If true, the texture's raw data will not be accessible to script. This can conserve memory. Default: false. + + A UnityWebRequest properly configured to download an image and convert it to a Texture. + + + + + Creates a UnityWebRequest intended to download an image via HTTP GET and create a Texture based on the retrieved data. + + The URI of the image to download. + If true, the texture's raw data will not be accessible to script. This can conserve memory. Default: false. + + A UnityWebRequest properly configured to download an image and convert it to a Texture. + + + + + Creates a UnityWebRequest configured to send a HTTP HEAD request. + + The URI to which to send a HTTP HEAD request. + + A UnityWebRequest configured to transmit a HTTP HEAD request. + + + + + Creates a UnityWebRequest configured to send form data to a server via HTTP POST. + + The target URI to which form data will be transmitted. + Form body data. Will be URLEncoded prior to transmission. + + A UnityWebRequest configured to send form data to uri via POST. + + + + + Create a UnityWebRequest configured to send form data to a server via HTTP POST. + + The target URI to which form data will be transmitted. + Form fields or files encapsulated in a WWWForm object, for formatting and transmission to the remote server. + + A UnityWebRequest configured to send form data to uri via POST. + + + + + Create a UnityWebRequest configured to send form data to a server via HTTP POST. + + The target URI to which form data will be transmitted. + A list of form fields or files to be formatted and transmitted to the remote server. + A unique boundary string, which will be used when separating form fields in a multipart form. If not supplied, a boundary will be generated for you. + + A UnityWebRequest configured to send form data to uri via POST. + + + + + Create a UnityWebRequest configured to send form data to a server via HTTP POST. + + The target URI to which form data will be transmitted. + A list of form fields or files to be formatted and transmitted to the remote server. + A unique boundary string, which will be used when separating form fields in a multipart form. If not supplied, a boundary will be generated for you. + + A UnityWebRequest configured to send form data to uri via POST. + + + + + Create a UnityWebRequest configured to send form data to a server via HTTP POST. + + The target URI to which form data will be transmitted. + Strings indicating the keys and values of form fields. Will be automatically formatted into a URL-encoded form body. + + A UnityWebRequest configured to send form data to uri via POST. + + + + + Creates a UnityWebRequest configured to upload raw data to a remote server via HTTP PUT. + + The URI to which the data will be sent. + The data to transmit to the remote server. + +If a string, the string will be converted to raw bytes via <a href="http:msdn.microsoft.comen-uslibrarysystem.text.encoding.utf8">System.Text.Encoding.UTF8<a>. + + A UnityWebRequest configured to transmit bodyData to uri via HTTP PUT. + + + + + Creates a UnityWebRequest configured to upload raw data to a remote server via HTTP PUT. + + The URI to which the data will be sent. + The data to transmit to the remote server. + +If a string, the string will be converted to raw bytes via <a href="http:msdn.microsoft.comen-uslibrarysystem.text.encoding.utf8">System.Text.Encoding.UTF8<a>. + + A UnityWebRequest configured to transmit bodyData to uri via HTTP PUT. + + + + + Begin communicating with the remote server. + + + An AsyncOperation indicating the progress/completion state of the UnityWebRequest. Yield this object to wait until the UnityWebRequest is done. + + + + + Begin communicating with the remote server. + + + + + Converts a List of IMultipartFormSection objects into a byte array containing raw multipart form data. + + A List of IMultipartFormSection objects. + A unique boundary string to separate the form sections. + + A byte array of raw multipart form data. + + + + + Serialize a dictionary of strings into a byte array containing URL-encoded UTF8 characters. + + A dictionary containing the form keys and values to serialize. + + A byte array containing the serialized form. The form's keys and values have been URL-encoded. + + + + + Set a HTTP request header to a custom value. + + The key of the header to be set. Case-sensitive. + The header's intended value. + + + + Converts URL-friendly escape sequences back to normal text. + + A string containing escaped characters. + The text encoding to use. + + + + Converts URL-friendly escape sequences back to normal text. + + A string containing escaped characters. + The text encoding to use. + + + + Helpers for downloading asset bundles using UnityWebRequest. + + + + + Creates a UnityWebRequest optimized for downloading a Unity Asset Bundle via HTTP GET. + + The URI of the asset bundle to download. + If nonzero, this number will be compared to the checksum of the downloaded asset bundle data. If the CRCs do not match, an error will be logged and the asset bundle will not be loaded. If set to zero, CRC checking will be skipped. + An integer version number, which will be compared to the cached version of the asset bundle to download. Increment this number to force Unity to redownload a cached asset bundle. + +Analogous to the version parameter for WWW.LoadFromCacheOrDownload. + A version hash. If this hash does not match the hash for the cached version of this asset bundle, the asset bundle will be redownloaded. + A structure used to download a given version of AssetBundle to a customized cache path. + + A UnityWebRequest configured to downloading a Unity Asset Bundle. + + + + + Creates a UnityWebRequest optimized for downloading a Unity Asset Bundle via HTTP GET. + + The URI of the asset bundle to download. + If nonzero, this number will be compared to the checksum of the downloaded asset bundle data. If the CRCs do not match, an error will be logged and the asset bundle will not be loaded. If set to zero, CRC checking will be skipped. + An integer version number, which will be compared to the cached version of the asset bundle to download. Increment this number to force Unity to redownload a cached asset bundle. + +Analogous to the version parameter for WWW.LoadFromCacheOrDownload. + A version hash. If this hash does not match the hash for the cached version of this asset bundle, the asset bundle will be redownloaded. + A structure used to download a given version of AssetBundle to a customized cache path. + + A UnityWebRequest configured to downloading a Unity Asset Bundle. + + + + + Creates a UnityWebRequest optimized for downloading a Unity Asset Bundle via HTTP GET. + + The URI of the asset bundle to download. + If nonzero, this number will be compared to the checksum of the downloaded asset bundle data. If the CRCs do not match, an error will be logged and the asset bundle will not be loaded. If set to zero, CRC checking will be skipped. + An integer version number, which will be compared to the cached version of the asset bundle to download. Increment this number to force Unity to redownload a cached asset bundle. + +Analogous to the version parameter for WWW.LoadFromCacheOrDownload. + A version hash. If this hash does not match the hash for the cached version of this asset bundle, the asset bundle will be redownloaded. + A structure used to download a given version of AssetBundle to a customized cache path. + + A UnityWebRequest configured to downloading a Unity Asset Bundle. + + + + + Creates a UnityWebRequest optimized for downloading a Unity Asset Bundle via HTTP GET. + + The URI of the asset bundle to download. + If nonzero, this number will be compared to the checksum of the downloaded asset bundle data. If the CRCs do not match, an error will be logged and the asset bundle will not be loaded. If set to zero, CRC checking will be skipped. + An integer version number, which will be compared to the cached version of the asset bundle to download. Increment this number to force Unity to redownload a cached asset bundle. + +Analogous to the version parameter for WWW.LoadFromCacheOrDownload. + A version hash. If this hash does not match the hash for the cached version of this asset bundle, the asset bundle will be redownloaded. + A structure used to download a given version of AssetBundle to a customized cache path. + + A UnityWebRequest configured to downloading a Unity Asset Bundle. + + + + + Creates a UnityWebRequest optimized for downloading a Unity Asset Bundle via HTTP GET. + + The URI of the asset bundle to download. + If nonzero, this number will be compared to the checksum of the downloaded asset bundle data. If the CRCs do not match, an error will be logged and the asset bundle will not be loaded. If set to zero, CRC checking will be skipped. + An integer version number, which will be compared to the cached version of the asset bundle to download. Increment this number to force Unity to redownload a cached asset bundle. + +Analogous to the version parameter for WWW.LoadFromCacheOrDownload. + A version hash. If this hash does not match the hash for the cached version of this asset bundle, the asset bundle will be redownloaded. + A structure used to download a given version of AssetBundle to a customized cache path. + + A UnityWebRequest configured to downloading a Unity Asset Bundle. + + + + + Creates a UnityWebRequest optimized for downloading a Unity Asset Bundle via HTTP GET. + + The URI of the asset bundle to download. + If nonzero, this number will be compared to the checksum of the downloaded asset bundle data. If the CRCs do not match, an error will be logged and the asset bundle will not be loaded. If set to zero, CRC checking will be skipped. + An integer version number, which will be compared to the cached version of the asset bundle to download. Increment this number to force Unity to redownload a cached asset bundle. + +Analogous to the version parameter for WWW.LoadFromCacheOrDownload. + A version hash. If this hash does not match the hash for the cached version of this asset bundle, the asset bundle will be redownloaded. + A structure used to download a given version of AssetBundle to a customized cache path. + + A UnityWebRequest configured to downloading a Unity Asset Bundle. + + + + + Creates a UnityWebRequest optimized for downloading a Unity Asset Bundle via HTTP GET. + + The URI of the asset bundle to download. + If nonzero, this number will be compared to the checksum of the downloaded asset bundle data. If the CRCs do not match, an error will be logged and the asset bundle will not be loaded. If set to zero, CRC checking will be skipped. + An integer version number, which will be compared to the cached version of the asset bundle to download. Increment this number to force Unity to redownload a cached asset bundle. + +Analogous to the version parameter for WWW.LoadFromCacheOrDownload. + A version hash. If this hash does not match the hash for the cached version of this asset bundle, the asset bundle will be redownloaded. + A structure used to download a given version of AssetBundle to a customized cache path. + + A UnityWebRequest configured to downloading a Unity Asset Bundle. + + + + + Creates a UnityWebRequest optimized for downloading a Unity Asset Bundle via HTTP GET. + + The URI of the asset bundle to download. + If nonzero, this number will be compared to the checksum of the downloaded asset bundle data. If the CRCs do not match, an error will be logged and the asset bundle will not be loaded. If set to zero, CRC checking will be skipped. + An integer version number, which will be compared to the cached version of the asset bundle to download. Increment this number to force Unity to redownload a cached asset bundle. + +Analogous to the version parameter for WWW.LoadFromCacheOrDownload. + A version hash. If this hash does not match the hash for the cached version of this asset bundle, the asset bundle will be redownloaded. + A structure used to download a given version of AssetBundle to a customized cache path. + + A UnityWebRequest configured to downloading a Unity Asset Bundle. + + + + + Creates a UnityWebRequest optimized for downloading a Unity Asset Bundle via HTTP GET. + + The URI of the asset bundle to download. + If nonzero, this number will be compared to the checksum of the downloaded asset bundle data. If the CRCs do not match, an error will be logged and the asset bundle will not be loaded. If set to zero, CRC checking will be skipped. + An integer version number, which will be compared to the cached version of the asset bundle to download. Increment this number to force Unity to redownload a cached asset bundle. + +Analogous to the version parameter for WWW.LoadFromCacheOrDownload. + A version hash. If this hash does not match the hash for the cached version of this asset bundle, the asset bundle will be redownloaded. + A structure used to download a given version of AssetBundle to a customized cache path. + + A UnityWebRequest configured to downloading a Unity Asset Bundle. + + + + + Creates a UnityWebRequest optimized for downloading a Unity Asset Bundle via HTTP GET. + + The URI of the asset bundle to download. + If nonzero, this number will be compared to the checksum of the downloaded asset bundle data. If the CRCs do not match, an error will be logged and the asset bundle will not be loaded. If set to zero, CRC checking will be skipped. + An integer version number, which will be compared to the cached version of the asset bundle to download. Increment this number to force Unity to redownload a cached asset bundle. + +Analogous to the version parameter for WWW.LoadFromCacheOrDownload. + A version hash. If this hash does not match the hash for the cached version of this asset bundle, the asset bundle will be redownloaded. + A structure used to download a given version of AssetBundle to a customized cache path. + + A UnityWebRequest configured to downloading a Unity Asset Bundle. + + + + + Asynchronous operation object returned from UnityWebRequest.SendWebRequest(). + +You can yield until it continues, register an event handler with AsyncOperation.completed, or manually check whether it's done (AsyncOperation.isDone) or progress (AsyncOperation.progress). + + + + + Returns the associated UnityWebRequest that created the operation. + + + + + Helpers for downloading multimedia files using UnityWebRequest. + + + + + Create a UnityWebRequest to download an audio clip via HTTP GET and create an AudioClip based on the retrieved data. + + The URI of the audio clip to download. + The type of audio encoding for the downloaded audio clip. See AudioType. + + A UnityWebRequest properly configured to download an audio clip and convert it to an AudioClip. + + + + + Create a UnityWebRequest intended to download a movie clip via HTTP GET and create an MovieTexture based on the retrieved data. + + The URI of the movie clip to download. + + A UnityWebRequest properly configured to download a movie clip and convert it to a MovieTexture. + + + + + Helpers for downloading image files into Textures using UnityWebRequest. + + + + + Create a UnityWebRequest intended to download an image via HTTP GET and create a Texture based on the retrieved data. + + The URI of the image to download. + If true, the texture's raw data will not be accessible to script. This can conserve memory. Default: false. + + A UnityWebRequest properly configured to download an image and convert it to a Texture. + + + + + Create a UnityWebRequest intended to download an image via HTTP GET and create a Texture based on the retrieved data. + + The URI of the image to download. + If true, the texture's raw data will not be accessible to script. This can conserve memory. Default: false. + + A UnityWebRequest properly configured to download an image and convert it to a Texture. + + + + + Helper object for UnityWebRequests. Manages the buffering and transmission of body data during HTTP requests. + + + + + Determines the default Content-Type header which will be transmitted with the outbound HTTP request. + + + + + The raw data which will be transmitted to the remote server as body data. (Read Only) + + + + + Returns the proportion of data uploaded to the remote server compared to the total amount of data to upload. (Read Only) + + + + + Signals that this UploadHandler is no longer being used, and should clean up any resources it is using. + + + + + A specialized UploadHandler that reads data from a given file and sends raw bytes to the server as the request body. + + + + + Create a new upload handler to send data from the given file to the server. + + A file containing data to send. + + + + A general-purpose UploadHandler subclass, using a native-code memory buffer. + + + + + General constructor. Contents of the input argument are copied into a native buffer. + + Raw data to transmit to the remote server. + + + + Networking Utility. + + + + + This property is deprecated and does not need to be set or referenced. + + + + + Utility function to get this client's access token for a particular network, if it has been set. + + + + + + Utility function to fetch the program's ID for UNET Cloud interfacing. + + + + + Utility function to get the client's SourceID for unique identification. + + + + + Utility function that accepts the access token for a network after it's received from the server. + + + + + + + Deprecated; Setting the AppID is no longer necessary. Please log in through the editor and set up the project there. + + + + + + Describes different levels of log information the network layer supports. + + + + + This data structure contains information on a message just received from the network. + + + + + The NetworkView who sent this message. + + + + + The player who sent this network message (owner). + + + + + The time stamp when the Message was sent in seconds. + + + + + Describes the status of the network interface peer type as returned by Network.peerType. + + + + + The NetworkPlayer is a data structure with which you can locate another player over the network. + + + + + Returns the external IP address of the network interface. + + + + + Returns the external port of the network interface. + + + + + The GUID for this player, used when connecting with NAT punchthrough. + + + + + The IP address of this player. + + + + + The port of this player. + + + + + Describes network reachability options. + + + + + Network is not reachable. + + + + + Network is reachable via carrier data network. + + + + + Network is reachable via WiFi or cable. + + + + + Different types of synchronization for the NetworkView component. + + + + + The network view is the binding material of multiplayer games. + + + + + The network group number of this network view. + + + + + Is the network view controlled by this object? + + + + + The component the network view is observing. + + + + + The NetworkPlayer who owns this network view. + + + + + The type of NetworkStateSynchronization set for this network view. + + + + + The ViewID of this network view. + + + + + Call a RPC function on all connected peers. + + + + + + + + Call a RPC function on a specific player. + + + + + + + + The NetworkViewID is a unique identifier for a network view instance in a multiplayer game. + + + + + True if instantiated by me. + + + + + The NetworkPlayer who owns the NetworkView. Could be the server. + + + + + Represents an invalid network view ID. + + + + + NPOT Texture2D|textures support. + + + + + Full NPOT support. + + + + + NPOT textures are not supported. Will be upscaled/padded at loading time. + + + + + Limited NPOT support: no mip-maps and clamp TextureWrapMode|wrap mode will be forced. + + + + + Base class for all objects Unity can reference. + + + + + Should the object be hidden, saved with the Scene or modifiable by the user? + + + + + The name of the object. + + + + + Removes a gameobject, component or asset. + + The object to destroy. + The optional amount of time to delay before destroying the object. + + + + Removes a gameobject, component or asset. + + The object to destroy. + The optional amount of time to delay before destroying the object. + + + + Destroys the object obj immediately. You are strongly recommended to use Destroy instead. + + Object to be destroyed. + Set to true to allow assets to be destroyed. + + + + Destroys the object obj immediately. You are strongly recommended to use Destroy instead. + + Object to be destroyed. + Set to true to allow assets to be destroyed. + + + + Do not destroy the target Object when loading a new Scene. + + An Object not destroyed on Scene change. + + + + Returns the first active loaded object of Type type. + + The type of object to find. + + This returns the Object that matches the specified type. It returns null if no Object matches the type. + + + + + Returns a list of all active loaded objects of Type type. + + The type of object to find. + + The array of objects found matching the type specified. + + + + + Returns a list of all active and inactive loaded objects of Type type. + + The type of object to find. + + The array of objects found matching the type specified. + + + + + Returns a list of all active and inactive loaded objects of Type type, including assets. + + The type of object or asset to find. + + The array of objects and assets found matching the type specified. + + + + + Returns the instance id of the object. + + + + + Does the object exist? + + + + + + Clones the object original and returns the clone. + + An existing object that you want to make a copy of. + Position for the new object. + Orientation of the new object. + Parent that will be assigned to the new object. + Pass true when assigning a parent Object to maintain the world position of the Object, instead of setting its position relative to the new parent. Pass false to set the Object's position relative to its new parent. + + The instantiated clone. + + + + + Clones the object original and returns the clone. + + An existing object that you want to make a copy of. + Position for the new object. + Orientation of the new object. + Parent that will be assigned to the new object. + Pass true when assigning a parent Object to maintain the world position of the Object, instead of setting its position relative to the new parent. Pass false to set the Object's position relative to its new parent. + + The instantiated clone. + + + + + Clones the object original and returns the clone. + + An existing object that you want to make a copy of. + Position for the new object. + Orientation of the new object. + Parent that will be assigned to the new object. + Pass true when assigning a parent Object to maintain the world position of the Object, instead of setting its position relative to the new parent. Pass false to set the Object's position relative to its new parent. + + The instantiated clone. + + + + + Clones the object original and returns the clone. + + An existing object that you want to make a copy of. + Position for the new object. + Orientation of the new object. + Parent that will be assigned to the new object. + Pass true when assigning a parent Object to maintain the world position of the Object, instead of setting its position relative to the new parent. Pass false to set the Object's position relative to its new parent. + + The instantiated clone. + + + + + Clones the object original and returns the clone. + + An existing object that you want to make a copy of. + Position for the new object. + Orientation of the new object. + Parent that will be assigned to the new object. + Pass true when assigning a parent Object to maintain the world position of the Object, instead of setting its position relative to the new parent. Pass false to set the Object's position relative to its new parent. + + The instantiated clone. + + + + + You can also use Generics to instantiate objects. See the page for more details. + + Object of type T that you want to make a clone of. + + + + + + Object of type T. + + + + + You can also use Generics to instantiate objects. See the page for more details. + + Object of type T that you want to make a clone of. + + + + + + Object of type T. + + + + + You can also use Generics to instantiate objects. See the page for more details. + + Object of type T that you want to make a clone of. + + + + + + Object of type T. + + + + + You can also use Generics to instantiate objects. See the page for more details. + + Object of type T that you want to make a clone of. + + + + + + Object of type T. + + + + + You can also use Generics to instantiate objects. See the page for more details. + + Object of type T that you want to make a clone of. + + + + + + Object of type T. + + + + + Compares two object references to see if they refer to the same object. + + The first Object. + The Object to compare against the first. + + + + Compares if two objects refer to a different object. + + + + + + + Returns the name of the GameObject. + + + The name returned by ToString. + + + + + OcclusionArea is an area in which occlusion culling is performed. + + + + + Center of the occlusion area relative to the transform. + + + + + Size that the occlusion area will have. + + + + + The portal for dynamically changing occlusion at runtime. + + + + + Gets / sets the portal's open state. + + + + + Enumeration for SystemInfo.operatingSystemFamily. + + + + + Linux operating system family. + + + + + macOS operating system family. + + + + + Returned for operating systems that do not fall into any other category. + + + + + Windows operating system family. + + + + + Information about a particle collision. + + + + + The Collider for the GameObject struck by the particles. + + + + + The Collider or Collider2D for the GameObject struck by the particles. + + + + + Intersection point of the collision in world coordinates. + + + + + Geometry normal at the intersection point of the collision. + + + + + Incident velocity at the intersection point of the collision. + + + + + Method extension for Physics in Particle System. + + + + + Get the particle collision events for a GameObject. Returns the number of events written to the array. + + The GameObject for which to retrieve collision events. + Array to write collision events to. + + + + + Safe array size for use with ParticleSystem.GetCollisionEvents. + + + + + + Safe array size for use with ParticleSystem.GetTriggerParticles. + + Particle system. + Type of trigger to return size for. + + Number of particles with this trigger event type. + + + + + Get the particles that met the condition in the particle trigger module. Returns the number of particles written to the array. + + Particle system. + Type of trigger to return particles for. + The array of particles matching the trigger event type. + + Number of particles with this trigger event type. + + + + + Write modified particles back to the Particle System, during a call to OnParticleTrigger. + + Particle system. + Type of trigger to set particles for. + Particle array. + Offset into the array, if you only want to write back a subset of the returned particles. + Number of particles to write, if you only want to write back a subset of the returned particles. + + + + Write modified particles back to the Particle System, during a call to OnParticleTrigger. + + Particle system. + Type of trigger to set particles for. + Particle array. + Offset into the array, if you only want to write back a subset of the returned particles. + Number of particles to write, if you only want to write back a subset of the returned particles. + + + + Script interface for Particle Systems. + + + + + Does this system support Automatic Culling? + + + + + Script interface for the Particle System collision module. + + + + + Script interface for the Particle System color by lifetime module. + + + + + Script interface for the Particle System color over lifetime module. + + + + + Script interface for the Particle System Custom Data module. + + + + + The duration of the Particle System in seconds (Read Only). + + + + + Script interface for the Particle System emission module. + + + + + The rate of particle emission. + + + + + When set to false, the Particle System will not emit particles. + + + + + Script interface for the Particle System external forces module. + + + + + Script interface for the Particle System force over lifetime module. + + + + + Scale being applied to the gravity defined by Physics.gravity. + + + + + Script interface for the Particle System velocity inheritance module. + + + + + Determines whether the Particle System is emitting particles. A Particle System may stop emitting when its emission module has finished, it has been paused or if the system has been stopped using ParticleSystem.Stop|Stop with the ParticleSystemStopBehavior.StopEmitting|StopEmitting flag. Resume emitting by calling ParticleSystem.Play|Play. + + + + + Determines whether the Particle System is paused. + + + + + Determines whether the Particle System is playing. + + + + + Determines whether the Particle System is stopped. + + + + + Script interface for the Particle System Lights module. + + + + + Script interface for the Particle System Limit Velocity over Lifetime module. + + + + + Determines whether the Particle System is looping. + + + + + Access the main Particle System settings. + + + + + The maximum number of particles to emit. + + + + + Script interface for the Particle System Noise module. + + + + + The current number of particles (Read Only). + + + + + The playback speed of the Particle System. 1 is normal playback speed. + + + + + If set to true, the Particle System will automatically start playing on startup. + + + + + Does this system support Procedural Simulation? + + + + + Override the random seed used for the Particle System emission. + + + + + Script interface for the Particle System Rotation by Speed module. + + + + + Script interface for the Particle System Rotation over Lifetime module. + + + + + The scaling mode applied to particle sizes and positions. + + + + + Script interface for the Particle System Shape module. + + + + + This selects the space in which to simulate particles. It can be either world or local space. + + + + + Script interface for the Particle System Size by Speed module. + + + + + Script interface for the Particle System Size over Lifetime module. + + + + + The initial color of particles when emitted. + + + + + Start delay in seconds. + + + + + The total lifetime in seconds that particles will have when emitted. When using curves, this value acts as a scale on the curve. This value is set in the particle when it is created by the Particle System. + + + + + The initial rotation of particles when emitted. When using curves, this value acts as a scale on the curve. + + + + + The initial 3D rotation of particles when emitted. When using curves, this value acts as a scale on the curves. + + + + + The initial size of particles when emitted. When using curves, this value acts as a scale on the curve. + + + + + The initial speed of particles when emitted. When using curves, this value acts as a scale on the curve. + + + + + Script interface for the Particle System Sub Emitters module. + + + + + Script interface for the Particle System Texture Sheet Animation module. + + + + + Playback position in seconds. + + + + + Script interface for the Particle System Trails module. + + + + + Script interface for the Particle System Trigger module. + + + + + Controls whether the Particle System uses an automatically-generated random number to seed the random number generator. + + + + + Script interface for the Particle System Velocity over Lifetime module. + + + + + Script interface for a Burst. + + + + + Number of particles to be emitted. + + + + + How many times to play the burst. (0 means infinitely). + + + + + Maximum number of particles to be emitted. + + + + + Minimum number of particles to be emitted. + + + + + The chance that the burst will trigger. + + + + + How often to repeat the burst, in seconds. + + + + + The time that each burst occurs. + + + + + Construct a new Burst with a time and count. + + Time to emit the burst. + Minimum number of particles to emit. + Maximum number of particles to emit. + Number of particles to emit. + Number of times to play the burst. (0 means indefinitely). + How often to repeat the burst, in seconds. + + + + Construct a new Burst with a time and count. + + Time to emit the burst. + Minimum number of particles to emit. + Maximum number of particles to emit. + Number of particles to emit. + Number of times to play the burst. (0 means indefinitely). + How often to repeat the burst, in seconds. + + + + Construct a new Burst with a time and count. + + Time to emit the burst. + Minimum number of particles to emit. + Maximum number of particles to emit. + Number of particles to emit. + Number of times to play the burst. (0 means indefinitely). + How often to repeat the burst, in seconds. + + + + Construct a new Burst with a time and count. + + Time to emit the burst. + Minimum number of particles to emit. + Maximum number of particles to emit. + Number of particles to emit. + Number of times to play the burst. (0 means indefinitely). + How often to repeat the burst, in seconds. + + + + Construct a new Burst with a time and count. + + Time to emit the burst. + Minimum number of particles to emit. + Maximum number of particles to emit. + Number of particles to emit. + Number of times to play the burst. (0 means indefinitely). + How often to repeat the burst, in seconds. + + + + Remove all particles in the Particle System. + + Clear all child Particle Systems as well. + + + + Script interface for the Collision module. + + + + + How much force is applied to each particle after a collision. + + + + + Change the bounce multiplier. + + + + + How much force is applied to a Collider when hit by particles from this Particle System. + + + + + Control which layers this Particle System collides with. + + + + + How much speed is lost from each particle after a collision. + + + + + Change the dampen multiplier. + + + + + Enable/disable the Collision module. + + + + + Allow particles to collide with dynamic colliders when using world collision mode. + + + + + Allow particles to collide when inside colliders. + + + + + How much a particle's lifetime is reduced after a collision. + + + + + Change the lifetime loss multiplier. + + + + + The maximum number of collision shapes that will be considered for particle collisions. Excess shapes will be ignored. Terrains take priority. + + + + + Kill particles whose speed goes above this threshold, after a collision. + + + + + The maximum number of planes it is possible to set as colliders. + + + + + Kill particles whose speed falls below this threshold, after a collision. + + + + + Choose between 2D and 3D world collisions. + + + + + If true, the collision angle is considered when applying forces from particles to Colliders. + + + + + If true, particle sizes are considered when applying forces to Colliders. + + + + + If true, particle speeds are considered when applying forces to Colliders. + + + + + Specifies the accuracy of particle collisions against colliders in the Scene. + + + + + A multiplier applied to the size of each particle before collisions are processed. + + + + + Send collision callback messages. + + + + + The type of particle collision to perform. + + + + + Size of voxels in the collision cache. + + + + + Get a collision plane associated with this Particle System. + + Specifies which plane to access. + + The plane. + + + + + Set a collision plane to be used with this Particle System. + + Specifies which plane to set. + The plane to set. + + + + Script interface for the Color By Speed module. + + + + + The gradient controlling the particle colors. + + + + + Enable/disable the Color By Speed module. + + + + + Apply the color gradient between these minimum and maximum speeds. + + + + + Script interface for the Color Over Lifetime module. + + + + + The gradient controlling the particle colors. + + + + + Enable/disable the Color Over Lifetime module. + + + + + Script interface for the Custom Data module. + + + + + Enable/disable the Custom Data module. + + + + + Get a ParticleSystem.MinMaxGradient, that is being used to generate custom HDR color data. + + The name of the custom data stream to retrieve the gradient from. + + The color gradient being used to generate custom color data. + + + + + Find out the type of custom data that is being generated for the chosen data stream. + + The name of the custom data stream to query. + + The type of data being generated for the requested stream. + + + + + Get a ParticleSystem.MinMaxCurve, that is being used to generate custom data. + + The name of the custom data stream to retrieve the curve from. + The component index to retrieve the curve for (0-3, mapping to the xyzw components of a Vector4 or float4). + + The curve being used to generate custom data. + + + + + Query how many ParticleSystem.MinMaxCurve elements are being used to generate this stream of custom data. + + The name of the custom data stream to retrieve the curve from. + + The number of curves. + + + + + Set a ParticleSystem.MinMaxGradient, in order to generate custom HDR color data. + + The name of the custom data stream to apply the gradient to. + The gradient to be used for generating custom color data. + + + + Choose the type of custom data to generate for the chosen data stream. + + The name of the custom data stream to enable data generation on. + The type of data to generate. + + + + Set a ParticleSystem.MinMaxCurve, in order to generate custom data. + + The name of the custom data stream to apply the curve to. + The component index to apply the curve to (0-3, mapping to the xyzw components of a Vector4 or float4). + The curve to be used for generating custom data. + + + + Specify how many curves are used to generate custom data for this stream. + + The name of the custom data stream to apply the curve to. + The number of curves to generate data for. + + + + + Script interface for the Emission module. + + + + + The current number of bursts. + + + + + Enable/disable the Emission module. + + + + + The rate at which new particles are spawned. + + + + + Change the rate multiplier. + + + + + The rate at which new particles are spawned, over distance. + + + + + Change the rate over distance multiplier. + + + + + The rate at which new particles are spawned, over time. + + + + + Change the rate over time multiplier. + + + + + The emission type. + + + + + Get a single burst from the array of bursts. + + The index of the burst to retrieve. + + The burst data at the given index. + + + + + Get the burst array. + + Array of bursts to be filled in. + + The number of bursts in the array. + + + + + Set a single burst in the array of bursts. + + The index of the burst to retrieve. + The new burst data to apply to the Particle System. + + + + Set the burst array. + + Array of bursts. + Optional array size, if burst count is less than array size. + + + + Set the burst array. + + Array of bursts. + Optional array size, if burst count is less than array size. + + + + Emit count particles immediately. + + Number of particles to emit. + + + + Emit a number of particles from script. + + Overidden particle properties. + Number of particles to emit. + + + + + + + + + + + + + + + + + + + + Script interface for Particle System emission parameters. + + + + + Override the angular velocity of emitted particles. + + + + + Override the 3D angular velocity of emitted particles. + + + + + When overriding the position of particles, setting this flag to true allows you to retain the influence of the shape module. + + + + + Override the axis of rotation of emitted particles. + + + + + Override the position of emitted particles. + + + + + Override the random seed of emitted particles. + + + + + Override the rotation of emitted particles. + + + + + Override the 3D rotation of emitted particles. + + + + + Override the initial color of emitted particles. + + + + + Override the lifetime of emitted particles. + + + + + Override the initial size of emitted particles. + + + + + Override the initial 3D size of emitted particles. + + + + + Override the velocity of emitted particles. + + + + + Reverts angularVelocity and angularVelocity3D back to the values specified in the inspector. + + + + + Revert the axis of rotation back to the value specified in the inspector. + + + + + Revert the position back to the value specified in the inspector. + + + + + Revert the random seed back to the value specified in the inspector. + + + + + Reverts rotation and rotation3D back to the values specified in the inspector. + + + + + Revert the initial color back to the value specified in the inspector. + + + + + Revert the lifetime back to the value specified in the inspector. + + + + + Revert the initial size back to the value specified in the inspector. + + + + + Revert the velocity back to the value specified in the inspector. + + + + + Script interface for the External Forces module. + + + + + Enable/disable the External Forces module. + + + + + The number of Force Fields explicitly provided to the influencers list. + + + + + Apply all Force Fields belonging to a matching layer to this Particle System. + + + + + Multiplies the magnitude of applied external forces. + + + + + Adds a ParticleSystemForceField to the influencers list. + + The Force Field to add to the influencers list. + + + + Returns the ParticleSystemForceField at the given index in the influencers list. + + The index to return the chosen Force Field from. + + The ForceField from the list. + + + + + Determines whether any particles are inside the influence of a Force Field. + + The Force Field to test. + + Whether the Force Field affects the Particle System. + + + + + Removes the Force Field from the influencers list at the given index. + + The index to remove the chosen Force Field from. + The Force Field to remove from the list. + + + + Removes the Force Field from the influencers list at the given index. + + The index to remove the chosen Force Field from. + The Force Field to remove from the list. + + + + Assigns the Force Field at the given index in the influencers list. + + Index to assign the Force Field. + Force Field that will be assigned. + + + + Script interface for the Force Over Lifetime module. + + + + + Enable/disable the Force Over Lifetime module. + + + + + When randomly selecting values between two curves or constants, this flag will cause a new random force to be chosen on each frame. + + + + + Are the forces being applied in local or world space? + + + + + The curve defining particle forces in the X axis. + + + + + Change the X axis mulutiplier. + + + + + The curve defining particle forces in the Y axis. + + + + + Change the Y axis multiplier. + + + + + The curve defining particle forces in the Z axis. + + + + + Change the Z axis multiplier. + + + + + Get a stream of custom per-particle data. + + The array of per-particle data. + Which stream to retrieve the data from. + + The amount of valid per-particle data. + + + + + Gets the particles of this Particle System. + + Output particle buffer, containing the current particle state. + The number of elements that are read from the Particle System. + The offset into the active particle list, from which to copy the particles. + + The number of particles written to the input particle array (the number of particles currently alive). + + + + + Gets the particles of this Particle System. + + Output particle buffer, containing the current particle state. + The number of elements that are read from the Particle System. + The offset into the active particle list, from which to copy the particles. + + The number of particles written to the input particle array (the number of particles currently alive). + + + + + Gets the particles of this Particle System. + + Output particle buffer, containing the current particle state. + The number of elements that are read from the Particle System. + The offset into the active particle list, from which to copy the particles. + + The number of particles written to the input particle array (the number of particles currently alive). + + + + + The Inherit Velocity Module controls how the velocity of the emitter is transferred to the particles as they are emitted. + + + + + Curve to define how much emitter velocity is applied during the lifetime of a particle. + + + + + Change the curve multiplier. + + + + + Enable/disable the InheritVelocity module. + + + + + How to apply emitter velocity to particles. + + + + + Does the Particle System contain any live particles, or will it produce more? + + Check all child Particle Systems as well. + + True if the Particle System contains live particles or is still creating new particles. False if the Particle System has stopped emitting particles and all particles are dead. + + + + + Does the Particle System contain any live particles, or will it produce more? + + Check all child Particle Systems as well. + + True if the Particle System contains live particles or is still creating new particles. False if the Particle System has stopped emitting particles and all particles are dead. + + + + + Access the ParticleSystem Lights Module. + + + + + Toggle whether the particle alpha gets multiplied by the light intensity, when computing the final light intensity. + + + + + Enable/disable the Lights module. + + + + + Define a curve to apply custom intensity scaling to particle lights. + + + + + Intensity multiplier. + + + + + Select what Light Prefab you want to base your particle lights on. + + + + + Set a limit on how many lights this Module can create. + + + + + Define a curve to apply custom range scaling to particle lights. + + + + + Range multiplier. + + + + + Choose what proportion of particles will receive a dynamic light. + + + + + Toggle where the particle size will be multiplied by the light range, to determine the final light range. + + + + + Toggle whether the particle lights will have their color multiplied by the particle color. + + + + + Randomly assign lights to new particles based on ParticleSystem.LightsModule.ratio. + + + + + Script interface for the Limit Velocity Over Lifetime module. + + + + + Controls how much the velocity that exceeds the velocity limit should be dampened. + + + + + Controls the amount of drag applied to the particle velocities. + + + + + Change the drag multiplier. + + + + + Enable/disable the Limit Force Over Lifetime module. + + + + + Maximum velocity curve, when not using one curve per axis. + + + + + Change the limit multiplier. + + + + + Maximum velocity curve for the X axis. + + + + + Change the limit multiplier on the X axis. + + + + + Maximum velocity curve for the Y axis. + + + + + Change the limit multiplier on the Y axis. + + + + + Maximum velocity curve for the Z axis. + + + + + Change the limit multiplier on the Z axis. + + + + + Adjust the amount of drag applied to particles, based on their sizes. + + + + + Adjust the amount of drag applied to particles, based on their speeds. + + + + + Set the velocity limit on each axis separately. + + + + + Specifies if the velocity limits are in local space (rotated with the transform) or world space. + + + + + Script interface for the main module. + + + + + Configure whether the Particle System will still be simulated each frame, when it is offscreen. + + + + + Simulate particles relative to a custom transform component. + + + + + The duration of the Particle System in seconds. + + + + + Control how the Particle System calculates its velocity, when moving in the world. + + + + + Makes some particles spin in the opposite direction. + + + + + Scale applied to the gravity, defined by Physics.gravity. + + + + + Change the gravity multiplier. + + + + + Is the Particle System looping? + + + + + The maximum number of particles to emit. + + + + + If set to true, the Particle System will automatically start playing on startup. + + + + + When looping is enabled, this controls whether this Particle System will look like it has already simulated for one loop when first becoming visible. + + + + + Cause some particles to spin in the opposite direction. + + + + + When ParticleSystem.MainModule.ringBufferMode is set to loop, this value defines the proportion of the particle life that is looped. + + + + + Configure the Particle System to not kill its particles when their lifetimes are exceeded. + + + + + Control how the Particle System's Transform Component is applied to the Particle System. + + + + + This selects the space in which to simulate particles. It can be either world or local space. + + + + + Override the default playback speed of the Particle System. + + + + + The initial color of particles when emitted. + + + + + Start delay in seconds. + + + + + Start delay multiplier in seconds. + + + + + The total lifetime in seconds that each new particle will have. + + + + + Start lifetime multiplier. + + + + + The initial rotation of particles when emitted. + + + + + A flag to enable 3D particle rotation. + + + + + The initial rotation multiplier of particles when emitted. + + + + + The initial rotation of particles around the X axis when emitted. + + + + + The initial rotation multiplier of particles around the X axis when emitted. + + + + + The initial rotation of particles around the Y axis when emitted. + + + + + The initial rotation multiplier of particles around the Y axis when emitted. + + + + + The initial rotation of particles around the Z axis when emitted. + + + + + The initial rotation multiplier of particles around the Z axis when emitted. + + + + + The initial size of particles when emitted. + + + + + A flag to enable specifying particle size individually for each axis. + + + + + A multiplier of the initial size of particles when emitted. + + + + + The initial size of particles along the X axis when emitted. + + + + + The initial size multiplier of particles along the X axis when emitted. + + + + + The initial size of particles along the Y axis when emitted. + + + + + The initial size multiplier of particles along the Y axis when emitted. + + + + + The initial size of particles along the Z axis when emitted. + + + + + The initial size multiplier of particles along the Z axis when emitted. + + + + + The initial speed of particles when emitted. + + + + + A multiplier of the initial speed of particles when emitted. + + + + + Select whether to Disable or Destroy the GameObject, or to call the OnParticleSystemStopped script Callback, when the Particle System is stopped and all particles have died. + + + + + When true, use the unscaled delta time to simulate the Particle System. Otherwise, use the scaled delta time. + + + + + Script interface for a Min-Max Curve. + + + + + Set the constant value. + + + + + Set a constant for the upper bound. + + + + + Set a constant for the lower bound. + + + + + Set the curve. + + + + + Set a curve for the upper bound. + + + + + Set a curve for the lower bound. + + + + + Set a multiplier to be applied to the curves. + + + + + Set the mode that the min-max curve will use to evaluate values. + + + + + A single constant value for the entire curve. + + Constant value. + + + + Use one curve when evaluating numbers along this Min-Max curve. + + A multiplier to be applied to the curve. + A single curve for evaluating against. + + + + + Randomly select values based on the interval between the minimum and maximum curves. + + A multiplier to be applied to the curves. + The curve describing the minimum values to be evaluated. + The curve describing the maximum values to be evaluated. + + + + + Randomly select values based on the interval between the minimum and maximum constants. + + The constant describing the minimum values to be evaluated. + The constant describing the maximum values to be evaluated. + + + + Manually query the curve to calculate values based on what mode it is in. + + Normalized time (in the range 0 - 1, where 1 represents 100%) at which to evaluate the curve. This is valid when ParticleSystem.MinMaxCurve.mode is set to ParticleSystemCurveMode.Curve or ParticleSystemCurveMode.TwoCurves. + Blend between the 2 curves/constants (Valid when ParticleSystem.MinMaxCurve.mode is set to ParticleSystemCurveMode.TwoConstants or ParticleSystemCurveMode.TwoCurves). + + Calculated curve/constant value. + + + + + Manually query the curve to calculate values based on what mode it is in. + + Normalized time (in the range 0 - 1, where 1 represents 100%) at which to evaluate the curve. This is valid when ParticleSystem.MinMaxCurve.mode is set to ParticleSystemCurveMode.Curve or ParticleSystemCurveMode.TwoCurves. + Blend between the 2 curves/constants (Valid when ParticleSystem.MinMaxCurve.mode is set to ParticleSystemCurveMode.TwoConstants or ParticleSystemCurveMode.TwoCurves). + + Calculated curve/constant value. + + + + + MinMaxGradient contains two Gradients, and returns a Color based on ParticleSystem.MinMaxGradient.mode. Depending on the mode, the Color returned may be randomized. +Gradients are edited via the ParticleSystem Inspector once a ParticleSystemGradientMode requiring them has been selected. Some modes do not require gradients, only colors. + + + + + Set a constant color. + + + + + Set a constant color for the upper bound. + + + + + Set a constant color for the lower bound. + + + + + Set the gradient. + + + + + Set a gradient for the upper bound. + + + + + Set a gradient for the lower bound. + + + + + Set the mode that the min-max gradient will use to evaluate colors. + + + + + A single constant color for the entire gradient. + + Constant color. + + + + Use one gradient when evaluating numbers along this Min-Max gradient. + + A single gradient for evaluating against. + + + + Randomly select colors based on the interval between the minimum and maximum constants. + + The constant color describing the minimum colors to be evaluated. + The constant color describing the maximum colors to be evaluated. + + + + Randomly select colors based on the interval between the minimum and maximum gradients. + + The gradient describing the minimum colors to be evaluated. + The gradient describing the maximum colors to be evaluated. + + + + Manually query the gradient to calculate colors based on what mode it is in. + + Normalized time (in the range 0 - 1, where 1 represents 100%) at which to evaluate the gradient. This is valid when ParticleSystem.MinMaxGradient.mode is set to ParticleSystemGradientMode.Gradient or ParticleSystemGradientMode.TwoGradients. + Blend between the 2 gradients/colors (Valid when ParticleSystem.MinMaxGradient.mode is set to ParticleSystemGradientMode.TwoColors or ParticleSystemGradientMode.TwoGradients). + + Calculated gradient/color value. + + + + + Manually query the gradient to calculate colors based on what mode it is in. + + Normalized time (in the range 0 - 1, where 1 represents 100%) at which to evaluate the gradient. This is valid when ParticleSystem.MinMaxGradient.mode is set to ParticleSystemGradientMode.Gradient or ParticleSystemGradientMode.TwoGradients. + Blend between the 2 gradients/colors (Valid when ParticleSystem.MinMaxGradient.mode is set to ParticleSystemGradientMode.TwoColors or ParticleSystemGradientMode.TwoGradients). + + Calculated gradient/color value. + + + + + Script interface for the Noise Module. + +The Noise Module allows you to apply turbulence to the movement of your particles. Use the low quality settings to create computationally efficient Noise, or simulate smoother, richer Noise with the higher quality settings. You can also choose to define the behavior of the Noise individually for each axis. + + + + + Higher frequency noise will reduce the strength by a proportional amount, if enabled. + + + + + Enable/disable the Noise module. + + + + + Low values create soft, smooth noise, and high values create rapidly changing noise. + + + + + Layers of noise that combine to produce final noise. + + + + + When combining each octave, scale the intensity by this amount. + + + + + When combining each octave, zoom in by this amount. + + + + + How much the noise affects the particle positions. + + + + + Generate 1D, 2D or 3D noise. + + + + + Define how the noise values are remapped. + + + + + Enable remapping of the final noise values, allowing for noise values to be translated into different values. + + + + + Remap multiplier. + + + + + Define how the noise values are remapped on the X axis, when using the ParticleSystem.NoiseModule.separateAxes option. + + + + + X axis remap multiplier. + + + + + Define how the noise values are remapped on the Y axis, when using the ParticleSystem.NoiseModule.separateAxes option. + + + + + Y axis remap multiplier. + + + + + Define how the noise values are remapped on the Z axis, when using the ParticleSystem.NoiseModule.separateAxes option. + + + + + Z axis remap multiplier. + + + + + How much the noise affects the particle rotation, in degrees per second. + + + + + Scroll the noise map over the Particle System. + + + + + Scroll speed multiplier. + + + + + Control the noise separately for each axis. + + + + + How much the noise affects the particle sizes, applied as a multiplier on the size of each particle. + + + + + How strong the overall noise effect is. + + + + + Strength multiplier. + + + + + Define the strength of the effect on the X axis, when using the ParticleSystem.NoiseModule.separateAxes option. + + + + + X axis strength multiplier. + + + + + Define the strength of the effect on the Y axis, when using the ParticleSystem.NoiseModule.separateAxes option. + + + + + Y axis strength multiplier. + + + + + Define the strength of the effect on the Z axis, when using the ParticleSystem.NoiseModule.separateAxes option. + + + + + Z axis strength multiplier. + + + + + Script interface for a Particle. + + + + + The angular velocity of the particle. + + + + + The 3D angular velocity of the particle. + + + + + The animated velocity of the particle. + + + + + Mesh particles will rotate around this axis. + + + + + The lifetime of the particle. + + + + + The position of the particle. + + + + + The random seed of the particle. + + + + + The random value of the particle. + + + + + The remaining lifetime of the particle. + + + + + The rotation of the particle. + + + + + The 3D rotation of the particle. + + + + + The initial color of the particle. The current color of the particle is calculated procedurally based on this value and the active color modules. + + + + + The starting lifetime of the particle. + + + + + The initial size of the particle. The current size of the particle is calculated procedurally based on this value and the active size modules. + + + + + The initial 3D size of the particle. The current size of the particle is calculated procedurally based on this value and the active size modules. + + + + + The total velocity of the particle. + + + + + The velocity of the particle. + + + + + Calculate the current color of the particle by applying the relevant curves to its startColor property. + + The Particle System from which this particle was emitted. + + Current color. + + + + + Calculate the current size of the particle by applying the relevant curves to its startSize property. + + The Particle System from which this particle was emitted. + + Current size. + + + + + Calculate the current 3D size of the particle by applying the relevant curves to its startSize3D property. + + The Particle System from which this particle was emitted. + + Current size. + + + + + Pauses the system so no new particles are emitted and the existing particles are not updated. + + Pause all child Particle Systems as well. + + + + Pauses the system so no new particles are emitted and the existing particles are not updated. + + Pause all child Particle Systems as well. + + + + Starts the Particle System. + + Play all child Particle Systems as well. + + + + Starts the Particle System. + + Play all child Particle Systems as well. + + + + Reset the cache of reserved graphics memory used for efficient rendering of Particle Systems. + + + + + Script interface for the Rotation By Speed module. + + + + + Enable/disable the Rotation By Speed module. + + + + + Apply the rotation curve between these minimum and maximum speeds. + + + + + Set the rotation by speed on each axis separately. + + + + + Rotation by speed curve for the X axis. + + + + + Speed multiplier along the X axis. + + + + + Rotation by speed curve for the Y axis. + + + + + Speed multiplier along the Y axis. + + + + + Rotation by speed curve for the Z axis. + + + + + Speed multiplier along the Z axis. + + + + + Script interface for the Rotation Over Lifetime module. + + + + + Enable/disable the Rotation Over Lifetime module. + + + + + Set the rotation over lifetime on each axis separately. + + + + + Rotation over lifetime curve for the X axis. + + + + + Rotation multiplier around the X axis. + + + + + Rotation over lifetime curve for the Y axis. + + + + + Rotation multiplier around the Y axis. + + + + + Rotation over lifetime curve for the Z axis. + + + + + Rotation multiplier around the Z axis. + + + + + Set a stream of custom per-particle data. + + The array of per-particle data. + Which stream to assign the data to. + + + + Sets the particles of this Particle System. + + Input particle buffer, containing the desired particle state. + The number of elements in the particles array that is written to the Particle System. + The offset into the destination particle list, to assign these particles. + + + + Sets the particles of this Particle System. + + Input particle buffer, containing the desired particle state. + The number of elements in the particles array that is written to the Particle System. + The offset into the destination particle list, to assign these particles. + + + + Sets the particles of this Particle System. + + Input particle buffer, containing the desired particle state. + The number of elements in the particles array that is written to the Particle System. + The offset into the destination particle list, to assign these particles. + + + + Script interface for the Shape module. + + + + + Align particles based on their initial direction of travel. + + + + + Angle of the cone to emit particles from. + + + + + Angle of the circle arc to emit particles from. + + + + + The mode used for generating particles around the arc. + + + + + In animated modes, this determines how quickly the particle emission position moves around the arc. + + + + + A multiplier of the arc speed of the particle emission shape. + + + + + Control the gap between particle emission points around the arc. + + + + + Scale of the box to emit particles from. + + + + + Thickness of the box to emit particles from. + + + + + The radius of the Donut shape to emit particles from. + + + + + Enable/disable the Shape module. + + + + + Length of the cone to emit particles from. + + + + + Mesh to emit particles from. + + + + + Emit particles from a single material of a mesh. + + + + + MeshRenderer to emit particles from. + + + + + Apply a scaling factor to the mesh that particles are emitted from. + + + + + Where on the mesh to emit particles from. + + + + + The mode used for generating particles on a mesh. + + + + + In animated modes, this determines how quickly the particle emission position moves across the mesh. + + + + + A multiplier of the mesh spawn speed. + + + + + Control the gap between particle emission points across the mesh. + + + + + Move particles away from the surface of the source mesh. + + + + + Apply an offset to the position from which particles are emitted. + + + + + Radius of the shape to emit particles from. + + + + + The mode used for generating particles along the radius. + + + + + In animated modes, this determines how quickly the particle emission position moves along the radius. + + + + + A multiplier of the radius speed of the particle emission shape. + + + + + Control the gap between particle emission points along the radius. + + + + + Radius thickness of the shape's edge from which to emit particles. + + + + + Randomizes the starting direction of particles. + + + + + Randomizes the starting direction of particles. + + + + + Randomizes the starting position of particles. + + + + + Apply a rotation to the shape from which particles are emitted. + + + + + Apply scale to the shape from which particles are emitted. + + + + + Type of shape to emit particles from. + + + + + SkinnedMeshRenderer to emit particles from. + + + + + Makes particles move in a spherical direction from their starting point. + + + + + Sprite to emit particles from. + + + + + SpriteRenderer to emit particles from. + + + + + Selects a texture to be used for tinting particle start colors. + + + + + When enabled, the alpha channel of the texture is applied to the particle alpha when spawned. + + + + + When enabled, 4 neighboring samples are taken from the texture, and combined to give the final particle value. + + + + + Selects which channel of the texture is used for discarding particles. + + + + + Discards particles when they are spawned on an area of the texture with a value lower than this threshold. + + + + + When enabled, the RGB channels of the texture are applied to the particle color when spawned. + + + + + When using a Mesh as a source shape type, this option controls which UV channel on the Mesh is used for reading the source texture. + + + + + Modulate the particle colors with the vertex colors, or the material color if no vertex colors exist. + + + + + Emit particles from a single material, or the whole mesh. + + + + + Fast-forwards the Particle System by simulating particles over the given period of time, then pauses it. + + Time period in seconds to advance the ParticleSystem simulation by. If restart is true, the ParticleSystem will be reset to 0 time, and then advanced by this value. If restart is false, the ParticleSystem simulation will be advanced in time from its current state by this value. + Fast-forward all child Particle Systems as well. + Restart and start from the beginning. + Only update the system at fixed intervals, based on the value in "Fixed Time" in the Time options. + + + + Fast-forwards the Particle System by simulating particles over the given period of time, then pauses it. + + Time period in seconds to advance the ParticleSystem simulation by. If restart is true, the ParticleSystem will be reset to 0 time, and then advanced by this value. If restart is false, the ParticleSystem simulation will be advanced in time from its current state by this value. + Fast-forward all child Particle Systems as well. + Restart and start from the beginning. + Only update the system at fixed intervals, based on the value in "Fixed Time" in the Time options. + + + + Fast-forwards the Particle System by simulating particles over the given period of time, then pauses it. + + Time period in seconds to advance the ParticleSystem simulation by. If restart is true, the ParticleSystem will be reset to 0 time, and then advanced by this value. If restart is false, the ParticleSystem simulation will be advanced in time from its current state by this value. + Fast-forward all child Particle Systems as well. + Restart and start from the beginning. + Only update the system at fixed intervals, based on the value in "Fixed Time" in the Time options. + + + + Fast-forwards the Particle System by simulating particles over the given period of time, then pauses it. + + Time period in seconds to advance the ParticleSystem simulation by. If restart is true, the ParticleSystem will be reset to 0 time, and then advanced by this value. If restart is false, the ParticleSystem simulation will be advanced in time from its current state by this value. + Fast-forward all child Particle Systems as well. + Restart and start from the beginning. + Only update the system at fixed intervals, based on the value in "Fixed Time" in the Time options. + + + + Script interface for the Size By Speed module. + + + + + Enable/disable the Size By Speed module. + + + + + Apply the size curve between these minimum and maximum speeds. + + + + + Set the size by speed on each axis separately. + + + + + Curve to control particle size based on speed. + + + + + Size multiplier. + + + + + Size by speed curve for the X axis. + + + + + X axis size multiplier. + + + + + Size by speed curve for the Y axis. + + + + + Y axis size multiplier. + + + + + Size by speed curve for the Z axis. + + + + + Z axis size multiplier. + + + + + Script interface for the Size Over Lifetime module. + + + + + Enable/disable the Size Over Lifetime module. + + + + + Set the size over lifetime on each axis separately. + + + + + Curve to control particle size based on lifetime. + + + + + Size multiplier. + + + + + Size over lifetime curve for the X axis. + + + + + X axis size multiplier. + + + + + Size over lifetime curve for the Y axis. + + + + + Y axis size multiplier. + + + + + Size over lifetime curve for the Z axis. + + + + + Z axis size multiplier. + + + + + Stops playing the Particle System using the supplied stop behaviour. + + Stop all child Particle Systems as well. + Stop emitting or stop emitting and clear the system. + + + + Stops playing the Particle System using the supplied stop behaviour. + + Stop all child Particle Systems as well. + Stop emitting or stop emitting and clear the system. + + + + Stops playing the Particle System using the supplied stop behaviour. + + Stop all child Particle Systems as well. + Stop emitting or stop emitting and clear the system. + + + + Script interface for the Sub Emitters module. + + + + + Sub Particle System which spawns at the locations of the birth of the particles from the parent system. + + + + + Sub Particle System which spawns at the locations of the birth of the particles from the parent system. + + + + + Sub Particle System which spawns at the locations of the collision of the particles from the parent system. + + + + + Sub Particle System which spawns at the locations of the collision of the particles from the parent system. + + + + + Sub Particle System which spawns at the locations of the death of the particles from the parent system. + + + + + Sub Particle System to spawn on death of the parent system's particles. + + + + + Enable/disable the Sub Emitters module. + + + + + The total number of sub-emitters. + + + + + Add a new sub-emitter. + + The sub-emitter to be added. + The event that creates new particles. + The properties of the new particles. + The probability that the sub-emitter emits particles. Accepts values from 0 to 1, where 0 is never and 1 is always. + + + + Add a new sub-emitter. + + The sub-emitter to be added. + The event that creates new particles. + The properties of the new particles. + The probability that the sub-emitter emits particles. Accepts values from 0 to 1, where 0 is never and 1 is always. + + + + Returns the probability that the sub-emitter emits particles. + + The index of the desired sub-emitter. + + The emission probability for the desired sub-emitter + + + + + Get the properties of the sub-emitter at the given index. + + The index of the desired sub-emitter. + + The properties of the requested sub-emitter. + + + + + Get the sub-emitter Particle System at the given index. + + The index of the desired sub-emitter. + + The sub-emitter being requested. + + + + + Get the type of the sub-emitter at the given index. + + The index of the desired sub-emitter. + + The type of the requested sub-emitter. + + + + + Remove a sub-emitter from the given index in the array. + + The index from which to remove a sub-emitter. + + + + Sets the probability that the sub-emitter emits particles. + + The index of the sub-emitter being modified. + Sets the emission probability of the sub-emitter at the given index. + + + + Set the properties of the sub-emitter at the given index. + + The index of the sub-emitter being modified. + The new properties to assign to this sub-emitter. + + + + Set the Particle System to use as the sub-emitter at the given index. + + The index of the sub-emitter being modified. + The Particle System being used as this sub-emitter. + + + + Set the type of the sub-emitter at the given index. + + The index of the sub-emitter being modified. + The new spawning type to assign to this sub-emitter. + + + + Script interface for the Texture Sheet Animation module. + + + + + Specifies the animation type. + + + + + Specifies how many times the animation will loop during the lifetime of the particle. + + + + + Enable/disable the Texture Sheet Animation module. + + + + + Flip the U coordinate on particles, causing them to appear mirrored horizontally. + + + + + Flip the V coordinate on particles, causing them to appear mirrored vertically. + + + + + Control how quickly the animation plays. + + + + + Curve to control which frame of the texture sheet animation to play. + + + + + Frame over time mutiplier. + + + + + Select whether the animated texture information comes from a grid of frames on a single texture, or from a list of Sprite objects. + + + + + Defines the tiling of the texture in the X axis. + + + + + Defines the tiling of the texture in the Y axis. + + + + + Explicitly select which row of the texture sheet is used, when ParticleSystem.TextureSheetAnimationModule.useRandomRow is set to false. + + + + + Specify how particle speeds are mapped to the animation frames. + + + + + The total number of sprites. + + + + + Define a random starting frame for the texture sheet animation. + + + + + Starting frame multiplier. + + + + + Select whether the playback is based on mapping a curve to the lifetime of each particle, by using the particle speeds, or if playback simply uses a constant frames per second. + + + + + Use a random row of the texture sheet for each particle emitted. + + + + + Choose which UV channels will receive texture animation. + + + + + Add a new Sprite. + + The Sprite to be added. + + + + Get the Sprite at the given index. + + The index of the desired Sprite. + + The Sprite being requested. + + + + + Remove a Sprite from the given index in the array. + + The index from which to remove a Sprite. + + + + Set the Sprite at the given index. + + The index of the Sprite being modified. + The Sprite being assigned. + + + + Script interface for the Particle System Trails module. + + + + + Adds an extra position to each ribbon, connecting it to the location of the Transform Component. + + + + + The gradient controlling the trail colors during the lifetime of the attached particle. + + + + + The gradient controlling the trail colors over the length of the trail. + + + + + If enabled, Trails will disappear immediately when their owning particle dies. Otherwise, the trail will persist until all its points have naturally expired, based on its lifetime. + + + + + Enable/disable the Trail module. + + + + + Configures the trails to generate Normals and Tangents. With this data, Scene lighting can affect the trails via Normal Maps and the Unity Standard Shader, or your own custom-built Shaders. + + + + + Toggle whether the trail will inherit the particle color as its starting color. + + + + + The curve describing the trail lifetime, throughout the lifetime of the particle. + + + + + Change the lifetime multiplier. + + + + + Set the minimum distance each trail can travel before a new vertex is added to it. + + + + + Choose how particle trails are generated. + + + + + Choose what proportion of particles will receive a trail. + + + + + Select how many lines to create through the Particle System. + + + + + Apply a shadow bias to prevent self-shadowing artifacts. The specified value is the proportion of the trail width at each segment. + + + + + Set whether the particle size will act as a multiplier on top of the trail lifetime. + + + + + Set whether the particle size will act as a multiplier on top of the trail width. + + + + + When used on a sub emitter, ribbons will connect particles from each parent particle independently. + + + + + Choose whether the U coordinate of the trail texture is tiled or stretched. + + + + + The curve describing the width, of each trail point. + + + + + Change the width multiplier. + + + + + Drop new trail points in world space, regardless of Particle System Simulation Space. + + + + + Script interface for the Trigger module. + + + + + Enable/disable the Trigger module. + + + + + Choose what action to perform when particles enter the trigger volume. + + + + + Choose what action to perform when particles leave the trigger volume. + + + + + Choose what action to perform when particles are inside the trigger volume. + + + + + The maximum number of collision shapes that can be attached to this Particle System trigger. + + + + + Choose what action to perform when particles are outside the trigger volume. + + + + + A multiplier applied to the size of each particle before overlaps are processed. + + + + + Get a collision shape associated with this Particle System trigger. + + Which collider to return. + + The collider at the given index. + + + + + Set a collision shape associated with this Particle System trigger. + + Which collider to set. + The collider to associate with this trigger. + + + + Triggers the specified sub emitter on all particles of the Particle System. + + Index of the sub emitter to trigger. + + + + Triggers the specified sub emitter on the specified particle(s) of the Particle System. + + Index of the sub emitter to trigger. + Triggers the sub emtter on a single particle. + Triggers the sub emtter on a list of particles. + + + + Triggers the specified sub emitter on the specified particle(s) of the Particle System. + + Index of the sub emitter to trigger. + Triggers the sub emtter on a single particle. + Triggers the sub emtter on a list of particles. + + + + Script interface for the Velocity Over Lifetime module. + + + + + Enable/disable the Velocity Over Lifetime module. + + + + + Specify a custom center of rotation for the orbital and radial velocities. + + + + + This method is more efficient than accessing the whole curve, if you only want to change the overall offset multiplier. + + + + + Specify a custom center of rotation for the orbital and radial velocities. + + + + + This method is more efficient than accessing the whole curve, if you only want to change the overall offset multiplier. + + + + + Specify a custom center of rotation for the orbital and radial velocities. + + + + + This method is more efficient than accessing the whole curve, if you only want to change the overall offset multiplier. + + + + + Curve to control particle speed based on lifetime, around the X axis. + + + + + X axis speed multiplier. + + + + + Curve to control particle speed based on lifetime, around the Y axis. + + + + + Y axis speed multiplier. + + + + + Curve to control particle speed based on lifetime, around the Z axis. + + + + + Z axis speed multiplier. + + + + + Curve to control particle speed based on lifetime, away from a center position. + + + + + Radial speed multiplier. + + + + + Specifies if the velocities are in local space (rotated with the transform) or world space. + + + + + Curve to control particle speed based on lifetime, without affecting the direction of the particles. + + + + + Speed multiplier. + + + + + Curve to control particle speed based on lifetime, on the X axis. + + + + + X axis speed multiplier. + + + + + Curve to control particle speed based on lifetime, on the Y axis. + + + + + Y axis speed multiplier. + + + + + Curve to control particle speed based on lifetime, on the Z axis. + + + + + Z axis speed multiplier. + + + + + The animation mode. + + + + + Use a regular grid to construct a sequence of animation frames. + + + + + Use a list of sprites to construct a sequence of animation frames. + + + + + Control how animation frames are selected. + + + + + Select animation frames sequentially at a constant rate of the specified frames per second. + + + + + Select animation frames based on the particle ages. + + + + + Select animation frames based on the particle speeds. + + + + + The animation type. + + + + + Animate a single row in the sheet from left to right. + + + + + Animate over the whole texture sheet from left to right, top to bottom. + + + + + Whether to use 2D or 3D colliders for particle collisions. + + + + + Use 2D colliders to collide particles against. + + + + + Use 3D colliders to collide particles against. + + + + + Quality of world collisions. Medium and low quality are approximate and may leak particles. + + + + + The most accurate world collisions. + + + + + Fastest and most approximate world collisions. + + + + + Approximate world collisions. + + + + + The type of collisions to use for a given Particle System. + + + + + Collide with a list of planes. + + + + + Collide with the world geometry. + + + + + The action to perform when the Particle System is offscreen. + + + + + Continue simulating the Particle System when it is offscreen. + + + + + For looping effects, the simulation is paused when offscreen, and for one-shot effects, the simulation will continue playing. + + + + + Pause the Particle System simulation when it is offscreen. + + + + + Pause the Particle System simulation when it is offscreen, and perform an extra simulation when the system comes back onscreen, creating the impression that it was never paused. + + + + + The particle curve mode. + + + + + Use a single constant for the ParticleSystem.MinMaxCurve. + + + + + Use a single curve for the ParticleSystem.MinMaxCurve. + + + + + Use a random value between 2 constants for the ParticleSystem.MinMaxCurve. + + + + + Use a random value between 2 curves for the ParticleSystem.MinMaxCurve. + + + + + Which stream of custom particle data to set. + + + + + The first stream of custom per-particle data. + + + + + The second stream of custom per-particle data. + + + + + Which mode the Custom Data module uses to generate its data. + + + + + Generate data using ParticleSystem.MinMaxGradient. + + + + + Don't generate any data. + + + + + Generate data using ParticleSystem.MinMaxCurve. + + + + + The mode in which particles are emitted. + + + + + Emit when emitter moves. + + + + + Emit over time. + + + + + Control how a Particle System calculates its velocity. + + + + + Calculate the Particle System velocity by using a Rigidbody or Rigidbody2D component, if one exists on the Game Object. + + + + + Calculate the Particle System velocity by using the Transform component. + + + + + Script interface for Particle System Force Fields. + + + + + Apply a linear force along the local X axis to particles within the volume of the Force Field. + + + + + Apply a linear force along the local Y axis to particles within the volume of the Force Field. + + + + + Apply a linear force along the local Z axis to particles within the volume of the Force Field. + + + + + Apply drag to particles within the volume of the Force Field. + + + + + Determines the size of the shape used for influencing particles. + + + + + Apply gravity to particles within the volume of the Force Field. + + + + + When using the gravity force, set this value between 0 and 1 to control the focal point of the gravity effect. + + + + + Describes the length of the Cylinder when using the Cylinder Force Field shape to influence particles. + + + + + When using Drag, the drag strength will be multiplied by the size of the particles if this toggle is enabled. + + + + + When using Drag, the drag strength will be multiplied by the speed of the particles if this toggle is enabled. + + + + + Controls how strongly particles are dragged into the vortex motion. + + + + + Apply randomness to the Force Field axis that particles will travel around. + + + + + The speed at which particles are propelled around a vortex. + + + + + Selects the type of shape used for influencing particles. + + + + + Setting a value greater than 0 creates a hollow Force Field shape. This will cause particles to not be affected by the Force Field when closer to the center of the volume than the startRange property. + + + + + Apply forces to particles within the volume of the Force Field, by using a 3D texture containing vector field data. + + + + + Controls how strongly particles are dragged into the vector field motion. + + + + + The speed at which particles are propelled through the vector field. + + + + + The type of shape used for influencing particles in the Force Field Component. + + + + + Influence particles inside a box shape. + + + + + Influence particles inside a cylinder shape. + + + + + Influence particles inside a hemisphere shape. + + + + + Influence particles inside a sphere shape. + + + + + The particle GameObject filtering mode that specifies which objects are used by specific Particle System modules. + + + + + Include objects based on a layer mask, where all objects that match the mask are included. + + + + + Include objects based on both a layer mask and an explicitly provided list. + + + + + Include objects based on an explicitly provided list. + + + + + The particle gradient mode. + + + + + Use a single color for the ParticleSystem.MinMaxGradient. + + + + + Use a single color gradient for the ParticleSystem.MinMaxGradient. + + + + + Define a list of colors in the ParticleSystem.MinMaxGradient, to be chosen from at random. + + + + + Use a random value between 2 colors for the ParticleSystem.MinMaxGradient. + + + + + Use a random value between 2 color gradients for the ParticleSystem.MinMaxGradient. + + + + + How to apply emitter velocity to particles. + + + + + Each particle's velocity is set to the emitter's current velocity value, every frame. + + + + + Each particle inherits the emitter's velocity on the frame when it was initially emitted. + + + + + The mesh emission type. + + + + + Emit from the edges of the mesh. + + + + + Emit from the surface of the mesh. + + + + + Emit from the vertices of the mesh. + + + + + The quality of the generated noise. + + + + + High quality 3D noise. + + + + + Low quality 1D noise. + + + + + Medium quality 2D noise. + + + + + What action to perform when the particle trigger module passes a test. + + + + + Send the OnParticleTrigger command to the Particle System's script. + + + + + Do nothing. + + + + + Kill all particles that pass this test. + + + + + Renders particles on to the screen. + + + + + The number of currently active custom vertex streams. + + + + + Control the direction that particles face. + + + + + Allow billboard particles to roll around their Z axis. + + + + + How much are the particles stretched depending on the Camera's speed. + + + + + Enables GPU Instancing on platforms where it is supported. + + + + + Flip a percentage of the particles, along each axis. + + + + + How much are the particles stretched in their direction of motion. + + + + + Specifies how the Particle System Renderer interacts with SpriteMask. + + + + + Clamp the maximum particle size. + + + + + Mesh used as particle instead of billboarded texture. + + + + + The number of meshes being used for particle rendering. + + + + + Clamp the minimum particle size. + + + + + How much are billboard particle normals oriented towards the camera. + + + + + Modify the pivot point used for rotating particles. + + + + + How particles are drawn. + + + + + Apply a shadow bias to prevent self-shadowing artifacts. The specified value is the proportion of the particle size. + + + + + Biases Particle System sorting amongst other transparencies. + + + + + Sort particles within a system. + + + + + Set the material used by the Trail module for attaching trails to particles. + + + + + How much are the particles stretched depending on "how fast they move". + + + + + Query whether the Particle System renderer uses a particular set of vertex streams. + + Streams to query. + + Whether all the queried streams are enabled or not. + + + + + Creates a snapshot of ParticleSystemRenderer and stores it in mesh. + + A static mesh that will receive the snapshot of the particles. + The camera used for determining which way camera-space particles will face. + Include the rotation and scale of the Transform in the baked mesh. + + + + Creates a snapshot of ParticleSystemRenderer and stores it in mesh. + + A static mesh that will receive the snapshot of the particles. + The camera used for determining which way camera-space particles will face. + Include the rotation and scale of the Transform in the baked mesh. + + + + Creates a snapshot of ParticleSystemRenderer and stores it in mesh. + + A static mesh that will receive the snapshot of the particles. + The camera used for determining which way camera-space particles will face. + Include the rotation and scale of the Transform in the baked mesh. + + + + Creates a snapshot of ParticleSystemRenderer and stores it in mesh. + + A static mesh that will receive the snapshot of the particles. + The camera used for determining which way camera-space particles will face. + Include the rotation and scale of the Transform in the baked mesh. + + + + Creates a snapshot of ParticleSystem Trails and stores them in mesh. + + A static mesh that will receive the snapshot of the particle trails. + The camera used for determining which way camera-space trails will face. + Include the rotation and scale of the Transform in the baked mesh. + + + + Creates a snapshot of ParticleSystem Trails and stores them in mesh. + + A static mesh that will receive the snapshot of the particle trails. + The camera used for determining which way camera-space trails will face. + Include the rotation and scale of the Transform in the baked mesh. + + + + Creates a snapshot of ParticleSystem Trails and stores them in mesh. + + A static mesh that will receive the snapshot of the particle trails. + The camera used for determining which way camera-space trails will face. + Include the rotation and scale of the Transform in the baked mesh. + + + + Creates a snapshot of ParticleSystem Trails and stores them in mesh. + + A static mesh that will receive the snapshot of the particle trails. + The camera used for determining which way camera-space trails will face. + Include the rotation and scale of the Transform in the baked mesh. + + + + Disable a set of vertex shader streams on the Particle System renderer. +The position stream is always enabled, and any attempts to remove it will be ignored. + + Streams to disable. + + + + Enable a set of vertex shader streams on the Particle System renderer. + + Streams to enable. + + + + Query which vertex shader streams are enabled on the ParticleSystemRenderer. + + The array of streams to be populated. + + + + Query whether the Particle System renderer uses a particular set of vertex streams. + + Streams to query. + + Returns the subset of the queried streams that are actually enabled. + + + + + Get the array of meshes to be used as particles. + + This array will be populated with the list of meshes being used for particle rendering. + + The number of meshes actually written to the destination array. + + + + + Enable a set of vertex shader streams on the ParticleSystemRenderer. + + The new array of enabled vertex streams. + + + + Set an array of meshes to be used as particles when the ParticleSystemRenderer.renderMode is set to ParticleSystemRenderMode.Mesh. + + Array of meshes to be used. + Number of elements from the mesh array to be applied. + + + + Set an array of meshes to be used as particles when the ParticleSystemRenderer.renderMode is set to ParticleSystemRenderMode.Mesh. + + Array of meshes to be used. + Number of elements from the mesh array to be applied. + + + + The rendering mode for particle systems. + + + + + Render particles as billboards facing the active camera. (Default) + + + + + Render particles as billboards always facing up along the y-Axis. + + + + + Render particles as meshes. + + + + + Do not render particles. + + + + + Stretch particles in the direction of motion. + + + + + Render particles as billboards always facing the player, but not pitching along the x-Axis. + + + + + How particles are aligned when rendered. + + + + + Particles face the eye position. + + + + + Particles align with their local transform. + + + + + Particles are aligned to their direction of travel. + + + + + Particles face the camera plane. + + + + + Particles align with the world. + + + + + Control how particles are removed from the Particle System. + + + + + Particles are removed when their age exceeds their lifetime. + + + + + Particles are removed when creating new particles would exceed the Max Particles property. Before being removed, particles remain alive until their age exceeds their lifetime. + + + + + Particles are removed when creating new particles would exceed the Max Particles property. + + + + + Control how particle systems apply transform scale. + + + + + Scale the Particle System using the entire transform hierarchy. + + + + + Scale the Particle System using only its own transform scale. (Ignores parent scale). + + + + + Only apply transform scale to the shape component, which controls where + particles are spawned, but does not affect their size or movement. + + + + + + The mode used to generate new points in a shape. + + + + + Distribute new particles around the shape evenly. + + + + + Animate the emission point around the shape. + + + + + Animate the emission point around the shape, alternating between clockwise and counter-clockwise directions. + + + + + Generate points randomly. (Default) + + + + + The texture channel. + + + + + The alpha channel. + + + + + The blue channel. + + + + + The green channel. + + + + + The red channel. + + + + + The emission shape. + + + + + Emit from the volume of a box. + + + + + Emit from the edges of a box. + + + + + Emit from the surface of a box. + + + + + Emit from a circle. + + + + + Emit from the edge of a circle. + + + + + Emit from the base of a cone. + + + + + Emit from the base surface of a cone. + + + + + Emit from a cone. + + + + + Emit from the surface of a cone. + + + + + Emit from a Donut. + + + + + Emit from a half-sphere. + + + + + Emit from the surface of a half-sphere. + + + + + Emit from a mesh. + + + + + Emit from a mesh renderer. + + + + + Emit from a rectangle. + + + + + Emit from an edge. + + + + + Emit from a skinned mesh renderer. + + + + + Emit from a sphere. + + + + + Emit from the surface of a sphere. + + + + + Emit from a sprite. + + + + + Emit from a sprite renderer. + + + + + The space to simulate particles in. + + + + + Simulate particles relative to a custom transform component, defined by ParticleSystem.MainModule.customSimulationSpace. + + + + + Simulate particles in local space. + + + + + Simulate particles in world space. + + + + + The sorting mode for particle systems. + + + + + Sort based on distance. + + + + + No sorting. + + + + + Sort the oldest particles to the front. + + + + + Sort the youngest particles to the front. + + + + + The action to perform when the Particle System stops. + + + + + Call OnParticleSystemStopped on the ParticleSystem script. + + + + + Destroy the GameObject containing the Particle System. + + + + + Disable the GameObject containing the Particle System. + + + + + Do nothing. + + + + + The behavior to apply when calling ParticleSystem.Stop|Stop. + + + + + Stops Particle System emitting any further particles. All existing particles will remain until they expire. + + + + + Stops Particle System emitting and removes all existing emitted particles. + + + + + The properties of sub-emitter particles. + + + + + When spawning new particles, multiply the start color by the color of the parent particles. + + + + + When spawning new particles, use the duration and age properties from the parent system, when sampling Main module curves in the Sub-Emitter. + + + + + When spawning new particles, inherit all available properties from the parent particles. + + + + + New particles will have a shorter lifespan, the closer their parent particles are to death. + + + + + When spawning new particles, do not inherit any properties from the parent particles. + + + + + When spawning new particles, add the start rotation to the rotation of the parent particles. + + + + + When spawning new particles, multiply the start size by the size of the parent particles. + + + + + The events that cause new particles to be spawned. + + + + + Spawns new particles when particles from the parent system are born. + + + + + Spawns new particles when particles from the parent system collide with something. + + + + + Spawns new particles when particles from the parent system die. + + + + + Spawns new particles when triggered from script using ParticleSystem.TriggerSubEmitter. + + + + + Spawns new particles when particles from the parent system pass conditions in the Trigger Module. + + + + + Choose how Particle Trails are generated. + + + + + Makes a trail behind each particle as the particle moves. + + + + + Draws a line between each particle, connecting the youngest particle to the oldest. + + + + + Choose how textures are applied to Particle Trails. + + + + + Map the texture once along the entire length of the trail, assuming all vertices are evenly spaced. + + + + + Repeat the texture along the trail, repeating at a rate of once per trail segment. To adjust the tiling rate, use Material.SetTextureScale. + + + + + Map the texture once along the entire length of the trail. + + + + + Repeat the texture along the trail. To set the tiling rate, use Material.SetTextureScale. + + + + + The different types of particle triggers. + + + + + Trigger when particles enter the collision volume. + + + + + Trigger when particles leave the collision volume. + + + + + Trigger when particles are inside the collision volume. + + + + + Trigger when particles are outside the collision volume. + + + + + All possible Particle System vertex shader inputs. + + + + + The normalized age of each particle, from 0 to 1. + + + + + The amount to blend between animated texture frames, from 0 to 1. + + + + + The current animation frame index of each particle. + + + + + The center position of the entire particle, in world space. + + + + + The color of each particle. + + + + + One custom value for each particle, defined by the Custom Data Module, or ParticleSystem.SetCustomParticleData. + + + + + Two custom values for each particle, defined by the Custom Data Module, or ParticleSystem.SetCustomParticleData. + + + + + Three custom values for each particle, defined by the Custom Data Module, or ParticleSystem.SetCustomParticleData. + + + + + Four custom values for each particle, defined by the Custom Data Module, or ParticleSystem.SetCustomParticleData. + + + + + One custom value for each particle, defined by the Custom Data Module, or ParticleSystem.SetCustomParticleData. + + + + + Two custom values for each particle, defined by the Custom Data Module, or ParticleSystem.SetCustomParticleData. + + + + + Three custom values for each particle, defined by the Custom Data Module, or ParticleSystem.SetCustomParticleData. + + + + + Four custom values for each particle, defined by the Custom Data Module, or ParticleSystem.SetCustomParticleData. + + + + + The reciprocal of the starting lifetime, in seconds (1.0f / startLifetime). + + + + + The X axis noise on the current frame. + + + + + The X and Y axis noise on the current frame. + + + + + The 3D noise on the current frame. + + + + + The accumulated X axis noise, over the lifetime of the particle. + + + + + The accumulated X and Y axis noise, over the lifetime of the particle. + + + + + The accumulated 3D noise, over the lifetime of the particle. + + + + + The vertex normal of each particle. + + + + + The position of each particle vertex, in world space. + + + + + The Z axis rotation of each particle. + + + + + The 3D rotation of each particle. + + + + + The Z axis rotational speed of each particle. + + + + + The 3D rotational speed of each particle. + + + + + The X axis size of each particle. + + + + + The X and Y axis sizes of each particle. + + + + + The 3D size of each particle. + + + + + The speed of each particle, calculated by taking the magnitude of the velocity. + + + + + A random number for each particle, which remains constant during their lifetime. + + + + + Two random numbers for each particle, which remain constant during their lifetime. + + + + + Three random numbers for each particle, which remain constant during their lifetime. + + + + + Four random numbers for each particle, which remain constant during their lifetime. + + + + + The tangent vector for each particle (for normal mapping). + + + + + The first UV stream of each particle. + + + + + The second UV stream of each particle. + + + + + The third UV stream of each particle (only for meshes). + + + + + The fourth UV stream of each particle (only for meshes). + + + + + A random number for each particle, which changes during their lifetime. + + + + + Two random numbers for each particle, which change during their lifetime. + + + + + Three random numbers for each particle, which change during their lifetime. + + + + + Four random numbers for each particle, which change during their lifetime. + + + + + The velocity of each particle, in world space. + + + + + The vertex ID of each particle. + + + + + All possible Particle System vertex shader inputs. + + + + + A mask with all vertex streams enabled. + + + + + The center position of each particle, with the vertex ID of each particle, from 0-3, stored in the w component. + + + + + The color of each particle. + + + + + The first stream of custom data, supplied from script. + + + + + The second stream of custom data, supplied from script. + + + + + Alive time as a 0-1 value in the X component, and Total Lifetime in the Y component. +To get the current particle age, simply multiply X by Y. + + + + + A mask with no vertex streams enabled. + + + + + The normal of each particle. + + + + + The world space position of each particle. + + + + + 4 random numbers. The first 3 are deterministic and assigned once when each particle is born, but the 4th value will change during the lifetime of the particle. + + + + + The rotation of each particle. + + + + + The size of each particle. + + + + + Tangent vectors for normal mapping. + + + + + The texture coordinates of each particle. + + + + + With the Texture Sheet Animation module enabled, this contains the UVs for the second texture frame, the blend factor for each particle, and the raw frame, allowing for blending of frames. + + + + + The 3D velocity of each particle. + + + + + Structure containing minimum and maximum terrain patch height values. + + + + + Maximum height of a terrain patch. + + + + + Minimum height of a terrain patch. + + + + + Physics material describes how to handle colliding objects (friction, bounciness). + + + + + Determines how the bounciness is combined. + + + + + How bouncy is the surface? A value of 0 will not bounce. A value of 1 will bounce without any loss of energy. + + + + + The friction used when already moving. This value is usually between 0 and 1. + + + + + If anisotropic friction is enabled, dynamicFriction2 will be applied along frictionDirection2. + + + + + Determines how the friction is combined. + + + + + The direction of anisotropy. Anisotropic friction is enabled if the vector is not zero. + + + + + The friction coefficient used when an object is lying on a surface. + + + + + If anisotropic friction is enabled, staticFriction2 will be applied along frictionDirection2. + + + + + Creates a new material. + + + + + Creates a new material named name. + + + + + + Describes how physics materials of the colliding objects are combined. + +The friction force as well as the residual bounce impulse are applied symmertrically to both of the colliders in contact, so each pair of overlapping colliders must have a single set of friction and bouciness settings. However, one can set arbitrary physics materials to any colliders. For that particular reason, there is a mechanism that allows the combination of two different sets of properties that correspond to each of the colliders in contact into one set to be used in the solver. + +Specifying Average, Maximum, Minimum or Multiply as the physics material combine mode, you directly set the function that is used to combine the settings corresponding to the two overlapping colliders into one set of settings that can be used to apply the material effect. + +Note that there is a special case when the two overlapping colliders have physics materials with different combine modes set. In this particular case, the function that has the highest priority is used. The priority order is as follows: Average < Minimum < Multiply < Maximum. For example, if one material has Average set but the other one has Maximum, then the combine function to be used is Maximum, since it has higher priority. + + + + + Averages the friction/bounce of the two colliding materials. + + + + + Uses the larger friction/bounce of the two colliding materials. + + + + + Uses the smaller friction/bounce of the two colliding materials. + + + + + Multiplies the friction/bounce of the two colliding materials. + + + + + Global physics properties and helper methods. + + + + + Sets whether the physics should be simulated automatically or not. + + + + + Whether or not to automatically sync transform changes with the physics system whenever a Transform component changes. + + + + + Two colliding objects with a relative velocity below this will not bounce (default 2). Must be positive. + + + + + The default contact offset of the newly created colliders. + + + + + The PhysicsScene automatically created when Unity starts. + + + + + The defaultSolverIterations determines how accurately Rigidbody joints and collision contacts are resolved. (default 6). Must be positive. + + + + + The defaultSolverVelocityIterations affects how accurately the Rigidbody joints and collision contacts are resolved. (default 1). Must be positive. + + + + + The gravity applied to all rigid bodies in the Scene. + + + + + Sets the minimum separation distance for cloth inter-collision. + + + + + Sets the cloth inter-collision stiffness. + + + + + The default maximum angular velocity permitted for any rigid bodies (default 7). Must be positive. + + + + + The minimum contact penetration value in order to apply a penalty force (default 0.05). Must be positive. + + + + + Whether physics queries should hit back-face triangles. + + + + + Specifies whether queries (raycasts, spherecasts, overlap tests, etc.) hit Triggers by default. + + + + + Determines whether the garbage collector should reuse only a single instance of a Collision type for all collision callbacks. + + + + + The default angular velocity, below which objects start sleeping (default 0.14). Must be positive. + + + + + The mass-normalized energy threshold, below which objects start going to sleep. + + + + + The default linear velocity, below which objects start going to sleep (default 0.15). Must be positive. + + + + + Layer mask constant to select all layers. + + + + + Casts the box along a ray and returns detailed information on what was hit. + + Center of the box. + Half the size of the box in each dimension. + The direction in which to cast the box. + Rotation of the box. + The max length of the cast. + A that is used to selectively ignore colliders when casting a capsule. + Specifies whether this query should hit Triggers. + + True, if any intersections were found. + + + + + Casts the box along a ray and returns detailed information on what was hit. + + Center of the box. + Half the size of the box in each dimension. + The direction in which to cast the box. + If true is returned, hitInfo will contain more information about where the collider was hit. (See Also: RaycastHit). + Rotation of the box. + The max length of the cast. + A that is used to selectively ignore colliders when casting a capsule. + Specifies whether this query should hit Triggers. + + True, if any intersections were found. + + + + + Like Physics.BoxCast, but returns all hits. + + Center of the box. + Half the size of the box in each dimension. + The direction in which to cast the box. + Rotation of the box. + The max length of the cast. + A that is used to selectively ignore colliders when casting a capsule. + Specifies whether this query should hit Triggers. + + + All colliders that were hit. + + + + + Cast the box along the direction, and store hits in the provided buffer. + + Center of the box. + Half the size of the box in each dimension. + The direction in which to cast the box. + The buffer to store the results in. + Rotation of the box. + The max length of the cast. + A that is used to selectively ignore colliders when casting a capsule. + Specifies whether this query should hit Triggers. + + + The amount of hits stored to the results buffer. + + + + + Casts a capsule against all colliders in the Scene and returns detailed information on what was hit. + + The center of the sphere at the start of the capsule. + The center of the sphere at the end of the capsule. + The radius of the capsule. + The direction into which to sweep the capsule. + The max length of the sweep. + A that is used to selectively ignore colliders when casting a capsule. + Specifies whether this query should hit Triggers. + + True when the capsule sweep intersects any collider, otherwise false. + + + + + + + The center of the sphere at the start of the capsule. + The center of the sphere at the end of the capsule. + The radius of the capsule. + The direction into which to sweep the capsule. + The max length of the sweep. + If true is returned, hitInfo will contain more information about where the collider was hit. (See Also: RaycastHit). + A that is used to selectively ignore colliders when casting a capsule. + Specifies whether this query should hit Triggers. + + + + Like Physics.CapsuleCast, but this function will return all hits the capsule sweep intersects. + + The center of the sphere at the start of the capsule. + The center of the sphere at the end of the capsule. + The radius of the capsule. + The direction into which to sweep the capsule. + The max length of the sweep. + A that is used to selectively ignore colliders when casting a capsule. + Specifies whether this query should hit Triggers. + + + An array of all colliders hit in the sweep. + + + + + Casts a capsule against all colliders in the Scene and returns detailed information on what was hit into the buffer. + + The center of the sphere at the start of the capsule. + The center of the sphere at the end of the capsule. + The radius of the capsule. + The direction into which to sweep the capsule. + The buffer to store the hits into. + The max length of the sweep. + A that is used to selectively ignore colliders when casting a capsule. + Specifies whether this query should hit Triggers. + + + The amount of hits stored into the buffer. + + + + + Check whether the given box overlaps with other colliders or not. + + Center of the box. + Half the size of the box in each dimension. + Rotation of the box. + A that is used to selectively ignore colliders when casting a ray. + Specifies whether this query should hit Triggers. + + True, if the box overlaps with any colliders. + + + + + Checks if any colliders overlap a capsule-shaped volume in world space. + + The center of the sphere at the start of the capsule. + The center of the sphere at the end of the capsule. + The radius of the capsule. + A that is used to selectively ignore colliders when casting a capsule. + Specifies whether this query should hit Triggers. + + + + + Returns true if there are any colliders overlapping the sphere defined by position and radius in world coordinates. + + Center of the sphere. + Radius of the sphere. + A that is used to selectively ignore colliders when casting a capsule. + Specifies whether this query should hit Triggers. + + + + Returns a point on the given collider that is closest to the specified location. + + Location you want to find the closest point to. + The collider that you find the closest point on. + The position of the collider. + The rotation of the collider. + + The point on the collider that is closest to the specified location. + + + + + Compute the minimal translation required to separate the given colliders apart at specified poses. + + The first collider. + Position of the first collider. + Rotation of the first collider. + The second collider. + Position of the second collider. + Rotation of the second collider. + Direction along which the translation required to separate the colliders apart is minimal. + The distance along direction that is required to separate the colliders apart. + + True, if the colliders overlap at the given poses. + + + + + Layer mask constant to select default raycast layers. + + + + + Are collisions between layer1 and layer2 being ignored? + + + + + + + Makes the collision detection system ignore all collisions between collider1 and collider2. + + Starting point of the collider. + End point of the collider. + Ignore collision. + + + + Makes the collision detection system ignore all collisions between any collider in layer1 and any collider in layer2. + +Note that IgnoreLayerCollision will reset the trigger state of affected colliders, so you might receive OnTriggerExit and OnTriggerEnter messages in response to calling this. + + + + + + + + Layer mask constant to select ignore raycast layer. + + + + + Returns true if there is any collider intersecting the line between start and end. + + Start point. + End point. + A that is used to selectively ignore colliders when casting a ray. + Specifies whether this query should hit Triggers. + + + + Returns true if there is any collider intersecting the line between start and end. + + Start point. + End point. + A that is used to selectively ignore colliders when casting a ray. + Specifies whether this query should hit Triggers. + If true is returned, hitInfo will contain more information about where the collider was hit. (See Also: RaycastHit). + + + + Find all colliders touching or inside of the given box. + + Center of the box. + Half of the size of the box in each dimension. + Rotation of the box. + A that is used to selectively ignore colliders when casting a ray. + Specifies whether this query should hit Triggers. + + Colliders that overlap with the given box. + + + + + Find all colliders touching or inside of the given box, and store them into the buffer. + + Center of the box. + Half of the size of the box in each dimension. + The buffer to store the results in. + Rotation of the box. + A that is used to selectively ignore colliders when casting a ray. + Specifies whether this query should hit Triggers. + + + The amount of colliders stored in results. + + + + + Check the given capsule against the physics world and return all overlapping colliders. + + The center of the sphere at the start of the capsule. + The center of the sphere at the end of the capsule. + The radius of the capsule. + A that is used to selectively ignore colliders when casting a capsule. + Specifies whether this query should hit Triggers. + + Colliders touching or inside the capsule. + + + + + Check the given capsule against the physics world and return all overlapping colliders in the user-provided buffer. + + The center of the sphere at the start of the capsule. + The center of the sphere at the end of the capsule. + The radius of the capsule. + The buffer to store the results into. + A that is used to selectively ignore colliders when casting a capsule. + Specifies whether this query should hit Triggers. + + The amount of entries written to the buffer. + + + + + Returns an array with all colliders touching or inside the sphere. + + Center of the sphere. + Radius of the sphere. + A that is used to selectively ignore colliders when casting a ray. + Specifies whether this query should hit Triggers. + + + + Computes and stores colliders touching or inside the sphere into the provided buffer. + + Center of the sphere. + Radius of the sphere. + The buffer to store the results into. + A that is used to selectively ignore colliders when casting a ray. + Specifies whether this query should hit Triggers. + + The amount of colliders stored into the results buffer. + + + + + Casts a ray, from point origin, in direction direction, of length maxDistance, against all colliders in the Scene. + + The starting point of the ray in world coordinates. + The direction of the ray. + The max distance the ray should check for collisions. + A that is used to selectively ignore Colliders when casting a ray. + Specifies whether this query should hit Triggers. + + True if the ray intersects with a Collider, otherwise false. + + + + + Casts a ray against all colliders in the Scene and returns detailed information on what was hit. + + The starting point of the ray in world coordinates. + The direction of the ray. + If true is returned, hitInfo will contain more information about where the collider was hit. (See Also: RaycastHit). + The max distance the ray should check for collisions. + A that is used to selectively ignore colliders when casting a ray. + Specifies whether this query should hit Triggers. + + True when the ray intersects any collider, otherwise false. + + + + + Same as above using ray.origin and ray.direction instead of origin and direction. + + The starting point and direction of the ray. + The max distance the ray should check for collisions. + A that is used to selectively ignore colliders when casting a ray. + Specifies whether this query should hit Triggers. + + True when the ray intersects any collider, otherwise false. + + + + + Same as above using ray.origin and ray.direction instead of origin and direction. + + The starting point and direction of the ray. + If true is returned, hitInfo will contain more information about where the collider was hit. (See Also: RaycastHit). + The max distance the ray should check for collisions. + A that is used to selectively ignore colliders when casting a ray. + Specifies whether this query should hit Triggers. + + True when the ray intersects any collider, otherwise false. + + + + + Casts a ray through the Scene and returns all hits. Note that order is not guaranteed. + + The starting point and direction of the ray. + The max distance the rayhit is allowed to be from the start of the ray. + A that is used to selectively ignore colliders when casting a ray. + Specifies whether this query should hit Triggers. + + + + See Also: Raycast. + + The starting point of the ray in world coordinates. + The direction of the ray. + The max distance the rayhit is allowed to be from the start of the ray. + A that is used to selectively ignore colliders when casting a ray. + Specifies whether this query should hit Triggers. + + + + + Cast a ray through the Scene and store the hits into the buffer. + + The starting point and direction of the ray. + The buffer to store the hits into. + The max distance the rayhit is allowed to be from the start of the ray. + A that is used to selectively ignore colliders when casting a ray. + Specifies whether this query should hit Triggers. + + The amount of hits stored into the results buffer. + + + + + Cast a ray through the Scene and store the hits into the buffer. + + The starting point and direction of the ray. + The buffer to store the hits into. + The direction of the ray. + The max distance the rayhit is allowed to be from the start of the ray. + A that is used to selectively ignore colliders when casting a ray. + Specifies whether this query should hit Triggers. + + + The amount of hits stored into the results buffer. + + + + + Rebuild the broadphase interest regions as well as set the world boundaries. + + Boundaries of the physics world. + How many cells to create along x and z axis. + + + + Simulate physics in the Scene. + + The time to advance physics by. + + + + Casts a sphere along a ray and returns detailed information on what was hit. + + The center of the sphere at the start of the sweep. + The radius of the sphere. + The direction into which to sweep the sphere. + If true is returned, hitInfo will contain more information about where the collider was hit. (See Also: RaycastHit). + The max length of the cast. + A that is used to selectively ignore colliders when casting a capsule. + Specifies whether this query should hit Triggers. + + True when the sphere sweep intersects any collider, otherwise false. + + + + + Casts a sphere along a ray and returns detailed information on what was hit. + + The starting point and direction of the ray into which the sphere sweep is cast. + The radius of the sphere. + The max length of the cast. + A that is used to selectively ignore colliders when casting a capsule. + Specifies whether this query should hit Triggers. + + True when the sphere sweep intersects any collider, otherwise false. + + + + + + + The starting point and direction of the ray into which the sphere sweep is cast. + The radius of the sphere. + If true is returned, hitInfo will contain more information about where the collider was hit. (See Also: RaycastHit). + The max length of the cast. + A that is used to selectively ignore colliders when casting a capsule. + Specifies whether this query should hit Triggers. + + + + Like Physics.SphereCast, but this function will return all hits the sphere sweep intersects. + + The center of the sphere at the start of the sweep. + The radius of the sphere. + The direction in which to sweep the sphere. + The max length of the sweep. + A that is used to selectively ignore colliders when casting a sphere. + Specifies whether this query should hit Triggers. + + An array of all colliders hit in the sweep. + + + + + Like Physics.SphereCast, but this function will return all hits the sphere sweep intersects. + + The starting point and direction of the ray into which the sphere sweep is cast. + The radius of the sphere. + The max length of the sweep. + A that is used to selectively ignore colliders when casting a sphere. + Specifies whether this query should hit Triggers. + + + + Cast sphere along the direction and store the results into buffer. + + The center of the sphere at the start of the sweep. + The radius of the sphere. + The direction in which to sweep the sphere. + The buffer to save the hits into. + The max length of the sweep. + A that is used to selectively ignore colliders when casting a sphere. + Specifies whether this query should hit Triggers. + + The amount of hits stored into the results buffer. + + + + + Cast sphere along the direction and store the results into buffer. + + The starting point and direction of the ray into which the sphere sweep is cast. + The radius of the sphere. + The buffer to save the results to. + The max length of the sweep. + A that is used to selectively ignore colliders when casting a sphere. + Specifies whether this query should hit Triggers. + + The amount of hits stored into the results buffer. + + + + + Apply Transform changes to the physics engine. + + + + + Global settings and helpers for 2D physics. + + + + + Should the collider gizmos always be shown even when they are not selected? + + + + + A rigid-body cannot sleep if its angular velocity is above this tolerance. + + + + + Sets whether the physics should be simulated automatically or not. + + + + + Whether or not to automatically sync transform changes with the physics system whenever a Transform component changes. + + + + + The scale factor that controls how fast overlaps are resolved. + + + + + The scale factor that controls how fast TOI overlaps are resolved. + + + + + Use this to control whether or not the appropriate OnCollisionExit2D or OnTriggerExit2D callbacks should be called when a Collider2D is disabled. + + + + + Whether or not to stop reporting collision callbacks immediately if any of the objects involved in the collision are deleted/moved. + + + + + Sets the color used by the gizmos to show all Collider axis-aligned bounding boxes (AABBs). + + + + + The color used by the gizmos to show all asleep colliders (collider is asleep when the body is asleep). + + + + + The color used by the gizmos to show all awake colliders (collider is awake when the body is awake). + + + + + The color used by the gizmos to show all collider contacts. + + + + + The scale of the contact arrow used by the collider gizmos. + + + + + The default contact offset of the newly created colliders. + + + + + The PhysicsScene2D automatically created when Unity starts. + + + + + Ets the collision callbacks to stop or continue processing if any of the objects involved in the collision are deleted. + + + + + Acceleration due to gravity. + + + + + A set of options that control how physics operates when using the job system to multithread the physics simulation. + + + + + A rigid-body cannot sleep if its linear velocity is above this tolerance. + + + + + The maximum angular position correction used when solving constraints. This helps to prevent overshoot. + + + + + The maximum linear position correction used when solving constraints. This helps to prevent overshoot. + + + + + The maximum angular speed of a rigid-body per physics update. Increasing this can cause numerical problems. + + + + + The maximum linear speed of a rigid-body per physics update. Increasing this can cause numerical problems. + + + + + This property is obsolete. You should use defaultContactOffset instead. + + + + + The number of iterations of the physics solver when considering objects' positions. + + + + + Do raycasts detect Colliders configured as triggers? + + + + + Sets the raycasts or linecasts that start inside Colliders to detect or not detect those Colliders. + + + + + Sets the raycasts to either detect or not detect Triggers. + + + + + Do ray/line casts that start inside a collider(s) detect those collider(s)? + + + + + Determines whether the garbage collector should reuse only a single instance of a Collision2D type for all collision callbacks. + + + + + Should the collider gizmos show the AABBs for each collider? + + + + + Should the collider gizmos show current contacts for each collider? + + + + + Should the collider gizmos show the sleep-state for each collider? + + + + + The time in seconds that a rigid-body must be still before it will go to sleep. + + + + + The number of iterations of the physics solver when considering objects' velocities. + + + + + Any collisions with a relative linear velocity below this threshold will be treated as inelastic. + + + + + Layer mask constant that includes all layers. + + + + + Casts a box against colliders in the Scene, returning the first collider to contact with it. + + The point in 2D space where the box originates. + The size of the box. + The angle of the box (in degrees). + Vector representing the direction of the box. + Maximum distance over which to cast the box. + Filter to detect Colliders only on certain layers. + Only include objects with a Z coordinate (depth) greater than or equal to this value. + Only include objects with a Z coordinate (depth) less than or equal to this value. + + The cast results returned. + + + + + Casts a box against the colliders in the Scene and returns all colliders that are in contact with it. + + The point in 2D space where the box originates. + The size of the box. + The angle of the box (in degrees). + Vector representing the direction of the box. + Maximum distance over which to cast the box. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + + Returns the number of results placed in the results array. + + + + + Casts a box against colliders in the Scene, returning all colliders that contact with it. + + The point in 2D space where the box originates. + The size of the box. + The angle of the box (in degrees). + Vector representing the direction of the box. + Maximum distance over which to cast the box. + Filter to detect Colliders only on certain layers. + Only include objects with a Z coordinate (depth) greater than or equal to this value. + Only include objects with a Z coordinate (depth) less than or equal to this value. + + The cast results returned. + + + + + Casts a box into the Scene, returning colliders that contact with it into the provided results array. + + The point in 2D space where the box originates. + The size of the box. + The angle of the box (in degrees). + Vector representing the direction of the box. + Array to receive results. + Maximum distance over which to cast the box. + Filter to detect Colliders only on certain layers. + Only include objects with a Z coordinate (depth) greater than or equal to this value. + Only include objects with a Z coordinate (depth) less than or equal to this value. + + Returns the number of results placed in the results array. + + + + + Casts a capsule against colliders in the Scene, returning the first collider to contact with it. + + The point in 2D space where the capsule originates. + The size of the capsule. + The direction of the capsule. + The angle of the capsule (in degrees). + Vector representing the direction to cast the capsule. + Maximum distance over which to cast the capsule. + Filter to detect Colliders only on certain layers. + Only include objects with a Z coordinate (depth) greater than this value. + Only include objects with a Z coordinate (depth) less than this value. + + The cast results returned. + + + + + Casts a capsule against the colliders in the Scene and returns all colliders that are in contact with it. + + The point in 2D space where the capsule originates. + The size of the capsule. + The direction of the capsule. + The angle of the capsule (in degrees). + Vector representing the direction to cast the capsule. + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + Maximum distance over which to cast the capsule. + + Returns the number of results placed in the results array. + + + + + Casts a capsule against colliders in the Scene, returning all colliders that contact with it. + + The point in 2D space where the capsule originates. + The size of the capsule. + The direction of the capsule. + The angle of the capsule (in degrees). + Vector representing the direction to cast the capsule. + Maximum distance over which to cast the capsule. + Filter to detect Colliders only on certain layers. + Only include objects with a Z coordinate (depth) greater than this value. + Only include objects with a Z coordinate (depth) less than this value. + + The cast results returned. + + + + + Casts a capsule into the Scene, returning colliders that contact with it into the provided results array. + + The point in 2D space where the capsule originates. + The size of the capsule. + The direction of the capsule. + The angle of the capsule (in degrees). + Vector representing the direction to cast the capsule. + Array to receive results. + Maximum distance over which to cast the capsule. + Filter to detect Colliders only on certain layers. + Only include objects with a Z coordinate (depth) greater than this value. + Only include objects with a Z coordinate (depth) less than this value. + + Returns the number of results placed in the results array. + + + + + Casts a circle against colliders in the Scene, returning the first collider to contact with it. + + The point in 2D space where the circle originates. + The radius of the circle. + Vector representing the direction of the circle. + Maximum distance over which to cast the circle. + Filter to detect Colliders only on certain layers. + Only include objects with a Z coordinate (depth) greater than or equal to this value. + Only include objects with a Z coordinate (depth) less than or equal to this value. + + The cast results returned. + + + + + Casts a circle against colliders in the Scene, returning all colliders that contact with it. + + The point in 2D space where the circle originates. + The radius of the circle. + Vector representing the direction of the circle. + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + Maximum distance over which to cast the circle. + + Returns the number of results placed in the results array. + + + + + Casts a circle against colliders in the Scene, returning all colliders that contact with it. + + The point in 2D space where the circle originates. + The radius of the circle. + Vector representing the direction of the circle. + Maximum distance over which to cast the circle. + Filter to detect Colliders only on certain layers. + Only include objects with a Z coordinate (depth) greater than or equal to this value. + Only include objects with a Z coordinate (depth) less than or equal to this value. + + The cast results returned. + + + + + Casts a circle into the Scene, returning colliders that contact with it into the provided results array. + + The point in 2D space where the circle originates. + The radius of the circle. + Vector representing the direction of the circle. + Array to receive results. + Maximum distance over which to cast the circle. + Filter to detect Colliders only on certain layers. + Only include objects with a Z coordinate (depth) greater than or equal to this value. + Only include objects with a Z coordinate (depth) less than or equal to this value. + + Returns the number of results placed in the results array. + + + + + Layer mask constant that includes all layers participating in raycasts by default. + + + + + Calculates the minimum distance between two colliders. + + A collider used to calculate the minimum distance against colliderB. + A collider used to calculate the minimum distance against colliderA. + + The minimum distance between colliderA and colliderB. + + + + + Retrieves all colliders in contact with the collider. + + The collider to retrieve contacts for. + An array of Collider2D used to receive the results. + + Returns the number of colliders placed in the colliders array. + + + + + Retrieves all contact points in contact with the collider. + + The collider to retrieve contacts for. + An array of ContactPoint2D used to receive the results. + + Returns the number of contacts placed in the contacts array. + + + + + Retrieves all contact points in contact with the collider, with the results filtered by the ContactFilter2D. + + The collider to retrieve contacts for. + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + An array of ContactPoint2D used to receive the results. + + Returns the number of contacts placed in the contacts array. + + + + + Retrieves all colliders in contact with the collider, with the results filtered by the ContactFilter2D. + + The collider to retrieve contacts for. + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + An array of Collider2D used to receive the results. + + Returns the number of colliders placed in the colliders array. + + + + + Retrieves all contact points in for contacts between with the collider1 and collider2, with the results filtered by the ContactFilter2D. + + The collider to check if it has contacts against collider2. + The collider to check if it has contacts against collider1. + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + An array of ContactPoint2D used to receive the results. + + Returns the number of contacts placed in the contacts array. + + + + + Retrieves all contact points in contact with any of the collider(s) attached to this rigidbody. + + The rigidbody to retrieve contacts for. All colliders attached to this rigidbody will be checked. + An array of ContactPoint2D used to receive the results. + + Returns the number of contacts placed in the contacts array. + + + + + Retrieves all colliders in contact with any of the collider(s) attached to this rigidbody. + + The rigidbody to retrieve contacts for. All colliders attached to this rigidbody will be checked. + An array of Collider2D used to receive the results. + + Returns the number of colliders placed in the colliders array. + + + + + Retrieves all contact points in contact with any of the collider(s) attached to this rigidbody, with the results filtered by the ContactFilter2D. + + The rigidbody to retrieve contacts for. All colliders attached to this rigidbody will be checked. + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + An array of ContactPoint2D used to receive the results. + + Returns the number of contacts placed in the contacts array. + + + + + Retrieves all colliders in contact with any of the collider(s) attached to this rigidbody, with the results filtered by the ContactFilter2D. + + The rigidbody to retrieve contacts for. All colliders attached to this rigidbody will be checked. + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + An array of Collider2D used to receive the results. + + Returns the number of colliders placed in the colliders array. + + + + + Checks whether the collision detection system will ignore all collisionstriggers between collider1 and collider2/ or not. + + The first collider to compare to collider2. + The second collider to compare to collider1. + + Whether the collision detection system will ignore all collisionstriggers between collider1 and collider2/ or not. + + + + + Checks whether collisions between the specified layers be ignored or not. + + ID of first layer. + ID of second layer. + + Whether collisions between the specified layers be ignored or not. + + + + + Get the collision layer mask that indicates which layer(s) the specified layer can collide with. + + The layer to retrieve the collision layer mask for. + + A mask where each bit indicates a layer and whether it can collide with layer or not. + + + + + Cast a 3D ray against the colliders in the Scene returning the first collider along the ray. + + The 3D ray defining origin and direction to test. + Maximum distance over which to cast the ray. + Filter to detect colliders only on certain layers. + + The cast results returned. + + + + + Cast a 3D ray against the colliders in the Scene returning all the colliders along the ray. + + The 3D ray defining origin and direction to test. + Maximum distance over which to cast the ray. + Filter to detect colliders only on certain layers. + + The cast results returned. + + + + + Cast a 3D ray against the colliders in the Scene returning the colliders along the ray. + + The 3D ray defining origin and direction to test. + Maximum distance over which to cast the ray. + Filter to detect colliders only on certain layers. + Array to receive results. + + The number of results returned. + + + + + Makes the collision detection system ignore all collisionstriggers between collider1 and collider2/. + + The first collider to compare to collider2. + The second collider to compare to collider1. + Whether collisionstriggers between collider1 and collider2/ should be ignored or not. + + + + Choose whether to detect or ignore collisions between a specified pair of layers. + + ID of the first layer. + ID of the second layer. + Should collisions between these layers be ignored? + + + + Layer mask constant for the default layer that ignores raycasts. + + + + + Checks whether the passed colliders are in contact or not. + + The collider to check if it is touching collider2. + The collider to check if it is touching collider1. + + Whether collider1 is touching collider2 or not. + + + + + Checks whether the passed colliders are in contact or not. + + The collider to check if it is touching any other collider filtered by the contactFilter. + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + + Whether the collider is touching any other collider filtered by the contactFilter or not. + + + + + Checks whether the passed colliders are in contact or not. + + The collider to check if it is touching collider2. + The collider to check if it is touching collider1. + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + + Whether collider1 is touching collider2 or not. + + + + + Checks whether the collider is touching any colliders on the specified layerMask or not. + + The collider to check if it is touching colliders on the layerMask. + Any colliders on any of these layers count as touching. + + Whether the collider is touching any colliders on the specified layerMask or not. + + + + + Casts a line segment against colliders in the Scene. + + The start point of the line in world space. + The end point of the line in world space. + Filter to detect Colliders only on certain layers. + Only include objects with a Z coordinate (depth) greater than or equal to this value. + Only include objects with a Z coordinate (depth) less than or equal to this value. + + The cast results returned. + + + + + Casts a line segment against colliders in the Scene with results filtered by ContactFilter2D. + + The start point of the line in world space. + The end point of the line in world space. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + + Returns the number of results placed in the results array. + + + + + Casts a line against colliders in the Scene. + + The start point of the line in world space. + The end point of the line in world space. + Filter to detect Colliders only on certain layers. + Only include objects with a Z coordinate (depth) greater than or equal to this value. + Only include objects with a Z coordinate (depth) less than or equal to this value. + + The cast results returned. + + + + + Casts a line against colliders in the Scene. + + Only include objects with a Z coordinate (depth) greater than or equal to this value. + Only include objects with a Z coordinate (depth) less than or equal to this value. + The start point of the line in world space. + The end point of the line in world space. + Returned array of objects that intersect the line. + Filter to detect Colliders only on certain layers. + + Returns the number of results placed in the results array. + + + + + Checks if a collider falls within a rectangular area. + + One corner of the rectangle. + Diagonally opposite the point A corner of the rectangle. + Filter to check objects only on specific layers. + Only include objects with a Z coordinate (depth) greater than or equal to this value. + Only include objects with a Z coordinate (depth) less than or equal to this value. + + The collider overlapping the area. + + + + + Checks if a collider falls within a rectangular area. + + One corner of the rectangle. + Diagonally opposite the point A corner of the rectangle. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + The contact filter used to filter the results differently, such as by layer mask, Z depth. Note that normal angle is not used for overlap testing. + + Returns the number of results placed in the results array. + + + + + Get a list of all colliders that fall within a rectangular area. + + One corner of the rectangle. + Diagonally opposite the point A corner of the rectangle. + Filter to check objects only on specific layers. + Only include objects with a Z coordinate (depth) greater than or equal to this value. + Only include objects with a Z coordinate (depth) less than or equal to this value. + + The cast results returned. + + + + + Get a list of all colliders that fall within a specified area. + + One corner of the rectangle. + Diagonally opposite the point A corner of the rectangle. + Array to receive results. + Filter to check objects only on specified layers. + Only include objects with a Z coordinate (depth) greater than or equal to this value. + Only include objects with a Z coordinate (depth) less than or equal to this value. + + Returns the number of results placed in the results array. + + + + + Checks if a collider falls within a box area. + + Center of the box. + Size of the box. + Angle of the box. + Filter to check objects only on specific layers. + Only include objects with a Z coordinate (depth) greater than this value. + Only include objects with a Z coordinate (depth) less than this value. + + The collider overlapping the box. + + + + + Checks if a collider falls within a box area. + + Center of the box. + Size of the box. + Angle of the box. + The contact filter used to filter the results differently, such as by layer mask, Z depth. Note that normal angle is not used for overlap testing. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + + Returns the number of results placed in the results array. + + + + + Get a list of all colliders that fall within a box area. + + Center of the box. + Size of the box. + Angle of the box. + Filter to check objects only on specific layers. + Only include objects with a Z coordinate (depth) greater than this value. + Only include objects with a Z coordinate (depth) less than this value. + + The cast results returned. + + + + + Get a list of all colliders that fall within a box area. + + Center of the box. + Size of the box. + Angle of the box. + Array to receive results. + Filter to check objects only on specific layers. + Only include objects with a Z coordinate (depth) greater than this value. + Only include objects with a Z coordinate (depth) less than this value. + + Returns the number of results placed in the results array. + + + + + Checks if a collider falls within a capsule area. + + Center of the capsule. + Size of the capsule. + The direction of the capsule. + Angle of the capsule. + Filter to check objects only on specific layers. + Only include objects with a Z coordinate (depth) greater than this value. + Only include objects with a Z coordinate (depth) less than this value. + + The collider overlapping the capsule. + + + + + Checks if a collider falls within a capsule area. + + Center of the capsule. + Size of the capsule. + The direction of the capsule. + Angle of the capsule. + The contact filter used to filter the results differently, such as by layer mask, Z depth. Note that normal angle is not used for overlap testing. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + + Returns the number of results placed in the results array. + + + + + Get a list of all colliders that fall within a capsule area. + + Center of the capsule. + Size of the capsule. + The direction of the capsule. + Angle of the capsule. + Filter to check objects only on specific layers. + Only include objects with a Z coordinate (depth) greater than this value. + Only include objects with a Z coordinate (depth) less than this value. + + The cast results returned. + + + + + Get a list of all colliders that fall within a capsule area. + + Center of the capsule. + Size of the capsule. + The direction of the capsule. + Angle of the capsule. + Array to receive results. + Filter to check objects only on specific layers. + Only include objects with a Z coordinate (depth) greater than this value. + Only include objects with a Z coordinate (depth) less than this value. + + Returns the number of results placed in the results array. + + + + + Checks if a collider falls within a circular area. + + Centre of the circle. + Radius of the circle. + Filter to check objects only on specific layers. + Only include objects with a Z coordinate (depth) greater than or equal to this value. + Only include objects with a Z coordinate (depth) less than or equal to this value. + + The collider overlapping the circle. + + + + + Checks if a collider is within a circular area. + + Centre of the circle. + Radius of the circle. + The contact filter used to filter the results differently, such as by layer mask, Z depth. Note that normal angle is not used for overlap testing. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + + Returns the number of results placed in the results array. + + + + + Get a list of all colliders that fall within a circular area. + + Center of the circle. + Radius of the circle. + Filter to check objects only on specified layers. + Only include objects with a Z coordinate (depth) greater than or equal to this value. + Only include objects with a Z coordinate (depth) less than or equal to this value. + + The cast results. + + + + + Get a list of all colliders that fall within a circular area. + + Center of the circle. + Radius of the circle. + Array to receive results. + Filter to check objects only on specific layers. + Only include objects with a Z coordinate (depth) greater than or equal to this value. + Only include objects with a Z coordinate (depth) less than or equal to this value. + + Returns the number of results placed in the results array. + + + + + Get a list of all colliders that overlap collider. + + The collider that defines the area used to query for other collider overlaps. + The contact filter used to filter the results differently, such as by layer mask, Z depth. Note that normal angle is not used for overlap testing. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + + Returns the number of results placed in the results array. + + + + + Checks if a collider overlaps a point in space. + + A point in world space. + Filter to check objects only on specific layers. + Only include objects with a Z coordinate (depth) greater than or equal to this value. + Only include objects with a Z coordinate (depth) less than or equal to this value. + + The collider overlapping the point. + + + + + Checks if a collider overlaps a point in world space. + + A point in world space. + The contact filter used to filter the results differently, such as by layer mask, Z depth. Note that normal angle is not used for overlap testing. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + + Returns the number of results placed in the results array. + + + + + Get a list of all colliders that overlap a point in space. + + Only include objects with a Z coordinate (depth) greater than or equal to this value. + Only include objects with a Z coordinate (depth) less than or equal to this value. + A point in space. + Filter to check objects only on specific layers. + + The cast results returned. + + + + + Get a list of all colliders that overlap a point in space. + + Only include objects with a Z coordinate (depth) greater than or equal to this value. + Only include objects with a Z coordinate (depth) less than or equal to this value. + A point in space. + Array to receive results. + Filter to check objects only on specific layers. + + Returns the number of results placed in the results array. + + + + + Casts a ray against colliders in the Scene. + + The point in 2D space where the ray originates. + The vector representing the direction of the ray. + Maximum distance over which to cast the ray. + Filter to detect Colliders only on certain layers. + Only include objects with a Z coordinate (depth) greater than or equal to this value. + Only include objects with a Z coordinate (depth) less than or equal to this value. + + The cast results returned. + + + + + Casts a ray against colliders in the Scene. + + The point in 2D space where the ray originates. + The vector representing the direction of the ray. + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + Maximum distance over which to cast the ray. + + Returns the number of results placed in the results array. + + + + + Casts a ray against colliders in the Scene, returning all colliders that contact with it. + + The point in 2D space where the ray originates. + The vector representing the direction of the ray. + Maximum distance over which to cast the ray. + Filter to detect Colliders only on certain layers. + Only include objects with a Z coordinate (depth) greater than or equal to this value. + Only include objects with a Z coordinate (depth) less than or equal to this value. + + The cast results returned. + + + + + Casts a ray into the Scene. + + Only include objects with a Z coordinate (depth) greater than or equal to this value. + Only include objects with a Z coordinate (depth) less than or equal to this value. + The point in 2D space where the ray originates. + The vector representing the direction of the ray. + Array to receive results. + Maximum distance over which to cast the ray. + Filter to check objects only on specific layers. + + Returns the number of results placed in the results array. + + + + + Set the collision layer mask that indicates which layer(s) the specified layer can collide with. + + The layer to set the collision layer mask for. + A mask where each bit indicates a layer and whether it can collide with layer or not. + + + + Simulate physics in the Scene. + + The time to advance physics by. + + Whether the simulation was run or not. Running the simulation during physics callbacks will always fail. + + + + + Synchronizes. + + + + + A set of options that control how physics operates when using the job system to multithread the physics simulation. + + + + + Controls the minimum number of bodies to be cleared in each simulation job. + + + + + Controls the minimum number of flags to be cleared in each simulation job. + + + + + Controls the minimum number of contacts to collide in each simulation job. + + + + + Controls the minimum number of nearest contacts to find in each simulation job. + + + + + Controls the minimum number of Rigidbody2D being interpolated in each simulation job. + + + + + Controls the minimum number of bodies to solve in each simulation job when performing island solving. + + + + + Scales the cost of each body during discrete island solving. + + + + + Scales the cost of each contact during discrete island solving. + + + + + Controls the minimum number of contacts to solve in each simulation job when performing island solving. + + + + + The minimum threshold cost of all bodies, contacts and joints in an island during discrete island solving. + + + + + Scales the cost of each joint during discrete island solving. + + + + + Controls the minimum number of new contacts to find in each simulation job. + + + + + Controls the minimum number of fixtures to synchronize in the broadphase during continuous island solving in each simulation job. + + + + + Controls the minimum number of fixtures to synchronize in the broadphase during discrete island solving in each simulation job. + + + + + Controls the minimum number of trigger contacts to update in each simulation job. + + + + + Should physics simulation sort multi-threaded results to maintain processing order consistency? + + + + + Should physics simulation use multithreading? + + + + + Asset type that defines the surface properties of a Collider2D. + + + + + The degree of elasticity during collisions. + + + + + Coefficient of friction. + + + + + Represents a single instance of a 3D physics Scene. + + + + + Gets whether the physics Scene is empty or not. + + + Is the physics Scene is empty? + + + + + Gets whether the physics Scene is valid or not. + + + Is the physics scene valid? + + + + + Casts a ray, from point origin, in direction direction, of length maxDistance, against all colliders in the Scene. + + The starting point of the ray in world coordinates. + The direction of the ray. + The max distance the ray should check for collisions. + A that is used to selectively ignore Colliders when casting a ray. + Specifies whether this query should hit Triggers. + + True if the ray intersects with a Collider, otherwise false. + + + + + Casts a ray, from point origin, in direction direction, of length maxDistance, against all colliders in the Scene. + + The starting point of the ray in world coordinates. + The direction of the ray. + If true is returned, hitInfo will contain more information about where the collider was hit. (See Also: RaycastHit). + The max distance the ray should check for collisions. + A that is used to selectively ignore Colliders when casting a ray. + Specifies whether this query should hit Triggers. + + True if the ray intersects with a Collider, otherwise false. + + + + + Casts a ray, from point origin, in direction direction, of length maxDistance, against all colliders in the Scene. + + The starting point and direction of the ray. + The direction of the ray. + The buffer to store the hits into. + The max distance the rayhit is allowed to be from the start of the ray. + A that is used to selectively ignore colliders when casting a ray. + The amount of hits stored into the results buffer. + + True if the ray intersects with a Collider, otherwise false. + + + + + Simulate physics associated with this PhysicsScene. + + The time to advance physics by. + + Whether the simulation was run or not. Running the simulation during physics callbacks will always fail. + + + + + Represents a single instance of a 2D physics Scene. + + + + + Casts a box against colliders in the PhysicsScene2D, returning the first intersection only. + + The point in 2D space where the box originates. + The size of the box. + The angle of the box (in degrees). + Vector representing the direction to cast the box. + Maximum distance over which to cast the box. + Filter to detect colliders only on certain layers. + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + + The cast results returned. + + + + + Casts a box against colliders in the PhysicsScene2D, returning the first intersection only. + + The point in 2D space where the box originates. + The size of the box. + The angle of the box (in degrees). + Vector representing the direction to cast the box. + Maximum distance over which to cast the box. + Filter to detect colliders only on certain layers. + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + + The cast results returned. + + + + + Casts a box against the colliders in the PhysicsScene2D, returning all intersections. + + The point in 2D space where the box originates. + The size of the box. + The angle of the box (in degrees). + Vector representing the direction to cast the box. + Maximum distance over which to cast the box. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + Filter to detect colliders only on certain layers. + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + + Returns the number of results placed in the results array. + + + + + Casts a box against the colliders in the PhysicsScene2D, returning all intersections. + + The point in 2D space where the box originates. + The size of the box. + The angle of the box (in degrees). + Vector representing the direction to cast the box. + Maximum distance over which to cast the box. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + Filter to detect colliders only on certain layers. + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + + Returns the number of results placed in the results array. + + + + + Casts a capsule against colliders in the PhysicsScene2D, returning the first intersection only. + + The point in 2D space where the capsule originates. + The size of the capsule. + The direction of the capsule. + The angle of the capsule (in degrees). + Vector representing the direction to cast the capsule. + Maximum distance over which to cast the capsule. + Filter to detect collider only on certain layers. + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + + The cast results returned. + + + + + Casts a capsule against colliders in the PhysicsScene2D, returning the first intersection only. + + The point in 2D space where the capsule originates. + The size of the capsule. + The direction of the capsule. + The angle of the capsule (in degrees). + Vector representing the direction to cast the capsule. + Maximum distance over which to cast the capsule. + Filter to detect collider only on certain layers. + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + + The cast results returned. + + + + + Casts a capsule against the colliders in the PhysicsScene2D, returning all intersections. + + The point in 2D space where the capsule originates. + The size of the capsule. + The direction of the capsule. + The angle of the capsule (in degrees). + Vector representing the direction to cast the capsule. + Maximum distance over which to cast the capsule. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + Filter to detect collider only on certain layers. + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + + Returns the number of results placed in the results array. + + + + + Casts a capsule against the colliders in the PhysicsScene2D, returning all intersections. + + The point in 2D space where the capsule originates. + The size of the capsule. + The direction of the capsule. + The angle of the capsule (in degrees). + Vector representing the direction to cast the capsule. + Maximum distance over which to cast the capsule. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + Filter to detect collider only on certain layers. + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + + Returns the number of results placed in the results array. + + + + + Casts a circle against colliders in the PhysicsScene2D, returning the first intersection only. + + The point in 2D space where the circle originates. + The radius of the circle. + Vector representing the direction to cast the circle. + Maximum distance over which to cast the circle. + Filter to detect collider only on certain layers. + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + + The cast results returned. + + + + + Casts a circle against colliders in the PhysicsScene2D, returning the first intersection only. + + The point in 2D space where the circle originates. + The radius of the circle. + Vector representing the direction to cast the circle. + Maximum distance over which to cast the circle. + Filter to detect collider only on certain layers. + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + + The cast results returned. + + + + + Casts a circle against the colliders in the PhysicsScene2D, returning all intersections. + + The point in 2D space where the circle originates. + The radius of the circle. + Vector representing the direction to cast the circle. + Maximum distance over which to cast the circle. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + Filter to detect collider only on certain layers. + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + + Returns the number of results placed in the results array. + + + + + Casts a circle against the colliders in the PhysicsScene2D, returning all intersections. + + The point in 2D space where the circle originates. + The radius of the circle. + Vector representing the direction to cast the circle. + Maximum distance over which to cast the circle. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + Filter to detect collider only on certain layers. + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + + Returns the number of results placed in the results array. + + + + + Cast a 3D ray against the colliders in the PhysicsScene2D, returning the first intersection only. + + The 3D ray defining origin and direction to test. + Maximum distance over which to cast the ray. + Filter to detect colliders only on certain layers. + + The cast results returned. + + + + + Cast a 3D ray against the colliders in the PhysicsScene2D, returning all intersections. + + The 3D ray defining origin and direction to test. + Maximum distance over which to cast the ray. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + Filter to detect colliders only on certain layers. + + The number of results returned. + + + + + Determines whether the physics Scene is empty or not. + + + True when the physics Scene is empty. + + + + + Determines whether the physics Scene is valid or not. + + + True when the physics Scene valid. + + + + + Casts a line segment against colliders in the PhysicsScene2D, returning the first intersection only. + + The start point of the line in world space. + The end point of the line in world space. + Filter to detect collider only on certain layers. + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + + The cast results returned. + + + + + Casts a line segment against colliders in the PhysicsScene2D, returning the first intersection only. + + The start point of the line in world space. + The end point of the line in world space. + Filter to detect collider only on certain layers. + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + + The cast results returned. + + + + + Casts a line segment against colliders in the PhysicsScene2D. + + The start point of the line in world space. + The end point of the line in world space. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + Filter to detect collider only on certain layers. + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + + Returns the number of results placed in the results array. + + + + + Casts a line segment against colliders in the PhysicsScene2D. + + The start point of the line in world space. + The end point of the line in world space. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + Filter to detect collider only on certain layers. + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + + Returns the number of results placed in the results array. + + + + + Checks an area (non-rotated box) against colliders in the PhysicsScene2D, returning the first intersection only. + + One corner of the rectangle. + The corner of the rectangle diagonally opposite the pointA corner. + Filter to check objects only on specific layers. + The contact filter used to filter the results differently, such as by layer mask and Z depth. Note that the normal angle is not used for overlap testing. + + The collider overlapping the area. + + + + + Checks an area (non-rotated box) against colliders in the PhysicsScene2D, returning the first intersection only. + + One corner of the rectangle. + The corner of the rectangle diagonally opposite the pointA corner. + Filter to check objects only on specific layers. + The contact filter used to filter the results differently, such as by layer mask and Z depth. Note that the normal angle is not used for overlap testing. + + The collider overlapping the area. + + + + + Checks an area (non-rotated box) against colliders in the PhysicsScene2D, returning all intersections. + + One corner of the rectangle. + The corner of the rectangle diagonally opposite the pointA corner. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + Filter to check objects only on specific layers. + The contact filter used to filter the results differently, such as by layer mask and Z depth. Note that the normal angle is not used for overlap testing. + + Returns the number of results placed in the results array. + + + + + Checks an area (non-rotated box) against colliders in the PhysicsScene2D, returning all intersections. + + One corner of the rectangle. + The corner of the rectangle diagonally opposite the pointA corner. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + Filter to check objects only on specific layers. + The contact filter used to filter the results differently, such as by layer mask and Z depth. Note that the normal angle is not used for overlap testing. + + Returns the number of results placed in the results array. + + + + + Checks a box against colliders in the PhysicsScene2D, returning the first intersection only. + + Center of the box. + Size of the box. + Angle of the box. + Filter to check objects only on specific layers. + The contact filter used to filter the results differently, such as by layer mask and Z depth. Note that the normal angle is not used for overlap testing. + + The collider overlapping the box. + + + + + Checks a box against colliders in the PhysicsScene2D, returning the first intersection only. + + Center of the box. + Size of the box. + Angle of the box. + Filter to check objects only on specific layers. + The contact filter used to filter the results differently, such as by layer mask and Z depth. Note that the normal angle is not used for overlap testing. + + The collider overlapping the box. + + + + + Checks a box against colliders in the PhysicsScene2D, returning all intersections. + + Center of the box. + Size of the box. + Angle of the box. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + Filter to check objects only on specific layers. + The contact filter used to filter the results differently, such as by layer mask and Z depth. Note that the normal angle is not used for overlap testing. + + Returns the number of results placed in the results array. + + + + + Checks a box against colliders in the PhysicsScene2D, returning all intersections. + + Center of the box. + Size of the box. + Angle of the box. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + Filter to check objects only on specific layers. + The contact filter used to filter the results differently, such as by layer mask and Z depth. Note that the normal angle is not used for overlap testing. + + Returns the number of results placed in the results array. + + + + + Checks a capsule against colliders in the PhysicsScene2D, returning the first intersection only. + + Center of the capsule. + Size of the capsule. + The direction of the capsule. + Angle of the capsule. + Filter to check objects only on specific layers. + The contact filter used to filter the results differently, such as by layer mask and Z depth. Note that the normal angle is not used for overlap testing. + + The collider overlapping the capsule. + + + + + Checks a capsule against colliders in the PhysicsScene2D, returning the first intersection only. + + Center of the capsule. + Size of the capsule. + The direction of the capsule. + Angle of the capsule. + Filter to check objects only on specific layers. + The contact filter used to filter the results differently, such as by layer mask and Z depth. Note that the normal angle is not used for overlap testing. + + The collider overlapping the capsule. + + + + + Checks a capsule against colliders in the PhysicsScene2D, returning all intersections. + + Center of the capsule. + Size of the capsule. + The direction of the capsule. + Angle of the capsule. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + Filter to check objects only on specific layers. + The contact filter used to filter the results differently, such as by layer mask and Z depth. Note that the normal angle is not used for overlap testing. + + Returns the number of results placed in the results array. + + + + + Checks a capsule against colliders in the PhysicsScene2D, returning all intersections. + + Center of the capsule. + Size of the capsule. + The direction of the capsule. + Angle of the capsule. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + Filter to check objects only on specific layers. + The contact filter used to filter the results differently, such as by layer mask and Z depth. Note that the normal angle is not used for overlap testing. + + Returns the number of results placed in the results array. + + + + + Checks a circle against colliders in the PhysicsScene2D, returning the first intersection only. + + Centre of the circle. + Radius of the circle. + Filter to check objects only on specific layers. + The contact filter used to filter the results differently, such as by layer mask and Z depth. Note that the normal angle is not used for overlap testing. + + The collider overlapping the circle. + + + + + Checks a circle against colliders in the PhysicsScene2D, returning the first intersection only. + + Centre of the circle. + Radius of the circle. + Filter to check objects only on specific layers. + The contact filter used to filter the results differently, such as by layer mask and Z depth. Note that the normal angle is not used for overlap testing. + + The collider overlapping the circle. + + + + + Checks a circle against colliders in the PhysicsScene2D, returning all intersections. + + Centre of the circle. + Radius of the circle. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + Filter to check objects only on specific layers. + The contact filter used to filter the results differently, such as by layer mask and Z depth. Note that the normal angle is not used for overlap testing. + + Returns the number of results placed in the results array. + + + + + Checks a circle against colliders in the PhysicsScene2D, returning all intersections. + + Centre of the circle. + Radius of the circle. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + Filter to check objects only on specific layers. + The contact filter used to filter the results differently, such as by layer mask and Z depth. Note that the normal angle is not used for overlap testing. + + Returns the number of results placed in the results array. + + + + + Checks a collider against colliders in the PhysicsScene2D, returning all intersections. + + The collider that defines the area used to query for other collider overlaps. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + Filter to check objects only on specific layers. + The contact filter used to filter the results differently, such as by layer mask and Z depth. Note that the normal angle is not used for overlap testing. + + The collider overlapping the collider. + + + + + Checks a collider against colliders in the PhysicsScene2D, returning all intersections. + + The collider that defines the area used to query for other collider overlaps. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + Filter to check objects only on specific layers. + The contact filter used to filter the results differently, such as by layer mask and Z depth. Note that the normal angle is not used for overlap testing. + + The collider overlapping the collider. + + + + + Checks a point against colliders in the PhysicsScene2D, returning the first intersection only. + + A point in world space. + Filter to check objects only on specific layers. + The contact filter used to filter the results differently, such as by layer mask and Z depth. Note that the normal angle is not used for overlap testing. + + The collider overlapping the point. + + + + + Checks a point against colliders in the PhysicsScene2D, returning the first intersection only. + + A point in world space. + Filter to check objects only on specific layers. + The contact filter used to filter the results differently, such as by layer mask and Z depth. Note that the normal angle is not used for overlap testing. + + The collider overlapping the point. + + + + + Checks a point against colliders in the PhysicsScene2D, returning all intersections. + + A point in world space. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + Filter to check objects only on specific layers. + The contact filter used to filter the results differently, such as by layer mask and Z depth. Note that the normal angle is not used for overlap testing. + + Returns the number of results placed in the results array. + + + + + Checks a point against colliders in the PhysicsScene2D, returning all intersections. + + A point in world space. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + Filter to check objects only on specific layers. + The contact filter used to filter the results differently, such as by layer mask and Z depth. Note that the normal angle is not used for overlap testing. + + Returns the number of results placed in the results array. + + + + + Casts a ray against colliders in the PhysicsScene2D, returning the first intersection only. + + The point in 2D space where the ray originates. + The vector representing the direction of the ray. + Maximum distance over which to cast the ray. + Filter to detect collider only on certain layers. + The contact filter used to filter the results differently, such as by layer mask and Z depth, or normal angle. + + The cast results returned. + + + + + Casts a ray against colliders in the PhysicsScene2D, returning the first intersection only. + + The point in 2D space where the ray originates. + The vector representing the direction of the ray. + Maximum distance over which to cast the ray. + Filter to detect collider only on certain layers. + The contact filter used to filter the results differently, such as by layer mask and Z depth, or normal angle. + + The cast results returned. + + + + + Casts a ray against colliders the PhysicsScene2D, returning all intersections. + + The point in 2D space where the ray originates. + The vector representing the direction of the ray. + Maximum distance over which to cast the ray. + Filter to detect collider only on certain layers. + The contact filter used to filter the results differently, such as by layer mask and Z depth, or normal angle. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + + Returns the number of results placed in the results array. + + + + + Casts a ray against colliders the PhysicsScene2D, returning all intersections. + + The point in 2D space where the ray originates. + The vector representing the direction of the ray. + Maximum distance over which to cast the ray. + Filter to detect collider only on certain layers. + The contact filter used to filter the results differently, such as by layer mask and Z depth, or normal angle. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + + Returns the number of results placed in the results array. + + + + + Simulate physics associated with this PhysicsScene. + + The time to advance physics by. + + Whether the simulation was run or not. Running the simulation during physics callbacks will always fail. + + + + + Scene extensions to access the underlying physics scene. + + + + + An extension method that returns the 3D physics Scene from the Scene. + + The Scene from which to return the 3D physics Scene. + + The 3D physics Scene used by the Scene. + + + + + Scene extensions to access the underlying physics scene. + + + + + An extension method that returns the 2D physics Scene from the Scene. + + The Scene from which to return the 2D physics Scene. + + The 2D physics Scene used by the Scene. + + + + + A base type for 2D physics components that required a callback during FixedUpdate. + + + + + Ping any given IP address (given in dot notation). + + + + + The IP target of the ping. + + + + + Has the ping function completed? + + + + + This property contains the ping time result after isDone returns true. + + + + + Perform a ping to the supplied target IP address. + + + + + + Representation of a plane in 3D space. + + + + + Distance from the origin to the plane. + + + + + Returns a copy of the plane that faces in the opposite direction. + + + + + Normal vector of the plane. + + + + + For a given point returns the closest point on the plane. + + The point to project onto the plane. + + A point on the plane that is closest to point. + + + + + Creates a plane. + + + + + + + Creates a plane. + + + + + + + Creates a plane. + + + + + + + + Makes the plane face in the opposite direction. + + + + + Returns a signed distance from plane to point. + + + + + + Is a point on the positive side of the plane? + + + + + + Intersects a ray with the plane. + + + + + + + Are two points on the same side of the plane? + + + + + + + Sets a plane using three points that lie within it. The points go around clockwise as you look down on the top surface of the plane. + + First point in clockwise order. + Second point in clockwise order. + Third point in clockwise order. + + + + Sets a plane using a point that lies within it along with a normal to orient it. + + The plane's normal vector. + A point that lies on the plane. + + + + Returns a copy of the given plane that is moved in space by the given translation. + + The plane to move in space. + The offset in space to move the plane with. + + The translated plane. + + + + + Moves the plane in space by the translation vector. + + The offset in space to move the plane with. + + + + Applies "platform" behaviour such as one-way collisions etc. + + + + + Whether to use one-way collision behaviour or not. + + + + + The rotational offset angle from the local 'up'. + + + + + The angle variance centered on the sides of the platform. Zero angle only matches sides 90-degree to the platform "top". + + + + + The angle of an arc that defines the sides of the platform centered on the local 'left' and 'right' of the effector. Any collision normals within this arc are considered for the 'side' behaviours. + + + + + Whether bounce should be used on the platform sides or not. + + + + + Whether friction should be used on the platform sides or not. + + + + + The angle of an arc that defines the surface of the platform centered of the local 'up' of the effector. + + + + + Should the one-way collision behaviour be used? + + + + + Ensures that all contacts controlled by the one-way behaviour act the same. + + + + + Should bounce be used on the platform sides? + + + + + Should friction be used on the platform sides? + + + + + Implements high-level utility methods to simplify use of the Playable API with Animations. + + + + + Plays the Playable on the given Animator. + + Target Animator. + The Playable that will be played. + The Graph that owns the Playable. + + + + Creates a PlayableGraph to be played on the given Animator. An AnimatorControllerPlayable is also created for the given RuntimeAnimatorController. + + Target Animator. + The RuntimeAnimatorController to create an AnimatorControllerPlayable for. + The created PlayableGraph. + + A handle to the newly-created AnimatorControllerPlayable. + + + + + Creates a PlayableGraph to be played on the given Animator. An AnimationClipPlayable is also created for the given AnimationClip. + + Target Animator. + The AnimationClip to create an AnimationClipPlayable for. + The created PlayableGraph. + + A handle to the newly-created AnimationClipPlayable. + + + + + Creates a PlayableGraph to be played on the given Animator. An AnimationLayerMixerPlayable is also created. + + Target Animator. + The input count for the AnimationLayerMixerPlayable. Defines the number of layers. + The created PlayableGraph. + + A handle to the newly-created AnimationLayerMixerPlayable. + + + + + Creates a PlayableGraph to be played on the given Animator. An AnimationMixerPlayable is also created. + + Target Animator. + The input count for the AnimationMixerPlayable. + The created PlayableGraph. + + A handle to the newly-created AnimationMixerPlayable. + + + + + Describes the type of information that flows in and out of a Playable. This also specifies that this Playable is connectable to others of the same type. + + + + + Describes that the information flowing in and out of the Playable is of Animation type. + + + + + Describes that the information flowing in and out of the Playable is of Audio type. + + + + + Describes that the Playable does not have any particular type. This is use for Playables that execute script code, or that create their own playable graphs, such as the Sequence. + + + + + Describes that the information flowing in and out of the Playable is of type Texture. + + + + + Defines what time source is used to update a Director graph. + + + + + Update is based on DSP (Digital Sound Processing) clock. Use this for graphs that need to be synchronized with Audio. + + + + + Update is based on Time.time. Use this for graphs that need to be synchronized on gameplay, and that need to be paused when the game is paused. + + + + + Update mode is manual. You need to manually call PlayableGraph.Evaluate with your own deltaTime. This can be useful for graphs that are completely disconnected from the rest of the game. For example, localized bullet time. + + + + + Update is based on Time.unscaledTime. Use this for graphs that need to be updated even when gameplay is paused. Example: Menus transitions need to be updated even when the game is paused. + + + + + Wrap mode for Playables. + + + + + Hold the last frame when the playable time reaches it's duration. + + + + + Loop back to zero time and continue playing. + + + + + Do not keep playing when the time reaches the duration. + + + + + This structure contains the frame information a Playable receives in Playable.PrepareFrame. + + + + + Time difference between this frame and the preceding frame. + + + + + The accumulated delay of the parent Playable during the PlayableGraph traversal. + + + + + The accumulated speed of the parent Playable during the PlayableGraph traversal. + + + + + The accumulated play state of this playable. + + + + + The accumulated speed of the Playable during the PlayableGraph traversal. + + + + + The accumulated weight of the Playable during the PlayableGraph traversal. + + + + + Indicates the type of evaluation that caused PlayableGraph.PrepareFrame to be called. + + + + + The current frame identifier. + + + + + The PlayableOutput that initiated this graph traversal. + + + + + Indicates that the local time was explicitly set. + + + + + Indicates the local time did not advance because it has reached the duration and the extrapolation mode is set to Hold. + + + + + Indicates the local time wrapped because it has reached the duration and the extrapolation mode is set to Loop. + + + + + The weight of the current Playable. + + + + + Describes the cause for the evaluation of a PlayableGraph. + + + + + Indicates the graph was updated due to a call to PlayableGraph.Evaluate. + + + + + Indicates the graph was called by the runtime during normal playback due to PlayableGraph.Play being called. + + + + + The base interface for all notifications sent through the playable system. + + + + + The identifier is a name that identifies this notifications, or class of notifications. + + + + + Implement this interface to create a class that will receives notifications from PlayableOutput. + + + + + The method called when a notification is raised. + + The playable that sent the notification. + The received notification. + User defined data that depends on the type of notification. Uses this to pass necessary information that can change with each invocation. + + + + Interface implemented by all C# Playable implementations. + + + + + Interface that permits a class to inject playables into a graph. + + + + + Duration in seconds. + + + + + A description of the PlayableOutputs generated by this asset. + + + + + Implement this method to have your asset inject playables into the given graph. + + The graph to inject playables into. + The game object which initiated the build. + + The playable injected into the graph, or the root playable if multiple playables are injected. + + + + + Interface implemented by all C# Playable Behaviour implementations. + + + + + Interface implemented by all C# Playable output implementations. + + + + + Default implementation for Playable notifications. + + + + + The name that identifies this notification. + + + + + Creates a new notification with the name specified in the argument. + + The name that identifies this notifications. + + + + Playables are customizable runtime objects that can be connected together and are contained in a PlayableGraph to create complex behaviours. + + + + + Returns an invalid Playable. + + + + + A base class for assets that can be used to instantiate a Playable at runtime. + + + + + The playback duration in seconds of the instantiated Playable. + + + + + A description of the outputs of the instantiated Playable. + + + + + Implement this method to have your asset inject playables into the given graph. + + The graph to inject playables into. + The game object which initiated the build. + + The playable injected into the graph, or the root playable if multiple playables are injected. + + + + + PlayableBehaviour is the base class from which every custom playable script derives. + + + + + This function is called when the Playable play state is changed to Playables.PlayState.Delayed. + + The Playable that owns the current PlayableBehaviour. + A FrameData structure that contains information about the current frame context. + + + + This method is invoked when one of the following situations occurs: +<br><br> + The effective play state during traversal is changed to Playables.PlayState.Paused. This state is indicated by FrameData.effectivePlayState.<br><br> + The PlayableGraph is stopped while the playable play state is Playing. This state is indicated by PlayableGraph.IsPlaying returning true. + + The Playable that owns the current PlayableBehaviour. + A FrameData structure that contains information about the current frame context. + + + + This function is called when the Playable play state is changed to Playables.PlayState.Playing. + + The Playable that owns the current PlayableBehaviour. + A FrameData structure that contains information about the current frame context. + + + + This function is called when the PlayableGraph that owns this PlayableBehaviour starts. + + The Playable that owns the current PlayableBehaviour. + + + + This function is called when the PlayableGraph that owns this PlayableBehaviour stops. + + The Playable that owns the current PlayableBehaviour. + + + + This function is called when the Playable that owns the PlayableBehaviour is created. + + The Playable that owns the current PlayableBehaviour. + + + + This function is called when the Playable that owns the PlayableBehaviour is destroyed. + + The Playable that owns the current PlayableBehaviour. + + + + This function is called during the PrepareData phase of the PlayableGraph. + + The Playable that owns the current PlayableBehaviour. + A FrameData structure that contains information about the current frame context. + + + + This function is called during the PrepareFrame phase of the PlayableGraph. + + The Playable that owns the current PlayableBehaviour. + A FrameData structure that contains information about the current frame context. + + + + This function is called during the ProcessFrame phase of the PlayableGraph. + + The Playable that owns the current PlayableBehaviour. + A FrameData structure that contains information about the current frame context. + The user data of the ScriptPlayableOutput that initiated the process pass. + + + + Struct that holds information regarding an output of a PlayableAsset. + + + + + The type of target required by the PlayableOutput for this PlayableBinding. + + + + + A reference to a UnityEngine.Object that acts a key for this binding. + + + + + The name of the output or input stream. + + + + + The type of the output or input stream. + + + + + The default duration used when a PlayableOutput has no fixed duration. + + + + + A constant to represent a PlayableAsset has no bindings. + + + + + Instantiates a PlayableAsset and controls playback of Playable objects. + + + + + The duration of the Playable in seconds. + + + + + Controls how the time is incremented when it goes beyond the duration of the playable. + + + + + The time at which the Playable should start when first played. + + + + + Event that is raised when a PlayableDirector component has paused. + + + + + + The PlayableAsset that is used to instantiate a playable for playback. + + + + + The PlayableGraph created by the PlayableDirector. + + + + + Event that is raised when a PlayableDirector component has begun playing. + + + + + + Whether the playable asset will start playing back as soon as the component awakes. + + + + + The current playing state of the component. (Read Only) + + + + + Event that is raised when a PlayableDirector component has stopped. + + + + + + The component's current time. This value is incremented according to the PlayableDirector.timeUpdateMode when it is playing. You can also change this value manually. + + + + + Controls how time is incremented when playing back. + + + + + Clears the binding of a reference object. + + The source object in the PlayableBinding. + + + + Clears an exposed reference value. + + Identifier of the ExposedReference. + + + + Tells the PlayableDirector to evaluate it's PlayableGraph on the next update. + + + + + Evaluates the currently playing Playable at the current time. + + + + + Returns a binding to a reference object. + + The object that acts as a key. + + + + Retreives an ExposedReference binding. + + Identifier of the ExposedReference. + Whether the reference was found. + + + + Pauses playback of the currently running playable. + + + + + Instatiates a Playable using the provided PlayableAsset and starts playback. + + An asset to instantiate a playable from. + What to do when the time passes the duration of the playable. + + + + Instatiates a Playable using the provided PlayableAsset and starts playback. + + An asset to instantiate a playable from. + What to do when the time passes the duration of the playable. + + + + Instatiates a Playable using the provided PlayableAsset and starts playback. + + An asset to instantiate a playable from. + What to do when the time passes the duration of the playable. + + + + Rebinds each PlayableOutput of the PlayableGraph. + + + + + Discards the existing PlayableGraph and creates a new instance. + + + + + Resume playing a paused playable. + + + + + Sets the binding of a reference object from a PlayableBinding. + + The source object in the PlayableBinding. + The object to bind to the key. + + + + Sets an ExposedReference value. + + Identifier of the ExposedReference. + The object to bind to set the reference value to. + + + + Stops playback of the current Playable and destroys the corresponding graph. + + + + + Extensions for all the types that implements IPlayable. + + + + + Create a new input port and connect it to the output port of the given Playable. + + The Playable used by this operation. + The Playable to connect to. + The output port of the Playable. + The weight of the created input port. + + The index of the newly created input port. + + + + + Connect the output port of a Playable to one of the input ports. + + The Playable used by this operation. + The input port index. + The Playable to connect to. + The output port of the Playable. + The weight of the input port. + + + + Destroys the current Playable. + + The Playable used by this operation. + + + + Disconnect the input port of a Playable. + + The Playable used by this operation. + The input port index. + + + + Returns the delay of the playable. + + The Playable used by this operation. + + The delay in seconds. + + + + + Returns the duration of the Playable. + + The Playable used by this operation. + + The duration in seconds. + + + + + Returns the PlayableGraph that owns this Playable. A Playable can only be used in the graph that was used to create it. + + The Playable used by this operation. + + The PlayableGraph associated with the current Playable. + + + + + Returns the Playable connected at the given input port index. + + The Playable used by this operation. + The port index. + + Playable connected at the index specified, or null if the index is valid but is not connected to anything. This happens if there was once a Playable connected at the index, but was disconnected via PlayableGraph.Disconnect. + + + + + Returns the number of inputs supported by the Playable. + + The Playable used by this operation. + + The count of inputs on the Playable. + + + + + Returns the weight of the Playable connected at the given input port index. + + The Playable used by this operation. + The port index. + + The current weight of the connected Playable. + + + + + Returns the Playable lead time in seconds. + + The Playable used by this operation. + + + + Returns the Playable connected at the given output port index. + + The Playable used by this operation. + The port index. + + Playable connected at the output index specified, or null if the index is valid but is not connected to anything. This happens if there was once a Playable connected at the index, but was disconnected via PlayableGraph.Disconnect. + + + + + Returns the number of outputs supported by the Playable. + + The Playable used by this operation. + + The count of outputs on the Playable. + + + + + Returns the current PlayState of the Playable. + + The Playable used by this operation. + + The current PlayState of the Playable. + + + + + Returns the previous local time of the Playable. + + The Playable used by this operation. + + The previous time in seconds. + + + + + Returns the time propagation behavior of this Playable. + + The Playable used by this operation. + + True if time propagation is enabled. + + + + + Returns the speed multiplier that is applied to the the current Playable. + + The Playable used by this operation. + + The current speed. + + + + + Returns the current local time of the Playable. + + The Playable used by this operation. + + The current time in seconds. + + + + + Returns the propagation mode for the multi-output playable. + + + + Traversal mode (Mix or Passthrough). + + + + + Returns whether or not the Playable has a delay. + + The Playable used by this operation. + + True if the playable is delayed, false otherwise. + + + + + Returns a flag indicating that a playable has completed its operation. + + The Playable used by this operation. + + True if the playable has completed its operation, false otherwise. + + + + + Returns true if the Playable is null, false otherwise. + + The Playable used by this operation. + + + + Returns the vality of the current Playable. + + The Playable used by this operation. + + True if the Playable is properly constructed by the PlayableGraph and has not been destroyed, false otherwise. + + + + + Tells to pause the Playable. + + The Playable used by this operation. + + + + Starts to play the Playable. + + The Playable used by this operation. + + + + Set a delay until the playable starts. + + The Playable used by this operation. + The delay in seconds. + + + + Changes a flag indicating that a playable has completed its operation. + + The Playable used by this operation. + True if the operation is completed, false otherwise. + + + + Changes the duration of the Playable. + + The Playable used by this operation. + The new duration in seconds, must be a positive value. + + + + Changes the number of inputs supported by the Playable. + + The Playable used by this operation. + + + + + Changes the weight of the Playable connected to the current Playable. + + The Playable used by this operation. + The connected Playable to change. + The weight. Should be between 0 and 1. + + + + + Changes the weight of the Playable connected to the current Playable. + + The Playable used by this operation. + The connected Playable to change. + The weight. Should be between 0 and 1. + + + + + Sets the Playable lead time in seconds. + + The Playable used by this operation. + The new lead time in seconds. + + + + Changes the number of outputs supported by the Playable. + + The Playable used by this operation. + + + + + Changes the current PlayState of the Playable. + + The Playable used by this operation. + The new PlayState. + + + + Changes the time propagation behavior of this Playable. + + The Playable used by this operation. + True to enable time propagation. + + + + Changes the speed multiplier that is applied to the the current Playable. + + The Playable used by this operation. + The new speed. + + + + Changes the current local time of the Playable. + + The Playable used by this operation. + The current time in seconds. + + + + Sets the propagation mode of PrepareFrame and ProcessFrame for the multi-output playable. + + The Playable used by this operation. + The new traversal mode. + + + + Use the PlayableGraph to manage Playable creations and destructions. + + + + + Connects two Playable instances. + + The source playable or its handle. + The port used in the source playable. + The destination playable or its handle. + The port used in the destination playable. + + Returns true if connection is successful. + + + + + Creates a PlayableGraph. + + The name of the graph. + + The newly created PlayableGraph. + + + + + Creates a PlayableGraph. + + The name of the graph. + + The newly created PlayableGraph. + + + + + Destroys the graph. + + + + + Destroys the PlayableOutput. + + The output to destroy. + + + + Destroys the Playable. + + The playable to destroy. + + + + Destroys the Playable and all its inputs, recursively. + + The Playable to destroy. + + + + Disconnects the Playable. The connections determine the topology of the PlayableGraph and how it is evaluated. + + The source playabe or its handle. + The port used in the source playable. + + + + Evaluates all the PlayableOutputs in the graph, and updates all the connected Playables in the graph. + + The time in seconds by which to advance each Playable in the graph. + + + + Evaluates all the PlayableOutputs in the graph, and updates all the connected Playables in the graph. + + The time in seconds by which to advance each Playable in the graph. + + + + Returns the name of the PlayableGraph. + + + + + Get PlayableOutput at the given index in the graph. + + The output index. + + The PlayableOutput at this given index, otherwise null. + + + + + Get PlayableOutput of the requested type at the given index in the graph. + + The output index. + + The PlayableOutput at the given index among all the PlayableOutput of the same type T. + + + + + Returns the number of PlayableOutput in the graph. + + + The number of PlayableOutput in the graph. + + + + + Get the number of PlayableOutput of the requested type in the graph. + + + The number of PlayableOutput of the same type T in the graph. + + + + + Returns the number of Playable owned by the Graph. + + + + + Returns the table used by the graph to resolve ExposedReferences. + + + + + Returns the Playable with no output connections at the given index. + + The index of the root Playable. + + + + Returns the number of Playable owned by the Graph that have no connected outputs. + + + + + Returns how time is incremented when playing back. + + + + + Indicates that a graph has completed its operations. + + + A boolean indicating if the graph is done playing or not. + + + + + Indicates that a graph is presently running. + + + A boolean indicating if the graph is playing or not. + + + + + Returns true if the PlayableGraph has been properly constructed using PlayableGraph.CreateGraph and is not deleted. + + + A boolean indicating if the graph is invalid or not. + + + + + Plays the graph. + + + + + Changes the table used by the graph to resolve ExposedReferences. + + + + + + Changes how time is incremented when playing back. + + The new DirectorUpdateMode. + + + + Stops the graph, if it is playing. + + + + + See: Playables.IPlayableOutput. + + + + + Returns an invalid PlayableOutput. + + + + + Extensions for all the types that implements IPlayableOutput. + + + + + Registers a new receiver that listens for notifications. + + The target output. + The receiver to register. + + + + Retrieves the list of notification receivers currently registered on the output. + + The output holding the receivers. + + Returns the list of registered receivers. + + + + + Returns the source playable's output connection index. + + The PlayableOutput used by this operation. + + The output port. + + + + + Returns the source playable. + + The PlayableOutput used by this operation. + + The source playable. + + + + + Returns the opaque user data. This is the same value as the last last argument of ProcessFrame. + + The PlayableOutput used by this operation. + + The user data. + + + + + Returns the weight of the connection from the PlayableOutput to the source playable. + + The PlayableOutput used by this operation. + + The weight of the connection to the source playable. + + + + + Returns true if the PlayableOutput is null, false otherwise. + + The PlayableOutput used by this operation. + + + + + + The PlayableOutput used by this operation. + + True if the PlayableOutput has not yet been destroyed and false otherwise. + + + + + Queues a notification to be sent through the Playable system. + + The output sending the notification. + The originating playable of the notification. + The notification to be sent. + Extra information about the state when the notification was fired. + + + + Unregisters a receiver on the output. + + The target output. + The receiver to unregister. + + + + Sets the bound object to a new value. Used to associate an output to an object (Track asset in case of Timeline). + + The PlayableOutput used by this operation. + The new reference object value. + + + + Sets the source playable's output connection index. For playables with multiple outputs, this determines which sub-branch of the source playable generates this output. + + The PlayableOutput used by this operation. + The new output port value. + + + + Sets which playable that computes the output and which sub-tree index. + + The PlayableOutput used by this operation. + The new source Playable. + The new output port value. + + + + Sets which playable that computes the output. + + The PlayableOutput used by this operation. + The new source Playable. + + + + Sets the opaque user data. This same data is passed as the last argument to ProcessFrame. + + The PlayableOutput used by this operation. + The new user data. + + + + Sets the weight of the connection from the PlayableOutput to the source playable. + + The PlayableOutput used by this operation. + The new weight. + + + + Traversal mode for Playables. + + + + + Causes the Playable to prepare and process it's inputs when demanded by an output. + + + + + Causes the Playable to act as a passthrough for PrepareFrame and ProcessFrame. If the PlayableOutput being processed is connected to the n-th input port of the Playable, the Playable only propagates the n-th output port. Use this enum value in conjunction with PlayableOutput SetSourceOutputPort. + + + + + Status of a Playable. + + + + + The Playable has been delayed, using PlayableExtensions.SetDelay. It will not start until the delay is entirely consumed. + + + + + The Playable has been paused. Its local time will not advance. + + + + + The Playable is currently Playing. + + + + + A IPlayable implementation that contains a PlayableBehaviour for the PlayableGraph. PlayableBehaviour can be used to write custom Playable that implement their own PrepareFrame callback. + + + + + A PlayableBinding that contains information representing a ScriptingPlayableOutput. + + + + + Creates a PlayableBinding that contains information representing a ScriptPlayableOutput. + + A reference to a UnityEngine.Object that acts as a key for this binding. + The type of object that will be bound to the ScriptPlayableOutput. + The name of the ScriptPlayableOutput. + + Returns a PlayableBinding that contains information that is used to create a ScriptPlayableOutput. + + + + + A IPlayableOutput implementation that contains a script output for the a PlayableGraph. + + + + + Creates a new ScriptPlayableOutput in the associated PlayableGraph. + + The PlayableGraph that will contain the ScriptPlayableOutput. + The name of this ScriptPlayableOutput. + + The created ScriptPlayableOutput. + + + + + Returns an invalid ScriptPlayableOutput. + + + + + Stores and accesses player preferences between game sessions. + + + + + Removes all keys and values from the preferences. Use with caution. + + + + + Removes key and its corresponding value from the preferences. + + + + + + Returns the value corresponding to key in the preference file if it exists. + + + + + + + Returns the value corresponding to key in the preference file if it exists. + + + + + + + Returns the value corresponding to key in the preference file if it exists. + + + + + + + Returns the value corresponding to key in the preference file if it exists. + + + + + + + Returns the value corresponding to key in the preference file if it exists. + + + + + + + Returns the value corresponding to key in the preference file if it exists. + + + + + + + Returns true if key exists in the preferences. + + + + + + Writes all modified preferences to disk. + + + + + Sets the value of the preference identified by key. + + + + + + + Sets the value of the preference identified by key. + + + + + + + Sets the value of the preference identified by key. + + + + + + + An exception thrown by the PlayerPrefs class in a web player build. + + + + + Used by Animation.Play function. + + + + + Will stop all animations that were started with this component before playing. + + + + + Will stop all animations that were started in the same layer. This is the default when playing animations. + + + + + Applies forces to attract/repulse against a point. + + + + + The angular drag to apply to rigid-bodies. + + + + + The scale applied to the calculated distance between source and target. + + + + + The linear drag to apply to rigid-bodies. + + + + + The magnitude of the force to be applied. + + + + + The mode used to apply the effector force. + + + + + The source which is used to calculate the centroid point of the effector. The distance from the target is defined from this point. + + + + + The target for where the effector applies any force. + + + + + The variation of the magnitude of the force to be applied. + + + + + Collider for 2D physics representing an arbitrary polygon defined by its vertices. + + + + + Determines whether the PolygonCollider2D's shape is automatically updated based on a SpriteRenderer's tiling properties. + + + + + The number of paths in the polygon. + + + + + Corner points that define the collider's shape in local space. + + + + + Creates as regular primitive polygon with the specified number of sides. + + The number of sides in the polygon. This must be greater than two. + The X/Y scale of the polygon. These must be greater than zero. + The X/Y offset of the polygon. + + + + Gets a path from the Collider by its index. + + The index of the path to retrieve. + + An ordered array of the vertices or points in the selected path. + + + + + Return the total number of points in the polygon in all paths. + + + + + Define a path by its constituent points. + + Index of the path to set. + Points that define the path. + + + + Representation of a Position, and a Rotation in 3D Space + + + + + Returns the forward vector of the pose. + + + + + Shorthand for pose which represents zero position, and an identity rotation. + + + + + The position component of the pose. + + + + + Returns the right vector of the pose. + + + + + The rotation component of the pose. + + + + + Returns the up vector of the pose. + + + + + Creates a new pose with the given vector, and quaternion values. + + + + + Transforms the current pose into the local space of the provided pose. + + + + + + Transforms the current pose into the local space of the provided pose. + + + + + + Returns true if two poses are equal. + + + + + + + Returns true if two poses are not equal. + + + + + + + Prefer ScriptableObject derived type to use binary serialization regardless of project's asset serialization mode. + + + + + The various primitives that can be created using the GameObject.CreatePrimitive function. + + + + + A capsule primitive. + + + + + A cube primitive. + + + + + A cylinder primitive. + + + + + A plane primitive. + + + + + A quad primitive. + + + + + A sphere primitive. + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + + Deprecated feature, no longer available + + + + + + Deprecated feature, no longer available + + + + + + Deprecated feature, no longer available + + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + + Deprecated feature, no longer available + + + + + + Deprecated feature, no longer available + + + + + + Deprecated feature, no longer available + + + + + + Deprecated feature, no longer available + + + + + + Deprecated feature, no longer available + + + + + + Deprecated feature, no longer available + + + + + Triggers an immediate (synchronous) rebuild of this ProceduralMaterial's dirty textures. + + + + + Deprecated feature, no longer available + + + + + + + Deprecated feature, no longer available + + + + + + + Deprecated feature, no longer available + + + + + + + Deprecated feature, no longer available + + + + + + + Deprecated feature, no longer available + + + + + + + Deprecated feature, no longer available + + + + + + + Deprecated feature, no longer available + + + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + Deprecated feature, no longer available + + + + + + + + + Deprecated feature, no longer available + + + + + Custom CPU Profiler label used for profiling arbitrary code blocks. + + + + + Begin profiling a piece of code with a custom label defined by this instance of CustomSampler. + + + + + + Begin profiling a piece of code with a custom label defined by this instance of CustomSampler. + + + + + + Creates a new CustomSampler for profiling parts of your code. + + Name of the Sampler. + + CustomSampler object or null if a built-in Sampler with the same name exists. + + + + + End profiling a piece of code with a custom label. + + + + + Flags that specify which fields to capture in a snapshot. + + + + + Corresponds to the ManagedHeapSections, ManagedStacks, Connections, TypeDescriptions fields in a Memory Snapshot. + + + + + Corresponds to the NativeAllocations, NativeMemoryRegions, NativeRootReferences, and NativeMemoryLabels fields in a Memory Snapshot. + + + + + Corresponds to the NativeAllocationSite field in a Memory Snapshot. + + + + + Corresponds to the NativeObject and NativeType fields in a Memory Snapshot. + + + + + Corresponds to the NativeCallstackSymbol field in a Memory Snapshot. + + + + + Memory profiling API container class. + + + + + Event to which meta data collection methods can be subscribed to. + + + + + + Trigger memory snapshot capture. + + Destination path for the memory snapshot file. + Event that is fired once the memory snapshot has finished the process of capturing data. + Flag mask defining the content of the memory snapshot. + + + + Trigger memory snapshot capture to Application.temporaryCachePath folder. + + Event that is fired once the memory snapshot has finished the process of capturing data. + Flag mask defining the content of the memory snapshot. + + + + Container for memory snapshot meta data. + + + + + User defined meta data. + + + + + Memory snapshot meta data containing platform information. + + + + + Screenshot stored in the memory snapshot. + + + + + Controls the from script. + + + + + The number of ProfilerArea|Profiler Areas that you can profile. + + + + + Enables the logging of profiling data to a file. + + + + + Enables the Profiler. + + + + + Specifies the file to use when writing profiling data. + + + + + Resize the profiler sample buffers to allow the desired amount of samples per thread. + + + + + Sets the maximum amount of memory that Profiler uses for buffering data. This property is expressed in bytes. + + + + + Heap size used by the program. + + + Size of the used heap in bytes, (or 0 if the profiler is disabled). + + + + + Returns the number of bytes that Unity has allocated. This does not include bytes allocated by external libraries or drivers. + + + Size of the memory allocated by Unity (or 0 if the profiler is disabled). + + + + + Displays the recorded profile data in the profiler. + + The name of the file containing the frame data, including extension. + + + + Begin profiling a piece of code with a custom label. + + A string to identify the sample in the Profiler window. + An object that provides context to the sample,. + + + + Begin profiling a piece of code with a custom label. + + A string to identify the sample in the Profiler window. + An object that provides context to the sample,. + + + + Enables profiling on the thread from which you call this method. + + The name of the thread group to which the thread belongs. + The name of the thread. + + + + Ends the current profiling sample. + + + + + Frees the internal resources used by the Profiler for the thread. + + + + + Returns the amount of allocated memory for the graphics driver, in bytes. + +Only available in development players and editor. + + + + + Returns whether or not a given ProfilerArea is currently enabled. + + Which area you want to check the state of. + + Returns whether or not a given ProfilerArea is currently enabled. + + + + + Returns the size of the mono heap. + + + + + Returns the size of the reserved space for managed-memory. + + + The size of the managed heap. This returns 0 if the Profiler is not available. + + + + + Returns the used size from mono. + + + + + The allocated managed-memory for live objects and non-collected objects. + + + A long integer value of the memory in use. This returns 0 if the Profiler is not available. + + + + + Returns the runtime memory usage of the resource. + + + + + + Gathers the native-memory used by a Unity object. + + The target Unity object. + + The amount of native-memory used by a Unity object. This returns 0 if the Profiler is not available. + + + + + Returns the size of the temp allocator. + + + Size in bytes. + + + + + Returns the amount of allocated and used system memory. + + + + + The total memory allocated by the internal allocators in Unity. Unity reserves large pools of memory from the system. This function returns the amount of used memory in those pools. + + + The amount of memory allocated by Unity. This returns 0 if the Profiler is not available. + + + + + Returns the amount of reserved system memory. + + + + + The total memory Unity has reserved. + + + Memory reserved by Unity in bytes. This returns 0 if the Profiler is not available. + + + + + Returns the amount of reserved but not used system memory. + + + + + Unity allocates memory in pools for usage when unity needs to allocate memory. This function returns the amount of unused memory in these pools. + + + The amount of unused memory in the reserved pools. This returns 0 if the Profiler is not available. + + + + + Enable or disable a given ProfilerArea. + + The area you want to enable or disable. + Enable or disable the collection of data for this area. + + + + Sets the size of the temp allocator. + + Size in bytes. + + Returns true if requested size was successfully set. Will return false if value is disallowed (too small). + + + + + The different areas of profiling, corresponding to the charts in ProfilerWindow. + + + + + Audio statistics. + + + + + CPU statistics. + + + + + Global Illumination statistics. + + + + + GPU statistics. + + + + + Memory statistics. + + + + + Network messages statistics. + + + + + Network operations statistics. + + + + + 3D Physics statistics. + + + + + 2D physics statistics. + + + + + Rendering statistics. + + + + + UI statistics. + + + + + Detailed UI statistics. + + + + + Video playback statistics. + + + + + Records profiling data produced by a specific Sampler. + + + + + Accumulated time of Begin/End pairs for the previous frame in nanoseconds. (Read Only) + + + + + Enables recording. + + + + + Returns true if Recorder is valid and can collect data. (Read Only) + + + + + Number of time Begin/End pairs was called during the previous frame. (Read Only) + + + + + Configures the recorder to collect samples from all threads. + + + + + Configures the recorder to only collect data from the current thread. + + + + + Use this function to get a Recorder for the specific Profiler label. + + Sampler name. + + Recorder object for the specified Sampler. + + + + + Provides control over a CPU Profiler label. + + + + + Returns true if Sampler is valid. (Read Only) + + + + + Sampler name. (Read Only) + + + + + Returns Sampler object for the specific CPU Profiler label. + + Profiler Sampler name. + + Sampler object which represents specific profiler label. + + + + + Returns number and names of all registered Profiler labels. + + Preallocated list the Sampler names are written to. Or null if you want to get number of Samplers only. + + Number of active Samplers. + + + + + Returns Recorder associated with the Sampler. + + + Recorder object associated with the Sampler. + + + + + A script interface for a. + + + + + The aspect ratio of the projection. + + + + + The far clipping plane distance. + + + + + The field of view of the projection in degrees. + + + + + Which object layers are ignored by the projector. + + + + + The material that will be projected onto every object. + + + + + The near clipping plane distance. + + + + + Is the projection orthographic (true) or perspective (false)? + + + + + Projection's half-size when in orthographic mode. + + + + + Base class to derive custom property attributes from. Use this to create custom attributes for script variables. + + + + + Optional field to specify the order that multiple DecorationDrawers should be drawn in. + + + + + Represents a string as an int for efficient lookup and comparison. Use this for common PropertyNames. + +Internally stores just an int to represent the string. A PropertyName can be created from a string but can not be converted back to a string. The same string always results in the same int representing that string. Thus this is a very efficient string representation in both memory and speed when all you need is comparison. + +PropertyName is serializable. + +ToString() is only implemented for debugging purposes in the editor it returns "theName:3737" in the player it returns "Unknown:3737". + + + + + Initializes the PropertyName using a string. + + + + + + Determines whether this instance and a specified object, which must also be a PropertyName object, have the same value. + + + + + + Returns the hash code for this PropertyName. + + + + + Converts the string passed into a PropertyName. See Also: PropertyName.ctor(System.String). + + + + + + Indicates whether the specified PropertyName is an Empty string. + + + + + + Determines whether two specified PropertyName have the same string value. Because two PropertyNames initialized with the same string value always have the same name index, we can simply perform a comparison of two ints to find out if the string value equals. + + + + + + + Determines whether two specified PropertyName have a different string value. + + + + + + + For debugging purposes only. Returns the string value representing the string in the Editor. +Returns "UnityEngine.PropertyName" in the player. + + + + + Script interface for. + + + + + Active color space (Read Only). + + + + + Global anisotropic filtering mode. + + + + + Set The AA Filtering option. + + + + + Async texture upload provides timesliced async texture upload on the render thread with tight control over memory and timeslicing. There are no allocations except for the ones which driver has to do. To read data and upload texture data a ringbuffer whose size can be controlled is re-used. + +Use asyncUploadBufferSize to set the buffer size for asynchronous texture uploads. The size is in megabytes. Minimum value is 2 and maximum is 512. Although the buffer will resize automatically to fit the largest texture currently loading, it is recommended to set the value approximately to the size of biggest texture used in the Scene to avoid re-sizing of the buffer which can incur performance cost. + + + + + This flag controls if the async upload pipeline's ring buffer remains allocated when there are no active loading operations. +To make the ring buffer allocation persist after all upload operations have completed, set this to true. +If you have issues with excessive memory usage, you can set this to false. This means you reduce the runtime memory footprint, but memory fragmentation can occur. +The default value is true. + + + + + Async texture upload provides timesliced async texture upload on the render thread with tight control over memory and timeslicing. There are no allocations except for the ones which driver has to do. To read data and upload texture data a ringbuffer whose size can be controlled is re-used. + +Use asyncUploadTimeSlice to set the time-slice in milliseconds for asynchronous texture uploads per +frame. Minimum value is 1 and maximum is 33. + + + + + If enabled, billboards will face towards camera position rather than camera orientation. + + + + + Blend weights. + + + + + Desired color space (Read Only). + + + + + Global multiplier for the LOD's switching distance. + + + + + A texture size limit applied to all textures. + + + + + A maximum LOD level. All LOD groups. + + + + + Maximum number of frames queued up by graphics driver. + + + + + The indexed list of available Quality Settings. + + + + + Budget for how many ray casts can be performed per frame for approximate collision testing. + + + + + The maximum number of pixel lights that should affect any object. + + + + + Enables realtime reflection probes. + + + + + In resolution scaling mode, this factor is used to multiply with the target Fixed DPI specified to get the actual Fixed DPI to use for this quality setting. + + + + + The normalized cascade distribution for a 2 cascade setup. The value defines the position of the cascade with respect to Zero. + + + + + The normalized cascade start position for a 4 cascade setup. Each member of the vector defines the normalized position of the coresponding cascade with respect to Zero. + + + + + Number of cascades to use for directional light shadows. + + + + + Shadow drawing distance. + + + + + The rendering mode of Shadowmask. + + + + + Offset shadow frustum near plane. + + + + + Directional light shadow projection. + + + + + The default resolution of the shadow maps. + + + + + Realtime Shadows type to be used. + + + + + Should soft blending be used for particles? + + + + + Use a two-pass shader for the vegetation in the terrain engine. + + + + + Enable automatic streaming of texture mipmap levels based on their distance from all active cameras. + + + + + Process all enabled Cameras for texture streaming (rather than just those with StreamingController components). + + + + + The maximum number of active texture file IO requests from the texture streaming system. + + + + + The maximum number of mipmap levels to discard for each texture. + + + + + The total amount of memory to be used by streaming and non-streaming textures. + + + + + Number of renderers used to process each frame during the calculation of desired mipmap levels for the associated textures. + + + + + The VSync Count. + + + + + Decrease the current quality level. + + Should expensive changes be applied (Anti-aliasing etc). + + + + Returns the current graphics quality level. + + + + + Increase the current quality level. + + Should expensive changes be applied (Anti-aliasing etc). + + + + Sets a new graphics quality level. + + Quality index to set. + Should expensive changes be applied (Anti-aliasing etc). + + + + Quaternions are used to represent rotations. + + + + + Returns or sets the euler angle representation of the rotation. + + + + + The identity rotation (Read Only). + + + + + Returns this quaternion with a magnitude of 1 (Read Only). + + + + + W component of the Quaternion. Do not directly modify quaternions. + + + + + X component of the Quaternion. Don't modify this directly unless you know quaternions inside out. + + + + + Y component of the Quaternion. Don't modify this directly unless you know quaternions inside out. + + + + + Z component of the Quaternion. Don't modify this directly unless you know quaternions inside out. + + + + + Returns the angle in degrees between two rotations a and b. + + + + + + + Creates a rotation which rotates angle degrees around axis. + + + + + + + Constructs new Quaternion with given x,y,z,w components. + + + + + + + + + The dot product between two rotations. + + + + + + + Returns a rotation that rotates z degrees around the z axis, x degrees around the x axis, and y degrees around the y axis. + + + + + + + + Returns a rotation that rotates z degrees around the z axis, x degrees around the x axis, and y degrees around the y axis. + + + + + + Creates a rotation which rotates from fromDirection to toDirection. + + + + + + + Returns the Inverse of rotation. + + + + + + Interpolates between a and b by t and normalizes the result afterwards. The parameter t is clamped to the range [0, 1]. + + + + + + + + Interpolates between a and b by t and normalizes the result afterwards. The parameter t is not clamped. + + + + + + + + Creates a rotation with the specified forward and upwards directions. + + The direction to look in. + The vector that defines in which direction up is. + + + + Creates a rotation with the specified forward and upwards directions. + + The direction to look in. + The vector that defines in which direction up is. + + + + Converts this quaternion to one with the same orientation but with a magnitude of 1. + + + + + + Are two quaternions equal to each other? + + + + + + + Combines rotations lhs and rhs. + + Left-hand side quaternion. + Right-hand side quaternion. + + + + Rotates the point point with rotation. + + + + + + + Rotates a rotation from towards to. + + + + + + + + Set x, y, z and w components of an existing Quaternion. + + + + + + + + + Creates a rotation which rotates from fromDirection to toDirection. + + + + + + + Creates a rotation with the specified forward and upwards directions. + + The direction to look in. + The vector that defines in which direction up is. + + + + Creates a rotation with the specified forward and upwards directions. + + The direction to look in. + The vector that defines in which direction up is. + + + + Spherically interpolates between a and b by t. The parameter t is clamped to the range [0, 1]. + + + + + + + + Spherically interpolates between a and b by t. The parameter t is not clamped. + + + + + + + + Access the x, y, z, w components using [0], [1], [2], [3] respectively. + + + + + Converts a rotation to angle-axis representation (angles in degrees). + + + + + + + Returns a nicely formatted string of the Quaternion. + + + + + + Returns a nicely formatted string of the Quaternion. + + + + + + Overrides the global Physics.queriesHitTriggers. + + + + + Queries always report Trigger hits. + + + + + Queries never report Trigger hits. + + + + + Queries use the global Physics.queriesHitTriggers setting. + + + + + Used by Animation.Play function. + + + + + Will start playing after all other animations have stopped playing. + + + + + Starts playing immediately. This can be used if you just want to quickly create a duplicate animation. + + + + + Class for generating random data. + + + + + Returns a random point inside a circle with radius 1 (Read Only). + + + + + Returns a random point inside a sphere with radius 1 (Read Only). + + + + + Returns a random point on the surface of a sphere with radius 1 (Read Only). + + + + + Returns a random rotation (Read Only). + + + + + Returns a random rotation with uniform distribution (Read Only). + + + + + Gets/Sets the full internal state of the random number generator. + + + + + Returns a random number between 0.0 [inclusive] and 1.0 [inclusive] (Read Only). + + + + + Generates a random color from HSV and alpha ranges. + + Minimum hue [0..1]. + Maximum hue [0..1]. + Minimum saturation [0..1]. + Maximum saturation[0..1]. + Minimum value [0..1]. + Maximum value [0..1]. + Minimum alpha [0..1]. + Maximum alpha [0..1]. + + A random color with HSV and alpha values in the input ranges. + + + + + Generates a random color from HSV and alpha ranges. + + Minimum hue [0..1]. + Maximum hue [0..1]. + Minimum saturation [0..1]. + Maximum saturation[0..1]. + Minimum value [0..1]. + Maximum value [0..1]. + Minimum alpha [0..1]. + Maximum alpha [0..1]. + + A random color with HSV and alpha values in the input ranges. + + + + + Generates a random color from HSV and alpha ranges. + + Minimum hue [0..1]. + Maximum hue [0..1]. + Minimum saturation [0..1]. + Maximum saturation[0..1]. + Minimum value [0..1]. + Maximum value [0..1]. + Minimum alpha [0..1]. + Maximum alpha [0..1]. + + A random color with HSV and alpha values in the input ranges. + + + + + Generates a random color from HSV and alpha ranges. + + Minimum hue [0..1]. + Maximum hue [0..1]. + Minimum saturation [0..1]. + Maximum saturation[0..1]. + Minimum value [0..1]. + Maximum value [0..1]. + Minimum alpha [0..1]. + Maximum alpha [0..1]. + + A random color with HSV and alpha values in the input ranges. + + + + + Generates a random color from HSV and alpha ranges. + + Minimum hue [0..1]. + Maximum hue [0..1]. + Minimum saturation [0..1]. + Maximum saturation[0..1]. + Minimum value [0..1]. + Maximum value [0..1]. + Minimum alpha [0..1]. + Maximum alpha [0..1]. + + A random color with HSV and alpha values in the input ranges. + + + + + Initializes the random number generator state with a seed. + + Seed used to initialize the random number generator. + + + + Return a random float number between min [inclusive] and max [inclusive] (Read Only). + + + + + + + Return a random integer number between min [inclusive] and max [exclusive] (Read Only). + + + + + + + Serializable structure used to hold the full internal state of the random number generator. See Also: Random.state. + + + + + Attribute used to make a float or int variable in a script be restricted to a specific range. + + + + + Attribute used to make a float or int variable in a script be restricted to a specific range. + + The minimum allowed value. + The maximum allowed value. + + + + Describes an integer range. + + + + + The end index of the range (not inclusive). + + + + + The length of the range. + + + + + The starting index of the range, where 0 is the first position, 1 is the second, 2 is the third, and so on. + + + + + Constructs a new RangeInt with given start, length values. + + The starting index of the range. + The length of the range. + + + + Representation of rays. + + + + + The direction of the ray. + + + + + The origin point of the ray. + + + + + Creates a ray starting at origin along direction. + + + + + + + Returns a point at distance units along the ray. + + + + + + Returns a nicely formatted string for this ray. + + + + + + Returns a nicely formatted string for this ray. + + + + + + A ray in 2D space. + + + + + The direction of the ray in world space. + + + + + The starting point of the ray in world space. + + + + + Creates a 2D ray starting at origin along direction. + + Origin. + Direction. + + + + + + Get a point that lies a given distance along a ray. + + Distance of the desired point along the path of the ray. + + + + Struct used to set up a raycast command to be performed asynchronously during a job. + + + + + The direction of the ray. + + + + + The maximum distance the ray should check for collisions. + + + + + The starting point of the ray in world coordinates. + + + + + A LayerMask that is used to selectively ignore Colliders when casting a ray. + + + + + The maximum number of Colliders the ray can hit. + + + + + Create a RaycastCommand. + + The starting point of the ray in world coordinates. + The direction of the ray. + The maximum distance the ray should check for collisions. + A LayerMask that is used to selectively ignore Colliders when casting a ray. + The maximum number of Colliders the ray can hit. + + + + Schedule a batch of raycasts which are performed in a job. + + A NativeArray of the RaycastCommands to perform. + A NativeArray of the RaycastHits where the results of the commands are stored. + The minimum number of jobs which should be performed in a single job. + A JobHandle of a job which must be completed before the raycast starts. + + The JobHandle of the job which will perform the raycasts. + + + + + Structure used to get information back from a raycast. + + + + + The barycentric coordinate of the triangle we hit. + + + + + The Collider that was hit. + + + + + The distance from the ray's origin to the impact point. + + + + + The uv lightmap coordinate at the impact point. + + + + + The normal of the surface the ray hit. + + + + + The impact point in world space where the ray hit the collider. + + + + + The Rigidbody of the collider that was hit. If the collider is not attached to a rigidbody then it is null. + + + + + The uv texture coordinate at the collision location. + + + + + The secondary uv texture coordinate at the impact point. + + + + + The Transform of the rigidbody or collider that was hit. + + + + + The index of the triangle that was hit. + + + + + Information returned about an object detected by a raycast in 2D physics. + + + + + The centroid of the primitive used to perform the cast. + + + + + The collider hit by the ray. + + + + + The distance from the ray origin to the impact point. + + + + + Fraction of the distance along the ray that the hit occurred. + + + + + The normal vector of the surface hit by the ray. + + + + + The point in world space where the ray hit the collider's surface. + + + + + The Rigidbody2D attached to the object that was hit. + + + + + The Transform of the object that was hit. + + + + + A 2D Rectangle defined by X and Y position, width and height. + + + + + The position of the center of the rectangle. + + + + + The height of the rectangle, measured from the Y position. + + + + + The position of the maximum corner of the rectangle. + + + + + The position of the minimum corner of the rectangle. + + + + + The X and Y position of the rectangle. + + + + + The width and height of the rectangle. + + + + + The width of the rectangle, measured from the X position. + + + + + The X coordinate of the rectangle. + + + + + The maximum X coordinate of the rectangle. + + + + + The minimum X coordinate of the rectangle. + + + + + The Y coordinate of the rectangle. + + + + + The maximum Y coordinate of the rectangle. + + + + + The minimum Y coordinate of the rectangle. + + + + + Shorthand for writing new Rect(0,0,0,0). + + + + + Returns true if the x and y components of point is a point inside this rectangle. If allowInverse is present and true, the width and height of the Rect are allowed to take negative values (ie, the min value is greater than the max), and the test will still work. + + Point to test. + Does the test allow the Rect's width and height to be negative? + + True if the point lies within the specified rectangle. + + + + + Returns true if the x and y components of point is a point inside this rectangle. If allowInverse is present and true, the width and height of the Rect are allowed to take negative values (ie, the min value is greater than the max), and the test will still work. + + Point to test. + Does the test allow the Rect's width and height to be negative? + + True if the point lies within the specified rectangle. + + + + + Returns true if the x and y components of point is a point inside this rectangle. If allowInverse is present and true, the width and height of the Rect are allowed to take negative values (ie, the min value is greater than the max), and the test will still work. + + Point to test. + Does the test allow the Rect's width and height to be negative? + + True if the point lies within the specified rectangle. + + + + + Creates a new rectangle. + + The X value the rect is measured from. + The Y value the rect is measured from. + The width of the rectangle. + The height of the rectangle. + + + + + + + + + + Creates a rectangle given a size and position. + + The position of the minimum corner of the rect. + The width and height of the rect. + + + + Creates a rectangle from min/max coordinate values. + + The minimum X coordinate. + The minimum Y coordinate. + The maximum X coordinate. + The maximum Y coordinate. + + A rectangle matching the specified coordinates. + + + + + Returns a point inside a rectangle, given normalized coordinates. + + Rectangle to get a point inside. + Normalized coordinates to get a point for. + + + + Returns true if the rectangles are the same. + + + + + + + Returns true if the other rectangle overlaps this one. If allowInverse is present and true, the widths and heights of the Rects are allowed to take negative values (ie, the min value is greater than the max), and the test will still work. + + Other rectangle to test overlapping with. + Does the test allow the widths and heights of the Rects to be negative? + + + + Returns true if the other rectangle overlaps this one. If allowInverse is present and true, the widths and heights of the Rects are allowed to take negative values (ie, the min value is greater than the max), and the test will still work. + + Other rectangle to test overlapping with. + Does the test allow the widths and heights of the Rects to be negative? + + + + Returns the normalized coordinates cooresponding the the point. + + Rectangle to get normalized coordinates inside. + A point inside the rectangle to get normalized coordinates for. + + + + Set components of an existing Rect. + + + + + + + + + Returns a nicely formatted string for this Rect. + + + + + + Returns a nicely formatted string for this Rect. + + + + + + A 2D Rectangle defined by x, y, width, height with integers. + + + + + A RectInt.PositionCollection that contains all positions within the RectInt. + + + + + Center coordinate of the rectangle. + + + + + Height of the rectangle. + + + + + Upper right corner of the rectangle. + + + + + Lower left corner of the rectangle. + + + + + Returns the position (x, y) of the RectInt. + + + + + Returns the width and height of the RectInt. + + + + + Width of the rectangle. + + + + + Left coordinate of the rectangle. + + + + + Returns the maximum X value of the RectInt. + + + + + Returns the minimum X value of the RectInt. + + + + + Top coordinate of the rectangle. + + + + + Returns the maximum Y value of the RectInt. + + + + + Returns the minimum Y value of the RectInt. + + + + + Clamps the position and size of the RectInt to the given bounds. + + Bounds to clamp the RectInt. + + + + Returns true if the given position is within the RectInt. + + Position to check. + Whether the max limits are included in the check. + + Whether the position is within the RectInt. + + + + + Returns true if the given position is within the RectInt. + + Position to check. + Whether the max limits are included in the check. + + Whether the position is within the RectInt. + + + + + Returns true if the given RectInt is equal to this RectInt. + + + + + + An iterator that allows you to iterate over all positions within the RectInt. + + + + + Current position of the enumerator. + + + + + Returns this as an iterator that allows you to iterate over all positions within the RectInt. + + + This RectInt.PositionEnumerator. + + + + + Moves the enumerator to the next position. + + + Whether the enumerator has successfully moved to the next position. + + + + + Resets this enumerator to its starting state. + + + + + Sets the bounds to the min and max value of the rect. + + + + + + + Returns the x, y, width and height of the RectInt. + + + + + Offsets for rectangles, borders, etc. + + + + + Bottom edge size. + + + + + Shortcut for left + right. (Read Only) + + + + + Left edge size. + + + + + Right edge size. + + + + + Top edge size. + + + + + Shortcut for top + bottom. (Read Only) + + + + + Add the border offsets to a rect. + + + + + + Creates a new rectangle with offsets. + + + + + + + + + Creates a new rectangle with offsets. + + + + + + + + + Remove the border offsets from a rect. + + + + + + Position, size, anchor and pivot information for a rectangle. + + + + + The position of the pivot of this RectTransform relative to the anchor reference point. + + + + + The 3D position of the pivot of this RectTransform relative to the anchor reference point. + + + + + The normalized position in the parent RectTransform that the upper right corner is anchored to. + + + + + The normalized position in the parent RectTransform that the lower left corner is anchored to. + + + + + The offset of the upper right corner of the rectangle relative to the upper right anchor. + + + + + The offset of the lower left corner of the rectangle relative to the lower left anchor. + + + + + The normalized position in this RectTransform that it rotates around. + + + + + Event that is invoked for RectTransforms that need to have their driven properties reapplied. + + + + + + The calculated rectangle in the local space of the Transform. + + + + + The size of this RectTransform relative to the distances between the anchors. + + + + + An axis that can be horizontal or vertical. + + + + + Horizontal. + + + + + Vertical. + + + + + Enum used to specify one edge of a rectangle. + + + + + The bottom edge. + + + + + The left edge. + + + + + The right edge. + + + + + The top edge. + + + + + Force the recalculation of RectTransforms internal data. + + + + + Get the corners of the calculated rectangle in the local space of its Transform. + + The array that corners are filled into. + + + + Get the corners of the calculated rectangle in world space. + + The array that corners are filled into. + + + + Delegate used for the reapplyDrivenProperties event. + + + + + + Set the distance of this rectangle relative to a specified edge of the parent rectangle, while also setting its size. + + The edge of the parent rectangle to inset from. + The inset distance. + The size of the rectangle along the same direction of the inset. + + + + Makes the RectTransform calculated rect be a given size on the specified axis. + + The axis to specify the size along. + The desired size along the specified axis. + + + + Utility class containing helper methods for working with RectTransform. + + + + + Flips the horizontal and vertical axes of the RectTransform size and alignment, and optionally its children as well. + + The RectTransform to flip. + Flips around the pivot if true. Flips within the parent rect if false. + Flip the children as well? + + + + Flips the alignment of the RectTransform along the horizontal or vertical axis, and optionally its children as well. + + The RectTransform to flip. + Flips around the pivot if true. Flips within the parent rect if false. + Flip the children as well? + The axis to flip along. 0 is horizontal and 1 is vertical. + + + + Convert a given point in screen space into a pixel correct point. + + + + + + Pixel adjusted point. + + + + + Given a rect transform, return the corner points in pixel accurate coordinates. + + + + + Pixel adjusted rect. + + + + + Does the RectTransform contain the screen point as seen from the given camera? + + The RectTransform to test with. + The screen point to test. + The camera from which the test is performed from. (Optional) + + True if the point is inside the rectangle. + + + + + Transform a screen space point to a position in the local space of a RectTransform that is on the plane of its rectangle. + + The RectTransform to find a point inside. + The camera associated with the screen space position. + Screen space position. + Point in local space of the rect transform. + + Returns true if the plane of the RectTransform is hit, regardless of whether the point is inside the rectangle. + + + + + Transform a screen space point to a position in world space that is on the plane of the given RectTransform. + + The RectTransform to find a point inside. + The camera associated with the screen space position. + Screen space position. + Point in world space. + + Returns true if the plane of the RectTransform is hit, regardless of whether the point is inside the rectangle. + + + + + The reflection probe is used to capture the surroundings into a texture which is passed to the shaders and used for reflections. + + + + + The color with which the texture of reflection probe will be cleared. + + + + + Reference to the baked texture of the reflection probe's surrounding. + + + + + Distance around probe used for blending (used in deferred probes). + + + + + The bounding volume of the reflection probe (Read Only). + + + + + Should this reflection probe use box projection? + + + + + The center of the box area in which reflections will be applied to the objects. Measured in the probes's local space. + + + + + How the reflection probe clears the background. + + + + + This is used to render parts of the reflecion probe's surrounding selectively. + + + + + Reference to the baked texture of the reflection probe's surrounding. Use this to assign custom reflection texture. + + + + + Adds a delegate to get notifications when the default specular Cubemap is changed. + + + + + + Texture which is used outside of all reflection probes (Read Only). + + + + + HDR decode values of the default reflection probe texture. + + + + + The far clipping plane distance when rendering the probe. + + + + + Should this reflection probe use HDR rendering? + + + + + Reflection probe importance. + + + + + The intensity modifier that is applied to the texture of reflection probe in the shader. + + + + + Should reflection probe texture be generated in the Editor (ReflectionProbeMode.Baked) or should probe use custom specified texure (ReflectionProbeMode.Custom)? + + + + + The near clipping plane distance when rendering the probe. + + + + + Reference to the realtime texture of the reflection probe's surroundings. Use this to assign a RenderTexture to use for realtime reflection. + + + + + Adds a delegate to get notifications when a Reflection Probe is added to a Scene or removed from a Scene. + + + + + + Sets the way the probe will refresh. + +See Also: ReflectionProbeRefreshMode. + + + + + Resolution of the underlying reflection texture in pixels. + + + + + Shadow drawing distance when rendering the probe. + + + + + The size of the box area in which reflections will be applied to the objects. Measured in the probes's local space. + + + + + Texture which is passed to the shader of the objects in the vicinity of the reflection probe (Read Only). + + + + + HDR decode values of the reflection probe texture. + + + + + Sets this probe time-slicing mode + +See Also: ReflectionProbeTimeSlicingMode. + + + + + Utility method to blend 2 cubemaps into a target render texture. + + Cubemap to blend from. + Cubemap to blend to. + Blend weight. + RenderTexture which will hold the result of the blend. + + Returns trues if cubemaps were blended, false otherwise. + + + + + Checks if a probe has finished a time-sliced render. + + An integer representing the RenderID as returned by the RenderProbe method. + + + True if the render has finished, false otherwise. + + See Also: timeSlicingMode + + + + + + Types of events that occur when ReflectionProbe components are used in a Scene. + + + + + An event that occurs when a Reflection Probe component is added to a Scene or enabled in a Scene. + + + + + An event that occurs when a Reflection Probe component is unloaded from a Scene or disabled in a Scene. + + + + + Refreshes the probe's cubemap. + + Target RendeTexture in which rendering should be done. Specifying null will update the probe's default texture. + + + An integer representing a RenderID which can subsequently be used to check if the probe has finished rendering while rendering in time-slice mode. + + See Also: IsFinishedRendering + See Also: timeSlicingMode + + + + + + Revert all ReflectionProbe parameters to default. + + + + + Keeps two Rigidbody2D at their relative orientations. + + + + + The current angular offset between the Rigidbody2D that the joint connects. + + + + + Should both the linearOffset and angularOffset be calculated automatically? + + + + + Scales both the linear and angular forces used to correct the required relative orientation. + + + + + The current linear offset between the Rigidbody2D that the joint connects. + + + + + The maximum force that can be generated when trying to maintain the relative joint constraint. + + + + + The maximum torque that can be generated when trying to maintain the relative joint constraint. + + + + + The world-space position that is currently trying to be maintained. + + + + + Provides access to your remote settings. + + + + + Dispatched before the RemoteSettings object makes the network request for the latest settings. + + + + + + Dispatched when the network request made by the RemoteSettings object to fetch the remote configuration file is complete. + + + + + + Forces the game to download the newest settings from the server and update its values. + + + + + Gets the value corresponding to remote setting identified by key, if it exists. + + The key identifying the setting. + The default value to use if the setting identified by the key parameter cannot be found or is unavailable. + + The current value of the setting identified by key, or the default value. + + + + + Gets the value corresponding to remote setting identified by key, if it exists. + + The key identifying the setting. + The default value to use if the setting identified by the key parameter cannot be found or is unavailable. + + The current value of the setting identified by key, or the default value. + + + + + Gets the number of keys in the remote settings configuration. + + + + + Gets the value corresponding to remote setting identified by key, if it exists. + + The key identifying the setting. + The default value to use if the setting identified by the key parameter cannot be found or is unavailable. + + The current value of the setting identified by key, or the default value. + + + + + Gets the value corresponding to remote setting identified by key, if it exists. + + The key identifying the setting. + The default value to use if the setting identified by the key parameter cannot be found or is unavailable. + + The current value of the setting identified by key, or the default value. + + + + + Gets the value corresponding to remote setting identified by key, if it exists. + + The key identifying the setting. + The default value to use if the setting identified by the key parameter cannot be found or is unavailable. + + The current value of the setting identified by key, or the default value. + + + + + Gets the value corresponding to remote setting identified by key, if it exists. + + The key identifying the setting. + The default value to use if the setting identified by the key parameter cannot be found or is unavailable. + + The current value of the setting identified by key, or the default value. + + + + + Gets an array containing all the keys in the remote settings configuration. + + + + + Gets the value corresponding to remote setting identified by key, if it exists. + + The key identifying the setting. + The default value to use if the setting identified by the key parameter cannot be found or is unavailable. + + The current value of the setting identified by key, or the default value. + + + + + Gets the value corresponding to remote setting identified by key, if it exists. + + The key identifying the setting. + The default value to use if the setting identified by the key parameter cannot be found or is unavailable. + + The current value of the setting identified by key, or the default value. + + + + + Gets the value corresponding to remote setting identified by key, if it exists. + + The key identifying the setting. + The default value to use if the setting identified by the key parameter cannot be found or is unavailable. + + The current value of the setting identified by key, or the default value. + + + + + Reports whether the specified key exists in the remote settings configuration. + + The key identifying the setting. + + True, if the key exists. + + + + + Dispatched when a remote settings configuration is fetched and successfully parsed from the server or from local cache. + + + + + + Defines the delegate signature for handling RemoteSettings.Updated events. + + + + + Reports whether or not the settings available from the RemoteSettings object were received from the Analytics Service during the current session. + + + True, if the remote settings file was received from the Analytics Service in the current session. False, if the remote settings file was received during an earlier session and cached. + + + + + Color or depth buffer part of a RenderTexture. + + + + + Returns native RenderBuffer. Be warned this is not native Texture, but rather pointer to unity struct that can be used with native unity API. Currently such API exists only on iOS. + + + + + General functionality for all renderers. + + + + + Controls if dynamic occlusion culling should be performed for this renderer. + + + + + The bounding volume of the renderer (Read Only). + + + + + Makes the rendered 3D object visible if enabled. + + + + + Has this renderer been statically batched with any other renderers? + + + + + Is this renderer visible in any camera? (Read Only) + + + + + The index of the baked lightmap applied to this renderer. + + + + + The UV scale & offset used for a lightmap. + + + + + If set, the Renderer will use the Light Probe Proxy Volume component attached to the source GameObject. + + + + + The light probe interpolation type. + + + + + Matrix that transforms a point from local space into world space (Read Only). + + + + + Returns the first instantiated Material assigned to the renderer. + + + + + Returns all the instantiated materials of this object. + + + + + Specifies the mode for motion vector rendering. + + + + + Specifies whether this renderer has a per-object motion vector pass. + + + + + If set, Renderer will use this Transform's position to find the light or reflection probe. + + + + + The index of the realtime lightmap applied to this renderer. + + + + + The UV scale & offset used for a realtime lightmap. + + + + + Does this object receive shadows? + + + + + Should reflection probes be used for this Renderer? + + + + + This value sorts renderers by priority. Lower values are rendered first and higher values are rendered last. + + + + + Determines which rendering layer this renderer lives on. + + + + + Does this object cast shadows? + + + + + The shared material of this object. + + + + + All the shared materials of this object. + + + + + Unique ID of the Renderer's sorting layer. + + + + + Name of the Renderer's sorting layer. + + + + + Renderer's order within a sorting layer. + + + + + Should light probes be used for this Renderer? + + + + + Matrix that transforms a point from world space into local space (Read Only). + + + + + Returns an array of closest reflection probes with weights, weight shows how much influence the probe has on the renderer, this value is also used when blending between reflection probes occur. + + + + + + Returns all the instantiated materials of this object. + + A list of materials to populate. + + + + Get per-Renderer or per-Material property block. + + Material parameters to retrieve. + The index of the Material you want to get overridden parameters from. The index ranges from 0 to Renderer.sharedMaterials.Length-1. + + + + Get per-Renderer or per-Material property block. + + Material parameters to retrieve. + The index of the Material you want to get overridden parameters from. The index ranges from 0 to Renderer.sharedMaterials.Length-1. + + + + Returns all the shared materials of this object. + + A list of materials to populate. + + + + Returns true if the Renderer has a material property block attached via SetPropertyBlock. + + + + + Lets you set or clear per-renderer or per-material parameter overrides. + + Property block with values you want to override. + The index of the Material you want to override the parameters of. The index ranges from 0 to Renderer.sharedMaterial.Length-1. + + + + Lets you set or clear per-renderer or per-material parameter overrides. + + Property block with values you want to override. + The index of the Material you want to override the parameters of. The index ranges from 0 to Renderer.sharedMaterial.Length-1. + + + + Extension methods to the Renderer class, used only for the UpdateGIMaterials method used by the Global Illumination System. + + + + + Schedules an update of the albedo and emissive Textures of a system that contains the Renderer. + + + + + + Ambient lighting mode. + + + + + Ambient lighting is defined by a custom cubemap. + + + + + Flat ambient lighting. + + + + + Skybox-based or custom ambient lighting. + + + + + Trilight ambient lighting. + + + + + Allows the asynchronous read back of GPU resources. + + + + + Triggers a request to asynchronously fetch the data from a GPU resource. + + The resource to read the data from. + Size in bytes of the data to be retrieved from the ComputeBuffer. + Offset in bytes in the ComputeBuffer. + The index of the mipmap to be fetched. + The target TextureFormat of the data. Conversion will happen automatically if format is different from the format stored on GPU. + Starting X coordinate in pixels of the Texture data to be fetched. + Width in pixels of the Texture data to be fetched. + Starting Y coordinate in pixels of the Texture data to be fetched. + Height in pixels of the Texture data to be fetched. + Start Z coordinate in pixels for the Texture3D being fetched. Index of Start layer for TextureCube, Texture2DArray and TextureCubeArray being fetched. + Depth in pixels for Texture3D being fetched. Number of layers for TextureCube, TextureArray and TextureCubeArray. + An optional delegate System.Action called once the request is fullfilled. The done request is passed as parameter to the System.Action. + + An AsyncGPUReadbackRequest that can be used to both access the data and check whether it is available. + + + + + Triggers a request to asynchronously fetch the data from a GPU resource. + + The resource to read the data from. + Size in bytes of the data to be retrieved from the ComputeBuffer. + Offset in bytes in the ComputeBuffer. + The index of the mipmap to be fetched. + The target TextureFormat of the data. Conversion will happen automatically if format is different from the format stored on GPU. + Starting X coordinate in pixels of the Texture data to be fetched. + Width in pixels of the Texture data to be fetched. + Starting Y coordinate in pixels of the Texture data to be fetched. + Height in pixels of the Texture data to be fetched. + Start Z coordinate in pixels for the Texture3D being fetched. Index of Start layer for TextureCube, Texture2DArray and TextureCubeArray being fetched. + Depth in pixels for Texture3D being fetched. Number of layers for TextureCube, TextureArray and TextureCubeArray. + An optional delegate System.Action called once the request is fullfilled. The done request is passed as parameter to the System.Action. + + An AsyncGPUReadbackRequest that can be used to both access the data and check whether it is available. + + + + + Triggers a request to asynchronously fetch the data from a GPU resource. + + The resource to read the data from. + Size in bytes of the data to be retrieved from the ComputeBuffer. + Offset in bytes in the ComputeBuffer. + The index of the mipmap to be fetched. + The target TextureFormat of the data. Conversion will happen automatically if format is different from the format stored on GPU. + Starting X coordinate in pixels of the Texture data to be fetched. + Width in pixels of the Texture data to be fetched. + Starting Y coordinate in pixels of the Texture data to be fetched. + Height in pixels of the Texture data to be fetched. + Start Z coordinate in pixels for the Texture3D being fetched. Index of Start layer for TextureCube, Texture2DArray and TextureCubeArray being fetched. + Depth in pixels for Texture3D being fetched. Number of layers for TextureCube, TextureArray and TextureCubeArray. + An optional delegate System.Action called once the request is fullfilled. The done request is passed as parameter to the System.Action. + + An AsyncGPUReadbackRequest that can be used to both access the data and check whether it is available. + + + + + Triggers a request to asynchronously fetch the data from a GPU resource. + + The resource to read the data from. + Size in bytes of the data to be retrieved from the ComputeBuffer. + Offset in bytes in the ComputeBuffer. + The index of the mipmap to be fetched. + The target TextureFormat of the data. Conversion will happen automatically if format is different from the format stored on GPU. + Starting X coordinate in pixels of the Texture data to be fetched. + Width in pixels of the Texture data to be fetched. + Starting Y coordinate in pixels of the Texture data to be fetched. + Height in pixels of the Texture data to be fetched. + Start Z coordinate in pixels for the Texture3D being fetched. Index of Start layer for TextureCube, Texture2DArray and TextureCubeArray being fetched. + Depth in pixels for Texture3D being fetched. Number of layers for TextureCube, TextureArray and TextureCubeArray. + An optional delegate System.Action called once the request is fullfilled. The done request is passed as parameter to the System.Action. + + An AsyncGPUReadbackRequest that can be used to both access the data and check whether it is available. + + + + + Triggers a request to asynchronously fetch the data from a GPU resource. + + The resource to read the data from. + Size in bytes of the data to be retrieved from the ComputeBuffer. + Offset in bytes in the ComputeBuffer. + The index of the mipmap to be fetched. + The target TextureFormat of the data. Conversion will happen automatically if format is different from the format stored on GPU. + Starting X coordinate in pixels of the Texture data to be fetched. + Width in pixels of the Texture data to be fetched. + Starting Y coordinate in pixels of the Texture data to be fetched. + Height in pixels of the Texture data to be fetched. + Start Z coordinate in pixels for the Texture3D being fetched. Index of Start layer for TextureCube, Texture2DArray and TextureCubeArray being fetched. + Depth in pixels for Texture3D being fetched. Number of layers for TextureCube, TextureArray and TextureCubeArray. + An optional delegate System.Action called once the request is fullfilled. The done request is passed as parameter to the System.Action. + + An AsyncGPUReadbackRequest that can be used to both access the data and check whether it is available. + + + + + Triggers a request to asynchronously fetch the data from a GPU resource. + + The resource to read the data from. + Size in bytes of the data to be retrieved from the ComputeBuffer. + Offset in bytes in the ComputeBuffer. + The index of the mipmap to be fetched. + The target TextureFormat of the data. Conversion will happen automatically if format is different from the format stored on GPU. + Starting X coordinate in pixels of the Texture data to be fetched. + Width in pixels of the Texture data to be fetched. + Starting Y coordinate in pixels of the Texture data to be fetched. + Height in pixels of the Texture data to be fetched. + Start Z coordinate in pixels for the Texture3D being fetched. Index of Start layer for TextureCube, Texture2DArray and TextureCubeArray being fetched. + Depth in pixels for Texture3D being fetched. Number of layers for TextureCube, TextureArray and TextureCubeArray. + An optional delegate System.Action called once the request is fullfilled. The done request is passed as parameter to the System.Action. + + An AsyncGPUReadbackRequest that can be used to both access the data and check whether it is available. + + + + + Represents an asynchronous request for a GPU resource. + + + + + When reading data from a ComputeBuffer, depth is 1, otherwise, the property takes the value of the requested depth from the texture. + + + + + Checks whether the request has been processed. + + + + + This property is true if the request has encountered an error. + + + + + When reading data from a ComputeBuffer, height is 1, otherwise, the property takes the value of the requested height from the texture. + + + + + Number of layers in the current request. + + + + + The size in bytes of one layer of the readback data. + + + + + The width of the requested GPU data. + + + + + Fetches the data of a successful request. + + The index of the layer to retrieve. + + + + Triggers an update of the request. + + + + + Waits for completion of the request. + + + + + Blend mode for controlling the blending. + + + + + Blend factor is (Ad, Ad, Ad, Ad). + + + + + Blend factor is (Rd, Gd, Bd, Ad). + + + + + Blend factor is (1, 1, 1, 1). + + + + + Blend factor is (1 - Ad, 1 - Ad, 1 - Ad, 1 - Ad). + + + + + Blend factor is (1 - Rd, 1 - Gd, 1 - Bd, 1 - Ad). + + + + + Blend factor is (1 - As, 1 - As, 1 - As, 1 - As). + + + + + Blend factor is (1 - Rs, 1 - Gs, 1 - Bs, 1 - As). + + + + + Blend factor is (As, As, As, As). + + + + + Blend factor is (f, f, f, 1); where f = min(As, 1 - Ad). + + + + + Blend factor is (Rs, Gs, Bs, As). + + + + + Blend factor is (0, 0, 0, 0). + + + + + Blend operation. + + + + + Add (s + d). + + + + + Color burn (Advanced OpenGL blending). + + + + + Color dodge (Advanced OpenGL blending). + + + + + Darken (Advanced OpenGL blending). + + + + + Difference (Advanced OpenGL blending). + + + + + Exclusion (Advanced OpenGL blending). + + + + + Hard light (Advanced OpenGL blending). + + + + + HSL color (Advanced OpenGL blending). + + + + + HSL Hue (Advanced OpenGL blending). + + + + + HSL luminosity (Advanced OpenGL blending). + + + + + HSL saturation (Advanced OpenGL blending). + + + + + Lighten (Advanced OpenGL blending). + + + + + Logical AND (s & d) (D3D11.1 only). + + + + + Logical inverted AND (!s & d) (D3D11.1 only). + + + + + Logical reverse AND (s & !d) (D3D11.1 only). + + + + + Logical Clear (0). + + + + + Logical Copy (s) (D3D11.1 only). + + + + + Logical inverted Copy (!s) (D3D11.1 only). + + + + + Logical Equivalence !(s XOR d) (D3D11.1 only). + + + + + Logical Inverse (!d) (D3D11.1 only). + + + + + Logical NAND !(s & d). D3D11.1 only. + + + + + Logical No-op (d) (D3D11.1 only). + + + + + Logical NOR !(s | d) (D3D11.1 only). + + + + + Logical OR (s | d) (D3D11.1 only). + + + + + Logical inverted OR (!s | d) (D3D11.1 only). + + + + + Logical reverse OR (s | !d) (D3D11.1 only). + + + + + Logical SET (1) (D3D11.1 only). + + + + + Logical XOR (s XOR d) (D3D11.1 only). + + + + + Max. + + + + + Min. + + + + + Multiply (Advanced OpenGL blending). + + + + + Overlay (Advanced OpenGL blending). + + + + + Reverse subtract. + + + + + Screen (Advanced OpenGL blending). + + + + + Soft light (Advanced OpenGL blending). + + + + + Subtract. + + + + + Built-in temporary render textures produced during camera's rendering. + + + + + The raw RenderBuffer pointer to be used. + + + + + Target texture of currently rendering camera. + + + + + Currently active render target. + + + + + Camera's depth texture. + + + + + Camera's depth+normals texture. + + + + + Deferred shading G-buffer #0 (typically diffuse color). + + + + + Deferred shading G-buffer #1 (typically specular + roughness). + + + + + Deferred shading G-buffer #2 (typically normals). + + + + + Deferred shading G-buffer #3 (typically emission/lighting). + + + + + Deferred shading G-buffer #4 (typically occlusion mask for static lights if any). + + + + + G-buffer #5 Available. + + + + + G-buffer #6 Available. + + + + + G-buffer #7 Available. + + + + + Motion Vectors generated when the camera has motion vectors enabled. + + + + + Deferred lighting light buffer. + + + + + Deferred lighting HDR specular light buffer (Xbox 360 only). + + + + + Deferred lighting (normals+specular) G-buffer. + + + + + A globally set property name. + + + + + Reflections gathered from default reflection and reflections probes. + + + + + The given RenderTexture. + + + + + Resolved depth buffer from deferred. + + + + + Defines set by editor when compiling shaders, depending on target platform and tier. + + + + + SHADER_API_DESKTOP is set when compiling shader for "desktop" platforms. + + + + + SHADER_API_MOBILE is set when compiling shader for mobile platforms. + + + + + UNITY_COLORSPACE_GAMMA is set when compiling shaders for Gamma Color Space. + + + + + UNITY_ENABLE_DETAIL_NORMALMAP is set if Detail Normal Map should be sampled if assigned. + + + + + UNITY_ENABLE_NATIVE_SHADOW_LOOKUPS enables use of built-in shadow comparison samplers on OpenGL ES 2.0. + + + + + UNITY_ENABLE_REFLECTION_BUFFERS is set when deferred shading renders reflection probes in deferred mode. With this option set reflections are rendered into a per-pixel buffer. This is similar to the way lights are rendered into a per-pixel buffer. UNITY_ENABLE_REFLECTION_BUFFERS is on by default when using deferred shading, but you can turn it off by setting “No support” for the Deferred Reflections shader option in Graphics Settings. When the setting is off, reflection probes are rendered per-object, similar to the way forward rendering works. + + + + + UNITY_FRAMEBUFFER_FETCH_AVAILABLE is set when compiling shaders for platforms where framebuffer fetch is potentially available. + + + + + UNITY_HALF_PRECISION_FRAGMENT_SHADER_REGISTERS is set automatically for platforms that don't require full floating-point precision support in fragment shaders. + + + + + UNITY_HARDWARE_TIER1 is set when compiling shaders for GraphicsTier.Tier1. + + + + + UNITY_HARDWARE_TIER2 is set when compiling shaders for GraphicsTier.Tier2. + + + + + UNITY_HARDWARE_TIER3 is set when compiling shaders for GraphicsTier.Tier3. + + + + + UNITY_LIGHT_PROBE_PROXY_VOLUME is set when Light Probe Proxy Volume feature is supported by the current graphics API and is enabled in the current Tier Settings(Graphics Settings). + + + + + UNITY_LIGHTMAP_DLDR_ENCODING is set when lightmap textures are using double LDR encoding to store the values in the texture. + + + + + UNITY_LIGHTMAP_FULL_HDR is set when lightmap textures are not using any encoding to store the values in the texture. + + + + + UNITY_LIGHTMAP_RGBM_ENCODING is set when lightmap textures are using RGBM encoding to store the values in the texture. + + + + + UNITY_METAL_SHADOWS_USE_POINT_FILTERING is set if shadow sampler should use point filtering on iOS Metal. + + + + + UNITY_NO_DXT5nm is set when compiling shader for platform that do not support DXT5NM, meaning that normal maps will be encoded in RGB instead. + + + + + UNITY_NO_FULL_STANDARD_SHADER is set if Standard shader BRDF3 with extra simplifications should be used. + + + + + UNITY_NO_RGBM is set when compiling shader for platform that do not support RGBM, so dLDR will be used instead. + + + + + UNITY_NO_SCREENSPACE_SHADOWS is set when screenspace cascaded shadow maps are disabled. + + + + + UNITY_PBS_USE_BRDF1 is set if Standard Shader BRDF1 should be used. + + + + + UNITY_PBS_USE_BRDF2 is set if Standard Shader BRDF2 should be used. + + + + + UNITY_PBS_USE_BRDF3 is set if Standard Shader BRDF3 should be used. + + + + + UNITY_SPECCUBE_BLENDING is set if Reflection Probes Blending is enabled. + + + + + UNITY_SPECCUBE_BLENDING is set if Reflection Probes Box Projection is enabled. + + + + + UNITY_USE_DITHER_MASK_FOR_ALPHABLENDED_SHADOWS is set when Semitransparent Shadows are enabled. + + + + + Built-in shader modes used by Rendering.GraphicsSettings. + + + + + Don't use any shader, effectively disabling the functionality. + + + + + Use built-in shader (default). + + + + + Use custom shader instead of built-in one. + + + + + Built-in shader types used by Rendering.GraphicsSettings. + + + + + Shader used for deferred reflection probes. + + + + + Shader used for deferred shading calculations. + + + + + Shader used for depth and normals texture when enabled on a Camera. + + + + + Shader used for legacy deferred lighting calculations. + + + + + Default shader used for lens flares. + + + + + Default shader used for light halos. + + + + + Shader used for Motion Vectors when enabled on a Camera. + + + + + Shader used for screen-space cascaded shadows. + + + + + Defines a place in camera's rendering to attach Rendering.CommandBuffer objects to. + + + + + After camera's depth+normals texture is generated. + + + + + After camera's depth texture is generated. + + + + + After camera has done rendering everything. + + + + + After final geometry pass in deferred lighting. + + + + + After transparent objects in forward rendering. + + + + + After opaque objects in forward rendering. + + + + + After deferred rendering G-buffer is rendered. + + + + + After halo and lens flares. + + + + + After image effects. + + + + + After image effects that happen between opaque & transparent objects. + + + + + After lighting pass in deferred rendering. + + + + + After reflections pass in deferred rendering. + + + + + After skybox is drawn. + + + + + Before camera's depth+normals texture is generated. + + + + + Before camera's depth texture is generated. + + + + + Before final geometry pass in deferred lighting. + + + + + Before transparent objects in forward rendering. + + + + + Before opaque objects in forward rendering. + + + + + Before deferred rendering G-buffer is rendered. + + + + + Before halo and lens flares. + + + + + Before image effects. + + + + + Before image effects that happen between opaque & transparent objects. + + + + + Before lighting pass in deferred rendering. + + + + + Before reflections pass in deferred rendering. + + + + + Before skybox is drawn. + + + + + The HDR mode to use for rendering. + + + + + Uses RenderTextureFormat.ARGBHalf. + + + + + Uses RenderTextureFormat.RGB111110Float. + + + + + Specifies which color components will get written into the target framebuffer. + + + + + Write all components (R, G, B and Alpha). + + + + + Write alpha component. + + + + + Write blue component. + + + + + Write green component. + + + + + Write red component. + + + + + List of graphics commands to execute. + + + + + Name of this command buffer. + + + + + Size of this command buffer in bytes (Read Only). + + + + + Adds a command to begin profile sampling. + + Name of the profile information used for sampling. + + + + Add a "blit into a render texture" command. + + Source texture or render target to blit from. + Destination to blit into. + Material to use. + Shader pass to use (default is -1, meaning "all passes"). + Scale applied to the source texture coordinate. + Offset applied to the source texture coordinate. + + + + Add a "blit into a render texture" command. + + Source texture or render target to blit from. + Destination to blit into. + Material to use. + Shader pass to use (default is -1, meaning "all passes"). + Scale applied to the source texture coordinate. + Offset applied to the source texture coordinate. + + + + Add a "blit into a render texture" command. + + Source texture or render target to blit from. + Destination to blit into. + Material to use. + Shader pass to use (default is -1, meaning "all passes"). + Scale applied to the source texture coordinate. + Offset applied to the source texture coordinate. + + + + Add a "blit into a render texture" command. + + Source texture or render target to blit from. + Destination to blit into. + Material to use. + Shader pass to use (default is -1, meaning "all passes"). + Scale applied to the source texture coordinate. + Offset applied to the source texture coordinate. + + + + Add a "blit into a render texture" command. + + Source texture or render target to blit from. + Destination to blit into. + Material to use. + Shader pass to use (default is -1, meaning "all passes"). + Scale applied to the source texture coordinate. + Offset applied to the source texture coordinate. + + + + Add a "blit into a render texture" command. + + Source texture or render target to blit from. + Destination to blit into. + Material to use. + Shader pass to use (default is -1, meaning "all passes"). + Scale applied to the source texture coordinate. + Offset applied to the source texture coordinate. + + + + Add a "blit into a render texture" command. + + Source texture or render target to blit from. + Destination to blit into. + Material to use. + Shader pass to use (default is -1, meaning "all passes"). + Scale applied to the source texture coordinate. + Offset applied to the source texture coordinate. + + + + Add a "blit into a render texture" command. + + Source texture or render target to blit from. + Destination to blit into. + Material to use. + Shader pass to use (default is -1, meaning "all passes"). + Scale applied to the source texture coordinate. + Offset applied to the source texture coordinate. + + + + Clear all commands in the buffer. + + + + + Clear random write targets for level pixel shaders. + + + + + Adds a "clear render target" command. + + Should clear depth buffer? + Should clear color buffer? + Color to clear with. + Depth to clear with (default is 1.0). + + + + Converts and copies a source texture to a destination texture with a different format or dimensions. + + Source texture. + Destination texture. + Source element (e.g. cubemap face). Set this to 0 for 2D source textures. + Destination element (e.g. cubemap face or texture array element). + + + + Converts and copies a source texture to a destination texture with a different format or dimensions. + + Source texture. + Destination texture. + Source element (e.g. cubemap face). Set this to 0 for 2D source textures. + Destination element (e.g. cubemap face or texture array element). + + + + Adds a command to copy ComputeBuffer counter value. + + Append/consume buffer to copy the counter from. + A buffer to copy the counter to. + Target byte offset in dst buffer. + + + + Adds a command to copy a texture into another texture. + + Source texture or identifier, see RenderTargetIdentifier. + Destination texture or identifier, see RenderTargetIdentifier. + Source texture element (cubemap face, texture array layer or 3D texture depth slice). + Source texture mipmap level. + Destination texture element (cubemap face, texture array layer or 3D texture depth slice). + Destination texture mipmap level. + X coordinate of source texture region to copy (left side is zero). + Y coordinate of source texture region to copy (bottom is zero). + Width of source texture region to copy. + Height of source texture region to copy. + X coordinate of where to copy region in destination texture (left side is zero). + Y coordinate of where to copy region in destination texture (bottom is zero). + + + + Adds a command to copy a texture into another texture. + + Source texture or identifier, see RenderTargetIdentifier. + Destination texture or identifier, see RenderTargetIdentifier. + Source texture element (cubemap face, texture array layer or 3D texture depth slice). + Source texture mipmap level. + Destination texture element (cubemap face, texture array layer or 3D texture depth slice). + Destination texture mipmap level. + X coordinate of source texture region to copy (left side is zero). + Y coordinate of source texture region to copy (bottom is zero). + Width of source texture region to copy. + Height of source texture region to copy. + X coordinate of where to copy region in destination texture (left side is zero). + Y coordinate of where to copy region in destination texture (bottom is zero). + + + + Adds a command to copy a texture into another texture. + + Source texture or identifier, see RenderTargetIdentifier. + Destination texture or identifier, see RenderTargetIdentifier. + Source texture element (cubemap face, texture array layer or 3D texture depth slice). + Source texture mipmap level. + Destination texture element (cubemap face, texture array layer or 3D texture depth slice). + Destination texture mipmap level. + X coordinate of source texture region to copy (left side is zero). + Y coordinate of source texture region to copy (bottom is zero). + Width of source texture region to copy. + Height of source texture region to copy. + X coordinate of where to copy region in destination texture (left side is zero). + Y coordinate of where to copy region in destination texture (bottom is zero). + + + + Adds a command to copy a texture into another texture. + + Source texture or identifier, see RenderTargetIdentifier. + Destination texture or identifier, see RenderTargetIdentifier. + Source texture element (cubemap face, texture array layer or 3D texture depth slice). + Source texture mipmap level. + Destination texture element (cubemap face, texture array layer or 3D texture depth slice). + Destination texture mipmap level. + X coordinate of source texture region to copy (left side is zero). + Y coordinate of source texture region to copy (bottom is zero). + Width of source texture region to copy. + Height of source texture region to copy. + X coordinate of where to copy region in destination texture (left side is zero). + Y coordinate of where to copy region in destination texture (bottom is zero). + + + + Creates a GPUFence which will be passed after the last Blit, Clear, Draw, Dispatch or Texture Copy command prior to this call has been completed on the GPU. + + On some platforms there is a significant gap between the vertex processing completing and the pixel processing begining for a given draw call. This parameter allows for the fence to be passed after either the vertex or pixel processing for the proceeding draw has completed. If a compute shader dispatch was the last task submitted then this parameter is ignored. + + Returns a new GPUFence. + + + + + Create a new empty command buffer. + + + + + Add a command to disable the hardware scissor rectangle. + + + + + Adds a command to disable global shader keyword. + + Shader keyword to disable. + + + + Add a command to execute a ComputeShader. + + ComputeShader to execute. + Kernel index to execute, see ComputeShader.FindKernel. + Number of work groups in the X dimension. + Number of work groups in the Y dimension. + Number of work groups in the Z dimension. + ComputeBuffer with dispatch arguments. + Byte offset indicating the location of the dispatch arguments in the buffer. + + + + Add a command to execute a ComputeShader. + + ComputeShader to execute. + Kernel index to execute, see ComputeShader.FindKernel. + Number of work groups in the X dimension. + Number of work groups in the Y dimension. + Number of work groups in the Z dimension. + ComputeBuffer with dispatch arguments. + Byte offset indicating the location of the dispatch arguments in the buffer. + + + + Add a "draw mesh" command. + + Mesh to draw. + Transformation matrix to use. + Material to use. + Which subset of the mesh to render. + Which pass of the shader to use (default is -1, which renders all passes). + Additional material properties to apply onto material just before this mesh will be drawn. See MaterialPropertyBlock. + + + + Add a "draw mesh with instancing" command. + +The command will not immediately fail and throw an exception if Material.enableInstancing is false, but it will log an error and skips rendering each time the command is being executed if such a condition is detected. + +InvalidOperationException will be thrown if the current platform doesn't support this API (i.e. if GPU instancing is not available). See SystemInfo.supportsInstancing. + + The Mesh to draw. + Which subset of the mesh to draw. This applies only to meshes that are composed of several materials. + Material to use. + Which pass of the shader to use, or -1 which renders all passes. + The array of object transformation matrices. + The number of instances to be drawn. + Additional material properties to apply onto material just before this mesh will be drawn. See MaterialPropertyBlock. + + + + Add a "draw mesh with indirect instancing" command. + + The Mesh to draw. + Which subset of the mesh to draw. This applies only to meshes that are composed of several materials. + Material to use. + Which pass of the shader to use, or -1 which renders all passes. + Additional material properties to apply onto material just before this mesh will be drawn. See MaterialPropertyBlock. + The GPU buffer containing the arguments for how many instances of this mesh to draw. + The byte offset into the buffer, where the draw arguments start. + + + + Add a "draw procedural geometry" command. + + Transformation matrix to use. + Material to use. + Which pass of the shader to use (or -1 for all passes). + Topology of the procedural geometry. + Vertex count to render. + Instance count to render. + Additional material properties to apply just before rendering. See MaterialPropertyBlock. + + + + Add a "draw procedural geometry" command. + + Transformation matrix to use. + Material to use. + Which pass of the shader to use (or -1 for all passes). + Topology of the procedural geometry. + Additional material properties to apply just before rendering. See MaterialPropertyBlock. + Buffer with draw arguments. + Byte offset where in the buffer the draw arguments are. + + + + Add a "draw renderer" command. + + Renderer to draw. + Material to use. + Which subset of the mesh to render. + Which pass of the shader to use (default is -1, which renders all passes). + + + + Add a command to enable the hardware scissor rectangle. + + Viewport rectangle in pixel coordinates. + + + + Adds a command to enable global shader keyword. + + Shader keyword to enable. + + + + Adds a command to begin profile sampling. + + Name of the profile information used for sampling. + + + + Generate mipmap levels of a render texture. + + The render texture requiring mipmaps generation. + + + + Add a "get a temporary render texture" command. + + Shader property name for this texture. + Width in pixels, or -1 for "camera pixel width". + Height in pixels, or -1 for "camera pixel height". + Depth buffer bits (0, 16 or 24). + Texture filtering mode (default is Point). + Format of the render texture (default is ARGB32). + Color space conversion mode. + Anti-aliasing (default is no anti-aliasing). + Should random-write access into the texture be enabled (default is false). + Use this RenderTextureDescriptor for the settings when creating the temporary RenderTexture. + Render texture memoryless mode. + + + + Add a "get a temporary render texture" command. + + Shader property name for this texture. + Width in pixels, or -1 for "camera pixel width". + Height in pixels, or -1 for "camera pixel height". + Depth buffer bits (0, 16 or 24). + Texture filtering mode (default is Point). + Format of the render texture (default is ARGB32). + Color space conversion mode. + Anti-aliasing (default is no anti-aliasing). + Should random-write access into the texture be enabled (default is false). + Use this RenderTextureDescriptor for the settings when creating the temporary RenderTexture. + Render texture memoryless mode. + + + + Add a "get a temporary render texture array" command. + + Shader property name for this texture. + Width in pixels, or -1 for "camera pixel width". + Height in pixels, or -1 for "camera pixel height". + Number of slices in texture array. + Depth buffer bits (0, 16 or 24). + Texture filtering mode (default is Point). + Format of the render texture (default is ARGB32). + Color space conversion mode. + Anti-aliasing (default is no anti-aliasing). + Should random-write access into the texture be enabled (default is false). + + + + Send a user-defined blit event to a native code plugin. + + Native code callback to queue for Unity's renderer to invoke. + User defined command id to send to the callback. + Source render target. + Destination render target. + User data command parameters. + User data command flags. + + + + Deprecated. Use CommandBuffer.IssuePluginCustomTextureUpdateV2 instead. + + Native code callback to queue for Unity's renderer to invoke. + Texture resource to be updated. + User data to send to the native plugin. + + + + Deprecated. Use CommandBuffer.IssuePluginCustomTextureUpdateV2 instead. + + Native code callback to queue for Unity's renderer to invoke. + Texture resource to be updated. + User data to send to the native plugin. + + + + Send a texture update event to a native code plugin. + + Native code callback to queue for Unity's renderer to invoke. + Texture resource to be updated. + User data to send to the native plugin. + + + + Send a user-defined event to a native code plugin. + + Native code callback to queue for Unity's renderer to invoke. + User defined id to send to the callback. + + + + Send a user-defined event to a native code plugin with custom data. + + Native code callback to queue for Unity's renderer to invoke. + Custom data to pass to the native plugin callback. + Built in or user defined id to send to the callback. + + + + Add a "release a temporary render texture" command. + + Shader property name for this texture. + + + + Adds an asynchonous GPU readback request command to the command buffer. + + The resource to read the data from. + Size in bytes of the data to be retrieved from the ComputeBuffer. + Offset in bytes in the ComputeBuffer. + The index of the mipmap to be fetched. + The target TextureFormat of the data. Conversion will happen automatically if format is different from the format stored on GPU. + Starting X coordinate in pixels of the Texture data to be fetched. + Starting Y coordinate in pixels of the Texture data to be fetched. + Start Z coordinate in pixels for the Texture3D being fetched. Index of Start layer for TextureCube, Texture2DArray and TextureCubeArray being fetched. + Depth in pixels for Texture3D being fetched. Number of layers for TextureCube, TextureArray and TextureCubeArray. + Width in pixels of the Texture data to be fetched. + Height in pixels of the Texture data to be fetched. + A delegate System.Action called once the request is fullfilled. The done request is passed as parameter to the System.Action. + + + + Adds an asynchonous GPU readback request command to the command buffer. + + The resource to read the data from. + Size in bytes of the data to be retrieved from the ComputeBuffer. + Offset in bytes in the ComputeBuffer. + The index of the mipmap to be fetched. + The target TextureFormat of the data. Conversion will happen automatically if format is different from the format stored on GPU. + Starting X coordinate in pixels of the Texture data to be fetched. + Starting Y coordinate in pixels of the Texture data to be fetched. + Start Z coordinate in pixels for the Texture3D being fetched. Index of Start layer for TextureCube, Texture2DArray and TextureCubeArray being fetched. + Depth in pixels for Texture3D being fetched. Number of layers for TextureCube, TextureArray and TextureCubeArray. + Width in pixels of the Texture data to be fetched. + Height in pixels of the Texture data to be fetched. + A delegate System.Action called once the request is fullfilled. The done request is passed as parameter to the System.Action. + + + + Adds an asynchonous GPU readback request command to the command buffer. + + The resource to read the data from. + Size in bytes of the data to be retrieved from the ComputeBuffer. + Offset in bytes in the ComputeBuffer. + The index of the mipmap to be fetched. + The target TextureFormat of the data. Conversion will happen automatically if format is different from the format stored on GPU. + Starting X coordinate in pixels of the Texture data to be fetched. + Starting Y coordinate in pixels of the Texture data to be fetched. + Start Z coordinate in pixels for the Texture3D being fetched. Index of Start layer for TextureCube, Texture2DArray and TextureCubeArray being fetched. + Depth in pixels for Texture3D being fetched. Number of layers for TextureCube, TextureArray and TextureCubeArray. + Width in pixels of the Texture data to be fetched. + Height in pixels of the Texture data to be fetched. + A delegate System.Action called once the request is fullfilled. The done request is passed as parameter to the System.Action. + + + + Adds an asynchonous GPU readback request command to the command buffer. + + The resource to read the data from. + Size in bytes of the data to be retrieved from the ComputeBuffer. + Offset in bytes in the ComputeBuffer. + The index of the mipmap to be fetched. + The target TextureFormat of the data. Conversion will happen automatically if format is different from the format stored on GPU. + Starting X coordinate in pixels of the Texture data to be fetched. + Starting Y coordinate in pixels of the Texture data to be fetched. + Start Z coordinate in pixels for the Texture3D being fetched. Index of Start layer for TextureCube, Texture2DArray and TextureCubeArray being fetched. + Depth in pixels for Texture3D being fetched. Number of layers for TextureCube, TextureArray and TextureCubeArray. + Width in pixels of the Texture data to be fetched. + Height in pixels of the Texture data to be fetched. + A delegate System.Action called once the request is fullfilled. The done request is passed as parameter to the System.Action. + + + + Adds an asynchonous GPU readback request command to the command buffer. + + The resource to read the data from. + Size in bytes of the data to be retrieved from the ComputeBuffer. + Offset in bytes in the ComputeBuffer. + The index of the mipmap to be fetched. + The target TextureFormat of the data. Conversion will happen automatically if format is different from the format stored on GPU. + Starting X coordinate in pixels of the Texture data to be fetched. + Starting Y coordinate in pixels of the Texture data to be fetched. + Start Z coordinate in pixels for the Texture3D being fetched. Index of Start layer for TextureCube, Texture2DArray and TextureCubeArray being fetched. + Depth in pixels for Texture3D being fetched. Number of layers for TextureCube, TextureArray and TextureCubeArray. + Width in pixels of the Texture data to be fetched. + Height in pixels of the Texture data to be fetched. + A delegate System.Action called once the request is fullfilled. The done request is passed as parameter to the System.Action. + + + + Adds an asynchonous GPU readback request command to the command buffer. + + The resource to read the data from. + Size in bytes of the data to be retrieved from the ComputeBuffer. + Offset in bytes in the ComputeBuffer. + The index of the mipmap to be fetched. + The target TextureFormat of the data. Conversion will happen automatically if format is different from the format stored on GPU. + Starting X coordinate in pixels of the Texture data to be fetched. + Starting Y coordinate in pixels of the Texture data to be fetched. + Start Z coordinate in pixels for the Texture3D being fetched. Index of Start layer for TextureCube, Texture2DArray and TextureCubeArray being fetched. + Depth in pixels for Texture3D being fetched. Number of layers for TextureCube, TextureArray and TextureCubeArray. + Width in pixels of the Texture data to be fetched. + Height in pixels of the Texture data to be fetched. + A delegate System.Action called once the request is fullfilled. The done request is passed as parameter to the System.Action. + + + + Adds an asynchonous GPU readback request command to the command buffer. + + The resource to read the data from. + Size in bytes of the data to be retrieved from the ComputeBuffer. + Offset in bytes in the ComputeBuffer. + The index of the mipmap to be fetched. + The target TextureFormat of the data. Conversion will happen automatically if format is different from the format stored on GPU. + Starting X coordinate in pixels of the Texture data to be fetched. + Starting Y coordinate in pixels of the Texture data to be fetched. + Start Z coordinate in pixels for the Texture3D being fetched. Index of Start layer for TextureCube, Texture2DArray and TextureCubeArray being fetched. + Depth in pixels for Texture3D being fetched. Number of layers for TextureCube, TextureArray and TextureCubeArray. + Width in pixels of the Texture data to be fetched. + Height in pixels of the Texture data to be fetched. + A delegate System.Action called once the request is fullfilled. The done request is passed as parameter to the System.Action. + + + + Force an antialiased render texture to be resolved. + + The antialiased render texture to resolve. + The render texture to resolve into. If set, the target render texture must have the same dimensions and format as the source. + + + + Adds a command to set an input or output buffer parameter on a ComputeShader. + + ComputeShader to set parameter for. + Which kernel the buffer is being set for. See ComputeShader.FindKernel. + Name of the buffer variable in shader code. + Property name ID. Use Shader.PropertyToID to get this ID. + Buffer to set. + + + + Adds a command to set an input or output buffer parameter on a ComputeShader. + + ComputeShader to set parameter for. + Which kernel the buffer is being set for. See ComputeShader.FindKernel. + Name of the buffer variable in shader code. + Property name ID. Use Shader.PropertyToID to get this ID. + Buffer to set. + + + + Adds a command to set a float parameter on a ComputeShader. + + ComputeShader to set parameter for. + Name of the variable in shader code. + Property name ID. Use Shader.PropertyToID to get this ID. + Value to set. + + + + Adds a command to set a float parameter on a ComputeShader. + + ComputeShader to set parameter for. + Name of the variable in shader code. + Property name ID. Use Shader.PropertyToID to get this ID. + Value to set. + + + + Adds a command to set multiple consecutive float parameters on a ComputeShader. + + ComputeShader to set parameter for. + Name of the variable in shader code. + Property name ID. Use Shader.PropertyToID to get this ID. + Values to set. + + + + Adds a command to set multiple consecutive float parameters on a ComputeShader. + + ComputeShader to set parameter for. + Name of the variable in shader code. + Property name ID. Use Shader.PropertyToID to get this ID. + Values to set. + + + + Adds a command to set an integer parameter on a ComputeShader. + + ComputeShader to set parameter for. + Name of the variable in shader code. + Property name ID. Use Shader.PropertyToID to get this ID. + Value to set. + + + + Adds a command to set an integer parameter on a ComputeShader. + + ComputeShader to set parameter for. + Name of the variable in shader code. + Property name ID. Use Shader.PropertyToID to get this ID. + Value to set. + + + + Adds a command to set multiple consecutive integer parameters on a ComputeShader. + + ComputeShader to set parameter for. + Name of the variable in shader code. + Property name ID. Use Shader.PropertyToID to get this ID. + Values to set. + + + + Adds a command to set multiple consecutive integer parameters on a ComputeShader. + + ComputeShader to set parameter for. + Name of the variable in shader code. + Property name ID. Use Shader.PropertyToID to get this ID. + Values to set. + + + + Adds a command to set a matrix array parameter on a ComputeShader. + + ComputeShader to set parameter for. + Name of the variable in shader code. + Property name ID. Use Shader.PropertyToID to get this ID. + Value to set. + + + + Adds a command to set a matrix array parameter on a ComputeShader. + + ComputeShader to set parameter for. + Name of the variable in shader code. + Property name ID. Use Shader.PropertyToID to get this ID. + Value to set. + + + + Adds a command to set a matrix parameter on a ComputeShader. + + ComputeShader to set parameter for. + Name of the variable in shader code. + Property name ID. Use Shader.PropertyToID to get this ID. + Value to set. + + + + Adds a command to set a matrix parameter on a ComputeShader. + + ComputeShader to set parameter for. + Name of the variable in shader code. + Property name ID. Use Shader.PropertyToID to get this ID. + Value to set. + + + + Adds a command to set a texture parameter on a ComputeShader. + + ComputeShader to set parameter for. + Which kernel the texture is being set for. See ComputeShader.FindKernel. + Name of the texture variable in shader code. + Property name ID. Use Shader.PropertyToID to get this ID. + Texture value or identifier to set, see RenderTargetIdentifier. + Optional mipmap level of the read-write texture. + + + + Adds a command to set a texture parameter on a ComputeShader. + + ComputeShader to set parameter for. + Which kernel the texture is being set for. See ComputeShader.FindKernel. + Name of the texture variable in shader code. + Property name ID. Use Shader.PropertyToID to get this ID. + Texture value or identifier to set, see RenderTargetIdentifier. + Optional mipmap level of the read-write texture. + + + + Adds a command to set a texture parameter on a ComputeShader. + + ComputeShader to set parameter for. + Which kernel the texture is being set for. See ComputeShader.FindKernel. + Name of the texture variable in shader code. + Property name ID. Use Shader.PropertyToID to get this ID. + Texture value or identifier to set, see RenderTargetIdentifier. + Optional mipmap level of the read-write texture. + + + + Adds a command to set a texture parameter on a ComputeShader. + + ComputeShader to set parameter for. + Which kernel the texture is being set for. See ComputeShader.FindKernel. + Name of the texture variable in shader code. + Property name ID. Use Shader.PropertyToID to get this ID. + Texture value or identifier to set, see RenderTargetIdentifier. + Optional mipmap level of the read-write texture. + + + + Adds a command to set a vector array parameter on a ComputeShader. + + ComputeShader to set parameter for. + Property name. + Property name ID. Use Shader.PropertyToID to get this ID. + Value to set. + + + + Adds a command to set a vector array parameter on a ComputeShader. + + ComputeShader to set parameter for. + Property name. + Property name ID. Use Shader.PropertyToID to get this ID. + Value to set. + + + + Adds a command to set a vector parameter on a ComputeShader. + + ComputeShader to set parameter for. + Name of the variable in shader code. + Property name ID. Use Shader.PropertyToID to get this ID. + Value to set. + + + + Adds a command to set a vector parameter on a ComputeShader. + + ComputeShader to set parameter for. + Name of the variable in shader code. + Property name ID. Use Shader.PropertyToID to get this ID. + Value to set. + + + + Add a "set global shader buffer property" command. + + + + + + + + Add a "set global shader buffer property" command. + + + + + + + + Add a "set global shader color property" command. + + + + + + + + Add a "set global shader color property" command. + + + + + + + + Add a command to set global depth bias. + + Constant depth bias. + Slope-dependent depth bias. + + + + Add a "set global shader float property" command. + + + + + + + + Add a "set global shader float property" command. + + + + + + + + Add a "set global shader float array property" command. + + + + + + + + Add a "set global shader float array property" command. + + + + + + + + Add a "set global shader float array property" command. + + + + + + + + Add a "set global shader float array property" command. + + + + + + + + Sets the given global integer property for all shaders. + + + + + + + + Sets the given global integer property for all shaders. + + + + + + + + Add a "set global shader matrix property" command. + + + + + + + + Add a "set global shader matrix property" command. + + + + + + + + Add a "set global shader matrix array property" command. + + + + + + + + Add a "set global shader matrix array property" command. + + + + + + + + Add a "set global shader matrix array property" command. + + + + + + + + Add a "set global shader matrix array property" command. + + + + + + + + Add a "set global shader texture property" command, referencing a RenderTexture. + + + + + + + + Add a "set global shader texture property" command, referencing a RenderTexture. + + + + + + + + Add a "set global shader vector property" command. + + + + + + + + Add a "set global shader vector property" command. + + + + + + + + Add a "set global shader vector array property" command. + + + + + + + + Add a "set global shader vector array property" command. + + + + + + + + Add a "set global shader vector array property" command. + + + + + + + + Add a "set global shader vector array property" command. + + + + + + + + Add a "set invert culling" command to the buffer. + + A boolean indicating whether to invert the backface culling (true) or not (false). + + + + Add a command to set the projection matrix. + + Projection (camera to clip space) matrix. + + + + Set random write target for level pixel shaders. + + Index of the random write target in the shader. + ComputeBuffer to set as write targe. + Whether to leave the append/consume counter value unchanged. + RenderTargetIdentifier to set as write target. + + + + Set random write target for level pixel shaders. + + Index of the random write target in the shader. + ComputeBuffer to set as write targe. + Whether to leave the append/consume counter value unchanged. + RenderTargetIdentifier to set as write target. + + + + Add a "set active render target" command. + + Render target to set for both color & depth buffers. + Render target to set as a color buffer. + Render targets to set as color buffers (MRT). + Render target to set as a depth buffer. + The mip level of the render target to render into. + The cubemap face of a cubemap render target to render into. + Slice of a 3D or array render target to set. + Load action that is used for color and depth/stencil buffers. + Store action that is used for color and depth/stencil buffers. + Load action that is used for the color buffer. + Store action that is used for the color buffer. + Load action that is used for the depth/stencil buffer. + Store action that is used for the depth/stencil buffer. + + + + + Add a "set active render target" command. + + Render target to set for both color & depth buffers. + Render target to set as a color buffer. + Render targets to set as color buffers (MRT). + Render target to set as a depth buffer. + The mip level of the render target to render into. + The cubemap face of a cubemap render target to render into. + Slice of a 3D or array render target to set. + Load action that is used for color and depth/stencil buffers. + Store action that is used for color and depth/stencil buffers. + Load action that is used for the color buffer. + Store action that is used for the color buffer. + Load action that is used for the depth/stencil buffer. + Store action that is used for the depth/stencil buffer. + + + + + Add a "set active render target" command. + + Render target to set for both color & depth buffers. + Render target to set as a color buffer. + Render targets to set as color buffers (MRT). + Render target to set as a depth buffer. + The mip level of the render target to render into. + The cubemap face of a cubemap render target to render into. + Slice of a 3D or array render target to set. + Load action that is used for color and depth/stencil buffers. + Store action that is used for color and depth/stencil buffers. + Load action that is used for the color buffer. + Store action that is used for the color buffer. + Load action that is used for the depth/stencil buffer. + Store action that is used for the depth/stencil buffer. + + + + + Add a "set active render target" command. + + Render target to set for both color & depth buffers. + Render target to set as a color buffer. + Render targets to set as color buffers (MRT). + Render target to set as a depth buffer. + The mip level of the render target to render into. + The cubemap face of a cubemap render target to render into. + Slice of a 3D or array render target to set. + Load action that is used for color and depth/stencil buffers. + Store action that is used for color and depth/stencil buffers. + Load action that is used for the color buffer. + Store action that is used for the color buffer. + Load action that is used for the depth/stencil buffer. + Store action that is used for the depth/stencil buffer. + + + + + Add a "set active render target" command. + + Render target to set for both color & depth buffers. + Render target to set as a color buffer. + Render targets to set as color buffers (MRT). + Render target to set as a depth buffer. + The mip level of the render target to render into. + The cubemap face of a cubemap render target to render into. + Slice of a 3D or array render target to set. + Load action that is used for color and depth/stencil buffers. + Store action that is used for color and depth/stencil buffers. + Load action that is used for the color buffer. + Store action that is used for the color buffer. + Load action that is used for the depth/stencil buffer. + Store action that is used for the depth/stencil buffer. + + + + + Add a "set active render target" command. + + Render target to set for both color & depth buffers. + Render target to set as a color buffer. + Render targets to set as color buffers (MRT). + Render target to set as a depth buffer. + The mip level of the render target to render into. + The cubemap face of a cubemap render target to render into. + Slice of a 3D or array render target to set. + Load action that is used for color and depth/stencil buffers. + Store action that is used for color and depth/stencil buffers. + Load action that is used for the color buffer. + Store action that is used for the color buffer. + Load action that is used for the depth/stencil buffer. + Store action that is used for the depth/stencil buffer. + + + + + Add a "set active render target" command. + + Render target to set for both color & depth buffers. + Render target to set as a color buffer. + Render targets to set as color buffers (MRT). + Render target to set as a depth buffer. + The mip level of the render target to render into. + The cubemap face of a cubemap render target to render into. + Slice of a 3D or array render target to set. + Load action that is used for color and depth/stencil buffers. + Store action that is used for color and depth/stencil buffers. + Load action that is used for the color buffer. + Store action that is used for the color buffer. + Load action that is used for the depth/stencil buffer. + Store action that is used for the depth/stencil buffer. + + + + + Add a "set active render target" command. + + Render target to set for both color & depth buffers. + Render target to set as a color buffer. + Render targets to set as color buffers (MRT). + Render target to set as a depth buffer. + The mip level of the render target to render into. + The cubemap face of a cubemap render target to render into. + Slice of a 3D or array render target to set. + Load action that is used for color and depth/stencil buffers. + Store action that is used for color and depth/stencil buffers. + Load action that is used for the color buffer. + Store action that is used for the color buffer. + Load action that is used for the depth/stencil buffer. + Store action that is used for the depth/stencil buffer. + + + + + Add a "set active render target" command. + + Render target to set for both color & depth buffers. + Render target to set as a color buffer. + Render targets to set as color buffers (MRT). + Render target to set as a depth buffer. + The mip level of the render target to render into. + The cubemap face of a cubemap render target to render into. + Slice of a 3D or array render target to set. + Load action that is used for color and depth/stencil buffers. + Store action that is used for color and depth/stencil buffers. + Load action that is used for the color buffer. + Store action that is used for the color buffer. + Load action that is used for the depth/stencil buffer. + Store action that is used for the depth/stencil buffer. + + + + + Add a "set active render target" command. + + Render target to set for both color & depth buffers. + Render target to set as a color buffer. + Render targets to set as color buffers (MRT). + Render target to set as a depth buffer. + The mip level of the render target to render into. + The cubemap face of a cubemap render target to render into. + Slice of a 3D or array render target to set. + Load action that is used for color and depth/stencil buffers. + Store action that is used for color and depth/stencil buffers. + Load action that is used for the color buffer. + Store action that is used for the color buffer. + Load action that is used for the depth/stencil buffer. + Store action that is used for the depth/stencil buffer. + + + + + Add a "set active render target" command. + + Render target to set for both color & depth buffers. + Render target to set as a color buffer. + Render targets to set as color buffers (MRT). + Render target to set as a depth buffer. + The mip level of the render target to render into. + The cubemap face of a cubemap render target to render into. + Slice of a 3D or array render target to set. + Load action that is used for color and depth/stencil buffers. + Store action that is used for color and depth/stencil buffers. + Load action that is used for the color buffer. + Store action that is used for the color buffer. + Load action that is used for the depth/stencil buffer. + Store action that is used for the depth/stencil buffer. + + + + + Add a "set active render target" command. + + Render target to set for both color & depth buffers. + Render target to set as a color buffer. + Render targets to set as color buffers (MRT). + Render target to set as a depth buffer. + The mip level of the render target to render into. + The cubemap face of a cubemap render target to render into. + Slice of a 3D or array render target to set. + Load action that is used for color and depth/stencil buffers. + Store action that is used for color and depth/stencil buffers. + Load action that is used for the color buffer. + Store action that is used for the color buffer. + Load action that is used for the depth/stencil buffer. + Store action that is used for the depth/stencil buffer. + + + + + Add a "set active render target" command. + + Render target to set for both color & depth buffers. + Render target to set as a color buffer. + Render targets to set as color buffers (MRT). + Render target to set as a depth buffer. + The mip level of the render target to render into. + The cubemap face of a cubemap render target to render into. + Slice of a 3D or array render target to set. + Load action that is used for color and depth/stencil buffers. + Store action that is used for color and depth/stencil buffers. + Load action that is used for the color buffer. + Store action that is used for the color buffer. + Load action that is used for the depth/stencil buffer. + Store action that is used for the depth/stencil buffer. + + + + + Add a "set shadow sampling mode" command. + + Shadowmap render target to change the sampling mode on. + New sampling mode. + + + + Add a command to set the view matrix. + + View (world to camera space) matrix. + + + + Add a command to set the rendering viewport. + + Viewport rectangle in pixel coordinates. + + + + Add a command to set the view and projection matrices. + + View (world to camera space) matrix. + Projection (camera to clip space) matrix. + + + + Instructs the GPU to wait until the given GPUFence is passed. + + The GPUFence that the GPU will be instructed to wait upon. + On some platforms there is a significant gap between the vertex processing completing and the pixel processing completing for a given draw call. This parameter allows for requested wait to be before the next items vertex or pixel processing begins. Some platforms can not differentiate between the start of vertex and pixel processing, these platforms will wait before the next items vertex processing. If a compute shader dispatch is the next item to be submitted then this parameter is ignored. + + + + Depth or stencil comparison function. + + + + + Always pass depth or stencil test. + + + + + Depth or stencil test is disabled. + + + + + Pass depth or stencil test when values are equal. + + + + + Pass depth or stencil test when new value is greater than old one. + + + + + Pass depth or stencil test when new value is greater or equal than old one. + + + + + Pass depth or stencil test when new value is less than old one. + + + + + Pass depth or stencil test when new value is less or equal than old one. + + + + + Never pass depth or stencil test. + + + + + Pass depth or stencil test when values are different. + + + + + Describes the desired characteristics with respect to prioritisation and load balancing of the queue that a command buffer being submitted via Graphics.ExecuteCommandBufferAsync or [[ScriptableRenderContext.ExecuteCommandBufferAsync] should be sent to. + + + + + Background queue types would be the choice for tasks intended to run for an extended period of time, e.g for most of a frame or for several frames. Dispatches on background queues would execute at a lower priority than gfx queue tasks. + + + + + This queue type would be the choice for compute tasks supporting or as optimisations to graphics processing. CommandBuffers sent to this queue would be expected to complete within the scope of a single frame and likely be synchronised with the graphics queue via GPUFence’s. Dispatches on default queue types would execute at a lower priority than graphics queue tasks. + + + + + This queue type would be the choice for compute tasks requiring processing as soon as possible and would be prioritised over the graphics queue. + + + + + Support for various Graphics.CopyTexture cases. + + + + + Basic Graphics.CopyTexture support. + + + + + Support for Texture3D in Graphics.CopyTexture. + + + + + Support for Graphics.CopyTexture between different texture types. + + + + + No support for Graphics.CopyTexture. + + + + + Support for RenderTexture to Texture copies in Graphics.CopyTexture. + + + + + Support for Texture to RenderTexture copies in Graphics.CopyTexture. + + + + + Backface culling mode. + + + + + Cull back-facing geometry. + + + + + Cull front-facing geometry. + + + + + Disable culling. + + + + + Default reflection mode. + + + + + Custom default reflection. + + + + + Skybox-based default reflection. + + + + + Used to manage synchronisation between tasks on async compute queues and the graphics queue. + + + + + Has the GPUFence passed? + +Allows for CPU determination of whether the GPU has passed the point in its processing represented by the GPUFence. + + + + + Graphics device API type. + + + + + Direct3D 11 graphics API. + + + + + Direct3D 12 graphics API. + + + + + Direct3D 9 graphics API. + + + + + iOS Metal graphics API. + + + + + Nintendo 3DS graphics API. + + + + + No graphics API. + + + + + OpenGL 2.x graphics API. (deprecated, only available on Linux and MacOSX) + + + + + OpenGL (Core profile - GL3 or later) graphics API. + + + + + OpenGL ES 2.0 graphics API. + + + + + OpenGL ES 3.0 graphics API. + + + + + PlayStation 3 graphics API. + + + + + PlayStation 4 graphics API. + + + + + PlayStation Mobile (PSM) graphics API. + + + + + Nintendo Switch graphics API. + + + + + Vulkan (EXPERIMENTAL). + + + + + Xbox One graphics API using Direct3D 11. + + + + + Xbox One graphics API using Direct3D 12. + + + + + Script interface for. + + + + + Whether to use a Light's color temperature when calculating the final color of that Light." + + + + + If this is true, Light intensity is multiplied against linear color values. If it is false, gamma color values are used. + + + + + The RenderPipelineAsset that describes how the Scene should be rendered. + + + + + An axis that describes the direction along which the distances of objects are measured for the purpose of sorting. + + + + + Transparent object sorting mode. + + + + + Enable/Disable SRP batcher (experimental) at runtime. + + + + + Get custom shader used instead of a built-in shader. + + Built-in shader type to query custom shader for. + + The shader used. + + + + + Get built-in shader mode. + + Built-in shader type to query. + + Mode used for built-in shader. + + + + + Returns true if shader define was set when compiling shaders for current GraphicsTier. + + + + + + + Returns true if shader define was set when compiling shaders for given tier. + + + + + + Set custom shader to use instead of a built-in shader. + + Built-in shader type to set custom shader to. + The shader to use. + + + + Set built-in shader mode. + + Built-in shader type to change. + Mode to use for built-in shader. + + + + Graphics Tier. +See Also: Graphics.activeTier. + + + + + The first graphics tier (Low) - corresponds to shader define UNITY_HARDWARE_TIER1. + + + + + The second graphics tier (Medium) - corresponds to shader define UNITY_HARDWARE_TIER2. + + + + + The third graphics tier (High) - corresponds to shader define UNITY_HARDWARE_TIER3. + + + + + Format of the mesh index buffer data. + + + + + 16 bit mesh index buffer format. + + + + + 32 bit mesh index buffer format. + + + + + Defines a place in light's rendering to attach Rendering.CommandBuffer objects to. + + + + + After directional light screenspace shadow mask is computed. + + + + + After shadowmap is rendered. + + + + + After shadowmap pass is rendered. + + + + + Before directional light screenspace shadow mask is computed. + + + + + Before shadowmap is rendered. + + + + + Before shadowmap pass is rendered. + + + + + Light probe interpolation type. + + + + + Simple light probe interpolation is used. + + + + + The light probe shader uniform values are extracted from the material property block set on the renderer. + + + + + Light Probes are not used. The Scene's ambient probe is provided to the shader. + + + + + Uses a 3D grid of interpolated light probes. + + + + + Shadow resolution options for a Light. + + + + + Use resolution from QualitySettings (default). + + + + + High shadow map resolution. + + + + + Low shadow map resolution. + + + + + Medium shadow map resolution. + + + + + Very high shadow map resolution. + + + + + Opaque object sorting mode of a Camera. + + + + + Default opaque sorting mode. + + + + + Do rough front-to-back sorting of opaque objects. + + + + + Do not sort opaque objects by distance. + + + + + Shader pass type for Unity's lighting pipeline. + + + + + Deferred Shading shader pass. + + + + + Forward rendering additive pixel light pass. + + + + + Forward rendering base pass. + + + + + Legacy deferred lighting (light pre-pass) base pass. + + + + + Legacy deferred lighting (light pre-pass) final pass. + + + + + Shader pass used to generate the albedo and emissive values used as input to lightmapping. + + + + + Motion vector render pass. + + + + + Regular shader pass that does not interact with lighting. + + + + + Custom scriptable pipeline. + + + + + Custom scriptable pipeline when lightmode is set to default unlit or no light mode is set. + + + + + Shadow caster & depth texure shader pass. + + + + + Legacy vertex-lit shader pass. + + + + + Legacy vertex-lit shader pass, with mobile lightmaps. + + + + + Legacy vertex-lit shader pass, with desktop (RGBM) lightmaps. + + + + + A collection of Rendering.ShaderKeyword that represents a specific platform variant. + + + + + Disable a specific shader keyword. + + + + + Enable a specific shader keyword. + + + + + Check whether a specific shader keyword is enabled. + + + + + + How much CPU usage to assign to the final lighting calculations at runtime. + + + + + 75% of the allowed CPU threads are used as worker threads. + + + + + 25% of the allowed CPU threads are used as worker threads. + + + + + 50% of the allowed CPU threads are used as worker threads. + + + + + 100% of the allowed CPU threads are used as worker threads. + + + + + Determines how Unity will compress baked reflection cubemap. + + + + + Baked Reflection cubemap will be compressed if compression format is suitable. + + + + + Baked Reflection cubemap will be compressed. + + + + + Baked Reflection cubemap will be left uncompressed. + + + + + ReflectionProbeBlendInfo contains information required for blending probes. + + + + + Reflection Probe used in blending. + + + + + Specifies the weight used in the interpolation between two probes, value varies from 0.0 to 1.0. + + + + + Values for ReflectionProbe.clearFlags, determining what to clear when rendering a ReflectionProbe. + + + + + Clear with the skybox. + + + + + Clear with a background color. + + + + + Reflection probe's update mode. + + + + + Reflection probe is baked in the Editor. + + + + + Reflection probe uses a custom texture specified by the user. + + + + + Reflection probe is updating in realtime. + + + + + An enum describing the way a realtime reflection probe refreshes in the Player. + + + + + Causes Unity to update the probe's cubemap every frame. +Note that updating a probe is very costly. Setting this option on too many probes could have a significant negative effect on frame rate. Use time-slicing to help improve performance. + +See Also: ReflectionProbeTimeSlicingMode. + + + + + Causes the probe to update only on the first frame it becomes visible. The probe will no longer update automatically, however you may subsequently use RenderProbe to refresh the probe + +See Also: ReflectionProbe.RenderProbe. + + + + + Sets the probe to never be automatically updated by Unity while your game is running. Use this to completely control the probe refresh behavior by script. + +See Also: ReflectionProbe.RenderProbe. + + + + + When a probe's ReflectionProbe.refreshMode is set to ReflectionProbeRefreshMode.EveryFrame, this enum specify whether or not Unity should update the probe's cubemap over several frames or update the whole cubemap in one frame. +Updating a probe's cubemap is a costly operation. Unity needs to render the entire Scene for each face of the cubemap, as well as perform special blurring in order to get glossy reflections. The impact on frame rate can be significant. Time-slicing helps maintaning a more constant frame rate during these updates by performing the rendering over several frames. + + + + + Instructs Unity to use time-slicing by first rendering all faces at once, then spreading the remaining work over the next 8 frames. Using this option, updating the probe will take 9 frames. + + + + + Instructs Unity to spread the rendering of each face over several frames. Using this option, updating the cubemap will take 14 frames. This option greatly reduces the impact on frame rate, however it may produce incorrect results, especially in Scenes where lighting conditions change over these 14 frames. + + + + + Unity will render the probe entirely in one frame. + + + + + Reflection Probe usage. + + + + + Reflection probes are enabled. Blending occurs only between probes, useful in indoor environments. The renderer will use default reflection if there are no reflection probes nearby, but no blending between default reflection and probe will occur. + + + + + Reflection probes are enabled. Blending occurs between probes or probes and default reflection, useful for outdoor environments. + + + + + Reflection probes are disabled, skybox will be used for reflection. + + + + + Reflection probes are enabled, but no blending will occur between probes when there are two overlapping volumes. + + + + + This enum describes what should be done on the render target when it is activated (loaded). + + + + + Upon activating the render buffer, clear its contents. Currently only works together with the RenderPass API. + + + + + When this RenderBuffer is activated, the GPU is instructed not to care about the existing contents of that RenderBuffer. On tile-based GPUs this means that the RenderBuffer contents do not need to be loaded into the tile memory, providing a performance boost. + + + + + When this RenderBuffer is activated, preserve the existing contents of it. This setting is expensive on tile-based GPUs and should be avoided whenever possible. + + + + + This enum describes what should be done on the render target when the GPU is done rendering into it. + + + + + The contents of the RenderBuffer are not needed and can be discarded. Tile-based GPUs will skip writing out the surface contents altogether, providing performance boost. + + + + + Resolve the (MSAA'd) surface. Currently only used with the RenderPass API. + + + + + The RenderBuffer contents need to be stored to RAM. If the surface has MSAA enabled, this stores the non-resolved surface. + + + + + Resolve the (MSAA'd) surface, but also store the multisampled version. Currently only used with the RenderPass API. + + + + + Determine in which order objects are renderered. + + + + + Alpha tested geometry uses this queue. + + + + + This render queue is rendered before any others. + + + + + Opaque geometry uses this queue. + + + + + Last render queue that is considered "opaque". + + + + + This render queue is meant for overlay effects. + + + + + This render queue is rendered after Geometry and AlphaTest, in back-to-front order. + + + + + Describes a render target with one or more color buffers, a depthstencil buffer and the associated loadstore-actions that are applied when the render target is active. + + + + + Load actions for color buffers. + + + + + Color buffers to use as render targets. + + + + + Store actions for color buffers. + + + + + Load action for the depth/stencil buffer. + + + + + Depth/stencil buffer to use as render target. + + + + + Store action for the depth/stencil buffer. + + + + + Constructs RenderTargetBinding. + + Color buffers to use as render targets. + Depth buffer to use as render target. + Load actions for color buffers. + Store actions for color buffers. + Load action for the depth/stencil buffer. + Store action for the depth/stencil buffer. + + + + + + + + + + Constructs RenderTargetBinding. + + Color buffers to use as render targets. + Depth buffer to use as render target. + Load actions for color buffers. + Store actions for color buffers. + Load action for the depth/stencil buffer. + Store action for the depth/stencil buffer. + + + + + + + + + + Constructs RenderTargetBinding. + + Color buffers to use as render targets. + Depth buffer to use as render target. + Load actions for color buffers. + Store actions for color buffers. + Load action for the depth/stencil buffer. + Store action for the depth/stencil buffer. + + + + + + + + + + Identifies a RenderTexture for a Rendering.CommandBuffer. + + + + + Creates a render target identifier. + + Built-in temporary render texture type. + Temporary render texture name. + Temporary render texture name (as integer, see Shader.PropertyToID). + RenderTexture or Texture object to use. + MipLevel of the RenderTexture to use. + Cubemap face of the Cubemap RenderTexture to use. + Depth slice of the Array RenderTexture to use. + An existing render target identifier. + + + + + Creates a render target identifier. + + Built-in temporary render texture type. + Temporary render texture name. + Temporary render texture name (as integer, see Shader.PropertyToID). + RenderTexture or Texture object to use. + MipLevel of the RenderTexture to use. + Cubemap face of the Cubemap RenderTexture to use. + Depth slice of the Array RenderTexture to use. + An existing render target identifier. + + + + + Creates a render target identifier. + + Built-in temporary render texture type. + Temporary render texture name. + Temporary render texture name (as integer, see Shader.PropertyToID). + RenderTexture or Texture object to use. + MipLevel of the RenderTexture to use. + Cubemap face of the Cubemap RenderTexture to use. + Depth slice of the Array RenderTexture to use. + An existing render target identifier. + + + + + Creates a render target identifier. + + Built-in temporary render texture type. + Temporary render texture name. + Temporary render texture name (as integer, see Shader.PropertyToID). + RenderTexture or Texture object to use. + MipLevel of the RenderTexture to use. + Cubemap face of the Cubemap RenderTexture to use. + Depth slice of the Array RenderTexture to use. + An existing render target identifier. + + + + + Creates a render target identifier. + + Built-in temporary render texture type. + Temporary render texture name. + Temporary render texture name (as integer, see Shader.PropertyToID). + RenderTexture or Texture object to use. + MipLevel of the RenderTexture to use. + Cubemap face of the Cubemap RenderTexture to use. + Depth slice of the Array RenderTexture to use. + An existing render target identifier. + + + + + Identifier of a specific code path in a shader. + + + + + Initializes a new instance of the ShaderKeyword class from a shader keyword name. + + + + + + Returns the string name of the keyword. + + + + + Returns the keyword kind: built-in or user defined. + + + + + Returns true if the keyword has been imported by Unity. + + + + + A collection of Rendering.ShaderKeyword that represents a specific shader variant. + + + + + Disable a specific shader keyword. + + + + + + Enable a specific shader keyword. + + + + + + Return an array with all the enabled keywords in the ShaderKeywordSet. + + + + + Check whether a specific shader keyword is enabled. + + + + + + Type of a shader keyword, eg: built-in or user defined. + + + + + The keyword is built-in the runtime and can be automatically stripped if unusued. + + + + + The keyword is built-in the runtime and it is systematically reserved. + + + + + The keyword is built-in the runtime and it is optionally reserved depending on the features used. + + + + + No type is assigned. + + + + + The keyword is defined by the user. + + + + + How shadows are cast from this object. + + + + + No shadows are cast from this object. + + + + + Shadows are cast from this object. + + + + + Object casts shadows, but is otherwise invisible in the Scene. + + + + + Shadows are cast from this object, treating it as two-sided. + + + + + Allows precise control over which shadow map passes to execute Rendering.CommandBuffer objects attached using Light.AddCommandBuffer. + + + + + All shadow map passes. + + + + + All directional shadow map passes. + + + + + First directional shadow map cascade. + + + + + Second directional shadow map cascade. + + + + + Third directional shadow map cascade. + + + + + Fourth directional shadow map cascade. + + + + + All point light shadow passes. + + + + + -X point light shadow cubemap face. + + + + + -Y point light shadow cubemap face. + + + + + -Z point light shadow cubemap face. + + + + + +X point light shadow cubemap face. + + + + + +Y point light shadow cubemap face. + + + + + +Z point light shadow cubemap face. + + + + + Spotlight shadow pass. + + + + + Used by CommandBuffer.SetShadowSamplingMode. + + + + + Default shadow sampling mode: sampling with a comparison filter. + + + + + In ShadowSamplingMode.None, depths are not compared. Use this value if a Texture is not a shadowmap. + + + + + Shadow sampling mode for sampling the depth value. + + + + + Adding a SortingGroup component to a GameObject will ensure that all Renderers within the GameObject's descendants will be sorted and rendered together. + + + + + Unique ID of the Renderer's sorting layer. + + + + + Name of the Renderer's sorting layer. + + + + + Renderer's order within a sorting layer. + + + + + Spherical harmonics up to the second order (3 bands, 9 coefficients). + + + + + Add ambient lighting to probe data. + + + + + + Add directional light to probe data. + + + + + + + + Clears SH probe to zero. + + + + + Evaluates the Spherical Harmonics for each of the given directions. The result from the first direction is written into the first element of results, the result from the second direction is written into the second element of results, and so on. The array size of directions and results must match and directions must be normalized. + + Normalized directions for which the spherical harmonics are to be evaluated. + Output array for the evaluated values of the corresponding directions. + + + + Returns true if SH probes are equal. + + + + + + + Scales SH by a given factor. + + + + + + + Scales SH by a given factor. + + + + + + + Returns true if SH probes are different. + + + + + + + Adds two SH probes. + + + + + + + Access individual SH coefficients. + + + + + Provides an interface to the Unity splash screen. + + + + + Returns true once the splash screen as finished. This is once all logos have been shown for their specified duration. + + + + + Initializes the splash screen so it is ready to begin drawing. Call this before you start calling Rendering.SplashScreen.Draw. Internally this function resets the timer and prepares the logos for drawing. + + + + + Immediately draws the splash screen. Ensure you have called Rendering.SplashScreen.Begin before you start calling this. + + + + + Specifies the operation that's performed on the stencil buffer when rendering. + + + + + Decrements the current stencil buffer value. Clamps to 0. + + + + + Decrements the current stencil buffer value. Wraps stencil buffer value to the maximum representable unsigned value when decrementing a stencil buffer value of zero. + + + + + Increments the current stencil buffer value. Clamps to the maximum representable unsigned value. + + + + + Increments the current stencil buffer value. Wraps stencil buffer value to zero when incrementing the maximum representable unsigned value. + + + + + Bitwise inverts the current stencil buffer value. + + + + + Keeps the current stencil value. + + + + + Replace the stencil buffer value with reference value (specified in the shader). + + + + + Sets the stencil buffer value to zero. + + + + + Broadly describes the stages of processing a draw call on the GPU. + + + + + The process of creating and shading the fragments. + + + + + All aspects of vertex processing. + + + + + Texture "dimension" (type). + + + + + Any texture type. + + + + + Cubemap texture. + + + + + Cubemap array texture (CubemapArray). + + + + + No texture is assigned. + + + + + 2D texture (Texture2D). + + + + + 2D array texture (Texture2DArray). + + + + + 3D volume texture (Texture3D). + + + + + Texture type is not initialized or unknown. + + + + + A flag representing each UV channel. + + + + + First UV channel. + + + + + Second UV channel. + + + + + Third UV channel. + + + + + Fourth UV channel. + + + + + A list of data channels that describe a vertex in a mesh. + + + + + Blend indices for skinned meshes. The common format is Int. + + + + + Blend weights for skinned meshes. The common format is Float. + + + + + The color channel. + + + + + The normal channel. The common format is Vector3. + + + + + The position channel. The common format is Vector3. + + + + + The tangent channel. The common format is Vector4. + + + + + The primary UV channel. The common format is Vector2. + + + + + Additional UV channel. The common format is Vector2. + + + + + Additional UV channel. The common format is Vector2. + + + + + Additional UV channel. The common format is Vector2. + + + + + Additional UV channel. The common format is Vector2. + + + + + Additional UV channel. The common format is Vector2. + + + + + Additional UV channel. The common format is Vector2. + + + + + Additional UV channel. The common format is Vector2. + + + + + Rendering path of a Camera. + + + + + Deferred Lighting (Legacy). + + + + + Deferred Shading. + + + + + Forward Rendering. + + + + + Use Player Settings. + + + + + Vertex Lit. + + + + + RenderMode for the Canvas. + + + + + Render using the Camera configured on the Canvas. + + + + + Render at the end of the Scene using a 2D Canvas. + + + + + Render using any Camera in the Scene that can render the layer. + + + + + The Render Settings contain values for a range of visual elements in your Scene, like fog and ambient light. + + + + + Ambient lighting coming from the sides. + + + + + Ambient lighting coming from below. + + + + + How much the light from the Ambient Source affects the Scene. + + + + + Flat ambient lighting color. + + + + + Ambient lighting mode. + + + + + Custom or skybox ambient lighting data. + + + + + Ambient lighting coming from above. + + + + + Custom specular reflection cubemap. + + + + + Default reflection mode. + + + + + Cubemap resolution for default reflection. + + + + + The fade speed of all flares in the Scene. + + + + + The intensity of all flares in the Scene. + + + + + Is fog enabled? + + + + + The color of the fog. + + + + + The density of the exponential fog. + + + + + The ending distance of linear fog. + + + + + Fog mode to use. + + + + + The starting distance of linear fog. + + + + + Size of the Light halos. + + + + + The number of times a reflection includes other reflections. + + + + + How much the skybox / custom cubemap reflection affects the Scene. + + + + + The global skybox to use. + + + + + The color used for the sun shadows in the Subtractive lightmode. + + + + + The light used by the procedural skybox. + + + + + Fully describes setup of RenderTarget. + + + + + Color Buffers to set. + + + + + Load Actions for Color Buffers. It will override any actions set on RenderBuffers themselves. + + + + + Store Actions for Color Buffers. It will override any actions set on RenderBuffers themselves. + + + + + Cubemap face to render to. + + + + + Depth Buffer to set. + + + + + Load Action for Depth Buffer. It will override any actions set on RenderBuffer itself. + + + + + Slice of a Texture3D or Texture2DArray to set as a render target. + + + + + Store Actions for Depth Buffer. It will override any actions set on RenderBuffer itself. + + + + + Mip Level to render to. + + + + + Constructs RenderTargetSetup. + + Color Buffer(s) to set. + Depth Buffer to set. + Mip Level to render to. + Cubemap face to render to. + + + + + Constructs RenderTargetSetup. + + Color Buffer(s) to set. + Depth Buffer to set. + Mip Level to render to. + Cubemap face to render to. + + + + + Constructs RenderTargetSetup. + + Color Buffer(s) to set. + Depth Buffer to set. + Mip Level to render to. + Cubemap face to render to. + + + + + Constructs RenderTargetSetup. + + Color Buffer(s) to set. + Depth Buffer to set. + Mip Level to render to. + Cubemap face to render to. + + + + + Constructs RenderTargetSetup. + + Color Buffer(s) to set. + Depth Buffer to set. + Mip Level to render to. + Cubemap face to render to. + + + + + Constructs RenderTargetSetup. + + Color Buffer(s) to set. + Depth Buffer to set. + Mip Level to render to. + Cubemap face to render to. + + + + + Render textures are textures that can be rendered to. + + + + + Currently active render texture. + + + + + The antialiasing level for the RenderTexture. + + + + + Mipmap levels are generated automatically when this flag is set. + + + + + If true and antiAliasing is greater than 1, the render texture will not be resolved by default. Use this if the render texture needs to be bound as a multisampled texture in a shader. + + + + + Color buffer of the render texture (Read Only). + + + + + The precision of the render texture's depth buffer in bits (0, 16, 24/32 are supported). + + + + + Depth/stencil buffer of the render texture (Read Only). + + + + + This struct contains all the information required to create a RenderTexture. It can be copied, cached, and reused to easily create RenderTextures that all share the same properties. + + + + + Dimensionality (type) of the render texture. + + + + + Enable random access write into this render texture on Shader Model 5.0 level shaders. + + + + + The color format of the render texture. + + + + + The height of the render texture in pixels. + + + + + If enabled, this Render Texture will be used as a Texture3D. + + + + + The render texture memoryless mode property. + + + + + Does this render texture use sRGB read/write conversions? (Read Only). + + + + + Is the render texture marked to be scaled by the Dynamic Resolution system. + + + + + Render texture has mipmaps when this flag is set. + + + + + Volume extent of a 3D render texture or number of slices of array texture. + + + + + If this RenderTexture is a VR eye texture used in stereoscopic rendering, this property decides what special rendering occurs, if any. + + + + + The width of the render texture in pixels. + + + + + Converts the render texture to equirectangular format (both stereoscopic or monoscopic equirect). +The left eye will occupy the top half and the right eye will occupy the bottom. The monoscopic version will occupy the whole texture. +Texture dimension must be of type TextureDimension.Cube. + + RenderTexture to render the equirect format to. + A Camera eye corresponding to the left or right eye for stereoscopic rendering, or neither for monoscopic rendering. + + + + Actually creates the RenderTexture. + + + True if the texture is created, else false. + + + + + Creates a new RenderTexture object. + + Texture width in pixels. + Texture height in pixels. + Number of bits in depth buffer (0, 16 or 24). Note that only 24 bit depth has stencil buffer. + Texture color format. + How or if color space conversions should be done on texture read/write. + Create the RenderTexture with the settings in the RenderTextureDescriptor. + Copy the settings from another RenderTexture. + + + + Creates a new RenderTexture object. + + Texture width in pixels. + Texture height in pixels. + Number of bits in depth buffer (0, 16 or 24). Note that only 24 bit depth has stencil buffer. + Texture color format. + How or if color space conversions should be done on texture read/write. + Create the RenderTexture with the settings in the RenderTextureDescriptor. + Copy the settings from another RenderTexture. + + + + Creates a new RenderTexture object. + + Texture width in pixels. + Texture height in pixels. + Number of bits in depth buffer (0, 16 or 24). Note that only 24 bit depth has stencil buffer. + Texture color format. + How or if color space conversions should be done on texture read/write. + Create the RenderTexture with the settings in the RenderTextureDescriptor. + Copy the settings from another RenderTexture. + + + + Hint the GPU driver that the contents of the RenderTexture will not be used. + + Should the colour buffer be discarded? + Should the depth buffer be discarded? + + + + Hint the GPU driver that the contents of the RenderTexture will not be used. + + Should the colour buffer be discarded? + Should the depth buffer be discarded? + + + + Generate mipmap levels of a render texture. + + + + + Retrieve a native (underlying graphics API) pointer to the depth buffer resource. + + + Pointer to an underlying graphics API depth buffer resource. + + + + + Allocate a temporary render texture. + + Width in pixels. + Height in pixels. + Depth buffer bits (0, 16 or 24). Note that only 24 bit depth has stencil buffer. + Render texture format. + Color space conversion mode. + Number of antialiasing samples to store in the texture. Valid values are 1, 2, 4, and 8. Throws an exception if any other value is passed. + Render texture memoryless mode. + Use this RenderTextureDesc for the settings when creating the temporary RenderTexture. + + + + + + Allocate a temporary render texture. + + Width in pixels. + Height in pixels. + Depth buffer bits (0, 16 or 24). Note that only 24 bit depth has stencil buffer. + Render texture format. + Color space conversion mode. + Number of antialiasing samples to store in the texture. Valid values are 1, 2, 4, and 8. Throws an exception if any other value is passed. + Render texture memoryless mode. + Use this RenderTextureDesc for the settings when creating the temporary RenderTexture. + + + + + + Is the render texture actually created? + + + + + Indicate that there's a RenderTexture restore operation expected. + + + + + Releases the RenderTexture. + + + + + Release a temporary texture allocated with GetTemporary. + + + + + + Force an antialiased render texture to be resolved. + + The render texture to resolve into. If set, the target render texture must have the same dimensions and format as the source. + + + + Force an antialiased render texture to be resolved. + + The render texture to resolve into. If set, the target render texture must have the same dimensions and format as the source. + + + + Assigns this RenderTexture as a global shader property named propertyName. + + + + + + Does a RenderTexture have stencil buffer? + + Render texture, or null for main screen. + + + + Set of flags that control the state of a newly-created RenderTexture. + + + + + Clear this flag when a RenderTexture is a VR eye texture and the device does not automatically flip the texture when being displayed. This is platform specific and +It is set by default. This flag is only cleared when part of a RenderTextureDesc that is returned from GetDefaultVREyeTextureDesc or other VR functions that return a RenderTextureDesc. Currently, only Hololens eye textures need to clear this flag. + + + + + Determines whether or not mipmaps are automatically generated when the RenderTexture is modified. +This flag is set by default, and has no effect if the RenderTextureCreationFlags.MipMap flag is not also set. +See RenderTexture.autoGenerateMips for more details. + + + + + Setting this flag causes the RenderTexture to be bound as a multisampled texture in a shader. The flag prevents the RenderTexture from being resolved by default when RenderTexture.antiAliasing is greater than 1. + + + + + This flag is always set internally when a RenderTexture is created from script. It has no effect when set manually from script code. + + + + + Set this flag to mark this RenderTexture for Dynamic Resolution should the target platform/graphics API support Dynamic Resolution. See ScalabeBufferManager for more details. + + + + + Set this flag to enable random access writes to the RenderTexture from shaders. +Normally, pixel shaders only operate on pixels they are given. Compute shaders cannot write to textures without this flag. Random write enables shaders to write to arbitrary locations on a RenderTexture. See RenderTexture.enableRandomWrite for more details, including supported platforms. + + + + + Set this flag when the Texture is to be used as a VR eye texture. This flag is cleared by default. This flag is set on a RenderTextureDesc when it is returned from GetDefaultVREyeTextureDesc or other VR functions returning a RenderTextureDesc. + + + + + Set this flag to allocate mipmaps in the RenderTexture. See RenderTexture.useMipMap for more details. + + + + + When this flag is set, the engine will not automatically resolve the color surface. + + + + + When this flag is set, reads and writes to this texture are converted to SRGB color space. See RenderTexture.sRGB for more details. + + + + + This struct contains all the information required to create a RenderTexture. It can be copied, cached, and reused to easily create RenderTextures that all share the same properties. + + + + + Mipmap levels are generated automatically when this flag is set. + + + + + If true and msaaSamples is greater than 1, the render texture will not be resolved by default. Use this if the render texture needs to be bound as a multisampled texture in a shader. + + + + + The color format for the RenderTexture. + + + + + The precision of the render texture's depth buffer in bits (0, 16, 24/32 are supported). + +See RenderTexture.depth. + + + + + Dimensionality (type) of the render texture. + +See RenderTexture.dimension. + + + + + Enable random access write into this render texture on Shader Model 5.0 level shaders. + +See RenderTexture.enableRandomWrite. + + + + + A set of RenderTextureCreationFlags that control how the texture is created. + + + + + The height of the render texture in pixels. + + + + + The render texture memoryless mode property. + + + + + The multisample antialiasing level for the RenderTexture. + +See RenderTexture.antiAliasing. + + + + + Determines how the RenderTexture is sampled if it is used as a shadow map. + +See ShadowSamplingMode for more details. + + + + + This flag causes the render texture uses sRGB read/write conversions. + + + + + Render texture has mipmaps when this flag is set. + +See RenderTexture.useMipMap. + + + + + Volume extent of a 3D render texture. + + + + + If this RenderTexture is a VR eye texture used in stereoscopic rendering, this property decides what special rendering occurs, if any. Instead of setting this manually, use the value returned by XR.XRSettings.eyeTextureDesc|eyeTextureDesc or other VR functions returning a RenderTextureDescriptor. + + + + + The width of the render texture in pixels. + + + + + Create a RenderTextureDescriptor with default values, or a certain width, height, and format. + + Width of the RenderTexture in pixels. + Height of the RenderTexture in pixels. + The color format for the RenderTexture. + The number of bits to use for the depth buffer. + + + + Create a RenderTextureDescriptor with default values, or a certain width, height, and format. + + Width of the RenderTexture in pixels. + Height of the RenderTexture in pixels. + The color format for the RenderTexture. + The number of bits to use for the depth buffer. + + + + Create a RenderTextureDescriptor with default values, or a certain width, height, and format. + + Width of the RenderTexture in pixels. + Height of the RenderTexture in pixels. + The color format for the RenderTexture. + The number of bits to use for the depth buffer. + + + + Format of a RenderTexture. + + + + + Color render texture format, 1 bit for Alpha channel, 5 bits for Red, Green and Blue channels. + + + + + Color render texture format. 10 bits for colors, 2 bits for alpha. + + + + + Color render texture format, 8 bits per channel. + + + + + Color render texture format, 4 bit per channel. + + + + + Four color render texture format, 16 bits per channel, fixed point, unsigned normalized. + + + + + Color render texture format, 32 bit floating point per channel. + + + + + Color render texture format, 16 bit floating point per channel. + + + + + Four channel (ARGB) render texture format, 32 bit signed integer per channel. + + + + + Color render texture format, 10 bit per channel, extended range. + + + + + Color render texture format, 10 bit per channel, extended range. + + + + + Color render texture format, 8 bits per channel. + + + + + Default color render texture format: will be chosen accordingly to Frame Buffer format and Platform. + + + + + Default HDR color render texture format: will be chosen accordingly to Frame Buffer format and Platform. + + + + + A depth render texture format. + + + + + Single channel (R) render texture format, 16 bit integer. + + + + + Single channel (R) render texture format, 8 bit integer. + + + + + Scalar (R) render texture format, 32 bit floating point. + + + + + Two channel (RG) render texture format, 8 bits per channel. + + + + + Two color (RG) render texture format, 16 bits per channel, fixed point, unsigned normalized. + + + + + Color render texture format. R and G channels are 11 bit floating point, B channel is 10 bit floating point. + + + + + Color render texture format. + + + + + Four channel (RGBA) render texture format, 16 bit unsigned integer per channel. + + + + + Two color (RG) render texture format, 32 bit floating point per channel. + + + + + Two color (RG) render texture format, 16 bit floating point per channel. + + + + + Two channel (RG) render texture format, 32 bit signed integer per channel. + + + + + Scalar (R) render texture format, 16 bit floating point. + + + + + Scalar (R) render texture format, 32 bit signed integer. + + + + + A native shadowmap render texture format. + + + + + Flags enumeration of the render texture memoryless modes. + + + + + Render texture color pixels are memoryless when RenderTexture.antiAliasing is set to 1. + + + + + Render texture depth pixels are memoryless. + + + + + Render texture color pixels are memoryless when RenderTexture.antiAliasing is set to 2, 4 or 8. + + + + + The render texture is not memoryless. + + + + + Color space conversion mode of a RenderTexture. + + + + + Render texture contains sRGB (color) data, perform Linear<->sRGB conversions on it. + + + + + Default color space conversion based on project settings. + + + + + Render texture contains linear (non-color) data; don't perform color conversions on it. + + + + + The RequireComponent attribute automatically adds required components as dependencies. + + + + + Require a single component. + + + + + + Require two components. + + + + + + + Require three components. + + + + + + + + Represents a display resolution. + + + + + Resolution height in pixels. + + + + + Resolution's vertical refresh rate in Hz. + + + + + Resolution width in pixels. + + + + + Returns a nicely formatted string of the resolution. + + + A string with the format "width x height @ refreshRateHz". + + + + + Asynchronous load request from the Resources bundle. + + + + + Asset object being loaded (Read Only). + + + + + The Resources class allows you to find and access Objects including assets. + + + + + Returns a list of all objects of Type type. + + Type of the class to match while searching. + + An array of objects whose class is type or is derived from type. + + + + + Returns a list of all objects of Type T. + + + + + Loads an asset stored at path in a folder called Resources. + + Pathname of the target folder. + + The requested asset returned as a Type. + + + + + Loads an asset stored at path in a Resources folder. + + Pathname of the target folder. When using the empty string (i.e., ""), the function will load the entire contents of the Resources folder. + Type filter for objects returned. + + The requested asset returned as an Object. + + + + + Loads an asset stored at path in a Resources folder. + + Pathname of the target folder. When using the empty string (i.e., ""), the function will load the entire contents of the Resources folder. + Type filter for objects returned. + + The requested asset returned as an Object. + + + + + Loads all assets in a folder or file at path in a Resources folder. + + Pathname of the target folder. When using the empty string (i.e., ""), the function will load the entire contents of the Resources folder. + Type filter for objects returned. + + + + Loads all assets in a folder or file at path in a Resources folder. + + Pathname of the target folder. When using the empty string (i.e., ""), the function will load the entire contents of the Resources folder. + Type filter for objects returned. + + + + Loads all assets in a folder or file at path in a Resources folder. + + Pathname of the target folder. When using the empty string (i.e., ""), the function will load the entire contents of the Resources folder. + + + + Returns a resource at an asset path (Editor Only). + + Pathname of the target asset. + Type filter for objects returned. + + + + Returns a resource at an asset path (Editor Only). + + Pathname of the target asset. + + + + Asynchronously loads an asset stored at path in a Resources folder. + + Pathname of the target folder. When using the empty string (i.e., ""), the function will load the entire contents of the Resources folder. + Type filter for objects returned. + + + + + Asynchronously loads an asset stored at path in a Resources folder. + + Pathname of the target folder. When using the empty string (i.e., ""), the function will load the entire contents of the Resources folder. + Type filter for objects returned. + + + + + Asynchronously loads an asset stored at path in a Resources folder. + + Pathname of the target folder. When using the empty string (i.e., ""), the function will load the entire contents of the Resources folder. + + + + Unloads assetToUnload from memory. + + + + + + Unloads assets that are not used. + + + Object on which you can yield to wait until the operation completes. + + + + + Control of an object's position through physics simulation. + + + + + The angular drag of the object. + + + + + The angular velocity vector of the rigidbody measured in radians per second. + + + + + The center of mass relative to the transform's origin. + + + + + The Rigidbody's collision detection mode. + + + + + Controls which degrees of freedom are allowed for the simulation of this Rigidbody. + + + + + Should collision detection be enabled? (By default always enabled). + + + + + The drag of the object. + + + + + Controls whether physics will change the rotation of the object. + + + + + The diagonal inertia tensor of mass relative to the center of mass. + + + + + The rotation of the inertia tensor. + + + + + Interpolation allows you to smooth out the effect of running physics at a fixed frame rate. + + + + + Controls whether physics affects the rigidbody. + + + + + The mass of the rigidbody. + + + + + The maximimum angular velocity of the rigidbody measured in radians per second. (Default 7) range { 0, infinity }. + + + + + Maximum velocity of a rigidbody when moving out of penetrating state. + + + + + The position of the rigidbody. + + + + + The rotation of the rigidbody. + + + + + The angular velocity below which objects start going to sleep. (Default 0.14) range { 0, infinity }. + + + + + The mass-normalized energy threshold, below which objects start going to sleep. + + + + + The linear velocity below which objects start going to sleep. (Default 0.14) range { 0, infinity }. + + + + + The solverIterations determines how accurately Rigidbody joints and collision contacts are resolved. Overrides Physics.defaultSolverIterations. Must be positive. + + + + + The solverVelocityIterations affects how how accurately Rigidbody joints and collision contacts are resolved. Overrides Physics.defaultSolverVelocityIterations. Must be positive. + + + + + Force cone friction to be used for this rigidbody. + + + + + Controls whether gravity affects this rigidbody. + + + + + The velocity vector of the rigidbody. + + + + + The center of mass of the rigidbody in world space (Read Only). + + + + + Applies a force to a rigidbody that simulates explosion effects. + + The force of the explosion (which may be modified by distance). + The centre of the sphere within which the explosion has its effect. + The radius of the sphere within which the explosion has its effect. + Adjustment to the apparent position of the explosion to make it seem to lift objects. + The method used to apply the force to its targets. + + + + Applies a force to a rigidbody that simulates explosion effects. + + The force of the explosion (which may be modified by distance). + The centre of the sphere within which the explosion has its effect. + The radius of the sphere within which the explosion has its effect. + Adjustment to the apparent position of the explosion to make it seem to lift objects. + The method used to apply the force to its targets. + + + + Applies a force to a rigidbody that simulates explosion effects. + + The force of the explosion (which may be modified by distance). + The centre of the sphere within which the explosion has its effect. + The radius of the sphere within which the explosion has its effect. + Adjustment to the apparent position of the explosion to make it seem to lift objects. + The method used to apply the force to its targets. + + + + Adds a force to the Rigidbody. + + Force vector in world coordinates. + Type of force to apply. + + + + Adds a force to the Rigidbody. + + Force vector in world coordinates. + Type of force to apply. + + + + Adds a force to the Rigidbody. + + Size of force along the world x-axis. + Size of force along the world y-axis. + Size of force along the world z-axis. + Type of force to apply. + + + + Adds a force to the Rigidbody. + + Size of force along the world x-axis. + Size of force along the world y-axis. + Size of force along the world z-axis. + Type of force to apply. + + + + Applies force at position. As a result this will apply a torque and force on the object. + + Force vector in world coordinates. + Position in world coordinates. + + + + + Applies force at position. As a result this will apply a torque and force on the object. + + Force vector in world coordinates. + Position in world coordinates. + + + + + Adds a force to the rigidbody relative to its coordinate system. + + Force vector in local coordinates. + + + + + Adds a force to the rigidbody relative to its coordinate system. + + Force vector in local coordinates. + + + + + Adds a force to the rigidbody relative to its coordinate system. + + Size of force along the local x-axis. + Size of force along the local y-axis. + Size of force along the local z-axis. + + + + + Adds a force to the rigidbody relative to its coordinate system. + + Size of force along the local x-axis. + Size of force along the local y-axis. + Size of force along the local z-axis. + + + + + Adds a torque to the rigidbody relative to its coordinate system. + + Torque vector in local coordinates. + + + + + Adds a torque to the rigidbody relative to its coordinate system. + + Torque vector in local coordinates. + + + + + Adds a torque to the rigidbody relative to its coordinate system. + + Size of torque along the local x-axis. + Size of torque along the local y-axis. + Size of torque along the local z-axis. + + + + + Adds a torque to the rigidbody relative to its coordinate system. + + Size of torque along the local x-axis. + Size of torque along the local y-axis. + Size of torque along the local z-axis. + + + + + Adds a torque to the rigidbody. + + Torque vector in world coordinates. + + + + + Adds a torque to the rigidbody. + + Torque vector in world coordinates. + + + + + Adds a torque to the rigidbody. + + Size of torque along the world x-axis. + Size of torque along the world y-axis. + Size of torque along the world z-axis. + + + + + Adds a torque to the rigidbody. + + Size of torque along the world x-axis. + Size of torque along the world y-axis. + Size of torque along the world z-axis. + + + + + The closest point to the bounding box of the attached colliders. + + + + + + The velocity of the rigidbody at the point worldPoint in global space. + + + + + + The velocity relative to the rigidbody at the point relativePoint. + + + + + + Is the rigidbody sleeping? + + + + + Moves the rigidbody to position. + + The new position for the Rigidbody object. + + + + Rotates the rigidbody to rotation. + + The new rotation for the Rigidbody. + + + + Reset the center of mass of the rigidbody. + + + + + Reset the inertia tensor value and rotation. + + + + + Sets the mass based on the attached colliders assuming a constant density. + + + + + + Forces a rigidbody to sleep at least one frame. + + + + + Tests if a rigidbody would collide with anything, if it was moved through the Scene. + + The direction into which to sweep the rigidbody. + If true is returned, hitInfo will contain more information about where the collider was hit (See Also: RaycastHit). + The length of the sweep. + Specifies whether this query should hit Triggers. + + True when the rigidbody sweep intersects any collider, otherwise false. + + + + + Like Rigidbody.SweepTest, but returns all hits. + + The direction into which to sweep the rigidbody. + The length of the sweep. + Specifies whether this query should hit Triggers. + + An array of all colliders hit in the sweep. + + + + + Forces a rigidbody to wake up. + + + + + Rigidbody physics component for 2D sprites. + + + + + Coefficient of angular drag. + + + + + Angular velocity in degrees per second. + + + + + Returns the number of Collider2D attached to this Rigidbody2D. + + + + + The physical behaviour type of the Rigidbody2D. + + + + + The center of mass of the rigidBody in local space. + + + + + The method used by the physics engine to check if two objects have collided. + + + + + Controls which degrees of freedom are allowed for the simulation of this Rigidbody2D. + + + + + Coefficient of drag. + + + + + Should the rigidbody be prevented from rotating? + + + + + Controls whether physics will change the rotation of the object. + + + + + The degree to which this object is affected by gravity. + + + + + The rigidBody rotational inertia. + + + + + Physics interpolation used between updates. + + + + + Should this rigidbody be taken out of physics control? + + + + + Mass of the Rigidbody. + + + + + The position of the rigidbody. + + + + + The rotation of the rigidbody. + + + + + The PhysicsMaterial2D that is applied to all Collider2D attached to this Rigidbody2D. + + + + + Indicates whether the rigid body should be simulated or not by the physics system. + + + + + The sleep state that the rigidbody will initially be in. + + + + + Should the total rigid-body mass be automatically calculated from the Collider2D.density of attached colliders? + + + + + Should kinematickinematic and kinematicstatic collisions be allowed? + + + + + Linear velocity of the rigidbody. + + + + + Gets the center of mass of the rigidBody in global space. + + + + + Apply a force to the rigidbody. + + Components of the force in the X and Y axes. + The method used to apply the specified force. + + + + Apply a force at a given position in space. + + Components of the force in the X and Y axes. + Position in world space to apply the force. + The method used to apply the specified force. + + + + Adds a force to the rigidbody2D relative to its coordinate system. + + Components of the force in the X and Y axes. + The method used to apply the specified force. + + + + Apply a torque at the rigidbody's centre of mass. + + Torque to apply. + The force mode to use. + + + + All the Collider2D shapes attached to the Rigidbody2D are cast into the Scene starting at each collider position ignoring the colliders attached to the same Rigidbody2D. + + Vector representing the direction to cast each Collider2D shape. + Array to receive results. + Maximum distance over which to cast the shape(s). + + The number of results returned. + + + + + All the Collider2D shapes attached to the Rigidbody2D are cast into the Scene starting at each collider position ignoring the colliders attached to the same Rigidbody2D. + + Vector representing the direction to cast each Collider2D shape. + Filter results defined by the contact filter. + Array to receive results. + Maximum distance over which to cast the shape(s). + + The number of results returned. + + + + + Calculates the minimum distance of this collider against all Collider2D attached to this Rigidbody2D. + + A collider used to calculate the minimum distance against all colliders attached to this Rigidbody2D. + + The minimum distance of collider against all colliders attached to this Rigidbody2D. + + + + + Returns all Collider2D that are attached to this Rigidbody2D. + + An array of Collider2D used to receive the results. + + Returns the number of Collider2D placed in the results array. + + + + + Retrieves all contact points for all of the collider(s) attached to this rigidbody. + + An array of ContactPoint2D used to receive the results. + + Returns the number of contacts placed in the contacts array. + + + + + Retrieves all colliders in contact with any of the collider(s) attached to this rigidbody. + + An array of Collider2D used to receive the results. + + Returns the number of colliders placed in the colliders array. + + + + + Retrieves all contact points for all of the collider(s) attached to this rigidbody, with the results filtered by the ContactFilter2D. + + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + An array of ContactPoint2D used to receive the results. + + Returns the number of contacts placed in the contacts array. + + + + + Retrieves all colliders in contact with any of the collider(s) attached to this rigidbody, with the results filtered by the ContactFilter2D. + + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + An array of Collider2D used to receive the results. + + Returns the number of colliders placed in the colliders array. + + + + + Get a local space point given the point point in rigidBody global space. + + The global space point to transform into local space. + + + + The velocity of the rigidbody at the point Point in global space. + + The global space point to calculate velocity for. + + + + Get a global space point given the point relativePoint in rigidBody local space. + + The local space point to transform into global space. + + + + The velocity of the rigidbody at the point Point in local space. + + The local space point to calculate velocity for. + + + + Get a global space vector given the vector relativeVector in rigidBody local space. + + The local space vector to transform into a global space vector. + + + + Get a local space vector given the vector vector in rigidBody global space. + + The global space vector to transform into a local space vector. + + + + Is the rigidbody "awake"? + + + + + Is the rigidbody "sleeping"? + + + + + Checks whether the collider is touching any of the collider(s) attached to this rigidbody or not. + + The collider to check if it is touching any of the collider(s) attached to this rigidbody. + + Whether the collider is touching any of the collider(s) attached to this rigidbody or not. + + + + + Checks whether the collider is touching any of the collider(s) attached to this rigidbody or not with the results filtered by the ContactFilter2D. + + The collider to check if it is touching any of the collider(s) attached to this rigidbody. + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + + Whether the collider is touching any of the collider(s) attached to this rigidbody or not. + + + + + Checks whether any collider is touching any of the collider(s) attached to this rigidbody or not with the results filtered by the ContactFilter2D. + + The contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle. + + Whether any collider is touching any of the collider(s) attached to this rigidbody or not. + + + + + Checks whether any of the collider(s) attached to this rigidbody are touching any colliders on the specified layerMask or not. + + Any colliders on any of these layers count as touching. + + Whether any of the collider(s) attached to this rigidbody are touching any colliders on the specified layerMask or not. + + + + + Moves the rigidbody to position. + + The new position for the Rigidbody object. + + + + Rotates the rigidbody to angle (given in degrees). + + The new rotation angle for the Rigidbody object. + + + + Get a list of all colliders that overlap all colliders attached to this Rigidbody2D. + + The contact filter used to filter the results differently, such as by layer mask, Z depth. Note that normal angle is not used for overlap testing. + The array to receive results. The size of the array determines the maximum number of results that can be returned. + + Returns the number of results placed in the results array. + + + + + Check if any of the Rigidbody2D colliders overlap a point in space. + + A point in world space. + + Whether the point overlapped any of the Rigidbody2D colliders. + + + + + Make the rigidbody "sleep". + + + + + Disables the "sleeping" state of a rigidbody. + + + + + Use these flags to constrain motion of Rigidbodies. + + + + + Freeze rotation and motion along all axes. + + + + + Freeze motion along all axes. + + + + + Freeze motion along the X-axis. + + + + + Freeze motion along the Y-axis. + + + + + Freeze motion along the Z-axis. + + + + + Freeze rotation along all axes. + + + + + Freeze rotation along the X-axis. + + + + + Freeze rotation along the Y-axis. + + + + + Freeze rotation along the Z-axis. + + + + + No constraints. + + + + + Use these flags to constrain motion of the Rigidbody2D. + + + + + Freeze rotation and motion along all axes. + + + + + Freeze motion along the X-axis and Y-axis. + + + + + Freeze motion along the X-axis. + + + + + Freeze motion along the Y-axis. + + + + + Freeze rotation along the Z-axis. + + + + + No constraints. + + + + + Rigidbody interpolation mode. + + + + + Extrapolation will predict the position of the rigidbody based on the current velocity. + + + + + Interpolation will always lag a little bit behind but can be smoother than extrapolation. + + + + + No Interpolation. + + + + + Interpolation mode for Rigidbody2D objects. + + + + + Smooth an object's movement based on an estimate of its position in the next frame. + + + + + Smooth movement based on the object's positions in previous frames. + + + + + Do not apply any smoothing to the object's movement. + + + + + Settings for a Rigidbody2D's initial sleep state. + + + + + Rigidbody2D never automatically sleeps. + + + + + Rigidbody2D is initially asleep. + + + + + Rigidbody2D is initially awake. + + + + + The physical behaviour type of the Rigidbody2D. + + + + + Sets the Rigidbody2D to have dynamic behaviour. + + + + + Sets the Rigidbody2D to have kinematic behaviour. + + + + + Sets the Rigidbody2D to have static behaviour. + + + + + Control ConfigurableJoint's rotation with either X & YZ or Slerp Drive. + + + + + Use Slerp drive. + + + + + Use XY & Z Drive. + + + + + Attribute for setting up RPC functions. + + + + + Option for who will receive an RPC, used by NetworkView.RPC. + + + + + The runtime representation of the AnimatorController. Use this representation to change the Animator Controller during runtime. + + + + + Retrieves all AnimationClip used by the controller. + + + + + Set RuntimeInitializeOnLoadMethod type. + + + + + After Scene is loaded. + + + + + Before Scene is loaded. + + + + + Allow a runtime class method to be initialized when a game is loaded at runtime + without action from the user. + + + + + Set RuntimeInitializeOnLoadMethod type. + + + + + Creation of the runtime class used when Scenes are loaded. + + Determine whether methods are called before or after the + Scene is loaded. + + + + Creation of the runtime class used when Scenes are loaded. + + Determine whether methods are called before or after the + Scene is loaded. + + + + The platform application is running. Returned by Application.platform. + + + + + In the player on the Apple's tvOS. + + + + + In the player on Android devices. + + + + + In the player on the iPhone. + + + + + In the Unity editor on Linux. + + + + + In the player on Linux. + + + + + In the Dashboard widget on macOS. + + + + + In the Unity editor on macOS. + + + + + In the player on macOS. + + + + + In the web player on macOS. + + + + + In the player on the Playstation 4. + + + + + In the player on Nintendo Switch. + + + + + In the player on WebGL + + + + + In the Unity editor on Windows. + + + + + In the player on Windows. + + + + + In the web player on Windows. + + + + + In the player on Windows Store Apps when CPU architecture is ARM. + + + + + In the player on Windows Store Apps when CPU architecture is X64. + + + + + In the player on Windows Store Apps when CPU architecture is X86. + + + + + In the player on Xbox One. + + + + + Scales render textures to support dynamic resolution if the target platform/graphics API supports it. + + + + + Height scale factor to control dynamic resolution. + + + + + Width scale factor to control dynamic resolution. + + + + + Function to resize all buffers marked as DynamicallyScalable. + + New scale factor for the width the ScalableBufferManager will use to resize all render textures the user marked as DynamicallyScalable, has to be some value greater than 0.0 and less than or equal to 1.0. + New scale factor for the height the ScalableBufferManager will use to resize all render textures the user marked as DynamicallyScalable, has to be some value greater than 0.0 and less than or equal to 1.0. + + + + Scaling mode to draw textures with. + + + + + Scales the texture, maintaining aspect ratio, so it completely covers the position rectangle passed to GUI.DrawTexture. If the texture is being draw to a rectangle with a different aspect ratio than the original, the image is cropped. + + + + + Scales the texture, maintaining aspect ratio, so it completely fits withing the position rectangle passed to GUI.DrawTexture. + + + + + Stretches the texture to fill the complete rectangle passed in to GUI.DrawTexture. + + + + + This struct collects all the CreateScene parameters in to a single place. + + + + + See SceneManagement.LocalPhysicsMode. + + + + + Used when loading a Scene in a player. + + + + + Adds the Scene to the current loaded Scenes. + + + + + Closes all current loaded Scenes + and loads a Scene. + + + + + This struct collects all the LoadScene parameters in to a single place. + + + + + See LoadSceneMode. + + + + + See SceneManagement.LocalPhysicsMode. + + + + + Constructor for LoadSceneParameters. See SceneManager.LoadScene. + + See LoadSceneParameters.loadSceneMode. + + + + Provides options for 2D and 3D local physics. + + + + + No local 2D or 3D physics Scene will be created. + + + + + A local 2D physics Scene will be created and owned by the Scene. + + + + + A local 3D physics Scene will be created and owned by the Scene. + + + + + Run-time data structure for *.unity file. + + + + + Return the index of the Scene in the Build Settings. + + + + + Returns true if the Scene is modifed. + + + + + Returns true if the Scene is loaded. + + + + + Returns the name of the Scene that is currently active in the game or app. + + + + + Returns the relative path of the Scene. Like: "AssetsMyScenesMyScene.unity". + + + + + The number of root transforms of this Scene. + + + + + Returns all the root game objects in the Scene. + + + An array of game objects. + + + + + Returns all the root game objects in the Scene. + + A list which is used to return the root game objects. + + + + Whether this is a valid Scene. +A Scene may be invalid if, for example, you tried to open a Scene that does not exist. In this case, the Scene returned from EditorSceneManager.OpenScene would return False for IsValid. + + + Whether this is a valid Scene. + + + + + Returns true if the Scenes are equal. + + + + + + + Returns true if the Scenes are different. + + + + + + + Scene management at run-time. + + + + + Subscribe to this event to get notified when the active Scene has changed. + + Use a subscription of either a UnityAction<SceneManagement.Scene, SceneManagement.Scene> or a method that takes two SceneManagement.Scene types arguments. + + + + The total number of currently loaded Scenes. + + + + + Number of Scenes in Build Settings. + + + + + Add a delegate to this to get notifications when a Scene has loaded. + + Use a subscription of either a UnityAction<SceneManagement.Scene, SceneManagement.LoadSceneMode> or a method that takes a SceneManagement.Scene and a SceneManagement.LoadSceneMode. + + + + Add a delegate to this to get notifications when a Scene has unloaded. + + Use a subscription of either a UnityAction<SceneManagement.Scene> or a method that takes a SceneManagement.Scene type argument. + + + + Create an empty new Scene at runtime with the given name. + + The name of the new Scene. It cannot be empty or null, or same as the name of the existing Scenes. + Various parameters used to create the Scene. + + A reference to the new Scene that was created, or an invalid Scene if creation failed. + + + + + Create an empty new Scene at runtime with the given name. + + The name of the new Scene. It cannot be empty or null, or same as the name of the existing Scenes. + Various parameters used to create the Scene. + + A reference to the new Scene that was created, or an invalid Scene if creation failed. + + + + + Gets the currently active Scene. + + + The active Scene. + + + + + Returns an array of all the Scenes currently open in the hierarchy. + + + Array of Scenes in the Hierarchy. + + + + + Get the Scene at index in the SceneManager's list of loaded Scenes. + + Index of the Scene to get. Index must be greater than or equal to 0 and less than SceneManager.sceneCount. + + A reference to the Scene at the index specified. + + + + + Get a Scene struct from a build index. + + Build index as shown in the Build Settings window. + + A reference to the Scene, if valid. If not, an invalid Scene is returned. + + + + + Searches through the Scenes loaded for a Scene with the given name. + + Name of Scene to find. + + A reference to the Scene, if valid. If not, an invalid Scene is returned. + + + + + Searches all Scenes loaded for a Scene that has the given asset path. + + Path of the Scene. Should be relative to the project folder. Like: "AssetsMyScenesMyScene.unity". + + A reference to the Scene, if valid. If not, an invalid Scene is returned. + + + + + Loads the Scene by its name or index in Build Settings. + + Name or path of the Scene to load. + Index of the Scene in the Build Settings to load. + Allows you to specify whether or not to load the Scene additively. See SceneManagement.LoadSceneMode for more information about the options. + + + + Loads the Scene by its name or index in Build Settings. + + Name or path of the Scene to load. + Index of the Scene in the Build Settings to load. + Allows you to specify whether or not to load the Scene additively. See SceneManagement.LoadSceneMode for more information about the options. + + + + Loads the Scene by its name or index in Build Settings. + + Name or path of the Scene to load. + Index of the Scene in the Build Settings to load. + Various parameters used to load the Scene. + + A handle to the Scene being loaded. + + + + + Loads the Scene by its name or index in Build Settings. + + Name or path of the Scene to load. + Index of the Scene in the Build Settings to load. + Various parameters used to load the Scene. + + A handle to the Scene being loaded. + + + + + Loads the Scene asynchronously in the background. + + Name or path of the Scene to load. + Index of the Scene in the Build Settings to load. + If LoadSceneMode.Single then all current Scenes will be unloaded before loading. + Struct that collects the various parameters into a single place except for the name and index. + + Use the AsyncOperation to determine if the operation has completed. + + + + + Loads the Scene asynchronously in the background. + + Name or path of the Scene to load. + Index of the Scene in the Build Settings to load. + If LoadSceneMode.Single then all current Scenes will be unloaded before loading. + Struct that collects the various parameters into a single place except for the name and index. + + Use the AsyncOperation to determine if the operation has completed. + + + + + Loads the Scene asynchronously in the background. + + Name or path of the Scene to load. + Index of the Scene in the Build Settings to load. + If LoadSceneMode.Single then all current Scenes will be unloaded before loading. + Struct that collects the various parameters into a single place except for the name and index. + + Use the AsyncOperation to determine if the operation has completed. + + + + + Loads the Scene asynchronously in the background. + + Name or path of the Scene to load. + Index of the Scene in the Build Settings to load. + If LoadSceneMode.Single then all current Scenes will be unloaded before loading. + Struct that collects the various parameters into a single place except for the name and index. + + Use the AsyncOperation to determine if the operation has completed. + + + + + This will merge the source Scene into the destinationScene. + + The Scene that will be merged into the destination Scene. + Existing Scene to merge the source Scene into. + + + + Move a GameObject from its current Scene to a new Scene. + + GameObject to move. + Scene to move into. + + + + Set the Scene to be active. + + The Scene to be set. + + Returns false if the Scene is not loaded yet. + + + + + Destroys all GameObjects associated with the given Scene and removes the Scene from the SceneManager. + + Index of the Scene in the Build Settings to unload. + Name or path of the Scene to unload. + Scene to unload. + + Returns true if the Scene is unloaded. + + + + + Destroys all GameObjects associated with the given Scene and removes the Scene from the SceneManager. + + Index of the Scene in the Build Settings to unload. + Name or path of the Scene to unload. + Scene to unload. + + Returns true if the Scene is unloaded. + + + + + Destroys all GameObjects associated with the given Scene and removes the Scene from the SceneManager. + + Index of the Scene in the Build Settings to unload. + Name or path of the Scene to unload. + Scene to unload. + + Returns true if the Scene is unloaded. + + + + + Destroys all GameObjects associated with the given Scene and removes the Scene from the SceneManager. + + Index of the Scene in BuildSettings. + Name or path of the Scene to unload. + Scene to unload. + Scene unloading options. + + Use the AsyncOperation to determine if the operation has completed. + + + + + Destroys all GameObjects associated with the given Scene and removes the Scene from the SceneManager. + + Index of the Scene in BuildSettings. + Name or path of the Scene to unload. + Scene to unload. + Scene unloading options. + + Use the AsyncOperation to determine if the operation has completed. + + + + + Destroys all GameObjects associated with the given Scene and removes the Scene from the SceneManager. + + Index of the Scene in BuildSettings. + Name or path of the Scene to unload. + Scene to unload. + Scene unloading options. + + Use the AsyncOperation to determine if the operation has completed. + + + + + Destroys all GameObjects associated with the given Scene and removes the Scene from the SceneManager. + + Index of the Scene in BuildSettings. + Name or path of the Scene to unload. + Scene to unload. + Scene unloading options. + + Use the AsyncOperation to determine if the operation has completed. + + + + + Destroys all GameObjects associated with the given Scene and removes the Scene from the SceneManager. + + Index of the Scene in BuildSettings. + Name or path of the Scene to unload. + Scene to unload. + Scene unloading options. + + Use the AsyncOperation to determine if the operation has completed. + + + + + Destroys all GameObjects associated with the given Scene and removes the Scene from the SceneManager. + + Index of the Scene in BuildSettings. + Name or path of the Scene to unload. + Scene to unload. + Scene unloading options. + + Use the AsyncOperation to determine if the operation has completed. + + + + + Scene and Build Settings related utilities. + + + + + Get the build index from a Scene path. + + Scene path (e.g: "AssetsScenesScene1.unity"). + + Build index. + + + + + Get the Scene path from a build index. + + + + Scene path (e.g "AssetsScenesScene1.unity"). + + + + + Scene unloading options passed to SceneManager.UnloadScene. + + + + + Unload scene without any special options. + + + + + Unloads all objects which were loaded from the scene's serialized file. Without this flag, only GameObject and Components within the scene's hierarchy will be unloaded. + +Note: Objects that are dynamically created during the build process can be embedded in the scene's serialized file. This can occur is when asset types are created and referenced inside the scene's post-processor callback. Some examples of these types are textures, meshes, and scriptable objects. Assets from your assets folder will not be embedded in the scene's serialized file. +Note: This flag will not unload assets which can be referenced by other scenes. + + + + + Access to display information. + + + + + Allow auto-rotation to landscape left? + + + + + Allow auto-rotation to landscape right? + + + + + Allow auto-rotation to portrait? + + + + + Allow auto-rotation to portrait, upside down? + + + + + The current screen resolution (Read Only). + + + + + The current DPI of the screen / device (Read Only). + + + + + Is the game running full-screen? + + + + + Set this property to one of the values in FullScreenMode to change the display mode of your application. + + + + + The current height of the screen window in pixels (Read Only). + + + + + Should the cursor be locked? + + + + + Specifies logical orientation of the screen. + + + + + All full-screen resolutions supported by the monitor (Read Only). + + + + + Returns the safe area of the screen in pixels (Read Only). + + + + + Should the cursor be visible? + + + + + A power saving setting, allowing the screen to dim some time after the last active user interaction. + + + + + The current width of the screen window in pixels (Read Only). + + + + + Switches the screen resolution. + + + + + + + + + + Switches the screen resolution. + + + + + + + + + + Switches the screen resolution. + + + + + + + + + + Functionality to take Screenshots. + + + + + Captures a screenshot at path filename as a PNG file. + + Pathname to save the screenshot file to. + Factor by which to increase resolution. + Specifies the eye texture to capture when stereo rendering is enabled. + + + + Captures a screenshot at path filename as a PNG file. + + Pathname to save the screenshot file to. + Factor by which to increase resolution. + Specifies the eye texture to capture when stereo rendering is enabled. + + + + Captures a screenshot of the game view into a Texture2D object. + + Factor by which to increase resolution. + Specifies the eye texture to capture when stereo rendering is enabled. + + + + Captures a screenshot of the game view into a Texture2D object. + + Factor by which to increase resolution. + Specifies the eye texture to capture when stereo rendering is enabled. + + + + Enumeration specifying the eye texture to capture when using ScreenCapture.CaptureScreenshot and when stereo rendering is enabled. + + + + + Both the left and right eyes are captured and composited into one image. + + + + + The Left Eye is captured. This is the default setting for the CaptureScreenshot method. + + + + + The Right Eye is captured. + + + + + Describes screen orientation. + + + + + Auto-rotates the screen as necessary toward any of the enabled orientations. + + + + + Landscape orientation, counter-clockwise from the portrait orientation. + + + + + Landscape orientation, clockwise from the portrait orientation. + + + + + Portrait orientation. + + + + + Portrait orientation, upside down. + + + + + A class you can derive from if you want to create objects that don't need to be attached to game objects. + + + + + Creates an instance of a scriptable object. + + The type of the ScriptableObject to create, as the name of the type. + The type of the ScriptableObject to create, as a System.Type instance. + + The created ScriptableObject. + + + + + Creates an instance of a scriptable object. + + The type of the ScriptableObject to create, as the name of the type. + The type of the ScriptableObject to create, as a System.Type instance. + + The created ScriptableObject. + + + + + Creates an instance of a scriptable object. + + + The created ScriptableObject. + + + + + Ensure an assembly is always processed during managed code stripping. + + + + + Experimental API to control the garbage collector on the Mono and IL2CPP scripting backends. + + + + + Set and get global garbage collector operation mode. + + + + + Subscribe to this event to get notified when GarbageCollector.GCMode changes. + + + + + + Garbage collector operation mode. + + + + + Disable garbage collector. + + + + + Enable garbage collector. + + + + + PreserveAttribute prevents byte code stripping from removing a class, method, field, or property. + + + + + Webplayer security related class. Not supported from 5.4.0 onwards. + + + + + Loads an assembly and checks that it is allowed to be used in the webplayer. (Web Player is no Longer Supported). + + Assembly to verify. + Public key used to verify assembly. + + Loaded, verified, assembly, or null if the assembly cannot be verfied. + + + + + Loads an assembly and checks that it is allowed to be used in the webplayer. (Web Player is no Longer Supported). + + Assembly to verify. + Public key used to verify assembly. + + Loaded, verified, assembly, or null if the assembly cannot be verfied. + + + + + Prefetch the webplayer socket security policy from a non-default port number. + + IP address of server. + Port from where socket policy is read. + Time to wait for response. + + + + Prefetch the webplayer socket security policy from a non-default port number. + + IP address of server. + Port from where socket policy is read. + Time to wait for response. + + + + Add this attribute to a script class to mark its GameObject as a selection base object for Scene View picking. + + + + + Options for how to send a message. + + + + + No receiver is required for SendMessage. + + + + + A receiver is required for SendMessage. + + + + + Use this attribute to rename a field without losing its serialized value. + + + + + The name of the field before the rename. + + + + + + + The name of the field before renaming. + + + + Force Unity to serialize a private field. + + + + + Shader scripts used for all rendering. + + + + + Shader LOD level for all shaders. + + + + + Render pipeline currently in use. + + + + + Shader hardware tier classification for current device. + + + + + Can this shader run on the end-users graphics card? (Read Only) + + + + + Shader LOD level for this shader. + + + + + Render queue of this shader. (Read Only) + + + + + Unset a global shader keyword. + + + + + + Set a global shader keyword. + + + + + + Finds a shader with the given name. + + + + + + Gets a global color property for all shaders previously set using SetGlobalColor. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Gets a global color property for all shaders previously set using SetGlobalColor. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Gets a global float property for all shaders previously set using SetGlobalFloat. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Gets a global float property for all shaders previously set using SetGlobalFloat. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Gets a global float array for all shaders previously set using SetGlobalFloatArray. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Gets a global float array for all shaders previously set using SetGlobalFloatArray. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Fetches a global float array into a list. + + The list to hold the returned array. + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Fetches a global float array into a list. + + The list to hold the returned array. + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Gets a global int property for all shaders previously set using SetGlobalInt. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Gets a global int property for all shaders previously set using SetGlobalInt. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Gets a global matrix property for all shaders previously set using SetGlobalMatrix. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Gets a global matrix property for all shaders previously set using SetGlobalMatrix. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Gets a global matrix array for all shaders previously set using SetGlobalMatrixArray. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Gets a global matrix array for all shaders previously set using SetGlobalMatrixArray. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Fetches a global matrix array into a list. + + The list to hold the returned array. + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Fetches a global matrix array into a list. + + The list to hold the returned array. + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Gets a global texture property for all shaders previously set using SetGlobalTexture. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Gets a global texture property for all shaders previously set using SetGlobalTexture. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Gets a global vector property for all shaders previously set using SetGlobalVector. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Gets a global vector property for all shaders previously set using SetGlobalVector. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Gets a global vector array for all shaders previously set using SetGlobalVectorArray. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Gets a global vector array for all shaders previously set using SetGlobalVectorArray. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Fetches a global vector array into a list. + + The list to hold the returned array. + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Fetches a global vector array into a list. + + The list to hold the returned array. + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + Is global shader keyword enabled? + + + + + + Gets unique identifier for a shader property name. + + Shader property name. + + Unique integer for the name. + + + + + Sets a global compute buffer property for all shaders. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + + Sets a global compute buffer property for all shaders. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + + Sets a global color property for all shaders. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + + Sets a global color property for all shaders. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + + Sets a global float property for all shaders. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + + Sets a global float property for all shaders. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + + Sets a global float array property for all shaders. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + + Sets a global float array property for all shaders. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + + Sets a global float array property for all shaders. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + + Sets a global float array property for all shaders. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + + Sets a global int property for all shaders. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + + Sets a global int property for all shaders. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + + Sets a global matrix property for all shaders. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + + Sets a global matrix property for all shaders. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + + Sets a global matrix array property for all shaders. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + + Sets a global matrix array property for all shaders. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + + Sets a global matrix array property for all shaders. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + + Sets a global matrix array property for all shaders. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + + Sets a global texture property for all shaders. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + + Sets a global texture property for all shaders. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + + Sets a global vector property for all shaders. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + + Sets a global vector property for all shaders. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + + Sets a global vector array property for all shaders. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + + Sets a global vector array property for all shaders. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + + Sets a global vector array property for all shaders. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + + Sets a global vector array property for all shaders. + + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + + + + + Fully load all shaders to prevent future performance hiccups. + + + + + ShaderVariantCollection records which shader variants are actually used in each shader. + + + + + Is this ShaderVariantCollection already warmed up? (Read Only) + + + + + Number of shaders in this collection (Read Only). + + + + + Number of total varians in this collection (Read Only). + + + + + Adds a new shader variant to the collection. + + Shader variant to add. + + False if already in the collection. + + + + + Remove all shader variants from the collection. + + + + + Checks if a shader variant is in the collection. + + Shader variant to check. + + True if the variant is in the collection. + + + + + Create a new empty shader variant collection. + + + + + Adds shader variant from the collection. + + Shader variant to add. + + False if was not in the collection. + + + + + Identifies a specific variant of a shader. + + + + + Array of shader keywords to use in this variant. + + + + + Pass type to use in this variant. + + + + + Shader to use in this variant. + + + + + Creates a ShaderVariant structure. + + + + + + + + Fully load shaders in ShaderVariantCollection. + + + + + The rendering mode of Shadowmask. + + + + + Static shadow casters will be rendered into realtime shadow maps. Shadowmasks and occlusion from Light Probes will only be used past the realtime shadow distance. + + + + + Static shadow casters won't be rendered into realtime shadow maps. All shadows from static casters are handled via Shadowmasks and occlusion from Light Probes. + + + + + Shadow projection type for. + + + + + Close fit shadow maps with linear fadeout. + + + + + Stable shadow maps with spherical fadeout. + + + + + Determines which type of shadows should be used. + + + + + Hard and Soft Shadows. + + + + + Disable Shadows. + + + + + Hard Shadows Only. + + + + + Default shadow resolution. + + + + + High shadow map resolution. + + + + + Low shadow map resolution. + + + + + Medium shadow map resolution. + + + + + Very high shadow map resolution. + + + + + SharedBetweenAnimatorsAttribute is an attribute that specify that this StateMachineBehaviour should be instantiate only once and shared among all Animator instance. This attribute reduce the memory footprint for each controller instance. + + + + + Details of the Transform name mapped to the skeleton bone of a model and its default position and rotation in the T-pose. + + + + + The name of the Transform mapped to the bone. + + + + + The T-pose position of the bone in local space. + + + + + The T-pose rotation of the bone in local space. + + + + + The T-pose scaling of the bone in local space. + + + + + The Skinned Mesh filter. + + + + + The bones used to skin the mesh. + + + + + Forces the Skinned Mesh to recalculate its matricies when rendered + + + + + AABB of this Skinned Mesh in its local space. + + + + + The maximum number of bones affecting a single vertex. + + + + + The mesh used for skinning. + + + + + Specifies whether skinned motion vectors should be used for this renderer. + + + + + If enabled, the Skinned Mesh will be updated when offscreen. If disabled, this also disables updating animations. + + + + + Creates a snapshot of SkinnedMeshRenderer and stores it in mesh. + + A static mesh that will receive the snapshot of the skinned mesh. + + + + Returns the weight of a BlendShape for this Renderer. + + The index of the BlendShape whose weight you want to retrieve. Index must be smaller than the Mesh.blendShapeCount of the Mesh attached to this Renderer. + + The weight of the BlendShape. + + + + + Sets the weight of a BlendShape for this Renderer. + + The index of the BlendShape to modify. Index must be smaller than the Mesh.blendShapeCount of the Mesh attached to this Renderer. + The weight for this BlendShape. + + + + The maximum number of bones affecting a single vertex. + + + + + Chooses the number of bones from the number current QualitySettings. (Default) + + + + + Use only 1 bone to deform a single vertex. (The most important bone will be used). + + + + + Use 2 bones to deform a single vertex. (The most important bones will be used). + + + + + Use 4 bones to deform a single vertex. + + + + + A script interface for the. + + + + + The material used by the skybox. + + + + + Constants for special values of Screen.sleepTimeout. + + + + + Prevent screen dimming. + + + + + Set the sleep timeout to whatever the user has specified in the system settings. + + + + + Joint that restricts the motion of a Rigidbody2D object to a single line. + + + + + The angle of the line in space (in degrees). + + + + + Should the angle be calculated automatically? + + + + + The current joint speed. + + + + + The current joint translation. + + + + + Restrictions on how far the joint can slide in each direction along the line. + + + + + Gets the state of the joint limit. + + + + + Parameters for a motor force that is applied automatically to the Rigibody2D along the line. + + + + + The angle (in degrees) referenced between the two bodies used as the constraint for the joint. + + + + + Should motion limits be used? + + + + + Should a motor force be applied automatically to the Rigidbody2D? + + + + + Gets the motor force of the joint given the specified timestep. + + The time to calculate the motor force for. + + + + Generic access to the Social API. + + + + + The local user (potentially not logged in). + + + + + This is the currently active social platform. + + + + + Create an IAchievement instance. + + + + + Create an ILeaderboard instance. + + + + + Loads the achievement descriptions accociated with this application. + + + + + + Load the achievements the logged in user has already achieved or reported progress on. + + + + + + Load a default set of scores from the given leaderboard. + + + + + + + Load the user profiles accociated with the given array of user IDs. + + + + + + + Reports the progress of an achievement. + + + + + + + + Report a score to a specific leaderboard. + + + + + + + + Show a default/system view of the games achievements. + + + + + Show a default/system view of the games leaderboards. + + + + + iOS GameCenter implementation for network services. + + + + + Reset all the achievements for the local user. + + + + + + Show the default iOS banner when achievements are completed. + + + + + + Show the leaderboard UI with a specific leaderboard shown initially with a specific time scope selected. + + + + + + + Information for a user's achievement. + + + + + Set to true when percentCompleted is 100.0. + + + + + This achievement is currently hidden from the user. + + + + + The unique identifier of this achievement. + + + + + Set by server when percentCompleted is updated. + + + + + Progress for this achievement. + + + + + Send notification about progress on this achievement. + + + + + + Static data describing an achievement. + + + + + Description when the achivement is completed. + + + + + Hidden achievement are not shown in the list until the percentCompleted has been touched (even if it's 0.0). + + + + + Unique identifier for this achievement description. + + + + + Image representation of the achievement. + + + + + Point value of this achievement. + + + + + Human readable title. + + + + + Description when the achivement has not been completed. + + + + + The leaderboard contains the scores of all players for a particular game. + + + + + Unique identifier for this leaderboard. + + + + + The leaderboad is in the process of loading scores. + + + + + The leaderboard score of the logged in user. + + + + + The total amount of scores the leaderboard contains. + + + + + The rank range this leaderboard returns. + + + + + The leaderboard scores returned by a query. + + + + + The time period/scope searched by this leaderboard. + + + + + The human readable title of this leaderboard. + + + + + The users scope searched by this leaderboard. + + + + + Load scores according to the filters set on this leaderboard. + + + + + + Only search for these user IDs. + + List of user ids. + + + + Represents the local or currently logged in user. + + + + + Checks if the current user has been authenticated. + + + + + The users friends list. + + + + + Is the user underage? + + + + + Authenticate the local user to the current active Social API implementation and fetch his profile data. + + Callback that is called whenever the authentication operation is finished. The first parameter is a Boolean identifying whether the authentication operation was successful. The optional second argument contains a string identifying any errors (if available) if the operation was unsuccessful. + + + + Authenticate the local user to the current active Social API implementation and fetch his profile data. + + Callback that is called whenever the authentication operation is finished. The first parameter is a Boolean identifying whether the authentication operation was successful. The optional second argument contains a string identifying any errors (if available) if the operation was unsuccessful. + + + + Fetches the friends list of the logged in user. The friends list on the ISocialPlatform.localUser|Social.localUser instance is populated if this call succeeds. + + + + + + A game score. + + + + + The date the score was achieved. + + + + + The correctly formatted value of the score, like X points or X kills. + + + + + The ID of the leaderboard this score belongs to. + + + + + The rank or position of the score in the leaderboard. + + + + + The user who owns this score. + + + + + The score value achieved. + + + + + Report this score instance. + + + + + + The generic Social API interface which implementations must inherit. + + + + + See Social.localUser. + + + + + See Social.CreateAchievement.. + + + + + See Social.CreateLeaderboard. + + + + + See Social.LoadAchievementDescriptions. + + + + + + See Social.LoadAchievements. + + + + + + See Social.LoadScores. + + + + + + + + See Social.LoadScores. + + + + + + + + See Social.LoadUsers. + + + + + + + See Social.ReportProgress. + + + + + + + + See Social.ReportScore. + + + + + + + + See Social.ShowAchievementsUI. + + + + + See Social.ShowLeaderboardUI. + + + + + Represents generic user instances, like friends of the local user. + + + + + This users unique identifier. + + + + + Avatar image of the user. + + + + + Is this user a friend of the current logged in user? + + + + + Presence state of the user. + + + + + This user's username or alias. + + + + + The score range a leaderboard query should include. + + + + + The total amount of scores retreived. + + + + + The rank of the first score which is returned. + + + + + Constructor for a score range, the range starts from a specific value and contains a maxium score count. + + The minimum allowed value. + The number of possible values. + + + + The scope of time searched through when querying the leaderboard. + + + + + The scope of the users searched through when querying the leaderboard. + + + + + User presence state. + + + + + The user is offline. + + + + + The user is online. + + + + + The user is online but away from their computer. + + + + + The user is online but set their status to busy. + + + + + The user is playing a game. + + + + + The limits defined by the CharacterJoint. + + + + + When the joint hits the limit, it can be made to bounce off it. + + + + + Determines how far ahead in space the solver can "see" the joint limit. + + + + + If spring is greater than zero, the limit is soft. + + + + + The limit position/angle of the joint (in degrees). + + + + + If greater than zero, the limit is soft. The spring will pull the joint back. + + + + + The configuration of the spring attached to the joint's limits: linear and angular. Used by CharacterJoint and ConfigurableJoint. + + + + + The damping of the spring limit. In effect when the stiffness of the sprint limit is not zero. + + + + + The stiffness of the spring limit. When stiffness is zero the limit is hard, otherwise soft. + + + + + SortingLayer allows you to set the render order of multiple sprites easily. There is always a default SortingLayer named "Default" which all sprites are added to initially. Added more SortingLayers to easily control the order of rendering of groups of sprites. Layers can be ordered before or after the default layer. + + + + + This is the unique id assigned to the layer. It is not an ordered running value and it should not be used to compare with other layers to determine the sorting order. + + + + + Returns all the layers defined in this project. + + + + + Returns the name of the layer as defined in the TagManager. + + + + + This is the relative value that indicates the sort order of this layer relative to the other layers. + + + + + Returns the final sorting layer value. To determine the sorting order between the various sorting layers, use this method to retrieve the final sorting value and use CompareTo to determine the order. + + The unique value of the sorting layer as returned by any renderer's sortingLayerID property. + + The final sorting value of the layer relative to other layers. + + + + + Returns the final sorting layer value. See Also: GetLayerValueFromID. + + The unique value of the sorting layer as returned by any renderer's sortingLayerID property. + + The final sorting value of the layer relative to other layers. + + + + + Returns the unique id of the layer. Will return "<unknown layer>" if an invalid id is given. + + The unique id of the layer. + + The name of the layer with id or "<unknown layer>" for invalid id. + + + + + Returns true if the id provided is a valid layer id. + + The unique id of a layer. + + True if the id provided is valid and assigned to a layer. + + + + + Returns the id given the name. Will return 0 if an invalid name was given. + + The name of the layer. + + The unique id of the layer with name. + + + + + The coordinate space in which to operate. + + + + + Applies transformation relative to the local coordinate system. + + + + + Applies transformation relative to the world coordinate system. + + + + + Use this PropertyAttribute to add some spacing in the Inspector. + + + + + The spacing in pixels. + + + + + Use this DecoratorDrawer to add some spacing in the Inspector. + + The spacing in pixels. + + + + Class for handling Sparse Textures. + + + + + Is the sparse texture actually created? (Read Only) + + + + + Get sparse texture tile height (Read Only). + + + + + Get sparse texture tile width (Read Only). + + + + + Create a sparse texture. + + Texture width in pixels. + Texture height in pixels. + Texture format. + Mipmap count. Pass -1 to create full mipmap chain. + Whether texture data will be in linear or sRGB color space (default is sRGB). + + + + Create a sparse texture. + + Texture width in pixels. + Texture height in pixels. + Texture format. + Mipmap count. Pass -1 to create full mipmap chain. + Whether texture data will be in linear or sRGB color space (default is sRGB). + + + + Unload sparse texture tile. + + Tile X coordinate. + Tile Y coordinate. + Mipmap level of the texture. + + + + Update sparse texture tile with color values. + + Tile X coordinate. + Tile Y coordinate. + Mipmap level of the texture. + Tile color data. + + + + Update sparse texture tile with raw pixel values. + + Tile X coordinate. + Tile Y coordinate. + Mipmap level of the texture. + Tile raw pixel data. + + + + Use this struct to set up a sphere cast command that is performed asynchronously during a job. + + + + + The direction of the sphere cast. + + + + + The maximum distance the sphere should check for collisions. + + + + + The LayerMask that selectively ignores Colliders when casting a sphere. + + + + + The starting point of the sphere cast in world coordinates. + + + + + The radius of the casting sphere. + + + + + Creates a SpherecastCommand. + + The starting point of the sphere cast. + The radius of the casting sphere. + The direction of the sphere cast. + The maximum distance the cast should check for collisions. + The LayerMask that selectively ignores Colliders when casting a sphere. + + + + Schedules a batch of sphere casts to perform in a job. + + A NaviveArray of SpherecastCommands to perform. + A NavtiveArray of RaycastHit where the result of commands are stored. + The minimum number of jobs which should be performed in a single job. + A jobHandle of the job that must be completed before performing the sphere casts. + + Returns a JobHandle of the job that will perform the sphere casts. + + + + + A sphere-shaped primitive collider. + + + + + The center of the sphere in the object's local space. + + + + + The radius of the sphere measured in the object's local space. + + + + + A Splat prototype is just a texture that is used by the TerrainData. + + + + + The metallic value of the splat layer. + + + + + Normal map of the splat applied to the Terrain. + + + + + The smoothness value of the splat layer when the main texture has no alpha channel. + + + + + Texture of the splat applied to the Terrain. + + + + + Offset of the tile texture of the SplatPrototype. + + + + + Size of the tile used in the texture of the SplatPrototype. + + + + + The spring joint ties together 2 rigid bodies, spring forces will be automatically applied to keep the object at the given distance. + + + + + The damper force used to dampen the spring force. + + + + + The maximum distance between the bodies relative to their initial distance. + + + + + The minimum distance between the bodies relative to their initial distance. + + + + + The spring force used to keep the two objects together. + + + + + The maximum allowed error between the current spring length and the length defined by minDistance and maxDistance. + + + + + Joint that attempts to keep two Rigidbody2D objects a set distance apart by applying a force between them. + + + + + Should the distance be calculated automatically? + + + + + The amount by which the spring force is reduced in proportion to the movement speed. + + + + + The distance the spring will try to keep between the two objects. + + + + + The frequency at which the spring oscillates around the distance distance between the objects. + + + + + Represents a Sprite object for use in 2D gameplay. + + + + + Returns the texture that contains the alpha channel from the source texture. Unity generates this texture under the hood for sprites that have alpha in the source, and need to be compressed using techniques like ETC1. + +Returns NULL if there is no associated alpha texture for the source sprite. This is the case if the sprite has not been setup to use ETC1 compression. + + + + + Returns the border sizes of the sprite. + + + + + Bounds of the Sprite, specified by its center and extents in world space units. + + + + + Returns true if this Sprite is packed in an atlas. + + + + + If Sprite is packed (see Sprite.packed), returns its SpritePackingMode. + + + + + If Sprite is packed (see Sprite.packed), returns its SpritePackingRotation. + + + + + Location of the Sprite's center point in the Rect on the original Texture, specified in pixels. + + + + + The number of pixels in the sprite that correspond to one unit in world space. (Read Only) + + + + + Location of the Sprite on the original Texture, specified in pixels. + + + + + Get the reference to the used texture. If packed this will point to the atlas, if not packed will point to the source sprite. + + + + + Get the rectangle this sprite uses on its texture. Raises an exception if this sprite is tightly packed in an atlas. + + + + + Gets the offset of the rectangle this sprite uses on its texture to the original sprite bounds. If sprite mesh type is FullRect, offset is zero. + + + + + Returns a copy of the array containing sprite mesh triangles. + + + + + The base texture coordinates of the sprite mesh. + + + + + Returns a copy of the array containing sprite mesh vertex positions. + + + + + Create a new Sprite object. + + Texture from which to obtain the sprite graphic. + Rectangular section of the texture to use for the sprite. + Sprite's pivot point relative to its graphic rectangle. + The number of pixels in the sprite that correspond to one unit in world space. + Amount by which the sprite mesh should be expanded outwards. + Controls the type of mesh generated for the sprite. + The border sizes of the sprite (X=left, Y=bottom, Z=right, W=top). + Generates a default physics shape for the sprite. + + + + Create a new Sprite object. + + Texture from which to obtain the sprite graphic. + Rectangular section of the texture to use for the sprite. + Sprite's pivot point relative to its graphic rectangle. + The number of pixels in the sprite that correspond to one unit in world space. + Amount by which the sprite mesh should be expanded outwards. + Controls the type of mesh generated for the sprite. + The border sizes of the sprite (X=left, Y=bottom, Z=right, W=top). + Generates a default physics shape for the sprite. + + + + Create a new Sprite object. + + Texture from which to obtain the sprite graphic. + Rectangular section of the texture to use for the sprite. + Sprite's pivot point relative to its graphic rectangle. + The number of pixels in the sprite that correspond to one unit in world space. + Amount by which the sprite mesh should be expanded outwards. + Controls the type of mesh generated for the sprite. + The border sizes of the sprite (X=left, Y=bottom, Z=right, W=top). + Generates a default physics shape for the sprite. + + + + Create a new Sprite object. + + Texture from which to obtain the sprite graphic. + Rectangular section of the texture to use for the sprite. + Sprite's pivot point relative to its graphic rectangle. + The number of pixels in the sprite that correspond to one unit in world space. + Amount by which the sprite mesh should be expanded outwards. + Controls the type of mesh generated for the sprite. + The border sizes of the sprite (X=left, Y=bottom, Z=right, W=top). + Generates a default physics shape for the sprite. + + + + Create a new Sprite object. + + Texture from which to obtain the sprite graphic. + Rectangular section of the texture to use for the sprite. + Sprite's pivot point relative to its graphic rectangle. + The number of pixels in the sprite that correspond to one unit in world space. + Amount by which the sprite mesh should be expanded outwards. + Controls the type of mesh generated for the sprite. + The border sizes of the sprite (X=left, Y=bottom, Z=right, W=top). + Generates a default physics shape for the sprite. + + + + Create a new Sprite object. + + Texture from which to obtain the sprite graphic. + Rectangular section of the texture to use for the sprite. + Sprite's pivot point relative to its graphic rectangle. + The number of pixels in the sprite that correspond to one unit in world space. + Amount by which the sprite mesh should be expanded outwards. + Controls the type of mesh generated for the sprite. + The border sizes of the sprite (X=left, Y=bottom, Z=right, W=top). + Generates a default physics shape for the sprite. + + + + Gets a physics shape from the Sprite by its index. + + The index of the physics shape to retrieve. + An ordered list of the points in the selected physics shape to store points in. + + The number of points stored in the given list. + + + + + The number of physics shapes for the Sprite. + + + The number of physics shapes for the Sprite. + + + + + The number of points in the selected physics shape for the Sprite. + + The index of the physics shape to retrieve the number of points from. + + The number of points in the selected physics shape for the Sprite. + + + + + Sets up new Sprite geometry. + + Array of vertex positions in Sprite Rect space. + Array of sprite mesh triangle indices. + + + + Sets up a new Sprite physics shape. + + A multidimensional list of points in Sprite.rect space denoting the physics shape outlines. + + + + How a Sprite's graphic rectangle is aligned with its pivot point. + + + + + Pivot is at the center of the bottom edge of the graphic rectangle. + + + + + Pivot is at the bottom left corner of the graphic rectangle. + + + + + Pivot is at the bottom right corner of the graphic rectangle. + + + + + Pivot is at the center of the graphic rectangle. + + + + + Pivot is at a custom position within the graphic rectangle. + + + + + Pivot is at the center of the left edge of the graphic rectangle. + + + + + Pivot is at the center of the right edge of the graphic rectangle. + + + + + Pivot is at the center of the top edge of the graphic rectangle. + + + + + Pivot is at the top left corner of the graphic rectangle. + + + + + Pivot is at the top right corner of the graphic rectangle. + + + + + SpriteRenderer draw mode. + + + + + Displays the full sprite. + + + + + The SpriteRenderer will render the sprite as a 9-slice image where the corners will remain constant and the other sections will scale. + + + + + The SpriteRenderer will render the sprite as a 9-slice image where the corners will remain constant and the other sections will tile. + + + + + A component for masking Sprites and Particles. + + + + + The minimum alpha value used by the mask to select the area of influence defined over the mask's sprite. + + + + + Unique ID of the sorting layer defining the end of the custom range. + + + + + Order within the back sorting layer defining the end of the custom range. + + + + + Unique ID of the sorting layer defining the start of the custom range. + + + + + Order within the front sorting layer defining the start of the custom range. + + + + + Mask sprites from front to back sorting values only. + + + + + The Sprite used to define the mask. + + + + + Determines the position of the Sprite used for sorting the SpriteMask. + + + + + This enum controls the mode under which the sprite will interact with the masking system. + + + + + The sprite will not interact with the masking system. + + + + + The sprite will be visible only in areas where a mask is present. + + + + + The sprite will be visible only in areas where no mask is present. + + + + + Defines the type of mesh generated for a sprite. + + + + + Rectangle mesh equal to the user specified sprite size. + + + + + Tight mesh based on pixel alpha values. As many excess pixels are cropped as possible. + + + + + Sprite packing modes for the Sprite Packer. + + + + + Alpha-cropped ractangle packing. + + + + + Tight mesh based packing. + + + + + Sprite rotation modes for the Sprite Packer. + + + + + Any rotation. + + + + + Sprite is flipped horizontally when packed. + + + + + Sprite is flipped vertically when packed. + + + + + No rotation. + + + + + Sprite is rotated 180 degree when packed. + + + + + Renders a Sprite for 2D graphics. + + + + + The current threshold for Sprite Renderer tiling. + + + + + Rendering color for the Sprite graphic. + + + + + The current draw mode of the Sprite Renderer. + + + + + Flips the sprite on the X axis. + + + + + Flips the sprite on the Y axis. + + + + + Specifies how the sprite interacts with the masks. + + + + + Property to set/get the size to render when the SpriteRenderer.drawMode is set to SpriteDrawMode.Sliced. + + + + + The Sprite to render. + + + + + Determines the position of the Sprite used for sorting the SpriteRenderer. + + + + + The current tile mode of the Sprite Renderer. + + + + + Helper utilities for accessing Sprite data. + + + + + Inner UV's of the Sprite. + + + + + + Minimum width and height of the Sprite. + + + + + + Outer UV's of the Sprite. + + + + + + Return the padding on the sprite. + + + + + + Determines the position of the Sprite used for sorting the Renderer. + + + + + The center of the Sprite is used as the point for sorting the Renderer. + + + + + The pivot of the Sprite is used as the point for sorting the Renderer. + + + + + Tiling mode for SpriteRenderer.tileMode. + + + + + Sprite Renderer tiles the sprite once the Sprite Renderer size is above SpriteRenderer.adaptiveModeThreshold. + + + + + Sprite Renderer tiles the sprite continuously when is set to SpriteRenderer.tileMode. + + + + + Stack trace logging options. + + + + + Native and managed stack trace will be logged. + + + + + No stack trace will be outputed to log. + + + + + Only managed stack trace will be outputed. + + + + + StateMachineBehaviour is a component that can be added to a state machine state. It's the base class every script on a state derives from. + + + + + Called on the first Update frame when a state machine evaluate this state. + + + + + Called on the last update frame when a state machine evaluate this state. + + + + + Called right after MonoBehaviour.OnAnimatorIK. + + + + + Called on the first Update frame when making a transition to a state machine. This is not called when making a transition into a state machine sub-state. + + The Animator playing this state machine. + The full path hash for this state machine. + + + + Called on the last Update frame when making a transition out of a StateMachine. This is not called when making a transition into a StateMachine sub-state. + + The Animator playing this state machine. + The full path hash for this state machine. + + + + Called right after MonoBehaviour.OnAnimatorMove. + + + + + Called at each Update frame except for the first and last frame. + + + + + StaticBatchingUtility can prepare your objects to take advantage of Unity's static batching. + + + + + StaticBatchingUtility.Combine prepares all children of the staticBatchRoot for static batching. + + The GameObject that should become the root of the combined batch. + + + + StaticBatchingUtility.Combine prepares all GameObjects contained in gos for static batching. staticBatchRoot is treated as their parent. + + The GameObjects to prepare for static batching. + The GameObject that should become the root of the combined batch. + + + + Enum values for the Camera's targetEye property. + + + + + Render both eyes to the HMD. + + + + + Render only the Left eye to the HMD. + + + + + Do not render either eye to the HMD. + + + + + Render only the right eye to the HMD. + + + + + A StreamingController controls the streaming settings for an individual camera location. + + + + + Offset applied to the mipmap level chosen by the texture streaming system for any textures visible from this camera. This Offset can take either a positive or negative value. + + + + + Abort preloading. + + + + + Used to find out whether the StreamingController is currently preloading texture mipmaps. + + + True if in a preloading state, otherwise False. + + + + + Initiate preloading of streaming data for this camera. + + Optional timeout before stopping preloading. Set to 0.0f when no timeout is required. + Set to True to activate the connected Camera component when timeout expires. + Camera to deactivate on timeout (if Camera.activateCameraOnTime is True). This parameter can be null. + + + + Applies tangent forces along the surfaces of colliders. + + + + + The scale of the impulse force applied while attempting to reach the surface speed. + + + + + The speed to be maintained along the surface. + + + + + The speed variation (from zero to the variation) added to base speed to be applied. + + + + + Should bounce be used for any contact with the surface? + + + + + Should the impulse force but applied to the contact point? + + + + + Should friction be used for any contact with the surface? + + + + + Access system and hardware information. + + + + + The current battery level (Read Only). + + + + + Returns the current status of the device's battery (Read Only). + + + + + Support for various Graphics.CopyTexture cases (Read Only). + + + + + The model of the device (Read Only). + + + + + The user defined name of the device (Read Only). + + + + + Returns the kind of device the application is running on (Read Only). + + + + + A unique device identifier. It is guaranteed to be unique for every device (Read Only). + + + + + The identifier code of the graphics device (Read Only). + + + + + The name of the graphics device (Read Only). + + + + + The graphics API type used by the graphics device (Read Only). + + + + + The vendor of the graphics device (Read Only). + + + + + The identifier code of the graphics device vendor (Read Only). + + + + + The graphics API type and driver version used by the graphics device (Read Only). + + + + + Amount of video memory present (Read Only). + + + + + Is graphics device using multi-threaded rendering (Read Only)? + + + + + Graphics device shader capability level (Read Only). + + + + + Returns true if the texture UV coordinate convention for this platform has Y starting at the top of the image. + + + + + Returns true when the GPU has native support for indexing uniform arrays in fragment shaders without restrictions. + + + + + True if the GPU supports hidden surface removal. + + + + + Maximum Cubemap texture size (Read Only). + + + + + Maximum texture size (Read Only). + + + + + What NPOT (non-power of two size) texture support does the GPU provide? (Read Only) + + + + + Operating system name with version (Read Only). + + + + + Returns the operating system family the game is running on (Read Only). + + + + + Number of processors present (Read Only). + + + + + Processor frequency in MHz (Read Only). + + + + + Processor name (Read Only). + + + + + How many simultaneous render targets (MRTs) are supported? (Read Only) + + + + + Are 2D Array textures supported? (Read Only) + + + + + Are 32-bit index buffers supported? (Read Only) + + + + + Are 3D (volume) RenderTextures supported? (Read Only) + + + + + Are 3D (volume) textures supported? (Read Only) + + + + + Is an accelerometer available on the device? + + + + + Returns true when the platform supports asynchronous compute queues and false if otherwise. + +Note that asynchronous compute queues are only supported on PS4. + + + + + Returns true if asynchronous readback of GPU data is available for this device and false otherwise. + + + + + Is there an Audio device available for playback? (Read Only) + + + + + Are compute shaders supported? (Read Only) + + + + + Are Cubemap Array textures supported? (Read Only) + + + + + Returns true when the platform supports GPUFences and false if otherwise. + +Note that GPUFences are only supported on PS4. + + + + + Is a gyroscope available on the device? + + + + + Does the hardware support quad topology? (Read Only) + + + + + Are image effects supported? (Read Only) + + + + + Is GPU draw call instancing supported? (Read Only) + + + + + Is the device capable of reporting its location? + + + + + Is streaming of texture mip maps supported? (Read Only) + + + + + Whether motion vectors are supported on this platform. + + + + + Returns true if multisampled textures are resolved automatically + + + + + Are multisampled textures supported? (Read Only) + + + + + Is sampling raw depth from shadowmaps supported? (Read Only) + + + + + Are render textures supported? (Read Only) + + + + + Are cubemap render textures supported? (Read Only) + + + + + Returns true when the platform supports different blend modes when rendering to multiple render targets, or false otherwise. + + + + + Are built-in shadows supported? (Read Only) + + + + + Are sparse textures supported? (Read Only) + + + + + Is the stencil buffer supported? (Read Only) + + + + + Returns true if the 'Mirror Once' texture wrap mode is supported. (Read Only) + + + + + Is the device capable of providing the user haptic feedback by vibration? + + + + + Amount of system memory present (Read Only). + + + + + Value returned by SystemInfo string properties which are not supported on the current platform. + + + + + This property is true if the current platform uses a reversed depth buffer (where values range from 1 at the near plane and 0 at far plane), and false if the depth buffer is normal (0 is near, 1 is far). (Read Only) + + + + + Verifies that the specified graphics format is supported for the specified usage. + + The Experimental.Rendering.GraphicsFormat format to look up. + The Experimental.Rendering.FormatUsage usage to look up. + + Returns true if the format is supported for the specific usage. Returns false otherwise. + + + + + Is blending supported on render texture format? + + The format to look up. + + True if blending is supported on the given format. + + + + + Is render texture format supported? + + The format to look up. + + True if the format is supported. + + + + + Is texture format supported on this device? + + The TextureFormat format to look up. + + True if the format is supported. + + + + + The language the user's operating system is running in. Returned by Application.systemLanguage. + + + + + Afrikaans. + + + + + Arabic. + + + + + Basque. + + + + + Belarusian. + + + + + Bulgarian. + + + + + Catalan. + + + + + Chinese. + + + + + ChineseSimplified. + + + + + ChineseTraditional. + + + + + Czech. + + + + + Danish. + + + + + Dutch. + + + + + English. + + + + + Estonian. + + + + + Faroese. + + + + + Finnish. + + + + + French. + + + + + German. + + + + + Greek. + + + + + Hebrew. + + + + + Hungarian. + + + + + Icelandic. + + + + + Indonesian. + + + + + Italian. + + + + + Japanese. + + + + + Korean. + + + + + Latvian. + + + + + Lithuanian. + + + + + Norwegian. + + + + + Polish. + + + + + Portuguese. + + + + + Romanian. + + + + + Russian. + + + + + Serbo-Croatian. + + + + + Slovak. + + + + + Slovenian. + + + + + Spanish. + + + + + Swedish. + + + + + Thai. + + + + + Turkish. + + + + + Ukrainian. + + + + + Unknown. + + + + + Vietnamese. + + + + + The joint attempts to move a Rigidbody2D to a specific target position. + + + + + The local-space anchor on the rigid-body the joint is attached to. + + + + + Should the target be calculated automatically? + + + + + The amount by which the target spring force is reduced in proportion to the movement speed. + + + + + The frequency at which the target spring oscillates around the target position. + + + + + The maximum force that can be generated when trying to maintain the target joint constraint. + + + + + The world-space position that the joint will attempt to move the body to. + + + + + The Terrain component renders the terrain. + + + + + The active terrain. This is a convenience function to get to the main terrain in the Scene. + + + + + The active terrains in the Scene. + + + + + Specifies if the terrain tile will be automatically connected to adjacent tiles. + + + + + Specifies if an array of internal light probes should be baked for terrain trees. Available only in editor. + + + + + Heightmap patches beyond basemap distance will use a precomputed low res basemap. + + + + + Terrain bottom neighbor. + + + + + Should terrain cast shadows?. + + + + + Collect detail patches from memory. + + + + + Removes ringing from probes on trees if enabled. + + + + + Density of detail objects. + + + + + Detail objects will be displayed up to this distance. + + + + + Specify if terrain heightmap should be drawn. + + + + + Set to true to enable the terrain instance renderer. The default value is false. + + + + + Specify if terrain trees and details should be drawn. + + + + + Controls what part of the terrain should be rendered. + + + + + Whether some per-camera rendering resources for the terrain should be freed after not being used for some frames. + + + + + Grouping ID for auto connect. + + + + + Lets you essentially lower the heightmap resolution used for rendering. + + + + + An approximation of how many pixels the terrain will pop in the worst case when switching lod. + + + + + RenderTextureFormat of the terrain heightmap. + + + + + Texture format of the terrain heightmap. + + + + + Terrain left neighbor. + + + + + The shininess value of the terrain. + + + + + The specular color of the terrain. + + + + + The index of the baked lightmap applied to this terrain. + + + + + The UV scale & offset used for a baked lightmap. + + + + + The custom material used to render the terrain. + + + + + The type of the material used to render the terrain. Could be one of the built-in types or custom. See Terrain.MaterialType. + + + + + Returns the normal map texture computed from sampling the heightmap. It is only used when terrain is rendered using instancing. + + + + + Set the terrain bounding box scale. + + + + + Allows you to specify how Unity chooses the for tree instances. + + + + + The index of the realtime lightmap applied to this terrain. + + + + + The UV scale & offset used for a realtime lightmap. + + + + + How reflection probes are used for terrain. See Rendering.ReflectionProbeUsage. + + + + + Terrain right neighbor. + + + + + The Terrain Data that stores heightmaps, terrain textures, detail meshes and trees. + + + + + Terrain top neighbor. + + + + + Distance from the camera where trees will be rendered as billboards only. + + + + + Total distance delta that trees will use to transition from billboard orientation to mesh orientation. + + + + + The maximum distance at which trees are rendered. + + + + + The multiplier to the current LOD bias used for rendering LOD trees (i.e. SpeedTree trees). + + + + + Maximum number of trees rendered at full LOD. + + + + + Adds a tree instance to the terrain. + + + + + + Update the terrain's LOD and vegetation information after making changes with TerrainData.SetHeightsDelayLOD. + + + + + Creates a Terrain including collider from TerrainData. + + + + + + Flushes any change done in the terrain so it takes effect. + + + + + Fills the list with reflection probes whose AABB intersects with terrain's AABB. Their weights are also provided. Weight shows how much influence the probe has on the terrain, and is used when the blending between multiple reflection probes occurs. + + [in / out] A list to hold the returned reflection probes and their weights. See ReflectionProbeBlendInfo. + + + + Get the position of the terrain. + + + + + Get the previously set splat material properties by copying to the dest MaterialPropertyBlock object. + + + + + + The type of the material used to render a terrain object. Could be one of the built-in types or custom. + + + + + A built-in material that uses the legacy Lambert (diffuse) lighting model and has optional normal map support. + + + + + A built-in material that uses the legacy BlinnPhong (specular) lighting model and has optional normal map support. + + + + + A built-in material that uses the standard physically-based lighting model. Inputs supported: smoothness, metallic / specular, normal. + + + + + Use a custom material given by Terrain.materialTemplate. + + + + + Samples the height at the given position defined in world space, relative to the terrain space. + + + + + + Marks the current connectivity status as invalid. + + + + + Lets you setup the connection between neighboring Terrains. + + + + + + + + + Set the additional material properties when rendering the terrain heightmap using the splat material. + + + + + + Indicate the types of changes to the terrain in OnTerrainChanged callback. + + + + + Indicates a change to the heightmap data without computing LOD. + + + + + Indicates that a change was made to the terrain that was so significant that the internal rendering data need to be flushed and recreated. + + + + + Indicates a change to the heightmap data. + + + + + Indicates a change to the detail data. + + + + + Indicates a change to the tree data. + + + + + Indicates that the TerrainData object is about to be destroyed. + + + + + A heightmap based collider. + + + + + The terrain that stores the heightmap. + + + + + The TerrainData class stores heightmaps, detail mesh positions, tree instances, and terrain texture alpha maps. + + + + + Height of the alpha map. + + + + + Number of alpha map layers. + + + + + Resolution of the alpha map. + + + + + Returns the number of alphamap textures. + + + + + Alpha map textures used by the Terrain. Used by Terrain Inspector for undo. + + + + + Width of the alpha map. + + + + + Resolution of the base map used for rendering far patches on the terrain. + + + + + The local bounding box of the TerrainData object. + + + + + Detail height of the TerrainData. + + + + + The number of patches along a terrain tile edge. This is squared to make a grid of patches. + + + + + Contains the detail texture/meshes that the terrain has. + + + + + Detail Resolution of the TerrainData. + + + + + Detail Resolution of each patch. A larger value will decrease the number of batches used by detail objects. + + + + + Detail width of the TerrainData. + + + + + Height of the terrain in samples (Read Only). + + + + + Resolution of the heightmap. + + + + + The size of each heightmap sample. + + + + + Returns the heightmap texture. + + + + + Width of the terrain in samples (Read Only). + + + + + The total size in world units of the terrain. + + + + + Splat texture used by the terrain. + + + + + Retrieves the terrain layers used by the current terrain. + + + + + The thickness of the terrain used for collision detection. + + + + + Returns the number of tree instances. + + + + + Contains the current trees placed in the terrain. + + + + + The list of tree prototypes this are the ones available in the inspector. + + + + + Amount of waving grass in the terrain. + + + + + Speed of the waving grass. + + + + + Strength of the waving grass in the terrain. + + + + + Color of the waving grass that the terrain has. + + + + + Returns the alpha map at a position x, y given a width and height. + + The x offset to read from. + The y offset to read from. + The width of the alpha map area to read. + The height of the alpha map area to read. + + A 3D array of floats, where the 3rd dimension represents the mixing weight of each splatmap at each x,y coordinate. + + + + + Returns the alphamap texture at the specified index. + + Index of the alphamap. + + Alphamap texture at the specified index. + + + + + Returns a 2D array of the detail object density in the specific location. + + + + + + + + + + Gets the height at a certain point x,y. + + + + + + + Get an array of heightmap samples. + + First x index of heightmap samples to retrieve. + First y index of heightmap samples to retrieve. + Number of samples to retrieve along the heightmap's x axis. + Number of samples to retrieve along the heightmap's y axis. + + + + Gets an interpolated height at a point x,y. + + + + + + + Get an interpolated normal at a given location. + + + + + + + Returns an array of tesselation maximum height error values per renderable terrain patch. The returned array can be modified and passed to OverrideMaximumHeightError. + + + Float array of maximum height error values. + + + + + Returns an array of min max height values for all the renderable patches in a terrain. The returned array can be modified and then passed to OverrideMinMaxPatchHeights. + + + Minimum and maximum height values for each patch. + + + + + Gets the gradient of the terrain at point (x,y). + + + + + + + Returns an array of all supported detail layer indices in the area. + + + + + + + + + Get the tree instance at the specified index. It is used as a faster version of treeInstances[index] as this function doesn't create the entire tree instances array. + + The index of the tree instance. + + + + Override the maximum tessellation height error with user provided values. Note that the overriden values get reset when the terrain resolution is changed and stays unchanged when the terrain heightmap is painted or changed via script. + + Provided maximum height error values. + + + + Override the minimum and maximum patch heights for every renderable terrain patch. Note that the overriden values get reset when the terrain resolution is changed and stays unchanged when the terrain heightmap is painted or changed via script. + + Array of minimum and maximum terrain patch height values. + + + + Reloads all the values of the available prototypes (ie, detail mesh assets) in the TerrainData Object. + + + + + Assign all splat values in the given map area. + + + + + + + + Marks the terrain data as dirty to trigger an update of the terrain basemap texture. + + + + + Sets the detail layer density map. + + + + + + + + + Set the resolution of the detail map. + + Specifies the number of pixels in the detail resolution map. A larger detailResolution, leads to more accurate detail object painting. + Specifies the size in pixels of each individually rendered detail patch. A larger number reduces draw calls, but might increase triangle count since detail patches are culled on a per batch basis. A recommended value is 16. If you use a very large detail object distance and your grass is very sparse, it makes sense to increase the value. + + + + Set an array of heightmap samples. + + First x index of heightmap samples to set. + First y index of heightmap samples to set. + Array of heightmap samples to set (values range from 0 to 1, array indexed as [y,x]). + + + + Set an array of heightmap samples. + + First x index of heightmap samples to set. + First y index of heightmap samples to set. + Array of heightmap samples to set (values range from 0 to 1, array indexed as [y,x]). + + + + Set the tree instance with new parameters at the specified index. However, TreeInstance.prototypeIndex and TreeInstance.position can not be changed otherwise an ArgumentException will be thrown. + + The index of the tree instance. + The new TreeInstance value. + + + + Triggers an update to integrate modifications done to the heightmap outside of unity. + + Start X position of the dirty heightmap region. + Start Y position of the dirty heightmap region. + Width of the the dirty heightmap region. + Width of the the dirty heightmap region. + + + + Extension methods to the Terrain class, used only for the UpdateGIMaterials method used by the Global Illumination System. + + + + + Schedules an update of the albedo and emissive Textures of a system that contains the Terrain. + + + + + + + + + + Schedules an update of the albedo and emissive Textures of a system that contains the Terrain. + + + + + + + + + + Description of a terrain layer. + + + + + A Vector4 value specifying the maximum RGBA value that the diffuse texture maps to when the value of the channel is 1. + + + + + A Vector4 value specifying the minimum RGBA value that the diffuse texture maps to when the value of the channel is 0. + + + + + The diffuse texture used by the terrain layer. + + + + + A Vector4 value specifying the maximum RGBA value that the mask map texture maps to when the value of the channel is 1. + + + + + A Vector4 value specifying the minimum RGBA value that the mask map texture maps to when the value of the channel is 0. + + + + + The mask map texture used by the terrain layer. + + + + + Metallic factor used by the terrain layer. + + + + + Normal map texture used by the terrain layer. + + + + + A float value that scales the normal vector. The minimum value is 0, the maximum value is 1. + + + + + Smoothness of the specular reflection. + + + + + Specular color. + + + + + UV tiling offset. + + + + + UV Tiling size. + + + + + Enum provding terrain rendering options. + + + + + Render all options. + + + + + Render terrain details. + + + + + Render heightmap. + + + + + Render trees. + + + + + Error states used by the TerrainMap. + + + + + Indicates that the adjacent terrain tiles are not aligned edge to edge. + + + + + No error detected. + + + + + Indicates that there are two terrain tiles occupying one grid cell in the TerrainMap. + + + + + Indicates that the adjacent terrain tiles have different sizes. + + + + + Terrain map filter. + + Terrain object to apply filter to. + + + + Specifies a set of 2D tile coordinates. + + + + + Tile X coordinate. + + + + + Tile Z coordinate. + + + + + How multiline text should be aligned. + + + + + Text lines are centered. + + + + + Text lines are aligned on the left side. + + + + + Text lines are aligned on the right side. + + + + + Where the anchor of the text is placed. + + + + + Text is anchored in lower side, centered horizontally. + + + + + Text is anchored in lower left corner. + + + + + Text is anchored in lower right corner. + + + + + Text is centered both horizontally and vertically. + + + + + Text is anchored in left side, centered vertically. + + + + + Text is anchored in right side, centered vertically. + + + + + Text is anchored in upper side, centered horizontally. + + + + + Text is anchored in upper left corner. + + + + + Text is anchored in upper right corner. + + + + + Attribute to make a string be edited with a height-flexible and scrollable text area. + + + + + The maximum amount of lines the text area can show before it starts using a scrollbar. + + + + + The minimum amount of lines the text area will use. + + + + + Attribute to make a string be edited with a height-flexible and scrollable text area. + + The minimum amount of lines the text area will use. + The maximum amount of lines the text area can show before it starts using a scrollbar. + + + + Attribute to make a string be edited with a height-flexible and scrollable text area. + + The minimum amount of lines the text area will use. + The maximum amount of lines the text area can show before it starts using a scrollbar. + + + + Text file assets. + + + + + The raw bytes of the text asset. (Read Only) + + + + + The text contents of the .txt file as a string. (Read Only) + + + + + Create a new TextAsset with the specified text contents. + +This constructor creates a TextAsset, which is not the same as a plain text file. When saved to disk using the AssetDatabase class, the TextAsset should be saved with the .asset extension. + + The text contents for the TextAsset. + + + + Returns the contents of the TextAsset. + + + + + Different methods for how the GUI system handles text being too large to fit the rectangle allocated. + + + + + Text gets clipped to be inside the element. + + + + + Text flows freely outside the element. + + + + + A structure that contains information about a given typeface and for a specific point size. + + + + + The Ascent line is typically located at the top of the tallest glyph in the typeface. + + + + + The Baseline is an imaginary line upon which all glyphs appear to rest on. + + + + + The Cap line is typically located at the top of capital letters. + + + + + The Descent line is typically located at the bottom of the glyph with the lowest descender in the typeface. + + + + + The name of the font typeface also known as family name. + + + + + The line height represents the distance between consecutive lines of text. + + + + + The Mean line is typically located at the top of lowercase letters. + + + + + The point size used for sampling the typeface. + + + + + The relative scale of the typeface. + + + + + The position of the strikethrough. + + + + + The thickness of the strikethrough. + + + + + The style name of the typeface which defines both the visual style and weight of the typeface. + + + + + The position of characters using subscript. + + + + + The relative size / scale of subscript characters. + + + + + The position of characters using superscript. + + + + + The relative size / scale of superscript characters. + + + + + The width of the tab character. + + + + + The position of the underline. + + + + + The thickness of the underline. + + + + + Compares the information in this FaceInfo structure with the information in the given FaceInfo structure to determine whether they have the same values. + + The FaceInfo structure to compare this FaceInfo structure with. + + Returns true if the FaceInfo structures have the same values. False if not. + + + + + A Glyph is the visual representation of a text element or character. + + + + + The index of the atlas texture that contains this glyph. + + + + + A rectangle that defines the position of a glyph within an atlas texture. + + + + + The index of the glyph in the source font file. + + + + + The metrics that define the size, position and spacing of a glyph when performing text layout. + + + + + The relative scale of the glyph. The default value is 1.0. + + + + + Compares two glyphs to determine if they have the same values. + + The glyph to compare with. + + Returns true if the glyphs have the same values. False if not. + + + + + Constructor for a new glyph. + + Glyph used as a reference for the new glyph. + The index of the glyph in the font file. + The metrics of the glyph. + The GlyphRect defining the position of the glyph in the atlas texture. + The relative scale of the glyph. + The index of the atlas texture that contains the glyph. + + + + Constructor for a new glyph. + + Glyph used as a reference for the new glyph. + The index of the glyph in the font file. + The metrics of the glyph. + The GlyphRect defining the position of the glyph in the atlas texture. + The relative scale of the glyph. + The index of the atlas texture that contains the glyph. + + + + Constructor for a new glyph. + + Glyph used as a reference for the new glyph. + The index of the glyph in the font file. + The metrics of the glyph. + The GlyphRect defining the position of the glyph in the atlas texture. + The relative scale of the glyph. + The index of the atlas texture that contains the glyph. + + + + Constructor for a new glyph. + + Glyph used as a reference for the new glyph. + The index of the glyph in the font file. + The metrics of the glyph. + The GlyphRect defining the position of the glyph in the atlas texture. + The relative scale of the glyph. + The index of the atlas texture that contains the glyph. + + + + A set of values that define the size, position and spacing of a glyph when performing text layout. + + + + + The height of the glyph. + + + + + The horizontal distance to increase (left to right) or decrease (right to left) the drawing position relative to the origin of the text element. + + + + + The horizontal distance from the current drawing position (origin) relative to the element's left bounding box edge (bbox). + + + + + The vertical distance from the current baseline relative to the element's top bounding box edge (bbox). + + + + + The width of the glyph. + + + + + Constructs a new GlyphMetrics structure. + + The width of the glyph. + The height of the glyph. + The horizontal bearingX. + The horizontal bearingY. + The horizontal advance. + + + + A rectangle that defines the position of a glyph within an atlas texture. + + + + + The height of the glyph. + + + + + The width of the glyph. + + + + + The x position of the glyph in the font atlas texture. + + + + + The y position of the glyph in the font atlas texture. + + + + + A GlyphRect with all values set to zero. Shorthand for writing GlyphRect(0, 0, 0, 0). + + + + + Constructor for a new GlyphRect. + + The x position of the glyph in the atlas texture. + The y position of the glyph in the atlas texture. + The width of the glyph. + The height of the glyph. + The Rect used to construct the new GlyphRect. + + + + Constructor for a new GlyphRect. + + The x position of the glyph in the atlas texture. + The y position of the glyph in the atlas texture. + The width of the glyph. + The height of the glyph. + The Rect used to construct the new GlyphRect. + + + + The FontEngine is used to access data from source font files. This includes information about individual characters, glyphs and relevant metrics typically used in the process of text parsing, layout and rendering. + +The types of font files supported are TrueType (.ttf, .ttc) and OpenType (.otf). + +The FontEngine is also used to raster the visual representation of characters known as glyphs in a given font atlas texture. + + + + + Destroy and unload resources used by the Font Engine. + + + A value of zero (0) if the Font Engine and used resources were successfully released. + + + + + Get the FaceInfo for the currently loaded and sized typeface. + + + Returns the FaceInfo of the currently loaded typeface. + + + + + Initialize the Font Engine and required resources. + + + A value of zero (0) if the initialization of the Font Engine was successful. + + + + + Load a source font file. + + The path of the source font file relative to the project. + The point size used to scale the font face. + An array that contains the font file. + The font to load the data from. The Unity font must be set to Dynamic mode with Include Font Data selected. + + A value of zero (0) if the font face was loaded successfully. + + + + + Load a source font file. + + The path of the source font file relative to the project. + The point size used to scale the font face. + An array that contains the font file. + The font to load the data from. The Unity font must be set to Dynamic mode with Include Font Data selected. + + A value of zero (0) if the font face was loaded successfully. + + + + + Load a source font file. + + The path of the source font file relative to the project. + The point size used to scale the font face. + An array that contains the font file. + The font to load the data from. The Unity font must be set to Dynamic mode with Include Font Data selected. + + A value of zero (0) if the font face was loaded successfully. + + + + + Load a source font file. + + The path of the source font file relative to the project. + The point size used to scale the font face. + An array that contains the font file. + The font to load the data from. The Unity font must be set to Dynamic mode with Include Font Data selected. + + A value of zero (0) if the font face was loaded successfully. + + + + + Load a source font file. + + The path of the source font file relative to the project. + The point size used to scale the font face. + An array that contains the font file. + The font to load the data from. The Unity font must be set to Dynamic mode with Include Font Data selected. + + A value of zero (0) if the font face was loaded successfully. + + + + + Load a source font file. + + The path of the source font file relative to the project. + The point size used to scale the font face. + An array that contains the font file. + The font to load the data from. The Unity font must be set to Dynamic mode with Include Font Data selected. + + A value of zero (0) if the font face was loaded successfully. + + + + + Set the size of the currently loaded font face. + + The point size used to scale the font face. + + A value of zero (0) if the font face was successfully scaled to the given point size. + + + + + Try to get the glyph index for the character at the given Unicode value. + + The unicode value of the character for which to lookup the glyph index. + The index of the glyph for the given unicode character or the .notdef glyph (index 0) if no glyph is available for the given Unicode value. + + Returns true if the given unicode has a glyph index. + + + + + Try loading the glyph for the given index value and if available populate the glyph. + + The index of the glyph that should be loaded. + The glyph loading flag that should be used to load the glyph. + The glyph using the provided index or the .notdef glyph (index 0) if no glyph was found at that index. + + Returns true if a glyph exists at the given index. Otherwise returns false. + + + + + Try loading a glyph for the given unicode value. If available, populates the glyph and returns true. Otherwise returns false and populates the glyph with the .notdef / missing glyph data. + + The glyph loading flag that should be used to load the glyph. + The glyph using the provided index or the .notdef glyph (index 0) if no glyph was found at that index. + The Unicode value of the character whose glyph should be loaded. + + Returns true if a glyph exists for the given unicode value. Otherwise returns false. + + + + + Error code returned by the various FontEngine functions. + + + + + Error code returned when the FontEngine glyph packing or rendering process has been cancelled. + + + + + Error code returned by the LoadGlyph function when referencing an invalid Unicode character value. + + + + + Error code indicating an invalid font face. + + + + + Error code indicating an invalid font file. + + + + + Error code returned by the LoadFontFace function when the source font file is of an unknown or invalid format. + + + + + Error code returned by the LoadFontFace function when the file path to the source font file appears invalid. + + + + + Error code returned by the LoadFontFace function when the source font file appears invalid or improperly formatted. + + + + + Error code returned by the LoadGlyph function when referencing an invalid or out of range glyph index value. + + + + + Error code indicating failure to initialize the font engine library. + + + + + Error code indicating failure to initialize the font engine library and / or successfully load a font face. + + + + + Error code returned by the LoadGlyph or SetFaceSize functions using an invalid pointSize value. + + + + + Error code indicating failure to load one of the tables of the font file. + + + + + Error code returned when the function was successfully executed. + + + + + The various options (flags) used by the FontEngine when loading glyphs from a font face. + + + + + Load glyph metrics without allocating and loading the bitmap data. + + + + + Load glyph metrics without using the 'hdmx' table. This flag is mostly used to validate font data. + + + + + Load glyph metrics and bitmap representation if available for the current face size. + + + + + Load glyphs using the auto hinter instead of the font's native hinter. + + + + + Load glyph metrics and render outline using 1-bit monochrome. + + + + + Load glyphs using the font's native hinter. + + + + + Load glyphs and ignore embedded bitmap strikes. + + + + + Load glyphs without hinting. + + + + + Load glyphs at default font units without scaling. This flag implies LOAD_NO_HINTING and LOAD_NO_BITMAP and unsets LOAD_RENDER. + + + + + Load glyph metrics and render outline using 8-bit or antialiased image of the glyph. + + + + + The modes available when packing glyphs into an atlas texture. + + + + + Place the glyph into the smallest free space available in which it can fit. + + + + + Place the glyph against the longer side of a free space to minimize the length of the longer leftover side. + + + + + Place the glyph against the short side of a free space to minimize the length of the shorter leftover side. + + + + + Place the glyph into available free space in a Tetris like fashion. + + + + + Place the glyph into the available free space by trying to maximize the contact point between it and other glyphs. + + + + + The rendering modes used by the Font Engine to render glyphs. + + + + + Renders a bitmap representation of the glyph from a binary (1-bit monochrome) image of the glyph outline with no hinting. + + + + + Renders a bitmap representation of the glyph from a binary (1-bit monochrome) image of the glyph outline with hinting. + + + + + Renders a signed distance field (SDF) representation of the glyph from a binary (1-bit monochrome) image of the glyph outline with no hinting. + + + + + Renders a signed distance field (SDF) representation of the glyph from a binary (1-bit monochrome) image of the glyph outline with no hinting. + + + + + Renders a signed distance field (SDF) representation of the glyph from a binary (1-bit monochrome) image of the glyph outline with no hinting. + + + + + Renders a signed distance field (SDF) representation of the glyph from a binary (1-bit monochrome) image of the glyph outline with no hinting. + + + + + Renders a signed distance field (SDF) representation of the glyph from an 8-bit or antialiased image of the glyph outline with no hinting. + + + + + Renders a signed distance field (SDF) representation of the glyph from an 8-bit or antialiased image of the glyph outline with hinting. + + + + + Renders a bitmap representation of the glyph from an 8-bit or antialiased image of the glyph outline with no hinting. + + + + + Renders a bitmap representation of the glyph from an 8-bit or antialiased image of the glyph outline with hinting. + + + + + A struct that stores the settings for TextGeneration. + + + + + Use the extents of glyph geometry to perform horizontal alignment rather than glyph metrics. + + + + + The base color for the text generation. + + + + + Font to use for generation. + + + + + Font size. + + + + + Font style. + + + + + Continue to generate characters even if the text runs out of bounds. + + + + + Extents that the generator will attempt to fit the text in. + + + + + What happens to text when it reaches the horizontal generation bounds. + + + + + The line spacing multiplier. + + + + + Generated vertices are offset by the pivot. + + + + + Should the text be resized to fit the configured bounds? + + + + + Maximum size for resized text. + + + + + Minimum size for resized text. + + + + + Allow rich text markup in generation. + + + + + A scale factor for the text. This is useful if the Text is on a Canvas and the canvas is scaled. + + + + + How is the generated text anchored. + + + + + Should the text generator update the bounds from the generated text. + + + + + What happens to text when it reaches the bottom generation bounds. + + + + + Class that can be used to generate text for rendering. + + + + + The number of characters that have been generated. + + + + + The number of characters that have been generated and are included in the visible lines. + + + + + Array of generated characters. + + + + + The size of the font that was found if using best fit mode. + + + + + Number of text lines generated. + + + + + Information about each generated text line. + + + + + Extents of the generated text in rect format. + + + + + Number of vertices generated. + + + + + Array of generated vertices. + + + + + Create a TextGenerator. + + + + + + Create a TextGenerator. + + + + + + Populate the given List with UICharInfo. + + List to populate. + + + + Returns the current UICharInfo. + + + Character information. + + + + + Populate the given list with UILineInfo. + + List to populate. + + + + Returns the current UILineInfo. + + + Line information. + + + + + Given a string and settings, returns the preferred height for a container that would hold this text. + + Generation text. + Settings for generation. + + Preferred height. + + + + + Given a string and settings, returns the preferred width for a container that would hold this text. + + Generation text. + Settings for generation. + + Preferred width. + + + + + Populate the given list with generated Vertices. + + List to populate. + + + + Returns the current UIVertex array. + + + Vertices. + + + + + Mark the text generator as invalid. This will force a full text generation the next time Populate is called. + + + + + Will generate the vertices and other data for the given string with the given settings. + + String to generate. + Settings. + + + + Will generate the vertices and other data for the given string with the given settings. + + String to generate. + Generation settings. + The object used as context of the error log message, if necessary. + + True if the generation is a success, false otherwise. + + + + + A script interface for the. + + + + + How lines of text are aligned (Left, Right, Center). + + + + + Which point of the text shares the position of the Transform. + + + + + The size of each character (This scales the whole text). + + + + + The color used to render the text. + + + + + The Font used. + + + + + The font size to use (for dynamic fonts). + + + + + The font style to use (for dynamic fonts). + + + + + How much space will be in-between lines of text. + + + + + How far should the text be offset from the transform.position.z when drawing. + + + + + Enable HTML-style tags for Text Formatting Markup. + + + + + How much space will be inserted for a tab '\t' character. This is a multiplum of the 'spacebar' character offset. + + + + + The text that is displayed. + + + + + Base class for texture handling. Contains functionality that is common to both Texture2D and RenderTexture classes. + + + + + Anisotropic filtering level of the texture. + + + + + The amount of memory currently being used by textures. + + + + + This amount of texture memory would be used before the texture streaming budget is applied. + + + + + Dimensionality (type) of the texture (Read Only). + + + + + Filtering mode of the texture. + + + + + Height of the texture in pixels. (Read Only) + + + + + The hash value of the Texture. + + + + + Returns true if the Read/Write Enabled checkbox was checked when the texture was imported; otherwise returns false. For a dynamic Texture created from script, always returns true. For additional information, see TextureImporter.isReadable. + + + + + Mip map bias of the texture. + + + + + Number of non-streaming textures. + + + + + Total amount of memory being used by non-streaming textures. + + + + + How many times has a texture been uploaded due to texture mipmap streaming. + + + + + Number of renderers registered with the texture streaming system. + + + + + Number of streaming textures. + + + + + Force the streaming texture system to discard all unused mipmaps immediately, rather than caching them until the texture memory budget is exceeded. + + + + + Force streaming textures to load all mipmap levels. + + + + + Number of streaming textures with mipmaps currently loading. + + + + + Number of streaming textures with outstanding mipmaps to be loaded. + + + + + The amount of memory used by textures after the mipmap streaming and budget are applied and loading is complete. + + + + + The total amount of memory that would be used by all textures at mipmap level 0. + + + + + This counter is incremented when the texture is updated. + + + + + Width of the texture in pixels. (Read Only) + + + + + Texture coordinate wrapping mode. + + + + + Texture U coordinate wrapping mode. + + + + + Texture V coordinate wrapping mode. + + + + + Texture W coordinate wrapping mode for Texture3D. + + + + + Retrieve a native (underlying graphics API) pointer to the texture resource. + + + Pointer to an underlying graphics API texture resource. + + + + + Increment the update counter. + + + + + Sets Anisotropic limits. + + + + + + + Uploads additional debug information to materials using textures set to stream mip maps. + + + + + Class for texture handling. + + + + + Indicates whether this texture was imported with TextureImporter.alphaIsTransparency enabled. This setting is available only in the Editor scripts. Note that changing this setting will have no effect; it must be enabled in TextureImporter instead. + + + + + Get a small texture with all black pixels. + + + + + The mipmap level which would have been loaded by the streaming system before memory budgets are applied. + + + + + The format of the pixel data in the texture (Read Only). + + + + + Returns true if the Read/Write Enabled checkbox was checked when the texture was imported; otherwise returns false. For a dynamic Texture created from script, always returns true. For additional information, see TextureImporter.isReadable. + + + + + Which mipmap level is currently loaded by the streaming system. + + + + + Which mipmap level is in the process of being loaded by the mipmap streaming system. + + + + + How many mipmap levels are in this texture (Read Only). + + + + + The mipmap level to load. + + + + + Has mipmap streaming been enabled for this texture. + + + + + Relative priority for this texture when reducing memory size in order to hit the memory budget. + + + + + Get a small texture with all white pixels. + + + + + Actually apply all previous SetPixel and SetPixels changes. + + When set to true, mipmap levels are recalculated. + When set to true, system memory copy of a texture is released. + + + + Resets the requestedMipmapLevel field. + + + + + Compress texture into DXT format. + + + + + + Creates Unity Texture out of externally created native texture object. + + Native 2D texture object. + Width of texture in pixels. + Height of texture in pixels. + Format of underlying texture object. + Does the texture have mipmaps? + Is texture using linear color space? + + + + + Create a new empty texture. + + + + + + + Create a new empty texture. + + + + + + + + + Create a new empty texture. + + + + + + + + + + Flags used to control the encoding to an EXR file. + + + + + This texture will use Wavelet compression. This is best used for grainy images. + + + + + The texture will use RLE (Run Length Encoding) EXR compression format (similar to Targa RLE compression). + + + + + The texture will use the EXR ZIP compression format. + + + + + No flag. This will result in an uncompressed 16-bit float EXR file. + + + + + The texture will be exported as a 32-bit float EXR file (default is 16-bit). + + + + + Packs a set of rectangles into a square atlas, with optional padding between rectangles. + + An array of rectangle dimensions. + Amount of padding to insert between adjacent rectangles in the atlas. + The size of the atlas. + + If the function succeeds, this will contain the packed rectangles. Otherwise, the return value is null. + + + + + Returns pixel color at coordinates (x, y). + + + + + + + Returns filtered pixel color at normalized coordinates (u, v). + + + + + + + Get the pixel colors from the texture. + + The mipmap level to fetch the pixels from. Defaults to zero. + + The array of all pixels in the mipmap level of the texture. + + + + + Get a block of pixel colors. + + The x position of the pixel array to fetch. + The y position of the pixel array to fetch. + The width length of the pixel array to fetch. + The height length of the pixel array to fetch. + The mipmap level to fetch the pixels. Defaults to zero, and is + optional. + + The array of pixels in the texture that have been selected. + + + + + Get a block of pixel colors in Color32 format. + + + + + + Get raw data from a texture for reading or writing. + + + Raw texture data view. + + + + + Get raw data from a texture. + + + Raw texture data as a byte array. + + + + + Has the mipmap level requested by setting requestedMipmapLevel finished loading? + + + True if the mipmap level requested by setting requestedMipmapLevel has finished loading. + + + + + Fills texture pixels with raw preformatted data. + + Raw data array to initialize texture pixels with. + Size of data in bytes. + + + + Fills texture pixels with raw preformatted data. + + Raw data array to initialize texture pixels with. + Size of data in bytes. + + + + Fills texture pixels with raw preformatted data. + + Raw data array to initialize texture pixels with. + Size of data in bytes. + + + + Packs multiple Textures into a texture atlas. + + Array of textures to pack into the atlas. + Padding in pixels between the packed textures. + Maximum size of the resulting texture. + Should the texture be marked as no longer readable? + + An array of rectangles containing the UV coordinates in the atlas for each input texture, or null if packing fails. + + + + + Read pixels from screen into the saved texture data. + + Rectangular region of the view to read from. Pixels are read from current render target. + Horizontal pixel position in the texture to place the pixels that are read. + Vertical pixel position in the texture to place the pixels that are read. + Should the texture's mipmaps be recalculated after reading? + + + + Resizes the texture. + + + + + + + + + Resizes the texture. + + + + + + + Sets pixel color at coordinates (x,y). + + + + + + + + Set a block of pixel colors. + + The array of pixel colours to assign (a 2D image flattened to a 1D array). + The mip level of the texture to write to. + + + + Set a block of pixel colors. + + + + + + + + + + + Set a block of pixel colors. + + + + + + + Set a block of pixel colors. + + + + + + + + + + + Updates Unity texture to use different native texture object. + + Native 2D texture object. + + + + Class for handling 2D texture arrays. + + + + + Number of elements in a texture array (Read Only). + + + + + Texture format (Read Only). + + + + + Returns true if this texture array is Read/Write Enabled; otherwise returns false. For dynamic textures created from script, always returns true. + + + + + Actually apply all previous SetPixels changes. + + When set to true, mipmap levels are recalculated. + When set to true, system memory copy of a texture is released. + + + + Create a new texture array. + + Width of texture array in pixels. + Height of texture array in pixels. + Number of elements in the texture array. + Format of the texture. + Should mipmaps be created? + Does the texture contain non-color data (i.e. don't do any color space conversions when sampling)? Default is false. + + + + + + Create a new texture array. + + Width of texture array in pixels. + Height of texture array in pixels. + Number of elements in the texture array. + Format of the texture. + Should mipmaps be created? + Does the texture contain non-color data (i.e. don't do any color space conversions when sampling)? Default is false. + + + + + + Returns pixel colors of a single array slice. + + Array slice to read pixels from. + Mipmap level to read pixels from. + + Array of pixel colors. + + + + + Returns pixel colors of a single array slice. + + Array slice to read pixels from. + Mipmap level to read pixels from. + + Array of pixel colors in low precision (8 bits/channel) format. + + + + + Set pixel colors for the whole mip level. + + An array of pixel colors. + The texture array element index. + The mip level. + + + + Set pixel colors for the whole mip level. + + An array of pixel colors. + The texture array element index. + The mip level. + + + + Class for handling 3D Textures, Use this to create. + + + + + The depth of the texture (Read Only). + + + + + The format of the pixel data in the texture (Read Only). + + + + + Returns true if this 3D texture is Read/Write Enabled; otherwise returns false. For dynamic textures created from script, always returns true. + + + + + Actually apply all previous SetPixels changes. + + When set to true, mipmap levels are recalculated. + When set to true, system memory copy of a texture is released. + + + + Create a new empty 3D Texture. + + Width of texture in pixels. + Height of texture in pixels. + Depth of texture in pixels. + Texture data format. + Should the texture have mipmaps? + + + + + + Returns an array of pixel colors representing one mip level of the 3D texture. + + + + + + Returns an array of pixel colors representing one mip level of the 3D texture. + + + + + + Sets pixel colors of a 3D texture. + + The colors to set the pixels to. + The mipmap level to be affected by the new colors. + + + + Sets pixel colors of a 3D texture. + + The colors to set the pixels to. + The mipmap level to be affected by the new colors. + + + + Compression Quality. + + + + + Best compression. + + + + + Fast compression. + + + + + Normal compression (default). + + + + + Format used when creating textures from scripts. + + + + + Alpha-only texture format. + + + + + Color with alpha texture format, 8-bits per channel. + + + + + A 16 bits/pixel texture format. Texture stores color with an alpha channel. + + + + + ASTC (10x10 pixel block in 128 bits) compressed RGB texture format. + + + + + ASTC (12x12 pixel block in 128 bits) compressed RGB texture format. + + + + + ASTC (4x4 pixel block in 128 bits) compressed RGB texture format. + + + + + ASTC (5x5 pixel block in 128 bits) compressed RGB texture format. + + + + + ASTC (6x6 pixel block in 128 bits) compressed RGB texture format. + + + + + ASTC (8x8 pixel block in 128 bits) compressed RGB texture format. + + + + + ASTC (10x10 pixel block in 128 bits) compressed RGBA texture format. + + + + + ASTC (12x12 pixel block in 128 bits) compressed RGBA texture format. + + + + + ASTC (4x4 pixel block in 128 bits) compressed RGBA texture format. + + + + + ASTC (5x5 pixel block in 128 bits) compressed RGBA texture format. + + + + + ASTC (6x6 pixel block in 128 bits) compressed RGBA texture format. + + + + + ASTC (8x8 pixel block in 128 bits) compressed RGBA texture format. + + + + + Compressed one channel (R) texture format. + + + + + Compressed two-channel (RG) texture format. + + + + + HDR compressed color texture format. + + + + + High quality compressed color texture format. + + + + + Color with alpha texture format, 8-bits per channel. + + + + + Compressed color texture format. + + + + + Compressed color texture format with Crunch compression for smaller storage sizes. + + + + + Compressed color with alpha channel texture format. + + + + + Compressed color with alpha channel texture format with Crunch compression for smaller storage sizes. + + + + + ETC2 EAC (GL ES 3.0) 4 bitspixel compressed unsigned single-channel texture format. + + + + + ETC2 EAC (GL ES 3.0) 4 bitspixel compressed signed single-channel texture format. + + + + + ETC2 EAC (GL ES 3.0) 8 bitspixel compressed unsigned dual-channel (RG) texture format. + + + + + ETC2 EAC (GL ES 3.0) 8 bitspixel compressed signed dual-channel (RG) texture format. + + + + + ETC (GLES2.0) 4 bits/pixel compressed RGB texture format. + + + + + ETC 4 bits/pixel compressed RGB texture format. + + + + + Compressed color texture format with Crunch compression for smaller storage sizes. + + + + + ETC 4 bitspixel RGB + 4 bitspixel Alpha compressed texture format. + + + + + ETC2 (GL ES 3.0) 4 bits/pixel compressed RGB texture format. + + + + + ETC2 (GL ES 3.0) 4 bits/pixel RGB+1-bit alpha texture format. + + + + + ETC2 (GL ES 3.0) 8 bits/pixel compressed RGBA texture format. + + + + + Compressed color with alpha channel texture format using Crunch compression for smaller storage sizes. + + + + + PowerVR (iOS) 2 bits/pixel compressed color texture format. + + + + + PowerVR (iOS) 4 bits/pixel compressed color texture format. + + + + + PowerVR (iOS) 2 bits/pixel compressed with alpha channel texture format. + + + + + PowerVR (iOS) 4 bits/pixel compressed with alpha channel texture format. + + + + + Single channel (R) texture format, 16 bit integer. + + + + + Single channel (R) texture format, 8 bit integer. + + + + + Scalar (R) texture format, 32 bit floating point. + + + + + Two color (RG) texture format, 8-bits per channel. + + + + + Color texture format, 8-bits per channel. + + + + + A 16 bit color texture format. + + + + + RGB HDR format, with 9 bit mantissa per channel and a 5 bit shared exponent. + + + + + Color with alpha texture format, 8-bits per channel. + + + + + Color and alpha texture format, 4 bit per channel. + + + + + RGB color and alpha texture format, 32-bit floats per channel. + + + + + RGB color and alpha texture format, 16 bit floating point per channel. + + + + + Two color (RG) texture format, 32 bit floating point per channel. + + + + + Two color (RG) texture format, 16 bit floating point per channel. + + + + + Scalar (R) texture format, 16 bit floating point. + + + + + A format that uses the YUV color space and is often used for video encoding or playback. + + + + + Wrap mode for textures. + + + + + Clamps the texture to the last pixel at the edge. + + + + + Tiles the texture, creating a repeating pattern by mirroring it at every integer boundary. + + + + + Mirrors the texture once, then clamps to edge pixels. + + + + + Tiles the texture, creating a repeating pattern. + + + + + Priority of a thread. + + + + + Below normal thread priority. + + + + + Highest thread priority. + + + + + Lowest thread priority. + + + + + Normal thread priority. + + + + + Class passed onto when information is queried from the tiles. + + + + + Returns the boundaries of the Tilemap in cell size. + + + + + Returns the boundaries of the Tilemap in local space size. + + + + + The origin of the Tilemap in cell position. + + + + + The size of the Tilemap in cells. + + + + + Gets the color of a. + + Position of the Tile on the Tilemap. + + Color of the at the XY coordinate. + + + + + Returns the component of type T if the GameObject of the tile map has one attached, null if it doesn't. + + + The Component of type T to retrieve. + + + + + Gets the. + + Position of the Tile on the Tilemap. + + Sprite at the XY coordinate. + + + + + Gets the. + + Position of the Tile on the Tilemap. + + placed at the cell. + + + + + Gets the. + + Position of the Tile on the Tilemap. + + placed at the cell. + + + + + Gets the TileFlags of the Tile at the given position. + + Position of the Tile on the Tilemap. + + TileFlags from the Tile. + + + + + Gets the transform matrix of a. + + Position of the Tile on the Tilemap. + + The transform matrix. + + + + + Refreshes a. + + Position of the Tile on the Tilemap. + + + + Class for a default tile in the Tilemap. + + + + + Color of the Tile. + + + + + TileFlags of the Tile. + + + + + GameObject of the Tile. + + + + + Sprite to be rendered at the Tile. + + + + + Matrix4x4|Transform matrix of the Tile. + + + + + Enum for determining what collider shape is generated for this Tile by the TilemapCollider2D. + + + + + The grid layout boundary outline is used as the collider shape for the Tile by the TilemapCollider2D. + + + + + No collider shape is generated for the Tile by the TilemapCollider2D. + + + + + The Sprite outline is used as the collider shape for the Tile by the TilemapCollider2D. + + + + + Retrieves the tile rendering data for the Tile. + + Position of the Tile on the Tilemap. + The Tilemap the tile is present on. + Data to render the tile. This is filled with Tile, Tile.color and Tile.transform. + + Whether the call was successful. This returns true for Tile. + + + + + A Struct for the required data for animating a Tile. + + + + + The array of that are ordered by appearance in the animation. + + + + + The animation speed. + + + + + The start time of the animation. The animation will begin at this time offset. + + + + + Base class for a tile in the Tilemap. + + + + + Retrieves any tile animation data from the scripted tile. + + Position of the Tile on the Tilemap. + The Tilemap the tile is present on. + Data to run an animation on the tile. + + Whether the call was successful. + + + + + Retrieves any tile rendering data from the scripted tile. + + Position of the Tile on the Tilemap. + The Tilemap the tile is present on. + Data to render the tile. + + Whether the call was successful. + + + + + This method is called when the tile is refreshed. + + Position of the Tile on the Tilemap. + The Tilemap the tile is present on. + + + + StartUp is called on the first frame of the running Scene. + + Position of the Tile on the Tilemap. + The Tilemap the tile is present on. + The GameObject instantiated for the Tile. + + Whether the call was successful. + + + + + A Struct for the required data for rendering a Tile. + + + + + Color of the Tile. + + + + + TileFlags of the Tile. + + + + + GameObject of the Tile. + + + + + Sprite to be rendered at the Tile. + + + + + Matrix4x4|Transform matrix of the Tile. + + + + + Flags controlling behavior for the TileBase. + + + + + TileBase does not instantiate its associated GameObject in editor mode and instantiates it only during play mode. + + + + + All lock flags. + + + + + TileBase locks any color set by brushes or the user. + + + + + TileBase locks any transform matrix set by brushes or the user. + + + + + No TileFlags are set. + + + + + The tile map stores component. + + + + + The frame rate for all tile animations in the tile map. + + + + + Returns the boundaries of the Tilemap in cell size. + + + + + The color of the tile map layer. + + + + + The origin of the Tilemap in cell position inclusive of editor preview tiles. + + + + + The size of the Tilemap in cells inclusive of editor preview tiles. + + + + + Gets the Grid associated with this tile map. + + + + + Gets the Grid associated with this tile map. + + + + + Returns the boundaries of the Tilemap in local space size. + + + + + Orientation of the tiles in the Tilemap. + + + + + Orientation Matrix of the orientation of the tiles in the Tilemap. + + + + + The origin of the Tilemap in cell position. + + + + + The size of the Tilemap in cells. + + + + + Gets the anchor point of tiles in the Tilemap. + + + + + Adds the TileFlags onto the Tile at the given position. + + Position of the Tile on the Tilemap. + TileFlags to add (with bitwise or) onto the flags provided by Tile.TileBase. + + + + Does a box fill with the given. Starts from given coordinates and fills the limits from start to end (inclusive). + + Position of the Tile on the Tilemap. + to place. + The minimum X coordinate limit to fill to. + The minimum Y coordinate limit to fill to. + The maximum X coordinate limit to fill to. + The maximum Y coordinate limit to fill to. + + + + Clears all editor preview tiles that are placed in the Tilemap. + + + + + Clears all tiles that are placed in the Tilemap. + + + + + Compresses the origin and size of the Tilemap to bounds where tiles exist. + + + + + Returns true if the Tilemap contains the given. Returns false if not. + + Tile to check. + + Whether the Tilemap contains the tile. + + + + + Does an editor preview of a box fill with the given. Starts from given coordinates and fills the limits from start to end (inclusive). + + Position of the Tile on the Tilemap. + to place. + The start X coordinate limit to fill to. + The start Y coordinate limit to fill to. + The ending X coordinate limit to fill to. + The ending Y coordinate limit to fill to. + + + + Does an editor preview of a flood fill with the given starting from the given coordinates. + + Start position of the flood fill on the Tilemap. + TileBase to place. + + + + Does a flood fill with the given starting from the given coordinates. + + Start position of the flood fill on the Tilemap. + to place. + + + + Get the logical center coordinate of a grid cell in local space. + + Grid cell position. + + Center of the cell transformed into local space coordinates. + + + + + Get the logical center coordinate of a grid cell in world space. + + Grid cell position. + + Center of the cell transformed into world space coordinates. + + + + + Gets the collider type of a. + + Position of the Tile on the Tilemap. + + Collider type of the at the XY coordinate. + + + + + Gets the color of a. + + Position of the Tile on the Tilemap. + + Color of the at the XY coordinate. + + + + + Gets the Color of an editor preview. + + Position of the Tile on the Tilemap. + + Color of the editor preview at the XY coordinate. + + + + + Gets the. + + Position of the editor preview Tile on the Tilemap. + + Sprite at the XY coordinate. + + + + + Gets the editor preview. + + Position of the editor preview Tile on the Tilemap. + + The editor preview placed at the cell. + + + + + Gets the editor preview. + + Position of the editor preview Tile on the Tilemap. + + The editor preview placed at the cell. + + + + + Gets the TileFlags of the editor preview Tile at the given position. + + Position of the Tile on the Tilemap. + + TileFlags from the editor preview Tile. + + + + + Gets the transform matrix of an editor preview. + + Position of the editor preview Tile on the Tilemap. + + The transform matrix. + + + + + Gets the. + + Position of the Tile on the Tilemap. + + GameObject instantiated by the Tile at the position. + + + + + Gets the. + + Position of the Tile on the Tilemap. + + Sprite at the XY coordinate. + + + + + Gets the. + + Position of the Tile on the Tilemap. + + Tilemaps.TileBase placed at the cell. + + + + + Gets the. + + Position of the Tile on the Tilemap. + + Tilemaps.TileBase|Tile of type T placed at the cell. + + + + + Gets the TileFlags of the Tile at the given position. + + Position of the Tile on the Tilemap. + + TileFlags from the Tile. + + + + + Retrieves an array of tiles with the given bounds. + + Bounds to retrieve from. + + An array of at the given bounds. + + + + + Gets the transform matrix of a. + + Position of the Tile on the Tilemap. + + The transform matrix. + + + + + Get the total number of different. + + + The total number of different. + + + + + Fills the given array with the total number of different and returns the number of tiles filled. + + The array to be filled. + + The number of tiles filled. + + + + + Returns whether there is an editor preview tile at the position. + + Position to check. + + True if there is an editor preview tile at the position. False if not. + + + + + Returns whether there is a tile at the position. + + Position to check. + + True if there is a tile at the position. False if not. + + + + + Determines the orientation of. + + + + + Use a custom orientation to all tiles in the tile map. + + + + + Orients tiles in the XY plane. + + + + + Orients tiles in the XZ plane. + + + + + Orients tiles in the YX plane. + + + + + Orients tiles in the YZ plane. + + + + + Orients tiles in the ZX plane. + + + + + Orients tiles in the ZY plane. + + + + + Refreshes all. The tile map will retrieve the rendering data, animation data and other data for all tiles and update all relevant components. + + + + + Refreshes a. + + Position of the Tile on the Tilemap. + + + + Removes the TileFlags onto the Tile at the given position. + + Position of the Tile on the Tilemap. + TileFlags to remove from the Tile. + + + + Resizes tiles in the Tilemap to bounds defined by origin and size. + + + + + Sets the collider type of a. + + Position of the Tile on the Tilemap. + Collider type to set the to at the XYZ coordinate. + + + + Sets the color of a. + + Position of the Tile on the Tilemap. + Color to set the to at the XY coordinate. + + + + Sets the color of an editor preview. + + Position of the editor preview Tile on the Tilemap. + Color to set the editor preview to at the XY coordinate. + + + + Sets an editor preview. + + Position of the editor preview Tile on the Tilemap. + The editor preview to be placed the cell. + + + + Sets the transform matrix of an editor preview tile given the XYZ coordinates of a cell in the. + + Position of the editor preview Tile on the Tilemap. + The transform matrix. + + + + Sets a. + + Position of the Tile on the Tilemap. + to be placed the cell. + + + + Sets the TileFlags onto the Tile at the given position. + + Position of the Tile on the Tilemap. + TileFlags to add onto the Tile. + + + + Sets an array of. + + An array of positions of Tiles on the Tilemap. + An array of to be placed. + + + + Fills bounds with array of tiles. + + Bounds to be filled. + An array of to be placed. + + + + Sets the transform matrix of a tile given the XYZ coordinates of a cell in the. + + Position of the Tile on the Tilemap. + The transform matrix. + + + + Swaps all existing tiles of changeTile to newTile and refreshes all the swapped tiles. + + Tile to swap. + Tile to swap to. + + + + Collider for 2D physics representing shapes defined by the corresponding Tilemap. + + + + + The tile map renderer is used to render the tile map marked out by a component. + + + + + Bounds used for culling of Tilemap chunks. + + + + + Size in number of tiles of each chunk created by the TilemapRenderer. + + + + + Returns whether the TilemapRenderer automatically detects the bounds to extend chunk culling by. + + + + + Specifies how the Tilemap interacts with the masks. + + + + + Maximum number of chunks the TilemapRenderer caches in memory. + + + + + Maximum number of frames the TilemapRenderer keeps unused chunks in memory. + + + + + The mode in which the TileMapRenderer batches the for rendering. + + + + + Active sort order for the TilemapRenderer. + + + + + Returns whether the TilemapRenderer automatically detects the bounds to extend chunk culling by. + + + + + The TilemapRenderer will automatically detect the bounds of extension by inspecting the Sprite/s used in the Tilemap. + + + + + The user adds in the values used for extend the bounds for culling of Tilemap chunks. + + + + + Determines how the TilemapRenderer should batch the for rendering. + + + + + Batches each Sprite from the Tilemap into grouped chunks to be rendered. + + + + + Sends each Sprite from the Tilemap to be rendered individually. + + + + + Sort order for all tiles rendered by the TilemapRenderer. + + + + + Sorts tiles for rendering starting from the tile with the lowest X and the lowest Y cell positions. + + + + + Sorts tiles for rendering starting from the tile with the highest X and the lowest Y cell positions. + + + + + Sorts tiles for rendering starting from the tile with the lowest X and the highest Y cell positions. + + + + + Sorts tiles for rendering starting from the tile with the highest X and the lowest Y cell positions. + + + + + The interface to get time information from Unity. + + + + + Slows game playback time to allow screenshots to be saved between frames. + + + + + The completion time in seconds since the last frame (Read Only). + + + + + The interval in seconds at which physics and other fixed frame rate updates (like MonoBehaviour's MonoBehaviour.FixedUpdate) are performed. + + + + + The time the latest MonoBehaviour.FixedUpdate has started (Read Only). This is the time in seconds since the start of the game. + + + + + The timeScale-independent interval in seconds from the last fixed frame to the current one (Read Only). + + + + + The TimeScale-independant time the latest MonoBehaviour.FixedUpdate has started (Read Only). This is the time in seconds since the start of the game. + + + + + The total number of frames that have passed (Read Only). + + + + + Returns true if called inside a fixed time step callback (like MonoBehaviour's MonoBehaviour.FixedUpdate), otherwise returns false. + + + + + The maximum time a frame can take. Physics and other fixed frame rate updates (like MonoBehaviour's MonoBehaviour.FixedUpdate) will be performed only for this duration of time per frame. + + + + + The maximum time a frame can spend on particle updates. If the frame takes longer than this, then updates are split into multiple smaller updates. + + + + + The real time in seconds since the game started (Read Only). + + + + + A smoothed out Time.deltaTime (Read Only). + + + + + The time at the beginning of this frame (Read Only). This is the time in seconds since the start of the game. + + + + + The scale at which the time is passing. This can be used for slow motion effects. + + + + + The time this frame has started (Read Only). This is the time in seconds since the last level has been loaded. + + + + + The timeScale-independent interval in seconds from the last frame to the current one (Read Only). + + + + + The timeScale-independant time for this frame (Read Only). This is the time in seconds since the start of the game. + + + + + Specify a tooltip for a field in the Inspector window. + + + + + The tooltip text. + + + + + Specify a tooltip for a field. + + The tooltip text. + + + + Structure describing the status of a finger touching the screen. + + + + + Value of 0 radians indicates that the stylus is parallel to the surface, pi/2 indicates that it is perpendicular. + + + + + Value of 0 radians indicates that the stylus is pointed along the x-axis of the device. + + + + + The position delta since last change. + + + + + Amount of time that has passed since the last recorded change in Touch values. + + + + + The unique index for the touch. + + + + + The maximum possible pressure value for a platform. If Input.touchPressureSupported returns false, the value of this property will always be 1.0f. + + + + + Describes the phase of the touch. + + + + + The position of the touch in pixel coordinates. + + + + + The current amount of pressure being applied to a touch. 1.0f is considered to be the pressure of an average touch. If Input.touchPressureSupported returns false, the value of this property will always be 1.0f. + + + + + An estimated value of the radius of a touch. Add radiusVariance to get the maximum touch size, subtract it to get the minimum touch size. + + + + + This value determines the accuracy of the touch radius. Add this value to the radius to get the maximum touch size, subtract it to get the minimum touch size. + + + + + The raw position used for the touch. + + + + + Number of taps. + + + + + A value that indicates whether a touch was of Direct, Indirect (or remote), or Stylus type. + + + + + Describes phase of a finger touch. + + + + + A finger touched the screen. + + + + + The system cancelled tracking for the touch. + + + + + A finger was lifted from the screen. This is the final phase of a touch. + + + + + A finger moved on the screen. + + + + + A finger is touching the screen but hasn't moved. + + + + + Interface into the native iPhone, Android, Windows Phone and Windows Store Apps on-screen keyboards - it is not available on other platforms. + + + + + Is the keyboard visible or sliding into the position on the screen? + + + + + Returns portion of the screen which is covered by the keyboard. + + + + + Specifies whether the TouchScreenKeyboard supports the selection property. (Read Only) + + + + + Specifies whether the TouchScreenKeyboard supports the selection property. (Read Only) + + + + + How many characters the keyboard input field is limited to. 0 = infinite. + + + + + Specifies if input process was finished. (Read Only) + + + + + Will text input field above the keyboard be hidden when the keyboard is on screen? + + + + + Is touch screen keyboard supported. + + + + + Gets or sets the character range of the selected text within the string currently being edited. + + + + + Returns the status of the on-screen keyboard. (Read Only) + + + + + Specified on which display the software keyboard will appear. + + + + + Returns the text displayed by the input field of the keyboard. + + + + + Returns the TouchScreenKeyboardType of the keyboard. + + + + + Returns true whenever any keyboard is completely visible on the screen. + + + + + Specifies if input process was canceled. (Read Only) + + + + + Opens the native keyboard provided by OS on the screen. + + Text to edit. + Type of keyboard (eg, any text, numbers only, etc). + Is autocorrection applied? + Can more than one line of text be entered? + Is the text masked (for passwords, etc)? + Is the keyboard opened in alert mode? + Text to be used if no other text is present. + How many characters the keyboard input field is limited to. 0 = infinite. (Android and iOS only) + + + + Opens the native keyboard provided by OS on the screen. + + Text to edit. + Type of keyboard (eg, any text, numbers only, etc). + Is autocorrection applied? + Can more than one line of text be entered? + Is the text masked (for passwords, etc)? + Is the keyboard opened in alert mode? + Text to be used if no other text is present. + How many characters the keyboard input field is limited to. 0 = infinite. (Android and iOS only) + + + + Opens the native keyboard provided by OS on the screen. + + Text to edit. + Type of keyboard (eg, any text, numbers only, etc). + Is autocorrection applied? + Can more than one line of text be entered? + Is the text masked (for passwords, etc)? + Is the keyboard opened in alert mode? + Text to be used if no other text is present. + How many characters the keyboard input field is limited to. 0 = infinite. (Android and iOS only) + + + + Opens the native keyboard provided by OS on the screen. + + Text to edit. + Type of keyboard (eg, any text, numbers only, etc). + Is autocorrection applied? + Can more than one line of text be entered? + Is the text masked (for passwords, etc)? + Is the keyboard opened in alert mode? + Text to be used if no other text is present. + How many characters the keyboard input field is limited to. 0 = infinite. (Android and iOS only) + + + + Opens the native keyboard provided by OS on the screen. + + Text to edit. + Type of keyboard (eg, any text, numbers only, etc). + Is autocorrection applied? + Can more than one line of text be entered? + Is the text masked (for passwords, etc)? + Is the keyboard opened in alert mode? + Text to be used if no other text is present. + How many characters the keyboard input field is limited to. 0 = infinite. (Android and iOS only) + + + + Opens the native keyboard provided by OS on the screen. + + Text to edit. + Type of keyboard (eg, any text, numbers only, etc). + Is autocorrection applied? + Can more than one line of text be entered? + Is the text masked (for passwords, etc)? + Is the keyboard opened in alert mode? + Text to be used if no other text is present. + How many characters the keyboard input field is limited to. 0 = infinite. (Android and iOS only) + + + + Opens the native keyboard provided by OS on the screen. + + Text to edit. + Type of keyboard (eg, any text, numbers only, etc). + Is autocorrection applied? + Can more than one line of text be entered? + Is the text masked (for passwords, etc)? + Is the keyboard opened in alert mode? + Text to be used if no other text is present. + How many characters the keyboard input field is limited to. 0 = infinite. (Android and iOS only) + + + + Opens the native keyboard provided by OS on the screen. + + Text to edit. + Type of keyboard (eg, any text, numbers only, etc). + Is autocorrection applied? + Can more than one line of text be entered? + Is the text masked (for passwords, etc)? + Is the keyboard opened in alert mode? + Text to be used if no other text is present. + How many characters the keyboard input field is limited to. 0 = infinite. (Android and iOS only) + + + + The status of the on-screen keyboard. + + + + + The on-screen keyboard was canceled. + + + + + The user has finished providing input. + + + + + The on-screen keyboard has lost focus. + + + + + The on-screen keyboard is visible. + + + + + Enumeration of the different types of supported touchscreen keyboards. + + + + + Keyboard with standard ASCII keys. + + + + + Keyboard with numbers and a decimal point. + + + + + The default keyboard layout of the target platform. + + + + + Keyboard with additional keys suitable for typing email addresses. + + + + + Keyboard with alphanumeric keys. + + + + + Keyboard for the Nintendo Network (Deprecated). + + + + + Keyboard with standard numeric keys. + + + + + Keyboard with numbers and punctuation mark keys. + + + + + Keyboard with a layout suitable for typing telephone numbers. + + + + + Keyboard with the "." key beside the space key, suitable for typing search terms. + + + + + Keyboard with symbol keys often used on social media, such as Twitter. + + + + + Keyboard with keys for URL entry. + + + + + Describes whether a touch is direct, indirect (or remote), or from a stylus. + + + + + A direct touch on a device. + + + + + An Indirect, or remote, touch on a device. + + + + + A touch from a stylus on a device. + + + + + The trail renderer is used to make trails behind objects in the Scene as they move about. + + + + + Select whether the trail will face the camera, or the orientation of the Transform Component. + + + + + Does the GameObject of this Trail Renderer auto destruct? + + + + + Set the color gradient describing the color of the trail at various points along its length. + + + + + Creates trails when the GameObject moves. + + + + + Set the color at the end of the trail. + + + + + The width of the trail at the end of the trail. + + + + + Configures a trail to generate Normals and Tangents. With this data, Scene lighting can affect the trail via Normal Maps and the Unity Standard Shader, or your own custom-built Shaders. + + + + + Set the minimum distance the trail can travel before a new vertex is added to it. + + + + + Set this to a value greater than 0, to get rounded corners on each end of the trail. + + + + + Set this to a value greater than 0, to get rounded corners between each segment of the trail. + + + + + Get the number of line segments in the trail. + + + + + Get the number of line segments in the trail. + + + + + Apply a shadow bias to prevent self-shadowing artifacts. The specified value is the proportion of the trail width at each segment. + + + + + Set the color at the start of the trail. + + + + + The width of the trail at the spawning point. + + + + + Choose whether the U coordinate of the trail texture is tiled or stretched. + + + + + How long does the trail take to fade out. + + + + + Set the curve describing the width of the trail at various points along its length. + + + + + Set an overall multiplier that is applied to the TrailRenderer.widthCurve to get the final width of the trail. + + + + + Adds a position to the trail. + + The position to add to the trail. + + + + Add an array of positions to the trail. + + The positions to add to the trail. + + + + Creates a snapshot of TrailRenderer and stores it in mesh. + + A static mesh that will receive the snapshot of the trail. + The camera used for determining which way camera-space trails will face. + Include the rotation and scale of the Transform in the baked mesh. + + + + Creates a snapshot of TrailRenderer and stores it in mesh. + + A static mesh that will receive the snapshot of the trail. + The camera used for determining which way camera-space trails will face. + Include the rotation and scale of the Transform in the baked mesh. + + + + Creates a snapshot of TrailRenderer and stores it in mesh. + + A static mesh that will receive the snapshot of the trail. + The camera used for determining which way camera-space trails will face. + Include the rotation and scale of the Transform in the baked mesh. + + + + Creates a snapshot of TrailRenderer and stores it in mesh. + + A static mesh that will receive the snapshot of the trail. + The camera used for determining which way camera-space trails will face. + Include the rotation and scale of the Transform in the baked mesh. + + + + Removes all points from the TrailRenderer. +Useful for restarting a trail from a new position. + + + + + Get the position of a vertex in the trail. + + The index of the position to retrieve. + + The position at the specified index in the array. + + + + + Get the positions of all vertices in the trail. + + The array of positions to retrieve. + + How many positions were actually stored in the output array. + + + + + Set the position of a vertex in the trail. + + Which position to set. + The new position. + + + + Sets the positions of all vertices in the trail. + + The array of positions to set. + + + + Position, rotation and scale of an object. + + + + + The number of children the parent Transform has. + + + + + The rotation as Euler angles in degrees. + + + + + The blue axis of the transform in world space. + + + + + Has the transform changed since the last time the flag was set to 'false'? + + + + + The transform capacity of the transform's hierarchy data structure. + + + + + The number of transforms in the transform's hierarchy data structure. + + + + + The rotation as Euler angles in degrees relative to the parent transform's rotation. + + + + + Position of the transform relative to the parent transform. + + + + + The rotation of the transform relative to the transform rotation of the parent. + + + + + The scale of the transform relative to the parent. + + + + + Matrix that transforms a point from local space into world space (Read Only). + + + + + The global scale of the object (Read Only). + + + + + The parent of the transform. + + + + + The world space position of the Transform. + + + + + The red axis of the transform in world space. + + + + + Returns the topmost transform in the hierarchy. + + + + + A quaternion that stores the rotation of the Transform in world space. + + + + + The green axis of the transform in world space. + + + + + Matrix that transforms a point from world space into local space (Read Only). + + + + + Unparents all children. + + + + + Finds a child by n and returns it. + + Name of child to be found. + + The returned child transform or null if no child is found. + + + + + Returns a transform child by index. + + Index of the child transform to return. Must be smaller than Transform.childCount. + + Transform child by index. + + + + + Gets the sibling index. + + + + + Transforms a direction from world space to local space. The opposite of Transform.TransformDirection. + + + + + + Transforms the direction x, y, z from world space to local space. The opposite of Transform.TransformDirection. + + + + + + + + Transforms position from world space to local space. + + + + + + Transforms the position x, y, z from world space to local space. The opposite of Transform.TransformPoint. + + + + + + + + Transforms a vector from world space to local space. The opposite of Transform.TransformVector. + + + + + + Transforms the vector x, y, z from world space to local space. The opposite of Transform.TransformVector. + + + + + + + + Is this transform a child of parent? + + + + + + Rotates the transform so the forward vector points at target's current position. + + Object to point towards. + Vector specifying the upward direction. + + + + Rotates the transform so the forward vector points at target's current position. + + Object to point towards. + Vector specifying the upward direction. + + + + Rotates the transform so the forward vector points at worldPosition. + + Point to look at. + Vector specifying the upward direction. + + + + Rotates the transform so the forward vector points at worldPosition. + + Point to look at. + Vector specifying the upward direction. + + + + Applies a rotation of eulerAngles.z degrees around the z-axis, eulerAngles.x degrees around the x-axis, and eulerAngles.y degrees around the y-axis (in that order). + + The rotation to apply. + Determines whether to rotate the GameObject either locally to the GameObject or relative to the Scene in world space. + + + + Applies a rotation of zAngle degrees around the z axis, xAngle degrees around the x axis, and yAngle degrees around the y axis (in that order). + + Determines whether to rotate the GameObject either locally to the GameObject or relative to the Scene in world space. + Degrees to rotate the GameObject around the X axis. + Degrees to rotate the GameObject around the Y axis. + Degrees to rotate the GameObject around the Z axis. + + + + Rotates the object around the given axis by the number of degrees defined by the given angle. + + The degrees of rotation to apply. + The axis to apply rotation to. + Determines whether to rotate the GameObject either locally to the GameObject or relative to the Scene in world space. + + + + Rotates the transform about axis passing through point in world coordinates by angle degrees. + + + + + + + + + + + + + + + Move the transform to the start of the local transform list. + + + + + Move the transform to the end of the local transform list. + + + + + Set the parent of the transform. + + The parent Transform to use. + If true, the parent-relative position, scale and + rotation are modified such that the object keeps the same world space position, + rotation and scale as before. + + + + + Set the parent of the transform. + + The parent Transform to use. + If true, the parent-relative position, scale and + rotation are modified such that the object keeps the same world space position, + rotation and scale as before. + + + + + Sets the world space position and rotation of the Transform component. + + + + + + + Sets the sibling index. + + Index to set. + + + + Transforms direction from local space to world space. + + + + + + Transforms direction x, y, z from local space to world space. + + + + + + + + Transforms position from local space to world space. + + + + + + Transforms the position x, y, z from local space to world space. + + + + + + + + Transforms vector from local space to world space. + + + + + + Transforms vector x, y, z from local space to world space. + + + + + + + + Moves the transform in the direction and distance of translation. + + + + + + + Moves the transform in the direction and distance of translation. + + + + + + + Moves the transform by x along the x axis, y along the y axis, and z along the z axis. + + + + + + + + + Moves the transform by x along the x axis, y along the y axis, and z along the z axis. + + + + + + + + + Moves the transform in the direction and distance of translation. + + + + + + + Moves the transform by x along the x axis, y along the y axis, and z along the z axis. + + + + + + + + + Transparent object sorting mode of a Camera. + + + + + Sort objects based on distance along a custom axis. + + + + + Default transparency sorting mode. + + + + + Orthographic transparency sorting mode. + + + + + Perspective transparency sorting mode. + + + + + Tree Component for the tree creator. + + + + + Data asociated to the Tree. + + + + + Tells if there is wind data exported from SpeedTree are saved on this component. + + + + + Contains information about a tree placed in the Terrain game object. + + + + + Color of this instance. + + + + + Height scale of this instance (compared to the prototype's size). + + + + + Lightmap color calculated for this instance. + + + + + Position of the tree. + + + + + Index of this instance in the TerrainData.treePrototypes array. + + + + + Read-only. + +Rotation of the tree on X-Z plane (in radians). + + + + + Width scale of this instance (compared to the prototype's size). + + + + + Simple class that contains a pointer to a tree prototype. + + + + + Bend factor of the tree prototype. + + + + + Retrieves the actual GameObject used by the tree. + + + + + Interface into tvOS specific functionality. + + + + + Advertising ID. + + + + + Is advertising tracking enabled. + + + + + The generation of the device. (Read Only) + + + + + iOS version. + + + + + Vendor ID. + + + + + Reset "no backup" file flag: file will be synced with iCloud/iTunes backup and can be deleted by OS in low storage situations. + + + + + + Set file flag to be excluded from iCloud/iTunes backup. + + + + + + iOS device generation. + + + + + First generation Apple TV. + + + + + Second generation (4K) Apple TV. + + + + + A class for Apple TV remote input configuration. + + + + + Configures how "Menu" button behaves on Apple TV Remote. If this property is set to true hitting "Menu" on Remote will exit to system home screen. When this property is false current application is responsible for handling "Menu" button. It is recommended to set this property to true on top level menus of your application. + + + + + Configures if Apple TV Remote should autorotate all the inputs when Remote is being held in horizontal orientation. Default is false. + + + + + Configures how touches are mapped to analog joystick axes in relative or absolute values. If set to true it will return +1 on Horizontal axis when very far right is being touched on Remote touch aread (and -1 when very left area is touched correspondingly). The same applies for Vertical axis too. When this property is set to false player should swipe instead of touching specific area of remote to generate Horizontal or Vertical input. + + + + + Disables Apple TV Remote touch propagation to Unity Input.touches API. Useful for 3rd party frameworks, which do not respect Touch.type == Indirect. +Default is false. + + + + + Sprite Atlas is an asset created within Unity. It is part of the built-in sprite packing solution. + + + + + Return true if this SpriteAtlas is a variant. + + + + + Get the total number of Sprite packed into this atlas. + + + + + Get the tag of this SpriteAtlas. + + + + + Return true if Sprite is packed into this SpriteAtlas. + + + + + + Clone the first Sprite in this atlas that matches the name packed in this atlas and return it. + + The name of the Sprite. + + + + Clone all the Sprite in this atlas and fill them into the supplied array. + + Array of Sprite that will be filled. + + The size of the returned array. + + + + + Clone all the Sprite matching the name in this atlas and fill them into the supplied array. + + Array of Sprite that will be filled. + The name of the Sprite. + + + + Manages SpriteAtlas during runtime. + + + + + Trigger when a SpriteAtlas is registered via invoking the callback in U2D.SpriteAtlasManager.atlasRequested. + + + + + + Trigger when any Sprite was bound to SpriteAtlas but couldn't locate the atlas asset during runtime. + + + + + + Class that specifies some information about a renderable character. + + + + + Character width. + + + + + Position of the character cursor in local (text generated) space. + + + + + Information about a generated line of text. + + + + + Height of the line. + + + + + Space in pixels between this line and the next line. + + + + + Index of the first character in the line. + + + + + The upper Y position of the line in pixels. This is used for text annotation such as the caret and selection box in the InputField. + + + + + Vertex class used by a Canvas for managing vertices. + + + + + Vertex color. + + + + + Normal. + + + + + Vertex position. + + + + + Simple UIVertex with sensible settings for use in the UI system. + + + + + Tangent. + + + + + The first texture coordinate set of the mesh. Used by UI elements by default. + + + + + The second texture coordinate set of the mesh, if present. + + + + + The Third texture coordinate set of the mesh, if present. + + + + + The forth texture coordinate set of the mesh, if present. + + + + + The BurstDiscard attribute lets you remove a method or property from being compiled to native code by the burst compiler. + + + + + The BurstDiscard attribute lets you remove a method or property from being compiled to native code by the burst compiler. + + + + + Used to specify allocation type for NativeArray. + + + + + Invalid allocation. + + + + + No allocation. + + + + + Persistent allocation. + + + + + Temporary allocation. + + + + + Temporary job allocation. + + + + + DeallocateOnJobCompletionAttribute. + + + + + AtomicSafetyHandle is used by the job system to provide validation and full safety. + + + + + Checks if the handle can be deallocated. Throws an exception if it has already been destroyed or a job is currently accessing the data. + + Safety handle. + + + + Checks if the handle is still valid and throws an exception if it is already destroyed. + + Safety handle. + + + + CheckGetSecondaryDataPointerAndThrow. + + Safety handle. + + + + Checks if the handle can be read from. Throws an exception if already destroyed or a job is currently writing to the data. + + Safety handle. + + + + Performs CheckWriteAndThrow and then bumps the secondary version. + + Safety handle. + + + + Checks if the handle can be written to. Throws an exception if already destroyed or a job is currently reading or writing to the data. + + Safety handle. + + + + Creates a new AtomicSafetyHandle that is valid until AtomicSafetyHandle.Release is called. + + + Safety handle. + + + + + Waits for all jobs running against this AtomicSafetyHandle to complete. + + Safety handle. + + Result. + + + + + Waits for all jobs running against this AtomicSafetyHandle to complete and then disables the read and write access on this atomic safety handle. + + Safety handle. + + Result. + + + + + Waits for all jobs running against this AtomicSafetyHandle to complete and then releases the atomic safety handle. + + Safety handle. + + Result. + + + + + Returns true if the AtomicSafetyHandle is configured to allow reading or writing. + + Safety handle. + + True if the AtomicSafetyHandle is configured to allow reading or writing, false otherwise. + + + + + Fetch the job handles of all jobs reading from the safety handle. + + The atomic safety handle to return readers for. + The maximum number of handles to be written to the output array. + A buffer where the job handles will be written. + + The actual number of readers on the handle, which can be greater than the maximum count provided. + + + + + Return the name of the specified reading job. + + Safety handle. + Index of the reader. + + The debug name of the reader. + + + + + Returns the safety handle which should be used for all temp memory allocations in this temp memory scope. All temp memory allocations share the same safety handle since they are automatically disposed of at the same time. + + + The safety handle for temp memory allocations in the current scope. + + + + + Returns a single shared handle, that can be shared by for example NativeSlice pointing to stack memory. + + + Safety handle. + + + + + Return the writer (if any) on an atomic safety handle. + + Safety handle. + + The job handle of the writer. + + + + + Return the debug name of the current writer on an atomic safety handle. + + Safety handle. + + Name of the writer, if any. + + + + + Checks if an AtomicSafetyHandle is the temp memory safety handle for the currently active temp memory scope. + + Safety handle. + + True if the safety handle is the temp memory handle for the current scope. + + + + + Marks the AtomicSafetyHandle so that it cannot be disposed of. + + Safety handle. + + + + Releases a previously created AtomicSafetyHandle. + + Safety handle. + + + + Lets you prevent read or write access on the atomic safety handle. + + Safety handle. + Use false to disallow read or write access, or true otherwise. + + + + Switches the AtomicSafetyHandle to the secondary version number. + + Safety handle. + Allow writing. + + + + Switches the AtomicSafetyHandle to the secondary version number. + + Safety handle. + + + + DisposeSentinel is used to automatically detect memory leaks. + + + + + Clears the DisposeSentinel. + + The DisposeSentinel to clear. + + + + Creates a new AtomicSafetyHandle and a new DisposeSentinel, to be used to track safety and leaks on some native data. + + The AtomicSafetyHandle that can be used to control access to the data related to the DisposeSentinel being created. + The new DisposeSentinel. + The stack depth where to extract the logging information from. + + + + Releases the AtomicSafetyHandle and clears the DisposeSentinel. + + The AtomicSafetyHandle returned when invoking Create. + The DisposeSentinel. + + + + EnforceJobResult. + + + + + AllJobsAlreadySynced. + + + + + DidSyncRunningJobs. + + + + + HandleWasAlreadyDeallocated. + + + + + NativeArray Unsafe Utility. + + + + + Converts an existing buffer to a NativeArray. + + Pointer to the preallocated data. + Length (in bytes) of the data. + Allocation strategy to use. + + A new NativeArray, allocated with the given strategy and wrapping the provided data. + + + + + Returns the AtomicSafetyHandle that is used for safety control on the NativeArray. + + NativeArray. + + Safety handle. + + + + + Gets the pointer to the data owner by the NativeArray, without performing checks. + + NativeArray. + + NativeArray memory buffer pointer. + + + + + Gets the pointer to the memory buffer owner by the NativeArray, performing checks on whether the native array can be written to. + + NativeArray. + + NativeArray memory buffer pointer. + + + + + Gets the pointer to the memory buffer owner by the NativeArray, performing checks on whether the native array can be read from. + + NativeArray. + + NativeArray memory buffer pointer. + + + + + Sets a new AtomicSafetyHandle for the provided NativeArray. + + NativeArray. + Safety handle. + + + + Allows you to create your own custom native container. + + + + + NativeContainerIsAtomicWriteOnlyAttribute. + + + + + NativeContainerIsReadOnlyAttribute. + + + + + NativeContainerSupportsDeallocateOnJobCompletionAttribute. + + + + + NativeContainerSupportsDeferredConvertListToArray. + + + + + NativeContainerSupportsMinMaxWriteRestrictionAttribute. + + + + + By default native containers are tracked by the safety system to avoid race conditions. The safety system encapsulates the best practices and catches many race condition bugs from the start. + + + + + By default unsafe Pointers are not allowed to be used in a job since it is not possible for the Job Debugger to gurantee race condition free behaviour. This attribute lets you explicitly disable the restriction on a job. + + + + + When this attribute is applied to a field in a job struct, the managed reference to the class will be set to null on the copy of the job struct that is passed to the job. + + + + + This attribute can inject a worker thread index into an int on the job struct. This is usually used in the implementation of atomic containers. The index is guaranteed to be unique to any other job that might be running in parallel. + + + + + NativeSlice unsafe utility class. + + + + + ConvertExistingDataToNativeSlice. + + Memory pointer. + Number of elements. + + + + Get safety handle for native slice. + + NativeSlice. + + Safety handle. + + + + + Get NativeSlice memory buffer pointer. Checks whether the native array can be written to. + + NativeSlice. + + Memory pointer. + + + + + Get NativeSlice memory buffer pointer. Checks whether the native array can be read from. + + NativeSlice. + + Memory pointer. + + + + + Set safetly handle on NativeSlice. + + NativeSlice. + Safety handle. + + + + Unsafe utility class. + + + + + The memory address of the struct. + + Struct. + + Memory pointer. + + + + + Minimum alignment of a struct. + + + Memory pointer. + + + + + Assigns an Object reference to a struct or pinned class. See Also: UnsafeUtility.PinGCObjectAndGetAddress. + + + + + + + Copies sizeof(T) bytes from ptr to output. + + Memory pointer. + Struct. + + + + Copies sizeof(T) bytes from input to ptr. + + Memory pointer. + Struct. + + + + Free memory. + + Memory pointer. + Allocator. + + + + Returns the offset of the field relative struct or class it is contained in. + + + + + + Returns whether the struct is blittable. + + The System.Type of a struct. + + True if struct is blittable, otherwise false. + + + + + Returns whether the struct is blittable. + + The System.Type of a struct. + + True if struct is blittable, otherwise false. + + + + + Returns true if the allocator label is valid and can be used to allocate or deallocate memory. + + + + + + Allocate memory. + + Size. + Alignment. + Allocator. + + Memory pointer. + + + + + Clear memory. + + Memory pointer. + Size. + + + + Checks to see whether two memory regions are identical or not by comparing a specified memory region in the first given memory buffer with the same region in the second given memory buffer. + + Pointer to the first memory buffer. + Pointer to the second memory buffer to compare the first one to. + Number of bytes to compare. + + 0 if the contents are identical, non-zero otherwise. + + + + + Copy memory. + + Destination memory pointer. + Source memory pointer. + Size. + + + + Copy memory and replicate. + + Destination memory pointer. + Source memory pointer. + Size. + Count. + + + + Similar to UnsafeUtility.MemCpy but can skip bytes via desinationStride and sourceStride. + + + + + + + + + + + Move memory. + + Destination memory pointer. + Source memory pointer. + Size. + + + + Keeps a strong GC reference to the object and pins it. The object is guranteed to not move its memory location in a moving GC. Returns the address of the first element of the array. + +See Also: UnsafeUtility.ReleaseGCObject. + + + + + Keeps a strong GC reference to the object and pins it. The object is guranteed to not move its memory location in a moving GC. Returns the address of the memory location of the object. + +See Also: UnsafeUtility.ReleaseGCObject. + + + + + + + Read array element. + + Memory pointer. + Array index. + + Array Element. + + + + + Read array element with stride. + + Memory pointer. + Array index. + Stride. + + Array element. + + + + + Releases a GC Object Handle, previously aquired by UnsafeUtility.PinGCObjectAndGetAddress. + + + + + + Size of struct. + + + Size of struct. + + + + + Write array element. + + Memory pointer. + Array index. + Value to write. + + + + Write array element with stride. + + Memory pointer. + Array index. + Stride. + Value to write. + + + + Used in conjunction with the ReadOnlyAttribute, WriteAccessRequiredAttribute lets you specify which struct method and property require write access to be invoked. + + + + + A NativeArray exposes a buffer of native memory to managed code, making it possible to share data between managed and native without marshalling costs. + + + + + Copies a range of elements from a source array to a destination array, starting from the source index and copying them to the destination index. + + The data to copy. + The array that receives the data. + A 32-bit integer that represents the number of elements to copy. The integer must be equal or greater than zero. + A 32-bit integer that represents the index in the srcArray at which copying begins. + A 32-bit integer that represents the index in the dstArray at which storing begins. + + + + Copies a range of elements from a source array to a destination array, starting from the source index and copying them to the destination index. + + The data to copy. + The array that receives the data. + A 32-bit integer that represents the number of elements to copy. The integer must be equal or greater than zero. + A 32-bit integer that represents the index in the srcArray at which copying begins. + A 32-bit integer that represents the index in the dstArray at which storing begins. + + + + Copies a range of elements from a source array to a destination array, starting from the source index and copying them to the destination index. + + The data to copy. + The array that receives the data. + A 32-bit integer that represents the number of elements to copy. The integer must be equal or greater than zero. + A 32-bit integer that represents the index in the srcArray at which copying begins. + A 32-bit integer that represents the index in the dstArray at which storing begins. + + + + Copies a range of elements from a source array to a destination array, starting from the source index and copying them to the destination index. + + The data to copy. + The array that receives the data. + A 32-bit integer that represents the number of elements to copy. The integer must be equal or greater than zero. + A 32-bit integer that represents the index in the srcArray at which copying begins. + A 32-bit integer that represents the index in the dstArray at which storing begins. + + + + Copies a range of elements from a source array to a destination array, starting from the source index and copying them to the destination index. + + The data to copy. + The array that receives the data. + A 32-bit integer that represents the number of elements to copy. The integer must be equal or greater than zero. + A 32-bit integer that represents the index in the srcArray at which copying begins. + A 32-bit integer that represents the index in the dstArray at which storing begins. + + + + Copies a range of elements from a source array to a destination array, starting from the source index and copying them to the destination index. + + The data to copy. + The array that receives the data. + A 32-bit integer that represents the number of elements to copy. The integer must be equal or greater than zero. + A 32-bit integer that represents the index in the srcArray at which copying begins. + A 32-bit integer that represents the index in the dstArray at which storing begins. + + + + Copies a range of elements from a source array to a destination array, starting from the source index and copying them to the destination index. + + The data to copy. + The array that receives the data. + A 32-bit integer that represents the number of elements to copy. The integer must be equal or greater than zero. + A 32-bit integer that represents the index in the srcArray at which copying begins. + A 32-bit integer that represents the index in the dstArray at which storing begins. + + + + Copies a range of elements from a source array to a destination array, starting from the source index and copying them to the destination index. + + The data to copy. + The array that receives the data. + A 32-bit integer that represents the number of elements to copy. The integer must be equal or greater than zero. + A 32-bit integer that represents the index in the srcArray at which copying begins. + A 32-bit integer that represents the index in the dstArray at which storing begins. + + + + Copies a range of elements from a source array to a destination array, starting from the source index and copying them to the destination index. + + The data to copy. + The array that receives the data. + A 32-bit integer that represents the number of elements to copy. The integer must be equal or greater than zero. + A 32-bit integer that represents the index in the srcArray at which copying begins. + A 32-bit integer that represents the index in the dstArray at which storing begins. + + + + Copy all the elements from another NativeArray or managed array of the same length. + + Source array. + + + + Copy all the elements from another NativeArray or managed array of the same length. + + Source array. + + + + Copy all elements to another NativeArray or managed array of the same length. + + Destination array. + + + + Copy all elements to another NativeArray or managed array of the same length. + + Destination array. + + + + Creates a new NativeArray from an existing array of elements. + + An array to copy the data from. + The allocation strategy used for the data. + + + + Creates a new NativeArray from an existing NativeArray. + + NativeArray to copy the data from. + The allocation strategy used for the data. + + + + Creates a new NativeArray allocating enough memory to fit the provided amount of elements. + + Number of elements to be allocated. + The allocation strategy used for the data. + Options to control the behaviour of the NativeArray. + + + + Disposes the NativeArray. + + + + + Compares to NativeArray. + + NativeArray to compare against. + + True in case the two NativeArray are the same, false otherwise. + + + + + Compares to NativeArray. + + Object to compare against. + + True in case the two NativeArray are the same, false otherwise. + + + + + Get enumerator. + + + Enumerator. + + + + + Returns a hash code for the current instance. + + + Hash code. + + + + + Indicates that the NativeArray has an allocated memory buffer. + + + + + Number of elements in the NativeArray. + + + + + Access NativeArray elements by index. Notice that structs are returned by value and not by reference. + + + + + Convert NativeArray to array. + + + Array. + + + + + NativeArrayOptions lets you control if memory should be cleared on allocation or left uninitialized. + + + + + Clear NativeArray memory on allocation. + + + + + Uninitialized memory can improve performance, but results in the contents of the array elements being undefined. +In performance sensitive code it can make sense to use NativeArrayOptions.Uninitialized, if you are writing to the entire array right after creating it without reading any of the elements first. + + + + + + NativeDisableParallelForRestrictionAttribute. + + + + + The container has from start a size that will never change. + + + + + The specified number of elements will never change. + + The fixed number of elements in the container. + + + + The fixed number of elements in the container. + + + + + Static class for native leak detection settings. + + + + + Set whether native memory leak detection should be enabled or disabled. + + + + + Native leak memory leak detection mode enum. + + + + + Indicates that native memory leak detection is disabled. + + + + + Indicates that native memory leak detection is enabled. + + + + + Native Slice. + + + + + Copy all the elements from a NativeSlice or managed array of the same length. + + NativeSlice. + Array. + + + + Copy all the elements from a NativeSlice or managed array of the same length. + + NativeSlice. + Array. + + + + Copy all the elements of the slice to a NativeArray or managed array of the same length. + + Array. + + + + Copy all the elements of the slice to a NativeArray or managed array of the same length. + + Array. + + + + Constructor. + + NativeArray. + Start index. + Memory pointer. + Length. + + + + Constructor. + + NativeArray. + Start index. + Memory pointer. + Length. + + + + Constructor. + + NativeArray. + Start index. + Memory pointer. + Length. + + + + Constructor. + + NativeArray. + Start index. + Memory pointer. + Length. + + + + GetEnumerator. + + + Enumerator. + + + + + Implicit operator for creating a NativeSlice from a NativeArray. + + NativeArray. + + + + Number of elements in the slice. + + + + + SliceConvert. + + + NativeSlice. + + + + + SliceWithStride. + + Stride offset. + Field name whos offset should be used as stride. + + NativeSlice. + + + + + SliceWithStride. + + Stride offset. + Field name whos offset should be used as stride. + + NativeSlice. + + + + + SliceWithStride. + + Stride offset. + Field name whos offset should be used as stride. + + NativeSlice. + + + + + Returns stride set for Slice. + + + + + Access NativeSlice elements by index. Notice that structs are returned by value and not by reference. + + + + + Convert NativeSlice to array. + + + Array. + + + + + The ReadOnly attribute lets you mark a member of a struct used in a job as read-only. + + + + + The ReadOnly attribute lets you mark a member of a struct used in a job as read-only. + + + + + The WriteOnly attribute lets you mark a member of a struct used in a job as write-only. + + + + + With the AsyncReadManager, you can perform asynchronous I/O operations through Unity's virtual file system. You can perform these operations on any thread or job. + + + + + Issues an asynchronous file read operation. Returns a ReadHandle. + + The filename to read from. + A pointer to an array of ReadCommand structs that specify offset, size, and destination buffer. + The number of read commands pointed to by readCmds. + + Used to monitor the progress and status of the read command. + + + + + Describes the offset, size, and destination buffer of a single read operation. + + + + + The buffer that receives the read data. + + + + + The offset where the read begins, within the file. + + + + + The size of the read in bytes. + + + + + You can use this handle to query the status of an asynchronous read operation. Note: To avoid a memory leak, you must call Dispose. + + + + + Disposes the ReadHandle. Use this to free up internal resources for reuse. + + + + + Check if the ReadHandle is valid. + + + True if the ReadHandle is valid. + + + + + JobHandle that completes when the read operation completes. + + + + + Current state of the read operation. + + + + + State of the read operation. + + + + + All the ReadCommand operations completed successfully. + + + + + One or more of the ReadCommand operations failed. + + + + + The read operation is in progress. + + + + + IJob allows you to schedule a single job that runs in parallel to other jobs and the main thread. + + + + + Implement this method to perform work on a worker thread. + + + + + Extension methods for Jobs using the IJob interface. + + + + + Perform the job's Execute method immediately on the same thread. + + The job and data to Run. + + + + Schedule the job for execution on a worker thread. + + The job and data to schedule. + Dependencies are used to ensure that a job executes on workerthreads after the dependency has completed execution. Making sure that two jobs reading or writing to same data do not run in parallel. + + The handle identifying the scheduled job. Can be used as a dependency for a later job or ensure completion on the main thread. + + + + + Parallel-for jobs allow you to perform the same independent operation for each element of a native container or for a fixed number of iterations. + + + + + Implement this method to perform work against a specific iteration index. + + The index of the Parallel for loop at which to perform work. + + + + Extension methods for Jobs using the IJobParallelFor. + + + + + Perform the job's Execute method immediately on the same thread. + + The job and data to Run. + The number of iterations the for loop will execute. + + + + Schedule the job for execution on a worker thread. + + The job and data to Schedule. + The number of iterations the for loop will execute. + Granularity in which workstealing is performed. A value of 32, means the job queue will steal 32 iterations and then perform them in an efficient inner loop. + Dependencies are used to ensure that a job executes on workerthreads after the dependency has completed execution. Making sure that two jobs reading or writing to same data do not run in parallel. + + The handle identifying the scheduled job. Can be used as a dependency for a later job or ensure completion on the main thread. + + + + + JobHandle. + + + + + CheckFenceIsDependencyOrDidSyncFence. + + Job handle. + Job handle dependency. + + Return value. + + + + + Combines multiple dependencies into a single one. + + + + + + + + + Combines multiple dependencies into a single one. + + + + + + + + + Combines multiple dependencies into a single one. + + + + + + + + + Ensures that the job has completed. + + + + + Ensures that all jobs have completed. + + + + + + + + + Ensures that all jobs have completed. + + + + + + + + + Ensures that all jobs have completed. + + + + + + + + + Returns false if the task is currently running. Returns true if the task has completed. + + + + + By default jobs are only put on a local queue when using Job Schedule functions, this actually makes them available to the worker threads to execute them. + + + + + Struct used to implement batch query jobs. + + + + + Create BatchQueryJob. + + NativeArray containing the commands to execute during a batch. The job executing the query will only read from the array, not write to it. + NativeArray which can contain the results from the commands. The job executing the query will write to the array. + + + + Struct used to schedule batch query jobs. + + + + + Initializes a BatchQueryJobStruct and returns a pointer to an internal structure (System.IntPtr) which should be passed to JobsUtility.JobScheduleParameters. + + + + + JobHandle Unsafe Utilities. + + + + + Combines multiple dependencies into a single one using an unsafe array of job handles. +See Also: JobHandle.CombineDependencies. + + + + + + + All job interface types must be marked with the JobProducerType. This is used to compile the Execute method by the Burst ASM inspector. + + + + + + + The type containing a static method named "Execute" method which is the method invokes by the job system. + + + + ProducerType is the type containing a static method named "Execute" method which is the method invokes by the job system. + + + + + Struct containing information about a range the job is allowed to work on. + + + + + The size of the batch. + + + + + Number of indices per phase. + + + + + Number of jobs. + + + + + Number of phases. + + + + + Phase Data. + + + + + The start and end index of the job range. + + + + + Total iteration count. + + + + + Static class containing functionality to create, run and debug jobs. + + + + + Size of a cache line. + + + + + Creates job reflection data. + + + Returns pointer to internal JobReflectionData. + + + + + Creates job reflection data. + + + Returns pointer to internal JobReflectionData. + + + + + Returns the begin index and end index of the range. + + + + + + + + + Returns the work stealing range. + + + + + + + Returns true if successful. + + + + + When disabled, forces jobs that have already been compiled with burst to run in mono instead. For example if you want to debug the C# jobs or just want to compare behaviour or performance. + + + + + Enables and disables the job debugger at runtime. Note that currently the job debugger is only supported in the Editor. Thus this only has effect in the editor. + + + + + Struct containing job parameters for scheduling. + + + + + Constructor. + + + + + + + + + A JobHandle to any dependency this job would have. + + + + + Pointer to the job data. + + + + + Pointer to the reflection data. + + + + + ScheduleMode option. + + + + + Maximum job thread count. + + + + + Injects debug checks for min and max ranges of native array. + + + + + Schedule a single IJob. + + + + Returns a JobHandle to the newly created Job. + + + + + Schedule a IJobParallelFor job. + + + + + + Returns a JobHandle to the newly created Job. + + + + + Schedule a IJobParallelFor job. + + + + + + + Returns a JobHandle to the newly created Job. + + + + + Schedule a IJobParallelForTransform job. + + + + + Returns a JobHandle to the newly created Job. + + + + + Determines what the job is used for (ParallelFor or a single job). + + + + + A parallel for job. + + + + + A single job. + + + + + ScheduleMode options for scheduling a manage job. + + + + + Schedule job as batched. + + + + + Schedule job as independent. + + + + + Performance marker used for profiling arbitrary code blocks. + + + + + Creates a helper struct for the scoped using blocks. + + + IDisposable struct which calls Begin and End automatically. + + + + + Helper IDisposable struct for use with ProfilerMarker.Auto. + + + + + Begin profiling a piece of code marked with a custom name defined by this instance of ProfilerMarker. + + Object associated with the operation. + + + + Begin profiling a piece of code marked with a custom name defined by this instance of ProfilerMarker. + + Object associated with the operation. + + + + Constructs a new performance marker for code instrumentation. + + Marker name. + + + + End profiling a piece of code marked with a custom name defined by this instance of ProfilerMarker. + + + + + Declares an assembly to be compatible (API wise) with a specific Unity API. Used by internal tools to avoid processing the assembly in order to decide whether assemblies may be using old Unity API. + + + + + Version of Unity API. + + + + + Initializes a new instance of UnityAPICompatibilityVersionAttribute. + + Unity version that this assembly with compatible with. + + + + Constants to pass to Application.RequestUserAuthorization. + + + + + Request permission to use any audio input sources attached to the computer. + + + + + Request permission to use any video input sources attached to the computer. + + + + + Representation of 2D vectors and points. + + + + + Shorthand for writing Vector2(0, -1). + + + + + Shorthand for writing Vector2(-1, 0). + + + + + Returns the length of this vector (Read Only). + + + + + Shorthand for writing Vector2(float.NegativeInfinity, float.NegativeInfinity). + + + + + Returns this vector with a magnitude of 1 (Read Only). + + + + + Shorthand for writing Vector2(1, 1). + + + + + Shorthand for writing Vector2(float.PositiveInfinity, float.PositiveInfinity). + + + + + Shorthand for writing Vector2(1, 0). + + + + + Returns the squared length of this vector (Read Only). + + + + + Shorthand for writing Vector2(0, 1). + + + + + X component of the vector. + + + + + Y component of the vector. + + + + + Shorthand for writing Vector2(0, 0). + + + + + Returns the unsigned angle in degrees between from and to. + + The vector from which the angular difference is measured. + The vector to which the angular difference is measured. + + + + Returns a copy of vector with its magnitude clamped to maxLength. + + + + + + + Constructs a new vector with given x, y components. + + + + + + + Returns the distance between a and b. + + + + + + + Dot Product of two vectors. + + + + + + + Returns true if the given vector is exactly equal to this vector. + + + + + + Converts a Vector3 to a Vector2. + + + + + + Converts a Vector2 to a Vector3. + + + + + + Linearly interpolates between vectors a and b by t. + + + + + + + + Linearly interpolates between vectors a and b by t. + + + + + + + + Returns a vector that is made from the largest components of two vectors. + + + + + + + Returns a vector that is made from the smallest components of two vectors. + + + + + + + Moves a point current towards target. + + + + + + + + Makes this vector have a magnitude of 1. + + + + + Divides a vector by a number. + + + + + + + Divides a vector by another vector. + + + + + + + Returns true if two vectors are approximately equal. + + + + + + + Subtracts one vector from another. + + + + + + + Negates a vector. + + + + + + Multiplies a vector by a number. + + + + + + + Multiplies a vector by a number. + + + + + + + Multiplies a vector by another vector. + + + + + + + Adds two vectors. + + + + + + + Returns the 2D vector perpendicular to this 2D vector. The result is always rotated 90-degrees in a counter-clockwise direction for a 2D coordinate system where the positive Y axis goes up. + + The input direction. + + The perpendicular direction. + + + + + Reflects a vector off the vector defined by a normal. + + + + + + + Multiplies two vectors component-wise. + + + + + + + Multiplies every component of this vector by the same component of scale. + + + + + + Set x and y components of an existing Vector2. + + + + + + + Returns the signed angle in degrees between from and to. + + The vector from which the angular difference is measured. + The vector to which the angular difference is measured. + + + + Gradually changes a vector towards a desired goal over time. + + The current position. + The position we are trying to reach. + The current velocity, this value is modified by the function every time you call it. + Approximately the time it will take to reach the target. A smaller value will reach the target faster. + Optionally allows you to clamp the maximum speed. + The time since the last call to this function. By default Time.deltaTime. + + + + Gradually changes a vector towards a desired goal over time. + + The current position. + The position we are trying to reach. + The current velocity, this value is modified by the function every time you call it. + Approximately the time it will take to reach the target. A smaller value will reach the target faster. + Optionally allows you to clamp the maximum speed. + The time since the last call to this function. By default Time.deltaTime. + + + + Gradually changes a vector towards a desired goal over time. + + The current position. + The position we are trying to reach. + The current velocity, this value is modified by the function every time you call it. + Approximately the time it will take to reach the target. A smaller value will reach the target faster. + Optionally allows you to clamp the maximum speed. + The time since the last call to this function. By default Time.deltaTime. + + + + Access the x or y component using [0] or [1] respectively. + + + + + Returns a nicely formatted string for this vector. + + + + + + Returns a nicely formatted string for this vector. + + + + + + Representation of 2D vectors and points using integers. + + + + + Shorthand for writing Vector2Int (0, -1). + + + + + Shorthand for writing Vector2Int (-1, 0). + + + + + Returns the length of this vector (Read Only). + + + + + Shorthand for writing Vector2Int (1, 1). + + + + + Shorthand for writing Vector2Int (1, 0). + + + + + Returns the squared length of this vector (Read Only). + + + + + Shorthand for writing Vector2Int (0, 1). + + + + + X component of the vector. + + + + + Y component of the vector. + + + + + Shorthand for writing Vector2Int (0, 0). + + + + + Converts a Vector2 to a Vector2Int by doing a Ceiling to each value. + + + + + + Clamps the Vector2Int to the bounds given by min and max. + + + + + + + Returns the distance between a and b. + + + + + + + Returns true if the objects are equal. + + + + + + Converts a Vector2 to a Vector2Int by doing a Floor to each value. + + + + + + Gets the hash code for the Vector2Int. + + + The hash code of the Vector2Int. + + + + + Converts a Vector2Int to a Vector2. + + + + + + Returns a vector that is made from the largest components of two vectors. + + + + + + + Returns a vector that is made from the smallest components of two vectors. + + + + + + + Returns true if the vectors are equal. + + + + + + + Converts a Vector2Int to a Vector3Int. + + + + + + Subtracts one vector from another. + + + + + + + Multiplies a vector by a number. + + + + + + + Multiplies a vector by a number. + + + + + + + Returns true if vectors different. + + + + + + + Adds two vectors. + + + + + + + Converts a Vector2 to a Vector2Int by doing a Round to each value. + + + + + + Multiplies two vectors component-wise. + + + + + + + Multiplies every component of this vector by the same component of scale. + + + + + + Set x and y components of an existing Vector2Int. + + + + + + + Access the x or y component using [0] or [1] respectively. + + + + + Returns a nicely formatted string for this vector. + + + + + Representation of 3D vectors and points. + + + + + Shorthand for writing Vector3(0, 0, -1). + + + + + Shorthand for writing Vector3(0, -1, 0). + + + + + Shorthand for writing Vector3(0, 0, 1). + + + + + Shorthand for writing Vector3(-1, 0, 0). + + + + + Returns the length of this vector (Read Only). + + + + + Shorthand for writing Vector3(float.NegativeInfinity, float.NegativeInfinity, float.NegativeInfinity). + + + + + Returns this vector with a magnitude of 1 (Read Only). + + + + + Shorthand for writing Vector3(1, 1, 1). + + + + + Shorthand for writing Vector3(float.PositiveInfinity, float.PositiveInfinity, float.PositiveInfinity). + + + + + Shorthand for writing Vector3(1, 0, 0). + + + + + Returns the squared length of this vector (Read Only). + + + + + Shorthand for writing Vector3(0, 1, 0). + + + + + X component of the vector. + + + + + Y component of the vector. + + + + + Z component of the vector. + + + + + Shorthand for writing Vector3(0, 0, 0). + + + + + Returns the angle in degrees between from and to. + + The vector from which the angular difference is measured. + The vector to which the angular difference is measured. + + The angle in degrees between the two vectors. + + + + + Returns a copy of vector with its magnitude clamped to maxLength. + + + + + + + Cross Product of two vectors. + + + + + + + Creates a new vector with given x, y, z components. + + + + + + + + Creates a new vector with given x, y components and sets z to zero. + + + + + + + Returns the distance between a and b. + + + + + + + Dot Product of two vectors. + + + + + + + Returns true if the given vector is exactly equal to this vector. + + + + + + Linearly interpolates between two vectors. + + + + + + + + Linearly interpolates between two vectors. + + + + + + + + Returns a vector that is made from the largest components of two vectors. + + + + + + + Returns a vector that is made from the smallest components of two vectors. + + + + + + + Calculate a position between the points specified by current and target, moving no farther than the distance specified by maxDistanceDelta. + + The position to move from. + The position to move towards. + Distance to move current per call. + + The new position. + + + + + Makes this vector have a magnitude of 1. + + + + + + Divides a vector by a number. + + + + + + + Returns true if two vectors are approximately equal. + + + + + + + Subtracts one vector from another. + + + + + + + Negates a vector. + + + + + + Multiplies a vector by a number. + + + + + + + Multiplies a vector by a number. + + + + + + + Returns true if vectors different. + + + + + + + Adds two vectors. + + + + + + + Makes vectors normalized and orthogonal to each other. + + + + + + + Makes vectors normalized and orthogonal to each other. + + + + + + + + Projects a vector onto another vector. + + + + + + + Projects a vector onto a plane defined by a normal orthogonal to the plane. + + The direction from the vector towards the plane. + The location of the vector above the plane. + + The location of the vector on the plane. + + + + + Reflects a vector off the plane defined by a normal. + + + + + + + Rotates a vector current towards target. + + The vector being managed. + The vector. + The distance between the two vectors in radians. + The length of the radian. + + The location that RotateTowards generates. + + + + + Multiplies two vectors component-wise. + + + + + + + Multiplies every component of this vector by the same component of scale. + + + + + + Set x, y and z components of an existing Vector3. + + + + + + + + Returns the signed angle in degrees between from and to. + + The vector from which the angular difference is measured. + The vector to which the angular difference is measured. + A vector around which the other vectors are rotated. + + + + Spherically interpolates between two vectors. + + + + + + + + Spherically interpolates between two vectors. + + + + + + + + Gradually changes a vector towards a desired goal over time. + + The current position. + The position we are trying to reach. + The current velocity, this value is modified by the function every time you call it. + Approximately the time it will take to reach the target. A smaller value will reach the target faster. + Optionally allows you to clamp the maximum speed. + The time since the last call to this function. By default Time.deltaTime. + + + + Gradually changes a vector towards a desired goal over time. + + The current position. + The position we are trying to reach. + The current velocity, this value is modified by the function every time you call it. + Approximately the time it will take to reach the target. A smaller value will reach the target faster. + Optionally allows you to clamp the maximum speed. + The time since the last call to this function. By default Time.deltaTime. + + + + Gradually changes a vector towards a desired goal over time. + + The current position. + The position we are trying to reach. + The current velocity, this value is modified by the function every time you call it. + Approximately the time it will take to reach the target. A smaller value will reach the target faster. + Optionally allows you to clamp the maximum speed. + The time since the last call to this function. By default Time.deltaTime. + + + + Access the x, y, z components using [0], [1], [2] respectively. + + + + + Returns a nicely formatted string for this vector. + + + + + + Returns a nicely formatted string for this vector. + + + + + + Representation of 3D vectors and points using integers. + + + + + Shorthand for writing Vector3Int (0, -1, 0). + + + + + Shorthand for writing Vector3Int (-1, 0, 0). + + + + + Returns the length of this vector (Read Only). + + + + + Shorthand for writing Vector3Int (1, 1, 1). + + + + + Shorthand for writing Vector3Int (1, 0, 0). + + + + + Returns the squared length of this vector (Read Only). + + + + + Shorthand for writing Vector3Int (0, 1, 0). + + + + + X component of the vector. + + + + + Y component of the vector. + + + + + Z component of the vector. + + + + + Shorthand for writing Vector3Int (0, 0, 0). + + + + + Converts a Vector3 to a Vector3Int by doing a Ceiling to each value. + + + + + + Clamps the Vector3Int to the bounds given by min and max. + + + + + + + Returns the distance between a and b. + + + + + + + Returns true if the objects are equal. + + + + + + Converts a Vector3 to a Vector3Int by doing a Floor to each value. + + + + + + Gets the hash code for the Vector3Int. + + + The hash code of the Vector3Int. + + + + + Converts a Vector3Int to a Vector3. + + + + + + Returns a vector that is made from the largest components of two vectors. + + + + + + + Returns a vector that is made from the smallest components of two vectors. + + + + + + + Returns true if the vectors are equal. + + + + + + + Converts a Vector3Int to a Vector2Int. + + + + + + Subtracts one vector from another. + + + + + + + Multiplies a vector by a number. + + + + + + + Multiplies a vector by a number. + + + + + + + Returns true if vectors different. + + + + + + + Adds two vectors. + + + + + + + Converts a Vector3 to a Vector3Int by doing a Round to each value. + + + + + + Multiplies two vectors component-wise. + + + + + + + Multiplies every component of this vector by the same component of scale. + + + + + + Set x, y and z components of an existing Vector3Int. + + + + + + + + Access the x, y or z component using [0], [1] or [2] respectively. + + + + + Returns a nicely formatted string for this vector. + + + + + + Returns a nicely formatted string for this vector. + + + + + + Representation of four-dimensional vectors. + + + + + Returns the length of this vector (Read Only). + + + + + Shorthand for writing Vector4(float.NegativeInfinity, float.NegativeInfinity, float.NegativeInfinity, float.NegativeInfinity). + + + + + Returns this vector with a magnitude of 1 (Read Only). + + + + + Shorthand for writing Vector4(1,1,1,1). + + + + + Shorthand for writing Vector4(float.PositiveInfinity, float.PositiveInfinity, float.PositiveInfinity, float.PositiveInfinity). + + + + + Returns the squared length of this vector (Read Only). + + + + + W component of the vector. + + + + + X component of the vector. + + + + + Y component of the vector. + + + + + Z component of the vector. + + + + + Shorthand for writing Vector4(0,0,0,0). + + + + + Creates a new vector with given x, y, z, w components. + + + + + + + + + Creates a new vector with given x, y, z components and sets w to zero. + + + + + + + + Creates a new vector with given x, y components and sets z and w to zero. + + + + + + + Returns the distance between a and b. + + + + + + + Dot Product of two vectors. + + + + + + + Returns true if the given vector is exactly equal to this vector. + + + + + + Converts a Vector4 to a Vector2. + + + + + + Converts a Vector4 to a Vector3. + + + + + + Converts a Vector2 to a Vector4. + + + + + + Converts a Vector3 to a Vector4. + + + + + + Linearly interpolates between two vectors. + + + + + + + + Linearly interpolates between two vectors. + + + + + + + + Returns a vector that is made from the largest components of two vectors. + + + + + + + Returns a vector that is made from the smallest components of two vectors. + + + + + + + Moves a point current towards target. + + + + + + + + + + + + + + Makes this vector have a magnitude of 1. + + + + + Divides a vector by a number. + + + + + + + Returns true if two vectors are approximately equal. + + + + + + + Subtracts one vector from another. + + + + + + + Negates a vector. + + + + + + Multiplies a vector by a number. + + + + + + + Multiplies a vector by a number. + + + + + + + Adds two vectors. + + + + + + + Projects a vector onto another vector. + + + + + + + Multiplies two vectors component-wise. + + + + + + + Multiplies every component of this vector by the same component of scale. + + + + + + Set x, y, z and w components of an existing Vector4. + + + + + + + + + Access the x, y, z, w components using [0], [1], [2], [3] respectively. + + + + + Return the Vector4 formatted as a string. + + + + + + Return the Vector4 formatted as a string. + + + + + + Wrapping modes for text that reaches the vertical boundary. + + + + + Text well continue to generate when reaching vertical boundary. + + + + + Text will be clipped when reaching the vertical boundary. + + + + + Types of 3D content layout within a video. + + + + + Video does not have any 3D content. + + + + + Video contains 3D content where the left eye occupies the upper half and right eye occupies the lower half of video frames. + + + + + Video contains 3D content where the left eye occupies the left half and right eye occupies the right half of video frames. + + + + + Methods used to fit a video in the target area. + + + + + Resize proportionally so that width fits the target area, cropping or adding black bars above and below if needed. + + + + + Resize proportionally so that content fits the target area, adding black bars if needed. + + + + + Resize proportionally so that content fits the target area, cropping if needed. + + + + + Resize proportionally so that height fits the target area, cropping or adding black bars on each side if needed. + + + + + Preserve the pixel size without adjusting for target area. + + + + + Resize non-proportionally to fit the target area. + + + + + Places where the audio embedded in a video can be sent. + + + + + Send the embedded audio to the associated AudioSampleProvider. + + + + + Send the embedded audio into a specified AudioSource. + + + + + Send the embedded audio direct to the platform's audio hardware. + + + + + Disable the embedded audio. + + + + + A container for video data. + + + + + Number of audio tracks in the clip. + + + + + The length of the VideoClip in frames. (Read Only). + + + + + The frame rate of the clip in frames/second. (Read Only). + + + + + The height of the images in the video clip in pixels. (Read Only). + + + + + The length of the video clip in seconds. (Read Only). + + + + + The video clip path in the project's assets. (Read Only). + + + + + Denominator of the pixel aspect ratio (num:den). (Read Only). + + + + + Numerator of the pixel aspect ratio (num:den). (Read Only). + + + + + The width of the images in the video clip in pixels. (Read Only). + + + + + The number of channels in the audio track. E.g. 2 for a stereo track. + + Index of the audio queried audio track. + + The number of channels. + + + + + Get the audio track language. Can be unknown. + + Index of the audio queried audio track. + + The abbreviated name of the language. + + + + + Get the audio track sampling rate in Hertz. + + Index of the audio queried audio track. + + The sampling rate in Hertz. + + + + + Plays video content onto a target. + + + + + Defines how the video content will be stretched to fill the target area. + + + + + Destination for the audio embedded in the video. + + + + + Number of audio tracks found in the data source currently configured. (Read Only) + + + + + Whether direct-output volume controls are supported for the current platform and video format. (Read Only) + + + + + Whether the playback speed can be changed. (Read Only) + + + + + Whether frame-skipping to maintain synchronization can be controlled. (Read Only) + + + + + Whether current time can be changed using the time or timeFrames property. (Read Only) + + + + + Whether the time source followed by the VideoPlayer can be changed. (Read Only) + + + + + Returns true if the VideoPlayer can step forward through the video content. (Read Only) + + + + + The clip being played by the VideoPlayer. + + + + + Invoked when the VideoPlayer clock is synced back to its Video.VideoTimeReference. + + + + + + The clock time that the VideoPlayer follows to schedule its samples. The clock time is expressed in seconds. (Read Only) + + + + + Number of audio tracks that this VideoPlayer will take control of. + + + + + Maximum number of audio tracks that can be controlled. (Read Only) + + + + + Errors such as HTTP connection problems are reported through this callback. + + + + + + Reference time of the external clock the Video.VideoPlayer uses to correct its drift. + + + + + The frame index of the currently available frame in VideoPlayer.texture. + + + + + Number of frames in the current video content. (Read Only) + + + + + [NOT YET IMPLEMENTED] Invoked when the video decoder does not produce a frame as per the time source during playback. + + + + + + The frame rate of the clip or URL in frames/second. (Read Only) + + + + + Invoked when a new frame is ready. + + + + + + The height of the images in the VideoClip, or URL, in pixels. (Read Only) + + + + + Determines whether the VideoPlayer restarts from the beginning when it reaches the end of the clip. + + + + + Whether playback is paused. (Read Only) + + + + + Whether content is being played. (Read Only) + + + + + Whether the VideoPlayer has successfully prepared the content to be played. (Read Only) + + + + + The length of the VideoClip, or the URL, in seconds. (Read Only) + + + + + Invoked when the VideoPlayer reaches the end of the content to play. + + + + + + Denominator of the pixel aspect ratio (num:den) for the VideoClip or the URL. (Read Only) + + + + + Numerator of the pixel aspect ratio (num:den) for the VideoClip or the URL. (Read Only) + + + + + Factor by which the basic playback rate will be multiplied. + + + + + Whether the content will start playing back as soon as the component awakes. + + + + + Invoked when the VideoPlayer preparation is complete. + + + + + + Where the video content will be drawn. + + + + + Invoke after a seek operation completes. + + + + + + Enables the frameReady events. + + + + + Whether the VideoPlayer is allowed to skip frames to catch up with current time. + + + + + The source that the VideoPlayer uses for playback. + + + + + Invoked immediately after Play is called. + + + + + + Camera component to draw to when Video.VideoPlayer.renderMode is set to either Video.VideoRenderMode.CameraFarPlane or Video.VideoRenderMode.CameraNearPlane. + + + + + Type of 3D content contained in the source video media. + + + + + Overall transparency level of the target camera plane video. + + + + + Material texture property which is targeted when Video.VideoPlayer.renderMode is set to Video.VideoTarget.MaterialOverride. + + + + + Renderer which is targeted when Video.VideoPlayer.renderMode is set to Video.VideoTarget.MaterialOverride + + + + + RenderTexture to draw to when Video.VideoPlayer.renderMode is set to Video.VideoTarget.RenderTexture. + + + + + Internal texture in which video content is placed. (Read Only) + + + + + The presentation time of the currently available frame in VideoPlayer.texture. + + + + + The clock that the Video.VideoPlayer observes to detect and correct drift. + + + + + [NOT YET IMPLEMENTED] The source used used by the VideoPlayer to derive its current time. + + + + + The file or HTTP URL that the VideoPlayer reads content from. + + + + + Determines whether the VideoPlayer will wait for the first frame to be loaded into the texture before starting playback when Video.VideoPlayer.playOnAwake is on. + + + + + The width of the images in the VideoClip, or URL, in pixels. (Read Only) + + + + + Enable/disable audio track decoding. Only effective when the VideoPlayer is not currently playing. + + Index of the audio track to enable/disable. + True for enabling the track. False for disabling the track. + + + + Delegate type for VideoPlayer events that contain an error message. + + The VideoPlayer that is emitting the event. + Message describing the error just encountered. + + + + Delegate type for all parameterless events emitted by VideoPlayers. + + The VideoPlayer that is emitting the event. + + + + Delegate type for VideoPlayer events that carry a frame number. + + The VideoPlayer that is emitting the event. + The current frame of the VideoPlayer. + + + + + The number of audio channels in the specified audio track. + + Index for the audio track being queried. + + Number of audio channels. + + + + + Returns the language code, if any, for the specified track. + + Index of the audio track to query. + + Language code. + + + + + Gets the audio track sampling rate in Hertz. + + Index of the audio track to query. + + The sampling rate in Hertz. + + + + + Gets the direct-output audio mute status for the specified track. + + + + + + Return the direct-output volume for specified track. + + Track index for which the volume is queried. + + Volume, between 0 and 1. + + + + + Gets the AudioSource that will receive audio samples for the specified track if Video.VideoPlayer.audioOutputMode is set to Video.VideoAudioOutputMode.AudioSource. + + Index of the audio track for which the AudioSource is wanted. + + The source associated with the audio track. + + + + + Whether decoding for the specified audio track is enabled. See Video.VideoPlayer.EnableAudioTrack for distinction with mute. + + Index of the audio track being queried. + + Returns true if decoding for the specified audio track is enabled. + + + + + Pauses the playback and leaves the current time intact. + + + + + Starts playback. + + + + + Initiates playback engine preparation. + + + + + Set the direct-output audio mute status for the specified track. + + Track index for which the mute is set. + Mute on/off. + + + + Set the direct-output audio volume for the specified track. + + Track index for which the volume is set. + New volume, between 0 and 1. + + + + Sets the AudioSource that will receive audio samples for the specified track if this audio target is selected with Video.VideoPlayer.audioOutputMode. + + Index of the audio track to associate with the specified AudioSource. + AudioSource to associate with the audio track. + + + + Advances the current time by one frame immediately. + + + + + Stops the playback and sets the current time to 0. + + + + + Delegate type for VideoPlayer events that carry a time position. + + The VideoPlayer that is emitting the event. + Time position. + + + + Type of destination for the images read by a VideoPlayer. + + + + + Don't draw the video content anywhere, but still make it available via the VideoPlayer's texture property in the API. + + + + + Draw video content behind a camera's Scene. + + + + + Draw video content in front of a camera's Scene. + + + + + Draw the video content into a user-specified property of the current GameObject's material. + + + + + Draw video content into a RenderTexture. + + + + + Source of the video content for a VideoPlayer. + + + + + Use the current URL as the video content source. + + + + + Use the current clip as the video content source. + + + + + The clock that the Video.VideoPlayer observes to detect and correct drift. + + + + + External reference clock the Video.VideoPlayer observes to detect and correct drift. + + + + + Disables the drift detection. + + + + + Internal reference clock the Video.VideoPlayer observes to detect and correct drift. + + + + + Time source followed by the Video.VideoPlayer when reading content. + + + + + The audio hardware clock. + + + + + The unscaled game time as defined by Time.realtimeSinceStartup. + + + + + This enum describes how the RenderTexture is used as a VR eye texture. Instead of using the values of this enum manually, use the value returned by XR.XRSettings.eyeTextureDesc|eyeTextureDesc or other VR functions returning a RenderTextureDescriptor. + + + + + The RenderTexture is not a VR eye texture. No special rendering behavior will occur. + + + + + This texture corresponds to a single eye on a stereoscopic display. + + + + + This texture corresponds to two eyes on a stereoscopic display. This will be taken into account when using Graphics.Blit and other rendering functions. + + + + + Waits until the end of the frame after Unity has rendererd every Camera and GUI, just before displaying the frame on screen. + + + + + Waits until next fixed frame rate update function. See Also: MonoBehaviour.FixedUpdate. + + + + + Suspends the coroutine execution for the given amount of seconds using scaled time. + + + + + Suspends the coroutine execution for the given amount of seconds using scaled time. + + Delay execution by the amount of time in seconds. + + + + Suspends the coroutine execution for the given amount of seconds using unscaled time. + + + + + The given amount of seconds that the yield instruction will wait for. + + + + + Creates a yield instruction to wait for a given number of seconds using unscaled time. + + + + + + Suspends the coroutine execution until the supplied delegate evaluates to true. + + + + + Initializes a yield instruction with a given delegate to be evaluated. + + Supplied delegate will be evaluated each frame after MonoBehaviour.Update and before MonoBehaviour.LateUpdate until delegate returns true. + + + + Suspends the coroutine execution until the supplied delegate evaluates to false. + + + + + Initializes a yield instruction with a given delegate to be evaluated. + + The supplied delegate will be evaluated each frame after MonoBehaviour.Update and before MonoBehaviour.LateUpdate until delegate returns false. + + + + A structure describing the webcam device. + + + + + Possible WebCamTexture resolutions for this device. + + + + + A string identifier used to create a depth data based WebCamTexture. + + + + + Returns true if the camera supports automatic focusing on points of interest and false otherwise. + + + + + True if camera faces the same direction a screen does, false otherwise. + + + + + Property of type WebCamKind denoting the kind of webcam device. + + + + + A human-readable name of the device. Varies across different systems. + + + + + Enum representing the different types of web camera device. + + + + + Camera which supports synchronized color and depth data (currently these are only dual back and true depth cameras on latest iOS devices). + + + + + A Telephoto camera device. These devices have a longer focal length than a wide-angle camera. + + + + + Wide angle (default) camera. + + + + + WebCam Textures are textures onto which the live video input is rendered. + + + + + This property allows you to set/get the auto focus point of the camera. This works only on Android and iOS devices. + + + + + Set this to specify the name of the device to use. + + + + + Return a list of available devices. + + + + + Did the video buffer update this frame? + + + + + This property is true if the texture is based on depth data. + + + + + Returns if the camera is currently playing. + + + + + Set the requested frame rate of the camera device (in frames per second). + + + + + Set the requested height of the camera device. + + + + + Set the requested width of the camera device. + + + + + Returns an clockwise angle (in degrees), which can be used to rotate a polygon so camera contents are shown in correct orientation. + + + + + Returns if the texture image is vertically flipped. + + + + + Create a WebCamTexture. + + The name of the video input device to be used. + The requested width of the texture. + The requested height of the texture. + The requested frame rate of the texture. + + + + Create a WebCamTexture. + + The name of the video input device to be used. + The requested width of the texture. + The requested height of the texture. + The requested frame rate of the texture. + + + + Create a WebCamTexture. + + The name of the video input device to be used. + The requested width of the texture. + The requested height of the texture. + The requested frame rate of the texture. + + + + Create a WebCamTexture. + + The name of the video input device to be used. + The requested width of the texture. + The requested height of the texture. + The requested frame rate of the texture. + + + + Create a WebCamTexture. + + The name of the video input device to be used. + The requested width of the texture. + The requested height of the texture. + The requested frame rate of the texture. + + + + Create a WebCamTexture. + + The name of the video input device to be used. + The requested width of the texture. + The requested height of the texture. + The requested frame rate of the texture. + + + + Returns pixel color at coordinates (x, y). + + + + + + + Get a block of pixel colors. + + + + + Get a block of pixel colors. + + + + + + + + + Returns the pixels data in raw format. + + Optional array to receive pixel data. + + + + Returns the pixels data in raw format. + + Optional array to receive pixel data. + + + + Pauses the camera. + + + + + Starts the camera. + + + + + Stops the camera. + + + + + Sets which weights to use when calculating curve segments. + + + + + Include inWeight and outWeight when calculating curve segments. + + + + + Include inWeight when calculating the previous curve segment. + + + + + Exclude both inWeight or outWeight when calculating curve segments. + + + + + Include outWeight when calculating the next curve segment. + + + + + A special collider for vehicle wheels. + + + + + Brake torque expressed in Newton metres. + + + + + The center of the wheel, measured in the object's local space. + + + + + Application point of the suspension and tire forces measured from the base of the resting wheel. + + + + + Properties of tire friction in the direction the wheel is pointing in. + + + + + Indicates whether the wheel currently collides with something (Read Only). + + + + + The mass of the wheel, expressed in kilograms. Must be larger than zero. Typical values would be in range (20,80). + + + + + Motor torque on the wheel axle expressed in Newton metres. Positive or negative depending on direction. + + + + + The radius of the wheel, measured in local space. + + + + + Current wheel axle rotation speed, in rotations per minute (Read Only). + + + + + Properties of tire friction in the sideways direction. + + + + + The mass supported by this WheelCollider. + + + + + Steering angle in degrees, always around the local y-axis. + + + + + Maximum extension distance of wheel suspension, measured in local space. + + + + + The parameters of wheel's suspension. The suspension attempts to reach a target position by applying a linear force and a damping force. + + + + + The damping rate of the wheel. Must be larger than zero. + + + + + Configure vehicle sub-stepping parameters. + + The speed threshold of the sub-stepping algorithm. + Amount of simulation sub-steps when vehicle's speed is below speedThreshold. + Amount of simulation sub-steps when vehicle's speed is above speedThreshold. + + + + Gets ground collision data for the wheel. + + + + + + Gets the world space pose of the wheel accounting for ground contact, suspension limits, steer angle, and rotation angle (angles in degrees). + + Position of the wheel in world space. + Rotation of the wheel in world space. + + + + WheelFrictionCurve is used by the WheelCollider to describe friction properties of the wheel tire. + + + + + Asymptote point slip (default 2). + + + + + Force at the asymptote slip (default 10000). + + + + + Extremum point slip (default 1). + + + + + Force at the extremum slip (default 20000). + + + + + Multiplier for the extremumValue and asymptoteValue values (default 1). + + + + + Contact information for the wheel, reported by WheelCollider. + + + + + The other Collider the wheel is hitting. + + + + + The magnitude of the force being applied for the contact. + + + + + The direction the wheel is pointing in. + + + + + Tire slip in the rolling direction. Acceleration slip is negative, braking slip is positive. + + + + + The normal at the point of contact. + + + + + The point of contact between the wheel and the ground. + + + + + The sideways direction of the wheel. + + + + + Tire slip in the sideways direction. + + + + + The wheel joint allows the simulation of wheels by providing a constraining suspension motion with an optional motor. + + + + + The current joint angle (in degrees) defined as the relative angle between the two Rigidbody2D that the joint connects to. + + + + + The current joint linear speed in meters/sec. + + + + + The current joint rotational speed in degrees/sec. + + + + + The current joint translation. + + + + + Parameters for a motor force that is applied automatically to the Rigibody2D along the line. + + + + + Set the joint suspension configuration. + + + + + Should a motor force be applied automatically to the Rigidbody2D? + + + + + Gets the motor torque of the joint given the specified timestep. + + The time to calculate the motor torque for. + + + + Exposes useful information related to crash reporting on Windows platforms. + + + + + Returns the path to the crash report folder on Windows. + + + + + Class representing cryptography algorithms. + + + + + Computes MD5 hash value for the specified byte array. + + The input to compute the hash code for. + + + + Computes SHA1 hash value for the specified byte array. + + The input to compute the hash code for. + + + + Exposes static methods for directory operations. + + + + + Returns a path to local folder. + + + + + Returns a path to roaming folder. + + + + + Returns a path to temporary folder. + + + + + Creates directory in the specified path. + + The directory path to create. + + + + Deletes a directory from a specified path. + + The name of the directory to remove. + + + + Determines whether the given path refers to an existing directory. + + The path to test. + + + + Provides static methods for file operations. + + + + + Deletes the specified file. + + The name of the file to be deleted. + + + + Determines whether the specified file exists. + + The file to check. + + + + Opens a binary file, reads the contents of the file into a byte array, and then closes the file. + + The file to open for reading. + + + + Creates a new file, writes the specified byte array to the file, and then closes the file. If the target file already exists, it is overwritten. + + The file to write to. + The bytes to write to the file. + + + + This class provides information regarding application's trial status and allows initiating application purchase. + + + + + Checks whether the application is installed in trial mode. + + + + + Attempts to purchase the app if it is in installed in trial mode. + + + Purchase receipt. + + + + + Used by KeywordRecognizer, GrammarRecognizer, DictationRecognizer. Phrases under the specified minimum level will be ignored. + + + + + High confidence level. + + + + + Low confidence level. + + + + + Medium confidence level. + + + + + Everything is rejected. + + + + + Represents the reason why dictation session has completed. + + + + + Dictation session completion was caused by bad audio quality. + + + + + Dictation session was either cancelled, or the application was paused while dictation session was in progress. + + + + + Dictation session has completed successfully. + + + + + Dictation session has finished because a microphone was not available. + + + + + Dictation session has finished because network connection was not available. + + + + + Dictation session has reached its timeout. + + + + + Dictation session has completed due to an unknown error. + + + + + DictationRecognizer listens to speech input and attempts to determine what phrase was uttered. + + + + + The time length in seconds before dictation recognizer session ends due to lack of audio input. + + + + + Create a DictationRecognizer with the specified minimum confidence and dictation topic constraint. Phrases under the specified minimum level will be ignored. + + The confidence level at which the recognizer will begin accepting phrases. + The dictation topic that this dictation recognizer should optimize its recognition for. + + + + + Create a DictationRecognizer with the specified minimum confidence and dictation topic constraint. Phrases under the specified minimum level will be ignored. + + The confidence level at which the recognizer will begin accepting phrases. + The dictation topic that this dictation recognizer should optimize its recognition for. + + + + + Create a DictationRecognizer with the specified minimum confidence and dictation topic constraint. Phrases under the specified minimum level will be ignored. + + The confidence level at which the recognizer will begin accepting phrases. + The dictation topic that this dictation recognizer should optimize its recognition for. + + + + + Create a DictationRecognizer with the specified minimum confidence and dictation topic constraint. Phrases under the specified minimum level will be ignored. + + The confidence level at which the recognizer will begin accepting phrases. + The dictation topic that this dictation recognizer should optimize its recognition for. + + + + + Event that is triggered when the recognizer session completes. + + Delegate that is to be invoked on DictationComplete event. + + + + Delegate for DictationComplete event. + + The cause of dictation session completion. + + + + Event that is triggered when the recognizer session encouters an error. + + Delegate that is to be invoked on DictationError event. + + + + Delegate for DictationError event. + + The error mesage. + HRESULT code that corresponds to the error. + + + + Event that is triggered when the recognizer changes its hypothesis for the current fragment. + + Delegate to be triggered in the event of a hypothesis changed event. + + + + Callback indicating a hypothesis change event. You should register with DictationHypothesis event. + + The text that the recognizer believes may have been recognized. + + + + Event indicating a phrase has been recognized with the specified confidence level. + + The delegate to be triggered when this event is triggered. + + + + Callback indicating a phrase has been recognized with the specified confidence level. You should register with DictationResult event. + + The recognized text. + The confidence level at which the text was recognized. + + + + Disposes the resources this dictation recognizer uses. + + + + + The time length in seconds before dictation recognizer session ends due to lack of audio input in case there was no audio heard in the current session. + + + + + Starts the dictation recognization session. Dictation recognizer can only be started if PhraseRecognitionSystem is not running. + + + + + Indicates the status of dictation recognizer. + + + + + Stops the dictation recognization session. + + + + + DictationTopicConstraint enum specifies the scenario for which a specific dictation recognizer should optimize. + + + + + Dictation recognizer will optimize for dictation scenario. + + + + + Dictation recognizer will optimize for form-filling scenario. + + + + + Dictation recognizer will optimize for web search scenario. + + + + + The GrammarRecognizer is a complement to the KeywordRecognizer. In many cases developers will find the KeywordRecognizer fills all their development needs. However, in some cases, more complex grammars will be better expressed in the form of an xml file on disk. +The GrammarRecognizer uses Extensible Markup Language (XML) elements and attributes, as specified in the World Wide Web Consortium (W3C) Speech Recognition Grammar Specification (SRGS) Version 1.0. These XML elements and attributes represent the rule structures that define the words or phrases (commands) recognized by speech recognition engines. + + + + + Creates a grammar recognizer using specified file path and minimum confidence. + + Path of the grammar file. + The confidence level at which the recognizer will begin accepting phrases. + + + + Creates a grammar recognizer using specified file path and minimum confidence. + + Path of the grammar file. + The confidence level at which the recognizer will begin accepting phrases. + + + + Returns the grammar file path which was supplied when the grammar recognizer was created. + + + + + KeywordRecognizer listens to speech input and attempts to match uttered phrases to a list of registered keywords. + + + + + Create a KeywordRecognizer which listens to specified keywords with the specified minimum confidence. Phrases under the specified minimum level will be ignored. + + The keywords that the recognizer will listen to. + The minimum confidence level of speech recognition that the recognizer will accept. + + + + Create a KeywordRecognizer which listens to specified keywords with the specified minimum confidence. Phrases under the specified minimum level will be ignored. + + The keywords that the recognizer will listen to. + The minimum confidence level of speech recognition that the recognizer will accept. + + + + Returns the list of keywords which was supplied when the keyword recognizer was created. + + + + + Phrase recognition system is responsible for managing phrase recognizers and dispatching recognition events to them. + + + + + Returns whether speech recognition is supported on the machine that the application is running on. + + + + + Delegate for OnError event. + + Error code for the error that occurred. + + + + Event that gets invoked when phrase recognition system encounters an error. + + Delegate that will be invoked when the event occurs. + + + + Event which occurs when the status of the phrase recognition system changes. + + Delegate that will be invoked when the event occurs. + + + + Attempts to restart the phrase recognition system. + + + + + Shuts phrase recognition system down. + + + + + Returns the current status of the phrase recognition system. + + + + + Delegate for OnStatusChanged event. + + The new status of the phrase recognition system. + + + + Provides information about a phrase recognized event. + + + + + A measure of correct recognition certainty. + + + + + The time it took for the phrase to be uttered. + + + + + The moment in time when uttering of the phrase began. + + + + + A semantic meaning of recognized phrase. + + + + + The text that was recognized. + + + + + A common base class for both keyword recognizer and grammar recognizer. + + + + + Disposes the resources used by phrase recognizer. + + + + + Tells whether the phrase recognizer is listening for phrases. + + + + + Event that gets fired when the phrase recognizer recognizes a phrase. + + Delegate that will be invoked when the event occurs. + + + + Delegate for OnPhraseRecognized event. + + Information about a phrase recognized event. + + + + Makes the phrase recognizer start listening to phrases. + + + + + Stops the phrase recognizer from listening to phrases. + + + + + Semantic meaning is a collection of semantic properties of a recognized phrase. These semantic properties can be specified in SRGS grammar files. + + + + + A key of semantic meaning. + + + + + Values of semantic property that the correspond to the semantic meaning key. + + + + + Represents an error in a speech recognition system. + + + + + Speech recognition engine failed because the audio quality was too low. + + + + + Speech recognition engine failed to compiled specified grammar. + + + + + Speech error occurred because a microphone was not available. + + + + + Speech error occurred due to a network failure. + + + + + No error occurred. + + + + + A speech recognition system has timed out. + + + + + Supplied grammar file language is not supported. + + + + + A speech recognition system has encountered an unknown error. + + + + + Represents the current status of the speech recognition system or a dictation recognizer. + + + + + Speech recognition system has encountered an error and is in an indeterminate state. + + + + + Speech recognition system is running. + + + + + Speech recognition system is stopped. + + + + + Wind Zones add realism to the trees you create by making them wave their branches and leaves as if blown by the wind. + + + + + Defines the type of wind zone to be used (Spherical or Directional). + + + + + Radius of the Spherical Wind Zone (only active if the WindZoneMode is set to Spherical). + + + + + The primary wind force. + + + + + Defines the frequency of the wind changes. + + + + + Defines how much the wind changes over time. + + + + + The turbulence wind force. + + + + + The constructor. + + + + + Modes a Wind Zone can have, either Spherical or Directional. + + + + + Wind zone affects the entire Scene in one direction. + + + + + Wind zone only has an effect inside the radius, and has a falloff from the center towards the edge. + + + + + Determines how time is treated outside of the keyframed range of an AnimationClip or AnimationCurve. + + + + + Plays back the animation. When it reaches the end, it will keep playing the last frame and never stop playing. + + + + + Reads the default repeat mode set higher up. + + + + + When time reaches the end of the animation clip, time will continue at the beginning. + + + + + When time reaches the end of the animation clip, the clip will automatically stop playing and time will be reset to beginning of the clip. + + + + + When time reaches the end of the animation clip, time will ping pong back between beginning and end. + + + + + Delegate that can be invoked on specific thread. + + + + + Provides essential methods related to Window Store application. + + + + + Advertising ID. + + + + + Arguments passed to application. + + + + + Fired when application window is activated. + + + + + + Fired when window size changes. + + + + + + Executes callback item on application thread. + + Item to execute. + Wait until item is executed. + + + + Executes callback item on UI thread. + + Item to execute. + Wait until item is executed. + + + + Returns true if you're running on application thread. + + + + + Returns true if you're running on UI thread. + + + + + [OBSOLETE] Tries to execute callback item on application thread. + + Item to execute. + Wait until item is executed. + + + + [OBSOLETE] Tries to execute callback item on UI thread. + + Item to execute. + Wait until item is executed. + + + + Cursor API for Windows Store Apps. + + + + + Set a custom cursor. + + The cursor resource id. + + + + List of accessible folders on Windows Store Apps. + + + + + Class which is capable of launching user's default app for file type or a protocol. See also PlayerSettings where you can specify file or URI associations. + + + + + Launches the default app associated with specified file. + + Folder type where the file is located. + Relative file path inside the specified folder. + Shows user a warning that application will be switched. + + + + Opens a dialog for picking the file. + + File extension. + + + + Starts the default app associated with the URI scheme name for the specified URI, using the specified options. + + The URI. + Displays a warning that the URI is potentially unsafe. + + + + Defines the default look of secondary tile. + + + + + + Arguments to be passed for application when secondary tile is activated. + + + + + Defines background color for secondary tile. + + + + + + Defines, whether backgroundColor should be used. + + + + + + Display name for secondary tile. + + + + + + Defines the style for foreground text on a secondary tile. + + + + + + Uri to logo, shown for secondary tile on lock screen. + + + + + + Whether to show secondary tile on lock screen. + + + + + + Phonetic name for secondary tile. + + + + + + Defines whether secondary tile is copied to another device when application is installed by the same users account. + + + + + + Defines whether the displayName should be shown on a medium secondary tile. + + + + + + Defines whether the displayName should be shown on a large secondary tile. + + + + + + Defines whether the displayName should be shown on a wide secondary tile. + + + + + + Uri to the logo for medium size tile. + + + + + Uri to the logo shown on tile + + + + + + Uri to the logo for large size tile. + + + + + + Uri to the logo for small size tile. + + + + + + Unique identifier within application for a secondary tile. + + + + + + Uri to the logo for wide tile. + + + + + Constructor for SecondaryTileData, sets default values for all members. + + Unique identifier for secondary tile. + A display name for a tile. + + + + Represents tile on Windows start screen + + + + + + Whether secondary tile is pinned to start screen. + + + + + + Whether secondary tile was approved (pinned to start screen) or rejected by user. + + + + + + A unique string, identifying secondary tile + + + + + Returns applications main tile + + + + + + Creates new or updates existing secondary tile. + + The data used to create or update secondary tile. + The coordinates for a request to create new tile. + The area on the screen above which the request to create new tile will be displayed. + + New Tile object, that can be used for further work with the tile. + + + + + Creates new or updates existing secondary tile. + + The data used to create or update secondary tile. + The coordinates for a request to create new tile. + The area on the screen above which the request to create new tile will be displayed. + + New Tile object, that can be used for further work with the tile. + + + + + Creates new or updates existing secondary tile. + + The data used to create or update secondary tile. + The coordinates for a request to create new tile. + The area on the screen above which the request to create new tile will be displayed. + + New Tile object, that can be used for further work with the tile. + + + + + Show a request to unpin secondary tile from start screen. + + The coordinates for a request to unpin tile. + The area on the screen above which the request to unpin tile will be displayed. + + + + Show a request to unpin secondary tile from start screen. + + The coordinates for a request to unpin tile. + The area on the screen above which the request to unpin tile will be displayed. + + + + Show a request to unpin secondary tile from start screen. + + The coordinates for a request to unpin tile. + The area on the screen above which the request to unpin tile will be displayed. + + + + Show a request to unpin secondary tile from start screen. + + An identifier for secondary tile. + The coordinates for a request to unpin tile. + The area on the screen above which the request to unpin tile will be displayed. + + + + Show a request to unpin secondary tile from start screen. + + An identifier for secondary tile. + The coordinates for a request to unpin tile. + The area on the screen above which the request to unpin tile will be displayed. + + + + Show a request to unpin secondary tile from start screen. + + An identifier for secondary tile. + The coordinates for a request to unpin tile. + The area on the screen above which the request to unpin tile will be displayed. + + + + Whether secondary tile is pinned to start screen. + + An identifier for secondary tile. + + + + Gets all secondary tiles. + + + An array of Tile objects. + + + + + Returns the secondary tile, identified by tile id. + + A tile identifier. + + A Tile object or null if secondary tile does not exist (not pinned to start screen and user request is complete). + + + + + Get template XML for tile notification. + + A template identifier. + + String, which is an empty XML document to be filled and used for tile notification. + + + + + Starts periodic update of a badge on a tile. + + + A remote location from where to retrieve tile update + A time interval in minutes, will be rounded to a value, supported by the system + + + + Starts periodic update of a tile. + + + a remote location fromwhere to retrieve tile update + a time interval in minutes, will be rounded to a value, supported by the system + + + + Remove badge from tile. + + + + + Stops previously started periodic update of a tile. + + + + + Stops previously started periodic update of a tile. + + + + + Send a notification for tile (update tiles look). + + A string containing XML document for new tile look. + An uri to 150x150 image, shown on medium tile. + An uri to a 310x150 image to be shown on a wide tile (if such issupported). + An uri to a 310x310 image to be shown on a large tile (if such is supported). + A text to shown on a tile. + + + + Send a notification for tile (update tiles look). + + A string containing XML document for new tile look. + An uri to 150x150 image, shown on medium tile. + An uri to a 310x150 image to be shown on a wide tile (if such issupported). + An uri to a 310x310 image to be shown on a large tile (if such is supported). + A text to shown on a tile. + + + + Sets or updates badge on a tile to an image. + + Image identifier. + + + + Set or update a badge on a tile to a number. + + Number to be shown on a badge. + + + + Style for foreground text on a secondary tile. + + + + + Templates for various tile styles. + + + + + + Represents a toast notification in Windows Store Apps. + + + + + + true if toast was activated by user. + + + + + Arguments to be passed for application when toast notification is activated. + + + + + true if toast notification was dismissed (for any reason). + + + + + true if toast notification was explicitly dismissed by user. + + + + + Create toast notification. + + XML document with tile data. + Uri to image to show on a toast, can be empty, in that case text-only notification will be shown. + A text to display on a toast notification. + + A toast object for further work with created notification or null, if creation of toast failed. + + + + + Create toast notification. + + XML document with tile data. + Uri to image to show on a toast, can be empty, in that case text-only notification will be shown. + A text to display on a toast notification. + + A toast object for further work with created notification or null, if creation of toast failed. + + + + + Get template XML for toast notification. + + + A template identifier. + + string, which is an empty XML document to be filled and used for toast notification. + + + + + Hide displayed toast notification. + + + + + Show toast notification. + + + + + Templates for various toast styles. + + + + + + This event occurs when window completes activation or deactivation, it also fires up when you snap and unsnap the application. + + + + + + Specifies the set of reasons that a windowActivated event was raised. + + + + + The window was activated. + + + + + The window was deactivated. + + + + + The window was activated by pointer interaction. + + + + + This event occurs when window rendering size changes. + + + + + + + Simple access to web pages. + + + + + Streams an AssetBundle that can contain any kind of asset from the project folder. + + + + + Returns a AudioClip generated from the downloaded data (Read Only). + + + + + Returns the contents of the fetched web page as a byte array (Read Only). + + + + + The number of bytes downloaded by this WWW query (read only). + + + + + Returns an error message if there was an error during the download (Read Only). + + + + + Is the download already finished? (Read Only) + + + + + Returns a MovieTexture generated from the downloaded data (Read Only). + + + + + Load an Ogg Vorbis file into the audio clip. + + + + + How far has the download progressed (Read Only). + + + + + Dictionary of headers returned by the request. + + + + + Returns the contents of the fetched web page as a string (Read Only). + + + + + Returns a Texture2D generated from the downloaded data (Read Only). + + + + + Returns a non-readable Texture2D generated from the downloaded data (Read Only). + + + + + Obsolete, has no effect. + + + + + How far has the upload progressed (Read Only). + + + + + The URL of this WWW request (Read Only). + + + + + Creates a WWW request with the given URL. + + The url to download. Must be '%' escaped. + + A new WWW object. When it has been downloaded, the results can be fetched from the returned object. + + + + + Creates a WWW request with the given URL. + + The url to download. Must be '%' escaped. + A WWWForm instance containing the form data to post. + + A new WWW object. When it has been downloaded, the results can be fetched from the returned object. + + + + + Creates a WWW request with the given URL. + + The url to download. Must be '%' escaped. + A byte array of data to be posted to the url. + + A new WWW object. When it has been downloaded, the results can be fetched from the returned object. + + + + + Creates a WWW request with the given URL. + + The url to download. Must be '%' escaped. + A byte array of data to be posted to the url. + A hash table of custom headers to send with the request. + + A new WWW object. When it has been downloaded, the results can be fetched from the returned object. + + + + + Creates a WWW request with the given URL. + + The url to download. Must be '%' escaped. + A byte array of data to be posted to the url. + A dictionary that contains the header keys and values to pass to the server. + + A new WWW object. When it has been downloaded, the results can be fetched from the returned object. + + + + + Disposes of an existing WWW object. + + + + + Escapes characters in a string to ensure they are URL-friendly. + + A string with characters to be escaped. + The text encoding to use. + + + + Escapes characters in a string to ensure they are URL-friendly. + + A string with characters to be escaped. + The text encoding to use. + + + + Returns an AudioClip generated from the downloaded data (Read Only). + + Use this to specify whether the clip should be a 2D or 3D clip +the .audioClip property defaults to 3D. + Sets whether the clip should be completely downloaded before it's ready to play (false) or the stream can be played even if only part of the clip is downloaded (true). +The latter will disable seeking on the clip (with .time and/or .timeSamples). + The AudioType of the content you are downloading. If this is not set Unity will try to determine the type from URL. + + The returned AudioClip. + + + + + Returns an AudioClip generated from the downloaded data (Read Only). + + Use this to specify whether the clip should be a 2D or 3D clip +the .audioClip property defaults to 3D. + Sets whether the clip should be completely downloaded before it's ready to play (false) or the stream can be played even if only part of the clip is downloaded (true). +The latter will disable seeking on the clip (with .time and/or .timeSamples). + The AudioType of the content you are downloading. If this is not set Unity will try to determine the type from URL. + + The returned AudioClip. + + + + + Returns an AudioClip generated from the downloaded data (Read Only). + + Use this to specify whether the clip should be a 2D or 3D clip +the .audioClip property defaults to 3D. + Sets whether the clip should be completely downloaded before it's ready to play (false) or the stream can be played even if only part of the clip is downloaded (true). +The latter will disable seeking on the clip (with .time and/or .timeSamples). + The AudioType of the content you are downloading. If this is not set Unity will try to determine the type from URL. + + The returned AudioClip. + + + + + Returns an AudioClip generated from the downloaded data that is compressed in memory (Read Only). + + Use this to specify whether the clip should be a 2D or 3D clip. + The AudioType of the content your downloading. If this is not set Unity will try to determine the type from URL. + + The returned AudioClip. + + + + + Returns an AudioClip generated from the downloaded data that is compressed in memory (Read Only). + + Use this to specify whether the clip should be a 2D or 3D clip. + The AudioType of the content your downloading. If this is not set Unity will try to determine the type from URL. + + The returned AudioClip. + + + + + Returns an AudioClip generated from the downloaded data that is compressed in memory (Read Only). + + Use this to specify whether the clip should be a 2D or 3D clip. + The AudioType of the content your downloading. If this is not set Unity will try to determine the type from URL. + + The returned AudioClip. + + + + + MovieTexture has been deprecated. Refer to the new movie playback solution VideoPlayer. + + + + + Loads an AssetBundle with the specified version number from the cache. If the AssetBundle is not currently cached, it will automatically be downloaded and stored in the cache for future retrieval from local storage. + + The URL to download the AssetBundle from, if it is not present in the cache. Must be '%' escaped. + Version of the AssetBundle. The file will only be loaded from the disk cache if it has previously been downloaded with the same version parameter. By incrementing the version number requested by your application, you can force Caching to download a new copy of the AssetBundle from url. + Hash128 which is used as the version of the AssetBundle. + A structure used to download a given version of AssetBundle to a customized cache path. + +Analogous to the cachedAssetBundle parameter for UnityWebRequestAssetBundle.GetAssetBundle.</param> + An optional CRC-32 Checksum of the uncompressed contents. If this is non-zero, then the content will be compared against the checksum before loading it, and give an error if it does not match. You can use this to avoid data corruption from bad downloads or users tampering with the cached files on disk. If the CRC does not match, Unity will try to redownload the data, and if the CRC on the server does not match it will fail with an error. Look at the error string returned to see the correct CRC value to use for an AssetBundle. + + A WWW instance, which can be used to access the data once the load/download operation is completed. + + + + + Loads an AssetBundle with the specified version number from the cache. If the AssetBundle is not currently cached, it will automatically be downloaded and stored in the cache for future retrieval from local storage. + + The URL to download the AssetBundle from, if it is not present in the cache. Must be '%' escaped. + Version of the AssetBundle. The file will only be loaded from the disk cache if it has previously been downloaded with the same version parameter. By incrementing the version number requested by your application, you can force Caching to download a new copy of the AssetBundle from url. + Hash128 which is used as the version of the AssetBundle. + A structure used to download a given version of AssetBundle to a customized cache path. + +Analogous to the cachedAssetBundle parameter for UnityWebRequestAssetBundle.GetAssetBundle.</param> + An optional CRC-32 Checksum of the uncompressed contents. If this is non-zero, then the content will be compared against the checksum before loading it, and give an error if it does not match. You can use this to avoid data corruption from bad downloads or users tampering with the cached files on disk. If the CRC does not match, Unity will try to redownload the data, and if the CRC on the server does not match it will fail with an error. Look at the error string returned to see the correct CRC value to use for an AssetBundle. + + A WWW instance, which can be used to access the data once the load/download operation is completed. + + + + + Loads an AssetBundle with the specified version number from the cache. If the AssetBundle is not currently cached, it will automatically be downloaded and stored in the cache for future retrieval from local storage. + + The URL to download the AssetBundle from, if it is not present in the cache. Must be '%' escaped. + Version of the AssetBundle. The file will only be loaded from the disk cache if it has previously been downloaded with the same version parameter. By incrementing the version number requested by your application, you can force Caching to download a new copy of the AssetBundle from url. + Hash128 which is used as the version of the AssetBundle. + A structure used to download a given version of AssetBundle to a customized cache path. + +Analogous to the cachedAssetBundle parameter for UnityWebRequestAssetBundle.GetAssetBundle.</param> + An optional CRC-32 Checksum of the uncompressed contents. If this is non-zero, then the content will be compared against the checksum before loading it, and give an error if it does not match. You can use this to avoid data corruption from bad downloads or users tampering with the cached files on disk. If the CRC does not match, Unity will try to redownload the data, and if the CRC on the server does not match it will fail with an error. Look at the error string returned to see the correct CRC value to use for an AssetBundle. + + A WWW instance, which can be used to access the data once the load/download operation is completed. + + + + + Loads an AssetBundle with the specified version number from the cache. If the AssetBundle is not currently cached, it will automatically be downloaded and stored in the cache for future retrieval from local storage. + + The URL to download the AssetBundle from, if it is not present in the cache. Must be '%' escaped. + Version of the AssetBundle. The file will only be loaded from the disk cache if it has previously been downloaded with the same version parameter. By incrementing the version number requested by your application, you can force Caching to download a new copy of the AssetBundle from url. + Hash128 which is used as the version of the AssetBundle. + A structure used to download a given version of AssetBundle to a customized cache path. + +Analogous to the cachedAssetBundle parameter for UnityWebRequestAssetBundle.GetAssetBundle.</param> + An optional CRC-32 Checksum of the uncompressed contents. If this is non-zero, then the content will be compared against the checksum before loading it, and give an error if it does not match. You can use this to avoid data corruption from bad downloads or users tampering with the cached files on disk. If the CRC does not match, Unity will try to redownload the data, and if the CRC on the server does not match it will fail with an error. Look at the error string returned to see the correct CRC value to use for an AssetBundle. + + A WWW instance, which can be used to access the data once the load/download operation is completed. + + + + + Replaces the contents of an existing Texture2D with an image from the downloaded data. + + An existing texture object to be overwritten with the image data. + + + + + Converts URL-friendly escape sequences back to normal text. + + A string containing escaped characters. + The text encoding to use. + + + + Converts URL-friendly escape sequences back to normal text. + + A string containing escaped characters. + The text encoding to use. + + + + Helper class to generate form data to post to web servers using the UnityWebRequest or WWW classes. + + + + + (Read Only) The raw data to pass as the POST request body when sending the form. + + + + + (Read Only) Returns the correct request headers for posting the form using the WWW class. + + + + + Add binary data to the form. + + + + + + + + + Add binary data to the form. + + + + + + + + + Add binary data to the form. + + + + + + + + + Add a simple field to the form. + + + + + + + + Add a simple field to the form. + + + + + + + + Adds a simple field to the form. + + + + + + + Creates an empty WWWForm object. + + + + + Class used to override a camera's default background rendering path to instead render a given Texture and/or Material. This will typically be used with images from the color camera for rendering the AR background on mobile devices. + + + + + The Material used for AR rendering. + + + + + Called when any of the public properties of this class have been changed. + + + + + + An optional Texture used for AR rendering. If this property is not set then the texture set in XR.ARBackgroundRenderer._backgroundMaterial as "_MainTex" is used. + + + + + An optional Camera whose background rendering will be overridden by this class. If this property is not set then the main Camera in the Scene is used. + + + + + When set to XR.ARRenderMode.StandardBackground (default) the camera is not overridden to display the background image. Setting this property to XR.ARRenderMode.MaterialAsBackground will render the texture specified by XR.ARBackgroundRenderer._backgroundMaterial and or XR.ARBackgroundRenderer._backgroundTexture as the background. + + + + + Disables AR background rendering. This method is called internally but can be overridden by users who wish to subclass XR.ARBackgroundRenderer to customize handling of AR background rendering. + + + + + Enumeration describing the AR rendering mode used with XR.ARBackgroundRenderer. + + + + + The material associated with XR.ARBackgroundRenderer is being rendered as the background. + + + + + The standard background is rendered. (Skybox, Solid Color, etc.) + + + + + Enumeration of available modes for XR rendering in the Game view or in the main window on a host PC. XR rendering only occurs when the Unity Editor is in Play Mode. + + + + + Renders both eyes of the XR device side-by-side in the Game view or in the main window on a host PC. + + + + + Renders the left eye of the XR device in the Game View window or in main window on a host PC. + + + + + Renders both eyes of the XR device, and the occlusion mesh, side-by-side in the Game view or in the main window on a host PC. + + + + + Renders the right eye of the XR device in the Game View window or in main window on a host PC. + + + + + Describes the haptic capabilities of the device at an XR.XRNode in the XR input subsystem. + + + + + The frequency (in Hz) that this device plays back buffered haptic data. + + + + + The number of channels that this device plays back haptic data. + + + + + True if this device supports sending a haptic buffer. + + + + + True if this device supports sending a haptic impulse. + + + + + Defines an input device in the XR input subsystem. + + + + + true if the device is currently a valid input device; otherwise false. + + + + + Sends a raw buffer of haptic data to the device. + + The channel to receive the data. + A raw byte buffer that contains the haptic data to send to the device. + + true if successful; otherwise false. + + + + + Sends a haptic impulse to a device. + + The channel to receive the impulse. + The normalized (0.0 to 1.0) amplitude value of the haptic impulse to play on the device. + The duration in seconds that the haptic impulse will play. Only supported on Oculus. + + true if successful; otherwise false. + + + + + Stop all haptic playback for a device. + + + + + Gets the haptic capabilities of the device. + + A HapticCapabilities struct to receive the capabilities of this device. + + true if device can be queried, false otherwise. + + + + + An interface for accessing devices in the XR input subsytem. + + + + + Gets the input device at a given XR.XRNode endpoint. + + The XRNode that owns the requested device. + + An XR.InputDevice at this [[XR.XRNode]. + + + + + A collection of methods and properties for interacting with the XR tracking system. + + + + + Disables positional tracking in XR. This takes effect the next time the head pose is sampled. If set to true the camera only tracks headset rotation state. + + + + + Called when a tracked node is added to the underlying XR system. + + Describes the node that has been added. + + + + + Called when a tracked node is removed from the underlying XR system. + + Describes the node that has been removed. + + + + + Called when a tracked node begins reporting tracking information. + + Describes the node that has begun being tracked. + + + + + Called when a tracked node stops reporting tracking information. + + Describes the node that has lost tracking. + + + + + Gets the position of a specific node. + + Specifies which node's position should be returned. + + The position of the node in its local tracking space. + + + + + Gets the rotation of a specific node. + + Specifies which node's rotation should be returned. + + The rotation of the node in its local tracking space. + + + + + Accepts the unique identifier for a tracked node and returns a friendly name for it. + + The unique identifier for the Node index. + + + The name of the tracked node if the given 64-bit identifier maps to a currently tracked node. Empty string otherwise. + + + + + Describes all currently connected XRNodes and provides available tracking states for each. + + A list that is populated with XR.XRNodeState objects. + + + + Center tracking to the current position and orientation of the HMD. + + + + + Represents how the device is reporting pose data. + + + + + Represents a Device relative tracking origin. A Device relative tracking origin defines a Local Origin at the position of the device in space at some previous point in time, usually at a recenter event, power-on or AR/VR session start. Pose data provided by the device will be in this space relative to the local origin. This means that poses returned in this mode will not include the user height (for VR) or the device height (for AR) and any camera tracking from the XR Device will need to be manually offset accordingly. + + + + + Represents the tracking origin whereby 0,0,0 is on the "floor" or other surface determined by the XR Device being used. The pose values reported by an XR Device in this mode will include the height of the XR Device above this surface, removing the need to offset the position of the camera tracking the XR Device by the height of the user (VR) or the height of the device above the floor (AR). + + + + + This indicates that the device does not know, or is unable to determine how it is reporting pose data. This value should be treated as an error condition. + + + + + Represents the size of physical space available for XR. + + + + + Represents a space large enough for free movement. + + + + + Represents a small space where movement may be constrained or positional tracking is unavailable. + + + + + Represents the current user presence state detected by the device. + + + + + The device does not detect that the user is present. + + + + + The device detects that the user is present. + + + + + The device is currently in a state where it cannot determine user presence. + + + + + The device does not support detecting user presence. + + + + + he Holographic Remoting interface allows you to connect an application to a remote holographic device, and stream data between the application and that device. + + + + + Whether the app is displaying protected content. + + + + + The Holographic Settings contain functions which effect the performance and presentation of Holograms on Windows Holographic platforms. + + + + + Option to allow developers to achieve higher framerate at the cost of high latency. By default this option is off. + + True to enable or false to disable Low Latent Frame Presentation. + + + + Represents the kind of reprojection an app is requesting to stabilize its holographic rendering relative to the user's head motion. + + + + + The image should not be stabilized for the user's head motion, instead remaining fixed in the display. This is generally discouraged, as it is only comfortable for users when used sparingly, such as when the only visible content is a small cursor. + + + + + The image should be stabilized only for changes to the user's head orientation, ignoring positional changes. This is best for body-locked content that should tag along with the user as they walk around, such as 360-degree video. + + + + + The image should be stabilized for changes to both the user's head position and orientation. This is best for world-locked content that should remain physically stationary as the user walks around. + + + + + Whether the app is displaying protected content. + + + + + This method returns whether or not the display associated with the main camera reports as opaque. + + + + + Returns true if Holographic rendering is currently running with Latent Frame Presentation. Default value is false. + + + + + The kind of reprojection the app is requesting to stabilize its holographic rendering relative to the user's head motion. + + + + + Sets a point in 3d space that is the focal point of the Scene for the user for this frame. This helps improve the visual fidelity of content around this point. This must be set every frame. + + The position of the focal point in the Scene, relative to the camera. + Surface normal of the plane being viewed at the focal point. + A vector that describes how the focus point is moving in the Scene at this point in time. This allows the HoloLens to compensate for both your head movement and the movement of the object in the Scene. + + + + Sets a point in 3d space that is the focal point of the Scene for the user for this frame. This helps improve the visual fidelity of content around this point. This must be set every frame. + + The position of the focal point in the Scene, relative to the camera. + Surface normal of the plane being viewed at the focal point. + A vector that describes how the focus point is moving in the Scene at this point in time. This allows the HoloLens to compensate for both your head movement and the movement of the object in the Scene. + + + + Sets a point in 3d space that is the focal point of the Scene for the user for this frame. This helps improve the visual fidelity of content around this point. This must be set every frame. + + The position of the focal point in the Scene, relative to the camera. + Surface normal of the plane being viewed at the focal point. + A vector that describes how the focus point is moving in the Scene at this point in time. This allows the HoloLens to compensate for both your head movement and the movement of the object in the Scene. + + + + Enum indicating the reason why connection to remote device has failed. + + + + + Enum indicating the reason why remote connection failed. + + + + + Handskahe failed while traying to establish connection with remote device. + + + + + No failure. + + + + + Protocol used by the app does not match remoting app running on remote device. + + + + + Couldn't identify the reason why connection failed. + + + + + Remove device is not reachable. + + + + + Current state of the holographis streamer remote connection. + + + + + Indicates app being connected to remote device. + + + + + Indicates app trying to connect to remote device. + + + + + Indicates app being currently disconnected from any other remote device. + + + + + Contains fields that are relevant during an error event. + + + + + A readable error string (when possible). + + + + + The HRESULT code from the platform. + + + + + Manager class with API for recognizing user gestures. + + + + + Cancels any pending gesture events. Additionally this will call StopCapturingGestures. + + + + + Create a GestureRecognizer. + + + + + Disposes the resources used by gesture recognizer. + + + + + Fires when Microsoft's gesture-recognition system encounters a warning or error. + + + + + + Callback indicating an error or warning occurred. + + A readable error string (when possible). + The HRESULT code from the platform. + + + + Fired when a warning or error is emitted by the GestureRecognizer. + + Delegate to be triggered to report warnings and errors. + + + + Retrieve a mask of the currently enabled gestures. + + + A mask indicating which Gestures are currently recognizable. + + + + + Fires when Microsoft's gesture-recognition system recognizers that a user has canceled a hold gesture. + + + + + + Fired when the user does a cancel event either using their hands or in speech. + + Delegate to be triggered when a cancel event is triggered. + + + + Callback indicating a cancel event. + + Indicates which input medium triggered this event. + Ray (with normalized direction) from user at the time this gesture began. + + + + Fires when Microsoft's gesture-recognition system recognizers that a user has completed a hold gesture. + + + + + + Fired when users complete a hold gesture. + + Delegate to be triggered when the user completes a hold gesture. + + + + Callback indicating a hold completed event. + + Indicates which input medium triggered this event. + Ray (with normalized direction) from user at the time this gesture began. + + + + Fires when Microsoft's gesture-recognition system recognizes that a user has started a hold gesture. + + + + + + Fired when users start a hold gesture. + + The delegate to be triggered when a user starts a hold gesture. + + + + Callback indicating a hold started event. + + Indicates which input medium triggered this event. + Ray (with normalized direction) from user at the time this gesture began. + + + + Used to query if the GestureRecognizer is currently receiving Gesture events. + + + True if the GestureRecognizer is receiving events or false otherwise. + + + + + Fires when Microsoft's gesture-recognition system recognizes that a user has canceled a manipulation gesture. + + + + + + Fires when a Manipulation gesture is canceled. + + Delegate to be triggered when a cancel event is triggered. + + + + Callback indicating a cancel event. + + Indicates which input medium triggered this event. + Total distance moved since the beginning of the manipulation gesture. + Ray (with normalized direction) from user at the time this gesture began. + + + + Fires when Microsoft's gesture-recognition system recognizes that a user has completed a manipulation gesture. + + + + + + Fires when a Manipulation gesture is completed. + + Delegate to be triggered when a completed event is triggered. + + + + Callback indicating a completed event. + + Indicates which input medium triggered this event. + Total distance moved since the beginning of the manipulation gesture. + Ray (with normalized direction) from user at the time this gesture began. + + + + Fires when Microsoft's gesture-recognition system recognizes that a user has started a manipulation gesture. + + + + + + Fires when an interaction becomes a Manipulation gesture. + + Delegate to be triggered when a started event is triggered. + + + + Callback indicating a started event. + + Indicates which input medium triggered this event. + Total distance moved since the beginning of the manipulation gesture. + Ray (with normalized direction) from user at the time this gesture began. + + + + Fires when Microsoft's gesture-recognition system recognizes that a user has updated a manipulation gesture. + + + + + + Fires when a Manipulation gesture is updated due to hand movement. + + Delegate to be triggered when a updated event is triggered. + + + + Callback indicating a updated event. + + Indicates which input medium triggered this event. + Total distance moved since the beginning of the manipulation gesture. + Ray (with normalized direction) from user at the time this gesture began. + + + + Fires when Microsoft's gesture-recognition system recognizes that a user has canceled a navigation gesture. + + + + + + Fires when a Navigation gesture is canceled. + + Delegate to be triggered when a cancel event is triggered. + + + + Callback indicating a cancel event. + + Indicates which input medium triggered this event. + The last known normalized offset of the input within the unit cube for the navigation gesture. + Ray (with normalized direction) from user at the time this gesture began. + + + + Fires when Microsoft's gesture-recognition system recognizes that a navigation gesture completes. + + + + + + Fires when a Navigation gesture is completed. + + Delegate to be triggered when a complete event is triggered. + + + + Callback indicating a completed event. + + Indicates which input medium triggered this event. + The last known normalized offset, since the navigation gesture began, of the input within the unit cube for the navigation gesture. + Ray (with normalized direction) from user at the time this gesture began. + + + + Fires when Microsoft's gesture-recognition system recognizes that a user has started a navigation gesture. + + + + + + Fires when an interaction becomes a Navigation gesture. + + Delegate to be triggered when a started event is triggered. + + + + Callback indicating a started event. + + Indicates which input medium triggered this event. + The normalized offset, since the navigation gesture began, of the input within the unit cube for the navigation gesture. + Ray (with normalized direction) from user at the time this gesture began. + + + + Fires when Microsoft's gesture-recognition system recognizes that navigation gesture has updated. + + + + + + Fires when a Navigation gesture is updated due to hand or controller movement. + + Delegate to be triggered when a update event is triggered. + + + + Callback indicating a update event. + + Indicates which input medium triggered this event. + The last known normalized offset, since the navigation gesture began, of the input within the unit cube for the navigation gesture. + Ray (with normalized direction) from user at the time this gesture began. + + + + Fires when recognition of gestures is done, either due to completion of a gesture or cancellation. + + + + + + Fires when recognition of gestures is done, either due to completion of a gesture or cancellation. + + Delegate to be triggered when an end event is triggered. + + + + Callback indicating the gesture event has completed. + + Indicates which input medium triggered this event. + Ray (with normalized direction) from user at the time a gesture began. + + + + Fires when recognition of gestures begins. + + + + + + Fires when recognition of gestures begins. + + Delegate to be triggered when a start event is triggered. + + + + Callback indicating the gesture event has started. + + Indicates which input medium triggered this event. + Ray (with normalized direction) from user at the time a gesture began. + + + + Set the recognizable gestures to the ones specified in newMaskValues and return the old settings. + + A mask indicating which gestures are now recognizable. + + The previous value. + + + + + Call to begin receiving gesture events on this recognizer. No events will be received until this method is called. + + + + + Call to stop receiving gesture events on this recognizer. + + + + + Fires when Microsoft's gesture-recognition system recognizes that a user has done a tap gesture and after the system voice command "Select" has been processed. For controllers, this event fires when the primary button is released after it was pressed. + + + + + + Occurs when a Tap gesture is recognized. + + Delegate to be triggered when a tap event is triggered. + + + + Callback indicating a tap event. + + Indicates which input medium triggered this event. + The count of taps (1 for single tap, 2 for double tap). + Ray (with normalized direction) from user at the time this event interaction began. + + + + This enumeration represents the set of gestures that may be recognized by GestureRecognizer. + + + + + Enable support for the double-tap gesture. + + + + + Enable support for the hold gesture. + + + + + Enable support for the manipulation gesture which tracks changes to the hand's position. This gesture is relative to the start position of the gesture and measures an absolute movement through the world. + + + + + Enable support for the navigation gesture, in the horizontal axis using rails (guides). + + + + + Enable support for the navigation gesture, in the vertical axis using rails (guides). + + + + + Enable support for the navigation gesture, in the depth axis using rails (guides). + + + + + Enable support for the navigation gesture, in the horizontal axis. + + + + + Enable support for the navigation gesture, in the vertical axis. + + + + + Enable support for the navigation gesture, in the depth axis. + + + + + Disable support for gestures. + + + + + Enable support for the tap gesture. + + + + + Contains fields that are relevant when a user cancels a hold gesture. + + + + + Head pose of the user at the time of the gesture. + + + + + The InteractionSource (hand, controller, or user's voice) that canceled the hold gesture. + + + + + Represents pose data of the input source, such as a hand or controller, when the gesture occurred. + + + + + Contains fields that are relevant when a hold gesture completes. + + + + + Head pose of the user at the time of the gesture. + + + + + The InteractionSource (hand, controller, or user's voice) that completed the hold gesture. + + + + + Pose data of the interaction source at the time of the gesture. + + + + + Contains fields that are relevant when a hold gesture starts. + + + + + Head pose of the user at the time of the gesture. + + + + + The InteractionSource (hand, controller, or user's voice) that started the hold gesture. + + + + + Pose data of the interaction source at the time of the gesture. + + + + + Provides access to user input from hands, controllers, and system voice commands. + + + + + (Read Only) The number of InteractionSourceState snapshots available for reading with InteractionManager.GetCurrentReading. + + + + + Get the current SourceState. + + + An array of InteractionSourceState snapshots. + + + + + Allows retrieving the current source states without allocating an array. The number of retrieved source states will be returned, up to a maximum of the size of the array. + + An array for storing InteractionSourceState snapshots. + + The number of snapshots stored in the array, up to the size of the array. + + + + + Occurs when a new hand, controller, or source of voice commands has been detected. + + + + + + Occurs when a new hand, controller, or source of voice commands has been detected. + + + + + + Occurs when a hand, controller, or source of voice commands is no longer available. + + + + + + Occurs when a hand, controller, or source of voice commands is no longer available. + + + + + + Occurs when a hand or controller has entered the pressed state. + + + + + + Occurs when a hand or controller has entered the pressed state. + + + + + + Occurs when a hand or controller has exited the pressed state. + + + + + + Occurs when a hand or controller has exited the pressed state. + + + + + + Occurs when a hand or controller has experienced a change to its SourceState. + + + + + + Occurs when a hand or controller has experienced a change to its SourceState. + + + + + + Callback to handle InteractionManager events. + + + + + + Represents one detected instance of an interaction source (hand, controller, or user's voice) that can cause interactions and gestures. + + + + + Denotes which hand was used as the input source. + + + + + The identifier for the interaction source (hand, controller, or user's voice). + + + + + Specifies the kind of an interaction source. + + + + + Following the make and model nomenclature of cars, this equates to the model number. + + + + + Following the make and model nomenclature of cars, this would be a minor update to the model. + + + + + This property returns true when the interaction source has at least one grasp button, and false if otherwise. + + + + + This property returns true when the interaction source has a menu button, and false if otherwise. + + + + + This property returns true if the interaction source has a separate pose for the pointer, and false if otherwise. + + + + + Returns true if the interaction source has a thumbstick, and false if otherwise. + + + + + Returns true if the interaction source has a touchpad, and false if otherwise. + + + + + All interaction sources developed by the same company will have the same vendor ID. + + + + + Contains fields that are relevent when an interaction source is detected. + + + + + The current state of the reported interaction source that was just detected. + + + + + Denotes which hand was used as the input source. + + + + + Specifies the kind of an interaction source. + + + + + The interaction source is of a kind not known in this version of the API. + + + + + The interaction source is one of the user's hands. + + + + + The interaction source is of a kind not known in this version of the API. + + + + + The interaction source is the user's speech. + + + + + Represents the position and velocity of a hand or controller - this has been deprecated. Use InteractionSourcePose instead. + + + + + Get the position of the interaction - this has been deprecated. Use InteractionSourcePose instead. + + Supplied Vector3 to be populated with interaction position. + + True if the position is successfully returned. + + + + + Get the velocity of the interaction - this has been deprecated. Use InteractionSourcePose instead. + + Supplied Vector3 to be populated with interaction velocity. + + True if the velocity is successfully returned. + + + + + Contains fields that are relevent when an interaction source is lost. + + + + + The current state of the reported interaction source that was just lost. + + + + + Specifies which part of the controller to query pose information for. + + + + + The grip of the controller. + + + + + The pointer of the controller. + + + + + Pose data of the interaction source at the time of either the gesture or interaction. + + + + + The position-tracking accuracy of the interaction source. + + + + + Attempts to retrieve a Vector3 representing the current angular velocity of the tracked node. + + If the function returns true, this will be filled out with the angular velocity of the interaction source. If the function returns false, the value filled out should not be used. + + True if the angular velocity was set in the output parameter. False if the angular velocity is not available due to limitations of the underlying platform or if the node is not presently tracked. + + + + + Gets the forward vector of the interaction source, assuming rotation is valid. + + The forward vector of the interaction source, if the function returns true. + Specifies which part of the controller to query for its forward vector. + + This method returns true when the rotation is valid and the Vector3 passed in was filled out correctly, and false if otherwise. + + + + + Gets the position of the interaction source, assuming the backing data is valid. + + The position of the interaction source, is the function returns true. + Specifies which part of the controller to query for its position. + + This method returns true when the Vector3 passed in was filled out correctly, and false if otherwise. + + + + + Gets the right vector of the interaction source, assuming rotation is valid. + + The right vector of the interaction source, if the function returns true. + Specifies which part of the controller to query for its right vector. + + This method returns true if rotation is valid and the Vector3 passed in was filled out correctly, and false if otherwise. + + + + + Gets the rotation of the interaction source, assuming the backing data is valid. + + Specifies which part of the controller to query for its rotation. + The rotation of the interaction source, if the function returns true. + + This method returns true if the Quaternion passed in was filled out correctly, and false if otherwise. + + + + + Gets the up vector of the interaction source, assuming rotation is valid. + + The up vector of the interaction source, if the function returns true. + Specifies which part of the controller to query for its up vector. + + Returns true if the rotation is valid and the Vector3 passed in was filled out correctly, and false if otherwise. + + + + + Gets the velocity of the interaction source, assuming the backing data is valid. + + The velocity of the interaction source, if the function returns true. + + Returns true if the Vector3 passed in was filled out correctly, and false if otherwise. + + + + + Denotes the accuracy of tracking on the interaction source. + + + + + A position accuracy of Approximate reports that you may not want to fully trust the positions reported, as the position is inferred or synthesized in some way, such as the controller leaving the sensors' field of view and forcing the API to rely on the device's IMU instead of visual tracking. + + + + + A position accuracy of High reports that you can fully trust the position, as the interaction source is within the sensors' visual field of view. + + + + + A position accuracy of None reports that there is no position accuracy, as the interaction source unlocatable. + + + + + Contains fields that are relevent when an interaction source enters the pressed state for one of its buttons. + + + + + Denotes the type of button that was just pressed. + + + + + The current state of the reported interaction source that just had one of its buttons enter the pressed state. + + + + + The type of button or controller feature pressed, if any. + + + + + These buttons are generally found on the side of the controller. Some hardware has more than one grasp button. + + + + + This button is marked with three horizontal lines, same as you would fine on an Xbox One controller. + + + + + Depending on the InteractionSourceType of the interaction source, this could be a number of equivalent things: main button on a blicker, air-tap on a hand, and the trigger on a motion controller. + + + + + Similar to the touchpad, moving the thumbstick won't count as pressing it - a press will occur when pressing down on the thumbstick enough. + + + + + A touchpad only counts as pressed when it's held down enough - otherwise, it's just touched, and will give a reading of the position through InteractionSourceState.touchpadPosition. + + + + + Represents the set of properties available to explore the current state of a hand or controller. + + + + + The position and velocity of the hand, expressed in the specified coordinate system - this has been deprecated. Use InteractionSourcePose instead. + + + + + The direction you should suggest that the user move their hand if it is nearing the edge of the detection area. + + + + + Gets the risk that detection of the hand will be lost as a value from 0.0 to 1.0. + + + + + Contains fields that are relevent when an interaction source exits the pressed state for one of its buttons. + + + + + Denotes the type of button that was just released. + + + + + The current state of the reported interaction source that just had one of its buttons exit the pressed state. + + + + + Represents a snapshot of the state of a spatial interaction source (hand, voice or controller) at a given time. + + + + + True if the source is in the pressed state. + + + + + Whether the controller is grasped. + + + + + Head pose of the user at the time of the interaction. + + + + + The Ray at the time represented by this InteractionSourceState. + + + + + Whether or not the menu button is pressed. + + + + + True if the source is in the pressed state, false otherwise. + + + + + Additional properties to explore the state of the interaction source. + + + + + Depending on the InteractionSourceType of the interaction source, this returning true could represent a number of equivalent things: main button on a clicker, air-tap on a hand, and the trigger on a motion controller. For hands, a select-press represents the user's index finger in the down position. For motion controllers, a select-press represents the controller's index-finger trigger (or primary face button, if no trigger) being fully pressed. Note that a voice command of "Select" causes an instant press and release, so you cannot poll for a voice press using this property - instead, you must use GestureRecognizer and subscribe to the Tapped event, or subscribe to the InteractionSourcePressed event from InteractionManager. + + + + + Normalized amount ([0, 1]) representing how much select is pressed. + + + + + The interaction source that this state describes. + + + + + Pose data of the interaction source at the time of the interaction. + + + + + Normalized coordinates for the position of a thumbstick. + + + + + Whether or not the thumbstick is pressed. + + + + + Normalized coordinates for the position of a touchpad interaction. + + + + + Whether or not the touchpad is pressed, as if a button. + + + + + Whether or not the touchpad is touched. + + + + + Contains fields that are relevent when an interaction source updates. + + + + + The current state of the reported interaction source that just updated. + + + + + Contains fields that are relevant when a manipulation gesture is canceled. + + + + + Head pose of the user at the time of the gesture. + + + + + The InteractionSource (hand, controller, or user's voice) that canceled the manipulation gesture. + + + + + Pose data of the interaction source at the time of the gesture. + + + + + Contains fields that are relevant when a manipulation gesture completes. + + + + + Total distance moved since the beginning of the manipulation gesture. + + + + + Head pose of the user at the time of the gesture. + + + + + The InteractionSource (hand, controller, or user's voice) that completed the manipulation gesture. + + + + + Pose data of the interaction source at the time of the gesture. + + + + + Contains fields relevant when a manipulation gesture starts. + + + + + Head pose of the user at the time of the gesture. + + + + + The InteractionSource (hand, controller, or user's voice) that started the manipulation gesture. + + + + + Pose data of the interaction source at the time of the gesture. + + + + + Contains fields that are relevant when a manipulation gesture gets updated. + + + + + Total distance moved since the beginning of the manipulation gesture. + + + + + Head pose of the user at the time of the gesture. + + + + + The InteractionSource (hand, controller, or user's voice) being used for the manipulation gesture. + + + + + Pose data of the interaction source at the time of the gesture. + + + + + Contains fields that are relevant when a navigation gesture is canceled. + + + + + Head pose of the user at the time of the gesture. + + + + + The InteractionSource (hand, controller, or user's voice) that canceled the navigation gesture. + + + + + Pose data of the interaction source at the time of the gesture. + + + + + Contains fields that are relevant when a navigation gesture completes. + + + + + Head pose of the user at the time of the gesture. + + + + + The normalized offset, since the navigation gesture began, of the input within the unit cube for the navigation gesture. + + + + + The InteractionSource (hand, controller, or user's voice) that completed the navigation gesture. + + + + + Pose data of the interaction source at the time of the gesture. + + + + + Contains fields that are relevant when a navigation gesture starts. + + + + + Head pose of the user at the time of the gesture. + + + + + The InteractionSource (hand, controller, or user's voice) that started the navigation gesture. + + + + + Pose data of the interaction source at the time of the gesture. + + + + + Contains fields that are relevant when a navigation gesture updates. + + + + + Head pose of the user at the time of the gesture. + + + + + The normalized offset, since the navigation gesture began, of the input within the unit cube for the navigation gesture. + + + + + The InteractionSource (hand, controller, or user's voice) being used for the navigation gesture. + + + + + Pose data of the interaction source at the time of the gesture. + + + + + Contains fields that are relevant when recognition of a gesture event ends. + + + + + Head pose of the user at the time of the gesture. + + + + + The InteractionSource (hand, controller, or user's voice) that ended the gesture. + + + + + Pose data of the interaction source at the time of the gesture. + + + + + Contains fields that are relevant when recognition of a gesture event begins. + + + + + Head pose of the user at the time of the gesture. + + + + + The InteractionSource (hand, controller, or user's voice) that started the gesture. + + + + + Pose data of the interaction source at the time of the gesture. + + + + + Contains fields that are relevant when a tap gesture occurs. + + + + + Head pose of the user at the time of the gesture. + + + + + The InteractionSource (hand, controller, or user's voice) that initiated the tap gesture. + + + + + Pose data of the interaction source at the time of the gesture. + + + + + The number of taps (1 for single-tap, 2 for double-tap). + + + + + The storage object for persisted WorldAnchors. + + + + + (Read Only) Gets the number of persisted world anchors in this WorldAnchorStore. + + + + + Clears all persisted WorldAnchors. + + + + + Deletes a persisted WorldAnchor from the store. + + The identifier of the WorldAnchor to delete. + + Whether or not the WorldAnchor was found and deleted. + + + + + Cleans up the WorldAnchorStore and releases memory. + + + + + Gets all of the identifiers of the currently persisted WorldAnchors. + + + An array of string identifiers. + + + + + Gets all of the identifiers of the currently persisted WorldAnchors. + + A target array to receive the identifiers of the currently persisted world anchors. + + The number of identifiers stored in the target array. + + + + + Gets the WorldAnchorStore instance. + + The handler to be called when the WorldAnchorStore is loaded. + + + + The handler for when getting the WorldAnchorStore from GetAsync. + + The instance of the WorldAnchorStore once loaded. + + + + Loads a WorldAnchor from disk for given identifier and attaches it to the GameObject. If the GameObject has a WorldAnchor, that WorldAnchor will be updated. If the anchor is not found, null will be returned and the GameObject and any existing WorldAnchor attached to it will not be modified. + + The identifier of the WorldAnchor to load. + The object to attach the WorldAnchor to if found. + + The WorldAnchor loaded by the identifier or null if not found. + + + + + Saves the provided WorldAnchor with the provided identifier. If the identifier is already in use, the method will return false. + + The identifier to save the anchor with. This needs to be unique for your app. + The anchor to save. + + Whether or not the save was successful. Will return false if the id conflicts with another already saved anchor's id. + + + + + Indicates the lifecycle state of the device's spatial location system. + + + + + The device is reporting its orientation and is preparing to locate its position in the user's surroundings. + + + + + The device is reporting its orientation and position in the user's surroundings. + + + + + The device is reporting its orientation but cannot locate its position in the user's surroundings due to external factors like poor lighting conditions. + + + + + The device is reporting its orientation and has not been asked to report its position in the user's surroundings. + + + + + The device's spatial location system is not available. + + + + + Hololens Device version used for connecting to a remote session. + + + + + Hololens 1 Device. + + + + + Hololens 2 device. + + + + + This enum represents the result of a WorldAnchorTransferBatch operation. + + + + + The operation has failed because access was denied. This occurs typically because the transfer batch was not readable when deserializing or writable when serializing. + + + + + The operation has failed because it was not supported. + + + + + The operation has completed successfully. + + + + + The operation has failed in an unexpected way. + + + + + A batch of WorldAnchors which can be exported and imported between apps. + + + + + (Read Only) Gets the number of world anchors in this WorldAnchorTransferBatch. + + + + + Adds a WorldAnchor to the batch with the specified identifier. + + The identifier associated with this anchor in the batch. This must be unique per batch. + The anchor to add to the batch. + + Whether or not the anchor was added successfully. + + + + + The handler for when deserialization has completed. + + The reason the deserialization completed (success or failure reason). + The resulting transfer batch which is empty on error. + + + + Cleans up the WorldAnchorTransferBatch and releases memory. + + + + + Exports the input WorldAnchorTransferBatch into a byte array which can be passed to WorldAnchorTransferBatch.ImportAsync to restore the original WorldAnchorTransferBatch. + + The WorldAnchorTransferBatch to export into a byte buffer. + The callback when some data is available. + The callback after the last bit of data was provided via onDataAvailable with a completion reason (success or failure reason). + + + + Gets all of the identifiers currently mapped in this WorldAnchorTransferBatch. + + + The identifiers of all of the WorldAnchors in this WorldAnchorTransferBatch. + + + + + Gets all of the identifiers currently mapped in this WorldAnchorTransferBatch. If the target array is not large enough to contain all the identifiers, then only those identifiers that fit within the array will be stored and the return value will equal the size of the array. You can detect this condition by checking for a return value less than WorldAnchorTransferBatch.anchorCount. + + A target array to receive the identifiers of the currently mapped world anchors. + + The number of identifiers stored in the target array. + + + + + Imports the provided bytes into a WorldAnchorTransferBatch. + + The complete data to import. + The handler when the data import is complete. + The offset in the array from which to start reading. + The length of the data in the array. + + + + Imports the provided bytes into a WorldAnchorTransferBatch. + + The complete data to import. + The handler when the data import is complete. + The offset in the array from which to start reading. + The length of the data in the array. + + + + Locks the provided GameObject to the world by loading and applying the WorldAnchor from the TransferBatch for the provided id. + + The identifier for the WorldAnchor to load and apply to the GameObject. + The GameObject to apply the WorldAnchor to. If the GameObject already has a WorldAnchor, it will be updated. + + The loaded WorldAnchor or null if the id does not map to a WorldAnchor. + + + + + The handler for when serialization is completed. + + Why the serialization completed (success or failure reason). + + + + The handler for when some data is available from serialization. + + A set of bytes from the exported transfer batch. + + + + Enumeration of the different types of SurfaceChange events. + + + + + Surface was Added. + + + + + Surface was removed. + + + + + Surface was updated. + + + + + SurfaceData is a container struct used for requesting baked spatial mapping data and receiving that data once baked. + + + + + Set this field to true when requesting data to bake collider data. This field will be set to true when receiving baked data if it was requested. Setting this field to true requires that a valid outputCollider is also specified. + + + + + This is the ID for the surface to be baked or the surface that was baked and being returned to the user. + + + + + This WorldAnchor is used to lock the surface into place relative to real world objects. It will be filled in when calling RequestMeshAsync to generate data for a surface and returned with the SurfaceDataReadyDelegate. + + + + + This MeshCollider will receive the baked physics mesh prepared by the system when requesting baked surface data through RequestMeshAsync. The MeshCollider is returned in the SurfaceDataReadyDelegate for those users requiring advanced workflows. + + + + + This MeshFilter will receive the baked mesh prepared by the system when requesting baked surface data. The MeshFilter is returned in the SurfaceDataReadyDelegate for those users requiring advanced workflows. + + + + + This value controls the basic resolution of baked mesh data and is returned with the SurfaceDataReadyDelegate. The device will deliver up to this number of triangles per cubic meter. + + + + + Constructor for conveniently filling out a SurfaceData struct. + + ID for the surface in question. + MeshFilter to write Mesh data to. + WorldAnchor receiving the anchor point for the surface. + MeshCollider to write baked physics data to (optional). + Requested resolution for the computed Mesh. Actual resolution may be less than this value. + Set to true if collider baking is/has been requested. + + + + SurfaceId is a structure wrapping the unique ID used to denote Surfaces. SurfaceIds are provided through the onSurfaceChanged callback in Update and returned after a RequestMeshAsync call has completed. SurfaceIds are guaranteed to be unique though Surfaces are sometimes replaced with a new Surface in the same location with a different ID. + + + + + The actual integer ID referring to a single surface. + + + + + SurfaceObserver is the main API portal for spatial mapping functionality in Unity. + + + + + Basic constructor for SurfaceObserver. + + + + + Call Dispose when the SurfaceObserver is no longer needed. This will ensure that the object is cleaned up appropriately but will not affect any Meshes, components, or objects returned by RequestMeshAsync. + + + + + Call RequestMeshAsync to start the process of baking mesh data for the specified surface. This data may take several frames to create. Baked data will be delivered through the specified SurfaceDataReadyDelegate. This method will throw ArgumentNullExcpetion and ArgumentException if parameters specified in the dataRequest are invalid. + + Bundle of request data used to bake the specified surface. + Callback called when the baking of this surface is complete. + + Returns false if the request has failed, typically due to specifying a bad surface ID. + + + + + This method sets the observation volume as an axis aligned box at the requested location. Successive calls can be used to reshape the observation volume and/or to move it in the Scene as needed. Extents are the distance from the center of the box to its edges along each axis. + + The origin of the requested observation volume. + The extents in meters of the requested observation volume. + + + + This method sets the observation volume as a frustum at the requested location. Successive calls can be used to reshape the observation volume and/or to move it in the Scene as needed. + + Planes defining the frustum as returned from GeometryUtility.CalculateFrustumPlanes. + + + + This method sets the observation volume as an oriented box at the requested location. Successive calls can be used to reshape the observation volume and/or to move it in the Scene as needed. Extents are the distance from the center of the box to its edges along each axis. + + The origin of the requested observation volume. + The extents in meters of the requested observation volume. + The orientation of the requested observation volume. + + + + This method sets the observation volume as a sphere at the requested location. Successive calls can be used to reshape the observation volume and/or to move it in the Scene as needed. + + The origin of the requested observation volume. + The radius in meters of the requested observation volume. + + + + The SurfaceChanged delegate handles SurfaceChanged events as generated by calling Update on a SurfaceObserver. Applications can use the bounds, changeType, and updateTime to selectively generate mesh data for the set of known surfaces. + + The ID of the surface that has changed. + The type of change this event represents (Added, Updated, Removed). + The bounds of the surface as reported by the device. + The update time of the surface as reported by the device. + + + + The SurfaceDataReadyDelegate handles events generated when the engine has completed generating a mesh. Mesh generation is requested through GetMeshAsync and may take many frames to complete. + + Struct containing output data. + Set to true if output has been written and false otherwise. + Elapsed seconds between mesh bake request and propagation of this event. + + + + Update generates SurfaceChanged events which are propagated through the specified callback. If no callback is specified, the system will throw an ArgumentNullException. Generated callbacks are synchronous with this call. Scenes containing multiple SurfaceObservers should consider using different callbacks so that events can be properly routed. + + Callback called when SurfaceChanged events are detected. + + + + When calling PhotoCapture.StartPhotoModeAsync, you must pass in a CameraParameters object that contains the various settings that the web camera will use. + + + + + A valid height resolution for use with the web camera. + + + + + A valid width resolution for use with the web camera. + + + + + The framerate at which to capture video. This is only for use with VideoCapture. + + + + + The opacity of captured holograms. + + + + + The pixel format used to capture and record your image data. + + + + + The encoded image or video pixel format to use for PhotoCapture and VideoCapture. + + + + + 8 bits per channel (blue, green, red, and alpha). + + + + + Encode photo in JPEG format. + + + + + 8-bit Y plane followed by an interleaved U/V plane with 2x2 subsampling. + + + + + Portable Network Graphics Format. + + + + + Captures a photo from the web camera and stores it in memory or on disk. + + + + + Contains the result of the capture request. + + + + + Specifies that the desired operation was successful. + + + + + Specifies that an unknown error occurred. + + + + + Asynchronously creates an instance of a PhotoCapture object that can be used to capture photos. + + Will allow you to capture holograms in your photo. + This callback will be invoked when the PhotoCapture instance is created and ready to be used. + + + + Dispose must be called to shutdown the PhotoCapture instance. + + + + + Provides a COM pointer to the native IVideoDeviceController. + + + A native COM pointer to the IVideoDeviceController. + + + + + Called when a photo has been saved to the file system. + + Indicates whether or not the photo was successfully saved to the file system. + + + + Called when a photo has been captured to memory. + + Indicates whether or not the photo was successfully captured to memory. + Contains the target texture. If available, the spatial information will be accessible through this structure as well. + + + + Called when a PhotoCapture resource has been created. + + The PhotoCapture instance. + + + + Called when photo mode has been started. + + Indicates whether or not photo mode was successfully activated. + + + + Called when photo mode has been stopped. + + Indicates whether or not photo mode was successfully deactivated. + + + + A data container that contains the result information of a photo capture operation. + + + + + The specific HResult value. + + + + + A generic result that indicates whether or not the PhotoCapture operation succeeded. + + + + + Indicates whether or not the operation was successful. + + + + + Asynchronously starts photo mode. + + The various settings that should be applied to the web camera. + This callback will be invoked once photo mode has been activated. + + + + Asynchronously stops photo mode. + + This callback will be invoked once photo mode has been deactivated. + + + + A list of all the supported device resolutions for taking pictures. + + + + + Asynchronously captures a photo from the web camera and saves it to disk. + + The location where the photo should be saved. The filename must end with a png or jpg file extension. + The encoding format that should be used. + Invoked once the photo has been saved to disk. + Invoked once the photo has been copied to the target texture. + + + + Asynchronously captures a photo from the web camera and saves it to disk. + + The location where the photo should be saved. The filename must end with a png or jpg file extension. + The encoding format that should be used. + Invoked once the photo has been saved to disk. + Invoked once the photo has been copied to the target texture. + + + + Image Encoding Format. + + + + + JPEG Encoding. + + + + + PNG Encoding. + + + + + Contains information captured from the web camera. + + + + + The length of the raw IMFMediaBuffer which contains the image captured. + + + + + Specifies whether or not spatial data was captured. + + + + + The raw image data pixel format. + + + + + Will copy the raw IMFMediaBuffer image data into a byte list. + + The destination byte list to which the raw captured image data will be copied to. + + + + Disposes the PhotoCaptureFrame and any resources it uses. + + + + + Provides a COM pointer to the native IMFMediaBuffer that contains the image data. + + + A native COM pointer to the IMFMediaBuffer which contains the image data. + + + + + This method will return the camera to world matrix at the time the photo was captured if location data if available. + + A matrix to be populated by the Camera to world Matrix. + + True if a valid matrix is returned or false otherwise. This will be false if the frame has no location data. + + + + + This method will return the projection matrix at the time the photo was captured if location data if available. + + The near clip plane distance. + The far clip plane distance. + A matrix to be populated by the Projection Matrix. + + True if a valid matrix is returned or false otherwise. This will be false if the frame has no location data. + + + + + This method will return the projection matrix at the time the photo was captured if location data if available. + + The near clip plane distance. + The far clip plane distance. + A matrix to be populated by the Projection Matrix. + + True if a valid matrix is returned or false otherwise. This will be false if the frame has no location data. + + + + + This method will copy the captured image data into a user supplied texture for use in Unity. + + The target texture that the captured image data will be copied to. + + + + Records a video from the web camera directly to disk. + + + + + Specifies what audio sources should be recorded while recording the video. + + + + + Include both the application audio as well as the mic audio in the video recording. + + + + + Only include the application audio in the video recording. + + + + + Only include the mic audio in the video recording. + + + + + Do not include any audio in the video recording. + + + + + Contains the result of the capture request. + + + + + Specifies that the desired operation was successful. + + + + + Specifies that an unknown error occurred. + + + + + Asynchronously creates an instance of a VideoCapture object that can be used to record videos from the web camera to disk. + + Will allow you to capture holograms in your video. + This callback will be invoked when the VideoCapture instance is created and ready to be used. + + + + Dispose must be called to shutdown the PhotoCapture instance. + + + + + Returns the supported frame rates at which a video can be recorded given a resolution. + + A recording resolution. + + The frame rates at which the video can be recorded. + + + + + Provides a COM pointer to the native IVideoDeviceController. + + + A native COM pointer to the IVideoDeviceController. + + + + + Indicates whether or not the VideoCapture instance is currently recording video. + + + + + Called when the web camera begins recording the video. + + Indicates whether or not video recording started successfully. + + + + Called when the video recording has been saved to the file system. + + Indicates whether or not video recording was saved successfully to the file system. + + + + Called when a VideoCapture resource has been created. + + The VideoCapture instance. + + + + Called when video mode has been started. + + Indicates whether or not video mode was successfully activated. + + + + Called when video mode has been stopped. + + Indicates whether or not video mode was successfully deactivated. + + + + Asynchronously records a video from the web camera to the file system. + + The name of the video to be recorded to. + Invoked as soon as the video recording begins. + + + + Asynchronously starts video mode. + + The various settings that should be applied to the web camera. + Indicates how audio should be recorded. + This callback will be invoked once video mode has been activated. + + + + Asynchronously stops recording a video from the web camera to the file system. + + Invoked as soon as video recording has finished. + + + + Asynchronously stops video mode. + + This callback will be invoked once video mode has been deactivated. + + + + A list of all the supported device resolutions for recording videos. + + + + + A data container that contains the result information of a video recording operation. + + + + + The specific HResult value. + + + + + A generic result that indicates whether or not the VideoCapture operation succeeded. + + + + + Indicates whether or not the operation was successful. + + + + + Contains general information about the current state of the web camera. + + + + + Specifies what mode the Web Camera is currently in. + + + + + Describes the active mode of the Web Camera resource. + + + + + Resource is not in use. + + + + + Resource is in Photo Mode. + + + + + Resource is in Video Mode. + + + + + The WorldAnchor component allows a GameObject's position to be locked in physical space. + + + + + Returns true if this WorldAnchor is located (read only). A return of false typically indicates a loss of tracking. + + + + + Retrieve a native pointer to the <a href="https:msdn.microsoft.comen-uslibrarywindowsappswindows.perception.spatial.spatialanchor.aspx">Windows.Perception.Spatial.SpatialAnchor<a> COM object. +This function calls <a href=" https:msdn.microsoft.comen-uslibrarywindowsdesktopms691379.aspx">IUnknown::AddRef<a> on the pointer before returning it. The pointer must be released by calling <a href=" https:msdn.microsoft.comen-uslibrarywindowsdesktopms682317.aspx">IUnknown::Release<a>. + + + The native pointer to the <a href=" https:msdn.microsoft.comen-uslibrarywindowsappswindows.perception.spatial.spatialanchor.aspx">Windows.Perception.Spatial.SpatialAnchor<a> COM object. + + + + + OnTrackingChanged notifies listeners when this object's tracking state changes. + + Event that fires when this object's tracking state changes. + + + + Event that is fired when this object's tracking state changes. + + Set to true if the object is locatable. + The WorldAnchor reporting the tracking state change. + + + + + Assigns the <a href="https:msdn.microsoft.comen-uslibrarywindowsappswindows.perception.spatial.spatialanchor.aspx">Windows.Perception.Spatial.SpatialAnchor<a> COM pointer maintained by this WorldAnchor. + + A live <a href="https:msdn.microsoft.comen-uslibrarywindowsappswindows.perception.spatial.spatialanchor.aspx">Windows.Perception.Spatial.SpatialAnchor<a> COM pointer. + + + + This class represents the state of the real world tracking system. + + + + + The current state of the world tracking systems. + + + + + Return the native pointer to Windows::Perception::Spatial::ISpatialCoordinateSystem which was retrieved from an Windows::Perception::Spatial::ISpatialStationaryFrameOfReference object underlying the Unity World Origin. + + + Pointer to Windows::Perception::Spatial::ISpatialCoordinateSystem. + + + + + Event fired when the world tracking systems state has changed. + + + + + + Callback on when the world tracking systems state has changed. + + The previous state of the world tracking systems. + The new state of the world tracking systems. + + + + Contains all functionality related to a XR device. + + + + + Subscribe a delegate to this event to get notified when an XRDevice is successfully loaded. + + + + + + The name of the family of the loaded XR device. + + + + + Zooms the XR projection. + + + + + Successfully detected a XR device in working order. + + + + + Specific model of loaded XR device. + + + + + Refresh rate of the display in Hertz. + + + + + Returns the devices TrackingOriginType. + + + The TrackingOriginType that the device is currently using. It will return the Unknown TrackingOriginType on failure. + + + + + Indicates whether the user is present and interacting with the device. + + + + + Sets whether the camera passed in the first parameter is controlled implicitly by the XR Device + + The camera that we wish to change behavior on + True if the camera's transform is set externally. False if the camera is to be driven implicitly by XRDevice, + + Nothing. + + + + + This method returns an IntPtr representing the native pointer to the XR device if one is available, otherwise the value will be IntPtr.Zero. + + + The native pointer to the XR device. + + + + + Returns the device's current TrackingSpaceType. This value determines how the camera is positioned relative to its starting position. For more, see the section "Understanding the camera" in. + + + The device's current TrackingSpaceType. + + + + + Sets the device's current TrackingSpaceType. Returns true on success. Returns false if the given TrackingSpaceType is not supported or the device fails to switch. + + The TrackingSpaceType the device should switch to. + + + True on success. False if the given TrackingSpaceType is not supported or the device fails to switch. + + + + + Recreates the XR platform's eye texture swap chain with the appropriate anti-aliasing sample count. The reallocation of the eye texture will only occur if the MSAA quality setting's sample count is different from the sample count of the current eye texture. Reallocations of the eye textures will happen at the beginning of the next frame. This is an expensive operation and should only be used when necessary. + + + Nothing. + + + + + Enumeration of XR nodes which can be updated by XR input or sent haptic data. + + + + + Node representing a point between the left and right eyes. + + + + + Represents a tracked game Controller not associated with a specific hand. + + + + + Represents a physical device that provides tracking data for objects to which it is attached. + + + + + Node representing the user's head. + + + + + Node representing the left eye. + + + + + Node representing the left hand. + + + + + Node representing the right eye. + + + + + Node representing the right hand. + + + + + Represents a stationary physical device that can be used as a point of reference in the tracked area. + + + + + Sets the vector representing the current acceleration of the tracked node. + + + + + Sets the vector representing the current angular acceleration of the tracked node. + + + + + Sets the vector representing the current angular velocity of the tracked node. + + + + + The type of the tracked node as specified in XR.XRNode. + + + + + Sets the vector representing the current position of the tracked node. + + + + + Sets the quaternion representing the current rotation of the tracked node. + + + + + + Set to true if the node is presently being tracked by the underlying XR system, +and false if the node is not presently being tracked by the underlying XR system. + + + + + The unique identifier of the tracked node. + + + + + Sets the vector representing the current velocity of the tracked node. + + + + + Attempt to retrieve a vector representing the current acceleration of the tracked node. + + + + True if the acceleration was set in the output parameter. False if the acceleration is not available due to limitations of the underlying platform or if the node is not presently tracked. + + + + + Attempt to retrieve a Vector3 representing the current angular acceleration of the tracked node. + + + + True if the angular acceleration was set in the output parameter. False if the angular acceleration is not available due to limitations of the underlying platform or if the node is not presently tracked. + + + + + Attempt to retrieve a Vector3 representing the current angular velocity of the tracked node. + + + + True if the angular velocity was set in the output parameter. False if the angular velocity is not available due to limitations of the underlying platform or if the node is not presently tracked. + + + + + Attempt to retrieve a vector representing the current position of the tracked node. + + + + True if the position was set in the output parameter. False if the position is not available due to limitations of the underlying platform or if the node is not presently tracked. + + + + + Attempt to retrieve a quaternion representing the current rotation of the tracked node. + + + + True if the rotation was set in the output parameter. False if the rotation is not available due to limitations of the underlying platform or if the node is not presently tracked. + + + + + Attempt to retrieve a vector representing the current velocity of the tracked node. + + + + True if the velocity was set in the output parameter. False if the velocity is not available due to limitations of the underlying platform or if the node is not presently tracked. + + + + + Global XR related settings. + + + + + Fetch the device eye texture dimension from the active stereo device. + + + + + Globally enables or disables XR for the application. + + + + + Fetch the eye texture RenderTextureDescriptor from the active stereo device. + + + + + The current height of an eye texture for the loaded device. + + + + + Controls the actual size of eye textures as a multiplier of the device's default resolution. + + + + + The current width of an eye texture for the loaded device. + + + + + Sets the render mode for the XR device. The render mode controls how the view of the XR device renders in the Game view and in the main window on a host PC. + + + + + Read-only value that can be used to determine if the XR device is active. + + + + + Type of XR device that is currently loaded. + + + + + A scale applied to the standard occulsion mask for each platform. + + + + + This field has been deprecated. Use XRSettings.eyeTextureResolutionScale instead. + + + + + Controls how much of the allocated eye texture should be used for rendering. + + + + + This property has been deprecated. Use XRSettings.gameViewRenderMode instead. + + + + + The stereo rendering mode that is currently in use. + + + + + Returns a list of supported XR devices that were included at build time. + + + + + Specifies whether or not the occlusion mesh should be used when rendering. Enabled by default. + + + + + Loads the requested device at the beginning of the next frame. + + Name of the device from XRSettings.supportedDevices. + Prioritized list of device names from XRSettings.supportedDevices. + + + + Loads the requested device at the beginning of the next frame. + + Name of the device from XRSettings.supportedDevices. + Prioritized list of device names from XRSettings.supportedDevices. + + + + Enum type signifying the different stereo rendering modes available. + + + + + This is the reference stereo rendering path for VR. + + + + + This is a faster rendering path for VR than XRSettings.StereoRenderingMode.MultiPass. + + + + + This is an optimized version of the XRSettings.StereoRenderingMode.SinglePass mode. + + + + + This is a OpenGL optimized version of the XRSettings.StereoRenderingMode.SinglePassInstanced mode. + + + + + Timing and other statistics from the XR subsystem. + + + + + Total GPU time utilized last frame as measured by the XR subsystem. + + + + + Retrieves the number of dropped frames reported by the XR SDK. + + Outputs the number of frames dropped since the last update. + + True if the dropped frame count is available, false otherwise. + + + + + Retrieves the number of times the current frame has been drawn to the device as reported by the XR SDK. + + Outputs the number of times the current frame has been presented. + + True if the frame present count is available, false otherwise. + + + + + Retrieves the time spent by the GPU last frame, in seconds, as reported by the XR SDK. + + Outputs the time spent by the GPU last frame. + + True if the GPU time spent last frame is available, false otherwise. + + + + + Base class for all yield instructions. + + + + diff --git a/lib/nunit.framework.dll b/lib/nunit.framework.dll deleted file mode 100644 index 780727f..0000000 Binary files a/lib/nunit.framework.dll and /dev/null differ diff --git a/link.xml b/link.xml new file mode 100644 index 0000000..54b14b0 --- /dev/null +++ b/link.xml @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/packages.config b/packages.config index a59383c..499da1c 100644 --- a/packages.config +++ b/packages.config @@ -1,6 +1,9 @@  - - - + + + + + + \ No newline at end of file diff --git a/packages/Castle.Core.3.3.3/ASL - Apache Software Foundation License.txt b/packages/Castle.Core.3.3.3/ASL - Apache Software Foundation License.txt deleted file mode 100644 index 9e90f82..0000000 --- a/packages/Castle.Core.3.3.3/ASL - Apache Software Foundation License.txt +++ /dev/null @@ -1,57 +0,0 @@ -Apache License, Version 2.0 - -Apache License -Version 2.0, January 2004 -http://www.apache.org/licenses/ - -TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - -1. Definitions. - -"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. - -"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. - -"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. - -"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. - -"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. - -"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. - -"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). - -"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. - -"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." - -"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. - -2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. - -3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. - -4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: - - 1. You must give any other recipients of the Work or Derivative Works a copy of this License; and - - 2. You must cause any modified files to carry prominent notices stating that You changed the files; and - - 3. You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and - - 4. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. - -You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. - -5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. - -6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. - -7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. - -8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. - -9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. - -END OF TERMS AND CONDITIONS diff --git a/packages/Castle.Core.3.3.3/BreakingChanges.txt b/packages/Castle.Core.3.3.3/BreakingChanges.txt deleted file mode 100644 index 6f39a7a..0000000 --- a/packages/Castle.Core.3.3.3/BreakingChanges.txt +++ /dev/null @@ -1,71 +0,0 @@ -=== version 3.0 -================================================================================================ -change - Removed overloads of logging methods that were taking format string from ILogger and - ILogger and IExtendedLogger and didn't have word Format in their name. - For example: - void Error(string format, params object[] args); // was removed - void ErrorFormat(string format, params object[] args); //use this one instead - - -impact - low -fixability - medium -revision - - -description - To minimize confusion and duplication those methods were removed. - -fix - Use methods that have explicit "Format" word in their name and same signature. -================================================================================================ -change - Removed WebLogger and WebLoggerFactory - -impact - low -fixability - medium -revision - - -description - To minimize management overhead the classes were removed so that only single - Client Profile version of Castle.Core can be distributed. - -fix - You can use NLog or Log4Net web logger integration, or reuse implementation of existing - web logger and use it as a custom logger. - -================================================================================================ -change - Removed obsolete overload of ProxyGenerator.CreateClassProxy - -impact - low -fixability - trivial -revision - - -description - Deprecated overload of ProxyGenerator.CreateClassProxy was removed to keep the - method consistent with other methods and to remove confusion - -fix - whenever removed overload was used, use one of the other overloads. - -================================================================================================ -change - IProxyGenerationHook.NonVirtualMemberNotification method was renamed - -impact - high -fixability - easy -revision - - -description - to accommodate class proxies with target method NonVirtualMemberNotification on - IProxyGenerationHook type was renamed to more accurate NonProxyableMemberNotification - since for class proxies with target not just methods but also fields and other member that - break the abstraction will be passed to this method. - -fix - whenever NonVirtualMemberNotification is used/implemented change the method name to - NonProxyableMemberNotification. Implementors should also accommodate possibility that not - only MethodInfos will be passed as method's second parameter. - -================================================================================================ -change - DynamicProxy will now allow to intercept members of System.Object - -impact - very low -fixability - easy -revision - - -description - to allow scenarios like mocking of System.Object members, DynamicProxy will not - disallow proxying of these methods anymore. AllMethodsHook (default IProxyGenerationHook) - will still filter them out though. - -fix - whenever custom IProxyGenerationHook is used, user should account for System.Object's - members being now passed to ShouldInterceptMethod and NonVirtualMemberNotification methods - and if neccessary update the code to handle them appropriately. diff --git a/packages/Castle.Core.3.3.3/Castle.Core.3.3.3.nupkg b/packages/Castle.Core.3.3.3/Castle.Core.3.3.3.nupkg deleted file mode 100644 index 9f18a41..0000000 Binary files a/packages/Castle.Core.3.3.3/Castle.Core.3.3.3.nupkg and /dev/null differ diff --git a/packages/Castle.Core.3.3.3/Changes.txt b/packages/Castle.Core.3.3.3/Changes.txt deleted file mode 100644 index 8ad9e2f..0000000 --- a/packages/Castle.Core.3.3.3/Changes.txt +++ /dev/null @@ -1,233 +0,0 @@ -3.3.3 -================== -- fixed #70 - Serilog integration modifies LoggerConfiguration.MinimumLevel -- fixed #69 - Added SourceContext to the Serilog Logger - contributed by @KevivL - -3.3.2 -================== -- fixed #66 - SerilogLogger implementation bug where exceptions were passed through incorrectly - -3.3.1 -================== -- implemented #61 - Added support for Serilog - contributed by Russell J Baker (@ruba1987) - -3.3.0 -================== -- implemented #51 - removed abandoned projects: Binder, Pagination, Validator -- implemented #49 - build NuGet and Zip packages from TeamCity - contributed by Blair Conrad (@blairconrad) -- implemented #42 - move complicated BuildInternalsVisibleMessageForType method out of DynamicProxyBuilder - contributed by Blair Conrad (@blairconrad) -- fixed #47 - Calling DynamicProxy proxy methods with multidimensional array parameters - contributed by Ed Parcell (@edparcell) -- fixed #44 - DictionaryAdapter FetchAttribute on type has no effect -- fixed #34 and #39 - inaccessible type parameters should give better error messsages - contributed by Blair Conrad (@blairconrad) - -3.2.2 -================== -- fixed #35 - ParameterBuilder.SetConstant fails when using a default value of null - contributed by (@jonasro) - -3.2.1 -================== -- fixed #32 - Improve configuration of SmtpClient in sync sending - contributed by Artur Dorochowicz (@ArturDorochowicz) -- fixed #31 - [DynamicProxy] Preserve DefaultValues of proxied method's parameters (in .NET 4.5) -- fixed #30 - tailoring InternalsVisibleTo message based on assembly of inaccessible type - contributed by Blair Conrad (@blairconrad) -- fixed #27 - Allow dynamic proxy of generic interfaces which have generic methods, under Mono 2.10.8 and Mono 3.0.6 - contributed by Iain Ballard (@i-e-b) -- fixed #26 - Proxy of COM class issue, reference count incremented - contributed by Jean-Claude Viau (@jcviau) -- fixed DYNPROXY-188 - CreateInterfaceProxyWithoutTarget fails with interface containing member with 'ref UIntPtr' - contributed by Pier Janssen (@Pjanssen) -- fixed DYNPROXY-186 - .Net remoting (transparent proxy) cannot be proxied - contributed by Jean-Claude Viau (@jcviau) -- fixed DYNPROXY-185 - ProxyUtil.GetUnproxiedInstance returns proxy object for ClassProxyWithTarget instead of its target - contributed by Dmitry Xlestkov (@d-s-x) - -3.2.0 (2013-02-16) -================== -- fixed DYNPROXY-179 - Exception when creating a generic proxy (from cache) -- fixed DYNPROXY-175 - invalid CompositionInvocation type used when code uses interface proxies with and without InterceptorSelector - -3.1.0 (2012-08-05) -================== -- fixed DYNPROXY-174 - Unable to cast object of type 'System.Collections.ObjectModel.ReadOnlyCollection`1[System.Reflection.CustomAttributeTypedArgument]' to type 'System.Array' - -3.1.0 RC (2012-07-08) -================== -- support multiple inheritance of DA attributes on interfaces. -- BREAKING CHANGE: removed propogate child notifications as it violated INotifyPropertyChanged contract -- improved DictionaryAdapter performance -- generalized IBindingList support for DictionaryAdapters -- added reference support to XmlAdapter -- BRAKING CHANGE: refactored XPathAdapter into XmlAdapter with much more flexibility to support other input like XLinq - -- implemented CORE-43 - Add option to skip configuring log4net/nlog - -- fixed CORE-44 - NLog logger does not preserver call site info -- fixed DYNPROXY-171 - PEVerify error on generic method definition -- fixed DYNPROXY-170 - Calls to properties inside non-intercepted methods are not forwarded to target object (regression from v2.5) -- fixed DYNPROXY-169 - Support IChangeProxyTarget on additional interfaces and mixins when using CreateInterfaceProxyWithTargetInterface - -3.0.0 (2011-12-13) -================== -no major changes since RC - -3.0.0 RC 1 (2011-11-20) -================== -- Applied Jeff Sharps patch that refactored Xml DictionaryAdapter to improve maintainability and enable more complete functionality - -- fixed DYNPROXY-165 - Object.GetType() and Object.MemberwiseClone() should be ignored and not reported as non-interceptable to IProxyGenerationHook -- fixed DYNPROXY-164 - Invalid Proxy type generated when there are more than one base class generic constraints -- fixed DYNPROXY-162 - ref or out parameters can not be passed back if proxied method throw an exception - -3.0.0 beta 1 (2011-08-14) -================== -- fixed CORE-37 - TAB characters in the XML Configuration of a component parameter is read as String.Empty -- fixed DYNPROXY-161 - Strong Named DynamicProxy Assembly Not Available in Silverligh -- fixed DYNPROXY-159 - Sorting MemberInfo array for serialization has side effects -- fixed DYNPROXY-158 - Can't create class proxy with target and without target in same ProxyGenerator -- fixed DYNPROXY-153 - When proxying a generic interface which has an interface as GenericType . No proxy can be created -- fixed DYNPROXY-151 - Cast error when using attributes - -- implemented CORE-33 - Add lazy logging -- implemented DYNPROXY-156 - Provide mechanism for interceptors to implement retry logic - -- removed obsolete members from ILogger and its implementations - -2.5.2 (2010-11-15) -================== -- fixed DYNPROXY-150 - Finalizer should not be proxied -- implemented DYNPROXY-149 - Make AllMethodsHook members virtual so it can be used as a base class -- fixed DYNPROXY-147 - Can't crete class proxies with two non-public methods having same argument types but different return type -- fixed DYNPROXY-145 Unable to proxy System.Threading.SynchronizationContext (.NET 4.0) -- fixed DYNPROXY-144 - params argument not supported in constructor -- fixed DYNPROXY-143 - Permit call to reach "non-proxied" methods of inherited interfaces -- implemented DYNPROXY-139 - Better error message -- fixed DYNPROXY-133 - Debug assertion in ClassProxyInstanceContributor fails when proxying ISerializable with an explicit implementation of GetObjectData -- fixed CORE-32 - Determining if permission is granted via PermissionUtil does not work in .NET 4 -- applied patch by Alwin Meijs - ExtendedLog4netFactory can be configured with a stream from for example an embedded log4net xml config -- Upgraded NLog to 2.0 Beta 1 -- Added DefaultXmlSerializer to bridge XPathAdapter with standard Xml Serialization. -- XPathAdapter for DictionaryAdapter added IXPathSerializer to provide hooks for custom serialization. - -2.5.1 (2010-09-21) -================== -- Interface proxy with target Interface now accepts null as a valid target value (which can be replaced at a later stage). -- DictionaryAdapter behavior overrides are now ordered with all other behaviors -- BREAKING CHANGE: removed web logger so that by default Castle.Core works in .NET 4 client profile -- added paramter to ModuleScope disabling usage of signed modules. This is to workaround issue DYNPROXY-134. Also a descriptive exception message is being thrown now when the issue is detected. -- Added IDictionaryBehaviorBuilder to allow grouping behaviors -- Added GenericDictionaryAdapter to simplify generic value sources -- fixed issue DYNPROXY-138 - Error message missing space -- fixed false positive where DynamicProxy would not let you proxy interface with target interface when target object was a COM object. -- fixed ReflectionBasedDictionaryAdapter when using indexed properties - -2.5.0 (2010-08-21) -================== -- DynamicProxy will now not replicate non-public attribute types -- Applied patch from Kenneth Siewers Mller which adds parameterless constructor to DefaultSmtpSender implementation, to be able to configure the inner SmtpClient from the application configuration file (system.net.smtp). -- added support for .NET 4 and Silverlight 4, updated solution to VisualStudio 2010 -- Removed obsolete overload of CreateClassProxy -- Added class proxy with taget -- Added ability to intercept explicitly implemented generic interface methods on class proxy. -- DynamicProxy does not disallow intercepting members of System.Object anymore. AllMethodsHook will still filter them out though. -- Added ability to intercept explicitly implemented interface members on class proxy. Does not support generic members. -- Merged DynamicProxy into Core binary -- fixed DYNPROXY-ISSUE-132 - "MetaProperty equals implementation incorrect" -- Fixed bug in DiagnosticsLoggerTestCase, where when running as non-admin, the teardown will throw SecurityException (contributed by maxild) -- Split IoC specific classes into Castle.Windsor project -- Merged logging services solution -- Merged DynamicProxy project - -1.2.0 (2010-01-11) -================== - -- Added IEmailSender interface and its default implementation - -1.2.0 beta (2009-12-04) -================== - -- BREAKING CHANGE - added ChangeProxyTarget method to IChangeProxyTarget interface -- added docs to IChangeProxyTarget methods -- Fixed DYNPROXY-ISSUE-108 - Obtaining replicated custom attributes on proxy may fail when property setter throws exception on default value -- Moved custom attribute replication from CustomAttributeUtil to new interface - IAttributeDisassembler -- Exposed IAttributeDisassembler via ProxyGenerationOptions, so that users can plug their implementation for some convoluted scenarios. (for Silverlight) -- Moved IInterceptorSelector from Dynamic Proxy to Core (IOC-ISSUE-156) - -1.1.0 (2009-05-04) -================== - -- Applied Eric Hauser's patch fixing CORE-ISSUE-22 - "Support for environment variables in resource URI" - -- Applied Gauthier Segay's patch fixing CORE-ISSUE-20 - "Castle.Core.Tests won't build via nant because it use TraceContext without referencing System.Web.dll" - -- Added simple interface to ComponentModel to make optional properties required. - -- Applied Mark's -- -- patch that changes - the Core to support being compiled for Silverlight 2 - -- Applied Louis DeJardin's patch adding TraceLogger as a new logger implementation - -- Applied Chris Bilson's patch fixing CORE-15 - "WebLogger Throws When Logging Outside of an HttpContext" - -Release Candidate 3 -=================== - -- Added IServiceProviderEx which extends IServiceProvider - -- Added Pair class. - -- Applied Bill Pierce's patch fixing CORE-9 - "Allow CastleComponent Attribute to Specify Lifestyle in Constructor" - -- Added UseSingleInterfaceProxy to CompomentModel to control the proxying - behavior while maintaining backward compatibility. - Added the corresponding ComponentProxyBehaviorAttribute. - -- Made NullLogger and IExtnededLogger - -- Enabled a new format on ILogger interface, with 6 overloads for each method: - Debug(string) - Debug(string, Exception) - Debug(string, params object[]) - DebugFormat(string, params object[]) - DebugFormat(Exception, string, params object[]) - DebugFormat(IFormatProvider, string, params object[]) - DebugFormat(IFormatProvider, Exception, string, params object[]) - - The "FatalError" overloads where marked as [Obsolete], replaced by "Fatal" and "FatalFormat". - -0.0.1.0 -======= - -- Included IProxyTargetAccessor - -- Removed IMethodInterceptor and IMethodInvocation, that have been replaced - by IInterceptor and IInvocation - -- Added FindByPropertyInfo to PropertySetCollection - -- Made the DependencyModel.IsOptional property writable - -- Applied Curtis Schlak's patch fixing IOC-27 - "assembly resource format only works for resources where the assemblies name and default namespace are the same." - - Quoting: - - "I chose to preserve backwards compatibility by implementing the code in the - reverse order as suggested by the reporter. Given the following URI for a resource: - - assembly://my.cool.assembly/context/moo/file.xml - - It will initially look for an embedded resource with the manifest name of - "my.cool.assembly.context.moo.file.xml" in the loaded assembly my.cool.assembly.dll. - If it does not find it, then it looks for the embedded resource with the manifest name - of "context.moo.file.xml". - -- IServiceEnabledComponent Introduced to be used across the project as - a standard way to have access to common services, for example, logger factories - -- Added missing log factories - -- Refactor StreamLogger and DiagnosticLogger to be more consistent behavior-wise - -- Refactored WebLogger to extend LevelFilteredLogger (removed duplication) - -- Refactored LoggerLevel order - -- Project started diff --git a/packages/Castle.Core.3.3.3/License.txt b/packages/Castle.Core.3.3.3/License.txt deleted file mode 100644 index dd4fb74..0000000 --- a/packages/Castle.Core.3.3.3/License.txt +++ /dev/null @@ -1,14 +0,0 @@ -Copyright 2004-2014 Castle Project - http://www.castleproject.org/ - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. - diff --git a/packages/Castle.Core.3.3.3/lib/net35/Castle.Core.dll b/packages/Castle.Core.3.3.3/lib/net35/Castle.Core.dll deleted file mode 100644 index c16e79d..0000000 Binary files a/packages/Castle.Core.3.3.3/lib/net35/Castle.Core.dll and /dev/null differ diff --git a/packages/Castle.Core.3.3.3/lib/net35/Castle.Core.xml b/packages/Castle.Core.3.3.3/lib/net35/Castle.Core.xml deleted file mode 100644 index 75d0a4b..0000000 --- a/packages/Castle.Core.3.3.3/lib/net35/Castle.Core.xml +++ /dev/null @@ -1,4774 +0,0 @@ - - - - Castle.Core - - - - - Specifies assignment by reference rather than by copying. - - - - - Suppresses any on-demand behaviors. - - - - - Removes a property if null or empty string, guid or collection. - - - - - Removes a property if matches value. - - - - - Assigns a specific dictionary key. - - - - - Defines the contract for customizing dictionary access. - - - - - Copies the dictionary behavior. - - null if should not be copied. Otherwise copy. - - - - Determines relative order to apply related behaviors. - - - - - Defines the contract for updating dictionary values. - - - - - Sets the stored dictionary value. - - The dictionary adapter. - The key. - The stored value. - The property. - true if the property should be stored. - - - - Contract for value matching. - - - - - Indicates that underlying values are changeable and should not be cached. - - - - - Contract for dictionary initialization. - - - - - Performs any initialization of the - - The dictionary adapter. - The dictionary behaviors. - - - - Abstract implementation of . - - - - - Conract for traversing a . - - - - - Contract for creating additional Dictionary adapters. - - - - - Contract for manipulating the Dictionary adapter. - - - - - Contract for editing the Dictionary adapter. - - - - - Contract for managing Dictionary adapter notifications. - - - - - Contract for validating Dictionary adapter. - - - - - Defines the contract for building s. - - - - - Builds the dictionary behaviors. - - - - - - Abstract adapter for the support - needed by the - - - - - Adds an element with the provided key and value to the object. - - The to use as the key of the element to add. - The to use as the value of the element to add. - An element with the same key already exists in the object. - key is null. - The is read-only.-or- The has a fixed size. - - - - Removes all elements from the object. - - The object is read-only. - - - - Determines whether the object contains an element with the specified key. - - The key to locate in the object. - - true if the contains an element with the key; otherwise, false. - - key is null. - - - - Returns an object for the object. - - - An object for the object. - - - - - Removes the element with the specified key from the object. - - The key of the element to remove. - The object is read-only.-or- The has a fixed size. - key is null. - - - - Copies the elements of the to an , starting at a particular index. - - The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing. - The zero-based index in array at which copying begins. - array is null. - The type of the source cannot be cast automatically to the type of the destination array. - index is less than zero. - array is multidimensional.-or- index is equal to or greater than the length of array.-or- The number of elements in the source is greater than the available space from index to the end of the destination array. - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - - - - Gets a value indicating whether the object has a fixed size. - - - true if the object has a fixed size; otherwise, false. - - - - Gets a value indicating whether the object is read-only. - - - true if the object is read-only; otherwise, false. - - - - Gets an object containing the keys of the object. - - - An object containing the keys of the object. - - - - Gets an object containing the values in the object. - - - An object containing the values in the object. - - - - Gets or sets the with the specified key. - - - - - - Gets the number of elements contained in the . - - - The number of elements contained in the . - - - - Gets a value indicating whether access to the is synchronized (thread safe). - - - true if access to the is synchronized (thread safe); otherwise, false. - - - - Gets an object that can be used to synchronize access to the . - - - An object that can be used to synchronize access to the . - - - - Provides a generic collection that supports data binding. - - - This class wraps the CLR - in order to implement the Castle-specific . - - The type of elements in the list. - - - - Initializes a new instance of the class - using default values. - - - - - Initializes a new instance of the class - with the specified list. - - - An of items - to be contained in the . - - - - - Initializes a new instance of the class - wrapping the specified instance. - - - A - to be wrapped by the . - - - - - Defines the contract for retrieving dictionary values. - - - - - Gets the effective dictionary value. - - The dictionary adapter. - The key. - The stored value. - The property. - true if return only existing. - The effective property value. - - - - Initializes a new instance of the class - that represents a child object in a larger object graph. - - - - - - - Contract for dictionary meta-data initialization. - - - - - Initializes the given object. - - The dictionary adapter factory. - The dictionary adapter meta. - - - - - Determines whether the given behavior should be included in a new - object. - - A dictionary behavior or annotation. - True if the behavior should be included; otherwise, false. - - behaviors are always included, - regardless of the result of this method. - - - - - - Checks whether or not collection is null or empty. Assumes colleciton can be safely enumerated multiple times. - - - - - - - Creates a message to inform clients that a proxy couldn't be created due to reliance on an - inaccessible type (perhaps itself). - - the inaccessible type that prevents proxy creation - the type that couldn't be proxied - - - - Find the best available name to describe a type. - - - Usually the best name will be , but - sometimes that's null (see http://msdn.microsoft.com/en-us/library/system.type.fullname%28v=vs.110%29.aspx) - in which case the method falls back to . - - the type to name - the best name - - - - Constant to use when making assembly internals visible to Castle.Core - [assembly: InternalsVisibleTo(CoreInternalsVisible.ToCastleCore)] - - - - - Constant to use when making assembly internals visible to proxy types generated by DynamicProxy. Required when proxying internal types. - [assembly: InternalsVisibleTo(CoreInternalsVisible.ToDynamicProxyGenAssembly2)] - - - - - Identifies a property should be represented as a nested component. - - - - - Defines the contract for building typed dictionary keys. - - - - - Builds the specified key. - - The dictionary adapter. - The current key. - The property. - The updated key - - - - Applies no prefix. - - - - - Gets or sets the prefix. - - The prefix. - - - - Identifies the dictionary adapter types. - - - - - Identifies an interface or property to be pre-fetched. - - - - - Instructs fetching to occur. - - - - - Instructs fetching according to - - - - - - Gets whether or not fetching should occur. - - - - - Assigns a property to a group. - - - - - Constructs a group assignment. - - The group name. - - - - Constructs a group assignment. - - The group name. - - - - Gets the group the property is assigned to. - - - - - Assigns a specific dictionary key. - - - - - Initializes a new instance of the class. - - The key. - - - - Initializes a new instance of the class. - - The compound key. - - - - Assigns a prefix to the keyed properties of an interface. - - - Key prefixes are not inherited by sub-interfaces. - - - - - Initializes a default instance of the class. - - - - - Initializes a new instance of the class. - - The prefix for the keyed properties of the interface. - - - - Gets the prefix key added to the properties of the interface. - - - - - Substitutes part of key with another string. - - - - - Initializes a new instance of the class. - - The old value. - The new value. - - - - Requests support for multi-level editing. - - - - - Generates a new GUID on demand. - - - - - Support for on-demand value resolution. - - - - - Provides simple string formatting from existing properties. - - - - - Gets the string format. - - - - - Gets the format properties. - - - - - Identifies a property should be represented as a delimited string value. - - - - - Gets the separator. - - - - - Converts all properties to strings. - - - - - Gets or sets the format. - - The format. - - - - Suppress property change notifications. - - - - - Contract for property descriptor initialization. - - - - - Performs any initialization of the - - The property descriptor. - The property behaviors. - - - - Assigns a prefix to the keyed properties using the interface name. - - - - - Manages conversion between property values. - - - - - Initializes a new instance of the class. - - The converter. - - - - Gets the effective dictionary value. - - The dictionary adapter. - The key. - The stored value. - The property. - true if return only existing. - The effective property value. - - - - - - - - - Uses Reflection.Emit to expose the properties of a dictionary - through a dynamic implementation of a typed interface. - - - - - Defines the contract for building typed dictionary adapters. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - An implementation of the typed interface bound to the dictionary. - - The type represented by T must be an interface with properties. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - An implementation of the typed interface bound to the dictionary. - - The type represented by T must be an interface with properties. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - The property descriptor. - An implementation of the typed interface bound to the dictionary. - - The type represented by T must be an interface with properties. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - An implementation of the typed interface bound to the namedValues. - - The type represented by T must be an interface with properties. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - An implementation of the typed interface bound to the namedValues. - - The type represented by T must be an interface with properties. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - An implementation of the typed interface bound to the . - - The type represented by T must be an interface with properties. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - An implementation of the typed interface bound to the . - - The type represented by T must be an interface with properties. - - - - - Gets the associated with the type. - - The typed interface. - The adapter meta-data. - - - - Gets the associated with the type. - - The typed interface. - The property descriptor. - The adapter meta-data. - - - - Gets the associated with the type. - - The typed interface. - Another from which to copy behaviors. - The adapter meta-data. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Contract for dictionary validation. - - - - - Determines if is valid. - - The dictionary adapter. - true if valid. - - - - Validates the . - - The dictionary adapter. - The error summary information. - - - - Validates the for a property. - - The dictionary adapter. - The property to validate. - The property summary information. - - - - Invalidates any results cached by the validator. - - The dictionary adapter. - - - - - - - - - Initializes a new instance of the class. - - The name values. - - - - Determines whether the object contains an element with the specified key. - - The key to locate in the object. - - true if the contains an element with the key; otherwise, false. - - key is null. - - - - Adapts the specified name values. - - The name values. - - - - - Gets a value indicating whether the object is read-only. - - - true if the object is read-only; otherwise, false. - - - - Gets or sets the with the specified key. - - - - - - Describes a dictionary property. - - - - - Initializes an empty class. - - - - - Initializes a new instance of the class. - - The property. - The annotations. - - - - Initializes a new instance class. - - - - - Copies an existinginstance of the class. - - - - - - - Gets the key. - - The dictionary adapter. - The key. - The descriptor. - - - - - Gets the property value. - - The dictionary adapter. - The key. - The stored value. - The descriptor. - true if return only existing. - - - - - Sets the property value. - - The dictionary adapter. - The key. - The value. - The descriptor. - - - - - Adds a single behavior. - - The behavior. - - - - Adds the behaviors. - - The behaviors. - - - - Adds the behaviors. - - The behaviors. - - - - Copies the behaviors to the other - - - - - - - Copies the - - - - - - - - - - - Gets the property name. - - - - - Gets the property type. - - - - - Gets the property. - - The property. - - - - Returns true if the property is dynamic. - - - - - Gets additional state. - - - - - Determines if property should be fetched. - - - - - Determines if property must exist first. - - - - - Determines if notifications should occur. - - - - - Gets the property behaviors. - - - - - Gets the type converter. - - The type converter. - - - - Gets the extended properties. - - - - - Gets the setter. - - The setter. - - - - Gets the key builders. - - The key builders. - - - - Gets the setter. - - The setter. - - - - Gets the getter. - - The getter. - - - - Gets the initializers. - - The initializers. - - - - Gets the meta-data initializers. - - The meta-data initializers. - - - - Helper class for retrieving attributes. - - - - - Gets the attribute. - - The member. - The member attribute. - - - - Gets the attributes. Does not consider inherited attributes! - - The member. - The member attributes. - - - - Gets the type attribute. - - The type. - The type attribute. - - - - Gets the type attributes. - - The type. - The type attributes. - - - - Gets the type converter. - - The member. - - - - - Gets the attribute. - - The member. - The member attribute. - - - - Contract for typed dynamic value resolution. - - - - - - Contract for dynamic value resolution. - - - - - Supporting Logger levels. - - - - - Logging will be off - - - - - Fatal logging level - - - - - Error logging level - - - - - Warn logging level - - - - - Info logging level - - - - - Debug logging level - - - - - Encapsulates an invocation of a proxied method. - - - - - Gets the value of the argument at the specified . - - The index. - The value of the argument at the specified . - - - - Returns the concrete instantiation of the on the proxy, with any generic - parameters bound to real types. - - - The concrete instantiation of the on the proxy, or the if - not a generic method. - - - Can be slower than calling . - - - - - Returns the concrete instantiation of , with any - generic parameters bound to real types. - For interface proxies, this will point to the on the target class. - - The concrete instantiation of , or - if not a generic method. - - In debug builds this can be slower than calling . - - - - - Proceeds the call to the next interceptor in line, and ultimately to the target method. - - - Since interface proxies without a target don't have the target implementation to proceed to, - it is important, that the last interceptor does not call this method, otherwise a - will be thrown. - - - - - Overrides the value of an argument at the given with the - new provided. - - - This method accepts an , however the value provided must be compatible - with the type of the argument defined on the method, otherwise an exception will be thrown. - - The index of the argument to override. - The new value for the argument. - - - - Gets the arguments that the has been invoked with. - - The arguments the method was invoked with. - - - - Gets the generic arguments of the method. - - The generic arguments, or null if not a generic method. - - - - Gets the object on which the invocation is performed. This is different from proxy object - because most of the time this will be the proxy target object. - - - The invocation target. - - - - Gets the representing the method being invoked on the proxy. - - The representing the method being invoked. - - - - For interface proxies, this will point to the on the target class. - - The method invocation target. - - - - Gets the proxy object on which the intercepted method is invoked. - - Proxy object on which the intercepted method is invoked. - - - - Gets or sets the return value of the method. - - The return value of the method. - - - - Gets the type of the target object for the intercepted method. - - The type of the target object. - - - - Used during the target type inspection process. Implementors have a chance to customize the - proxy generation process. - - - - - Invoked by the generation process to notify that the whole process has completed. - - - - - Invoked by the generation process to notify that a member was not marked as virtual. - - The type which declares the non-virtual member. - The non-virtual member. - - This method gives an opportunity to inspect any non-proxyable member of a type that has - been requested to be proxied, and if appropriate - throw an exception to notify the caller. - - - - - Invoked by the generation process to determine if the specified method should be proxied. - - The type which declares the given method. - The method to inspect. - True if the given method should be proxied; false otherwise. - - - - Interface describing elements composing generated type - - - - - Performs some basic screening and invokes the - to select methods. - - - - - - - - - Provides functionality for disassembling instances of attributes to CustomAttributeBuilder form, during the process of emiting new types by Dynamic Proxy. - - - - - Disassembles given attribute instance back to corresponding CustomAttributeBuilder. - - An instance of attribute to disassemble - corresponding 1 to 1 to given attribute instance, or null reference. - - Implementers should return that corresponds to given attribute instance 1 to 1, - that is after calling specified constructor with specified arguments, and setting specified properties and fields with values specified - we should be able to get an attribute instance identical to the one passed in . Implementer can return null - if it wishes to opt out of replicating the attribute. Notice however, that for some cases, like attributes passed explicitly by the user - it is illegal to return null, and doing so will result in exception. - - - - - Handles error during disassembly process - - Type of the attribute being disassembled - Exception thrown during the process - usually null, or (re)throws the exception - - - - Here we try to match a constructor argument to its value. - Since we can't get the values from the assembly, we use some heuristics to get it. - a/ we first try to match all the properties on the attributes by name (case insensitive) to the argument - b/ if we fail we try to match them by property type, with some smarts about convertions (i,e: can use Guid for string). - - - - - We have the following rules here. - Try to find a matching type, failing that, if the parameter is string, get the first property (under the assumption that - we can convert it. - - - - - Attributes can only accept simple types, so we return null for null, - if the value is passed as string we call to string (should help with converting), - otherwise, we use the value as is (enums, integer, etc). - - - - - Returns list of all unique interfaces implemented given types, including their base interfaces. - - - - - - - Applied to the assemblies saved by in order to persist the cache data included in the persisted assembly. - - - - - Base class that exposes the common functionalities - to proxy generation. - - - - - It is safe to add mapping (no mapping for the interface exists) - - - - - - - - Generates a parameters constructor that initializes the proxy - state with just to make it non-null. - - This constructor is important to allow proxies to be XML serializable - - - - - - Generates the constructor for the class that extends - - - - - - - - - Default implementation of interface producing in-memory proxy assemblies. - - - - - Abstracts the implementation of proxy type construction. - - - - - Creates a proxy type for given , implementing , using provided. - - The class type to proxy. - Additional interface types to proxy. - The proxy generation options. - The generated proxy type. - - Implementers should return a proxy type for the specified class and interfaces. - Additional interfaces should be only 'mark' interfaces, that is, they should work like interface proxy without target. (See method.) - - Thrown when or any of is a generic type definition. - Thrown when or any of is not public. - Note that to avoid this exception, you can mark offending type internal, and define - pointing to Castle Dynamic Proxy assembly, in assembly containing that type, if this is appropriate. - - - - - Creates a proxy type that proxies calls to members on , implementing , using provided. - - The interface type to proxy. - Additional interface types to proxy. - Type implementing on which calls to the interface members should be intercepted. - The proxy generation options. - The generated proxy type. - - Implementers should return a proxy type for the specified interface that 'proceeds' executions to the specified target. - Additional interfaces should be only 'mark' interfaces, that is, they should work like interface proxy without target. (See method.) - - Thrown when or any of is a generic type definition. - Thrown when or any of is not public. - Note that to avoid this exception, you can mark offending type internal, and define - pointing to Castle Dynamic Proxy assembly, in assembly containing that type, if this is appropriate. - - - - - Creates a proxy type for given and that delegates all calls to the provided interceptors and allows interceptors to switch the actual target of invocation. - - The interface type to proxy. - Additional interface types to proxy. - The proxy generation options. - The generated proxy type. - - Implementers should return a proxy type for the specified interface(s) that delegate all executions to the specified interceptors - and uses an instance of the interface as their targets (i.e. ), rather than a class. All classes should then implement interface, - to allow interceptors to switch invocation target with instance of another type implementing called interface. - - Thrown when or any of is a generic type definition. - Thrown when or any of is not public. - Note that to avoid this exception, you can mark offending type internal, and define - pointing to Castle Dynamic Proxy assembly, in assembly containing that type, if this is appropriate. - - - - - Creates a proxy type for given that delegates all calls to the provided interceptors. - - The interface type to proxy. - Additional interface types to proxy. - The proxy generation options. - The generated proxy type. - - Implementers should return a proxy type for the specified interface and additional interfaces that delegate all executions to the specified interceptors. - - Thrown when or any of is a generic type definition. - Thrown when or any of is not public. - Note that to avoid this exception, you can mark offending type internal, and define - pointing to Castle Dynamic Proxy assembly, in assembly containing that type, if this is appropriate. - - - - - Gets or sets the that this logs to. - - - - - Gets the associated with this builder. - - The module scope associated with this builder. - - - - Initializes a new instance of the class with new . - - - - - Initializes a new instance of the class. - - The module scope for generated proxy types. - - - - Registers custom disassembler to handle disassembly of specified type of attributes. - - Type of attributes to handle - Disassembler converting existing instances of Attributes to CustomAttributeBuilders - - When disassembling an attribute Dynamic Proxy will first check if an custom disassembler has been registered to handle attributes of that type, - and if none is found, it'll use the . - - - - - Attributes should be replicated if they are non-inheritable, - but there are some special cases where the attributes means - something to the CLR, where they should be skipped. - - - - - Initializes a new instance of the class. - - Target element. This is either target type or target method for invocation types. - The type of the proxy. This is base type for invocation types. - The interfaces. - The options. - - - - Initializes a new instance of the class. - - Type of the target. - The interfaces. - The options. - - - - s - Provides appropriate Ldc.X opcode for the type of primitive value to be loaded. - - - - - Provides appropriate Ldind.X opcode for - the type of primitive value to be loaded indirectly. - - - - - Emits a load indirect opcode of the appropriate type for a value or object reference. - Pops a pointer off the evaluation stack, dereferences it and loads - a value of the specified type. - - - - - - - Emits a load opcode of the appropriate kind for a constant string or - primitive value. - - - - - - - Emits a load opcode of the appropriate kind for the constant default value of a - type, such as 0 for value types and null for reference types. - - - - - Emits a store indirectopcode of the appropriate type for a value or object reference. - Pops a value of the specified type and a pointer off the evaluation stack, and - stores the value. - - - - - - - Summary description for PropertiesCollection. - - - - - Wraps a reference that is passed - ByRef and provides indirect load/store support. - - - - - Summary description for NewArrayExpression. - - - - - - - - - Provides appropriate Stind.X opcode - for the type of primitive value to be stored indirectly. - - - - - Initializes a new instance of the class. - - The name. - Type declaring the original event being overriten, or null. - - The add method. - The remove method. - The attributes. - - - - Represents the scope of uniquenes of names for types and their members - - - - - Gets a unique name based on - - Name suggested by the caller - Unique name based on . - - Implementers should provide name as closely resembling as possible. - Generally if no collision occurs it is suggested to return suggested name, otherwise append sequential suffix. - Implementers must return deterministic names, that is when is called twice - with the same suggested name, the same returned name should be provided each time. Non-deterministic return - values, like appending random suffices will break serialization of proxies. - - - - - Returns new, disposable naming scope. It is responsibilty of the caller to make sure that no naming collision - with enclosing scope, or other subscopes is possible. - - New naming scope. - - - - Returns the methods implemented by a type. Use this instead of Type.GetMethods() to work around a CLR issue - where duplicate MethodInfos are returned by Type.GetMethods() after a token of a generic type's method was loaded. - - - - - Determines whether the specified method is internal. - - The method. - - true if the specified method is internal; otherwise, false. - - - - - Determines whether this assembly has internals visible to dynamic proxy. - - The assembly to inspect. - - - - Checks if the method is public or protected. - - - - - - - Because we need to cache the types based on the mixed in mixins, we do the following here: - - Get all the mixin interfaces - - Sort them by full name - - Return them by position - - The idea is to have reproducible behavior for the case that mixins are registered in different orders. - This method is here because it is required - - - - - Summary description for ModuleScope. - - - - - The default file name used when the assembly is saved using . - - - - - The default assembly (simple) name used for the assemblies generated by a instance. - - - - - Initializes a new instance of the class; assemblies created by this instance will not be saved. - - - - - Initializes a new instance of the class, allowing to specify whether the assemblies generated by this instance - should be saved. - - If set to true saves the generated module. - - - - Initializes a new instance of the class, allowing to specify whether the assemblies generated by this instance - should be saved. - - If set to true saves the generated module. - If set to true disables ability to generate signed module. This should be used in cases where ran under constrained permissions. - - - - Initializes a new instance of the class, allowing to specify whether the assemblies generated by this instance - should be saved and what simple names are to be assigned to them. - - If set to true saves the generated module. - If set to true disables ability to generate signed module. This should be used in cases where ran under constrained permissions. - The simple name of the strong-named assembly generated by this . - The path and file name of the manifest module of the strong-named assembly generated by this . - The simple name of the weak-named assembly generated by this . - The path and file name of the manifest module of the weak-named assembly generated by this . - - - - Initializes a new instance of the class, allowing to specify whether the assemblies generated by this instance - should be saved and what simple names are to be assigned to them. - - If set to true saves the generated module. - If set to true disables ability to generate signed module. This should be used in cases where ran under constrained permissions. - Naming scope used to provide unique names to generated types and their members (usually via sub-scopes). - The simple name of the strong-named assembly generated by this . - The path and file name of the manifest module of the strong-named assembly generated by this . - The simple name of the weak-named assembly generated by this . - The path and file name of the manifest module of the weak-named assembly generated by this . - - - - Returns a type from this scope's type cache, or null if the key cannot be found. - - The key to be looked up in the cache. - The type from this scope's type cache matching the key, or null if the key cannot be found - - - - Registers a type in this scope's type cache. - - The key to be associated with the type. - The type to be stored in the cache. - - - - Gets the key pair used to sign the strong-named assembly generated by this . - - - - - - Gets the specified module generated by this scope, creating a new one if none has yet been generated. - - If set to true, a strong-named module is returned; otherwise, a weak-named module is returned. - A strong-named or weak-named module generated by this scope, as specified by the parameter. - - - - Gets the strong-named module generated by this scope, creating a new one if none has yet been generated. - - A strong-named module generated by this scope. - - - - Gets the weak-named module generated by this scope, creating a new one if none has yet been generated. - - A weak-named module generated by this scope. - - - - Saves the generated assembly with the name and directory information given when this instance was created (or with - the and current directory if none was given). - - - - This method stores the generated assembly in the directory passed as part of the module information specified when this instance was - constructed (if any, else the current directory is used). If both a strong-named and a weak-named assembly - have been generated, it will throw an exception; in this case, use the overload. - - - If this was created without indicating that the assembly should be saved, this method does nothing. - - - Both a strong-named and a weak-named assembly have been generated. - The path of the generated assembly file, or null if no file has been generated. - - - - Saves the specified generated assembly with the name and directory information given when this instance was created - (or with the and current directory if none was given). - - True if the generated assembly with a strong name should be saved (see ); - false if the generated assembly without a strong name should be saved (see . - - - This method stores the specified generated assembly in the directory passed as part of the module information specified when this instance was - constructed (if any, else the current directory is used). - - - If this was created without indicating that the assembly should be saved, this method does nothing. - - - No assembly has been generated that matches the parameter. - - The path of the generated assembly file, or null if no file has been generated. - - - - Loads the generated types from the given assembly into this 's cache. - - The assembly to load types from. This assembly must have been saved via or - , or it must have the manually applied. - - This method can be used to load previously generated and persisted proxy types from disk into this scope's type cache, eg. in order - to avoid the performance hit associated with proxy generation. - - - - - Users of this should use this lock when accessing the cache. - - - - - Gets the strong-named module generated by this scope, or if none has yet been generated. - - The strong-named module generated by this scope, or if none has yet been generated. - - - - Gets the file name of the strongly named module generated by this scope. - - The file name of the strongly named module generated by this scope. - - - - Gets the directory where the strongly named module generated by this scope will be saved, or if the current directory - is used. - - The directory where the strongly named module generated by this scope will be saved when is called - (if this scope was created to save modules). - - - - Gets the weak-named module generated by this scope, or if none has yet been generated. - - The weak-named module generated by this scope, or if none has yet been generated. - - - - Gets the file name of the weakly named module generated by this scope. - - The file name of the weakly named module generated by this scope. - - - - Gets the directory where the weakly named module generated by this scope will be saved, or if the current directory - is used. - - The directory where the weakly named module generated by this scope will be saved when is called - (if this scope was created to save modules). - - - - ProxyBuilder that persists the generated type. - - - The saved assembly contains just the last generated type. - - - - - Initializes a new instance of the class. - - - - - Saves the generated assembly to a physical file. Note that this renders the unusable. - - The path of the generated assembly file, or null if no assembly has been generated. - - This method does not support saving multiple files. If both a signed and an unsigned module have been generated, use the - respective methods of the . - - - - - Initializes a new instance of the class. - - The hook. - - - - Initializes a new instance of the class. - - - - - Provides proxy objects for classes and interfaces. - - - - - Initializes a new instance of the class. - - Proxy types builder. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - If true forces all types to be generated into an unsigned module. - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - Object proxying calls to members of on object. - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of types on generated target object. - - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - As a result of that also at least one implementation must be provided. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of types on generated target object. - - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - As a result of that also at least one implementation must be provided. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of types on generated target object. - - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - As a result of that also at least one implementation must be provided. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The proxy generation options used to influence generated proxy type and object. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no parameterless constructor exists on type . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The proxy generation options used to influence generated proxy type and object. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no parameterless constructor exists on type . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The proxy generation options used to influence generated proxy type and object. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates the proxy type for class proxy with given class, implementing given and using provided . - - The base class for proxy type. - The interfaces that proxy type should implement. - The options for proxy generation process. - of proxy. - - - - Creates the proxy type for interface proxy with target for given interface, implementing given on given and using provided . - - The interface proxy type should implement. - The additional interfaces proxy type should implement. - Actual type that the proxy type will encompass. - The options for proxy generation process. - of proxy. - - - - Creates the proxy type for interface proxy with target interface for given interface, implementing given on given and using provided . - - The interface proxy type should implement. - The additional interfaces proxy type should implement. - The options for proxy generation process. - of proxy. - - - - Creates the proxy type for interface proxy without target for given interface, implementing given and using provided . - - The interface proxy type should implement. - The additional interfaces proxy type should implement. - The options for proxy generation process. - of proxy. - - - - Gets or sets the that this log to. - - - - - Gets the proxy builder instance used to generate proxy types. - - The proxy builder. - - - - - - - - - - - - - For interface proxies, this will point to the - on the target class - - - - - Handles the deserialization of proxies. - - - - - Resets the used for deserialization to a new scope. - - - This is useful for test cases. - - - - - Resets the used for deserialization to a given . - - The scope to be used for deserialization. - - By default, the deserialization process uses a different scope than the rest of the application, which can lead to multiple proxies - being generated for the same type. By explicitly setting the deserialization scope to the application's scope, this can be avoided. - - - - - Gets the used for deserialization. - - As has no way of automatically determining the scope used by the application (and the application might use more than one scope at the same time), uses a dedicated scope instance for deserializing proxy types. This instance can be reset and set to a specific value via and . - - - - Holds objects representing methods of class. - - - - - Holds objects representing methods of class. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Provides an extension point that allows proxies to choose specific interceptors on - a per method basis. - - - - - Selects the interceptors that should intercept calls to the given . - - The type declaring the method to intercept. - The method that will be intercepted. - All interceptors registered with the proxy. - An array of interceptors to invoke upon calling the . - - This method is called only once per proxy instance, upon the first call to the - . Either an empty array or null are valid return values to indicate - that no interceptor should intercept calls to the method. Although it is not advised, it is - legal to return other implementations than these provided in - . - - - - - Creates a new lock. - - - - - - This interface should be implemented by classes - that are available in a bigger context, exposing - the container to different areas in the same application. - - For example, in Web application, the (global) HttpApplication - subclasses should implement this interface to expose - the configured container - - - - - - Exposes means to change target objects of proxies and invocations - - - - - Changes the target object () of current . - - The new value of target of invocation. - - Although the method takes the actual instance must be of type assignable to , otherwise an will be thrown. - Also while it's technically legal to pass null reference (Nothing in Visual Basic) as , for obvious reasons Dynamic Proxy will not be able to call the intercepted method on such target. - In this case last interceptor in the pipeline mustn't call or a will be throws. - Also while it's technically legal to pass proxy itself as , this would create stack overflow. - In this case last interceptor in the pipeline mustn't call or a will be throws. - - Thrown when is not assignable to the proxied type. - - - - Permanently changes the target object of the proxy. This does not affect target of the current invocation. - - The new value of target of the proxy. - - Although the method takes the actual instance must be of type assignable to proxy's target type, otherwise an will be thrown. - Also while it's technically legal to pass null reference (Nothing in Visual Basic) as , for obvious reasons Dynamic Proxy will not be able to call the intercepted method on such target. - In this case last interceptor in the pipeline mustn't call or a will be throws. - Also while it's technically legal to pass proxy itself as , this would create stack overflow. - In this case last interceptor in the pipeline mustn't call or a will be throws. - - Thrown when is not assignable to the proxied type. - - - - New interface that is going to be used by DynamicProxy 2 - - - - - Get the proxy target (note that null is a valid target!) - - - - - - Gets the interceptors for the proxy - - - - - - Defines that the implementation wants a - in order to - access other components. The creator must be aware - that the component might (or might not) implement - the interface. - - - Used by Castle Project components to, for example, - gather logging factories - - - - - Increments IServiceProvider with a generic service resolution operation. - - - - - Provides a factory that can produce either or - classes. - - - - - Manages the instantiation of s. - - - - - Creates a new logger, getting the logger name from the specified type. - - - - - Creates a new logger. - - - - - Creates a new logger, getting the logger name from the specified type. - - - - - Creates a new logger. - - - - - Creates a new extended logger, getting the logger name from the specified type. - - - - - Creates a new extended logger. - - - - - Creates a new extended logger, getting the logger name from the specified type. - - - - - Creates a new extended logger. - - - - - Creates a new extended logger, getting the logger name from the specified type. - - - - - Creates a new extended logger. - - - - - Creates a new extended logger, getting the logger name from the specified type. - - - - - Creates a new extended logger. - - - - - Creates a new logger, getting the logger name from the specified type. - - - - - Creates a new logger. - - - - - Creates a new logger, getting the logger name from the specified type. - - - - - Creates a new logger. - - - - - Gets the configuration file. - - i.e. log4net.config - - - - - Used to create the TraceLogger implementation of ILogger interface. See . - - - - - Gets the configuration file. - - i.e. log4net.config - - - - - Interface for Context Properties implementations - - - - This interface defines a basic property get set accessor. - - - Based on the ContextPropertiesBase of log4net, by Nicko Cadell. - - - - - - Gets or sets the value of a property - - - The value for the property with the specified key - - - - Gets or sets the value of a property - - - - - - NullLogFactory used when logging is turned off. - - - - - Creates an instance of ILogger with the specified name. - - Name. - - - - - Creates an instance of ILogger with the specified name and LoggerLevel. - - Name. - Level. - - - - - Creates outputing - to files. The name of the file is derived from the log name - plus the 'log' extension. - - - - - Provides an interface that supports and - allows the storage and retrieval of Contexts. These are supported in - both log4net and NLog. - - - - - Manages logging. - - - This is a facade for the different logging subsystems. - It offers a simplified interface that follows IOC patterns - and a simplified priority/level/severity abstraction. - - - - - Create a new child logger. - The name of the child logger is [current-loggers-name].[passed-in-name] - - The Subname of this logger. - The New ILogger instance. - If the name has an empty element name. - - - - Logs a debug message. - - The message to log - - - - Logs a debug message with lazily constructed message. The message will be constructed only if the is true. - - - - - - Logs a debug message. - - The exception to log - The message to log - - - - Logs a debug message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The message to log - - - - Logs an error message with lazily constructed message. The message will be constructed only if the is true. - - - - - - Logs an error message. - - The exception to log - The message to log - - - - Logs an error message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The message to log - - - - Logs a fatal message with lazily constructed message. The message will be constructed only if the is true. - - - - - - Logs a fatal message. - - The exception to log - The message to log - - - - Logs a fatal message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The message to log - - - - Logs a info message with lazily constructed message. The message will be constructed only if the is true. - - - - - - Logs an info message. - - The exception to log - The message to log - - - - Logs an info message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The message to log - - - - Logs a warn message with lazily constructed message. The message will be constructed only if the is true. - - - - - - Logs a warn message. - - The exception to log - The message to log - - - - Logs a warn message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Determines if messages of priority "debug" will be logged. - - True if "debug" messages will be logged. - - - - Determines if messages of priority "error" will be logged. - - True if "error" messages will be logged. - - - - Determines if messages of priority "fatal" will be logged. - - True if "fatal" messages will be logged. - - - - Determines if messages of priority "info" will be logged. - - True if "info" messages will be logged. - - - - Determines if messages of priority "warn" will be logged. - - True if "warn" messages will be logged. - - - - Exposes the Global Context of the extended logger. - - - - - Exposes the Thread Context of the extended logger. - - - - - Exposes the Thread Stack of the extended logger. - - - - - The Logger sending everything to the standard output streams. - This is mainly for the cases when you have a utility that - does not have a logger to supply. - - - - - The Level Filtered Logger class. This is a base clase which - provides a LogLevel attribute and reroutes all functions into - one Log method. - - - - - Creates a new LevelFilteredLogger. - - - - - Keep the instance alive in a remoting scenario - - - - - - Logs a debug message. - - The message to log - - - - Logs a debug message. - - The exception to log - The message to log - - - - Logs a debug message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The message to log - - - - Logs an info message. - - The exception to log - The message to log - - - - Logs an info message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The message to log - - - - Logs a warn message. - - The exception to log - The message to log - - - - Logs a warn message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The message to log - - - - Logs an error message. - - The exception to log - The message to log - - - - Logs an error message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The message to log - - - - Logs a fatal message. - - The exception to log - The message to log - - - - Logs a fatal message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Implementors output the log content by implementing this method only. - Note that exception can be null - - - - - - - - - The LoggerLevel that this logger - will be using. Defaults to LoggerLevel.Off - - - - - The name that this logger will be using. - Defaults to String.Empty - - - - - Determines if messages of priority "debug" will be logged. - - true if log level flags include the bit - - - - Determines if messages of priority "info" will be logged. - - true if log level flags include the bit - - - - Determines if messages of priority "warn" will be logged. - - true if log level flags include the bit - - - - Determines if messages of priority "error" will be logged. - - true if log level flags include the bit - - - - Determines if messages of priority "fatal" will be logged. - - true if log level flags include the bit - - - - Creates a new ConsoleLogger with the Level - set to LoggerLevel.Debug and the Name - set to String.Empty. - - - - - Creates a new ConsoleLogger with the Name - set to String.Empty. - - The logs Level. - - - - Creates a new ConsoleLogger with the Level - set to LoggerLevel.Debug. - - The logs Name. - - - - Creates a new ConsoleLogger. - - The logs Name. - The logs Level. - - - - A Common method to log. - - The level of logging - The name of the logger - The Message - The Exception - - - - Returns a new ConsoleLogger with the name - added after this loggers name, with a dot in between. - - The added hierarchical name. - A new ConsoleLogger. - - - - The Logger using standart Diagnostics namespace. - - - - - Creates a logger based on . - - - - - - Creates a logger based on . - - - - - - - Creates a logger based on . - - - - - - - - The Null Logger class. This is useful for implementations where you need - to provide a logger to a utility class, but do not want any output from it. - It also helps when you have a utility that does not have a logger to supply. - - - - - Returns this NullLogger. - - Ignored - This ILogger instance. - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - Returns empty context properties. - - - - - Returns empty context properties. - - - - - Returns empty context stacks. - - - - - No-op. - - false - - - - No-op. - - false - - - - No-op. - - false - - - - No-op. - - false - - - - No-op. - - false - - - - The Stream Logger class. This class can stream log information - to any stream, it is suitable for storing a log file to disk, - or to a MemoryStream for testing your components. - - - This logger is not thread safe. - - - - - Creates a new StreamLogger with default encoding - and buffer size. Initial Level is set to Debug. - - - The name of the log. - - - The stream that will be used for logging, - seeking while the logger is alive - - - - - Creates a new StreamLogger with default buffer size. - Initial Level is set to Debug. - - - The name of the log. - - - The stream that will be used for logging, - seeking while the logger is alive - - - The encoding that will be used for this stream. - - - - - - Creates a new StreamLogger. - Initial Level is set to Debug. - - - The name of the log. - - - The stream that will be used for logging, - seeking while the logger is alive - - - The encoding that will be used for this stream. - - - - The buffer size that will be used for this stream. - - - - - - Creates a new StreamLogger with - Debug as default Level. - - The name of the log. - The StreamWriter the log will write to. - - - - The TraceLogger sends all logging to the System.Diagnostics.TraceSource - built into the .net framework. - - - Logging can be configured in the system.diagnostics configuration - section. - - If logger doesn't find a source name with a full match it will - use source names which match the namespace partially. For example you can - configure from all castle components by adding a source name with the - name "Castle". - - If no portion of the namespace matches the source named "Default" will - be used. - - - - - Build a new trace logger based on the named TraceSource - - The name used to locate the best TraceSource. In most cases comes from the using type's fullname. - - - - Build a new trace logger based on the named TraceSource - - The name used to locate the best TraceSource. In most cases comes from the using type's fullname. - The default logging level at which this source should write messages. In almost all cases this - default value will be overridden in the config file. - - - - Create a new child logger. - The name of the child logger is [current-loggers-name].[passed-in-name] - - The Subname of this logger. - The New ILogger instance. - - - - This is an abstract implementation - that deals with methods that can be abstracted away - from underlying implementations. - - - AbstractConfiguration makes easier to implementers - to create a new version of - - - - - is a interface encapsulating a configuration node - used to retrieve configuration values. - - - - - Gets the value of the node and converts it - into specified . - - The - - The Default value returned if the conversion fails. - - The Value converted into the specified type. - - - - Gets the name of the node. - - - The Name of the node. - - - - - Gets the value of the node. - - - The Value of the node. - - - - - Gets an of - elements containing all node children. - - The Collection of child nodes. - - - - Gets an of the configuration attributes. - - - - - Gets the value of the node and converts it - into specified . - - The - - The Default value returned if the conversion fails. - - The Value converted into the specified type. - - - - Gets node attributes. - - - All attributes of the node. - - - - - Gets all child nodes. - - The of child nodes. - - - - Gets the name of the . - - - The Name of the . - - - - - Gets the value of . - - - The Value of the . - - - - - A collection of objects. - - - - - Creates a new instance of ConfigurationCollection. - - - - - Creates a new instance of ConfigurationCollection. - - - - - Summary description for MutableConfiguration. - - - - - Initializes a new instance of the class. - - The name. - - - - Gets the value of . - - - The Value of the . - - - - - Deserializes the specified node into an abstract representation of configuration. - - The node. - - - - - If a config value is an empty string we return null, this is to keep - backward compatibility with old code - - - - - General purpose class to represent a standard pair of values. - - Type of the first value - Type of the second value - - - - Constructs a pair with its values - - - - - - - List of utility methods related to dynamic proxy operations - - - - - Determines whether the specified type is a proxy generated by - DynamicProxy (1 or 2). - - The type. - - true if it is a proxy; otherwise, false. - - - - - Readonly implementation of which uses an anonymous object as its source. Uses names of properties as keys, and property values as... well - values. Keys are not case sensitive. - - - - - Initializes a new instance of the class. - - The target. - - - - Adds an element with the provided key and value to the object. - - The to use as the key of the element to add. - The to use as the value of the element to add. - - is null. - An element with the same key already exists in the object. - The is read-only.-or- The has a fixed size. - - - - Removes all elements from the object. - - The object is read-only. - - - - Determines whether the object contains an element with the specified key. - - The key to locate in the object. - - true if the contains an element with the key; otherwise, false. - - - is null. - - - - Removes the element with the specified key from the object. - - The key of the element to remove. - - is null. - The object is read-only.-or- The has a fixed size. - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - - - - Copies the elements of the to an , starting at a particular index. - - The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing. - The zero-based index in at which copying begins. - - is null. - - is less than zero. - - is multidimensional.-or- is equal to or greater than the length of .-or- The number of elements in the source is greater than the available space from to the end of the destination . - The type of the source cannot be cast automatically to the type of the destination . - - - - Returns an object for the object. - - - An object for the object. - - - - - Reads values of properties from and inserts them into using property names as keys. - - - - - - - Gets the number of elements contained in the . - - - The number of elements contained in the . - - - - Gets a value indicating whether access to the is synchronized (thread safe). - - - true if access to the is synchronized (thread safe); otherwise, false. - - - - Gets an object that can be used to synchronize access to the . - - - An object that can be used to synchronize access to the . - - - - Gets a value indicating whether the object is read-only. - - - true if the object is read-only; otherwise, false. - - - - Gets or sets the with the specified key. - - - - - - Gets an object containing the keys of the object. - - - An object containing the keys of the object. - - - - Gets an object containing the values in the object. - - - An object containing the values in the object. - - - - Gets a value indicating whether the object has a fixed size. - - - true if the object has a fixed size; otherwise, false. - - - - Represents a 'streamable' resource. Can - be a file, a resource in an assembly. - - - - - Returns a reader for the stream - - - It's up to the caller to dispose the reader. - - - - - - Returns a reader for the stream - - - It's up to the caller to dispose the reader. - - - - - - - Returns an instance of - created according to the relativePath - using itself as the root. - - - - - - - - - - Only valid for resources that - can be obtained through relative paths - - - - - - - - - - This returns a new stream instance each time it is called. - It is the responsibility of the caller to dispose of this stream - - - - - Depicts the contract for resource factories. - - - - - Used to check whether the resource factory - is able to deal with the given resource - identifier. - - - Implementors should return true - only if the given identifier is supported - by the resource factory - - - - - - - Creates an instance - for the given resource identifier - - - - - - - Creates an instance - for the given resource identifier - - - - - - - - - - - - - - - - - - Adapts a static string content as an - - - - - Enable access to files on network shares - - - - - Email sender abstraction. - - - - - Sends a mail message. - - From field - To field - E-mail's subject - message's body - - - - Sends a message. - - Message instance - - - - Sends multiple messages. - - List of messages - - - - Default implementation. - - - - - Initializes a new instance of the class based on the configuration provided in the application configuration file. - - - This constructor is based on the default configuration in the application configuration file. - - - - - This service implementation - requires a host name in order to work - - The smtp server name - - - - Sends a message. - - If any of the parameters is null - From field - To field - e-mail's subject - message's body - - - - Sends a message. - - If the message is null - Message instance - - - - Configures the sender - with port information and eventual credential - informed - - Message instance - - - - Gets or sets the port used to - access the SMTP server - - - - - Gets the hostname. - - The hostname. - - - - Gets or sets a value which is used to - configure if emails are going to be sent asynchronously or not. - - - - - Gets or sets a value that specifies - the amount of time after which a synchronous Send call times out. - - - - - Gets or sets a value indicating whether the email should be sent using - a secure communication channel. - - true if should use SSL; otherwise, false. - - - - Gets or sets the domain. - - The domain. - - - - Gets or sets the name of the user. - - The name of the user. - - - - Gets or sets the password. - - The password. - - - - Gets a value indicating whether credentials were informed. - - - if this instance has credentials; otherwise, . - - - - diff --git a/packages/Castle.Core.3.3.3/lib/net40-client/Castle.Core.dll b/packages/Castle.Core.3.3.3/lib/net40-client/Castle.Core.dll deleted file mode 100644 index 864f535..0000000 Binary files a/packages/Castle.Core.3.3.3/lib/net40-client/Castle.Core.dll and /dev/null differ diff --git a/packages/Castle.Core.3.3.3/lib/net40-client/Castle.Core.xml b/packages/Castle.Core.3.3.3/lib/net40-client/Castle.Core.xml deleted file mode 100644 index 75d0a4b..0000000 --- a/packages/Castle.Core.3.3.3/lib/net40-client/Castle.Core.xml +++ /dev/null @@ -1,4774 +0,0 @@ - - - - Castle.Core - - - - - Specifies assignment by reference rather than by copying. - - - - - Suppresses any on-demand behaviors. - - - - - Removes a property if null or empty string, guid or collection. - - - - - Removes a property if matches value. - - - - - Assigns a specific dictionary key. - - - - - Defines the contract for customizing dictionary access. - - - - - Copies the dictionary behavior. - - null if should not be copied. Otherwise copy. - - - - Determines relative order to apply related behaviors. - - - - - Defines the contract for updating dictionary values. - - - - - Sets the stored dictionary value. - - The dictionary adapter. - The key. - The stored value. - The property. - true if the property should be stored. - - - - Contract for value matching. - - - - - Indicates that underlying values are changeable and should not be cached. - - - - - Contract for dictionary initialization. - - - - - Performs any initialization of the - - The dictionary adapter. - The dictionary behaviors. - - - - Abstract implementation of . - - - - - Conract for traversing a . - - - - - Contract for creating additional Dictionary adapters. - - - - - Contract for manipulating the Dictionary adapter. - - - - - Contract for editing the Dictionary adapter. - - - - - Contract for managing Dictionary adapter notifications. - - - - - Contract for validating Dictionary adapter. - - - - - Defines the contract for building s. - - - - - Builds the dictionary behaviors. - - - - - - Abstract adapter for the support - needed by the - - - - - Adds an element with the provided key and value to the object. - - The to use as the key of the element to add. - The to use as the value of the element to add. - An element with the same key already exists in the object. - key is null. - The is read-only.-or- The has a fixed size. - - - - Removes all elements from the object. - - The object is read-only. - - - - Determines whether the object contains an element with the specified key. - - The key to locate in the object. - - true if the contains an element with the key; otherwise, false. - - key is null. - - - - Returns an object for the object. - - - An object for the object. - - - - - Removes the element with the specified key from the object. - - The key of the element to remove. - The object is read-only.-or- The has a fixed size. - key is null. - - - - Copies the elements of the to an , starting at a particular index. - - The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing. - The zero-based index in array at which copying begins. - array is null. - The type of the source cannot be cast automatically to the type of the destination array. - index is less than zero. - array is multidimensional.-or- index is equal to or greater than the length of array.-or- The number of elements in the source is greater than the available space from index to the end of the destination array. - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - - - - Gets a value indicating whether the object has a fixed size. - - - true if the object has a fixed size; otherwise, false. - - - - Gets a value indicating whether the object is read-only. - - - true if the object is read-only; otherwise, false. - - - - Gets an object containing the keys of the object. - - - An object containing the keys of the object. - - - - Gets an object containing the values in the object. - - - An object containing the values in the object. - - - - Gets or sets the with the specified key. - - - - - - Gets the number of elements contained in the . - - - The number of elements contained in the . - - - - Gets a value indicating whether access to the is synchronized (thread safe). - - - true if access to the is synchronized (thread safe); otherwise, false. - - - - Gets an object that can be used to synchronize access to the . - - - An object that can be used to synchronize access to the . - - - - Provides a generic collection that supports data binding. - - - This class wraps the CLR - in order to implement the Castle-specific . - - The type of elements in the list. - - - - Initializes a new instance of the class - using default values. - - - - - Initializes a new instance of the class - with the specified list. - - - An of items - to be contained in the . - - - - - Initializes a new instance of the class - wrapping the specified instance. - - - A - to be wrapped by the . - - - - - Defines the contract for retrieving dictionary values. - - - - - Gets the effective dictionary value. - - The dictionary adapter. - The key. - The stored value. - The property. - true if return only existing. - The effective property value. - - - - Initializes a new instance of the class - that represents a child object in a larger object graph. - - - - - - - Contract for dictionary meta-data initialization. - - - - - Initializes the given object. - - The dictionary adapter factory. - The dictionary adapter meta. - - - - - Determines whether the given behavior should be included in a new - object. - - A dictionary behavior or annotation. - True if the behavior should be included; otherwise, false. - - behaviors are always included, - regardless of the result of this method. - - - - - - Checks whether or not collection is null or empty. Assumes colleciton can be safely enumerated multiple times. - - - - - - - Creates a message to inform clients that a proxy couldn't be created due to reliance on an - inaccessible type (perhaps itself). - - the inaccessible type that prevents proxy creation - the type that couldn't be proxied - - - - Find the best available name to describe a type. - - - Usually the best name will be , but - sometimes that's null (see http://msdn.microsoft.com/en-us/library/system.type.fullname%28v=vs.110%29.aspx) - in which case the method falls back to . - - the type to name - the best name - - - - Constant to use when making assembly internals visible to Castle.Core - [assembly: InternalsVisibleTo(CoreInternalsVisible.ToCastleCore)] - - - - - Constant to use when making assembly internals visible to proxy types generated by DynamicProxy. Required when proxying internal types. - [assembly: InternalsVisibleTo(CoreInternalsVisible.ToDynamicProxyGenAssembly2)] - - - - - Identifies a property should be represented as a nested component. - - - - - Defines the contract for building typed dictionary keys. - - - - - Builds the specified key. - - The dictionary adapter. - The current key. - The property. - The updated key - - - - Applies no prefix. - - - - - Gets or sets the prefix. - - The prefix. - - - - Identifies the dictionary adapter types. - - - - - Identifies an interface or property to be pre-fetched. - - - - - Instructs fetching to occur. - - - - - Instructs fetching according to - - - - - - Gets whether or not fetching should occur. - - - - - Assigns a property to a group. - - - - - Constructs a group assignment. - - The group name. - - - - Constructs a group assignment. - - The group name. - - - - Gets the group the property is assigned to. - - - - - Assigns a specific dictionary key. - - - - - Initializes a new instance of the class. - - The key. - - - - Initializes a new instance of the class. - - The compound key. - - - - Assigns a prefix to the keyed properties of an interface. - - - Key prefixes are not inherited by sub-interfaces. - - - - - Initializes a default instance of the class. - - - - - Initializes a new instance of the class. - - The prefix for the keyed properties of the interface. - - - - Gets the prefix key added to the properties of the interface. - - - - - Substitutes part of key with another string. - - - - - Initializes a new instance of the class. - - The old value. - The new value. - - - - Requests support for multi-level editing. - - - - - Generates a new GUID on demand. - - - - - Support for on-demand value resolution. - - - - - Provides simple string formatting from existing properties. - - - - - Gets the string format. - - - - - Gets the format properties. - - - - - Identifies a property should be represented as a delimited string value. - - - - - Gets the separator. - - - - - Converts all properties to strings. - - - - - Gets or sets the format. - - The format. - - - - Suppress property change notifications. - - - - - Contract for property descriptor initialization. - - - - - Performs any initialization of the - - The property descriptor. - The property behaviors. - - - - Assigns a prefix to the keyed properties using the interface name. - - - - - Manages conversion between property values. - - - - - Initializes a new instance of the class. - - The converter. - - - - Gets the effective dictionary value. - - The dictionary adapter. - The key. - The stored value. - The property. - true if return only existing. - The effective property value. - - - - - - - - - Uses Reflection.Emit to expose the properties of a dictionary - through a dynamic implementation of a typed interface. - - - - - Defines the contract for building typed dictionary adapters. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - An implementation of the typed interface bound to the dictionary. - - The type represented by T must be an interface with properties. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - An implementation of the typed interface bound to the dictionary. - - The type represented by T must be an interface with properties. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - The property descriptor. - An implementation of the typed interface bound to the dictionary. - - The type represented by T must be an interface with properties. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - An implementation of the typed interface bound to the namedValues. - - The type represented by T must be an interface with properties. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - An implementation of the typed interface bound to the namedValues. - - The type represented by T must be an interface with properties. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - An implementation of the typed interface bound to the . - - The type represented by T must be an interface with properties. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - An implementation of the typed interface bound to the . - - The type represented by T must be an interface with properties. - - - - - Gets the associated with the type. - - The typed interface. - The adapter meta-data. - - - - Gets the associated with the type. - - The typed interface. - The property descriptor. - The adapter meta-data. - - - - Gets the associated with the type. - - The typed interface. - Another from which to copy behaviors. - The adapter meta-data. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Contract for dictionary validation. - - - - - Determines if is valid. - - The dictionary adapter. - true if valid. - - - - Validates the . - - The dictionary adapter. - The error summary information. - - - - Validates the for a property. - - The dictionary adapter. - The property to validate. - The property summary information. - - - - Invalidates any results cached by the validator. - - The dictionary adapter. - - - - - - - - - Initializes a new instance of the class. - - The name values. - - - - Determines whether the object contains an element with the specified key. - - The key to locate in the object. - - true if the contains an element with the key; otherwise, false. - - key is null. - - - - Adapts the specified name values. - - The name values. - - - - - Gets a value indicating whether the object is read-only. - - - true if the object is read-only; otherwise, false. - - - - Gets or sets the with the specified key. - - - - - - Describes a dictionary property. - - - - - Initializes an empty class. - - - - - Initializes a new instance of the class. - - The property. - The annotations. - - - - Initializes a new instance class. - - - - - Copies an existinginstance of the class. - - - - - - - Gets the key. - - The dictionary adapter. - The key. - The descriptor. - - - - - Gets the property value. - - The dictionary adapter. - The key. - The stored value. - The descriptor. - true if return only existing. - - - - - Sets the property value. - - The dictionary adapter. - The key. - The value. - The descriptor. - - - - - Adds a single behavior. - - The behavior. - - - - Adds the behaviors. - - The behaviors. - - - - Adds the behaviors. - - The behaviors. - - - - Copies the behaviors to the other - - - - - - - Copies the - - - - - - - - - - - Gets the property name. - - - - - Gets the property type. - - - - - Gets the property. - - The property. - - - - Returns true if the property is dynamic. - - - - - Gets additional state. - - - - - Determines if property should be fetched. - - - - - Determines if property must exist first. - - - - - Determines if notifications should occur. - - - - - Gets the property behaviors. - - - - - Gets the type converter. - - The type converter. - - - - Gets the extended properties. - - - - - Gets the setter. - - The setter. - - - - Gets the key builders. - - The key builders. - - - - Gets the setter. - - The setter. - - - - Gets the getter. - - The getter. - - - - Gets the initializers. - - The initializers. - - - - Gets the meta-data initializers. - - The meta-data initializers. - - - - Helper class for retrieving attributes. - - - - - Gets the attribute. - - The member. - The member attribute. - - - - Gets the attributes. Does not consider inherited attributes! - - The member. - The member attributes. - - - - Gets the type attribute. - - The type. - The type attribute. - - - - Gets the type attributes. - - The type. - The type attributes. - - - - Gets the type converter. - - The member. - - - - - Gets the attribute. - - The member. - The member attribute. - - - - Contract for typed dynamic value resolution. - - - - - - Contract for dynamic value resolution. - - - - - Supporting Logger levels. - - - - - Logging will be off - - - - - Fatal logging level - - - - - Error logging level - - - - - Warn logging level - - - - - Info logging level - - - - - Debug logging level - - - - - Encapsulates an invocation of a proxied method. - - - - - Gets the value of the argument at the specified . - - The index. - The value of the argument at the specified . - - - - Returns the concrete instantiation of the on the proxy, with any generic - parameters bound to real types. - - - The concrete instantiation of the on the proxy, or the if - not a generic method. - - - Can be slower than calling . - - - - - Returns the concrete instantiation of , with any - generic parameters bound to real types. - For interface proxies, this will point to the on the target class. - - The concrete instantiation of , or - if not a generic method. - - In debug builds this can be slower than calling . - - - - - Proceeds the call to the next interceptor in line, and ultimately to the target method. - - - Since interface proxies without a target don't have the target implementation to proceed to, - it is important, that the last interceptor does not call this method, otherwise a - will be thrown. - - - - - Overrides the value of an argument at the given with the - new provided. - - - This method accepts an , however the value provided must be compatible - with the type of the argument defined on the method, otherwise an exception will be thrown. - - The index of the argument to override. - The new value for the argument. - - - - Gets the arguments that the has been invoked with. - - The arguments the method was invoked with. - - - - Gets the generic arguments of the method. - - The generic arguments, or null if not a generic method. - - - - Gets the object on which the invocation is performed. This is different from proxy object - because most of the time this will be the proxy target object. - - - The invocation target. - - - - Gets the representing the method being invoked on the proxy. - - The representing the method being invoked. - - - - For interface proxies, this will point to the on the target class. - - The method invocation target. - - - - Gets the proxy object on which the intercepted method is invoked. - - Proxy object on which the intercepted method is invoked. - - - - Gets or sets the return value of the method. - - The return value of the method. - - - - Gets the type of the target object for the intercepted method. - - The type of the target object. - - - - Used during the target type inspection process. Implementors have a chance to customize the - proxy generation process. - - - - - Invoked by the generation process to notify that the whole process has completed. - - - - - Invoked by the generation process to notify that a member was not marked as virtual. - - The type which declares the non-virtual member. - The non-virtual member. - - This method gives an opportunity to inspect any non-proxyable member of a type that has - been requested to be proxied, and if appropriate - throw an exception to notify the caller. - - - - - Invoked by the generation process to determine if the specified method should be proxied. - - The type which declares the given method. - The method to inspect. - True if the given method should be proxied; false otherwise. - - - - Interface describing elements composing generated type - - - - - Performs some basic screening and invokes the - to select methods. - - - - - - - - - Provides functionality for disassembling instances of attributes to CustomAttributeBuilder form, during the process of emiting new types by Dynamic Proxy. - - - - - Disassembles given attribute instance back to corresponding CustomAttributeBuilder. - - An instance of attribute to disassemble - corresponding 1 to 1 to given attribute instance, or null reference. - - Implementers should return that corresponds to given attribute instance 1 to 1, - that is after calling specified constructor with specified arguments, and setting specified properties and fields with values specified - we should be able to get an attribute instance identical to the one passed in . Implementer can return null - if it wishes to opt out of replicating the attribute. Notice however, that for some cases, like attributes passed explicitly by the user - it is illegal to return null, and doing so will result in exception. - - - - - Handles error during disassembly process - - Type of the attribute being disassembled - Exception thrown during the process - usually null, or (re)throws the exception - - - - Here we try to match a constructor argument to its value. - Since we can't get the values from the assembly, we use some heuristics to get it. - a/ we first try to match all the properties on the attributes by name (case insensitive) to the argument - b/ if we fail we try to match them by property type, with some smarts about convertions (i,e: can use Guid for string). - - - - - We have the following rules here. - Try to find a matching type, failing that, if the parameter is string, get the first property (under the assumption that - we can convert it. - - - - - Attributes can only accept simple types, so we return null for null, - if the value is passed as string we call to string (should help with converting), - otherwise, we use the value as is (enums, integer, etc). - - - - - Returns list of all unique interfaces implemented given types, including their base interfaces. - - - - - - - Applied to the assemblies saved by in order to persist the cache data included in the persisted assembly. - - - - - Base class that exposes the common functionalities - to proxy generation. - - - - - It is safe to add mapping (no mapping for the interface exists) - - - - - - - - Generates a parameters constructor that initializes the proxy - state with just to make it non-null. - - This constructor is important to allow proxies to be XML serializable - - - - - - Generates the constructor for the class that extends - - - - - - - - - Default implementation of interface producing in-memory proxy assemblies. - - - - - Abstracts the implementation of proxy type construction. - - - - - Creates a proxy type for given , implementing , using provided. - - The class type to proxy. - Additional interface types to proxy. - The proxy generation options. - The generated proxy type. - - Implementers should return a proxy type for the specified class and interfaces. - Additional interfaces should be only 'mark' interfaces, that is, they should work like interface proxy without target. (See method.) - - Thrown when or any of is a generic type definition. - Thrown when or any of is not public. - Note that to avoid this exception, you can mark offending type internal, and define - pointing to Castle Dynamic Proxy assembly, in assembly containing that type, if this is appropriate. - - - - - Creates a proxy type that proxies calls to members on , implementing , using provided. - - The interface type to proxy. - Additional interface types to proxy. - Type implementing on which calls to the interface members should be intercepted. - The proxy generation options. - The generated proxy type. - - Implementers should return a proxy type for the specified interface that 'proceeds' executions to the specified target. - Additional interfaces should be only 'mark' interfaces, that is, they should work like interface proxy without target. (See method.) - - Thrown when or any of is a generic type definition. - Thrown when or any of is not public. - Note that to avoid this exception, you can mark offending type internal, and define - pointing to Castle Dynamic Proxy assembly, in assembly containing that type, if this is appropriate. - - - - - Creates a proxy type for given and that delegates all calls to the provided interceptors and allows interceptors to switch the actual target of invocation. - - The interface type to proxy. - Additional interface types to proxy. - The proxy generation options. - The generated proxy type. - - Implementers should return a proxy type for the specified interface(s) that delegate all executions to the specified interceptors - and uses an instance of the interface as their targets (i.e. ), rather than a class. All classes should then implement interface, - to allow interceptors to switch invocation target with instance of another type implementing called interface. - - Thrown when or any of is a generic type definition. - Thrown when or any of is not public. - Note that to avoid this exception, you can mark offending type internal, and define - pointing to Castle Dynamic Proxy assembly, in assembly containing that type, if this is appropriate. - - - - - Creates a proxy type for given that delegates all calls to the provided interceptors. - - The interface type to proxy. - Additional interface types to proxy. - The proxy generation options. - The generated proxy type. - - Implementers should return a proxy type for the specified interface and additional interfaces that delegate all executions to the specified interceptors. - - Thrown when or any of is a generic type definition. - Thrown when or any of is not public. - Note that to avoid this exception, you can mark offending type internal, and define - pointing to Castle Dynamic Proxy assembly, in assembly containing that type, if this is appropriate. - - - - - Gets or sets the that this logs to. - - - - - Gets the associated with this builder. - - The module scope associated with this builder. - - - - Initializes a new instance of the class with new . - - - - - Initializes a new instance of the class. - - The module scope for generated proxy types. - - - - Registers custom disassembler to handle disassembly of specified type of attributes. - - Type of attributes to handle - Disassembler converting existing instances of Attributes to CustomAttributeBuilders - - When disassembling an attribute Dynamic Proxy will first check if an custom disassembler has been registered to handle attributes of that type, - and if none is found, it'll use the . - - - - - Attributes should be replicated if they are non-inheritable, - but there are some special cases where the attributes means - something to the CLR, where they should be skipped. - - - - - Initializes a new instance of the class. - - Target element. This is either target type or target method for invocation types. - The type of the proxy. This is base type for invocation types. - The interfaces. - The options. - - - - Initializes a new instance of the class. - - Type of the target. - The interfaces. - The options. - - - - s - Provides appropriate Ldc.X opcode for the type of primitive value to be loaded. - - - - - Provides appropriate Ldind.X opcode for - the type of primitive value to be loaded indirectly. - - - - - Emits a load indirect opcode of the appropriate type for a value or object reference. - Pops a pointer off the evaluation stack, dereferences it and loads - a value of the specified type. - - - - - - - Emits a load opcode of the appropriate kind for a constant string or - primitive value. - - - - - - - Emits a load opcode of the appropriate kind for the constant default value of a - type, such as 0 for value types and null for reference types. - - - - - Emits a store indirectopcode of the appropriate type for a value or object reference. - Pops a value of the specified type and a pointer off the evaluation stack, and - stores the value. - - - - - - - Summary description for PropertiesCollection. - - - - - Wraps a reference that is passed - ByRef and provides indirect load/store support. - - - - - Summary description for NewArrayExpression. - - - - - - - - - Provides appropriate Stind.X opcode - for the type of primitive value to be stored indirectly. - - - - - Initializes a new instance of the class. - - The name. - Type declaring the original event being overriten, or null. - - The add method. - The remove method. - The attributes. - - - - Represents the scope of uniquenes of names for types and their members - - - - - Gets a unique name based on - - Name suggested by the caller - Unique name based on . - - Implementers should provide name as closely resembling as possible. - Generally if no collision occurs it is suggested to return suggested name, otherwise append sequential suffix. - Implementers must return deterministic names, that is when is called twice - with the same suggested name, the same returned name should be provided each time. Non-deterministic return - values, like appending random suffices will break serialization of proxies. - - - - - Returns new, disposable naming scope. It is responsibilty of the caller to make sure that no naming collision - with enclosing scope, or other subscopes is possible. - - New naming scope. - - - - Returns the methods implemented by a type. Use this instead of Type.GetMethods() to work around a CLR issue - where duplicate MethodInfos are returned by Type.GetMethods() after a token of a generic type's method was loaded. - - - - - Determines whether the specified method is internal. - - The method. - - true if the specified method is internal; otherwise, false. - - - - - Determines whether this assembly has internals visible to dynamic proxy. - - The assembly to inspect. - - - - Checks if the method is public or protected. - - - - - - - Because we need to cache the types based on the mixed in mixins, we do the following here: - - Get all the mixin interfaces - - Sort them by full name - - Return them by position - - The idea is to have reproducible behavior for the case that mixins are registered in different orders. - This method is here because it is required - - - - - Summary description for ModuleScope. - - - - - The default file name used when the assembly is saved using . - - - - - The default assembly (simple) name used for the assemblies generated by a instance. - - - - - Initializes a new instance of the class; assemblies created by this instance will not be saved. - - - - - Initializes a new instance of the class, allowing to specify whether the assemblies generated by this instance - should be saved. - - If set to true saves the generated module. - - - - Initializes a new instance of the class, allowing to specify whether the assemblies generated by this instance - should be saved. - - If set to true saves the generated module. - If set to true disables ability to generate signed module. This should be used in cases where ran under constrained permissions. - - - - Initializes a new instance of the class, allowing to specify whether the assemblies generated by this instance - should be saved and what simple names are to be assigned to them. - - If set to true saves the generated module. - If set to true disables ability to generate signed module. This should be used in cases where ran under constrained permissions. - The simple name of the strong-named assembly generated by this . - The path and file name of the manifest module of the strong-named assembly generated by this . - The simple name of the weak-named assembly generated by this . - The path and file name of the manifest module of the weak-named assembly generated by this . - - - - Initializes a new instance of the class, allowing to specify whether the assemblies generated by this instance - should be saved and what simple names are to be assigned to them. - - If set to true saves the generated module. - If set to true disables ability to generate signed module. This should be used in cases where ran under constrained permissions. - Naming scope used to provide unique names to generated types and their members (usually via sub-scopes). - The simple name of the strong-named assembly generated by this . - The path and file name of the manifest module of the strong-named assembly generated by this . - The simple name of the weak-named assembly generated by this . - The path and file name of the manifest module of the weak-named assembly generated by this . - - - - Returns a type from this scope's type cache, or null if the key cannot be found. - - The key to be looked up in the cache. - The type from this scope's type cache matching the key, or null if the key cannot be found - - - - Registers a type in this scope's type cache. - - The key to be associated with the type. - The type to be stored in the cache. - - - - Gets the key pair used to sign the strong-named assembly generated by this . - - - - - - Gets the specified module generated by this scope, creating a new one if none has yet been generated. - - If set to true, a strong-named module is returned; otherwise, a weak-named module is returned. - A strong-named or weak-named module generated by this scope, as specified by the parameter. - - - - Gets the strong-named module generated by this scope, creating a new one if none has yet been generated. - - A strong-named module generated by this scope. - - - - Gets the weak-named module generated by this scope, creating a new one if none has yet been generated. - - A weak-named module generated by this scope. - - - - Saves the generated assembly with the name and directory information given when this instance was created (or with - the and current directory if none was given). - - - - This method stores the generated assembly in the directory passed as part of the module information specified when this instance was - constructed (if any, else the current directory is used). If both a strong-named and a weak-named assembly - have been generated, it will throw an exception; in this case, use the overload. - - - If this was created without indicating that the assembly should be saved, this method does nothing. - - - Both a strong-named and a weak-named assembly have been generated. - The path of the generated assembly file, or null if no file has been generated. - - - - Saves the specified generated assembly with the name and directory information given when this instance was created - (or with the and current directory if none was given). - - True if the generated assembly with a strong name should be saved (see ); - false if the generated assembly without a strong name should be saved (see . - - - This method stores the specified generated assembly in the directory passed as part of the module information specified when this instance was - constructed (if any, else the current directory is used). - - - If this was created without indicating that the assembly should be saved, this method does nothing. - - - No assembly has been generated that matches the parameter. - - The path of the generated assembly file, or null if no file has been generated. - - - - Loads the generated types from the given assembly into this 's cache. - - The assembly to load types from. This assembly must have been saved via or - , or it must have the manually applied. - - This method can be used to load previously generated and persisted proxy types from disk into this scope's type cache, eg. in order - to avoid the performance hit associated with proxy generation. - - - - - Users of this should use this lock when accessing the cache. - - - - - Gets the strong-named module generated by this scope, or if none has yet been generated. - - The strong-named module generated by this scope, or if none has yet been generated. - - - - Gets the file name of the strongly named module generated by this scope. - - The file name of the strongly named module generated by this scope. - - - - Gets the directory where the strongly named module generated by this scope will be saved, or if the current directory - is used. - - The directory where the strongly named module generated by this scope will be saved when is called - (if this scope was created to save modules). - - - - Gets the weak-named module generated by this scope, or if none has yet been generated. - - The weak-named module generated by this scope, or if none has yet been generated. - - - - Gets the file name of the weakly named module generated by this scope. - - The file name of the weakly named module generated by this scope. - - - - Gets the directory where the weakly named module generated by this scope will be saved, or if the current directory - is used. - - The directory where the weakly named module generated by this scope will be saved when is called - (if this scope was created to save modules). - - - - ProxyBuilder that persists the generated type. - - - The saved assembly contains just the last generated type. - - - - - Initializes a new instance of the class. - - - - - Saves the generated assembly to a physical file. Note that this renders the unusable. - - The path of the generated assembly file, or null if no assembly has been generated. - - This method does not support saving multiple files. If both a signed and an unsigned module have been generated, use the - respective methods of the . - - - - - Initializes a new instance of the class. - - The hook. - - - - Initializes a new instance of the class. - - - - - Provides proxy objects for classes and interfaces. - - - - - Initializes a new instance of the class. - - Proxy types builder. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - If true forces all types to be generated into an unsigned module. - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - Object proxying calls to members of on object. - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of types on generated target object. - - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - As a result of that also at least one implementation must be provided. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of types on generated target object. - - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - As a result of that also at least one implementation must be provided. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of types on generated target object. - - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - As a result of that also at least one implementation must be provided. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The proxy generation options used to influence generated proxy type and object. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no parameterless constructor exists on type . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The proxy generation options used to influence generated proxy type and object. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no parameterless constructor exists on type . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The proxy generation options used to influence generated proxy type and object. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates the proxy type for class proxy with given class, implementing given and using provided . - - The base class for proxy type. - The interfaces that proxy type should implement. - The options for proxy generation process. - of proxy. - - - - Creates the proxy type for interface proxy with target for given interface, implementing given on given and using provided . - - The interface proxy type should implement. - The additional interfaces proxy type should implement. - Actual type that the proxy type will encompass. - The options for proxy generation process. - of proxy. - - - - Creates the proxy type for interface proxy with target interface for given interface, implementing given on given and using provided . - - The interface proxy type should implement. - The additional interfaces proxy type should implement. - The options for proxy generation process. - of proxy. - - - - Creates the proxy type for interface proxy without target for given interface, implementing given and using provided . - - The interface proxy type should implement. - The additional interfaces proxy type should implement. - The options for proxy generation process. - of proxy. - - - - Gets or sets the that this log to. - - - - - Gets the proxy builder instance used to generate proxy types. - - The proxy builder. - - - - - - - - - - - - - For interface proxies, this will point to the - on the target class - - - - - Handles the deserialization of proxies. - - - - - Resets the used for deserialization to a new scope. - - - This is useful for test cases. - - - - - Resets the used for deserialization to a given . - - The scope to be used for deserialization. - - By default, the deserialization process uses a different scope than the rest of the application, which can lead to multiple proxies - being generated for the same type. By explicitly setting the deserialization scope to the application's scope, this can be avoided. - - - - - Gets the used for deserialization. - - As has no way of automatically determining the scope used by the application (and the application might use more than one scope at the same time), uses a dedicated scope instance for deserializing proxy types. This instance can be reset and set to a specific value via and . - - - - Holds objects representing methods of class. - - - - - Holds objects representing methods of class. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Provides an extension point that allows proxies to choose specific interceptors on - a per method basis. - - - - - Selects the interceptors that should intercept calls to the given . - - The type declaring the method to intercept. - The method that will be intercepted. - All interceptors registered with the proxy. - An array of interceptors to invoke upon calling the . - - This method is called only once per proxy instance, upon the first call to the - . Either an empty array or null are valid return values to indicate - that no interceptor should intercept calls to the method. Although it is not advised, it is - legal to return other implementations than these provided in - . - - - - - Creates a new lock. - - - - - - This interface should be implemented by classes - that are available in a bigger context, exposing - the container to different areas in the same application. - - For example, in Web application, the (global) HttpApplication - subclasses should implement this interface to expose - the configured container - - - - - - Exposes means to change target objects of proxies and invocations - - - - - Changes the target object () of current . - - The new value of target of invocation. - - Although the method takes the actual instance must be of type assignable to , otherwise an will be thrown. - Also while it's technically legal to pass null reference (Nothing in Visual Basic) as , for obvious reasons Dynamic Proxy will not be able to call the intercepted method on such target. - In this case last interceptor in the pipeline mustn't call or a will be throws. - Also while it's technically legal to pass proxy itself as , this would create stack overflow. - In this case last interceptor in the pipeline mustn't call or a will be throws. - - Thrown when is not assignable to the proxied type. - - - - Permanently changes the target object of the proxy. This does not affect target of the current invocation. - - The new value of target of the proxy. - - Although the method takes the actual instance must be of type assignable to proxy's target type, otherwise an will be thrown. - Also while it's technically legal to pass null reference (Nothing in Visual Basic) as , for obvious reasons Dynamic Proxy will not be able to call the intercepted method on such target. - In this case last interceptor in the pipeline mustn't call or a will be throws. - Also while it's technically legal to pass proxy itself as , this would create stack overflow. - In this case last interceptor in the pipeline mustn't call or a will be throws. - - Thrown when is not assignable to the proxied type. - - - - New interface that is going to be used by DynamicProxy 2 - - - - - Get the proxy target (note that null is a valid target!) - - - - - - Gets the interceptors for the proxy - - - - - - Defines that the implementation wants a - in order to - access other components. The creator must be aware - that the component might (or might not) implement - the interface. - - - Used by Castle Project components to, for example, - gather logging factories - - - - - Increments IServiceProvider with a generic service resolution operation. - - - - - Provides a factory that can produce either or - classes. - - - - - Manages the instantiation of s. - - - - - Creates a new logger, getting the logger name from the specified type. - - - - - Creates a new logger. - - - - - Creates a new logger, getting the logger name from the specified type. - - - - - Creates a new logger. - - - - - Creates a new extended logger, getting the logger name from the specified type. - - - - - Creates a new extended logger. - - - - - Creates a new extended logger, getting the logger name from the specified type. - - - - - Creates a new extended logger. - - - - - Creates a new extended logger, getting the logger name from the specified type. - - - - - Creates a new extended logger. - - - - - Creates a new extended logger, getting the logger name from the specified type. - - - - - Creates a new extended logger. - - - - - Creates a new logger, getting the logger name from the specified type. - - - - - Creates a new logger. - - - - - Creates a new logger, getting the logger name from the specified type. - - - - - Creates a new logger. - - - - - Gets the configuration file. - - i.e. log4net.config - - - - - Used to create the TraceLogger implementation of ILogger interface. See . - - - - - Gets the configuration file. - - i.e. log4net.config - - - - - Interface for Context Properties implementations - - - - This interface defines a basic property get set accessor. - - - Based on the ContextPropertiesBase of log4net, by Nicko Cadell. - - - - - - Gets or sets the value of a property - - - The value for the property with the specified key - - - - Gets or sets the value of a property - - - - - - NullLogFactory used when logging is turned off. - - - - - Creates an instance of ILogger with the specified name. - - Name. - - - - - Creates an instance of ILogger with the specified name and LoggerLevel. - - Name. - Level. - - - - - Creates outputing - to files. The name of the file is derived from the log name - plus the 'log' extension. - - - - - Provides an interface that supports and - allows the storage and retrieval of Contexts. These are supported in - both log4net and NLog. - - - - - Manages logging. - - - This is a facade for the different logging subsystems. - It offers a simplified interface that follows IOC patterns - and a simplified priority/level/severity abstraction. - - - - - Create a new child logger. - The name of the child logger is [current-loggers-name].[passed-in-name] - - The Subname of this logger. - The New ILogger instance. - If the name has an empty element name. - - - - Logs a debug message. - - The message to log - - - - Logs a debug message with lazily constructed message. The message will be constructed only if the is true. - - - - - - Logs a debug message. - - The exception to log - The message to log - - - - Logs a debug message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The message to log - - - - Logs an error message with lazily constructed message. The message will be constructed only if the is true. - - - - - - Logs an error message. - - The exception to log - The message to log - - - - Logs an error message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The message to log - - - - Logs a fatal message with lazily constructed message. The message will be constructed only if the is true. - - - - - - Logs a fatal message. - - The exception to log - The message to log - - - - Logs a fatal message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The message to log - - - - Logs a info message with lazily constructed message. The message will be constructed only if the is true. - - - - - - Logs an info message. - - The exception to log - The message to log - - - - Logs an info message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The message to log - - - - Logs a warn message with lazily constructed message. The message will be constructed only if the is true. - - - - - - Logs a warn message. - - The exception to log - The message to log - - - - Logs a warn message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Determines if messages of priority "debug" will be logged. - - True if "debug" messages will be logged. - - - - Determines if messages of priority "error" will be logged. - - True if "error" messages will be logged. - - - - Determines if messages of priority "fatal" will be logged. - - True if "fatal" messages will be logged. - - - - Determines if messages of priority "info" will be logged. - - True if "info" messages will be logged. - - - - Determines if messages of priority "warn" will be logged. - - True if "warn" messages will be logged. - - - - Exposes the Global Context of the extended logger. - - - - - Exposes the Thread Context of the extended logger. - - - - - Exposes the Thread Stack of the extended logger. - - - - - The Logger sending everything to the standard output streams. - This is mainly for the cases when you have a utility that - does not have a logger to supply. - - - - - The Level Filtered Logger class. This is a base clase which - provides a LogLevel attribute and reroutes all functions into - one Log method. - - - - - Creates a new LevelFilteredLogger. - - - - - Keep the instance alive in a remoting scenario - - - - - - Logs a debug message. - - The message to log - - - - Logs a debug message. - - The exception to log - The message to log - - - - Logs a debug message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The message to log - - - - Logs an info message. - - The exception to log - The message to log - - - - Logs an info message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The message to log - - - - Logs a warn message. - - The exception to log - The message to log - - - - Logs a warn message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The message to log - - - - Logs an error message. - - The exception to log - The message to log - - - - Logs an error message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The message to log - - - - Logs a fatal message. - - The exception to log - The message to log - - - - Logs a fatal message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Implementors output the log content by implementing this method only. - Note that exception can be null - - - - - - - - - The LoggerLevel that this logger - will be using. Defaults to LoggerLevel.Off - - - - - The name that this logger will be using. - Defaults to String.Empty - - - - - Determines if messages of priority "debug" will be logged. - - true if log level flags include the bit - - - - Determines if messages of priority "info" will be logged. - - true if log level flags include the bit - - - - Determines if messages of priority "warn" will be logged. - - true if log level flags include the bit - - - - Determines if messages of priority "error" will be logged. - - true if log level flags include the bit - - - - Determines if messages of priority "fatal" will be logged. - - true if log level flags include the bit - - - - Creates a new ConsoleLogger with the Level - set to LoggerLevel.Debug and the Name - set to String.Empty. - - - - - Creates a new ConsoleLogger with the Name - set to String.Empty. - - The logs Level. - - - - Creates a new ConsoleLogger with the Level - set to LoggerLevel.Debug. - - The logs Name. - - - - Creates a new ConsoleLogger. - - The logs Name. - The logs Level. - - - - A Common method to log. - - The level of logging - The name of the logger - The Message - The Exception - - - - Returns a new ConsoleLogger with the name - added after this loggers name, with a dot in between. - - The added hierarchical name. - A new ConsoleLogger. - - - - The Logger using standart Diagnostics namespace. - - - - - Creates a logger based on . - - - - - - Creates a logger based on . - - - - - - - Creates a logger based on . - - - - - - - - The Null Logger class. This is useful for implementations where you need - to provide a logger to a utility class, but do not want any output from it. - It also helps when you have a utility that does not have a logger to supply. - - - - - Returns this NullLogger. - - Ignored - This ILogger instance. - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - Returns empty context properties. - - - - - Returns empty context properties. - - - - - Returns empty context stacks. - - - - - No-op. - - false - - - - No-op. - - false - - - - No-op. - - false - - - - No-op. - - false - - - - No-op. - - false - - - - The Stream Logger class. This class can stream log information - to any stream, it is suitable for storing a log file to disk, - or to a MemoryStream for testing your components. - - - This logger is not thread safe. - - - - - Creates a new StreamLogger with default encoding - and buffer size. Initial Level is set to Debug. - - - The name of the log. - - - The stream that will be used for logging, - seeking while the logger is alive - - - - - Creates a new StreamLogger with default buffer size. - Initial Level is set to Debug. - - - The name of the log. - - - The stream that will be used for logging, - seeking while the logger is alive - - - The encoding that will be used for this stream. - - - - - - Creates a new StreamLogger. - Initial Level is set to Debug. - - - The name of the log. - - - The stream that will be used for logging, - seeking while the logger is alive - - - The encoding that will be used for this stream. - - - - The buffer size that will be used for this stream. - - - - - - Creates a new StreamLogger with - Debug as default Level. - - The name of the log. - The StreamWriter the log will write to. - - - - The TraceLogger sends all logging to the System.Diagnostics.TraceSource - built into the .net framework. - - - Logging can be configured in the system.diagnostics configuration - section. - - If logger doesn't find a source name with a full match it will - use source names which match the namespace partially. For example you can - configure from all castle components by adding a source name with the - name "Castle". - - If no portion of the namespace matches the source named "Default" will - be used. - - - - - Build a new trace logger based on the named TraceSource - - The name used to locate the best TraceSource. In most cases comes from the using type's fullname. - - - - Build a new trace logger based on the named TraceSource - - The name used to locate the best TraceSource. In most cases comes from the using type's fullname. - The default logging level at which this source should write messages. In almost all cases this - default value will be overridden in the config file. - - - - Create a new child logger. - The name of the child logger is [current-loggers-name].[passed-in-name] - - The Subname of this logger. - The New ILogger instance. - - - - This is an abstract implementation - that deals with methods that can be abstracted away - from underlying implementations. - - - AbstractConfiguration makes easier to implementers - to create a new version of - - - - - is a interface encapsulating a configuration node - used to retrieve configuration values. - - - - - Gets the value of the node and converts it - into specified . - - The - - The Default value returned if the conversion fails. - - The Value converted into the specified type. - - - - Gets the name of the node. - - - The Name of the node. - - - - - Gets the value of the node. - - - The Value of the node. - - - - - Gets an of - elements containing all node children. - - The Collection of child nodes. - - - - Gets an of the configuration attributes. - - - - - Gets the value of the node and converts it - into specified . - - The - - The Default value returned if the conversion fails. - - The Value converted into the specified type. - - - - Gets node attributes. - - - All attributes of the node. - - - - - Gets all child nodes. - - The of child nodes. - - - - Gets the name of the . - - - The Name of the . - - - - - Gets the value of . - - - The Value of the . - - - - - A collection of objects. - - - - - Creates a new instance of ConfigurationCollection. - - - - - Creates a new instance of ConfigurationCollection. - - - - - Summary description for MutableConfiguration. - - - - - Initializes a new instance of the class. - - The name. - - - - Gets the value of . - - - The Value of the . - - - - - Deserializes the specified node into an abstract representation of configuration. - - The node. - - - - - If a config value is an empty string we return null, this is to keep - backward compatibility with old code - - - - - General purpose class to represent a standard pair of values. - - Type of the first value - Type of the second value - - - - Constructs a pair with its values - - - - - - - List of utility methods related to dynamic proxy operations - - - - - Determines whether the specified type is a proxy generated by - DynamicProxy (1 or 2). - - The type. - - true if it is a proxy; otherwise, false. - - - - - Readonly implementation of which uses an anonymous object as its source. Uses names of properties as keys, and property values as... well - values. Keys are not case sensitive. - - - - - Initializes a new instance of the class. - - The target. - - - - Adds an element with the provided key and value to the object. - - The to use as the key of the element to add. - The to use as the value of the element to add. - - is null. - An element with the same key already exists in the object. - The is read-only.-or- The has a fixed size. - - - - Removes all elements from the object. - - The object is read-only. - - - - Determines whether the object contains an element with the specified key. - - The key to locate in the object. - - true if the contains an element with the key; otherwise, false. - - - is null. - - - - Removes the element with the specified key from the object. - - The key of the element to remove. - - is null. - The object is read-only.-or- The has a fixed size. - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - - - - Copies the elements of the to an , starting at a particular index. - - The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing. - The zero-based index in at which copying begins. - - is null. - - is less than zero. - - is multidimensional.-or- is equal to or greater than the length of .-or- The number of elements in the source is greater than the available space from to the end of the destination . - The type of the source cannot be cast automatically to the type of the destination . - - - - Returns an object for the object. - - - An object for the object. - - - - - Reads values of properties from and inserts them into using property names as keys. - - - - - - - Gets the number of elements contained in the . - - - The number of elements contained in the . - - - - Gets a value indicating whether access to the is synchronized (thread safe). - - - true if access to the is synchronized (thread safe); otherwise, false. - - - - Gets an object that can be used to synchronize access to the . - - - An object that can be used to synchronize access to the . - - - - Gets a value indicating whether the object is read-only. - - - true if the object is read-only; otherwise, false. - - - - Gets or sets the with the specified key. - - - - - - Gets an object containing the keys of the object. - - - An object containing the keys of the object. - - - - Gets an object containing the values in the object. - - - An object containing the values in the object. - - - - Gets a value indicating whether the object has a fixed size. - - - true if the object has a fixed size; otherwise, false. - - - - Represents a 'streamable' resource. Can - be a file, a resource in an assembly. - - - - - Returns a reader for the stream - - - It's up to the caller to dispose the reader. - - - - - - Returns a reader for the stream - - - It's up to the caller to dispose the reader. - - - - - - - Returns an instance of - created according to the relativePath - using itself as the root. - - - - - - - - - - Only valid for resources that - can be obtained through relative paths - - - - - - - - - - This returns a new stream instance each time it is called. - It is the responsibility of the caller to dispose of this stream - - - - - Depicts the contract for resource factories. - - - - - Used to check whether the resource factory - is able to deal with the given resource - identifier. - - - Implementors should return true - only if the given identifier is supported - by the resource factory - - - - - - - Creates an instance - for the given resource identifier - - - - - - - Creates an instance - for the given resource identifier - - - - - - - - - - - - - - - - - - Adapts a static string content as an - - - - - Enable access to files on network shares - - - - - Email sender abstraction. - - - - - Sends a mail message. - - From field - To field - E-mail's subject - message's body - - - - Sends a message. - - Message instance - - - - Sends multiple messages. - - List of messages - - - - Default implementation. - - - - - Initializes a new instance of the class based on the configuration provided in the application configuration file. - - - This constructor is based on the default configuration in the application configuration file. - - - - - This service implementation - requires a host name in order to work - - The smtp server name - - - - Sends a message. - - If any of the parameters is null - From field - To field - e-mail's subject - message's body - - - - Sends a message. - - If the message is null - Message instance - - - - Configures the sender - with port information and eventual credential - informed - - Message instance - - - - Gets or sets the port used to - access the SMTP server - - - - - Gets the hostname. - - The hostname. - - - - Gets or sets a value which is used to - configure if emails are going to be sent asynchronously or not. - - - - - Gets or sets a value that specifies - the amount of time after which a synchronous Send call times out. - - - - - Gets or sets a value indicating whether the email should be sent using - a secure communication channel. - - true if should use SSL; otherwise, false. - - - - Gets or sets the domain. - - The domain. - - - - Gets or sets the name of the user. - - The name of the user. - - - - Gets or sets the password. - - The password. - - - - Gets a value indicating whether credentials were informed. - - - if this instance has credentials; otherwise, . - - - - diff --git a/packages/Castle.Core.3.3.3/lib/net45/Castle.Core.dll b/packages/Castle.Core.3.3.3/lib/net45/Castle.Core.dll deleted file mode 100644 index 957a85c..0000000 Binary files a/packages/Castle.Core.3.3.3/lib/net45/Castle.Core.dll and /dev/null differ diff --git a/packages/Castle.Core.3.3.3/lib/net45/Castle.Core.xml b/packages/Castle.Core.3.3.3/lib/net45/Castle.Core.xml deleted file mode 100644 index 75d0a4b..0000000 --- a/packages/Castle.Core.3.3.3/lib/net45/Castle.Core.xml +++ /dev/null @@ -1,4774 +0,0 @@ - - - - Castle.Core - - - - - Specifies assignment by reference rather than by copying. - - - - - Suppresses any on-demand behaviors. - - - - - Removes a property if null or empty string, guid or collection. - - - - - Removes a property if matches value. - - - - - Assigns a specific dictionary key. - - - - - Defines the contract for customizing dictionary access. - - - - - Copies the dictionary behavior. - - null if should not be copied. Otherwise copy. - - - - Determines relative order to apply related behaviors. - - - - - Defines the contract for updating dictionary values. - - - - - Sets the stored dictionary value. - - The dictionary adapter. - The key. - The stored value. - The property. - true if the property should be stored. - - - - Contract for value matching. - - - - - Indicates that underlying values are changeable and should not be cached. - - - - - Contract for dictionary initialization. - - - - - Performs any initialization of the - - The dictionary adapter. - The dictionary behaviors. - - - - Abstract implementation of . - - - - - Conract for traversing a . - - - - - Contract for creating additional Dictionary adapters. - - - - - Contract for manipulating the Dictionary adapter. - - - - - Contract for editing the Dictionary adapter. - - - - - Contract for managing Dictionary adapter notifications. - - - - - Contract for validating Dictionary adapter. - - - - - Defines the contract for building s. - - - - - Builds the dictionary behaviors. - - - - - - Abstract adapter for the support - needed by the - - - - - Adds an element with the provided key and value to the object. - - The to use as the key of the element to add. - The to use as the value of the element to add. - An element with the same key already exists in the object. - key is null. - The is read-only.-or- The has a fixed size. - - - - Removes all elements from the object. - - The object is read-only. - - - - Determines whether the object contains an element with the specified key. - - The key to locate in the object. - - true if the contains an element with the key; otherwise, false. - - key is null. - - - - Returns an object for the object. - - - An object for the object. - - - - - Removes the element with the specified key from the object. - - The key of the element to remove. - The object is read-only.-or- The has a fixed size. - key is null. - - - - Copies the elements of the to an , starting at a particular index. - - The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing. - The zero-based index in array at which copying begins. - array is null. - The type of the source cannot be cast automatically to the type of the destination array. - index is less than zero. - array is multidimensional.-or- index is equal to or greater than the length of array.-or- The number of elements in the source is greater than the available space from index to the end of the destination array. - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - - - - Gets a value indicating whether the object has a fixed size. - - - true if the object has a fixed size; otherwise, false. - - - - Gets a value indicating whether the object is read-only. - - - true if the object is read-only; otherwise, false. - - - - Gets an object containing the keys of the object. - - - An object containing the keys of the object. - - - - Gets an object containing the values in the object. - - - An object containing the values in the object. - - - - Gets or sets the with the specified key. - - - - - - Gets the number of elements contained in the . - - - The number of elements contained in the . - - - - Gets a value indicating whether access to the is synchronized (thread safe). - - - true if access to the is synchronized (thread safe); otherwise, false. - - - - Gets an object that can be used to synchronize access to the . - - - An object that can be used to synchronize access to the . - - - - Provides a generic collection that supports data binding. - - - This class wraps the CLR - in order to implement the Castle-specific . - - The type of elements in the list. - - - - Initializes a new instance of the class - using default values. - - - - - Initializes a new instance of the class - with the specified list. - - - An of items - to be contained in the . - - - - - Initializes a new instance of the class - wrapping the specified instance. - - - A - to be wrapped by the . - - - - - Defines the contract for retrieving dictionary values. - - - - - Gets the effective dictionary value. - - The dictionary adapter. - The key. - The stored value. - The property. - true if return only existing. - The effective property value. - - - - Initializes a new instance of the class - that represents a child object in a larger object graph. - - - - - - - Contract for dictionary meta-data initialization. - - - - - Initializes the given object. - - The dictionary adapter factory. - The dictionary adapter meta. - - - - - Determines whether the given behavior should be included in a new - object. - - A dictionary behavior or annotation. - True if the behavior should be included; otherwise, false. - - behaviors are always included, - regardless of the result of this method. - - - - - - Checks whether or not collection is null or empty. Assumes colleciton can be safely enumerated multiple times. - - - - - - - Creates a message to inform clients that a proxy couldn't be created due to reliance on an - inaccessible type (perhaps itself). - - the inaccessible type that prevents proxy creation - the type that couldn't be proxied - - - - Find the best available name to describe a type. - - - Usually the best name will be , but - sometimes that's null (see http://msdn.microsoft.com/en-us/library/system.type.fullname%28v=vs.110%29.aspx) - in which case the method falls back to . - - the type to name - the best name - - - - Constant to use when making assembly internals visible to Castle.Core - [assembly: InternalsVisibleTo(CoreInternalsVisible.ToCastleCore)] - - - - - Constant to use when making assembly internals visible to proxy types generated by DynamicProxy. Required when proxying internal types. - [assembly: InternalsVisibleTo(CoreInternalsVisible.ToDynamicProxyGenAssembly2)] - - - - - Identifies a property should be represented as a nested component. - - - - - Defines the contract for building typed dictionary keys. - - - - - Builds the specified key. - - The dictionary adapter. - The current key. - The property. - The updated key - - - - Applies no prefix. - - - - - Gets or sets the prefix. - - The prefix. - - - - Identifies the dictionary adapter types. - - - - - Identifies an interface or property to be pre-fetched. - - - - - Instructs fetching to occur. - - - - - Instructs fetching according to - - - - - - Gets whether or not fetching should occur. - - - - - Assigns a property to a group. - - - - - Constructs a group assignment. - - The group name. - - - - Constructs a group assignment. - - The group name. - - - - Gets the group the property is assigned to. - - - - - Assigns a specific dictionary key. - - - - - Initializes a new instance of the class. - - The key. - - - - Initializes a new instance of the class. - - The compound key. - - - - Assigns a prefix to the keyed properties of an interface. - - - Key prefixes are not inherited by sub-interfaces. - - - - - Initializes a default instance of the class. - - - - - Initializes a new instance of the class. - - The prefix for the keyed properties of the interface. - - - - Gets the prefix key added to the properties of the interface. - - - - - Substitutes part of key with another string. - - - - - Initializes a new instance of the class. - - The old value. - The new value. - - - - Requests support for multi-level editing. - - - - - Generates a new GUID on demand. - - - - - Support for on-demand value resolution. - - - - - Provides simple string formatting from existing properties. - - - - - Gets the string format. - - - - - Gets the format properties. - - - - - Identifies a property should be represented as a delimited string value. - - - - - Gets the separator. - - - - - Converts all properties to strings. - - - - - Gets or sets the format. - - The format. - - - - Suppress property change notifications. - - - - - Contract for property descriptor initialization. - - - - - Performs any initialization of the - - The property descriptor. - The property behaviors. - - - - Assigns a prefix to the keyed properties using the interface name. - - - - - Manages conversion between property values. - - - - - Initializes a new instance of the class. - - The converter. - - - - Gets the effective dictionary value. - - The dictionary adapter. - The key. - The stored value. - The property. - true if return only existing. - The effective property value. - - - - - - - - - Uses Reflection.Emit to expose the properties of a dictionary - through a dynamic implementation of a typed interface. - - - - - Defines the contract for building typed dictionary adapters. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - An implementation of the typed interface bound to the dictionary. - - The type represented by T must be an interface with properties. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - An implementation of the typed interface bound to the dictionary. - - The type represented by T must be an interface with properties. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - The property descriptor. - An implementation of the typed interface bound to the dictionary. - - The type represented by T must be an interface with properties. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - An implementation of the typed interface bound to the namedValues. - - The type represented by T must be an interface with properties. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - An implementation of the typed interface bound to the namedValues. - - The type represented by T must be an interface with properties. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - An implementation of the typed interface bound to the . - - The type represented by T must be an interface with properties. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - An implementation of the typed interface bound to the . - - The type represented by T must be an interface with properties. - - - - - Gets the associated with the type. - - The typed interface. - The adapter meta-data. - - - - Gets the associated with the type. - - The typed interface. - The property descriptor. - The adapter meta-data. - - - - Gets the associated with the type. - - The typed interface. - Another from which to copy behaviors. - The adapter meta-data. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Contract for dictionary validation. - - - - - Determines if is valid. - - The dictionary adapter. - true if valid. - - - - Validates the . - - The dictionary adapter. - The error summary information. - - - - Validates the for a property. - - The dictionary adapter. - The property to validate. - The property summary information. - - - - Invalidates any results cached by the validator. - - The dictionary adapter. - - - - - - - - - Initializes a new instance of the class. - - The name values. - - - - Determines whether the object contains an element with the specified key. - - The key to locate in the object. - - true if the contains an element with the key; otherwise, false. - - key is null. - - - - Adapts the specified name values. - - The name values. - - - - - Gets a value indicating whether the object is read-only. - - - true if the object is read-only; otherwise, false. - - - - Gets or sets the with the specified key. - - - - - - Describes a dictionary property. - - - - - Initializes an empty class. - - - - - Initializes a new instance of the class. - - The property. - The annotations. - - - - Initializes a new instance class. - - - - - Copies an existinginstance of the class. - - - - - - - Gets the key. - - The dictionary adapter. - The key. - The descriptor. - - - - - Gets the property value. - - The dictionary adapter. - The key. - The stored value. - The descriptor. - true if return only existing. - - - - - Sets the property value. - - The dictionary adapter. - The key. - The value. - The descriptor. - - - - - Adds a single behavior. - - The behavior. - - - - Adds the behaviors. - - The behaviors. - - - - Adds the behaviors. - - The behaviors. - - - - Copies the behaviors to the other - - - - - - - Copies the - - - - - - - - - - - Gets the property name. - - - - - Gets the property type. - - - - - Gets the property. - - The property. - - - - Returns true if the property is dynamic. - - - - - Gets additional state. - - - - - Determines if property should be fetched. - - - - - Determines if property must exist first. - - - - - Determines if notifications should occur. - - - - - Gets the property behaviors. - - - - - Gets the type converter. - - The type converter. - - - - Gets the extended properties. - - - - - Gets the setter. - - The setter. - - - - Gets the key builders. - - The key builders. - - - - Gets the setter. - - The setter. - - - - Gets the getter. - - The getter. - - - - Gets the initializers. - - The initializers. - - - - Gets the meta-data initializers. - - The meta-data initializers. - - - - Helper class for retrieving attributes. - - - - - Gets the attribute. - - The member. - The member attribute. - - - - Gets the attributes. Does not consider inherited attributes! - - The member. - The member attributes. - - - - Gets the type attribute. - - The type. - The type attribute. - - - - Gets the type attributes. - - The type. - The type attributes. - - - - Gets the type converter. - - The member. - - - - - Gets the attribute. - - The member. - The member attribute. - - - - Contract for typed dynamic value resolution. - - - - - - Contract for dynamic value resolution. - - - - - Supporting Logger levels. - - - - - Logging will be off - - - - - Fatal logging level - - - - - Error logging level - - - - - Warn logging level - - - - - Info logging level - - - - - Debug logging level - - - - - Encapsulates an invocation of a proxied method. - - - - - Gets the value of the argument at the specified . - - The index. - The value of the argument at the specified . - - - - Returns the concrete instantiation of the on the proxy, with any generic - parameters bound to real types. - - - The concrete instantiation of the on the proxy, or the if - not a generic method. - - - Can be slower than calling . - - - - - Returns the concrete instantiation of , with any - generic parameters bound to real types. - For interface proxies, this will point to the on the target class. - - The concrete instantiation of , or - if not a generic method. - - In debug builds this can be slower than calling . - - - - - Proceeds the call to the next interceptor in line, and ultimately to the target method. - - - Since interface proxies without a target don't have the target implementation to proceed to, - it is important, that the last interceptor does not call this method, otherwise a - will be thrown. - - - - - Overrides the value of an argument at the given with the - new provided. - - - This method accepts an , however the value provided must be compatible - with the type of the argument defined on the method, otherwise an exception will be thrown. - - The index of the argument to override. - The new value for the argument. - - - - Gets the arguments that the has been invoked with. - - The arguments the method was invoked with. - - - - Gets the generic arguments of the method. - - The generic arguments, or null if not a generic method. - - - - Gets the object on which the invocation is performed. This is different from proxy object - because most of the time this will be the proxy target object. - - - The invocation target. - - - - Gets the representing the method being invoked on the proxy. - - The representing the method being invoked. - - - - For interface proxies, this will point to the on the target class. - - The method invocation target. - - - - Gets the proxy object on which the intercepted method is invoked. - - Proxy object on which the intercepted method is invoked. - - - - Gets or sets the return value of the method. - - The return value of the method. - - - - Gets the type of the target object for the intercepted method. - - The type of the target object. - - - - Used during the target type inspection process. Implementors have a chance to customize the - proxy generation process. - - - - - Invoked by the generation process to notify that the whole process has completed. - - - - - Invoked by the generation process to notify that a member was not marked as virtual. - - The type which declares the non-virtual member. - The non-virtual member. - - This method gives an opportunity to inspect any non-proxyable member of a type that has - been requested to be proxied, and if appropriate - throw an exception to notify the caller. - - - - - Invoked by the generation process to determine if the specified method should be proxied. - - The type which declares the given method. - The method to inspect. - True if the given method should be proxied; false otherwise. - - - - Interface describing elements composing generated type - - - - - Performs some basic screening and invokes the - to select methods. - - - - - - - - - Provides functionality for disassembling instances of attributes to CustomAttributeBuilder form, during the process of emiting new types by Dynamic Proxy. - - - - - Disassembles given attribute instance back to corresponding CustomAttributeBuilder. - - An instance of attribute to disassemble - corresponding 1 to 1 to given attribute instance, or null reference. - - Implementers should return that corresponds to given attribute instance 1 to 1, - that is after calling specified constructor with specified arguments, and setting specified properties and fields with values specified - we should be able to get an attribute instance identical to the one passed in . Implementer can return null - if it wishes to opt out of replicating the attribute. Notice however, that for some cases, like attributes passed explicitly by the user - it is illegal to return null, and doing so will result in exception. - - - - - Handles error during disassembly process - - Type of the attribute being disassembled - Exception thrown during the process - usually null, or (re)throws the exception - - - - Here we try to match a constructor argument to its value. - Since we can't get the values from the assembly, we use some heuristics to get it. - a/ we first try to match all the properties on the attributes by name (case insensitive) to the argument - b/ if we fail we try to match them by property type, with some smarts about convertions (i,e: can use Guid for string). - - - - - We have the following rules here. - Try to find a matching type, failing that, if the parameter is string, get the first property (under the assumption that - we can convert it. - - - - - Attributes can only accept simple types, so we return null for null, - if the value is passed as string we call to string (should help with converting), - otherwise, we use the value as is (enums, integer, etc). - - - - - Returns list of all unique interfaces implemented given types, including their base interfaces. - - - - - - - Applied to the assemblies saved by in order to persist the cache data included in the persisted assembly. - - - - - Base class that exposes the common functionalities - to proxy generation. - - - - - It is safe to add mapping (no mapping for the interface exists) - - - - - - - - Generates a parameters constructor that initializes the proxy - state with just to make it non-null. - - This constructor is important to allow proxies to be XML serializable - - - - - - Generates the constructor for the class that extends - - - - - - - - - Default implementation of interface producing in-memory proxy assemblies. - - - - - Abstracts the implementation of proxy type construction. - - - - - Creates a proxy type for given , implementing , using provided. - - The class type to proxy. - Additional interface types to proxy. - The proxy generation options. - The generated proxy type. - - Implementers should return a proxy type for the specified class and interfaces. - Additional interfaces should be only 'mark' interfaces, that is, they should work like interface proxy without target. (See method.) - - Thrown when or any of is a generic type definition. - Thrown when or any of is not public. - Note that to avoid this exception, you can mark offending type internal, and define - pointing to Castle Dynamic Proxy assembly, in assembly containing that type, if this is appropriate. - - - - - Creates a proxy type that proxies calls to members on , implementing , using provided. - - The interface type to proxy. - Additional interface types to proxy. - Type implementing on which calls to the interface members should be intercepted. - The proxy generation options. - The generated proxy type. - - Implementers should return a proxy type for the specified interface that 'proceeds' executions to the specified target. - Additional interfaces should be only 'mark' interfaces, that is, they should work like interface proxy without target. (See method.) - - Thrown when or any of is a generic type definition. - Thrown when or any of is not public. - Note that to avoid this exception, you can mark offending type internal, and define - pointing to Castle Dynamic Proxy assembly, in assembly containing that type, if this is appropriate. - - - - - Creates a proxy type for given and that delegates all calls to the provided interceptors and allows interceptors to switch the actual target of invocation. - - The interface type to proxy. - Additional interface types to proxy. - The proxy generation options. - The generated proxy type. - - Implementers should return a proxy type for the specified interface(s) that delegate all executions to the specified interceptors - and uses an instance of the interface as their targets (i.e. ), rather than a class. All classes should then implement interface, - to allow interceptors to switch invocation target with instance of another type implementing called interface. - - Thrown when or any of is a generic type definition. - Thrown when or any of is not public. - Note that to avoid this exception, you can mark offending type internal, and define - pointing to Castle Dynamic Proxy assembly, in assembly containing that type, if this is appropriate. - - - - - Creates a proxy type for given that delegates all calls to the provided interceptors. - - The interface type to proxy. - Additional interface types to proxy. - The proxy generation options. - The generated proxy type. - - Implementers should return a proxy type for the specified interface and additional interfaces that delegate all executions to the specified interceptors. - - Thrown when or any of is a generic type definition. - Thrown when or any of is not public. - Note that to avoid this exception, you can mark offending type internal, and define - pointing to Castle Dynamic Proxy assembly, in assembly containing that type, if this is appropriate. - - - - - Gets or sets the that this logs to. - - - - - Gets the associated with this builder. - - The module scope associated with this builder. - - - - Initializes a new instance of the class with new . - - - - - Initializes a new instance of the class. - - The module scope for generated proxy types. - - - - Registers custom disassembler to handle disassembly of specified type of attributes. - - Type of attributes to handle - Disassembler converting existing instances of Attributes to CustomAttributeBuilders - - When disassembling an attribute Dynamic Proxy will first check if an custom disassembler has been registered to handle attributes of that type, - and if none is found, it'll use the . - - - - - Attributes should be replicated if they are non-inheritable, - but there are some special cases where the attributes means - something to the CLR, where they should be skipped. - - - - - Initializes a new instance of the class. - - Target element. This is either target type or target method for invocation types. - The type of the proxy. This is base type for invocation types. - The interfaces. - The options. - - - - Initializes a new instance of the class. - - Type of the target. - The interfaces. - The options. - - - - s - Provides appropriate Ldc.X opcode for the type of primitive value to be loaded. - - - - - Provides appropriate Ldind.X opcode for - the type of primitive value to be loaded indirectly. - - - - - Emits a load indirect opcode of the appropriate type for a value or object reference. - Pops a pointer off the evaluation stack, dereferences it and loads - a value of the specified type. - - - - - - - Emits a load opcode of the appropriate kind for a constant string or - primitive value. - - - - - - - Emits a load opcode of the appropriate kind for the constant default value of a - type, such as 0 for value types and null for reference types. - - - - - Emits a store indirectopcode of the appropriate type for a value or object reference. - Pops a value of the specified type and a pointer off the evaluation stack, and - stores the value. - - - - - - - Summary description for PropertiesCollection. - - - - - Wraps a reference that is passed - ByRef and provides indirect load/store support. - - - - - Summary description for NewArrayExpression. - - - - - - - - - Provides appropriate Stind.X opcode - for the type of primitive value to be stored indirectly. - - - - - Initializes a new instance of the class. - - The name. - Type declaring the original event being overriten, or null. - - The add method. - The remove method. - The attributes. - - - - Represents the scope of uniquenes of names for types and their members - - - - - Gets a unique name based on - - Name suggested by the caller - Unique name based on . - - Implementers should provide name as closely resembling as possible. - Generally if no collision occurs it is suggested to return suggested name, otherwise append sequential suffix. - Implementers must return deterministic names, that is when is called twice - with the same suggested name, the same returned name should be provided each time. Non-deterministic return - values, like appending random suffices will break serialization of proxies. - - - - - Returns new, disposable naming scope. It is responsibilty of the caller to make sure that no naming collision - with enclosing scope, or other subscopes is possible. - - New naming scope. - - - - Returns the methods implemented by a type. Use this instead of Type.GetMethods() to work around a CLR issue - where duplicate MethodInfos are returned by Type.GetMethods() after a token of a generic type's method was loaded. - - - - - Determines whether the specified method is internal. - - The method. - - true if the specified method is internal; otherwise, false. - - - - - Determines whether this assembly has internals visible to dynamic proxy. - - The assembly to inspect. - - - - Checks if the method is public or protected. - - - - - - - Because we need to cache the types based on the mixed in mixins, we do the following here: - - Get all the mixin interfaces - - Sort them by full name - - Return them by position - - The idea is to have reproducible behavior for the case that mixins are registered in different orders. - This method is here because it is required - - - - - Summary description for ModuleScope. - - - - - The default file name used when the assembly is saved using . - - - - - The default assembly (simple) name used for the assemblies generated by a instance. - - - - - Initializes a new instance of the class; assemblies created by this instance will not be saved. - - - - - Initializes a new instance of the class, allowing to specify whether the assemblies generated by this instance - should be saved. - - If set to true saves the generated module. - - - - Initializes a new instance of the class, allowing to specify whether the assemblies generated by this instance - should be saved. - - If set to true saves the generated module. - If set to true disables ability to generate signed module. This should be used in cases where ran under constrained permissions. - - - - Initializes a new instance of the class, allowing to specify whether the assemblies generated by this instance - should be saved and what simple names are to be assigned to them. - - If set to true saves the generated module. - If set to true disables ability to generate signed module. This should be used in cases where ran under constrained permissions. - The simple name of the strong-named assembly generated by this . - The path and file name of the manifest module of the strong-named assembly generated by this . - The simple name of the weak-named assembly generated by this . - The path and file name of the manifest module of the weak-named assembly generated by this . - - - - Initializes a new instance of the class, allowing to specify whether the assemblies generated by this instance - should be saved and what simple names are to be assigned to them. - - If set to true saves the generated module. - If set to true disables ability to generate signed module. This should be used in cases where ran under constrained permissions. - Naming scope used to provide unique names to generated types and their members (usually via sub-scopes). - The simple name of the strong-named assembly generated by this . - The path and file name of the manifest module of the strong-named assembly generated by this . - The simple name of the weak-named assembly generated by this . - The path and file name of the manifest module of the weak-named assembly generated by this . - - - - Returns a type from this scope's type cache, or null if the key cannot be found. - - The key to be looked up in the cache. - The type from this scope's type cache matching the key, or null if the key cannot be found - - - - Registers a type in this scope's type cache. - - The key to be associated with the type. - The type to be stored in the cache. - - - - Gets the key pair used to sign the strong-named assembly generated by this . - - - - - - Gets the specified module generated by this scope, creating a new one if none has yet been generated. - - If set to true, a strong-named module is returned; otherwise, a weak-named module is returned. - A strong-named or weak-named module generated by this scope, as specified by the parameter. - - - - Gets the strong-named module generated by this scope, creating a new one if none has yet been generated. - - A strong-named module generated by this scope. - - - - Gets the weak-named module generated by this scope, creating a new one if none has yet been generated. - - A weak-named module generated by this scope. - - - - Saves the generated assembly with the name and directory information given when this instance was created (or with - the and current directory if none was given). - - - - This method stores the generated assembly in the directory passed as part of the module information specified when this instance was - constructed (if any, else the current directory is used). If both a strong-named and a weak-named assembly - have been generated, it will throw an exception; in this case, use the overload. - - - If this was created without indicating that the assembly should be saved, this method does nothing. - - - Both a strong-named and a weak-named assembly have been generated. - The path of the generated assembly file, or null if no file has been generated. - - - - Saves the specified generated assembly with the name and directory information given when this instance was created - (or with the and current directory if none was given). - - True if the generated assembly with a strong name should be saved (see ); - false if the generated assembly without a strong name should be saved (see . - - - This method stores the specified generated assembly in the directory passed as part of the module information specified when this instance was - constructed (if any, else the current directory is used). - - - If this was created without indicating that the assembly should be saved, this method does nothing. - - - No assembly has been generated that matches the parameter. - - The path of the generated assembly file, or null if no file has been generated. - - - - Loads the generated types from the given assembly into this 's cache. - - The assembly to load types from. This assembly must have been saved via or - , or it must have the manually applied. - - This method can be used to load previously generated and persisted proxy types from disk into this scope's type cache, eg. in order - to avoid the performance hit associated with proxy generation. - - - - - Users of this should use this lock when accessing the cache. - - - - - Gets the strong-named module generated by this scope, or if none has yet been generated. - - The strong-named module generated by this scope, or if none has yet been generated. - - - - Gets the file name of the strongly named module generated by this scope. - - The file name of the strongly named module generated by this scope. - - - - Gets the directory where the strongly named module generated by this scope will be saved, or if the current directory - is used. - - The directory where the strongly named module generated by this scope will be saved when is called - (if this scope was created to save modules). - - - - Gets the weak-named module generated by this scope, or if none has yet been generated. - - The weak-named module generated by this scope, or if none has yet been generated. - - - - Gets the file name of the weakly named module generated by this scope. - - The file name of the weakly named module generated by this scope. - - - - Gets the directory where the weakly named module generated by this scope will be saved, or if the current directory - is used. - - The directory where the weakly named module generated by this scope will be saved when is called - (if this scope was created to save modules). - - - - ProxyBuilder that persists the generated type. - - - The saved assembly contains just the last generated type. - - - - - Initializes a new instance of the class. - - - - - Saves the generated assembly to a physical file. Note that this renders the unusable. - - The path of the generated assembly file, or null if no assembly has been generated. - - This method does not support saving multiple files. If both a signed and an unsigned module have been generated, use the - respective methods of the . - - - - - Initializes a new instance of the class. - - The hook. - - - - Initializes a new instance of the class. - - - - - Provides proxy objects for classes and interfaces. - - - - - Initializes a new instance of the class. - - Proxy types builder. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - If true forces all types to be generated into an unsigned module. - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - Object proxying calls to members of on object. - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of types on generated target object. - - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - As a result of that also at least one implementation must be provided. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of types on generated target object. - - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - As a result of that also at least one implementation must be provided. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of types on generated target object. - - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - As a result of that also at least one implementation must be provided. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The proxy generation options used to influence generated proxy type and object. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no parameterless constructor exists on type . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The proxy generation options used to influence generated proxy type and object. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no parameterless constructor exists on type . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The proxy generation options used to influence generated proxy type and object. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates the proxy type for class proxy with given class, implementing given and using provided . - - The base class for proxy type. - The interfaces that proxy type should implement. - The options for proxy generation process. - of proxy. - - - - Creates the proxy type for interface proxy with target for given interface, implementing given on given and using provided . - - The interface proxy type should implement. - The additional interfaces proxy type should implement. - Actual type that the proxy type will encompass. - The options for proxy generation process. - of proxy. - - - - Creates the proxy type for interface proxy with target interface for given interface, implementing given on given and using provided . - - The interface proxy type should implement. - The additional interfaces proxy type should implement. - The options for proxy generation process. - of proxy. - - - - Creates the proxy type for interface proxy without target for given interface, implementing given and using provided . - - The interface proxy type should implement. - The additional interfaces proxy type should implement. - The options for proxy generation process. - of proxy. - - - - Gets or sets the that this log to. - - - - - Gets the proxy builder instance used to generate proxy types. - - The proxy builder. - - - - - - - - - - - - - For interface proxies, this will point to the - on the target class - - - - - Handles the deserialization of proxies. - - - - - Resets the used for deserialization to a new scope. - - - This is useful for test cases. - - - - - Resets the used for deserialization to a given . - - The scope to be used for deserialization. - - By default, the deserialization process uses a different scope than the rest of the application, which can lead to multiple proxies - being generated for the same type. By explicitly setting the deserialization scope to the application's scope, this can be avoided. - - - - - Gets the used for deserialization. - - As has no way of automatically determining the scope used by the application (and the application might use more than one scope at the same time), uses a dedicated scope instance for deserializing proxy types. This instance can be reset and set to a specific value via and . - - - - Holds objects representing methods of class. - - - - - Holds objects representing methods of class. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Provides an extension point that allows proxies to choose specific interceptors on - a per method basis. - - - - - Selects the interceptors that should intercept calls to the given . - - The type declaring the method to intercept. - The method that will be intercepted. - All interceptors registered with the proxy. - An array of interceptors to invoke upon calling the . - - This method is called only once per proxy instance, upon the first call to the - . Either an empty array or null are valid return values to indicate - that no interceptor should intercept calls to the method. Although it is not advised, it is - legal to return other implementations than these provided in - . - - - - - Creates a new lock. - - - - - - This interface should be implemented by classes - that are available in a bigger context, exposing - the container to different areas in the same application. - - For example, in Web application, the (global) HttpApplication - subclasses should implement this interface to expose - the configured container - - - - - - Exposes means to change target objects of proxies and invocations - - - - - Changes the target object () of current . - - The new value of target of invocation. - - Although the method takes the actual instance must be of type assignable to , otherwise an will be thrown. - Also while it's technically legal to pass null reference (Nothing in Visual Basic) as , for obvious reasons Dynamic Proxy will not be able to call the intercepted method on such target. - In this case last interceptor in the pipeline mustn't call or a will be throws. - Also while it's technically legal to pass proxy itself as , this would create stack overflow. - In this case last interceptor in the pipeline mustn't call or a will be throws. - - Thrown when is not assignable to the proxied type. - - - - Permanently changes the target object of the proxy. This does not affect target of the current invocation. - - The new value of target of the proxy. - - Although the method takes the actual instance must be of type assignable to proxy's target type, otherwise an will be thrown. - Also while it's technically legal to pass null reference (Nothing in Visual Basic) as , for obvious reasons Dynamic Proxy will not be able to call the intercepted method on such target. - In this case last interceptor in the pipeline mustn't call or a will be throws. - Also while it's technically legal to pass proxy itself as , this would create stack overflow. - In this case last interceptor in the pipeline mustn't call or a will be throws. - - Thrown when is not assignable to the proxied type. - - - - New interface that is going to be used by DynamicProxy 2 - - - - - Get the proxy target (note that null is a valid target!) - - - - - - Gets the interceptors for the proxy - - - - - - Defines that the implementation wants a - in order to - access other components. The creator must be aware - that the component might (or might not) implement - the interface. - - - Used by Castle Project components to, for example, - gather logging factories - - - - - Increments IServiceProvider with a generic service resolution operation. - - - - - Provides a factory that can produce either or - classes. - - - - - Manages the instantiation of s. - - - - - Creates a new logger, getting the logger name from the specified type. - - - - - Creates a new logger. - - - - - Creates a new logger, getting the logger name from the specified type. - - - - - Creates a new logger. - - - - - Creates a new extended logger, getting the logger name from the specified type. - - - - - Creates a new extended logger. - - - - - Creates a new extended logger, getting the logger name from the specified type. - - - - - Creates a new extended logger. - - - - - Creates a new extended logger, getting the logger name from the specified type. - - - - - Creates a new extended logger. - - - - - Creates a new extended logger, getting the logger name from the specified type. - - - - - Creates a new extended logger. - - - - - Creates a new logger, getting the logger name from the specified type. - - - - - Creates a new logger. - - - - - Creates a new logger, getting the logger name from the specified type. - - - - - Creates a new logger. - - - - - Gets the configuration file. - - i.e. log4net.config - - - - - Used to create the TraceLogger implementation of ILogger interface. See . - - - - - Gets the configuration file. - - i.e. log4net.config - - - - - Interface for Context Properties implementations - - - - This interface defines a basic property get set accessor. - - - Based on the ContextPropertiesBase of log4net, by Nicko Cadell. - - - - - - Gets or sets the value of a property - - - The value for the property with the specified key - - - - Gets or sets the value of a property - - - - - - NullLogFactory used when logging is turned off. - - - - - Creates an instance of ILogger with the specified name. - - Name. - - - - - Creates an instance of ILogger with the specified name and LoggerLevel. - - Name. - Level. - - - - - Creates outputing - to files. The name of the file is derived from the log name - plus the 'log' extension. - - - - - Provides an interface that supports and - allows the storage and retrieval of Contexts. These are supported in - both log4net and NLog. - - - - - Manages logging. - - - This is a facade for the different logging subsystems. - It offers a simplified interface that follows IOC patterns - and a simplified priority/level/severity abstraction. - - - - - Create a new child logger. - The name of the child logger is [current-loggers-name].[passed-in-name] - - The Subname of this logger. - The New ILogger instance. - If the name has an empty element name. - - - - Logs a debug message. - - The message to log - - - - Logs a debug message with lazily constructed message. The message will be constructed only if the is true. - - - - - - Logs a debug message. - - The exception to log - The message to log - - - - Logs a debug message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The message to log - - - - Logs an error message with lazily constructed message. The message will be constructed only if the is true. - - - - - - Logs an error message. - - The exception to log - The message to log - - - - Logs an error message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The message to log - - - - Logs a fatal message with lazily constructed message. The message will be constructed only if the is true. - - - - - - Logs a fatal message. - - The exception to log - The message to log - - - - Logs a fatal message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The message to log - - - - Logs a info message with lazily constructed message. The message will be constructed only if the is true. - - - - - - Logs an info message. - - The exception to log - The message to log - - - - Logs an info message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The message to log - - - - Logs a warn message with lazily constructed message. The message will be constructed only if the is true. - - - - - - Logs a warn message. - - The exception to log - The message to log - - - - Logs a warn message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Determines if messages of priority "debug" will be logged. - - True if "debug" messages will be logged. - - - - Determines if messages of priority "error" will be logged. - - True if "error" messages will be logged. - - - - Determines if messages of priority "fatal" will be logged. - - True if "fatal" messages will be logged. - - - - Determines if messages of priority "info" will be logged. - - True if "info" messages will be logged. - - - - Determines if messages of priority "warn" will be logged. - - True if "warn" messages will be logged. - - - - Exposes the Global Context of the extended logger. - - - - - Exposes the Thread Context of the extended logger. - - - - - Exposes the Thread Stack of the extended logger. - - - - - The Logger sending everything to the standard output streams. - This is mainly for the cases when you have a utility that - does not have a logger to supply. - - - - - The Level Filtered Logger class. This is a base clase which - provides a LogLevel attribute and reroutes all functions into - one Log method. - - - - - Creates a new LevelFilteredLogger. - - - - - Keep the instance alive in a remoting scenario - - - - - - Logs a debug message. - - The message to log - - - - Logs a debug message. - - The exception to log - The message to log - - - - Logs a debug message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The message to log - - - - Logs an info message. - - The exception to log - The message to log - - - - Logs an info message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The message to log - - - - Logs a warn message. - - The exception to log - The message to log - - - - Logs a warn message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The message to log - - - - Logs an error message. - - The exception to log - The message to log - - - - Logs an error message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The message to log - - - - Logs a fatal message. - - The exception to log - The message to log - - - - Logs a fatal message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Implementors output the log content by implementing this method only. - Note that exception can be null - - - - - - - - - The LoggerLevel that this logger - will be using. Defaults to LoggerLevel.Off - - - - - The name that this logger will be using. - Defaults to String.Empty - - - - - Determines if messages of priority "debug" will be logged. - - true if log level flags include the bit - - - - Determines if messages of priority "info" will be logged. - - true if log level flags include the bit - - - - Determines if messages of priority "warn" will be logged. - - true if log level flags include the bit - - - - Determines if messages of priority "error" will be logged. - - true if log level flags include the bit - - - - Determines if messages of priority "fatal" will be logged. - - true if log level flags include the bit - - - - Creates a new ConsoleLogger with the Level - set to LoggerLevel.Debug and the Name - set to String.Empty. - - - - - Creates a new ConsoleLogger with the Name - set to String.Empty. - - The logs Level. - - - - Creates a new ConsoleLogger with the Level - set to LoggerLevel.Debug. - - The logs Name. - - - - Creates a new ConsoleLogger. - - The logs Name. - The logs Level. - - - - A Common method to log. - - The level of logging - The name of the logger - The Message - The Exception - - - - Returns a new ConsoleLogger with the name - added after this loggers name, with a dot in between. - - The added hierarchical name. - A new ConsoleLogger. - - - - The Logger using standart Diagnostics namespace. - - - - - Creates a logger based on . - - - - - - Creates a logger based on . - - - - - - - Creates a logger based on . - - - - - - - - The Null Logger class. This is useful for implementations where you need - to provide a logger to a utility class, but do not want any output from it. - It also helps when you have a utility that does not have a logger to supply. - - - - - Returns this NullLogger. - - Ignored - This ILogger instance. - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - Returns empty context properties. - - - - - Returns empty context properties. - - - - - Returns empty context stacks. - - - - - No-op. - - false - - - - No-op. - - false - - - - No-op. - - false - - - - No-op. - - false - - - - No-op. - - false - - - - The Stream Logger class. This class can stream log information - to any stream, it is suitable for storing a log file to disk, - or to a MemoryStream for testing your components. - - - This logger is not thread safe. - - - - - Creates a new StreamLogger with default encoding - and buffer size. Initial Level is set to Debug. - - - The name of the log. - - - The stream that will be used for logging, - seeking while the logger is alive - - - - - Creates a new StreamLogger with default buffer size. - Initial Level is set to Debug. - - - The name of the log. - - - The stream that will be used for logging, - seeking while the logger is alive - - - The encoding that will be used for this stream. - - - - - - Creates a new StreamLogger. - Initial Level is set to Debug. - - - The name of the log. - - - The stream that will be used for logging, - seeking while the logger is alive - - - The encoding that will be used for this stream. - - - - The buffer size that will be used for this stream. - - - - - - Creates a new StreamLogger with - Debug as default Level. - - The name of the log. - The StreamWriter the log will write to. - - - - The TraceLogger sends all logging to the System.Diagnostics.TraceSource - built into the .net framework. - - - Logging can be configured in the system.diagnostics configuration - section. - - If logger doesn't find a source name with a full match it will - use source names which match the namespace partially. For example you can - configure from all castle components by adding a source name with the - name "Castle". - - If no portion of the namespace matches the source named "Default" will - be used. - - - - - Build a new trace logger based on the named TraceSource - - The name used to locate the best TraceSource. In most cases comes from the using type's fullname. - - - - Build a new trace logger based on the named TraceSource - - The name used to locate the best TraceSource. In most cases comes from the using type's fullname. - The default logging level at which this source should write messages. In almost all cases this - default value will be overridden in the config file. - - - - Create a new child logger. - The name of the child logger is [current-loggers-name].[passed-in-name] - - The Subname of this logger. - The New ILogger instance. - - - - This is an abstract implementation - that deals with methods that can be abstracted away - from underlying implementations. - - - AbstractConfiguration makes easier to implementers - to create a new version of - - - - - is a interface encapsulating a configuration node - used to retrieve configuration values. - - - - - Gets the value of the node and converts it - into specified . - - The - - The Default value returned if the conversion fails. - - The Value converted into the specified type. - - - - Gets the name of the node. - - - The Name of the node. - - - - - Gets the value of the node. - - - The Value of the node. - - - - - Gets an of - elements containing all node children. - - The Collection of child nodes. - - - - Gets an of the configuration attributes. - - - - - Gets the value of the node and converts it - into specified . - - The - - The Default value returned if the conversion fails. - - The Value converted into the specified type. - - - - Gets node attributes. - - - All attributes of the node. - - - - - Gets all child nodes. - - The of child nodes. - - - - Gets the name of the . - - - The Name of the . - - - - - Gets the value of . - - - The Value of the . - - - - - A collection of objects. - - - - - Creates a new instance of ConfigurationCollection. - - - - - Creates a new instance of ConfigurationCollection. - - - - - Summary description for MutableConfiguration. - - - - - Initializes a new instance of the class. - - The name. - - - - Gets the value of . - - - The Value of the . - - - - - Deserializes the specified node into an abstract representation of configuration. - - The node. - - - - - If a config value is an empty string we return null, this is to keep - backward compatibility with old code - - - - - General purpose class to represent a standard pair of values. - - Type of the first value - Type of the second value - - - - Constructs a pair with its values - - - - - - - List of utility methods related to dynamic proxy operations - - - - - Determines whether the specified type is a proxy generated by - DynamicProxy (1 or 2). - - The type. - - true if it is a proxy; otherwise, false. - - - - - Readonly implementation of which uses an anonymous object as its source. Uses names of properties as keys, and property values as... well - values. Keys are not case sensitive. - - - - - Initializes a new instance of the class. - - The target. - - - - Adds an element with the provided key and value to the object. - - The to use as the key of the element to add. - The to use as the value of the element to add. - - is null. - An element with the same key already exists in the object. - The is read-only.-or- The has a fixed size. - - - - Removes all elements from the object. - - The object is read-only. - - - - Determines whether the object contains an element with the specified key. - - The key to locate in the object. - - true if the contains an element with the key; otherwise, false. - - - is null. - - - - Removes the element with the specified key from the object. - - The key of the element to remove. - - is null. - The object is read-only.-or- The has a fixed size. - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - - - - Copies the elements of the to an , starting at a particular index. - - The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing. - The zero-based index in at which copying begins. - - is null. - - is less than zero. - - is multidimensional.-or- is equal to or greater than the length of .-or- The number of elements in the source is greater than the available space from to the end of the destination . - The type of the source cannot be cast automatically to the type of the destination . - - - - Returns an object for the object. - - - An object for the object. - - - - - Reads values of properties from and inserts them into using property names as keys. - - - - - - - Gets the number of elements contained in the . - - - The number of elements contained in the . - - - - Gets a value indicating whether access to the is synchronized (thread safe). - - - true if access to the is synchronized (thread safe); otherwise, false. - - - - Gets an object that can be used to synchronize access to the . - - - An object that can be used to synchronize access to the . - - - - Gets a value indicating whether the object is read-only. - - - true if the object is read-only; otherwise, false. - - - - Gets or sets the with the specified key. - - - - - - Gets an object containing the keys of the object. - - - An object containing the keys of the object. - - - - Gets an object containing the values in the object. - - - An object containing the values in the object. - - - - Gets a value indicating whether the object has a fixed size. - - - true if the object has a fixed size; otherwise, false. - - - - Represents a 'streamable' resource. Can - be a file, a resource in an assembly. - - - - - Returns a reader for the stream - - - It's up to the caller to dispose the reader. - - - - - - Returns a reader for the stream - - - It's up to the caller to dispose the reader. - - - - - - - Returns an instance of - created according to the relativePath - using itself as the root. - - - - - - - - - - Only valid for resources that - can be obtained through relative paths - - - - - - - - - - This returns a new stream instance each time it is called. - It is the responsibility of the caller to dispose of this stream - - - - - Depicts the contract for resource factories. - - - - - Used to check whether the resource factory - is able to deal with the given resource - identifier. - - - Implementors should return true - only if the given identifier is supported - by the resource factory - - - - - - - Creates an instance - for the given resource identifier - - - - - - - Creates an instance - for the given resource identifier - - - - - - - - - - - - - - - - - - Adapts a static string content as an - - - - - Enable access to files on network shares - - - - - Email sender abstraction. - - - - - Sends a mail message. - - From field - To field - E-mail's subject - message's body - - - - Sends a message. - - Message instance - - - - Sends multiple messages. - - List of messages - - - - Default implementation. - - - - - Initializes a new instance of the class based on the configuration provided in the application configuration file. - - - This constructor is based on the default configuration in the application configuration file. - - - - - This service implementation - requires a host name in order to work - - The smtp server name - - - - Sends a message. - - If any of the parameters is null - From field - To field - e-mail's subject - message's body - - - - Sends a message. - - If the message is null - Message instance - - - - Configures the sender - with port information and eventual credential - informed - - Message instance - - - - Gets or sets the port used to - access the SMTP server - - - - - Gets the hostname. - - The hostname. - - - - Gets or sets a value which is used to - configure if emails are going to be sent asynchronously or not. - - - - - Gets or sets a value that specifies - the amount of time after which a synchronous Send call times out. - - - - - Gets or sets a value indicating whether the email should be sent using - a secure communication channel. - - true if should use SSL; otherwise, false. - - - - Gets or sets the domain. - - The domain. - - - - Gets or sets the name of the user. - - The name of the user. - - - - Gets or sets the password. - - The password. - - - - Gets a value indicating whether credentials were informed. - - - if this instance has credentials; otherwise, . - - - - diff --git a/packages/Castle.Core.3.3.3/lib/sl4/Castle.Core.dll b/packages/Castle.Core.3.3.3/lib/sl4/Castle.Core.dll deleted file mode 100644 index eb0280c..0000000 Binary files a/packages/Castle.Core.3.3.3/lib/sl4/Castle.Core.dll and /dev/null differ diff --git a/packages/Castle.Core.3.3.3/lib/sl4/Castle.Core.xml b/packages/Castle.Core.3.3.3/lib/sl4/Castle.Core.xml deleted file mode 100644 index ec23220..0000000 --- a/packages/Castle.Core.3.3.3/lib/sl4/Castle.Core.xml +++ /dev/null @@ -1,4243 +0,0 @@ - - - - Castle.Core - - - - - Specifies assignment by reference rather than by copying. - - - - - Suppresses any on-demand behaviors. - - - - - Removes a property if null or empty string, guid or collection. - - - - - Removes a property if matches value. - - - - - Assigns a specific dictionary key. - - - - - Defines the contract for customizing dictionary access. - - - - - Copies the dictionary behavior. - - null if should not be copied. Otherwise copy. - - - - Determines relative order to apply related behaviors. - - - - - Defines the contract for updating dictionary values. - - - - - Sets the stored dictionary value. - - The dictionary adapter. - The key. - The stored value. - The property. - true if the property should be stored. - - - - Contract for value matching. - - - - - Indicates that underlying values are changeable and should not be cached. - - - - - Contract for dictionary initialization. - - - - - Performs any initialization of the - - The dictionary adapter. - The dictionary behaviors. - - - - Abstract implementation of . - - - - - Conract for traversing a . - - - - - Contract for creating additional Dictionary adapters. - - - - - Contract for manipulating the Dictionary adapter. - - - - - Contract for editing the Dictionary adapter. - - - - - Contract for managing Dictionary adapter notifications. - - - - - Contract for validating Dictionary adapter. - - - - - Defines the contract for building s. - - - - - Builds the dictionary behaviors. - - - - - - Abstract adapter for the support - needed by the - - - - - Adds an element with the provided key and value to the object. - - The to use as the key of the element to add. - The to use as the value of the element to add. - An element with the same key already exists in the object. - key is null. - The is read-only.-or- The has a fixed size. - - - - Removes all elements from the object. - - The object is read-only. - - - - Determines whether the object contains an element with the specified key. - - The key to locate in the object. - - true if the contains an element with the key; otherwise, false. - - key is null. - - - - Returns an object for the object. - - - An object for the object. - - - - - Removes the element with the specified key from the object. - - The key of the element to remove. - The object is read-only.-or- The has a fixed size. - key is null. - - - - Copies the elements of the to an , starting at a particular index. - - The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing. - The zero-based index in array at which copying begins. - array is null. - The type of the source cannot be cast automatically to the type of the destination array. - index is less than zero. - array is multidimensional.-or- index is equal to or greater than the length of array.-or- The number of elements in the source is greater than the available space from index to the end of the destination array. - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - - - - Gets a value indicating whether the object has a fixed size. - - - true if the object has a fixed size; otherwise, false. - - - - Gets a value indicating whether the object is read-only. - - - true if the object is read-only; otherwise, false. - - - - Gets an object containing the keys of the object. - - - An object containing the keys of the object. - - - - Gets an object containing the values in the object. - - - An object containing the values in the object. - - - - Gets or sets the with the specified key. - - - - - - Gets the number of elements contained in the . - - - The number of elements contained in the . - - - - Gets a value indicating whether access to the is synchronized (thread safe). - - - true if access to the is synchronized (thread safe); otherwise, false. - - - - Gets an object that can be used to synchronize access to the . - - - An object that can be used to synchronize access to the . - - - - Checks whether or not collection is null or empty. Assumes colleciton can be safely enumerated multiple times. - - - - - - - Creates a message to inform clients that a proxy couldn't be created due to reliance on an - inaccessible type (perhaps itself). - - the inaccessible type that prevents proxy creation - the type that couldn't be proxied - - - - Find the best available name to describe a type. - - - Usually the best name will be , but - sometimes that's null (see http://msdn.microsoft.com/en-us/library/system.type.fullname%28v=vs.110%29.aspx) - in which case the method falls back to . - - the type to name - the best name - - - - Constant to use when making assembly internals visible to Castle.Core - [assembly: InternalsVisibleTo(CoreInternalsVisible.ToCastleCore)] - - - - - Constant to use when making assembly internals visible to proxy types generated by DynamicProxy. Required when proxying internal types. - [assembly: InternalsVisibleTo(CoreInternalsVisible.ToDynamicProxyGenAssembly2)] - - - - - Identifies a property should be represented as a nested component. - - - - - Defines the contract for building typed dictionary keys. - - - - - Builds the specified key. - - The dictionary adapter. - The current key. - The property. - The updated key - - - - Defines the contract for retrieving dictionary values. - - - - - Gets the effective dictionary value. - - The dictionary adapter. - The key. - The stored value. - The property. - true if return only existing. - The effective property value. - - - - Applies no prefix. - - - - - Gets or sets the prefix. - - The prefix. - - - - Identifies the dictionary adapter types. - - - - - Identifies an interface or property to be pre-fetched. - - - - - Instructs fetching to occur. - - - - - Instructs fetching according to - - - - - - Gets whether or not fetching should occur. - - - - - Assigns a property to a group. - - - - - Constructs a group assignment. - - The group name. - - - - Constructs a group assignment. - - The group name. - - - - Gets the group the property is assigned to. - - - - - Assigns a specific dictionary key. - - - - - Initializes a new instance of the class. - - The key. - - - - Initializes a new instance of the class. - - The compound key. - - - - Assigns a prefix to the keyed properties of an interface. - - - Key prefixes are not inherited by sub-interfaces. - - - - - Initializes a default instance of the class. - - - - - Initializes a new instance of the class. - - The prefix for the keyed properties of the interface. - - - - Gets the prefix key added to the properties of the interface. - - - - - Substitutes part of key with another string. - - - - - Initializes a new instance of the class. - - The old value. - The new value. - - - - Requests support for multi-level editing. - - - - - Generates a new GUID on demand. - - - - - Support for on-demand value resolution. - - - - - Provides simple string formatting from existing properties. - - - - - Gets the string format. - - - - - Gets the format properties. - - - - - Identifies a property should be represented as a delimited string value. - - - - - Gets the separator. - - - - - Converts all properties to strings. - - - - - Gets or sets the format. - - The format. - - - - Suppress property change notifications. - - - - - Contract for property descriptor initialization. - - - - - Performs any initialization of the - - The property descriptor. - The property behaviors. - - - - Assigns a prefix to the keyed properties using the interface name. - - - - - Manages conversion between property values. - - - - - Initializes a new instance of the class. - - The converter. - - - - Gets the effective dictionary value. - - The dictionary adapter. - The key. - The stored value. - The property. - true if return only existing. - The effective property value. - - - - - - - - - Uses Reflection.Emit to expose the properties of a dictionary - through a dynamic implementation of a typed interface. - - - - - Defines the contract for building typed dictionary adapters. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - An implementation of the typed interface bound to the dictionary. - - The type represented by T must be an interface with properties. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - An implementation of the typed interface bound to the dictionary. - - The type represented by T must be an interface with properties. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - The property descriptor. - An implementation of the typed interface bound to the dictionary. - - The type represented by T must be an interface with properties. - - - - - Gets the associated with the type. - - The typed interface. - The adapter meta-data. - - - - Gets the associated with the type. - - The typed interface. - The property descriptor. - The adapter meta-data. - - - - Gets the associated with the type. - - The typed interface. - Another from which to copy behaviors. - The adapter meta-data. - - - - - - - - - - - - - - - - - - - - - - - - - - - - Contract for dictionary meta-data initialization. - - - - - Initializes the given object. - - The dictionary adapter factory. - The dictionary adapter meta. - - - - - Determines whether the given behavior should be included in a new - object. - - A dictionary behavior or annotation. - True if the behavior should be included; otherwise, false. - - behaviors are always included, - regardless of the result of this method. - - - - - - Contract for dictionary validation. - - - - - Determines if is valid. - - The dictionary adapter. - true if valid. - - - - Validates the . - - The dictionary adapter. - The error summary information. - - - - Validates the for a property. - - The dictionary adapter. - The property to validate. - The property summary information. - - - - Invalidates any results cached by the validator. - - The dictionary adapter. - - - - Describes a dictionary property. - - - - - Initializes an empty class. - - - - - Initializes a new instance of the class. - - The property. - The annotations. - - - - Initializes a new instance class. - - - - - Copies an existinginstance of the class. - - - - - - - Gets the key. - - The dictionary adapter. - The key. - The descriptor. - - - - - Gets the property value. - - The dictionary adapter. - The key. - The stored value. - The descriptor. - true if return only existing. - - - - - Sets the property value. - - The dictionary adapter. - The key. - The value. - The descriptor. - - - - - Adds a single behavior. - - The behavior. - - - - Adds the behaviors. - - The behaviors. - - - - Adds the behaviors. - - The behaviors. - - - - Copies the behaviors to the other - - - - - - - Copies the - - - - - - - - - - - Gets the property name. - - - - - Gets the property type. - - - - - Gets the property. - - The property. - - - - Returns true if the property is dynamic. - - - - - Gets additional state. - - - - - Determines if property should be fetched. - - - - - Determines if property must exist first. - - - - - Determines if notifications should occur. - - - - - Gets the property behaviors. - - - - - Gets the type converter. - - The type converter. - - - - Gets the extended properties. - - - - - Gets the setter. - - The setter. - - - - Gets the key builders. - - The key builders. - - - - Gets the setter. - - The setter. - - - - Gets the getter. - - The getter. - - - - Gets the initializers. - - The initializers. - - - - Gets the meta-data initializers. - - The meta-data initializers. - - - - Helper class for retrieving attributes. - - - - - Gets the attribute. - - The member. - The member attribute. - - - - Gets the attributes. Does not consider inherited attributes! - - The member. - The member attributes. - - - - Gets the type attribute. - - The type. - The type attribute. - - - - Gets the type attributes. - - The type. - The type attributes. - - - - Gets the type converter. - - The member. - - - - - Gets the attribute. - - The member. - The member attribute. - - - - Contract for typed dynamic value resolution. - - - - - - Contract for dynamic value resolution. - - - - - Supporting Logger levels. - - - - - Logging will be off - - - - - Fatal logging level - - - - - Error logging level - - - - - Warn logging level - - - - - Info logging level - - - - - Debug logging level - - - - - Encapsulates an invocation of a proxied method. - - - - - Gets the value of the argument at the specified . - - The index. - The value of the argument at the specified . - - - - Returns the concrete instantiation of the on the proxy, with any generic - parameters bound to real types. - - - The concrete instantiation of the on the proxy, or the if - not a generic method. - - - Can be slower than calling . - - - - - Returns the concrete instantiation of , with any - generic parameters bound to real types. - For interface proxies, this will point to the on the target class. - - The concrete instantiation of , or - if not a generic method. - - In debug builds this can be slower than calling . - - - - - Proceeds the call to the next interceptor in line, and ultimately to the target method. - - - Since interface proxies without a target don't have the target implementation to proceed to, - it is important, that the last interceptor does not call this method, otherwise a - will be thrown. - - - - - Overrides the value of an argument at the given with the - new provided. - - - This method accepts an , however the value provided must be compatible - with the type of the argument defined on the method, otherwise an exception will be thrown. - - The index of the argument to override. - The new value for the argument. - - - - Gets the arguments that the has been invoked with. - - The arguments the method was invoked with. - - - - Gets the generic arguments of the method. - - The generic arguments, or null if not a generic method. - - - - Gets the object on which the invocation is performed. This is different from proxy object - because most of the time this will be the proxy target object. - - - The invocation target. - - - - Gets the representing the method being invoked on the proxy. - - The representing the method being invoked. - - - - For interface proxies, this will point to the on the target class. - - The method invocation target. - - - - Gets the proxy object on which the intercepted method is invoked. - - Proxy object on which the intercepted method is invoked. - - - - Gets or sets the return value of the method. - - The return value of the method. - - - - Gets the type of the target object for the intercepted method. - - The type of the target object. - - - - Used during the target type inspection process. Implementors have a chance to customize the - proxy generation process. - - - - - Invoked by the generation process to notify that the whole process has completed. - - - - - Invoked by the generation process to notify that a member was not marked as virtual. - - The type which declares the non-virtual member. - The non-virtual member. - - This method gives an opportunity to inspect any non-proxyable member of a type that has - been requested to be proxied, and if appropriate - throw an exception to notify the caller. - - - - - Invoked by the generation process to determine if the specified method should be proxied. - - The type which declares the given method. - The method to inspect. - True if the given method should be proxied; false otherwise. - - - - Interface describing elements composing generated type - - - - - Performs some basic screening and invokes the - to select methods. - - - - - - - - - Provides functionality for disassembling instances of attributes to CustomAttributeBuilder form, during the process of emiting new types by Dynamic Proxy. - - - - - Disassembles given attribute instance back to corresponding CustomAttributeBuilder. - - An instance of attribute to disassemble - corresponding 1 to 1 to given attribute instance, or null reference. - - Implementers should return that corresponds to given attribute instance 1 to 1, - that is after calling specified constructor with specified arguments, and setting specified properties and fields with values specified - we should be able to get an attribute instance identical to the one passed in . Implementer can return null - if it wishes to opt out of replicating the attribute. Notice however, that for some cases, like attributes passed explicitly by the user - it is illegal to return null, and doing so will result in exception. - - - - - Handles error during disassembly process - - Type of the attribute being disassembled - Exception thrown during the process - usually null, or (re)throws the exception - - - - Here we try to match a constructor argument to its value. - Since we can't get the values from the assembly, we use some heuristics to get it. - a/ we first try to match all the properties on the attributes by name (case insensitive) to the argument - b/ if we fail we try to match them by property type, with some smarts about convertions (i,e: can use Guid for string). - - - - - We have the following rules here. - Try to find a matching type, failing that, if the parameter is string, get the first property (under the assumption that - we can convert it. - - - - - Attributes can only accept simple types, so we return null for null, - if the value is passed as string we call to string (should help with converting), - otherwise, we use the value as is (enums, integer, etc). - - - - - Returns list of all unique interfaces implemented given types, including their base interfaces. - - - - - - - Base class that exposes the common functionalities - to proxy generation. - - - - - It is safe to add mapping (no mapping for the interface exists) - - - - - - - - Generates a parameters constructor that initializes the proxy - state with just to make it non-null. - - This constructor is important to allow proxies to be XML serializable - - - - - - Generates the constructor for the class that extends - - - - - - - - - Default implementation of interface producing in-memory proxy assemblies. - - - - - Abstracts the implementation of proxy type construction. - - - - - Creates a proxy type for given , implementing , using provided. - - The class type to proxy. - Additional interface types to proxy. - The proxy generation options. - The generated proxy type. - - Implementers should return a proxy type for the specified class and interfaces. - Additional interfaces should be only 'mark' interfaces, that is, they should work like interface proxy without target. (See method.) - - Thrown when or any of is a generic type definition. - Thrown when or any of is not public. - Note that to avoid this exception, you can mark offending type internal, and define - pointing to Castle Dynamic Proxy assembly, in assembly containing that type, if this is appropriate. - - - - - Creates a proxy type that proxies calls to members on , implementing , using provided. - - The interface type to proxy. - Additional interface types to proxy. - Type implementing on which calls to the interface members should be intercepted. - The proxy generation options. - The generated proxy type. - - Implementers should return a proxy type for the specified interface that 'proceeds' executions to the specified target. - Additional interfaces should be only 'mark' interfaces, that is, they should work like interface proxy without target. (See method.) - - Thrown when or any of is a generic type definition. - Thrown when or any of is not public. - Note that to avoid this exception, you can mark offending type internal, and define - pointing to Castle Dynamic Proxy assembly, in assembly containing that type, if this is appropriate. - - - - - Creates a proxy type for given and that delegates all calls to the provided interceptors and allows interceptors to switch the actual target of invocation. - - The interface type to proxy. - Additional interface types to proxy. - The proxy generation options. - The generated proxy type. - - Implementers should return a proxy type for the specified interface(s) that delegate all executions to the specified interceptors - and uses an instance of the interface as their targets (i.e. ), rather than a class. All classes should then implement interface, - to allow interceptors to switch invocation target with instance of another type implementing called interface. - - Thrown when or any of is a generic type definition. - Thrown when or any of is not public. - Note that to avoid this exception, you can mark offending type internal, and define - pointing to Castle Dynamic Proxy assembly, in assembly containing that type, if this is appropriate. - - - - - Creates a proxy type for given that delegates all calls to the provided interceptors. - - The interface type to proxy. - Additional interface types to proxy. - The proxy generation options. - The generated proxy type. - - Implementers should return a proxy type for the specified interface and additional interfaces that delegate all executions to the specified interceptors. - - Thrown when or any of is a generic type definition. - Thrown when or any of is not public. - Note that to avoid this exception, you can mark offending type internal, and define - pointing to Castle Dynamic Proxy assembly, in assembly containing that type, if this is appropriate. - - - - - Gets or sets the that this logs to. - - - - - Gets the associated with this builder. - - The module scope associated with this builder. - - - - Initializes a new instance of the class with new . - - - - - Initializes a new instance of the class. - - The module scope for generated proxy types. - - - - Registers custom disassembler to handle disassembly of specified type of attributes. - - Type of attributes to handle - Disassembler converting existing instances of Attributes to CustomAttributeBuilders - - When disassembling an attribute Dynamic Proxy will first check if an custom disassembler has been registered to handle attributes of that type, - and if none is found, it'll use the . - - - - - Attributes should be replicated if they are non-inheritable, - but there are some special cases where the attributes means - something to the CLR, where they should be skipped. - - - - - Initializes a new instance of the class. - - Target element. This is either target type or target method for invocation types. - The type of the proxy. This is base type for invocation types. - The interfaces. - The options. - - - - Initializes a new instance of the class. - - Type of the target. - The interfaces. - The options. - - - - s - Provides appropriate Ldc.X opcode for the type of primitive value to be loaded. - - - - - Provides appropriate Ldind.X opcode for - the type of primitive value to be loaded indirectly. - - - - - Emits a load indirect opcode of the appropriate type for a value or object reference. - Pops a pointer off the evaluation stack, dereferences it and loads - a value of the specified type. - - - - - - - Emits a load opcode of the appropriate kind for a constant string or - primitive value. - - - - - - - Emits a load opcode of the appropriate kind for the constant default value of a - type, such as 0 for value types and null for reference types. - - - - - Emits a store indirectopcode of the appropriate type for a value or object reference. - Pops a value of the specified type and a pointer off the evaluation stack, and - stores the value. - - - - - - - Summary description for PropertiesCollection. - - - - - Wraps a reference that is passed - ByRef and provides indirect load/store support. - - - - - Summary description for NewArrayExpression. - - - - - - - - - Provides appropriate Stind.X opcode - for the type of primitive value to be stored indirectly. - - - - - Initializes a new instance of the class. - - The name. - Type declaring the original event being overriten, or null. - - The add method. - The remove method. - The attributes. - - - - Represents the scope of uniquenes of names for types and their members - - - - - Gets a unique name based on - - Name suggested by the caller - Unique name based on . - - Implementers should provide name as closely resembling as possible. - Generally if no collision occurs it is suggested to return suggested name, otherwise append sequential suffix. - Implementers must return deterministic names, that is when is called twice - with the same suggested name, the same returned name should be provided each time. Non-deterministic return - values, like appending random suffices will break serialization of proxies. - - - - - Returns new, disposable naming scope. It is responsibilty of the caller to make sure that no naming collision - with enclosing scope, or other subscopes is possible. - - New naming scope. - - - - Returns the methods implemented by a type. Use this instead of Type.GetMethods() to work around a CLR issue - where duplicate MethodInfos are returned by Type.GetMethods() after a token of a generic type's method was loaded. - - - - - Determines whether the specified method is internal. - - The method. - - true if the specified method is internal; otherwise, false. - - - - - Determines whether this assembly has internals visible to dynamic proxy. - - The assembly to inspect. - - - - Checks if the method is public or protected. - - - - - - - Because we need to cache the types based on the mixed in mixins, we do the following here: - - Get all the mixin interfaces - - Sort them by full name - - Return them by position - - The idea is to have reproducible behavior for the case that mixins are registered in different orders. - This method is here because it is required - - - - - Summary description for ModuleScope. - - - - - The default file name used when the assembly is saved using . - - - - - The default assembly (simple) name used for the assemblies generated by a instance. - - - - - Initializes a new instance of the class; assemblies created by this instance will not be saved. - - - - - Initializes a new instance of the class, allowing to specify whether the assemblies generated by this instance - should be saved. - - If set to true saves the generated module. - - - - Initializes a new instance of the class, allowing to specify whether the assemblies generated by this instance - should be saved. - - If set to true saves the generated module. - If set to true disables ability to generate signed module. This should be used in cases where ran under constrained permissions. - - - - Initializes a new instance of the class, allowing to specify whether the assemblies generated by this instance - should be saved and what simple names are to be assigned to them. - - If set to true saves the generated module. - If set to true disables ability to generate signed module. This should be used in cases where ran under constrained permissions. - The simple name of the strong-named assembly generated by this . - The path and file name of the manifest module of the strong-named assembly generated by this . - The simple name of the weak-named assembly generated by this . - The path and file name of the manifest module of the weak-named assembly generated by this . - - - - Initializes a new instance of the class, allowing to specify whether the assemblies generated by this instance - should be saved and what simple names are to be assigned to them. - - If set to true saves the generated module. - If set to true disables ability to generate signed module. This should be used in cases where ran under constrained permissions. - Naming scope used to provide unique names to generated types and their members (usually via sub-scopes). - The simple name of the strong-named assembly generated by this . - The path and file name of the manifest module of the strong-named assembly generated by this . - The simple name of the weak-named assembly generated by this . - The path and file name of the manifest module of the weak-named assembly generated by this . - - - - Returns a type from this scope's type cache, or null if the key cannot be found. - - The key to be looked up in the cache. - The type from this scope's type cache matching the key, or null if the key cannot be found - - - - Registers a type in this scope's type cache. - - The key to be associated with the type. - The type to be stored in the cache. - - - - Gets the key pair used to sign the strong-named assembly generated by this . - - - - - - Gets the specified module generated by this scope, creating a new one if none has yet been generated. - - If set to true, a strong-named module is returned; otherwise, a weak-named module is returned. - A strong-named or weak-named module generated by this scope, as specified by the parameter. - - - - Gets the strong-named module generated by this scope, creating a new one if none has yet been generated. - - A strong-named module generated by this scope. - - - - Gets the weak-named module generated by this scope, creating a new one if none has yet been generated. - - A weak-named module generated by this scope. - - - - Users of this should use this lock when accessing the cache. - - - - - Gets the strong-named module generated by this scope, or if none has yet been generated. - - The strong-named module generated by this scope, or if none has yet been generated. - - - - Gets the file name of the strongly named module generated by this scope. - - The file name of the strongly named module generated by this scope. - - - - Gets the weak-named module generated by this scope, or if none has yet been generated. - - The weak-named module generated by this scope, or if none has yet been generated. - - - - Gets the file name of the weakly named module generated by this scope. - - The file name of the weakly named module generated by this scope. - - - - Initializes a new instance of the class. - - The hook. - - - - Initializes a new instance of the class. - - - - - Provides proxy objects for classes and interfaces. - - - - - Initializes a new instance of the class. - - Proxy types builder. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - If true forces all types to be generated into an unsigned module. - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - Object proxying calls to members of on object. - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of types on generated target object. - - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - As a result of that also at least one implementation must be provided. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of types on generated target object. - - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - As a result of that also at least one implementation must be provided. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of types on generated target object. - - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - As a result of that also at least one implementation must be provided. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The proxy generation options used to influence generated proxy type and object. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no parameterless constructor exists on type . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The proxy generation options used to influence generated proxy type and object. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no parameterless constructor exists on type . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The proxy generation options used to influence generated proxy type and object. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates the proxy type for class proxy with given class, implementing given and using provided . - - The base class for proxy type. - The interfaces that proxy type should implement. - The options for proxy generation process. - of proxy. - - - - Creates the proxy type for interface proxy with target for given interface, implementing given on given and using provided . - - The interface proxy type should implement. - The additional interfaces proxy type should implement. - Actual type that the proxy type will encompass. - The options for proxy generation process. - of proxy. - - - - Creates the proxy type for interface proxy with target interface for given interface, implementing given on given and using provided . - - The interface proxy type should implement. - The additional interfaces proxy type should implement. - The options for proxy generation process. - of proxy. - - - - Creates the proxy type for interface proxy without target for given interface, implementing given and using provided . - - The interface proxy type should implement. - The additional interfaces proxy type should implement. - The options for proxy generation process. - of proxy. - - - - Gets or sets the that this log to. - - - - - Gets the proxy builder instance used to generate proxy types. - - The proxy builder. - - - - The silverlight System.Type is missing the IsNested property so this exposes similar functionality. - - - - - - - Holds objects representing methods of class. - - - - - Provides an extension point that allows proxies to choose specific interceptors on - a per method basis. - - - - - Selects the interceptors that should intercept calls to the given . - - The type declaring the method to intercept. - The method that will be intercepted. - All interceptors registered with the proxy. - An array of interceptors to invoke upon calling the . - - This method is called only once per proxy instance, upon the first call to the - . Either an empty array or null are valid return values to indicate - that no interceptor should intercept calls to the method. Although it is not advised, it is - legal to return other implementations than these provided in - . - - - - - Creates a new lock. - - - - - - This interface should be implemented by classes - that are available in a bigger context, exposing - the container to different areas in the same application. - - For example, in Web application, the (global) HttpApplication - subclasses should implement this interface to expose - the configured container - - - - - - Exposes means to change target objects of proxies and invocations - - - - - Changes the target object () of current . - - The new value of target of invocation. - - Although the method takes the actual instance must be of type assignable to , otherwise an will be thrown. - Also while it's technically legal to pass null reference (Nothing in Visual Basic) as , for obvious reasons Dynamic Proxy will not be able to call the intercepted method on such target. - In this case last interceptor in the pipeline mustn't call or a will be throws. - Also while it's technically legal to pass proxy itself as , this would create stack overflow. - In this case last interceptor in the pipeline mustn't call or a will be throws. - - Thrown when is not assignable to the proxied type. - - - - Permanently changes the target object of the proxy. This does not affect target of the current invocation. - - The new value of target of the proxy. - - Although the method takes the actual instance must be of type assignable to proxy's target type, otherwise an will be thrown. - Also while it's technically legal to pass null reference (Nothing in Visual Basic) as , for obvious reasons Dynamic Proxy will not be able to call the intercepted method on such target. - In this case last interceptor in the pipeline mustn't call or a will be throws. - Also while it's technically legal to pass proxy itself as , this would create stack overflow. - In this case last interceptor in the pipeline mustn't call or a will be throws. - - Thrown when is not assignable to the proxied type. - - - - New interface that is going to be used by DynamicProxy 2 - - - - - Get the proxy target (note that null is a valid target!) - - - - - - Gets the interceptors for the proxy - - - - - - Defines that the implementation wants a - in order to - access other components. The creator must be aware - that the component might (or might not) implement - the interface. - - - Used by Castle Project components to, for example, - gather logging factories - - - - - Increments IServiceProvider with a generic service resolution operation. - - - - - Provides a factory that can produce either or - classes. - - - - - Manages the instantiation of s. - - - - - Creates a new logger, getting the logger name from the specified type. - - - - - Creates a new logger. - - - - - Creates a new logger, getting the logger name from the specified type. - - - - - Creates a new logger. - - - - - Creates a new extended logger, getting the logger name from the specified type. - - - - - Creates a new extended logger. - - - - - Creates a new extended logger, getting the logger name from the specified type. - - - - - Creates a new extended logger. - - - - - Creates a new extended logger, getting the logger name from the specified type. - - - - - Creates a new extended logger. - - - - - Creates a new extended logger, getting the logger name from the specified type. - - - - - Creates a new extended logger. - - - - - Creates a new logger, getting the logger name from the specified type. - - - - - Creates a new logger. - - - - - Creates a new logger, getting the logger name from the specified type. - - - - - Creates a new logger. - - - - - Gets the configuration file. - - i.e. log4net.config - - - - - Interface for Context Properties implementations - - - - This interface defines a basic property get set accessor. - - - Based on the ContextPropertiesBase of log4net, by Nicko Cadell. - - - - - - Gets or sets the value of a property - - - The value for the property with the specified key - - - - Gets or sets the value of a property - - - - - - Gets the configuration file. - - i.e. log4net.config - - - - - NullLogFactory used when logging is turned off. - - - - - Creates an instance of ILogger with the specified name. - - Name. - - - - - Creates an instance of ILogger with the specified name and LoggerLevel. - - Name. - Level. - - - - - Provides an interface that supports and - allows the storage and retrieval of Contexts. These are supported in - both log4net and NLog. - - - - - Manages logging. - - - This is a facade for the different logging subsystems. - It offers a simplified interface that follows IOC patterns - and a simplified priority/level/severity abstraction. - - - - - Create a new child logger. - The name of the child logger is [current-loggers-name].[passed-in-name] - - The Subname of this logger. - The New ILogger instance. - If the name has an empty element name. - - - - Logs a debug message. - - The message to log - - - - Logs a debug message with lazily constructed message. The message will be constructed only if the is true. - - - - - - Logs a debug message. - - The exception to log - The message to log - - - - Logs a debug message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The message to log - - - - Logs an error message with lazily constructed message. The message will be constructed only if the is true. - - - - - - Logs an error message. - - The exception to log - The message to log - - - - Logs an error message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The message to log - - - - Logs a fatal message with lazily constructed message. The message will be constructed only if the is true. - - - - - - Logs a fatal message. - - The exception to log - The message to log - - - - Logs a fatal message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The message to log - - - - Logs a info message with lazily constructed message. The message will be constructed only if the is true. - - - - - - Logs an info message. - - The exception to log - The message to log - - - - Logs an info message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The message to log - - - - Logs a warn message with lazily constructed message. The message will be constructed only if the is true. - - - - - - Logs a warn message. - - The exception to log - The message to log - - - - Logs a warn message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Determines if messages of priority "debug" will be logged. - - True if "debug" messages will be logged. - - - - Determines if messages of priority "error" will be logged. - - True if "error" messages will be logged. - - - - Determines if messages of priority "fatal" will be logged. - - True if "fatal" messages will be logged. - - - - Determines if messages of priority "info" will be logged. - - True if "info" messages will be logged. - - - - Determines if messages of priority "warn" will be logged. - - True if "warn" messages will be logged. - - - - Exposes the Global Context of the extended logger. - - - - - Exposes the Thread Context of the extended logger. - - - - - Exposes the Thread Stack of the extended logger. - - - - - The Logger sending everything to the standard output streams. - This is mainly for the cases when you have a utility that - does not have a logger to supply. - - - - - The Level Filtered Logger class. This is a base clase which - provides a LogLevel attribute and reroutes all functions into - one Log method. - - - - - Creates a new LevelFilteredLogger. - - - - - Logs a debug message. - - The message to log - - - - Logs a debug message. - - The exception to log - The message to log - - - - Logs a debug message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The message to log - - - - Logs an info message. - - The exception to log - The message to log - - - - Logs an info message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The message to log - - - - Logs a warn message. - - The exception to log - The message to log - - - - Logs a warn message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The message to log - - - - Logs an error message. - - The exception to log - The message to log - - - - Logs an error message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The message to log - - - - Logs a fatal message. - - The exception to log - The message to log - - - - Logs a fatal message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Implementors output the log content by implementing this method only. - Note that exception can be null - - - - - - - - - The LoggerLevel that this logger - will be using. Defaults to LoggerLevel.Off - - - - - The name that this logger will be using. - Defaults to String.Empty - - - - - Determines if messages of priority "debug" will be logged. - - true if log level flags include the bit - - - - Determines if messages of priority "info" will be logged. - - true if log level flags include the bit - - - - Determines if messages of priority "warn" will be logged. - - true if log level flags include the bit - - - - Determines if messages of priority "error" will be logged. - - true if log level flags include the bit - - - - Determines if messages of priority "fatal" will be logged. - - true if log level flags include the bit - - - - Creates a new ConsoleLogger with the Level - set to LoggerLevel.Debug and the Name - set to String.Empty. - - - - - Creates a new ConsoleLogger with the Name - set to String.Empty. - - The logs Level. - - - - Creates a new ConsoleLogger with the Level - set to LoggerLevel.Debug. - - The logs Name. - - - - Creates a new ConsoleLogger. - - The logs Name. - The logs Level. - - - - A Common method to log. - - The level of logging - The name of the logger - The Message - The Exception - - - - Returns a new ConsoleLogger with the name - added after this loggers name, with a dot in between. - - The added hierarchical name. - A new ConsoleLogger. - - - - The Null Logger class. This is useful for implementations where you need - to provide a logger to a utility class, but do not want any output from it. - It also helps when you have a utility that does not have a logger to supply. - - - - - Returns this NullLogger. - - Ignored - This ILogger instance. - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - Returns empty context properties. - - - - - Returns empty context properties. - - - - - Returns empty context stacks. - - - - - No-op. - - false - - - - No-op. - - false - - - - No-op. - - false - - - - No-op. - - false - - - - No-op. - - false - - - - The Stream Logger class. This class can stream log information - to any stream, it is suitable for storing a log file to disk, - or to a MemoryStream for testing your components. - - - This logger is not thread safe. - - - - - Creates a new StreamLogger with default encoding - and buffer size. Initial Level is set to Debug. - - - The name of the log. - - - The stream that will be used for logging, - seeking while the logger is alive - - - - - Creates a new StreamLogger with default buffer size. - Initial Level is set to Debug. - - - The name of the log. - - - The stream that will be used for logging, - seeking while the logger is alive - - - The encoding that will be used for this stream. - - - - - - Creates a new StreamLogger. - Initial Level is set to Debug. - - - The name of the log. - - - The stream that will be used for logging, - seeking while the logger is alive - - - The encoding that will be used for this stream. - - - - The buffer size that will be used for this stream. - - - - - - Creates a new StreamLogger with - Debug as default Level. - - The name of the log. - The StreamWriter the log will write to. - - - - This is an abstract implementation - that deals with methods that can be abstracted away - from underlying implementations. - - - AbstractConfiguration makes easier to implementers - to create a new version of - - - - - is a interface encapsulating a configuration node - used to retrieve configuration values. - - - - - Gets the value of the node and converts it - into specified . - - The - - The Default value returned if the conversion fails. - - The Value converted into the specified type. - - - - Gets the name of the node. - - - The Name of the node. - - - - - Gets the value of the node. - - - The Value of the node. - - - - - Gets an of - elements containing all node children. - - The Collection of child nodes. - - - - Gets an of the configuration attributes. - - - - - Gets the value of the node and converts it - into specified . - - The - - The Default value returned if the conversion fails. - - The Value converted into the specified type. - - - - Gets node attributes. - - - All attributes of the node. - - - - - Gets all child nodes. - - The of child nodes. - - - - Gets the name of the . - - - The Name of the . - - - - - Gets the value of . - - - The Value of the . - - - - - A collection of objects. - - - - - Creates a new instance of ConfigurationCollection. - - - - - Creates a new instance of ConfigurationCollection. - - - - - Summary description for MutableConfiguration. - - - - - Initializes a new instance of the class. - - The name. - - - - Gets the value of . - - - The Value of the . - - - - - General purpose class to represent a standard pair of values. - - Type of the first value - Type of the second value - - - - Constructs a pair with its values - - - - - - - List of utility methods related to dynamic proxy operations - - - - - Determines whether the specified type is a proxy generated by - DynamicProxy (1 or 2). - - The type. - - true if it is a proxy; otherwise, false. - - - - - Readonly implementation of which uses an anonymous object as its source. Uses names of properties as keys, and property values as... well - values. Keys are not case sensitive. - - - - - Initializes a new instance of the class. - - The target. - - - - Adds an element with the provided key and value to the object. - - The to use as the key of the element to add. - The to use as the value of the element to add. - - is null. - An element with the same key already exists in the object. - The is read-only.-or- The has a fixed size. - - - - Removes all elements from the object. - - The object is read-only. - - - - Determines whether the object contains an element with the specified key. - - The key to locate in the object. - - true if the contains an element with the key; otherwise, false. - - - is null. - - - - Removes the element with the specified key from the object. - - The key of the element to remove. - - is null. - The object is read-only.-or- The has a fixed size. - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - - - - Copies the elements of the to an , starting at a particular index. - - The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing. - The zero-based index in at which copying begins. - - is null. - - is less than zero. - - is multidimensional.-or- is equal to or greater than the length of .-or- The number of elements in the source is greater than the available space from to the end of the destination . - The type of the source cannot be cast automatically to the type of the destination . - - - - Returns an object for the object. - - - An object for the object. - - - - - Reads values of properties from and inserts them into using property names as keys. - - - - - - - Gets the number of elements contained in the . - - - The number of elements contained in the . - - - - Gets a value indicating whether access to the is synchronized (thread safe). - - - true if access to the is synchronized (thread safe); otherwise, false. - - - - Gets an object that can be used to synchronize access to the . - - - An object that can be used to synchronize access to the . - - - - Gets a value indicating whether the object is read-only. - - - true if the object is read-only; otherwise, false. - - - - Gets or sets the with the specified key. - - - - - - Gets an object containing the keys of the object. - - - An object containing the keys of the object. - - - - Gets an object containing the values in the object. - - - An object containing the values in the object. - - - - Gets a value indicating whether the object has a fixed size. - - - true if the object has a fixed size; otherwise, false. - - - - Represents a 'streamable' resource. Can - be a file, a resource in an assembly. - - - - - Returns a reader for the stream - - - It's up to the caller to dispose the reader. - - - - - - Returns a reader for the stream - - - It's up to the caller to dispose the reader. - - - - - - - Returns an instance of - created according to the relativePath - using itself as the root. - - - - - - - - - - Only valid for resources that - can be obtained through relative paths - - - - - - - - - - This returns a new stream instance each time it is called. - It is the responsibility of the caller to dispose of this stream - - - - - Depicts the contract for resource factories. - - - - - Used to check whether the resource factory - is able to deal with the given resource - identifier. - - - Implementors should return true - only if the given identifier is supported - by the resource factory - - - - - - - Creates an instance - for the given resource identifier - - - - - - - Creates an instance - for the given resource identifier - - - - - - - - - - - - - Adapts a static string content as an - - - - - Enable access to files on network shares - - - - diff --git a/packages/Castle.Core.3.3.3/lib/sl5/Castle.Core.dll b/packages/Castle.Core.3.3.3/lib/sl5/Castle.Core.dll deleted file mode 100644 index f000d25..0000000 Binary files a/packages/Castle.Core.3.3.3/lib/sl5/Castle.Core.dll and /dev/null differ diff --git a/packages/Castle.Core.3.3.3/lib/sl5/Castle.Core.xml b/packages/Castle.Core.3.3.3/lib/sl5/Castle.Core.xml deleted file mode 100644 index ec23220..0000000 --- a/packages/Castle.Core.3.3.3/lib/sl5/Castle.Core.xml +++ /dev/null @@ -1,4243 +0,0 @@ - - - - Castle.Core - - - - - Specifies assignment by reference rather than by copying. - - - - - Suppresses any on-demand behaviors. - - - - - Removes a property if null or empty string, guid or collection. - - - - - Removes a property if matches value. - - - - - Assigns a specific dictionary key. - - - - - Defines the contract for customizing dictionary access. - - - - - Copies the dictionary behavior. - - null if should not be copied. Otherwise copy. - - - - Determines relative order to apply related behaviors. - - - - - Defines the contract for updating dictionary values. - - - - - Sets the stored dictionary value. - - The dictionary adapter. - The key. - The stored value. - The property. - true if the property should be stored. - - - - Contract for value matching. - - - - - Indicates that underlying values are changeable and should not be cached. - - - - - Contract for dictionary initialization. - - - - - Performs any initialization of the - - The dictionary adapter. - The dictionary behaviors. - - - - Abstract implementation of . - - - - - Conract for traversing a . - - - - - Contract for creating additional Dictionary adapters. - - - - - Contract for manipulating the Dictionary adapter. - - - - - Contract for editing the Dictionary adapter. - - - - - Contract for managing Dictionary adapter notifications. - - - - - Contract for validating Dictionary adapter. - - - - - Defines the contract for building s. - - - - - Builds the dictionary behaviors. - - - - - - Abstract adapter for the support - needed by the - - - - - Adds an element with the provided key and value to the object. - - The to use as the key of the element to add. - The to use as the value of the element to add. - An element with the same key already exists in the object. - key is null. - The is read-only.-or- The has a fixed size. - - - - Removes all elements from the object. - - The object is read-only. - - - - Determines whether the object contains an element with the specified key. - - The key to locate in the object. - - true if the contains an element with the key; otherwise, false. - - key is null. - - - - Returns an object for the object. - - - An object for the object. - - - - - Removes the element with the specified key from the object. - - The key of the element to remove. - The object is read-only.-or- The has a fixed size. - key is null. - - - - Copies the elements of the to an , starting at a particular index. - - The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing. - The zero-based index in array at which copying begins. - array is null. - The type of the source cannot be cast automatically to the type of the destination array. - index is less than zero. - array is multidimensional.-or- index is equal to or greater than the length of array.-or- The number of elements in the source is greater than the available space from index to the end of the destination array. - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - - - - Gets a value indicating whether the object has a fixed size. - - - true if the object has a fixed size; otherwise, false. - - - - Gets a value indicating whether the object is read-only. - - - true if the object is read-only; otherwise, false. - - - - Gets an object containing the keys of the object. - - - An object containing the keys of the object. - - - - Gets an object containing the values in the object. - - - An object containing the values in the object. - - - - Gets or sets the with the specified key. - - - - - - Gets the number of elements contained in the . - - - The number of elements contained in the . - - - - Gets a value indicating whether access to the is synchronized (thread safe). - - - true if access to the is synchronized (thread safe); otherwise, false. - - - - Gets an object that can be used to synchronize access to the . - - - An object that can be used to synchronize access to the . - - - - Checks whether or not collection is null or empty. Assumes colleciton can be safely enumerated multiple times. - - - - - - - Creates a message to inform clients that a proxy couldn't be created due to reliance on an - inaccessible type (perhaps itself). - - the inaccessible type that prevents proxy creation - the type that couldn't be proxied - - - - Find the best available name to describe a type. - - - Usually the best name will be , but - sometimes that's null (see http://msdn.microsoft.com/en-us/library/system.type.fullname%28v=vs.110%29.aspx) - in which case the method falls back to . - - the type to name - the best name - - - - Constant to use when making assembly internals visible to Castle.Core - [assembly: InternalsVisibleTo(CoreInternalsVisible.ToCastleCore)] - - - - - Constant to use when making assembly internals visible to proxy types generated by DynamicProxy. Required when proxying internal types. - [assembly: InternalsVisibleTo(CoreInternalsVisible.ToDynamicProxyGenAssembly2)] - - - - - Identifies a property should be represented as a nested component. - - - - - Defines the contract for building typed dictionary keys. - - - - - Builds the specified key. - - The dictionary adapter. - The current key. - The property. - The updated key - - - - Defines the contract for retrieving dictionary values. - - - - - Gets the effective dictionary value. - - The dictionary adapter. - The key. - The stored value. - The property. - true if return only existing. - The effective property value. - - - - Applies no prefix. - - - - - Gets or sets the prefix. - - The prefix. - - - - Identifies the dictionary adapter types. - - - - - Identifies an interface or property to be pre-fetched. - - - - - Instructs fetching to occur. - - - - - Instructs fetching according to - - - - - - Gets whether or not fetching should occur. - - - - - Assigns a property to a group. - - - - - Constructs a group assignment. - - The group name. - - - - Constructs a group assignment. - - The group name. - - - - Gets the group the property is assigned to. - - - - - Assigns a specific dictionary key. - - - - - Initializes a new instance of the class. - - The key. - - - - Initializes a new instance of the class. - - The compound key. - - - - Assigns a prefix to the keyed properties of an interface. - - - Key prefixes are not inherited by sub-interfaces. - - - - - Initializes a default instance of the class. - - - - - Initializes a new instance of the class. - - The prefix for the keyed properties of the interface. - - - - Gets the prefix key added to the properties of the interface. - - - - - Substitutes part of key with another string. - - - - - Initializes a new instance of the class. - - The old value. - The new value. - - - - Requests support for multi-level editing. - - - - - Generates a new GUID on demand. - - - - - Support for on-demand value resolution. - - - - - Provides simple string formatting from existing properties. - - - - - Gets the string format. - - - - - Gets the format properties. - - - - - Identifies a property should be represented as a delimited string value. - - - - - Gets the separator. - - - - - Converts all properties to strings. - - - - - Gets or sets the format. - - The format. - - - - Suppress property change notifications. - - - - - Contract for property descriptor initialization. - - - - - Performs any initialization of the - - The property descriptor. - The property behaviors. - - - - Assigns a prefix to the keyed properties using the interface name. - - - - - Manages conversion between property values. - - - - - Initializes a new instance of the class. - - The converter. - - - - Gets the effective dictionary value. - - The dictionary adapter. - The key. - The stored value. - The property. - true if return only existing. - The effective property value. - - - - - - - - - Uses Reflection.Emit to expose the properties of a dictionary - through a dynamic implementation of a typed interface. - - - - - Defines the contract for building typed dictionary adapters. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - An implementation of the typed interface bound to the dictionary. - - The type represented by T must be an interface with properties. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - An implementation of the typed interface bound to the dictionary. - - The type represented by T must be an interface with properties. - - - - - Gets a typed adapter bound to the . - - The typed interface. - The underlying source of properties. - The property descriptor. - An implementation of the typed interface bound to the dictionary. - - The type represented by T must be an interface with properties. - - - - - Gets the associated with the type. - - The typed interface. - The adapter meta-data. - - - - Gets the associated with the type. - - The typed interface. - The property descriptor. - The adapter meta-data. - - - - Gets the associated with the type. - - The typed interface. - Another from which to copy behaviors. - The adapter meta-data. - - - - - - - - - - - - - - - - - - - - - - - - - - - - Contract for dictionary meta-data initialization. - - - - - Initializes the given object. - - The dictionary adapter factory. - The dictionary adapter meta. - - - - - Determines whether the given behavior should be included in a new - object. - - A dictionary behavior or annotation. - True if the behavior should be included; otherwise, false. - - behaviors are always included, - regardless of the result of this method. - - - - - - Contract for dictionary validation. - - - - - Determines if is valid. - - The dictionary adapter. - true if valid. - - - - Validates the . - - The dictionary adapter. - The error summary information. - - - - Validates the for a property. - - The dictionary adapter. - The property to validate. - The property summary information. - - - - Invalidates any results cached by the validator. - - The dictionary adapter. - - - - Describes a dictionary property. - - - - - Initializes an empty class. - - - - - Initializes a new instance of the class. - - The property. - The annotations. - - - - Initializes a new instance class. - - - - - Copies an existinginstance of the class. - - - - - - - Gets the key. - - The dictionary adapter. - The key. - The descriptor. - - - - - Gets the property value. - - The dictionary adapter. - The key. - The stored value. - The descriptor. - true if return only existing. - - - - - Sets the property value. - - The dictionary adapter. - The key. - The value. - The descriptor. - - - - - Adds a single behavior. - - The behavior. - - - - Adds the behaviors. - - The behaviors. - - - - Adds the behaviors. - - The behaviors. - - - - Copies the behaviors to the other - - - - - - - Copies the - - - - - - - - - - - Gets the property name. - - - - - Gets the property type. - - - - - Gets the property. - - The property. - - - - Returns true if the property is dynamic. - - - - - Gets additional state. - - - - - Determines if property should be fetched. - - - - - Determines if property must exist first. - - - - - Determines if notifications should occur. - - - - - Gets the property behaviors. - - - - - Gets the type converter. - - The type converter. - - - - Gets the extended properties. - - - - - Gets the setter. - - The setter. - - - - Gets the key builders. - - The key builders. - - - - Gets the setter. - - The setter. - - - - Gets the getter. - - The getter. - - - - Gets the initializers. - - The initializers. - - - - Gets the meta-data initializers. - - The meta-data initializers. - - - - Helper class for retrieving attributes. - - - - - Gets the attribute. - - The member. - The member attribute. - - - - Gets the attributes. Does not consider inherited attributes! - - The member. - The member attributes. - - - - Gets the type attribute. - - The type. - The type attribute. - - - - Gets the type attributes. - - The type. - The type attributes. - - - - Gets the type converter. - - The member. - - - - - Gets the attribute. - - The member. - The member attribute. - - - - Contract for typed dynamic value resolution. - - - - - - Contract for dynamic value resolution. - - - - - Supporting Logger levels. - - - - - Logging will be off - - - - - Fatal logging level - - - - - Error logging level - - - - - Warn logging level - - - - - Info logging level - - - - - Debug logging level - - - - - Encapsulates an invocation of a proxied method. - - - - - Gets the value of the argument at the specified . - - The index. - The value of the argument at the specified . - - - - Returns the concrete instantiation of the on the proxy, with any generic - parameters bound to real types. - - - The concrete instantiation of the on the proxy, or the if - not a generic method. - - - Can be slower than calling . - - - - - Returns the concrete instantiation of , with any - generic parameters bound to real types. - For interface proxies, this will point to the on the target class. - - The concrete instantiation of , or - if not a generic method. - - In debug builds this can be slower than calling . - - - - - Proceeds the call to the next interceptor in line, and ultimately to the target method. - - - Since interface proxies without a target don't have the target implementation to proceed to, - it is important, that the last interceptor does not call this method, otherwise a - will be thrown. - - - - - Overrides the value of an argument at the given with the - new provided. - - - This method accepts an , however the value provided must be compatible - with the type of the argument defined on the method, otherwise an exception will be thrown. - - The index of the argument to override. - The new value for the argument. - - - - Gets the arguments that the has been invoked with. - - The arguments the method was invoked with. - - - - Gets the generic arguments of the method. - - The generic arguments, or null if not a generic method. - - - - Gets the object on which the invocation is performed. This is different from proxy object - because most of the time this will be the proxy target object. - - - The invocation target. - - - - Gets the representing the method being invoked on the proxy. - - The representing the method being invoked. - - - - For interface proxies, this will point to the on the target class. - - The method invocation target. - - - - Gets the proxy object on which the intercepted method is invoked. - - Proxy object on which the intercepted method is invoked. - - - - Gets or sets the return value of the method. - - The return value of the method. - - - - Gets the type of the target object for the intercepted method. - - The type of the target object. - - - - Used during the target type inspection process. Implementors have a chance to customize the - proxy generation process. - - - - - Invoked by the generation process to notify that the whole process has completed. - - - - - Invoked by the generation process to notify that a member was not marked as virtual. - - The type which declares the non-virtual member. - The non-virtual member. - - This method gives an opportunity to inspect any non-proxyable member of a type that has - been requested to be proxied, and if appropriate - throw an exception to notify the caller. - - - - - Invoked by the generation process to determine if the specified method should be proxied. - - The type which declares the given method. - The method to inspect. - True if the given method should be proxied; false otherwise. - - - - Interface describing elements composing generated type - - - - - Performs some basic screening and invokes the - to select methods. - - - - - - - - - Provides functionality for disassembling instances of attributes to CustomAttributeBuilder form, during the process of emiting new types by Dynamic Proxy. - - - - - Disassembles given attribute instance back to corresponding CustomAttributeBuilder. - - An instance of attribute to disassemble - corresponding 1 to 1 to given attribute instance, or null reference. - - Implementers should return that corresponds to given attribute instance 1 to 1, - that is after calling specified constructor with specified arguments, and setting specified properties and fields with values specified - we should be able to get an attribute instance identical to the one passed in . Implementer can return null - if it wishes to opt out of replicating the attribute. Notice however, that for some cases, like attributes passed explicitly by the user - it is illegal to return null, and doing so will result in exception. - - - - - Handles error during disassembly process - - Type of the attribute being disassembled - Exception thrown during the process - usually null, or (re)throws the exception - - - - Here we try to match a constructor argument to its value. - Since we can't get the values from the assembly, we use some heuristics to get it. - a/ we first try to match all the properties on the attributes by name (case insensitive) to the argument - b/ if we fail we try to match them by property type, with some smarts about convertions (i,e: can use Guid for string). - - - - - We have the following rules here. - Try to find a matching type, failing that, if the parameter is string, get the first property (under the assumption that - we can convert it. - - - - - Attributes can only accept simple types, so we return null for null, - if the value is passed as string we call to string (should help with converting), - otherwise, we use the value as is (enums, integer, etc). - - - - - Returns list of all unique interfaces implemented given types, including their base interfaces. - - - - - - - Base class that exposes the common functionalities - to proxy generation. - - - - - It is safe to add mapping (no mapping for the interface exists) - - - - - - - - Generates a parameters constructor that initializes the proxy - state with just to make it non-null. - - This constructor is important to allow proxies to be XML serializable - - - - - - Generates the constructor for the class that extends - - - - - - - - - Default implementation of interface producing in-memory proxy assemblies. - - - - - Abstracts the implementation of proxy type construction. - - - - - Creates a proxy type for given , implementing , using provided. - - The class type to proxy. - Additional interface types to proxy. - The proxy generation options. - The generated proxy type. - - Implementers should return a proxy type for the specified class and interfaces. - Additional interfaces should be only 'mark' interfaces, that is, they should work like interface proxy without target. (See method.) - - Thrown when or any of is a generic type definition. - Thrown when or any of is not public. - Note that to avoid this exception, you can mark offending type internal, and define - pointing to Castle Dynamic Proxy assembly, in assembly containing that type, if this is appropriate. - - - - - Creates a proxy type that proxies calls to members on , implementing , using provided. - - The interface type to proxy. - Additional interface types to proxy. - Type implementing on which calls to the interface members should be intercepted. - The proxy generation options. - The generated proxy type. - - Implementers should return a proxy type for the specified interface that 'proceeds' executions to the specified target. - Additional interfaces should be only 'mark' interfaces, that is, they should work like interface proxy without target. (See method.) - - Thrown when or any of is a generic type definition. - Thrown when or any of is not public. - Note that to avoid this exception, you can mark offending type internal, and define - pointing to Castle Dynamic Proxy assembly, in assembly containing that type, if this is appropriate. - - - - - Creates a proxy type for given and that delegates all calls to the provided interceptors and allows interceptors to switch the actual target of invocation. - - The interface type to proxy. - Additional interface types to proxy. - The proxy generation options. - The generated proxy type. - - Implementers should return a proxy type for the specified interface(s) that delegate all executions to the specified interceptors - and uses an instance of the interface as their targets (i.e. ), rather than a class. All classes should then implement interface, - to allow interceptors to switch invocation target with instance of another type implementing called interface. - - Thrown when or any of is a generic type definition. - Thrown when or any of is not public. - Note that to avoid this exception, you can mark offending type internal, and define - pointing to Castle Dynamic Proxy assembly, in assembly containing that type, if this is appropriate. - - - - - Creates a proxy type for given that delegates all calls to the provided interceptors. - - The interface type to proxy. - Additional interface types to proxy. - The proxy generation options. - The generated proxy type. - - Implementers should return a proxy type for the specified interface and additional interfaces that delegate all executions to the specified interceptors. - - Thrown when or any of is a generic type definition. - Thrown when or any of is not public. - Note that to avoid this exception, you can mark offending type internal, and define - pointing to Castle Dynamic Proxy assembly, in assembly containing that type, if this is appropriate. - - - - - Gets or sets the that this logs to. - - - - - Gets the associated with this builder. - - The module scope associated with this builder. - - - - Initializes a new instance of the class with new . - - - - - Initializes a new instance of the class. - - The module scope for generated proxy types. - - - - Registers custom disassembler to handle disassembly of specified type of attributes. - - Type of attributes to handle - Disassembler converting existing instances of Attributes to CustomAttributeBuilders - - When disassembling an attribute Dynamic Proxy will first check if an custom disassembler has been registered to handle attributes of that type, - and if none is found, it'll use the . - - - - - Attributes should be replicated if they are non-inheritable, - but there are some special cases where the attributes means - something to the CLR, where they should be skipped. - - - - - Initializes a new instance of the class. - - Target element. This is either target type or target method for invocation types. - The type of the proxy. This is base type for invocation types. - The interfaces. - The options. - - - - Initializes a new instance of the class. - - Type of the target. - The interfaces. - The options. - - - - s - Provides appropriate Ldc.X opcode for the type of primitive value to be loaded. - - - - - Provides appropriate Ldind.X opcode for - the type of primitive value to be loaded indirectly. - - - - - Emits a load indirect opcode of the appropriate type for a value or object reference. - Pops a pointer off the evaluation stack, dereferences it and loads - a value of the specified type. - - - - - - - Emits a load opcode of the appropriate kind for a constant string or - primitive value. - - - - - - - Emits a load opcode of the appropriate kind for the constant default value of a - type, such as 0 for value types and null for reference types. - - - - - Emits a store indirectopcode of the appropriate type for a value or object reference. - Pops a value of the specified type and a pointer off the evaluation stack, and - stores the value. - - - - - - - Summary description for PropertiesCollection. - - - - - Wraps a reference that is passed - ByRef and provides indirect load/store support. - - - - - Summary description for NewArrayExpression. - - - - - - - - - Provides appropriate Stind.X opcode - for the type of primitive value to be stored indirectly. - - - - - Initializes a new instance of the class. - - The name. - Type declaring the original event being overriten, or null. - - The add method. - The remove method. - The attributes. - - - - Represents the scope of uniquenes of names for types and their members - - - - - Gets a unique name based on - - Name suggested by the caller - Unique name based on . - - Implementers should provide name as closely resembling as possible. - Generally if no collision occurs it is suggested to return suggested name, otherwise append sequential suffix. - Implementers must return deterministic names, that is when is called twice - with the same suggested name, the same returned name should be provided each time. Non-deterministic return - values, like appending random suffices will break serialization of proxies. - - - - - Returns new, disposable naming scope. It is responsibilty of the caller to make sure that no naming collision - with enclosing scope, or other subscopes is possible. - - New naming scope. - - - - Returns the methods implemented by a type. Use this instead of Type.GetMethods() to work around a CLR issue - where duplicate MethodInfos are returned by Type.GetMethods() after a token of a generic type's method was loaded. - - - - - Determines whether the specified method is internal. - - The method. - - true if the specified method is internal; otherwise, false. - - - - - Determines whether this assembly has internals visible to dynamic proxy. - - The assembly to inspect. - - - - Checks if the method is public or protected. - - - - - - - Because we need to cache the types based on the mixed in mixins, we do the following here: - - Get all the mixin interfaces - - Sort them by full name - - Return them by position - - The idea is to have reproducible behavior for the case that mixins are registered in different orders. - This method is here because it is required - - - - - Summary description for ModuleScope. - - - - - The default file name used when the assembly is saved using . - - - - - The default assembly (simple) name used for the assemblies generated by a instance. - - - - - Initializes a new instance of the class; assemblies created by this instance will not be saved. - - - - - Initializes a new instance of the class, allowing to specify whether the assemblies generated by this instance - should be saved. - - If set to true saves the generated module. - - - - Initializes a new instance of the class, allowing to specify whether the assemblies generated by this instance - should be saved. - - If set to true saves the generated module. - If set to true disables ability to generate signed module. This should be used in cases where ran under constrained permissions. - - - - Initializes a new instance of the class, allowing to specify whether the assemblies generated by this instance - should be saved and what simple names are to be assigned to them. - - If set to true saves the generated module. - If set to true disables ability to generate signed module. This should be used in cases where ran under constrained permissions. - The simple name of the strong-named assembly generated by this . - The path and file name of the manifest module of the strong-named assembly generated by this . - The simple name of the weak-named assembly generated by this . - The path and file name of the manifest module of the weak-named assembly generated by this . - - - - Initializes a new instance of the class, allowing to specify whether the assemblies generated by this instance - should be saved and what simple names are to be assigned to them. - - If set to true saves the generated module. - If set to true disables ability to generate signed module. This should be used in cases where ran under constrained permissions. - Naming scope used to provide unique names to generated types and their members (usually via sub-scopes). - The simple name of the strong-named assembly generated by this . - The path and file name of the manifest module of the strong-named assembly generated by this . - The simple name of the weak-named assembly generated by this . - The path and file name of the manifest module of the weak-named assembly generated by this . - - - - Returns a type from this scope's type cache, or null if the key cannot be found. - - The key to be looked up in the cache. - The type from this scope's type cache matching the key, or null if the key cannot be found - - - - Registers a type in this scope's type cache. - - The key to be associated with the type. - The type to be stored in the cache. - - - - Gets the key pair used to sign the strong-named assembly generated by this . - - - - - - Gets the specified module generated by this scope, creating a new one if none has yet been generated. - - If set to true, a strong-named module is returned; otherwise, a weak-named module is returned. - A strong-named or weak-named module generated by this scope, as specified by the parameter. - - - - Gets the strong-named module generated by this scope, creating a new one if none has yet been generated. - - A strong-named module generated by this scope. - - - - Gets the weak-named module generated by this scope, creating a new one if none has yet been generated. - - A weak-named module generated by this scope. - - - - Users of this should use this lock when accessing the cache. - - - - - Gets the strong-named module generated by this scope, or if none has yet been generated. - - The strong-named module generated by this scope, or if none has yet been generated. - - - - Gets the file name of the strongly named module generated by this scope. - - The file name of the strongly named module generated by this scope. - - - - Gets the weak-named module generated by this scope, or if none has yet been generated. - - The weak-named module generated by this scope, or if none has yet been generated. - - - - Gets the file name of the weakly named module generated by this scope. - - The file name of the weakly named module generated by this scope. - - - - Initializes a new instance of the class. - - The hook. - - - - Initializes a new instance of the class. - - - - - Provides proxy objects for classes and interfaces. - - - - - Initializes a new instance of the class. - - Proxy types builder. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - If true forces all types to be generated into an unsigned module. - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - Object proxying calls to members of on object. - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method generates new proxy type for each type of , which affects performance. If you don't want to proxy types differently depending on the type of the target - use method. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on object with given . - Interceptors can use interface to provide other target for method invocation than default . - - Type of the interface implemented by which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on object or alternative implementation swapped at runtime by an interceptor. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - Thrown when given does not implement interface. - Thrown when no default constructor exists on actual type of object. - Thrown when default constructor of actual type of throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of types on generated target object. - - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - As a result of that also at least one implementation must be provided. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of types on generated target object. - - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - As a result of that also at least one implementation must be provided. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of types on generated target object. - - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - As a result of that also at least one implementation must be provided. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of type on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of interfaces to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not an interface type. - - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to members of interface on target object generated at runtime with given . - - Type of the interface which will be proxied. - The proxy generation options used to influence generated proxy type and object. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - Object proxying calls to members of and types on generated target object. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given array is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not an interface type. - - Since this method uses an empty-shell implementation of to proxy generated at runtime, the actual implementation of proxied methods must be provided by given implementations. - They are responsible for setting return value (and out parameters) on proxied methods. It is also illegal for an interceptor to call , since there's no actual implementation to proceed with. - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no parameterless constructor exists on type . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The target object, calls to which will be intercepted. - The proxy generation options used to influence generated proxy type and object. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The proxy generation options used to influence generated proxy type and object. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no parameterless constructor exists on type . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of type. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The proxy generation options used to influence generated proxy type and object. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no default constructor exists on type . - Thrown when default constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates proxy object intercepting calls to virtual members of type on newly created instance of that type with given . - - Type of class which will be proxied. - Additional interface types. Calls to their members will be proxied as well. - The proxy generation options used to influence generated proxy type and object. - Arguments of constructor of type which should be used to create a new instance of that type. - The interceptors called during the invocation of proxied methods. - - New object of type proxying calls to virtual members of and types. - - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given object is a null reference (Nothing in Visual Basic). - Thrown when given or any of is a generic type definition. - Thrown when given is not a class type. - Thrown when no constructor exists on type with parameters matching . - Thrown when constructor of type throws an exception. - - This method uses implementation to generate a proxy type. - As such caller should expect any type of exception that given implementation may throw. - - - - - Creates the proxy type for class proxy with given class, implementing given and using provided . - - The base class for proxy type. - The interfaces that proxy type should implement. - The options for proxy generation process. - of proxy. - - - - Creates the proxy type for interface proxy with target for given interface, implementing given on given and using provided . - - The interface proxy type should implement. - The additional interfaces proxy type should implement. - Actual type that the proxy type will encompass. - The options for proxy generation process. - of proxy. - - - - Creates the proxy type for interface proxy with target interface for given interface, implementing given on given and using provided . - - The interface proxy type should implement. - The additional interfaces proxy type should implement. - The options for proxy generation process. - of proxy. - - - - Creates the proxy type for interface proxy without target for given interface, implementing given and using provided . - - The interface proxy type should implement. - The additional interfaces proxy type should implement. - The options for proxy generation process. - of proxy. - - - - Gets or sets the that this log to. - - - - - Gets the proxy builder instance used to generate proxy types. - - The proxy builder. - - - - The silverlight System.Type is missing the IsNested property so this exposes similar functionality. - - - - - - - Holds objects representing methods of class. - - - - - Provides an extension point that allows proxies to choose specific interceptors on - a per method basis. - - - - - Selects the interceptors that should intercept calls to the given . - - The type declaring the method to intercept. - The method that will be intercepted. - All interceptors registered with the proxy. - An array of interceptors to invoke upon calling the . - - This method is called only once per proxy instance, upon the first call to the - . Either an empty array or null are valid return values to indicate - that no interceptor should intercept calls to the method. Although it is not advised, it is - legal to return other implementations than these provided in - . - - - - - Creates a new lock. - - - - - - This interface should be implemented by classes - that are available in a bigger context, exposing - the container to different areas in the same application. - - For example, in Web application, the (global) HttpApplication - subclasses should implement this interface to expose - the configured container - - - - - - Exposes means to change target objects of proxies and invocations - - - - - Changes the target object () of current . - - The new value of target of invocation. - - Although the method takes the actual instance must be of type assignable to , otherwise an will be thrown. - Also while it's technically legal to pass null reference (Nothing in Visual Basic) as , for obvious reasons Dynamic Proxy will not be able to call the intercepted method on such target. - In this case last interceptor in the pipeline mustn't call or a will be throws. - Also while it's technically legal to pass proxy itself as , this would create stack overflow. - In this case last interceptor in the pipeline mustn't call or a will be throws. - - Thrown when is not assignable to the proxied type. - - - - Permanently changes the target object of the proxy. This does not affect target of the current invocation. - - The new value of target of the proxy. - - Although the method takes the actual instance must be of type assignable to proxy's target type, otherwise an will be thrown. - Also while it's technically legal to pass null reference (Nothing in Visual Basic) as , for obvious reasons Dynamic Proxy will not be able to call the intercepted method on such target. - In this case last interceptor in the pipeline mustn't call or a will be throws. - Also while it's technically legal to pass proxy itself as , this would create stack overflow. - In this case last interceptor in the pipeline mustn't call or a will be throws. - - Thrown when is not assignable to the proxied type. - - - - New interface that is going to be used by DynamicProxy 2 - - - - - Get the proxy target (note that null is a valid target!) - - - - - - Gets the interceptors for the proxy - - - - - - Defines that the implementation wants a - in order to - access other components. The creator must be aware - that the component might (or might not) implement - the interface. - - - Used by Castle Project components to, for example, - gather logging factories - - - - - Increments IServiceProvider with a generic service resolution operation. - - - - - Provides a factory that can produce either or - classes. - - - - - Manages the instantiation of s. - - - - - Creates a new logger, getting the logger name from the specified type. - - - - - Creates a new logger. - - - - - Creates a new logger, getting the logger name from the specified type. - - - - - Creates a new logger. - - - - - Creates a new extended logger, getting the logger name from the specified type. - - - - - Creates a new extended logger. - - - - - Creates a new extended logger, getting the logger name from the specified type. - - - - - Creates a new extended logger. - - - - - Creates a new extended logger, getting the logger name from the specified type. - - - - - Creates a new extended logger. - - - - - Creates a new extended logger, getting the logger name from the specified type. - - - - - Creates a new extended logger. - - - - - Creates a new logger, getting the logger name from the specified type. - - - - - Creates a new logger. - - - - - Creates a new logger, getting the logger name from the specified type. - - - - - Creates a new logger. - - - - - Gets the configuration file. - - i.e. log4net.config - - - - - Interface for Context Properties implementations - - - - This interface defines a basic property get set accessor. - - - Based on the ContextPropertiesBase of log4net, by Nicko Cadell. - - - - - - Gets or sets the value of a property - - - The value for the property with the specified key - - - - Gets or sets the value of a property - - - - - - Gets the configuration file. - - i.e. log4net.config - - - - - NullLogFactory used when logging is turned off. - - - - - Creates an instance of ILogger with the specified name. - - Name. - - - - - Creates an instance of ILogger with the specified name and LoggerLevel. - - Name. - Level. - - - - - Provides an interface that supports and - allows the storage and retrieval of Contexts. These are supported in - both log4net and NLog. - - - - - Manages logging. - - - This is a facade for the different logging subsystems. - It offers a simplified interface that follows IOC patterns - and a simplified priority/level/severity abstraction. - - - - - Create a new child logger. - The name of the child logger is [current-loggers-name].[passed-in-name] - - The Subname of this logger. - The New ILogger instance. - If the name has an empty element name. - - - - Logs a debug message. - - The message to log - - - - Logs a debug message with lazily constructed message. The message will be constructed only if the is true. - - - - - - Logs a debug message. - - The exception to log - The message to log - - - - Logs a debug message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The message to log - - - - Logs an error message with lazily constructed message. The message will be constructed only if the is true. - - - - - - Logs an error message. - - The exception to log - The message to log - - - - Logs an error message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The message to log - - - - Logs a fatal message with lazily constructed message. The message will be constructed only if the is true. - - - - - - Logs a fatal message. - - The exception to log - The message to log - - - - Logs a fatal message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The message to log - - - - Logs a info message with lazily constructed message. The message will be constructed only if the is true. - - - - - - Logs an info message. - - The exception to log - The message to log - - - - Logs an info message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The message to log - - - - Logs a warn message with lazily constructed message. The message will be constructed only if the is true. - - - - - - Logs a warn message. - - The exception to log - The message to log - - - - Logs a warn message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Determines if messages of priority "debug" will be logged. - - True if "debug" messages will be logged. - - - - Determines if messages of priority "error" will be logged. - - True if "error" messages will be logged. - - - - Determines if messages of priority "fatal" will be logged. - - True if "fatal" messages will be logged. - - - - Determines if messages of priority "info" will be logged. - - True if "info" messages will be logged. - - - - Determines if messages of priority "warn" will be logged. - - True if "warn" messages will be logged. - - - - Exposes the Global Context of the extended logger. - - - - - Exposes the Thread Context of the extended logger. - - - - - Exposes the Thread Stack of the extended logger. - - - - - The Logger sending everything to the standard output streams. - This is mainly for the cases when you have a utility that - does not have a logger to supply. - - - - - The Level Filtered Logger class. This is a base clase which - provides a LogLevel attribute and reroutes all functions into - one Log method. - - - - - Creates a new LevelFilteredLogger. - - - - - Logs a debug message. - - The message to log - - - - Logs a debug message. - - The exception to log - The message to log - - - - Logs a debug message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a debug message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The message to log - - - - Logs an info message. - - The exception to log - The message to log - - - - Logs an info message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an info message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The message to log - - - - Logs a warn message. - - The exception to log - The message to log - - - - Logs a warn message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a warn message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The message to log - - - - Logs an error message. - - The exception to log - The message to log - - - - Logs an error message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs an error message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The message to log - - - - Logs a fatal message. - - The exception to log - The message to log - - - - Logs a fatal message. - - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The exception to log - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Logs a fatal message. - - The exception to log - The format provider to use - Format string for the message to log - Format arguments for the message to log - - - - Implementors output the log content by implementing this method only. - Note that exception can be null - - - - - - - - - The LoggerLevel that this logger - will be using. Defaults to LoggerLevel.Off - - - - - The name that this logger will be using. - Defaults to String.Empty - - - - - Determines if messages of priority "debug" will be logged. - - true if log level flags include the bit - - - - Determines if messages of priority "info" will be logged. - - true if log level flags include the bit - - - - Determines if messages of priority "warn" will be logged. - - true if log level flags include the bit - - - - Determines if messages of priority "error" will be logged. - - true if log level flags include the bit - - - - Determines if messages of priority "fatal" will be logged. - - true if log level flags include the bit - - - - Creates a new ConsoleLogger with the Level - set to LoggerLevel.Debug and the Name - set to String.Empty. - - - - - Creates a new ConsoleLogger with the Name - set to String.Empty. - - The logs Level. - - - - Creates a new ConsoleLogger with the Level - set to LoggerLevel.Debug. - - The logs Name. - - - - Creates a new ConsoleLogger. - - The logs Name. - The logs Level. - - - - A Common method to log. - - The level of logging - The name of the logger - The Message - The Exception - - - - Returns a new ConsoleLogger with the name - added after this loggers name, with a dot in between. - - The added hierarchical name. - A new ConsoleLogger. - - - - The Null Logger class. This is useful for implementations where you need - to provide a logger to a utility class, but do not want any output from it. - It also helps when you have a utility that does not have a logger to supply. - - - - - Returns this NullLogger. - - Ignored - This ILogger instance. - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - - - - No-op. - - Ignored - Ignored - Ignored - Ignored - - - - Returns empty context properties. - - - - - Returns empty context properties. - - - - - Returns empty context stacks. - - - - - No-op. - - false - - - - No-op. - - false - - - - No-op. - - false - - - - No-op. - - false - - - - No-op. - - false - - - - The Stream Logger class. This class can stream log information - to any stream, it is suitable for storing a log file to disk, - or to a MemoryStream for testing your components. - - - This logger is not thread safe. - - - - - Creates a new StreamLogger with default encoding - and buffer size. Initial Level is set to Debug. - - - The name of the log. - - - The stream that will be used for logging, - seeking while the logger is alive - - - - - Creates a new StreamLogger with default buffer size. - Initial Level is set to Debug. - - - The name of the log. - - - The stream that will be used for logging, - seeking while the logger is alive - - - The encoding that will be used for this stream. - - - - - - Creates a new StreamLogger. - Initial Level is set to Debug. - - - The name of the log. - - - The stream that will be used for logging, - seeking while the logger is alive - - - The encoding that will be used for this stream. - - - - The buffer size that will be used for this stream. - - - - - - Creates a new StreamLogger with - Debug as default Level. - - The name of the log. - The StreamWriter the log will write to. - - - - This is an abstract implementation - that deals with methods that can be abstracted away - from underlying implementations. - - - AbstractConfiguration makes easier to implementers - to create a new version of - - - - - is a interface encapsulating a configuration node - used to retrieve configuration values. - - - - - Gets the value of the node and converts it - into specified . - - The - - The Default value returned if the conversion fails. - - The Value converted into the specified type. - - - - Gets the name of the node. - - - The Name of the node. - - - - - Gets the value of the node. - - - The Value of the node. - - - - - Gets an of - elements containing all node children. - - The Collection of child nodes. - - - - Gets an of the configuration attributes. - - - - - Gets the value of the node and converts it - into specified . - - The - - The Default value returned if the conversion fails. - - The Value converted into the specified type. - - - - Gets node attributes. - - - All attributes of the node. - - - - - Gets all child nodes. - - The of child nodes. - - - - Gets the name of the . - - - The Name of the . - - - - - Gets the value of . - - - The Value of the . - - - - - A collection of objects. - - - - - Creates a new instance of ConfigurationCollection. - - - - - Creates a new instance of ConfigurationCollection. - - - - - Summary description for MutableConfiguration. - - - - - Initializes a new instance of the class. - - The name. - - - - Gets the value of . - - - The Value of the . - - - - - General purpose class to represent a standard pair of values. - - Type of the first value - Type of the second value - - - - Constructs a pair with its values - - - - - - - List of utility methods related to dynamic proxy operations - - - - - Determines whether the specified type is a proxy generated by - DynamicProxy (1 or 2). - - The type. - - true if it is a proxy; otherwise, false. - - - - - Readonly implementation of which uses an anonymous object as its source. Uses names of properties as keys, and property values as... well - values. Keys are not case sensitive. - - - - - Initializes a new instance of the class. - - The target. - - - - Adds an element with the provided key and value to the object. - - The to use as the key of the element to add. - The to use as the value of the element to add. - - is null. - An element with the same key already exists in the object. - The is read-only.-or- The has a fixed size. - - - - Removes all elements from the object. - - The object is read-only. - - - - Determines whether the object contains an element with the specified key. - - The key to locate in the object. - - true if the contains an element with the key; otherwise, false. - - - is null. - - - - Removes the element with the specified key from the object. - - The key of the element to remove. - - is null. - The object is read-only.-or- The has a fixed size. - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - - - - Copies the elements of the to an , starting at a particular index. - - The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing. - The zero-based index in at which copying begins. - - is null. - - is less than zero. - - is multidimensional.-or- is equal to or greater than the length of .-or- The number of elements in the source is greater than the available space from to the end of the destination . - The type of the source cannot be cast automatically to the type of the destination . - - - - Returns an object for the object. - - - An object for the object. - - - - - Reads values of properties from and inserts them into using property names as keys. - - - - - - - Gets the number of elements contained in the . - - - The number of elements contained in the . - - - - Gets a value indicating whether access to the is synchronized (thread safe). - - - true if access to the is synchronized (thread safe); otherwise, false. - - - - Gets an object that can be used to synchronize access to the . - - - An object that can be used to synchronize access to the . - - - - Gets a value indicating whether the object is read-only. - - - true if the object is read-only; otherwise, false. - - - - Gets or sets the with the specified key. - - - - - - Gets an object containing the keys of the object. - - - An object containing the keys of the object. - - - - Gets an object containing the values in the object. - - - An object containing the values in the object. - - - - Gets a value indicating whether the object has a fixed size. - - - true if the object has a fixed size; otherwise, false. - - - - Represents a 'streamable' resource. Can - be a file, a resource in an assembly. - - - - - Returns a reader for the stream - - - It's up to the caller to dispose the reader. - - - - - - Returns a reader for the stream - - - It's up to the caller to dispose the reader. - - - - - - - Returns an instance of - created according to the relativePath - using itself as the root. - - - - - - - - - - Only valid for resources that - can be obtained through relative paths - - - - - - - - - - This returns a new stream instance each time it is called. - It is the responsibility of the caller to dispose of this stream - - - - - Depicts the contract for resource factories. - - - - - Used to check whether the resource factory - is able to deal with the given resource - identifier. - - - Implementors should return true - only if the given identifier is supported - by the resource factory - - - - - - - Creates an instance - for the given resource identifier - - - - - - - Creates an instance - for the given resource identifier - - - - - - - - - - - - - Adapts a static string content as an - - - - - Enable access to files on network shares - - - - diff --git a/packages/Castle.Core.3.3.3/readme.txt b/packages/Castle.Core.3.3.3/readme.txt deleted file mode 100644 index 239ae67..0000000 --- a/packages/Castle.Core.3.3.3/readme.txt +++ /dev/null @@ -1,10 +0,0 @@ -Thanks for downloading this Castle package. -You can find full list of changes in changes.txt - -Documentation (work in progress, contributions appreciated): -Dictionary Adapter - http://docs.castleproject.org/Tools.Castle-DictionaryAdapter.ashx -DynamicProxy - http://docs.castleproject.org/Tools.DynamicProxy.ashx -Discusssion group: - http://groups.google.com/group/castle-project-users -StackOverflow tags: - castle-dynamicproxy, castle-dictionaryadapter, castle - -Issue tracker: - http://issues.castleproject.org/dashboard \ No newline at end of file diff --git a/packages/Moq.4.5.8/Moq.4.5.8.nupkg b/packages/Moq.4.5.8/Moq.4.5.8.nupkg deleted file mode 100644 index a5f44f9..0000000 Binary files a/packages/Moq.4.5.8/Moq.4.5.8.nupkg and /dev/null differ diff --git a/packages/Moq.4.5.8/lib/net45/Moq.dll b/packages/Moq.4.5.8/lib/net45/Moq.dll deleted file mode 100644 index bc58607..0000000 Binary files a/packages/Moq.4.5.8/lib/net45/Moq.dll and /dev/null differ diff --git a/packages/Moq.4.5.8/lib/net45/Moq.xml b/packages/Moq.4.5.8/lib/net45/Moq.xml deleted file mode 100644 index f1f6bef..0000000 --- a/packages/Moq.4.5.8/lib/net45/Moq.xml +++ /dev/null @@ -1,5574 +0,0 @@ - - - - Moq - - - - - Handle interception - - the current invocation context - shared data for the interceptor as a whole - shared data among the strategies during a single interception - InterceptionAction.Continue if further interception has to be processed, otherwise InterceptionAction.Stop - - - - Covarient interface for Mock<T> such that casts between IMock<Employee> to IMock<Person> - are possible. Only covers the covariant members of Mock<T>. - - - - - Exposes the mocked object instance. - - - - - Behavior of the mock, according to the value set in the constructor. - - - - - Whether the base member virtual implementation will be called - for mocked classes if no setup is matched. Defaults to . - - - - - Specifies the behavior to use when returning default values for - unexpected invocations on loose mocks. - - - - - Get an eventInfo for a given event name. Search type ancestors depth first if necessary. - - Name of the event, with the set_ or get_ prefix already removed - - - - Get an eventInfo for a given event name. Search type ancestors depth first if necessary. - Searches also in non public events. - - Name of the event, with the set_ or get_ prefix already removed - - - - Given a type return all of its ancestors, both types and interfaces. - - The type to find immediate ancestors of - - - - Defines the Callback verb and overloads. - - - - - Specifies a callback to invoke when the method is called. - - The callback method to invoke. - - The following example specifies a callback to set a boolean - value that can be used later: - - var called = false; - mock.Setup(x => x.Execute()) - .Callback(() => called = true); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The argument type of the invoked method. - The callback method to invoke. - - Invokes the given callback with the concrete invocation argument value. - - Notice how the specific string argument is retrieved by simply declaring - it as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute(It.IsAny<string>())) - .Callback((string command) => Console.WriteLine(command)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2) => Console.WriteLine(arg1 + arg2)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3) => Console.WriteLine(arg1 + arg2 + arg3)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4) => Console.WriteLine(arg1 + arg2 + arg3 + arg4)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11, string arg12) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11, string arg12, string arg13) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The type of the fourteenth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11, string arg12, string arg13, string arg14) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13 + arg14)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The type of the fourteenth argument of the invoked method. - The type of the fifteenth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11, string arg12, string arg13, string arg14, string arg15) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13 + arg14 + arg15)); - - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The type of the fourteenth argument of the invoked method. - The type of the fifteenth argument of the invoked method. - The type of the sixteenth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11, string arg12, string arg13, string arg14, string arg15, string arg16) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13 + arg14 + arg15 + arg16)); - - - - - - Defines the Callback verb and overloads for callbacks on - setups that return a value. - - Mocked type. - Type of the return value of the setup. - - - - Specifies a callback to invoke when the method is called. - - The callback method to invoke. - - The following example specifies a callback to set a boolean value that can be used later: - - var called = false; - mock.Setup(x => x.Execute()) - .Callback(() => called = true) - .Returns(true); - - Note that in the case of value-returning methods, after the Callback - call you can still specify the return value. - - - - - Specifies a callback to invoke when the method is called that receives the original arguments. - - The type of the argument of the invoked method. - Callback method to invoke. - - Invokes the given callback with the concrete invocation argument value. - - Notice how the specific string argument is retrieved by simply declaring - it as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute(It.IsAny<string>())) - .Callback(command => Console.WriteLine(command)) - .Returns(true); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2) => Console.WriteLine(arg1 + arg2)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3) => Console.WriteLine(arg1 + arg2 + arg3)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4) => Console.WriteLine(arg1 + arg2 + arg3 + arg4)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6, arg7) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11, arg12) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11, arg12, arg13) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The type of the fourteenth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11, arg12, arg13, arg14) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13 + arg14)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The type of the fourteenth argument of the invoked method. - The type of the fifteenth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11, arg12, arg13, arg14, arg15) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13 + arg14 + arg15)); - - - - - - Specifies a callback to invoke when the method is called that receives the original - arguments. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The type of the fourteenth argument of the invoked method. - The type of the fifteenth argument of the invoked method. - The type of the sixteenth argument of the invoked method. - The callback method to invoke. - A reference to interface. - - Invokes the given callback with the concrete invocation arguments values. - - Notice how the specific arguments are retrieved by simply declaring - them as part of the lambda expression for the callback: - - - mock.Setup(x => x.Execute( - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>(), - It.IsAny<string>())) - .Callback((arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11, arg12, arg13, arg14, arg15, arg16) => Console.WriteLine(arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13 + arg14 + arg15 + arg16)); - - - - - - Defines the Raises verb. - - - - - Specifies the event that will be raised - when the setup is met. - - An expression that represents an event attach or detach action. - The event arguments to pass for the raised event. - - The following example shows how to raise an event when - the setup is met: - - var mock = new Mock<IContainer>(); - - mock.Setup(add => add.Add(It.IsAny<string>(), It.IsAny<object>())) - .Raises(add => add.Added += null, EventArgs.Empty); - - - - - - Specifies the event that will be raised - when the setup is matched. - - An expression that represents an event attach or detach action. - A function that will build the - to pass when raising the event. - - - - - Specifies the custom event that will be raised - when the setup is matched. - - An expression that represents an event attach or detach action. - The arguments to pass to the custom delegate (non EventHandler-compatible). - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - The type of the seventh argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - The type of the seventh argument received by the expected invocation. - The type of the eighth argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - The type of the seventh argument received by the expected invocation. - The type of the eighth argument received by the expected invocation. - The type of the nineth argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - The type of the seventh argument received by the expected invocation. - The type of the eighth argument received by the expected invocation. - The type of the nineth argument received by the expected invocation. - The type of the tenth argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - The type of the seventh argument received by the expected invocation. - The type of the eighth argument received by the expected invocation. - The type of the nineth argument received by the expected invocation. - The type of the tenth argument received by the expected invocation. - The type of the eleventh argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - The type of the seventh argument received by the expected invocation. - The type of the eighth argument received by the expected invocation. - The type of the nineth argument received by the expected invocation. - The type of the tenth argument received by the expected invocation. - The type of the eleventh argument received by the expected invocation. - The type of the twelfth argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - The type of the seventh argument received by the expected invocation. - The type of the eighth argument received by the expected invocation. - The type of the nineth argument received by the expected invocation. - The type of the tenth argument received by the expected invocation. - The type of the eleventh argument received by the expected invocation. - The type of the twelfth argument received by the expected invocation. - The type of the thirteenth argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - The type of the seventh argument received by the expected invocation. - The type of the eighth argument received by the expected invocation. - The type of the nineth argument received by the expected invocation. - The type of the tenth argument received by the expected invocation. - The type of the eleventh argument received by the expected invocation. - The type of the twelfth argument received by the expected invocation. - The type of the thirteenth argument received by the expected invocation. - The type of the fourteenth argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - The type of the seventh argument received by the expected invocation. - The type of the eighth argument received by the expected invocation. - The type of the nineth argument received by the expected invocation. - The type of the tenth argument received by the expected invocation. - The type of the eleventh argument received by the expected invocation. - The type of the twelfth argument received by the expected invocation. - The type of the thirteenth argument received by the expected invocation. - The type of the fourteenth argument received by the expected invocation. - The type of the fifteenth argument received by the expected invocation. - - - - - Specifies the event that will be raised when the setup is matched. - - The expression that represents an event attach or detach action. - The function that will build the - to pass when raising the event. - The type of the first argument received by the expected invocation. - The type of the second argument received by the expected invocation. - The type of the third argument received by the expected invocation. - The type of the fourth argument received by the expected invocation. - The type of the fifth argument received by the expected invocation. - The type of the sixth argument received by the expected invocation. - The type of the seventh argument received by the expected invocation. - The type of the eighth argument received by the expected invocation. - The type of the nineth argument received by the expected invocation. - The type of the tenth argument received by the expected invocation. - The type of the eleventh argument received by the expected invocation. - The type of the twelfth argument received by the expected invocation. - The type of the thirteenth argument received by the expected invocation. - The type of the fourteenth argument received by the expected invocation. - The type of the fifteenth argument received by the expected invocation. - The type of the sixteenth argument received by the expected invocation. - - - - - Defines the Returns verb. - - Mocked type. - Type of the return value from the expression. - - - - Specifies the value to return. - - The value to return, or . - - Return a true value from the method call: - - mock.Setup(x => x.Execute("ping")) - .Returns(true); - - - - - - Specifies a function that will calculate the value to return from the method. - - The function that will calculate the return value. - - Return a calculated value when the method is called: - - mock.Setup(x => x.Execute("ping")) - .Returns(() => returnValues[0]); - - The lambda expression to retrieve the return value is lazy-executed, - meaning that its value may change depending on the moment the method - is executed and the value the returnValues array has at - that moment. - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the argument of the invoked method. - The function that will calculate the return value. - - Return a calculated value which is evaluated lazily at the time of the invocation. - - The lookup list can change between invocations and the setup - will return different values accordingly. Also, notice how the specific - string argument is retrieved by simply declaring it as part of the lambda - expression: - - - mock.Setup(x => x.Execute(It.IsAny<string>())) - .Returns((string command) => returnValues[command]); - - - - - - Calls the real method of the object and returns its return value. - - The value calculated by the real method of the object. - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2) => arg1 + arg2); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3) => arg1 + arg2 + arg3); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4) => arg1 + arg2 + arg3 + arg4); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5) => arg1 + arg2 + arg3 + arg4 + arg5); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11, string arg12) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11, string arg12, string arg13) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The type of the fourteenth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11, string arg12, string arg13, string arg14) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13 + arg14); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The type of the fourteenth argument of the invoked method. - The type of the fifteenth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11, string arg12, string arg13, string arg14, string arg15) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13 + arg14 + arg15); - - - - - - Specifies a function that will calculate the value to return from the method, - retrieving the arguments for the invocation. - - The type of the first argument of the invoked method. - The type of the second argument of the invoked method. - The type of the third argument of the invoked method. - The type of the fourth argument of the invoked method. - The type of the fifth argument of the invoked method. - The type of the sixth argument of the invoked method. - The type of the seventh argument of the invoked method. - The type of the eighth argument of the invoked method. - The type of the nineth argument of the invoked method. - The type of the tenth argument of the invoked method. - The type of the eleventh argument of the invoked method. - The type of the twelfth argument of the invoked method. - The type of the thirteenth argument of the invoked method. - The type of the fourteenth argument of the invoked method. - The type of the fifteenth argument of the invoked method. - The type of the sixteenth argument of the invoked method. - The function that will calculate the return value. - Returns a calculated value which is evaluated lazily at the time of the invocation. - - - The return value is calculated from the value of the actual method invocation arguments. - Notice how the arguments are retrieved by simply declaring them as part of the lambda - expression: - - - mock.Setup(x => x.Execute( - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>(), - It.IsAny<int>())) - .Returns((string arg1, string arg2, string arg3, string arg4, string arg5, string arg6, string arg7, string arg8, string arg9, string arg10, string arg11, string arg12, string arg13, string arg14, string arg15, string arg16) => arg1 + arg2 + arg3 + arg4 + arg5 + arg6 + arg7 + arg8 + arg9 + arg10 + arg11 + arg12 + arg13 + arg14 + arg15 + arg16); - - - - - - Language for ReturnSequence - - - - - Returns value - - - - - Throws an exception - - - - - Throws an exception - - - - - Calls original method - - - - - Implements the fluent API. - - - - - The expectation will be considered only in the former condition. - - - - - - - The expectation will be considered only in the former condition. - - - - - - - - Setups the get. - - The type of the property. - The expression. - - - - - Setups the set. - - The type of the property. - The setter expression. - - - - - Setups the set. - - The setter expression. - - - - - Defines occurrence members to constraint setups. - - - - - The expected invocation can happen at most once. - - - - var mock = new Mock<ICommand>(); - mock.Setup(foo => foo.Execute("ping")) - .AtMostOnce(); - - - - - - The expected invocation can happen at most specified number of times. - - The number of times to accept calls. - - - var mock = new Mock<ICommand>(); - mock.Setup(foo => foo.Execute("ping")) - .AtMost( 5 ); - - - - - - Implements the fluent API. - - - - - Implements the fluent API. - - - - - Implements the fluent API. - - - - - Implements the fluent API. - - - - - Implements the fluent API. - - - - - Implements the fluent API. - - - - - Implements the fluent API. - - - - - Implements the fluent API. - - - - - Implements the fluent API. - - - - - Defines the Returns verb for property get setups. - - Mocked type. - Type of the property. - - - - Specifies the value to return. - - The value to return, or . - - Return a true value from the property getter call: - - mock.SetupGet(x => x.Suspended) - .Returns(true); - - - - - - Specifies a function that will calculate the value to return for the property. - - The function that will calculate the return value. - - Return a calculated value when the property is retrieved: - - mock.SetupGet(x => x.Suspended) - .Returns(() => returnValues[0]); - - The lambda expression to retrieve the return value is lazy-executed, - meaning that its value may change depending on the moment the property - is retrieved and the value the returnValues array has at - that moment. - - - - - Calls the real property of the object and returns its return value. - - The value calculated by the real property of the object. - - - - Defines the Callback verb for property getter setups. - - - Mocked type. - Type of the property. - - - - Specifies a callback to invoke when the property is retrieved. - - Callback method to invoke. - - Invokes the given callback with the property value being set. - - mock.SetupGet(x => x.Suspended) - .Callback(() => called = true) - .Returns(true); - - - - - - Defines the Callback verb for property setter setups. - - Type of the property. - - - - Specifies a callback to invoke when the property is set that receives the - property value being set. - - Callback method to invoke. - - Invokes the given callback with the property value being set. - - mock.SetupSet(x => x.Suspended) - .Callback((bool state) => Console.WriteLine(state)); - - - - - - Defines the Throws verb. - - - - - Specifies the exception to throw when the method is invoked. - - Exception instance to throw. - - This example shows how to throw an exception when the method is - invoked with an empty string argument: - - mock.Setup(x => x.Execute("")) - .Throws(new ArgumentException()); - - - - - - Specifies the type of exception to throw when the method is invoked. - - Type of exception to instantiate and throw when the setup is matched. - - This example shows how to throw an exception when the method is - invoked with an empty string argument: - - mock.Setup(x => x.Execute("")) - .Throws<ArgumentException>(); - - - - - - Defines the Verifiable verb. - - - - - Marks the expectation as verifiable, meaning that a call - to will check if this particular - expectation was met. - - - The following example marks the expectation as verifiable: - - mock.Expect(x => x.Execute("ping")) - .Returns(true) - .Verifiable(); - - - - - - Marks the expectation as verifiable, meaning that a call - to will check if this particular - expectation was met, and specifies a message for failures. - - - The following example marks the expectation as verifiable: - - mock.Expect(x => x.Execute("ping")) - .Returns(true) - .Verifiable("Ping should be executed always!"); - - - - - - Hook used to tells Castle which methods to proxy in mocked classes. - - Here we proxy the default methods Castle suggests (everything Object's methods) - plus Object.ToString(), so we can give mocks useful default names. - - This is required to allow Moq to mock ToString on proxy *class* implementations. - - - - - Extends AllMethodsHook.ShouldInterceptMethod to also intercept Object.ToString(). - - - - - The base class used for all our interface-inheriting proxies, which overrides the default - Object.ToString() behavior, to route it via the mock by default, unless overriden by a - real implementation. - - This is required to allow Moq to mock ToString on proxy *interface* implementations. - - - This is internal to Moq and should not be generally used. - - Unfortunately it must be public, due to cross-assembly visibility issues with reflection, - see github.com/Moq/moq4/issues/98 for details. - - - - - Overrides the default ToString implementation to instead find the mock for this mock.Object, - and return MockName + '.Object' as the mocked object's ToString, to make it easy to relate - mocks and mock object instances in error messages. - - - - - - - - - - - Gets an autogenerated interface with a method on it that matches the signature of the specified - . - - - Such an interface can then be mocked, and a delegate pointed at the method on the mocked instance. - This is how we support delegate mocking. The factory caches such interfaces and reuses them - for repeated requests for the same delegate type. - - The delegate type for which an interface is required. - The method on the autogenerated interface. - - - - Defines async extension methods on IReturns. - - - - - Allows to specify the return value of an asynchronous method. - - - - - Allows to specify the exception thrown by an asynchronous method. - - - - - The first method call or member access will be the - last segment of the expression (depth-first traversal), - which is the one we have to Setup rather than FluentMock. - And the last one is the one we have to Mock.Get rather - than FluentMock. - - - - - A default implementation of IQueryable for use with QueryProvider - - - - - The is a - static method that returns an IQueryable of Mocks of T which is used to - apply the linq specification to. - - - - - Base class for mocks and static helper class with methods that - apply to mocked objects, such as to - retrieve a from an object instance. - - - - - Creates an mock object of the indicated type. - - The type of the mocked object. - The mocked object created. - - - - Creates an mock object of the indicated type. - - The predicate with the specification of how the mocked object should behave. - The type of the mocked object. - The mocked object created. - - - - Initializes a new instance of the class. - - - - - Retrieves the mock object for the given object instance. - - Type of the mock to retrieve. Can be omitted as it's inferred - from the object instance passed in as the instance. - The instance of the mocked object.The mock associated with the mocked object. - The received instance - was not created by Moq. - - The following example shows how to add a new setup to an object - instance which is not the original but rather - the object associated with it: - - // Typed instance, not the mock, is retrieved from some test API. - HttpContextBase context = GetMockContext(); - - // context.Request is the typed object from the "real" API - // so in order to add a setup to it, we need to get - // the mock that "owns" it - Mock<HttpRequestBase> request = Mock.Get(context.Request); - mock.Setup(req => req.AppRelativeCurrentExecutionFilePath) - .Returns(tempUrl); - - - - - - Verifies that all verifiable expectations have been met. - - This example sets up an expectation and marks it as verifiable. After - the mock is used, a Verify() call is issued on the mock - to ensure the method in the setup was invoked: - - var mock = new Mock<IWarehouse>(); - this.Setup(x => x.HasInventory(TALISKER, 50)).Verifiable().Returns(true); - ... - // other test code - ... - // Will throw if the test code has didn't call HasInventory. - this.Verify(); - - Not all verifiable expectations were met. - - - - Verifies all expectations regardless of whether they have - been flagged as verifiable. - - This example sets up an expectation without marking it as verifiable. After - the mock is used, a call is issued on the mock - to ensure that all expectations are met: - - var mock = new Mock<IWarehouse>(); - this.Setup(x => x.HasInventory(TALISKER, 50)).Returns(true); - ... - // other test code - ... - // Will throw if the test code has didn't call HasInventory, even - // that expectation was not marked as verifiable. - this.VerifyAll(); - - At least one expectation was not met. - - - - Behavior of the mock, according to the value set in the constructor. - - - - - Whether the base member virtual implementation will be called - for mocked classes if no setup is matched. Defaults to . - - - - - Specifies the behavior to use when returning default values for - unexpected invocations on loose mocks. - - - - - Gets the mocked object instance. - - - - - Returns the mocked object value. - - - - - Retrieves the type of the mocked object, its generic type argument. - This is used in the auto-mocking of hierarchy access. - - - - - If this is a mock of a delegate, this property contains the method - on the autogenerated interface so that we can convert setup + verify - expressions on the delegate into expressions on the interface proxy. - - - - - Allows to check whether expression conversion to the - must be performed on the mock, without causing unnecessarily early initialization of - the mock instance, which breaks As{T}. - - - - - Specifies the class that will determine the default - value to return when invocations are made that - have no setups and need to return a default - value (for loose mocks). - - - - - Exposes the list of extra interfaces implemented by the mock. - - - - - Verifies that all verifiable expectations have been met. - - This example sets up an expectation and marks it as verifiable. After - the mock is used, a Verify() call is issued on the mock - to ensure the method in the setup was invoked: - - var mock = new Mock<IWarehouse>(); - this.Setup(x => x.HasInventory(TALISKER, 50)).Verifiable().Returns(true); - ... - // other test code - ... - // Will throw if the test code has didn't call HasInventory. - this.Verify(); - - Not all verifiable expectations were met. - - - - Verifies all expectations regardless of whether they have - been flagged as verifiable. - - This example sets up an expectation without marking it as verifiable. After - the mock is used, a call is issued on the mock - to ensure that all expectations are met: - - var mock = new Mock<IWarehouse>(); - this.Setup(x => x.HasInventory(TALISKER, 50)).Returns(true); - ... - // other test code - ... - // Will throw if the test code has didn't call HasInventory, even - // that expectation was not marked as verifiable. - this.VerifyAll(); - - At least one expectation was not met. - - - - Gets the interceptor target for the given expression and root mock, - building the intermediate hierarchy of mock objects if necessary. - - - - - Raises the associated event with the given - event argument data. - - - - - Raises the associated event with the given - event argument data. - - - - - Adds an interface implementation to the mock, - allowing setups to be specified for it. - - This method can only be called before the first use - of the mock property, at which - point the runtime type has already been generated - and no more interfaces can be added to it. - - Also, must be an - interface and not a class, which must be specified - when creating the mock instead. - - - The mock type - has already been generated by accessing the property. - - The specified - is not an interface. - - The following example creates a mock for the main interface - and later adds to it to verify - it's called by the consumer code: - - var mock = new Mock<IProcessor>(); - mock.Setup(x => x.Execute("ping")); - - // add IDisposable interface - var disposable = mock.As<IDisposable>(); - disposable.Setup(d => d.Dispose()).Verifiable(); - - Type of interface to cast the mock to. - - - - - - - Utility repository class to use to construct multiple - mocks when consistent verification is - desired for all of them. - - - If multiple mocks will be created during a test, passing - the desired (if different than the - or the one - passed to the repository constructor) and later verifying each - mock can become repetitive and tedious. - - This repository class helps in that scenario by providing a - simplified creation of multiple mocks with a default - (unless overriden by calling - ) and posterior verification. - - - - The following is a straightforward example on how to - create and automatically verify strict mocks using a : - - var repository = new MockRepository(MockBehavior.Strict); - - var foo = repository.Create<IFoo>(); - var bar = repository.Create<IBar>(); - - // no need to call Verifiable() on the setup - // as we'll be validating all of them anyway. - foo.Setup(f => f.Do()); - bar.Setup(b => b.Redo()); - - // exercise the mocks here - - repository.VerifyAll(); - // At this point all setups are already checked - // and an optional MockException might be thrown. - // Note also that because the mocks are strict, any invocation - // that doesn't have a matching setup will also throw a MockException. - - The following examples shows how to setup the repository - to create loose mocks and later verify only verifiable setups: - - var repository = new MockRepository(MockBehavior.Loose); - - var foo = repository.Create<IFoo>(); - var bar = repository.Create<IBar>(); - - // this setup will be verified when we verify the repository - foo.Setup(f => f.Do()).Verifiable(); - - // this setup will NOT be verified - foo.Setup(f => f.Calculate()); - - // this setup will be verified when we verify the repository - bar.Setup(b => b.Redo()).Verifiable(); - - // exercise the mocks here - // note that because the mocks are Loose, members - // called in the interfaces for which no matching - // setups exist will NOT throw exceptions, - // and will rather return default values. - - repository.Verify(); - // At this point verifiable setups are already checked - // and an optional MockException might be thrown. - - The following examples shows how to setup the repository with a - default strict behavior, overriding that default for a - specific mock: - - var repository = new MockRepository(MockBehavior.Strict); - - // this particular one we want loose - var foo = repository.Create<IFoo>(MockBehavior.Loose); - var bar = repository.Create<IBar>(); - - // specify setups - - // exercise the mocks here - - repository.Verify(); - - - - - - - Access the universe of mocks of the given type, to retrieve those - that behave according to the LINQ query specification. - - The type of the mocked object to query. - - - - Access the universe of mocks of the given type, to retrieve those - that behave according to the LINQ query specification. - - The predicate with the setup expressions. - The type of the mocked object to query. - - - - Creates an mock object of the indicated type. - - The type of the mocked object. - The mocked object created. - - - - Creates an mock object of the indicated type. - - The predicate with the setup expressions. - The type of the mocked object. - The mocked object created. - - - - Creates the mock query with the underlying queriable implementation. - - - - - Wraps the enumerator inside a queryable. - - - - - Method that is turned into the actual call from .Query{T}, to - transform the queryable query into a normal enumerable query. - This method is never used directly by consumers. - - - - - Initializes the repository with the given - for newly created mocks from the repository. - - The behavior to use for mocks created - using the repository method if not overriden - by using the overload. - - - - Matcher to treat static functions as matchers. - - mock.Setup(x => x.StringMethod(A.MagicString())); - - public static class A - { - [Matcher] - public static string MagicString() { return null; } - public static bool MagicString(string arg) - { - return arg == "magic"; - } - } - - Will succeed if: mock.Object.StringMethod("magic"); - and fail with any other call. - - - - - A that returns an empty default value - for invocations that do not have setups or return values, with loose mocks. - This is the default behavior for a mock. - - - - - The intention of is to create a more readable - string representation for the failure message. - - - - - Provides additional methods on mocks. - - - Those methods are useful for Testeroids support. - - - - - Resets the calls previously made on the specified mock. - - The mock whose calls need to be reset. - - - - Resets mock state, including setups and any previously made calls. - - The mock that needs to be reset. - - - - Helper class to setup a full trace between many mocks - - - - - Initialize a trace setup - - - - - Allow sequence to be repeated - - - - - define nice api - - - - - Perform an expectation in the trace. - - - - - Marks a method as a matcher, which allows complete replacement - of the built-in class with your own argument - matching rules. - - - This feature has been deprecated in favor of the new - and simpler . - - - The argument matching is used to determine whether a concrete - invocation in the mock matches a given setup. This - matching mechanism is fully extensible. - - - There are two parts of a matcher: the compiler matcher - and the runtime matcher. - - - Compiler matcher - Used to satisfy the compiler requirements for the - argument. Needs to be a method optionally receiving any arguments - you might need for the matching, but with a return type that - matches that of the argument. - - Let's say I want to match a lists of orders that contains - a particular one. I might create a compiler matcher like the following: - - - public static class Orders - { - [Matcher] - public static IEnumerable<Order> Contains(Order order) - { - return null; - } - } - - Now we can invoke this static method instead of an argument in an - invocation: - - var order = new Order { ... }; - var mock = new Mock<IRepository<Order>>(); - - mock.Setup(x => x.Save(Orders.Contains(order))) - .Throws<ArgumentException>(); - - Note that the return value from the compiler matcher is irrelevant. - This method will never be called, and is just used to satisfy the - compiler and to signal Moq that this is not a method that we want - to be invoked at runtime. - - - - Runtime matcher - - The runtime matcher is the one that will actually perform evaluation - when the test is run, and is defined by convention to have the - same signature as the compiler matcher, but where the return - value is the first argument to the call, which contains the - object received by the actual invocation at runtime: - - public static bool Contains(IEnumerable<Order> orders, Order order) - { - return orders.Contains(order); - } - - At runtime, the mocked method will be invoked with a specific - list of orders. This value will be passed to this runtime - matcher as the first argument, while the second argument is the - one specified in the setup (x.Save(Orders.Contains(order))). - - The boolean returned determines whether the given argument has been - matched. If all arguments to the expected method are matched, then - the setup matches and is evaluated. - - - - - - Using this extensible infrastructure, you can easily replace the entire - set of matchers with your own. You can also avoid the - typical (and annoying) lengthy expressions that result when you have - multiple arguments that use generics. - - - The following is the complete example explained above: - - public static class Orders - { - [Matcher] - public static IEnumerable<Order> Contains(Order order) - { - return null; - } - - public static bool Contains(IEnumerable<Order> orders, Order order) - { - return orders.Contains(order); - } - } - - And the concrete test using this matcher: - - var order = new Order { ... }; - var mock = new Mock<IRepository<Order>>(); - - mock.Setup(x => x.Save(Orders.Contains(order))) - .Throws<ArgumentException>(); - - // use mock, invoke Save, and have the matcher filter. - - - - - - Provides a mock implementation of . - - Any interface type can be used for mocking, but for classes, only abstract and virtual members can be mocked. - - The behavior of the mock with regards to the setups and the actual calls is determined - by the optional that can be passed to the - constructor. - - Type to mock, which can be an interface or a class. - The following example shows establishing setups with specific values - for method invocations: - - // Arrange - var order = new Order(TALISKER, 50); - var mock = new Mock<IWarehouse>(); - - mock.Setup(x => x.HasInventory(TALISKER, 50)).Returns(true); - - // Act - order.Fill(mock.Object); - - // Assert - Assert.True(order.IsFilled); - - The following example shows how to use the class - to specify conditions for arguments instead of specific values: - - // Arrange - var order = new Order(TALISKER, 50); - var mock = new Mock<IWarehouse>(); - - // shows how to expect a value within a range - mock.Setup(x => x.HasInventory( - It.IsAny<string>(), - It.IsInRange(0, 100, Range.Inclusive))) - .Returns(false); - - // shows how to throw for unexpected calls. - mock.Setup(x => x.Remove( - It.IsAny<string>(), - It.IsAny<int>())) - .Throws(new InvalidOperationException()); - - // Act - order.Fill(mock.Object); - - // Assert - Assert.False(order.IsFilled); - - - - - - Obsolete. - - - - - Obsolete. - - - - - Obsolete. - - - - - Obsolete. - - - - - Obsolete. - - - - - Ctor invoked by AsTInterface exclusively. - - - - - Initializes an instance of the mock with default behavior. - - var mock = new Mock<IFormatProvider>(); - - - - - Initializes an instance of the mock with default behavior and with - the given constructor arguments for the class. (Only valid when is a class) - - The mock will try to find the best match constructor given the constructor arguments, and invoke that - to initialize the instance. This applies only for classes, not interfaces. - - var mock = new Mock<MyProvider>(someArgument, 25); - Optional constructor arguments if the mocked type is a class. - - - - Initializes an instance of the mock with the specified behavior. - - var mock = new Mock<IFormatProvider>(MockBehavior.Relaxed); - Behavior of the mock. - - - - Initializes an instance of the mock with a specific behavior with - the given constructor arguments for the class. - - The mock will try to find the best match constructor given the constructor arguments, and invoke that - to initialize the instance. This applies only to classes, not interfaces. - - var mock = new Mock<MyProvider>(someArgument, 25); - Behavior of the mock.Optional constructor arguments if the mocked type is a class. - - - - Exposes the mocked object instance. - - - - - Allows naming of your mocks, so they can be easily identified in error messages (e.g. from failed assertions). - - - - - Returns the name of the mock - - - - - - - - Returns the mocked object value. - - - - - Specifies a setup on the mocked type for a call to - to a void method. - - If more than one setup is specified for the same method or property, - the latest one wins and is the one that will be executed. - Lambda expression that specifies the expected method invocation. - - var mock = new Mock<IProcessor>(); - mock.Setup(x => x.Execute("ping")); - - - - - - Specifies a setup on the mocked type for a call to - to a value returning method. - Type of the return value. Typically omitted as it can be inferred from the expression. - If more than one setup is specified for the same method or property, - the latest one wins and is the one that will be executed. - Lambda expression that specifies the method invocation. - - mock.Setup(x => x.HasInventory("Talisker", 50)).Returns(true); - - - - - - Specifies a setup on the mocked type for a call to - to a property getter. - - If more than one setup is set for the same property getter, - the latest one wins and is the one that will be executed. - Type of the property. Typically omitted as it can be inferred from the expression.Lambda expression that specifies the property getter. - - mock.SetupGet(x => x.Suspended) - .Returns(true); - - - - - - Specifies a setup on the mocked type for a call to - to a property setter. - - If more than one setup is set for the same property setter, - the latest one wins and is the one that will be executed. - - This overloads allows the use of a callback already - typed for the property type. - - Type of the property. Typically omitted as it can be inferred from the expression.The Lambda expression that sets a property to a value. - - mock.SetupSet(x => x.Suspended = true); - - - - - - Specifies a setup on the mocked type for a call to - to a property setter. - - If more than one setup is set for the same property setter, - the latest one wins and is the one that will be executed. - Lambda expression that sets a property to a value. - - mock.SetupSet(x => x.Suspended = true); - - - - - - Specifies that the given property should have "property behavior", - meaning that setting its value will cause it to be saved and - later returned when the property is requested. (this is also - known as "stubbing"). - - Type of the property, inferred from the property - expression (does not need to be specified). - Property expression to stub. - If you have an interface with an int property Value, you might - stub it using the following straightforward call: - - var mock = new Mock<IHaveValue>(); - mock.Stub(v => v.Value); - - After the Stub call has been issued, setting and - retrieving the object value will behave as expected: - - IHaveValue v = mock.Object; - - v.Value = 5; - Assert.Equal(5, v.Value); - - - - - - Specifies that the given property should have "property behavior", - meaning that setting its value will cause it to be saved and - later returned when the property is requested. This overload - allows setting the initial value for the property. (this is also - known as "stubbing"). - - Type of the property, inferred from the property - expression (does not need to be specified). - Property expression to stub.Initial value for the property. - If you have an interface with an int property Value, you might - stub it using the following straightforward call: - - var mock = new Mock<IHaveValue>(); - mock.SetupProperty(v => v.Value, 5); - - After the SetupProperty call has been issued, setting and - retrieving the object value will behave as expected: - - IHaveValue v = mock.Object; - // Initial value was stored - Assert.Equal(5, v.Value); - - // New value set which changes the initial value - v.Value = 6; - Assert.Equal(6, v.Value); - - - - - - Specifies that the all properties on the mock should have "property behavior", - meaning that setting its value will cause it to be saved and - later returned when the property is requested. (this is also - known as "stubbing"). The default value for each property will be the - one generated as specified by the property for the mock. - - If the mock is set to , - the mocked default values will also get all properties setup recursively. - - - - - - - - Verifies that a specific invocation matching the given expression was performed on the mock. Use - in conjunction with the default . - - This example assumes that the mock has been used, and later we want to verify that a given - invocation with specific parameters was performed: - - var mock = new Mock<IProcessor>(); - // exercise mock - //... - // Will throw if the test code didn't call Execute with a "ping" string argument. - mock.Verify(proc => proc.Execute("ping")); - - The invocation was not performed on the mock.Expression to verify. - - - - Verifies that a specific invocation matching the given expression was performed on the mock. Use - in conjunction with the default . - - The invocation was not call the times specified by - . - Expression to verify.The number of times a method is allowed to be called. - - - - Verifies that a specific invocation matching the given expression was performed on the mock. Use - in conjunction with the default . - - The invocation was not call the times specified by - . - Expression to verify.The number of times a method is allowed to be called. - - - - Verifies that a specific invocation matching the given expression was performed on the mock, - specifying a failure error message. Use in conjunction with the default - . - - This example assumes that the mock has been used, and later we want to verify that a given - invocation with specific parameters was performed: - - var mock = new Mock<IProcessor>(); - // exercise mock - //... - // Will throw if the test code didn't call Execute with a "ping" string argument. - mock.Verify(proc => proc.Execute("ping")); - - The invocation was not performed on the mock.Expression to verify.Message to show if verification fails. - - - - Verifies that a specific invocation matching the given expression was performed on the mock, - specifying a failure error message. Use in conjunction with the default - . - - The invocation was not call the times specified by - . - Expression to verify.The number of times a method is allowed to be called.Message to show if verification fails. - - - - Verifies that a specific invocation matching the given expression was performed on the mock, - specifying a failure error message. Use in conjunction with the default - . - - The invocation was not call the times specified by - . - Expression to verify.The number of times a method is allowed to be called.Message to show if verification fails. - - - - Verifies that a specific invocation matching the given expression was performed on the mock. Use - in conjunction with the default . - - This example assumes that the mock has been used, and later we want to verify that a given - invocation with specific parameters was performed: - - var mock = new Mock<IWarehouse>(); - // exercise mock - //... - // Will throw if the test code didn't call HasInventory. - mock.Verify(warehouse => warehouse.HasInventory(TALISKER, 50)); - - The invocation was not performed on the mock.Expression to verify.Type of return value from the expression. - - - - Verifies that a specific invocation matching the given - expression was performed on the mock. Use in conjunction - with the default . - - The invocation was not call the times specified by - . - Expression to verify.The number of times a method is allowed to be called.Type of return value from the expression. - - - - Verifies that a specific invocation matching the given - expression was performed on the mock. Use in conjunction - with the default . - - The invocation was not call the times specified by - . - Expression to verify.The number of times a method is allowed to be called.Type of return value from the expression. - - - - Verifies that a specific invocation matching the given - expression was performed on the mock, specifying a failure - error message. - - This example assumes that the mock has been used, - and later we want to verify that a given invocation - with specific parameters was performed: - - var mock = new Mock<IWarehouse>(); - // exercise mock - //... - // Will throw if the test code didn't call HasInventory. - mock.Verify(warehouse => warehouse.HasInventory(TALISKER, 50), "When filling orders, inventory has to be checked"); - - The invocation was not performed on the mock.Expression to verify.Message to show if verification fails.Type of return value from the expression. - - - - Verifies that a specific invocation matching the given - expression was performed on the mock, specifying a failure - error message. - - The invocation was not call the times specified by - . - Expression to verify.The number of times a method is allowed to be called.Message to show if verification fails.Type of return value from the expression. - - - - Verifies that a property was read on the mock. - - This example assumes that the mock has been used, - and later we want to verify that a given property - was retrieved from it: - - var mock = new Mock<IWarehouse>(); - // exercise mock - //... - // Will throw if the test code didn't retrieve the IsClosed property. - mock.VerifyGet(warehouse => warehouse.IsClosed); - - The invocation was not performed on the mock.Expression to verify. - Type of the property to verify. Typically omitted as it can - be inferred from the expression's return type. - - - - - Verifies that a property was read on the mock. - - The invocation was not call the times specified by - . - The number of times a method is allowed to be called.Expression to verify. - Type of the property to verify. Typically omitted as it can - be inferred from the expression's return type. - - - - - Verifies that a property was read on the mock. - - The invocation was not call the times specified by - . - The number of times a method is allowed to be called.Expression to verify. - Type of the property to verify. Typically omitted as it can - be inferred from the expression's return type. - - - - - Verifies that a property was read on the mock, specifying a failure - error message. - - This example assumes that the mock has been used, - and later we want to verify that a given property - was retrieved from it: - - var mock = new Mock<IWarehouse>(); - // exercise mock - //... - // Will throw if the test code didn't retrieve the IsClosed property. - mock.VerifyGet(warehouse => warehouse.IsClosed); - - The invocation was not performed on the mock.Expression to verify.Message to show if verification fails. - Type of the property to verify. Typically omitted as it can - be inferred from the expression's return type. - - - - - Verifies that a property was read on the mock, specifying a failure - error message. - - The invocation was not call the times specified by - . - The number of times a method is allowed to be called.Expression to verify.Message to show if verification fails. - Type of the property to verify. Typically omitted as it can - be inferred from the expression's return type. - - - - - Verifies that a property was read on the mock, specifying a failure - error message. - - The invocation was not call the times specified by - . - The number of times a method is allowed to be called.Expression to verify.Message to show if verification fails. - Type of the property to verify. Typically omitted as it can - be inferred from the expression's return type. - - - - - Verifies that a property was set on the mock. - - This example assumes that the mock has been used, - and later we want to verify that a given property - was set on it: - - var mock = new Mock<IWarehouse>(); - // exercise mock - //... - // Will throw if the test code didn't set the IsClosed property. - mock.VerifySet(warehouse => warehouse.IsClosed = true); - - The invocation was not performed on the mock.Expression to verify. - - - - Verifies that a property was set on the mock. - - The invocation was not call the times specified by - . - The number of times a method is allowed to be called.Expression to verify. - - - - Verifies that a property was set on the mock. - - The invocation was not call the times specified by - . - The number of times a method is allowed to be called.Expression to verify. - - - - Verifies that a property was set on the mock, specifying - a failure message. - - This example assumes that the mock has been used, - and later we want to verify that a given property - was set on it: - - var mock = new Mock<IWarehouse>(); - // exercise mock - //... - // Will throw if the test code didn't set the IsClosed property. - mock.VerifySet(warehouse => warehouse.IsClosed = true, "Warehouse should always be closed after the action"); - - The invocation was not performed on the mock.Expression to verify.Message to show if verification fails. - - - - Verifies that a property was set on the mock, specifying - a failure message. - - The invocation was not call the times specified by - . - The number of times a method is allowed to be called.Expression to verify.Message to show if verification fails. - - - - Verifies that a property was set on the mock, specifying - a failure message. - - The invocation was not call the times specified by - . - The number of times a method is allowed to be called.Expression to verify.Message to show if verification fails. - - - - Raises the event referenced in using - the given argument. - - The argument is - invalid for the target event invocation, or the is - not an event attach or detach expression. - - The following example shows how to raise a event: - - var mock = new Mock<IViewModel>(); - - mock.Raise(x => x.PropertyChanged -= null, new PropertyChangedEventArgs("Name")); - - - This example shows how to invoke an event with a custom event arguments - class in a view that will cause its corresponding presenter to - react by changing its state: - - var mockView = new Mock<IOrdersView>(); - var presenter = new OrdersPresenter(mockView.Object); - - // Check that the presenter has no selection by default - Assert.Null(presenter.SelectedOrder); - - // Raise the event with a specific arguments data - mockView.Raise(v => v.SelectionChanged += null, new OrderEventArgs { Order = new Order("moq", 500) }); - - // Now the presenter reacted to the event, and we have a selected order - Assert.NotNull(presenter.SelectedOrder); - Assert.Equal("moq", presenter.SelectedOrder.ProductName); - - - - - - Raises the event referenced in using - the given argument for a non-EventHandler typed event. - - The arguments are - invalid for the target event invocation, or the is - not an event attach or detach expression. - - The following example shows how to raise a custom event that does not adhere to - the standard EventHandler: - - var mock = new Mock<IViewModel>(); - - mock.Raise(x => x.MyEvent -= null, "Name", bool, 25); - - - - - - Provides legacy API members as extensions so that - existing code continues to compile, but new code - doesn't see then. - - - - - Obsolete. - - - - - Obsolete. - - - - - Obsolete. - - - - - Provides additional methods on mocks. - - - Provided as extension methods as they confuse the compiler - with the overloads taking Action. - - - - - Specifies a setup on the mocked type for a call to - to a property setter, regardless of its value. - - - If more than one setup is set for the same property setter, - the latest one wins and is the one that will be executed. - - Type of the property. Typically omitted as it can be inferred from the expression. - Type of the mock. - The target mock for the setup. - Lambda expression that specifies the property setter. - - - mock.SetupSet(x => x.Suspended); - - - - This method is not legacy, but must be on an extension method to avoid - confusing the compiler with the new Action syntax. - - - - - Verifies that a property has been set on the mock, regarless of its value. - - - This example assumes that the mock has been used, - and later we want to verify that a given invocation - with specific parameters was performed: - - var mock = new Mock<IWarehouse>(); - // exercise mock - //... - // Will throw if the test code didn't set the IsClosed property. - mock.VerifySet(warehouse => warehouse.IsClosed); - - - The invocation was not performed on the mock. - Expression to verify. - The mock instance. - Mocked type. - Type of the property to verify. Typically omitted as it can - be inferred from the expression's return type. - - - - Verifies that a property has been set on the mock, specifying a failure - error message. - - - This example assumes that the mock has been used, - and later we want to verify that a given invocation - with specific parameters was performed: - - var mock = new Mock<IWarehouse>(); - // exercise mock - //... - // Will throw if the test code didn't set the IsClosed property. - mock.VerifySet(warehouse => warehouse.IsClosed); - - - The invocation was not performed on the mock. - Expression to verify. - Message to show if verification fails. - The mock instance. - Mocked type. - Type of the property to verify. Typically omitted as it can - be inferred from the expression's return type. - - - - Verifies that a property has been set on the mock, regardless - of the value but only the specified number of times. - - - This example assumes that the mock has been used, - and later we want to verify that a given invocation - with specific parameters was performed: - - var mock = new Mock<IWarehouse>(); - // exercise mock - //... - // Will throw if the test code didn't set the IsClosed property. - mock.VerifySet(warehouse => warehouse.IsClosed); - - - The invocation was not performed on the mock. - The invocation was not call the times specified by - . - The mock instance. - Mocked type. - The number of times a method is allowed to be called. - Expression to verify. - Type of the property to verify. Typically omitted as it can - be inferred from the expression's return type. - - - - Verifies that a property has been set on the mock, regardless - of the value but only the specified number of times, and specifying a failure - error message. - - - This example assumes that the mock has been used, - and later we want to verify that a given invocation - with specific parameters was performed: - - var mock = new Mock<IWarehouse>(); - // exercise mock - //... - // Will throw if the test code didn't set the IsClosed property. - mock.VerifySet(warehouse => warehouse.IsClosed); - - - The invocation was not performed on the mock. - The invocation was not call the times specified by - . - The mock instance. - Mocked type. - The number of times a method is allowed to be called. - Message to show if verification fails. - Expression to verify. - Type of the property to verify. Typically omitted as it can - be inferred from the expression's return type. - - - - Utility factory class to use to construct multiple - mocks when consistent verification is - desired for all of them. - - - If multiple mocks will be created during a test, passing - the desired (if different than the - or the one - passed to the factory constructor) and later verifying each - mock can become repetitive and tedious. - - This factory class helps in that scenario by providing a - simplified creation of multiple mocks with a default - (unless overriden by calling - ) and posterior verification. - - - - The following is a straightforward example on how to - create and automatically verify strict mocks using a : - - var factory = new MockFactory(MockBehavior.Strict); - - var foo = factory.Create<IFoo>(); - var bar = factory.Create<IBar>(); - - // no need to call Verifiable() on the setup - // as we'll be validating all of them anyway. - foo.Setup(f => f.Do()); - bar.Setup(b => b.Redo()); - - // exercise the mocks here - - factory.VerifyAll(); - // At this point all setups are already checked - // and an optional MockException might be thrown. - // Note also that because the mocks are strict, any invocation - // that doesn't have a matching setup will also throw a MockException. - - The following examples shows how to setup the factory - to create loose mocks and later verify only verifiable setups: - - var factory = new MockFactory(MockBehavior.Loose); - - var foo = factory.Create<IFoo>(); - var bar = factory.Create<IBar>(); - - // this setup will be verified when we verify the factory - foo.Setup(f => f.Do()).Verifiable(); - - // this setup will NOT be verified - foo.Setup(f => f.Calculate()); - - // this setup will be verified when we verify the factory - bar.Setup(b => b.Redo()).Verifiable(); - - // exercise the mocks here - // note that because the mocks are Loose, members - // called in the interfaces for which no matching - // setups exist will NOT throw exceptions, - // and will rather return default values. - - factory.Verify(); - // At this point verifiable setups are already checked - // and an optional MockException might be thrown. - - The following examples shows how to setup the factory with a - default strict behavior, overriding that default for a - specific mock: - - var factory = new MockFactory(MockBehavior.Strict); - - // this particular one we want loose - var foo = factory.Create<IFoo>(MockBehavior.Loose); - var bar = factory.Create<IBar>(); - - // specify setups - - // exercise the mocks here - - factory.Verify(); - - - - - - - Initializes the factory with the given - for newly created mocks from the factory. - - The behavior to use for mocks created - using the factory method if not overriden - by using the overload. - - - - Whether the base member virtual implementation will be called - for mocked classes if no setup is matched. Defaults to . - - - - - Specifies the behavior to use when returning default values for - unexpected invocations on loose mocks. - - - - - Gets the mocks that have been created by this factory and - that will get verified together. - - - - - Creates a new mock with the default - specified at factory construction time. - - Type to mock. - A new . - - - var factory = new MockFactory(MockBehavior.Strict); - - var foo = factory.Create<IFoo>(); - // use mock on tests - - factory.VerifyAll(); - - - - - - Creates a new mock with the default - specified at factory construction time and with the - the given constructor arguments for the class. - - - The mock will try to find the best match constructor given the - constructor arguments, and invoke that to initialize the instance. - This applies only to classes, not interfaces. - - Type to mock. - Constructor arguments for mocked classes. - A new . - - - var factory = new MockFactory(MockBehavior.Default); - - var mock = factory.Create<MyBase>("Foo", 25, true); - // use mock on tests - - factory.Verify(); - - - - - - Creates a new mock with the given . - - Type to mock. - Behavior to use for the mock, which overrides - the default behavior specified at factory construction time. - A new . - - The following example shows how to create a mock with a different - behavior to that specified as the default for the factory: - - var factory = new MockFactory(MockBehavior.Strict); - - var foo = factory.Create<IFoo>(MockBehavior.Loose); - - - - - - Creates a new mock with the given - and with the the given constructor arguments for the class. - - - The mock will try to find the best match constructor given the - constructor arguments, and invoke that to initialize the instance. - This applies only to classes, not interfaces. - - Type to mock. - Behavior to use for the mock, which overrides - the default behavior specified at factory construction time. - Constructor arguments for mocked classes. - A new . - - The following example shows how to create a mock with a different - behavior to that specified as the default for the factory, passing - constructor arguments: - - var factory = new MockFactory(MockBehavior.Default); - - var mock = factory.Create<MyBase>(MockBehavior.Strict, "Foo", 25, true); - - - - - - Implements creation of a new mock within the factory. - - Type to mock. - The behavior for the new mock. - Optional arguments for the construction of the mock. - - - - Verifies all verifiable expectations on all mocks created - by this factory. - - - One or more mocks had expectations that were not satisfied. - - - - Verifies all verifiable expectations on all mocks created - by this factory. - - - One or more mocks had expectations that were not satisfied. - - - - Invokes for each mock - in , and accumulates the resulting - that might be - thrown from the action. - - The action to execute against - each mock. - - - - Helper for sequencing return values in the same method. - - - - - Return a sequence of values, once per call. - - - - - Return a sequence of tasks, once per call. - - - - - Throws a sequence of exceptions, once per call. - - - - - Casts the expression to a lambda expression, removing - a cast if there's any. - - - - - Casts the body of the lambda expression to a . - - If the body is not a method call. - - - - Converts the body of the lambda expression into the referenced by it. - - - - - Checks whether the body of the lambda expression is a property access. - - - - - Checks whether the expression is a property access. - - - - - Checks whether the body of the lambda expression is a property indexer, which is true - when the expression is an whose - has - equal to . - - - - - Checks whether the expression is a property indexer, which is true - when the expression is an whose - has - equal to . - - - - - Creates an expression that casts the given expression to the - type. - - - - - TODO: remove this code when https://connect.microsoft.com/VisualStudio/feedback/ViewFeedback.aspx?FeedbackID=331583 - is fixed. - - - - - Extracts, into a common form, information from a - around either a (for a normal method call) - or a (for a delegate invocation). - - - - - Tests if a type is a delegate type (subclasses ). - - - - - Provides partial evaluation of subtrees, whenever they can be evaluated locally. - - Matt Warren: http://blogs.msdn.com/mattwar - Documented by InSTEDD: http://www.instedd.org - - - - Performs evaluation and replacement of independent sub-trees - - The root of the expression tree. - A function that decides whether a given expression - node can be part of the local function. - A new tree with sub-trees evaluated and replaced. - - - - Performs evaluation and replacement of independent sub-trees - - The root of the expression tree. - A new tree with sub-trees evaluated and replaced. - - - - Evaluates and replaces sub-trees when first candidate is reached (top-down) - - - - - Performs bottom-up analysis to determine which nodes can possibly - be part of an evaluated sub-tree. - - - - - Ensures the given is not null. - Throws otherwise. - - - - - Ensures the given string is not null or empty. - Throws in the first case, or - in the latter. - - - - - Checks an argument to ensure it is in the specified range including the edges. - - Type of the argument to check, it must be an type. - - The expression containing the name of the argument. - The argument value to check. - The minimun allowed value for the argument. - The maximun allowed value for the argument. - - - - Checks an argument to ensure it is in the specified range excluding the edges. - - Type of the argument to check, it must be an type. - - The expression containing the name of the argument. - The argument value to check. - The minimun allowed value for the argument. - The maximun allowed value for the argument. - - - - Implemented by all generated mock object instances. - - - - - Reference the Mock that contains this as the mock.Object value. - - - - - Implemented by all generated mock object instances. - - - - - Reference the Mock that contains this as the mock.Object value. - - - - - Implements the actual interception and method invocation for - all mocks. - - - - - Allows the specification of a matching condition for an - argument in a method invocation, rather than a specific - argument value. "It" refers to the argument being matched. - - This class allows the setup to match a method invocation - with an arbitrary value, with a value in a specified range, or - even one that matches a given predicate. - - - - - Matches any value of the given type. - - Typically used when the actual argument value for a method - call is not relevant. - - - // Throws an exception for a call to Remove with any string value. - mock.Setup(x => x.Remove(It.IsAny<string>())).Throws(new InvalidOperationException()); - - Type of the value. - - - - Matches any value of the given type, except null. - Type of the value. - - - - Matches any value that satisfies the given predicate. - Type of the argument to check.The predicate used to match the method argument. - Allows the specification of a predicate to perform matching - of method call arguments. - - This example shows how to return the value 1 whenever the argument to the - Do method is an even number. - - mock.Setup(x => x.Do(It.Is<int>(i => i % 2 == 0))) - .Returns(1); - - This example shows how to throw an exception if the argument to the - method is a negative number: - - mock.Setup(x => x.GetUser(It.Is<int>(i => i < 0))) - .Throws(new ArgumentException()); - - - - - - Matches any value that is in the range specified. - Type of the argument to check.The lower bound of the range.The upper bound of the range. - The kind of range. See . - - The following example shows how to expect a method call - with an integer argument within the 0..100 range. - - mock.Setup(x => x.HasInventory( - It.IsAny<string>(), - It.IsInRange(0, 100, Range.Inclusive))) - .Returns(false); - - - - - - Matches any value that is present in the sequence specified. - Type of the argument to check.The sequence of possible values. - The following example shows how to expect a method call - with an integer argument with value from a list. - - var values = new List<int> { 1, 2, 3 }; - - mock.Setup(x => x.HasInventory( - It.IsAny<string>(), - It.IsIn(values))) - .Returns(false); - - - - - - Matches any value that is present in the sequence specified. - Type of the argument to check.The sequence of possible values. - The following example shows how to expect a method call - with an integer argument with a value of 1, 2, or 3. - - mock.Setup(x => x.HasInventory( - It.IsAny<string>(), - It.IsIn(1, 2, 3))) - .Returns(false); - - - - - - Matches any value that is not found in the sequence specified. - Type of the argument to check.The sequence of disallowed values. - The following example shows how to expect a method call - with an integer argument with value not found from a list. - - var values = new List<int> { 1, 2, 3 }; - - mock.Setup(x => x.HasInventory( - It.IsAny<string>(), - It.IsNotIn(values))) - .Returns(false); - - - - - - Matches any value that is not found in the sequence specified. - Type of the argument to check.The sequence of disallowed values. - The following example shows how to expect a method call - with an integer argument of any value except 1, 2, or 3. - - mock.Setup(x => x.HasInventory( - It.IsAny<string>(), - It.IsNotIn(1, 2, 3))) - .Returns(false); - - - - - - Matches a string argument if it matches the given regular expression pattern. - The pattern to use to match the string argument value. - The following example shows how to expect a call to a method where the - string argument matches the given regular expression: - - mock.Setup(x => x.Check(It.IsRegex("[a-z]+"))).Returns(1); - - - - - - Matches a string argument if it matches the given regular expression pattern. - The pattern to use to match the string argument value.The options used to interpret the pattern. - The following example shows how to expect a call to a method where the - string argument matches the given regular expression, in a case insensitive way: - - mock.Setup(x => x.Check(It.IsRegex("[a-z]+", RegexOptions.IgnoreCase))).Returns(1); - - - - - - We need this non-generics base class so that - we can use from - generic code. - - - - - Options to customize the behavior of the mock. - - - - - Causes the mock to always throw - an exception for invocations that don't have a - corresponding setup. - - - - - Will never throw exceptions, returning default - values when necessary (null for reference types, - zero for value types or empty enumerables and arrays). - - - - - Default mock behavior, which equals . - - - - - Exception thrown by mocks when setups are not matched, - the mock is not properly setup, etc. - - - A distinct exception type is provided so that exceptions - thrown by the mock can be differentiated in tests that - expect other exceptions to be thrown (i.e. ArgumentException). - - Richer exception hierarchy/types are not provided as - tests typically should not catch or expect exceptions - from the mocks. These are typically the result of changes - in the tested class or its collaborators implementation, and - result in fixes in the mock setup so that they dissapear and - allow the test to pass. - - - - - - Made internal as it's of no use for - consumers, but it's important for - our own tests. - - - - - Indicates whether this exception is a verification fault raised by Verify() - - - - - Supports the serialization infrastructure. - - Serialization information. - Streaming context. - - - - Supports the serialization infrastructure. - - Serialization information. - Streaming context. - - - - Used by the mock factory to accumulate verification - failures. - - - - - Supports the serialization infrastructure. - - - - - A strongly-typed resource class, for looking up localized strings, etc. - - - - - Returns the cached ResourceManager instance used by this class. - - - - - Overrides the current thread's CurrentUICulture property for all - resource lookups using this strongly typed resource class. - - - - - Looks up a localized string similar to Mock type has already been initialized by accessing its Object property. Adding interfaces must be done before that.. - - - - - Looks up a localized string similar to Value cannot be an empty string.. - - - - - Looks up a localized string similar to Can only add interfaces to the mock.. - - - - - Looks up a localized string similar to Can't set return value for void method {0}.. - - - - - Looks up a localized string similar to Constructor arguments cannot be passed for delegate mocks.. - - - - - Looks up a localized string similar to Constructor arguments cannot be passed for interface mocks.. - - - - - Looks up a localized string similar to A matching constructor for the given arguments was not found on the mocked type.. - - - - - Looks up a localized string similar to Could not locate event for attach or detach method {0}.. - - - - - Looks up a localized string similar to Expression {0} involves a field access, which is not supported. Use properties instead.. - - - - - Looks up a localized string similar to Type to mock must be an interface or an abstract or non-sealed class. . - - - - - Looks up a localized string similar to Cannot retrieve a mock with the given object type {0} as it's not the main type of the mock or any of its additional interfaces. - Please cast the argument to one of the supported types: {1}. - Remember that there's no generics covariance in the CLR, so your object must be one of these types in order for the call to succeed.. - - - - - Looks up a localized string similar to The equals ("==" or "=" in VB) and the conditional 'and' ("&&" or "AndAlso" in VB) operators are the only ones supported in the query specification expression. Unsupported expression: {0}. - - - - - Looks up a localized string similar to LINQ method '{0}' not supported.. - - - - - Looks up a localized string similar to Expression contains a call to a method which is not virtual (overridable in VB) or abstract. Unsupported expression: {0}. - - - - - Looks up a localized string similar to Member {0}.{1} does not exist.. - - - - - Looks up a localized string similar to Method {0}.{1} is public. Use strong-typed Expect overload instead: - mock.Setup(x => x.{1}()); - . - - - - - Looks up a localized string similar to {0} invocation failed with mock behavior {1}. - {2}. - - - - - Looks up a localized string similar to Expected only {0} calls to {1}.. - - - - - Looks up a localized string similar to Expected only one call to {0}.. - - - - - Looks up a localized string similar to {0} - Expected invocation on the mock at least {2} times, but was {4} times: {1}. - - - - - Looks up a localized string similar to {0} - Expected invocation on the mock at least once, but was never performed: {1}. - - - - - Looks up a localized string similar to {0} - Expected invocation on the mock at most {3} times, but was {4} times: {1}. - - - - - Looks up a localized string similar to {0} - Expected invocation on the mock at most once, but was {4} times: {1}. - - - - - Looks up a localized string similar to {0} - Expected invocation on the mock between {2} and {3} times (Exclusive), but was {4} times: {1}. - - - - - Looks up a localized string similar to {0} - Expected invocation on the mock between {2} and {3} times (Inclusive), but was {4} times: {1}. - - - - - Looks up a localized string similar to {0} - Expected invocation on the mock exactly {2} times, but was {4} times: {1}. - - - - - Looks up a localized string similar to {0} - Expected invocation on the mock should never have been performed, but was {4} times: {1}. - - - - - Looks up a localized string similar to {0} - Expected invocation on the mock once, but was {4} times: {1}. - - - - - Looks up a localized string similar to All invocations on the mock must have a corresponding setup.. - - - - - Looks up a localized string similar to Object instance was not created by Moq.. - - - - - Looks up a localized string similar to Out expression must evaluate to a constant value.. - - - - - Looks up a localized string similar to Property {0}.{1} does not have a getter.. - - - - - Looks up a localized string similar to Property {0}.{1} does not exist.. - - - - - Looks up a localized string similar to Property {0}.{1} is write-only.. - - - - - Looks up a localized string similar to Property {0}.{1} is read-only.. - - - - - Looks up a localized string similar to Property {0}.{1} does not have a setter.. - - - - - Looks up a localized string similar to Cannot raise a mocked event unless it has been associated (attached) to a concrete event in a mocked object.. - - - - - Looks up a localized string similar to Ref expression must evaluate to a constant value.. - - - - - Looks up a localized string similar to Invocation needs to return a value and therefore must have a corresponding setup that provides it.. - - - - - Looks up a localized string similar to A lambda expression is expected as the argument to It.Is<T>.. - - - - - Looks up a localized string similar to Invocation {0} should not have been made.. - - - - - Looks up a localized string similar to Expression is not a method invocation: {0}. - - - - - Looks up a localized string similar to Expression is not a property access: {0}. - - - - - Looks up a localized string similar to Expression is not a property setter invocation.. - - - - - Looks up a localized string similar to Expression references a method that does not belong to the mocked object: {0}. - - - - - Looks up a localized string similar to Invalid setup on a non-virtual (overridable in VB) member: {0}. - - - - - Looks up a localized string similar to Type {0} does not implement required interface {1}. - - - - - Looks up a localized string similar to Type {0} does not from required type {1}. - - - - - Looks up a localized string similar to To specify a setup for public property {0}.{1}, use the typed overloads, such as: - mock.Setup(x => x.{1}).Returns(value); - mock.SetupGet(x => x.{1}).Returns(value); //equivalent to previous one - mock.SetupSet(x => x.{1}).Callback(callbackDelegate); - . - - - - - Looks up a localized string similar to Unsupported expression: {0}. - - - - - Looks up a localized string similar to Only property accesses are supported in intermediate invocations on a setup. Unsupported expression {0}.. - - - - - Looks up a localized string similar to Expression contains intermediate property access {0}.{1} which is of type {2} and cannot be mocked. Unsupported expression {3}.. - - - - - Looks up a localized string similar to Setter expression cannot use argument matchers that receive parameters.. - - - - - Looks up a localized string similar to Member {0} is not supported for protected mocking.. - - - - - Looks up a localized string similar to Setter expression can only use static custom matchers.. - - - - - Looks up a localized string similar to The following setups were not matched: - {0}. - - - - - Looks up a localized string similar to Invalid verify on a non-virtual (overridable in VB) member: {0}. - - - - - Allows setups to be specified for protected members by using their - name as a string, rather than strong-typing them which is not possible - due to their visibility. - - - - - Specifies a setup for a void method invocation with the given - , optionally specifying arguments for the method call. - - The name of the void method to be invoked. - The optional arguments for the invocation. If argument matchers are used, - remember to use rather than . - - - - Specifies a setup for an invocation on a property or a non void method with the given - , optionally specifying arguments for the method call. - - The name of the method or property to be invoked. - The optional arguments for the invocation. If argument matchers are used, - remember to use rather than . - The return type of the method or property. - - - - Specifies a setup for an invocation on a property getter with the given - . - - The name of the property. - The type of the property. - - - - Specifies a setup for an invocation on a property setter with the given - . - - The name of the property. - The property value. If argument matchers are used, - remember to use rather than . - The type of the property. - - - - Specifies a verify for a void method with the given , - optionally specifying arguments for the method call. Use in conjunction with the default - . - - The invocation was not call the times specified by - . - The name of the void method to be verified. - The number of times a method is allowed to be called. - The optional arguments for the invocation. If argument matchers are used, - remember to use rather than . - - - - Specifies a verify for an invocation on a property or a non void method with the given - , optionally specifying arguments for the method call. - - The invocation was not call the times specified by - . - The name of the method or property to be invoked. - The optional arguments for the invocation. If argument matchers are used, - remember to use rather than . - The number of times a method is allowed to be called. - The type of return value from the expression. - - - - Specifies a verify for an invocation on a property getter with the given - . - The invocation was not call the times specified by - . - - The name of the property. - The number of times a method is allowed to be called. - The type of the property. - - - - Specifies a setup for an invocation on a property setter with the given - . - - The invocation was not call the times specified by - . - The name of the property. - The number of times a method is allowed to be called. - The property value. - The type of the property. If argument matchers are used, - remember to use rather than . - - - - Allows the specification of a matching condition for an - argument in a protected member setup, rather than a specific - argument value. "ItExpr" refers to the argument being matched. - - - Use this variant of argument matching instead of - for protected setups. - This class allows the setup to match a method invocation - with an arbitrary value, with a value in a specified range, or - even one that matches a given predicate, or null. - - - - - Matches a null value of the given type. - - - Required for protected mocks as the null value cannot be used - directly as it prevents proper method overload selection. - - - - // Throws an exception for a call to Remove with a null string value. - mock.Protected() - .Setup("Remove", ItExpr.IsNull<string>()) - .Throws(new InvalidOperationException()); - - - Type of the value. - - - - Matches any value of the given type. - - - Typically used when the actual argument value for a method - call is not relevant. - - - - // Throws an exception for a call to Remove with any string value. - mock.Protected() - .Setup("Remove", ItExpr.IsAny<string>()) - .Throws(new InvalidOperationException()); - - - Type of the value. - - - - Matches any value that satisfies the given predicate. - - Type of the argument to check. - The predicate used to match the method argument. - - Allows the specification of a predicate to perform matching - of method call arguments. - - - This example shows how to return the value 1 whenever the argument to the - Do method is an even number. - - mock.Protected() - .Setup("Do", ItExpr.Is<int>(i => i % 2 == 0)) - .Returns(1); - - This example shows how to throw an exception if the argument to the - method is a negative number: - - mock.Protected() - .Setup("GetUser", ItExpr.Is<int>(i => i < 0)) - .Throws(new ArgumentException()); - - - - - - Matches any value that is in the range specified. - - Type of the argument to check. - The lower bound of the range. - The upper bound of the range. - The kind of range. See . - - The following example shows how to expect a method call - with an integer argument within the 0..100 range. - - mock.Protected() - .Setup("HasInventory", - ItExpr.IsAny<string>(), - ItExpr.IsInRange(0, 100, Range.Inclusive)) - .Returns(false); - - - - - - Matches a string argument if it matches the given regular expression pattern. - - The pattern to use to match the string argument value. - - The following example shows how to expect a call to a method where the - string argument matches the given regular expression: - - mock.Protected() - .Setup("Check", ItExpr.IsRegex("[a-z]+")) - .Returns(1); - - - - - - Matches a string argument if it matches the given regular expression pattern. - - The pattern to use to match the string argument value. - The options used to interpret the pattern. - - The following example shows how to expect a call to a method where the - string argument matches the given regular expression, in a case insensitive way: - - mock.Protected() - .Setup("Check", ItExpr.IsRegex("[a-z]+", RegexOptions.IgnoreCase)) - .Returns(1); - - - - - - Enables the Protected() method on , - allowing setups to be set for protected members by using their - name as a string, rather than strong-typing them which is not possible - due to their visibility. - - - - - Enable protected setups for the mock. - - Mocked object type. Typically omitted as it can be inferred from the mock instance. - The mock to set the protected setups on. - - - - Kind of range to use in a filter specified through - . - - - - - The range includes the to and - from values. - - - - - The range does not include the to and - from values. - - - - - Determines the way default values are generated - calculated for loose mocks. - - - - - Default behavior, which generates empty values for - value types (i.e. default(int)), empty array and - enumerables, and nulls for all other reference types. - - - - - Whenever the default value generated by - is null, replaces this value with a mock (if the type - can be mocked). - - - For sealed classes, a null value will be generated. - - - - - Interface to be implemented by classes that determine the - default value of non-expected invocations. - - - - - Defines the default value to return in all the methods returning . - The type of the return value.The value to set as default. - - - - Provides a value for the given member and arguments. - - The member to provide a default value for. - - - - - Allows creation custom value matchers that can be used on setups and verification, - completely replacing the built-in class with your own argument - matching rules. - - See also . - - - - - Provided for the sole purpose of rendering the delegate passed to the - matcher constructor if no friendly render lambda is provided. - - - - - Initializes the match with the condition that - will be checked in order to match invocation - values. - The condition to match against actual values. - - - - - - - - - This method is used to set an expression as the last matcher invoked, - which is used in the SetupSet to allow matchers in the prop = value - delegate expression. This delegate is executed in "fluent" mode in - order to capture the value being set, and construct the corresponding - methodcall. - This is also used in the MatcherFactory for each argument expression. - This method ensures that when we execute the delegate, we - also track the matcher that was invoked, so that when we create the - methodcall we build the expression using it, rather than the null/default - value returned from the actual invocation. - - - - - Allows creation custom value matchers that can be used on setups and verification, - completely replacing the built-in class with your own argument - matching rules. - Type of the value to match. - The argument matching is used to determine whether a concrete - invocation in the mock matches a given setup. This - matching mechanism is fully extensible. - - Creating a custom matcher is straightforward. You just need to create a method - that returns a value from a call to with - your matching condition and optional friendly render expression: - - [Matcher] - public Order IsBigOrder() - { - return Match<Order>.Create( - o => o.GrandTotal >= 5000, - /* a friendly expression to render on failures */ - () => IsBigOrder()); - } - - This method can be used in any mock setup invocation: - - mock.Setup(m => m.Submit(IsBigOrder()).Throws<UnauthorizedAccessException>(); - - At runtime, Moq knows that the return value was a matcher (note that the method MUST be - annotated with the [Matcher] attribute in order to determine this) and - evaluates your predicate with the actual value passed into your predicate. - - Another example might be a case where you want to match a lists of orders - that contains a particular one. You might create matcher like the following: - - - public static class Orders - { - [Matcher] - public static IEnumerable<Order> Contains(Order order) - { - return Match<IEnumerable<Order>>.Create(orders => orders.Contains(order)); - } - } - - Now we can invoke this static method instead of an argument in an - invocation: - - var order = new Order { ... }; - var mock = new Mock<IRepository<Order>>(); - - mock.Setup(x => x.Save(Orders.Contains(order))) - .Throws<ArgumentException>(); - - - - - - Tracks the current mock and interception context. - - - - - Having an active fluent mock context means that the invocation - is being performed in "trial" mode, just to gather the - target method and arguments that need to be matched later - when the actual invocation is made. - - - - - A that returns an empty default value - for non-mockeable types, and mocks for all other types (interfaces and - non-sealed classes) that can be mocked. - - - - - Allows querying the universe of mocks for those that behave - according to the LINQ query specification. - - - This entry-point into Linq to Mocks is the only one in the root Moq - namespace to ease discovery. But to get all the mocking extension - methods on Object, a using of Moq.Linq must be done, so that the - polluting of the intellisense for all objects is an explicit opt-in. - - - - - Access the universe of mocks of the given type, to retrieve those - that behave according to the LINQ query specification. - - The type of the mocked object to query. - - - - Access the universe of mocks of the given type, to retrieve those - that behave according to the LINQ query specification. - - The predicate with the setup expressions. - The type of the mocked object to query. - - - - Creates an mock object of the indicated type. - - The type of the mocked object. - The mocked object created. - - - - Creates an mock object of the indicated type. - - The predicate with the setup expressions. - The type of the mocked object. - The mocked object created. - - - - Creates the mock query with the underlying queriable implementation. - - - - - Wraps the enumerator inside a queryable. - - - - - Method that is turned into the actual call from .Query{T}, to - transform the queryable query into a normal enumerable query. - This method is never used directly by consumers. - - - - - Extension method used to support Linq-like setup properties that are not virtual but do have - a getter and a setter, thereby allowing the use of Linq to Mocks to quickly initialize Dtos too :) - - - - - Helper extensions that are used by the query translator. - - - - - Retrieves a fluent mock from the given setup expression. - - - - - Defines the number of invocations allowed by a mocked method. - - - - - Specifies that a mocked method should be invoked times as minimum. - The minimun number of times.An object defining the allowed number of invocations. - - - - Specifies that a mocked method should be invoked one time as minimum. - An object defining the allowed number of invocations. - - - - Specifies that a mocked method should be invoked time as maximun. - The maximun number of times.An object defining the allowed number of invocations. - - - - Specifies that a mocked method should be invoked one time as maximun. - An object defining the allowed number of invocations. - - - - Specifies that a mocked method should be invoked between and - times. - The minimun number of times.The maximun number of times. - The kind of range. See . - An object defining the allowed number of invocations. - - - - Specifies that a mocked method should be invoked exactly times. - The times that a method or property can be called.An object defining the allowed number of invocations. - - - - Specifies that a mocked method should not be invoked. - An object defining the allowed number of invocations. - - - - Specifies that a mocked method should be invoked exactly one time. - An object defining the allowed number of invocations. - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Returns a hash code for this instance. - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Determines whether two specified objects have the same value. - - The first . - - The second . - - true if the value of left is the same as the value of right; otherwise, false. - - - - - Determines whether two specified objects have different values. - - The first . - - The second . - - true if the value of left is different from the value of right; otherwise, false. - - - - - Interface that is used to build fluent interfaces by hiding methods declared by from IntelliSense. - - - Code that consumes implementations of this interface should expect one of two things: - - When referencing the interface from within the same solution (project reference), you will still see the methods this interface is meant to hide. - When referencing the interface through the compiled output assembly (external reference), the standard Object methods will be hidden as intended. - When using Resharper, be sure to configure it to respect the attribute: Options, go to Environment | IntelliSense | Completion Appearance and check "Filter members by [EditorBrowsable] attribute". - - See https://kzu.github.io/IFluentInterface for more information. - - - - - - Redeclaration that hides the method from IntelliSense. - - - - - Redeclaration that hides the method from IntelliSense. - - - - - Redeclaration that hides the method from IntelliSense. - - - - - Redeclaration that hides the method from IntelliSense. - - - - - - - - - - Provides access to the current assembly information. - - - Provides access to the git information for the current assembly. - - - Branch: master - - - Commit: 44b3fbc - - - Sha: 44b3fbc099d53ce1efc52922a4f6414a57a6426a - - - Commits on top of base version: 8 - - - Tag: - - - Base tag: - - - Provides access to the base version information used to determine the . - - - Major: 4 - - - Minor: 5 - - - Patch: 0 - - - Provides access to SemVer information for the current assembly. - - - Major: 4 - - - Minor: 5 - - - Patch: 8 - - - Label: - - - Label with dash prefix: - - - Source: File - - - diff --git a/packages/NUnitTestAdapter.WithFramework.2.0.0/NUnitTestAdapter.WithFramework.2.0.0.nupkg b/packages/NUnitTestAdapter.WithFramework.2.0.0/NUnitTestAdapter.WithFramework.2.0.0.nupkg deleted file mode 100644 index 1ea18c2..0000000 Binary files a/packages/NUnitTestAdapter.WithFramework.2.0.0/NUnitTestAdapter.WithFramework.2.0.0.nupkg and /dev/null differ diff --git a/packages/NUnitTestAdapter.WithFramework.2.0.0/lib/NUnit.VisualStudio.TestAdapter.dll b/packages/NUnitTestAdapter.WithFramework.2.0.0/lib/NUnit.VisualStudio.TestAdapter.dll deleted file mode 100644 index 0992921..0000000 Binary files a/packages/NUnitTestAdapter.WithFramework.2.0.0/lib/NUnit.VisualStudio.TestAdapter.dll and /dev/null differ diff --git a/packages/NUnitTestAdapter.WithFramework.2.0.0/lib/nunit.core.dll b/packages/NUnitTestAdapter.WithFramework.2.0.0/lib/nunit.core.dll deleted file mode 100644 index 0156d2d..0000000 Binary files a/packages/NUnitTestAdapter.WithFramework.2.0.0/lib/nunit.core.dll and /dev/null differ diff --git a/packages/NUnitTestAdapter.WithFramework.2.0.0/lib/nunit.core.interfaces.dll b/packages/NUnitTestAdapter.WithFramework.2.0.0/lib/nunit.core.interfaces.dll deleted file mode 100644 index 32d9b1f..0000000 Binary files a/packages/NUnitTestAdapter.WithFramework.2.0.0/lib/nunit.core.interfaces.dll and /dev/null differ diff --git a/packages/NUnitTestAdapter.WithFramework.2.0.0/lib/nunit.framework.dll b/packages/NUnitTestAdapter.WithFramework.2.0.0/lib/nunit.framework.dll deleted file mode 100644 index ed6550b..0000000 Binary files a/packages/NUnitTestAdapter.WithFramework.2.0.0/lib/nunit.framework.dll and /dev/null differ diff --git a/packages/NUnitTestAdapter.WithFramework.2.0.0/lib/nunit.framework.xml b/packages/NUnitTestAdapter.WithFramework.2.0.0/lib/nunit.framework.xml deleted file mode 100644 index 7702cee..0000000 --- a/packages/NUnitTestAdapter.WithFramework.2.0.0/lib/nunit.framework.xml +++ /dev/null @@ -1,10899 +0,0 @@ - - - - nunit.framework - - - - - Attribute used to apply a category to a test - - - - - The name of the category - - - - - Construct attribute for a given category based on - a name. The name may not contain the characters ',', - '+', '-' or '!'. However, this is not checked in the - constructor since it would cause an error to arise at - as the test was loaded without giving a clear indication - of where the problem is located. The error is handled - in NUnitFramework.cs by marking the test as not - runnable. - - The name of the category - - - - Protected constructor uses the Type name as the name - of the category. - - - - - The name of the category - - - - - Used to mark a field for use as a datapoint when executing a theory - within the same fixture that requires an argument of the field's Type. - - - - - Used to mark an array as containing a set of datapoints to be used - executing a theory within the same fixture that requires an argument - of the Type of the array elements. - - - - - Attribute used to provide descriptive text about a - test case or fixture. - - - - - Construct the attribute - - Text describing the test - - - - Gets the test description - - - - - Enumeration indicating how the expected message parameter is to be used - - - - Expect an exact match - - - Expect a message containing the parameter string - - - Match the regular expression provided as a parameter - - - Expect a message that starts with the parameter string - - - - ExpectedExceptionAttribute - - - - - - Constructor for a non-specific exception - - - - - Constructor for a given type of exception - - The type of the expected exception - - - - Constructor for a given exception name - - The full name of the expected exception - - - - Gets or sets the expected exception type - - - - - Gets or sets the full Type name of the expected exception - - - - - Gets or sets the expected message text - - - - - Gets or sets the user message displayed in case of failure - - - - - Gets or sets the type of match to be performed on the expected message - - - - - Gets the name of a method to be used as an exception handler - - - - - ExplicitAttribute marks a test or test fixture so that it will - only be run if explicitly executed from the gui or command line - or if it is included by use of a filter. The test will not be - run simply because an enclosing suite is run. - - - - - Default constructor - - - - - Constructor with a reason - - The reason test is marked explicit - - - - The reason test is marked explicit - - - - - Attribute used to mark a test that is to be ignored. - Ignored tests result in a warning message when the - tests are run. - - - - - Constructs the attribute without giving a reason - for ignoring the test. - - - - - Constructs the attribute giving a reason for ignoring the test - - The reason for ignoring the test - - - - The reason for ignoring a test - - - - - Abstract base for Attributes that are used to include tests - in the test run based on environmental settings. - - - - - Constructor with no included items specified, for use - with named property syntax. - - - - - Constructor taking one or more included items - - Comma-delimited list of included items - - - - Name of the item that is needed in order for - a test to run. Multiple itemss may be given, - separated by a comma. - - - - - Name of the item to be excluded. Multiple items - may be given, separated by a comma. - - - - - The reason for including or excluding the test - - - - - PlatformAttribute is used to mark a test fixture or an - individual method as applying to a particular platform only. - - - - - Constructor with no platforms specified, for use - with named property syntax. - - - - - Constructor taking one or more platforms - - Comma-deliminted list of platforms - - - - CultureAttribute is used to mark a test fixture or an - individual method as applying to a particular Culture only. - - - - - Constructor with no cultures specified, for use - with named property syntax. - - - - - Constructor taking one or more cultures - - Comma-deliminted list of cultures - - - - Marks a test to use a combinatorial join of any argument data - provided. NUnit will create a test case for every combination of - the arguments provided. This can result in a large number of test - cases and so should be used judiciously. This is the default join - type, so the attribute need not be used except as documentation. - - - - - PropertyAttribute is used to attach information to a test as a name/value pair.. - - - - - Construct a PropertyAttribute with a name and string value - - The name of the property - The property value - - - - Construct a PropertyAttribute with a name and int value - - The name of the property - The property value - - - - Construct a PropertyAttribute with a name and double value - - The name of the property - The property value - - - - Constructor for derived classes that set the - property dictionary directly. - - - - - Constructor for use by derived classes that use the - name of the type as the property name. Derived classes - must ensure that the Type of the property value is - a standard type supported by the BCL. Any custom - types will cause a serialization Exception when - in the client. - - - - - Gets the property dictionary for this attribute - - - - - Default constructor - - - - - Marks a test to use pairwise join of any argument data provided. - NUnit will attempt too excercise every pair of argument values at - least once, using as small a number of test cases as it can. With - only two arguments, this is the same as a combinatorial join. - - - - - Default constructor - - - - - Marks a test to use a sequential join of any argument data - provided. NUnit will use arguements for each parameter in - sequence, generating test cases up to the largest number - of argument values provided and using null for any arguments - for which it runs out of values. Normally, this should be - used with the same number of arguments for each parameter. - - - - - Default constructor - - - - - Summary description for MaxTimeAttribute. - - - - - Construct a MaxTimeAttribute, given a time in milliseconds. - - The maximum elapsed time in milliseconds - - - - RandomAttribute is used to supply a set of random values - to a single parameter of a parameterized test. - - - - - ValuesAttribute is used to provide literal arguments for - an individual parameter of a test. - - - - - Abstract base class for attributes that apply to parameters - and supply data for the parameter. - - - - - Gets the data to be provided to the specified parameter - - - - - The collection of data to be returned. Must - be set by any derived attribute classes. - We use an object[] so that the individual - elements may have their type changed in GetData - if necessary. - - - - - Construct with one argument - - - - - - Construct with two arguments - - - - - - - Construct with three arguments - - - - - - - - Construct with an array of arguments - - - - - - Get the collection of values to be used as arguments - - - - - Construct a set of doubles from 0.0 to 1.0, - specifying only the count. - - - - - - Construct a set of doubles from min to max - - - - - - - - Construct a set of ints from min to max - - - - - - - - Get the collection of values to be used as arguments - - - - - RangeAttribute is used to supply a range of values to an - individual parameter of a parameterized test. - - - - - Construct a range of ints using default step of 1 - - - - - - - Construct a range of ints specifying the step size - - - - - - - - Construct a range of longs - - - - - - - - Construct a range of doubles - - - - - - - - Construct a range of floats - - - - - - - - RepeatAttribute may be applied to test case in order - to run it multiple times. - - - - - Construct a RepeatAttribute - - The number of times to run the test - - - - RequiredAddinAttribute may be used to indicate the names of any addins - that must be present in order to run some or all of the tests in an - assembly. If the addin is not loaded, the entire assembly is marked - as NotRunnable. - - - - - Initializes a new instance of the class. - - The required addin. - - - - Gets the name of required addin. - - The required addin name. - - - - Summary description for SetCultureAttribute. - - - - - Construct given the name of a culture - - - - - - Summary description for SetUICultureAttribute. - - - - - Construct given the name of a culture - - - - - - SetUpAttribute is used in a TestFixture to identify a method - that is called immediately before each test is run. It is - also used in a SetUpFixture to identify the method that is - called once, before any of the subordinate tests are run. - - - - - Attribute used to mark a class that contains one-time SetUp - and/or TearDown methods that apply to all the tests in a - namespace or an assembly. - - - - - Attribute used to mark a static (shared in VB) property - that returns a list of tests. - - - - - Attribute used in a TestFixture to identify a method that is - called immediately after each test is run. It is also used - in a SetUpFixture to identify the method that is called once, - after all subordinate tests have run. In either case, the method - is guaranteed to be called, even if an exception is thrown. - - - - - Provide actions to execute before and after tests. - - - - - When implemented by an attribute, this interface implemented to provide actions to execute before and after tests. - - - - - Executed before each test is run - - Provides details about the test that is going to be run. - - - - Executed after each test is run - - Provides details about the test that has just been run. - - - - Provides the target for the action attribute - - The target for the action attribute - - - - Adding this attribute to a method within a - class makes the method callable from the NUnit test runner. There is a property - called Description which is optional which you can provide a more detailed test - description. This class cannot be inherited. - - - - [TestFixture] - public class Fixture - { - [Test] - public void MethodToTest() - {} - - [Test(Description = "more detailed description")] - publc void TestDescriptionMethod() - {} - } - - - - - - Descriptive text for this test - - - - - TestCaseAttribute is used to mark parameterized test cases - and provide them with their arguments. - - - - - The ITestCaseData interface is implemented by a class - that is able to return complete testcases for use by - a parameterized test method. - - NOTE: This interface is used in both the framework - and the core, even though that results in two different - types. However, sharing the source code guarantees that - the various implementations will be compatible and that - the core is able to reflect successfully over the - framework implementations of ITestCaseData. - - - - - Gets the argument list to be provided to the test - - - - - Gets the expected result - - - - - Indicates whether a result has been specified. - This is necessary because the result may be - null, so it's value cannot be checked. - - - - - Gets the expected exception Type - - - - - Gets the FullName of the expected exception - - - - - Gets the name to be used for the test - - - - - Gets the description of the test - - - - - Gets a value indicating whether this is ignored. - - true if ignored; otherwise, false. - - - - Gets a value indicating whether this is explicit. - - true if explicit; otherwise, false. - - - - Gets the ignore reason. - - The ignore reason. - - - - Construct a TestCaseAttribute with a list of arguments. - This constructor is not CLS-Compliant - - - - - - Construct a TestCaseAttribute with a single argument - - - - - - Construct a TestCaseAttribute with a two arguments - - - - - - - Construct a TestCaseAttribute with a three arguments - - - - - - - - Gets the list of arguments to a test case - - - - - Gets or sets the expected result. Use - ExpectedResult by preference. - - The result. - - - - Gets or sets the expected result. - - The result. - - - - Gets a flag indicating whether an expected - result has been set. - - - - - Gets a list of categories associated with this test; - - - - - Gets or sets the category associated with this test. - May be a single category or a comma-separated list. - - - - - Gets or sets the expected exception. - - The expected exception. - - - - Gets or sets the name the expected exception. - - The expected name of the exception. - - - - Gets or sets the expected message of the expected exception - - The expected message of the exception. - - - - Gets or sets the type of match to be performed on the expected message - - - - - Gets or sets the description. - - The description. - - - - Gets or sets the name of the test. - - The name of the test. - - - - Gets or sets the ignored status of the test - - - - - Gets or sets the ignored status of the test - - - - - Gets or sets the explicit status of the test - - - - - Gets or sets the reason for not running the test - - - - - Gets or sets the reason for not running the test. - Set has the side effect of marking the test as ignored. - - The ignore reason. - - - - FactoryAttribute indicates the source to be used to - provide test cases for a test method. - - - - - Construct with the name of the data source, which must - be a property, field or method of the test class itself. - - An array of the names of the factories that will provide data - - - - Construct with a Type, which must implement IEnumerable - - The Type that will provide data - - - - Construct with a Type and name. - that don't support params arrays. - - The Type that will provide data - The name of the method, property or field that will provide data - - - - The name of a the method, property or fiend to be used as a source - - - - - A Type to be used as a source - - - - - Gets or sets the category associated with this test. - May be a single category or a comma-separated list. - - - - - [TestFixture] - public class ExampleClass - {} - - - - - Default constructor - - - - - Construct with a object[] representing a set of arguments. - In .NET 2.0, the arguments may later be separated into - type arguments and constructor arguments. - - - - - - Descriptive text for this fixture - - - - - Gets and sets the category for this fixture. - May be a comma-separated list of categories. - - - - - Gets a list of categories for this fixture - - - - - The arguments originally provided to the attribute - - - - - Gets or sets a value indicating whether this should be ignored. - - true if ignore; otherwise, false. - - - - Gets or sets the ignore reason. May set Ignored as a side effect. - - The ignore reason. - - - - Get or set the type arguments. If not set - explicitly, any leading arguments that are - Types are taken as type arguments. - - - - - Attribute used to identify a method that is - called before any tests in a fixture are run. - - - - - Attribute used to identify a method that is called after - all the tests in a fixture have run. The method is - guaranteed to be called, even if an exception is thrown. - - - - - Adding this attribute to a method within a - class makes the method callable from the NUnit test runner. There is a property - called Description which is optional which you can provide a more detailed test - description. This class cannot be inherited. - - - - [TestFixture] - public class Fixture - { - [Test] - public void MethodToTest() - {} - - [Test(Description = "more detailed description")] - publc void TestDescriptionMethod() - {} - } - - - - - - Used on a method, marks the test with a timeout value in milliseconds. - The test will be run in a separate thread and is cancelled if the timeout - is exceeded. Used on a method or assembly, sets the default timeout - for all contained test methods. - - - - - Construct a TimeoutAttribute given a time in milliseconds - - The timeout value in milliseconds - - - - Marks a test that must run in the STA, causing it - to run in a separate thread if necessary. - - On methods, you may also use STAThreadAttribute - to serve the same purpose. - - - - - Construct a RequiresSTAAttribute - - - - - Marks a test that must run in the MTA, causing it - to run in a separate thread if necessary. - - On methods, you may also use MTAThreadAttribute - to serve the same purpose. - - - - - Construct a RequiresMTAAttribute - - - - - Marks a test that must run on a separate thread. - - - - - Construct a RequiresThreadAttribute - - - - - Construct a RequiresThreadAttribute, specifying the apartment - - - - - ValueSourceAttribute indicates the source to be used to - provide data for one parameter of a test method. - - - - - Construct with the name of the factory - for use with languages - that don't support params arrays. - - The name of the data source to be used - - - - Construct with a Type and name - for use with languages - that don't support params arrays. - - The Type that will provide data - The name of the method, property or field that will provide data - - - - The name of a the method, property or fiend to be used as a source - - - - - A Type to be used as a source - - - - - AttributeExistsConstraint tests for the presence of a - specified attribute on a Type. - - - - - The Constraint class is the base of all built-in constraints - within NUnit. It provides the operator overloads used to combine - constraints. - - - - - The IConstraintExpression interface is implemented by all - complete and resolvable constraints and expressions. - - - - - Return the top-level constraint for this expression - - - - - - Static UnsetObject used to detect derived constraints - failing to set the actual value. - - - - - The actual value being tested against a constraint - - - - - The display name of this Constraint for use by ToString() - - - - - Argument fields used by ToString(); - - - - - The builder holding this constraint - - - - - Construct a constraint with no arguments - - - - - Construct a constraint with one argument - - - - - Construct a constraint with two arguments - - - - - Sets the ConstraintBuilder holding this constraint - - - - - Write the failure message to the MessageWriter provided - as an argument. The default implementation simply passes - the constraint and the actual value to the writer, which - then displays the constraint description and the value. - - Constraints that need to provide additional details, - such as where the error occured can override this. - - The MessageWriter on which to display the message - - - - Test whether the constraint is satisfied by a given value - - The value to be tested - True for success, false for failure - - - - Test whether the constraint is satisfied by an - ActualValueDelegate that returns the value to be tested. - The default implementation simply evaluates the delegate - but derived classes may override it to provide for delayed - processing. - - An ActualValueDelegate - True for success, false for failure - - - - Test whether the constraint is satisfied by a given reference. - The default implementation simply dereferences the value but - derived classes may override it to provide for delayed processing. - - A reference to the value to be tested - True for success, false for failure - - - - Write the constraint description to a MessageWriter - - The writer on which the description is displayed - - - - Write the actual value for a failing constraint test to a - MessageWriter. The default implementation simply writes - the raw value of actual, leaving it to the writer to - perform any formatting. - - The writer on which the actual value is displayed - - - - Default override of ToString returns the constraint DisplayName - followed by any arguments within angle brackets. - - - - - - Returns the string representation of this constraint - - - - - This operator creates a constraint that is satisfied only if both - argument constraints are satisfied. - - - - - This operator creates a constraint that is satisfied if either - of the argument constraints is satisfied. - - - - - This operator creates a constraint that is satisfied if the - argument constraint is not satisfied. - - - - - Returns a DelayedConstraint with the specified delay time. - - The delay in milliseconds. - - - - - Returns a DelayedConstraint with the specified delay time - and polling interval. - - The delay in milliseconds. - The interval at which to test the constraint. - - - - - The display name of this Constraint for use by ToString(). - The default value is the name of the constraint with - trailing "Constraint" removed. Derived classes may set - this to another name in their constructors. - - - - - Returns a ConstraintExpression by appending And - to the current constraint. - - - - - Returns a ConstraintExpression by appending And - to the current constraint. - - - - - Returns a ConstraintExpression by appending Or - to the current constraint. - - - - - Class used to detect any derived constraints - that fail to set the actual value in their - Matches override. - - - - - Constructs an AttributeExistsConstraint for a specific attribute Type - - - - - - Tests whether the object provides the expected attribute. - - A Type, MethodInfo, or other ICustomAttributeProvider - True if the expected attribute is present, otherwise false - - - - Writes the description of the constraint to the specified writer - - - - - AttributeConstraint tests that a specified attribute is present - on a Type or other provider and that the value of the attribute - satisfies some other constraint. - - - - - Abstract base class used for prefixes - - - - - The base constraint - - - - - Construct given a base constraint - - - - - - Constructs an AttributeConstraint for a specified attriute - Type and base constraint. - - - - - - - Determines whether the Type or other provider has the - expected attribute and if its value matches the - additional constraint specified. - - - - - Writes a description of the attribute to the specified writer. - - - - - Writes the actual value supplied to the specified writer. - - - - - Returns a string representation of the constraint. - - - - - BasicConstraint is the abstract base for constraints that - perform a simple comparison to a constant value. - - - - - Initializes a new instance of the class. - - The expected. - The description. - - - - Test whether the constraint is satisfied by a given value - - The value to be tested - True for success, false for failure - - - - Write the constraint description to a MessageWriter - - The writer on which the description is displayed - - - - NullConstraint tests that the actual value is null - - - - - Initializes a new instance of the class. - - - - - TrueConstraint tests that the actual value is true - - - - - Initializes a new instance of the class. - - - - - FalseConstraint tests that the actual value is false - - - - - Initializes a new instance of the class. - - - - - NaNConstraint tests that the actual value is a double or float NaN - - - - - Test that the actual value is an NaN - - - - - - - Write the constraint description to a specified writer - - - - - - BinaryConstraint is the abstract base of all constraints - that combine two other constraints in some fashion. - - - - - The first constraint being combined - - - - - The second constraint being combined - - - - - Construct a BinaryConstraint from two other constraints - - The first constraint - The second constraint - - - - AndConstraint succeeds only if both members succeed. - - - - - Create an AndConstraint from two other constraints - - The first constraint - The second constraint - - - - Apply both member constraints to an actual value, succeeding - succeeding only if both of them succeed. - - The actual value - True if the constraints both succeeded - - - - Write a description for this contraint to a MessageWriter - - The MessageWriter to receive the description - - - - Write the actual value for a failing constraint test to a - MessageWriter. The default implementation simply writes - the raw value of actual, leaving it to the writer to - perform any formatting. - - The writer on which the actual value is displayed - - - - OrConstraint succeeds if either member succeeds - - - - - Create an OrConstraint from two other constraints - - The first constraint - The second constraint - - - - Apply the member constraints to an actual value, succeeding - succeeding as soon as one of them succeeds. - - The actual value - True if either constraint succeeded - - - - Write a description for this contraint to a MessageWriter - - The MessageWriter to receive the description - - - - CollectionConstraint is the abstract base class for - constraints that operate on collections. - - - - - Construct an empty CollectionConstraint - - - - - Construct a CollectionConstraint - - - - - - Determines whether the specified enumerable is empty. - - The enumerable. - - true if the specified enumerable is empty; otherwise, false. - - - - - Test whether the constraint is satisfied by a given value - - The value to be tested - True for success, false for failure - - - - Protected method to be implemented by derived classes - - - - - - - CollectionItemsEqualConstraint is the abstract base class for all - collection constraints that apply some notion of item equality - as a part of their operation. - - - - - Construct an empty CollectionConstraint - - - - - Construct a CollectionConstraint - - - - - - Flag the constraint to use the supplied IComparer object. - - The IComparer object to use. - Self. - - - - Flag the constraint to use the supplied IComparer object. - - The IComparer object to use. - Self. - - - - Flag the constraint to use the supplied Comparison object. - - The IComparer object to use. - Self. - - - - Flag the constraint to use the supplied IEqualityComparer object. - - The IComparer object to use. - Self. - - - - Flag the constraint to use the supplied IEqualityComparer object. - - The IComparer object to use. - Self. - - - - Compares two collection members for equality - - - - - Return a new CollectionTally for use in making tests - - The collection to be included in the tally - - - - Flag the constraint to ignore case and return self. - - - - - EmptyCollectionConstraint tests whether a collection is empty. - - - - - Check that the collection is empty - - - - - - - Write the constraint description to a MessageWriter - - - - - - UniqueItemsConstraint tests whether all the items in a - collection are unique. - - - - - Check that all items are unique. - - - - - - - Write a description of this constraint to a MessageWriter - - - - - - CollectionContainsConstraint is used to test whether a collection - contains an expected object as a member. - - - - - Construct a CollectionContainsConstraint - - - - - - Test whether the expected item is contained in the collection - - - - - - - Write a descripton of the constraint to a MessageWriter - - - - - - CollectionEquivalentCOnstraint is used to determine whether two - collections are equivalent. - - - - - Construct a CollectionEquivalentConstraint - - - - - - Test whether two collections are equivalent - - - - - - - Write a description of this constraint to a MessageWriter - - - - - - CollectionSubsetConstraint is used to determine whether - one collection is a subset of another - - - - - Construct a CollectionSubsetConstraint - - The collection that the actual value is expected to be a subset of - - - - Test whether the actual collection is a subset of - the expected collection provided. - - - - - - - Write a description of this constraint to a MessageWriter - - - - - - CollectionOrderedConstraint is used to test whether a collection is ordered. - - - - - Construct a CollectionOrderedConstraint - - - - - Modifies the constraint to use an IComparer and returns self. - - - - - Modifies the constraint to use an IComparer<T> and returns self. - - - - - Modifies the constraint to use a Comparison<T> and returns self. - - - - - Modifies the constraint to test ordering by the value of - a specified property and returns self. - - - - - Test whether the collection is ordered - - - - - - - Write a description of the constraint to a MessageWriter - - - - - - Returns the string representation of the constraint. - - - - - - If used performs a reverse comparison - - - - - CollectionTally counts (tallies) the number of - occurences of each object in one or more enumerations. - - - - - Construct a CollectionTally object from a comparer and a collection - - - - - Try to remove an object from the tally - - The object to remove - True if successful, false if the object was not found - - - - Try to remove a set of objects from the tally - - The objects to remove - True if successful, false if any object was not found - - - - The number of objects remaining in the tally - - - - - ComparisonAdapter class centralizes all comparisons of - values in NUnit, adapting to the use of any provided - IComparer, IComparer<T> or Comparison<T> - - - - - Returns a ComparisonAdapter that wraps an IComparer - - - - - Returns a ComparisonAdapter that wraps an IComparer<T> - - - - - Returns a ComparisonAdapter that wraps a Comparison<T> - - - - - Compares two objects - - - - - Gets the default ComparisonAdapter, which wraps an - NUnitComparer object. - - - - - Construct a ComparisonAdapter for an IComparer - - - - - Compares two objects - - - - - - - - Construct a default ComparisonAdapter - - - - - ComparisonAdapter<T> extends ComparisonAdapter and - allows use of an IComparer<T> or Comparison<T> - to actually perform the comparison. - - - - - Construct a ComparisonAdapter for an IComparer<T> - - - - - Compare a Type T to an object - - - - - Construct a ComparisonAdapter for a Comparison<T> - - - - - Compare a Type T to an object - - - - - Abstract base class for constraints that compare values to - determine if one is greater than, equal to or less than - the other. This class supplies the Using modifiers. - - - - - ComparisonAdapter to be used in making the comparison - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - Modifies the constraint to use an IComparer and returns self - - - - - Modifies the constraint to use an IComparer<T> and returns self - - - - - Modifies the constraint to use a Comparison<T> and returns self - - - - - Delegate used to delay evaluation of the actual value - to be used in evaluating a constraint - - - - - ConstraintBuilder maintains the stacks that are used in - processing a ConstraintExpression. An OperatorStack - is used to hold operators that are waiting for their - operands to be reognized. a ConstraintStack holds - input constraints as well as the results of each - operator applied. - - - - - Initializes a new instance of the class. - - - - - Appends the specified operator to the expression by first - reducing the operator stack and then pushing the new - operator on the stack. - - The operator to push. - - - - Appends the specified constraint to the expresson by pushing - it on the constraint stack. - - The constraint to push. - - - - Sets the top operator right context. - - The right context. - - - - Reduces the operator stack until the topmost item - precedence is greater than or equal to the target precedence. - - The target precedence. - - - - Resolves this instance, returning a Constraint. If the builder - is not currently in a resolvable state, an exception is thrown. - - The resolved constraint - - - - Gets a value indicating whether this instance is resolvable. - - - true if this instance is resolvable; otherwise, false. - - - - - OperatorStack is a type-safe stack for holding ConstraintOperators - - - - - Initializes a new instance of the class. - - The builder. - - - - Pushes the specified operator onto the stack. - - The op. - - - - Pops the topmost operator from the stack. - - - - - - Gets a value indicating whether this is empty. - - true if empty; otherwise, false. - - - - Gets the topmost operator without modifying the stack. - - The top. - - - - ConstraintStack is a type-safe stack for holding Constraints - - - - - Initializes a new instance of the class. - - The builder. - - - - Pushes the specified constraint. As a side effect, - the constraint's builder field is set to the - ConstraintBuilder owning this stack. - - The constraint. - - - - Pops this topmost constrait from the stack. - As a side effect, the constraint's builder - field is set to null. - - - - - - Gets a value indicating whether this is empty. - - true if empty; otherwise, false. - - - - Gets the topmost constraint without modifying the stack. - - The topmost constraint - - - - ConstraintExpression represents a compound constraint in the - process of being constructed from a series of syntactic elements. - - Individual elements are appended to the expression as they are - reognized. Once an actual Constraint is appended, the expression - returns a resolvable Constraint. - - - - - ConstraintExpressionBase is the abstract base class for the - ConstraintExpression class, which represents a - compound constraint in the process of being constructed - from a series of syntactic elements. - - NOTE: ConstraintExpressionBase is separate because the - ConstraintExpression class was generated in earlier - versions of NUnit. The two classes may be combined - in a future version. - - - - - The ConstraintBuilder holding the elements recognized so far - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the - class passing in a ConstraintBuilder, which may be pre-populated. - - The builder. - - - - Returns a string representation of the expression as it - currently stands. This should only be used for testing, - since it has the side-effect of resolving the expression. - - - - - - Appends an operator to the expression and returns the - resulting expression itself. - - - - - Appends a self-resolving operator to the expression and - returns a new ResolvableConstraintExpression. - - - - - Appends a constraint to the expression and returns that - constraint, which is associated with the current state - of the expression being built. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the - class passing in a ConstraintBuilder, which may be pre-populated. - - The builder. - - - - Returns a ConstraintExpression, which will apply - the following constraint to all members of a collection, - succeeding only if a specified number of them succeed. - - - - - Returns a new PropertyConstraintExpression, which will either - test for the existence of the named property on the object - being tested or apply any following constraint to that property. - - - - - Returns a new AttributeConstraint checking for the - presence of a particular attribute on an object. - - - - - Returns a new AttributeConstraint checking for the - presence of a particular attribute on an object. - - - - - Returns the constraint provided as an argument - used to allow custom - custom constraints to easily participate in the syntax. - - - - - Returns the constraint provided as an argument - used to allow custom - custom constraints to easily participate in the syntax. - - - - - Returns a constraint that tests two items for equality - - - - - Returns a constraint that tests that two references are the same object - - - - - Returns a constraint that tests whether the - actual value is greater than the suppled argument - - - - - Returns a constraint that tests whether the - actual value is greater than or equal to the suppled argument - - - - - Returns a constraint that tests whether the - actual value is greater than or equal to the suppled argument - - - - - Returns a constraint that tests whether the - actual value is less than the suppled argument - - - - - Returns a constraint that tests whether the - actual value is less than or equal to the suppled argument - - - - - Returns a constraint that tests whether the - actual value is less than or equal to the suppled argument - - - - - Returns a constraint that tests whether the actual - value is of the exact type supplied as an argument. - - - - - Returns a constraint that tests whether the actual - value is of the exact type supplied as an argument. - - - - - Returns a constraint that tests whether the actual value - is of the type supplied as an argument or a derived type. - - - - - Returns a constraint that tests whether the actual value - is of the type supplied as an argument or a derived type. - - - - - Returns a constraint that tests whether the actual value - is of the type supplied as an argument or a derived type. - - - - - Returns a constraint that tests whether the actual value - is of the type supplied as an argument or a derived type. - - - - - Returns a constraint that tests whether the actual value - is assignable from the type supplied as an argument. - - - - - Returns a constraint that tests whether the actual value - is assignable from the type supplied as an argument. - - - - - Returns a constraint that tests whether the actual value - is assignable from the type supplied as an argument. - - - - - Returns a constraint that tests whether the actual value - is assignable from the type supplied as an argument. - - - - - Returns a constraint that tests whether the actual value - is a collection containing the same elements as the - collection supplied as an argument. - - - - - Returns a constraint that tests whether the actual value - is a subset of the collection supplied as an argument. - - - - - Returns a new CollectionContainsConstraint checking for the - presence of a particular object in the collection. - - - - - Returns a new CollectionContainsConstraint checking for the - presence of a particular object in the collection. - - - - - Returns a new ContainsConstraint. This constraint - will, in turn, make use of the appropriate second-level - constraint, depending on the type of the actual argument. - This overload is only used if the item sought is a string, - since any other type implies that we are looking for a - collection member. - - - - - Returns a constraint that succeeds if the actual - value contains the substring supplied as an argument. - - - - - Returns a constraint that succeeds if the actual - value contains the substring supplied as an argument. - - - - - Returns a constraint that succeeds if the actual - value starts with the substring supplied as an argument. - - - - - Returns a constraint that succeeds if the actual - value starts with the substring supplied as an argument. - - - - - Returns a constraint that succeeds if the actual - value ends with the substring supplied as an argument. - - - - - Returns a constraint that succeeds if the actual - value ends with the substring supplied as an argument. - - - - - Returns a constraint that succeeds if the actual - value matches the Regex pattern supplied as an argument. - - - - - Returns a constraint that succeeds if the actual - value matches the Regex pattern supplied as an argument. - - - - - Returns a constraint that tests whether the path provided - is the same as an expected path after canonicalization. - - - - - Returns a constraint that tests whether the path provided - is the same path or under an expected path after canonicalization. - - - - - Returns a constraint that tests whether the path provided - is the same path or under an expected path after canonicalization. - - - - - Returns a constraint that tests whether the actual value falls - within a specified range. - - - - - Returns a ConstraintExpression that negates any - following constraint. - - - - - Returns a ConstraintExpression that negates any - following constraint. - - - - - Returns a ConstraintExpression, which will apply - the following constraint to all members of a collection, - succeeding if all of them succeed. - - - - - Returns a ConstraintExpression, which will apply - the following constraint to all members of a collection, - succeeding if at least one of them succeeds. - - - - - Returns a ConstraintExpression, which will apply - the following constraint to all members of a collection, - succeeding if all of them fail. - - - - - Returns a new ConstraintExpression, which will apply the following - constraint to the Length property of the object being tested. - - - - - Returns a new ConstraintExpression, which will apply the following - constraint to the Count property of the object being tested. - - - - - Returns a new ConstraintExpression, which will apply the following - constraint to the Message property of the object being tested. - - - - - Returns a new ConstraintExpression, which will apply the following - constraint to the InnerException property of the object being tested. - - - - - With is currently a NOP - reserved for future use. - - - - - Returns a constraint that tests for null - - - - - Returns a constraint that tests for True - - - - - Returns a constraint that tests for False - - - - - Returns a constraint that tests for a positive value - - - - - Returns a constraint that tests for a negative value - - - - - Returns a constraint that tests for NaN - - - - - Returns a constraint that tests for empty - - - - - Returns a constraint that tests whether a collection - contains all unique items. - - - - - Returns a constraint that tests whether an object graph is serializable in binary format. - - - - - Returns a constraint that tests whether an object graph is serializable in xml format. - - - - - Returns a constraint that tests whether a collection is ordered - - - - - Helper class with properties and methods that supply - a number of constraints used in Asserts. - - - - - Returns a ConstraintExpression, which will apply - the following constraint to all members of a collection, - succeeding only if a specified number of them succeed. - - - - - Returns a new PropertyConstraintExpression, which will either - test for the existence of the named property on the object - being tested or apply any following constraint to that property. - - - - - Returns a new AttributeConstraint checking for the - presence of a particular attribute on an object. - - - - - Returns a new AttributeConstraint checking for the - presence of a particular attribute on an object. - - - - - Returns a constraint that tests two items for equality - - - - - Returns a constraint that tests that two references are the same object - - - - - Returns a constraint that tests whether the - actual value is greater than the suppled argument - - - - - Returns a constraint that tests whether the - actual value is greater than or equal to the suppled argument - - - - - Returns a constraint that tests whether the - actual value is greater than or equal to the suppled argument - - - - - Returns a constraint that tests whether the - actual value is less than the suppled argument - - - - - Returns a constraint that tests whether the - actual value is less than or equal to the suppled argument - - - - - Returns a constraint that tests whether the - actual value is less than or equal to the suppled argument - - - - - Returns a constraint that tests whether the actual - value is of the exact type supplied as an argument. - - - - - Returns a constraint that tests whether the actual - value is of the exact type supplied as an argument. - - - - - Returns a constraint that tests whether the actual value - is of the type supplied as an argument or a derived type. - - - - - Returns a constraint that tests whether the actual value - is of the type supplied as an argument or a derived type. - - - - - Returns a constraint that tests whether the actual value - is of the type supplied as an argument or a derived type. - - - - - Returns a constraint that tests whether the actual value - is of the type supplied as an argument or a derived type. - - - - - Returns a constraint that tests whether the actual value - is assignable from the type supplied as an argument. - - - - - Returns a constraint that tests whether the actual value - is assignable from the type supplied as an argument. - - - - - Returns a constraint that tests whether the actual value - is assignable from the type supplied as an argument. - - - - - Returns a constraint that tests whether the actual value - is assignable from the type supplied as an argument. - - - - - Returns a constraint that tests whether the actual value - is a collection containing the same elements as the - collection supplied as an argument. - - - - - Returns a constraint that tests whether the actual value - is a subset of the collection supplied as an argument. - - - - - Returns a new CollectionContainsConstraint checking for the - presence of a particular object in the collection. - - - - - Returns a new CollectionContainsConstraint checking for the - presence of a particular object in the collection. - - - - - Returns a new ContainsConstraint. This constraint - will, in turn, make use of the appropriate second-level - constraint, depending on the type of the actual argument. - This overload is only used if the item sought is a string, - since any other type implies that we are looking for a - collection member. - - - - - Returns a constraint that succeeds if the actual - value contains the substring supplied as an argument. - - - - - Returns a constraint that succeeds if the actual - value contains the substring supplied as an argument. - - - - - Returns a constraint that fails if the actual - value contains the substring supplied as an argument. - - - - - Returns a constraint that succeeds if the actual - value starts with the substring supplied as an argument. - - - - - Returns a constraint that succeeds if the actual - value starts with the substring supplied as an argument. - - - - - Returns a constraint that fails if the actual - value starts with the substring supplied as an argument. - - - - - Returns a constraint that succeeds if the actual - value ends with the substring supplied as an argument. - - - - - Returns a constraint that succeeds if the actual - value ends with the substring supplied as an argument. - - - - - Returns a constraint that fails if the actual - value ends with the substring supplied as an argument. - - - - - Returns a constraint that succeeds if the actual - value matches the Regex pattern supplied as an argument. - - - - - Returns a constraint that succeeds if the actual - value matches the Regex pattern supplied as an argument. - - - - - Returns a constraint that fails if the actual - value matches the pattern supplied as an argument. - - - - - Returns a constraint that tests whether the path provided - is the same as an expected path after canonicalization. - - - - - Returns a constraint that tests whether the path provided - is the same path or under an expected path after canonicalization. - - - - - Returns a constraint that tests whether the path provided - is the same path or under an expected path after canonicalization. - - - - - Returns a constraint that tests whether the actual value falls - within a specified range. - - - - - Returns a ConstraintExpression that negates any - following constraint. - - - - - Returns a ConstraintExpression that negates any - following constraint. - - - - - Returns a ConstraintExpression, which will apply - the following constraint to all members of a collection, - succeeding if all of them succeed. - - - - - Returns a ConstraintExpression, which will apply - the following constraint to all members of a collection, - succeeding if at least one of them succeeds. - - - - - Returns a ConstraintExpression, which will apply - the following constraint to all members of a collection, - succeeding if all of them fail. - - - - - Returns a new ConstraintExpression, which will apply the following - constraint to the Length property of the object being tested. - - - - - Returns a new ConstraintExpression, which will apply the following - constraint to the Count property of the object being tested. - - - - - Returns a new ConstraintExpression, which will apply the following - constraint to the Message property of the object being tested. - - - - - Returns a new ConstraintExpression, which will apply the following - constraint to the InnerException property of the object being tested. - - - - - Returns a constraint that tests for null - - - - - Returns a constraint that tests for True - - - - - Returns a constraint that tests for False - - - - - Returns a constraint that tests for a positive value - - - - - Returns a constraint that tests for a negative value - - - - - Returns a constraint that tests for NaN - - - - - Returns a constraint that tests for empty - - - - - Returns a constraint that tests whether a collection - contains all unique items. - - - - - Returns a constraint that tests whether an object graph is serializable in binary format. - - - - - Returns a constraint that tests whether an object graph is serializable in xml format. - - - - - Returns a constraint that tests whether a collection is ordered - - - - - The ConstraintOperator class is used internally by a - ConstraintBuilder to represent an operator that - modifies or combines constraints. - - Constraint operators use left and right precedence - values to determine whether the top operator on the - stack should be reduced before pushing a new operator. - - - - - The precedence value used when the operator - is about to be pushed to the stack. - - - - - The precedence value used when the operator - is on the top of the stack. - - - - - Reduce produces a constraint from the operator and - any arguments. It takes the arguments from the constraint - stack and pushes the resulting constraint on it. - - - - - - The syntax element preceding this operator - - - - - The syntax element folowing this operator - - - - - The precedence value used when the operator - is about to be pushed to the stack. - - - - - The precedence value used when the operator - is on the top of the stack. - - - - - PrefixOperator takes a single constraint and modifies - it's action in some way. - - - - - Reduce produces a constraint from the operator and - any arguments. It takes the arguments from the constraint - stack and pushes the resulting constraint on it. - - - - - - Returns the constraint created by applying this - prefix to another constraint. - - - - - - - Negates the test of the constraint it wraps. - - - - - Constructs a new NotOperator - - - - - Returns a NotConstraint applied to its argument. - - - - - Abstract base for operators that indicate how to - apply a constraint to items in a collection. - - - - - Constructs a CollectionOperator - - - - - Represents a constraint that succeeds if all the - members of a collection match a base constraint. - - - - - Returns a constraint that will apply the argument - to the members of a collection, succeeding if - they all succeed. - - - - - Represents a constraint that succeeds if any of the - members of a collection match a base constraint. - - - - - Returns a constraint that will apply the argument - to the members of a collection, succeeding if - any of them succeed. - - - - - Represents a constraint that succeeds if none of the - members of a collection match a base constraint. - - - - - Returns a constraint that will apply the argument - to the members of a collection, succeeding if - none of them succeed. - - - - - Represents a constraint that succeeds if the specified - count of members of a collection match a base constraint. - - - - - Construct an ExactCountOperator for a specified count - - The expected count - - - - Returns a constraint that will apply the argument - to the members of a collection, succeeding if - none of them succeed. - - - - - Represents a constraint that simply wraps the - constraint provided as an argument, without any - further functionality, but which modifes the - order of evaluation because of its precedence. - - - - - Constructor for the WithOperator - - - - - Returns a constraint that wraps its argument - - - - - Abstract base class for operators that are able to reduce to a - constraint whether or not another syntactic element follows. - - - - - Operator used to test for the presence of a named Property - on an object and optionally apply further tests to the - value of that property. - - - - - Constructs a PropOperator for a particular named property - - - - - Reduce produces a constraint from the operator and - any arguments. It takes the arguments from the constraint - stack and pushes the resulting constraint on it. - - - - - - Gets the name of the property to which the operator applies - - - - - Operator that tests for the presence of a particular attribute - on a type and optionally applies further tests to the attribute. - - - - - Construct an AttributeOperator for a particular Type - - The Type of attribute tested - - - - Reduce produces a constraint from the operator and - any arguments. It takes the arguments from the constraint - stack and pushes the resulting constraint on it. - - - - - Operator that tests that an exception is thrown and - optionally applies further tests to the exception. - - - - - Construct a ThrowsOperator - - - - - Reduce produces a constraint from the operator and - any arguments. It takes the arguments from the constraint - stack and pushes the resulting constraint on it. - - - - - Abstract base class for all binary operators - - - - - Reduce produces a constraint from the operator and - any arguments. It takes the arguments from the constraint - stack and pushes the resulting constraint on it. - - - - - - Abstract method that produces a constraint by applying - the operator to its left and right constraint arguments. - - - - - Gets the left precedence of the operator - - - - - Gets the right precedence of the operator - - - - - Operator that requires both it's arguments to succeed - - - - - Construct an AndOperator - - - - - Apply the operator to produce an AndConstraint - - - - - Operator that requires at least one of it's arguments to succeed - - - - - Construct an OrOperator - - - - - Apply the operator to produce an OrConstraint - - - - - ContainsConstraint tests a whether a string contains a substring - or a collection contains an object. It postpones the decision of - which test to use until the type of the actual argument is known. - This allows testing whether a string is contained in a collection - or as a substring of another string using the same syntax. - - - - - Initializes a new instance of the class. - - The expected. - - - - Test whether the constraint is satisfied by a given value - - The value to be tested - True for success, false for failure - - - - Write the constraint description to a MessageWriter - - The writer on which the description is displayed - - - - Flag the constraint to use the supplied IComparer object. - - The IComparer object to use. - Self. - - - - Flag the constraint to use the supplied IComparer object. - - The IComparer object to use. - Self. - - - - Flag the constraint to use the supplied Comparison object. - - The IComparer object to use. - Self. - - - - Flag the constraint to use the supplied IEqualityComparer object. - - The IComparer object to use. - Self. - - - - Flag the constraint to use the supplied IEqualityComparer object. - - The IComparer object to use. - Self. - - - - Flag the constraint to ignore case and return self. - - - - - Applies a delay to the match so that a match can be evaluated in the future. - - - - - Creates a new DelayedConstraint - - The inner constraint two decorate - The time interval after which the match is performed - If the value of is less than 0 - - - - Creates a new DelayedConstraint - - The inner constraint two decorate - The time interval after which the match is performed - The time interval used for polling - If the value of is less than 0 - - - - Test whether the constraint is satisfied by a given value - - The value to be tested - True for if the base constraint fails, false if it succeeds - - - - Test whether the constraint is satisfied by a delegate - - The delegate whose value is to be tested - True for if the base constraint fails, false if it succeeds - - - - Test whether the constraint is satisfied by a given reference. - Overridden to wait for the specified delay period before - calling the base constraint with the dereferenced value. - - A reference to the value to be tested - True for success, false for failure - - - - Write the constraint description to a MessageWriter - - The writer on which the description is displayed - - - - Write the actual value for a failing constraint test to a MessageWriter. - - The writer on which the actual value is displayed - - - - Returns the string representation of the constraint. - - - - - EmptyDirectoryConstraint is used to test that a directory is empty - - - - - Test whether the constraint is satisfied by a given value - - The value to be tested - True for success, false for failure - - - - Write the constraint description to a MessageWriter - - The writer on which the description is displayed - - - - Write the actual value for a failing constraint test to a - MessageWriter. The default implementation simply writes - the raw value of actual, leaving it to the writer to - perform any formatting. - - The writer on which the actual value is displayed - - - - EmptyConstraint tests a whether a string or collection is empty, - postponing the decision about which test is applied until the - type of the actual argument is known. - - - - - Test whether the constraint is satisfied by a given value - - The value to be tested - True for success, false for failure - - - - Write the constraint description to a MessageWriter - - The writer on which the description is displayed - - - - EqualConstraint is able to compare an actual value with the - expected value provided in its constructor. Two objects are - considered equal if both are null, or if both have the same - value. NUnit has special semantics for some object types. - - - - - If true, strings in error messages will be clipped - - - - - NUnitEqualityComparer used to test equality. - - - - - Initializes a new instance of the class. - - The expected value. - - - - Flag the constraint to use a tolerance when determining equality. - - Tolerance value to be used - Self. - - - - Flag the constraint to use the supplied IComparer object. - - The IComparer object to use. - Self. - - - - Flag the constraint to use the supplied IComparer object. - - The IComparer object to use. - Self. - - - - Flag the constraint to use the supplied IComparer object. - - The IComparer object to use. - Self. - - - - Flag the constraint to use the supplied Comparison object. - - The IComparer object to use. - Self. - - - - Flag the constraint to use the supplied IEqualityComparer object. - - The IComparer object to use. - Self. - - - - Flag the constraint to use the supplied IEqualityComparer object. - - The IComparer object to use. - Self. - - - - Test whether the constraint is satisfied by a given value - - The value to be tested - True for success, false for failure - - - - Write a failure message. Overridden to provide custom - failure messages for EqualConstraint. - - The MessageWriter to write to - - - - Write description of this constraint - - The MessageWriter to write to - - - - Display the failure information for two collections that did not match. - - The MessageWriter on which to display - The expected collection. - The actual collection - The depth of this failure in a set of nested collections - - - - Displays a single line showing the types and sizes of the expected - and actual enumerations, collections or arrays. If both are identical, - the value is only shown once. - - The MessageWriter on which to display - The expected collection or array - The actual collection or array - The indentation level for the message line - - - - Displays a single line showing the point in the expected and actual - arrays at which the comparison failed. If the arrays have different - structures or dimensions, both values are shown. - - The MessageWriter on which to display - The expected array - The actual array - Index of the failure point in the underlying collections - The indentation level for the message line - - - - Display the failure information for two IEnumerables that did not match. - - The MessageWriter on which to display - The expected enumeration. - The actual enumeration - The depth of this failure in a set of nested collections - - - - Flag the constraint to ignore case and return self. - - - - - Flag the constraint to suppress string clipping - and return self. - - - - - Flag the constraint to compare arrays as collections - and return self. - - - - - Switches the .Within() modifier to interpret its tolerance as - a distance in representable values (see remarks). - - Self. - - Ulp stands for "unit in the last place" and describes the minimum - amount a given value can change. For any integers, an ulp is 1 whole - digit. For floating point values, the accuracy of which is better - for smaller numbers and worse for larger numbers, an ulp depends - on the size of the number. Using ulps for comparison of floating - point results instead of fixed tolerances is safer because it will - automatically compensate for the added inaccuracy of larger numbers. - - - - - Switches the .Within() modifier to interpret its tolerance as - a percentage that the actual values is allowed to deviate from - the expected value. - - Self - - - - Causes the tolerance to be interpreted as a TimeSpan in days. - - Self - - - - Causes the tolerance to be interpreted as a TimeSpan in hours. - - Self - - - - Causes the tolerance to be interpreted as a TimeSpan in minutes. - - Self - - - - Causes the tolerance to be interpreted as a TimeSpan in seconds. - - Self - - - - Causes the tolerance to be interpreted as a TimeSpan in milliseconds. - - Self - - - - Causes the tolerance to be interpreted as a TimeSpan in clock ticks. - - Self - - - - EqualityAdapter class handles all equality comparisons - that use an IEqualityComparer, IEqualityComparer<T> - or a ComparisonAdapter. - - - - - Compares two objects, returning true if they are equal - - - - - Returns true if the two objects can be compared by this adapter. - The base adapter cannot handle IEnumerables except for strings. - - - - - Returns an EqualityAdapter that wraps an IComparer. - - - - - Returns an EqualityAdapter that wraps an IEqualityComparer. - - - - - Returns an EqualityAdapter that wraps an IEqualityComparer<T>. - - - - - Returns an EqualityAdapter that wraps an IComparer<T>. - - - - - Returns an EqualityAdapter that wraps a Comparison<T>. - - - - - EqualityAdapter that wraps an IComparer. - - - - - Returns true if the two objects can be compared by this adapter. - Generic adapter requires objects of the specified type. - - - - - EqualityAdapter that wraps an IComparer. - - - - Helper routines for working with floating point numbers - - - The floating point comparison code is based on this excellent article: - http://www.cygnus-software.com/papers/comparingfloats/comparingfloats.htm - - - "ULP" means Unit in the Last Place and in the context of this library refers to - the distance between two adjacent floating point numbers. IEEE floating point - numbers can only represent a finite subset of natural numbers, with greater - accuracy for smaller numbers and lower accuracy for very large numbers. - - - If a comparison is allowed "2 ulps" of deviation, that means the values are - allowed to deviate by up to 2 adjacent floating point values, which might be - as low as 0.0000001 for small numbers or as high as 10.0 for large numbers. - - - - - Compares two floating point values for equality - First floating point value to be compared - Second floating point value t be compared - - Maximum number of representable floating point values that are allowed to - be between the left and the right floating point values - - True if both numbers are equal or close to being equal - - - Floating point values can only represent a finite subset of natural numbers. - For example, the values 2.00000000 and 2.00000024 can be stored in a float, - but nothing inbetween them. - - - This comparison will count how many possible floating point values are between - the left and the right number. If the number of possible values between both - numbers is less than or equal to maxUlps, then the numbers are considered as - being equal. - - - Implementation partially follows the code outlined here: - http://www.anttirt.net/2007/08/19/proper-floating-point-comparisons/ - - - - - Compares two double precision floating point values for equality - First double precision floating point value to be compared - Second double precision floating point value t be compared - - Maximum number of representable double precision floating point values that are - allowed to be between the left and the right double precision floating point values - - True if both numbers are equal or close to being equal - - - Double precision floating point values can only represent a limited series of - natural numbers. For example, the values 2.0000000000000000 and 2.0000000000000004 - can be stored in a double, but nothing inbetween them. - - - This comparison will count how many possible double precision floating point - values are between the left and the right number. If the number of possible - values between both numbers is less than or equal to maxUlps, then the numbers - are considered as being equal. - - - Implementation partially follows the code outlined here: - http://www.anttirt.net/2007/08/19/proper-floating-point-comparisons/ - - - - - - Reinterprets the memory contents of a floating point value as an integer value - - - Floating point value whose memory contents to reinterpret - - - The memory contents of the floating point value interpreted as an integer - - - - - Reinterprets the memory contents of a double precision floating point - value as an integer value - - - Double precision floating point value whose memory contents to reinterpret - - - The memory contents of the double precision floating point value - interpreted as an integer - - - - - Reinterprets the memory contents of an integer as a floating point value - - Integer value whose memory contents to reinterpret - - The memory contents of the integer value interpreted as a floating point value - - - - - Reinterprets the memory contents of an integer value as a double precision - floating point value - - Integer whose memory contents to reinterpret - - The memory contents of the integer interpreted as a double precision - floating point value - - - - Union of a floating point variable and an integer - - - The union's value as a floating point variable - - - The union's value as an integer - - - The union's value as an unsigned integer - - - Union of a double precision floating point variable and a long - - - The union's value as a double precision floating point variable - - - The union's value as a long - - - The union's value as an unsigned long - - - - Tests whether a value is greater than the value supplied to its constructor - - - - - The value against which a comparison is to be made - - - - - Initializes a new instance of the class. - - The expected value. - - - - Write the constraint description to a MessageWriter - - The writer on which the description is displayed - - - - Test whether the constraint is satisfied by a given value - - The value to be tested - True for success, false for failure - - - - Tests whether a value is greater than or equal to the value supplied to its constructor - - - - - The value against which a comparison is to be made - - - - - Initializes a new instance of the class. - - The expected value. - - - - Write the constraint description to a MessageWriter - - The writer on which the description is displayed - - - - Test whether the constraint is satisfied by a given value - - The value to be tested - True for success, false for failure - - - - Tests whether a value is less than the value supplied to its constructor - - - - - The value against which a comparison is to be made - - - - - Initializes a new instance of the class. - - The expected value. - - - - Write the constraint description to a MessageWriter - - The writer on which the description is displayed - - - - Test whether the constraint is satisfied by a given value - - The value to be tested - True for success, false for failure - - - - Tests whether a value is less than or equal to the value supplied to its constructor - - - - - The value against which a comparison is to be made - - - - - Initializes a new instance of the class. - - The expected value. - - - - Write the constraint description to a MessageWriter - - The writer on which the description is displayed - - - - Test whether the constraint is satisfied by a given value - - The value to be tested - True for success, false for failure - - - - MessageWriter is the abstract base for classes that write - constraint descriptions and messages in some form. The - class has separate methods for writing various components - of a message, allowing implementations to tailor the - presentation as needed. - - - - - Construct a MessageWriter given a culture - - - - - Method to write single line message with optional args, usually - written to precede the general failure message. - - The message to be written - Any arguments used in formatting the message - - - - Method to write single line message with optional args, usually - written to precede the general failure message, at a givel - indentation level. - - The indentation level of the message - The message to be written - Any arguments used in formatting the message - - - - Display Expected and Actual lines for a constraint. This - is called by MessageWriter's default implementation of - WriteMessageTo and provides the generic two-line display. - - The constraint that failed - - - - Display Expected and Actual lines for given values. This - method may be called by constraints that need more control over - the display of actual and expected values than is provided - by the default implementation. - - The expected value - The actual value causing the failure - - - - Display Expected and Actual lines for given values, including - a tolerance value on the Expected line. - - The expected value - The actual value causing the failure - The tolerance within which the test was made - - - - Display the expected and actual string values on separate lines. - If the mismatch parameter is >=0, an additional line is displayed - line containing a caret that points to the mismatch point. - - The expected string value - The actual string value - The point at which the strings don't match or -1 - If true, case is ignored in locating the point where the strings differ - If true, the strings should be clipped to fit the line - - - - Writes the text for a connector. - - The connector. - - - - Writes the text for a predicate. - - The predicate. - - - - Writes the text for an expected value. - - The expected value. - - - - Writes the text for a modifier - - The modifier. - - - - Writes the text for an actual value. - - The actual value. - - - - Writes the text for a generalized value. - - The value. - - - - Writes the text for a collection value, - starting at a particular point, to a max length - - The collection containing elements to write. - The starting point of the elements to write - The maximum number of elements to write - - - - Abstract method to get the max line length - - - - - Static methods used in creating messages - - - - - Static string used when strings are clipped - - - - - Returns the representation of a type as used in NUnitLite. - This is the same as Type.ToString() except for arrays, - which are displayed with their declared sizes. - - - - - - - Converts any control characters in a string - to their escaped representation. - - The string to be converted - The converted string - - - - Return the a string representation for a set of indices into an array - - Array of indices for which a string is needed - - - - Get an array of indices representing the point in a enumerable, - collection or array corresponding to a single int index into the - collection. - - The collection to which the indices apply - Index in the collection - Array of indices - - - - Clip a string to a given length, starting at a particular offset, returning the clipped - string with ellipses representing the removed parts - - The string to be clipped - The maximum permitted length of the result string - The point at which to start clipping - The clipped string - - - - Clip the expected and actual strings in a coordinated fashion, - so that they may be displayed together. - - - - - - - - - Shows the position two strings start to differ. Comparison - starts at the start index. - - The expected string - The actual string - The index in the strings at which comparison should start - Boolean indicating whether case should be ignored - -1 if no mismatch found, or the index where mismatch found - - - - The Numerics class contains common operations on numeric values. - - - - - Checks the type of the object, returning true if - the object is a numeric type. - - The object to check - true if the object is a numeric type - - - - Checks the type of the object, returning true if - the object is a floating point numeric type. - - The object to check - true if the object is a floating point numeric type - - - - Checks the type of the object, returning true if - the object is a fixed point numeric type. - - The object to check - true if the object is a fixed point numeric type - - - - Test two numeric values for equality, performing the usual numeric - conversions and using a provided or default tolerance. If the tolerance - provided is Empty, this method may set it to a default tolerance. - - The expected value - The actual value - A reference to the tolerance in effect - True if the values are equal - - - - Compare two numeric values, performing the usual numeric conversions. - - The expected value - The actual value - The relationship of the values to each other - - - - NUnitComparer encapsulates NUnit's default behavior - in comparing two objects. - - - - - Compares two objects - - - - - - - - Returns the default NUnitComparer. - - - - - Generic version of NUnitComparer - - - - - - Compare two objects of the same type - - - - - NUnitEqualityComparer encapsulates NUnit's handling of - equality tests between objects. - - - - - - - - - - Compares two objects for equality within a tolerance - - The first object to compare - The second object to compare - The tolerance to use in the comparison - - - - - If true, all string comparisons will ignore case - - - - - If true, arrays will be treated as collections, allowing - those of different dimensions to be compared - - - - - Comparison objects used in comparisons for some constraints. - - - - - Compares two objects for equality within a tolerance. - - - - - Helper method to compare two arrays - - - - - Method to compare two DirectoryInfo objects - - first directory to compare - second directory to compare - true if equivalent, false if not - - - - Returns the default NUnitEqualityComparer - - - - - Gets and sets a flag indicating whether case should - be ignored in determining equality. - - - - - Gets and sets a flag indicating that arrays should be - compared as collections, without regard to their shape. - - - - - Gets and sets an external comparer to be used to - test for equality. It is applied to members of - collections, in place of NUnit's own logic. - - - - - Gets the list of failure points for the last Match performed. - - - - - FailurePoint class represents one point of failure - in an equality test. - - - - - The location of the failure - - - - - The expected value - - - - - The actual value - - - - - Indicates whether the expected value is valid - - - - - Indicates whether the actual value is valid - - - - - PathConstraint serves as the abstract base of constraints - that operate on paths and provides several helper methods. - - - - - The expected path used in the constraint - - - - - The actual path being tested - - - - - Flag indicating whether a caseInsensitive comparison should be made - - - - - Construct a PathConstraint for a give expected path - - The expected path - - - - Test whether the constraint is satisfied by a given value - - The value to be tested - True for success, false for failure - - - - Returns true if the expected path and actual path match - - - - - Returns the string representation of this constraint - - - - - Canonicalize the provided path - - - The path in standardized form - - - - Test whether two paths are the same - - The first path - The second path - Indicates whether case should be ignored - - - - - Test whether one path is under another path - - The first path - supposed to be the parent path - The second path - supposed to be the child path - Indicates whether case should be ignored - - - - - Test whether one path is the same as or under another path - - The first path - supposed to be the parent path - The second path - supposed to be the child path - - - - - Modifies the current instance to be case-insensitve - and returns it. - - - - - Modifies the current instance to be case-sensitve - and returns it. - - - - - Summary description for SamePathConstraint. - - - - - Initializes a new instance of the class. - - The expected path - - - - Test whether the constraint is satisfied by a given value - - The expected path - The actual path - True for success, false for failure - - - - Write the constraint description to a MessageWriter - - The writer on which the description is displayed - - - - SubPathConstraint tests that the actual path is under the expected path - - - - - Initializes a new instance of the class. - - The expected path - - - - Test whether the constraint is satisfied by a given value - - The expected path - The actual path - True for success, false for failure - - - - Write the constraint description to a MessageWriter - - The writer on which the description is displayed - - - - SamePathOrUnderConstraint tests that one path is under another - - - - - Initializes a new instance of the class. - - The expected path - - - - Test whether the constraint is satisfied by a given value - - The expected path - The actual path - True for success, false for failure - - - - Write the constraint description to a MessageWriter - - The writer on which the description is displayed - - - - Predicate constraint wraps a Predicate in a constraint, - returning success if the predicate is true. - - - - - Construct a PredicateConstraint from a predicate - - - - - Determines whether the predicate succeeds when applied - to the actual value. - - - - - Writes the description to a MessageWriter - - - - - NotConstraint negates the effect of some other constraint - - - - - Initializes a new instance of the class. - - The base constraint to be negated. - - - - Test whether the constraint is satisfied by a given value - - The value to be tested - True for if the base constraint fails, false if it succeeds - - - - Write the constraint description to a MessageWriter - - The writer on which the description is displayed - - - - Write the actual value for a failing constraint test to a MessageWriter. - - The writer on which the actual value is displayed - - - - AllItemsConstraint applies another constraint to each - item in a collection, succeeding if they all succeed. - - - - - Construct an AllItemsConstraint on top of an existing constraint - - - - - - Apply the item constraint to each item in the collection, - failing if any item fails. - - - - - - - Write a description of this constraint to a MessageWriter - - - - - - SomeItemsConstraint applies another constraint to each - item in a collection, succeeding if any of them succeeds. - - - - - Construct a SomeItemsConstraint on top of an existing constraint - - - - - - Apply the item constraint to each item in the collection, - succeeding if any item succeeds. - - - - - - - Write a description of this constraint to a MessageWriter - - - - - - NoItemConstraint applies another constraint to each - item in a collection, failing if any of them succeeds. - - - - - Construct a NoItemConstraint on top of an existing constraint - - - - - - Apply the item constraint to each item in the collection, - failing if any item fails. - - - - - - - Write a description of this constraint to a MessageWriter - - - - - - ExactCoutConstraint applies another constraint to each - item in a collection, succeeding only if a specified - number of items succeed. - - - - - Construct an ExactCountConstraint on top of an existing constraint - - - - - - - Apply the item constraint to each item in the collection, - succeeding only if the expected number of items pass. - - - - - - - Write a description of this constraint to a MessageWriter - - - - - - PropertyExistsConstraint tests that a named property - exists on the object provided through Match. - - Originally, PropertyConstraint provided this feature - in addition to making optional tests on the vaue - of the property. The two constraints are now separate. - - - - - Initializes a new instance of the class. - - The name of the property. - - - - Test whether the property exists for a given object - - The object to be tested - True for success, false for failure - - - - Write the constraint description to a MessageWriter - - The writer on which the description is displayed - - - - Write the actual value for a failing constraint test to a - MessageWriter. - - The writer on which the actual value is displayed - - - - Returns the string representation of the constraint. - - - - - - PropertyConstraint extracts a named property and uses - its value as the actual value for a chained constraint. - - - - - Initializes a new instance of the class. - - The name. - The constraint to apply to the property. - - - - Test whether the constraint is satisfied by a given value - - The value to be tested - True for success, false for failure - - - - Write the constraint description to a MessageWriter - - The writer on which the description is displayed - - - - Write the actual value for a failing constraint test to a - MessageWriter. The default implementation simply writes - the raw value of actual, leaving it to the writer to - perform any formatting. - - The writer on which the actual value is displayed - - - - Returns the string representation of the constraint. - - - - - - RangeConstraint tests whethe two values are within a - specified range. - - - - - Initializes a new instance of the class. - - From. - To. - - - - Test whether the constraint is satisfied by a given value - - The value to be tested - True for success, false for failure - - - - Write the constraint description to a MessageWriter - - The writer on which the description is displayed - - - - ResolvableConstraintExpression is used to represent a compound - constraint being constructed at a point where the last operator - may either terminate the expression or may have additional - qualifying constraints added to it. - - It is used, for example, for a Property element or for - an Exception element, either of which may be optionally - followed by constraints that apply to the property or - exception. - - - - - Create a new instance of ResolvableConstraintExpression - - - - - Create a new instance of ResolvableConstraintExpression, - passing in a pre-populated ConstraintBuilder. - - - - - Resolve the current expression to a Constraint - - - - - This operator creates a constraint that is satisfied only if both - argument constraints are satisfied. - - - - - This operator creates a constraint that is satisfied only if both - argument constraints are satisfied. - - - - - This operator creates a constraint that is satisfied only if both - argument constraints are satisfied. - - - - - This operator creates a constraint that is satisfied if either - of the argument constraints is satisfied. - - - - - This operator creates a constraint that is satisfied if either - of the argument constraints is satisfied. - - - - - This operator creates a constraint that is satisfied if either - of the argument constraints is satisfied. - - - - - This operator creates a constraint that is satisfied if the - argument constraint is not satisfied. - - - - - Appends an And Operator to the expression - - - - - Appends an Or operator to the expression. - - - - - ReusableConstraint wraps a resolved constraint so that it - may be saved and reused as needed. - - - - - Construct a ReusableConstraint - - The constraint or expression to be reused - - - - Conversion operator from a normal constraint to a ReusableConstraint. - - The original constraint to be wrapped as a ReusableConstraint - - - - - Returns the string representation of the constraint. - - A string representing the constraint - - - - Resolves the ReusableConstraint by returning the constraint - that it originally wrapped. - - A resolved constraint - - - - SameAsConstraint tests whether an object is identical to - the object passed to its constructor - - - - - Initializes a new instance of the class. - - The expected object. - - - - Test whether the constraint is satisfied by a given value - - The value to be tested - True for success, false for failure - - - - Write the constraint description to a MessageWriter - - The writer on which the description is displayed - - - - BinarySerializableConstraint tests whether - an object is serializable in binary format. - - - - - Test whether the constraint is satisfied by a given value - - The value to be tested - True for success, false for failure - - - - Write the constraint description to a MessageWriter - - The writer on which the description is displayed - - - - Write the actual value for a failing constraint test to a - MessageWriter. The default implementation simply writes - the raw value of actual, leaving it to the writer to - perform any formatting. - - The writer on which the actual value is displayed - - - - Returns the string representation - - - - - BinarySerializableConstraint tests whether - an object is serializable in binary format. - - - - - Test whether the constraint is satisfied by a given value - - The value to be tested - True for success, false for failure - - - - Write the constraint description to a MessageWriter - - The writer on which the description is displayed - - - - Write the actual value for a failing constraint test to a - MessageWriter. The default implementation simply writes - the raw value of actual, leaving it to the writer to - perform any formatting. - - The writer on which the actual value is displayed - - - - Returns the string representation of this constraint - - - - - StringConstraint is the abstract base for constraints - that operate on strings. It supports the IgnoreCase - modifier for string operations. - - - - - The expected value - - - - - Indicates whether tests should be case-insensitive - - - - - Constructs a StringConstraint given an expected value - - The expected value - - - - Modify the constraint to ignore case in matching. - - - - - EmptyStringConstraint tests whether a string is empty. - - - - - Test whether the constraint is satisfied by a given value - - The value to be tested - True for success, false for failure - - - - Write the constraint description to a MessageWriter - - The writer on which the description is displayed - - - - NullEmptyStringConstraint tests whether a string is either null or empty. - - - - - Constructs a new NullOrEmptyStringConstraint - - - - - Test whether the constraint is satisfied by a given value - - The value to be tested - True for success, false for failure - - - - Write the constraint description to a MessageWriter - - The writer on which the description is displayed - - - - SubstringConstraint can test whether a string contains - the expected substring. - - - - - Initializes a new instance of the class. - - The expected. - - - - Test whether the constraint is satisfied by a given value - - The value to be tested - True for success, false for failure - - - - Write the constraint description to a MessageWriter - - The writer on which the description is displayed - - - - StartsWithConstraint can test whether a string starts - with an expected substring. - - - - - Initializes a new instance of the class. - - The expected string - - - - Test whether the constraint is matched by the actual value. - This is a template method, which calls the IsMatch method - of the derived class. - - - - - - - Write the constraint description to a MessageWriter - - The writer on which the description is displayed - - - - EndsWithConstraint can test whether a string ends - with an expected substring. - - - - - Initializes a new instance of the class. - - The expected string - - - - Test whether the constraint is matched by the actual value. - This is a template method, which calls the IsMatch method - of the derived class. - - - - - - - Write the constraint description to a MessageWriter - - The writer on which the description is displayed - - - - RegexConstraint can test whether a string matches - the pattern provided. - - - - - Initializes a new instance of the class. - - The pattern. - - - - Test whether the constraint is satisfied by a given value - - The value to be tested - True for success, false for failure - - - - Write the constraint description to a MessageWriter - - The writer on which the description is displayed - - - - ThrowsConstraint is used to test the exception thrown by - a delegate by applying a constraint to it. - - - - - Initializes a new instance of the class, - using a constraint to be applied to the exception. - - A constraint to apply to the caught exception. - - - - Executes the code of the delegate and captures any exception. - If a non-null base constraint was provided, it applies that - constraint to the exception. - - A delegate representing the code to be tested - True if an exception is thrown and the constraint succeeds, otherwise false - - - - Converts an ActualValueDelegate to a TestDelegate - before calling the primary overload. - - - - - - - Write the constraint description to a MessageWriter - - The writer on which the description is displayed - - - - Write the actual value for a failing constraint test to a - MessageWriter. The default implementation simply writes - the raw value of actual, leaving it to the writer to - perform any formatting. - - The writer on which the actual value is displayed - - - - Returns the string representation of this constraint - - - - - Get the actual exception thrown - used by Assert.Throws. - - - - - ThrowsNothingConstraint tests that a delegate does not - throw an exception. - - - - - Test whether the constraint is satisfied by a given value - - The value to be tested - True if no exception is thrown, otherwise false - - - - Converts an ActualValueDelegate to a TestDelegate - before calling the primary overload. - - - - - - - Write the constraint description to a MessageWriter - - The writer on which the description is displayed - - - - Write the actual value for a failing constraint test to a - MessageWriter. The default implementation simply writes - the raw value of actual, leaving it to the writer to - perform any formatting. - - The writer on which the actual value is displayed - - - - Modes in which the tolerance value for a comparison can - be interpreted. - - - - - The tolerance was created with a value, without specifying - how the value would be used. This is used to prevent setting - the mode more than once and is generally changed to Linear - upon execution of the test. - - - - - The tolerance is used as a numeric range within which - two compared values are considered to be equal. - - - - - Interprets the tolerance as the percentage by which - the two compared values my deviate from each other. - - - - - Compares two values based in their distance in - representable numbers. - - - - - The Tolerance class generalizes the notion of a tolerance - within which an equality test succeeds. Normally, it is - used with numeric types, but it can be used with any - type that supports taking a difference between two - objects and comparing that difference to a value. - - - - - Constructs a linear tolerance of a specdified amount - - - - - Constructs a tolerance given an amount and ToleranceMode - - - - - Tests that the current Tolerance is linear with a - numeric value, throwing an exception if it is not. - - - - - Returns an empty Tolerance object, equivalent to - specifying no tolerance. In most cases, it results - in an exact match but for floats and doubles a - default tolerance may be used. - - - - - Returns a zero Tolerance object, equivalent to - specifying an exact match. - - - - - Gets the ToleranceMode for the current Tolerance - - - - - Gets the value of the current Tolerance instance. - - - - - Returns a new tolerance, using the current amount as a percentage. - - - - - Returns a new tolerance, using the current amount in Ulps. - - - - - Returns a new tolerance with a TimeSpan as the amount, using - the current amount as a number of days. - - - - - Returns a new tolerance with a TimeSpan as the amount, using - the current amount as a number of hours. - - - - - Returns a new tolerance with a TimeSpan as the amount, using - the current amount as a number of minutes. - - - - - Returns a new tolerance with a TimeSpan as the amount, using - the current amount as a number of seconds. - - - - - Returns a new tolerance with a TimeSpan as the amount, using - the current amount as a number of milliseconds. - - - - - Returns a new tolerance with a TimeSpan as the amount, using - the current amount as a number of clock ticks. - - - - - Returns true if the current tolerance is empty. - - - - - TypeConstraint is the abstract base for constraints - that take a Type as their expected value. - - - - - The expected Type used by the constraint - - - - - Construct a TypeConstraint for a given Type - - - - - - Write the actual value for a failing constraint test to a - MessageWriter. TypeConstraints override this method to write - the name of the type. - - The writer on which the actual value is displayed - - - - ExactTypeConstraint is used to test that an object - is of the exact type provided in the constructor - - - - - Construct an ExactTypeConstraint for a given Type - - The expected Type. - - - - Test that an object is of the exact type specified - - The actual value. - True if the tested object is of the exact type provided, otherwise false. - - - - Write the description of this constraint to a MessageWriter - - The MessageWriter to use - - - - ExceptionTypeConstraint is a special version of ExactTypeConstraint - used to provided detailed info about the exception thrown in - an error message. - - - - - Constructs an ExceptionTypeConstraint - - - - - Write the actual value for a failing constraint test to a - MessageWriter. Overriden to write additional information - in the case of an Exception. - - The MessageWriter to use - - - - InstanceOfTypeConstraint is used to test that an object - is of the same type provided or derived from it. - - - - - Construct an InstanceOfTypeConstraint for the type provided - - The expected Type - - - - Test whether an object is of the specified type or a derived type - - The object to be tested - True if the object is of the provided type or derives from it, otherwise false. - - - - Write a description of this constraint to a MessageWriter - - The MessageWriter to use - - - - AssignableFromConstraint is used to test that an object - can be assigned from a given Type. - - - - - Construct an AssignableFromConstraint for the type provided - - - - - - Test whether an object can be assigned from the specified type - - The object to be tested - True if the object can be assigned a value of the expected Type, otherwise false. - - - - Write a description of this constraint to a MessageWriter - - The MessageWriter to use - - - - AssignableToConstraint is used to test that an object - can be assigned to a given Type. - - - - - Construct an AssignableToConstraint for the type provided - - - - - - Test whether an object can be assigned to the specified type - - The object to be tested - True if the object can be assigned a value of the expected Type, otherwise false. - - - - Write a description of this constraint to a MessageWriter - - The MessageWriter to use - - - - Thrown when an assertion failed. - - - - - The error message that explains - the reason for the exception - - - The error message that explains - the reason for the exception - The exception that caused the - current exception - - - - Serialization Constructor - - - - - Thrown when an assertion failed. - - - - - - - The error message that explains - the reason for the exception - The exception that caused the - current exception - - - - Serialization Constructor - - - - - Thrown when a test executes inconclusively. - - - - - The error message that explains - the reason for the exception - - - The error message that explains - the reason for the exception - The exception that caused the - current exception - - - - Serialization Constructor - - - - - Thrown when an assertion failed. - - - - - - - The error message that explains - the reason for the exception - The exception that caused the - current exception - - - - Serialization Constructor - - - - - - - - - - - Compares two objects of a given Type for equality within a tolerance - - The first object to compare - The second object to compare - The tolerance to use in the comparison - - - - - The different targets a test action attribute can be applied to - - - - - Default target, which is determined by where the action attribute is attached - - - - - Target a individual test case - - - - - Target a suite of test cases - - - - - Delegate used by tests that execute code and - capture any thrown exception. - - - - - The Assert class contains a collection of static methods that - implement the most common assertions used in NUnit. - - - - - We don't actually want any instances of this object, but some people - like to inherit from it to add other static methods. Hence, the - protected constructor disallows any instances of this object. - - - - - The Equals method throws an AssertionException. This is done - to make sure there is no mistake by calling this function. - - - - - - - override the default ReferenceEquals to throw an AssertionException. This - implementation makes sure there is no mistake in calling this function - as part of Assert. - - - - - - - Helper for Assert.AreEqual(double expected, double actual, ...) - allowing code generation to work consistently. - - The expected value - The actual value - The maximum acceptable difference between the - the expected and the actual - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Throws a with the message and arguments - that are passed in. This allows a test to be cut short, with a result - of success returned to NUnit. - - The message to initialize the with. - Arguments to be used in formatting the message - - - - Throws a with the message and arguments - that are passed in. This allows a test to be cut short, with a result - of success returned to NUnit. - - The message to initialize the with. - - - - Throws a with the message and arguments - that are passed in. This allows a test to be cut short, with a result - of success returned to NUnit. - - - - - Throws an with the message and arguments - that are passed in. This is used by the other Assert functions. - - The message to initialize the with. - Arguments to be used in formatting the message - - - - Throws an with the message that is - passed in. This is used by the other Assert functions. - - The message to initialize the with. - - - - Throws an . - This is used by the other Assert functions. - - - - - Throws an with the message and arguments - that are passed in. This causes the test to be reported as ignored. - - The message to initialize the with. - Arguments to be used in formatting the message - - - - Throws an with the message that is - passed in. This causes the test to be reported as ignored. - - The message to initialize the with. - - - - Throws an . - This causes the test to be reported as ignored. - - - - - Throws an with the message and arguments - that are passed in. This causes the test to be reported as inconclusive. - - The message to initialize the with. - Arguments to be used in formatting the message - - - - Throws an with the message that is - passed in. This causes the test to be reported as inconclusive. - - The message to initialize the with. - - - - Throws an . - This causes the test to be reported as Inconclusive. - - - - - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. - - A Constraint to be applied - The actual value to test - - - - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. - - A Constraint to be applied - The actual value to test - The message that will be displayed on failure - - - - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. - - A Constraint expression to be applied - The actual value to test - The message that will be displayed on failure - Arguments to be used in formatting the message - - - - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. - - A Constraint expression to be applied - An ActualValueDelegate returning the value to be tested - - - - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. - - A Constraint expression to be applied - An ActualValueDelegate returning the value to be tested - The message that will be displayed on failure - - - - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. - - An ActualValueDelegate returning the value to be tested - A Constraint expression to be applied - The message that will be displayed on failure - Arguments to be used in formatting the message - - - - Apply a constraint to a referenced value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. - - A Constraint to be applied - The actual value to test - - - - Apply a constraint to a referenced value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. - - A Constraint to be applied - The actual value to test - The message that will be displayed on failure - - - - Apply a constraint to a referenced value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. - - A Constraint to be applied - The actual value to test - The message that will be displayed on failure - Arguments to be used in formatting the message - - - - Asserts that a condition is true. If the condition is false the method throws - an . - - The evaluated condition - The message to display if the condition is false - Arguments to be used in formatting the message - - - - Asserts that a condition is true. If the condition is false the method throws - an . - - The evaluated condition - The message to display if the condition is false - - - - Asserts that a condition is true. If the condition is false the method throws - an . - - The evaluated condition - - - - Asserts that the code represented by a delegate throws an exception - that satisfies the constraint provided. - - A TestDelegate to be executed - A ThrowsConstraint used in the test - - - - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. - Used as a synonym for That in rare cases where a private setter - causes a Visual Basic compilation error. - - A Constraint to be applied - The actual value to test - - - - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. - Used as a synonym for That in rare cases where a private setter - causes a Visual Basic compilation error. - - A Constraint to be applied - The actual value to test - The message that will be displayed on failure - - - - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. - Used as a synonym for That in rare cases where a private setter - causes a Visual Basic compilation error. - - - This method is provided for use by VB developers needing to test - the value of properties with private setters. - - A Constraint expression to be applied - The actual value to test - The message that will be displayed on failure - Arguments to be used in formatting the message - - - - Verifies that a delegate throws a particular exception when called. - - A constraint to be satisfied by the exception - A TestSnippet delegate - The message that will be displayed on failure - Arguments to be used in formatting the message - - - - Verifies that a delegate throws a particular exception when called. - - A constraint to be satisfied by the exception - A TestSnippet delegate - The message that will be displayed on failure - - - - Verifies that a delegate throws a particular exception when called. - - A constraint to be satisfied by the exception - A TestSnippet delegate - - - - Verifies that a delegate throws a particular exception when called. - - The exception Type expected - A TestSnippet delegate - The message that will be displayed on failure - Arguments to be used in formatting the message - - - - Verifies that a delegate throws a particular exception when called. - - The exception Type expected - A TestSnippet delegate - The message that will be displayed on failure - - - - Verifies that a delegate throws a particular exception when called. - - The exception Type expected - A TestSnippet delegate - - - - Verifies that a delegate throws a particular exception when called. - - Type of the expected exception - A TestSnippet delegate - The message that will be displayed on failure - Arguments to be used in formatting the message - - - - Verifies that a delegate throws a particular exception when called. - - Type of the expected exception - A TestSnippet delegate - The message that will be displayed on failure - - - - Verifies that a delegate throws a particular exception when called. - - Type of the expected exception - A TestSnippet delegate - - - - Verifies that a delegate throws an exception when called - and returns it. - - A TestDelegate - The message that will be displayed on failure - Arguments to be used in formatting the message - - - - Verifies that a delegate throws an exception when called - and returns it. - - A TestDelegate - The message that will be displayed on failure - - - - Verifies that a delegate throws an exception when called - and returns it. - - A TestDelegate - - - - Verifies that a delegate throws an exception of a certain Type - or one derived from it when called and returns it. - - The expected Exception Type - A TestDelegate - The message that will be displayed on failure - Arguments to be used in formatting the message - - - - Verifies that a delegate throws an exception of a certain Type - or one derived from it when called and returns it. - - The expected Exception Type - A TestDelegate - The message that will be displayed on failure - - - - Verifies that a delegate throws an exception of a certain Type - or one derived from it when called and returns it. - - The expected Exception Type - A TestDelegate - - - - Verifies that a delegate throws an exception of a certain Type - or one derived from it when called and returns it. - - The expected Exception Type - A TestDelegate - The message that will be displayed on failure - Arguments to be used in formatting the message - - - - Verifies that a delegate throws an exception of a certain Type - or one derived from it when called and returns it. - - The expected Exception Type - A TestDelegate - The message that will be displayed on failure - - - - Verifies that a delegate throws an exception of a certain Type - or one derived from it when called and returns it. - - The expected Exception Type - A TestDelegate - - - - Verifies that a delegate does not throw an exception - - A TestSnippet delegate - The message that will be displayed on failure - Arguments to be used in formatting the message - - - - Verifies that a delegate does not throw an exception. - - A TestSnippet delegate - The message that will be displayed on failure - - - - Verifies that a delegate does not throw an exception. - - A TestSnippet delegate - - - - Asserts that a condition is true. If the condition is false the method throws - an . - - The evaluated condition - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Asserts that a condition is true. If the condition is false the method throws - an . - - The evaluated condition - The message to display in case of failure - - - - Asserts that a condition is true. If the condition is false the method throws - an . - - The evaluated condition - - - - Asserts that a condition is true. If the condition is false the method throws - an . - - The evaluated condition - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Asserts that a condition is true. If the condition is false the method throws - an . - - The evaluated condition - The message to display in case of failure - - - - Asserts that a condition is true. If the condition is false the method throws - an . - - The evaluated condition - - - - Asserts that a condition is false. If the condition is true the method throws - an . - - The evaluated condition - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Asserts that a condition is false. If the condition is true the method throws - an . - - The evaluated condition - The message to display in case of failure - - - - Asserts that a condition is false. If the condition is true the method throws - an . - - The evaluated condition - - - - Asserts that a condition is false. If the condition is true the method throws - an . - - The evaluated condition - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Asserts that a condition is false. If the condition is true the method throws - an . - - The evaluated condition - The message to display in case of failure - - - - Asserts that a condition is false. If the condition is true the method throws - an . - - The evaluated condition - - - - Verifies that the object that is passed in is not equal to null - If the object is null then an - is thrown. - - The object that is to be tested - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the object that is passed in is not equal to null - If the object is null then an - is thrown. - - The object that is to be tested - The message to display in case of failure - - - - Verifies that the object that is passed in is not equal to null - If the object is null then an - is thrown. - - The object that is to be tested - - - - Verifies that the object that is passed in is not equal to null - If the object is null then an - is thrown. - - The object that is to be tested - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the object that is passed in is not equal to null - If the object is null then an - is thrown. - - The object that is to be tested - The message to display in case of failure - - - - Verifies that the object that is passed in is not equal to null - If the object is null then an - is thrown. - - The object that is to be tested - - - - Verifies that the object that is passed in is equal to null - If the object is not null then an - is thrown. - - The object that is to be tested - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the object that is passed in is equal to null - If the object is not null then an - is thrown. - - The object that is to be tested - The message to display in case of failure - - - - Verifies that the object that is passed in is equal to null - If the object is not null then an - is thrown. - - The object that is to be tested - - - - Verifies that the object that is passed in is equal to null - If the object is not null then an - is thrown. - - The object that is to be tested - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the object that is passed in is equal to null - If the object is not null then an - is thrown. - - The object that is to be tested - The message to display in case of failure - - - - Verifies that the object that is passed in is equal to null - If the object is not null then an - is thrown. - - The object that is to be tested - - - - Verifies that the double that is passed in is an NaN value. - If the object is not NaN then an - is thrown. - - The value that is to be tested - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the double that is passed in is an NaN value. - If the object is not NaN then an - is thrown. - - The value that is to be tested - The message to display in case of failure - - - - Verifies that the double that is passed in is an NaN value. - If the object is not NaN then an - is thrown. - - The value that is to be tested - - - - Verifies that the double that is passed in is an NaN value. - If the object is not NaN then an - is thrown. - - The value that is to be tested - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the double that is passed in is an NaN value. - If the object is not NaN then an - is thrown. - - The value that is to be tested - The message to display in case of failure - - - - Verifies that the double that is passed in is an NaN value. - If the object is not NaN then an - is thrown. - - The value that is to be tested - - - - Assert that a string is empty - that is equal to string.Empty - - The string to be tested - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Assert that a string is empty - that is equal to string.Empty - - The string to be tested - The message to display in case of failure - - - - Assert that a string is empty - that is equal to string.Empty - - The string to be tested - - - - Assert that an array, list or other collection is empty - - An array, list or other collection implementing ICollection - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Assert that an array, list or other collection is empty - - An array, list or other collection implementing ICollection - The message to display in case of failure - - - - Assert that an array, list or other collection is empty - - An array, list or other collection implementing ICollection - - - - Assert that a string is not empty - that is not equal to string.Empty - - The string to be tested - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Assert that a string is not empty - that is not equal to string.Empty - - The string to be tested - The message to display in case of failure - - - - Assert that a string is not empty - that is not equal to string.Empty - - The string to be tested - - - - Assert that an array, list or other collection is not empty - - An array, list or other collection implementing ICollection - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Assert that an array, list or other collection is not empty - - An array, list or other collection implementing ICollection - The message to display in case of failure - - - - Assert that an array, list or other collection is not empty - - An array, list or other collection implementing ICollection - - - - Assert that a string is either null or equal to string.Empty - - The string to be tested - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Assert that a string is either null or equal to string.Empty - - The string to be tested - The message to display in case of failure - - - - Assert that a string is either null or equal to string.Empty - - The string to be tested - - - - Assert that a string is not null or empty - - The string to be tested - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Assert that a string is not null or empty - - The string to be tested - The message to display in case of failure - - - - Assert that a string is not null or empty - - The string to be tested - - - - Asserts that an object may be assigned a value of a given Type. - - The expected Type. - The object under examination - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Asserts that an object may be assigned a value of a given Type. - - The expected Type. - The object under examination - The message to display in case of failure - - - - Asserts that an object may be assigned a value of a given Type. - - The expected Type. - The object under examination - - - - Asserts that an object may be assigned a value of a given Type. - - The expected Type. - The object under examination - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Asserts that an object may be assigned a value of a given Type. - - The expected Type. - The object under examination - The message to display in case of failure - - - - Asserts that an object may be assigned a value of a given Type. - - The expected Type. - The object under examination - - - - Asserts that an object may not be assigned a value of a given Type. - - The expected Type. - The object under examination - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Asserts that an object may not be assigned a value of a given Type. - - The expected Type. - The object under examination - The message to display in case of failure - - - - Asserts that an object may not be assigned a value of a given Type. - - The expected Type. - The object under examination - - - - Asserts that an object may not be assigned a value of a given Type. - - The expected Type. - The object under examination - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Asserts that an object may not be assigned a value of a given Type. - - The expected Type. - The object under examination - The message to display in case of failure - - - - Asserts that an object may not be assigned a value of a given Type. - - The expected Type. - The object under examination - - - - Asserts that an object is an instance of a given type. - - The expected Type - The object being examined - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Asserts that an object is an instance of a given type. - - The expected Type - The object being examined - The message to display in case of failure - - - - Asserts that an object is an instance of a given type. - - The expected Type - The object being examined - - - - Asserts that an object is an instance of a given type. - - The expected Type - The object being examined - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Asserts that an object is an instance of a given type. - - The expected Type - The object being examined - The message to display in case of failure - - - - Asserts that an object is an instance of a given type. - - The expected Type - The object being examined - - - - Asserts that an object is an instance of a given type. - - The expected Type - The object being examined - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Asserts that an object is an instance of a given type. - - The expected Type - The object being examined - The message to display in case of failure - - - - Asserts that an object is an instance of a given type. - - The expected Type - The object being examined - - - - Asserts that an object is not an instance of a given type. - - The expected Type - The object being examined - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Asserts that an object is not an instance of a given type. - - The expected Type - The object being examined - The message to display in case of failure - - - - Asserts that an object is not an instance of a given type. - - The expected Type - The object being examined - - - - Asserts that an object is not an instance of a given type. - - The expected Type - The object being examined - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Asserts that an object is not an instance of a given type. - - The expected Type - The object being examined - The message to display in case of failure - - - - Asserts that an object is not an instance of a given type. - - The expected Type - The object being examined - - - - Asserts that an object is not an instance of a given type. - - The expected Type - The object being examined - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Asserts that an object is not an instance of a given type. - - The expected Type - The object being examined - The message to display in case of failure - - - - Asserts that an object is not an instance of a given type. - - The expected Type - The object being examined - - - - Verifies that two values are equal. If they are not, then an - is thrown. - - The expected value - The actual value - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that two values are equal. If they are not, then an - is thrown. - - The expected value - The actual value - The message to display in case of failure - - - - Verifies that two values are equal. If they are not, then an - is thrown. - - The expected value - The actual value - - - - Verifies that two values are equal. If they are not, then an - is thrown. - - The expected value - The actual value - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that two values are equal. If they are not, then an - is thrown. - - The expected value - The actual value - The message to display in case of failure - - - - Verifies that two values are equal. If they are not, then an - is thrown. - - The expected value - The actual value - - - - Verifies that two values are equal. If they are not, then an - is thrown. - - The expected value - The actual value - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that two values are equal. If they are not, then an - is thrown. - - The expected value - The actual value - The message to display in case of failure - - - - Verifies that two values are equal. If they are not, then an - is thrown. - - The expected value - The actual value - - - - Verifies that two values are equal. If they are not, then an - is thrown. - - The expected value - The actual value - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that two values are equal. If they are not, then an - is thrown. - - The expected value - The actual value - The message to display in case of failure - - - - Verifies that two values are equal. If they are not, then an - is thrown. - - The expected value - The actual value - - - - Verifies that two values are equal. If they are not, then an - is thrown. - - The expected value - The actual value - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that two values are equal. If they are not, then an - is thrown. - - The expected value - The actual value - The message to display in case of failure - - - - Verifies that two values are equal. If they are not, then an - is thrown. - - The expected value - The actual value - - - - Verifies that two doubles are equal considering a delta. If the - expected value is infinity then the delta value is ignored. If - they are not equal then an is - thrown. - - The expected value - The actual value - The maximum acceptable difference between the - the expected and the actual - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that two doubles are equal considering a delta. If the - expected value is infinity then the delta value is ignored. If - they are not equal then an is - thrown. - - The expected value - The actual value - The maximum acceptable difference between the - the expected and the actual - The message to display in case of failure - - - - Verifies that two doubles are equal considering a delta. If the - expected value is infinity then the delta value is ignored. If - they are not equal then an is - thrown. - - The expected value - The actual value - The maximum acceptable difference between the - the expected and the actual - - - - Verifies that two doubles are equal considering a delta. If the - expected value is infinity then the delta value is ignored. If - they are not equal then an is - thrown. - - The expected value - The actual value - The maximum acceptable difference between the - the expected and the actual - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that two doubles are equal considering a delta. If the - expected value is infinity then the delta value is ignored. If - they are not equal then an is - thrown. - - The expected value - The actual value - The maximum acceptable difference between the - the expected and the actual - The message to display in case of failure - - - - Verifies that two doubles are equal considering a delta. If the - expected value is infinity then the delta value is ignored. If - they are not equal then an is - thrown. - - The expected value - The actual value - The maximum acceptable difference between the - the expected and the actual - - - - Verifies that two objects are equal. Two objects are considered - equal if both are null, or if both have the same value. NUnit - has special semantics for some object types. - If they are not equal an is thrown. - - The value that is expected - The actual value - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that two objects are equal. Two objects are considered - equal if both are null, or if both have the same value. NUnit - has special semantics for some object types. - If they are not equal an is thrown. - - The value that is expected - The actual value - The message to display in case of failure - - - - Verifies that two objects are equal. Two objects are considered - equal if both are null, or if both have the same value. NUnit - has special semantics for some object types. - If they are not equal an is thrown. - - The value that is expected - The actual value - - - - Verifies that two values are not equal. If they are equal, then an - is thrown. - - The expected value - The actual value - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that two values are not equal. If they are equal, then an - is thrown. - - The expected value - The actual value - The message to display in case of failure - - - - Verifies that two values are not equal. If they are equal, then an - is thrown. - - The expected value - The actual value - - - - Verifies that two values are not equal. If they are equal, then an - is thrown. - - The expected value - The actual value - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that two values are not equal. If they are equal, then an - is thrown. - - The expected value - The actual value - The message to display in case of failure - - - - Verifies that two values are not equal. If they are equal, then an - is thrown. - - The expected value - The actual value - - - - Verifies that two values are not equal. If they are equal, then an - is thrown. - - The expected value - The actual value - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that two values are not equal. If they are equal, then an - is thrown. - - The expected value - The actual value - The message to display in case of failure - - - - Verifies that two values are not equal. If they are equal, then an - is thrown. - - The expected value - The actual value - - - - Verifies that two values are not equal. If they are equal, then an - is thrown. - - The expected value - The actual value - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that two values are not equal. If they are equal, then an - is thrown. - - The expected value - The actual value - The message to display in case of failure - - - - Verifies that two values are not equal. If they are equal, then an - is thrown. - - The expected value - The actual value - - - - Verifies that two values are not equal. If they are equal, then an - is thrown. - - The expected value - The actual value - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that two values are not equal. If they are equal, then an - is thrown. - - The expected value - The actual value - The message to display in case of failure - - - - Verifies that two values are not equal. If they are equal, then an - is thrown. - - The expected value - The actual value - - - - Verifies that two values are not equal. If they are equal, then an - is thrown. - - The expected value - The actual value - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that two values are not equal. If they are equal, then an - is thrown. - - The expected value - The actual value - The message to display in case of failure - - - - Verifies that two values are not equal. If they are equal, then an - is thrown. - - The expected value - The actual value - - - - Verifies that two values are not equal. If they are equal, then an - is thrown. - - The expected value - The actual value - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that two values are not equal. If they are equal, then an - is thrown. - - The expected value - The actual value - The message to display in case of failure - - - - Verifies that two values are not equal. If they are equal, then an - is thrown. - - The expected value - The actual value - - - - Verifies that two objects are not equal. Two objects are considered - equal if both are null, or if both have the same value. NUnit - has special semantics for some object types. - If they are equal an is thrown. - - The value that is expected - The actual value - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that two objects are not equal. Two objects are considered - equal if both are null, or if both have the same value. NUnit - has special semantics for some object types. - If they are equal an is thrown. - - The value that is expected - The actual value - The message to display in case of failure - - - - Verifies that two objects are not equal. Two objects are considered - equal if both are null, or if both have the same value. NUnit - has special semantics for some object types. - If they are equal an is thrown. - - The value that is expected - The actual value - - - - Asserts that two objects refer to the same object. If they - are not the same an is thrown. - - The expected object - The actual object - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Asserts that two objects refer to the same object. If they - are not the same an is thrown. - - The expected object - The actual object - The message to display in case of failure - - - - Asserts that two objects refer to the same object. If they - are not the same an is thrown. - - The expected object - The actual object - - - - Asserts that two objects do not refer to the same object. If they - are the same an is thrown. - - The expected object - The actual object - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Asserts that two objects do not refer to the same object. If they - are the same an is thrown. - - The expected object - The actual object - The message to display in case of failure - - - - Asserts that two objects do not refer to the same object. If they - are the same an is thrown. - - The expected object - The actual object - - - - Verifies that the first value is greater than the second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is greater than the second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - - - - Verifies that the first value is greater than the second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - - - - Verifies that the first value is greater than the second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is greater than the second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - - - - Verifies that the first value is greater than the second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - - - - Verifies that the first value is greater than the second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is greater than the second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - - - - Verifies that the first value is greater than the second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - - - - Verifies that the first value is greater than the second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is greater than the second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - - - - Verifies that the first value is greater than the second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - - - - Verifies that the first value is greater than the second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is greater than the second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - - - - Verifies that the first value is greater than the second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - - - - Verifies that the first value is greater than the second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is greater than the second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - - - - Verifies that the first value is greater than the second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - - - - Verifies that the first value is greater than the second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is greater than the second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - - - - Verifies that the first value is greater than the second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - - - - Verifies that the first value is greater than the second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is greater than the second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - - - - Verifies that the first value is greater than the second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - - - - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - - - - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - - - - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - - - - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - - - - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - - - - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - - - - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - - - - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - - - - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - - - - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - - - - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - - - - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - - - - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - - - - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - - - - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - - - - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - - - - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - - - - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - - - - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - - - - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - - - - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - - - - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - - - - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - - - - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - - - - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - - - - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - - - - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - - - - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - - - - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - - - - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - - - - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure - - - - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. - - The first value, expected to be greater - The second value, expected to be less - - - - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - - - - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - - - - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - - - - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - - - - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - - - - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - - - - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - - - - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - - - - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - - - - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - - - - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - - - - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - - - - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - - - - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - - - - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure - - - - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. - - The first value, expected to be less - The second value, expected to be greater - - - - Asserts that an object is contained in a list. - - The expected object - The list to be examined - The message to display in case of failure - Array of objects to be used in formatting the message - - - - Asserts that an object is contained in a list. - - The expected object - The list to be examined - The message to display in case of failure - - - - Asserts that an object is contained in a list. - - The expected object - The list to be examined - - - - Gets the number of assertions executed so far and - resets the counter to zero. - - - - - AssertionHelper is an optional base class for user tests, - allowing the use of shorter names for constraints and - asserts and avoiding conflict with the definition of - , from which it inherits much of its - behavior, in certain mock object frameworks. - - - - - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. Works - identically to Assert.That - - A Constraint to be applied - The actual value to test - - - - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. Works - identically to Assert.That. - - A Constraint to be applied - The actual value to test - The message that will be displayed on failure - - - - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. Works - identically to Assert.That - - A Constraint to be applied - The actual value to test - The message that will be displayed on failure - Arguments to be used in formatting the message - - - - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. - - A Constraint expression to be applied - An ActualValueDelegate returning the value to be tested - - - - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. - - A Constraint expression to be applied - An ActualValueDelegate returning the value to be tested - The message that will be displayed on failure - - - - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. - - An ActualValueDelegate returning the value to be tested - A Constraint expression to be applied - The message that will be displayed on failure - Arguments to be used in formatting the message - - - - Apply a constraint to a referenced value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. - - A Constraint to be applied - The actual value to test - - - - Apply a constraint to a referenced value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. - - A Constraint to be applied - The actual value to test - The message that will be displayed on failure - - - - Apply a constraint to a referenced value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. - - A Constraint to be applied - The actual value to test - The message that will be displayed on failure - Arguments to be used in formatting the message - - - - Asserts that a condition is true. If the condition is false the method throws - an . Works Identically to Assert.That. - - The evaluated condition - The message to display if the condition is false - Arguments to be used in formatting the message - - - - Asserts that a condition is true. If the condition is false the method throws - an . Works Identically to Assert.That. - - The evaluated condition - The message to display if the condition is false - - - - Asserts that a condition is true. If the condition is false the method throws - an . Works Identically Assert.That. - - The evaluated condition - - - - Asserts that the code represented by a delegate throws an exception - that satisfies the constraint provided. - - A TestDelegate to be executed - A ThrowsConstraint used in the test - - - - Returns a ListMapper based on a collection. - - The original collection - - - - - Provides static methods to express the assumptions - that must be met for a test to give a meaningful - result. If an assumption is not met, the test - should produce an inconclusive result. - - - - - The Equals method throws an AssertionException. This is done - to make sure there is no mistake by calling this function. - - - - - - - override the default ReferenceEquals to throw an AssertionException. This - implementation makes sure there is no mistake in calling this function - as part of Assert. - - - - - - - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an InconclusiveException on failure. - - A Constraint expression to be applied - The actual value to test - - - - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an InconclusiveException on failure. - - A Constraint expression to be applied - The actual value to test - The message that will be displayed on failure - - - - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an InconclusiveException on failure. - - A Constraint expression to be applied - The actual value to test - The message that will be displayed on failure - Arguments to be used in formatting the message - - - - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an InconclusiveException on failure. - - A Constraint expression to be applied - An ActualValueDelegate returning the value to be tested - - - - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an InconclusiveException on failure. - - A Constraint expression to be applied - An ActualValueDelegate returning the value to be tested - The message that will be displayed on failure - - - - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an InconclusiveException on failure. - - An ActualValueDelegate returning the value to be tested - A Constraint expression to be applied - The message that will be displayed on failure - Arguments to be used in formatting the message - - - - Apply a constraint to a referenced value, succeeding if the constraint - is satisfied and throwing an InconclusiveException on failure. - - A Constraint expression to be applied - The actual value to test - - - - Apply a constraint to a referenced value, succeeding if the constraint - is satisfied and throwing an InconclusiveException on failure. - - A Constraint expression to be applied - The actual value to test - The message that will be displayed on failure - - - - Apply a constraint to a referenced value, succeeding if the constraint - is satisfied and throwing an InconclusiveException on failure. - - A Constraint expression to be applied - The actual value to test - The message that will be displayed on failure - Arguments to be used in formatting the message - - - - Asserts that a condition is true. If the condition is false the method throws - an . - - The evaluated condition - The message to display if the condition is false - Arguments to be used in formatting the message - - - - Asserts that a condition is true. If the condition is false the method throws - an . - - The evaluated condition - The message to display if the condition is false - - - - Asserts that a condition is true. If the condition is false the - method throws an . - - The evaluated condition - - - - Asserts that the code represented by a delegate throws an exception - that satisfies the constraint provided. - - A TestDelegate to be executed - A ThrowsConstraint used in the test - - - - A set of Assert methods operationg on one or more collections - - - - - The Equals method throws an AssertionException. This is done - to make sure there is no mistake by calling this function. - - - - - - - override the default ReferenceEquals to throw an AssertionException. This - implementation makes sure there is no mistake in calling this function - as part of Assert. - - - - - - - Asserts that all items contained in collection are of the type specified by expectedType. - - IEnumerable containing objects to be considered - System.Type that all objects in collection must be instances of - - - - Asserts that all items contained in collection are of the type specified by expectedType. - - IEnumerable containing objects to be considered - System.Type that all objects in collection must be instances of - The message that will be displayed on failure - - - - Asserts that all items contained in collection are of the type specified by expectedType. - - IEnumerable containing objects to be considered - System.Type that all objects in collection must be instances of - The message that will be displayed on failure - Arguments to be used in formatting the message - - - - Asserts that all items contained in collection are not equal to null. - - IEnumerable containing objects to be considered - - - - Asserts that all items contained in collection are not equal to null. - - IEnumerable containing objects to be considered - The message that will be displayed on failure - - - - Asserts that all items contained in collection are not equal to null. - - IEnumerable of objects to be considered - The message that will be displayed on failure - Arguments to be used in formatting the message - - - - Ensures that every object contained in collection exists within the collection - once and only once. - - IEnumerable of objects to be considered - - - - Ensures that every object contained in collection exists within the collection - once and only once. - - IEnumerable of objects to be considered - The message that will be displayed on failure - - - - Ensures that every object contained in collection exists within the collection - once and only once. - - IEnumerable of objects to be considered - The message that will be displayed on failure - Arguments to be used in formatting the message - - - - Asserts that expected and actual are exactly equal. The collections must have the same count, - and contain the exact same objects in the same order. - - The first IEnumerable of objects to be considered - The second IEnumerable of objects to be considered - - - - Asserts that expected and actual are exactly equal. The collections must have the same count, - and contain the exact same objects in the same order. - If comparer is not null then it will be used to compare the objects. - - The first IEnumerable of objects to be considered - The second IEnumerable of objects to be considered - The IComparer to use in comparing objects from each IEnumerable - - - - Asserts that expected and actual are exactly equal. The collections must have the same count, - and contain the exact same objects in the same order. - - The first IEnumerable of objects to be considered - The second IEnumerable of objects to be considered - The message that will be displayed on failure - - - - Asserts that expected and actual are exactly equal. The collections must have the same count, - and contain the exact same objects in the same order. - If comparer is not null then it will be used to compare the objects. - - The first IEnumerable of objects to be considered - The second IEnumerable of objects to be considered - The IComparer to use in comparing objects from each IEnumerable - The message that will be displayed on failure - - - - Asserts that expected and actual are exactly equal. The collections must have the same count, - and contain the exact same objects in the same order. - - The first IEnumerable of objects to be considered - The second IEnumerable of objects to be considered - The message that will be displayed on failure - Arguments to be used in formatting the message - - - - Asserts that expected and actual are exactly equal. The collections must have the same count, - and contain the exact same objects in the same order. - If comparer is not null then it will be used to compare the objects. - - The first IEnumerable of objects to be considered - The second IEnumerable of objects to be considered - The IComparer to use in comparing objects from each IEnumerable - The message that will be displayed on failure - Arguments to be used in formatting the message - - - - Asserts that expected and actual are equivalent, containing the same objects but the match may be in any order. - - The first IEnumerable of objects to be considered - The second IEnumerable of objects to be considered - - - - Asserts that expected and actual are equivalent, containing the same objects but the match may be in any order. - - The first IEnumerable of objects to be considered - The second IEnumerable of objects to be considered - The message that will be displayed on failure - - - - Asserts that expected and actual are equivalent, containing the same objects but the match may be in any order. - - The first IEnumerable of objects to be considered - The second IEnumerable of objects to be considered - The message that will be displayed on failure - Arguments to be used in formatting the message - - - - Asserts that expected and actual are not exactly equal. - - The first IEnumerable of objects to be considered - The second IEnumerable of objects to be considered - - - - Asserts that expected and actual are not exactly equal. - If comparer is not null then it will be used to compare the objects. - - The first IEnumerable of objects to be considered - The second IEnumerable of objects to be considered - The IComparer to use in comparing objects from each IEnumerable - - - - Asserts that expected and actual are not exactly equal. - - The first IEnumerable of objects to be considered - The second IEnumerable of objects to be considered - The message that will be displayed on failure - - - - Asserts that expected and actual are not exactly equal. - If comparer is not null then it will be used to compare the objects. - - The first IEnumerable of objects to be considered - The second IEnumerable of objects to be considered - The IComparer to use in comparing objects from each IEnumerable - The message that will be displayed on failure - - - - Asserts that expected and actual are not exactly equal. - - The first IEnumerable of objects to be considered - The second IEnumerable of objects to be considered - The message that will be displayed on failure - Arguments to be used in formatting the message - - - - Asserts that expected and actual are not exactly equal. - If comparer is not null then it will be used to compare the objects. - - The first IEnumerable of objects to be considered - The second IEnumerable of objects to be considered - The IComparer to use in comparing objects from each IEnumerable - The message that will be displayed on failure - Arguments to be used in formatting the message - - - - Asserts that expected and actual are not equivalent. - - The first IEnumerable of objects to be considered - The second IEnumerable of objects to be considered - - - - Asserts that expected and actual are not equivalent. - - The first IEnumerable of objects to be considered - The second IEnumerable of objects to be considered - The message that will be displayed on failure - - - - Asserts that expected and actual are not equivalent. - - The first IEnumerable of objects to be considered - The second IEnumerable of objects to be considered - The message that will be displayed on failure - Arguments to be used in formatting the message - - - - Asserts that collection contains actual as an item. - - IEnumerable of objects to be considered - Object to be found within collection - - - - Asserts that collection contains actual as an item. - - IEnumerable of objects to be considered - Object to be found within collection - The message that will be displayed on failure - - - - Asserts that collection contains actual as an item. - - IEnumerable of objects to be considered - Object to be found within collection - The message that will be displayed on failure - Arguments to be used in formatting the message - - - - Asserts that collection does not contain actual as an item. - - IEnumerable of objects to be considered - Object that cannot exist within collection - - - - Asserts that collection does not contain actual as an item. - - IEnumerable of objects to be considered - Object that cannot exist within collection - The message that will be displayed on failure - - - - Asserts that collection does not contain actual as an item. - - IEnumerable of objects to be considered - Object that cannot exist within collection - The message that will be displayed on failure - Arguments to be used in formatting the message - - - - Asserts that superset is not a subject of subset. - - The IEnumerable superset to be considered - The IEnumerable subset to be considered - - - - Asserts that superset is not a subject of subset. - - The IEnumerable superset to be considered - The IEnumerable subset to be considered - The message that will be displayed on failure - - - - Asserts that superset is not a subject of subset. - - The IEnumerable superset to be considered - The IEnumerable subset to be considered - The message that will be displayed on failure - Arguments to be used in formatting the message - - - - Asserts that superset is a subset of subset. - - The IEnumerable superset to be considered - The IEnumerable subset to be considered - - - - Asserts that superset is a subset of subset. - - The IEnumerable superset to be considered - The IEnumerable subset to be considered - The message that will be displayed on failure - - - - Asserts that superset is a subset of subset. - - The IEnumerable superset to be considered - The IEnumerable subset to be considered - The message that will be displayed on failure - Arguments to be used in formatting the message - - - - Assert that an array, list or other collection is empty - - An array, list or other collection implementing IEnumerable - The message to be displayed on failure - Arguments to be used in formatting the message - - - - Assert that an array, list or other collection is empty - - An array, list or other collection implementing IEnumerable - The message to be displayed on failure - - - - Assert that an array,list or other collection is empty - - An array, list or other collection implementing IEnumerable - - - - Assert that an array, list or other collection is empty - - An array, list or other collection implementing IEnumerable - The message to be displayed on failure - Arguments to be used in formatting the message - - - - Assert that an array, list or other collection is empty - - An array, list or other collection implementing IEnumerable - The message to be displayed on failure - - - - Assert that an array,list or other collection is empty - - An array, list or other collection implementing IEnumerable - - - - Assert that an array, list or other collection is ordered - - An array, list or other collection implementing IEnumerable - The message to be displayed on failure - Arguments to be used in formatting the message - - - - Assert that an array, list or other collection is ordered - - An array, list or other collection implementing IEnumerable - The message to be displayed on failure - - - - Assert that an array, list or other collection is ordered - - An array, list or other collection implementing IEnumerable - - - - Assert that an array, list or other collection is ordered - - An array, list or other collection implementing IEnumerable - A custom comparer to perform the comparisons - The message to be displayed on failure - Arguments to be used in formatting the message - - - - Assert that an array, list or other collection is ordered - - An array, list or other collection implementing IEnumerable - A custom comparer to perform the comparisons - The message to be displayed on failure - - - - Assert that an array, list or other collection is ordered - - An array, list or other collection implementing IEnumerable - A custom comparer to perform the comparisons - - - - Static helper class used in the constraint-based syntax - - - - - Creates a new SubstringConstraint - - The value of the substring - A SubstringConstraint - - - - Creates a new CollectionContainsConstraint. - - The item that should be found. - A new CollectionContainsConstraint - - - - Summary description for DirectoryAssert - - - - - The Equals method throws an AssertionException. This is done - to make sure there is no mistake by calling this function. - - - - - - - override the default ReferenceEquals to throw an AssertionException. This - implementation makes sure there is no mistake in calling this function - as part of Assert. - - - - - - - We don't actually want any instances of this object, but some people - like to inherit from it to add other static methods. Hence, the - protected constructor disallows any instances of this object. - - - - - Verifies that two directories are equal. Two directories are considered - equal if both are null, or if both have the same value byte for byte. - If they are not equal an is thrown. - - A directory containing the value that is expected - A directory containing the actual value - The message to display if directories are not equal - Arguments to be used in formatting the message - - - - Verifies that two directories are equal. Two directories are considered - equal if both are null, or if both have the same value byte for byte. - If they are not equal an is thrown. - - A directory containing the value that is expected - A directory containing the actual value - The message to display if directories are not equal - - - - Verifies that two directories are equal. Two directories are considered - equal if both are null, or if both have the same value byte for byte. - If they are not equal an is thrown. - - A directory containing the value that is expected - A directory containing the actual value - - - - Verifies that two directories are equal. Two directories are considered - equal if both are null, or if both have the same value byte for byte. - If they are not equal an is thrown. - - A directory path string containing the value that is expected - A directory path string containing the actual value - The message to display if directories are not equal - Arguments to be used in formatting the message - - - - Verifies that two directories are equal. Two directories are considered - equal if both are null, or if both have the same value byte for byte. - If they are not equal an is thrown. - - A directory path string containing the value that is expected - A directory path string containing the actual value - The message to display if directories are not equal - - - - Verifies that two directories are equal. Two directories are considered - equal if both are null, or if both have the same value byte for byte. - If they are not equal an is thrown. - - A directory path string containing the value that is expected - A directory path string containing the actual value - - - - Asserts that two directories are not equal. If they are equal - an is thrown. - - A directory containing the value that is expected - A directory containing the actual value - The message to display if directories are not equal - Arguments to be used in formatting the message - - - - Asserts that two directories are not equal. If they are equal - an is thrown. - - A directory containing the value that is expected - A directory containing the actual value - The message to display if directories are not equal - - - - Asserts that two directories are not equal. If they are equal - an is thrown. - - A directory containing the value that is expected - A directory containing the actual value - - - - Asserts that two directories are not equal. If they are equal - an is thrown. - - A directory path string containing the value that is expected - A directory path string containing the actual value - The message to display if directories are equal - Arguments to be used in formatting the message - - - - Asserts that two directories are not equal. If they are equal - an is thrown. - - A directory path string containing the value that is expected - A directory path string containing the actual value - The message to display if directories are equal - - - - Asserts that two directories are not equal. If they are equal - an is thrown. - - A directory path string containing the value that is expected - A directory path string containing the actual value - - - - Asserts that the directory is empty. If it is not empty - an is thrown. - - A directory to search - The message to display if directories are not equal - Arguments to be used in formatting the message - - - - Asserts that the directory is empty. If it is not empty - an is thrown. - - A directory to search - The message to display if directories are not equal - - - - Asserts that the directory is empty. If it is not empty - an is thrown. - - A directory to search - - - - Asserts that the directory is empty. If it is not empty - an is thrown. - - A directory to search - The message to display if directories are not equal - Arguments to be used in formatting the message - - - - Asserts that the directory is empty. If it is not empty - an is thrown. - - A directory to search - The message to display if directories are not equal - - - - Asserts that the directory is empty. If it is not empty - an is thrown. - - A directory to search - - - - Asserts that the directory is not empty. If it is empty - an is thrown. - - A directory to search - The message to display if directories are not equal - Arguments to be used in formatting the message - - - - Asserts that the directory is not empty. If it is empty - an is thrown. - - A directory to search - The message to display if directories are not equal - - - - Asserts that the directory is not empty. If it is empty - an is thrown. - - A directory to search - - - - Asserts that the directory is not empty. If it is empty - an is thrown. - - A directory to search - The message to display if directories are not equal - Arguments to be used in formatting the message - - - - Asserts that the directory is not empty. If it is empty - an is thrown. - - A directory to search - The message to display if directories are not equal - - - - Asserts that the directory is not empty. If it is empty - an is thrown. - - A directory to search - - - - Asserts that path contains actual as a subdirectory or - an is thrown. - - A directory to search - sub-directory asserted to exist under directory - The message to display if directory is not within the path - Arguments to be used in formatting the message - - - - Asserts that path contains actual as a subdirectory or - an is thrown. - - A directory to search - sub-directory asserted to exist under directory - The message to display if directory is not within the path - - - - Asserts that path contains actual as a subdirectory or - an is thrown. - - A directory to search - sub-directory asserted to exist under directory - - - - Asserts that path contains actual as a subdirectory or - an is thrown. - - A directory to search - sub-directory asserted to exist under directory - The message to display if directory is not within the path - Arguments to be used in formatting the message - - - - Asserts that path contains actual as a subdirectory or - an is thrown. - - A directory to search - sub-directory asserted to exist under directory - The message to display if directory is not within the path - - - - Asserts that path contains actual as a subdirectory or - an is thrown. - - A directory to search - sub-directory asserted to exist under directory - - - - Asserts that path does not contain actual as a subdirectory or - an is thrown. - - A directory to search - sub-directory asserted to exist under directory - The message to display if directory is not within the path - Arguments to be used in formatting the message - - - - Asserts that path does not contain actual as a subdirectory or - an is thrown. - - A directory to search - sub-directory asserted to exist under directory - The message to display if directory is not within the path - - - - Asserts that path does not contain actual as a subdirectory or - an is thrown. - - A directory to search - sub-directory asserted to exist under directory - - - - Asserts that path does not contain actual as a subdirectory or - an is thrown. - - A directory to search - sub-directory asserted to exist under directory - The message to display if directory is not within the path - Arguments to be used in formatting the message - - - - Asserts that path does not contain actual as a subdirectory or - an is thrown. - - A directory to search - sub-directory asserted to exist under directory - The message to display if directory is not within the path - - - - Asserts that path does not contain actual as a subdirectory or - an is thrown. - - A directory to search - sub-directory asserted to exist under directory - - - - Summary description for FileAssert. - - - - - The Equals method throws an AssertionException. This is done - to make sure there is no mistake by calling this function. - - - - - - - override the default ReferenceEquals to throw an AssertionException. This - implementation makes sure there is no mistake in calling this function - as part of Assert. - - - - - - - We don't actually want any instances of this object, but some people - like to inherit from it to add other static methods. Hence, the - protected constructor disallows any instances of this object. - - - - - Verifies that two Streams are equal. Two Streams are considered - equal if both are null, or if both have the same value byte for byte. - If they are not equal an is thrown. - - The expected Stream - The actual Stream - The message to display if Streams are not equal - Arguments to be used in formatting the message - - - - Verifies that two Streams are equal. Two Streams are considered - equal if both are null, or if both have the same value byte for byte. - If they are not equal an is thrown. - - The expected Stream - The actual Stream - The message to display if objects are not equal - - - - Verifies that two Streams are equal. Two Streams are considered - equal if both are null, or if both have the same value byte for byte. - If they are not equal an is thrown. - - The expected Stream - The actual Stream - - - - Verifies that two files are equal. Two files are considered - equal if both are null, or if both have the same value byte for byte. - If they are not equal an is thrown. - - A file containing the value that is expected - A file containing the actual value - The message to display if Streams are not equal - Arguments to be used in formatting the message - - - - Verifies that two files are equal. Two files are considered - equal if both are null, or if both have the same value byte for byte. - If they are not equal an is thrown. - - A file containing the value that is expected - A file containing the actual value - The message to display if objects are not equal - - - - Verifies that two files are equal. Two files are considered - equal if both are null, or if both have the same value byte for byte. - If they are not equal an is thrown. - - A file containing the value that is expected - A file containing the actual value - - - - Verifies that two files are equal. Two files are considered - equal if both are null, or if both have the same value byte for byte. - If they are not equal an is thrown. - - The path to a file containing the value that is expected - The path to a file containing the actual value - The message to display if Streams are not equal - Arguments to be used in formatting the message - - - - Verifies that two files are equal. Two files are considered - equal if both are null, or if both have the same value byte for byte. - If they are not equal an is thrown. - - The path to a file containing the value that is expected - The path to a file containing the actual value - The message to display if objects are not equal - - - - Verifies that two files are equal. Two files are considered - equal if both are null, or if both have the same value byte for byte. - If they are not equal an is thrown. - - The path to a file containing the value that is expected - The path to a file containing the actual value - - - - Asserts that two Streams are not equal. If they are equal - an is thrown. - - The expected Stream - The actual Stream - The message to be displayed when the two Stream are the same. - Arguments to be used in formatting the message - - - - Asserts that two Streams are not equal. If they are equal - an is thrown. - - The expected Stream - The actual Stream - The message to be displayed when the Streams are the same. - - - - Asserts that two Streams are not equal. If they are equal - an is thrown. - - The expected Stream - The actual Stream - - - - Asserts that two files are not equal. If they are equal - an is thrown. - - A file containing the value that is expected - A file containing the actual value - The message to display if Streams are not equal - Arguments to be used in formatting the message - - - - Asserts that two files are not equal. If they are equal - an is thrown. - - A file containing the value that is expected - A file containing the actual value - The message to display if objects are not equal - - - - Asserts that two files are not equal. If they are equal - an is thrown. - - A file containing the value that is expected - A file containing the actual value - - - - Asserts that two files are not equal. If they are equal - an is thrown. - - The path to a file containing the value that is expected - The path to a file containing the actual value - The message to display if Streams are not equal - Arguments to be used in formatting the message - - - - Asserts that two files are not equal. If they are equal - an is thrown. - - The path to a file containing the value that is expected - The path to a file containing the actual value - The message to display if objects are not equal - - - - Asserts that two files are not equal. If they are equal - an is thrown. - - The path to a file containing the value that is expected - The path to a file containing the actual value - - - - GlobalSettings is a place for setting default values used - by the framework in performing asserts. - - - - - Default tolerance for floating point equality - - - - - Helper class with properties and methods that supply - a number of constraints used in Asserts. - - - - - Returns a ConstraintExpression, which will apply - the following constraint to all members of a collection, - succeeding only if a specified number of them succeed. - - - - - Returns a new PropertyConstraintExpression, which will either - test for the existence of the named property on the object - being tested or apply any following constraint to that property. - - - - - Returns a new AttributeConstraint checking for the - presence of a particular attribute on an object. - - - - - Returns a new AttributeConstraint checking for the - presence of a particular attribute on an object. - - - - - Returns a new CollectionContainsConstraint checking for the - presence of a particular object in the collection. - - - - - Returns a ConstraintExpression that negates any - following constraint. - - - - - Returns a ConstraintExpression, which will apply - the following constraint to all members of a collection, - succeeding if all of them succeed. - - - - - Returns a ConstraintExpression, which will apply - the following constraint to all members of a collection, - succeeding if at least one of them succeeds. - - - - - Returns a ConstraintExpression, which will apply - the following constraint to all members of a collection, - succeeding if all of them fail. - - - - - Returns a new ConstraintExpression, which will apply the following - constraint to the Length property of the object being tested. - - - - - Returns a new ConstraintExpression, which will apply the following - constraint to the Count property of the object being tested. - - - - - Returns a new ConstraintExpression, which will apply the following - constraint to the Message property of the object being tested. - - - - - Returns a new ConstraintExpression, which will apply the following - constraint to the InnerException property of the object being tested. - - - - - Interface implemented by a user fixture in order to - validate any expected exceptions. It is only called - for test methods marked with the ExpectedException - attribute. - - - - - Method to handle an expected exception - - The exception to be handled - - - - Helper class with properties and methods that supply - a number of constraints used in Asserts. - - - - - Returns a constraint that tests two items for equality - - - - - Returns a constraint that tests that two references are the same object - - - - - Returns a constraint that tests whether the - actual value is greater than the suppled argument - - - - - Returns a constraint that tests whether the - actual value is greater than or equal to the suppled argument - - - - - Returns a constraint that tests whether the - actual value is greater than or equal to the suppled argument - - - - - Returns a constraint that tests whether the - actual value is less than the suppled argument - - - - - Returns a constraint that tests whether the - actual value is less than or equal to the suppled argument - - - - - Returns a constraint that tests whether the - actual value is less than or equal to the suppled argument - - - - - Returns a constraint that tests whether the actual - value is of the exact type supplied as an argument. - - - - - Returns a constraint that tests whether the actual - value is of the exact type supplied as an argument. - - - - - Returns a constraint that tests whether the actual value - is of the type supplied as an argument or a derived type. - - - - - Returns a constraint that tests whether the actual value - is of the type supplied as an argument or a derived type. - - - - - Returns a constraint that tests whether the actual value - is of the type supplied as an argument or a derived type. - - - - - Returns a constraint that tests whether the actual value - is of the type supplied as an argument or a derived type. - - - - - Returns a constraint that tests whether the actual value - is assignable from the type supplied as an argument. - - - - - Returns a constraint that tests whether the actual value - is assignable from the type supplied as an argument. - - - - - Returns a constraint that tests whether the actual value - is assignable from the type supplied as an argument. - - - - - Returns a constraint that tests whether the actual value - is assignable from the type supplied as an argument. - - - - - Returns a constraint that tests whether the actual value - is a collection containing the same elements as the - collection supplied as an argument. - - - - - Returns a constraint that tests whether the actual value - is a subset of the collection supplied as an argument. - - - - - Returns a constraint that succeeds if the actual - value contains the substring supplied as an argument. - - - - - Returns a constraint that succeeds if the actual - value starts with the substring supplied as an argument. - - - - - Returns a constraint that succeeds if the actual - value ends with the substring supplied as an argument. - - - - - Returns a constraint that succeeds if the actual - value matches the Regex pattern supplied as an argument. - - - - - Returns a constraint that tests whether the path provided - is the same as an expected path after canonicalization. - - - - - Returns a constraint that tests whether the path provided - is the same path or under an expected path after canonicalization. - - - - - Returns a constraint that tests whether the path provided - is the same path or under an expected path after canonicalization. - - - - - Returns a constraint that tests whether the actual value falls - within a specified range. - - - - - Returns a ConstraintExpression that negates any - following constraint. - - - - - Returns a ConstraintExpression, which will apply - the following constraint to all members of a collection, - succeeding if all of them succeed. - - - - - Returns a constraint that tests for null - - - - - Returns a constraint that tests for True - - - - - Returns a constraint that tests for False - - - - - Returns a constraint that tests for a positive value - - - - - Returns a constraint that tests for a negative value - - - - - Returns a constraint that tests for NaN - - - - - Returns a constraint that tests for empty - - - - - Returns a constraint that tests whether a collection - contains all unique items. - - - - - Returns a constraint that tests whether an object graph is serializable in binary format. - - - - - Returns a constraint that tests whether an object graph is serializable in xml format. - - - - - Returns a constraint that tests whether a collection is ordered - - - - - The Iz class is a synonym for Is intended for use in VB, - which regards Is as a keyword. - - - - - The List class is a helper class with properties and methods - that supply a number of constraints used with lists and collections. - - - - - List.Map returns a ListMapper, which can be used to map - the original collection to another collection. - - - - - - - ListMapper is used to transform a collection used as an actual argument - producing another collection to be used in the assertion. - - - - - Construct a ListMapper based on a collection - - The collection to be transformed - - - - Produces a collection containing all the values of a property - - The collection of property values - - - - - Randomizer returns a set of random values in a repeatable - way, to allow re-running of tests if necessary. - - - - - Get a randomizer for a particular member, returning - one that has already been created if it exists. - This ensures that the same values are generated - each time the tests are reloaded. - - - - - Get a randomizer for a particular parameter, returning - one that has already been created if it exists. - This ensures that the same values are generated - each time the tests are reloaded. - - - - - Construct a randomizer using a random seed - - - - - Construct a randomizer using a specified seed - - - - - Return an array of random doubles between 0.0 and 1.0. - - - - - - - Return an array of random doubles with values in a specified range. - - - - - Return an array of random ints with values in a specified range. - - - - - Get a random seed for use in creating a randomizer. - - - - - The SpecialValue enum is used to represent TestCase arguments - that cannot be used as arguments to an Attribute. - - - - - Null represents a null value, which cannot be used as an - argument to an attriute under .NET 1.x - - - - - Basic Asserts on strings. - - - - - The Equals method throws an AssertionException. This is done - to make sure there is no mistake by calling this function. - - - - - - - override the default ReferenceEquals to throw an AssertionException. This - implementation makes sure there is no mistake in calling this function - as part of Assert. - - - - - - - Asserts that a string is found within another string. - - The expected string - The string to be examined - The message to display in case of failure - Arguments used in formatting the message - - - - Asserts that a string is found within another string. - - The expected string - The string to be examined - The message to display in case of failure - - - - Asserts that a string is found within another string. - - The expected string - The string to be examined - - - - Asserts that a string is not found within another string. - - The expected string - The string to be examined - The message to display in case of failure - Arguments used in formatting the message - - - - Asserts that a string is found within another string. - - The expected string - The string to be examined - The message to display in case of failure - - - - Asserts that a string is found within another string. - - The expected string - The string to be examined - - - - Asserts that a string starts with another string. - - The expected string - The string to be examined - The message to display in case of failure - Arguments used in formatting the message - - - - Asserts that a string starts with another string. - - The expected string - The string to be examined - The message to display in case of failure - - - - Asserts that a string starts with another string. - - The expected string - The string to be examined - - - - Asserts that a string does not start with another string. - - The expected string - The string to be examined - The message to display in case of failure - Arguments used in formatting the message - - - - Asserts that a string does not start with another string. - - The expected string - The string to be examined - The message to display in case of failure - - - - Asserts that a string does not start with another string. - - The expected string - The string to be examined - - - - Asserts that a string ends with another string. - - The expected string - The string to be examined - The message to display in case of failure - Arguments used in formatting the message - - - - Asserts that a string ends with another string. - - The expected string - The string to be examined - The message to display in case of failure - - - - Asserts that a string ends with another string. - - The expected string - The string to be examined - - - - Asserts that a string does not end with another string. - - The expected string - The string to be examined - The message to display in case of failure - Arguments used in formatting the message - - - - Asserts that a string does not end with another string. - - The expected string - The string to be examined - The message to display in case of failure - - - - Asserts that a string does not end with another string. - - The expected string - The string to be examined - - - - Asserts that two strings are equal, without regard to case. - - The expected string - The actual string - The message to display in case of failure - Arguments used in formatting the message - - - - Asserts that two strings are equal, without regard to case. - - The expected string - The actual string - The message to display in case of failure - - - - Asserts that two strings are equal, without regard to case. - - The expected string - The actual string - - - - Asserts that two strings are not equal, without regard to case. - - The expected string - The actual string - The message to display in case of failure - Arguments used in formatting the message - - - - Asserts that two strings are Notequal, without regard to case. - - The expected string - The actual string - The message to display in case of failure - - - - Asserts that two strings are not equal, without regard to case. - - The expected string - The actual string - - - - Asserts that a string matches an expected regular expression pattern. - - The regex pattern to be matched - The actual string - The message to display in case of failure - Arguments used in formatting the message - - - - Asserts that a string matches an expected regular expression pattern. - - The regex pattern to be matched - The actual string - The message to display in case of failure - - - - Asserts that a string matches an expected regular expression pattern. - - The regex pattern to be matched - The actual string - - - - Asserts that a string does not match an expected regular expression pattern. - - The regex pattern to be used - The actual string - The message to display in case of failure - Arguments used in formatting the message - - - - Asserts that a string does not match an expected regular expression pattern. - - The regex pattern to be used - The actual string - The message to display in case of failure - - - - Asserts that a string does not match an expected regular expression pattern. - - The regex pattern to be used - The actual string - - - - The TestCaseData class represents a set of arguments - and other parameter info to be used for a parameterized - test case. It provides a number of instance modifiers - for use in initializing the test case. - - Note: Instance modifiers are getters that return - the same instance after modifying it's state. - - - - - The argument list to be provided to the test - - - - - The expected result to be returned - - - - - Set to true if this has an expected result - - - - - The expected exception Type - - - - - The FullName of the expected exception - - - - - The name to be used for the test - - - - - The description of the test - - - - - A dictionary of properties, used to add information - to tests without requiring the class to change. - - - - - If true, indicates that the test case is to be ignored - - - - - If true, indicates that the test case is marked explicit - - - - - The reason for ignoring a test case - - - - - Initializes a new instance of the class. - - The arguments. - - - - Initializes a new instance of the class. - - The argument. - - - - Initializes a new instance of the class. - - The first argument. - The second argument. - - - - Initializes a new instance of the class. - - The first argument. - The second argument. - The third argument. - - - - Sets the expected result for the test - - The expected result - A modified TestCaseData - - - - Sets the expected exception type for the test - - Type of the expected exception. - The modified TestCaseData instance - - - - Sets the expected exception type for the test - - FullName of the expected exception. - The modified TestCaseData instance - - - - Sets the name of the test case - - The modified TestCaseData instance - - - - Sets the description for the test case - being constructed. - - The description. - The modified TestCaseData instance. - - - - Applies a category to the test - - - - - - - Applies a named property to the test - - - - - - - - Applies a named property to the test - - - - - - - - Applies a named property to the test - - - - - - - - Ignores this TestCase. - - - - - - Ignores this TestCase, specifying the reason. - - The reason. - - - - - Marks this TestCase as Explicit - - - - - - Marks this TestCase as Explicit, specifying the reason. - - The reason. - - - - - Gets the argument list to be provided to the test - - - - - Gets the expected result - - - - - Returns true if the result has been set - - - - - Gets the expected exception Type - - - - - Gets the FullName of the expected exception - - - - - Gets the name to be used for the test - - - - - Gets the description of the test - - - - - Gets a value indicating whether this is ignored. - - true if ignored; otherwise, false. - - - - Gets a value indicating whether this is explicit. - - true if explicit; otherwise, false. - - - - Gets the ignore reason. - - The ignore reason. - - - - Gets a list of categories associated with this test. - - - - - Gets the property dictionary for this test - - - - - Provide the context information of the current test - - - - - Constructs a TestContext using the provided context dictionary - - A context dictionary - - - - Get the current test context. This is created - as needed. The user may save the context for - use within a test, but it should not be used - outside the test for which it is created. - - - - - Gets a TestAdapter representing the currently executing test in this context. - - - - - Gets a ResultAdapter representing the current result for the test - executing in this context. - - - - - Gets the directory containing the current test assembly. - - - - - Gets the directory to be used for outputing files created - by this test run. - - - - - TestAdapter adapts a Test for consumption by - the user test code. - - - - - Constructs a TestAdapter for this context - - The context dictionary - - - - The name of the test. - - - - - The FullName of the test - - - - - The properties of the test. - - - - - ResultAdapter adapts a TestResult for consumption by - the user test code. - - - - - Construct a ResultAdapter for a context - - The context holding the result - - - - The TestState of current test. This maps to the ResultState - used in nunit.core and is subject to change in the future. - - - - - The TestStatus of current test. This enum will be used - in future versions of NUnit and so is to be preferred - to the TestState value. - - - - - Provides details about a test - - - - - Creates an instance of TestDetails - - The fixture that the test is a member of, if available. - The method that implements the test, if available. - The full name of the test. - A string representing the type of test, e.g. "Test Case". - Indicates if the test represents a suite of tests. - - - - The fixture that the test is a member of, if available. - - - - - The method that implements the test, if available. - - - - - The full name of the test. - - - - - A string representing the type of test, e.g. "Test Case". - - - - - Indicates if the test represents a suite of tests. - - - - - The ResultState enum indicates the result of running a test - - - - - The result is inconclusive - - - - - The test was not runnable. - - - - - The test has been skipped. - - - - - The test has been ignored. - - - - - The test succeeded - - - - - The test failed - - - - - The test encountered an unexpected exception - - - - - The test was cancelled by the user - - - - - The TestStatus enum indicates the result of running a test - - - - - The test was inconclusive - - - - - The test has skipped - - - - - The test succeeded - - - - - The test failed - - - - - Helper class with static methods used to supply constraints - that operate on strings. - - - - - Returns a constraint that succeeds if the actual - value contains the substring supplied as an argument. - - - - - Returns a constraint that fails if the actual - value contains the substring supplied as an argument. - - - - - Returns a constraint that succeeds if the actual - value starts with the substring supplied as an argument. - - - - - Returns a constraint that fails if the actual - value starts with the substring supplied as an argument. - - - - - Returns a constraint that succeeds if the actual - value ends with the substring supplied as an argument. - - - - - Returns a constraint that fails if the actual - value ends with the substring supplied as an argument. - - - - - Returns a constraint that succeeds if the actual - value matches the Regex pattern supplied as an argument. - - - - - Returns a constraint that fails if the actual - value matches the pattern supplied as an argument. - - - - - Returns a ConstraintExpression, which will apply - the following constraint to all members of a collection, - succeeding if all of them succeed. - - - - - TextMessageWriter writes constraint descriptions and messages - in displayable form as a text stream. It tailors the display - of individual message components to form the standard message - format of NUnit assertion failure messages. - - - - - Prefix used for the expected value line of a message - - - - - Prefix used for the actual value line of a message - - - - - Length of a message prefix - - - - - Construct a TextMessageWriter - - - - - Construct a TextMessageWriter, specifying a user message - and optional formatting arguments. - - - - - - - Method to write single line message with optional args, usually - written to precede the general failure message, at a givel - indentation level. - - The indentation level of the message - The message to be written - Any arguments used in formatting the message - - - - Display Expected and Actual lines for a constraint. This - is called by MessageWriter's default implementation of - WriteMessageTo and provides the generic two-line display. - - The constraint that failed - - - - Display Expected and Actual lines for given values. This - method may be called by constraints that need more control over - the display of actual and expected values than is provided - by the default implementation. - - The expected value - The actual value causing the failure - - - - Display Expected and Actual lines for given values, including - a tolerance value on the expected line. - - The expected value - The actual value causing the failure - The tolerance within which the test was made - - - - Display the expected and actual string values on separate lines. - If the mismatch parameter is >=0, an additional line is displayed - line containing a caret that points to the mismatch point. - - The expected string value - The actual string value - The point at which the strings don't match or -1 - If true, case is ignored in string comparisons - If true, clip the strings to fit the max line length - - - - Writes the text for a connector. - - The connector. - - - - Writes the text for a predicate. - - The predicate. - - - - Write the text for a modifier. - - The modifier. - - - - Writes the text for an expected value. - - The expected value. - - - - Writes the text for an actual value. - - The actual value. - - - - Writes the text for a generalized value. - - The value. - - - - Writes the text for a collection value, - starting at a particular point, to a max length - - The collection containing elements to write. - The starting point of the elements to write - The maximum number of elements to write - - - - Write the generic 'Expected' line for a constraint - - The constraint that failed - - - - Write the generic 'Expected' line for a given value - - The expected value - - - - Write the generic 'Expected' line for a given value - and tolerance. - - The expected value - The tolerance within which the test was made - - - - Write the generic 'Actual' line for a constraint - - The constraint for which the actual value is to be written - - - - Write the generic 'Actual' line for a given value - - The actual value causing a failure - - - - Gets or sets the maximum line length for this writer - - - - - Helper class with properties and methods that supply - constraints that operate on exceptions. - - - - - Creates a constraint specifying the exact type of exception expected - - - - - Creates a constraint specifying the exact type of exception expected - - - - - Creates a constraint specifying the type of exception expected - - - - - Creates a constraint specifying the type of exception expected - - - - - Creates a constraint specifying an expected exception - - - - - Creates a constraint specifying an exception with a given InnerException - - - - - Creates a constraint specifying an expected TargetInvocationException - - - - - Creates a constraint specifying an expected TargetInvocationException - - - - - Creates a constraint specifying an expected TargetInvocationException - - - - - Creates a constraint specifying that no exception is thrown - - - - diff --git a/packages/NUnitTestAdapter.WithFramework.2.0.0/lib/nunit.util.dll b/packages/NUnitTestAdapter.WithFramework.2.0.0/lib/nunit.util.dll deleted file mode 100644 index c7e0294..0000000 Binary files a/packages/NUnitTestAdapter.WithFramework.2.0.0/lib/nunit.util.dll and /dev/null differ diff --git a/packages/NUnitTestAdapter.WithFramework.2.0.0/tools/install.ps1 b/packages/NUnitTestAdapter.WithFramework.2.0.0/tools/install.ps1 deleted file mode 100644 index 7ba6ede..0000000 --- a/packages/NUnitTestAdapter.WithFramework.2.0.0/tools/install.ps1 +++ /dev/null @@ -1,12 +0,0 @@ -param($installPath, $toolsPath, $package, $project) -$asms = $package.AssemblyReferences | %{$_.Name} -foreach ($reference in $project.Object.References) -{ - if ($asms -contains $reference.Name + ".dll") - { - if ($reference.Name -ne "nunit.framework") - { - $reference.CopyLocal = $false; - } - } -} diff --git a/robotlegs-sharp-framework-test.csproj b/robotlegs-sharp-framework-test.csproj index 3cb4631..840e043 100644 --- a/robotlegs-sharp-framework-test.csproj +++ b/robotlegs-sharp-framework-test.csproj @@ -1,5 +1,6 @@  + Debug AnyCPU @@ -8,6 +9,8 @@ robotlegs.bender Robotlegs-Sharp-Framework-Test v4.5 + + true @@ -28,39 +31,35 @@ false - - packages\Castle.Core.3.3.3\lib\net45\Castle.Core.dll + + packages\Castle.Core.4.3.1\lib\net45\Castle.Core.dll True - - packages\Moq.4.5.8\lib\net45\Moq.dll + + packages\Moq.4.9.0\lib\net45\Moq.dll True - - packages\NUnitTestAdapter.WithFramework.2.0.0\lib\nunit.core.dll - False - - - packages\NUnitTestAdapter.WithFramework.2.0.0\lib\nunit.core.interfaces.dll - False - - - packages\NUnitTestAdapter.WithFramework.2.0.0\lib\nunit.framework.dll + + packages\NUnit.3.10.1\lib\net45\nunit.framework.dll True - - packages\NUnitTestAdapter.WithFramework.2.0.0\lib\nunit.util.dll - False - - - packages\NUnitTestAdapter.WithFramework.2.0.0\lib\NUnit.VisualStudio.TestAdapter.dll - False - lib\swiftsuspenders-sharp.dll - False + + + packages\System.Runtime.CompilerServices.Unsafe.4.5.1\lib\netstandard1.0\System.Runtime.CompilerServices.Unsafe.dll + True + + + packages\System.Threading.Tasks.Extensions.4.5.1\lib\portable-net45+win8+wp8+wpa81\System.Threading.Tasks.Extensions.dll + True + + + packages\System.ValueTuple.4.5.0\lib\netstandard1.0\System.ValueTuple.dll + True + @@ -99,6 +98,13 @@ + + + + + + + @@ -230,15 +236,27 @@ + + - {ba0b7671-3283-4afe-b5b2-8cf9bd9c74be} + {BA0B7671-3283-4AFE-B5B2-8CF9BD9C74BE} robotlegs-sharp-framework + + + + + + + 这台计算机上缺少此项目引用的 NuGet 程序包。使用“NuGet 程序包还原”可下载这些程序包。有关更多信息，请参见 http://go.microsoft.com/fwlink/?LinkID=322105。缺少的文件是 {0}。 + + + \ No newline at end of file diff --git a/robotlegs-sharp-framework.csproj b/robotlegs-sharp-framework.csproj index f55fe5c..85b37a3 100644 --- a/robotlegs-sharp-framework.csproj +++ b/robotlegs-sharp-framework.csproj @@ -1,224 +1,212 @@ - - - - Debug - AnyCPU - {BA0B7671-3283-4AFE-B5B2-8CF9BD9C74BE} - Library - robotlegs.bender - Robotlegs-Sharp-Framework - v3.5 - - - true - full - false - bin\Debug - DEBUG; - prompt - 4 - false - - - full - true - bin\Release - prompt - 4 - false - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - lib\swiftsuspenders-sharp.dll - False - - + + + + Debug + AnyCPU + {BA0B7671-3283-4AFE-B5B2-8CF9BD9C74BE} + Library + robotlegs.bender + Robotlegs-Sharp-Framework + v3.5 + + + true + full + false + bin\Debug + DEBUG; + prompt + 4 + false + + + full + true + bin\Release + prompt + 4 + false + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + False + lib\swiftsuspenders-sharp.dll + + + \ No newline at end of file diff --git a/robotlegs-sharp-platform-unity.csproj b/robotlegs-sharp-platform-unity.csproj index 8d0f1fb..a507b4e 100644 --- a/robotlegs-sharp-platform-unity.csproj +++ b/robotlegs-sharp-platform-unity.csproj @@ -28,7 +28,11 @@ 4 false - + + + Always + + @@ -63,6 +67,7 @@ lib\UnityEngine.dll + False diff --git a/src/Robotlegs/Bender/Bundles/MVCS/MVCSBundle.cs b/src/Robotlegs/Bender/Bundles/MVCS/MVCSBundle.cs index 3b3c1c9..116691e 100644 --- a/src/Robotlegs/Bender/Bundles/MVCS/MVCSBundle.cs +++ b/src/Robotlegs/Bender/Bundles/MVCS/MVCSBundle.cs @@ -5,6 +5,7 @@ // in accordance with the terms of the license agreement accompanying it. //------------------------------------------------------------------------------ +using Robotlegs.Bender.Extensions.DirectAsyncCommand; using Robotlegs.Bender.Extensions.DirectCommand; using Robotlegs.Bender.Extensions.EnhancedLogging; using Robotlegs.Bender.Extensions.EventCommand; @@ -36,7 +37,8 @@ public void Extend(IContext context) context.Install(typeof(VigilanceExtension)); context.Install(typeof(InjectableLoggerExtension)); context.Install(typeof(EventDispatcherExtension)); - context.Install(typeof(DirectCommandMapExtension)); + context.Install(typeof(DirectAsyncCommandMapExtension)); + context.Install(typeof(DirectCommandMapExtension)); context.Install(typeof(EventCommandMapExtension)); context.Install(typeof(LocalEventMapExtension)); context.Install(typeof(ViewManagerExtension)); diff --git a/src/Robotlegs/Bender/Extensions/CommandCenter/API/CommandPayload.cs b/src/Robotlegs/Bender/Extensions/CommandCenter/API/CommandPayload.cs index ad66ce1..60618ba 100644 --- a/src/Robotlegs/Bender/Extensions/CommandCenter/API/CommandPayload.cs +++ b/src/Robotlegs/Bender/Extensions/CommandCenter/API/CommandPayload.cs @@ -5,7 +5,7 @@ // in accordance with the terms of the license agreement accompanying it. //------------------------------------------------------------------------------ -using System; + using System; using System.Collections.Generic; namespace Robotlegs.Bender.Extensions.CommandCenter.API diff --git a/src/Robotlegs/Bender/Extensions/DirectAsyncCommand/API/IAsyncCommand.cs b/src/Robotlegs/Bender/Extensions/DirectAsyncCommand/API/IAsyncCommand.cs new file mode 100644 index 0000000..94566ea --- /dev/null +++ b/src/Robotlegs/Bender/Extensions/DirectAsyncCommand/API/IAsyncCommand.cs @@ -0,0 +1,41 @@ +//------------------------------------------------------------------------------ +// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. +// +// NOTICE: You are permitted to use, modify, and distribute this file +// in accordance with the terms of the license agreement accompanying it. +//------------------------------------------------------------------------------ + +using Robotlegs.Bender.Extensions.CommandCenter.API; +using System; + +namespace Robotlegs.Bender.Extensions.DirectAsyncCommand.API +{ + /// + /// AsyncCommand interface + /// + /// + public interface IAsyncCommand : ICommand + { + #region Properties + + /// + /// Gets the executed callback. + /// + /// The executed callback. + Action ExecutedCallback + { + get; + } + + #endregion Properties + + #region Methods + + /// + /// Aborts asynchronous operation. + /// + void Abort(); + + #endregion Methods + } +} \ No newline at end of file diff --git a/src/Robotlegs/Bender/Extensions/DirectAsyncCommand/API/IAsyncCommandExecutor.cs b/src/Robotlegs/Bender/Extensions/DirectAsyncCommand/API/IAsyncCommandExecutor.cs new file mode 100644 index 0000000..c8dfed0 --- /dev/null +++ b/src/Robotlegs/Bender/Extensions/DirectAsyncCommand/API/IAsyncCommandExecutor.cs @@ -0,0 +1,61 @@ +//------------------------------------------------------------------------------ +// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. +// +// NOTICE: You are permitted to use, modify, and distribute this file +// in accordance with the terms of the license agreement accompanying it. +//------------------------------------------------------------------------------ + +using Robotlegs.Bender.Extensions.CommandCenter.API; +using System; +using System.Collections.Generic; + +namespace Robotlegs.Bender.Extensions.DirectAsyncCommand.API +{ + /// + /// Optional asynchronous Command interface. + /// + public interface IAsyncCommandExecutor + { + #region Properties + + /// + /// Gets a value indicating whether the asynchronous commands execution is aborted. + /// + /// true if the asynchronous commands is aborted; otherwise, false. + bool IsAborted + { + get; + } + + #endregion Properties + + #region Methods + + /// + /// Aborts asynchronous Command execution. + /// + /// if set to true abort current command execution. + void Abort(bool abortCurrentCommand = true); + + /// + /// Execute a list of asynchronous commands for a given list of mappings + /// + /// The Command Mappings + /// The Command Payload + void ExecuteAsyncCommands(IEnumerable mapping, CommandPayload payload); + + /// + /// Sets the callback function that remaining commands was aborted. + /// + /// The callback function that remaining commands was aborted. + void SetCommandsAbortedCallback(Action callback); + + /// + /// Sets the callback function that all commands executed. + /// + /// The callback function that all commands executed to invoke. + void SetCommandsExecutedCallback(Action callback); + + #endregion Methods + } +} \ No newline at end of file diff --git a/src/Robotlegs/Bender/Extensions/DirectAsyncCommand/API/IDirectAsyncCommandMap.cs b/src/Robotlegs/Bender/Extensions/DirectAsyncCommand/API/IDirectAsyncCommandMap.cs new file mode 100644 index 0000000..4034ec3 --- /dev/null +++ b/src/Robotlegs/Bender/Extensions/DirectAsyncCommand/API/IDirectAsyncCommandMap.cs @@ -0,0 +1,45 @@ +//------------------------------------------------------------------------------ +// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. +// +// NOTICE: You are permitted to use, modify, and distribute this file +// in accordance with the terms of the license agreement accompanying it. +//------------------------------------------------------------------------------ + +using System; +using Robotlegs.Bender.Extensions.CommandCenter.Impl; + +namespace Robotlegs.Bender.Extensions.DirectAsyncCommand.API +{ + public interface IDirectAsyncCommandMap : IDirectAsyncCommandMapper + { + #region Properties + + /// + /// Gets a value indicating whether the asynchronous commands execution is aborted. + /// + /// true if the asynchronous commands is aborted; otherwise, false. + bool IsAborted + { + get; + } + + #endregion Properties + + #region Methods + + /// + /// Aborts the asynchronous commands execution. + /// + /// if set to true abort current command execution. + void Abort(bool abortCurrentCommand = true); + + /// + /// Adds a handler to the process mappings + /// + /// Self + /// Delegate that accepts a mapping + IDirectAsyncCommandMap AddMappingProcessor(CommandMappingList.Processor handler); + + #endregion Methods + } +} \ No newline at end of file diff --git a/src/Robotlegs/Bender/Extensions/DirectAsyncCommand/API/IDirectAsyncCommandMapper.cs b/src/Robotlegs/Bender/Extensions/DirectAsyncCommand/API/IDirectAsyncCommandMapper.cs new file mode 100644 index 0000000..e615769 --- /dev/null +++ b/src/Robotlegs/Bender/Extensions/DirectAsyncCommand/API/IDirectAsyncCommandMapper.cs @@ -0,0 +1,47 @@ +//------------------------------------------------------------------------------ +// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. +// +// NOTICE: You are permitted to use, modify, and distribute this file +// in accordance with the terms of the license agreement accompanying it. +//------------------------------------------------------------------------------ + +using Robotlegs.Bender.Extensions.CommandCenter.API; +using Robotlegs.Bender.Extensions.DirectAsyncCommand.DSL; +using System; + +namespace Robotlegs.Bender.Extensions.DirectAsyncCommand.API +{ + public interface IDirectAsyncCommandMapper + { + #region Methods + + /// + /// Executes the configured command(s) + /// + /// The command payload + void Execute(CommandPayload payload = null); + + /// + /// Creates a mapping for a command class. + /// + /// The concrete asynchronous command class. + /// The command configurator. + IDirectAsyncCommandConfigurator Map() where T : IAsyncCommand; + + /// + /// Sets the callback function that remaining commands was aborted. + /// + /// The callback function that remaining commands was aborted. + /// The command mapper. + IDirectAsyncCommandMapper SetCommandsAbortedCallback(Action callback); + + /// + /// Sets the callback function that all commands executed. + /// + /// The callback function that all commands executed. + /// The command mapper. + IDirectAsyncCommandMapper SetCommandsExecutedCallback(Action callback); + + #endregion Methods + } +} \ No newline at end of file diff --git a/src/Robotlegs/Bender/Extensions/DirectAsyncCommand/DSL/IDirectAsyncCommandConfigurator.cs b/src/Robotlegs/Bender/Extensions/DirectAsyncCommand/DSL/IDirectAsyncCommandConfigurator.cs new file mode 100644 index 0000000..3f15b12 --- /dev/null +++ b/src/Robotlegs/Bender/Extensions/DirectAsyncCommand/DSL/IDirectAsyncCommandConfigurator.cs @@ -0,0 +1,46 @@ +//------------------------------------------------------------------------------ +// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. +// +// NOTICE: You are permitted to use, modify, and distribute this file +// in accordance with the terms of the license agreement accompanying it. +//------------------------------------------------------------------------------ + +using Robotlegs.Bender.Extensions.DirectAsyncCommand.API; + +namespace Robotlegs.Bender.Extensions.DirectAsyncCommand.DSL +{ + public interface IDirectAsyncCommandConfigurator : IDirectAsyncCommandMapper + { + #region Methods + + /// + /// The 'execute' method to invoke on the Command instance + /// + /// Self + /// The method name + IDirectAsyncCommandConfigurator WithExecuteMethod(string name); + + /// + /// Guards to check before allowing a command to execute + /// + /// Self + /// Guards + IDirectAsyncCommandConfigurator WithGuards(params object[] guards); + + /// + /// Hooks to run before command execution + /// + /// Self + /// Hooks + IDirectAsyncCommandConfigurator WithHooks(params object[] hooks); + + /// + /// Should the payload values be injected into the command instance? + /// + /// Self + /// Toggle + IDirectAsyncCommandConfigurator WithPayloadInjection(bool value = true); + + #endregion Methods + } +} \ No newline at end of file diff --git a/src/Robotlegs/Bender/Extensions/DirectAsyncCommand/DirectAsyncCommandMapExtension.cs b/src/Robotlegs/Bender/Extensions/DirectAsyncCommand/DirectAsyncCommandMapExtension.cs new file mode 100644 index 0000000..51f0501 --- /dev/null +++ b/src/Robotlegs/Bender/Extensions/DirectAsyncCommand/DirectAsyncCommandMapExtension.cs @@ -0,0 +1,24 @@ +//------------------------------------------------------------------------------ +// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. +// +// NOTICE: You are permitted to use, modify, and distribute this file +// in accordance with the terms of the license agreement accompanying it. +//------------------------------------------------------------------------------ + +using Robotlegs.Bender.Extensions.DirectAsyncCommand.API; +using Robotlegs.Bender.Framework.API; + +namespace Robotlegs.Bender.Extensions.DirectAsyncCommand +{ + public class DirectAsyncCommandMapExtension : IExtension + { + /*============================================================================*/ + /* Public Functions */ + /*============================================================================*/ + + public void Extend(IContext context) + { + context.injector.Map(typeof(IDirectAsyncCommandMap)).ToType(typeof(Impl.DirectAsyncCommandMap)); + } + } +} \ No newline at end of file diff --git a/src/Robotlegs/Bender/Extensions/DirectAsyncCommand/Impl/AsyncCommand.cs b/src/Robotlegs/Bender/Extensions/DirectAsyncCommand/Impl/AsyncCommand.cs new file mode 100644 index 0000000..f7cbae0 --- /dev/null +++ b/src/Robotlegs/Bender/Extensions/DirectAsyncCommand/Impl/AsyncCommand.cs @@ -0,0 +1,54 @@ +//------------------------------------------------------------------------------ +// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. +// +// NOTICE: You are permitted to use, modify, and distribute this file +// in accordance with the terms of the license agreement accompanying it. +//------------------------------------------------------------------------------ + +using Robotlegs.Bender.Extensions.DirectAsyncCommand.API; +using System; + +namespace Robotlegs.Bender.Extensions.DirectAsyncCommand.Impl +{ + public abstract class AsyncCommand : IAsyncCommand + { + /*============================================================================*/ + /* Public Properties */ + /*============================================================================*/ + + #region Properties + + [Inject(true, "AsyncCommandExecutedCallback")] + public Action ExecutedCallback + { + get; + protected set; + } + + #endregion Properties + + /*============================================================================*/ + /* Public Functions */ + /*============================================================================*/ + + #region Methods + + public virtual void Abort() + { + Executed(true); + } + + public abstract void Execute(); + + /*============================================================================*/ + /* Protected Functions */ + /*============================================================================*/ + + protected virtual void Executed(bool stop = false) + { + ExecutedCallback?.Invoke(this, stop); + } + + #endregion Methods + } +} \ No newline at end of file diff --git a/src/Robotlegs/Bender/Extensions/DirectAsyncCommand/Impl/AsyncCommandExecutor.cs b/src/Robotlegs/Bender/Extensions/DirectAsyncCommand/Impl/AsyncCommandExecutor.cs new file mode 100644 index 0000000..ec4207b --- /dev/null +++ b/src/Robotlegs/Bender/Extensions/DirectAsyncCommand/Impl/AsyncCommandExecutor.cs @@ -0,0 +1,166 @@ +//------------------------------------------------------------------------------ +// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. +// +// NOTICE: You are permitted to use, modify, and distribute this file +// in accordance with the terms of the license agreement accompanying it. +//------------------------------------------------------------------------------ + +using Robotlegs.Bender.Extensions.CommandCenter.API; +using Robotlegs.Bender.Extensions.CommandCenter.Impl; +using Robotlegs.Bender.Extensions.DirectAsyncCommand.API; +using Robotlegs.Bender.Framework.API; +using System; +using System.Collections.Generic; + +namespace Robotlegs.Bender.Extensions.DirectAsyncCommand.Impl +{ + internal class AsyncCommandExecutor : IAsyncCommandExecutor + { + #region Fields + + private const string AsyncCommandExecutedCallbackName = "AsyncCommandExecutedCallback"; + + /*============================================================================*/ + /* Private Fields */ + /*============================================================================*/ + + private ICommandExecutor _commandExecutor; + private Queue _commandMappingQueue; + private Action _commandsAbortedCallback; + private Action _commandsExecutedCallback; + private IContext _context; + + private IAsyncCommand _currentAsyncCommand; + private CommandExecutor.HandleResultDelegate _handleResult; + private IInjector _injector; + private CommandPayload _payload; + + #endregion Fields + + /*============================================================================*/ + /* Public Properties */ + /*============================================================================*/ + + #region Constructors + + public AsyncCommandExecutor(IContext context, IInjector injector, + CommandExecutor.RemoveMappingDelegate removeMapping = null, CommandExecutor.HandleResultDelegate handleResult = null) + { + IsAborted = false; + _context = context; + _injector = injector; + _handleResult = handleResult; + _commandExecutor = new CommandExecutor(injector, removeMapping, HandleCommandExecuteResult); + } + + #endregion Constructors + + #region Properties + + public bool IsAborted + { + get; + private set; + } + + #endregion Properties + + /*============================================================================*/ + /* Constructors */ + /*============================================================================*/ + /*============================================================================*/ + /* Public Functions */ + /*============================================================================*/ + + #region Methods + + /// + /// Aborts asynchronous Command execution. + /// + /// if set to true abort current command execution. + public void Abort(bool abortCurrentCommand = true) + { + IsAborted = true; + + if (abortCurrentCommand && _currentAsyncCommand != null) + { + _currentAsyncCommand.Abort(); + } + } + + public void ExecuteAsyncCommands(IEnumerable mappings, CommandPayload payload) + { + _commandMappingQueue = new Queue(mappings); + _payload = payload; + ExecuteNextCommand(); + } + + public void SetCommandsAbortedCallback(Action callback) + { + _commandsAbortedCallback = callback; + } + + public void SetCommandsExecutedCallback(Action callback) + { + _commandsExecutedCallback = callback; + } + + /*============================================================================*/ + /* Private Functions */ + /*============================================================================*/ + + private void CommandExecutedCallback(IAsyncCommand command, bool stop = false) + { + _context.Release(command); + + if (stop) + { + Abort(false); + } + + ExecuteNextCommand(); + } + + private void ExecuteNextCommand() + { + while (!IsAborted && _commandMappingQueue.Count > 0) + { + ICommandMapping mapping = _commandMappingQueue.Dequeue(); + + if (mapping != null) + { + _injector.Map>(AsyncCommandExecutedCallbackName).ToValue((Action)CommandExecutedCallback); + _commandExecutor.ExecuteCommand(mapping, _payload); + + if (_injector.HasDirectMapping>(AsyncCommandExecutedCallbackName)) + { + _injector.Unmap>(AsyncCommandExecutedCallbackName); + } + return; + } + } + + if (IsAborted) + { + _commandMappingQueue.Clear(); + _commandsAbortedCallback?.Invoke(); + } + else if (_commandMappingQueue.Count == 0) + { + _commandsExecutedCallback?.Invoke(); + } + } + + private void HandleCommandExecuteResult(object result, object command, ICommandMapping CommandMapping) + { + _currentAsyncCommand = command as IAsyncCommand; + + if (_handleResult != null) + _handleResult.Invoke(result, command, CommandMapping); + + _context.Detain(command); + } + + #endregion Methods + } +} \ No newline at end of file diff --git a/src/Robotlegs/Bender/Extensions/DirectAsyncCommand/Impl/DirectAsyncCommandMap.cs b/src/Robotlegs/Bender/Extensions/DirectAsyncCommand/Impl/DirectAsyncCommandMap.cs new file mode 100644 index 0000000..8a33ff1 --- /dev/null +++ b/src/Robotlegs/Bender/Extensions/DirectAsyncCommand/Impl/DirectAsyncCommandMap.cs @@ -0,0 +1,113 @@ +//------------------------------------------------------------------------------ +// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. +// +// NOTICE: You are permitted to use, modify, and distribute this file +// in accordance with the terms of the license agreement accompanying it. +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; +using Robotlegs.Bender.Extensions.CommandCenter.API; +using Robotlegs.Bender.Extensions.CommandCenter.Impl; +using Robotlegs.Bender.Extensions.DirectAsyncCommand.API; +using Robotlegs.Bender.Extensions.DirectAsyncCommand.DSL; +using Robotlegs.Bender.Framework.API; + +namespace Robotlegs.Bender.Extensions.DirectAsyncCommand.Impl +{ + public class DirectAsyncCommandMap : IDirectAsyncCommandMap + { + /*============================================================================*/ + /* Private Fields */ + /*============================================================================*/ + + #region Fields + + private IContext _context; + private IAsyncCommandExecutor _executor; + private List _mappingProcessors = new List(); + private CommandMappingList _mappings; + + #endregion Fields + + /*============================================================================*/ + /* Pulbic Properties */ + /*============================================================================*/ + + #region Constructors + + public DirectAsyncCommandMap(IContext context) + { + _context = context; + IInjector sandboxedInjector = context.injector.CreateChild(); + sandboxedInjector.Map(typeof(IDirectAsyncCommandMap)).ToValue(this); + _mappings = new CommandMappingList( + new NullCommandTrigger(), _mappingProcessors, context.GetLogger(this)); + _executor = new AsyncCommandExecutor(_context, sandboxedInjector, _mappings.RemoveMapping); + } + + #endregion Constructors + + #region Properties + + public bool IsAborted + { + get + { + if (_executor != null) + { + return _executor.IsAborted; + } + + return false; + } + } + + #endregion Properties + + /*============================================================================*/ + /* Constructor */ + /*============================================================================*/ + /*============================================================================*/ + /* Public Functions */ + /*============================================================================*/ + + #region Methods + + public void Abort(bool abortCurrentCommand = true) + { + _executor.Abort(abortCurrentCommand); + } + + public IDirectAsyncCommandMap AddMappingProcessor(CommandMappingList.Processor handler) + { + if (!_mappingProcessors.Contains(handler)) + _mappingProcessors.Add(handler); + return this; + } + + public void Execute(CommandPayload payload = null) + { + _executor.ExecuteAsyncCommands(_mappings.GetList(), payload); + } + + public IDirectAsyncCommandConfigurator Map() where T : IAsyncCommand + { + return new DirectAsyncCommandMapper(_executor, _mappings, typeof(T)); + } + + public IDirectAsyncCommandMapper SetCommandsAbortedCallback(Action callback) + { + _executor.SetCommandsAbortedCallback(callback); + return this; + } + + public IDirectAsyncCommandMapper SetCommandsExecutedCallback(Action callback) + { + _executor.SetCommandsExecutedCallback(callback); + return this; + } + + #endregion Methods + } +} \ No newline at end of file diff --git a/src/Robotlegs/Bender/Extensions/DirectAsyncCommand/Impl/DirectAsyncCommandMapper.cs b/src/Robotlegs/Bender/Extensions/DirectAsyncCommand/Impl/DirectAsyncCommandMapper.cs new file mode 100644 index 0000000..1bd767c --- /dev/null +++ b/src/Robotlegs/Bender/Extensions/DirectAsyncCommand/Impl/DirectAsyncCommandMapper.cs @@ -0,0 +1,101 @@ +//------------------------------------------------------------------------------ +// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. +// +// NOTICE: You are permitted to use, modify, and distribute this file +// in accordance with the terms of the license agreement accompanying it. +//------------------------------------------------------------------------------ + +using Robotlegs.Bender.Extensions.CommandCenter.API; +using Robotlegs.Bender.Extensions.CommandCenter.Impl; +using Robotlegs.Bender.Extensions.DirectAsyncCommand.API; +using Robotlegs.Bender.Extensions.DirectAsyncCommand.DSL; +using System; + +namespace Robotlegs.Bender.Extensions.DirectAsyncCommand.Impl +{ + public class DirectAsyncCommandMapper : IDirectAsyncCommandConfigurator + { + /*============================================================================*/ + /* Private Properties */ + /*============================================================================*/ + + #region Fields + + private IAsyncCommandExecutor _executor; + private ICommandMapping _mapping; + private ICommandMappingList _mappings; + + #endregion Fields + + /*============================================================================*/ + /* Constructor */ + /*============================================================================*/ + + #region Constructors + + public DirectAsyncCommandMapper(IAsyncCommandExecutor executor, ICommandMappingList mappings, Type commandClass) + { + _executor = executor; + _mappings = mappings; + _mapping = new CommandMapping(commandClass); + _mapping.SetFireOnce(true); + _mappings.AddMapping(_mapping); + } + + #endregion Constructors + + /*============================================================================*/ + /* Public Functions */ + /*============================================================================*/ + + #region Methods + + public void Execute(CommandPayload payload = null) + { + _executor.ExecuteAsyncCommands(_mappings.GetList(), payload); + } + + public IDirectAsyncCommandConfigurator Map() where T : IAsyncCommand + { + return new DirectAsyncCommandMapper(_executor, _mappings, typeof(T)); + } + + public IDirectAsyncCommandMapper SetCommandsAbortedCallback(Action callback) + { + _executor.SetCommandsAbortedCallback(callback); + return this; + } + + public IDirectAsyncCommandMapper SetCommandsExecutedCallback(Action callback) + { + _executor.SetCommandsExecutedCallback(callback); + return this; + } + + public IDirectAsyncCommandConfigurator WithExecuteMethod(string name) + { + _mapping.SetExecuteMethod(name); + return this; + } + + public IDirectAsyncCommandConfigurator WithGuards(params object[] guards) + { + _mapping.AddGuards(guards); + return this; + } + + public IDirectAsyncCommandConfigurator WithHooks(params object[] hooks) + { + _mapping.AddHooks(hooks); + return this; + } + + public IDirectAsyncCommandConfigurator WithPayloadInjection(bool value = true) + { + _mapping.SetPayloadInjectionEnabled(value); + return this; + } + + #endregion Methods + } +} \ No newline at end of file diff --git a/src/Robotlegs/Bender/Framework/API/IContext.cs b/src/Robotlegs/Bender/Framework/API/IContext.cs index 3214053..28f8186 100644 --- a/src/Robotlegs/Bender/Framework/API/IContext.cs +++ b/src/Robotlegs/Bender/Framework/API/IContext.cs @@ -69,11 +69,29 @@ public interface IContext : IPinEvent, ILifecycleEvent /// Destruction callback. IContext Destroy (Action callback = null); - /// - /// Installs custom extensions or bundles into the context - /// - /// IExtension class - IContext Install() where T : IExtension; + /// + /// Determines whether the custom extensions or bundles is installed. + /// + /// IExtension class. + /// + /// true if the custom extensions or bundles is installed; otherwise, false. + /// + bool IsInstalled() where T : IExtension; + + /// + /// Determines whether the custom extensions or bundles is installed. + /// + /// Type with an 'Extend(IContext context)' method signature. + /// + /// true if the custom extensions or bundles is installed; otherwise, false. + /// + bool IsInstalled (Type type); + + /// + /// Installs custom extensions or bundles into the context + /// + /// IExtension class + IContext Install() where T : IExtension; /// /// Installs custom extensions or bundles into the context /// diff --git a/src/Robotlegs/Bender/Framework/Impl/Context.cs b/src/Robotlegs/Bender/Framework/Impl/Context.cs index abda7aa..a2d4292 100644 --- a/src/Robotlegs/Bender/Framework/Impl/Context.cs +++ b/src/Robotlegs/Bender/Framework/Impl/Context.cs @@ -436,7 +436,17 @@ public IContext AfterDestroying(Action callback) return this; } - public IContext Install() where T : IExtension + public bool IsInstalled() where T : IExtension + { + return IsInstalled(typeof(T)); + } + + public bool IsInstalled(Type type) + { + return _extensionInstaller.IsInstalled(type); + } + + public IContext Install() where T : IExtension { _extensionInstaller.Install(); return this; diff --git a/src/Robotlegs/Bender/Framework/Impl/ExtensionInstaller.cs b/src/Robotlegs/Bender/Framework/Impl/ExtensionInstaller.cs index 19e7598..5d89286 100644 --- a/src/Robotlegs/Bender/Framework/Impl/ExtensionInstaller.cs +++ b/src/Robotlegs/Bender/Framework/Impl/ExtensionInstaller.cs @@ -39,6 +39,16 @@ public ExtensionInstaller (Context context) /* Public Functions */ /*============================================================================*/ + public bool IsInstalled() where T : IExtension + { + return IsInstalled(typeof(T)); + } + + public bool IsInstalled(Type type) + { + return _types.ContainsKey(type); + } + public void Install() where T : IExtension { Install (typeof(T)); @@ -46,7 +56,7 @@ public void Install() where T : IExtension public void Install(Type type) { - if (_types.ContainsKey (type)) + if (IsInstalled(type)) return; object extension = CreateInstance (type); @@ -57,7 +67,7 @@ public void Install(object extension) { Type type = extension.GetType(); - if (_types.ContainsKey(type)) + if (IsInstalled(type)) return; _logger.Debug("Installing extension {0}", extension); diff --git a/tests/Robotlegs/Bender/Extensions/CommandCenter/Impl/CommandMappingListTest.cs b/tests/Robotlegs/Bender/Extensions/CommandCenter/Impl/CommandMappingListTest.cs index 9a8ee50..eccf2ef 100644 --- a/tests/Robotlegs/Bender/Extensions/CommandCenter/Impl/CommandMappingListTest.cs +++ b/tests/Robotlegs/Bender/Extensions/CommandCenter/Impl/CommandMappingListTest.cs @@ -1,284 +1,290 @@ -//------------------------------------------------------------------------------ -// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. -// -// NOTICE: You are permitted to use, modify, and distribute this file -// in accordance with the terms of the license agreement accompanying it. -//------------------------------------------------------------------------------ - -using System; -using System.Collections.Generic; -using NUnit.Framework; -using Moq; -using Robotlegs.Bender.Extensions.CommandCenter.Support; -using Robotlegs.Bender.Extensions.CommandCenter.API; -using Robotlegs.Bender.Framework.API; - -namespace Robotlegs.Bender.Extensions.CommandCenter.Impl -{ - public class CommandMappingListTest - { - /*============================================================================*/ - /* Public Properties */ - /*============================================================================*/ - - public Mock logger; - - public Mock trigger; - - /*============================================================================*/ - /* Private Properties */ - /*============================================================================*/ - - private CommandMappingList subject; - - private ICommandMapping mapping1; - - private ICommandMapping mapping2; - - private ICommandMapping mapping3; - - private List processors; - - /*============================================================================*/ - /* Test Setup and Teardown */ - /*============================================================================*/ - - [SetUp] - public void before() - { - logger = new Mock (); - trigger = new Mock (); - processors = new List(); - subject = new CommandMappingList(trigger.Object, processors, logger.Object); - mapping1 = new CommandMapping(typeof(NullCommand)); - mapping2 = new CommandMapping(typeof(NullCommand2)); - mapping3 = new CommandMapping(typeof(NullCommand3)); - } - - /*============================================================================*/ - /* Tests */ - /*============================================================================*/ - - [Test] - public void trigger_is_activated_when_first_mapping_is_added() - { - subject.AddMapping(mapping1); - trigger.Verify (t => t.Activate (), Times.Once); - } - - [Test] - public void trigger_is_not_activated_when_second_mapping_is_added() - { - subject.AddMapping(mapping1); - subject.AddMapping(mapping2); - trigger.Verify (t => t.Activate (), Times.Once); - } - - [Test] - public void trigger_is_not_activated_when_mapping_overwritten() - { - subject.AddMapping(new CommandMapping(typeof(NullCommand))); - subject.AddMapping(new CommandMapping(typeof(NullCommand))); - trigger.Verify (t => t.Activate (), Times.Once); - } - - [Test] - public void trigger_is_not_activated_for_second_identical_mapping() - { - subject.AddMapping(mapping1); - subject.AddMapping(mapping1); - trigger.Verify (t => t.Activate (), Times.Once); - } - - [Test] - public void trigger_is_deactivated_when_last_mapping_is_removed() - { - subject.AddMapping(mapping1); - subject.AddMapping(mapping2); - subject.RemoveMappingFor(mapping1.CommandClass); - subject.RemoveMappingFor(mapping2.CommandClass); - trigger.Verify (t => t.Deactivate (), Times.Once); - } - - [Test] - public void trigger_is_deactivated_when_all_mappings_are_removed() - { - subject.AddMapping(mapping1); - subject.AddMapping(mapping2); - subject.AddMapping(mapping3); - subject.RemoveAllMappings(); - trigger.Verify (t => t.Deactivate (), Times.Once); - } - - [Test] - public void trigger_is_not_deactivated_when_list_is_already_empty() - { - subject.RemoveAllMappings(); - trigger.Verify (t => t.Deactivate (), Times.Never); - } - - [Test] - public void trigger_is_not_deactivated_when_second_last_mapping_is_removed() - { - subject.AddMapping(mapping1); - subject.AddMapping(mapping2); - subject.RemoveMappingFor(mapping1.CommandClass); - trigger.Verify (t => t.Deactivate (), Times.Never); - } - - [Test] - public void warning_logged_when_mapping_overwritten() - { - subject.AddMapping(new CommandMapping(typeof(NullCommand))); - subject.AddMapping(new CommandMapping(typeof(NullCommand))); - logger.Verify(r=> r.Warn(It.IsRegex("already mapped"), It.IsAny()), Times.Once); - } - - [Test] - public void list_is_empty() - { - Assert.That(subject.GetList().Count, Is.EqualTo(0)); - } - - [Test] - public void list_not_empty_after_mapping_added() - { - subject.AddMapping(mapping1); - Assert.That(subject.GetList().Count, Is.EqualTo(1)); - } - - [Test] - public void list_has_mapping() - { - subject.AddMapping(mapping1); - Assert.That(subject.GetList().IndexOf(mapping1), Is.EqualTo(0)); - } - - [Test] - public void list_is_empty_after_mappings_are_removed() - { - subject.AddMapping(mapping1); - subject.AddMapping(mapping2); - subject.RemoveMapping(mapping1); - subject.RemoveMapping(mapping2); - Assert.That(subject.GetList().Count, Is.EqualTo(0)); - } - - [Test] - public void list_is_empty_after_removeAll() - { - subject.AddMapping(mapping1); - subject.AddMapping(mapping2); - subject.AddMapping(mapping3); - subject.RemoveAllMappings(); - Assert.That(subject.GetList().Count, Is.EqualTo(0)); - } - - [Test] - public void getList_returns_unique_list() - { - Assert.That(subject.GetList().GetHashCode(), Is.Not.EqualTo(subject.GetList().GetHashCode())); - } - - [Test] - public void getList_returns_similar_list() - { - subject.AddMapping(mapping1); - subject.AddMapping(mapping2); - subject.AddMapping(mapping3); - Assert.That(subject.GetList(), Is.EquivalentTo(subject.GetList())); - } - - [Test] - public void sortFunction_is_used() - { - subject.WithSortFunction (new PriorityMappingComparer ()); - PriorityMapping mapping1 = new PriorityMapping(typeof(NullCommand), 1); - PriorityMapping mapping2 = new PriorityMapping(typeof(NullCommand2), 2); - PriorityMapping mapping3 = new PriorityMapping(typeof(NullCommand3), 3); - subject.AddMapping(mapping3); - subject.AddMapping(mapping1); - subject.AddMapping(mapping2); - Assert.That (subject.GetList (), Is.EquivalentTo (new List (){ mapping1, mapping2, mapping3 })); - } - - [Test] - public void sortFunction_is_called_after_mappings_are_added() - { - Mock> priorityComparer = new Mock> (); - priorityComparer.Setup (c => c.Compare (It.IsAny (), It.IsAny ())).Returns (0); - subject.WithSortFunction (priorityComparer.Object); - addPriorityMappings(); - subject.GetList(); - priorityComparer.Verify (c => c.Compare (It.IsAny (), It.IsAny ()), Times.AtLeastOnce); - } - - [Test] - public void sortFunction_is_only_called_once_after_mappings_are_added() - { - Mock> priorityComparer = new Mock> (); - priorityComparer.Setup (c => c.Compare (It.IsAny (), It.IsAny ())).Returns (0); - subject.WithSortFunction (priorityComparer.Object); - - addPriorityMappings(); - subject.GetList(); - - // Reset Times.count to zero - priorityComparer.ResetCalls (); - - subject.GetList(); - priorityComparer.Verify (c => c.Compare (It.IsAny (), It.IsAny ()), Times.Never); - } - - [Test] - public void sortFunction_is_not_called_after_a_mapping_is_removed() - { - Mock> priorityComparer = new Mock> (); - priorityComparer.Setup (c => c.Compare (It.IsAny (), It.IsAny ())).Returns (0); - subject.WithSortFunction (priorityComparer.Object); - - addPriorityMappings(); - subject.GetList(); - priorityComparer.ResetCalls (); - subject.RemoveMappingFor(typeof(NullCommand)); - subject.GetList(); - priorityComparer.Verify (c => c.Compare (It.IsAny (), It.IsAny ()), Times.Never); - } - - [Test] - public void mapping_processor_is_called() - { - int callCount = 0; - processors.Add((CommandMappingList.Processor) delegate(ICommandMapping mapping) { - callCount++; - }); - subject.AddMapping(mapping1); - Assert.That(callCount, Is.EqualTo(1)); - } - - [Test] - public void mapping_processor_is_given_mappings() - { - List mappings = new List (); - processors.Add((CommandMappingList.Processor) delegate(ICommandMapping mapping) { - mappings.Add(mapping); - }); - subject.AddMapping(mapping1); - subject.AddMapping(mapping2); - subject.AddMapping(mapping3); - Assert.That(mappings, Is.EqualTo(new List(){mapping1, mapping2, mapping3}).AsCollection); - } - - /*============================================================================*/ - /* Private Functions */ - /*============================================================================*/ - - private void addPriorityMappings() - { - subject.AddMapping(new PriorityMapping(typeof(NullCommand), 1)); - subject.AddMapping(new PriorityMapping(typeof(NullCommand2), 2)); - subject.AddMapping(new PriorityMapping(typeof(NullCommand3), 3)); - } - } -} - +//------------------------------------------------------------------------------ +// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. +// +// NOTICE: You are permitted to use, modify, and distribute this file +// in accordance with the terms of the license agreement accompanying it. +//------------------------------------------------------------------------------ + +using System; +using System.Collections.Generic; +using NUnit.Framework; +using Moq; +using Robotlegs.Bender.Extensions.CommandCenter.Support; +using Robotlegs.Bender.Extensions.CommandCenter.API; +using Robotlegs.Bender.Framework.API; + +namespace Robotlegs.Bender.Extensions.CommandCenter.Impl +{ + public class CommandMappingListTest + { + /*============================================================================*/ + /* Public Properties */ + /*============================================================================*/ + + + #region Fields + + public Mock logger; + + public Mock trigger; + + /*============================================================================*/ + /* Private Properties */ + /*============================================================================*/ + + private ICommandMapping mapping1; + private ICommandMapping mapping2; + private ICommandMapping mapping3; + private List processors; + private CommandMappingList subject; + + #endregion Fields + + /*============================================================================*/ + /* Test Setup and Teardown */ + /*============================================================================*/ + + #region Methods + + [SetUp] + public void before() + { + logger = new Mock(); + trigger = new Mock(); + processors = new List(); + subject = new CommandMappingList(trigger.Object, processors, logger.Object); + mapping1 = new CommandMapping(typeof(NullCommand)); + mapping2 = new CommandMapping(typeof(NullCommand2)); + mapping3 = new CommandMapping(typeof(NullCommand3)); + } + + /*============================================================================*/ + /* Tests */ + /*============================================================================*/ + + [Test] + public void getList_returns_similar_list() + { + subject.AddMapping(mapping1); + subject.AddMapping(mapping2); + subject.AddMapping(mapping3); + Assert.That(subject.GetList(), Is.EquivalentTo(subject.GetList())); + } + + [Test] + public void getList_returns_unique_list() + { + Assert.That(subject.GetList().GetHashCode(), Is.Not.EqualTo(subject.GetList().GetHashCode())); + } + + [Test] + public void list_has_mapping() + { + subject.AddMapping(mapping1); + Assert.That(subject.GetList().IndexOf(mapping1), Is.EqualTo(0)); + } + + [Test] + public void list_is_empty() + { + Assert.That(subject.GetList().Count, Is.EqualTo(0)); + } + + [Test] + public void list_is_empty_after_mappings_are_removed() + { + subject.AddMapping(mapping1); + subject.AddMapping(mapping2); + subject.RemoveMapping(mapping1); + subject.RemoveMapping(mapping2); + Assert.That(subject.GetList().Count, Is.EqualTo(0)); + } + + [Test] + public void list_is_empty_after_removeAll() + { + subject.AddMapping(mapping1); + subject.AddMapping(mapping2); + subject.AddMapping(mapping3); + subject.RemoveAllMappings(); + Assert.That(subject.GetList().Count, Is.EqualTo(0)); + } + + [Test] + public void list_not_empty_after_mapping_added() + { + subject.AddMapping(mapping1); + Assert.That(subject.GetList().Count, Is.EqualTo(1)); + } + + [Test] + public void mapping_processor_is_called() + { + int callCount = 0; + processors.Add((CommandMappingList.Processor)delegate (ICommandMapping mapping) + { + callCount++; + }); + subject.AddMapping(mapping1); + Assert.That(callCount, Is.EqualTo(1)); + } + + [Test] + public void mapping_processor_is_given_mappings() + { + List mappings = new List(); + processors.Add((CommandMappingList.Processor)delegate (ICommandMapping mapping) + { + mappings.Add(mapping); + }); + subject.AddMapping(mapping1); + subject.AddMapping(mapping2); + subject.AddMapping(mapping3); + Assert.That(mappings, Is.EqualTo(new List() { mapping1, mapping2, mapping3 }).AsCollection); + } + + [Test] + public void sortFunction_is_called_after_mappings_are_added() + { + Mock> priorityComparer = new Mock>(); + priorityComparer.Setup(c => c.Compare(It.IsAny(), It.IsAny())).Returns(0); + subject.WithSortFunction(priorityComparer.Object); + addPriorityMappings(); + subject.GetList(); + priorityComparer.Verify(c => c.Compare(It.IsAny(), It.IsAny()), Times.AtLeastOnce); + } + + [Test] + public void sortFunction_is_not_called_after_a_mapping_is_removed() + { + Mock> priorityComparer = new Mock>(); + priorityComparer.Setup(c => c.Compare(It.IsAny(), It.IsAny())).Returns(0); + subject.WithSortFunction(priorityComparer.Object); + + addPriorityMappings(); + subject.GetList(); + priorityComparer.Invocations.Clear(); + subject.RemoveMappingFor(typeof(NullCommand)); + subject.GetList(); + priorityComparer.Verify(c => c.Compare(It.IsAny(), It.IsAny()), Times.Never); + } + + [Test] + public void sortFunction_is_only_called_once_after_mappings_are_added() + { + Mock> priorityComparer = new Mock>(); + priorityComparer.Setup(c => c.Compare(It.IsAny(), It.IsAny())).Returns(0); + subject.WithSortFunction(priorityComparer.Object); + + addPriorityMappings(); + subject.GetList(); + + // Reset Times.count to zero + priorityComparer.Invocations.Clear(); + + subject.GetList(); + priorityComparer.Verify(c => c.Compare(It.IsAny(), It.IsAny()), Times.Never); + } + + [Test] + public void sortFunction_is_used() + { + subject.WithSortFunction(new PriorityMappingComparer()); + PriorityMapping mapping1 = new PriorityMapping(typeof(NullCommand), 1); + PriorityMapping mapping2 = new PriorityMapping(typeof(NullCommand2), 2); + PriorityMapping mapping3 = new PriorityMapping(typeof(NullCommand3), 3); + subject.AddMapping(mapping3); + subject.AddMapping(mapping1); + subject.AddMapping(mapping2); + Assert.That(subject.GetList(), Is.EquivalentTo(new List() { mapping1, mapping2, mapping3 })); + } + + [Test] + public void trigger_is_activated_when_first_mapping_is_added() + { + subject.AddMapping(mapping1); + trigger.Verify(t => t.Activate(), Times.Once); + } + + [Test] + public void trigger_is_deactivated_when_all_mappings_are_removed() + { + subject.AddMapping(mapping1); + subject.AddMapping(mapping2); + subject.AddMapping(mapping3); + subject.RemoveAllMappings(); + trigger.Verify(t => t.Deactivate(), Times.Once); + } + + [Test] + public void trigger_is_deactivated_when_last_mapping_is_removed() + { + subject.AddMapping(mapping1); + subject.AddMapping(mapping2); + subject.RemoveMappingFor(mapping1.CommandClass); + subject.RemoveMappingFor(mapping2.CommandClass); + trigger.Verify(t => t.Deactivate(), Times.Once); + } + + [Test] + public void trigger_is_not_activated_for_second_identical_mapping() + { + subject.AddMapping(mapping1); + subject.AddMapping(mapping1); + trigger.Verify(t => t.Activate(), Times.Once); + } + + [Test] + public void trigger_is_not_activated_when_mapping_overwritten() + { + subject.AddMapping(new CommandMapping(typeof(NullCommand))); + subject.AddMapping(new CommandMapping(typeof(NullCommand))); + trigger.Verify(t => t.Activate(), Times.Once); + } + + [Test] + public void trigger_is_not_activated_when_second_mapping_is_added() + { + subject.AddMapping(mapping1); + subject.AddMapping(mapping2); + trigger.Verify(t => t.Activate(), Times.Once); + } + + [Test] + public void trigger_is_not_deactivated_when_list_is_already_empty() + { + subject.RemoveAllMappings(); + trigger.Verify(t => t.Deactivate(), Times.Never); + } + + [Test] + public void trigger_is_not_deactivated_when_second_last_mapping_is_removed() + { + subject.AddMapping(mapping1); + subject.AddMapping(mapping2); + subject.RemoveMappingFor(mapping1.CommandClass); + trigger.Verify(t => t.Deactivate(), Times.Never); + } + + [Test] + public void warning_logged_when_mapping_overwritten() + { + subject.AddMapping(new CommandMapping(typeof(NullCommand))); + subject.AddMapping(new CommandMapping(typeof(NullCommand))); + logger.Verify(r => r.Warn(It.IsRegex("already mapped"), It.IsAny()), Times.Once); + } + + /*============================================================================*/ + /* Private Functions */ + /*============================================================================*/ + + private void addPriorityMappings() + { + subject.AddMapping(new PriorityMapping(typeof(NullCommand), 1)); + subject.AddMapping(new PriorityMapping(typeof(NullCommand2), 2)); + subject.AddMapping(new PriorityMapping(typeof(NullCommand3), 3)); + } + + #endregion Methods + } +} \ No newline at end of file diff --git a/tests/Robotlegs/Bender/Extensions/DirectAsyncCommand/DirectAsyncCommandMapExtensionTest.cs b/tests/Robotlegs/Bender/Extensions/DirectAsyncCommand/DirectAsyncCommandMapExtensionTest.cs new file mode 100644 index 0000000..aa68842 --- /dev/null +++ b/tests/Robotlegs/Bender/Extensions/DirectAsyncCommand/DirectAsyncCommandMapExtensionTest.cs @@ -0,0 +1,58 @@ +//------------------------------------------------------------------------------ +// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. +// +// NOTICE: You are permitted to use, modify, and distribute this file +// in accordance with the terms of the license agreement accompanying it. +//------------------------------------------------------------------------------ + +using NUnit.Framework; +using Robotlegs.Bender.Extensions.DirectAsyncCommand.API; +using Robotlegs.Bender.Framework.Impl; + +namespace Robotlegs.Bender.Extensions.DirectAsyncCommand +{ + [TestFixture] + public class DirectAsyncCommandMapExtensionTest + { + /*============================================================================*/ + /* Private Properties */ + /*============================================================================*/ + + #region Fields + + private Context context; + + #endregion Fields + + /*============================================================================*/ + /* Test Setup and Teardown */ + /*============================================================================*/ + + #region Methods + + [SetUp] + public void before() + { + context = new Context(); + context.Install(); + } + + /*============================================================================*/ + /* Tests */ + /*============================================================================*/ + + [Test] + public void directCommandMap_is_mapped_into_injector() + { + object actual = null; + context.WhenInitializing(delegate () + { + actual = context.injector.GetInstance(); + }); + context.Initialize(); + Assert.That(actual, Is.InstanceOf()); + } + + #endregion Methods + } +} \ No newline at end of file diff --git a/tests/Robotlegs/Bender/Extensions/DirectAsyncCommand/Impl/DirectAsyncCommandMapTest.cs b/tests/Robotlegs/Bender/Extensions/DirectAsyncCommand/Impl/DirectAsyncCommandMapTest.cs new file mode 100644 index 0000000..5db83d8 --- /dev/null +++ b/tests/Robotlegs/Bender/Extensions/DirectAsyncCommand/Impl/DirectAsyncCommandMapTest.cs @@ -0,0 +1,155 @@ +//------------------------------------------------------------------------------ +// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. +// +// NOTICE: You are permitted to use, modify, and distribute this file +// in accordance with the terms of the license agreement accompanying it. +//------------------------------------------------------------------------------ + +using NUnit.Framework; +using Robotlegs.Bender.Extensions.CommandCenter.API; +using Robotlegs.Bender.Extensions.CommandCenter.Impl; +using Robotlegs.Bender.Extensions.DirectAsyncCommand.API; +using Robotlegs.Bender.Extensions.DirectAsyncCommand.DSL; +using Robotlegs.Bender.Extensions.DirectAsyncCommand.Support; +using Robotlegs.Bender.Framework.API; +using Robotlegs.Bender.Framework.Impl; +using System; + +namespace Robotlegs.Bender.Extensions.DirectAsyncCommand.Impl +{ + [TestFixture] + public class DirectAsyncCommandMapTest + { + /*============================================================================*/ + /* Private Properties */ + /*============================================================================*/ + + #region Fields + + private IContext context; + + private IInjector injector; + private DirectAsyncCommandMap subject; + + #endregion Fields + + /*============================================================================*/ + /* Test Setup and Teardown */ + /*============================================================================*/ + + #region Methods + + [SetUp] + public void before() + { + context = new Context(); + injector = context.injector; + injector.Map().ToType(); + subject = injector.GetInstance() as DirectAsyncCommandMap; + } + + /*============================================================================*/ + /* Tests */ + /*============================================================================*/ + + [Test] + public void commands_aborted() + { + var aborted = false; + subject.SetCommandsAbortedCallback(() => + { + aborted = true; + }); + subject.Map() + .Map() + .Map() + .Execute(); + Assert.AreEqual(true, aborted); + } + + [Test] + public void commands_all_executed() + { + var allExecuted = false; + subject.SetCommandsExecutedCallback(() => + { + allExecuted = true; + }); + + subject.Map().Map().Execute(); + Assert.AreEqual(true, allExecuted); + } + + [Test] + public void commands_get_injected_with_DirectCommandMap_instance() + { + IDirectAsyncCommandMap actual = null; + injector.Map(typeof(Action), "ReportingFunction").ToValue((Action)delegate (IDirectAsyncCommandMap passed) + { + actual = passed; + }); + + subject.Map().Execute(); + + Assert.That(actual, Is.EqualTo(subject)); + } + + [Test] + public void detains_command() + { + object command = new object(); + bool wasDetained = false; + context.Detained += delegate (object obj) + { + wasDetained = true; + }; + context.Detain(command); + + Assert.That(wasDetained, Is.True); + } + + [Test] + public void map_creates_IOnceCommandConfig() + { + Assert.That(subject.Map(), Is.InstanceOf()); + } + + [Test] + public void mapping_processor_is_called() + { + int callCount = 0; + subject.AddMappingProcessor((CommandMappingList.Processor)delegate (ICommandMapping mapping) + { + callCount++; + }); + subject.Map(); + Assert.That(callCount, Is.EqualTo(1)); + } + + [Test] + public void releases_command() + { + object command = new object(); + bool wasReleased = false; + context.Released += delegate (object obj) + { + wasReleased = true; + }; + context.Detain(command); + + context.Release(command); + + Assert.That(wasReleased, Is.True); + } + + [Test] + public void sandboxed_directCommandMap_instance_does_not_leak_into_system() + { + IDirectAsyncCommandMap actual = injector.GetInstance(); + + Assert.That(actual, Is.Not.EqualTo(subject)); + } + + #endregion Methods + } +} \ No newline at end of file diff --git a/tests/Robotlegs/Bender/Extensions/DirectAsyncCommand/Impl/DirectAsyncCommandMapperTest.cs b/tests/Robotlegs/Bender/Extensions/DirectAsyncCommand/Impl/DirectAsyncCommandMapperTest.cs new file mode 100644 index 0000000..b2708e0 --- /dev/null +++ b/tests/Robotlegs/Bender/Extensions/DirectAsyncCommand/Impl/DirectAsyncCommandMapperTest.cs @@ -0,0 +1,139 @@ +//------------------------------------------------------------------------------ +// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. +// +// NOTICE: You are permitted to use, modify, and distribute this file +// in accordance with the terms of the license agreement accompanying it. +//------------------------------------------------------------------------------ + +using Moq; +using NUnit.Framework; +using Robotlegs.Bender.Extensions.CommandCenter.API; +using Robotlegs.Bender.Extensions.CommandCenter.Support; +using Robotlegs.Bender.Extensions.DirectAsyncCommand.API; +using Robotlegs.Bender.Extensions.DirectAsyncCommand.DSL; +using Robotlegs.Bender.Extensions.DirectAsyncCommand.Support; +using Robotlegs.Bender.Framework.Impl.GuardSupport; +using System.Collections.Generic; + +namespace Robotlegs.Bender.Extensions.DirectAsyncCommand.Impl +{ + [TestFixture] + public class DirectAsyncCommandMapperTest + { + #region Fields + + private ICommandMapping caughtMapping = null; + private Mock mockExecutor; + private Mock mockMappingList; + private DirectAsyncCommandMapper subject; + + #endregion Fields + + /*============================================================================*/ + /* Test Setup and Teardown */ + /*============================================================================*/ + + #region Methods + + [TearDown] + public void after() + { + caughtMapping = null; + subject = null; + } + + [SetUp] + public void before() + { + mockExecutor = new Mock(); + mockMappingList = new Mock(); + mockMappingList.Setup(m => m.AddMapping(It.IsAny())).Callback(r => caughtMapping = r); + } + + /*============================================================================*/ + /* Tests */ + /*============================================================================*/ + + [Test] + public void calls_executor_executeAsyncCommands_with_arguments() + { + List list = new List(); + mockMappingList.Setup(m => m.GetList()).Returns(list); + CreateMapper().Execute(null); + + mockExecutor.Verify(e => e.ExecuteAsyncCommands(It.Is>(arg1 => arg1 == list), It.Is(arg2 => arg2 == null)), Times.Once); + } + + [Test] + public void map_creates_new_mapper_instance() + { + IDirectAsyncCommandConfigurator newMapper = CreateMapper().Map(); + + Assert.That(newMapper, Is.Not.Null); + Assert.That(newMapper, Is.Not.EqualTo(subject)); + } + + [Test] + public void mapping_is_fireOnce_by_default() + { + CreateMapper(); + + Assert.That(caughtMapping.FireOnce, Is.True); + } + + [Test] + public void registers_new_commandMapping_with_CommandMappingList() + { + CreateMapper(); + + Assert.That(caughtMapping, Is.InstanceOf()); + } + + [Test] + public void withExecuteMethod_sets_executeMethod_of_mapping() + { + string executeMethod = "otherThanExecute"; + CreateMapper().WithExecuteMethod(executeMethod); + + Assert.That(caughtMapping.ExecuteMethod, Is.EqualTo(executeMethod)); + } + + [Test] + public void withGuards_sets_guards_of_mapping() + { + object[] expected = new object[] { typeof(HappyGuard), typeof(GrumpyGuard) }; + CreateMapper().WithGuards(expected); + + Assert.That(caughtMapping.Guards, Is.EqualTo(expected).AsCollection); + } + + [Test] + public void withHooks_sets_hooks_of_mapping() + { + object[] expected = new object[] { typeof(ClassReportingCallbackHook), typeof(ClassReportingCallbackHook) }; + CreateMapper().WithHooks(expected); + + Assert.That(caughtMapping.Hooks, Is.EqualTo(expected).AsCollection); + } + + [Test] + public void withPayloadInjection_sets_payloadInjection_of_mapping() + { + CreateMapper().WithPayloadInjection(false); + + Assert.That(caughtMapping.PayloadInjectionEnabled, Is.False); + } + + /*============================================================================*/ + /* Private Functions */ + /*============================================================================*/ + + private DirectAsyncCommandMapper CreateMapper() + { + subject = new DirectAsyncCommandMapper(mockExecutor.Object, mockMappingList.Object, typeof(T)); + return subject; + } + + #endregion Methods + } +} \ No newline at end of file diff --git a/tests/Robotlegs/Bender/Extensions/DirectAsyncCommand/Support/AbortAsyncCommand.cs b/tests/Robotlegs/Bender/Extensions/DirectAsyncCommand/Support/AbortAsyncCommand.cs new file mode 100644 index 0000000..80d8c2d --- /dev/null +++ b/tests/Robotlegs/Bender/Extensions/DirectAsyncCommand/Support/AbortAsyncCommand.cs @@ -0,0 +1,23 @@ +//------------------------------------------------------------------------------ +// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. +// +// NOTICE: You are permitted to use, modify, and distribute this file +// in accordance with the terms of the license agreement accompanying it. +//------------------------------------------------------------------------------ + +using Robotlegs.Bender.Extensions.DirectAsyncCommand.Impl; + +namespace Robotlegs.Bender.Extensions.DirectAsyncCommand.Support +{ + public class AbortAsyncCommand : AsyncCommand + { + #region Methods + + public override void Execute() + { + Abort(); + } + + #endregion Methods + } +} \ No newline at end of file diff --git a/tests/Robotlegs/Bender/Extensions/DirectAsyncCommand/Support/DirectAsyncCommandMapReportingAsyncCommand.cs b/tests/Robotlegs/Bender/Extensions/DirectAsyncCommand/Support/DirectAsyncCommandMapReportingAsyncCommand.cs new file mode 100644 index 0000000..f02020f --- /dev/null +++ b/tests/Robotlegs/Bender/Extensions/DirectAsyncCommand/Support/DirectAsyncCommandMapReportingAsyncCommand.cs @@ -0,0 +1,35 @@ +//------------------------------------------------------------------------------ +// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. +// +// NOTICE: You are permitted to use, modify, and distribute this file +// in accordance with the terms of the license agreement accompanying it. +//------------------------------------------------------------------------------ + +using Robotlegs.Bender.Extensions.DirectAsyncCommand.API; +using Robotlegs.Bender.Extensions.DirectAsyncCommand.Impl; +using System; + +namespace Robotlegs.Bender.Extensions.DirectAsyncCommand.Support +{ + public class DirectAsyncCommandMapReportingAsyncCommand : AsyncCommand + { + #region Fields + + [Inject] + public IDirectAsyncCommandMap dcm; + + [Inject("ReportingFunction")] + public Action reportingFunc; + + #endregion Fields + + #region Methods + + public override void Execute() + { + reportingFunc.Invoke(dcm); + } + + #endregion Methods + } +} \ No newline at end of file diff --git a/tests/Robotlegs/Bender/Extensions/DirectAsyncCommand/Support/NullAsyncCommand.cs b/tests/Robotlegs/Bender/Extensions/DirectAsyncCommand/Support/NullAsyncCommand.cs new file mode 100644 index 0000000..352fafa --- /dev/null +++ b/tests/Robotlegs/Bender/Extensions/DirectAsyncCommand/Support/NullAsyncCommand.cs @@ -0,0 +1,23 @@ +//------------------------------------------------------------------------------ +// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. +// +// NOTICE: You are permitted to use, modify, and distribute this file +// in accordance with the terms of the license agreement accompanying it. +//------------------------------------------------------------------------------ + +using Robotlegs.Bender.Extensions.DirectAsyncCommand.Impl; + +namespace Robotlegs.Bender.Extensions.DirectAsyncCommand.Support +{ + public class NullAsyncCommand : AsyncCommand + { + #region Methods + + public override void Execute() + { + Executed(); + } + + #endregion Methods + } +} \ No newline at end of file diff --git a/tests/Robotlegs/Bender/Extensions/DirectAsyncCommand/Support/NullAsyncCommand2.cs b/tests/Robotlegs/Bender/Extensions/DirectAsyncCommand/Support/NullAsyncCommand2.cs new file mode 100644 index 0000000..eb5c8c1 --- /dev/null +++ b/tests/Robotlegs/Bender/Extensions/DirectAsyncCommand/Support/NullAsyncCommand2.cs @@ -0,0 +1,13 @@ +//------------------------------------------------------------------------------ +// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. +// +// NOTICE: You are permitted to use, modify, and distribute this file +// in accordance with the terms of the license agreement accompanying it. +//------------------------------------------------------------------------------ + +namespace Robotlegs.Bender.Extensions.DirectAsyncCommand.Support +{ + public class NullAsyncCommand2 : NullAsyncCommand + { + } +} \ No newline at end of file diff --git a/tests/Robotlegs/Bender/Extensions/Modularity/ModularityExtensionTest.cs b/tests/Robotlegs/Bender/Extensions/Modularity/ModularityExtensionTest.cs index 47513f9..988713d 100644 --- a/tests/Robotlegs/Bender/Extensions/Modularity/ModularityExtensionTest.cs +++ b/tests/Robotlegs/Bender/Extensions/Modularity/ModularityExtensionTest.cs @@ -1,464 +1,475 @@ -//------------------------------------------------------------------------------ -// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. -// -// NOTICE: You are permitted to use, modify, and distribute this file -// in accordance with the terms of the license agreement accompanying it. -//------------------------------------------------------------------------------ - -using Robotlegs.Bender.Framework.API; -using Robotlegs.Bender.Framework.Impl; -using Robotlegs.Bender.Extensions.ContextViews; -using NUnit.Framework; -using Robotlegs.Bender.Extensions.ContextViews.Impl; -using Robotlegs.Bender.Framework.Impl.LoggingSupport; -using Robotlegs.Bender.Extensions.EventManagement; -using Robotlegs.Bender.Extensions.Modularity.API; -using System; -using Robotlegs.Bender.Extensions.ViewManagement.API; -using Robotlegs.Bender.Extensions.ViewManagement; -using Robotlegs.Bender.Extensions.ViewManagement.Support; -using Robotlegs.Bender.Extensions.ViewManagement.Impl; -using Robotlegs.Bender.Extensions.EventManagement.API; -using Robotlegs.Bender.Extensions.Modularity.Impl; -using System.Reflection; - -namespace Robotlegs.Bender.Extensions.Modularity -{ - public class ModularityExtensionTest - { - - /*============================================================================*/ - /* Private Properties */ - /*============================================================================*/ - - private IContext parentContext; - - private IContext childContext; - - private SupportView root; - - private SupportView parentView; - - private SupportView childView; - - /*============================================================================*/ - /* Test Setup and Teardown */ - /*============================================================================*/ - - [SetUp] - public void Setup() - { - root = new SupportView(); - parentView = new SupportView(); - childView = new SupportView(); - - parentContext = new Context() - .Install(typeof(StageSyncExtension)) - .Install(typeof(ContextViewExtension)); - childContext = new Context() - .Install(typeof(StageSyncExtension)) - .Install(typeof(ContextViewExtension)); - } - - /*============================================================================*/ - /* Tests */ - /*============================================================================*/ - - [Test] - public void Initialize_Context_Withought_Context_View_Thows_Error() - { - IContext context = new Context (); - LogLevelTarget llt = new LogLevelTarget (); - int errorCount = 0; - context.AddLogTarget(llt); - llt.ERROR += (LogLevelTarget.LogEventDelegate)delegate(object source, object message, object[] messageParams) { - errorCount++; - Assert.That(message, Contains.Substring("no contextview").IgnoreCase); - }; - context.Install (); - context.Initialize (); - Assert.That (errorCount, Is.EqualTo (1)); - } - - [Test] - public void Initialize_Context_Should_Work() - { - IContext context = new Context (); - context.Install (); - context.Install (); - context.Install (); - LogLevelTarget llt = new LogLevelTarget (); - context.AddLogTarget(llt); - llt.ERROR += (LogLevelTarget.LogEventDelegate)delegate(object source, object message, object[] messageParams) { - Assert.Fail(); - }; - context.Configure (new ContextView (root)); - } - - [Test] - public void Install_ModularityExtension_Before_IViewStateWatcher_Will_Error() - { - IContext context = new Context (); - context.Install (); - context.Install (); - context.Install (); - LogLevelTarget llt = new LogLevelTarget (); - context.AddLogTarget(llt); - llt.ERROR += (LogLevelTarget.LogEventDelegate)delegate(object source, object message, object[] messageParams) { - Console.WriteLine(message); - Assert.That(message, Is.StringContaining("IViewStateWatcher installed prior to Modularity").IgnoreCase); - Assert.Pass(); - }; - context.Configure (new ContextView (root)); - Assert.Fail(); - } - - [Test] - public void Initialize_Context_Wihtout_IParentFinder_Logs_Error() - { - LogLevelTarget llt = new LogLevelTarget (); - parentContext.AddLogTarget(llt); - llt.ERROR += (LogLevelTarget.LogEventDelegate)delegate(object source, object message, object[] messageParams) { - Assert.Pass(); - }; - parentContext.Install (); - parentContext.Install (); - parentContext.Initialize (); - Assert.Fail (); - } - - [Test] - public void Initialize_Context_Wihtout_IViewStateWatcher_Logs_Error() - { - LogLevelTarget llt = new LogLevelTarget (); - parentContext.AddLogTarget(llt); - llt.ERROR += (LogLevelTarget.LogEventDelegate)delegate(object source, object message, object[] messageParams) { - Assert.Pass(); - }; - parentContext.Install (); - parentContext.Install (); - parentContext.Initialize (); - Assert.Fail (); - } - - [Test] - public void Installing_After_Initialization_Throws_Error() - { +//------------------------------------------------------------------------------ +// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. +// +// NOTICE: You are permitted to use, modify, and distribute this file +// in accordance with the terms of the license agreement accompanying it. +//------------------------------------------------------------------------------ + +using Robotlegs.Bender.Framework.API; +using Robotlegs.Bender.Framework.Impl; +using Robotlegs.Bender.Extensions.ContextViews; +using NUnit.Framework; +using Robotlegs.Bender.Extensions.ContextViews.Impl; +using Robotlegs.Bender.Framework.Impl.LoggingSupport; +using Robotlegs.Bender.Extensions.EventManagement; +using Robotlegs.Bender.Extensions.Modularity.API; +using System; +using Robotlegs.Bender.Extensions.ViewManagement.API; +using Robotlegs.Bender.Extensions.ViewManagement; +using Robotlegs.Bender.Extensions.ViewManagement.Support; +using Robotlegs.Bender.Extensions.ViewManagement.Impl; +using Robotlegs.Bender.Extensions.EventManagement.API; +using Robotlegs.Bender.Extensions.Modularity.Impl; +using System.Reflection; + +namespace Robotlegs.Bender.Extensions.Modularity +{ + public class ModularityExtensionTest + { + /*============================================================================*/ + /* Private Properties */ + /*============================================================================*/ + + #region Fields + + private IContext childContext; + private SupportView childView; + private IContext parentContext; + private SupportView parentView; + private SupportView root; + + #endregion Fields + + /*============================================================================*/ + /* Test Setup and Teardown */ + /*============================================================================*/ + + #region Methods + + [Test] + public void Can_Get_Modularity_Dispatcher() + { + Assert.That(GetModularityEventDispatcher(), Is.Not.Null); + } + + [Test] + public void Child_Added_To_ViewManager_Inherits_Injector() + { + AddRootToStage(); + parentContext + .Install(typeof(TestSupportViewStateWatcherExtension)) + .Install(typeof(ModularityExtension)) + .Install(typeof(ViewManagerExtension)) + .Install(typeof(SupportParentFinderExtension)) + .Configure(typeof(ContextViewListenerConfig)) + .Configure(new ContextView(parentView)); + + IViewManager viewManager = parentContext.injector.GetInstance(typeof(IViewManager)) as IViewManager; + viewManager.AddContainer(childView); + + childContext + .Install(typeof(TestSupportViewStateWatcherExtension)) + .Install(typeof(ModularityExtension)) + .Install(typeof(SupportParentFinderExtension)) + .Configure(new ContextView(childView)); + + root.AddChild(parentView); + root.AddChild(childView); + + Assert.That(childContext.injector.parent, Is.EqualTo(parentContext.injector)); + } + + [Test] + public void Context_Does_Not_Inherit_Parent_Injector_When_Disallowed_By_Parent() + { + AddRootToStage(); + parentContext.Install(new ModularityExtension(true, false)).Configure(new ContextView(parentView)); + childContext.Install(typeof(ModularityExtension)).Configure(new ContextView(childView)); + root.AddChild(parentView); + parentView.AddChild(childView); + + Assert.That(childContext.injector.parent, Is.Not.EqualTo(parentContext.injector)); + } + + [Test] + public void Context_Does_Not_Inherit_Parent_Injector_When_Not_Interested() + { + AddRootToStage(); + parentContext.Install(typeof(ModularityExtension)).Configure(new ContextView(parentView)); + childContext.Install(new ModularityExtension(false)).Configure(new ContextView(childView)); + root.AddChild(parentView); + parentView.AddChild(childView); + + Assert.That(childContext.injector.parent, Is.Not.EqualTo(parentContext.injector)); + } + + [Test] + public void Context_Inherits_Parent_Injector() + { + AddRootToStage(); + + parentContext + .Install(typeof(SupportParentFinderExtension)) + .Install(typeof(TestSupportViewStateWatcherExtension)) + .Install(typeof(ModularityExtension)) + .Configure(new ContextView(parentView)); + + childContext + .Install(typeof(TestSupportViewStateWatcherExtension)) + .Install(typeof(ModularityExtension)) + .Install(typeof(SupportParentFinderExtension)) + .Configure(new ContextView(childView)); + + ContainerRegistry cr = new ContainerRegistry(); + cr.SetParentFinder(new SupportParentFinder()); + + parentContext.injector.Map(typeof(ContainerRegistry)).ToValue(cr); + childContext.injector.Map(typeof(ContainerRegistry)).ToValue(cr); + + cr.AddContainer(parentView); + cr.AddContainer(childView); + + root.AddChild(parentView); + parentView.AddChild(childView); + + Assert.That(childContext.injector.parent, Is.EqualTo(parentContext.injector)); + } + + [Test] + public void Extension_Logs_Error_When_Context_Initialized_With_No_ContextView() + { + bool errorLogged = false; + CallbackLogTarget logTarget = new CallbackLogTarget(delegate (LogParams result) + { + if (result.level == LogLevel.ERROR && result.source.GetType() == typeof(ModularityExtension)) + errorLogged = true; + }); + childContext.Install(typeof(ModularityExtension)).Install(typeof(SupportParentFinderExtension)); + childContext.AddLogTarget(logTarget); + childContext.Initialize(); + Assert.That(errorLogged, Is.True); + } + + [Test] + public void Extension_Logs_Error_When_Context_Initialized_With_No_Parent_Finder_Installed() + { + bool errorLogged = false; + CallbackLogTarget logTarget = new CallbackLogTarget(delegate (LogParams result) + { + if (result.level == LogLevel.ERROR && result.source.GetType() == typeof(ModularityExtension)) + errorLogged = true; + }); + childContext.Install(typeof(ModularityExtension)); + childContext.AddLogTarget(logTarget); + childContext.Initialize(); + Assert.That(errorLogged, Is.True); + } + + [Test] + public void Initialize_Context_Should_Work() + { + IContext context = new Context(); + context.Install(); + context.Install(); + context.Install(); + LogLevelTarget llt = new LogLevelTarget(); + context.AddLogTarget(llt); + llt.ERROR += (LogLevelTarget.LogEventDelegate)delegate (object source, object message, object[] messageParams) + { + Assert.Fail(); + }; + context.Configure(new ContextView(root)); + } + + [Test] + public void Initialize_Context_Wihtout_IParentFinder_Logs_Error() + { + LogLevelTarget llt = new LogLevelTarget(); + parentContext.AddLogTarget(llt); + llt.ERROR += (LogLevelTarget.LogEventDelegate)delegate (object source, object message, object[] messageParams) + { + Assert.Pass(); + }; + parentContext.Install(); + parentContext.Install(); + parentContext.Initialize(); + Assert.Fail(); + } + + [Test] + public void Initialize_Context_Wihtout_IViewStateWatcher_Logs_Error() + { + LogLevelTarget llt = new LogLevelTarget(); + parentContext.AddLogTarget(llt); + llt.ERROR += (LogLevelTarget.LogEventDelegate)delegate (object source, object message, object[] messageParams) + { + Assert.Pass(); + }; + parentContext.Install(); + parentContext.Install(); + parentContext.Initialize(); + Assert.Fail(); + } + + [Test] + public void Initialize_Context_Withought_Context_View_Thows_Error() + { + IContext context = new Context(); + LogLevelTarget llt = new LogLevelTarget(); + int errorCount = 0; + context.AddLogTarget(llt); + llt.ERROR += (LogLevelTarget.LogEventDelegate)delegate (object source, object message, object[] messageParams) + { + errorCount++; + Assert.That(message, Contains.Substring("no contextview").IgnoreCase); + }; + context.Install(); + context.Initialize(); + Assert.That(errorCount, Is.EqualTo(1)); + } + + [Test] + public void Install_ModularityExtension_Before_IViewStateWatcher_Will_Error() + { + IContext context = new Context(); + context.Install(); + context.Install(); + context.Install(); + LogLevelTarget llt = new LogLevelTarget(); + context.AddLogTarget(llt); + llt.ERROR += (LogLevelTarget.LogEventDelegate)delegate (object source, object message, object[] messageParams) + { + Console.WriteLine(message); + Assert.That(message, Does.Contain("IViewStateWatcher installed prior to Modularity").IgnoreCase); + Assert.Pass(); + }; + context.Configure(new ContextView(root)); + Assert.Fail(); + } + + [Test] + public void Installing_After_Initialization_Throws_Error() + { Assert.Throws(typeof(LifecycleException), new TestDelegate(() => { parentContext.Initialize(); parentContext.Install(typeof(ModularityExtension)); - } - )); - } - - [Test] - public void Context_Inherits_Parent_Injector() - { - AddRootToStage(); - - parentContext - .Install (typeof(SupportParentFinderExtension)) - .Install(typeof(TestSupportViewStateWatcherExtension)) - .Install (typeof(ModularityExtension)) - .Configure(new ContextView(parentView)); - - childContext - .Install (typeof(TestSupportViewStateWatcherExtension)) - .Install (typeof(ModularityExtension)) - .Install (typeof(SupportParentFinderExtension)) - .Configure (new ContextView (childView)); - - ContainerRegistry cr = new ContainerRegistry(); - cr.SetParentFinder (new SupportParentFinder ()); - - parentContext.injector.Map(typeof(ContainerRegistry)).ToValue(cr); - childContext.injector.Map(typeof(ContainerRegistry)).ToValue(cr); - - cr.AddContainer(parentView); - cr.AddContainer(childView); - - root.AddChild(parentView); - parentView.AddChild (childView); - - Assert.That (childContext.injector.parent, Is.EqualTo (parentContext.injector)); - } - - [Test] - public void Context_Does_Not_Inherit_Parent_Injector_When_Not_Interested() - { - AddRootToStage(); - parentContext.Install(typeof(ModularityExtension)).Configure(new ContextView(parentView)); - childContext.Install(new ModularityExtension(false)).Configure(new ContextView(childView)); - root.AddChild(parentView); - parentView.AddChild(childView); - - Assert.That (childContext.injector.parent, Is.Not.EqualTo (parentContext.injector)); - } - - [Test] - public void Context_Does_Not_Inherit_Parent_Injector_When_Disallowed_By_Parent() - { - AddRootToStage(); - parentContext.Install(new ModularityExtension(true, false)).Configure(new ContextView(parentView)); - childContext.Install(typeof(ModularityExtension)).Configure(new ContextView(childView)); - root.AddChild (parentView); - parentView.AddChild (childView); - - Assert.That(childContext.injector.parent, Is.Not.EqualTo(parentContext.injector)); - } - - [Test] - public void Multiple_Parallel_Children_Only_Inherit_Parent_Injector() - { - AddRootToStage(); - - parentContext - .Install (typeof(SupportParentFinderExtension)) - .Install(typeof(TestSupportViewStateWatcherExtension)) - .Install (typeof(ModularityExtension)) - .Configure(new ContextView(parentView)); - - childContext - .Install (typeof(TestSupportViewStateWatcherExtension)) - .Install (typeof(ModularityExtension)) - .Install (typeof(SupportParentFinderExtension)) - .Configure (new ContextView (childView)); - - - SupportView anotherChildView = new SupportView (); - IContext anotherChildContext = new Context() - .Install (typeof(StageSyncExtension)) - .Install (typeof(ContextViewExtension)) - .Install (typeof(TestSupportViewStateWatcherExtension)) - .Install (typeof(ModularityExtension)) - .Install (typeof(SupportParentFinderExtension)) - .Configure (new ContextView (anotherChildView)); - - - ContainerRegistry cr = new ContainerRegistry(); - parentContext.injector.Map(typeof(ContainerRegistry)).ToValue(cr); - childContext.injector.Map(typeof(ContainerRegistry)).ToValue(cr); - anotherChildContext.injector.Map(typeof(ContainerRegistry)).ToValue(cr); - - cr.AddContainer(parentView); - cr.AddContainer(childView); - cr.AddContainer(anotherChildView); - - root.AddChild (parentView); - parentView.AddChild (childView); - parentView.AddChild (anotherChildView); - - Assert.That (childContext.injector.parent, Is.EqualTo (parentContext.injector)); - Assert.That (anotherChildContext.injector.parent, Is.EqualTo (parentContext.injector)); - } - - [Test] - public void Multiple_Depths_Of_Children_Only_Inherit_The_First_Parents_Injector() - { - AddRootToStage(); - - parentContext - .Install(typeof(TestSupportViewStateWatcherExtension)) - .Install (typeof(SupportParentFinderExtension)) - .Install (typeof(ModularityExtension)) - .Configure(new ContextView(parentView)); - - childContext - .Install (typeof(TestSupportViewStateWatcherExtension)) - .Install (typeof(ModularityExtension)) - .Install (typeof(SupportParentFinderExtension)) - .Configure (new ContextView (childView)); - - - SupportView anotherChildView = new SupportView (); - IContext anotherChildContext = new Context() - .Install (typeof(TestSupportViewStateWatcherExtension)) - .Install (typeof(StageSyncExtension)) - .Install (typeof(ContextViewExtension)) - .Install (typeof(ModularityExtension)) - .Install (typeof(SupportParentFinderExtension)) - .Configure (new ContextView (anotherChildView)); - - - ContainerRegistry cr = new ContainerRegistry(); - parentContext.injector.Map(typeof(ContainerRegistry)).ToValue(cr); - childContext.injector.Map(typeof(ContainerRegistry)).ToValue(cr); - anotherChildContext.injector.Map(typeof(ContainerRegistry)).ToValue(cr); - - cr.AddContainer(parentView); - cr.AddContainer(childView); - cr.AddContainer(anotherChildView); - - root.AddChild (parentView); - parentView.AddChild (childView); - childView.AddChild (anotherChildView); - - Assert.That (childContext.injector.parent, Is.EqualTo (parentContext.injector)); - Assert.That (anotherChildContext.injector.parent, Is.EqualTo (childContext.injector)); - Assert.That (anotherChildContext.injector.parent, Is.Not.EqualTo (parentContext.injector)); - } - - [Test] - public void Extension_Logs_Error_When_Context_Initialized_With_No_ContextView() - { - bool errorLogged = false; - CallbackLogTarget logTarget = new CallbackLogTarget(delegate (LogParams result) { - if(result.level == LogLevel.ERROR && result.source.GetType() == typeof(ModularityExtension)) - errorLogged = true; - }); - childContext.Install(typeof(ModularityExtension)).Install(typeof(SupportParentFinderExtension)); - childContext.AddLogTarget(logTarget); - childContext.Initialize(); - Assert.That (errorLogged, Is.True); - } - - [Test] - public void Extension_Logs_Error_When_Context_Initialized_With_No_Parent_Finder_Installed() - { - bool errorLogged = false; - CallbackLogTarget logTarget = new CallbackLogTarget(delegate (LogParams result) { - if(result.level == LogLevel.ERROR && result.source.GetType() == typeof(ModularityExtension)) - errorLogged = true; - }); - childContext.Install(typeof(ModularityExtension)); - childContext.AddLogTarget(logTarget); - childContext.Initialize(); - Assert.That (errorLogged, Is.True); - } - - [Test] - public void Child_Added_To_ViewManager_Inherits_Injector() - { - AddRootToStage(); - parentContext - .Install(typeof(TestSupportViewStateWatcherExtension)) - .Install (typeof(ModularityExtension)) - .Install(typeof(ViewManagerExtension)) - .Install (typeof(SupportParentFinderExtension)) - .Configure(typeof(ContextViewListenerConfig)) - .Configure(new ContextView(parentView)); - - IViewManager viewManager = parentContext.injector.GetInstance (typeof(IViewManager)) as IViewManager; - viewManager.AddContainer (childView); - - childContext - .Install(typeof(TestSupportViewStateWatcherExtension)) - .Install (typeof(ModularityExtension)) - .Install (typeof(SupportParentFinderExtension)) - .Configure(new ContextView(childView)); - - root.AddChild(parentView); - root.AddChild(childView); - - Assert.That (childContext.injector.parent, Is.EqualTo (parentContext.injector)); - } - - [Test] - public void ModuleConnector_Mapped_To_Injector() - { - object actual = null; - IContext parentContext = new Context(); - parentContext - .Install(typeof(EventDispatcherExtension)) - .Install(typeof(ModularityExtension)); - parentContext.WhenInitializing( delegate() { - actual = parentContext.injector.GetInstance(typeof(IModuleConnector)); - }); - parentContext.Initialize(); - Assert.That (actual, Is.InstanceOf (typeof(IModuleConnector))); - } - - [Test] - public void Can_Get_Modularity_Dispatcher() - { - Assert.That (GetModularityEventDispatcher (), Is.Not.Null); - } - - [Test] - public void Modularity_Dispatcher_Should_Broadcast_When_Child_Context_Is_Added() - { - int eventFireCount = 0; - - AddRootToStage(); - root.AddChild(parentView); - root.AddChild(childView); - parentContext - .Install (typeof(EventDispatcherExtension)) - .Install(typeof(TestSupportViewStateWatcherExtension)) - .Install (typeof(ModularityExtension)) - .Install(typeof(ViewManagerExtension)) - .Install (typeof(SupportParentFinderExtension)) - .Configure(typeof(ContextViewListenerConfig)) - .Configure(new ContextView(parentView)); - - GetModularityEventDispatcher().AddEventListener(ModularContextEvent.Type.CONTEXT_ADD, delegate() { - eventFireCount++; - }); - - IViewManager viewManager = parentContext.injector.GetInstance (typeof(IViewManager)) as IViewManager; - viewManager.AddContainer (childView); - - childContext - .Install(typeof(TestSupportViewStateWatcherExtension)) - .Install (typeof(ModularityExtension)) - .Install (typeof(SupportParentFinderExtension)) - .Configure(new ContextView(childView)); - - Assert.That (eventFireCount, Is.EqualTo(1)); - } - - [Test] - public void Modularity_Dispatcher_Should_Broadcast_Add_Child_Before_Child_Context_Is_Initialized() - { - bool eventFired = false; - bool childContextUninitialzied = false; - - AddRootToStage(); - root.AddChild(parentView); - root.AddChild(childView); - parentContext - .Install (typeof(EventDispatcherExtension)) - .Install(typeof(TestSupportViewStateWatcherExtension)) - .Install (typeof(ModularityExtension)) - .Install(typeof(ViewManagerExtension)) - .Install (typeof(SupportParentFinderExtension)) - .Configure(typeof(ContextViewListenerConfig)) - .Configure(new ContextView(parentView)); - - GetModularityEventDispatcher().AddEventListener(ModularContextEvent.Type.CONTEXT_ADD, delegate() { - eventFired = true; - childContextUninitialzied = childContext.Uninitialized; - }); - - IViewManager viewManager = parentContext.injector.GetInstance (typeof(IViewManager)) as IViewManager; - viewManager.AddContainer (childView); - - childContext - .Install(typeof(TestSupportViewStateWatcherExtension)) - .Install (typeof(ModularityExtension)) - .Install (typeof(SupportParentFinderExtension)) - .Configure(new ContextView(childView)); - - Assert.That (eventFired, Is.True); - Assert.That (childContextUninitialzied, Is.True); - } - - /*============================================================================*/ - /* Private Functions */ - /*============================================================================*/ - - private void AddRootToStage() - { - root.RemoveThisView(); - } - - private IEventDispatcher GetModularityEventDispatcher() - { - Type modularityType = typeof(ModularityExtension); - FieldInfo fieldInfo = modularityType.GetField ("_modularityDispatcher", BindingFlags.NonPublic | BindingFlags.Static | BindingFlags.DeclaredOnly); - return fieldInfo.GetValue (modularityType) as IEventDispatcher; - } - - } -} + } + )); + } + + [Test] + public void Modularity_Dispatcher_Should_Broadcast_Add_Child_Before_Child_Context_Is_Initialized() + { + bool eventFired = false; + bool childContextUninitialzied = false; + + AddRootToStage(); + root.AddChild(parentView); + root.AddChild(childView); + parentContext + .Install(typeof(EventDispatcherExtension)) + .Install(typeof(TestSupportViewStateWatcherExtension)) + .Install(typeof(ModularityExtension)) + .Install(typeof(ViewManagerExtension)) + .Install(typeof(SupportParentFinderExtension)) + .Configure(typeof(ContextViewListenerConfig)) + .Configure(new ContextView(parentView)); + + GetModularityEventDispatcher().AddEventListener(ModularContextEvent.Type.CONTEXT_ADD, delegate () + { + eventFired = true; + childContextUninitialzied = childContext.Uninitialized; + }); + + IViewManager viewManager = parentContext.injector.GetInstance(typeof(IViewManager)) as IViewManager; + viewManager.AddContainer(childView); + + childContext + .Install(typeof(TestSupportViewStateWatcherExtension)) + .Install(typeof(ModularityExtension)) + .Install(typeof(SupportParentFinderExtension)) + .Configure(new ContextView(childView)); + + Assert.That(eventFired, Is.True); + Assert.That(childContextUninitialzied, Is.True); + } + + [Test] + public void Modularity_Dispatcher_Should_Broadcast_When_Child_Context_Is_Added() + { + int eventFireCount = 0; + + AddRootToStage(); + root.AddChild(parentView); + root.AddChild(childView); + parentContext + .Install(typeof(EventDispatcherExtension)) + .Install(typeof(TestSupportViewStateWatcherExtension)) + .Install(typeof(ModularityExtension)) + .Install(typeof(ViewManagerExtension)) + .Install(typeof(SupportParentFinderExtension)) + .Configure(typeof(ContextViewListenerConfig)) + .Configure(new ContextView(parentView)); + + GetModularityEventDispatcher().AddEventListener(ModularContextEvent.Type.CONTEXT_ADD, delegate () + { + eventFireCount++; + }); + + IViewManager viewManager = parentContext.injector.GetInstance(typeof(IViewManager)) as IViewManager; + viewManager.AddContainer(childView); + + childContext + .Install(typeof(TestSupportViewStateWatcherExtension)) + .Install(typeof(ModularityExtension)) + .Install(typeof(SupportParentFinderExtension)) + .Configure(new ContextView(childView)); + + Assert.That(eventFireCount, Is.EqualTo(1)); + } + + [Test] + public void ModuleConnector_Mapped_To_Injector() + { + object actual = null; + IContext parentContext = new Context(); + parentContext + .Install(typeof(EventDispatcherExtension)) + .Install(typeof(ModularityExtension)); + parentContext.WhenInitializing(delegate () + { + actual = parentContext.injector.GetInstance(typeof(IModuleConnector)); + }); + parentContext.Initialize(); + Assert.That(actual, Is.InstanceOf(typeof(IModuleConnector))); + } + + [Test] + public void Multiple_Depths_Of_Children_Only_Inherit_The_First_Parents_Injector() + { + AddRootToStage(); + + parentContext + .Install(typeof(TestSupportViewStateWatcherExtension)) + .Install(typeof(SupportParentFinderExtension)) + .Install(typeof(ModularityExtension)) + .Configure(new ContextView(parentView)); + + childContext + .Install(typeof(TestSupportViewStateWatcherExtension)) + .Install(typeof(ModularityExtension)) + .Install(typeof(SupportParentFinderExtension)) + .Configure(new ContextView(childView)); + + + SupportView anotherChildView = new SupportView(); + IContext anotherChildContext = new Context() + .Install(typeof(TestSupportViewStateWatcherExtension)) + .Install(typeof(StageSyncExtension)) + .Install(typeof(ContextViewExtension)) + .Install(typeof(ModularityExtension)) + .Install(typeof(SupportParentFinderExtension)) + .Configure(new ContextView(anotherChildView)); + + + ContainerRegistry cr = new ContainerRegistry(); + parentContext.injector.Map(typeof(ContainerRegistry)).ToValue(cr); + childContext.injector.Map(typeof(ContainerRegistry)).ToValue(cr); + anotherChildContext.injector.Map(typeof(ContainerRegistry)).ToValue(cr); + + cr.AddContainer(parentView); + cr.AddContainer(childView); + cr.AddContainer(anotherChildView); + + root.AddChild(parentView); + parentView.AddChild(childView); + childView.AddChild(anotherChildView); + + Assert.That(childContext.injector.parent, Is.EqualTo(parentContext.injector)); + Assert.That(anotherChildContext.injector.parent, Is.EqualTo(childContext.injector)); + Assert.That(anotherChildContext.injector.parent, Is.Not.EqualTo(parentContext.injector)); + } + + [Test] + public void Multiple_Parallel_Children_Only_Inherit_Parent_Injector() + { + AddRootToStage(); + + parentContext + .Install(typeof(SupportParentFinderExtension)) + .Install(typeof(TestSupportViewStateWatcherExtension)) + .Install(typeof(ModularityExtension)) + .Configure(new ContextView(parentView)); + + childContext + .Install(typeof(TestSupportViewStateWatcherExtension)) + .Install(typeof(ModularityExtension)) + .Install(typeof(SupportParentFinderExtension)) + .Configure(new ContextView(childView)); + + + SupportView anotherChildView = new SupportView(); + IContext anotherChildContext = new Context() + .Install(typeof(StageSyncExtension)) + .Install(typeof(ContextViewExtension)) + .Install(typeof(TestSupportViewStateWatcherExtension)) + .Install(typeof(ModularityExtension)) + .Install(typeof(SupportParentFinderExtension)) + .Configure(new ContextView(anotherChildView)); + + + ContainerRegistry cr = new ContainerRegistry(); + parentContext.injector.Map(typeof(ContainerRegistry)).ToValue(cr); + childContext.injector.Map(typeof(ContainerRegistry)).ToValue(cr); + anotherChildContext.injector.Map(typeof(ContainerRegistry)).ToValue(cr); + + cr.AddContainer(parentView); + cr.AddContainer(childView); + cr.AddContainer(anotherChildView); + + root.AddChild(parentView); + parentView.AddChild(childView); + parentView.AddChild(anotherChildView); + + Assert.That(childContext.injector.parent, Is.EqualTo(parentContext.injector)); + Assert.That(anotherChildContext.injector.parent, Is.EqualTo(parentContext.injector)); + } + + [SetUp] + public void Setup() + { + root = new SupportView(); + parentView = new SupportView(); + childView = new SupportView(); + + parentContext = new Context() + .Install(typeof(StageSyncExtension)) + .Install(typeof(ContextViewExtension)); + childContext = new Context() + .Install(typeof(StageSyncExtension)) + .Install(typeof(ContextViewExtension)); + } + + /*============================================================================*/ + /* Tests */ + /*============================================================================*/ + /*============================================================================*/ + /* Private Functions */ + /*============================================================================*/ + + private void AddRootToStage() + { + root.RemoveThisView(); + } + + private IEventDispatcher GetModularityEventDispatcher() + { + Type modularityType = typeof(ModularityExtension); + FieldInfo fieldInfo = modularityType.GetField("_modularityDispatcher", BindingFlags.NonPublic | BindingFlags.Static | BindingFlags.DeclaredOnly); + return fieldInfo.GetValue(modularityType) as IEventDispatcher; + } + + #endregion Methods + } +} \ No newline at end of file diff --git a/tests/Robotlegs/Bender/Extensions/ViewProcessor/Impl/ViewProcessorMapTest.cs b/tests/Robotlegs/Bender/Extensions/ViewProcessor/Impl/ViewProcessorMapTest.cs index c96d30b..1c7b499 100644 --- a/tests/Robotlegs/Bender/Extensions/ViewProcessor/Impl/ViewProcessorMapTest.cs +++ b/tests/Robotlegs/Bender/Extensions/ViewProcessor/Impl/ViewProcessorMapTest.cs @@ -1,8 +1,8 @@ //------------------------------------------------------------------------------ -// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. -// -// NOTICE: You are permitted to use, modify, and distribute this file -// in accordance with the terms of the license agreement accompanying it. +// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. +// +// NOTICE: You are permitted to use, modify, and distribute this file +// in accordance with the terms of the license agreement accompanying it. //------------------------------------------------------------------------------ using Robotlegs.Bender.Extensions.Matching; @@ -20,466 +20,516 @@ namespace Robotlegs.Bender.Extensions.ViewProcessor.Impl { - public class ViewProcessorMapTest - { - - /*============================================================================*/ - /* Private Properties */ - /*============================================================================*/ - - // TODO: extract processing tests into own tests - // TODO: add actual ViewProcessorMap tests - - private TypeMatcher supportViewMatcher = new TypeMatcher().AllOf(typeof(SupportView)); - - private ViewProcessorMap viewProcessorMap; - - private TrackingProcessor trackingProcessor; - - private TrackingProcessor trackingProcessor2; - - private IInjector injector; - - private SupportView matchingView; - - private ObjectB nonMatchingView; - - private GuardObject guardObject; - - private SupportViewWithWidthAndHeight matchingView2; - - /*============================================================================*/ - /* Test Setup and Teardown */ - /*============================================================================*/ - - [SetUp] - public void Setup() - { - injector = new RobotlegsInjector(); - injector.Map(typeof(RobotlegsInjector)).ToValue(injector); - viewProcessorMap = new ViewProcessorMap(new ViewProcessorFactory(injector)); - trackingProcessor = new TrackingProcessor(); - trackingProcessor2 = new TrackingProcessor(); - matchingView = new SupportView(); - nonMatchingView = new ObjectB(); - guardObject = new GuardObject(); - matchingView2 = new SupportViewWithWidthAndHeight(); - } - - /*============================================================================*/ - /* Tests */ - /*============================================================================*/ - - [Test] - public void Implements_IViewHandler() - { - Assert.That (viewProcessorMap, Is.InstanceOf (typeof(IViewHandler))); - } - - [Test] - public void Process_Passes_Mapped_Views_To_Processor_Instance_Process_With_Mapping_By_Type() - { - viewProcessorMap.Map(typeof(SupportView)).ToProcess(trackingProcessor); - viewProcessorMap.Process(matchingView); - viewProcessorMap.Process(nonMatchingView); - - AssertThatProcessorHasProcessedThese(trackingProcessor, new object[1] { matchingView }); - } - - [Test] - public void Process_Passes_Mapped_Views_To_Processor_Instance_Process_With_Mapping_By_Matcher() - { - viewProcessorMap.MapMatcher(supportViewMatcher).ToProcess(trackingProcessor); - viewProcessorMap.Process(matchingView); - viewProcessorMap.Process(nonMatchingView); - AssertThatProcessorHasProcessedThese(trackingProcessor, new object[1] { matchingView }); - } - - [Test] - public void Process_Passes_Mapped_Views_To_Processor_Class_Process_With_Mapping_By_Type() - { - viewProcessorMap.Map(typeof(SupportView)).ToProcess(typeof(TrackingProcessor)); - viewProcessorMap.Process(matchingView); - viewProcessorMap.Process(nonMatchingView); - AssertThatProcessorHasProcessedThese(FromInjector(typeof(TrackingProcessor)), new object [1] { matchingView }); - } - - [Test] - public void Process_Passes_Mapped_Views_To_Processor_Class_Process_With_Mapping_By_Matcher() - { - viewProcessorMap.MapMatcher(supportViewMatcher).ToProcess(typeof(TrackingProcessor)); - viewProcessorMap.Process(matchingView); - viewProcessorMap.Process(nonMatchingView); - AssertThatProcessorHasProcessedThese(FromInjector(typeof(TrackingProcessor)), new object[1] { matchingView }); - } - - [Test] - public void Mapping_One_Matcher_To_Multiple_Processes_By_Class_All_Processes_Run() - { - viewProcessorMap.MapMatcher(supportViewMatcher).ToProcess(typeof(TrackingProcessor)); - viewProcessorMap.MapMatcher(supportViewMatcher).ToProcess(typeof(TrackingProcessor2)); - viewProcessorMap.Process(matchingView); - viewProcessorMap.Process(nonMatchingView); - AssertThatProcessorHasProcessedThese(FromInjector(typeof(TrackingProcessor)), new object[1] { matchingView}); - AssertThatProcessorHasProcessedThese(FromInjector(typeof(TrackingProcessor2)), new object[1] { matchingView}); - } - - [Test] - public void Mapping_One_Matcher_To_Multiple_Processes_By_Instance_All_Processes_Run() - { - viewProcessorMap.MapMatcher(supportViewMatcher).ToProcess(trackingProcessor); - viewProcessorMap.MapMatcher(supportViewMatcher).ToProcess(trackingProcessor2); - viewProcessorMap.Process(matchingView); - viewProcessorMap.Process(nonMatchingView); - AssertThatProcessorHasProcessedThese(trackingProcessor, new object[1] { matchingView }); - AssertThatProcessorHasProcessedThese(trackingProcessor2, new object[1] { matchingView }); - } - - [Test] - public void Duplicate_Identical_Mappings_By_Class_Do_Not_Repeat_Processes() - { - viewProcessorMap.MapMatcher(supportViewMatcher).ToProcess(typeof(TrackingProcessor)); - viewProcessorMap.MapMatcher(supportViewMatcher).ToProcess(typeof(TrackingProcessor)); - viewProcessorMap.Process(matchingView); - viewProcessorMap.Process(nonMatchingView); - AssertThatProcessorHasProcessedThese(FromInjector(typeof(TrackingProcessor)), new object[1] { matchingView }); - } - - [Test] - public void Duplicate_Identical_Mappings_By_Instance_Do_Not_Repeat_Processes() - { - viewProcessorMap.MapMatcher(supportViewMatcher).ToProcess(trackingProcessor); - viewProcessorMap.MapMatcher(supportViewMatcher).ToProcess(trackingProcessor); - viewProcessorMap.Process(matchingView); - viewProcessorMap.Process(nonMatchingView); - AssertThatProcessorHasProcessedThese(trackingProcessor, new object[1] { matchingView }); - } - - [Test] - public void Unprocess_Passes_Mapped_Views_To_Processor_Instance_Unprocess_With_Mapping_By_Type() - { - viewProcessorMap.Map(typeof(SupportView)).ToProcess(trackingProcessor); - viewProcessorMap.Unprocess(matchingView); - viewProcessorMap.Unprocess(nonMatchingView); - AssertThatProcessorHasUnprocessedThese(trackingProcessor, new object[1] { matchingView }); - } - - [Test] - public void Unprocess_Passes_Mapped_Views_To_Processor_Instance_Unprocess_With_Mapping_By_Matcher() - { - viewProcessorMap.MapMatcher(supportViewMatcher).ToProcess(trackingProcessor); - viewProcessorMap.Unprocess(matchingView); - viewProcessorMap.Unprocess(nonMatchingView); - AssertThatProcessorHasUnprocessedThese(trackingProcessor, new object[1] { matchingView }); - } - - [Test] - public void Unmapping_Matcher_From_Single_Processor_Stops_Further_Processing() - { - viewProcessorMap.MapMatcher(supportViewMatcher).ToProcess(trackingProcessor); - viewProcessorMap.Process(matchingView); - viewProcessorMap.UnmapMatcher(supportViewMatcher).FromProcess(trackingProcessor); - viewProcessorMap.Process(matchingView); - AssertThatProcessorHasProcessedThese(trackingProcessor, new object[1] { matchingView }); - } - - [Test] - public void Unmapping_Type_From_Single_Processor_Stops_Further_Processing() - { - viewProcessorMap.Map(typeof(SupportView)).ToProcess(trackingProcessor); - viewProcessorMap.Process(matchingView); - viewProcessorMap.Unmap(typeof(SupportView)).FromProcess(trackingProcessor); - viewProcessorMap.Process(matchingView); - AssertThatProcessorHasProcessedThese(trackingProcessor, new object[1] { matchingView }); - } - - [Test] - public void Unmapping_From_Single_Processor_Keeps_Other_Processors_Intact() - { - viewProcessorMap.Map(typeof(SupportView)).ToProcess(trackingProcessor); - viewProcessorMap.Map(typeof(SupportView)).ToProcess(trackingProcessor2); - viewProcessorMap.Unmap(typeof(SupportView)).FromProcess(trackingProcessor); - viewProcessorMap.Process(matchingView); - AssertThatProcessorHasProcessedThese(trackingProcessor, new object[0]); - AssertThatProcessorHasProcessedThese(trackingProcessor2, new object [1] { matchingView }); - } - - [Test] - public void Unmapping_From_All_Processes_Removes_All_Processes() - { - viewProcessorMap.Map(matchingView.GetType()).ToProcess(typeof(TrackingProcessor)); - viewProcessorMap.Map(matchingView.GetType()).ToProcess(trackingProcessor2); - viewProcessorMap.Unmap(matchingView.GetType()).FromAll(); - viewProcessorMap.Process(matchingView); - AssertThatProcessorHasProcessedThese(FromInjector(typeof(TrackingProcessor)), new object[0]); - AssertThatProcessorHasProcessedThese(trackingProcessor2, new object[0]); - } - - [Test] - public void HandleItem_Passes_Mapped_views_To_Processor_Instance_Process_With_Mapping_By_Type() - { - viewProcessorMap.Map(matchingView.GetType()).ToProcess(trackingProcessor); - viewProcessorMap.HandleView(matchingView, matchingView.GetType()); - viewProcessorMap.HandleView(nonMatchingView, nonMatchingView.GetType()); - AssertThatProcessorHasProcessedThese(trackingProcessor, new object[1] { matchingView }); - } - - [Test] - public void A_Hook_Runs_And_Receives_Injection_Of_View() - { - viewProcessorMap.Map(matchingView2.GetType()).ToProcess(trackingProcessor).WithHooks(typeof(HookWithViewInjectionChangesSize)); - - int expectedViewWidth = 100; - int expectedViewHeight = 200; - - injector.Map(typeof(int), "rectHeight").ToValue(expectedViewHeight); - injector.Map(typeof(int), "rectWidth").ToValue(expectedViewWidth); - - viewProcessorMap.Process(matchingView2); - - Assert.That(matchingView2.Width, Is.EqualTo(expectedViewWidth)); - Assert.That(matchingView2.Height, Is.EqualTo(expectedViewHeight)); - } - - [Test] - public void Does_Not_Leave_View_Mapping_Lying_Around() - { - viewProcessorMap.Map(matchingView.GetType()).ToProcess(trackingProcessor); - viewProcessorMap.HandleView(matchingView, matchingView.GetType()); - Assert.That(injector.HasMapping(matchingView.GetType()), Is.False); - } - - [Test] - public void Process_Runs_If_Guard_Allows_It() - { - viewProcessorMap.Map(guardObject.GetType()).ToProcess(trackingProcessor).WithGuards(typeof(OnlyIfViewApprovesGuard)); - guardObject.ShouldApprove = true; - viewProcessorMap.Process(guardObject); - AssertThatProcessorHasProcessedThese(trackingProcessor, new object[1] { guardObject }); - } - - [Test] - public void Process_Does_Not_Run_If_Guard_Prevents_It() - { - viewProcessorMap.Map(guardObject.GetType()).ToProcess(trackingProcessor).WithGuards(typeof(OnlyIfViewApprovesGuard)); - viewProcessorMap.Process(guardObject); - AssertThatProcessorHasProcessedThese(trackingProcessor, new object[0]); - } - - [Test] - public void Removing_A_Mapping_That_Does_Not_Exist_Does_Not_Throw_An_Error() - { - viewProcessorMap.Unmap(matchingView.GetType()).FromProcess(trackingProcessor); - } - - [Test] - public void Mapping_For_Injection_Results_In_View_Being_Injected() - { - string expectedInjectionValue = "Injected string"; - injector.Map(typeof(string)).ToValue(expectedInjectionValue); - - viewProcessorMap.Map(typeof(ViewNeedingInjection)).ToInjection(); - ViewNeedingInjection viewNeedingInjection = new ViewNeedingInjection(); - viewProcessorMap.Process(viewNeedingInjection); - Assert.That(viewNeedingInjection.injectedValue, Is.EqualTo(expectedInjectionValue)); - } - - [Test] - public void Unmapping_For_Injection_Results_In_View_Not_Being_Injected() - { - viewProcessorMap.Map(typeof(ViewNeedingInjection)).ToInjection(); - viewProcessorMap.Unmap(typeof(ViewNeedingInjection)).FromInjection(); - ViewNeedingInjection viewNeedingInjection = new ViewNeedingInjection(); - viewProcessorMap.Process(viewNeedingInjection); - Assert.That(viewNeedingInjection.injectedValue, Is.EqualTo(null)); - } - - [Test] - public void Mapping_To_No_Process_Still_Applies_Hooks() - { - viewProcessorMap.Map(matchingView2.GetType()).ToNoProcess().WithHooks(typeof(HookWithViewInjectionChangesSize)); - - int expectedViewWidth = 100; - int expectedViewHeight = 200; - - injector.Map(typeof(int), "rectHeight").ToValue(expectedViewHeight); - injector.Map(typeof(int), "rectWidth").ToValue(expectedViewWidth); - - viewProcessorMap.Process(matchingView2); - - Assert.That(matchingView2.Width, Is.EqualTo(expectedViewWidth)); - Assert.That(matchingView2.Height, Is.EqualTo(expectedViewHeight)); - } - - [Test] - public void Unmapping_From_No_Process_Does_Not_Apply_Hooks() - { - viewProcessorMap.Map(matchingView2.GetType()).ToNoProcess().WithHooks(typeof(HookWithViewInjectionChangesSize)); - - injector.Map(typeof(int), "rectHeight").ToValue(100); - injector.Map(typeof(int), "rectWidth").ToValue(200); - - viewProcessorMap.Unmap(matchingView2.GetType()).FromNoProcess(); - viewProcessorMap.Process(matchingView2); - - Assert.That(matchingView2.Width, Is.EqualTo(0)); - Assert.That(matchingView2.Height, Is.EqualTo(0)); - } - - [Test] - public async void Automatically_Unprocesses_When_View_Leaves_Stage() - { - viewProcessorMap.Map(matchingView.GetType()).ToProcess(trackingProcessor); - matchingView.AddThisView(); - viewProcessorMap.Process(matchingView); - - matchingView.RemoveView += CheckUnprocessorsRan; - matchingView.RemoveThisView(); - await Task.Delay(500); - } - - [Test] - public void Hooks_Run_Before_Process() - { - List timingTracker = new List(); - injector.Map(typeof(List), "timingTracker").ToValue(timingTracker); - viewProcessorMap.Map(matchingView.GetType()).ToProcess(typeof(Processor)).WithHooks(typeof(HookA)); - viewProcessorMap.Process(matchingView); - Assert.That(timingTracker, Is.EquivalentTo(new Object[2]{ typeof(HookA), typeof(Processor) })); - } - - /*============================================================================*/ - /* Protected Functions */ - /*============================================================================*/ - - protected object FromInjector(Type type) - { - if (!injector.HasDirectMapping(type)) - { - injector.Map(type).AsSingleton(); - } - return injector.GetInstance(type); - } - - protected void AssertThatProcessorHasProcessedThese(object processor, object[] expected) - { - PropertyInfo processedViewsProperty = processor.GetType ().GetProperty ("ProcessedViews"); - Assert.That (processedViewsProperty, Is.Not.Null, String.Format("Object {0} does not contain a property called ProcessedViews", processor)); - - object processedViews = processedViewsProperty.GetValue (processor); - - Assert.That(processedViews, Is.EqualTo(expected).AsCollection); - } - - protected void AssertThatProcessorHasUnprocessedThese(object processor, object[] expected) - { - AssertThatProcessorHasUnprocessedThese(processor as TrackingProcessor, expected); - } - - protected void AssertThatProcessorHasUnprocessedThese(TrackingProcessor processor, object[] expected) - { - Assert.That(processor.UnprocessedViews, Is.EqualTo(expected).AsCollection); - } - - /*============================================================================*/ - /* Private Functions */ - /*============================================================================*/ - - private void CheckUnprocessorsRan(IView view) - { - AssertThatProcessorHasUnprocessedThese(trackingProcessor, new object[1] { matchingView }); - } - - } + public class ViewProcessorMapTest + { + /*============================================================================*/ + /* Private Properties */ + /*============================================================================*/ + + // TODO: extract processing tests into own tests + // TODO: add actual ViewProcessorMap tests + + #region Fields + + private GuardObject guardObject; + private IInjector injector; + private SupportView matchingView; + private SupportViewWithWidthAndHeight matchingView2; + private ObjectB nonMatchingView; + private TypeMatcher supportViewMatcher = new TypeMatcher().AllOf(typeof(SupportView)); + + private TrackingProcessor trackingProcessor; + private TrackingProcessor trackingProcessor2; + private ViewProcessorMap viewProcessorMap; + + #endregion Fields + + /*============================================================================*/ + /* Test Setup and Teardown */ + /*============================================================================*/ + + #region Methods + + [Test] + public void A_Hook_Runs_And_Receives_Injection_Of_View() + { + viewProcessorMap.Map(matchingView2.GetType()).ToProcess(trackingProcessor).WithHooks(typeof(HookWithViewInjectionChangesSize)); + + int expectedViewWidth = 100; + int expectedViewHeight = 200; + + injector.Map(typeof(int), "rectHeight").ToValue(expectedViewHeight); + injector.Map(typeof(int), "rectWidth").ToValue(expectedViewWidth); + + viewProcessorMap.Process(matchingView2); + + Assert.That(matchingView2.Width, Is.EqualTo(expectedViewWidth)); + Assert.That(matchingView2.Height, Is.EqualTo(expectedViewHeight)); + } + + [Test] + public async Task Automatically_Unprocesses_When_View_Leaves_Stage() + { + viewProcessorMap.Map(matchingView.GetType()).ToProcess(trackingProcessor); + matchingView.AddThisView(); + viewProcessorMap.Process(matchingView); + + matchingView.RemoveView += CheckUnprocessorsRan; + matchingView.RemoveThisView(); + await Task.Delay(500); + } + + [Test] + public void Does_Not_Leave_View_Mapping_Lying_Around() + { + viewProcessorMap.Map(matchingView.GetType()).ToProcess(trackingProcessor); + viewProcessorMap.HandleView(matchingView, matchingView.GetType()); + Assert.That(injector.HasMapping(matchingView.GetType()), Is.False); + } + + [Test] + public void Duplicate_Identical_Mappings_By_Class_Do_Not_Repeat_Processes() + { + viewProcessorMap.MapMatcher(supportViewMatcher).ToProcess(typeof(TrackingProcessor)); + viewProcessorMap.MapMatcher(supportViewMatcher).ToProcess(typeof(TrackingProcessor)); + viewProcessorMap.Process(matchingView); + viewProcessorMap.Process(nonMatchingView); + AssertThatProcessorHasProcessedThese(FromInjector(typeof(TrackingProcessor)), new object[1] { matchingView }); + } + + [Test] + public void Duplicate_Identical_Mappings_By_Instance_Do_Not_Repeat_Processes() + { + viewProcessorMap.MapMatcher(supportViewMatcher).ToProcess(trackingProcessor); + viewProcessorMap.MapMatcher(supportViewMatcher).ToProcess(trackingProcessor); + viewProcessorMap.Process(matchingView); + viewProcessorMap.Process(nonMatchingView); + AssertThatProcessorHasProcessedThese(trackingProcessor, new object[1] { matchingView }); + } + + [Test] + public void HandleItem_Passes_Mapped_views_To_Processor_Instance_Process_With_Mapping_By_Type() + { + viewProcessorMap.Map(matchingView.GetType()).ToProcess(trackingProcessor); + viewProcessorMap.HandleView(matchingView, matchingView.GetType()); + viewProcessorMap.HandleView(nonMatchingView, nonMatchingView.GetType()); + AssertThatProcessorHasProcessedThese(trackingProcessor, new object[1] { matchingView }); + } + + [Test] + public void Hooks_Run_Before_Process() + { + List timingTracker = new List(); + injector.Map(typeof(List), "timingTracker").ToValue(timingTracker); + viewProcessorMap.Map(matchingView.GetType()).ToProcess(typeof(Processor)).WithHooks(typeof(HookA)); + viewProcessorMap.Process(matchingView); + Assert.That(timingTracker, Is.EquivalentTo(new Object[2] { typeof(HookA), typeof(Processor) })); + } + + [Test] + public void Implements_IViewHandler() + { + Assert.That(viewProcessorMap, Is.InstanceOf(typeof(IViewHandler))); + } + + [Test] + public void Mapping_For_Injection_Results_In_View_Being_Injected() + { + string expectedInjectionValue = "Injected string"; + injector.Map(typeof(string)).ToValue(expectedInjectionValue); + + viewProcessorMap.Map(typeof(ViewNeedingInjection)).ToInjection(); + ViewNeedingInjection viewNeedingInjection = new ViewNeedingInjection(); + viewProcessorMap.Process(viewNeedingInjection); + Assert.That(viewNeedingInjection.injectedValue, Is.EqualTo(expectedInjectionValue)); + } + + [Test] + public void Mapping_One_Matcher_To_Multiple_Processes_By_Class_All_Processes_Run() + { + viewProcessorMap.MapMatcher(supportViewMatcher).ToProcess(typeof(TrackingProcessor)); + viewProcessorMap.MapMatcher(supportViewMatcher).ToProcess(typeof(TrackingProcessor2)); + viewProcessorMap.Process(matchingView); + viewProcessorMap.Process(nonMatchingView); + AssertThatProcessorHasProcessedThese(FromInjector(typeof(TrackingProcessor)), new object[1] { matchingView }); + AssertThatProcessorHasProcessedThese(FromInjector(typeof(TrackingProcessor2)), new object[1] { matchingView }); + } + + [Test] + public void Mapping_One_Matcher_To_Multiple_Processes_By_Instance_All_Processes_Run() + { + viewProcessorMap.MapMatcher(supportViewMatcher).ToProcess(trackingProcessor); + viewProcessorMap.MapMatcher(supportViewMatcher).ToProcess(trackingProcessor2); + viewProcessorMap.Process(matchingView); + viewProcessorMap.Process(nonMatchingView); + AssertThatProcessorHasProcessedThese(trackingProcessor, new object[1] { matchingView }); + AssertThatProcessorHasProcessedThese(trackingProcessor2, new object[1] { matchingView }); + } + + [Test] + public void Mapping_To_No_Process_Still_Applies_Hooks() + { + viewProcessorMap.Map(matchingView2.GetType()).ToNoProcess().WithHooks(typeof(HookWithViewInjectionChangesSize)); + + int expectedViewWidth = 100; + int expectedViewHeight = 200; + + injector.Map(typeof(int), "rectHeight").ToValue(expectedViewHeight); + injector.Map(typeof(int), "rectWidth").ToValue(expectedViewWidth); + + viewProcessorMap.Process(matchingView2); + + Assert.That(matchingView2.Width, Is.EqualTo(expectedViewWidth)); + Assert.That(matchingView2.Height, Is.EqualTo(expectedViewHeight)); + } + + [Test] + public void Process_Does_Not_Run_If_Guard_Prevents_It() + { + viewProcessorMap.Map(guardObject.GetType()).ToProcess(trackingProcessor).WithGuards(typeof(OnlyIfViewApprovesGuard)); + viewProcessorMap.Process(guardObject); + AssertThatProcessorHasProcessedThese(trackingProcessor, new object[0]); + } + + [Test] + public void Process_Passes_Mapped_Views_To_Processor_Class_Process_With_Mapping_By_Matcher() + { + viewProcessorMap.MapMatcher(supportViewMatcher).ToProcess(typeof(TrackingProcessor)); + viewProcessorMap.Process(matchingView); + viewProcessorMap.Process(nonMatchingView); + AssertThatProcessorHasProcessedThese(FromInjector(typeof(TrackingProcessor)), new object[1] { matchingView }); + } + + [Test] + public void Process_Passes_Mapped_Views_To_Processor_Class_Process_With_Mapping_By_Type() + { + viewProcessorMap.Map(typeof(SupportView)).ToProcess(typeof(TrackingProcessor)); + viewProcessorMap.Process(matchingView); + viewProcessorMap.Process(nonMatchingView); + AssertThatProcessorHasProcessedThese(FromInjector(typeof(TrackingProcessor)), new object[1] { matchingView }); + } + + [Test] + public void Process_Passes_Mapped_Views_To_Processor_Instance_Process_With_Mapping_By_Matcher() + { + viewProcessorMap.MapMatcher(supportViewMatcher).ToProcess(trackingProcessor); + viewProcessorMap.Process(matchingView); + viewProcessorMap.Process(nonMatchingView); + AssertThatProcessorHasProcessedThese(trackingProcessor, new object[1] { matchingView }); + } + + [Test] + public void Process_Passes_Mapped_Views_To_Processor_Instance_Process_With_Mapping_By_Type() + { + viewProcessorMap.Map(typeof(SupportView)).ToProcess(trackingProcessor); + viewProcessorMap.Process(matchingView); + viewProcessorMap.Process(nonMatchingView); + + AssertThatProcessorHasProcessedThese(trackingProcessor, new object[1] { matchingView }); + } + + [Test] + public void Process_Runs_If_Guard_Allows_It() + { + viewProcessorMap.Map(guardObject.GetType()).ToProcess(trackingProcessor).WithGuards(typeof(OnlyIfViewApprovesGuard)); + guardObject.ShouldApprove = true; + viewProcessorMap.Process(guardObject); + AssertThatProcessorHasProcessedThese(trackingProcessor, new object[1] { guardObject }); + } + + [Test] + public void Removing_A_Mapping_That_Does_Not_Exist_Does_Not_Throw_An_Error() + { + viewProcessorMap.Unmap(matchingView.GetType()).FromProcess(trackingProcessor); + } + + [SetUp] + public void Setup() + { + injector = new RobotlegsInjector(); + injector.Map(typeof(RobotlegsInjector)).ToValue(injector); + viewProcessorMap = new ViewProcessorMap(new ViewProcessorFactory(injector)); + trackingProcessor = new TrackingProcessor(); + trackingProcessor2 = new TrackingProcessor(); + matchingView = new SupportView(); + nonMatchingView = new ObjectB(); + guardObject = new GuardObject(); + matchingView2 = new SupportViewWithWidthAndHeight(); + } + + /*============================================================================*/ + /* Tests */ + /*============================================================================*/ + + [Test] + public void Unmapping_For_Injection_Results_In_View_Not_Being_Injected() + { + viewProcessorMap.Map(typeof(ViewNeedingInjection)).ToInjection(); + viewProcessorMap.Unmap(typeof(ViewNeedingInjection)).FromInjection(); + ViewNeedingInjection viewNeedingInjection = new ViewNeedingInjection(); + viewProcessorMap.Process(viewNeedingInjection); + Assert.That(viewNeedingInjection.injectedValue, Is.EqualTo(null)); + } + + [Test] + public void Unmapping_From_All_Processes_Removes_All_Processes() + { + viewProcessorMap.Map(matchingView.GetType()).ToProcess(typeof(TrackingProcessor)); + viewProcessorMap.Map(matchingView.GetType()).ToProcess(trackingProcessor2); + viewProcessorMap.Unmap(matchingView.GetType()).FromAll(); + viewProcessorMap.Process(matchingView); + AssertThatProcessorHasProcessedThese(FromInjector(typeof(TrackingProcessor)), new object[0]); + AssertThatProcessorHasProcessedThese(trackingProcessor2, new object[0]); + } + + [Test] + public void Unmapping_From_No_Process_Does_Not_Apply_Hooks() + { + viewProcessorMap.Map(matchingView2.GetType()).ToNoProcess().WithHooks(typeof(HookWithViewInjectionChangesSize)); + + injector.Map(typeof(int), "rectHeight").ToValue(100); + injector.Map(typeof(int), "rectWidth").ToValue(200); + + viewProcessorMap.Unmap(matchingView2.GetType()).FromNoProcess(); + viewProcessorMap.Process(matchingView2); + + Assert.That(matchingView2.Width, Is.EqualTo(0)); + Assert.That(matchingView2.Height, Is.EqualTo(0)); + } + + [Test] + public void Unmapping_From_Single_Processor_Keeps_Other_Processors_Intact() + { + viewProcessorMap.Map(typeof(SupportView)).ToProcess(trackingProcessor); + viewProcessorMap.Map(typeof(SupportView)).ToProcess(trackingProcessor2); + viewProcessorMap.Unmap(typeof(SupportView)).FromProcess(trackingProcessor); + viewProcessorMap.Process(matchingView); + AssertThatProcessorHasProcessedThese(trackingProcessor, new object[0]); + AssertThatProcessorHasProcessedThese(trackingProcessor2, new object[1] { matchingView }); + } + + [Test] + public void Unmapping_Matcher_From_Single_Processor_Stops_Further_Processing() + { + viewProcessorMap.MapMatcher(supportViewMatcher).ToProcess(trackingProcessor); + viewProcessorMap.Process(matchingView); + viewProcessorMap.UnmapMatcher(supportViewMatcher).FromProcess(trackingProcessor); + viewProcessorMap.Process(matchingView); + AssertThatProcessorHasProcessedThese(trackingProcessor, new object[1] { matchingView }); + } + + [Test] + public void Unmapping_Type_From_Single_Processor_Stops_Further_Processing() + { + viewProcessorMap.Map(typeof(SupportView)).ToProcess(trackingProcessor); + viewProcessorMap.Process(matchingView); + viewProcessorMap.Unmap(typeof(SupportView)).FromProcess(trackingProcessor); + viewProcessorMap.Process(matchingView); + AssertThatProcessorHasProcessedThese(trackingProcessor, new object[1] { matchingView }); + } + + [Test] + public void Unprocess_Passes_Mapped_Views_To_Processor_Instance_Unprocess_With_Mapping_By_Matcher() + { + viewProcessorMap.MapMatcher(supportViewMatcher).ToProcess(trackingProcessor); + viewProcessorMap.Unprocess(matchingView); + viewProcessorMap.Unprocess(nonMatchingView); + AssertThatProcessorHasUnprocessedThese(trackingProcessor, new object[1] { matchingView }); + } + + [Test] + public void Unprocess_Passes_Mapped_Views_To_Processor_Instance_Unprocess_With_Mapping_By_Type() + { + viewProcessorMap.Map(typeof(SupportView)).ToProcess(trackingProcessor); + viewProcessorMap.Unprocess(matchingView); + viewProcessorMap.Unprocess(nonMatchingView); + AssertThatProcessorHasUnprocessedThese(trackingProcessor, new object[1] { matchingView }); + } + + /*============================================================================*/ + /* Protected Functions */ + /*============================================================================*/ + + protected void AssertThatProcessorHasProcessedThese(object processor, object[] expected) + { + PropertyInfo processedViewsProperty = processor.GetType().GetProperty("ProcessedViews"); + Assert.That(processedViewsProperty, Is.Not.Null, String.Format("Object {0} does not contain a property called ProcessedViews", processor)); + + object processedViews = processedViewsProperty.GetValue(processor); + + Assert.That(processedViews, Is.EqualTo(expected).AsCollection); + } + + protected void AssertThatProcessorHasUnprocessedThese(object processor, object[] expected) + { + AssertThatProcessorHasUnprocessedThese(processor as TrackingProcessor, expected); + } + + protected void AssertThatProcessorHasUnprocessedThese(TrackingProcessor processor, object[] expected) + { + Assert.That(processor.UnprocessedViews, Is.EqualTo(expected).AsCollection); + } + + protected object FromInjector(Type type) + { + if (!injector.HasDirectMapping(type)) + { + injector.Map(type).AsSingleton(); + } + return injector.GetInstance(type); + } + + /*============================================================================*/ + /* Private Functions */ + /*============================================================================*/ + + private void CheckUnprocessorsRan(IView view) + { + AssertThatProcessorHasUnprocessedThese(trackingProcessor, new object[1] { matchingView }); + } + + #endregion Methods + } } -class ViewNeedingInjection : object +internal class GuardObject : Object { + #region Fields - /*============================================================================*/ - /* Public Properties */ - /*============================================================================*/ + public bool ShouldApprove; - [Inject] - public string injectedValue {get;set;} + #endregion Fields } -class OnlyIfViewApprovesGuard +internal class HookA { + /*============================================================================*/ + /* Public Properties */ + /*============================================================================*/ - /*============================================================================*/ - /* Public Properties */ - /*============================================================================*/ - [Inject] - public GuardObject view {get;set;} + #region Properties - /*============================================================================*/ - /* Public Functions */ - /*============================================================================*/ + [Inject("timingTracker")] + public List timingTracker + { + get; set; + } - public bool Approve() - { - return view.ShouldApprove; - } -} + #endregion Properties -class SupportViewWithWidthAndHeight : SupportView -{ - public int Width; + /*============================================================================*/ + /* Public Functions */ + /*============================================================================*/ + + #region Methods - public int Height; + public void Hook() + { + timingTracker.Add(typeof(HookA)); + } + + #endregion Methods } -class HookWithViewInjectionChangesSize +internal class HookWithViewInjectionChangesSize { + /*============================================================================*/ + /* Public Properties */ + /*============================================================================*/ + + #region Properties - /*============================================================================*/ - /* Public Properties */ - /*============================================================================*/ + [Inject("rectHeight")] + public int rectHeight + { + get; set; + } - [Inject] - public SupportViewWithWidthAndHeight view {get;set;} + [Inject("rectWidth")] + public int rectWidth + { + get; set; + } - [Inject("rectWidth")] - public int rectWidth {get;set;} + [Inject] + public SupportViewWithWidthAndHeight view + { + get; set; + } - [Inject("rectHeight")] - public int rectHeight {get;set;} + #endregion Properties - /*============================================================================*/ - /* Public Functions */ - /*============================================================================*/ + /*============================================================================*/ + /* Public Functions */ + /*============================================================================*/ - public void Hook() - { - view.Width = rectWidth; - view.Height = rectHeight; - } + #region Methods + + public void Hook() + { + view.Width = rectWidth; + view.Height = rectHeight; + } + + #endregion Methods } -class HookA +internal class OnlyIfViewApprovesGuard { + /*============================================================================*/ + /* Public Properties */ + /*============================================================================*/ - /*============================================================================*/ - /* Public Properties */ - /*============================================================================*/ - [Inject("timingTracker")] - public List timingTracker {get;set;} + #region Properties - /*============================================================================*/ - /* Public Functions */ - /*============================================================================*/ + [Inject] + public GuardObject view + { + get; set; + } - public void Hook() - { - timingTracker.Add(typeof(HookA)); - } -} + #endregion Properties + + /*============================================================================*/ + /* Public Functions */ + /*============================================================================*/ + + #region Methods + public bool Approve() + { + return view.ShouldApprove; + } -class GuardObject : Object + #endregion Methods +} + +internal class SupportViewWithWidthAndHeight : SupportView { - public bool ShouldApprove; + #region Fields + + public int Height; + public int Width; + + #endregion Fields } + +internal class ViewNeedingInjection : object +{ + /*============================================================================*/ + /* Public Properties */ + /*============================================================================*/ + + + #region Properties + + [Inject] + public string injectedValue + { + get; set; + } + + #endregion Properties +} \ No newline at end of file diff --git a/tests/Robotlegs/Bender/Extensions/ViewProcessor/Impl/ViewProcessorMediatorsTest.cs b/tests/Robotlegs/Bender/Extensions/ViewProcessor/Impl/ViewProcessorMediatorsTest.cs index 421ca8a..0cbb354 100644 --- a/tests/Robotlegs/Bender/Extensions/ViewProcessor/Impl/ViewProcessorMediatorsTest.cs +++ b/tests/Robotlegs/Bender/Extensions/ViewProcessor/Impl/ViewProcessorMediatorsTest.cs @@ -1,8 +1,8 @@ //------------------------------------------------------------------------------ -// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. -// -// NOTICE: You are permitted to use, modify, and distribute this file -// in accordance with the terms of the license agreement accompanying it. +// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. +// +// NOTICE: You are permitted to use, modify, and distribute this file +// in accordance with the terms of the license agreement accompanying it. //------------------------------------------------------------------------------ using Robotlegs.Bender.Framework.API; @@ -20,154 +20,174 @@ namespace Robotlegs.Bender.Extensions.ViewProcessor.Impl { - public class ViewProcessorMediatorsTest - { - - /*============================================================================*/ - /* Private Properties */ - /*============================================================================*/ - - private IInjector injector; - - private ViewProcessorMap instance; - - private MediatorWatcher mediatorWatcher; - - private SupportView matchingView; - - /*============================================================================*/ - /* Test Setup and Teardown */ - /*============================================================================*/ - - [SetUp] - public void Setup() - { - injector = new RobotlegsInjector(); - instance = new ViewProcessorMap(new ViewProcessorFactory(injector)); - - mediatorWatcher = new MediatorWatcher(); - injector.Map(typeof(MediatorWatcher)).ToValue(mediatorWatcher); - matchingView = new SupportView(); - } - - [TearDown] - public void TearDown() - { - instance = null; - injector = null; - mediatorWatcher = null; - } - - /*============================================================================*/ - /* Tests */ - /*============================================================================*/ - - [Test] - public void Test_Failure_Seen() - { - Assert.That (true, Is.True); - } - - [Test] - public void Create_Mediator_Instantiates_Mediator_For_View_When_Mapped() - { - instance.Map(typeof(SupportView)).ToProcess(new MediatorCreator(typeof(SupportMediator))); - - SupportView objA = new SupportView(); - instance.HandleView(objA, objA.GetType()); - objA.AddThisView(); - - string[] expectedNotifications = new string[1] { "SupportMediator" }; - Assert.That (expectedNotifications, Is.EquivalentTo (mediatorWatcher.Notifications)); - } - - [Test] - public void Doesnt_Leave_View_And_Mediator_Mappings_Lying_Around() - { - instance.MapMatcher(new TypeMatcher().AnyOf(typeof(ObjectWhichExtendsSupportView), typeof(SupportView))).ToProcess(new MediatorCreator(typeof(SupportMediator))); - instance.HandleView(new SupportView(), typeof(SupportView)); - - Assert.That(injector.HasDirectMapping(typeof(ObjectWhichExtendsSupportView)), Is.False); - Assert.That(injector.HasDirectMapping(typeof(SupportView)), Is.False); - Assert.That(injector.HasDirectMapping(typeof(SupportMediator)), Is.False); - } - - [Test] - public void Process_Instantiates_Mediator_For_View_When_Matched_To_Mapping() - { - instance.Map(typeof(SupportView)).ToProcess(new MediatorCreator(typeof(SupportMediator))); - - instance.Process(new SupportView()); - - List expectedNotifications = new List{"SupportMediator"}; - Assert.That(expectedNotifications, Is.EquivalentTo(mediatorWatcher.Notifications)); - } - - [Test] - public void Runs_Destroy_On_Created_Mediator_When_Unprocess_Runs() - { - instance.Map(typeof(SupportView)).ToProcess(new MediatorCreator(typeof(SupportMediator))); - - SupportView view = new SupportView(); - instance.Process(view); - instance.Unprocess(view); - - List expectedNotifications = new List{"SupportMediator", "SupportMediator destroy"}; - Assert.That(expectedNotifications, Is.EquivalentTo(mediatorWatcher.Notifications)); - } - - [Test] - public async void Automatically_Unprocesses_When_View_Leaves_Stage() - { - instance.Map(typeof(SupportView)).ToProcess(new MediatorCreator(typeof(SupportMediator))); - matchingView.AddThisView(); - instance.Process(matchingView); - Action removeViewCallback = null; - removeViewCallback = delegate(IView view) { - matchingView.RemoveView -= removeViewCallback; - CheckMediatorsDestroyed(view); - }; - matchingView.RemoveView += removeViewCallback; - matchingView.RemoveThisView(); - await Task.Delay (500); - } - - /*============================================================================*/ - /* Private Functions */ - /*============================================================================*/ - - private void CheckMediatorsDestroyed(object view) - { - List expectedNotifications = new List {"SupportMediator", "SupportMediator destroy"}; - Assert.That(expectedNotifications, Is.EqualTo(expectedNotifications).AsCollection); - } - } + public class ViewProcessorMediatorsTest + { + /*============================================================================*/ + /* Private Properties */ + /*============================================================================*/ + + #region Fields + + private IInjector injector; + + private ViewProcessorMap instance; + + private SupportView matchingView; + private MediatorWatcher mediatorWatcher; + + #endregion Fields + + /*============================================================================*/ + /* Test Setup and Teardown */ + /*============================================================================*/ + + #region Methods + + [Test] + public async Task Automatically_Unprocesses_When_View_Leaves_Stage() + { + instance.Map(typeof(SupportView)).ToProcess(new MediatorCreator(typeof(SupportMediator))); + matchingView.AddThisView(); + instance.Process(matchingView); + Action removeViewCallback = null; + removeViewCallback = delegate (IView view) + { + matchingView.RemoveView -= removeViewCallback; + CheckMediatorsDestroyed(view); + }; + matchingView.RemoveView += removeViewCallback; + matchingView.RemoveThisView(); + await Task.Delay(500); + } + + [Test] + public void Create_Mediator_Instantiates_Mediator_For_View_When_Mapped() + { + instance.Map(typeof(SupportView)).ToProcess(new MediatorCreator(typeof(SupportMediator))); + + SupportView objA = new SupportView(); + instance.HandleView(objA, objA.GetType()); + objA.AddThisView(); + + string[] expectedNotifications = new string[1] { "SupportMediator" }; + Assert.That(expectedNotifications, Is.EquivalentTo(mediatorWatcher.Notifications)); + } + + [Test] + public void Doesnt_Leave_View_And_Mediator_Mappings_Lying_Around() + { + instance.MapMatcher(new TypeMatcher().AnyOf(typeof(ObjectWhichExtendsSupportView), typeof(SupportView))).ToProcess(new MediatorCreator(typeof(SupportMediator))); + instance.HandleView(new SupportView(), typeof(SupportView)); + + Assert.That(injector.HasDirectMapping(typeof(ObjectWhichExtendsSupportView)), Is.False); + Assert.That(injector.HasDirectMapping(typeof(SupportView)), Is.False); + Assert.That(injector.HasDirectMapping(typeof(SupportMediator)), Is.False); + } + + [Test] + public void Process_Instantiates_Mediator_For_View_When_Matched_To_Mapping() + { + instance.Map(typeof(SupportView)).ToProcess(new MediatorCreator(typeof(SupportMediator))); + + instance.Process(new SupportView()); + + List expectedNotifications = new List { "SupportMediator" }; + Assert.That(expectedNotifications, Is.EquivalentTo(mediatorWatcher.Notifications)); + } + + [Test] + public void Runs_Destroy_On_Created_Mediator_When_Unprocess_Runs() + { + instance.Map(typeof(SupportView)).ToProcess(new MediatorCreator(typeof(SupportMediator))); + + SupportView view = new SupportView(); + instance.Process(view); + instance.Unprocess(view); + + List expectedNotifications = new List { "SupportMediator", "SupportMediator destroy" }; + Assert.That(expectedNotifications, Is.EquivalentTo(mediatorWatcher.Notifications)); + } + + [SetUp] + public void Setup() + { + injector = new RobotlegsInjector(); + instance = new ViewProcessorMap(new ViewProcessorFactory(injector)); + + mediatorWatcher = new MediatorWatcher(); + injector.Map(typeof(MediatorWatcher)).ToValue(mediatorWatcher); + matchingView = new SupportView(); + } + + [TearDown] + public void TearDown() + { + instance = null; + injector = null; + mediatorWatcher = null; + } + + /*============================================================================*/ + /* Tests */ + /*============================================================================*/ + + [Test] + public void Test_Failure_Seen() + { + Assert.That(true, Is.True); + } + + /*============================================================================*/ + /* Private Functions */ + /*============================================================================*/ + + private void CheckMediatorsDestroyed(object view) + { + List expectedNotifications = new List { "SupportMediator", "SupportMediator destroy" }; + Assert.That(expectedNotifications, Is.EqualTo(expectedNotifications).AsCollection); + } + + #endregion Methods + } } -class SupportMediator2 +internal class SupportMediator2 { + /*============================================================================*/ + /* Public Properties */ + /*============================================================================*/ - /*============================================================================*/ - /* Public Properties */ - /*============================================================================*/ + #region Properties - [Inject] - public MediatorWatcher mediatorWatcher {get;set;} + [Inject] + public MediatorWatcher mediatorWatcher + { + get; set; + } - [Inject] - public SupportView view {get;set;} + [Inject] + public SupportView view + { + get; set; + } - /*============================================================================*/ - /* Public Functions */ - /*============================================================================*/ + #endregion Properties - public void Initialize() - { - mediatorWatcher.Notify("SupportMediator2"); - } + /*============================================================================*/ + /* Public Functions */ + /*============================================================================*/ - public void Destroy() - { - mediatorWatcher.Notify("SupportMediator2 destroy"); - } -} + #region Methods + + public void Destroy() + { + mediatorWatcher.Notify("SupportMediator2 destroy"); + } + + public void Initialize() + { + mediatorWatcher.Notify("SupportMediator2"); + } + + #endregion Methods +} \ No newline at end of file diff --git a/tests/Robotlegs/Bender/Framework/Impl/ContextSupport/EmptyExtension.cs b/tests/Robotlegs/Bender/Framework/Impl/ContextSupport/EmptyExtension.cs new file mode 100644 index 0000000..57a506d --- /dev/null +++ b/tests/Robotlegs/Bender/Framework/Impl/ContextSupport/EmptyExtension.cs @@ -0,0 +1,25 @@ +//------------------------------------------------------------------------------ +// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. +// +// NOTICE: You are permitted to use, modify, and distribute this file +// in accordance with the terms of the license agreement accompanying it. +//------------------------------------------------------------------------------ + +using System; +using Robotlegs.Bender.Framework.API; + +namespace Robotlegs.Bender.Framework.Impl.ContextSupport +{ + public class EmptyExtension : IExtension + { + /*============================================================================*/ + /* Public Functions */ + /*============================================================================*/ + + public void Extend(IContext context) + { + + } + } +} + diff --git a/tests/Robotlegs/Bender/Framework/Impl/ContextTest.cs b/tests/Robotlegs/Bender/Framework/Impl/ContextTest.cs index 3e2e7e0..2733579 100644 --- a/tests/Robotlegs/Bender/Framework/Impl/ContextTest.cs +++ b/tests/Robotlegs/Bender/Framework/Impl/ContextTest.cs @@ -1,11 +1,11 @@ //------------------------------------------------------------------------------ -// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. -// -// NOTICE: You are permitted to use, modify, and distribute this file -// in accordance with the terms of the license agreement accompanying it. +// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. +// +// NOTICE: You are permitted to use, modify, and distribute this file +// in accordance with the terms of the license agreement accompanying it. //------------------------------------------------------------------------------ -using System; +using System; using System.Collections.Generic; using NUnit.Framework; using Robotlegs.Bender.Framework.Impl; @@ -15,366 +15,390 @@ namespace Robotlegs.Bender.Framework.Impl { - [TestFixture] - public class ContextTest - { - /*============================================================================*/ - /* Private Properties */ - /*============================================================================*/ - - private IContext context; - - /*============================================================================*/ - /* Test Setup and Teardown */ - /*============================================================================*/ - - [SetUp] - public void before() - { - context = new Context(); - } - - /*============================================================================*/ - /* Tests */ - /*============================================================================*/ - - [Test] - public void can_instantiate() - { - Assert.That(context, Is.Not.Null); - Assert.That (context, Is.InstanceOf ()); - } - - [Test] - public void extensions_are_installed() - { - IContext actual = null; - IExtension extension = new CallbackExtension( - delegate(IContext c) { - actual = c; - }); - context.Install(extension); - Assert.That(actual, Is.EqualTo(context)); - } - - [Test] - public void configs_are_installed() - { - bool installed = false; - IConfig config = new CallbackConfig( - delegate() { - installed = true; - }); - context.Configure(config); - context.Initialize(); - Assert.That(installed, Is.True); - } - - [Test] - public void injector_is_mapped_into_itself() - { - IInjector injector = context.injector.GetInstance(); - Assert.That(injector, Is.EqualTo(context.injector)); - } - - [Test] - public void detain_stores_the_instance() - { - object expected = new object(); - object actual = null; - context.Detained += delegate(object obj) { - actual = obj; - }; - context.Detain(expected); - Assert.AreEqual (actual, expected); - } - - [Test] - public void release_frees_up_the_instance() - { - object expected = new object (); - object actual = null; - context.Released += delegate(object obj) { - actual = obj; - }; - context.Detain (expected); - context.Release (expected); - - Assert.AreEqual (actual, expected); - } - - [Test] - public void addChild_sets_child_parentInjector() - { - Context child = new Context(); - context.AddChild(child); - Assert.That(child.injector.parent, Is.EqualTo(context.injector)); - } - - [Test] - public void addChild_logs_warning_unless_child_is_uninitialized() - { - LogParams? warning = null; - context.AddLogTarget(new CallbackLogTarget( - delegate(LogParams log) { - if (log.level == LogLevel.WARN) - warning = log; - })); - Context child = new Context(); - child.Initialize(); - context.AddChild(child); - Assert.That(warning, Is.Not.Null); - Assert.That(warning.Value.message, Is.StringContaining("must be uninitialized")); - Assert.That (warning.Value.messageParameters, Is.EqualTo (new object[]{ child }).AsCollection); - } - - [Test] - public void addChild_logs_warning_if_child_parentInjector_is_already_set() - { - LogParams? warning = null; - context.AddLogTarget(new CallbackLogTarget( - delegate(LogParams log) { - if (log.level == LogLevel.WARN) - warning = log; - })); - Context child = new Context(); - child.injector.parent = new RobotlegsInjector(); - context.AddChild(child); - - Assert.That(warning, Is.Not.Null); - Assert.That(warning.Value.message, Is.StringContaining("must not have a parent Injector")); - Assert.That (warning.Value.messageParameters, Is.EqualTo (new object[]{ child }).AsCollection); - } - - [Test] - public void removeChild_logs_warning_if_child_is_NOT_a_child() - { - LogParams? warning = null; - context.AddLogTarget(new CallbackLogTarget( - delegate(LogParams log) { - if (log.level == LogLevel.WARN) - warning = log; - })); - Context child = new Context(); - context.RemoveChild(child); - - Assert.That(warning, Is.Not.Null); - Assert.That(warning.Value.message, Is.StringContaining("must be a child")); - Assert.That (warning.Value.messageParameters, Is.EqualTo (new object[]{ child, context }).AsCollection); - } - - [Test] - public void removesChild_clears_child_parentInjector() - { - Context child = new Context(); - context.AddChild(child); - context.RemoveChild(child); - Assert.That(child.injector.parent, Is.Null); - } - - [Test] - public void child_is_removed_when_child_is_destroyed() - { - Context child = new Context(); - context.AddChild(child); - child.Initialize(); - child.Destroy(); - Assert.That(child.injector.parent, Is.Null); - } - - [Test] - public void children_are_removed_when_parent_is_destroyed() - { - Context child1 = new Context(); - Context child2 = new Context(); - context.AddChild(child1); - context.AddChild(child2); - context.Initialize(); - context.Destroy(); - Assert.That(child1.injector.parent, Is.Null); - Assert.That(child2.injector.parent, Is.Null); - } - - [Test] - public void removed_child_is_not_removed_again_when_destroyed() - { - LogParams? warning = null; - context.AddLogTarget(new CallbackLogTarget( - delegate(LogParams log) { - if (log.level == LogLevel.WARN) - warning = log; - })); - Context child = new Context(); - context.AddChild(child); - child.Initialize(); - context.RemoveChild(child); - child.Destroy(); - Assert.That(warning, Is.Null); - } - - [Test] - public void lifecycleEvents_are_propagated() - { - List actual = new List (); - List expected = new List{ - "PRE_INITIALIZE", - "INITIALIZE", - "POST_INITIALIZE", - "PRE_SUSPEND", - "SUSPEND", - "POST_SUSPEND", - "PRE_RESUME", - "RESUME", - "POST_RESUME", - "PRE_DESTROY", - "DESTROY", - "POST_DESTROY" - }; - context.PRE_INITIALIZE += CreateValuePusher (actual, "PRE_INITIALIZE"); - context.INITIALIZE += CreateValuePusher (actual, "INITIALIZE"); - context.POST_INITIALIZE += CreateValuePusher (actual, "POST_INITIALIZE"); - context.PRE_SUSPEND += CreateValuePusher (actual, "PRE_SUSPEND"); - context.SUSPEND += CreateValuePusher (actual, "SUSPEND"); - context.POST_SUSPEND += CreateValuePusher (actual, "POST_SUSPEND"); - context.PRE_RESUME += CreateValuePusher (actual, "PRE_RESUME"); - context.RESUME += CreateValuePusher (actual, "RESUME"); - context.POST_RESUME += CreateValuePusher (actual, "POST_RESUME"); - context.PRE_DESTROY += CreateValuePusher (actual, "PRE_DESTROY"); - context.DESTROY += CreateValuePusher (actual, "DESTROY"); - context.POST_DESTROY += CreateValuePusher (actual, "POST_DESTROY"); - - context.Initialize(); - context.Suspend(); - context.Resume(); - context.Destroy(); - Assert.That(actual, Is.EqualTo(expected).AsCollection); - } - - [Test] - public void lifecycleStateChangeEvent_is_propagated() - { - bool called = false; - context.STATE_CHANGE += delegate() { - called = true; - }; - context.Initialize(); - Assert.That(called, Is.True); - } - - [Test] - public void adding_BeforeInitializing_handler_after_initialization_throws_error() - { + [TestFixture] + public class ContextTest + { + /*============================================================================*/ + /* Private Properties */ + /*============================================================================*/ + + #region Fields + + private IContext context; + + #endregion Fields + + /*============================================================================*/ + /* Test Setup and Teardown */ + /*============================================================================*/ + + #region Methods + + [Test] + public void addChild_logs_warning_if_child_parentInjector_is_already_set() + { + LogParams? warning = null; + context.AddLogTarget(new CallbackLogTarget( + delegate (LogParams log) + { + if (log.level == LogLevel.WARN) + warning = log; + })); + Context child = new Context(); + child.injector.parent = new RobotlegsInjector(); + context.AddChild(child); + + Assert.That(warning, Is.Not.Null); + Assert.That(warning.Value.message, Does.Contain("must not have a parent Injector")); + Assert.That(warning.Value.messageParameters, Is.EqualTo(new object[] { child }).AsCollection); + } + + [Test] + public void addChild_logs_warning_unless_child_is_uninitialized() + { + LogParams? warning = null; + context.AddLogTarget(new CallbackLogTarget( + delegate (LogParams log) + { + if (log.level == LogLevel.WARN) + warning = log; + })); + Context child = new Context(); + child.Initialize(); + context.AddChild(child); + Assert.That(warning, Is.Not.Null); + Assert.That(warning.Value.message, Does.Contain("must be uninitialized")); + Assert.That(warning.Value.messageParameters, Is.EqualTo(new object[] { child }).AsCollection); + } + + [Test] + public void addChild_sets_child_parentInjector() + { + Context child = new Context(); + context.AddChild(child); + Assert.That(child.injector.parent, Is.EqualTo(context.injector)); + } + + [Test] + public void adding_after_initializing_hander_during_configure_is_allowed() + { + bool hasDoneCallback = false; + context.Configure(new CallbackConfig(delegate + { + context.AfterInitializing(delegate + { + hasDoneCallback = true; + }); + })); + context.Initialize(); + Assert.That(hasDoneCallback, Is.True); + } + + [Test] + public void adding_BeforeInitializing_handler_after_initialization_catches_error() + { + bool caught = false; + context.ERROR += delegate (Exception obj) + { + caught = true; + }; + context.Initialize(); + context.BeforeInitializing(nop); + Assert.That(caught, Is.True); + } + + [Test] + public void adding_BeforeInitializing_handler_after_initialization_throws_error() + { Assert.Throws(typeof(LifecycleException), new TestDelegate(() => { context.Initialize(); context.BeforeInitializing(nop); } )); - } + } - [Test] - public void adding_WhenInitializing_handler_after_initialization_throws_error() - { + [Test] + public void adding_WhenInitializing_handler_after_initialization_catches_error() + { + bool caught = false; + context.ERROR += delegate (Exception obj) + { + caught = true; + }; + context.Initialize(); + context.WhenInitializing(nop); + Assert.That(caught, Is.True); + } + + [Test] + public void adding_WhenInitializing_handler_after_initialization_throws_error() + { Assert.Throws(typeof(LifecycleException), new TestDelegate(() => { context.Initialize(); context.WhenInitializing(nop); } )); - } - - [Test] - public void adding_BeforeInitializing_handler_after_initialization_catches_error() - { - bool caught = false; - context.ERROR += delegate(Exception obj) { - caught = true; - }; - context.Initialize(); - context.BeforeInitializing(nop); - Assert.That (caught, Is.True); - } - - [Test] - public void adding_WhenInitializing_handler_after_initialization_catches_error() - { - bool caught = false; - context.ERROR += delegate(Exception obj) { - caught = true; - }; - context.Initialize(); - context.WhenInitializing(nop); - Assert.That (caught, Is.True); - } - - [Test] - public void adding_after_initializing_hander_during_configure_is_allowed() - { - bool hasDoneCallback = false; - context.Configure(new CallbackConfig(delegate { - context.AfterInitializing(delegate { - hasDoneCallback = true; - }); - })); - context.Initialize (); - Assert.That(hasDoneCallback, Is.True); - } - - [Test] - public void initialization_callback_is_fired() - { - context.Initialize (delegate { - Assert.Pass(); - }); - Assert.Fail(); - } - - [Test] - public void suspend_callback_is_fired() - { - context.Initialize (); - context.Suspend (delegate { - Assert.Pass(); - }); - Assert.Fail(); - } - - [Test] - public void resume_callback_is_fired() - { - context.Initialize (); - context.Suspend (); - context.Resume (delegate { - Assert.Pass(); - }); - Assert.Fail(); - } - - [Test] - public void destroy_callback_is_fired() - { - context.Initialize (); - context.Destroy (delegate { - Assert.Pass(); - }); - Assert.Fail(); - } - - /*============================================================================*/ - /* Private Functions */ - /*============================================================================*/ - - private Action CreateValuePusher(List list, object value) - { - return delegate(object context) { - list.Add(value); - }; - } - - private void nop() - { - - } - } -} + } + + [SetUp] + public void before() + { + context = new Context(); + } + + /*============================================================================*/ + /* Tests */ + /*============================================================================*/ + + [Test] + public void can_instantiate() + { + Assert.That(context, Is.Not.Null); + Assert.That(context, Is.InstanceOf()); + } + + [Test] + public void child_is_removed_when_child_is_destroyed() + { + Context child = new Context(); + context.AddChild(child); + child.Initialize(); + child.Destroy(); + Assert.That(child.injector.parent, Is.Null); + } + + [Test] + public void children_are_removed_when_parent_is_destroyed() + { + Context child1 = new Context(); + Context child2 = new Context(); + context.AddChild(child1); + context.AddChild(child2); + context.Initialize(); + context.Destroy(); + Assert.That(child1.injector.parent, Is.Null); + Assert.That(child2.injector.parent, Is.Null); + } + + [Test] + public void configs_are_installed() + { + bool installed = false; + IConfig config = new CallbackConfig( + delegate () + { + installed = true; + }); + context.Configure(config); + context.Initialize(); + Assert.That(installed, Is.True); + } + + [Test] + public void destroy_callback_is_fired() + { + context.Initialize(); + context.Destroy(delegate + { + Assert.Pass(); + }); + Assert.Fail(); + } + + [Test] + public void detain_stores_the_instance() + { + object expected = new object(); + object actual = null; + context.Detained += delegate (object obj) + { + actual = obj; + }; + context.Detain(expected); + Assert.AreEqual(actual, expected); + } + + [Test] + public void extensions_are_installed() + { + IContext actual = null; + IExtension extension = new CallbackExtension( + delegate (IContext c) + { + actual = c; + }); + context.Install(extension); + Assert.That(actual, Is.EqualTo(context)); + } + + [Test] + public void initialization_callback_is_fired() + { + context.Initialize(delegate + { + Assert.Pass(); + }); + Assert.Fail(); + } + + [Test] + public void injector_is_mapped_into_itself() + { + IInjector injector = context.injector.GetInstance(); + Assert.That(injector, Is.EqualTo(context.injector)); + } + + [Test] + public void lifecycleEvents_are_propagated() + { + List actual = new List(); + List expected = new List{ + "PRE_INITIALIZE", + "INITIALIZE", + "POST_INITIALIZE", + "PRE_SUSPEND", + "SUSPEND", + "POST_SUSPEND", + "PRE_RESUME", + "RESUME", + "POST_RESUME", + "PRE_DESTROY", + "DESTROY", + "POST_DESTROY" + }; + context.PRE_INITIALIZE += CreateValuePusher(actual, "PRE_INITIALIZE"); + context.INITIALIZE += CreateValuePusher(actual, "INITIALIZE"); + context.POST_INITIALIZE += CreateValuePusher(actual, "POST_INITIALIZE"); + context.PRE_SUSPEND += CreateValuePusher(actual, "PRE_SUSPEND"); + context.SUSPEND += CreateValuePusher(actual, "SUSPEND"); + context.POST_SUSPEND += CreateValuePusher(actual, "POST_SUSPEND"); + context.PRE_RESUME += CreateValuePusher(actual, "PRE_RESUME"); + context.RESUME += CreateValuePusher(actual, "RESUME"); + context.POST_RESUME += CreateValuePusher(actual, "POST_RESUME"); + context.PRE_DESTROY += CreateValuePusher(actual, "PRE_DESTROY"); + context.DESTROY += CreateValuePusher(actual, "DESTROY"); + context.POST_DESTROY += CreateValuePusher(actual, "POST_DESTROY"); + + context.Initialize(); + context.Suspend(); + context.Resume(); + context.Destroy(); + Assert.That(actual, Is.EqualTo(expected).AsCollection); + } + + [Test] + public void lifecycleStateChangeEvent_is_propagated() + { + bool called = false; + context.STATE_CHANGE += delegate () + { + called = true; + }; + context.Initialize(); + Assert.That(called, Is.True); + } + + [Test] + public void release_frees_up_the_instance() + { + object expected = new object(); + object actual = null; + context.Released += delegate (object obj) + { + actual = obj; + }; + context.Detain(expected); + context.Release(expected); + + Assert.AreEqual(actual, expected); + } + + [Test] + public void removeChild_logs_warning_if_child_is_NOT_a_child() + { + LogParams? warning = null; + context.AddLogTarget(new CallbackLogTarget( + delegate (LogParams log) + { + if (log.level == LogLevel.WARN) + warning = log; + })); + Context child = new Context(); + context.RemoveChild(child); + + Assert.That(warning, Is.Not.Null); + Assert.That(warning.Value.message, Does.Contain("must be a child")); + Assert.That(warning.Value.messageParameters, Is.EqualTo(new object[] { child, context }).AsCollection); + } + + [Test] + public void removed_child_is_not_removed_again_when_destroyed() + { + LogParams? warning = null; + context.AddLogTarget(new CallbackLogTarget( + delegate (LogParams log) + { + if (log.level == LogLevel.WARN) + warning = log; + })); + Context child = new Context(); + context.AddChild(child); + child.Initialize(); + context.RemoveChild(child); + child.Destroy(); + Assert.That(warning, Is.Null); + } + + [Test] + public void removesChild_clears_child_parentInjector() + { + Context child = new Context(); + context.AddChild(child); + context.RemoveChild(child); + Assert.That(child.injector.parent, Is.Null); + } + + [Test] + public void resume_callback_is_fired() + { + context.Initialize(); + context.Suspend(); + context.Resume(delegate + { + Assert.Pass(); + }); + Assert.Fail(); + } + + [Test] + public void suspend_callback_is_fired() + { + context.Initialize(); + context.Suspend(delegate + { + Assert.Pass(); + }); + Assert.Fail(); + } + + /*============================================================================*/ + /* Private Functions */ + /*============================================================================*/ + + private Action CreateValuePusher(List list, object value) + { + return delegate (object context) + { + list.Add(value); + }; + } + + private void nop() + { + } + #endregion Methods + } +} \ No newline at end of file diff --git a/tests/Robotlegs/Bender/Framework/Impl/ExtensionInstallerTest.cs b/tests/Robotlegs/Bender/Framework/Impl/ExtensionInstallerTest.cs index 882825a..fd6a29d 100644 --- a/tests/Robotlegs/Bender/Framework/Impl/ExtensionInstallerTest.cs +++ b/tests/Robotlegs/Bender/Framework/Impl/ExtensionInstallerTest.cs @@ -176,6 +176,23 @@ public void class_with_multiple_construtors_is_passed_defaults() Assert.That (instance.value1, Is.EqualTo (1)); Assert.That (instance.value2, Is.EqualTo ("arg")); } + + [Test] + public void check_is_installed_from_object() + { + IExtension extension = new EmptyExtension(); + Assert.That(installer.IsInstalled(), Is.False); + installer.Install(extension); + Assert.That(installer.IsInstalled(), Is.True); + } + + [Test] + public void check_is_installed_from_class() + { + Assert.That(installer.IsInstalled(), Is.False); + installer.Install(); + Assert.That(installer.IsInstalled(), Is.True); + } } } diff --git a/tests/Robotlegs/Bender/Framework/Impl/LifecycleTest.cs b/tests/Robotlegs/Bender/Framework/Impl/LifecycleTest.cs index d568569..f9244ee 100644 --- a/tests/Robotlegs/Bender/Framework/Impl/LifecycleTest.cs +++ b/tests/Robotlegs/Bender/Framework/Impl/LifecycleTest.cs @@ -1,11 +1,11 @@ //------------------------------------------------------------------------------ -// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. -// -// NOTICE: You are permitted to use, modify, and distribute this file -// in accordance with the terms of the license agreement accompanying it. +// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. +// +// NOTICE: You are permitted to use, modify, and distribute this file +// in accordance with the terms of the license agreement accompanying it. //------------------------------------------------------------------------------ -using System; +using System; using NUnit.Framework; using Robotlegs.Bender.Framework.API; using System.Threading.Tasks; @@ -15,424 +15,419 @@ namespace Robotlegs.Bender.Framework.Impl { - [TestFixture] - public class LifecycleTest - { - /*============================================================================*/ - /* Private Properties */ - /*============================================================================*/ - - private object target; - - private Lifecycle lifecycle; - - /*============================================================================*/ - /* Test Setup and Teardown */ - /*============================================================================*/ - - [SetUp] - public void Setup() - { - target = new object(); - lifecycle = new Lifecycle(target); - } - - /*============================================================================*/ - /* Tests */ - /*============================================================================*/ - - [Test] - public void lifecycle_starts_uninitialized() - { - Assert.AreEqual (LifecycleState.UNINITIALIZED, lifecycle.state); - Assert.True (lifecycle.Uninitialized); - } - - // ----- Basic valid transitions - - [Test] - public void initialize_turns_state_active() - { - lifecycle.Initialize(); - Assert.AreEqual (LifecycleState.ACTIVE, lifecycle.state); - Assert.True (lifecycle.Active); - } - - [Test] - public void suspend_turns_state_suspended() - { - lifecycle.Initialize(); - lifecycle.Suspend(); - Assert.That(lifecycle.state, Is.EqualTo(LifecycleState.SUSPENDED)); - Assert.That(lifecycle.Suspended, Is.True); - } - - [Test] - public void resume_turns_state_active() - { - lifecycle.Initialize(); - lifecycle.Suspend(); - lifecycle.Resume(); - Assert.That(lifecycle.state, Is.EqualTo(LifecycleState.ACTIVE)); - Assert.That(lifecycle.Active, Is.True); - } - - [Test] - public void destroy_turns_state_destroyed() - { - lifecycle.Initialize(); - lifecycle.Destroy(); - Assert.That(lifecycle.state, Is.EqualTo(LifecycleState.DESTROYED)); - Assert.That(lifecycle.Destroyed, Is.True); - } - - [Test] - public void typical_transition_chain_does_not_throw_errors() - { - Delegate[] methods = new Delegate[]{ - (Action)lifecycle.Initialize, - (Action)lifecycle.Suspend, - (Action)lifecycle.Resume, - (Action)lifecycle.Suspend, - (Action)lifecycle.Resume, - (Action)lifecycle.Destroy}; - Assert.That(MethodErrorCount(methods), Is.EqualTo(0)); - } - - // ----- Events - - [Test] - public void events_are_dispatched() - { - List actual = new List (); - List expected = new List{ - "PRE_INITIALIZE", - "INITIALIZE", - "POST_INITIALIZE", - "PRE_SUSPEND", - "SUSPEND", - "POST_SUSPEND", - "PRE_RESUME", - "RESUME", - "POST_RESUME", - "PRE_DESTROY", - "DESTROY", - "POST_DESTROY" - }; - lifecycle.PRE_INITIALIZE += CreateObjectValuePusher (actual, "PRE_INITIALIZE"); - lifecycle.INITIALIZE += CreateObjectValuePusher (actual, "INITIALIZE"); - lifecycle.POST_INITIALIZE += CreateObjectValuePusher (actual, "POST_INITIALIZE"); - lifecycle.PRE_SUSPEND += CreateObjectValuePusher (actual, "PRE_SUSPEND"); - lifecycle.SUSPEND += CreateObjectValuePusher (actual, "SUSPEND"); - lifecycle.POST_SUSPEND += CreateObjectValuePusher (actual, "POST_SUSPEND"); - lifecycle.PRE_RESUME += CreateObjectValuePusher (actual, "PRE_RESUME"); - lifecycle.RESUME += CreateObjectValuePusher (actual, "RESUME"); - lifecycle.POST_RESUME += CreateObjectValuePusher (actual, "POST_RESUME"); - lifecycle.PRE_DESTROY += CreateObjectValuePusher (actual, "PRE_DESTROY"); - lifecycle.DESTROY += CreateObjectValuePusher (actual, "DESTROY"); - lifecycle.POST_DESTROY += CreateObjectValuePusher (actual, "POST_DESTROY"); - - lifecycle.Initialize(); - lifecycle.Suspend(); - lifecycle.Resume(); - lifecycle.Destroy(); - - Assert.That(actual, Is.EqualTo(expected).AsCollection); - } - - // ----- Shorthand transition handlers - -// [Test] -// public void when_and_afterHandlers_with_single_arguments_receive_event_types() -// { -// const expected:Array = [ -// LifecycleEvent.INITIALIZE, LifecycleEvent.POST_INITIALIZE, -// LifecycleEvent.SUSPEND, LifecycleEvent.POST_SUSPEND, -// LifecycleEvent.RESUME, LifecycleEvent.POST_RESUME, -// LifecycleEvent.Destroy, LifecycleEvent.POST_DESTROY]; -// const actual:Array = []; -// const handler:Function = function(type:String) { -// actual.push(type); -// }; -// lifecycle -// .WhenInitializing(handler).AfterInitializing(handler) -// .WhenSuspending(handler).AfterSuspending(handler) -// .WhenResuming(handler).AfterResuming(handler) -// .WhenDestroying(handler).AfterDestroying(handler); -// lifecycle.Initialize(); -// lifecycle.Suspend(); -// lifecycle.Resume(); -// lifecycle.Destroy(); -// Assert.That(actual, array(expected)); -// } - - [Test] - public void when_and_afterHandlers_with_no_arguments_are_called() - { - int callCount = 0; - Action handler = delegate() { - callCount++; - }; - lifecycle - .WhenInitializing(handler).AfterInitializing(handler) - .WhenSuspending(handler).AfterSuspending(handler) - .WhenResuming(handler).AfterResuming(handler) - .WhenDestroying(handler).AfterDestroying(handler); - lifecycle.Initialize(); - lifecycle.Suspend(); - lifecycle.Resume(); - lifecycle.Destroy(); - Assert.That(callCount, Is.EqualTo(8)); - } - - [Test] - public void before_handlers_are_executed() - { - int callCount = 0; - Action handler = delegate() { - callCount++; - }; - lifecycle - .BeforeInitializing(handler) - .BeforeSuspending(handler) - .BeforeResuming(handler) - .BeforeDestroying(handler); - lifecycle.Initialize(); - lifecycle.Suspend(); - lifecycle.Resume(); - lifecycle.Destroy(); - Assert.That(callCount, Is.EqualTo(4)); - } - - [Test] - public async Task async_before_handlers_are_executed() - { - int callCount = 0; - HandlerMessageCallbackDelegate handler = delegate(object message, HandlerAsyncCallback callback) { - callCount++; - new Timer (new TimerCallback (callback), null, 1, System.Threading.Timeout.Infinite); - }; - lifecycle - .BeforeInitializing(handler) - .BeforeSuspending(handler) - .BeforeResuming(handler) - .BeforeDestroying(handler); - lifecycle.Initialize(delegate() { - lifecycle.Suspend(delegate() { - lifecycle.Resume(delegate() { - lifecycle.Destroy(); - }); - }); - }); - - await Task.Delay (200); - Assert.That (callCount, Is.EqualTo (4)); - } - - // ----- Suspend and Destroy run backwards - - [Test] - public void suspend_runs_backwards() - { - List actual = new List(); - List expected = new List () { - "before3", "before2", "before1", - "when3", "when2", "when1", - "after3", "after2", "after1" - }; - lifecycle.BeforeSuspending(CreateValuePusher(actual, "before1")); - lifecycle.BeforeSuspending(CreateValuePusher(actual, "before2")); - lifecycle.BeforeSuspending(CreateValuePusher(actual, "before3")); - lifecycle.WhenSuspending(CreateValuePusher(actual, "when1")); - lifecycle.WhenSuspending(CreateValuePusher(actual, "when2")); - lifecycle.WhenSuspending(CreateValuePusher(actual, "when3")); - lifecycle.AfterSuspending(CreateValuePusher(actual, "after1")); - lifecycle.AfterSuspending(CreateValuePusher(actual, "after2")); - lifecycle.AfterSuspending(CreateValuePusher(actual, "after3")); - lifecycle.Initialize(); - lifecycle.Suspend(); - Assert.That(actual, Is.EqualTo(expected).AsCollection); - } - - [Test] - public void destroy_runs_backwards() - { - List actual = new List(); - List expected = new List () { - "before3", "before2", "before1", - "when3", "when2", "when1", - "after3", "after2", "after1" - }; - lifecycle.BeforeDestroying(CreateValuePusher(actual, "before1")); - lifecycle.BeforeDestroying(CreateValuePusher(actual, "before2")); - lifecycle.BeforeDestroying(CreateValuePusher(actual, "before3")); - lifecycle.WhenDestroying(CreateValuePusher(actual, "when1")); - lifecycle.WhenDestroying(CreateValuePusher(actual, "when2")); - lifecycle.WhenDestroying(CreateValuePusher(actual, "when3")); - lifecycle.AfterDestroying(CreateValuePusher(actual, "after1")); - lifecycle.AfterDestroying(CreateValuePusher(actual, "after2")); - lifecycle.AfterDestroying(CreateValuePusher(actual, "after3")); - lifecycle.Initialize(); - lifecycle.Destroy(); - Assert.That(actual, Is.EqualTo(expected).AsCollection); - } - - // ----- Before handlers callback message - -// [Test] -// public void beforeHandler_callbacks_are_passed_correct_message() -// { -// List expected = new List(); -// const expected:Array = [ -// LifecycleEvent.PRE_INITIALIZE, LifecycleEvent.INITIALIZE, LifecycleEvent.POST_INITIALIZE, -// LifecycleEvent.PRE_SUSPEND, LifecycleEvent.SUSPEND, LifecycleEvent.POST_SUSPEND, -// LifecycleEvent.PRE_RESUME, LifecycleEvent.RESUME, LifecycleEvent.POST_RESUME, -// LifecycleEvent.PRE_DESTROY, LifecycleEvent.Destroy, LifecycleEvent.POST_DESTROY]; -// List actual = new List(); - -// lifecycle.BeforeInitializing(CreateMessagePusher(actual)); -// lifecycle.WhenInitializing(CreateMessagePusher(actual)); -// lifecycle.AfterInitializing(CreateMessagePusher(actual)); -// lifecycle.BeforeSuspending(CreateMessagePusher(actual)); -// lifecycle.WhenSuspending(CreateMessagePusher(actual)); -// lifecycle.AfterSuspending(CreateMessagePusher(actual)); -// lifecycle.BeforeResuming(CreateMessagePusher(actual)); -// lifecycle.WhenResuming(CreateMessagePusher(actual)); -// lifecycle.BeforeResuming(CreateMessagePusher(actual)); -// lifecycle.BeforeDestroying(CreateMessagePusher(actual)); -// lifecycle.WhenDestroying(CreateMessagePusher(actual)); -// lifecycle.AfterDestroying(CreateMessagePusher(actual)); -// lifecycle.Initialize(); -// lifecycle.Suspend(); -// lifecycle.Resume(); -// lifecycle.Destroy(); -// Assert.That(actual, Is.EqualTo(expected).AsCollection); -// } - - // ----- StateChange Event - - [Test] - public void stateChange_triggers_event() - { - bool fired = false; - lifecycle.STATE_CHANGE += delegate() { - fired = true; - }; - lifecycle.Initialize(); - Assert.That(fired, Is.True); - } - - // ----- Adding handlers that will never be called - - [Test] - public void adding_BeforeInitializing_handler_after_initialization_throws_error() - { + [TestFixture] + public class LifecycleTest + { + /*============================================================================*/ + /* Private Properties */ + /*============================================================================*/ + + #region Fields + + private Lifecycle lifecycle; + private object target; + + #endregion Fields + + /*============================================================================*/ + /* Test Setup and Teardown */ + /*============================================================================*/ + + #region Methods + + [Test] + public void adding_AfterInitializing_handler_after_initialization_throws_error() + { Assert.Throws(typeof(LifecycleException), new TestDelegate(() => { lifecycle.Initialize(); - lifecycle.BeforeInitializing(nop); + lifecycle.AfterInitializing(nop); } )); - } + } - [Test] - public void adding_WhenInitializing_handler_after_initialization_throws_error() - { + [Test] + public void adding_AfterInitializing_handler_during_initialization_does_NOT_throw_error() + { + int callCount = 0; + lifecycle.WhenInitializing(delegate () + { + lifecycle.AfterInitializing(delegate () + { + callCount++; + }); + }); + lifecycle.Initialize(); + Assert.That(callCount, Is.EqualTo(1)); + } + + [Test] + public void adding_BeforeInitializing_handler_after_initialization_throws_error() + { Assert.Throws(typeof(LifecycleException), new TestDelegate(() => { lifecycle.Initialize(); - lifecycle.WhenInitializing(nop); + lifecycle.BeforeInitializing(nop); } )); - } - - [Test] - public async Task adding_WhenInitializing_handler_during_initialization_does_NOT_throw_error() - { - int callCount = 0; - lifecycle.BeforeInitializing(delegate(object message, HandlerAsyncCallback callback) { - Timer t = new Timer(new TimerCallback(callback), null, 100, System.Threading.Timeout.Infinite); - }); - lifecycle.Initialize(); - Assert.That (lifecycle.state, Is.EqualTo (LifecycleState.INITIALIZING)); - lifecycle.WhenInitializing(delegate() { - callCount++; - }); - - await Task.Delay(200); - Assert.That(callCount, Is.EqualTo(1)); - } - - [Test] - public void adding_AfterInitializing_handler_after_initialization_throws_error() - { + } + + // ----- Adding handlers that will never be called + [Test] + public void adding_WhenInitializing_handler_after_initialization_throws_error() + { Assert.Throws(typeof(LifecycleException), new TestDelegate(() => { lifecycle.Initialize(); - lifecycle.AfterInitializing(nop); + lifecycle.WhenInitializing(nop); } )); - } - - [Test] - public void adding_AfterInitializing_handler_during_initialization_does_NOT_throw_error() - { - int callCount = 0; - lifecycle.WhenInitializing(delegate() { - lifecycle.AfterInitializing(delegate() { - callCount++; - }); - }); - lifecycle.Initialize(); - Assert.That(callCount, Is.EqualTo(1)); - } - - /*============================================================================*/ - /* Private Functions */ - /*============================================================================*/ - - private int MethodErrorCount(Delegate[] methods) - { - int errorCount = 0; - foreach (Delegate method in methods) - { - try - { - object[] args = new object[method.Method.GetParameters().Length]; - method.DynamicInvoke(args); - } - catch (Exception) - { - errorCount++; - } - } - return errorCount; - } - - private Action CreateObjectValuePusher(List list, object value) - { - return delegate(object obj) { - list.Add(value); - }; - } - - private Action CreateValuePusher(List list, object value) - { - return delegate() { - list.Add(value); - }; - } - - private HandlerMessageDelegate CreateMessagePusher(List list) - { - return delegate(object message) { - list.Add(message); - }; - } - - private void nop() - { - } - } -} + } + + [Test] + public async Task adding_WhenInitializing_handler_during_initialization_does_NOT_throw_error() + { + int callCount = 0; + lifecycle.BeforeInitializing(delegate (object message, HandlerAsyncCallback callback) + { + Timer t = new Timer(new TimerCallback(callback), null, 100, System.Threading.Timeout.Infinite); + }); + lifecycle.Initialize(); + Assert.That(lifecycle.state, Is.EqualTo(LifecycleState.INITIALIZING)); + lifecycle.WhenInitializing(delegate () + { + callCount++; + }); + + await Task.Delay(100); + Assert.That(callCount, Is.EqualTo(1)); + } + + [Test] + public async Task async_before_handlers_are_executed() + { + int callCount = 0; + HandlerMessageCallbackDelegate handler = delegate (object message, HandlerAsyncCallback callback) + { + callCount++; + new Timer(new TimerCallback(callback), null, 1, System.Threading.Timeout.Infinite); + }; + lifecycle + .BeforeInitializing(handler) + .BeforeSuspending(handler) + .BeforeResuming(handler) + .BeforeDestroying(handler); + lifecycle.Initialize(delegate () + { + lifecycle.Suspend(delegate () + { + lifecycle.Resume(delegate () + { + lifecycle.Destroy(); + }); + }); + }); + + await Task.Delay(200); + Assert.That(callCount, Is.EqualTo(4)); + } + + [Test] + public void before_handlers_are_executed() + { + int callCount = 0; + Action handler = delegate () + { + callCount++; + }; + lifecycle + .BeforeInitializing(handler) + .BeforeSuspending(handler) + .BeforeResuming(handler) + .BeforeDestroying(handler); + lifecycle.Initialize(); + lifecycle.Suspend(); + lifecycle.Resume(); + lifecycle.Destroy(); + Assert.That(callCount, Is.EqualTo(4)); + } + + [Test] + public void destroy_runs_backwards() + { + List actual = new List(); + List expected = new List() { + "before3", "before2", "before1", + "when3", "when2", "when1", + "after3", "after2", "after1" + }; + lifecycle.BeforeDestroying(CreateValuePusher(actual, "before1")); + lifecycle.BeforeDestroying(CreateValuePusher(actual, "before2")); + lifecycle.BeforeDestroying(CreateValuePusher(actual, "before3")); + lifecycle.WhenDestroying(CreateValuePusher(actual, "when1")); + lifecycle.WhenDestroying(CreateValuePusher(actual, "when2")); + lifecycle.WhenDestroying(CreateValuePusher(actual, "when3")); + lifecycle.AfterDestroying(CreateValuePusher(actual, "after1")); + lifecycle.AfterDestroying(CreateValuePusher(actual, "after2")); + lifecycle.AfterDestroying(CreateValuePusher(actual, "after3")); + lifecycle.Initialize(); + lifecycle.Destroy(); + Assert.That(actual, Is.EqualTo(expected).AsCollection); + } + + [Test] + public void destroy_turns_state_destroyed() + { + lifecycle.Initialize(); + lifecycle.Destroy(); + Assert.That(lifecycle.state, Is.EqualTo(LifecycleState.DESTROYED)); + Assert.That(lifecycle.Destroyed, Is.True); + } + + [Test] + public void events_are_dispatched() + { + List actual = new List(); + List expected = new List{ + "PRE_INITIALIZE", + "INITIALIZE", + "POST_INITIALIZE", + "PRE_SUSPEND", + "SUSPEND", + "POST_SUSPEND", + "PRE_RESUME", + "RESUME", + "POST_RESUME", + "PRE_DESTROY", + "DESTROY", + "POST_DESTROY" + }; + lifecycle.PRE_INITIALIZE += CreateObjectValuePusher(actual, "PRE_INITIALIZE"); + lifecycle.INITIALIZE += CreateObjectValuePusher(actual, "INITIALIZE"); + lifecycle.POST_INITIALIZE += CreateObjectValuePusher(actual, "POST_INITIALIZE"); + lifecycle.PRE_SUSPEND += CreateObjectValuePusher(actual, "PRE_SUSPEND"); + lifecycle.SUSPEND += CreateObjectValuePusher(actual, "SUSPEND"); + lifecycle.POST_SUSPEND += CreateObjectValuePusher(actual, "POST_SUSPEND"); + lifecycle.PRE_RESUME += CreateObjectValuePusher(actual, "PRE_RESUME"); + lifecycle.RESUME += CreateObjectValuePusher(actual, "RESUME"); + lifecycle.POST_RESUME += CreateObjectValuePusher(actual, "POST_RESUME"); + lifecycle.PRE_DESTROY += CreateObjectValuePusher(actual, "PRE_DESTROY"); + lifecycle.DESTROY += CreateObjectValuePusher(actual, "DESTROY"); + lifecycle.POST_DESTROY += CreateObjectValuePusher(actual, "POST_DESTROY"); + + lifecycle.Initialize(); + lifecycle.Suspend(); + lifecycle.Resume(); + lifecycle.Destroy(); + + Assert.That(actual, Is.EqualTo(expected).AsCollection); + } + + [Test] + public void initialize_turns_state_active() + { + lifecycle.Initialize(); + Assert.AreEqual(LifecycleState.ACTIVE, lifecycle.state); + Assert.True(lifecycle.Active); + } + + [Test] + public void lifecycle_starts_uninitialized() + { + Assert.AreEqual(LifecycleState.UNINITIALIZED, lifecycle.state); + Assert.True(lifecycle.Uninitialized); + } + + [Test] + public void resume_turns_state_active() + { + lifecycle.Initialize(); + lifecycle.Suspend(); + lifecycle.Resume(); + Assert.That(lifecycle.state, Is.EqualTo(LifecycleState.ACTIVE)); + Assert.That(lifecycle.Active, Is.True); + } + + [SetUp] + public void Setup() + { + target = new object(); + lifecycle = new Lifecycle(target); + } + + /*============================================================================*/ + /* Tests */ + /*============================================================================*/ + + [Test] + public void stateChange_triggers_event() + { + bool fired = false; + lifecycle.STATE_CHANGE += delegate () + { + fired = true; + }; + lifecycle.Initialize(); + Assert.That(fired, Is.True); + } + + [Test] + public void suspend_runs_backwards() + { + List actual = new List(); + List expected = new List() { + "before3", "before2", "before1", + "when3", "when2", "when1", + "after3", "after2", "after1" + }; + lifecycle.BeforeSuspending(CreateValuePusher(actual, "before1")); + lifecycle.BeforeSuspending(CreateValuePusher(actual, "before2")); + lifecycle.BeforeSuspending(CreateValuePusher(actual, "before3")); + lifecycle.WhenSuspending(CreateValuePusher(actual, "when1")); + lifecycle.WhenSuspending(CreateValuePusher(actual, "when2")); + lifecycle.WhenSuspending(CreateValuePusher(actual, "when3")); + lifecycle.AfterSuspending(CreateValuePusher(actual, "after1")); + lifecycle.AfterSuspending(CreateValuePusher(actual, "after2")); + lifecycle.AfterSuspending(CreateValuePusher(actual, "after3")); + lifecycle.Initialize(); + lifecycle.Suspend(); + Assert.That(actual, Is.EqualTo(expected).AsCollection); + } + + // ----- Basic valid transitions + [Test] + public void suspend_turns_state_suspended() + { + lifecycle.Initialize(); + lifecycle.Suspend(); + Assert.That(lifecycle.state, Is.EqualTo(LifecycleState.SUSPENDED)); + Assert.That(lifecycle.Suspended, Is.True); + } + + [Test] + public void typical_transition_chain_does_not_throw_errors() + { + Delegate[] methods = new Delegate[]{ + (Action)lifecycle.Initialize, + (Action)lifecycle.Suspend, + (Action)lifecycle.Resume, + (Action)lifecycle.Suspend, + (Action)lifecycle.Resume, + (Action)lifecycle.Destroy}; + Assert.That(MethodErrorCount(methods), Is.EqualTo(0)); + } + + // ----- Events + // ----- Shorthand transition handlers + + // [Test] public void when_and_afterHandlers_with_single_arguments_receive_event_types() { + // const expected:Array = [ LifecycleEvent.INITIALIZE, LifecycleEvent.POST_INITIALIZE, + // LifecycleEvent.SUSPEND, LifecycleEvent.POST_SUSPEND, LifecycleEvent.RESUME, + // LifecycleEvent.POST_RESUME, LifecycleEvent.Destroy, LifecycleEvent.POST_DESTROY]; const + // actual:Array = []; const handler:Function = function(type:String) { actual.push(type); }; + // lifecycle .WhenInitializing(handler).AfterInitializing(handler) + // .WhenSuspending(handler).AfterSuspending(handler) + // .WhenResuming(handler).AfterResuming(handler) + // .WhenDestroying(handler).AfterDestroying(handler); lifecycle.Initialize(); + // lifecycle.Suspend(); lifecycle.Resume(); lifecycle.Destroy(); Assert.That(actual, + // array(expected)); } + + [Test] + public void when_and_afterHandlers_with_no_arguments_are_called() + { + int callCount = 0; + Action handler = delegate () + { + callCount++; + }; + lifecycle + .WhenInitializing(handler).AfterInitializing(handler) + .WhenSuspending(handler).AfterSuspending(handler) + .WhenResuming(handler).AfterResuming(handler) + .WhenDestroying(handler).AfterDestroying(handler); + lifecycle.Initialize(); + lifecycle.Suspend(); + lifecycle.Resume(); + lifecycle.Destroy(); + Assert.That(callCount, Is.EqualTo(8)); + } + + // ----- Suspend and Destroy run backwards + // ----- Before handlers callback message + + // [Test] public void beforeHandler_callbacks_are_passed_correct_message() { List + // expected = new List(); const expected:Array = [ LifecycleEvent.PRE_INITIALIZE, + // LifecycleEvent.INITIALIZE, LifecycleEvent.POST_INITIALIZE, LifecycleEvent.PRE_SUSPEND, + // LifecycleEvent.SUSPEND, LifecycleEvent.POST_SUSPEND, LifecycleEvent.PRE_RESUME, + // LifecycleEvent.RESUME, LifecycleEvent.POST_RESUME, LifecycleEvent.PRE_DESTROY, + // LifecycleEvent.Destroy, LifecycleEvent.POST_DESTROY]; List actual = new List(); + + // lifecycle.BeforeInitializing(CreateMessagePusher(actual)); + // lifecycle.WhenInitializing(CreateMessagePusher(actual)); + // lifecycle.AfterInitializing(CreateMessagePusher(actual)); + // lifecycle.BeforeSuspending(CreateMessagePusher(actual)); + // lifecycle.WhenSuspending(CreateMessagePusher(actual)); + // lifecycle.AfterSuspending(CreateMessagePusher(actual)); + // lifecycle.BeforeResuming(CreateMessagePusher(actual)); + // lifecycle.WhenResuming(CreateMessagePusher(actual)); + // lifecycle.BeforeResuming(CreateMessagePusher(actual)); + // lifecycle.BeforeDestroying(CreateMessagePusher(actual)); + // lifecycle.WhenDestroying(CreateMessagePusher(actual)); + // lifecycle.AfterDestroying(CreateMessagePusher(actual)); lifecycle.Initialize(); + // lifecycle.Suspend(); lifecycle.Resume(); lifecycle.Destroy(); Assert.That(actual, + // Is.EqualTo(expected).AsCollection); } + + // ----- StateChange Event + /*============================================================================*/ + /* Private Functions */ + /*============================================================================*/ + + private HandlerMessageDelegate CreateMessagePusher(List list) + { + return delegate (object message) + { + list.Add(message); + }; + } + + private Action CreateObjectValuePusher(List list, object value) + { + return delegate (object obj) + { + list.Add(value); + }; + } + + private Action CreateValuePusher(List list, object value) + { + return delegate () + { + list.Add(value); + }; + } + + private int MethodErrorCount(Delegate[] methods) + { + int errorCount = 0; + foreach (Delegate method in methods) + { + try + { + object[] args = new object[method.Method.GetParameters().Length]; + method.DynamicInvoke(args); + } + catch (Exception) + { + errorCount++; + } + } + return errorCount; + } + + private void nop() + { + } + #endregion Methods + } +} \ No newline at end of file diff --git a/tests/Robotlegs/Bender/Framework/Impl/MessageDispatcherTest.cs b/tests/Robotlegs/Bender/Framework/Impl/MessageDispatcherTest.cs index f6bd260..df0ca1e 100644 --- a/tests/Robotlegs/Bender/Framework/Impl/MessageDispatcherTest.cs +++ b/tests/Robotlegs/Bender/Framework/Impl/MessageDispatcherTest.cs @@ -1,475 +1,505 @@ -//------------------------------------------------------------------------------ -// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. -// -// NOTICE: You are permitted to use, modify, and distribute this file -// in accordance with the terms of the license agreement accompanying it. -//------------------------------------------------------------------------------ - -using System; -using NUnit.Framework; -using System.Threading.Tasks; -using Robotlegs.Bender.Framework.Impl.SafelyCallBackSupport; -using Robotlegs.Bender.Framework.API; -using System.Threading; -using System.Collections.Generic; - -namespace Robotlegs.Bender.Framework.Impl -{ - [TestFixture] - public class MessageDispatcherTest - { - /*============================================================================*/ - /* Private Properties */ - /*============================================================================*/ - - private MessageDispatcher dispatcher; - - private object message; - - /*============================================================================*/ - /* Test Setup and Teardown */ - /*============================================================================*/ - - [SetUp] - public void before() - { - dispatcher = new MessageDispatcher(); - message = new object(); - } - - /*============================================================================*/ - /* Tests */ - /*============================================================================*/ - - [Test] - public void addMessageHandler_runs() - { - dispatcher.AddMessageHandler(message, delegate() {}); - } - - [Test] - public void addMessageHandler_stores_handler() - { - dispatcher.AddMessageHandler(message, delegate() {}); - Assert.True(dispatcher.HasMessageHandler(message)); - } - - [Test] - public void hasMessageHandler_runs() - { - dispatcher.HasMessageHandler(message); - } - - [Test] - public void hasMessageHandler_returns_false() - { - Assert.False(dispatcher.HasMessageHandler(message)); - } - - [Test] - public void hasMessageHandler_returns_true() - { - dispatcher.AddMessageHandler(message, delegate() {}); - Assert.True(dispatcher.HasMessageHandler(message)); - } - - [Test] - public void hasMessageHandler_returns_false_for_wrong_message() - { - dispatcher.AddMessageHandler("abcde", delegate() {}); - Assert.False(dispatcher.HasMessageHandler(message)); - } - - [Test] - public void removeMessageHandler_runs() - { - dispatcher.RemoveMessageHandler(message, delegate() {}); - } - - [Test] - public void removeMessageHandler_removes_the_handler() - { - Action handler = delegate() {}; - dispatcher.AddMessageHandler(message, handler); - dispatcher.RemoveMessageHandler(message, handler); - Assert.False(dispatcher.HasMessageHandler(message)); - } - - [Test] - public void removeMessageHandler_does_not_remove_the_wrong_handler() - { - Action handler = delegate() {}; - Action otherHandler = delegate() {}; - dispatcher.AddMessageHandler(message, handler); - dispatcher.AddMessageHandler(message, otherHandler); - dispatcher.RemoveMessageHandler(message, otherHandler); - Assert.True(dispatcher.HasMessageHandler(message)); - } - - [Test] - public void dispatchMessage_runs() - { - dispatcher.DispatchMessage(message); - } - - [Test] - public void deaf_handler_handles_message() - { - bool handled = false; - dispatcher.AddMessageHandler(message, delegate() { - handled = true; - }); - dispatcher.DispatchMessage(message); - Assert.True(handled); - } - - [Test] - public void handler_handles_message() - { - object actualMessage = null; - dispatcher.AddMessageHandler(message, delegate(object msg) { - actualMessage = msg; - }); - dispatcher.DispatchMessage(message); - Assert.AreEqual(actualMessage, message); - } - - [Test] - public void message_is_handled_by_multiple_handlers() - { - int handleCount = 0; - dispatcher.AddMessageHandler(message, delegate() { - handleCount++; - }); - dispatcher.AddMessageHandler(message, delegate() { - handleCount++; - }); - dispatcher.AddMessageHandler(message, delegate() { - handleCount++; - }); - dispatcher.DispatchMessage(message); - Assert.AreEqual(handleCount, 3); - } - - [Test] - public void message_is_handled_by_handler_multiple_times() - { - int handleCount = 0; - dispatcher.AddMessageHandler(message, delegate() { - handleCount++; - }); - dispatcher.DispatchMessage(message); - dispatcher.DispatchMessage(message); - dispatcher.DispatchMessage(message); - Assert.AreEqual(handleCount, 3); - } - - [Test] - public void handler_does_not_handle_the_wrong_message() - { - bool handled = false; - dispatcher.AddMessageHandler(message, delegate() { - handled = true; - }); - dispatcher.DispatchMessage("abcde"); - Assert.False(handled); - } - - [Test] - public void handler_with_callback_handles_message() - { - object actualMessage = null; - dispatcher.AddMessageHandler(message, delegate(object msg, HandlerAsyncCallback callback) { - actualMessage = msg; - callback(); - }); - dispatcher.DispatchMessage(message); - Assert.That(actualMessage, Is.EqualTo(message)); - } - - [Test] - public async Task async_handler_handles_message() - { - object actualMessage = null; - dispatcher.AddMessageHandler(message, delegate(object msg, HandlerAsyncCallback callback) { - actualMessage = msg; - SetTimeout(callback, 5, new object[]{null}); - }); - dispatcher.DispatchMessage(message); - await Delay (); - Assert.That(actualMessage, Is.EqualTo(message)); - } - - [Test] - public void callback_is_called_once() - { - int callbackCount = 0; - dispatcher.DispatchMessage(message, delegate() { - callbackCount++; - }); - Assert.AreEqual(callbackCount, 1); - } - - [Test] - public async Task callback_is_called_once_after_sync_handler() - { - int callbackCount = 0; - dispatcher.AddMessageHandler(message, CreateHandler.Handler()); - dispatcher.DispatchMessage(message, delegate() { - callbackCount++; - }); - await Delay(); - Assert.AreEqual (callbackCount, 1); - } - - [Test] - public async Task callback_is_called_once_after_async_handler() - { - int callbackCount = 0; - dispatcher.AddMessageHandler(message, CreateHandler.AsyncHandler()); - dispatcher.DispatchMessage(message, delegate() { - callbackCount++; - }); - await Delay (); - Assert.That(callbackCount, Is.EqualTo(1)); - } - - [Test] - public async Task callback_is_called_once_after_sync_and_async_handlers() - { - int callbackCount = 0; - dispatcher.AddMessageHandler(message, CreateHandler.AsyncHandler()); - dispatcher.AddMessageHandler(message, CreateHandler.Handler()); - dispatcher.AddMessageHandler(message, CreateHandler.AsyncHandler()); - dispatcher.AddMessageHandler(message, CreateHandler.Handler()); - dispatcher.DispatchMessage(message, delegate() { - callbackCount++; - }); - await Delay (100); - Assert.That(callbackCount, Is.EqualTo(1)); - } - - [Test] - public void handler_passes_error_to_callback() - { - object expectedError = "Error"; - object actualError = null; - dispatcher.AddMessageHandler(message, delegate(object msg, HandlerAsyncCallback callback) { - callback(expectedError); - }); - dispatcher.DispatchMessage(message, delegate(object error) { - actualError = error; - }); - Assert.That(actualError, Is.EqualTo(expectedError)); - } - - [Test] - public async void async_handler_passes_error_to_callback() - { - object expectedError = "Error"; - object actualError = null; - dispatcher.AddMessageHandler(message, delegate(object msg, HandlerAsyncCallback callback) { - SetTimeout(callback, 5, new object[]{expectedError}); - }); - dispatcher.DispatchMessage(message, delegate(object error) { - actualError = error; - }); - await Delay (); - Assert.That(actualError, Is.EqualTo(expectedError)); - } - - [Test] - public void handler_that_calls_back_more_than_once_is_ignored() - { - int callbackCount = 0; - dispatcher.AddMessageHandler(message, delegate(object msg, HandlerAsyncCallback callback) { - callback(); - callback(); - }); - dispatcher.DispatchMessage(message, delegate(object error) { - callbackCount++; - }); - Assert.That(callbackCount, Is.EqualTo(1)); - } - - [Test] - public async Task async_handler_that_calls_back_more_than_once_is_ignored() - { - int callbackCount = 0; - dispatcher.AddMessageHandler(message, delegate(object msg, HandlerAsyncCallback callback) { - callback(); - callback(); - }); - dispatcher.DispatchMessage(message, delegate(object error) { - callbackCount++; - }); - await Delay(); - Assert.That(callbackCount, Is.EqualTo(1)); - } - - [Test] - public void sync_handlers_should_run_in_order() - { - List results = new List(); - foreach (char id in new object[]{'A', 'B', 'C', 'D'}) - dispatcher.AddMessageHandler(message, CreateHandler.Handler((Action)results.Add, new object[]{id})); - dispatcher.DispatchMessage(message); - Assert.That (results, Is.EqualTo (new object[]{ 'A', 'B', 'C', 'D' }).AsCollection); - } - - [Test] - public void sync_handlers_should_run_in_reverse_order() - { - List results = new List(); - foreach (char id in new object[]{'A', 'B', 'C', 'D'}) - dispatcher.AddMessageHandler(message, CreateHandler.Handler((Action)results.Add, new object[]{id})); - dispatcher.DispatchMessage(message, true); - Assert.That (results, Is.EqualTo (new object[]{ 'D', 'C', 'B', 'A' }).AsCollection); - } - - [Test] - public async Task async_handlers_should_run_in_order() - { - //TODO: This fails but not everytime... - List results = new List(); - foreach (char id in new object[]{'A', 'B', 'C', 'D'}) - dispatcher.AddMessageHandler (message, CreateHandler.AsyncHandler ((Action)results.Add, new object[]{ id })); - dispatcher.DispatchMessage(message); - await Delay(200); - Assert.That (results, Is.EqualTo (new object[]{ 'A', 'B', 'C', 'D' }).AsCollection); - } - - [Test] - public async Task async_handlers_should_run_in_reverse_order_when_reversed() - { - List results = new List(); - foreach (char id in new object[]{'A', 'B', 'C', 'D'}) - dispatcher.AddMessageHandler(message, CreateHandler.AsyncHandler((Action)results.Add, new object[]{id})); - dispatcher.DispatchMessage(message, true); - await Delay(200); - Assert.That (results, Is.EqualTo (new object[]{ 'D', 'C', 'B', 'A' }).AsCollection); - } - - [Test] - public async Task async_and_sync_handlers_should_run_in_order() - { - //TODO: This fails but not everytime... sometimes it's empty - List results = new List (); - dispatcher.AddMessageHandler(message, CreateHandler.AsyncHandler((Action)results.Add, new object[]{'A'})); - dispatcher.AddMessageHandler(message, CreateHandler.Handler((Action)results.Add, new object[]{'B'})); - dispatcher.AddMessageHandler(message, CreateHandler.AsyncHandler((Action)results.Add, new object[]{'C'})); - dispatcher.AddMessageHandler(message, CreateHandler.Handler((Action)results.Add, new object[]{'D'})); - dispatcher.DispatchMessage(message); - await Delay (200); - Assert.That (results, Is.EqualTo (new object[]{ 'A', 'B', 'C', 'D' }).AsCollection); - } - - [Test] - public async Task async_and_sync_handlers_should_run_in_order_when_reversed() - { - List results = new List (); - dispatcher.AddMessageHandler(message, CreateHandler.AsyncHandler((Action)results.Add, new object[]{'A'})); - dispatcher.AddMessageHandler(message, CreateHandler.Handler((Action)results.Add, new object[]{'B'})); - dispatcher.AddMessageHandler(message, CreateHandler.AsyncHandler((Action)results.Add, new object[]{'C'})); - dispatcher.AddMessageHandler(message, CreateHandler.Handler((Action)results.Add, new object[]{'D'})); - dispatcher.DispatchMessage(message, true); - await Delay (200); - Assert.That (results, Is.EqualTo (new object[]{ 'D', 'C', 'B', 'A' }).AsCollection); - } - - [Test] - public void terminated_message_should_not_reach_further_handlers() - { - List results = new List (); - dispatcher.AddMessageHandler(message, CreateHandler.Handler((Action)results.Add, new object[]{'A'})); - dispatcher.AddMessageHandler(message, CreateHandler.Handler((Action)results.Add, new object[]{'B'})); - dispatcher.AddMessageHandler(message, CreateHandler.HandlerThatErrors((Action)results.Add, new object[]{"C (with error)"})); - dispatcher.AddMessageHandler(message, CreateHandler.Handler((Action)results.Add, new object[]{'D'})); - dispatcher.DispatchMessage(message); - Assert.That (results, Is.EqualTo (new object[]{ 'A', 'B', "C (with error)" }).AsCollection); - } - - [Test] - public void terminated_message_should_not_reach_further_handlers_when_reversed() - { - List results = new List (); - dispatcher.AddMessageHandler(message, CreateHandler.Handler((Action)results.Add, new object[]{'A'})); - dispatcher.AddMessageHandler(message, CreateHandler.Handler((Action)results.Add, new object[]{'B'})); - dispatcher.AddMessageHandler(message, CreateHandler.HandlerThatErrors((Action)results.Add, new object[]{"C (with error)"})); - dispatcher.AddMessageHandler(message, CreateHandler.Handler((Action)results.Add, new object[]{'D'})); - dispatcher.DispatchMessage(message, true); - Assert.That (results, Is.EqualTo (new object[]{ 'D', "C (with error)" }).AsCollection); - } - - [Test] - public async Task terminated_async_message_should_not_reach_further_handlers() - { - List results = new List (); - dispatcher.AddMessageHandler(message, CreateHandler.AsyncHandler((Action)results.Add, new object[]{'A'})); - dispatcher.AddMessageHandler(message, CreateHandler.AsyncHandler((Action)results.Add, new object[]{'B'})); - dispatcher.AddMessageHandler(message, CreateHandler.HandlerThatErrors((Action)results.Add, new object[]{"C (with error)"})); - dispatcher.AddMessageHandler(message, CreateHandler.AsyncHandler((Action)results.Add, new object[]{'D'})); - dispatcher.DispatchMessage(message); - await Delay (200); - Assert.That (results, Is.EqualTo (new object[]{ 'A', 'B', "C (with error)" }).AsCollection); - } - - [Test] - public async Task terminated_async_message_should_not_reach_further_handlers_when_reversed() - { - List results = new List (); - dispatcher.AddMessageHandler(message, CreateHandler.AsyncHandler((Action)results.Add, new object[]{'A'})); - dispatcher.AddMessageHandler(message, CreateHandler.AsyncHandler((Action)results.Add, new object[]{'B'})); - dispatcher.AddMessageHandler(message, CreateHandler.HandlerThatErrors((Action)results.Add, new object[]{"C (with error)"})); - dispatcher.AddMessageHandler(message, CreateHandler.AsyncHandler((Action)results.Add, new object[]{'D'})); - dispatcher.DispatchMessage(message, true); - await Delay (200); - Assert.That (results, Is.EqualTo (new object[]{ 'D', "C (with error)" }).AsCollection); - } - - [Test] - public void handler_is_only_added_once() - { - int callbackCount = 0; - Action handler = delegate() { - callbackCount++; - }; - dispatcher.AddMessageHandler(message, handler); - dispatcher.AddMessageHandler(message, handler); - dispatcher.DispatchMessage(message); - Assert.That(callbackCount, Is.EqualTo(1)); - } - - /*============================================================================*/ - /* Private Functions */ - /*============================================================================*/ - - private async Task DelayAssertion(Delegate closure, int delay = 50) - { - await Task.Delay(delay); - InvokeDelegate (closure); - } - - private void SetTimeout(Delegate callback, int delay, object[] args = null) - { - Timer t = new Timer(new TimerCallback(delegate(object state) - { - callback.DynamicInvoke(args); - } - ), null, delay, System.Threading.Timeout.Infinite); - } - - private void InvokeDelegate(Delegate del) - { - int length = del.Method.GetParameters ().Length; - object[] parameters = new object[length]; - del.DynamicInvoke (parameters); - } - - private Task Delay(int milliseconds = 50) - { - return Task.Delay(milliseconds); - } - } -} - +//------------------------------------------------------------------------------ +// Copyright (c) 2014-2016 the original author or authors. All Rights Reserved. +// +// NOTICE: You are permitted to use, modify, and distribute this file +// in accordance with the terms of the license agreement accompanying it. +//------------------------------------------------------------------------------ + +using System; +using NUnit.Framework; +using System.Threading.Tasks; +using Robotlegs.Bender.Framework.Impl.SafelyCallBackSupport; +using Robotlegs.Bender.Framework.API; +using System.Threading; +using System.Collections.Generic; + +namespace Robotlegs.Bender.Framework.Impl +{ + [TestFixture] + public class MessageDispatcherTest + { + /*============================================================================*/ + /* Private Properties */ + /*============================================================================*/ + + #region Fields + + private MessageDispatcher dispatcher; + + private object message; + + #endregion Fields + + /*============================================================================*/ + /* Test Setup and Teardown */ + /*============================================================================*/ + + #region Methods + + [Test] + public void addMessageHandler_runs() + { + dispatcher.AddMessageHandler(message, delegate () { }); + } + + [Test] + public void addMessageHandler_stores_handler() + { + dispatcher.AddMessageHandler(message, delegate () { }); + Assert.True(dispatcher.HasMessageHandler(message)); + } + + [Test] + public async Task async_and_sync_handlers_should_run_in_order() + { + //TODO: This fails but not everytime... sometimes it's empty + List results = new List(); + dispatcher.AddMessageHandler(message, CreateHandler.AsyncHandler((Action)results.Add, new object[] { 'A' })); + dispatcher.AddMessageHandler(message, CreateHandler.Handler((Action)results.Add, new object[] { 'B' })); + dispatcher.AddMessageHandler(message, CreateHandler.AsyncHandler((Action)results.Add, new object[] { 'C' })); + dispatcher.AddMessageHandler(message, CreateHandler.Handler((Action)results.Add, new object[] { 'D' })); + dispatcher.DispatchMessage(message); + await Delay(200); + Assert.That(results, Is.EqualTo(new object[] { 'A', 'B', 'C', 'D' }).AsCollection); + } + + [Test] + public async Task async_and_sync_handlers_should_run_in_order_when_reversed() + { + List results = new List(); + dispatcher.AddMessageHandler(message, CreateHandler.AsyncHandler((Action)results.Add, new object[] { 'A' })); + dispatcher.AddMessageHandler(message, CreateHandler.Handler((Action)results.Add, new object[] { 'B' })); + dispatcher.AddMessageHandler(message, CreateHandler.AsyncHandler((Action)results.Add, new object[] { 'C' })); + dispatcher.AddMessageHandler(message, CreateHandler.Handler((Action)results.Add, new object[] { 'D' })); + dispatcher.DispatchMessage(message, true); + await Delay(200); + Assert.That(results, Is.EqualTo(new object[] { 'D', 'C', 'B', 'A' }).AsCollection); + } + + [Test] + public async Task async_handler_handles_message() + { + object actualMessage = null; + dispatcher.AddMessageHandler(message, delegate (object msg, HandlerAsyncCallback callback) + { + actualMessage = msg; + SetTimeout(callback, 5, new object[] { null }); + }); + dispatcher.DispatchMessage(message); + await Delay(); + Assert.That(actualMessage, Is.EqualTo(message)); + } + + [Test] + public async Task async_handler_passes_error_to_callback() + { + object expectedError = "Error"; + object actualError = null; + dispatcher.AddMessageHandler(message, delegate (object msg, HandlerAsyncCallback callback) + { + SetTimeout(callback, 5, new object[] { expectedError }); + }); + dispatcher.DispatchMessage(message, delegate (object error) + { + actualError = error; + }); + await Delay(); + Assert.That(actualError, Is.EqualTo(expectedError)); + } + + [Test] + public async Task async_handler_that_calls_back_more_than_once_is_ignored() + { + int callbackCount = 0; + dispatcher.AddMessageHandler(message, delegate (object msg, HandlerAsyncCallback callback) + { + callback(); + callback(); + }); + dispatcher.DispatchMessage(message, delegate (object error) + { + callbackCount++; + }); + await Delay(); + Assert.That(callbackCount, Is.EqualTo(1)); + } + + [Test] + public async Task async_handlers_should_run_in_order() + { + //TODO: This fails but not everytime... + List results = new List(); + foreach (char id in new object[] { 'A', 'B', 'C', 'D' }) + dispatcher.AddMessageHandler(message, CreateHandler.AsyncHandler((Action)results.Add, new object[] { id })); + dispatcher.DispatchMessage(message); + await Delay(200); + Assert.That(results, Is.EqualTo(new object[] { 'A', 'B', 'C', 'D' }).AsCollection); + } + + [Test] + public async Task async_handlers_should_run_in_reverse_order_when_reversed() + { + List results = new List(); + foreach (char id in new object[] { 'A', 'B', 'C', 'D' }) + dispatcher.AddMessageHandler(message, CreateHandler.AsyncHandler((Action)results.Add, new object[] { id })); + dispatcher.DispatchMessage(message, true); + await Delay(200); + Assert.That(results, Is.EqualTo(new object[] { 'D', 'C', 'B', 'A' }).AsCollection); + } + + [SetUp] + public void before() + { + dispatcher = new MessageDispatcher(); + message = new object(); + } + + /*============================================================================*/ + /* Tests */ + /*============================================================================*/ + + [Test] + public void callback_is_called_once() + { + int callbackCount = 0; + dispatcher.DispatchMessage(message, delegate () + { + callbackCount++; + }); + Assert.AreEqual(callbackCount, 1); + } + + [Test] + public async Task callback_is_called_once_after_async_handler() + { + int callbackCount = 0; + dispatcher.AddMessageHandler(message, CreateHandler.AsyncHandler()); + dispatcher.DispatchMessage(message, delegate () + { + callbackCount++; + }); + await Delay(); + Assert.That(callbackCount, Is.EqualTo(1)); + } + + [Test] + public async Task callback_is_called_once_after_sync_and_async_handlers() + { + int callbackCount = 0; + dispatcher.AddMessageHandler(message, CreateHandler.AsyncHandler()); + dispatcher.AddMessageHandler(message, CreateHandler.Handler()); + dispatcher.AddMessageHandler(message, CreateHandler.AsyncHandler()); + dispatcher.AddMessageHandler(message, CreateHandler.Handler()); + dispatcher.DispatchMessage(message, delegate () + { + callbackCount++; + }); + await Delay(100); + Assert.That(callbackCount, Is.EqualTo(1)); + } + + [Test] + public async Task callback_is_called_once_after_sync_handler() + { + int callbackCount = 0; + dispatcher.AddMessageHandler(message, CreateHandler.Handler()); + dispatcher.DispatchMessage(message, delegate () + { + callbackCount++; + }); + await Delay(); + Assert.AreEqual(callbackCount, 1); + } + + [Test] + public void deaf_handler_handles_message() + { + bool handled = false; + dispatcher.AddMessageHandler(message, delegate () + { + handled = true; + }); + dispatcher.DispatchMessage(message); + Assert.True(handled); + } + + [Test] + public void dispatchMessage_runs() + { + dispatcher.DispatchMessage(message); + } + + [Test] + public void handler_does_not_handle_the_wrong_message() + { + bool handled = false; + dispatcher.AddMessageHandler(message, delegate () + { + handled = true; + }); + dispatcher.DispatchMessage("abcde"); + Assert.False(handled); + } + + [Test] + public void handler_handles_message() + { + object actualMessage = null; + dispatcher.AddMessageHandler(message, delegate (object msg) + { + actualMessage = msg; + }); + dispatcher.DispatchMessage(message); + Assert.AreEqual(actualMessage, message); + } + + [Test] + public void handler_is_only_added_once() + { + int callbackCount = 0; + Action handler = delegate () + { + callbackCount++; + }; + dispatcher.AddMessageHandler(message, handler); + dispatcher.AddMessageHandler(message, handler); + dispatcher.DispatchMessage(message); + Assert.That(callbackCount, Is.EqualTo(1)); + } + + [Test] + public void handler_passes_error_to_callback() + { + object expectedError = "Error"; + object actualError = null; + dispatcher.AddMessageHandler(message, delegate (object msg, HandlerAsyncCallback callback) + { + callback(expectedError); + }); + dispatcher.DispatchMessage(message, delegate (object error) + { + actualError = error; + }); + Assert.That(actualError, Is.EqualTo(expectedError)); + } + + [Test] + public void handler_that_calls_back_more_than_once_is_ignored() + { + int callbackCount = 0; + dispatcher.AddMessageHandler(message, delegate (object msg, HandlerAsyncCallback callback) + { + callback(); + callback(); + }); + dispatcher.DispatchMessage(message, delegate (object error) + { + callbackCount++; + }); + Assert.That(callbackCount, Is.EqualTo(1)); + } + + [Test] + public void handler_with_callback_handles_message() + { + object actualMessage = null; + dispatcher.AddMessageHandler(message, delegate (object msg, HandlerAsyncCallback callback) + { + actualMessage = msg; + callback(); + }); + dispatcher.DispatchMessage(message); + Assert.That(actualMessage, Is.EqualTo(message)); + } + + [Test] + public void hasMessageHandler_returns_false() + { + Assert.False(dispatcher.HasMessageHandler(message)); + } + + [Test] + public void hasMessageHandler_returns_false_for_wrong_message() + { + dispatcher.AddMessageHandler("abcde", delegate () { }); + Assert.False(dispatcher.HasMessageHandler(message)); + } + + [Test] + public void hasMessageHandler_returns_true() + { + dispatcher.AddMessageHandler(message, delegate () { }); + Assert.True(dispatcher.HasMessageHandler(message)); + } + + [Test] + public void hasMessageHandler_runs() + { + dispatcher.HasMessageHandler(message); + } + + [Test] + public void message_is_handled_by_handler_multiple_times() + { + int handleCount = 0; + dispatcher.AddMessageHandler(message, delegate () + { + handleCount++; + }); + dispatcher.DispatchMessage(message); + dispatcher.DispatchMessage(message); + dispatcher.DispatchMessage(message); + Assert.AreEqual(handleCount, 3); + } + + [Test] + public void message_is_handled_by_multiple_handlers() + { + int handleCount = 0; + dispatcher.AddMessageHandler(message, delegate () + { + handleCount++; + }); + dispatcher.AddMessageHandler(message, delegate () + { + handleCount++; + }); + dispatcher.AddMessageHandler(message, delegate () + { + handleCount++; + }); + dispatcher.DispatchMessage(message); + Assert.AreEqual(handleCount, 3); + } + + [Test] + public void removeMessageHandler_does_not_remove_the_wrong_handler() + { + Action handler = delegate () { }; + Action otherHandler = delegate () { }; + dispatcher.AddMessageHandler(message, handler); + dispatcher.AddMessageHandler(message, otherHandler); + dispatcher.RemoveMessageHandler(message, otherHandler); + Assert.True(dispatcher.HasMessageHandler(message)); + } + + [Test] + public void removeMessageHandler_removes_the_handler() + { + Action handler = delegate () { }; + dispatcher.AddMessageHandler(message, handler); + dispatcher.RemoveMessageHandler(message, handler); + Assert.False(dispatcher.HasMessageHandler(message)); + } + + [Test] + public void removeMessageHandler_runs() + { + dispatcher.RemoveMessageHandler(message, delegate () { }); + } + + [Test] + public void sync_handlers_should_run_in_order() + { + List results = new List(); + foreach (char id in new object[] { 'A', 'B', 'C', 'D' }) + dispatcher.AddMessageHandler(message, CreateHandler.Handler((Action)results.Add, new object[] { id })); + dispatcher.DispatchMessage(message); + Assert.That(results, Is.EqualTo(new object[] { 'A', 'B', 'C', 'D' }).AsCollection); + } + + [Test] + public void sync_handlers_should_run_in_reverse_order() + { + List results = new List(); + foreach (char id in new object[] { 'A', 'B', 'C', 'D' }) + dispatcher.AddMessageHandler(message, CreateHandler.Handler((Action)results.Add, new object[] { id })); + dispatcher.DispatchMessage(message, true); + Assert.That(results, Is.EqualTo(new object[] { 'D', 'C', 'B', 'A' }).AsCollection); + } + + [Test] + public async Task terminated_async_message_should_not_reach_further_handlers() + { + List results = new List(); + dispatcher.AddMessageHandler(message, CreateHandler.AsyncHandler((Action)results.Add, new object[] { 'A' })); + dispatcher.AddMessageHandler(message, CreateHandler.AsyncHandler((Action)results.Add, new object[] { 'B' })); + dispatcher.AddMessageHandler(message, CreateHandler.HandlerThatErrors((Action)results.Add, new object[] { "C (with error)" })); + dispatcher.AddMessageHandler(message, CreateHandler.AsyncHandler((Action)results.Add, new object[] { 'D' })); + dispatcher.DispatchMessage(message); + await Delay(200); + + Assert.That(results, Is.EqualTo(new object[] { 'A', 'B', "C (with error)" }).AsCollection); + } + + [Test] + public async Task terminated_async_message_should_not_reach_further_handlers_when_reversed() + { + List results = new List(); + dispatcher.AddMessageHandler(message, CreateHandler.AsyncHandler((Action)results.Add, new object[] { 'A' })); + dispatcher.AddMessageHandler(message, CreateHandler.AsyncHandler((Action)results.Add, new object[] { 'B' })); + dispatcher.AddMessageHandler(message, CreateHandler.HandlerThatErrors((Action)results.Add, new object[] { "C (with error)" })); + dispatcher.AddMessageHandler(message, CreateHandler.AsyncHandler((Action)results.Add, new object[] { 'D' })); + dispatcher.DispatchMessage(message, true); + await Delay(200); + Assert.That(results, Is.EqualTo(new object[] { 'D', "C (with error)" }).AsCollection); + } + + [Test] + public void terminated_message_should_not_reach_further_handlers() + { + List results = new List(); + dispatcher.AddMessageHandler(message, CreateHandler.Handler((Action)results.Add, new object[] { 'A' })); + dispatcher.AddMessageHandler(message, CreateHandler.Handler((Action)results.Add, new object[] { 'B' })); + dispatcher.AddMessageHandler(message, CreateHandler.HandlerThatErrors((Action)results.Add, new object[] { "C (with error)" })); + dispatcher.AddMessageHandler(message, CreateHandler.Handler((Action)results.Add, new object[] { 'D' })); + dispatcher.DispatchMessage(message); + Assert.That(results, Is.EqualTo(new object[] { 'A', 'B', "C (with error)" }).AsCollection); + } + + [Test] + public void terminated_message_should_not_reach_further_handlers_when_reversed() + { + List results = new List(); + dispatcher.AddMessageHandler(message, CreateHandler.Handler((Action)results.Add, new object[] { 'A' })); + dispatcher.AddMessageHandler(message, CreateHandler.Handler((Action)results.Add, new object[] { 'B' })); + dispatcher.AddMessageHandler(message, CreateHandler.HandlerThatErrors((Action)results.Add, new object[] { "C (with error)" })); + dispatcher.AddMessageHandler(message, CreateHandler.Handler((Action)results.Add, new object[] { 'D' })); + dispatcher.DispatchMessage(message, true); + Assert.That(results, Is.EqualTo(new object[] { 'D', "C (with error)" }).AsCollection); + } + + /*============================================================================*/ + /* Private Functions */ + /*============================================================================*/ + + private Task Delay(int milliseconds = 50) + { + return Task.Delay(milliseconds); + } + + private async Task DelayAssertion(Delegate closure, int delay = 50) + { + await Task.Delay(delay); + InvokeDelegate(closure); + } + + private void InvokeDelegate(Delegate del) + { + int length = del.Method.GetParameters().Length; + object[] parameters = new object[length]; + del.DynamicInvoke(parameters); + } + + private void SetTimeout(Delegate callback, int delay, object[] args = null) + { + Timer t = new Timer(new TimerCallback(delegate (object state) + { + callback.DynamicInvoke(args); + } + ), null, delay, System.Threading.Timeout.Infinite); + } + + #endregion Methods + } +} \ No newline at end of file