diff --git a/Assets/HOTK/HOTK_Overlay.cs b/Assets/HOTK/HOTK_Overlay.cs index e727abd..937c1af 100644 --- a/Assets/HOTK/HOTK_Overlay.cs +++ b/Assets/HOTK/HOTK_Overlay.cs @@ -610,7 +610,7 @@ private void UpdateOverlay() var tex = new Texture_t { handle = OverlayTexture.GetNativeTexturePtr(), - eType = SteamVR.instance.graphicsAPI, + eType = SteamVR.instance.textureType, eColorSpace = EColorSpace.Auto }; overlay.SetOverlayColor(_handle, 1f, 1f, 1f); @@ -708,7 +708,7 @@ private void UpdateRenderTexture() var tex = new Texture_t { handle = OverlayTexture.GetNativeTexturePtr(), - eType = SteamVR.instance.graphicsAPI, + eType = SteamVR.instance.textureType, eColorSpace = EColorSpace.Auto }; diff --git a/Assets/HOTK/HOTK_TrackedDevice.cs b/Assets/HOTK/HOTK_TrackedDevice.cs index 8503103..e7ba763 100644 --- a/Assets/HOTK/HOTK_TrackedDevice.cs +++ b/Assets/HOTK/HOTK_TrackedDevice.cs @@ -39,7 +39,7 @@ public enum EType private EType _type; - private void OnNewPoses(params object[] args) + private void OnNewPoses(params TrackedDevicePose_t[] args) { if (_type != Type) { @@ -79,7 +79,7 @@ private void OnNewPoses(params object[] args) var i = (int) Index; - var poses = (TrackedDevicePose_t[]) args[0]; + var poses = args; if (poses.Length <= i) return; @@ -130,12 +130,12 @@ private void OnControllerIndexChanged(ETrackedControllerRole role, uint index) public void OnEnable() { Reset(); - SteamVR_Utils.Event.Listen("new_poses", OnNewPoses); + SteamVR_Events.NewPoses.Listen(OnNewPoses); } public void OnDisable() { - SteamVR_Utils.Event.Remove("new_poses", OnNewPoses); + SteamVR_Events.NewPoses.Remove(OnNewPoses); Reset(); } diff --git a/Assets/HOTK/HOTK_TrackedDeviceManager.cs b/Assets/HOTK/HOTK_TrackedDeviceManager.cs index 264d53b..31b5fd2 100644 --- a/Assets/HOTK/HOTK_TrackedDeviceManager.cs +++ b/Assets/HOTK/HOTK_TrackedDeviceManager.cs @@ -65,8 +65,8 @@ private void UpdatePoses() var compositor = OpenVR.Compositor; if (compositor == null) return; compositor.GetLastPoses(_poses, _gamePoses); - SteamVR_Utils.Event.Send("new_poses", _poses); - SteamVR_Utils.Event.Send("new_poses_applied"); + SteamVR_Events.NewPoses.Send(_poses); + SteamVR_Events.NewPosesApplied.Send(); } /// diff --git a/Assets/Plugins/openvr_api.bundle.meta b/Assets/Plugins/openvr_api.bundle.meta index 7a63b74..089e14e 100644 --- a/Assets/Plugins/openvr_api.bundle.meta +++ b/Assets/Plugins/openvr_api.bundle.meta @@ -4,14 +4,43 @@ folderAsset: yes timeCreated: 1465633285 licenseType: Free PluginImporter: - serializedVersion: 1 + serializedVersion: 2 iconMap: {} executionOrder: {} isPreloaded: 0 + isOverridable: 0 platformData: - Any: - enabled: 1 - settings: {} + data: + first: + Any: + second: + enabled: 0 + settings: {} + data: + first: + Editor: Editor + second: + enabled: 1 + settings: + DefaultValueInitialized: true + data: + first: + Standalone: OSXIntel + second: + enabled: 1 + settings: {} + data: + first: + Standalone: OSXIntel64 + second: + enabled: 1 + settings: {} + data: + first: + Standalone: OSXUniversal + second: + enabled: 1 + settings: {} userData: assetBundleName: assetBundleVariant: diff --git a/Assets/Plugins/openvr_api.cs b/Assets/Plugins/openvr_api.cs index f31b0cd..33bfd25 100644 --- a/Assets/Plugins/openvr_api.cs +++ b/Assets/Plugins/openvr_api.cs @@ -1,4 +1,4 @@ -//======= Copyright 1996-2014, Valve Corporation, All rights reserved. ======== +//======= Copyright (c) Valve Corporation, All rights reserved. =============== // // Purpose: This file contains C#/managed code bindings for the OpenVR interfaces // This file is auto-generated, do not edit it. @@ -21,7 +21,7 @@ public struct IVRSystem internal _GetRecommendedRenderTargetSize GetRecommendedRenderTargetSize; [UnmanagedFunctionPointer(CallingConvention.StdCall)] - internal delegate HmdMatrix44_t _GetProjectionMatrix(EVREye eEye, float fNearZ, float fFarZ, EGraphicsAPIConvention eProjType); + internal delegate HmdMatrix44_t _GetProjectionMatrix(EVREye eEye, float fNearZ, float fFarZ); [MarshalAs(UnmanagedType.FunctionPtr)] internal _GetProjectionMatrix GetProjectionMatrix; @@ -31,7 +31,7 @@ public struct IVRSystem internal _GetProjectionRaw GetProjectionRaw; [UnmanagedFunctionPointer(CallingConvention.StdCall)] - internal delegate DistortionCoordinates_t _ComputeDistortion(EVREye eEye, float fU, float fV); + internal delegate bool _ComputeDistortion(EVREye eEye, float fU, float fV, ref DistortionCoordinates_t pDistortionCoordinates); [MarshalAs(UnmanagedType.FunctionPtr)] internal _ComputeDistortion ComputeDistortion; @@ -171,17 +171,17 @@ public struct IVRSystem internal _GetEventTypeNameFromEnum GetEventTypeNameFromEnum; [UnmanagedFunctionPointer(CallingConvention.StdCall)] - internal delegate HiddenAreaMesh_t _GetHiddenAreaMesh(EVREye eEye); + internal delegate HiddenAreaMesh_t _GetHiddenAreaMesh(EVREye eEye, EHiddenAreaMeshType type); [MarshalAs(UnmanagedType.FunctionPtr)] internal _GetHiddenAreaMesh GetHiddenAreaMesh; [UnmanagedFunctionPointer(CallingConvention.StdCall)] - internal delegate bool _GetControllerState(uint unControllerDeviceIndex, ref VRControllerState_t pControllerState); + internal delegate bool _GetControllerState(uint unControllerDeviceIndex, ref VRControllerState_t pControllerState, uint unControllerStateSize); [MarshalAs(UnmanagedType.FunctionPtr)] internal _GetControllerState GetControllerState; [UnmanagedFunctionPointer(CallingConvention.StdCall)] - internal delegate bool _GetControllerStateWithPose(ETrackingUniverseOrigin eOrigin, uint unControllerDeviceIndex, ref VRControllerState_t pControllerState, ref TrackedDevicePose_t pTrackedDevicePose); + internal delegate bool _GetControllerStateWithPose(ETrackingUniverseOrigin eOrigin, uint unControllerDeviceIndex, ref VRControllerState_t pControllerState, uint unControllerStateSize, ref TrackedDevicePose_t pTrackedDevicePose); [MarshalAs(UnmanagedType.FunctionPtr)] internal _GetControllerStateWithPose GetControllerStateWithPose; @@ -257,6 +257,71 @@ public struct IVRExtendedDisplay } +[StructLayout(LayoutKind.Sequential)] +public struct IVRTrackedCamera +{ + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate IntPtr _GetCameraErrorNameFromEnum(EVRTrackedCameraError eCameraError); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetCameraErrorNameFromEnum GetCameraErrorNameFromEnum; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate EVRTrackedCameraError _HasCamera(uint nDeviceIndex, ref bool pHasCamera); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _HasCamera HasCamera; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate EVRTrackedCameraError _GetCameraFrameSize(uint nDeviceIndex, EVRTrackedCameraFrameType eFrameType, ref uint pnWidth, ref uint pnHeight, ref uint pnFrameBufferSize); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetCameraFrameSize GetCameraFrameSize; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate EVRTrackedCameraError _GetCameraIntrinsics(uint nDeviceIndex, EVRTrackedCameraFrameType eFrameType, ref HmdVector2_t pFocalLength, ref HmdVector2_t pCenter); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetCameraIntrinsics GetCameraIntrinsics; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate EVRTrackedCameraError _GetCameraProjection(uint nDeviceIndex, EVRTrackedCameraFrameType eFrameType, float flZNear, float flZFar, ref HmdMatrix44_t pProjection); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetCameraProjection GetCameraProjection; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate EVRTrackedCameraError _AcquireVideoStreamingService(uint nDeviceIndex, ref ulong pHandle); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _AcquireVideoStreamingService AcquireVideoStreamingService; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate EVRTrackedCameraError _ReleaseVideoStreamingService(ulong hTrackedCamera); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _ReleaseVideoStreamingService ReleaseVideoStreamingService; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate EVRTrackedCameraError _GetVideoStreamFrameBuffer(ulong hTrackedCamera, EVRTrackedCameraFrameType eFrameType, IntPtr pFrameBuffer, uint nFrameBufferSize, ref CameraVideoStreamFrameHeader_t pFrameHeader, uint nFrameHeaderSize); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetVideoStreamFrameBuffer GetVideoStreamFrameBuffer; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate EVRTrackedCameraError _GetVideoStreamTextureSize(uint nDeviceIndex, EVRTrackedCameraFrameType eFrameType, ref VRTextureBounds_t pTextureBounds, ref uint pnWidth, ref uint pnHeight); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetVideoStreamTextureSize GetVideoStreamTextureSize; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate EVRTrackedCameraError _GetVideoStreamTextureD3D11(ulong hTrackedCamera, EVRTrackedCameraFrameType eFrameType, IntPtr pD3D11DeviceOrResource, ref IntPtr ppD3D11ShaderResourceView, ref CameraVideoStreamFrameHeader_t pFrameHeader, uint nFrameHeaderSize); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetVideoStreamTextureD3D11 GetVideoStreamTextureD3D11; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate EVRTrackedCameraError _GetVideoStreamTextureGL(ulong hTrackedCamera, EVRTrackedCameraFrameType eFrameType, ref uint pglTextureId, ref CameraVideoStreamFrameHeader_t pFrameHeader, uint nFrameHeaderSize); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetVideoStreamTextureGL GetVideoStreamTextureGL; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate EVRTrackedCameraError _ReleaseVideoStreamTextureGL(ulong hTrackedCamera, uint glTextureId); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _ReleaseVideoStreamTextureGL ReleaseVideoStreamTextureGL; + +} + [StructLayout(LayoutKind.Sequential)] public struct IVRApplications { @@ -281,7 +346,7 @@ public struct IVRApplications internal _GetApplicationCount GetApplicationCount; [UnmanagedFunctionPointer(CallingConvention.StdCall)] - internal delegate EVRApplicationError _GetApplicationKeyByIndex(uint unApplicationIndex, string pchAppKeyBuffer, uint unAppKeyBufferLen); + internal delegate EVRApplicationError _GetApplicationKeyByIndex(uint unApplicationIndex, System.Text.StringBuilder pchAppKeyBuffer, uint unAppKeyBufferLen); [MarshalAs(UnmanagedType.FunctionPtr)] internal _GetApplicationKeyByIndex GetApplicationKeyByIndex; @@ -300,6 +365,11 @@ public struct IVRApplications [MarshalAs(UnmanagedType.FunctionPtr)] internal _LaunchTemplateApplication LaunchTemplateApplication; + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate EVRApplicationError _LaunchApplicationFromMimeType(string pchMimeType, string pchArgs); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _LaunchApplicationFromMimeType LaunchApplicationFromMimeType; + [UnmanagedFunctionPointer(CallingConvention.StdCall)] internal delegate EVRApplicationError _LaunchDashboardOverlay(string pchAppKey); [MarshalAs(UnmanagedType.FunctionPtr)] @@ -326,7 +396,7 @@ public struct IVRApplications internal _GetApplicationsErrorNameFromEnum GetApplicationsErrorNameFromEnum; [UnmanagedFunctionPointer(CallingConvention.StdCall)] - internal delegate uint _GetApplicationPropertyString(string pchAppKey, EVRApplicationProperty eProperty, string pchPropertyValueBuffer, uint unPropertyValueBufferLen, ref EVRApplicationError peError); + internal delegate uint _GetApplicationPropertyString(string pchAppKey, EVRApplicationProperty eProperty, System.Text.StringBuilder pchPropertyValueBuffer, uint unPropertyValueBufferLen, ref EVRApplicationError peError); [MarshalAs(UnmanagedType.FunctionPtr)] internal _GetApplicationPropertyString GetApplicationPropertyString; @@ -350,6 +420,31 @@ public struct IVRApplications [MarshalAs(UnmanagedType.FunctionPtr)] internal _GetApplicationAutoLaunch GetApplicationAutoLaunch; + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate EVRApplicationError _SetDefaultApplicationForMimeType(string pchAppKey, string pchMimeType); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _SetDefaultApplicationForMimeType SetDefaultApplicationForMimeType; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate bool _GetDefaultApplicationForMimeType(string pchMimeType, string pchAppKeyBuffer, uint unAppKeyBufferLen); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetDefaultApplicationForMimeType GetDefaultApplicationForMimeType; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate bool _GetApplicationSupportedMimeTypes(string pchAppKey, string pchMimeTypesBuffer, uint unMimeTypesBuffer); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetApplicationSupportedMimeTypes GetApplicationSupportedMimeTypes; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate uint _GetApplicationsThatSupportMimeType(string pchMimeType, string pchAppKeysThatSupportBuffer, uint unAppKeysThatSupportBuffer); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetApplicationsThatSupportMimeType GetApplicationsThatSupportMimeType; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate uint _GetApplicationLaunchArguments(uint unHandle, string pchArgs, uint unArgs); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetApplicationLaunchArguments GetApplicationLaunchArguments; + [UnmanagedFunctionPointer(CallingConvention.StdCall)] internal delegate EVRApplicationError _GetStartingApplication(string pchAppKeyBuffer, uint unAppKeyBufferLen); [MarshalAs(UnmanagedType.FunctionPtr)] @@ -380,6 +475,11 @@ public struct IVRApplications [MarshalAs(UnmanagedType.FunctionPtr)] internal _LaunchInternalProcess LaunchInternalProcess; + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate uint _GetCurrentSceneProcessId(); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetCurrentSceneProcessId GetCurrentSceneProcessId; + } [StructLayout(LayoutKind.Sequential)] @@ -580,21 +680,41 @@ public struct IVRCompositor [MarshalAs(UnmanagedType.FunctionPtr)] internal _GetFrameTiming GetFrameTiming; + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate uint _GetFrameTimings(ref Compositor_FrameTiming pTiming, uint nFrames); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetFrameTimings GetFrameTimings; + [UnmanagedFunctionPointer(CallingConvention.StdCall)] internal delegate float _GetFrameTimeRemaining(); [MarshalAs(UnmanagedType.FunctionPtr)] internal _GetFrameTimeRemaining GetFrameTimeRemaining; + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate void _GetCumulativeStats(ref Compositor_CumulativeStats pStats, uint nStatsSizeInBytes); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetCumulativeStats GetCumulativeStats; + [UnmanagedFunctionPointer(CallingConvention.StdCall)] internal delegate void _FadeToColor(float fSeconds, float fRed, float fGreen, float fBlue, float fAlpha, bool bBackground); [MarshalAs(UnmanagedType.FunctionPtr)] internal _FadeToColor FadeToColor; + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate HmdColor_t _GetCurrentFadeColor(bool bBackground); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetCurrentFadeColor GetCurrentFadeColor; + [UnmanagedFunctionPointer(CallingConvention.StdCall)] internal delegate void _FadeGrid(float fSeconds, bool bFadeIn); [MarshalAs(UnmanagedType.FunctionPtr)] internal _FadeGrid FadeGrid; + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate float _GetCurrentGridAlpha(); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetCurrentGridAlpha GetCurrentGridAlpha; + [UnmanagedFunctionPointer(CallingConvention.StdCall)] internal delegate EVRCompositorError _SetSkyboxOverride([In, Out] Texture_t[] pTextures, uint unTextureCount); [MarshalAs(UnmanagedType.FunctionPtr)] @@ -680,6 +800,46 @@ public struct IVRCompositor [MarshalAs(UnmanagedType.FunctionPtr)] internal _SuspendRendering SuspendRendering; + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate EVRCompositorError _GetMirrorTextureD3D11(EVREye eEye, IntPtr pD3D11DeviceOrResource, ref IntPtr ppD3D11ShaderResourceView); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetMirrorTextureD3D11 GetMirrorTextureD3D11; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate void _ReleaseMirrorTextureD3D11(IntPtr pD3D11ShaderResourceView); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _ReleaseMirrorTextureD3D11 ReleaseMirrorTextureD3D11; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate EVRCompositorError _GetMirrorTextureGL(EVREye eEye, ref uint pglTextureId, IntPtr pglSharedTextureHandle); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetMirrorTextureGL GetMirrorTextureGL; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate bool _ReleaseSharedGLTexture(uint glTextureId, IntPtr glSharedTextureHandle); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _ReleaseSharedGLTexture ReleaseSharedGLTexture; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate void _LockGLSharedTextureForAccess(IntPtr glSharedTextureHandle); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _LockGLSharedTextureForAccess LockGLSharedTextureForAccess; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate void _UnlockGLSharedTextureForAccess(IntPtr glSharedTextureHandle); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _UnlockGLSharedTextureForAccess UnlockGLSharedTextureForAccess; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate uint _GetVulkanInstanceExtensionsRequired(System.Text.StringBuilder pchValue, uint unBufferSize); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetVulkanInstanceExtensionsRequired GetVulkanInstanceExtensionsRequired; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate uint _GetVulkanDeviceExtensionsRequired(IntPtr pPhysicalDevice, System.Text.StringBuilder pchValue, uint unBufferSize); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetVulkanDeviceExtensionsRequired GetVulkanDeviceExtensionsRequired; + } [StructLayout(LayoutKind.Sequential)] @@ -770,6 +930,26 @@ public struct IVROverlay [MarshalAs(UnmanagedType.FunctionPtr)] internal _GetOverlayAlpha GetOverlayAlpha; + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate EVROverlayError _SetOverlayTexelAspect(ulong ulOverlayHandle, float fTexelAspect); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _SetOverlayTexelAspect SetOverlayTexelAspect; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate EVROverlayError _GetOverlayTexelAspect(ulong ulOverlayHandle, ref float pfTexelAspect); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetOverlayTexelAspect GetOverlayTexelAspect; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate EVROverlayError _SetOverlaySortOrder(ulong ulOverlayHandle, uint unSortOrder); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _SetOverlaySortOrder SetOverlaySortOrder; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate EVROverlayError _GetOverlaySortOrder(ulong ulOverlayHandle, ref uint punSortOrder); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetOverlaySortOrder GetOverlaySortOrder; + [UnmanagedFunctionPointer(CallingConvention.StdCall)] internal delegate EVROverlayError _SetOverlayWidthInMeters(ulong ulOverlayHandle, float fWidthInMeters); [MarshalAs(UnmanagedType.FunctionPtr)] @@ -946,7 +1126,7 @@ public struct IVROverlay internal _SetOverlayFromFile SetOverlayFromFile; [UnmanagedFunctionPointer(CallingConvention.StdCall)] - internal delegate EVROverlayError _GetOverlayTexture(ulong ulOverlayHandle, ref IntPtr pNativeTextureHandle, IntPtr pNativeTextureRef, ref uint pWidth, ref uint pHeight, ref uint pNativeFormat, ref EGraphicsAPIConvention pAPI, ref EColorSpace pColorSpace); + internal delegate EVROverlayError _GetOverlayTexture(ulong ulOverlayHandle, ref IntPtr pNativeTextureHandle, IntPtr pNativeTextureRef, ref uint pWidth, ref uint pHeight, ref uint pNativeFormat, ref ETextureType pAPIType, ref EColorSpace pColorSpace, ref VRTextureBounds_t pTextureBounds); [MarshalAs(UnmanagedType.FunctionPtr)] internal _GetOverlayTexture GetOverlayTexture; @@ -955,6 +1135,11 @@ public struct IVROverlay [MarshalAs(UnmanagedType.FunctionPtr)] internal _ReleaseNativeOverlayHandle ReleaseNativeOverlayHandle; + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate EVROverlayError _GetOverlayTextureSize(ulong ulOverlayHandle, ref uint pWidth, ref uint pHeight); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetOverlayTextureSize GetOverlayTextureSize; + [UnmanagedFunctionPointer(CallingConvention.StdCall)] internal delegate EVROverlayError _CreateDashboardOverlay(string pchOverlayKey, string pchOverlayFriendlyName, ref ulong pMainHandle, ref ulong pThumbnailHandle); [MarshalAs(UnmanagedType.FunctionPtr)] @@ -1020,6 +1205,21 @@ public struct IVROverlay [MarshalAs(UnmanagedType.FunctionPtr)] internal _SetKeyboardPositionForOverlay SetKeyboardPositionForOverlay; + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate EVROverlayError _SetOverlayIntersectionMask(ulong ulOverlayHandle, ref VROverlayIntersectionMaskPrimitive_t pMaskPrimitives, uint unNumMaskPrimitives, uint unPrimitiveSize); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _SetOverlayIntersectionMask SetOverlayIntersectionMask; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate EVROverlayError _GetOverlayFlags(ulong ulOverlayHandle, ref uint pFlags); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetOverlayFlags GetOverlayFlags; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate VRMessageOverlayResponse _ShowMessageOverlay(string pchText, string pchCaption, string pchButton0Text, string pchButton1Text, string pchButton2Text, string pchButton3Text); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _ShowMessageOverlay ShowMessageOverlay; + } [StructLayout(LayoutKind.Sequential)] @@ -1100,6 +1300,21 @@ public struct IVRRenderModels [MarshalAs(UnmanagedType.FunctionPtr)] internal _RenderModelHasComponent RenderModelHasComponent; + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate uint _GetRenderModelThumbnailURL(string pchRenderModelName, System.Text.StringBuilder pchThumbnailURL, uint unThumbnailURLLen, ref EVRRenderModelError peError); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetRenderModelThumbnailURL GetRenderModelThumbnailURL; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate uint _GetRenderModelOriginalPath(string pchRenderModelName, System.Text.StringBuilder pchOriginalPath, uint unOriginalPathLen, ref EVRRenderModelError peError); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetRenderModelOriginalPath GetRenderModelOriginalPath; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate IntPtr _GetRenderModelErrorNameFromEnum(EVRRenderModelError error); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetRenderModelErrorNameFromEnum GetRenderModelErrorNameFromEnum; + } [StructLayout(LayoutKind.Sequential)] @@ -1131,44 +1346,44 @@ public struct IVRSettings internal _Sync Sync; [UnmanagedFunctionPointer(CallingConvention.StdCall)] - internal delegate bool _GetBool(string pchSection, string pchSettingsKey, bool bDefaultValue, ref EVRSettingsError peError); + internal delegate void _SetBool(string pchSection, string pchSettingsKey, bool bValue, ref EVRSettingsError peError); [MarshalAs(UnmanagedType.FunctionPtr)] - internal _GetBool GetBool; + internal _SetBool SetBool; [UnmanagedFunctionPointer(CallingConvention.StdCall)] - internal delegate void _SetBool(string pchSection, string pchSettingsKey, bool bValue, ref EVRSettingsError peError); + internal delegate void _SetInt32(string pchSection, string pchSettingsKey, int nValue, ref EVRSettingsError peError); [MarshalAs(UnmanagedType.FunctionPtr)] - internal _SetBool SetBool; + internal _SetInt32 SetInt32; [UnmanagedFunctionPointer(CallingConvention.StdCall)] - internal delegate int _GetInt32(string pchSection, string pchSettingsKey, int nDefaultValue, ref EVRSettingsError peError); + internal delegate void _SetFloat(string pchSection, string pchSettingsKey, float flValue, ref EVRSettingsError peError); [MarshalAs(UnmanagedType.FunctionPtr)] - internal _GetInt32 GetInt32; + internal _SetFloat SetFloat; [UnmanagedFunctionPointer(CallingConvention.StdCall)] - internal delegate void _SetInt32(string pchSection, string pchSettingsKey, int nValue, ref EVRSettingsError peError); + internal delegate void _SetString(string pchSection, string pchSettingsKey, string pchValue, ref EVRSettingsError peError); [MarshalAs(UnmanagedType.FunctionPtr)] - internal _SetInt32 SetInt32; + internal _SetString SetString; [UnmanagedFunctionPointer(CallingConvention.StdCall)] - internal delegate float _GetFloat(string pchSection, string pchSettingsKey, float flDefaultValue, ref EVRSettingsError peError); + internal delegate bool _GetBool(string pchSection, string pchSettingsKey, ref EVRSettingsError peError); [MarshalAs(UnmanagedType.FunctionPtr)] - internal _GetFloat GetFloat; + internal _GetBool GetBool; [UnmanagedFunctionPointer(CallingConvention.StdCall)] - internal delegate void _SetFloat(string pchSection, string pchSettingsKey, float flValue, ref EVRSettingsError peError); + internal delegate int _GetInt32(string pchSection, string pchSettingsKey, ref EVRSettingsError peError); [MarshalAs(UnmanagedType.FunctionPtr)] - internal _SetFloat SetFloat; + internal _GetInt32 GetInt32; [UnmanagedFunctionPointer(CallingConvention.StdCall)] - internal delegate void _GetString(string pchSection, string pchSettingsKey, string pchValue, uint unValueLen, string pchDefaultValue, ref EVRSettingsError peError); + internal delegate float _GetFloat(string pchSection, string pchSettingsKey, ref EVRSettingsError peError); [MarshalAs(UnmanagedType.FunctionPtr)] - internal _GetString GetString; + internal _GetFloat GetFloat; [UnmanagedFunctionPointer(CallingConvention.StdCall)] - internal delegate void _SetString(string pchSection, string pchSettingsKey, string pchValue, ref EVRSettingsError peError); + internal delegate void _GetString(string pchSection, string pchSettingsKey, System.Text.StringBuilder pchValue, uint unValueLen, ref EVRSettingsError peError); [MarshalAs(UnmanagedType.FunctionPtr)] - internal _SetString SetString; + internal _GetString GetString; [UnmanagedFunctionPointer(CallingConvention.StdCall)] internal delegate void _RemoveSection(string pchSection, ref EVRSettingsError peError); @@ -1182,6 +1397,61 @@ public struct IVRSettings } +[StructLayout(LayoutKind.Sequential)] +public struct IVRScreenshots +{ + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate EVRScreenshotError _RequestScreenshot(ref uint pOutScreenshotHandle, EVRScreenshotType type, string pchPreviewFilename, string pchVRFilename); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _RequestScreenshot RequestScreenshot; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate EVRScreenshotError _HookScreenshot([In, Out] EVRScreenshotType[] pSupportedTypes, int numTypes); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _HookScreenshot HookScreenshot; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate EVRScreenshotType _GetScreenshotPropertyType(uint screenshotHandle, ref EVRScreenshotError pError); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetScreenshotPropertyType GetScreenshotPropertyType; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate uint _GetScreenshotPropertyFilename(uint screenshotHandle, EVRScreenshotPropertyFilenames filenameType, System.Text.StringBuilder pchFilename, uint cchFilename, ref EVRScreenshotError pError); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetScreenshotPropertyFilename GetScreenshotPropertyFilename; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate EVRScreenshotError _UpdateScreenshotProgress(uint screenshotHandle, float flProgress); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _UpdateScreenshotProgress UpdateScreenshotProgress; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate EVRScreenshotError _TakeStereoScreenshot(ref uint pOutScreenshotHandle, string pchPreviewFilename, string pchVRFilename); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _TakeStereoScreenshot TakeStereoScreenshot; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate EVRScreenshotError _SubmitScreenshot(uint screenshotHandle, EVRScreenshotType type, string pchSourcePreviewFilename, string pchSourceVRFilename); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _SubmitScreenshot SubmitScreenshot; + +} + +[StructLayout(LayoutKind.Sequential)] +public struct IVRResources +{ + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate uint _LoadSharedResource(string pchResourceName, string pchBuffer, uint unBufferLen); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _LoadSharedResource LoadSharedResource; + + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate uint _GetResourceFullPath(string pchResourceName, string pchResourceTypeDirectory, string pchPathBuffer, uint unBufferLen); + [MarshalAs(UnmanagedType.FunctionPtr)] + internal _GetResourceFullPath GetResourceFullPath; + +} + public class CVRSystem { @@ -1196,9 +1466,9 @@ public void GetRecommendedRenderTargetSize(ref uint pnWidth,ref uint pnHeight) pnHeight = 0; FnTable.GetRecommendedRenderTargetSize(ref pnWidth,ref pnHeight); } - public HmdMatrix44_t GetProjectionMatrix(EVREye eEye,float fNearZ,float fFarZ,EGraphicsAPIConvention eProjType) + public HmdMatrix44_t GetProjectionMatrix(EVREye eEye,float fNearZ,float fFarZ) { - HmdMatrix44_t result = FnTable.GetProjectionMatrix(eEye,fNearZ,fFarZ,eProjType); + HmdMatrix44_t result = FnTable.GetProjectionMatrix(eEye,fNearZ,fFarZ); return result; } public void GetProjectionRaw(EVREye eEye,ref float pfLeft,ref float pfRight,ref float pfTop,ref float pfBottom) @@ -1209,9 +1479,9 @@ public void GetProjectionRaw(EVREye eEye,ref float pfLeft,ref float pfRight,ref pfBottom = 0; FnTable.GetProjectionRaw(eEye,ref pfLeft,ref pfRight,ref pfTop,ref pfBottom); } - public DistortionCoordinates_t ComputeDistortion(EVREye eEye,float fU,float fV) + public bool ComputeDistortion(EVREye eEye,float fU,float fV,ref DistortionCoordinates_t pDistortionCoordinates) { - DistortionCoordinates_t result = FnTable.ComputeDistortion(eEye,fU,fV); + bool result = FnTable.ComputeDistortion(eEye,fU,fV,ref pDistortionCoordinates); return result; } public HmdMatrix34_t GetEyeToHeadTransform(EVREye eEye) @@ -1331,7 +1601,7 @@ public uint GetStringTrackedDeviceProperty(uint unDeviceIndex,ETrackedDeviceProp public string GetPropErrorNameFromEnum(ETrackedPropertyError error) { IntPtr result = FnTable.GetPropErrorNameFromEnum(error); - return (string) Marshal.PtrToStructure(result, typeof(string)); + return Marshal.PtrToStringAnsi(result); } public bool PollNextEvent(ref VREvent_t pEvent,uint uncbVREvent) { @@ -1346,21 +1616,69 @@ public bool PollNextEventWithPose(ETrackingUniverseOrigin eOrigin,ref VREvent_t public string GetEventTypeNameFromEnum(EVREventType eType) { IntPtr result = FnTable.GetEventTypeNameFromEnum(eType); - return (string) Marshal.PtrToStructure(result, typeof(string)); + return Marshal.PtrToStringAnsi(result); } - public HiddenAreaMesh_t GetHiddenAreaMesh(EVREye eEye) + public HiddenAreaMesh_t GetHiddenAreaMesh(EVREye eEye,EHiddenAreaMeshType type) { - HiddenAreaMesh_t result = FnTable.GetHiddenAreaMesh(eEye); + HiddenAreaMesh_t result = FnTable.GetHiddenAreaMesh(eEye,type); return result; } - public bool GetControllerState(uint unControllerDeviceIndex,ref VRControllerState_t pControllerState) +// This is a terrible hack to workaround the fact that VRControllerState_t was +// originally mis-compiled with the wrong packing for Linux and OSX. + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate bool _GetControllerStatePacked(uint unControllerDeviceIndex,ref VRControllerState_t_Packed pControllerState,uint unControllerStateSize); + [StructLayout(LayoutKind.Explicit)] + struct GetControllerStateUnion + { + [FieldOffset(0)] + public IVRSystem._GetControllerState pGetControllerState; + [FieldOffset(0)] + public _GetControllerStatePacked pGetControllerStatePacked; + } + public bool GetControllerState(uint unControllerDeviceIndex,ref VRControllerState_t pControllerState,uint unControllerStateSize) { - bool result = FnTable.GetControllerState(unControllerDeviceIndex,ref pControllerState); + if ((System.Environment.OSVersion.Platform == System.PlatformID.MacOSX) || + (System.Environment.OSVersion.Platform == System.PlatformID.Unix)) + { + GetControllerStateUnion u; + VRControllerState_t_Packed state_packed = new VRControllerState_t_Packed(); + u.pGetControllerStatePacked = null; + u.pGetControllerState = FnTable.GetControllerState; + bool packed_result = u.pGetControllerStatePacked(unControllerDeviceIndex,ref state_packed,(uint)System.Runtime.InteropServices.Marshal.SizeOf(typeof(VRControllerState_t_Packed))); + + state_packed.Unpack(ref pControllerState); + return packed_result; + } + bool result = FnTable.GetControllerState(unControllerDeviceIndex,ref pControllerState,unControllerStateSize); return result; } - public bool GetControllerStateWithPose(ETrackingUniverseOrigin eOrigin,uint unControllerDeviceIndex,ref VRControllerState_t pControllerState,ref TrackedDevicePose_t pTrackedDevicePose) +// This is a terrible hack to workaround the fact that VRControllerState_t was +// originally mis-compiled with the wrong packing for Linux and OSX. + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate bool _GetControllerStateWithPosePacked(ETrackingUniverseOrigin eOrigin,uint unControllerDeviceIndex,ref VRControllerState_t_Packed pControllerState,uint unControllerStateSize,ref TrackedDevicePose_t pTrackedDevicePose); + [StructLayout(LayoutKind.Explicit)] + struct GetControllerStateWithPoseUnion + { + [FieldOffset(0)] + public IVRSystem._GetControllerStateWithPose pGetControllerStateWithPose; + [FieldOffset(0)] + public _GetControllerStateWithPosePacked pGetControllerStateWithPosePacked; + } + public bool GetControllerStateWithPose(ETrackingUniverseOrigin eOrigin,uint unControllerDeviceIndex,ref VRControllerState_t pControllerState,uint unControllerStateSize,ref TrackedDevicePose_t pTrackedDevicePose) { - bool result = FnTable.GetControllerStateWithPose(eOrigin,unControllerDeviceIndex,ref pControllerState,ref pTrackedDevicePose); + if ((System.Environment.OSVersion.Platform == System.PlatformID.MacOSX) || + (System.Environment.OSVersion.Platform == System.PlatformID.Unix)) + { + GetControllerStateWithPoseUnion u; + VRControllerState_t_Packed state_packed = new VRControllerState_t_Packed(); + u.pGetControllerStateWithPosePacked = null; + u.pGetControllerStateWithPose = FnTable.GetControllerStateWithPose; + bool packed_result = u.pGetControllerStateWithPosePacked(eOrigin,unControllerDeviceIndex,ref state_packed,(uint)System.Runtime.InteropServices.Marshal.SizeOf(typeof(VRControllerState_t_Packed)),ref pTrackedDevicePose); + + state_packed.Unpack(ref pControllerState); + return packed_result; + } + bool result = FnTable.GetControllerStateWithPose(eOrigin,unControllerDeviceIndex,ref pControllerState,unControllerStateSize,ref pTrackedDevicePose); return result; } public void TriggerHapticPulse(uint unControllerDeviceIndex,uint unAxisId,char usDurationMicroSec) @@ -1370,12 +1688,12 @@ public void TriggerHapticPulse(uint unControllerDeviceIndex,uint unAxisId,char u public string GetButtonIdNameFromEnum(EVRButtonId eButtonId) { IntPtr result = FnTable.GetButtonIdNameFromEnum(eButtonId); - return (string) Marshal.PtrToStructure(result, typeof(string)); + return Marshal.PtrToStringAnsi(result); } public string GetControllerAxisTypeNameFromEnum(EVRControllerAxisType eAxisType) { IntPtr result = FnTable.GetControllerAxisTypeNameFromEnum(eAxisType); - return (string) Marshal.PtrToStructure(result, typeof(string)); + return Marshal.PtrToStringAnsi(result); } public bool CaptureInputFocus() { @@ -1444,6 +1762,84 @@ public void GetDXGIOutputInfo(ref int pnAdapterIndex,ref int pnAdapterOutputInde } +public class CVRTrackedCamera +{ + IVRTrackedCamera FnTable; + internal CVRTrackedCamera(IntPtr pInterface) + { + FnTable = (IVRTrackedCamera)Marshal.PtrToStructure(pInterface, typeof(IVRTrackedCamera)); + } + public string GetCameraErrorNameFromEnum(EVRTrackedCameraError eCameraError) + { + IntPtr result = FnTable.GetCameraErrorNameFromEnum(eCameraError); + return Marshal.PtrToStringAnsi(result); + } + public EVRTrackedCameraError HasCamera(uint nDeviceIndex,ref bool pHasCamera) + { + pHasCamera = false; + EVRTrackedCameraError result = FnTable.HasCamera(nDeviceIndex,ref pHasCamera); + return result; + } + public EVRTrackedCameraError GetCameraFrameSize(uint nDeviceIndex,EVRTrackedCameraFrameType eFrameType,ref uint pnWidth,ref uint pnHeight,ref uint pnFrameBufferSize) + { + pnWidth = 0; + pnHeight = 0; + pnFrameBufferSize = 0; + EVRTrackedCameraError result = FnTable.GetCameraFrameSize(nDeviceIndex,eFrameType,ref pnWidth,ref pnHeight,ref pnFrameBufferSize); + return result; + } + public EVRTrackedCameraError GetCameraIntrinsics(uint nDeviceIndex,EVRTrackedCameraFrameType eFrameType,ref HmdVector2_t pFocalLength,ref HmdVector2_t pCenter) + { + EVRTrackedCameraError result = FnTable.GetCameraIntrinsics(nDeviceIndex,eFrameType,ref pFocalLength,ref pCenter); + return result; + } + public EVRTrackedCameraError GetCameraProjection(uint nDeviceIndex,EVRTrackedCameraFrameType eFrameType,float flZNear,float flZFar,ref HmdMatrix44_t pProjection) + { + EVRTrackedCameraError result = FnTable.GetCameraProjection(nDeviceIndex,eFrameType,flZNear,flZFar,ref pProjection); + return result; + } + public EVRTrackedCameraError AcquireVideoStreamingService(uint nDeviceIndex,ref ulong pHandle) + { + pHandle = 0; + EVRTrackedCameraError result = FnTable.AcquireVideoStreamingService(nDeviceIndex,ref pHandle); + return result; + } + public EVRTrackedCameraError ReleaseVideoStreamingService(ulong hTrackedCamera) + { + EVRTrackedCameraError result = FnTable.ReleaseVideoStreamingService(hTrackedCamera); + return result; + } + public EVRTrackedCameraError GetVideoStreamFrameBuffer(ulong hTrackedCamera,EVRTrackedCameraFrameType eFrameType,IntPtr pFrameBuffer,uint nFrameBufferSize,ref CameraVideoStreamFrameHeader_t pFrameHeader,uint nFrameHeaderSize) + { + EVRTrackedCameraError result = FnTable.GetVideoStreamFrameBuffer(hTrackedCamera,eFrameType,pFrameBuffer,nFrameBufferSize,ref pFrameHeader,nFrameHeaderSize); + return result; + } + public EVRTrackedCameraError GetVideoStreamTextureSize(uint nDeviceIndex,EVRTrackedCameraFrameType eFrameType,ref VRTextureBounds_t pTextureBounds,ref uint pnWidth,ref uint pnHeight) + { + pnWidth = 0; + pnHeight = 0; + EVRTrackedCameraError result = FnTable.GetVideoStreamTextureSize(nDeviceIndex,eFrameType,ref pTextureBounds,ref pnWidth,ref pnHeight); + return result; + } + public EVRTrackedCameraError GetVideoStreamTextureD3D11(ulong hTrackedCamera,EVRTrackedCameraFrameType eFrameType,IntPtr pD3D11DeviceOrResource,ref IntPtr ppD3D11ShaderResourceView,ref CameraVideoStreamFrameHeader_t pFrameHeader,uint nFrameHeaderSize) + { + EVRTrackedCameraError result = FnTable.GetVideoStreamTextureD3D11(hTrackedCamera,eFrameType,pD3D11DeviceOrResource,ref ppD3D11ShaderResourceView,ref pFrameHeader,nFrameHeaderSize); + return result; + } + public EVRTrackedCameraError GetVideoStreamTextureGL(ulong hTrackedCamera,EVRTrackedCameraFrameType eFrameType,ref uint pglTextureId,ref CameraVideoStreamFrameHeader_t pFrameHeader,uint nFrameHeaderSize) + { + pglTextureId = 0; + EVRTrackedCameraError result = FnTable.GetVideoStreamTextureGL(hTrackedCamera,eFrameType,ref pglTextureId,ref pFrameHeader,nFrameHeaderSize); + return result; + } + public EVRTrackedCameraError ReleaseVideoStreamTextureGL(ulong hTrackedCamera,uint glTextureId) + { + EVRTrackedCameraError result = FnTable.ReleaseVideoStreamTextureGL(hTrackedCamera,glTextureId); + return result; + } +} + + public class CVRApplications { IVRApplications FnTable; @@ -1471,7 +1867,7 @@ public uint GetApplicationCount() uint result = FnTable.GetApplicationCount(); return result; } - public EVRApplicationError GetApplicationKeyByIndex(uint unApplicationIndex,string pchAppKeyBuffer,uint unAppKeyBufferLen) + public EVRApplicationError GetApplicationKeyByIndex(uint unApplicationIndex,System.Text.StringBuilder pchAppKeyBuffer,uint unAppKeyBufferLen) { EVRApplicationError result = FnTable.GetApplicationKeyByIndex(unApplicationIndex,pchAppKeyBuffer,unAppKeyBufferLen); return result; @@ -1491,6 +1887,11 @@ public EVRApplicationError LaunchTemplateApplication(string pchTemplateAppKey,st EVRApplicationError result = FnTable.LaunchTemplateApplication(pchTemplateAppKey,pchNewAppKey,pKeys,(uint) pKeys.Length); return result; } + public EVRApplicationError LaunchApplicationFromMimeType(string pchMimeType,string pchArgs) + { + EVRApplicationError result = FnTable.LaunchApplicationFromMimeType(pchMimeType,pchArgs); + return result; + } public EVRApplicationError LaunchDashboardOverlay(string pchAppKey) { EVRApplicationError result = FnTable.LaunchDashboardOverlay(pchAppKey); @@ -1514,9 +1915,9 @@ public uint GetApplicationProcessId(string pchAppKey) public string GetApplicationsErrorNameFromEnum(EVRApplicationError error) { IntPtr result = FnTable.GetApplicationsErrorNameFromEnum(error); - return (string) Marshal.PtrToStructure(result, typeof(string)); + return Marshal.PtrToStringAnsi(result); } - public uint GetApplicationPropertyString(string pchAppKey,EVRApplicationProperty eProperty,string pchPropertyValueBuffer,uint unPropertyValueBufferLen,ref EVRApplicationError peError) + public uint GetApplicationPropertyString(string pchAppKey,EVRApplicationProperty eProperty,System.Text.StringBuilder pchPropertyValueBuffer,uint unPropertyValueBufferLen,ref EVRApplicationError peError) { uint result = FnTable.GetApplicationPropertyString(pchAppKey,eProperty,pchPropertyValueBuffer,unPropertyValueBufferLen,ref peError); return result; @@ -1541,6 +1942,31 @@ public bool GetApplicationAutoLaunch(string pchAppKey) bool result = FnTable.GetApplicationAutoLaunch(pchAppKey); return result; } + public EVRApplicationError SetDefaultApplicationForMimeType(string pchAppKey,string pchMimeType) + { + EVRApplicationError result = FnTable.SetDefaultApplicationForMimeType(pchAppKey,pchMimeType); + return result; + } + public bool GetDefaultApplicationForMimeType(string pchMimeType,string pchAppKeyBuffer,uint unAppKeyBufferLen) + { + bool result = FnTable.GetDefaultApplicationForMimeType(pchMimeType,pchAppKeyBuffer,unAppKeyBufferLen); + return result; + } + public bool GetApplicationSupportedMimeTypes(string pchAppKey,string pchMimeTypesBuffer,uint unMimeTypesBuffer) + { + bool result = FnTable.GetApplicationSupportedMimeTypes(pchAppKey,pchMimeTypesBuffer,unMimeTypesBuffer); + return result; + } + public uint GetApplicationsThatSupportMimeType(string pchMimeType,string pchAppKeysThatSupportBuffer,uint unAppKeysThatSupportBuffer) + { + uint result = FnTable.GetApplicationsThatSupportMimeType(pchMimeType,pchAppKeysThatSupportBuffer,unAppKeysThatSupportBuffer); + return result; + } + public uint GetApplicationLaunchArguments(uint unHandle,string pchArgs,uint unArgs) + { + uint result = FnTable.GetApplicationLaunchArguments(unHandle,pchArgs,unArgs); + return result; + } public EVRApplicationError GetStartingApplication(string pchAppKeyBuffer,uint unAppKeyBufferLen) { EVRApplicationError result = FnTable.GetStartingApplication(pchAppKeyBuffer,unAppKeyBufferLen); @@ -1559,7 +1985,7 @@ public EVRApplicationError PerformApplicationPrelaunchCheck(string pchAppKey) public string GetApplicationsTransitionStateNameFromEnum(EVRApplicationTransitionState state) { IntPtr result = FnTable.GetApplicationsTransitionStateNameFromEnum(state); - return (string) Marshal.PtrToStructure(result, typeof(string)); + return Marshal.PtrToStringAnsi(result); } public bool IsQuitUserPromptRequested() { @@ -1571,6 +1997,11 @@ public EVRApplicationError LaunchInternalProcess(string pchBinaryPath,string pch EVRApplicationError result = FnTable.LaunchInternalProcess(pchBinaryPath,pchArguments,pchWorkingDirectory); return result; } + public uint GetCurrentSceneProcessId() + { + uint result = FnTable.GetCurrentSceneProcessId(); + return result; + } } @@ -1789,19 +2220,38 @@ public bool GetFrameTiming(ref Compositor_FrameTiming pTiming,uint unFramesAgo) bool result = FnTable.GetFrameTiming(ref pTiming,unFramesAgo); return result; } + public uint GetFrameTimings(ref Compositor_FrameTiming pTiming,uint nFrames) + { + uint result = FnTable.GetFrameTimings(ref pTiming,nFrames); + return result; + } public float GetFrameTimeRemaining() { float result = FnTable.GetFrameTimeRemaining(); return result; } + public void GetCumulativeStats(ref Compositor_CumulativeStats pStats,uint nStatsSizeInBytes) + { + FnTable.GetCumulativeStats(ref pStats,nStatsSizeInBytes); + } public void FadeToColor(float fSeconds,float fRed,float fGreen,float fBlue,float fAlpha,bool bBackground) { FnTable.FadeToColor(fSeconds,fRed,fGreen,fBlue,fAlpha,bBackground); } + public HmdColor_t GetCurrentFadeColor(bool bBackground) + { + HmdColor_t result = FnTable.GetCurrentFadeColor(bBackground); + return result; + } public void FadeGrid(float fSeconds,bool bFadeIn) { FnTable.FadeGrid(fSeconds,bFadeIn); } + public float GetCurrentGridAlpha() + { + float result = FnTable.GetCurrentGridAlpha(); + return result; + } public EVRCompositorError SetSkyboxOverride(Texture_t [] pTextures) { EVRCompositorError result = FnTable.SetSkyboxOverride(pTextures,(uint) pTextures.Length); @@ -1877,6 +2327,44 @@ public void SuspendRendering(bool bSuspend) { FnTable.SuspendRendering(bSuspend); } + public EVRCompositorError GetMirrorTextureD3D11(EVREye eEye,IntPtr pD3D11DeviceOrResource,ref IntPtr ppD3D11ShaderResourceView) + { + EVRCompositorError result = FnTable.GetMirrorTextureD3D11(eEye,pD3D11DeviceOrResource,ref ppD3D11ShaderResourceView); + return result; + } + public void ReleaseMirrorTextureD3D11(IntPtr pD3D11ShaderResourceView) + { + FnTable.ReleaseMirrorTextureD3D11(pD3D11ShaderResourceView); + } + public EVRCompositorError GetMirrorTextureGL(EVREye eEye,ref uint pglTextureId,IntPtr pglSharedTextureHandle) + { + pglTextureId = 0; + EVRCompositorError result = FnTable.GetMirrorTextureGL(eEye,ref pglTextureId,pglSharedTextureHandle); + return result; + } + public bool ReleaseSharedGLTexture(uint glTextureId,IntPtr glSharedTextureHandle) + { + bool result = FnTable.ReleaseSharedGLTexture(glTextureId,glSharedTextureHandle); + return result; + } + public void LockGLSharedTextureForAccess(IntPtr glSharedTextureHandle) + { + FnTable.LockGLSharedTextureForAccess(glSharedTextureHandle); + } + public void UnlockGLSharedTextureForAccess(IntPtr glSharedTextureHandle) + { + FnTable.UnlockGLSharedTextureForAccess(glSharedTextureHandle); + } + public uint GetVulkanInstanceExtensionsRequired(System.Text.StringBuilder pchValue,uint unBufferSize) + { + uint result = FnTable.GetVulkanInstanceExtensionsRequired(pchValue,unBufferSize); + return result; + } + public uint GetVulkanDeviceExtensionsRequired(IntPtr pPhysicalDevice,System.Text.StringBuilder pchValue,uint unBufferSize) + { + uint result = FnTable.GetVulkanDeviceExtensionsRequired(pPhysicalDevice,pchValue,unBufferSize); + return result; + } } @@ -1934,7 +2422,7 @@ public EVROverlayError GetOverlayImageData(ulong ulOverlayHandle,IntPtr pvBuffer public string GetOverlayErrorNameFromEnum(EVROverlayError error) { IntPtr result = FnTable.GetOverlayErrorNameFromEnum(error); - return (string) Marshal.PtrToStructure(result, typeof(string)); + return Marshal.PtrToStringAnsi(result); } public EVROverlayError SetOverlayRenderingPid(ulong ulOverlayHandle,uint unPID) { @@ -1981,6 +2469,28 @@ public EVROverlayError GetOverlayAlpha(ulong ulOverlayHandle,ref float pfAlpha) EVROverlayError result = FnTable.GetOverlayAlpha(ulOverlayHandle,ref pfAlpha); return result; } + public EVROverlayError SetOverlayTexelAspect(ulong ulOverlayHandle,float fTexelAspect) + { + EVROverlayError result = FnTable.SetOverlayTexelAspect(ulOverlayHandle,fTexelAspect); + return result; + } + public EVROverlayError GetOverlayTexelAspect(ulong ulOverlayHandle,ref float pfTexelAspect) + { + pfTexelAspect = 0; + EVROverlayError result = FnTable.GetOverlayTexelAspect(ulOverlayHandle,ref pfTexelAspect); + return result; + } + public EVROverlayError SetOverlaySortOrder(ulong ulOverlayHandle,uint unSortOrder) + { + EVROverlayError result = FnTable.SetOverlaySortOrder(ulOverlayHandle,unSortOrder); + return result; + } + public EVROverlayError GetOverlaySortOrder(ulong ulOverlayHandle,ref uint punSortOrder) + { + punSortOrder = 0; + EVROverlayError result = FnTable.GetOverlaySortOrder(ulOverlayHandle,ref punSortOrder); + return result; + } public EVROverlayError SetOverlayWidthInMeters(ulong ulOverlayHandle,float fWidthInMeters) { EVROverlayError result = FnTable.SetOverlayWidthInMeters(ulOverlayHandle,fWidthInMeters); @@ -2161,12 +2671,12 @@ public EVROverlayError SetOverlayFromFile(ulong ulOverlayHandle,string pchFilePa EVROverlayError result = FnTable.SetOverlayFromFile(ulOverlayHandle,pchFilePath); return result; } - public EVROverlayError GetOverlayTexture(ulong ulOverlayHandle,ref IntPtr pNativeTextureHandle,IntPtr pNativeTextureRef,ref uint pWidth,ref uint pHeight,ref uint pNativeFormat,ref EGraphicsAPIConvention pAPI,ref EColorSpace pColorSpace) + public EVROverlayError GetOverlayTexture(ulong ulOverlayHandle,ref IntPtr pNativeTextureHandle,IntPtr pNativeTextureRef,ref uint pWidth,ref uint pHeight,ref uint pNativeFormat,ref ETextureType pAPIType,ref EColorSpace pColorSpace,ref VRTextureBounds_t pTextureBounds) { pWidth = 0; pHeight = 0; pNativeFormat = 0; - EVROverlayError result = FnTable.GetOverlayTexture(ulOverlayHandle,ref pNativeTextureHandle,pNativeTextureRef,ref pWidth,ref pHeight,ref pNativeFormat,ref pAPI,ref pColorSpace); + EVROverlayError result = FnTable.GetOverlayTexture(ulOverlayHandle,ref pNativeTextureHandle,pNativeTextureRef,ref pWidth,ref pHeight,ref pNativeFormat,ref pAPIType,ref pColorSpace,ref pTextureBounds); return result; } public EVROverlayError ReleaseNativeOverlayHandle(ulong ulOverlayHandle,IntPtr pNativeTextureHandle) @@ -2174,6 +2684,13 @@ public EVROverlayError ReleaseNativeOverlayHandle(ulong ulOverlayHandle,IntPtr p EVROverlayError result = FnTable.ReleaseNativeOverlayHandle(ulOverlayHandle,pNativeTextureHandle); return result; } + public EVROverlayError GetOverlayTextureSize(ulong ulOverlayHandle,ref uint pWidth,ref uint pHeight) + { + pWidth = 0; + pHeight = 0; + EVROverlayError result = FnTable.GetOverlayTextureSize(ulOverlayHandle,ref pWidth,ref pHeight); + return result; + } public EVROverlayError CreateDashboardOverlay(string pchOverlayKey,string pchOverlayFriendlyName,ref ulong pMainHandle,ref ulong pThumbnailHandle) { pMainHandle = 0; @@ -2238,6 +2755,22 @@ public void SetKeyboardPositionForOverlay(ulong ulOverlayHandle,HmdRect2_t avoid { FnTable.SetKeyboardPositionForOverlay(ulOverlayHandle,avoidRect); } + public EVROverlayError SetOverlayIntersectionMask(ulong ulOverlayHandle,ref VROverlayIntersectionMaskPrimitive_t pMaskPrimitives,uint unNumMaskPrimitives,uint unPrimitiveSize) + { + EVROverlayError result = FnTable.SetOverlayIntersectionMask(ulOverlayHandle,ref pMaskPrimitives,unNumMaskPrimitives,unPrimitiveSize); + return result; + } + public EVROverlayError GetOverlayFlags(ulong ulOverlayHandle,ref uint pFlags) + { + pFlags = 0; + EVROverlayError result = FnTable.GetOverlayFlags(ulOverlayHandle,ref pFlags); + return result; + } + public VRMessageOverlayResponse ShowMessageOverlay(string pchText,string pchCaption,string pchButton0Text,string pchButton1Text,string pchButton2Text,string pchButton3Text) + { + VRMessageOverlayResponse result = FnTable.ShowMessageOverlay(pchText,pchCaption,pchButton0Text,pchButton1Text,pchButton2Text,pchButton3Text); + return result; + } } @@ -2310,8 +2843,32 @@ public uint GetComponentRenderModelName(string pchRenderModelName,string pchComp uint result = FnTable.GetComponentRenderModelName(pchRenderModelName,pchComponentName,pchComponentRenderModelName,unComponentRenderModelNameLen); return result; } +// This is a terrible hack to workaround the fact that VRControllerState_t was +// originally mis-compiled with the wrong packing for Linux and OSX. + [UnmanagedFunctionPointer(CallingConvention.StdCall)] + internal delegate bool _GetComponentStatePacked(string pchRenderModelName,string pchComponentName,ref VRControllerState_t_Packed pControllerState,ref RenderModel_ControllerMode_State_t pState,ref RenderModel_ComponentState_t pComponentState); + [StructLayout(LayoutKind.Explicit)] + struct GetComponentStateUnion + { + [FieldOffset(0)] + public IVRRenderModels._GetComponentState pGetComponentState; + [FieldOffset(0)] + public _GetComponentStatePacked pGetComponentStatePacked; + } public bool GetComponentState(string pchRenderModelName,string pchComponentName,ref VRControllerState_t pControllerState,ref RenderModel_ControllerMode_State_t pState,ref RenderModel_ComponentState_t pComponentState) { + if ((System.Environment.OSVersion.Platform == System.PlatformID.MacOSX) || + (System.Environment.OSVersion.Platform == System.PlatformID.Unix)) + { + GetComponentStateUnion u; + VRControllerState_t_Packed state_packed = new VRControllerState_t_Packed(); + u.pGetComponentStatePacked = null; + u.pGetComponentState = FnTable.GetComponentState; + bool packed_result = u.pGetComponentStatePacked(pchRenderModelName,pchComponentName,ref state_packed,ref pState,ref pComponentState); + + state_packed.Unpack(ref pControllerState); + return packed_result; + } bool result = FnTable.GetComponentState(pchRenderModelName,pchComponentName,ref pControllerState,ref pState,ref pComponentState); return result; } @@ -2320,6 +2877,21 @@ public bool RenderModelHasComponent(string pchRenderModelName,string pchComponen bool result = FnTable.RenderModelHasComponent(pchRenderModelName,pchComponentName); return result; } + public uint GetRenderModelThumbnailURL(string pchRenderModelName,System.Text.StringBuilder pchThumbnailURL,uint unThumbnailURLLen,ref EVRRenderModelError peError) + { + uint result = FnTable.GetRenderModelThumbnailURL(pchRenderModelName,pchThumbnailURL,unThumbnailURLLen,ref peError); + return result; + } + public uint GetRenderModelOriginalPath(string pchRenderModelName,System.Text.StringBuilder pchOriginalPath,uint unOriginalPathLen,ref EVRRenderModelError peError) + { + uint result = FnTable.GetRenderModelOriginalPath(pchRenderModelName,pchOriginalPath,unOriginalPathLen,ref peError); + return result; + } + public string GetRenderModelErrorNameFromEnum(EVRRenderModelError error) + { + IntPtr result = FnTable.GetRenderModelErrorNameFromEnum(error); + return Marshal.PtrToStringAnsi(result); + } } @@ -2354,47 +2926,47 @@ internal CVRSettings(IntPtr pInterface) public string GetSettingsErrorNameFromEnum(EVRSettingsError eError) { IntPtr result = FnTable.GetSettingsErrorNameFromEnum(eError); - return (string) Marshal.PtrToStructure(result, typeof(string)); + return Marshal.PtrToStringAnsi(result); } public bool Sync(bool bForce,ref EVRSettingsError peError) { bool result = FnTable.Sync(bForce,ref peError); return result; } - public bool GetBool(string pchSection,string pchSettingsKey,bool bDefaultValue,ref EVRSettingsError peError) - { - bool result = FnTable.GetBool(pchSection,pchSettingsKey,bDefaultValue,ref peError); - return result; - } public void SetBool(string pchSection,string pchSettingsKey,bool bValue,ref EVRSettingsError peError) { FnTable.SetBool(pchSection,pchSettingsKey,bValue,ref peError); } - public int GetInt32(string pchSection,string pchSettingsKey,int nDefaultValue,ref EVRSettingsError peError) - { - int result = FnTable.GetInt32(pchSection,pchSettingsKey,nDefaultValue,ref peError); - return result; - } public void SetInt32(string pchSection,string pchSettingsKey,int nValue,ref EVRSettingsError peError) { FnTable.SetInt32(pchSection,pchSettingsKey,nValue,ref peError); } - public float GetFloat(string pchSection,string pchSettingsKey,float flDefaultValue,ref EVRSettingsError peError) + public void SetFloat(string pchSection,string pchSettingsKey,float flValue,ref EVRSettingsError peError) + { + FnTable.SetFloat(pchSection,pchSettingsKey,flValue,ref peError); + } + public void SetString(string pchSection,string pchSettingsKey,string pchValue,ref EVRSettingsError peError) + { + FnTable.SetString(pchSection,pchSettingsKey,pchValue,ref peError); + } + public bool GetBool(string pchSection,string pchSettingsKey,ref EVRSettingsError peError) { - float result = FnTable.GetFloat(pchSection,pchSettingsKey,flDefaultValue,ref peError); + bool result = FnTable.GetBool(pchSection,pchSettingsKey,ref peError); return result; } - public void SetFloat(string pchSection,string pchSettingsKey,float flValue,ref EVRSettingsError peError) + public int GetInt32(string pchSection,string pchSettingsKey,ref EVRSettingsError peError) { - FnTable.SetFloat(pchSection,pchSettingsKey,flValue,ref peError); + int result = FnTable.GetInt32(pchSection,pchSettingsKey,ref peError); + return result; } - public void GetString(string pchSection,string pchSettingsKey,string pchValue,uint unValueLen,string pchDefaultValue,ref EVRSettingsError peError) + public float GetFloat(string pchSection,string pchSettingsKey,ref EVRSettingsError peError) { - FnTable.GetString(pchSection,pchSettingsKey,pchValue,unValueLen,pchDefaultValue,ref peError); + float result = FnTable.GetFloat(pchSection,pchSettingsKey,ref peError); + return result; } - public void SetString(string pchSection,string pchSettingsKey,string pchValue,ref EVRSettingsError peError) + public void GetString(string pchSection,string pchSettingsKey,System.Text.StringBuilder pchValue,uint unValueLen,ref EVRSettingsError peError) { - FnTable.SetString(pchSection,pchSettingsKey,pchValue,ref peError); + FnTable.GetString(pchSection,pchSettingsKey,pchValue,unValueLen,ref peError); } public void RemoveSection(string pchSection,ref EVRSettingsError peError) { @@ -2407,23 +2979,90 @@ public void RemoveKeyInSection(string pchSection,string pchSettingsKey,ref EVRSe } +public class CVRScreenshots +{ + IVRScreenshots FnTable; + internal CVRScreenshots(IntPtr pInterface) + { + FnTable = (IVRScreenshots)Marshal.PtrToStructure(pInterface, typeof(IVRScreenshots)); + } + public EVRScreenshotError RequestScreenshot(ref uint pOutScreenshotHandle,EVRScreenshotType type,string pchPreviewFilename,string pchVRFilename) + { + pOutScreenshotHandle = 0; + EVRScreenshotError result = FnTable.RequestScreenshot(ref pOutScreenshotHandle,type,pchPreviewFilename,pchVRFilename); + return result; + } + public EVRScreenshotError HookScreenshot(EVRScreenshotType [] pSupportedTypes) + { + EVRScreenshotError result = FnTable.HookScreenshot(pSupportedTypes,(int) pSupportedTypes.Length); + return result; + } + public EVRScreenshotType GetScreenshotPropertyType(uint screenshotHandle,ref EVRScreenshotError pError) + { + EVRScreenshotType result = FnTable.GetScreenshotPropertyType(screenshotHandle,ref pError); + return result; + } + public uint GetScreenshotPropertyFilename(uint screenshotHandle,EVRScreenshotPropertyFilenames filenameType,System.Text.StringBuilder pchFilename,uint cchFilename,ref EVRScreenshotError pError) + { + uint result = FnTable.GetScreenshotPropertyFilename(screenshotHandle,filenameType,pchFilename,cchFilename,ref pError); + return result; + } + public EVRScreenshotError UpdateScreenshotProgress(uint screenshotHandle,float flProgress) + { + EVRScreenshotError result = FnTable.UpdateScreenshotProgress(screenshotHandle,flProgress); + return result; + } + public EVRScreenshotError TakeStereoScreenshot(ref uint pOutScreenshotHandle,string pchPreviewFilename,string pchVRFilename) + { + pOutScreenshotHandle = 0; + EVRScreenshotError result = FnTable.TakeStereoScreenshot(ref pOutScreenshotHandle,pchPreviewFilename,pchVRFilename); + return result; + } + public EVRScreenshotError SubmitScreenshot(uint screenshotHandle,EVRScreenshotType type,string pchSourcePreviewFilename,string pchSourceVRFilename) + { + EVRScreenshotError result = FnTable.SubmitScreenshot(screenshotHandle,type,pchSourcePreviewFilename,pchSourceVRFilename); + return result; + } +} + + +public class CVRResources +{ + IVRResources FnTable; + internal CVRResources(IntPtr pInterface) + { + FnTable = (IVRResources)Marshal.PtrToStructure(pInterface, typeof(IVRResources)); + } + public uint LoadSharedResource(string pchResourceName,string pchBuffer,uint unBufferLen) + { + uint result = FnTable.LoadSharedResource(pchResourceName,pchBuffer,unBufferLen); + return result; + } + public uint GetResourceFullPath(string pchResourceName,string pchResourceTypeDirectory,string pchPathBuffer,uint unBufferLen) + { + uint result = FnTable.GetResourceFullPath(pchResourceName,pchResourceTypeDirectory,pchPathBuffer,unBufferLen); + return result; + } +} + + public class OpenVRInterop { - [DllImportAttribute("openvr_api", EntryPoint = "VR_InitInternal")] + [DllImportAttribute("openvr_api", EntryPoint = "VR_InitInternal", CallingConvention = CallingConvention.Cdecl)] internal static extern uint InitInternal(ref EVRInitError peError, EVRApplicationType eApplicationType); - [DllImportAttribute("openvr_api", EntryPoint = "VR_ShutdownInternal")] + [DllImportAttribute("openvr_api", EntryPoint = "VR_ShutdownInternal", CallingConvention = CallingConvention.Cdecl)] internal static extern void ShutdownInternal(); - [DllImportAttribute("openvr_api", EntryPoint = "VR_IsHmdPresent")] + [DllImportAttribute("openvr_api", EntryPoint = "VR_IsHmdPresent", CallingConvention = CallingConvention.Cdecl)] internal static extern bool IsHmdPresent(); - [DllImportAttribute("openvr_api", EntryPoint = "VR_IsRuntimeInstalled")] + [DllImportAttribute("openvr_api", EntryPoint = "VR_IsRuntimeInstalled", CallingConvention = CallingConvention.Cdecl)] internal static extern bool IsRuntimeInstalled(); - [DllImportAttribute("openvr_api", EntryPoint = "VR_GetStringForHmdError")] + [DllImportAttribute("openvr_api", EntryPoint = "VR_GetStringForHmdError", CallingConvention = CallingConvention.Cdecl)] internal static extern IntPtr GetStringForHmdError(EVRInitError error); - [DllImportAttribute("openvr_api", EntryPoint = "VR_GetGenericInterface")] + [DllImportAttribute("openvr_api", EntryPoint = "VR_GetGenericInterface", CallingConvention = CallingConvention.Cdecl)] internal static extern IntPtr GetGenericInterface([In, MarshalAs(UnmanagedType.LPStr)] string pchInterfaceVersion, ref EVRInitError peError); - [DllImportAttribute("openvr_api", EntryPoint = "VR_IsInterfaceVersionValid")] + [DllImportAttribute("openvr_api", EntryPoint = "VR_IsInterfaceVersionValid", CallingConvention = CallingConvention.Cdecl)] internal static extern bool IsInterfaceVersionValid([In, MarshalAs(UnmanagedType.LPStr)] string pchInterfaceVersion); - [DllImportAttribute("openvr_api", EntryPoint = "VR_GetInitToken")] + [DllImportAttribute("openvr_api", EntryPoint = "VR_GetInitToken", CallingConvention = CallingConvention.Cdecl)] internal static extern uint GetInitToken(); } @@ -2433,10 +3072,13 @@ public enum EVREye Eye_Left = 0, Eye_Right = 1, } -public enum EGraphicsAPIConvention +public enum ETextureType { - API_DirectX = 0, - API_OpenGL = 1, + DirectX = 0, + OpenGL = 1, + Vulkan = 2, + IOSurface = 3, + DirectX12 = 4, } public enum EColorSpace { @@ -2457,8 +3099,8 @@ public enum ETrackedDeviceClass Invalid = 0, HMD = 1, Controller = 2, + GenericTracker = 3, TrackingReference = 4, - Other = 1000, } public enum ETrackedControllerRole { @@ -2474,6 +3116,7 @@ public enum ETrackingUniverseOrigin } public enum ETrackedDeviceProperty { + Prop_Invalid = 0, Prop_TrackingSystemName_String = 1000, Prop_ModelNumber_String = 1001, Prop_SerialNumber_String = 1002, @@ -2507,6 +3150,8 @@ public enum ETrackedDeviceProperty Prop_HasCamera_Bool = 1030, Prop_DriverVersion_String = 1031, Prop_Firmware_ForceUpdateRequired_Bool = 1032, + Prop_ViveSystemButtonFixRequired_Bool = 1033, + Prop_ParentDriver_Uint64 = 1034, Prop_ReportsTimeSinceVSync_Bool = 2000, Prop_SecondsFromVsyncToPhotons_Float = 2001, Prop_DisplayFrequency_Float = 2002, @@ -2541,6 +3186,15 @@ public enum ETrackedDeviceProperty Prop_DisplayHardwareVersion_Uint64 = 2031, Prop_AudioFirmwareVersion_Uint64 = 2032, Prop_CameraCompatibilityMode_Int32 = 2033, + Prop_ScreenshotHorizontalFieldOfViewDegrees_Float = 2034, + Prop_ScreenshotVerticalFieldOfViewDegrees_Float = 2035, + Prop_DisplaySuppressed_Bool = 2036, + Prop_DisplayAllowNightMode_Bool = 2037, + Prop_DisplayMCImageWidth_Int32 = 2038, + Prop_DisplayMCImageHeight_Int32 = 2039, + Prop_DisplayMCImageNumChannels_Int32 = 2040, + Prop_DisplayMCImageData_Binary = 2041, + Prop_UsesDriverDirectMode_Bool = 2042, Prop_AttachedDeviceId_String = 3000, Prop_SupportedButtons_Uint64 = 3001, Prop_Axis0Type_Int32 = 3002, @@ -2548,6 +3202,7 @@ public enum ETrackedDeviceProperty Prop_Axis2Type_Int32 = 3004, Prop_Axis3Type_Int32 = 3005, Prop_Axis4Type_Int32 = 3006, + Prop_ControllerRoleHint_Int32 = 3007, Prop_FieldOfViewLeftDegrees_Float = 4000, Prop_FieldOfViewRightDegrees_Float = 4001, Prop_FieldOfViewTopDegrees_Float = 4002, @@ -2555,6 +3210,19 @@ public enum ETrackedDeviceProperty Prop_TrackingRangeMinimumMeters_Float = 4004, Prop_TrackingRangeMaximumMeters_Float = 4005, Prop_ModeLabel_String = 4006, + Prop_IconPathName_String = 5000, + Prop_NamedIconPathDeviceOff_String = 5001, + Prop_NamedIconPathDeviceSearching_String = 5002, + Prop_NamedIconPathDeviceSearchingAlert_String = 5003, + Prop_NamedIconPathDeviceReady_String = 5004, + Prop_NamedIconPathDeviceReadyAlert_String = 5005, + Prop_NamedIconPathDeviceNotReady_String = 5006, + Prop_NamedIconPathDeviceStandby_String = 5007, + Prop_NamedIconPathDeviceAlertLow_String = 5008, + Prop_DisplayHiddenArea_Binary_Start = 5100, + Prop_DisplayHiddenArea_Binary_End = 5150, + Prop_UserConfigPath_String = 6000, + Prop_InstallPath_String = 6001, Prop_VendorSpecific_Reserved_Start = 10000, Prop_VendorSpecific_Reserved_End = 10999, } @@ -2570,12 +3238,15 @@ public enum ETrackedPropertyError TrackedProp_ValueNotProvidedByDevice = 7, TrackedProp_StringExceedsMaximumLength = 8, TrackedProp_NotYetAvailable = 9, + TrackedProp_PermissionDenied = 10, + TrackedProp_InvalidOperation = 11, } public enum EVRSubmitFlags { Submit_Default = 0, Submit_LensDistortionAlreadyApplied = 1, Submit_GlRenderBuffer = 2, + Submit_Reserved = 4, } public enum EVRState { @@ -2587,6 +3258,7 @@ public enum EVRState Ready_Alert = 4, NotReady = 5, Standby = 6, + Ready_Alert_Low = 7, } public enum EVREventType { @@ -2600,6 +3272,9 @@ public enum EVREventType VREvent_EnterStandbyMode = 106, VREvent_LeaveStandbyMode = 107, VREvent_TrackedDeviceRoleChanged = 108, + VREvent_WatchdogWakeUpRequested = 109, + VREvent_LensDistortionChanged = 110, + VREvent_PropertyChanged = 111, VREvent_ButtonPress = 200, VREvent_ButtonUnpress = 201, VREvent_ButtonTouch = 202, @@ -2611,6 +3286,7 @@ public enum EVREventType VREvent_FocusLeave = 304, VREvent_Scroll = 305, VREvent_TouchPadMove = 306, + VREvent_OverlayFocusChanged = 307, VREvent_InputFocusCaptured = 400, VREvent_InputFocusReleased = 401, VREvent_SceneFocusLost = 402, @@ -2618,6 +3294,7 @@ public enum EVREventType VREvent_SceneApplicationChanged = 404, VREvent_SceneFocusChanged = 405, VREvent_InputFocusChanged = 406, + VREvent_SceneApplicationSecondaryRenderingStarted = 407, VREvent_HideRenderModels = 410, VREvent_ShowRenderModels = 411, VREvent_OverlayShown = 500, @@ -2636,6 +3313,15 @@ public enum EVREventType VREvent_OverlaySharedTextureChanged = 513, VREvent_DashboardGuideButtonDown = 514, VREvent_DashboardGuideButtonUp = 515, + VREvent_ScreenshotTriggered = 516, + VREvent_ImageFailed = 517, + VREvent_DashboardOverlayCreated = 518, + VREvent_RequestScreenshot = 520, + VREvent_ScreenshotTaken = 521, + VREvent_ScreenshotFailed = 522, + VREvent_SubmitScreenshotToDashboard = 523, + VREvent_ScreenshotProgressToDashboard = 524, + VREvent_PrimaryDashboardDeviceChanged = 525, VREvent_Notification_Shown = 600, VREvent_Notification_Hidden = 601, VREvent_Notification_BeginInteraction = 602, @@ -2654,6 +3340,9 @@ public enum EVREventType VREvent_BackgroundSettingHasChanged = 850, VREvent_CameraSettingsHaveChanged = 851, VREvent_ReprojectionSettingHasChanged = 852, + VREvent_ModelSkinSettingsHaveChanged = 853, + VREvent_EnvironmentSettingsHaveChanged = 854, + VREvent_PowerSettingsHaveChanged = 855, VREvent_StatusUpdate = 900, VREvent_MCImageUpdated = 1000, VREvent_FirmwareUpdateStarted = 1100, @@ -2664,6 +3353,9 @@ public enum EVREventType VREvent_ApplicationTransitionStarted = 1300, VREvent_ApplicationTransitionAborted = 1301, VREvent_ApplicationTransitionNewAppStarted = 1302, + VREvent_ApplicationListUpdated = 1303, + VREvent_ApplicationMimeTypeLoad = 1304, + VREvent_ApplicationTransitionNewAppLaunchComplete = 1305, VREvent_Compositor_MirrorWindowShown = 1400, VREvent_Compositor_MirrorWindowHidden = 1401, VREvent_Compositor_ChaperoneBoundsShown = 1410, @@ -2672,9 +3364,11 @@ public enum EVREventType VREvent_TrackedCamera_StopVideoStream = 1501, VREvent_TrackedCamera_PauseVideoStream = 1502, VREvent_TrackedCamera_ResumeVideoStream = 1503, + VREvent_TrackedCamera_EditingSurface = 1550, VREvent_PerformanceTest_EnableCapture = 1600, VREvent_PerformanceTest_DisableCapture = 1601, VREvent_PerformanceTest_FidelityLevel = 1602, + VREvent_MessageOverlay_Closed = 1650, VREvent_VendorSpecific_Reserved_Start = 10000, VREvent_VendorSpecific_Reserved_End = 19999, } @@ -2696,6 +3390,7 @@ public enum EVRButtonId k_EButton_DPad_Right = 5, k_EButton_DPad_Down = 6, k_EButton_A = 7, + k_EButton_ProximitySensor = 31, k_EButton_Axis0 = 32, k_EButton_Axis1 = 33, k_EButton_Axis2 = 34, @@ -2712,6 +3407,13 @@ public enum EVRMouseButton Right = 2, Middle = 4, } +public enum EHiddenAreaMeshType +{ + k_eHiddenAreaMesh_Standard = 0, + k_eHiddenAreaMesh_Inverse = 1, + k_eHiddenAreaMesh_LineLoop = 2, + k_eHiddenAreaMesh_Max = 3, +} public enum EVRControllerAxisType { k_eControllerAxis_None = 0, @@ -2752,8 +3454,10 @@ public enum EVROverlayError RequestFailed = 23, InvalidTexture = 24, UnableToLoadFile = 25, - VROVerlayError_KeyboardAlreadyInUse = 26, + KeyboardAlreadyInUse = 26, NoNeighbor = 27, + TooManyMaskPrimitives = 29, + BadMaskPrimitive = 30, } public enum EVRApplicationType { @@ -2763,6 +3467,8 @@ public enum EVRApplicationType VRApplication_Background = 3, VRApplication_Utility = 4, VRApplication_VRMonitor = 5, + VRApplication_SteamWatchdog = 6, + VRApplication_Max = 7, } public enum EVRFirmwareError { @@ -2776,6 +3482,7 @@ public enum EVRNotificationError InvalidNotificationId = 100, NotificationQueueFull = 101, InvalidOverlayHandle = 102, + SystemWithUserValueAlreadyExists = 103, } public enum EVRInitError { @@ -2806,6 +3513,16 @@ public enum EVRInitError Init_NotSupportedWithCompositor = 122, Init_NotAvailableToUtilityApps = 123, Init_Internal = 124, + Init_HmdDriverIdIsNone = 125, + Init_HmdNotFoundPresenceFailed = 126, + Init_VRMonitorNotFound = 127, + Init_VRMonitorStartupFailed = 128, + Init_LowPowerWatchdogNotSupported = 129, + Init_InvalidApplicationType = 130, + Init_NotAvailableToWatchdogApps = 131, + Init_WatchdogDisabledInSettings = 132, + Init_VRDashboardNotFound = 133, + Init_VRDashboardStartupFailed = 134, Driver_Failed = 200, Driver_Unknown = 201, Driver_HmdUnknown = 202, @@ -2815,15 +3532,23 @@ public enum EVRInitError Driver_NotCalibrated = 206, Driver_CalibrationInvalid = 207, Driver_HmdDisplayNotFound = 208, + Driver_TrackedDeviceInterfaceUnknown = 209, + Driver_HmdDriverIdOutOfBounds = 211, + Driver_HmdDisplayMirrored = 212, IPC_ServerInitFailed = 300, IPC_ConnectFailed = 301, IPC_SharedStateInitFailed = 302, IPC_CompositorInitFailed = 303, IPC_MutexInitFailed = 304, IPC_Failed = 305, + IPC_CompositorConnectFailed = 306, + IPC_CompositorInvalidConnectResponse = 307, + IPC_ConnectFailedAfterMultipleAttempts = 308, Compositor_Failed = 400, Compositor_D3D11HardwareRequired = 401, Compositor_FirmwareRequiresUpdate = 402, + Compositor_OverlayInitFailed = 403, + Compositor_ScreenshotsInitFailed = 404, VendorSpecific_UnableToConnectToOculusRuntime = 1000, VendorSpecific_HmdFound_CantOpenDevice = 1101, VendorSpecific_HmdFound_UnableToRequestConfigStart = 1102, @@ -2840,6 +3565,47 @@ public enum EVRInitError VendorSpecific_HmdFound_ConfigFailedSanityCheck = 1113, Steam_SteamInstallationNotFound = 2000, } +public enum EVRScreenshotType +{ + None = 0, + Mono = 1, + Stereo = 2, + Cubemap = 3, + MonoPanorama = 4, + StereoPanorama = 5, +} +public enum EVRScreenshotPropertyFilenames +{ + Preview = 0, + VR = 1, +} +public enum EVRTrackedCameraError +{ + None = 0, + OperationFailed = 100, + InvalidHandle = 101, + InvalidFrameHeaderVersion = 102, + OutOfHandles = 103, + IPCFailure = 104, + NotSupportedForThisDevice = 105, + SharedMemoryFailure = 106, + FrameBufferingFailure = 107, + StreamSetupFailure = 108, + InvalidGLTextureId = 109, + InvalidSharedTextureHandle = 110, + FailedToGetGLTextureId = 111, + SharedTextureFailure = 112, + NoFrameAvailable = 113, + InvalidArgument = 114, + InvalidFrameBufferSize = 115, +} +public enum EVRTrackedCameraFrameType +{ + Distorted = 0, + Undistorted = 1, + MaximumUndistorted = 2, + MAX_CAMERA_FRAME_TYPES = 3, +} public enum EVRApplicationError { None = 0, @@ -2878,6 +3644,7 @@ public enum EVRApplicationProperty IsDashboardOverlay_Bool = 60, IsTemplate_Bool = 61, IsInstanced_Bool = 62, + IsInternal_Bool = 63, LastLaunchTime_Uint64 = 70, } public enum EVRApplicationTransitionState @@ -2895,7 +3662,7 @@ public enum ChaperoneCalibrationState Warning_BaseStationRemoved = 102, Warning_SeatedBoundsInvalid = 103, Error = 200, - Error_BaseStationUninitalized = 201, + Error_BaseStationUninitialized = 201, Error_BaseStationConflict = 202, Error_PlayAreaInvalid = 203, Error_CollisionBoundsInvalid = 204, @@ -2912,6 +3679,7 @@ public enum EChaperoneImportFlags public enum EVRCompositorError { None = 0, + RequestFailed = 1, IncompatibleVersion = 100, DoNotHaveFocus = 101, InvalidTexture = 102, @@ -2920,6 +3688,7 @@ public enum EVRCompositorError TextureUsesUnsupportedFormat = 105, SharedTexturesNotSupported = 106, IndexOutOfRange = 107, + AlreadySubmitted = 108, } public enum VROverlayInputMethod { @@ -2945,6 +3714,22 @@ public enum VROverlayFlags SendVRTouchpadEvents = 7, ShowTouchPadScrollWheel = 8, TransferOwnershipToInternalProcess = 9, + SideBySide_Parallel = 10, + SideBySide_Crossed = 11, + Panorama = 12, + StereoPanorama = 13, + SortWithNonSceneOverlays = 14, + VisibleInDashboard = 15, +} +public enum VRMessageOverlayResponse +{ + ButtonPress_0 = 0, + ButtonPress_1 = 1, + ButtonPress_2 = 2, + ButtonPress_3 = 3, + CouldntFindSystemOverlay = 4, + CouldntFindOrCreateClientOverlay = 5, + ApplicationQuit = 6, } public enum EGamepadTextInputMode { @@ -2965,6 +3750,11 @@ public enum EOverlayDirection Right = 3, Count = 4, } +public enum EVROverlayIntersectionMaskPrimitiveType +{ + OverlayIntersectionPrimitiveType_Rectangle = 0, + OverlayIntersectionPrimitiveType_Circle = 1, +} public enum EVRRenderModelError { None = 0, @@ -2974,8 +3764,11 @@ public enum EVRRenderModelError InvalidModel = 301, NoShapes = 302, MultipleShapes = 303, - TooManyIndices = 304, + TooManyVertices = 304, MultipleTextures = 305, + BufferTooSmall = 306, + NotEnoughNormals = 307, + NotEnoughTexCoords = 308, InvalidTexture = 400, } public enum EVRComponentProperty @@ -2990,6 +3783,7 @@ public enum EVRNotificationType { Transient = 0, Persistent = 1, + Transient_SystemWithUserValue = 2, } public enum EVRNotificationStyle { @@ -3005,6 +3799,17 @@ public enum EVRSettingsError IPCFailed = 1, WriteFailed = 2, ReadFailed = 3, + JsonParseFailed = 4, + UnsetSettingHasNoDefault = 5, +} +public enum EVRScreenshotError +{ + None = 0, + RequestFailed = 1, + IncompatibleVersion = 100, + NotFound = 101, + BufferTooSmall = 102, + ScreenshotAlreadyInProgress = 108, } [StructLayout(LayoutKind.Explicit)] public struct VREvent_Data_t @@ -3022,9 +3827,21 @@ public enum EVRSettingsError [FieldOffset(0)] public VREvent_PerformanceTest_t performanceTest; [FieldOffset(0)] public VREvent_TouchPadMove_t touchPadMove; [FieldOffset(0)] public VREvent_SeatedZeroPoseReset_t seatedZeroPoseReset; + [FieldOffset(0)] public VREvent_Screenshot_t screenshot; + [FieldOffset(0)] public VREvent_ScreenshotProgress_t screenshotProgress; + [FieldOffset(0)] public VREvent_ApplicationLaunch_t applicationLaunch; + [FieldOffset(0)] public VREvent_EditingCameraSurface_t cameraSurface; + [FieldOffset(0)] public VREvent_MessageOverlay_t messageOverlay; [FieldOffset(0)] public VREvent_Keyboard_t keyboard; // This has to be at the end due to a mono bug } + +[StructLayout(LayoutKind.Explicit)] public struct VROverlayIntersectionMaskPrimitive_Data_t +{ + [FieldOffset(0)] public IntersectionMaskRectangle_t m_Rectangle; + [FieldOffset(0)] public IntersectionMaskCircle_t m_Circle; +} + [StructLayout(LayoutKind.Sequential)] public struct HmdMatrix34_t { public float m0; //float[3][4] @@ -3121,7 +3938,7 @@ public enum EVRSettingsError [StructLayout(LayoutKind.Sequential)] public struct Texture_t { public IntPtr handle; // void * - public EGraphicsAPIConvention eType; + public ETextureType eType; public EColorSpace eColorSpace; } [StructLayout(LayoutKind.Sequential)] public struct TrackedDevicePose_t @@ -3142,6 +3959,25 @@ public enum EVRSettingsError public float uMax; public float vMax; } +[StructLayout(LayoutKind.Sequential)] public struct VRVulkanTextureData_t +{ + public ulong m_nImage; + public IntPtr m_pDevice; // struct VkDevice_T * + public IntPtr m_pPhysicalDevice; // struct VkPhysicalDevice_T * + public IntPtr m_pInstance; // struct VkInstance_T * + public IntPtr m_pQueue; // struct VkQueue_T * + public uint m_nQueueFamilyIndex; + public uint m_nWidth; + public uint m_nHeight; + public uint m_nFormat; + public uint m_nSampleCount; +} +[StructLayout(LayoutKind.Sequential)] public struct D3D12TextureData_t +{ + public IntPtr m_pResource; // struct ID3D12Resource * + public IntPtr m_pCommandQueue; // struct ID3D12CommandQueue * + public uint m_nNodeMask; +} [StructLayout(LayoutKind.Sequential)] public struct VREvent_Controller_t { public uint button; @@ -3216,6 +4052,34 @@ public enum EVRSettingsError [MarshalAs(UnmanagedType.I1)] public bool bResetBySystemMenu; } +[StructLayout(LayoutKind.Sequential)] public struct VREvent_Screenshot_t +{ + public uint handle; + public uint type; +} +[StructLayout(LayoutKind.Sequential)] public struct VREvent_ScreenshotProgress_t +{ + public float progress; +} +[StructLayout(LayoutKind.Sequential)] public struct VREvent_ApplicationLaunch_t +{ + public uint pid; + public uint unArgsHandle; +} +[StructLayout(LayoutKind.Sequential)] public struct VREvent_EditingCameraSurface_t +{ + public ulong overlayHandle; + public uint nVisualMode; +} +[StructLayout(LayoutKind.Sequential)] public struct VREvent_MessageOverlay_t +{ + public uint unVRMessageOverlayResponse; +} +[StructLayout(LayoutKind.Sequential)] public struct VREvent_Property_t +{ + public ulong container; + public ETrackedDeviceProperty prop; +} [StructLayout(LayoutKind.Sequential)] public struct VREvent_t { public uint eventType; @@ -3244,6 +4108,29 @@ public enum EVRSettingsError public VRControllerAxis_t rAxis3; public VRControllerAxis_t rAxis4; } +// This structure is for backwards binary compatibility on Linux and OSX only +[StructLayout(LayoutKind.Sequential, Pack = 4)] public struct VRControllerState_t_Packed +{ + public uint unPacketNum; + public ulong ulButtonPressed; + public ulong ulButtonTouched; + public VRControllerAxis_t rAxis0; //VRControllerAxis_t[5] + public VRControllerAxis_t rAxis1; + public VRControllerAxis_t rAxis2; + public VRControllerAxis_t rAxis3; + public VRControllerAxis_t rAxis4; + public void Unpack(ref VRControllerState_t unpacked) + { + unpacked.unPacketNum = this.unPacketNum; + unpacked.ulButtonPressed = this.ulButtonPressed; + unpacked.ulButtonTouched = this.ulButtonTouched; + unpacked.rAxis0 = this.rAxis0; + unpacked.rAxis1 = this.rAxis1; + unpacked.rAxis2 = this.rAxis2; + unpacked.rAxis3 = this.rAxis3; + unpacked.rAxis4 = this.rAxis4; + } +} [StructLayout(LayoutKind.Sequential)] public struct Compositor_OverlaySettings { public uint size; @@ -3263,6 +4150,15 @@ public enum EVRSettingsError public float gridScale; public HmdMatrix44_t transform; } +[StructLayout(LayoutKind.Sequential)] public struct CameraVideoStreamFrameHeader_t +{ + public EVRTrackedCameraFrameType eFrameType; + public uint nWidth; + public uint nHeight; + public uint nBytesPerPixel; + public uint nFrameSequence; + public TrackedDevicePose_t standingTrackedDevicePose; +} [StructLayout(LayoutKind.Sequential)] public struct AppOverrideKeys_t { public IntPtr pchKey; // const char * @@ -3273,9 +4169,12 @@ public enum EVRSettingsError public uint m_nSize; public uint m_nFrameIndex; public uint m_nNumFramePresents; + public uint m_nNumMisPresented; public uint m_nNumDroppedFrames; + public uint m_nReprojectionFlags; public double m_flSystemTimeInSeconds; - public float m_flSceneRenderGpuMs; + public float m_flPreSubmitGpuMs; + public float m_flPostSubmitGpuMs; public float m_flTotalRenderGpuMs; public float m_flCompositorRenderGpuMs; public float m_flCompositorRenderCpuMs; @@ -3291,8 +4190,24 @@ public enum EVRSettingsError public float m_flCompositorUpdateEndMs; public float m_flCompositorRenderStartMs; public TrackedDevicePose_t m_HmdPose; - public int m_nFidelityLevel; - public uint m_nReprojectionFlags; +} +[StructLayout(LayoutKind.Sequential)] public struct Compositor_CumulativeStats +{ + public uint m_nPid; + public uint m_nNumFramePresents; + public uint m_nNumDroppedFrames; + public uint m_nNumReprojectedFrames; + public uint m_nNumFramePresentsOnStartup; + public uint m_nNumDroppedFramesOnStartup; + public uint m_nNumReprojectedFramesOnStartup; + public uint m_nNumLoading; + public uint m_nNumFramePresentsLoading; + public uint m_nNumDroppedFramesLoading; + public uint m_nNumReprojectedFramesLoading; + public uint m_nNumTimedOut; + public uint m_nNumFramePresentsTimedOut; + public uint m_nNumDroppedFramesTimedOut; + public uint m_nNumReprojectedFramesTimedOut; } [StructLayout(LayoutKind.Sequential)] public struct VROverlayIntersectionParams_t { @@ -3307,6 +4222,24 @@ public enum EVRSettingsError public HmdVector2_t vUVs; public float fDistance; } +[StructLayout(LayoutKind.Sequential)] public struct IntersectionMaskRectangle_t +{ + public float m_flTopLeftX; + public float m_flTopLeftY; + public float m_flWidth; + public float m_flHeight; +} +[StructLayout(LayoutKind.Sequential)] public struct IntersectionMaskCircle_t +{ + public float m_flCenterX; + public float m_flCenterY; + public float m_flRadius; +} +[StructLayout(LayoutKind.Sequential)] public struct VROverlayIntersectionMaskPrimitive_t +{ + public EVROverlayIntersectionMaskPrimitiveType m_nPrimitiveType; + public VROverlayIntersectionMaskPrimitive_Data_t m_Primitive; +} [StructLayout(LayoutKind.Sequential)] public struct RenderModel_ComponentState_t { public HmdMatrix34_t mTrackingToComponentRenderModel; @@ -3326,6 +4259,19 @@ public enum EVRSettingsError public char unHeight; public IntPtr rubTextureMapData; // const uint8_t * } +// This structure is for backwards binary compatibility on Linux and OSX only +[StructLayout(LayoutKind.Sequential, Pack = 4)] public struct RenderModel_TextureMap_t_Packed +{ + public char unWidth; + public char unHeight; + public IntPtr rubTextureMapData; // const uint8_t * + public void Unpack(ref RenderModel_TextureMap_t unpacked) + { + unpacked.unWidth = this.unWidth; + unpacked.unHeight = this.unHeight; + unpacked.rubTextureMapData = this.rubTextureMapData; + } +} [StructLayout(LayoutKind.Sequential)] public struct RenderModel_t { public IntPtr rVertexData; // const struct vr::RenderModel_Vertex_t * @@ -3334,6 +4280,23 @@ public enum EVRSettingsError public uint unTriangleCount; public int diffuseTextureId; } +// This structure is for backwards binary compatibility on Linux and OSX only +[StructLayout(LayoutKind.Sequential, Pack = 4)] public struct RenderModel_t_Packed +{ + public IntPtr rVertexData; // const struct vr::RenderModel_Vertex_t * + public uint unVertexCount; + public IntPtr rIndexData; // const uint16_t * + public uint unTriangleCount; + public int diffuseTextureId; + public void Unpack(ref RenderModel_t unpacked) + { + unpacked.rVertexData = this.rVertexData; + unpacked.unVertexCount = this.unVertexCount; + unpacked.rIndexData = this.rIndexData; + unpacked.unTriangleCount = this.unTriangleCount; + unpacked.diffuseTextureId = this.diffuseTextureId; + } +} [StructLayout(LayoutKind.Sequential)] public struct RenderModel_ControllerMode_State_t { [MarshalAs(UnmanagedType.I1)] @@ -3341,10 +4304,10 @@ public enum EVRSettingsError } [StructLayout(LayoutKind.Sequential)] public struct NotificationBitmap_t { - public IntPtr bytes; // void * - public int width; - public int height; - public int depth; + public IntPtr m_pImageData; // void * + public int m_nWidth; + public int m_nHeight; + public int m_nBytesPerPixel; } [StructLayout(LayoutKind.Sequential)] public struct COpenVRContext { @@ -3353,10 +4316,13 @@ public enum EVRSettingsError public IntPtr m_pVRChaperoneSetup; // class vr::IVRChaperoneSetup * public IntPtr m_pVRCompositor; // class vr::IVRCompositor * public IntPtr m_pVROverlay; // class vr::IVROverlay * + public IntPtr m_pVRResources; // class vr::IVRResources * public IntPtr m_pVRRenderModels; // class vr::IVRRenderModels * public IntPtr m_pVRExtendedDisplay; // class vr::IVRExtendedDisplay * public IntPtr m_pVRSettings; // class vr::IVRSettings * public IntPtr m_pVRApplications; // class vr::IVRApplications * + public IntPtr m_pVRTrackedCamera; // class vr::IVRTrackedCamera * + public IntPtr m_pVRScreenshots; // class vr::IVRScreenshots * } public class OpenVR @@ -3402,25 +4368,44 @@ public static uint GetInitToken() return OpenVRInterop.GetInitToken(); } - public const uint k_unTrackingStringSize = 32; public const uint k_unMaxDriverDebugResponseSize = 32768; public const uint k_unTrackedDeviceIndex_Hmd = 0; public const uint k_unMaxTrackedDeviceCount = 16; + public const uint k_unTrackedDeviceIndexOther = 4294967294; public const uint k_unTrackedDeviceIndexInvalid = 4294967295; + public const ulong k_ulInvalidPropertyContainer = 0; + public const uint k_unInvalidPropertyTag = 0; + public const uint k_unFloatPropertyTag = 1; + public const uint k_unInt32PropertyTag = 2; + public const uint k_unUint64PropertyTag = 3; + public const uint k_unBoolPropertyTag = 4; + public const uint k_unStringPropertyTag = 5; + public const uint k_unHmdMatrix34PropertyTag = 20; + public const uint k_unHmdMatrix44PropertyTag = 21; + public const uint k_unHmdVector3PropertyTag = 22; + public const uint k_unHmdVector4PropertyTag = 23; + public const uint k_unHiddenAreaPropertyTag = 30; + public const uint k_unOpenVRInternalReserved_Start = 1000; + public const uint k_unOpenVRInternalReserved_End = 10000; public const uint k_unMaxPropertyStringSize = 32768; public const uint k_unControllerStateAxisCount = 5; public const ulong k_ulOverlayHandleInvalid = 0; - public const string IVRSystem_Version = "IVRSystem_012"; + public const uint k_unScreenshotHandleInvalid = 0; + public const string IVRSystem_Version = "IVRSystem_015"; public const string IVRExtendedDisplay_Version = "IVRExtendedDisplay_001"; + public const string IVRTrackedCamera_Version = "IVRTrackedCamera_003"; public const uint k_unMaxApplicationKeyLength = 128; - public const string IVRApplications_Version = "IVRApplications_005"; + public const string k_pch_MimeType_HomeApp = "vr/home"; + public const string k_pch_MimeType_GameTheater = "vr/game_theater"; + public const string IVRApplications_Version = "IVRApplications_006"; public const string IVRChaperone_Version = "IVRChaperone_003"; public const string IVRChaperoneSetup_Version = "IVRChaperoneSetup_005"; - public const string IVRCompositor_Version = "IVRCompositor_014"; + public const string IVRCompositor_Version = "IVRCompositor_020"; public const uint k_unVROverlayMaxKeyLength = 128; public const uint k_unVROverlayMaxNameLength = 128; - public const uint k_unMaxOverlayCount = 32; - public const string IVROverlay_Version = "IVROverlay_011"; + public const uint k_unMaxOverlayCount = 64; + public const uint k_unMaxOverlayIntersectionMaskPrimitivesCount = 32; + public const string IVROverlay_Version = "IVROverlay_014"; public const string k_pch_Controller_Component_GDC2015 = "gdc2015"; public const string k_pch_Controller_Component_Base = "base"; public const string k_pch_Controller_Component_Tip = "tip"; @@ -3430,7 +4415,7 @@ public static uint GetInitToken() public const uint k_unNotificationTextMaxSize = 256; public const string IVRNotifications_Version = "IVRNotifications_002"; public const uint k_unMaxSettingsKeyLength = 128; - public const string IVRSettings_Version = "IVRSettings_001"; + public const string IVRSettings_Version = "IVRSettings_002"; public const string k_pch_SteamVR_Section = "steamvr"; public const string k_pch_SteamVR_RequireHmd_String = "requireHmd"; public const string k_pch_SteamVR_ForcedDriverKey_String = "forcedDriver"; @@ -3444,12 +4429,13 @@ public static uint GetInitToken() public const string k_pch_SteamVR_LogLevel_Int32 = "loglevel"; public const string k_pch_SteamVR_IPD_Float = "ipd"; public const string k_pch_SteamVR_Background_String = "background"; + public const string k_pch_SteamVR_BackgroundUseDomeProjection_Bool = "backgroundUseDomeProjection"; + public const string k_pch_SteamVR_BackgroundCameraHeight_Float = "backgroundCameraHeight"; + public const string k_pch_SteamVR_BackgroundDomeRadius_Float = "backgroundDomeRadius"; public const string k_pch_SteamVR_GridColor_String = "gridColor"; public const string k_pch_SteamVR_PlayAreaColor_String = "playAreaColor"; + public const string k_pch_SteamVR_ShowStage_Bool = "showStage"; public const string k_pch_SteamVR_ActivateMultipleDrivers_Bool = "activateMultipleDrivers"; - public const string k_pch_SteamVR_PowerOffOnExit_Bool = "powerOffOnExit"; - public const string k_pch_SteamVR_StandbyAppRunningTimeout_Float = "standbyAppRunningTimeout"; - public const string k_pch_SteamVR_StandbyNoAppTimeout_Float = "standbyNoAppTimeout"; public const string k_pch_SteamVR_DirectMode_Bool = "directMode"; public const string k_pch_SteamVR_DirectModeEdidVid_Int32 = "directModeEdidVid"; public const string k_pch_SteamVR_DirectModeEdidPid_Int32 = "directModeEdidPid"; @@ -3458,22 +4444,29 @@ public static uint GetInitToken() public const string k_pch_SteamVR_BaseStationPowerManagement_Bool = "basestationPowerManagement"; public const string k_pch_SteamVR_NeverKillProcesses_Bool = "neverKillProcesses"; public const string k_pch_SteamVR_RenderTargetMultiplier_Float = "renderTargetMultiplier"; - public const string k_pch_SteamVR_AllowReprojection_Bool = "allowReprojection"; + public const string k_pch_SteamVR_AllowAsyncReprojection_Bool = "allowAsyncReprojection"; + public const string k_pch_SteamVR_AllowReprojection_Bool = "allowInterleavedReprojection"; + public const string k_pch_SteamVR_ForceReprojection_Bool = "forceReprojection"; + public const string k_pch_SteamVR_ForceFadeOnBadTracking_Bool = "forceFadeOnBadTracking"; + public const string k_pch_SteamVR_DefaultMirrorView_Int32 = "defaultMirrorView"; + public const string k_pch_SteamVR_ShowMirrorView_Bool = "showMirrorView"; + public const string k_pch_SteamVR_MirrorViewGeometry_String = "mirrorViewGeometry"; + public const string k_pch_SteamVR_StartMonitorFromAppLaunch = "startMonitorFromAppLaunch"; + public const string k_pch_SteamVR_StartCompositorFromAppLaunch_Bool = "startCompositorFromAppLaunch"; + public const string k_pch_SteamVR_StartDashboardFromAppLaunch_Bool = "startDashboardFromAppLaunch"; + public const string k_pch_SteamVR_StartOverlayAppsFromDashboard_Bool = "startOverlayAppsFromDashboard"; + public const string k_pch_SteamVR_EnableHomeApp = "enableHomeApp"; + public const string k_pch_SteamVR_SetInitialDefaultHomeApp = "setInitialDefaultHomeApp"; + public const string k_pch_SteamVR_CycleBackgroundImageTimeSec_Int32 = "CycleBackgroundImageTimeSec"; + public const string k_pch_SteamVR_RetailDemo_Bool = "retailDemo"; + public const string k_pch_SteamVR_IpdOffset_Float = "ipdOffset"; public const string k_pch_Lighthouse_Section = "driver_lighthouse"; public const string k_pch_Lighthouse_DisableIMU_Bool = "disableimu"; public const string k_pch_Lighthouse_UseDisambiguation_String = "usedisambiguation"; public const string k_pch_Lighthouse_DisambiguationDebug_Int32 = "disambiguationdebug"; public const string k_pch_Lighthouse_PrimaryBasestation_Int32 = "primarybasestation"; - public const string k_pch_Lighthouse_LighthouseName_String = "lighthousename"; - public const string k_pch_Lighthouse_MaxIncidenceAngleDegrees_Float = "maxincidenceangledegrees"; - public const string k_pch_Lighthouse_UseLighthouseDirect_Bool = "uselighthousedirect"; public const string k_pch_Lighthouse_DBHistory_Bool = "dbhistory"; - public const string k_pch_Lighthouse_OriginOffsetX_Float = "originoffsetx"; - public const string k_pch_Lighthouse_OriginOffsetY_Float = "originoffsety"; - public const string k_pch_Lighthouse_OriginOffsetZ_Float = "originoffsetz"; - public const string k_pch_Lighthouse_HeadingOffset_Float = "headingoffset"; public const string k_pch_Null_Section = "driver_null"; - public const string k_pch_Null_EnableNullDriver_Bool = "enable"; public const string k_pch_Null_SerialNumber_String = "serialNumber"; public const string k_pch_Null_ModelNumber_String = "modelNumber"; public const string k_pch_Null_WindowX_Int32 = "windowX"; @@ -3486,6 +4479,9 @@ public static uint GetInitToken() public const string k_pch_Null_DisplayFrequency_Float = "displayFrequency"; public const string k_pch_UserInterface_Section = "userinterface"; public const string k_pch_UserInterface_StatusAlwaysOnTop_Bool = "StatusAlwaysOnTop"; + public const string k_pch_UserInterface_MinimizeToTray_Bool = "MinimizeToTray"; + public const string k_pch_UserInterface_Screenshots_Bool = "screenshots"; + public const string k_pch_UserInterface_ScreenshotType_Int = "screenshotType"; public const string k_pch_Notifications_Section = "notifications"; public const string k_pch_Notifications_DoNotDisturb_Bool = "DoNotDisturb"; public const string k_pch_Keyboard_Section = "keyboard"; @@ -3522,6 +4518,7 @@ public static uint GetInitToken() public const string k_pch_Camera_BoundsColorGammaG_Int32 = "cameraBoundsColorGammaG"; public const string k_pch_Camera_BoundsColorGammaB_Int32 = "cameraBoundsColorGammaB"; public const string k_pch_Camera_BoundsColorGammaA_Int32 = "cameraBoundsColorGammaA"; + public const string k_pch_Camera_BoundsStrength_Int32 = "cameraBoundsStrength"; public const string k_pch_audio_Section = "audio"; public const string k_pch_audio_OnPlaybackDevice_String = "onPlaybackDevice"; public const string k_pch_audio_OnRecordDevice_String = "onRecordDevice"; @@ -3529,6 +4526,19 @@ public static uint GetInitToken() public const string k_pch_audio_OffPlaybackDevice_String = "offPlaybackDevice"; public const string k_pch_audio_OffRecordDevice_String = "offRecordDevice"; public const string k_pch_audio_VIVEHDMIGain = "viveHDMIGain"; + public const string k_pch_Power_Section = "power"; + public const string k_pch_Power_PowerOffOnExit_Bool = "powerOffOnExit"; + public const string k_pch_Power_TurnOffScreensTimeout_Float = "turnOffScreensTimeout"; + public const string k_pch_Power_TurnOffControllersTimeout_Float = "turnOffControllersTimeout"; + public const string k_pch_Power_ReturnToWatchdogTimeout_Float = "returnToWatchdogTimeout"; + public const string k_pch_Power_AutoLaunchSteamVROnButtonPress = "autoLaunchSteamVROnButtonPress"; + public const string k_pch_Dashboard_Section = "dashboard"; + public const string k_pch_Dashboard_EnableDashboard_Bool = "enableDashboard"; + public const string k_pch_Dashboard_ArcadeMode_Bool = "arcadeMode"; + public const string k_pch_modelskin_Section = "modelskins"; + public const string k_pch_Driver_Enable_Bool = "enable"; + public const string IVRScreenshots_Version = "IVRScreenshots_001"; + public const string IVRResources_Version = "IVRResources_001"; static uint VRToken { get; set; } @@ -3549,6 +4559,8 @@ public void Clear() m_pVRExtendedDisplay = null; m_pVRSettings = null; m_pVRApplications = null; + m_pVRScreenshots = null; + m_pVRTrackedCamera = null; } void CheckClear() @@ -3677,6 +4689,32 @@ public CVRApplications VRApplications() return m_pVRApplications; } + public CVRScreenshots VRScreenshots() + { + CheckClear(); + if (m_pVRScreenshots == null) + { + var eError = EVRInitError.None; + var pInterface = OpenVRInterop.GetGenericInterface(FnTable_Prefix+IVRScreenshots_Version, ref eError); + if (pInterface != IntPtr.Zero && eError == EVRInitError.None) + m_pVRScreenshots = new CVRScreenshots(pInterface); + } + return m_pVRScreenshots; + } + + public CVRTrackedCamera VRTrackedCamera() + { + CheckClear(); + if (m_pVRTrackedCamera == null) + { + var eError = EVRInitError.None; + var pInterface = OpenVRInterop.GetGenericInterface(FnTable_Prefix+IVRTrackedCamera_Version, ref eError); + if (pInterface != IntPtr.Zero && eError == EVRInitError.None) + m_pVRTrackedCamera = new CVRTrackedCamera(pInterface); + } + return m_pVRTrackedCamera; + } + private CVRSystem m_pVRSystem; private CVRChaperone m_pVRChaperone; private CVRChaperoneSetup m_pVRChaperoneSetup; @@ -3686,6 +4724,8 @@ public CVRApplications VRApplications() private CVRExtendedDisplay m_pVRExtendedDisplay; private CVRSettings m_pVRSettings; private CVRApplications m_pVRApplications; + private CVRScreenshots m_pVRScreenshots; + private CVRTrackedCamera m_pVRTrackedCamera; }; private static COpenVRContext _OpenVRInternal_ModuleContext = null; @@ -3705,9 +4745,11 @@ static COpenVRContext OpenVRInternal_ModuleContext public static CVRCompositor Compositor { get { return OpenVRInternal_ModuleContext.VRCompositor(); } } public static CVROverlay Overlay { get { return OpenVRInternal_ModuleContext.VROverlay(); } } public static CVRRenderModels RenderModels { get { return OpenVRInternal_ModuleContext.VRRenderModels(); } } - public static CVRApplications Applications { get { return OpenVRInternal_ModuleContext.VRApplications(); } } - public static CVRSettings Settings { get { return OpenVRInternal_ModuleContext.VRSettings(); } } public static CVRExtendedDisplay ExtendedDisplay { get { return OpenVRInternal_ModuleContext.VRExtendedDisplay(); } } + public static CVRSettings Settings { get { return OpenVRInternal_ModuleContext.VRSettings(); } } + public static CVRApplications Applications { get { return OpenVRInternal_ModuleContext.VRApplications(); } } + public static CVRScreenshots Screenshots { get { return OpenVRInternal_ModuleContext.VRScreenshots(); } } + public static CVRTrackedCamera TrackedCamera { get { return OpenVRInternal_ModuleContext.VRTrackedCamera(); } } /** Finds the active installation of vrclient.dll and initializes it */ public static CVRSystem Init(ref EVRInitError peError, EVRApplicationType eApplicationType = EVRApplicationType.VRApplication_Scene) diff --git a/Assets/Plugins/x86/libopenvr_api.so b/Assets/Plugins/x86/libopenvr_api.so deleted file mode 100644 index a250545..0000000 Binary files a/Assets/Plugins/x86/libopenvr_api.so and /dev/null differ diff --git a/Assets/Plugins/x86/libopenvr_api.so.meta b/Assets/Plugins/x86/libopenvr_api.so.meta deleted file mode 100644 index dc09699..0000000 --- a/Assets/Plugins/x86/libopenvr_api.so.meta +++ /dev/null @@ -1,53 +0,0 @@ -fileFormatVersion: 2 -guid: 64b48e8bdcc9e0541aa902936def9faa -timeCreated: 1463158122 -licenseType: Store -PluginImporter: - serializedVersion: 1 - iconMap: {} - executionOrder: {} - isPreloaded: 0 - platformData: - Any: - enabled: 1 - settings: {} - Editor: - enabled: 0 - settings: - CPU: x86 - DefaultValueInitialized: true - Linux: - enabled: 1 - settings: - CPU: x86 - Linux64: - enabled: 0 - settings: - CPU: None - LinuxUniversal: - enabled: 0 - settings: - CPU: x86 - OSXIntel: - enabled: 1 - settings: - CPU: AnyCPU - OSXIntel64: - enabled: 0 - settings: - CPU: None - OSXUniversal: - enabled: 0 - settings: - CPU: x86 - Win: - enabled: 1 - settings: - CPU: AnyCPU - Win64: - enabled: 0 - settings: - CPU: None - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Plugins/x86/openvr_api.dll b/Assets/Plugins/x86/openvr_api.dll deleted file mode 100644 index eb776af..0000000 Binary files a/Assets/Plugins/x86/openvr_api.dll and /dev/null differ diff --git a/Assets/Plugins/x86/openvr_api.dll.meta b/Assets/Plugins/x86/openvr_api.dll.meta deleted file mode 100644 index 647b8d2..0000000 --- a/Assets/Plugins/x86/openvr_api.dll.meta +++ /dev/null @@ -1,30 +0,0 @@ -fileFormatVersion: 2 -guid: 73d5d79effb76f84491567f3c473b810 -timeCreated: 1429123045 -licenseType: Store -PluginImporter: - serializedVersion: 1 - iconMap: {} - executionOrder: {} - isPreloaded: 0 - platformData: - Any: - enabled: 0 - settings: {} - Editor: - enabled: 1 - settings: - CPU: x86 - DefaultValueInitialized: true - OS: Windows - Win: - enabled: 1 - settings: - CPU: AnyCPU - Win64: - enabled: 1 - settings: - CPU: None - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Plugins/x86_64/libopenvr_api.so b/Assets/Plugins/x86_64/libopenvr_api.so deleted file mode 100644 index 9c025e0..0000000 Binary files a/Assets/Plugins/x86_64/libopenvr_api.so and /dev/null differ diff --git a/Assets/Plugins/x86_64/libopenvr_api.so.meta b/Assets/Plugins/x86_64/libopenvr_api.so.meta deleted file mode 100644 index a25cb25..0000000 --- a/Assets/Plugins/x86_64/libopenvr_api.so.meta +++ /dev/null @@ -1,76 +0,0 @@ -fileFormatVersion: 2 -guid: d4aa343e31277cd45b2c3096d3318b90 -timeCreated: 1457668425 -licenseType: Store -PluginImporter: - serializedVersion: 1 - iconMap: {} - executionOrder: {} - isPreloaded: 0 - platformData: - Android: - enabled: 0 - settings: - CPU: AnyCPU - Any: - enabled: 0 - settings: {} - Editor: - enabled: 0 - settings: - CPU: x86_64 - DefaultValueInitialized: true - OS: AnyOS - Linux: - enabled: 1 - settings: - CPU: None - Linux64: - enabled: 1 - settings: - CPU: x86_64 - LinuxUniversal: - enabled: 1 - settings: - CPU: x86_64 - OSXIntel: - enabled: 1 - settings: - CPU: None - OSXIntel64: - enabled: 1 - settings: - CPU: None - OSXUniversal: - enabled: 1 - settings: - CPU: None - WP8: - enabled: 0 - settings: - CPU: AnyCPU - DontProcess: False - PlaceholderPath: - Win: - enabled: 1 - settings: - CPU: None - Win64: - enabled: 1 - settings: - CPU: AnyCPU - WindowsStoreApps: - enabled: 0 - settings: - CPU: AnyCPU - DontProcess: False - PlaceholderPath: - SDK: AnySDK - iOS: - enabled: 0 - settings: - CompileFlags: - FrameworkDependencies: - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Plugins/x86_64/openvr_api.dll b/Assets/Plugins/x86_64/openvr_api.dll deleted file mode 100644 index 826cf9c..0000000 Binary files a/Assets/Plugins/x86_64/openvr_api.dll and /dev/null differ diff --git a/Assets/Plugins/x86_64/openvr_api.dll.meta b/Assets/Plugins/x86_64/openvr_api.dll.meta deleted file mode 100644 index 697d221..0000000 --- a/Assets/Plugins/x86_64/openvr_api.dll.meta +++ /dev/null @@ -1,30 +0,0 @@ -fileFormatVersion: 2 -guid: 9d42e4d46d897b648a1d6ed58a18e8a6 -timeCreated: 1429123045 -licenseType: Store -PluginImporter: - serializedVersion: 1 - iconMap: {} - executionOrder: {} - isPreloaded: 0 - platformData: - Any: - enabled: 0 - settings: {} - Editor: - enabled: 1 - settings: - CPU: x86_64 - DefaultValueInitialized: true - OS: Windows - Win: - enabled: 1 - settings: - CPU: None - Win64: - enabled: 1 - settings: - CPU: AnyCPU - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/SteamVR.meta b/Assets/SteamVR.meta index a17b64e..7e4ea13 100644 --- a/Assets/SteamVR.meta +++ b/Assets/SteamVR.meta @@ -1,7 +1,7 @@ fileFormatVersion: 2 guid: f0032bd9499af5e4aa85ea41615843a0 folderAsset: yes -timeCreated: 1465633285 +timeCreated: 1496367098 licenseType: Free DefaultImporter: userData: diff --git a/Assets/SteamVR/Editor.meta b/Assets/SteamVR/Editor.meta index e2f41ed..90b104c 100644 --- a/Assets/SteamVR/Editor.meta +++ b/Assets/SteamVR/Editor.meta @@ -1,9 +1,6 @@ fileFormatVersion: 2 -guid: 941dde9a9ca65d74489c024e76c8bfe8 +guid: c33af0785775d7548b22541da37936fe folderAsset: yes -timeCreated: 1465633285 -licenseType: Free DefaultImporter: userData: assetBundleName: - assetBundleVariant: diff --git a/Assets/SteamVR/Editor/SteamVR_Editor.cs b/Assets/SteamVR/Editor/SteamVR_Editor.cs index f347231..8889e49 100644 --- a/Assets/SteamVR/Editor/SteamVR_Editor.cs +++ b/Assets/SteamVR/Editor/SteamVR_Editor.cs @@ -1,4 +1,4 @@ -//========= Copyright 2014, Valve Corporation, All rights reserved. =========== +//======= Copyright (c) Valve Corporation, All rights reserved. =============== // // Purpose: Custom inspector display for SteamVR_Camera // @@ -27,11 +27,9 @@ string GetResourcePath() void OnEnable() { var resourcePath = GetResourcePath(); -#if UNITY_5_0 - logo = Resources.LoadAssetAtPath(resourcePath + "logo.png"); -#else + logo = AssetDatabase.LoadAssetAtPath(resourcePath + "logo.png"); -#endif + script = serializedObject.FindProperty("m_Script"); wireframe = serializedObject.FindProperty("wireframe"); diff --git a/Assets/SteamVR/Editor/SteamVR_Preferences.cs b/Assets/SteamVR/Editor/SteamVR_Preferences.cs new file mode 100644 index 0000000..ad3e000 --- /dev/null +++ b/Assets/SteamVR/Editor/SteamVR_Preferences.cs @@ -0,0 +1,48 @@ +//======= Copyright (c) Valve Corporation, All rights reserved. =============== +// +// Purpose: Preferences pane for how SteamVR plugin behaves. +// +//============================================================================= + +using UnityEngine; +using UnityEditor; + +public class SteamVR_Preferences +{ + /// + /// Should SteamVR automatically enable VR when opening Unity or pressing play. + /// + public static bool AutoEnableVR + { + get + { + return EditorPrefs.GetBool("SteamVR_AutoEnableVR", true); + } + set + { + EditorPrefs.SetBool("SteamVR_AutoEnableVR", value); + } + } + + [PreferenceItem("SteamVR")] + static void PreferencesGUI() + { + EditorGUILayout.BeginVertical(); + EditorGUILayout.Space(); + + // Automatically Enable VR + { + string title = "Automatically Enable VR"; + string tooltip = "Should SteamVR automatically enable VR on launch and play?"; + AutoEnableVR = EditorGUILayout.Toggle(new GUIContent(title, tooltip), AutoEnableVR); + string helpMessage = "To enable VR manually:\n"; + helpMessage += "- go to Edit -> Project Settings -> Player,\n"; + helpMessage += "- tick 'Virtual Reality Supported',\n"; + helpMessage += "- make sure OpenVR is in the 'Virtual Reality SDKs' list."; + EditorGUILayout.HelpBox(helpMessage, MessageType.Info); + } + + EditorGUILayout.EndVertical(); + } +} + diff --git a/Assets/SteamVR/Editor/SteamVR_Preferences.cs.meta b/Assets/SteamVR/Editor/SteamVR_Preferences.cs.meta new file mode 100644 index 0000000..3ecb77a --- /dev/null +++ b/Assets/SteamVR/Editor/SteamVR_Preferences.cs.meta @@ -0,0 +1,12 @@ +fileFormatVersion: 2 +guid: 29abf75f7265ccb45b799eac4ab0ca94 +timeCreated: 1487968203 +licenseType: Store +MonoImporter: + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/SteamVR/Editor/SteamVR_Settings.cs b/Assets/SteamVR/Editor/SteamVR_Settings.cs index ef4278b..f6e8145 100644 --- a/Assets/SteamVR/Editor/SteamVR_Settings.cs +++ b/Assets/SteamVR/Editor/SteamVR_Settings.cs @@ -1,4 +1,4 @@ -//========= Copyright 2015, Valve Corporation, All rights reserved. =========== +//======= Copyright (c) Valve Corporation, All rights reserved. =============== // // Purpose: Prompt developers to use settings most compatible with SteamVR. // @@ -26,20 +26,15 @@ public class SteamVR_Settings : EditorWindow const string resizableWindow = "Resizable Window"; const string fullscreenMode = "D3D11 Fullscreen Mode"; const string visibleInBackground = "Visible In Background"; +#if (UNITY_5_4 || UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) const string renderingPath = "Rendering Path"; +#endif const string colorSpace = "Color Space"; -#if !(UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) const string gpuSkinning = "GPU Skinning"; -#endif -#if !(UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) && false // skyboxes are currently broken +#if false // skyboxes are currently broken const string singlePassStereoRendering = "Single-Pass Stereo Rendering"; #endif -#if (UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) - const string stereoscopicRendering = "Stereoscopic Rendering"; -#endif -#if (UNITY_5_3 || UNITY_5_2 || UNITY_5_1) - const string virtualRealitySupported = "Virtual Reality Support"; -#endif + const BuildTarget recommended_BuildTarget = BuildTarget.StandaloneWindows64; const bool recommended_ShowUnitySplashScreen = false; const bool recommended_DefaultIsFullScreen = false; @@ -50,20 +45,15 @@ public class SteamVR_Settings : EditorWindow const bool recommended_ResizableWindow = true; const D3D11FullscreenMode recommended_FullscreenMode = D3D11FullscreenMode.FullscreenWindow; const bool recommended_VisibleInBackground = true; +#if (UNITY_5_4 || UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) const RenderingPath recommended_RenderPath = RenderingPath.Forward; +#endif const ColorSpace recommended_ColorSpace = ColorSpace.Linear; -#if !(UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) const bool recommended_GpuSkinning = true; -#endif -#if !(UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) && false +#if false const bool recommended_SinglePassStereoRendering = true; #endif -#if (UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) - const bool recommended_StereoscopicRendering = false; -#endif -#if (UNITY_5_3 || UNITY_5_2 || UNITY_5_1) - const bool recommended_VirtualRealitySupported = false; -#endif + static SteamVR_Settings window; static SteamVR_Settings() @@ -77,7 +67,11 @@ static void Update() (!EditorPrefs.HasKey(ignore + buildTarget) && EditorUserBuildSettings.activeBuildTarget != recommended_BuildTarget) || (!EditorPrefs.HasKey(ignore + showUnitySplashScreen) && +#if (UNITY_5_4 || UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) PlayerSettings.showUnitySplashScreen != recommended_ShowUnitySplashScreen) || +#else + PlayerSettings.SplashScreen.show != recommended_ShowUnitySplashScreen) || +#endif (!EditorPrefs.HasKey(ignore + defaultIsFullScreen) && PlayerSettings.defaultIsFullScreen != recommended_DefaultIsFullScreen) || (!EditorPrefs.HasKey(ignore + defaultScreenSize) && @@ -93,25 +87,17 @@ static void Update() PlayerSettings.d3d11FullscreenMode != recommended_FullscreenMode) || (!EditorPrefs.HasKey(ignore + visibleInBackground) && PlayerSettings.visibleInBackground != recommended_VisibleInBackground) || +#if (UNITY_5_4 || UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) (!EditorPrefs.HasKey(ignore + renderingPath) && PlayerSettings.renderingPath != recommended_RenderPath) || +#endif (!EditorPrefs.HasKey(ignore + colorSpace) && PlayerSettings.colorSpace != recommended_ColorSpace) || -#if !(UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) (!EditorPrefs.HasKey(ignore + gpuSkinning) && PlayerSettings.gpuSkinning != recommended_GpuSkinning) || -#endif -#if !(UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) && false +#if false (!EditorPrefs.HasKey(ignore + singlePassStereoRendering) && PlayerSettings.singlePassStereoRendering != recommended_SinglePassStereoRendering) || -#endif -#if (UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) - (!EditorPrefs.HasKey(ignore + stereoscopicRendering) && - PlayerSettings.stereoscopic3D != recommended_StereoscopicRendering) || -#endif -#if (UNITY_5_3 || UNITY_5_2 || UNITY_5_1) - (!EditorPrefs.HasKey(ignore + virtualRealitySupported) && - PlayerSettings.virtualRealitySupported != recommended_VirtualRealitySupported) || #endif forceShow; @@ -122,42 +108,53 @@ static void Update() //window.title = "SteamVR"; } -#if !(UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) - // Switch to native OpenVR support. - var updated = false; - - if (!PlayerSettings.virtualRealitySupported) + if (SteamVR_Preferences.AutoEnableVR) { - PlayerSettings.virtualRealitySupported = true; - updated = true; - } + // Switch to native OpenVR support. + var updated = false; - var devices = UnityEditorInternal.VR.VREditor.GetVREnabledDevices(BuildTargetGroup.Standalone); - var hasOpenVR = false; - foreach (var device in devices) - if (device.ToLower() == "openvr") - hasOpenVR = true; - - if (!hasOpenVR) - { - string[] newDevices; - if (updated) + if (!PlayerSettings.virtualRealitySupported) { - newDevices = new string[] { "OpenVR" }; + PlayerSettings.virtualRealitySupported = true; + updated = true; } - else + +#if (UNITY_5_4 || UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) + var devices = UnityEditorInternal.VR.VREditor.GetVREnabledDevices(BuildTargetGroup.Standalone); +#else + var devices = UnityEditorInternal.VR.VREditor.GetVREnabledDevicesOnTargetGroup(BuildTargetGroup.Standalone); +#endif + var hasOpenVR = false; + foreach (var device in devices) + if (device.ToLower() == "openvr") + hasOpenVR = true; + + + if (!hasOpenVR) { - newDevices = new string[devices.Length + 1]; - for (int i = 0; i < devices.Length; i++) - newDevices[i] = devices[i]; - newDevices[devices.Length] = "OpenVR"; - updated = true; + string[] newDevices; + if (updated) + { + newDevices = new string[] { "OpenVR" }; + } + else + { + newDevices = new string[devices.Length + 1]; + for (int i = 0; i < devices.Length; i++) + newDevices[i] = devices[i]; + newDevices[devices.Length] = "OpenVR"; + updated = true; + } +#if (UNITY_5_4 || UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) + UnityEditorInternal.VR.VREditor.SetVREnabledDevices(BuildTargetGroup.Standalone, newDevices); +#else + UnityEditorInternal.VR.VREditor.SetVREnabledDevicesOnTargetGroup(BuildTargetGroup.Standalone, newDevices); +#endif } - UnityEditorInternal.VR.VREditor.SetVREnabledDevices(BuildTargetGroup.Standalone, newDevices); - } - if (updated) - Debug.Log("Switching to native OpenVR support."); + if (updated) + Debug.Log("Switching to native OpenVR support."); + } var dlls = new string[] { @@ -177,13 +174,12 @@ static void Update() Debug.Log(path + " in use; cannot delete. Please restart Unity to complete upgrade."); } } -#endif + EditorApplication.update -= Update; } Vector2 scrollPosition; - bool toggleState; - + string GetResourcePath() { var ms = MonoScript.FromScriptableObject(this); @@ -195,11 +191,7 @@ string GetResourcePath() public void OnGUI() { var resourcePath = GetResourcePath(); -#if !(UNITY_5_0) var logo = AssetDatabase.LoadAssetAtPath(resourcePath + "logo.png"); -#else - var logo = Resources.LoadAssetAtPath(resourcePath + "logo.png"); -#endif var rect = GUILayoutUtility.GetRect(position.width, 150, GUI.skin.box); if (logo) GUI.DrawTexture(rect, logo, ScaleMode.ScaleToFit); @@ -221,7 +213,11 @@ public void OnGUI() if (GUILayout.Button(string.Format(useRecommended, recommended_BuildTarget))) { +#if (UNITY_5_5 || UNITY_5_4 || UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) EditorUserBuildSettings.SwitchActiveBuildTarget(recommended_BuildTarget); +#else + EditorUserBuildSettings.SwitchActiveBuildTarget(BuildTargetGroup.Standalone, recommended_BuildTarget); +#endif } GUILayout.FlexibleSpace(); @@ -234,6 +230,7 @@ public void OnGUI() GUILayout.EndHorizontal(); } +#if (UNITY_5_4 || UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) if (!EditorPrefs.HasKey(ignore + showUnitySplashScreen) && PlayerSettings.showUnitySplashScreen != recommended_ShowUnitySplashScreen) { @@ -257,7 +254,31 @@ public void OnGUI() GUILayout.EndHorizontal(); } +#else + if (!EditorPrefs.HasKey(ignore + showUnitySplashScreen) && + PlayerSettings.SplashScreen.show != recommended_ShowUnitySplashScreen) + { + ++numItems; + + GUILayout.Label(showUnitySplashScreen + string.Format(currentValue, PlayerSettings.SplashScreen.show)); + + GUILayout.BeginHorizontal(); + + if (GUILayout.Button(string.Format(useRecommended, recommended_ShowUnitySplashScreen))) + { + PlayerSettings.SplashScreen.show = recommended_ShowUnitySplashScreen; + } + GUILayout.FlexibleSpace(); + + if (GUILayout.Button("Ignore")) + { + EditorPrefs.SetBool(ignore + showUnitySplashScreen, true); + } + + GUILayout.EndHorizontal(); + } +#endif if (!EditorPrefs.HasKey(ignore + defaultIsFullScreen) && PlayerSettings.defaultIsFullScreen != recommended_DefaultIsFullScreen) { @@ -427,7 +448,7 @@ public void OnGUI() GUILayout.EndHorizontal(); } - +#if (UNITY_5_4 || UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) if (!EditorPrefs.HasKey(ignore + renderingPath) && PlayerSettings.renderingPath != recommended_RenderPath) { @@ -451,7 +472,7 @@ public void OnGUI() GUILayout.EndHorizontal(); } - +#endif if (!EditorPrefs.HasKey(ignore + colorSpace) && PlayerSettings.colorSpace != recommended_ColorSpace) { @@ -475,7 +496,7 @@ public void OnGUI() GUILayout.EndHorizontal(); } -#if !(UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) + if (!EditorPrefs.HasKey(ignore + gpuSkinning) && PlayerSettings.gpuSkinning != recommended_GpuSkinning) { @@ -499,8 +520,8 @@ public void OnGUI() GUILayout.EndHorizontal(); } -#endif -#if !(UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) && false + +#if false if (!EditorPrefs.HasKey(ignore + singlePassStereoRendering) && PlayerSettings.singlePassStereoRendering != recommended_SinglePassStereoRendering) { @@ -525,56 +546,7 @@ public void OnGUI() GUILayout.EndHorizontal(); } #endif -#if (UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) - if (!EditorPrefs.HasKey(ignore + stereoscopicRendering) && - PlayerSettings.stereoscopic3D != recommended_StereoscopicRendering) - { - ++numItems; - - GUILayout.Label(stereoscopicRendering + string.Format(currentValue, PlayerSettings.stereoscopic3D)); - - GUILayout.BeginHorizontal(); - - if (GUILayout.Button(string.Format(useRecommended, recommended_StereoscopicRendering))) - { - PlayerSettings.stereoscopic3D = recommended_StereoscopicRendering; - } - - GUILayout.FlexibleSpace(); - - if (GUILayout.Button("Ignore")) - { - EditorPrefs.SetBool(ignore + stereoscopicRendering, true); - } - - GUILayout.EndHorizontal(); - } -#endif -#if (UNITY_5_3 || UNITY_5_2 || UNITY_5_1) - if (!EditorPrefs.HasKey(ignore + virtualRealitySupported) && - PlayerSettings.virtualRealitySupported != recommended_VirtualRealitySupported) - { - ++numItems; - GUILayout.Label(virtualRealitySupported + string.Format(currentValue, PlayerSettings.virtualRealitySupported)); - - GUILayout.BeginHorizontal(); - - if (GUILayout.Button(string.Format(useRecommended, recommended_VirtualRealitySupported))) - { - PlayerSettings.virtualRealitySupported = recommended_VirtualRealitySupported; - } - - GUILayout.FlexibleSpace(); - - if (GUILayout.Button("Ignore")) - { - EditorPrefs.SetBool(ignore + virtualRealitySupported, true); - } - - GUILayout.EndHorizontal(); - } -#endif GUILayout.BeginHorizontal(); GUILayout.FlexibleSpace(); @@ -590,19 +562,13 @@ public void OnGUI() EditorPrefs.DeleteKey(ignore + resizableWindow); EditorPrefs.DeleteKey(ignore + fullscreenMode); EditorPrefs.DeleteKey(ignore + visibleInBackground); +#if (UNITY_5_4 || UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) EditorPrefs.DeleteKey(ignore + renderingPath); +#endif EditorPrefs.DeleteKey(ignore + colorSpace); -#if !(UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) EditorPrefs.DeleteKey(ignore + gpuSkinning); -#endif -#if !(UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) && false +#if false EditorPrefs.DeleteKey(ignore + singlePassStereoRendering); -#endif -#if (UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) - EditorPrefs.DeleteKey(ignore + stereoscopicRendering); -#endif -#if (UNITY_5_3 || UNITY_5_2 || UNITY_5_1) - EditorPrefs.DeleteKey(ignore + virtualRealitySupported); #endif } @@ -620,9 +586,17 @@ public void OnGUI() { // Only set those that have not been explicitly ignored. if (!EditorPrefs.HasKey(ignore + buildTarget)) +#if (UNITY_5_5 || UNITY_5_4 || UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) EditorUserBuildSettings.SwitchActiveBuildTarget(recommended_BuildTarget); +#else + EditorUserBuildSettings.SwitchActiveBuildTarget(BuildTargetGroup.Standalone, recommended_BuildTarget); +#endif if (!EditorPrefs.HasKey(ignore + showUnitySplashScreen)) +#if (UNITY_5_4 || UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) PlayerSettings.showUnitySplashScreen = recommended_ShowUnitySplashScreen; +#else + PlayerSettings.SplashScreen.show = recommended_ShowUnitySplashScreen; +#endif if (!EditorPrefs.HasKey(ignore + defaultIsFullScreen)) PlayerSettings.defaultIsFullScreen = recommended_DefaultIsFullScreen; if (!EditorPrefs.HasKey(ignore + defaultScreenSize)) @@ -640,26 +614,19 @@ public void OnGUI() PlayerSettings.d3d11FullscreenMode = recommended_FullscreenMode; if (!EditorPrefs.HasKey(ignore + visibleInBackground)) PlayerSettings.visibleInBackground = recommended_VisibleInBackground; +#if (UNITY_5_4 || UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) if (!EditorPrefs.HasKey(ignore + renderingPath)) PlayerSettings.renderingPath = recommended_RenderPath; +#endif if (!EditorPrefs.HasKey(ignore + colorSpace)) PlayerSettings.colorSpace = recommended_ColorSpace; -#if !(UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) if (!EditorPrefs.HasKey(ignore + gpuSkinning)) PlayerSettings.gpuSkinning = recommended_GpuSkinning; -#endif -#if !(UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) && false +#if false if (!EditorPrefs.HasKey(ignore + singlePassStereoRendering)) PlayerSettings.singlePassStereoRendering = recommended_SinglePassStereoRendering; #endif -#if (UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) - if (!EditorPrefs.HasKey(ignore + stereoscopicRendering)) - PlayerSettings.stereoscopic3D = recommended_StereoscopicRendering; -#endif -#if (UNITY_5_3 || UNITY_5_2 || UNITY_5_1) - if (!EditorPrefs.HasKey(ignore + virtualRealitySupported)) - PlayerSettings.virtualRealitySupported = recommended_VirtualRealitySupported; -#endif + EditorUtility.DisplayDialog("Accept All", "You made the right choice!", "Ok"); Close(); @@ -672,7 +639,11 @@ public void OnGUI() // Only ignore those that do not currently match our recommended settings. if (EditorUserBuildSettings.activeBuildTarget != recommended_BuildTarget) EditorPrefs.SetBool(ignore + buildTarget, true); +#if (UNITY_5_4 || UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) if (PlayerSettings.showUnitySplashScreen != recommended_ShowUnitySplashScreen) +#else + if (PlayerSettings.SplashScreen.show != recommended_ShowUnitySplashScreen) +#endif EditorPrefs.SetBool(ignore + showUnitySplashScreen, true); if (PlayerSettings.defaultIsFullScreen != recommended_DefaultIsFullScreen) EditorPrefs.SetBool(ignore + defaultIsFullScreen, true); @@ -689,26 +660,19 @@ public void OnGUI() EditorPrefs.SetBool(ignore + fullscreenMode, true); if (PlayerSettings.visibleInBackground != recommended_VisibleInBackground) EditorPrefs.SetBool(ignore + visibleInBackground, true); +#if (UNITY_5_4 || UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) if (PlayerSettings.renderingPath != recommended_RenderPath) EditorPrefs.SetBool(ignore + renderingPath, true); +#endif if (PlayerSettings.colorSpace != recommended_ColorSpace) EditorPrefs.SetBool(ignore + colorSpace, true); -#if !(UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) if (PlayerSettings.gpuSkinning != recommended_GpuSkinning) EditorPrefs.SetBool(ignore + gpuSkinning, true); -#endif -#if !(UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) && false +#if false if (PlayerSettings.singlePassStereoRendering != recommended_SinglePassStereoRendering) EditorPrefs.SetBool(ignore + singlePassStereoRendering, true); #endif -#if (UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) - if (PlayerSettings.stereoscopic3D != recommended_StereoscopicRendering) - EditorPrefs.SetBool(ignore + stereoscopicRendering, true); -#endif -#if (UNITY_5_3 || UNITY_5_2 || UNITY_5_1) - if (PlayerSettings.virtualRealitySupported != recommended_VirtualRealitySupported) - EditorPrefs.SetBool(ignore + virtualRealitySupported, true); -#endif + Close(); } } diff --git a/Assets/SteamVR/Editor/SteamVR_Update.cs b/Assets/SteamVR/Editor/SteamVR_Update.cs index b41762a..792b1c9 100644 --- a/Assets/SteamVR/Editor/SteamVR_Update.cs +++ b/Assets/SteamVR/Editor/SteamVR_Update.cs @@ -1,4 +1,4 @@ -//========= Copyright 2015, Valve Corporation, All rights reserved. =========== +//======= Copyright (c) Valve Corporation, All rights reserved. =============== // // Purpose: Notify developers when a new version of the plugin is available. // @@ -12,26 +12,29 @@ [InitializeOnLoad] public class SteamVR_Update : EditorWindow { - const string currentVersion = "1.1.0"; + const string currentVersion = "1.2.1"; const string versionUrl = "http://media.steampowered.com/apps/steamvr/unitypluginversion.txt"; const string notesUrl = "http://media.steampowered.com/apps/steamvr/unityplugin-v{0}.txt"; const string pluginUrl = "http://u3d.as/content/valve-corporation/steam-vr-plugin"; const string doNotShowKey = "SteamVR.DoNotShow.v{0}"; + static bool gotVersion = false; static WWW wwwVersion, wwwNotes; static string version, notes; static SteamVR_Update window; static SteamVR_Update() { - wwwVersion = new WWW(versionUrl); EditorApplication.update += Update; } static void Update() { - if (wwwVersion != null) + if (!gotVersion) { + if (wwwVersion == null) + wwwVersion = new WWW(versionUrl); + if (!wwwVersion.isDone) return; @@ -39,6 +42,7 @@ static void Update() version = wwwVersion.text; wwwVersion = null; + gotVersion = true; if (ShouldDisplay()) { @@ -125,11 +129,7 @@ public void OnGUI() EditorGUILayout.HelpBox("A new version of the SteamVR plugin is available!", MessageType.Warning); var resourcePath = GetResourcePath(); -#if UNITY_5_0 - var logo = Resources.LoadAssetAtPath(resourcePath + "logo.png"); -#else var logo = AssetDatabase.LoadAssetAtPath(resourcePath + "logo.png"); -#endif var rect = GUILayoutUtility.GetRect(position.width, 150, GUI.skin.box); if (logo) GUI.DrawTexture(rect, logo, ScaleMode.ScaleToFit); diff --git a/Assets/SteamVR/Prefabs.meta b/Assets/SteamVR/Prefabs.meta index b857624..3cc8acb 100644 --- a/Assets/SteamVR/Prefabs.meta +++ b/Assets/SteamVR/Prefabs.meta @@ -1,9 +1,6 @@ fileFormatVersion: 2 -guid: f4d909dcb749c45459770e058a2efac3 +guid: 3e2543c4beea3eb4e9ea1e02a4bc2df2 folderAsset: yes -timeCreated: 1465633285 -licenseType: Free DefaultImporter: userData: assetBundleName: - assetBundleVariant: diff --git a/Assets/SteamVR/Resources.meta b/Assets/SteamVR/Resources.meta index de3d65c..32789b2 100644 --- a/Assets/SteamVR/Resources.meta +++ b/Assets/SteamVR/Resources.meta @@ -1,9 +1,6 @@ fileFormatVersion: 2 -guid: 128449277d8f96b46a3816056eee4067 +guid: 40af2f692be87864ba388a27fcac9ed8 folderAsset: yes -timeCreated: 1465633285 -licenseType: Free DefaultImporter: userData: assetBundleName: - assetBundleVariant: diff --git a/Assets/SteamVR/Resources/SteamVR_Blit.shader b/Assets/SteamVR/Resources/SteamVR_Blit.shader deleted file mode 100644 index 6086abb..0000000 --- a/Assets/SteamVR/Resources/SteamVR_Blit.shader +++ /dev/null @@ -1,52 +0,0 @@ -Shader "Custom/SteamVR_Blit" { - Properties { _MainTex ("Base (RGB)", 2D) = "white" {} } - - CGINCLUDE - - #include "UnityCG.cginc" - - sampler2D _MainTex; - - struct v2f { - float4 pos : SV_POSITION; - float2 tex : TEXCOORD0; - }; - - v2f vert(appdata_base v) { - v2f o; - o.pos = v.vertex; - o.tex = v.texcoord; - return o; - } - - float4 frag(v2f i) : COLOR { - return tex2D(_MainTex, i.tex); - } - - float4 frag_linear(v2f i) : COLOR { - return pow(tex2D(_MainTex, i.tex), 1.0 / 2.2); - } - - ENDCG - - SubShader { - Pass { - ZTest Always Cull Off ZWrite Off - Fog { Mode Off } - - CGPROGRAM - #pragma vertex vert - #pragma fragment frag - ENDCG - } - Pass { - ZTest Always Cull Off ZWrite Off - Fog { Mode Off } - - CGPROGRAM - #pragma vertex vert - #pragma fragment frag_linear - ENDCG - } - } -} diff --git a/Assets/SteamVR/Resources/SteamVR_Blit.shader.meta b/Assets/SteamVR/Resources/SteamVR_Blit.shader.meta deleted file mode 100644 index 98528ca..0000000 --- a/Assets/SteamVR/Resources/SteamVR_Blit.shader.meta +++ /dev/null @@ -1,9 +0,0 @@ -fileFormatVersion: 2 -guid: 021228b76f139394fae4afb56cd6bf29 -timeCreated: 1465931332 -licenseType: Free -ShaderImporter: - defaultTextures: [] - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/SteamVR/Resources/SteamVR_BlitFlip.shader b/Assets/SteamVR/Resources/SteamVR_BlitFlip.shader deleted file mode 100644 index 00d9343..0000000 --- a/Assets/SteamVR/Resources/SteamVR_BlitFlip.shader +++ /dev/null @@ -1,40 +0,0 @@ -Shader "Custom/SteamVR_BlitFlip" { - Properties { _MainTex ("Base (RGB)", 2D) = "white" {} } - - CGINCLUDE - - #include "UnityCG.cginc" - - sampler2D _MainTex; - - struct v2f { - float4 pos : SV_POSITION; - float2 tex : TEXCOORD0; - }; - - v2f vert(appdata_base v) { - v2f o; - o.pos = mul(UNITY_MATRIX_MVP, v.vertex); - o.tex.x = v.texcoord.x; - o.tex.y = 1 - v.texcoord.y; - return o; - } - - float4 frag(v2f i) : COLOR { - return tex2D(_MainTex, i.tex); - } - - ENDCG - - SubShader { - Pass { - ZTest Always Cull Off ZWrite Off - Fog { Mode Off } - - CGPROGRAM - #pragma vertex vert - #pragma fragment frag - ENDCG - } - } -} diff --git a/Assets/SteamVR/Resources/SteamVR_BlitFlip.shader.meta b/Assets/SteamVR/Resources/SteamVR_BlitFlip.shader.meta deleted file mode 100644 index 1b6b751..0000000 --- a/Assets/SteamVR/Resources/SteamVR_BlitFlip.shader.meta +++ /dev/null @@ -1,9 +0,0 @@ -fileFormatVersion: 2 -guid: 7f38d614fcfa3b541bde2acda92af7ca -timeCreated: 1465931347 -licenseType: Free -ShaderImporter: - defaultTextures: [] - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/SteamVR/Resources/SteamVR_HiddenArea.shader b/Assets/SteamVR/Resources/SteamVR_HiddenArea.shader deleted file mode 100644 index 31e62fb..0000000 --- a/Assets/SteamVR/Resources/SteamVR_HiddenArea.shader +++ /dev/null @@ -1,24 +0,0 @@ -Shader "Custom/SteamVR_HiddenArea" { - - CGINCLUDE - - #include "UnityCG.cginc" - - float4 vert(appdata_base v) : SV_POSITION { return v.vertex; } - float4 frag(float4 v : SV_POSITION) : COLOR { return float4(0,0,0,0); } - - ENDCG - - SubShader { - Tags { "Queue" = "Background" } - Pass { - ZTest Always Cull Off ZWrite On - Fog { Mode Off } - - CGPROGRAM - #pragma vertex vert - #pragma fragment frag - ENDCG - } - } -} diff --git a/Assets/SteamVR/Resources/SteamVR_HiddenArea.shader.meta b/Assets/SteamVR/Resources/SteamVR_HiddenArea.shader.meta deleted file mode 100644 index 0715bf0..0000000 --- a/Assets/SteamVR/Resources/SteamVR_HiddenArea.shader.meta +++ /dev/null @@ -1,9 +0,0 @@ -fileFormatVersion: 2 -guid: 7687f525efe9f4b449dfe5a7fe0b7c8e -timeCreated: 1428972938 -licenseType: Store -ShaderImporter: - defaultTextures: [] - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/SteamVR/Scripts.meta b/Assets/SteamVR/Scripts.meta index 3e07a77..1dd1d81 100644 --- a/Assets/SteamVR/Scripts.meta +++ b/Assets/SteamVR/Scripts.meta @@ -1,9 +1,6 @@ fileFormatVersion: 2 -guid: 95553d89c282bf141b499a612fd87915 +guid: d88af1b1098a33a42bc43c910c864102 folderAsset: yes -timeCreated: 1465633285 -licenseType: Free DefaultImporter: userData: assetBundleName: - assetBundleVariant: diff --git a/Assets/SteamVR/Scripts/SteamVR.cs b/Assets/SteamVR/Scripts/SteamVR.cs index c246a8c..06a7aea 100644 --- a/Assets/SteamVR/Scripts/SteamVR.cs +++ b/Assets/SteamVR/Scripts/SteamVR.cs @@ -1,11 +1,10 @@ -//========= Copyright 2014, Valve Corporation, All rights reserved. =========== +//======= Copyright (c) Valve Corporation, All rights reserved. =============== // // Purpose: Access to SteamVR system (hmd) and compositor (distort) interfaces. // //============================================================================= using UnityEngine; -using System.Runtime.InteropServices; using Valve.VR; public class SteamVR : System.IDisposable @@ -18,7 +17,12 @@ public class SteamVR : System.IDisposable private static bool _enabled = true; public static bool enabled { - get { return _enabled; } + get + { + if (!UnityEngine.VR.VRSettings.enabled) + enabled = false; + return _enabled; + } set { _enabled = value; @@ -54,14 +58,7 @@ public static SteamVR instance public static bool usingNativeSupport { - get - { -#if !(UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) - return UnityEngine.VR.VRDevice.GetNativePtr() != System.IntPtr.Zero; -#else - return false; -#endif - } + get { return UnityEngine.VR.VRDevice.GetNativePtr() != System.IntPtr.Zero; } } static SteamVR CreateInstance() @@ -71,18 +68,8 @@ static SteamVR CreateInstance() var error = EVRInitError.None; if (!SteamVR.usingNativeSupport) { -#if !(UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) Debug.Log("OpenVR initialization failed. Ensure 'Virtual Reality Supported' is checked in Player Settings, and OpenVR is added to the list of Virtual Reality SDKs."); return null; -#else - OpenVR.Init(ref error, EVRApplicationType.VRApplication_Overlay); - if (error != EVRInitError.None) - { - ReportError(error); - ShutdownSystems(); - return null; - } -#endif } // Verify common interfaces are valid. @@ -91,7 +78,6 @@ static SteamVR CreateInstance() if (error != EVRInitError.None) { ReportError(error); - ShutdownSystems(); return null; } @@ -99,7 +85,6 @@ static SteamVR CreateInstance() if (error != EVRInitError.None) { ReportError(error); - ShutdownSystems(); return null; } } @@ -153,7 +138,7 @@ static void ReportError(EVRInitError error) public Vector2 tanHalfFov { get; private set; } public VRTextureBounds_t[] textureBounds { get; private set; } public SteamVR_Utils.RigidTransform[] eyes { get; private set; } - public EGraphicsAPIConvention graphicsAPI; + public ETextureType textureType; // hmd properties public string hmd_TrackingSystemName { get { return GetStringProperty(ETrackedDeviceProperty.Prop_TrackingSystemName_String); } } @@ -197,31 +182,28 @@ float GetFloatProperty(ETrackedDeviceProperty prop) #region Event callbacks - private void OnInitializing(params object[] args) + private void OnInitializing(bool initializing) { - initializing = (bool)args[0]; + SteamVR.initializing = initializing; } - private void OnCalibrating(params object[] args) + private void OnCalibrating(bool calibrating) { - calibrating = (bool)args[0]; + SteamVR.calibrating = calibrating; } - private void OnOutOfRange(params object[] args) + private void OnOutOfRange(bool outOfRange) { - outOfRange = (bool)args[0]; + SteamVR.outOfRange = outOfRange; } - private void OnDeviceConnected(params object[] args) + private void OnDeviceConnected(int i, bool connected) { - var i = (int)args[0]; - connected[i] = (bool)args[1]; + SteamVR.connected[i] = connected; } - private void OnNewPoses(params object[] args) + private void OnNewPoses(TrackedDevicePose_t[] poses) { - var poses = (TrackedDevicePose_t[])args[0]; - // Update eye offsets to account for IPD changes. eyes[0] = new SteamVR_Utils.RigidTransform(hmd.GetEyeToHeadTransform(EVREye.Eye_Left)); eyes[1] = new SteamVR_Utils.RigidTransform(hmd.GetEyeToHeadTransform(EVREye.Eye_Right)); @@ -231,7 +213,7 @@ private void OnNewPoses(params object[] args) var connected = poses[i].bDeviceIsConnected; if (connected != SteamVR.connected[i]) { - SteamVR_Utils.Event.Send("device_connected", i, connected); + SteamVR_Events.DeviceConnected.Send(i, connected); } } @@ -242,7 +224,7 @@ private void OnNewPoses(params object[] args) var initializing = result == ETrackingResult.Uninitialized; if (initializing != SteamVR.initializing) { - SteamVR_Utils.Event.Send("initializing", initializing); + SteamVR_Events.Initializing.Send(initializing); } var calibrating = @@ -250,7 +232,7 @@ private void OnNewPoses(params object[] args) result == ETrackingResult.Calibrating_OutOfRange; if (calibrating != SteamVR.calibrating) { - SteamVR_Utils.Event.Send("calibrating", calibrating); + SteamVR_Events.Calibrating.Send(calibrating); } var outOfRange = @@ -258,7 +240,7 @@ private void OnNewPoses(params object[] args) result == ETrackingResult.Calibrating_OutOfRange; if (outOfRange != SteamVR.outOfRange) { - SteamVR_Utils.Event.Send("out_of_range", outOfRange); + SteamVR_Events.OutOfRange.Send(outOfRange); } } } @@ -301,9 +283,6 @@ private SteamVR() textureBounds[1].vMin = 0.5f - 0.5f * r_bottom / tanHalfFov.y; textureBounds[1].vMax = 0.5f - 0.5f * r_top / tanHalfFov.y; -#if (UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) - SteamVR.Unity.SetSubmitParams(textureBounds[0], textureBounds[1], EVRSubmitFlags.Submit_Default); -#endif // Grow the recommended size to account for the overlapping fov sceneWidth = sceneWidth / Mathf.Max(textureBounds[0].uMax - textureBounds[0].uMin, textureBounds[1].uMax - textureBounds[1].uMin); sceneHeight = sceneHeight / Mathf.Max(textureBounds[0].vMax - textureBounds[0].vMin, textureBounds[1].vMax - textureBounds[1].vMin); @@ -315,16 +294,31 @@ private SteamVR() new SteamVR_Utils.RigidTransform(hmd.GetEyeToHeadTransform(EVREye.Eye_Left)), new SteamVR_Utils.RigidTransform(hmd.GetEyeToHeadTransform(EVREye.Eye_Right)) }; - if (SystemInfo.graphicsDeviceVersion.StartsWith("OpenGL")) - graphicsAPI = EGraphicsAPIConvention.API_OpenGL; - else - graphicsAPI = EGraphicsAPIConvention.API_DirectX; + switch (SystemInfo.graphicsDeviceType) + { +#if (UNITY_5_4) + case UnityEngine.Rendering.GraphicsDeviceType.OpenGL2: +#endif + case UnityEngine.Rendering.GraphicsDeviceType.OpenGLCore: + case UnityEngine.Rendering.GraphicsDeviceType.OpenGLES2: + case UnityEngine.Rendering.GraphicsDeviceType.OpenGLES3: + textureType = ETextureType.OpenGL; + break; +#if !(UNITY_5_4) + case UnityEngine.Rendering.GraphicsDeviceType.Vulkan: + textureType = ETextureType.Vulkan; + break; +#endif + default: + textureType = ETextureType.DirectX; + break; + } - SteamVR_Utils.Event.Listen("initializing", OnInitializing); - SteamVR_Utils.Event.Listen("calibrating", OnCalibrating); - SteamVR_Utils.Event.Listen("out_of_range", OnOutOfRange); - SteamVR_Utils.Event.Listen("device_connected", OnDeviceConnected); - SteamVR_Utils.Event.Listen("new_poses", OnNewPoses); + SteamVR_Events.Initializing.Listen(OnInitializing); + SteamVR_Events.Calibrating.Listen(OnCalibrating); + SteamVR_Events.OutOfRange.Listen(OnOutOfRange); + SteamVR_Events.DeviceConnected.Listen(OnDeviceConnected); + SteamVR_Events.NewPoses.Listen(OnNewPoses); } ~SteamVR() @@ -340,52 +334,20 @@ public void Dispose() private void Dispose(bool disposing) { - SteamVR_Utils.Event.Remove("initializing", OnInitializing); - SteamVR_Utils.Event.Remove("calibrating", OnCalibrating); - SteamVR_Utils.Event.Remove("out_of_range", OnOutOfRange); - SteamVR_Utils.Event.Remove("device_connected", OnDeviceConnected); - SteamVR_Utils.Event.Remove("new_poses", OnNewPoses); + SteamVR_Events.Initializing.Remove(OnInitializing); + SteamVR_Events.Calibrating.Remove(OnCalibrating); + SteamVR_Events.OutOfRange.Remove(OnOutOfRange); + SteamVR_Events.DeviceConnected.Remove(OnDeviceConnected); + SteamVR_Events.NewPoses.Remove(OnNewPoses); - ShutdownSystems(); _instance = null; } - private static void ShutdownSystems() - { -#if (UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) - OpenVR.Shutdown(); -#endif - } - // Use this interface to avoid accidentally creating the instance in the process of attempting to dispose of it. public static void SafeDispose() { if (_instance != null) _instance.Dispose(); } - -#if (UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) - // Unityhooks in openvr_api. - public class Unity - { - public const int k_nRenderEventID_WaitGetPoses = 201510020; - public const int k_nRenderEventID_SubmitL = 201510021; - public const int k_nRenderEventID_SubmitR = 201510022; - public const int k_nRenderEventID_Flush = 201510023; - public const int k_nRenderEventID_PostPresentHandoff = 201510024; - - [DllImport("openvr_api", EntryPoint = "UnityHooks_GetRenderEventFunc")] - public static extern System.IntPtr GetRenderEventFunc(); - - [DllImport("openvr_api", EntryPoint = "UnityHooks_SetSubmitParams")] - public static extern void SetSubmitParams(VRTextureBounds_t boundsL, VRTextureBounds_t boundsR, EVRSubmitFlags nSubmitFlags); - - [DllImport("openvr_api", EntryPoint = "UnityHooks_SetColorSpace")] - public static extern void SetColorSpace(EColorSpace eColorSpace); - - [DllImport("openvr_api", EntryPoint = "UnityHooks_EventWriteString")] - public static extern void EventWriteString([In, MarshalAs(UnmanagedType.LPWStr)] string sEvent); - } -#endif } diff --git a/Assets/SteamVR/Scripts/SteamVR_Camera.cs b/Assets/SteamVR/Scripts/SteamVR_Camera.cs index d041257..f70058c 100644 --- a/Assets/SteamVR/Scripts/SteamVR_Camera.cs +++ b/Assets/SteamVR/Scripts/SteamVR_Camera.cs @@ -1,4 +1,4 @@ -//========= Copyright 2014, Valve Corporation, All rights reserved. =========== +//======= Copyright (c) Valve Corporation, All rights reserved. =============== // // Purpose: Adds SteamVR render support to existing camera objects // @@ -18,6 +18,8 @@ public class SteamVR_Camera : MonoBehaviour public Transform offset { get { return _head; } } // legacy public Transform origin { get { return _head.parent; } } + public new Camera camera { get; private set; } + [SerializeField] private Transform _ears; public Transform ears { get { return _ears; } } @@ -29,63 +31,11 @@ public Ray GetRay() public bool wireframe = false; - [SerializeField] - private SteamVR_CameraFlip flip; - - #region Materials - - static public Material blitMaterial; - -#if (UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) - // Using a single shared offscreen buffer to render the scene. This needs to be larger - // than the backbuffer to account for distortion correction. The default resolution - // gives us 1:1 sized pixels in the center of view, but quality can be adjusted up or - // down using the following scale value to balance performance. - static public float sceneResolutionScale = 1.0f; - static private RenderTexture _sceneTexture; - static public RenderTexture GetSceneTexture(bool hdr) - { - var vr = SteamVR.instance; - if (vr == null) - return null; - - int w = (int)(vr.sceneWidth * sceneResolutionScale); - int h = (int)(vr.sceneHeight * sceneResolutionScale); - int aa = QualitySettings.antiAliasing == 0 ? 1 : QualitySettings.antiAliasing; - var format = hdr ? RenderTextureFormat.ARGBHalf : RenderTextureFormat.ARGB32; - - if (_sceneTexture != null) - { - if (_sceneTexture.width != w || _sceneTexture.height != h || _sceneTexture.antiAliasing != aa || _sceneTexture.format != format) - { - Debug.Log(string.Format("Recreating scene texture.. Old: {0}x{1} MSAA={2} [{3}] New: {4}x{5} MSAA={6} [{7}]", - _sceneTexture.width, _sceneTexture.height, _sceneTexture.antiAliasing, _sceneTexture.format, w, h, aa, format)); - Object.Destroy(_sceneTexture); - _sceneTexture = null; - } - } - - if (_sceneTexture == null) - { - _sceneTexture = new RenderTexture(w, h, 0, format); - _sceneTexture.antiAliasing = aa; - - // OpenVR assumes floating point render targets are linear unless otherwise specified. - var colorSpace = (hdr && QualitySettings.activeColorSpace == ColorSpace.Gamma) ? EColorSpace.Gamma : EColorSpace.Auto; - SteamVR.Unity.SetColorSpace(colorSpace); - } - - return _sceneTexture; - } -#else static public float sceneResolutionScale { get { return UnityEngine.VR.VRSettings.renderScale; } set { UnityEngine.VR.VRSettings.renderScale = value; } } -#endif - - #endregion #region Enable / Disable @@ -102,17 +52,13 @@ void OnEnable() { if (head != null) { - head.GetComponent().enabled = false; head.GetComponent().enabled = false; } - if (flip != null) - flip.enabled = false; - enabled = false; return; } -#if !(UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) + // Convert camera rig for native OpenVR integration. var t = transform; if (head != t) @@ -135,42 +81,6 @@ void OnEnable() _head = t; } - if (flip != null) - { - DestroyImmediate(flip); - flip = null; - } -#else - // Ensure rig is properly set up - Expand(); - - if (blitMaterial == null) - { - blitMaterial = new Material(Shader.Find("Custom/SteamVR_Blit")); - } - - // Set remaining hmd specific settings - var camera = GetComponent(); - camera.fieldOfView = vr.fieldOfView; - camera.aspect = vr.aspect; - camera.eventMask = 0; // disable mouse events - camera.orthographic = false; // force perspective - camera.enabled = false; // manually rendered by SteamVR_Render - - if (camera.actualRenderingPath != RenderingPath.Forward && QualitySettings.antiAliasing > 1) - { - Debug.LogWarning("MSAA only supported in Forward rendering path. (disabling MSAA)"); - QualitySettings.antiAliasing = 0; - } - - // Ensure game view camera hdr setting matches - var headCam = head.GetComponent(); - if (headCam != null) - { - headCam.hdr = camera.hdr; - headCam.renderingPath = camera.renderingPath; - } -#endif if (ears == null) { var e = transform.GetComponentInChildren(); @@ -188,7 +98,11 @@ void OnEnable() #region Functionality to ensure SteamVR_Camera component is always the last component on an object - void Awake() { ForceLast(); } + void Awake() + { + camera = GetComponent(); // cached to avoid runtime lookup + ForceLast(); + } static Hashtable values; @@ -215,23 +129,14 @@ public void ForceLast() var c = components[i] as SteamVR_Camera; if (c != null && c != this) { - if (c.flip != null) - DestroyImmediate(c.flip); DestroyImmediate(c); } } components = GetComponents(); -#if !(UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) if (this != components[components.Length - 1]) { -#else - if (this != components[components.Length - 1] || flip == null) - { - if (flip == null) - flip = gameObject.AddComponent(); -#endif // Store off values to be restored on new instance values = new Hashtable(); var fields = GetType().GetFields(BindingFlags.Instance | BindingFlags.NonPublic | BindingFlags.Public); @@ -275,22 +180,12 @@ public void Expand() if (head == null) { - _head = new GameObject(name + headSuffix, typeof(SteamVR_GameView), typeof(SteamVR_TrackedObject)).transform; + _head = new GameObject(name + headSuffix, typeof(SteamVR_TrackedObject)).transform; head.parent = _origin; head.position = transform.position; head.rotation = transform.rotation; head.localScale = Vector3.one; head.tag = tag; - - var camera = head.GetComponent(); - camera.clearFlags = CameraClearFlags.Nothing; - camera.cullingMask = 0; - camera.eventMask = 0; - camera.orthographic = true; - camera.orthographicSize = 1; - camera.nearClipPlane = 0; - camera.farClipPlane = 1; - camera.useOcclusionCulling = false; } if (transform.parent != head) @@ -378,70 +273,5 @@ public void Collapse() } #endregion - -#if (UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) - - #region Render callbacks - - void OnPreRender() - { - if (flip) - flip.enabled = (SteamVR_Render.Top() == this && SteamVR.instance.graphicsAPI == EGraphicsAPIConvention.API_DirectX); - - var headCam = head.GetComponent(); - if (headCam != null) - headCam.enabled = (SteamVR_Render.Top() == this); - - if (wireframe) - GL.wireframe = true; - } - - void OnPostRender() - { - if (wireframe) - GL.wireframe = false; - } - - void OnRenderImage(RenderTexture src, RenderTexture dest) - { - if (SteamVR_Render.Top() == this) - { - int eventID; - if (SteamVR_Render.eye == EVREye.Eye_Left) - { - // Get gpu started on work early to avoid bubbles at the top of the frame. - SteamVR_Utils.QueueEventOnRenderThread(SteamVR.Unity.k_nRenderEventID_Flush); - - eventID = SteamVR.Unity.k_nRenderEventID_SubmitL; - } - else - { - eventID = SteamVR.Unity.k_nRenderEventID_SubmitR; - } - - // Queue up a call on the render thread to Submit our render target to the compositor. - SteamVR_Utils.QueueEventOnRenderThread(eventID); - } - - Graphics.SetRenderTarget(dest); - SteamVR_Camera.blitMaterial.mainTexture = src; - - GL.PushMatrix(); - GL.LoadOrtho(); - SteamVR_Camera.blitMaterial.SetPass(0); - GL.Begin(GL.QUADS); - GL.TexCoord2(0.0f, 0.0f); GL.Vertex3(-1, 1, 0); - GL.TexCoord2(1.0f, 0.0f); GL.Vertex3( 1, 1, 0); - GL.TexCoord2(1.0f, 1.0f); GL.Vertex3( 1, -1, 0); - GL.TexCoord2(0.0f, 1.0f); GL.Vertex3(-1, -1, 0); - GL.End(); - GL.PopMatrix(); - - Graphics.SetRenderTarget(null); - } - - #endregion - -#endif } diff --git a/Assets/SteamVR/Scripts/SteamVR_CameraFlip.cs b/Assets/SteamVR/Scripts/SteamVR_CameraFlip.cs index 97e6854..c1b150e 100644 --- a/Assets/SteamVR/Scripts/SteamVR_CameraFlip.cs +++ b/Assets/SteamVR/Scripts/SteamVR_CameraFlip.cs @@ -1,25 +1,18 @@ -//========= Copyright 2015, Valve Corporation, All rights reserved. =========== +//======= Copyright (c) Valve Corporation, All rights reserved. =============== // // Purpose: Flips the camera output back to normal for D3D. // //============================================================================= using UnityEngine; -using System.Collections; +[ExecuteInEditMode] public class SteamVR_CameraFlip : MonoBehaviour { - static Material blitMaterial; - - void OnEnable() - { - if (blitMaterial == null) - blitMaterial = new Material(Shader.Find("Custom/SteamVR_BlitFlip")); - } - - void OnRenderImage(RenderTexture src, RenderTexture dest) + void Awake() { - Graphics.Blit(src, dest, blitMaterial); + Debug.Log("SteamVR_CameraFlip is deprecated in Unity 5.4 - REMOVING"); + DestroyImmediate(this); } } diff --git a/Assets/SteamVR/Scripts/SteamVR_CameraMask.cs b/Assets/SteamVR/Scripts/SteamVR_CameraMask.cs index e16205d..3aefb4e 100644 --- a/Assets/SteamVR/Scripts/SteamVR_CameraMask.cs +++ b/Assets/SteamVR/Scripts/SteamVR_CameraMask.cs @@ -1,51 +1,18 @@ -//========= Copyright 2014, Valve Corporation, All rights reserved. =========== +//======= Copyright (c) Valve Corporation, All rights reserved. =============== // // Purpose: Masks out pixels that cannot be seen through the connected hmd. // //============================================================================= using UnityEngine; -using System.Collections; -using UnityEngine.Rendering; -[RequireComponent(typeof(MeshFilter), typeof(MeshRenderer))] +[ExecuteInEditMode] public class SteamVR_CameraMask : MonoBehaviour { - static Material material; - static Mesh[] hiddenAreaMeshes = new Mesh[] { null, null }; - - MeshFilter meshFilter; - void Awake() { - meshFilter = GetComponent(); - - if (material == null) - material = new Material(Shader.Find("Custom/SteamVR_HiddenArea")); - - var mr = GetComponent(); - mr.material = material; - mr.shadowCastingMode = ShadowCastingMode.Off; - mr.receiveShadows = false; -#if !(UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) - mr.lightProbeUsage = LightProbeUsage.Off; -#else - mr.useLightProbes = false; -#endif - mr.reflectionProbeUsage = ReflectionProbeUsage.Off; - } - - public void Set(SteamVR vr, Valve.VR.EVREye eye) - { - int i = (int)eye; - if (hiddenAreaMeshes[i] == null) - hiddenAreaMeshes[i] = SteamVR_Utils.CreateHiddenAreaMesh(vr.hmd.GetHiddenAreaMesh(eye), vr.textureBounds[i]); - meshFilter.mesh = hiddenAreaMeshes[i]; - } - - public void Clear() - { - meshFilter.mesh = null; + Debug.Log("SteamVR_CameraMask is deprecated in Unity 5.4 - REMOVING"); + DestroyImmediate(this); } } diff --git a/Assets/SteamVR/Scripts/SteamVR_Controller.cs b/Assets/SteamVR/Scripts/SteamVR_Controller.cs index 95c1ac0..bfaef94 100644 --- a/Assets/SteamVR/Scripts/SteamVR_Controller.cs +++ b/Assets/SteamVR/Scripts/SteamVR_Controller.cs @@ -1,4 +1,4 @@ -//========= Copyright 2015, Valve Corporation, All rights reserved. =========== +//======= Copyright (c) Valve Corporation, All rights reserved. =============== // // Purpose: Wrapper for working with SteamVR controller input // @@ -65,7 +65,7 @@ public void Update() var system = OpenVR.System; if (system != null) { - valid = system.GetControllerStateWithPose(SteamVR_Render.instance.trackingSpace, index, ref state, ref pose); + valid = system.GetControllerStateWithPose(SteamVR_Render.instance.trackingSpace, index, ref state, (uint)System.Runtime.InteropServices.Marshal.SizeOf(typeof(VRControllerState_t)), ref pose); UpdateHairTrigger(); } } diff --git a/Assets/SteamVR/Scripts/SteamVR_ControllerManager.cs b/Assets/SteamVR/Scripts/SteamVR_ControllerManager.cs index ad3b116..832fbd8 100644 --- a/Assets/SteamVR/Scripts/SteamVR_ControllerManager.cs +++ b/Assets/SteamVR/Scripts/SteamVR_ControllerManager.cs @@ -10,228 +10,248 @@ public class SteamVR_ControllerManager : MonoBehaviour { - public GameObject left, right; - public GameObject[] objects; // populate with objects you want to assign to additional controllers - - uint[] indices; // assigned - bool[] connected = new bool[OpenVR.k_unMaxTrackedDeviceCount]; // controllers only - - // cached roles - may or may not be connected - uint leftIndex = OpenVR.k_unTrackedDeviceIndexInvalid; - uint rightIndex = OpenVR.k_unTrackedDeviceIndexInvalid; - - void Awake() - { - // Add left and right entries to the head of the list so we only have to operate on the list itself. - var additional = (this.objects != null) ? this.objects.Length : 0; - var objects = new GameObject[2 + additional]; - indices = new uint[2 + additional]; - objects[0] = right; - indices[0] = OpenVR.k_unTrackedDeviceIndexInvalid; - objects[1] = left; - indices[1] = OpenVR.k_unTrackedDeviceIndexInvalid; - for (int i = 0; i < additional; i++) - { - objects[2 + i] = this.objects[i]; - indices[2 + i] = OpenVR.k_unTrackedDeviceIndexInvalid; - } - this.objects = objects; - } - - void OnEnable() - { - for (int i = 0; i < objects.Length; i++) - { - var obj = objects[i]; - if (obj != null) - obj.SetActive(false); - } - - OnTrackedDeviceRoleChanged(); - - for (int i = 0; i < SteamVR.connected.Length; i++) - if (SteamVR.connected[i]) - OnDeviceConnected(i, true); - - SteamVR_Utils.Event.Listen("input_focus", OnInputFocus); - SteamVR_Utils.Event.Listen("device_connected", OnDeviceConnected); - SteamVR_Utils.Event.Listen("TrackedDeviceRoleChanged", OnTrackedDeviceRoleChanged); - } - - void OnDisable() - { - SteamVR_Utils.Event.Remove("input_focus", OnInputFocus); - SteamVR_Utils.Event.Remove("device_connected", OnDeviceConnected); - SteamVR_Utils.Event.Remove("TrackedDeviceRoleChanged", OnTrackedDeviceRoleChanged); - } - - static string[] labels = { "left", "right" }; - - // Hide controllers when the dashboard is up. - private void OnInputFocus(params object[] args) - { - bool hasFocus = (bool)args[0]; - if (hasFocus) - { - for (int i = 0; i < objects.Length; i++) - { - var obj = objects[i]; - if (obj != null) - { - var label = (i < 2) ? labels[i] : (i - 1).ToString(); - ShowObject(obj.transform, "hidden (" + label + ")"); - } - } - } - else - { - for (int i = 0; i < objects.Length; i++) - { - var obj = objects[i]; - if (obj != null) - { - var label = (i < 2) ? labels[i] : (i - 1).ToString(); - HideObject(obj.transform, "hidden (" + label + ")"); - } - } - } - } - - // Reparents to a new object and deactivates that object (this allows - // us to call SetActive in OnDeviceConnected independently. - private void HideObject(Transform t, string name) - { - var hidden = new GameObject(name).transform; - hidden.parent = t.parent; - t.parent = hidden; - hidden.gameObject.SetActive(false); - } - private void ShowObject(Transform t, string name) - { - var hidden = t.parent; - if (hidden.gameObject.name != name) - return; - t.parent = hidden.parent; - Destroy(hidden.gameObject); - } - - private void SetTrackedDeviceIndex(int objectIndex, uint trackedDeviceIndex) - { - // First make sure no one else is already using this index. - if (trackedDeviceIndex != OpenVR.k_unTrackedDeviceIndexInvalid) - { - for (int i = 0; i < objects.Length; i++) - { - if (i != objectIndex && indices[i] == trackedDeviceIndex) - { - var obj = objects[i]; - if (obj != null) - obj.SetActive(false); - - indices[i] = OpenVR.k_unTrackedDeviceIndexInvalid; - } - } - } - - // Only set when changed. - if (trackedDeviceIndex != indices[objectIndex]) - { - indices[objectIndex] = trackedDeviceIndex; - - var obj = objects[objectIndex]; - if (obj != null) - { - if (trackedDeviceIndex == OpenVR.k_unTrackedDeviceIndexInvalid) - obj.SetActive(false); - else - { - obj.SetActive(true); - obj.BroadcastMessage("SetDeviceIndex", (int)trackedDeviceIndex, SendMessageOptions.DontRequireReceiver); - } - } - } - } - - // Keep track of assigned roles. - private void OnTrackedDeviceRoleChanged(params object[] args) - { - Refresh(); - } - - // Keep track of connected controller indices. - private void OnDeviceConnected(params object[] args) - { - var index = (uint)(int)args[0]; - bool changed = this.connected[index]; - this.connected[index] = false; - - var connected = (bool)args[1]; - if (connected) - { - var system = OpenVR.System; - if (system != null && system.GetTrackedDeviceClass(index) == ETrackedDeviceClass.Controller) - { - this.connected[index] = true; - changed = !changed; // if we clear and set the same index, nothing has changed - } - } - - if (changed) - Refresh(); - } - - public void Refresh() - { - int objectIndex = 0; - - var system = OpenVR.System; - if (system != null) - { - leftIndex = system.GetTrackedDeviceIndexForControllerRole(ETrackedControllerRole.LeftHand); - rightIndex = system.GetTrackedDeviceIndexForControllerRole(ETrackedControllerRole.RightHand); - } - - // If neither role has been assigned yet, try hooking up at least the right controller. - if (leftIndex == OpenVR.k_unTrackedDeviceIndexInvalid && rightIndex == OpenVR.k_unTrackedDeviceIndexInvalid) - { - for (uint deviceIndex = 0; deviceIndex < connected.Length; deviceIndex++) - { - if (connected[deviceIndex]) - { - SetTrackedDeviceIndex(objectIndex++, deviceIndex); - break; - } - } - } - else - { - SetTrackedDeviceIndex(objectIndex++, (rightIndex < connected.Length && connected[rightIndex]) ? rightIndex : OpenVR.k_unTrackedDeviceIndexInvalid); - SetTrackedDeviceIndex(objectIndex++, (leftIndex < connected.Length && connected[leftIndex]) ? leftIndex : OpenVR.k_unTrackedDeviceIndexInvalid); - - // Assign out any additional controllers only after both left and right have been assigned. - if (leftIndex != OpenVR.k_unTrackedDeviceIndexInvalid && rightIndex != OpenVR.k_unTrackedDeviceIndexInvalid) - { - for (uint deviceIndex = 0; deviceIndex < connected.Length; deviceIndex++) - { - if (objectIndex >= objects.Length) - break; - - if (!connected[deviceIndex]) - continue; - - if (deviceIndex != leftIndex && deviceIndex != rightIndex) - { - SetTrackedDeviceIndex(objectIndex++, deviceIndex); - } - } - } - } - - // Reset the rest. - while (objectIndex < objects.Length) - { - SetTrackedDeviceIndex(objectIndex++, OpenVR.k_unTrackedDeviceIndexInvalid); - } - } + public GameObject left, right; + public GameObject[] objects; // populate with objects you want to assign to additional controllers + + public bool assignAllBeforeIdentified; // set to true if you want objects arbitrarily assigned to controllers before their role (left vs right) is identified + + uint[] indices; // assigned + bool[] connected = new bool[OpenVR.k_unMaxTrackedDeviceCount]; // controllers only + + // cached roles - may or may not be connected + uint leftIndex = OpenVR.k_unTrackedDeviceIndexInvalid; + uint rightIndex = OpenVR.k_unTrackedDeviceIndexInvalid; + + // This needs to be called if you update left, right or objects at runtime (e.g. when dyanmically spawned). + public void UpdateTargets() + { + // Add left and right entries to the head of the list so we only have to operate on the list itself. + var additional = (this.objects != null) ? this.objects.Length : 0; + var objects = new GameObject[2 + additional]; + indices = new uint[2 + additional]; + objects[0] = right; + indices[0] = OpenVR.k_unTrackedDeviceIndexInvalid; + objects[1] = left; + indices[1] = OpenVR.k_unTrackedDeviceIndexInvalid; + for (int i = 0; i < additional; i++) + { + objects[2 + i] = this.objects[i]; + indices[2 + i] = OpenVR.k_unTrackedDeviceIndexInvalid; + } + this.objects = objects; + } + + SteamVR_Events.Action inputFocusAction, deviceConnectedAction, trackedDeviceRoleChangedAction; + + void Awake() + { + UpdateTargets(); + inputFocusAction = SteamVR_Events.InputFocusAction(OnInputFocus); + deviceConnectedAction = SteamVR_Events.DeviceConnectedAction(OnDeviceConnected); + trackedDeviceRoleChangedAction = SteamVR_Events.SystemAction(EVREventType.VREvent_TrackedDeviceRoleChanged, OnTrackedDeviceRoleChanged); + } + + void OnEnable() + { + for (int i = 0; i < objects.Length; i++) + { + var obj = objects[i]; + if (obj != null) + obj.SetActive(false); + } + + Refresh(); + + for (int i = 0; i < SteamVR.connected.Length; i++) + if (SteamVR.connected[i]) + OnDeviceConnected(i, true); + + inputFocusAction.enabled = true; + deviceConnectedAction.enabled = true; + trackedDeviceRoleChangedAction.enabled = true; + } + + void OnDisable() + { + inputFocusAction.enabled = false; + deviceConnectedAction.enabled = false; + trackedDeviceRoleChangedAction.enabled = false; + } + + static string[] labels = { "left", "right" }; + + // Hide controllers when the dashboard is up. + private void OnInputFocus(bool hasFocus) + { + if (hasFocus) + { + for (int i = 0; i < objects.Length; i++) + { + var obj = objects[i]; + if (obj != null) + { + var label = (i < 2) ? labels[i] : (i - 1).ToString(); + ShowObject(obj.transform, "hidden (" + label + ")"); + } + } + } + else + { + for (int i = 0; i < objects.Length; i++) + { + var obj = objects[i]; + if (obj != null) + { + var label = (i < 2) ? labels[i] : (i - 1).ToString(); + HideObject(obj.transform, "hidden (" + label + ")"); + } + } + } + } + + // Reparents to a new object and deactivates that object (this allows + // us to call SetActive in OnDeviceConnected independently. + private void HideObject(Transform t, string name) + { + var hidden = new GameObject(name).transform; + hidden.parent = t.parent; + t.parent = hidden; + hidden.gameObject.SetActive(false); + } + private void ShowObject(Transform t, string name) + { + var hidden = t.parent; + if (hidden.gameObject.name != name) + return; + t.parent = hidden.parent; + Destroy(hidden.gameObject); + } + + private void SetTrackedDeviceIndex(int objectIndex, uint trackedDeviceIndex) + { + // First make sure no one else is already using this index. + if (trackedDeviceIndex != OpenVR.k_unTrackedDeviceIndexInvalid) + { + for (int i = 0; i < objects.Length; i++) + { + if (i != objectIndex && indices[i] == trackedDeviceIndex) + { + var obj = objects[i]; + if (obj != null) + obj.SetActive(false); + + indices[i] = OpenVR.k_unTrackedDeviceIndexInvalid; + } + } + } + + // Only set when changed. + if (trackedDeviceIndex != indices[objectIndex]) + { + indices[objectIndex] = trackedDeviceIndex; + + var obj = objects[objectIndex]; + if (obj != null) + { + if (trackedDeviceIndex == OpenVR.k_unTrackedDeviceIndexInvalid) + obj.SetActive(false); + else + { + obj.SetActive(true); + obj.BroadcastMessage("SetDeviceIndex", (int)trackedDeviceIndex, SendMessageOptions.DontRequireReceiver); + } + } + } + } + + // Keep track of assigned roles. + private void OnTrackedDeviceRoleChanged(VREvent_t vrEvent) + { + Refresh(); + } + + // Keep track of connected controller indices. + private void OnDeviceConnected(int index, bool connected) + { + bool changed = this.connected[index]; + this.connected[index] = false; + + if (connected) + { + var system = OpenVR.System; + if (system != null) + { + var deviceClass = system.GetTrackedDeviceClass((uint)index); + if (deviceClass == ETrackedDeviceClass.Controller || + deviceClass == ETrackedDeviceClass.GenericTracker) + { + this.connected[index] = true; + changed = !changed; // if we clear and set the same index, nothing has changed + } + } + } + + if (changed) + Refresh(); + } + + public void Refresh() + { + int objectIndex = 0; + + var system = OpenVR.System; + if (system != null) + { + leftIndex = system.GetTrackedDeviceIndexForControllerRole(ETrackedControllerRole.LeftHand); + rightIndex = system.GetTrackedDeviceIndexForControllerRole(ETrackedControllerRole.RightHand); + } + + // If neither role has been assigned yet, try hooking up at least the right controller. + if (leftIndex == OpenVR.k_unTrackedDeviceIndexInvalid && rightIndex == OpenVR.k_unTrackedDeviceIndexInvalid) + { + for (uint deviceIndex = 0; deviceIndex < connected.Length; deviceIndex++) + { + if (objectIndex >= objects.Length) + break; + + if (!connected[deviceIndex]) + continue; + + SetTrackedDeviceIndex(objectIndex++, deviceIndex); + + if (!assignAllBeforeIdentified) + break; + } + } + else + { + SetTrackedDeviceIndex(objectIndex++, (rightIndex < connected.Length && connected[rightIndex]) ? rightIndex : OpenVR.k_unTrackedDeviceIndexInvalid); + SetTrackedDeviceIndex(objectIndex++, (leftIndex < connected.Length && connected[leftIndex]) ? leftIndex : OpenVR.k_unTrackedDeviceIndexInvalid); + + // Assign out any additional controllers only after both left and right have been assigned. + if (leftIndex != OpenVR.k_unTrackedDeviceIndexInvalid && rightIndex != OpenVR.k_unTrackedDeviceIndexInvalid) + { + for (uint deviceIndex = 0; deviceIndex < connected.Length; deviceIndex++) + { + if (objectIndex >= objects.Length) + break; + + if (!connected[deviceIndex]) + continue; + + if (deviceIndex != leftIndex && deviceIndex != rightIndex) + { + SetTrackedDeviceIndex(objectIndex++, deviceIndex); + } + } + } + } + + // Reset the rest. + while (objectIndex < objects.Length) + { + SetTrackedDeviceIndex(objectIndex++, OpenVR.k_unTrackedDeviceIndexInvalid); + } + } } diff --git a/Assets/SteamVR/Scripts/SteamVR_ControllerManager.cs.meta b/Assets/SteamVR/Scripts/SteamVR_ControllerManager.cs.meta index cfd6376..8f4c60b 100644 --- a/Assets/SteamVR/Scripts/SteamVR_ControllerManager.cs.meta +++ b/Assets/SteamVR/Scripts/SteamVR_ControllerManager.cs.meta @@ -1,7 +1,7 @@ fileFormatVersion: 2 -guid: 1edaba0e604d1244a9245cd9a8306816 -timeCreated: 1465931117 -licenseType: Free +guid: e3b47c2980b93bc48844a54641dab5b8 +timeCreated: 1437430318 +licenseType: Store MonoImporter: serializedVersion: 2 defaultReferences: [] diff --git a/Assets/SteamVR/Scripts/SteamVR_Ears.cs b/Assets/SteamVR/Scripts/SteamVR_Ears.cs index 6428b1f..ccc83da 100644 --- a/Assets/SteamVR/Scripts/SteamVR_Ears.cs +++ b/Assets/SteamVR/Scripts/SteamVR_Ears.cs @@ -1,4 +1,4 @@ -//========= Copyright 2016, Valve Corporation, All rights reserved. =========== +//======= Copyright (c) Valve Corporation, All rights reserved. =============== // // Purpose: Handles aligning audio listener when using speakers. // @@ -15,7 +15,7 @@ public class SteamVR_Ears : MonoBehaviour bool usingSpeakers; Quaternion offset; - private void OnNewPosesApplied(params object[] args) + private void OnNewPosesApplied() { var origin = vrcam.origin; var baseRotation = origin != null ? origin.rotation : Quaternion.identity; @@ -30,23 +30,23 @@ void OnEnable() if (settings != null) { var error = EVRSettingsError.None; - if (settings.GetBool(OpenVR.k_pch_SteamVR_Section, OpenVR.k_pch_SteamVR_UsingSpeakers_Bool, false, ref error)) + if (settings.GetBool(OpenVR.k_pch_SteamVR_Section, OpenVR.k_pch_SteamVR_UsingSpeakers_Bool, ref error)) { usingSpeakers = true; - var yawOffset = settings.GetFloat(OpenVR.k_pch_SteamVR_Section, OpenVR.k_pch_SteamVR_SpeakersForwardYawOffsetDegrees_Float, 0.0f, ref error); + var yawOffset = settings.GetFloat(OpenVR.k_pch_SteamVR_Section, OpenVR.k_pch_SteamVR_SpeakersForwardYawOffsetDegrees_Float, ref error); offset = Quaternion.Euler(0.0f, yawOffset, 0.0f); } } if (usingSpeakers) - SteamVR_Utils.Event.Listen("new_poses_applied", OnNewPosesApplied); + SteamVR_Events.NewPosesApplied.Listen(OnNewPosesApplied); } void OnDisable() { if (usingSpeakers) - SteamVR_Utils.Event.Remove("new_poses_applied", OnNewPosesApplied); + SteamVR_Events.NewPosesApplied.Remove(OnNewPosesApplied); } } diff --git a/Assets/SteamVR/Scripts/SteamVR_Events.cs b/Assets/SteamVR/Scripts/SteamVR_Events.cs new file mode 100644 index 0000000..ba0dced --- /dev/null +++ b/Assets/SteamVR/Scripts/SteamVR_Events.cs @@ -0,0 +1,203 @@ +//======= Copyright (c) Valve Corporation, All rights reserved. =============== +// +// Purpose: Simple event system for SteamVR. +// +// Example usage: +// +// void OnDeviceConnected(int i, bool connected) { ... } +// SteamVR_Events.DeviceConnected.Listen(OnDeviceConnected); // Usually in OnEnable +// SteamVR_Events.DeviceConnected.Remove(OnDeviceConnected); // Usually in OnDisable +// +// Alternatively, if Listening/Removing often these can be cached as follows: +// +// SteamVR_Event.Action deviceConnectedAction; +// void OnAwake() { deviceConnectedAction = SteamVR_Event.DeviceConnectedAction(OnDeviceConnected); } +// void OnEnable() { deviceConnectedAction.enabled = true; } +// void OnDisable() { deviceConnectedAction.enabled = false; } +// +//============================================================================= + +using UnityEngine; +using UnityEngine.Events; +using Valve.VR; + +public static class SteamVR_Events +{ + public abstract class Action + { + public abstract void Enable(bool enabled); + public bool enabled { set { Enable(value); } } + } + + [System.Serializable] + public class ActionNoArgs : Action + { + public ActionNoArgs(Event _event, UnityAction action) + { + this._event = _event; + this.action = action; + } + + public override void Enable(bool enabled) + { + if (enabled) + _event.Listen(action); + else + _event.Remove(action); + } + + Event _event; + UnityAction action; + } + + [System.Serializable] + public class Action : Action + { + public Action(Event _event, UnityAction action) + { + this._event = _event; + this.action = action; + } + + public override void Enable(bool enabled) + { + if (enabled) + _event.Listen(action); + else + _event.Remove(action); + } + + Event _event; + UnityAction action; + } + + [System.Serializable] + public class Action : Action + { + public Action(Event _event, UnityAction action) + { + this._event = _event; + this.action = action; + } + + public override void Enable(bool enabled) + { + if (enabled) + _event.Listen(action); + else + _event.Remove(action); + } + + Event _event; + UnityAction action; + } + + [System.Serializable] + public class Action : Action + { + public Action(Event _event, UnityAction action) + { + this._event = _event; + this.action = action; + } + + public override void Enable(bool enabled) + { + if (enabled) + _event.Listen(action); + else + _event.Remove(action); + } + + Event _event; + UnityAction action; + } + + public class Event : UnityEvent + { + public void Listen(UnityAction action) { this.AddListener(action); } + public void Remove(UnityAction action) { this.RemoveListener(action); } + public void Send() { this.Invoke(); } + } + + public class Event : UnityEvent + { + public void Listen(UnityAction action) { this.AddListener(action); } + public void Remove(UnityAction action) { this.RemoveListener(action); } + public void Send(T arg0) { this.Invoke(arg0); } + } + + public class Event : UnityEvent + { + public void Listen(UnityAction action) { this.AddListener(action); } + public void Remove(UnityAction action) { this.RemoveListener(action); } + public void Send(T0 arg0, T1 arg1) { this.Invoke(arg0, arg1); } + } + + public class Event : UnityEvent + { + public void Listen(UnityAction action) { this.AddListener(action); } + public void Remove(UnityAction action) { this.RemoveListener(action); } + public void Send(T0 arg0, T1 arg1, T2 arg2) { this.Invoke(arg0, arg1, arg2); } + } + + public static Event Calibrating = new Event(); + public static Action CalibratingAction(UnityAction action) { return new Action(Calibrating, action); } + + public static Event DeviceConnected = new Event(); + public static Action DeviceConnectedAction(UnityAction action) { return new Action(DeviceConnected, action); } + + public static Event Fade = new Event(); + public static Action FadeAction(UnityAction action) { return new Action(Fade, action); } + + public static Event FadeReady = new Event(); + public static Action FadeReadyAction(UnityAction action) { return new ActionNoArgs(FadeReady, action); } + + public static Event HideRenderModels = new Event(); + public static Action HideRenderModelsAction(UnityAction action) { return new Action(HideRenderModels, action); } + + public static Event Initializing = new Event(); + public static Action InitializingAction(UnityAction action) { return new Action(Initializing, action); } + + public static Event InputFocus = new Event(); + public static Action InputFocusAction(UnityAction action) { return new Action(InputFocus, action); } + + public static Event Loading = new Event(); + public static Action LoadingAction(UnityAction action) { return new Action(Loading, action); } + + public static Event LoadingFadeIn = new Event(); + public static Action LoadingFadeInAction(UnityAction action) { return new Action(LoadingFadeIn, action); } + + public static Event LoadingFadeOut = new Event(); + public static Action LoadingFadeOutAction(UnityAction action) { return new Action(LoadingFadeOut, action); } + + public static Event NewPoses = new Event(); + public static Action NewPosesAction(UnityAction action) { return new Action(NewPoses, action); } + + public static Event NewPosesApplied = new Event(); + public static Action NewPosesAppliedAction(UnityAction action) { return new ActionNoArgs(NewPosesApplied, action); } + + public static Event OutOfRange = new Event(); + public static Action OutOfRangeAction(UnityAction action) { return new Action(OutOfRange, action); } + + public static Event RenderModelLoaded = new Event(); + public static Action RenderModelLoadedAction(UnityAction action) { return new Action(RenderModelLoaded, action); } + + static System.Collections.Generic.Dictionary> systemEvents = new System.Collections.Generic.Dictionary>(); + public static Event System(EVREventType eventType) + { + Event e; + if (!systemEvents.TryGetValue(eventType, out e)) + { + e = new Event(); + systemEvents.Add(eventType, e); + } + return e; + } + + public static Action SystemAction(EVREventType eventType, UnityAction action) + { + return new Action(System(eventType), action); + } +} + diff --git a/Assets/SteamVR/Scripts/SteamVR_Events.cs.meta b/Assets/SteamVR/Scripts/SteamVR_Events.cs.meta new file mode 100644 index 0000000..c3c9d5c --- /dev/null +++ b/Assets/SteamVR/Scripts/SteamVR_Events.cs.meta @@ -0,0 +1,12 @@ +fileFormatVersion: 2 +guid: 44cb57742f235524189e5d8af1c4f3cc +timeCreated: 1483744463 +licenseType: Store +MonoImporter: + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/SteamVR/Scripts/SteamVR_ExternalCamera.cs b/Assets/SteamVR/Scripts/SteamVR_ExternalCamera.cs index 48c3ae8..b7900e9 100644 --- a/Assets/SteamVR/Scripts/SteamVR_ExternalCamera.cs +++ b/Assets/SteamVR/Scripts/SteamVR_ExternalCamera.cs @@ -1,4 +1,4 @@ -//========= Copyright 2016, Valve Corporation, All rights reserved. =========== +//======= Copyright (c) Valve Corporation, All rights reserved. =============== // // Purpose: Used to render an external camera of vr player (split front/back). // @@ -119,7 +119,6 @@ public void AttachToCamera(SteamVR_Camera vrcam) go.name = "camera"; DestroyImmediate(go.GetComponent()); - DestroyImmediate(go.GetComponent()); cam = go.GetComponent(); cam.fieldOfView = config.fov; @@ -149,11 +148,7 @@ public void AttachToCamera(SteamVR_Camera vrcam) clipRenderer.material = clipMaterial; clipRenderer.shadowCastingMode = ShadowCastingMode.Off; clipRenderer.receiveShadows = false; -#if !(UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) clipRenderer.lightProbeUsage = LightProbeUsage.Off; -#else - clipRenderer.useLightProbes = false; -#endif clipRenderer.reflectionProbeUsage = ReflectionProbeUsage.Off; var clipTransform = clipQuad.transform; diff --git a/Assets/SteamVR/Scripts/SteamVR_Frustum.cs b/Assets/SteamVR/Scripts/SteamVR_Frustum.cs index db0520d..de547d1 100644 --- a/Assets/SteamVR/Scripts/SteamVR_Frustum.cs +++ b/Assets/SteamVR/Scripts/SteamVR_Frustum.cs @@ -1,4 +1,4 @@ -//========= Copyright 2014, Valve Corporation, All rights reserved. =========== +//======= Copyright (c) Valve Corporation, All rights reserved. =============== // // Purpose: Generates a mesh based on field of view. // @@ -87,15 +87,13 @@ public void UpdateModel() GetComponent().mesh = mesh; } - private void OnDeviceConnected(params object[] args) + private void OnDeviceConnected(int i, bool connected) { - var i = (int)args[0]; if (i != (int)index) return; GetComponent().mesh = null; - var connected = (bool)args[1]; if (connected) { var system = OpenVR.System; @@ -134,12 +132,12 @@ private void OnDeviceConnected(params object[] args) void OnEnable() { GetComponent().mesh = null; - SteamVR_Utils.Event.Listen("device_connected", OnDeviceConnected); + SteamVR_Events.DeviceConnected.Listen(OnDeviceConnected); } void OnDisable() { - SteamVR_Utils.Event.Remove("device_connected", OnDeviceConnected); + SteamVR_Events.DeviceConnected.Remove(OnDeviceConnected); GetComponent().mesh = null; } diff --git a/Assets/SteamVR/Scripts/SteamVR_GameView.cs b/Assets/SteamVR/Scripts/SteamVR_GameView.cs index b06a945..0cade74 100644 --- a/Assets/SteamVR/Scripts/SteamVR_GameView.cs +++ b/Assets/SteamVR/Scripts/SteamVR_GameView.cs @@ -1,4 +1,4 @@ -//========= Copyright 2014, Valve Corporation, All rights reserved. =========== +//======= Copyright (c) Valve Corporation, All rights reserved. =============== // // Purpose: Handles rendering to the game view window // @@ -6,79 +6,13 @@ using UnityEngine; -[RequireComponent(typeof(Camera))] +[ExecuteInEditMode] public class SteamVR_GameView : MonoBehaviour { -#if (UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) // DEPRECATED in Unity 5.4+ - public float scale = 1.5f; - public bool drawOverlay = true; - - static Material overlayMaterial; - - void OnEnable() - { - if (overlayMaterial == null) - { - overlayMaterial = new Material(Shader.Find("Custom/SteamVR_Overlay")); - } - } - - void OnPostRender() + void Awake() { - var vr = SteamVR.instance; - var camera = GetComponent(); - var aspect = scale * camera.aspect / vr.aspect; - - var x0 = -scale; - var x1 = scale; - var y0 = aspect; - var y1 = -aspect; - - var blitMaterial = SteamVR_Camera.blitMaterial; - blitMaterial.mainTexture = SteamVR_Camera.GetSceneTexture(camera.hdr); - - GL.PushMatrix(); - GL.LoadOrtho(); -#if !(UNITY_5_0) - blitMaterial.SetPass(0); -#else - blitMaterial.SetPass(QualitySettings.activeColorSpace == ColorSpace.Linear ? 1 : 0); -#endif - GL.Begin(GL.QUADS); - GL.TexCoord2(0.0f, 0.0f); GL.Vertex3(x0, y0, 0); - GL.TexCoord2(1.0f, 0.0f); GL.Vertex3(x1, y0, 0); - GL.TexCoord2(1.0f, 1.0f); GL.Vertex3(x1, y1, 0); - GL.TexCoord2(0.0f, 1.0f); GL.Vertex3(x0, y1, 0); - GL.End(); - GL.PopMatrix(); - - var overlay = SteamVR_Overlay.instance; - if (overlay && overlay.texture && overlayMaterial && drawOverlay) - { - var texture = overlay.texture; - overlayMaterial.mainTexture = texture; - - var u0 = 0.0f; - var v0 = 1.0f - (float)Screen.height / texture.height; - var u1 = (float)Screen.width / texture.width; - var v1 = 1.0f; - - GL.PushMatrix(); - GL.LoadOrtho(); -#if !(UNITY_5_0) - overlayMaterial.SetPass(QualitySettings.activeColorSpace == ColorSpace.Linear ? 1 : 0); -#else - overlayMaterial.SetPass(0); -#endif - GL.Begin(GL.QUADS); - GL.TexCoord2(u0, v0); GL.Vertex3(-1, -1, 0); - GL.TexCoord2(u1, v0); GL.Vertex3( 1, -1, 0); - GL.TexCoord2(u1, v1); GL.Vertex3( 1, 1, 0); - GL.TexCoord2(u0, v1); GL.Vertex3(-1, 1, 0); - GL.End(); - GL.PopMatrix(); - } + Debug.Log("SteamVR_GameView is deprecated in Unity 5.4 - REMOVING"); + DestroyImmediate(this); } -#endif } diff --git a/Assets/SteamVR/Scripts/SteamVR_Overlay.cs b/Assets/SteamVR/Scripts/SteamVR_Overlay.cs index b0e02ea..9d0563c 100644 --- a/Assets/SteamVR/Scripts/SteamVR_Overlay.cs +++ b/Assets/SteamVR/Scripts/SteamVR_Overlay.cs @@ -1,4 +1,4 @@ -//========= Copyright 2014, Valve Corporation, All rights reserved. =========== +//======= Copyright (c) Valve Corporation, All rights reserved. =============== // // Purpose: Displays 2d content on a large virtual screen. // @@ -30,7 +30,7 @@ public class SteamVR_Overlay : MonoBehaviour private ulong handle = OpenVR.k_ulOverlayHandleInvalid; - void OnEnable() + void OnEnable() { var overlay = OpenVR.Overlay; if (overlay != null) @@ -80,7 +80,7 @@ public void UpdateOverlay() var tex = new Texture_t(); tex.handle = texture.GetNativeTexturePtr(); - tex.eType = SteamVR.instance.graphicsAPI; + tex.eType = SteamVR.instance.textureType; tex.eColorSpace = EColorSpace.Auto; overlay.SetOverlayTexture(handle, ref tex); diff --git a/Assets/SteamVR/Scripts/SteamVR_Overlay.cs.meta b/Assets/SteamVR/Scripts/SteamVR_Overlay.cs.meta index e2c9383..21fe1d6 100644 --- a/Assets/SteamVR/Scripts/SteamVR_Overlay.cs.meta +++ b/Assets/SteamVR/Scripts/SteamVR_Overlay.cs.meta @@ -1,7 +1,5 @@ fileFormatVersion: 2 guid: 46fe9e0b23166454c8cb73040321d78c -timeCreated: 1466224777 -licenseType: Free MonoImporter: serializedVersion: 2 defaultReferences: [] @@ -9,4 +7,3 @@ MonoImporter: icon: {instanceID: 0} userData: assetBundleName: - assetBundleVariant: diff --git a/Assets/SteamVR/Scripts/SteamVR_Render.cs b/Assets/SteamVR/Scripts/SteamVR_Render.cs index d1c49ba..420040e 100644 --- a/Assets/SteamVR/Scripts/SteamVR_Render.cs +++ b/Assets/SteamVR/Scripts/SteamVR_Render.cs @@ -1,4 +1,4 @@ -//========= Copyright 2014, Valve Corporation, All rights reserved. =========== +//======= Copyright (c) Valve Corporation, All rights reserved. =============== // // Purpose: Handles rendering of all SteamVR_Cameras // @@ -16,11 +16,6 @@ public class SteamVR_Render : MonoBehaviour public SteamVR_ExternalCamera externalCamera; public string externalCameraConfigPath = "externalcamera.cfg"; -#if (UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) - public LayerMask leftMask, rightMask; - - SteamVR_CameraMask cameraMask; -#endif public ETrackingUniverseOrigin trackingSpace = ETrackingUniverseOrigin.TrackingUniverseStanding; static public EVREye eye { get; private set; } @@ -93,10 +88,6 @@ void AddInternal(SteamVR_Camera vrcam) sorted[insert] = vrcam; cameras = sorted; - -#if (UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) - enabled = true; -#endif } void RemoveInternal(SteamVR_Camera vrcam) @@ -142,19 +133,20 @@ static public bool pauseRendering set { _pauseRendering = value; -#if !(UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) + var compositor = OpenVR.Compositor; if (compositor != null) compositor.SuspendRendering(value); -#endif } } + private WaitForEndOfFrame waitForEndOfFrame = new WaitForEndOfFrame(); + private IEnumerator RenderLoop() { - while (true) + while (Application.isPlaying) { - yield return new WaitForEndOfFrame(); + yield return waitForEndOfFrame; if (pauseRendering) continue; @@ -166,19 +158,6 @@ private IEnumerator RenderLoop() continue; compositor.SetTrackingSpace(trackingSpace); - -#if (UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) - SteamVR_Utils.QueueEventOnRenderThread(SteamVR.Unity.k_nRenderEventID_WaitGetPoses); - - // Hack to flush render event that was queued in Update (this ensures WaitGetPoses has returned before we grab the new values). - SteamVR.Unity.EventWriteString("[UnityMain] GetNativeTexturePtr - Begin"); - SteamVR_Camera.GetSceneTexture(cameras[0].GetComponent().hdr).GetNativeTexturePtr(); - SteamVR.Unity.EventWriteString("[UnityMain] GetNativeTexturePtr - End"); - - compositor.GetLastPoses(poses, gamePoses); - SteamVR_Utils.Event.Send("new_poses", poses); - SteamVR_Utils.Event.Send("new_poses_applied"); -#endif } var overlay = SteamVR_Overlay.instance; @@ -186,60 +165,8 @@ private IEnumerator RenderLoop() overlay.UpdateOverlay(); RenderExternalCamera(); - -#if (UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) - var vr = SteamVR.instance; - RenderEye(vr, EVREye.Eye_Left); - RenderEye(vr, EVREye.Eye_Right); - - // Move cameras back to head position so they can be tracked reliably - foreach (var c in cameras) - { - c.transform.localPosition = Vector3.zero; - c.transform.localRotation = Quaternion.identity; - } - - if (cameraMask != null) - cameraMask.Clear(); -#endif - } - } - -#if (UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) - void RenderEye(SteamVR vr, EVREye eye) - { - int i = (int)eye; - SteamVR_Render.eye = eye; - - if (cameraMask != null) - cameraMask.Set(vr, eye); - - foreach (var c in cameras) - { - c.transform.localPosition = vr.eyes[i].pos; - c.transform.localRotation = vr.eyes[i].rot; - - // Update position to keep from getting culled - cameraMask.transform.position = c.transform.position; - - var camera = c.GetComponent(); - camera.targetTexture = SteamVR_Camera.GetSceneTexture(camera.hdr); - int cullingMask = camera.cullingMask; - if (eye == EVREye.Eye_Left) - { - camera.cullingMask &= ~rightMask; - camera.cullingMask |= leftMask; - } - else - { - camera.cullingMask &= ~leftMask; - camera.cullingMask |= rightMask; - } - camera.Render(); - camera.cullingMask = cullingMask; } } -#endif void RenderExternalCamera() { @@ -262,9 +189,8 @@ void RenderExternalCamera() float sceneResolutionScale = 1.0f, timeScale = 1.0f; - private void OnInputFocus(params object[] args) + private void OnInputFocus(bool hasFocus) { - bool hasFocus = (bool)args[0]; if (hasFocus) { if (pauseGameWhenDashboardIsVisible) @@ -287,7 +213,7 @@ private void OnInputFocus(params object[] args) } } - void OnQuit(params object[] args) + void OnQuit(VREvent_t vrEvent) { #if UNITY_EDITOR foreach (System.Reflection.Assembly a in System.AppDomain.CurrentDomain.GetAssemblies()) @@ -304,27 +230,76 @@ void OnQuit(params object[] args) #endif } + private string GetScreenshotFilename(uint screenshotHandle, EVRScreenshotPropertyFilenames screenshotPropertyFilename) + { + var error = EVRScreenshotError.None; + var capacity = OpenVR.Screenshots.GetScreenshotPropertyFilename(screenshotHandle, screenshotPropertyFilename, null, 0, ref error); + if (error != EVRScreenshotError.None && error != EVRScreenshotError.BufferTooSmall) + return null; + if (capacity > 1) + { + var result = new System.Text.StringBuilder((int)capacity); + OpenVR.Screenshots.GetScreenshotPropertyFilename(screenshotHandle, screenshotPropertyFilename, result, capacity, ref error); + if (error != EVRScreenshotError.None) + return null; + return result.ToString(); + } + return null; + } + + private void OnRequestScreenshot(VREvent_t vrEvent) + { + var screenshotHandle = vrEvent.data.screenshot.handle; + var screenshotType = (EVRScreenshotType)vrEvent.data.screenshot.type; + + if (screenshotType == EVRScreenshotType.StereoPanorama) + { + string previewFilename = GetScreenshotFilename(screenshotHandle, EVRScreenshotPropertyFilenames.Preview); + string VRFilename = GetScreenshotFilename(screenshotHandle, EVRScreenshotPropertyFilenames.VR); + + if (previewFilename == null || VRFilename == null) + return; + + // Do the stereo panorama screenshot + // Figure out where the view is + GameObject screenshotPosition = new GameObject("screenshotPosition"); + screenshotPosition.transform.position = SteamVR_Render.Top().transform.position; + screenshotPosition.transform.rotation = SteamVR_Render.Top().transform.rotation; + screenshotPosition.transform.localScale = SteamVR_Render.Top().transform.lossyScale; + SteamVR_Utils.TakeStereoScreenshot(screenshotHandle, screenshotPosition, 32, 0.064f, ref previewFilename, ref VRFilename); + + // and submit it + OpenVR.Screenshots.SubmitScreenshot(screenshotHandle, screenshotType, previewFilename, VRFilename); + } + } + void OnEnable() { StartCoroutine("RenderLoop"); - SteamVR_Utils.Event.Listen("input_focus", OnInputFocus); - SteamVR_Utils.Event.Listen("Quit", OnQuit); + SteamVR_Events.InputFocus.Listen(OnInputFocus); + SteamVR_Events.System(EVREventType.VREvent_Quit).Listen(OnQuit); + SteamVR_Events.System(EVREventType.VREvent_RequestScreenshot).Listen(OnRequestScreenshot); + + var vr = SteamVR.instance; + if (vr == null) + { + enabled = false; + return; + } + var types = new EVRScreenshotType[] { EVRScreenshotType.StereoPanorama }; + OpenVR.Screenshots.HookScreenshot(types); } void OnDisable() { StopAllCoroutines(); - SteamVR_Utils.Event.Remove("input_focus", OnInputFocus); - SteamVR_Utils.Event.Remove("Quit", OnQuit); + SteamVR_Events.InputFocus.Remove(OnInputFocus); + SteamVR_Events.System(EVREventType.VREvent_Quit).Remove(OnQuit); + SteamVR_Events.System(EVREventType.VREvent_RequestScreenshot).Remove(OnRequestScreenshot); } void Awake() { -#if (UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) - var go = new GameObject("cameraMask"); - go.transform.parent = transform; - cameraMask = go.AddComponent(); -#endif if (externalCamera == null && System.IO.File.Exists(externalCameraConfigPath)) { var prefab = Resources.Load("SteamVR_ExternalCamera"); @@ -337,36 +312,19 @@ void Awake() } } - void FixedUpdate() - { -#if (UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) - // We want to call this as soon after Present as possible. - SteamVR_Utils.QueueEventOnRenderThread(SteamVR.Unity.k_nRenderEventID_PostPresentHandoff); -#endif - } - -#if !(UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) +#if !(UNITY_5_6) private SteamVR_UpdatePoses poseUpdater; #endif void Update() { -#if !(UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) +#if !(UNITY_5_6) if (poseUpdater == null) { var go = new GameObject("poseUpdater"); go.transform.parent = transform; poseUpdater = go.AddComponent(); } -#else - if (cameras.Length == 0) - { - enabled = false; - return; - } - - // If our FixedUpdate rate doesn't match our render framerate, then catch the handoff here. - SteamVR_Utils.QueueEventOnRenderThread(SteamVR.Unity.k_nRenderEventID_PostPresentHandoff); #endif // Force controller update in case no one else called this frame to ensure prevState gets updated. SteamVR_Controller.Update(); @@ -387,25 +345,23 @@ void Update() case EVREventType.VREvent_InputFocusCaptured: // another app has taken focus (likely dashboard) if (vrEvent.data.process.oldPid == 0) { - SteamVR_Utils.Event.Send("input_focus", false); + SteamVR_Events.InputFocus.Send(false); } break; case EVREventType.VREvent_InputFocusReleased: // that app has released input focus if (vrEvent.data.process.pid == 0) { - SteamVR_Utils.Event.Send("input_focus", true); + SteamVR_Events.InputFocus.Send(true); } break; case EVREventType.VREvent_ShowRenderModels: - SteamVR_Utils.Event.Send("hide_render_models", false); + SteamVR_Events.HideRenderModels.Send(false); break; case EVREventType.VREvent_HideRenderModels: - SteamVR_Utils.Event.Send("hide_render_models", true); + SteamVR_Events.HideRenderModels.Send(true); break; default: - var name = System.Enum.GetName(typeof(EVREventType), vrEvent.eventType); - if (name != null) - SteamVR_Utils.Event.Send(name.Substring(8) /*strip VREvent_*/, vrEvent); + SteamVR_Events.System((EVREventType)vrEvent.eventType).Send(vrEvent); break; } } @@ -427,7 +383,6 @@ void Update() vr.compositor.GetFrameTiming(ref timing, 0); Time.fixedDeltaTime = Time.timeScale / vr.hmd_DisplayFrequency; - Time.maximumDeltaTime = Time.fixedDeltaTime * timing.m_nNumFramePresents; } } } diff --git a/Assets/SteamVR/Scripts/SteamVR_RenderModel.cs b/Assets/SteamVR/Scripts/SteamVR_RenderModel.cs new file mode 100644 index 0000000..450c8e9 --- /dev/null +++ b/Assets/SteamVR/Scripts/SteamVR_RenderModel.cs @@ -0,0 +1,792 @@ +//======= Copyright (c) Valve Corporation, All rights reserved. =============== +// +// Purpose: Render model of associated tracked object +// +//============================================================================= + +using UnityEngine; +using System.Collections; +using System.Collections.Generic; +using System.Runtime.InteropServices; +using Valve.VR; + +[ExecuteInEditMode] +public class SteamVR_RenderModel : MonoBehaviour +{ + public SteamVR_TrackedObject.EIndex index = SteamVR_TrackedObject.EIndex.None; + public string modelOverride; + + // Shader to apply to model. + public Shader shader; + + // Enable to print out when render models are loaded. + public bool verbose = false; + + // If available, break down into separate components instead of loading as a single mesh. + public bool createComponents = true; + + // Update transforms of components at runtime to reflect user action. + public bool updateDynamically = true; + + // Additional controller settings for showing scrollwheel, etc. + public RenderModel_ControllerMode_State_t controllerModeState; + + // Name of the sub-object which represents the "local" coordinate space for each component. + public const string k_localTransformName = "attach"; + + // Cached name of this render model for updating component transforms at runtime. + public string renderModelName { get; private set; } + + // If someone knows how to keep these from getting cleaned up every time + // you exit play mode, let me know. I've tried marking the RenderModel + // class below as [System.Serializable] and switching to normal public + // variables for mesh and material to get them to serialize properly, + // as well as tried marking the mesh and material objects as + // DontUnloadUnusedAsset, but Unity was still unloading them. + // The hashtable is preserving its entries, but the mesh and material + // variables are going null. + + public class RenderModel + { + public RenderModel(Mesh mesh, Material material) + { + this.mesh = mesh; + this.material = material; + } + public Mesh mesh { get; private set; } + public Material material { get; private set; } + } + + public static Hashtable models = new Hashtable(); + public static Hashtable materials = new Hashtable(); + + // Helper class to load render models interface on demand and clean up when done. + public sealed class RenderModelInterfaceHolder : System.IDisposable + { + private bool needsShutdown, failedLoadInterface; + private CVRRenderModels _instance; + public CVRRenderModels instance + { + get + { + if (_instance == null && !failedLoadInterface) + { + if (!SteamVR.active && !SteamVR.usingNativeSupport) + { + var error = EVRInitError.None; + OpenVR.Init(ref error, EVRApplicationType.VRApplication_Other); + needsShutdown = true; + } + + _instance = OpenVR.RenderModels; + if (_instance == null) + { + Debug.LogError("Failed to load IVRRenderModels interface version " + OpenVR.IVRRenderModels_Version); + failedLoadInterface = true; + } + } + return _instance; + } + } + public void Dispose() + { + if (needsShutdown) + OpenVR.Shutdown(); + } + } + + private void OnModelSkinSettingsHaveChanged(VREvent_t vrEvent) + { + if (!string.IsNullOrEmpty(renderModelName)) + { + renderModelName = ""; + UpdateModel(); + } + } + + private void OnHideRenderModels(bool hidden) + { + var meshRenderer = GetComponent(); + if (meshRenderer != null) + meshRenderer.enabled = !hidden; + foreach (var child in transform.GetComponentsInChildren()) + child.enabled = !hidden; + } + + private void OnDeviceConnected(int i, bool connected) + { + if (i != (int)index) + return; + + if (connected) + { + UpdateModel(); + } + } + + public void UpdateModel() + { + var system = OpenVR.System; + if (system == null) + return; + + var error = ETrackedPropertyError.TrackedProp_Success; + var capacity = system.GetStringTrackedDeviceProperty((uint)index, ETrackedDeviceProperty.Prop_RenderModelName_String, null, 0, ref error); + if (capacity <= 1) + { + Debug.LogError("Failed to get render model name for tracked object " + index); + return; + } + + var buffer = new System.Text.StringBuilder((int)capacity); + system.GetStringTrackedDeviceProperty((uint)index, ETrackedDeviceProperty.Prop_RenderModelName_String, buffer, capacity, ref error); + + var s = buffer.ToString(); + if (renderModelName != s) + { + renderModelName = s; + StartCoroutine(SetModelAsync(s)); + } + } + + IEnumerator SetModelAsync(string renderModelName) + { + if (string.IsNullOrEmpty(renderModelName)) + yield break; + + // Preload all render models before asking for the data to create meshes. + using (var holder = new RenderModelInterfaceHolder()) + { + var renderModels = holder.instance; + if (renderModels == null) + yield break; + + // Gather names of render models to preload. + string[] renderModelNames; + + var count = renderModels.GetComponentCount(renderModelName); + if (count > 0) + { + renderModelNames = new string[count]; + + for (int i = 0; i < count; i++) + { + var capacity = renderModels.GetComponentName(renderModelName, (uint)i, null, 0); + if (capacity == 0) + continue; + + var componentName = new System.Text.StringBuilder((int)capacity); + if (renderModels.GetComponentName(renderModelName, (uint)i, componentName, capacity) == 0) + continue; + + capacity = renderModels.GetComponentRenderModelName(renderModelName, componentName.ToString(), null, 0); + if (capacity == 0) + continue; + + var name = new System.Text.StringBuilder((int)capacity); + if (renderModels.GetComponentRenderModelName(renderModelName, componentName.ToString(), name, capacity) == 0) + continue; + + var s = name.ToString(); + + // Only need to preload if not already cached. + var model = models[s] as RenderModel; + if (model == null || model.mesh == null) + { + renderModelNames[i] = s; + } + } + } + else + { + // Only need to preload if not already cached. + var model = models[renderModelName] as RenderModel; + if (model == null || model.mesh == null) + { + renderModelNames = new string[] { renderModelName }; + } + else + { + renderModelNames = new string[0]; + } + } + + // Keep trying every 100ms until all components finish loading. + while (true) + { + var loading = false; + foreach (var name in renderModelNames) + { + if (string.IsNullOrEmpty(name)) + continue; + + var pRenderModel = System.IntPtr.Zero; + + var error = renderModels.LoadRenderModel_Async(name, ref pRenderModel); + if (error == EVRRenderModelError.Loading) + { + loading = true; + } + else if (error == EVRRenderModelError.None) + { + // Preload textures as well. + var renderModel = MarshalRenderModel(pRenderModel); + + // Check the cache first. + var material = materials[renderModel.diffuseTextureId] as Material; + if (material == null || material.mainTexture == null) + { + var pDiffuseTexture = System.IntPtr.Zero; + + error = renderModels.LoadTexture_Async(renderModel.diffuseTextureId, ref pDiffuseTexture); + if (error == EVRRenderModelError.Loading) + { + loading = true; + } + } + } + } + + if (loading) + { + yield return new WaitForSeconds(0.1f); + } + else + { + break; + } + } + } + + bool success = SetModel(renderModelName); + SteamVR_Events.RenderModelLoaded.Send(this, success); + } + + private bool SetModel(string renderModelName) + { + StripMesh(gameObject); + + using (var holder = new RenderModelInterfaceHolder()) + { + if (createComponents) + { + if (LoadComponents(holder, renderModelName)) + { + UpdateComponents(holder.instance); + return true; + } + + Debug.Log("[" + gameObject.name + "] Render model does not support components, falling back to single mesh."); + } + + if (!string.IsNullOrEmpty(renderModelName)) + { + var model = models[renderModelName] as RenderModel; + if (model == null || model.mesh == null) + { + var renderModels = holder.instance; + if (renderModels == null) + return false; + + if (verbose) + Debug.Log("Loading render model " + renderModelName); + + model = LoadRenderModel(renderModels, renderModelName, renderModelName); + if (model == null) + return false; + + models[renderModelName] = model; + } + + gameObject.AddComponent().mesh = model.mesh; + gameObject.AddComponent().sharedMaterial = model.material; + return true; + } + } + + return false; + } + + RenderModel LoadRenderModel(CVRRenderModels renderModels, string renderModelName, string baseName) + { + var pRenderModel = System.IntPtr.Zero; + + EVRRenderModelError error; + while ( true ) + { + error = renderModels.LoadRenderModel_Async(renderModelName, ref pRenderModel); + if (error != EVRRenderModelError.Loading) + break; + + System.Threading.Thread.Sleep(1); + } + + if (error != EVRRenderModelError.None) + { + Debug.LogError(string.Format("Failed to load render model {0} - {1}", renderModelName, error.ToString())); + return null; + } + + var renderModel = MarshalRenderModel(pRenderModel); + + var vertices = new Vector3[renderModel.unVertexCount]; + var normals = new Vector3[renderModel.unVertexCount]; + var uv = new Vector2[renderModel.unVertexCount]; + + var type = typeof(RenderModel_Vertex_t); + for (int iVert = 0; iVert < renderModel.unVertexCount; iVert++) + { + var ptr = new System.IntPtr(renderModel.rVertexData.ToInt64() + iVert * Marshal.SizeOf(type)); + var vert = (RenderModel_Vertex_t)Marshal.PtrToStructure(ptr, type); + + vertices[iVert] = new Vector3(vert.vPosition.v0, vert.vPosition.v1, -vert.vPosition.v2); + normals[iVert] = new Vector3(vert.vNormal.v0, vert.vNormal.v1, -vert.vNormal.v2); + uv[iVert] = new Vector2(vert.rfTextureCoord0, vert.rfTextureCoord1); + } + + int indexCount = (int)renderModel.unTriangleCount * 3; + var indices = new short[indexCount]; + Marshal.Copy(renderModel.rIndexData, indices, 0, indices.Length); + + var triangles = new int[indexCount]; + for (int iTri = 0; iTri < renderModel.unTriangleCount; iTri++) + { + triangles[iTri * 3 + 0] = (int)indices[iTri * 3 + 2]; + triangles[iTri * 3 + 1] = (int)indices[iTri * 3 + 1]; + triangles[iTri * 3 + 2] = (int)indices[iTri * 3 + 0]; + } + + var mesh = new Mesh(); + mesh.vertices = vertices; + mesh.normals = normals; + mesh.uv = uv; + mesh.triangles = triangles; + +#if (UNITY_5_4 || UNITY_5_3 || UNITY_5_2 || UNITY_5_1 || UNITY_5_0) + mesh.Optimize(); +#endif + //mesh.hideFlags = HideFlags.DontUnloadUnusedAsset; + + // Check cache before loading texture. + var material = materials[renderModel.diffuseTextureId] as Material; + if (material == null || material.mainTexture == null) + { + var pDiffuseTexture = System.IntPtr.Zero; + + while (true) + { + error = renderModels.LoadTexture_Async(renderModel.diffuseTextureId, ref pDiffuseTexture); + if (error != EVRRenderModelError.Loading) + break; + + System.Threading.Thread.Sleep(1); + } + + if (error == EVRRenderModelError.None) + { + var diffuseTexture = MarshalRenderModel_TextureMap(pDiffuseTexture); + var texture = new Texture2D(diffuseTexture.unWidth, diffuseTexture.unHeight, TextureFormat.ARGB32, false); + if (SystemInfo.graphicsDeviceType == UnityEngine.Rendering.GraphicsDeviceType.Direct3D11) + { + texture.Apply(); + + while (true) + { + error = renderModels.LoadIntoTextureD3D11_Async(renderModel.diffuseTextureId, texture.GetNativeTexturePtr()); + if (error != EVRRenderModelError.Loading) + break; + + System.Threading.Thread.Sleep(1); + } + } + else + { + var textureMapData = new byte[diffuseTexture.unWidth * diffuseTexture.unHeight * 4]; // RGBA + Marshal.Copy(diffuseTexture.rubTextureMapData, textureMapData, 0, textureMapData.Length); + + var colors = new Color32[diffuseTexture.unWidth * diffuseTexture.unHeight]; + int iColor = 0; + for (int iHeight = 0; iHeight < diffuseTexture.unHeight; iHeight++) + { + for (int iWidth = 0; iWidth < diffuseTexture.unWidth; iWidth++) + { + var r = textureMapData[iColor++]; + var g = textureMapData[iColor++]; + var b = textureMapData[iColor++]; + var a = textureMapData[iColor++]; + colors[iHeight * diffuseTexture.unWidth + iWidth] = new Color32(r, g, b, a); + } + } + + texture.SetPixels32(colors); + texture.Apply(); + } + + material = new Material(shader != null ? shader : Shader.Find("Standard")); + material.mainTexture = texture; + //material.hideFlags = HideFlags.DontUnloadUnusedAsset; + + materials[renderModel.diffuseTextureId] = material; + + renderModels.FreeTexture(pDiffuseTexture); + } + else + { + Debug.Log("Failed to load render model texture for render model " + renderModelName); + } + } + + // Delay freeing when we can since we'll often get multiple requests for the same model right + // after another (e.g. two controllers or two basestations). +#if UNITY_EDITOR + if (!Application.isPlaying) + renderModels.FreeRenderModel(pRenderModel); + else +#endif + StartCoroutine(FreeRenderModel(pRenderModel)); + + return new RenderModel(mesh, material); + } + + IEnumerator FreeRenderModel(System.IntPtr pRenderModel) + { + yield return new WaitForSeconds(1.0f); + + using (var holder = new RenderModelInterfaceHolder()) + { + var renderModels = holder.instance; + renderModels.FreeRenderModel(pRenderModel); + } + } + + public Transform FindComponent(string componentName) + { + var t = transform; + for (int i = 0; i < t.childCount; i++) + { + var child = t.GetChild(i); + if (child.name == componentName) + return child; + } + return null; + } + + private void StripMesh(GameObject go) + { + var meshRenderer = go.GetComponent(); + if (meshRenderer != null) + DestroyImmediate(meshRenderer); + + var meshFilter = go.GetComponent(); + if (meshFilter != null) + DestroyImmediate(meshFilter); + } + + private bool LoadComponents(RenderModelInterfaceHolder holder, string renderModelName) + { + // Disable existing components (we will re-enable them if referenced by this new model). + // Also strip mesh filter and renderer since these will get re-added if the new component needs them. + var t = transform; + for (int i = 0; i < t.childCount; i++) + { + var child = t.GetChild(i); + child.gameObject.SetActive(false); + StripMesh(child.gameObject); + } + + // If no model specified, we're done; return success. + if (string.IsNullOrEmpty(renderModelName)) + return true; + + var renderModels = holder.instance; + if (renderModels == null) + return false; + + var count = renderModels.GetComponentCount(renderModelName); + if (count == 0) + return false; + + for (int i = 0; i < count; i++) + { + var capacity = renderModels.GetComponentName(renderModelName, (uint)i, null, 0); + if (capacity == 0) + continue; + + var componentName = new System.Text.StringBuilder((int)capacity); + if (renderModels.GetComponentName(renderModelName, (uint)i, componentName, capacity) == 0) + continue; + + // Create (or reuse) a child object for this component (some components are dynamic and don't have meshes). + t = FindComponent(componentName.ToString()); + if (t != null) + { + t.gameObject.SetActive(true); + } + else + { + t = new GameObject(componentName.ToString()).transform; + t.parent = transform; + t.gameObject.layer = gameObject.layer; + + // Also create a child 'attach' object for attaching things. + var attach = new GameObject(k_localTransformName).transform; + attach.parent = t; + attach.localPosition = Vector3.zero; + attach.localRotation = Quaternion.identity; + attach.localScale = Vector3.one; + attach.gameObject.layer = gameObject.layer; + } + + // Reset transform. + t.localPosition = Vector3.zero; + t.localRotation = Quaternion.identity; + t.localScale = Vector3.one; + + capacity = renderModels.GetComponentRenderModelName(renderModelName, componentName.ToString(), null, 0); + if (capacity == 0) + continue; + + var componentRenderModelName = new System.Text.StringBuilder((int)capacity); + if (renderModels.GetComponentRenderModelName(renderModelName, componentName.ToString(), componentRenderModelName, capacity) == 0) + continue; + + // Check the cache or load into memory. + var model = models[componentRenderModelName] as RenderModel; + if (model == null || model.mesh == null) + { + if (verbose) + Debug.Log("Loading render model " + componentRenderModelName); + + model = LoadRenderModel(renderModels, componentRenderModelName.ToString(), renderModelName); + if (model == null) + continue; + + models[componentRenderModelName] = model; + } + + t.gameObject.AddComponent().mesh = model.mesh; + t.gameObject.AddComponent().sharedMaterial = model.material; + } + + return true; + } + + SteamVR_Events.Action deviceConnectedAction, hideRenderModelsAction, modelSkinSettingsHaveChangedAction; + + void Awake() + { + deviceConnectedAction = SteamVR_Events.DeviceConnectedAction(OnDeviceConnected); + hideRenderModelsAction = SteamVR_Events.HideRenderModelsAction(OnHideRenderModels); + modelSkinSettingsHaveChangedAction = SteamVR_Events.SystemAction(EVREventType.VREvent_ModelSkinSettingsHaveChanged, OnModelSkinSettingsHaveChanged); + } + + void OnEnable() + { +#if UNITY_EDITOR + if (!Application.isPlaying) + return; +#endif + if (!string.IsNullOrEmpty(modelOverride)) + { + Debug.Log("Model override is really only meant to be used in the scene view for lining things up; using it at runtime is discouraged. Use tracked device index instead to ensure the correct model is displayed for all users."); + enabled = false; + return; + } + + var system = OpenVR.System; + if (system != null && system.IsTrackedDeviceConnected((uint)index)) + { + UpdateModel(); + } + + deviceConnectedAction.enabled = true; + hideRenderModelsAction.enabled = true; + modelSkinSettingsHaveChangedAction.enabled = true; + } + + void OnDisable() + { +#if UNITY_EDITOR + if (!Application.isPlaying) + return; +#endif + deviceConnectedAction.enabled = false; + hideRenderModelsAction.enabled = false; + modelSkinSettingsHaveChangedAction.enabled = false; + } + +#if UNITY_EDITOR + Hashtable values; +#endif + void Update() + { +#if UNITY_EDITOR + if (!Application.isPlaying) + { + // See if anything has changed since this gets called whenever anything gets touched. + var fields = GetType().GetFields(System.Reflection.BindingFlags.Instance | System.Reflection.BindingFlags.Public); + + bool modified = false; + + if (values == null) + { + modified = true; + } + else + { + foreach (var f in fields) + { + if (!values.Contains(f)) + { + modified = true; + break; + } + + var v0 = values[f]; + var v1 = f.GetValue(this); + if (v1 != null) + { + if (!v1.Equals(v0)) + { + modified = true; + break; + } + } + else if (v0 != null) + { + modified = true; + break; + } + } + } + + if (modified) + { + if (renderModelName != modelOverride) + { + renderModelName = modelOverride; + SetModel(modelOverride); + } + + values = new Hashtable(); + foreach (var f in fields) + values[f] = f.GetValue(this); + } + + return; // Do not update transforms (below) when not playing in Editor (to avoid keeping OpenVR running all the time). + } +#endif + // Update component transforms dynamically. + if (updateDynamically) + UpdateComponents(OpenVR.RenderModels); + } + + Dictionary nameCache; + + public void UpdateComponents(CVRRenderModels renderModels) + { + if (renderModels == null) + return; + + var t = transform; + if (t.childCount == 0) + return; + + var controllerState = (index != SteamVR_TrackedObject.EIndex.None) ? + SteamVR_Controller.Input((int)index).GetState() : new VRControllerState_t(); + + if (nameCache == null) + nameCache = new Dictionary(); + + for (int i = 0; i < t.childCount; i++) + { + var child = t.GetChild(i); + + // Cache names since accessing an object's name allocate memory. + string name; + if (!nameCache.TryGetValue(child.GetInstanceID(), out name)) + { + name = child.name; + nameCache.Add(child.GetInstanceID(), name); + } + + var componentState = new RenderModel_ComponentState_t(); + if (!renderModels.GetComponentState(renderModelName, name, ref controllerState, ref controllerModeState, ref componentState)) + continue; + + var componentTransform = new SteamVR_Utils.RigidTransform(componentState.mTrackingToComponentRenderModel); + child.localPosition = componentTransform.pos; + child.localRotation = componentTransform.rot; + + var attach = child.Find(k_localTransformName); + if (attach != null) + { + var attachTransform = new SteamVR_Utils.RigidTransform(componentState.mTrackingToComponentLocal); + attach.position = t.TransformPoint(attachTransform.pos); + attach.rotation = t.rotation * attachTransform.rot; + } + + bool visible = (componentState.uProperties & (uint)EVRComponentProperty.IsVisible) != 0; + if (visible != child.gameObject.activeSelf) + { + child.gameObject.SetActive(visible); + } + } + } + + public void SetDeviceIndex(int index) + { + this.index = (SteamVR_TrackedObject.EIndex)index; + modelOverride = ""; + + if (enabled) + { + UpdateModel(); + } + } + + /// + /// Helper function to handle the inconvenient fact that the packing for RenderModel_t is + /// different on Linux/OSX (4) than it is on Windows (8) + /// + /// native pointer to the RenderModel_t + /// + private RenderModel_t MarshalRenderModel(System.IntPtr pRenderModel) + { + if ((System.Environment.OSVersion.Platform == System.PlatformID.MacOSX) || + (System.Environment.OSVersion.Platform == System.PlatformID.Unix)) + { + var packedModel = (RenderModel_t_Packed)Marshal.PtrToStructure(pRenderModel, typeof(RenderModel_t_Packed)); + RenderModel_t model = new RenderModel_t(); + packedModel.Unpack(ref model); + return model; + } + else + { + return (RenderModel_t)Marshal.PtrToStructure(pRenderModel, typeof(RenderModel_t)); + } + } + + /// + /// Helper function to handle the inconvenient fact that the packing for RenderModel_TextureMap_t is + /// different on Linux/OSX (4) than it is on Windows (8) + /// + /// native pointer to the RenderModel_TextureMap_t + /// + private RenderModel_TextureMap_t MarshalRenderModel_TextureMap(System.IntPtr pRenderModel) + { + if ((System.Environment.OSVersion.Platform == System.PlatformID.MacOSX) || + (System.Environment.OSVersion.Platform == System.PlatformID.Unix)) + { + var packedModel = (RenderModel_TextureMap_t_Packed)Marshal.PtrToStructure(pRenderModel, typeof(RenderModel_TextureMap_t_Packed)); + RenderModel_TextureMap_t model = new RenderModel_TextureMap_t(); + packedModel.Unpack(ref model); + return model; + } + else + { + return (RenderModel_TextureMap_t)Marshal.PtrToStructure(pRenderModel, typeof(RenderModel_TextureMap_t)); + } + } +} + diff --git a/Assets/SteamVR/Scripts/SteamVR_RenderModel.cs.meta b/Assets/SteamVR/Scripts/SteamVR_RenderModel.cs.meta new file mode 100644 index 0000000..429899d --- /dev/null +++ b/Assets/SteamVR/Scripts/SteamVR_RenderModel.cs.meta @@ -0,0 +1,9 @@ +fileFormatVersion: 2 +guid: 5890e3cad70bea64d91aef9145ba3454 +MonoImporter: + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: diff --git a/Assets/SteamVR/Scripts/SteamVR_SphericalProjection.cs b/Assets/SteamVR/Scripts/SteamVR_SphericalProjection.cs new file mode 100644 index 0000000..8c69c23 --- /dev/null +++ b/Assets/SteamVR/Scripts/SteamVR_SphericalProjection.cs @@ -0,0 +1,40 @@ +//======= Copyright (c) Valve Corporation, All rights reserved. =============== +// +// Purpose: Applies spherical projection to output. +// +//============================================================================= + +using UnityEngine; + +[ExecuteInEditMode] +public class SteamVR_SphericalProjection : MonoBehaviour +{ + static Material material; + + public void Set(Vector3 N, + float phi0, float phi1, float theta0, float theta1, // in degrees + Vector3 uAxis, Vector3 uOrigin, float uScale, + Vector3 vAxis, Vector3 vOrigin, float vScale) + { + if (material == null) + material = new Material(Shader.Find("Custom/SteamVR_SphericalProjection")); + + material.SetVector("_N", new Vector4(N.x, N.y, N.z)); + material.SetFloat("_Phi0", phi0 * Mathf.Deg2Rad); + material.SetFloat("_Phi1", phi1 * Mathf.Deg2Rad); + material.SetFloat("_Theta0", theta0 * Mathf.Deg2Rad + Mathf.PI / 2); + material.SetFloat("_Theta1", theta1 * Mathf.Deg2Rad + Mathf.PI / 2); + material.SetVector("_UAxis", uAxis); + material.SetVector("_VAxis", vAxis); + material.SetVector("_UOrigin", uOrigin); + material.SetVector("_VOrigin", vOrigin); + material.SetFloat("_UScale", uScale); + material.SetFloat("_VScale", vScale); + } + + void OnRenderImage(RenderTexture src, RenderTexture dest) + { + Graphics.Blit(src, dest, material); + } +} + diff --git a/Assets/SteamVR/Scripts/SteamVR_SphericalProjection.cs.meta b/Assets/SteamVR/Scripts/SteamVR_SphericalProjection.cs.meta new file mode 100644 index 0000000..a8ece21 --- /dev/null +++ b/Assets/SteamVR/Scripts/SteamVR_SphericalProjection.cs.meta @@ -0,0 +1,12 @@ +fileFormatVersion: 2 +guid: 7f4097fabec5d2b4da2b861750319952 +timeCreated: 1462380202 +licenseType: Store +MonoImporter: + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/SteamVR/Scripts/SteamVR_TrackedObject.cs b/Assets/SteamVR/Scripts/SteamVR_TrackedObject.cs index 133602b..a351540 100644 --- a/Assets/SteamVR/Scripts/SteamVR_TrackedObject.cs +++ b/Assets/SteamVR/Scripts/SteamVR_TrackedObject.cs @@ -1,4 +1,4 @@ -//========= Copyright 2014, Valve Corporation, All rights reserved. =========== +//======= Copyright (c) Valve Corporation, All rights reserved. =============== // // Purpose: For controlling in-game objects with tracked devices. // @@ -34,7 +34,7 @@ public enum EIndex public Transform origin; // if not set, relative to parent public bool isValid = false; - private void OnNewPoses(params object[] args) + private void OnNewPoses(TrackedDevicePose_t[] poses) { if (index == EIndex.None) return; @@ -42,7 +42,6 @@ private void OnNewPoses(params object[] args) var i = (int)index; isValid = false; - var poses = (Valve.VR.TrackedDevicePose_t[])args[0]; if (poses.Length <= i) return; @@ -58,12 +57,8 @@ private void OnNewPoses(params object[] args) if (origin != null) { - pose = new SteamVR_Utils.RigidTransform(origin) * pose; - pose.pos.x *= origin.localScale.x; - pose.pos.y *= origin.localScale.y; - pose.pos.z *= origin.localScale.z; - transform.position = pose.pos; - transform.rotation = pose.rot; + transform.position = origin.transform.TransformPoint(pose.pos); + transform.rotation = origin.rotation * pose.rot; } else { @@ -72,6 +67,13 @@ private void OnNewPoses(params object[] args) } } + SteamVR_Events.Action newPosesAction; + + void Awake() + { + newPosesAction = SteamVR_Events.NewPosesAction(OnNewPoses); + } + void OnEnable() { var render = SteamVR_Render.instance; @@ -81,12 +83,12 @@ void OnEnable() return; } - SteamVR_Utils.Event.Listen("new_poses", OnNewPoses); + newPosesAction.enabled = true; } void OnDisable() { - SteamVR_Utils.Event.Remove("new_poses", OnNewPoses); + newPosesAction.enabled = false; isValid = false; } diff --git a/Assets/SteamVR/Scripts/SteamVR_Utils.cs b/Assets/SteamVR/Scripts/SteamVR_Utils.cs index 7f1d182..c1f5945 100644 --- a/Assets/SteamVR/Scripts/SteamVR_Utils.cs +++ b/Assets/SteamVR/Scripts/SteamVR_Utils.cs @@ -1,4 +1,4 @@ -//========= Copyright 2014, Valve Corporation, All rights reserved. =========== +//======= Copyright (c) Valve Corporation, All rights reserved. =============== // // Purpose: Utilities for working with SteamVR // @@ -11,44 +11,6 @@ public static class SteamVR_Utils { - public class Event - { - public delegate void Handler(params object[] args); - - public static void Listen(string message, Handler action) - { - var actions = listeners[message] as Handler; - if (actions != null) - { - listeners[message] = actions + action; - } - else - { - listeners[message] = action; - } - } - - public static void Remove(string message, Handler action) - { - var actions = listeners[message] as Handler; - if (actions != null) - { - listeners[message] = actions - action; - } - } - - public static void Send(string message, params object[] args) - { - var actions = listeners[message] as Handler; - if (actions != null) - { - actions(args); - } - } - - private static Hashtable listeners = new Hashtable(); - } - // this version does not clamp [0..1] public static Quaternion Slerp(Quaternion A, Quaternion B, float t) { @@ -387,79 +349,6 @@ public void Interpolate(RigidTransform to, float t) } } - public static Mesh CreateHiddenAreaMesh(HiddenAreaMesh_t src, VRTextureBounds_t bounds) - { - if (src.unTriangleCount == 0) - return null; - - var data = new float[src.unTriangleCount * 3 * 2]; //HmdVector2_t - Marshal.Copy(src.pVertexData, data, 0, data.Length); - - var vertices = new Vector3[src.unTriangleCount * 3 + 12]; - var indices = new int[src.unTriangleCount * 3 + 24]; - - var x0 = 2.0f * bounds.uMin - 1.0f; - var x1 = 2.0f * bounds.uMax - 1.0f; - var y0 = 2.0f * bounds.vMin - 1.0f; - var y1 = 2.0f * bounds.vMax - 1.0f; - - for (int i = 0, j = 0; i < src.unTriangleCount * 3; i++) - { - var x = Lerp(x0, x1, data[j++]); - var y = Lerp(y0, y1, data[j++]); - vertices[i] = new Vector3(x, y, 0.0f); - indices[i] = i; - } - - // Add border - var offset = (int)src.unTriangleCount * 3; - var iVert = offset; - vertices[iVert++] = new Vector3(-1, -1, 0); - vertices[iVert++] = new Vector3(x0, -1, 0); - vertices[iVert++] = new Vector3(-1, 1, 0); - vertices[iVert++] = new Vector3(x0, 1, 0); - vertices[iVert++] = new Vector3(x1, -1, 0); - vertices[iVert++] = new Vector3( 1, -1, 0); - vertices[iVert++] = new Vector3(x1, 1, 0); - vertices[iVert++] = new Vector3( 1, 1, 0); - vertices[iVert++] = new Vector3(x0, y0, 0); - vertices[iVert++] = new Vector3(x1, y0, 0); - vertices[iVert++] = new Vector3(x0, y1, 0); - vertices[iVert++] = new Vector3(x1, y1, 0); - - var iTri = offset; - indices[iTri++] = offset + 0; - indices[iTri++] = offset + 1; - indices[iTri++] = offset + 2; - indices[iTri++] = offset + 2; - indices[iTri++] = offset + 1; - indices[iTri++] = offset + 3; - indices[iTri++] = offset + 4; - indices[iTri++] = offset + 5; - indices[iTri++] = offset + 6; - indices[iTri++] = offset + 6; - indices[iTri++] = offset + 5; - indices[iTri++] = offset + 7; - indices[iTri++] = offset + 1; - indices[iTri++] = offset + 4; - indices[iTri++] = offset + 8; - indices[iTri++] = offset + 8; - indices[iTri++] = offset + 4; - indices[iTri++] = offset + 9; - indices[iTri++] = offset + 10; - indices[iTri++] = offset + 11; - indices[iTri++] = offset + 3; - indices[iTri++] = offset + 3; - indices[iTri++] = offset + 11; - indices[iTri++] = offset + 6; - - var mesh = new Mesh(); - mesh.vertices = vertices; - mesh.triangles = indices; - mesh.bounds = new Bounds( Vector3.zero, new Vector3( float.MaxValue, float.MaxValue, float.MaxValue ) ); // Prevent frustum culling from culling this mesh - return mesh; - } - public delegate object SystemFn(CVRSystem system, params object[] args); public static object CallSystemFn(SystemFn fn, params object[] args) @@ -480,13 +369,229 @@ public static object CallSystemFn(SystemFn fn, params object[] args) return result; } - public static void QueueEventOnRenderThread(int eventID) + public static void TakeStereoScreenshot(uint screenshotHandle, GameObject target, int cellSize, float ipd, ref string previewFilename, ref string VRFilename) { -#if (UNITY_5_0 || UNITY_5_1) - GL.IssuePluginEvent(eventID); -#elif (UNITY_5_2 || UNITY_5_3) - GL.IssuePluginEvent(SteamVR.Unity.GetRenderEventFunc(), eventID); -#endif + const int width = 4096; + const int height = width / 2; + const int halfHeight = height / 2; + + var texture = new Texture2D(width, height * 2, TextureFormat.ARGB32, false); + + var timer = new System.Diagnostics.Stopwatch(); + + Camera tempCamera = null; + + timer.Start(); + + var camera = target.GetComponent(); + if (camera == null) + { + if (tempCamera == null) + tempCamera = new GameObject().AddComponent(); + camera = tempCamera; + } + + // Render preview texture + const int previewWidth = 2048; + const int previewHeight = 2048; + var previewTexture = new Texture2D(previewWidth, previewHeight, TextureFormat.ARGB32, false); + var targetPreviewTexture = new RenderTexture(previewWidth, previewHeight, 24); + + var oldTargetTexture = camera.targetTexture; + var oldOrthographic = camera.orthographic; + var oldFieldOfView = camera.fieldOfView; + var oldAspect = camera.aspect; + var oldstereoTargetEye = camera.stereoTargetEye; + camera.stereoTargetEye = StereoTargetEyeMask.None; + camera.fieldOfView = 60.0f; + camera.orthographic = false; + camera.targetTexture = targetPreviewTexture; + camera.aspect = 1.0f; + camera.Render(); + + // copy preview texture + RenderTexture.active = targetPreviewTexture; + previewTexture.ReadPixels(new Rect(0, 0, targetPreviewTexture.width, targetPreviewTexture.height), 0, 0); + RenderTexture.active = null; + camera.targetTexture = null; + Object.DestroyImmediate(targetPreviewTexture); + + var fx = camera.gameObject.AddComponent(); + + var oldPosition = target.transform.localPosition; + var oldRotation = target.transform.localRotation; + var basePosition = target.transform.position; + var baseRotation = Quaternion.Euler(0, target.transform.rotation.eulerAngles.y, 0); + + var transform = camera.transform; + + int vTotal = halfHeight / cellSize; + float dv = 90.0f / vTotal; // vertical degrees per segment + float dvHalf = dv / 2.0f; + + var targetTexture = new RenderTexture(cellSize, cellSize, 24); + targetTexture.wrapMode = TextureWrapMode.Clamp; + targetTexture.antiAliasing = 8; + + camera.fieldOfView = dv; + camera.orthographic = false; + camera.targetTexture = targetTexture; + camera.aspect = oldAspect; + camera.stereoTargetEye = StereoTargetEyeMask.None; + + // Render sections of a sphere using a rectilinear projection + // and resample using a sphereical projection into a single panorama + // texture per eye. We break into sections in order to keep the eye + // separation similar around the sphere. Rendering alternates between + // top and bottom sections, sweeping horizontally around the sphere, + // alternating left and right eyes. + for (int v = 0; v < vTotal; v++) + { + var pitch = 90.0f - (v * dv) - dvHalf; + var uTotal = width / targetTexture.width; + var du = 360.0f / uTotal; // horizontal degrees per segment + var duHalf = du / 2.0f; + + var vTarget = v * halfHeight / vTotal; + + for (int i = 0; i < 2; i++) // top, bottom + { + if (i == 1) + { + pitch = -pitch; + vTarget = height - vTarget - cellSize; + } + + for (int u = 0; u < uTotal; u++) + { + var yaw = -180.0f + (u * du) + duHalf; + + var uTarget = u * width / uTotal; + + var vTargetOffset = 0; + var xOffset = -ipd / 2 * Mathf.Cos(pitch * Mathf.Deg2Rad); + + for (int j = 0; j < 2; j++) // left, right + { + if (j == 1) + { + vTargetOffset = height; + xOffset = -xOffset; + } + + var offset = baseRotation * Quaternion.Euler(0, yaw, 0) * new Vector3(xOffset, 0, 0); + transform.position = basePosition + offset; + + var direction = Quaternion.Euler(pitch, yaw, 0.0f); + transform.rotation = baseRotation * direction; + + // vector pointing to center of this section + var N = direction * Vector3.forward; + + // horizontal span of this section in degrees + var phi0 = yaw - (du / 2); + var phi1 = phi0 + du; + + // vertical span of this section in degrees + var theta0 = pitch + (dv / 2); + var theta1 = theta0 - dv; + + var midPhi = (phi0 + phi1) / 2; + var baseTheta = Mathf.Abs(theta0) < Mathf.Abs(theta1) ? theta0 : theta1; + + // vectors pointing to corners of image closes to the equator + var V00 = Quaternion.Euler(baseTheta, phi0, 0.0f) * Vector3.forward; + var V01 = Quaternion.Euler(baseTheta, phi1, 0.0f) * Vector3.forward; + + // vectors pointing to top and bottom midsection of image + var V0M = Quaternion.Euler(theta0, midPhi, 0.0f) * Vector3.forward; + var V1M = Quaternion.Euler(theta1, midPhi, 0.0f) * Vector3.forward; + + // intersection points for each of the above + var P00 = V00 / Vector3.Dot(V00, N); + var P01 = V01 / Vector3.Dot(V01, N); + var P0M = V0M / Vector3.Dot(V0M, N); + var P1M = V1M / Vector3.Dot(V1M, N); + + // calculate basis vectors for plane + var P00_P01 = P01 - P00; + var P0M_P1M = P1M - P0M; + + var uMag = P00_P01.magnitude; + var vMag = P0M_P1M.magnitude; + + var uScale = 1.0f / uMag; + var vScale = 1.0f / vMag; + + var uAxis = P00_P01 * uScale; + var vAxis = P0M_P1M * vScale; + + // update material constant buffer + fx.Set(N, phi0, phi1, theta0, theta1, + uAxis, P00, uScale, + vAxis, P0M, vScale); + + camera.aspect = uMag / vMag; + camera.Render(); + + RenderTexture.active = targetTexture; + texture.ReadPixels(new Rect(0, 0, targetTexture.width, targetTexture.height), uTarget, vTarget + vTargetOffset); + RenderTexture.active = null; + } + + // Update progress + var progress = (float)( v * ( uTotal * 2.0f ) + u + i*uTotal) / (float)(vTotal * ( uTotal * 2.0f ) ); + OpenVR.Screenshots.UpdateScreenshotProgress(screenshotHandle, progress); + } + } + } + + // 100% flush + OpenVR.Screenshots.UpdateScreenshotProgress(screenshotHandle, 1.0f); + + // Save textures to disk. + // Add extensions + previewFilename += ".png"; + VRFilename += ".png"; + + // Preview + previewTexture.Apply(); + System.IO.File.WriteAllBytes(previewFilename, previewTexture.EncodeToPNG()); + + // VR + texture.Apply(); + System.IO.File.WriteAllBytes(VRFilename, texture.EncodeToPNG()); + + // Cleanup. + if (camera != tempCamera) + { + camera.targetTexture = oldTargetTexture; + camera.orthographic = oldOrthographic; + camera.fieldOfView = oldFieldOfView; + camera.aspect = oldAspect; + camera.stereoTargetEye = oldstereoTargetEye; + + target.transform.localPosition = oldPosition; + target.transform.localRotation = oldRotation; + } + else + { + tempCamera.targetTexture = null; + } + + Object.DestroyImmediate(targetTexture); + Object.DestroyImmediate(fx); + + timer.Stop(); + Debug.Log(string.Format("Screenshot took {0} seconds.", timer.Elapsed)); + + if (tempCamera != null) + { + Object.DestroyImmediate(tempCamera.gameObject); + } + + Object.DestroyImmediate(previewTexture); + Object.DestroyImmediate(texture); } } diff --git a/Assets/SteamVR/Textures.meta b/Assets/SteamVR/Textures.meta index 043ec8d..04298ac 100644 --- a/Assets/SteamVR/Textures.meta +++ b/Assets/SteamVR/Textures.meta @@ -1,9 +1,6 @@ fileFormatVersion: 2 -guid: 003cb17d6edd28b4d88df6f35f9c03ab +guid: abfc00e0350ad744083849e2d7ae06ee folderAsset: yes -timeCreated: 1465633285 -licenseType: Free DefaultImporter: userData: assetBundleName: - assetBundleVariant: diff --git a/Assets/SteamVR/readme.txt b/Assets/SteamVR/readme.txt index e0d4a56..b0c5d2c 100644 --- a/Assets/SteamVR/readme.txt +++ b/Assets/SteamVR/readme.txt @@ -1,37 +1,101 @@ -This is a stripped down version of the Unity Steam VR plugin v1.1 that includes just the core functionality required to display Overlays. +SteamVR plugin for Unity - v1.2.1 +Copyright (c) Valve Corporation, All rights reserved. -Please see https://www.assetstore.unity3d.com/en/#!/content/32647 for additional information. +Quickstart: +To use, simply add the SteamVR_Camera script to your Camera object(s). Everything else gets set up at +runtime. See the included quickstart guide for more details. -The following is the original text of this ReadMe, though many features have been stripped from this version. +Requirements: +The SteamVR runtime must be installed. This can be found in Steam under Tools. +Changes for v1.2.1: +* Updated to SteamVR runtime v1485823399 and SDK version 1.0.6. +* Switched SteamVR_Events.SystemAction from using strings to specify event type over to their associated enum values. +* Fixed an issue with using WWW in static constructors. +* Added Unity Preferences for SteamVR to allow disabling automatic enabling of native OpenVR support in Unity 5.4 or newer. +https://github.com/ValveSoftware/steamvr_unity_plugin/issues/8 +https://github.com/ValveSoftware/steamvr_unity_plugin/pull/9 +* Added UNITY_SHADER_NO_UPGRADE to all shaders to avoid log spam in later versions of Unity for issues that have already been fixed but the compiler isn't able to detect. +* Specified Vulkan support for Interaction System shaders. +* Fix for crash in Interaction_Example selecting BowPickup: +https://github.com/ValveSoftware/steamvr_unity_plugin/issues/4 -SteamVR plugin for Unity - v1.1.0 -Copyright 2014-2016, Valve Corporation, All rights reserved. +* Cleaned up unused fields: +https://github.com/ValveSoftware/steamvr_unity_plugin/issues/2 +* Updated Interaction System's LinearDrive to initialize using linearMapping.value. +https://github.com/ValveSoftware/steamvr_unity_plugin/pull/5 -Quickstart: +* Updated Interaction System documetation to fix a few errors. -To use, simply add the SteamVR_Camera script to your Camera object(s). Everything else gets set up at -runtime. See the included quickstart guide for more details. +* Added an icon for all Interaction System scripts. +* Fixes for SteamVR on Linux. -Requirements: -The SteamVR runtime must be installed. This can be found in Steam under Tools. +Changes for v1.2.0: + +* Updated to SteamVR runtime v1481926580 and SDK version 1.0.5. + +* Replaced SteamVR_Utils.Event with SteamVR_Events. to avoid runtime memory allocation associated with use of params object[] args. + +* Added SteamVR_Events.Action to make it easy to wrap callbacks to avoid memory allocation when components are frequently enabled/disabled at runtime. + +* Fixed other miscellaneous runtime memory allocation in SteamVR_Render and SteamVR_RenderModels. (Suggestions by unity3d user @8bitgoose.) + +* Integrated fix for SteamVR_LaserPointer direction (from github user @fredsa). + +* Integrated fixes and comments for SteamVR_Teleporter (from github user @natewinck). + +* Removed SteamVR_Status and SteamVR_StatusText as they were using SteamVR_Utils.Event with generic strings which is no longer allowed. + +* Added SteamVR_Controller.assignAllBeforeIdentified (to allow controller to be assigned before identified as left vs right). Suggested by github user @chrwoizi. -The plugin currently only supports Windows / DX11. +* Added SteamVR_Controller.UpdateTargets public interface. This allows spawning the component at runtime. Suggested by github user @demonixis. + +* Fixed bug with SteamVR_TrackedObject when specifying origin. Suggested by github user @fredsa. + +* Fixed issue with head camera reference in SteamVR_Camera. Suggested by github user @pedrofe. + +Known issues: + +* The current beta version of Unity 5.6 breaks the normal operation of the SteamVR_UpdatePoses component (required for tracked controllers). +To work around this in the meantime, you will need to manually add the SteamVR_UpdatePoses component to your main camera. + + +Changes for v1.1.1: + +* Updated to SteamVR runtime v1467410709 and SDK version 1.0.2. + +* Updated Copyright notice. + +* Added SteamVR_TrackedCamera for accessing tracked camera video stream and poses. + +* Added SteamVR_TestTrackedCamera scene and associated script to demonstrate how to use SteamVR_TrackedCamera. + +* Fix for SteamVR_Fade shader to account for changes in Unity 5.4. + +* SteamVR_GameView will now use the compositor's mirror texture to render the companion window (pre-Unity 5.4 only). + +* Renamed SteamVR_LoadLevel 'externalApp' to 'internalProcess' to reflect actual functionality. + +* Fixed issue with SteamVR_PlayArea material loading due to changes in Unity 5.4. + +* Added Screenshot support handling for stereo panoramas generation. + +* Removed code that was setting Time.maximumDeltaTime as this was causing issues. Changes for v1.1.0: @@ -328,8 +392,7 @@ up and running quickly and easily. You are encouraged to modify these to suit y and provide feedback at http://steamcommunity.com/app/250820 or http://steamcommunity.com/app/358720/discussions Assets/SteamVR/Scenes/example.unity - A sample scene demonstrating the functionality provided by this plugin. -This also shows you how to set up a separate camera for rendering gui elements, and handle events to display -hmd status. +This also shows you how to set up a separate camera for rendering gui elements. Details: @@ -379,8 +442,7 @@ Prefabs: SteamVR_Camera component added to it, and the Expand button clicked. It also includes a full set of Tracked Devices which will display and follow any connected tracked devices (e.g. controllers, base stations and cameras). -[Status] - This is a set of components for providing various status info. You can add it to your scene to get -notifications for leaving the tracking bounds, et cetera. It also includes an escape menu for tweaking options. +[Status] - The prefab is for demonstration purposes only. It adds an escape menu to your scene. Note: It uses the SteamVR_Overlay component, which is rather expensive rendering-wise. [SteamVR] - This object controls some global settings for SteamVR, most notably Tracking Space. Legacy projects @@ -434,28 +496,21 @@ and right culling mask to use to control rendering per eye if necessary. Events: -SteamVR_Camera fires off several events. These can be handled by registering for them through -SteamVR_Utils.Event.Listen. Be sure to remove your handler when no longer needed. The best pattern is to -Listen and Remove in OnEnable and OnDisable respectively. +SteamVR fires off several events. These can be handled by registering for them through +SteamVR_Events..Listen. Be sure to remove your handler when no longer needed. +The best pattern is to Listen and Remove in OnEnable and OnDisable respectively. -"initializing" - This event is sent when the hmd's tracking status changes to or from Unitialized. +Initializing - This event is sent when the hmd's tracking status changes to or from Unitialized. -"calibrating" - This event is sent when starting or stopping calibration with the new state. +Calibrating - This event is sent when starting or stopping calibration with the new state. -"out_of_range" - This event is sent when losing or reacquiring absolute positional tracking. This will +OutOfRange - This event is sent when losing or reacquiring absolute positional tracking. This will never fire for the Rift DK1 since it does not have positional tracking. For camera based trackers, this happens when the hmd exits and enters the camera's view. -"device_connected" - This event is sent when devices are connected or disconnected. The device index is passed +DeviceConnected - This event is sent when devices are connected or disconnected. The device index is passed as the first argument, and the connected status (true / false) as the second argument. -Feel free to leverage this system to fire off events of your own. SteamVR_Utils.Event.Send takes any number -of parameters, and passes them on to all registered callbacks. - -A helper class has been included called SteamVR_Status which leverages these events to display hmd status to -the user. Examples of this can be found in the example scene. SteamVR_StatusText specifically, leverages this -functionality to wrap up GUIText display, overriding SetAlpha. - Keybindings (if using the [Status] prefab): diff --git a/HeadlessOverlayToolkit.sln b/HeadlessOverlayToolkit.sln index 611f241..7c4ef4b 100644 --- a/HeadlessOverlayToolkit.sln +++ b/HeadlessOverlayToolkit.sln @@ -1,11 +1,11 @@  Microsoft Visual Studio Solution File, Format Version 12.00 -# Visual Studio 2015 -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "HeadlessOverlayToolkit.CSharp.Plugins", "HeadlessOverlayToolkit.CSharp.Plugins.csproj", "{471817E4-67A9-BA4F-2262-A19C91959061}" +# Visual Studio 2017 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "HeadlessOverlayToolkit.Plugins", "HeadlessOverlayToolkit.Plugins.csproj", "{80B11C52-6A9D-A19E-017A-11779F10F324}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "HeadlessOverlayToolkit.CSharp", "HeadlessOverlayToolkit.CSharp.csproj", "{8F24E7B6-8CFC-E0AE-713B-BA6442E31BD9}" +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "HeadlessOverlayToolkit", "HeadlessOverlayToolkit.csproj", "{D8AD80B1-8258-56A8-A566-DD1E0971896D}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "HeadlessOverlayToolkit.CSharp.Editor", "HeadlessOverlayToolkit.CSharp.Editor.csproj", "{0A44FD87-305E-6AA5-8803-843E7DC44199}" +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "HeadlessOverlayToolkit.Editor", "HeadlessOverlayToolkit.Editor.csproj", "{D58FEC66-C1BD-6992-8B3A-9885EEA82DA5}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution @@ -13,18 +13,18 @@ Global Release|Any CPU = Release|Any CPU EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution - {471817E4-67A9-BA4F-2262-A19C91959061}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {471817E4-67A9-BA4F-2262-A19C91959061}.Debug|Any CPU.Build.0 = Debug|Any CPU - {471817E4-67A9-BA4F-2262-A19C91959061}.Release|Any CPU.ActiveCfg = Release|Any CPU - {471817E4-67A9-BA4F-2262-A19C91959061}.Release|Any CPU.Build.0 = Release|Any CPU - {8F24E7B6-8CFC-E0AE-713B-BA6442E31BD9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {8F24E7B6-8CFC-E0AE-713B-BA6442E31BD9}.Debug|Any CPU.Build.0 = Debug|Any CPU - {8F24E7B6-8CFC-E0AE-713B-BA6442E31BD9}.Release|Any CPU.ActiveCfg = Release|Any CPU - {8F24E7B6-8CFC-E0AE-713B-BA6442E31BD9}.Release|Any CPU.Build.0 = Release|Any CPU - {0A44FD87-305E-6AA5-8803-843E7DC44199}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {0A44FD87-305E-6AA5-8803-843E7DC44199}.Debug|Any CPU.Build.0 = Debug|Any CPU - {0A44FD87-305E-6AA5-8803-843E7DC44199}.Release|Any CPU.ActiveCfg = Release|Any CPU - {0A44FD87-305E-6AA5-8803-843E7DC44199}.Release|Any CPU.Build.0 = Release|Any CPU + {80B11C52-6A9D-A19E-017A-11779F10F324}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {80B11C52-6A9D-A19E-017A-11779F10F324}.Debug|Any CPU.Build.0 = Debug|Any CPU + {80B11C52-6A9D-A19E-017A-11779F10F324}.Release|Any CPU.ActiveCfg = Release|Any CPU + {80B11C52-6A9D-A19E-017A-11779F10F324}.Release|Any CPU.Build.0 = Release|Any CPU + {D8AD80B1-8258-56A8-A566-DD1E0971896D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {D8AD80B1-8258-56A8-A566-DD1E0971896D}.Debug|Any CPU.Build.0 = Debug|Any CPU + {D8AD80B1-8258-56A8-A566-DD1E0971896D}.Release|Any CPU.ActiveCfg = Release|Any CPU + {D8AD80B1-8258-56A8-A566-DD1E0971896D}.Release|Any CPU.Build.0 = Release|Any CPU + {D58FEC66-C1BD-6992-8B3A-9885EEA82DA5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {D58FEC66-C1BD-6992-8B3A-9885EEA82DA5}.Debug|Any CPU.Build.0 = Debug|Any CPU + {D58FEC66-C1BD-6992-8B3A-9885EEA82DA5}.Release|Any CPU.ActiveCfg = Release|Any CPU + {D58FEC66-C1BD-6992-8B3A-9885EEA82DA5}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE diff --git a/Library/AssetImportState b/Library/AssetImportState index 99e6017..0ecf2e2 100644 --- a/Library/AssetImportState +++ b/Library/AssetImportState @@ -1 +1 @@ -5;0;6;-1 \ No newline at end of file +19;0;6;0;1 \ No newline at end of file diff --git a/Library/AssetServerCacheV3 b/Library/AssetServerCacheV3 index e2de7cf..0bd07e6 100644 Binary files a/Library/AssetServerCacheV3 and b/Library/AssetServerCacheV3 differ diff --git a/Library/CurrentLayout.dwlt b/Library/CurrentLayout.dwlt index 4efcfc0..23a17dd 100644 Binary files a/Library/CurrentLayout.dwlt and b/Library/CurrentLayout.dwlt differ diff --git a/Library/EditorUserBuildSettings.asset b/Library/EditorUserBuildSettings.asset index fb68135..459d171 100644 Binary files a/Library/EditorUserBuildSettings.asset and b/Library/EditorUserBuildSettings.asset differ diff --git a/Library/LastSceneManagerSetup.txt b/Library/LastSceneManagerSetup.txt index 3dcbb39..cb46bcd 100644 --- a/Library/LastSceneManagerSetup.txt +++ b/Library/LastSceneManagerSetup.txt @@ -1,4 +1,4 @@ sceneSetups: -- path: Assets/Default.unity +- path: Assets/HOTK/Example Content/HOTK_DemoScene.unity isLoaded: 1 isActive: 1 diff --git a/Library/ProjectSettings.asset b/Library/ProjectSettings.asset index efca6a5..7ac0ca7 100644 Binary files a/Library/ProjectSettings.asset and b/Library/ProjectSettings.asset differ diff --git a/Library/ScriptAssemblies/Assembly-CSharp-Editor.dll b/Library/ScriptAssemblies/Assembly-CSharp-Editor.dll index 644b619..5feef59 100644 Binary files a/Library/ScriptAssemblies/Assembly-CSharp-Editor.dll and b/Library/ScriptAssemblies/Assembly-CSharp-Editor.dll differ diff --git a/Library/ScriptAssemblies/Assembly-CSharp-Editor.dll.mdb b/Library/ScriptAssemblies/Assembly-CSharp-Editor.dll.mdb index 20e3c16..5c99686 100644 Binary files a/Library/ScriptAssemblies/Assembly-CSharp-Editor.dll.mdb and b/Library/ScriptAssemblies/Assembly-CSharp-Editor.dll.mdb differ diff --git a/Library/ScriptAssemblies/Assembly-CSharp-firstpass.dll b/Library/ScriptAssemblies/Assembly-CSharp-firstpass.dll index 62d55ce..1db2275 100644 Binary files a/Library/ScriptAssemblies/Assembly-CSharp-firstpass.dll and b/Library/ScriptAssemblies/Assembly-CSharp-firstpass.dll differ diff --git a/Library/ScriptAssemblies/Assembly-CSharp-firstpass.dll.mdb b/Library/ScriptAssemblies/Assembly-CSharp-firstpass.dll.mdb index 21e1713..1e1493a 100644 Binary files a/Library/ScriptAssemblies/Assembly-CSharp-firstpass.dll.mdb and b/Library/ScriptAssemblies/Assembly-CSharp-firstpass.dll.mdb differ diff --git a/Library/ScriptAssemblies/Assembly-CSharp.dll b/Library/ScriptAssemblies/Assembly-CSharp.dll index dd385b1..5a1bb2a 100644 Binary files a/Library/ScriptAssemblies/Assembly-CSharp.dll and b/Library/ScriptAssemblies/Assembly-CSharp.dll differ diff --git a/Library/ScriptAssemblies/Assembly-CSharp.dll.mdb b/Library/ScriptAssemblies/Assembly-CSharp.dll.mdb index 486b682..fdb979a 100644 Binary files a/Library/ScriptAssemblies/Assembly-CSharp.dll.mdb and b/Library/ScriptAssemblies/Assembly-CSharp.dll.mdb differ diff --git a/Library/ScriptAssemblies/BuiltinAssemblies.stamp b/Library/ScriptAssemblies/BuiltinAssemblies.stamp index 35b4e81..134fea5 100644 --- a/Library/ScriptAssemblies/BuiltinAssemblies.stamp +++ b/Library/ScriptAssemblies/BuiltinAssemblies.stamp @@ -1,2 +1,2 @@ -0000.572f869a.0000 -0000.572f86ae.0000 \ No newline at end of file +0000.59106994.0000 +0000.591069ac.0000 \ No newline at end of file diff --git a/Library/ScriptMapper b/Library/ScriptMapper index e1a7aa8..18d93e6 100644 Binary files a/Library/ScriptMapper and b/Library/ScriptMapper differ diff --git a/Library/ShaderCache.db b/Library/ShaderCache.db index 3941199..3d67eec 100644 Binary files a/Library/ShaderCache.db and b/Library/ShaderCache.db differ diff --git a/Library/UnityAssemblies/SyntaxTree.VisualStudio.Unity.Bridge.dll b/Library/UnityAssemblies/SyntaxTree.VisualStudio.Unity.Bridge.dll index 6a2a061..a7b5a86 100644 Binary files a/Library/UnityAssemblies/SyntaxTree.VisualStudio.Unity.Bridge.dll and b/Library/UnityAssemblies/SyntaxTree.VisualStudio.Unity.Bridge.dll differ diff --git a/Library/UnityAssemblies/UnityEditor.Advertisements.dll b/Library/UnityAssemblies/UnityEditor.Advertisements.dll index d0ce904..9c1ac8f 100644 Binary files a/Library/UnityAssemblies/UnityEditor.Advertisements.dll and b/Library/UnityAssemblies/UnityEditor.Advertisements.dll differ diff --git a/Library/UnityAssemblies/UnityEditor.EditorTestsRunner.dll b/Library/UnityAssemblies/UnityEditor.EditorTestsRunner.dll deleted file mode 100644 index 484c8fb..0000000 Binary files a/Library/UnityAssemblies/UnityEditor.EditorTestsRunner.dll and /dev/null differ diff --git a/Library/UnityAssemblies/UnityEditor.EditorTestsRunner.xml b/Library/UnityAssemblies/UnityEditor.EditorTestsRunner.xml deleted file mode 100644 index 0314cec..0000000 --- a/Library/UnityAssemblies/UnityEditor.EditorTestsRunner.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - UnityEditor.EditorTestsRunner - - - diff --git a/Library/UnityAssemblies/UnityEditor.Graphs.dll b/Library/UnityAssemblies/UnityEditor.Graphs.dll index 113fa09..5670169 100644 Binary files a/Library/UnityAssemblies/UnityEditor.Graphs.dll and b/Library/UnityAssemblies/UnityEditor.Graphs.dll differ diff --git a/Library/UnityAssemblies/UnityEditor.Networking.dll b/Library/UnityAssemblies/UnityEditor.Networking.dll index 5160311..1267635 100644 Binary files a/Library/UnityAssemblies/UnityEditor.Networking.dll and b/Library/UnityAssemblies/UnityEditor.Networking.dll differ diff --git a/Library/UnityAssemblies/UnityEditor.TreeEditor.dll b/Library/UnityAssemblies/UnityEditor.TreeEditor.dll index d0443ab..ca5c368 100644 Binary files a/Library/UnityAssemblies/UnityEditor.TreeEditor.dll and b/Library/UnityAssemblies/UnityEditor.TreeEditor.dll differ diff --git a/Library/UnityAssemblies/UnityEditor.UI.dll b/Library/UnityAssemblies/UnityEditor.UI.dll index 3718685..d03b046 100644 Binary files a/Library/UnityAssemblies/UnityEditor.UI.dll and b/Library/UnityAssemblies/UnityEditor.UI.dll differ diff --git a/Library/UnityAssemblies/UnityEditor.UI.xml b/Library/UnityAssemblies/UnityEditor.UI.xml index 8cdbaca..5a68024 100644 --- a/Library/UnityAssemblies/UnityEditor.UI.xml +++ b/Library/UnityAssemblies/UnityEditor.UI.xml @@ -279,6 +279,11 @@ Rectangle in which to draw the preview. Background image. + + + Custom editor for the RectMask2d component. + + Custom Editor for the Scrollbar Component. diff --git a/Library/UnityAssemblies/UnityEditor.WindowsStandalone.Extensions.dll b/Library/UnityAssemblies/UnityEditor.WindowsStandalone.Extensions.dll index 8ddef14..f48a2b6 100644 Binary files a/Library/UnityAssemblies/UnityEditor.WindowsStandalone.Extensions.dll and b/Library/UnityAssemblies/UnityEditor.WindowsStandalone.Extensions.dll differ diff --git a/Library/UnityAssemblies/UnityEditor.dll b/Library/UnityAssemblies/UnityEditor.dll index c8505a6..15a608c 100644 Binary files a/Library/UnityAssemblies/UnityEditor.dll and b/Library/UnityAssemblies/UnityEditor.dll differ diff --git a/Library/UnityAssemblies/UnityEditor.xml b/Library/UnityAssemblies/UnityEditor.xml index 32a2054..8ea1af8 100644 --- a/Library/UnityAssemblies/UnityEditor.xml +++ b/Library/UnityAssemblies/UnityEditor.xml @@ -19,6 +19,105 @@ 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. + + + + + Returns if a specific platform is enabled. + + + + Boolean for the platform. + + + + + Sets the game identifier for the specified platform. + + + + + + + Enable the specific platform. + + + + + + + Navigation mesh builder interface. + + + + + Returns true if an asynchronous build is still running. + + + + + Build the Navmesh. + + + + + Build the Navmesh Asyncronously. + + + + + Builds the combined navmesh for the contents of multiple scenes. + + Array of paths to scenes that are used for building the navmesh. + + + + Cancels an asynchronous update of the specified NavMesh data. See Also: UpdateNavMeshDataAsync. + + The data associated with asynchronous updating. + + + + Clear all Navmeshes. + + + + + Represents the visualization state of the navigation debug graphics. + + + + + A count of how many users requesting navigation debug graphics to be enabled. + + Hierarchy sort method to allow for items and their children to be sorted alphabetically. @@ -29,79 +128,114 @@ Content to visualize the alphabetical sorting method. - + - Gamepad support level for Android TV. + 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. - + - Requires a gamepad for gameplay. + This Boolean field will cause the Analytics feature in Unity to be enabled if true, or disabled if false. - + - Game is fully operational with a D-pad, no gamepad needed. + Set to true for testing Analytics integration only within the Editor. - + - Works with a gamepad, but does not require it. + Normally performance reporting is enabled from the Services window, but if writing your own editor extension, this API can be used. - + - Preferred application install location. + This Boolean field causes the performance reporting feature in Unity to be enabled if true, or disabled if false. - + - Let the OS decide, app doesn't have any preferences. + Type of Android build system. - + - Force installation into internal memory. Needed for things like Live Wallpapers. + Export ADT (legacy) project. - + - Prefer external, if possible. Install to internal otherwise. + Build APK using Gradle or export Gradle project. - + - Supported Android SDK versions. + 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. + + + + + Gamepad support level for Android TV. + + + + + Requires a gamepad for gameplay. + + + + + Game is fully operational with a D-pad, no gamepad needed. - + - Android 2.3.3, "Gingerbread", API level 10. + Works with a gamepad, but does not require it. - + - Android 3.0, "Honeycomb", API level 11. + Preferred application install location. - + - Android 3.1, "Honeycomb", API level 12. + Let the OS decide, app doesn't have any preferences. - + - Android 3.2, "Honeycomb", API level 13. + Force installation into internal memory. Needed for things like Live Wallpapers. - + - Android 4.0, "Ice Cream Sandwich", API level 14. + Prefer external, if possible. Install to internal otherwise. - + - Android 4.0.3, "Ice Cream Sandwich", API level 15. + Supported Android SDK versions. @@ -134,9 +268,24 @@ 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 2.3.1, "Gingerbread", API level 9. + Sets the target API level automatically, according to the latest installed SDK on your computer. @@ -428,7 +577,8 @@ - AnimationMode is used by the AnimationWindow to store properties modifed by the AnimationClip playback. + AnimationMode is used by the AnimationWindow to store properties modified + by the AnimationClip playback. @@ -436,21 +586,43 @@ The color used to show that a property is currently being animated. + + + 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 prefab. + + + + Initialise the start of the animation clip sampling. + + + + + Finish the sampling of the animation clip. + + - Are we currently in AnimationMode. + 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. + Samples an AnimationClip on the object and also records any modified + properties in AnimationMode. @@ -1226,7 +1398,13 @@ Units is normalized time. - The normalized time of the source state when the condition is true. + 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. @@ -1236,7 +1414,7 @@ Units is normalized time. - When active the transition duration will have a fixed duration. + Determines whether the duration of the transition is reported in a fixed duration in seconds or as a normalized time. @@ -1318,135 +1496,6 @@ Units is normalized time. The condition to remove. - - - AvatarMask are used to mask out humanoid body parts and transforms. - - - - - Number of transforms. - - - - - 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. - - - - 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. - - Blend trees are used to blend continuously animation between their childs. They can either be 1D or 2D. @@ -1779,6 +1828,36 @@ Units is normalized time. + + + 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. @@ -1830,6 +1909,30 @@ Units is normalized time. The bindings which defines the path and the property of the curve. The curve to add. Setting this to null will remove the curve. + + + 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. @@ -1838,31 +1941,76 @@ Units is normalized time. - + - .NET API compatibility level. + Tangent constraints on Keyframe. - + - .NET 2.0. + The tangents are automatically set to make the curve go smoothly through the key. - + - .NET 2.0 Subset. + The tangents are automatically set to make the curve go smoothly through the key. - + - Helpers for builtin arrays ... + The curve retains a constant value between two keys. - + - Appends item to the end of array. + 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, Android and Tizen if stripping level is set to "Use micro mscorlib". + + + + + Web profile, used only by Samsung TV. + + + + + Helpers for builtin arrays ... + + + + + Appends item to the end of array. + + @@ -1882,6 +2030,16 @@ Units is normalized time. 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. @@ -2025,6 +2183,30 @@ Units is normalized time. 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. @@ -2136,22 +2318,24 @@ Units is normalized time. - Search the asset database using a search filter string. + Search the asset database using the search filter string. - The filter string can contain search data for: names, asset labels and types (class names). - Specifying one or more folders will limit the searching to these folders and their child folders (and is faster than searching all assets). + 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 GUIDs. + Array of matching asset. Note that GUIDs will be returned. - Search the asset database using a search filter string. + Search the asset database using the search filter string. - The filter string can contain search data for: names, asset labels and types (class names). - Specifying one or more folders will limit the searching to these folders and their child folders (and is faster than searching all assets). + 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 GUIDs. + Array of matching asset. Note that GUIDs will be returned. @@ -2168,6 +2352,16 @@ Units is normalized time. 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. @@ -2268,12 +2462,36 @@ Units is normalized time. 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 an absolute path to a directory, this method will return an array of all it's subdirectories. @@ -2330,6 +2548,19 @@ Units is normalized time. + + + 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. + + + + Is asset a foreign asset? @@ -2358,6 +2589,60 @@ Units is normalized time. + + + 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. + + Is asset a native asset? @@ -2372,52 +2657,108 @@ Units is normalized time. + + + 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. + + - Use IsOpenForEdit to determine if the asset is open for edit by the version control. + Query whether an asset file is open for edit in version control. - Is the path to the asset on disk relative to project folder. - Used to give reason for not open. - - + 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 is the asset can be edited. + True if the asset is considered open for edit by the selected version control system. - Use IsOpenForEdit to determine if the asset is open for edit by the version control. + Query whether an asset file is open for edit in version control. - Is the path to the asset on disk relative to project folder. - Used to give reason for not open. - - + 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 is the asset can be edited. + True if the asset is considered open for edit by the selected version control system. - Use IsOpenForEdit to determine if the asset is open for edit by the version control. + Query whether an asset file is open for edit in version control. - Is the path to the asset on disk relative to project folder. - Used to give reason for not open. - - + 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 is the asset can be edited. + True if the asset is considered open for edit by the selected version control system. - Use IsOpenForEdit to determine if the asset is open for edit by the version control. + Query whether an asset file is open for edit in version control. - Is the path to the asset on disk relative to project folder. - Used to give reason for not open. - - + 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 is the asset can be edited. + True if the asset is considered open for edit by the selected version control system. @@ -2459,7 +2800,7 @@ Units is normalized time. Path of the asset to load. Data type of the asset. - The asset matching the parameters + The asset matching the parameters. @@ -2568,6 +2909,13 @@ Units is normalized time. + + + 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. @@ -2659,7 +3007,8 @@ Units is normalized time. - AssetModificationProcessor lets you hook into saving of serialized assets and scenes which are edited inside Unity. + AssetModificationProcessor lets you hook into saving of serialized assets and + scenes which are edited inside Unity. @@ -2785,6 +3134,71 @@ Units is normalized time. The number of previews that can be loaded into the cache before the least used previews are being unloaded. + + + 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. @@ -2923,6 +3337,70 @@ Amount of compression. The value roughly corresponds to the ratio between the re + + + An exception class that represents a failed build. + + + + + Constructs a BuildFailedException object. + + The error that caused the build to fail. + The exception that caused the build to fail. + + + + Constructs a BuildFailedException object. + + The error that caused the build to fail. + The exception that caused the build to fail. + + + + 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 after the build is complete. + + + + + Implement this function to receive a callback after the build is complete. + + + + + + + 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 for each Scene during the build. + + + + + Implement this function to receive a callback for each Scene during the build. + + The current Scene being processed. + Asset Bundle building options. @@ -2958,6 +3436,11 @@ Amount of compression. The value roughly corresponds to the ratio between the re Do not include type information within the AssetBundle. + + + Do a dry run build. + + Force rebuild the assetBundles. @@ -2973,6 +3456,11 @@ Amount of compression. The value roughly corresponds to the ratio between the re 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. @@ -3008,6 +3496,16 @@ Amount of compression. The value roughly corresponds to the ratio between the re Build only the scripts of a project. + + + Use chunk-based Lz4 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. @@ -3043,6 +3541,11 @@ Amount of compression. The value roughly corresponds to the ratio between the re 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). @@ -3212,21 +3715,48 @@ These will be used as asset names, which you can then pass to AssetBundle.Load t Output path for the AssetBundles. AssetBundle building options. - Target build platform. + 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. - AssetBundle building map. + + The manifest listing all AssetBundles included in this build. + - + Builds a player. + Provide various options to control the behavior of BuildPipeline.BuildPlayer. + + An error message if an error occurred. + + + + + Builds a player. These overloads are still supported, but will be replaces by BuildPlayer (BuildPlayerOptions). Please use it 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 replaces by BuildPlayer (BuildPlayerOptions). Please use it 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. @@ -3311,44 +3841,74 @@ These will be used as asset names, which you can then pass to AssetBundle.Load t Lets you manage cross-references and dependencies between different asset bundles and player builds. - + - Target build platform. + Provide various options to control the behavior of BuildPipeline.BuildPlayer. - + - Build an iOS player. + The path to an manifest file describing all of the asset bundles used in the build (optional). - + - OBSOLETE: Use iOS. Build an iOS player. + The path where the application will be built. - + - Build to Apple's tvOS platform. + Additional BuildOptions, like whether to run the built player. - + - Build an Android .apk standalone app. + 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). - + - Build to Nintendo 3DS platform. + The BuildTarget to build. - + - Build a PS3 Standalone. + The BuildTargetGroup to build. - + - Build a PS4 Standalone. + 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. @@ -3378,17 +3938,17 @@ These will be used as asset names, which you can then pass to AssetBundle.Load t - Build an OS X standalone (Intel only). + Build a macOS standalone (Intel only). - Build an OSX Intel 64-bit standalone. + Build a macOS Intel 64-bit standalone. - Build a universal OSX standalone. + Build a universal macOS standalone. @@ -3401,6 +3961,11 @@ These will be used as asset names, which you can then pass to AssetBundle.Load t Build a Windows 64-bit standalone. + + + Build a Nintendo Switch player. + + Build a Tizen player. @@ -3431,11 +3996,6 @@ These will be used as asset names, which you can then pass to AssetBundle.Load t Build an Windows Store Apps player. - - - Build a XBox Standalone. - - Build a Xbox One Standalone. @@ -3466,21 +4026,16 @@ These will be used as asset names, which you can then pass to AssetBundle.Load t Android target. - + - GLESEmu target. + Facebook target. - + Nintendo 3DS target. - - - Sony Playstation 3 target. - - Sony Playstation 4 target. @@ -3501,6 +4056,11 @@ These will be used as asset names, which you can then pass to AssetBundle.Load t Mac/PC standalone target. + + + Nintendo Switch target. + + Samsung Tizen target. @@ -3531,11 +4091,6 @@ These will be used as asset names, which you can then pass to AssetBundle.Load t Windows Store Apps target. - - - Microsoft XBOX360 target. - - Microsoft Xbox One target. @@ -3575,7 +4130,7 @@ These will be used as asset names, which you can then pass to AssetBundle.Load t - Add this attribute to get a callback just before building the scene. + Add this attribute to a method to get a notification just after building the scene. @@ -3613,6 +4168,11 @@ These will be used as asset names, which you can then pass to AssetBundle.Load t A mask containing all the transform in the file will be created internally. + + + No Mask. All the animation will be imported. + + Used as input to ColorField to configure the HDR color ranges in the ColorPicker. @@ -3647,6 +4207,21 @@ These will be used as asset names, which you can then pass to AssetBundle.Load t Minimum exposure value used in the tonemapping section of the Color Picker. Maximum exposure value used in the tonemapping section of the Color Picker. + + + 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. + + Tells an Editor class which run-time type it's an editor for. @@ -3731,6 +4306,16 @@ These will be used as asset names, which you can then pass to AssetBundle.Load t 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. @@ -3748,7 +4333,8 @@ These will be used as asset names, which you can then pass to AssetBundle.Load t - Override this method to make your own GUI for the decorator. + 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. @@ -3858,27 +4444,62 @@ These will be used as asset names, which you can then pass to AssetBundle.Load t - Draw objects with the albedo component only. + Draw objects with the albedo component only. This value has been deprecated. Please use DrawCameraMode.RealtimeAlbedo. - Display alpha channel of the rendering. + The camera is set to display the alpha channel of the rendering. - Draw objects with baked GI only. + 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 baked texel validity only. - Draw objects with different color for each chart (UV island). + Draw objects with different colors for each real-time chart (UV island). - Draw with different color for each cluster. + Draw with different colors for each cluster. @@ -3903,17 +4524,22 @@ These will be used as asset names, which you can then pass to AssetBundle.Load t - Draw objects with directionality for real-time GI. + Draw objects with directionality for real-time GI. This value has been deprecated. Please use DrawCameraMode.RealtimeDirectionality. - Draw objects with the emission component only. + Draw objects with the emission component only. This value has been deprecated. Please use DrawCameraMode.RealtimeEmissive. - Draw objects with real-time GI only. + 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. @@ -3923,7 +4549,7 @@ These will be used as asset names, which you can then pass to AssetBundle.Load t - Display texture resolution, with red tint indicating too high resolution, and blue tint indicating texture sizes that could be higher. + 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. @@ -3933,17 +4559,47 @@ These will be used as asset names, which you can then pass to AssetBundle.Load t - Display scene overdraw, with brighter colors indicating more overdraw. + 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. - Draw color-coded render paths. + The camera is set to draw color coded render paths. - Draw directional light shadowmap cascades. + 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. @@ -3961,6 +4617,16 @@ These will be used as asset names, which you can then pass to AssetBundle.Load t Draw the camera where all objects have a wireframe overlay. and no background clearing. + + + 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. @@ -4026,6 +4692,26 @@ These will be used as asset names, which you can then pass to AssetBundle.Load t + + + Creates a cached editor using a context object. + + + + + + + + + + Creates a cached editor using a context object. + + + + + + + Make a custom editor for targetObject or targetObjects. @@ -4062,6 +4748,14 @@ These will be used as asset names, which you can then pass to AssetBundle.Load t + + + Make a custom editor for targetObject or targetObjects with a context object. + + + + + Draw the built-in inspector. @@ -4160,6 +4854,11 @@ These will be used as asset names, which you can then pass to AssetBundle.Load t 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) @@ -4213,9 +4912,14 @@ Each time an object is (or a group of objects are) created, renamed, parented, u 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. + + - Is editor currently updating? (Read Only) + True if the Editor is currently refreshing the AssetDatabase. @@ -4374,7 +5078,7 @@ Each time an object is (or a group of objects are) created, renamed, parented, u - Ask the user if he wants to save the open scene. + Ask the user if they want to save the open scene. @@ -4407,6 +5111,19 @@ Each time an object is (or a group of objects are) created, renamed, parented, u 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. @@ -4417,6 +5134,42 @@ Each time an object is (or a group of objects are) created, renamed, parented, u 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. + + + + + 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. + + + + + 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. @@ -4496,6 +5249,21 @@ Each time an object is (or a group of objects are) created, renamed, parented, u The value entered by the user. + + + Check if any control was changed inside a block of code. + + + + + True if GUI.changed was set to true, otherwise false. + + + + + Begins a ChangeCheckScope. + + Make a field for selecting a Color. @@ -4642,7 +5410,61 @@ Each time an object is (or a group of objects are) created, renamed, parented, u 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. + + + + Make 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. + + + + Make 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. + + + + + Make 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. + + + + + Make 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. + + + + + Make 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. @@ -4787,6 +5609,17 @@ Each time an object is (or a group of objects are) created, renamed, parented, u 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. + Make a text field for entering doubles. @@ -4897,6 +5730,30 @@ Each time an object is (or a group of objects are) created, renamed, parented, u 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. + + + Make 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. + + + + + Make 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. @@ -5032,6 +5889,18 @@ Each time an object is (or a group of objects are) created, renamed, parented, u Internal version that also gives you back which flags were changed and what they were changed to. + + + Make 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. + + Make an enum popup selection field for a bitmask. @@ -5567,7 +6436,7 @@ Each time an object is (or a group of objects are) created, renamed, parented, u 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. + 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. @@ -5577,7 +6446,7 @@ Each time an object is (or a group of objects are) created, renamed, parented, u 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. + 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. @@ -5795,7 +6664,7 @@ Each time an object is (or a group of objects are) created, renamed, parented, u - Make a text field for entering integers. + Make 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. @@ -5807,7 +6676,7 @@ Each time an object is (or a group of objects are) created, renamed, parented, u - Make a text field for entering integers. + Make 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. @@ -5819,7 +6688,7 @@ Each time an object is (or a group of objects are) created, renamed, parented, u - Make a text field for entering integers. + Make 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. @@ -5829,9 +6698,9 @@ Each time an object is (or a group of objects are) created, renamed, parented, u The value entered by the user. - + - Make a text field for entering integers. + Make 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. @@ -5841,9 +6710,9 @@ Each time an object is (or a group of objects are) created, renamed, parented, u The value entered by the user. - + - Make a text field for entering integers. + Make 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. @@ -5853,21 +6722,9 @@ Each time an object is (or a group of objects are) created, renamed, parented, u The value entered by the user. - + - Make a text field for entering 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. - - - - - Make a field for masks. + Make a field for masks. Rectangle on the screen to use for this control. Label for the field. @@ -5953,9 +6810,8 @@ Each time an object is (or a group of objects are) created, renamed, parented, u 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. Rectangle on the screen to use for the slider. - The value the slider shows. This determines the position of the draggable thumb. + 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. @@ -5965,9 +6821,30 @@ Each time an object is (or a group of objects are) created, renamed, parented, u Make 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. + + + + Make 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. - The value the slider shows. This determines the position of the draggable thumb. + 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. + + + + Make 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. @@ -6087,6 +6964,42 @@ Each time an object is (or a group of objects are) created, renamed, parented, u The object that has been set by the user. + + + Make 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. + + + + Make 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. + + + + Make 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. + + + + Make 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. + Make a text field where the user can enter a password. @@ -6845,8 +7758,9 @@ Each time an object is (or a group of objects are) created, renamed, parented, u Begin a horizontal group and get its rect back. Optional GUIStyle. - 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, + 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. @@ -6854,8 +7768,9 @@ 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 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, + 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. @@ -6973,8 +7888,9 @@ 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 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, + 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. @@ -6982,8 +7898,19 @@ 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 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, + 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 group and get its rect back. + + Optional GUIStyle. + 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. @@ -6998,7 +7925,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Label to display above the field. The value to edit. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -7011,7 +7938,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Label to display above the field. The value to edit. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -7024,7 +7951,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Label to display above the field. The value to edit. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -7041,7 +7968,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. If true, treat the color as an HDR value. If false, treat it as a standard LDR value. An object that sets the presentation parameters for an HDR color. If not using an HDR color, set this to null. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The color selected by the user. @@ -7058,7 +7985,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. If true, treat the color as an HDR value. If false, treat it as a standard LDR value. An object that sets the presentation parameters for an HDR color. If not using an HDR color, set this to null. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The color selected by the user. @@ -7075,7 +8002,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. If true, treat the color as an HDR value. If false, treat it as a standard LDR value. An object that sets the presentation parameters for an HDR color. If not using an HDR color, set this to null. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The color selected by the user. @@ -7092,7 +8019,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. If true, treat the color as an HDR value. If false, treat it as a standard LDR value. An object that sets the presentation parameters for an HDR color. If not using an HDR color, set this to null. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The color selected by the user. @@ -7107,7 +8034,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The color to show the curve with. Optional rectangle that the curve is restrained within. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The curve edited by the user. @@ -7122,7 +8049,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The color to show the curve with. Optional rectangle that the curve is restrained within. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The curve edited by the user. @@ -7137,7 +8064,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The color to show the curve with. Optional rectangle that the curve is restrained within. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The curve edited by the user. @@ -7152,7 +8079,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The color to show the curve with. Optional rectangle that the curve is restrained within. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The curve edited by the user. @@ -7167,7 +8094,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The color to show the curve with. Optional rectangle that the curve is restrained within. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The curve edited by the user. @@ -7182,13 +8109,25 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The color to show the curve with. Optional rectangle that the curve is restrained within. 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, +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 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. + Optional label to display in front of the field. Pass [[GUIContent.none] to hide the label. + + Make a field for editing an AnimationCurve. @@ -7196,8 +8135,129 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The color to show the curve with. Optional rectangle that the curve is restrained within. 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, +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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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. + @@ -7207,7 +8267,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle. 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, +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. @@ -7221,7 +8281,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle. 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, +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. @@ -7235,7 +8295,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle. 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, +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. @@ -7249,7 +8309,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle. 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, +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. @@ -7263,7 +8323,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle. 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, +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. @@ -7277,7 +8337,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle. 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, +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. @@ -7290,7 +8350,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -7300,7 +8360,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -7311,7 +8371,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle. 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, +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. @@ -7325,7 +8385,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle. 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, +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. @@ -7339,7 +8399,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle. 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, +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. @@ -7353,7 +8413,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle. 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, +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. @@ -7367,7 +8427,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle. 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, +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. @@ -7381,7 +8441,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle. 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, +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. @@ -7394,7 +8454,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -7404,7 +8464,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -7415,7 +8475,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The text to edit. Optional GUIStyle. 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, +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. @@ -7429,7 +8489,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The text to edit. Optional GUIStyle. 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, +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. @@ -7443,7 +8503,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The text to edit. Optional GUIStyle. 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, +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. @@ -7457,7 +8517,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The text to edit. Optional GUIStyle. 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, +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. @@ -7471,7 +8531,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The text to edit. Optional GUIStyle. 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, +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. @@ -7485,7 +8545,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The text to edit. Optional GUIStyle. 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, +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. @@ -7498,7 +8558,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -7508,7 +8568,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -7519,7 +8579,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -7533,7 +8593,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -7547,7 +8607,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -7561,7 +8621,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -7575,7 +8635,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -7589,12 +8649,40 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle. 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, +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. @@ -7627,7 +8715,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Prefix label for this field. Enum to use for the flags. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -7641,7 +8729,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Prefix label for this field. Enum to use for the flags. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -7655,7 +8743,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Prefix label for this field. Enum to use for the flags. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -7669,7 +8757,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Prefix label for this field. Enum to use for the flags. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -7683,7 +8771,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Prefix label for this field. Enum to use for the flags. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -7697,13 +8785,37 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Prefix label for this field. Enum to use for the flags. 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, +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 an enum popup selection field for a bitmask. + + Optional label in front of the field. + The enum options the field shows. + Optional layout options. + Optional GUIStyle. + + The enum options that has been selected by the user. + + + + + Make an enum popup selection field for a bitmask. + + Optional label in front of the field. + The enum options the field shows. + Optional layout options. + Optional GUIStyle. + + The enum options that has been selected by the user. + + Make an enum popup selection field for a bitmask. @@ -7711,6 +8823,19 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Optional label in front of the field. The enum options the field shows. Optional layout options. + Optional GUIStyle. + + The enum options that has been selected by the user. + + + + + Make an enum popup selection field for a bitmask. + + Optional label in front of the field. + The enum options the field shows. + Optional layout options. + Optional GUIStyle. The enum options that has been selected by the user. @@ -7723,7 +8848,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The enum option the field shows. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The enum option that has been selected by the user. @@ -7737,7 +8862,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The enum option the field shows. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The enum option that has been selected by the user. @@ -7751,7 +8876,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The enum option the field shows. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The enum option that has been selected by the user. @@ -7765,7 +8890,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The enum option the field shows. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The enum option that has been selected by the user. @@ -7779,7 +8904,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The enum option the field shows. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The enum option that has been selected by the user. @@ -7793,7 +8918,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The enum option the field shows. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The enum option that has been selected by the user. @@ -7823,7 +8948,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -7837,7 +8962,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -7851,7 +8976,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -7865,7 +8990,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -7879,7 +9004,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -7893,7 +9018,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -7906,6 +9031,19 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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. @@ -7917,6 +9055,19 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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. @@ -7928,6 +9079,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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. @@ -7939,6 +9091,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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. @@ -7950,8 +9103,8 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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 layouting 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, + 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. @@ -7961,8 +9114,8 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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 layouting 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, + 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. @@ -7972,8 +9125,8 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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 layouting 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, + 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. @@ -7983,8 +9136,8 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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 layouting 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, + 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. @@ -8019,7 +9172,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -8028,7 +9181,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -8061,7 +9214,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -8075,7 +9228,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -8089,7 +9242,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -8103,7 +9256,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -8117,7 +9270,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -8131,7 +9284,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -8147,7 +9300,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. An array with the values for each option. Optional GUIStyle. 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, +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. @@ -8163,7 +9316,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. An array with the values for each option. Optional GUIStyle. 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, +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. @@ -8179,7 +9332,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. An array with the values for each option. Optional GUIStyle. 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, +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. @@ -8195,7 +9348,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. An array with the values for each option. Optional GUIStyle. 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, +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. @@ -8211,7 +9364,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. An array with the values for each option. Optional GUIStyle. 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, +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. @@ -8227,7 +9380,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. An array with the values for each option. Optional GUIStyle. 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, +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. @@ -8243,7 +9396,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. An array with the values for each option. Optional GUIStyle. 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, +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. @@ -8259,7 +9412,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. An array with the values for each option. Optional GUIStyle. 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, +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. @@ -8274,7 +9427,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. An array with the values for each option. Optional label in front of the field. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -8287,7 +9440,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. An array with the values for each option. Optional label in front of the field. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -8300,7 +9453,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. An array with the values for each option. Optional label in front of the field. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -8313,7 +9466,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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 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, +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. @@ -8328,7 +9481,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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 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, +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. @@ -8343,7 +9496,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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 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, +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. @@ -8358,7 +9511,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -8370,7 +9523,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -8382,7 +9535,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -8392,7 +9545,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Label in front of the label field. The label to show to the right. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -8403,7 +9556,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Label in front of the label field. The label to show to the right. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -8414,7 +9567,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Label in front of the label field. The label to show to the right. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -8425,7 +9578,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Label in front of the label field. The label to show to the right. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -8436,7 +9589,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Label in front of the label field. The label to show to the right. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -8447,7 +9600,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Label in front of the label field. The label to show to the right. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -8458,7 +9611,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Label in front of the label field. The label to show to the right. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -8469,7 +9622,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Label in front of the label field. The label to show to the right. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -8481,7 +9634,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The layer shown in the field. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The layer selected by the user. @@ -8495,7 +9648,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The layer shown in the field. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The layer selected by the user. @@ -8509,7 +9662,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The layer shown in the field. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The layer selected by the user. @@ -8523,7 +9676,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The layer shown in the field. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The layer selected by the user. @@ -8537,7 +9690,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The layer shown in the field. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The layer selected by the user. @@ -8551,7 +9704,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The layer shown in the field. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The layer selected by the user. @@ -8559,13 +9712,13 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. - Make a text field for entering integers. + 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 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -8573,13 +9726,13 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. - Make a text field for entering integers. + 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 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -8587,13 +9740,13 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. - Make a text field for entering integers. + 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 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -8601,13 +9754,13 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. - Make a text field for entering integers. + 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 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -8615,13 +9768,13 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. - Make a text field for entering integers. + 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 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -8629,13 +9782,13 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. - Make a text field for entering integers. + 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 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -8649,7 +9802,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The current mask to display. A string array containing the labels for each flag. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -8665,7 +9818,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The current mask to display. A string array containing the labels for each flag. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -8681,7 +9834,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The current mask to display. A string array containing the labels for each flag. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -8697,7 +9850,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The current mask to display. A string array containing the labels for each flag. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -8713,7 +9866,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The current mask to display. A string array containing the labels for each flag. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -8729,7 +9882,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The current mask to display. A string array containing the labels for each flag. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -8742,13 +9895,25 @@ 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 value the slider shows. This determines the position of the draggable thumb. 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 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, +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 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. @@ -8756,13 +9921,12 @@ 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 value the slider shows. This determines the position of the draggable thumb. 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 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -8774,7 +9938,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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, +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. @@ -8789,7 +9953,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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, +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. @@ -8804,52 +9968,136 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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, +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 text field where the user can enter a password. + Make a field to receive any object type. - 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 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, + 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 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 password entered by the user. - - + - Make a text field where the user can enter a password. + Make a field to receive any object type. - 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 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, + 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 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 password entered by the user. - - + - Make a text field where the user can enter a password. + Make a field to receive any object type. - 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 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, + 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 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 password entered 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 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 field to receive any object type. + + The object the field shows. + The type of the objects that can be assigned. + Optional label in front of the field. + 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. +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 the field shows. + The type of the objects that can be assigned. + Optional label in front of the field. + 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. +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 the field shows. + The type of the objects that can be assigned. + Optional label in front of the field. + 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. +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 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 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 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 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 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 password entered by the user. @@ -8860,7 +10108,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The password to edit. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The password entered by the user. @@ -8874,7 +10122,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The password to edit. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The password entered by the user. @@ -8888,7 +10136,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The password to edit. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The password entered by the user. @@ -8903,7 +10151,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. An array with the options shown in the popup. Optional GUIStyle. 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, +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. @@ -8918,7 +10166,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. An array with the options shown in the popup. Optional GUIStyle. 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, +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. @@ -8933,7 +10181,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. An array with the options shown in the popup. Optional GUIStyle. 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, +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. @@ -8948,7 +10196,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. An array with the options shown in the popup. Optional GUIStyle. 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, +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. @@ -8963,7 +10211,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. An array with the options shown in the popup. Optional GUIStyle. 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, +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. @@ -8978,7 +10226,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. An array with the options shown in the popup. Optional GUIStyle. 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, +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. @@ -8993,7 +10241,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. An array with the options shown in the popup. Optional GUIStyle. 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, +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. @@ -9008,7 +10256,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. An array with the options shown in the popup. Optional GUIStyle. 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, +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. @@ -9018,7 +10266,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Make a label in front of some control. - Label to show in front of the control. + Label to show to the left of the control. @@ -9026,7 +10274,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Make a label in front of some control. - Label to show in front of the control. + Label to show to the left of the control. @@ -9034,7 +10282,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Make a label in front of some control. - Label to show in front of the control. + Label to show to the left of the control. @@ -9042,7 +10290,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Make a label in front of some control. - Label to show in front of the control. + Label to show to the left of the control. @@ -9050,7 +10298,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Make a label in front of some control. - Label to show in front of the control. + Label to show to the left of the control. @@ -9058,7 +10306,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Make a label in front of some control. - Label to show in front of the control. + Label to show to the left of the control. @@ -9070,7 +10318,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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 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, +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. @@ -9084,7 +10332,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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 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, +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. @@ -9098,7 +10346,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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 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, +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. @@ -9112,7 +10360,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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 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, +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. @@ -9125,7 +10373,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Label to display above the field. The value to edit. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -9138,7 +10386,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Label to display above the field. The value to edit. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -9151,7 +10399,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Label to display above the field. The value to edit. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -9244,7 +10492,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The text to show. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -9254,7 +10502,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The text to show. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -9266,7 +10514,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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 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, +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. @@ -9281,7 +10529,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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 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, +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. @@ -9296,7 +10544,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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 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, +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. @@ -9311,7 +10559,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -9323,7 +10571,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -9335,7 +10583,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -9351,7 +10599,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The tag the field shows. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The tag selected by the user. @@ -9365,7 +10613,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The tag the field shows. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The tag selected by the user. @@ -9379,7 +10627,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The tag the field shows. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The tag selected by the user. @@ -9393,7 +10641,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The tag the field shows. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The tag selected by the user. @@ -9407,7 +10655,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The tag the field shows. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The tag selected by the user. @@ -9421,7 +10669,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The tag the field shows. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The tag selected by the user. @@ -9434,7 +10682,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The text to edit. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The text entered by the user. @@ -9447,7 +10695,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The text to edit. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The text entered by the user. @@ -9461,7 +10709,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The text to edit. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The text entered by the user. @@ -9475,7 +10723,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The text to edit. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The text entered by the user. @@ -9489,7 +10737,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The text to edit. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The text entered by the user. @@ -9503,7 +10751,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The text to edit. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The text entered by the user. @@ -9517,7 +10765,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The text to edit. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The text entered by the user. @@ -9531,7 +10779,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The text to edit. Optional GUIStyle. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The text entered by the user. @@ -9544,8 +10792,10 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Optional label in front of the toggle. The shown state of the toggle. Optional GUIStyle. - 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, + 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 selected state of the toggle. @@ -9558,8 +10808,10 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Optional label in front of the toggle. The shown state of the toggle. Optional GUIStyle. - 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, + 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 selected state of the toggle. @@ -9572,8 +10824,10 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Optional label in front of the toggle. The shown state of the toggle. Optional GUIStyle. - 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, + 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 selected state of the toggle. @@ -9586,8 +10840,10 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Optional label in front of the toggle. The shown state of the toggle. Optional GUIStyle. - 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, + 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 selected state of the toggle. @@ -9600,8 +10856,10 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Optional label in front of the toggle. The shown state of the toggle. Optional GUIStyle. - 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, + 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 selected state of the toggle. @@ -9614,8 +10872,10 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Optional label in front of the toggle. The shown state of the toggle. Optional GUIStyle. - 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, + 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 selected state of the toggle. @@ -9653,7 +10913,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle to use for the label. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -9664,7 +10924,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle to use for the label. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -9675,7 +10935,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle to use for the label. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -9686,7 +10946,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value to edit. Optional GUIStyle to use for the label. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -9696,7 +10956,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Label to display above the field. The value to edit. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -9709,7 +10969,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Label to display above the field. The value to edit. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -9721,8 +10981,9 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Label to display above the field. The value to edit. - 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, + 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 value entered by the user. @@ -9734,8 +10995,9 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Label to display above the field. The value to edit. - 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, + 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 value entered by the user. @@ -9748,7 +11010,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Label to display above the field. The value to edit. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The value entered by the user. @@ -9770,7 +11032,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -9779,7 +11041,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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, +See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. @@ -9817,6 +11079,13 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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. @@ -9860,9 +11129,9 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. - Creates an event. + Creates an event that can be sent to another window. - + The command to be sent. @@ -9965,15 +11234,26 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Fetch the GUIContent from the Unity builtin resources with the given name. - Content name. - Tooltip. + Name of the desired icon. + Tooltip for hovering over the icon. Fetch the GUIContent from the Unity builtin resources with the given name. - Content name. - Tooltip. + 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. @@ -9992,7 +11272,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. - Load a built-in resource that has to be there. + Load a required built-in resource. @@ -10031,18 +11311,54 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. - Ping an object in a window like clicking it in an inspector. + Ping an object in the Scene like clicking it in an inspector. - + The object to be pinged. - Ping an object in a window like clicking it in an inspector. + 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. @@ -10087,14 +11403,14 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. 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. @@ -10104,7 +11420,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The object's data in JSON format. - + Generate a JSON representation of an object. @@ -10146,31 +11462,45 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. - 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 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 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. + @@ -10188,9 +11518,12 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. - Returns true if key exists in the preferences. + Returns true if key exists in the preferences file. - + Name of key to check for. + + The existence or not of the key. + @@ -10201,25 +11534,45 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. - 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. + 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. @@ -10490,19 +11843,19 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Android platform options. - + - The texture compression type to be used when building. + Set which build system to use for building the Android package. - + - The build type to be used. + Is build script only enabled. - + - Is build script only enabled. + Compress files in package. @@ -10525,6 +11878,11 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Enables a Linux headless build. + + + Are divide by zero's actively checked? + + Are null references actively checked? @@ -10532,7 +11890,7 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. - Export Android Project for use wih Android Studio or Eclipse. + Export Android Project for use with Android StudioGradle or EclipseADT. @@ -10550,6 +11908,11 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Place the built player in the build folder. + + + Scheme with which the project will be run in Xcode. + + Create a .cia "download image" for deploying to test kits (3DS). @@ -10565,6 +11928,11 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. PS4 Build Subtarget. + + + Specifies which version of PS4 hardware to target. + + PSM Build Subtarget. @@ -10575,11 +11943,6 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. PS Vita Build subtarget. - - - SCE Build subtarget. - - The currently selected build target group. @@ -10605,9 +11968,9 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. The texture compression type to be used when building. - + - Optimization level for WebGL. + Use prebuilt JavaScript version of Unity engine. @@ -10650,6 +12013,16 @@ GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. Target Windows SDK. + + + 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. + + Xbox Build subtarget. @@ -10671,17 +12044,19 @@ MYCOMPUTER\SHAREDFOLDER\. Windows account username associated with PC share folder. - - - Selected Xbox Run Method. - - 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. @@ -10699,6 +12074,14 @@ More information - https:msdn.microsoft.comen-uslibrary/dn584397(v=vs.110).aspx. + + + 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. @@ -10721,6 +12104,11 @@ More information - https:msdn.microsoft.comen-uslibrary/dn584397(v=vs.110).aspx. Editor utility functions. + + + True if there are any compilation error messages in the log. + + Removes progress bar. @@ -10741,6 +12129,22 @@ More information - https:msdn.microsoft.comen-uslibrary/dn584397(v=vs.110).aspx. + + + Compress a cubemap texture. + + + + + + + + Compress a cubemap texture. + + + + + Compress a texture. @@ -10764,6 +12168,13 @@ More information - https:msdn.microsoft.comen-uslibrary/dn584397(v=vs.110).aspx. + + + Copy all settings of a Unity Object to a second Object if they differ. + + + + Creates a game object with HideFlags and specified components. @@ -10802,11 +12213,14 @@ More information - https:msdn.microsoft.comen-uslibrary/dn584397(v=vs.110).aspx. Displays a modal dialog with three buttons. - - - - - + Title for dialog. + Purpose for the dialog. + Dialog function chosen. + Choose alternative dialog purpose. + Close dialog with no operation. + + The id of the chosen button. + @@ -10919,9 +12333,9 @@ More information - https:msdn.microsoft.comen-uslibrary/dn584397(v=vs.110).aspx. - Marks target object as dirty. + Marks target object as dirty. (Only suitable for non-scene objects). - + The object to mark as dirty. @@ -10930,9 +12344,16 @@ More information - https:msdn.microsoft.comen-uslibrary/dn584397(v=vs.110).aspx. + + + Set the Scene View selected display mode for this Renderer. + + + + - Set whether the renderer's wireframe will be hidden when the renderer's gameobject is selected. + Sets whether the selected Renderer's wireframe will be hidden when the GameObject it is attached to is selected. @@ -10943,7 +12364,7 @@ More information - https:msdn.microsoft.comen-uslibrary/dn584397(v=vs.110).aspx. When true delete assets even if linked in scripts. - + Unloads assets that are not used. @@ -10999,9 +12420,14 @@ More information - https:msdn.microsoft.comen-uslibrary/dn584397(v=vs.110).aspx. The GUIContent used for drawing the title of EditorWindows. + + + Checks whether MouseEnterWindow and MouseLeaveWindow events are received in the GUI in this Editor window. + + - Does the GUI in this editor window want MouseMove events? + Checks whether MouseMove events are received in the GUI in this Editor window. @@ -11250,10 +12676,10 @@ More information - https:msdn.microsoft.comen-uslibrary/dn584397(v=vs.110).aspx. - Show window with dropdown behaviour (e.g. window is closed when it loses focus) and having. + Shows a window with dropdown behaviour and styling. - Is used for positioning the window. - Is used for setting up initial size of the window. + The button from which the position of the window will be determined (see description). + The initial size of the window. @@ -11872,6 +13298,21 @@ More information - https:msdn.microsoft.comen-uslibrary/dn584397(v=vs.110).aspx. Draw the gizmo if it is selected. + + + Enum used to specify the graphics jobs mode to use. + + + + + Legacy graphics jobs. + + + + + Native graphics jobs. + + Base class for PropertyDrawer and DecoratorDrawer. @@ -11937,14 +13378,20 @@ More information - https:msdn.microsoft.comen-uslibrary/dn584397(v=vs.110).aspx. 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 world-space position of the handle's start point. - The rotation of the handle. - The size of the handle in world-space units. + 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. @@ -11958,27 +13405,38 @@ More information - https:msdn.microsoft.comen-uslibrary/dn584397(v=vs.110).aspx. The position and size of the 2D GUI area. - + Make a 3D Button. - The world-space position to draw the button. - The rotation of the button. - The visual size of the button. - The size of the button for the purpose of detecting a click. - The draw style of the 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. - + - Draw a camera-facing Circle. Pass this into handle functions. + The function to use for drawing the handle e.g. Handles.RectangleCap. The control ID for the handle. - The world-space position for the start of the handle. - The rotation of 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. @@ -11987,54 +13445,60 @@ More information - https:msdn.microsoft.comen-uslibrary/dn584397(v=vs.110).aspx. Where in the Scene to clear. The camera to clear. - + - Draw a Cone. Pass this into handle functions. + Draw a cone handle. Pass this into handle functions. The control ID for the handle. - The world-space position of the handle's start point. - The rotation of the handle. - The size of the handle in world-space units. + 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. Pass this into handle functions. + Draw a cube handle. Pass this into handle functions. The control ID for the handle. - The world-space position of the handle's start point. - The rotation of the handle. - The size of the handle in world-space units. + 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. Pass this into handle functions. + Draw a cylinder handle. Pass this into handle functions. The control ID for the handle. - The world-space position of the handle's start point. - The rotation of the handle. - The size of the handle in world-space units. + 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. + Make a 3D disc that can be dragged with the mouse. +Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized handles. The rotation of the disc. The center of the disc. The axis to rotate around. The size of the disc in world space See Also:HandleUtility.GetHandleSize. 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 new value after the user has modified it. - -Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized handles. + 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 camera-facing dot. Pass this into handle functions. + Draw a dot handle. Pass this into handle functions. The control ID for the handle. - The world-space position of the handle's start point. - The rotation of the handle. - The size of the handle in world-space units. + 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. @@ -12124,15 +13588,6 @@ Note: Use HandleUtility.GetHandleSize where you might want to have constant scre The camera to draw. How the camera is drawn (textured, wireframe, etc.). - - - The function to use for drawing the handle e.g. Handles.RectangleCap. - - - - - - Draw a dotted line from p1 to p2. @@ -12156,6 +13611,47 @@ Note: Use HandleUtility.GetHandleSize where you might want to have constant scre 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. + + + 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. @@ -12182,6 +13678,16 @@ Note: Use HandleUtility.GetHandleSize where you might want to have constant scre + + + Draw a camera facing selection frame. + + + + + + + Draw a circular sector (pie piece) in 3D space. @@ -12224,6 +13730,13 @@ Note: Use HandleUtility.GetHandleSize where you might want to have constant scre 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. @@ -12239,17 +13752,18 @@ Note: Use HandleUtility.GetHandleSize where you might want to have constant scre End a 2D GUI block and get back to the 3D handle GUI. - + Make an unconstrained movement handle. - The position of the handle. - The rotation of the handle. this defines the space along. - The size of the handle. - The function to use for drawing the handle, eg, Handles.RectangleCap - -Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized handles. - + 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 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. + @@ -12260,6 +13774,9 @@ Note: Use HandleUtility.GetHandleSize where you might want to have constant scre 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. + @@ -12338,14 +13855,12 @@ Note: Use HandleUtility.GetHandleSize where you might want to have constant scre - Make a 3D Scene view position handle. + Make a position handle. Center of the handle in 3D space. Orientation of the handle in 3D space. - The new position. If the user has not performed any operation, it will return the same value as you passed it in postion. - -Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized 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. @@ -12355,9 +13870,9 @@ Note: Use HandleUtility.GetHandleSize where you might want to have constant scre 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 modified radius + 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. @@ -12369,13 +13884,23 @@ Note: Use HandleUtility.GetHandleSize where you might want to have constant scre 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 modified radius + 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. @@ -12383,23 +13908,21 @@ Note: Use HandleUtility.GetHandleSize where you might want to have constant scre Orientation of the handle. Center of the handle in 3D space. - The modified rotation - -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 a Scene view scale handle. + Make a Scene view scale handle. + +Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized handles. 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 scale vector. - -Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized 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. @@ -12407,35 +13930,28 @@ Note: Use HandleUtility.GetHandleSize where you might want to have constant scre Make a directional scale slider. The value the user can modify. - The position of the handle. - The direction of the handle. - The rotation of whole object. - The size of the handle. - The new value after the user has modified it. - -Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized handles. + 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 single-float draggable handle. + Make a 3D handle that scales a single float. The value the user can modify. - The position of the handle. - The rotation of the handle. - The size of the handle. - The function to use for drawing the handle e.g. Handles.RectangleCap. - The new value after the user has modified it. - -Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized handles. - - - - Draw a camera facing selection frame. - - - - - + 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. + @@ -12451,193 +13967,113 @@ Note: Use HandleUtility.GetHandleSize where you might want to have constant scre - - - Make a 3D slider. - - The position of the current point. - The direction of the sliding. - 3D size the size of the handle. - The function to call for doing the actual drawing - by default, it's Handles.ArrowCap, but any function that has the same signature can be used. - The snap value (see Handles.SnapValue). - -Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized handles. - - + - Make a 3D slider. + A delegate type for getting a handle's size based on its current position. - The position of the current point. - The direction of the sliding. - 3D size the size of the handle. - The function to call for doing the actual drawing - by default, it's Handles.ArrowCap, but any function that has the same signature can be used. - The snap value (see Handles.SnapValue). - -Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized handles. - - - - Slide a handle in a 2D plane. - - (optional) override the default ControlID for this Slider2D instance. - The position of the current point. - (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, only used for rendering of the handle. - The first direction of the sliding. - The second direction of the sliding. - The size of the handle. - The function to call for doing the actual drawing - by default, it's Handles.ArrowCap, but any function that has the same signature can be used. - (float or Vector2) set the snap increment (Pass a Vector2 to use separate snap increments in each dimension). - (default: false) render a rectangle around the handle when dragging. - - The new handle position - -Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized handles. - - - - - Slide a handle in a 2D plane. - - (optional) override the default ControlID for this Slider2D instance. - The position of the current point. - (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, only used for rendering of the handle. - The first direction of the sliding. - The second direction of the sliding. - The size of the handle. - The function to call for doing the actual drawing - by default, it's Handles.ArrowCap, but any function that has the same signature can be used. - (float or Vector2) set the snap increment (Pass a Vector2 to use separate snap increments in each dimension). - (default: false) render a rectangle around the handle when dragging. - - The new handle position - -Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized handles. - + The current position of the handle in the space of Handles.matrix. - + - Slide a handle in a 2D plane. + Make a 3D slider that moves along one axis. - (optional) override the default ControlID for this Slider2D instance. - The position of the current point. - (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, only used for rendering of the handle. - The first direction of the sliding. - The second direction of the sliding. - The size of the handle. - The function to call for doing the actual drawing - by default, it's Handles.ArrowCap, but any function that has the same signature can be used. - (float or Vector2) set the snap increment (Pass a Vector2 to use separate snap increments in each dimension). - (default: false) render a rectangle around the handle when dragging. + 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 handle position - -Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized 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 position value passed into the function. - + - Slide a handle in a 2D plane. + Make a 3D slider that moves along one axis. - (optional) override the default ControlID for this Slider2D instance. - The position of the current point. - (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, only used for rendering of the handle. - The first direction of the sliding. - The second direction of the sliding. - The size of the handle. - The function to call for doing the actual drawing - by default, it's Handles.ArrowCap, but any function that has the same signature can be used. - (float or Vector2) set the snap increment (Pass a Vector2 to use separate snap increments in each dimension). - (default: false) render a rectangle around the handle when dragging. + 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 handle position - -Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized 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 position value passed into the function. - + - Slide a handle in a 2D plane. + 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. + 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, only used for rendering of the handle. - The first direction of the sliding. - The second direction of the sliding. - The size of the handle. - The function to call for doing the actual drawing - by default, it's Handles.ArrowCap, but any function that has the same signature can be used. - (float or Vector2) set the snap increment (Pass a Vector2 to use separate snap increments in each dimension). + 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 handle position - -Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized 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 position value passed into the function. - + - Slide a handle in a 2D plane. + 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. + 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, only used for rendering of the handle. - The first direction of the sliding. - The second direction of the sliding. - The size of the handle. - The function to call for doing the actual drawing - by default, it's Handles.ArrowCap, but any function that has the same signature can be used. - (float or Vector2) set the snap increment (Pass a Vector2 to use separate snap increments in each dimension). + 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 handle position - -Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized 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 position value passed into the function. - + - Slide a handle in a 2D plane. + 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. + 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, only used for rendering of the handle. - The first direction of the sliding. - The second direction of the sliding. - The size of the handle. - The function to call for doing the actual drawing - by default, it's Handles.ArrowCap, but any function that has the same signature can be used. - (float or Vector2) set the snap increment (Pass a Vector2 to use separate snap increments in each dimension). + 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 handle position - -Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized 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 position value passed into the function. - + - Slide a handle in a 2D plane. + 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. + 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, only used for rendering of the handle. - The first direction of the sliding. - The second direction of the sliding. - The size of the handle. - The function to call for doing the actual drawing - by default, it's Handles.ArrowCap, but any function that has the same signature can be used. - (float or Vector2) set the snap increment (Pass a Vector2 to use separate snap increments in each dimension). + 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 handle position - -Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized 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 position value passed into the function. - Rounds the value val to the closest multiple of snap (snap can only be posiive). + Rounds the value val to the closest multiple of snap (snap can only be positive). @@ -12645,14 +14081,15 @@ Note: Use HandleUtility.GetHandleSize where you might want to have constant scre The rounded value, if snap is positive, and val otherwise. - + - Draw a Sphere. Pass this into handle functions. + 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. @@ -12807,7 +14244,16 @@ Note: Use HandleUtility.GetHandleSize where you might want to have constant scre 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. + + @@ -13027,2660 +14473,4971 @@ Note: Use HandleUtility.GetHandleSize where you might want to have constant scre Highlights an entire editor control using its label text as identifier. - + - Asset importing options. + Use IHVImageFormatImporter to modify Texture2D import settings for Textures in IHV (Independent Hardware Vendor) formats such as .DDS and .PVR from Editor scripts. - + - Default import options. + Filtering mode of the texture. - + - Force a full reimport but don't download the assets from the cache server. + Is texture data readable from scripts. - + - Import all assets synchronously. + Wrap mode of the texture. - + - Forces asset import as uncompressed for edition facilities. + A compound handle to edit a box-shaped bounding volume in the Scene view. - + - User initiated asset import. + Gets or sets the size of the bounding box. - + - When a folder is imported, import all its contents as well. + Create a new instance of the BoxBoundsHandle class. + An integer value used to generate consistent control IDs for each control handle on this instance. You may use any value you like, but should avoid using the same value for all of your PrimitiveBoundsHandle instances. - + - Allow an editor class to be initialized when Unity loads without action from the user. + Draw a wireframe box for this instance. - + - Allow an editor class method to be initialized when Unity loads without action from the user. + A compound handle to edit a capsule-shaped bounding volume in the Scene view. - + - A device requirement description used for configuration of App Slicing. + Gets or sets the height of the capsule bounding volume. - + - The values of the device requirement description. + Gets or sets the axis in the handle's space to which height maps. The radius maps to the remaining axes. - + - Constructs new device requirement description. + Gets or sets the radius of the capsule bounding volume. - + - Supported iOS SDK versions. + Create a new instance of the CapsuleBoundsHandle class. + An integer value used to generate consistent control IDs for each control handle on this instance. You may use any value you like, but should avoid using the same value for all of your PrimitiveBoundsHandle instances. - + - Device SDK. + Draw a wireframe capsule for this instance. - + - Simulator SDK. + An enumeration for specifying which axis on a CapsuleBoundsHandle object maps to the CapsuleBoundsHandle.height parameter. - + - Activity Indicator on loading. + X-axis. - + - Don't Show. + Y-axis. - + - Gray. + Z-axis. - + - White. + 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. + - + - White Large. + 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. - + - iOS status bar style. + Use this property to control whether sorting is enabled for all the columns. - + - Black opaque. + Customizable height of the multi column header. - + - Black translucent. + 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. - + - Default. + Subscribe to this event to get notified when sorting has changed. + - + - Target iOS device. + This is the state of the MultiColumnHeader. - + - iPad Only. + Subscribe to this event to get notified when the number of visible columns has changed. + - + - Universal : iPhone/iPod + iPad. + Override this method to extend the default context menu items shown when context clicking the header area. + Context menu shown. - + - iPhone/iPod Only. + Override to customize the behavior when clicking a column header. + Column clicked. + Column index clicked. - + - Supported iOS deployment versions. + Override to customize the GUI of a single column header. + Column header data. + Rect for column header. + Column index. - + - iOS 4.0. + Constructor. + Column header state and Column state. - + - iOS 4.1. + Default GUI methods and properties for the MultiColumnHeader class. - + - iOS 4.2. + Margin that can be used by clients of the MultiColumnHeader to control spacing between content in multiple columns. - + - iOS 4.3. + Default height of the header. - + - iOS 5.0. + This height is the minium height the header can have and can only be used if sorting is disabled. - + - iOS 5.1. + Default styles used by the MultiColumnHeader class. - + - iOS 6.0. + Style used for rendering the background of the header. - + - iOS 7.0. + Style used for left aligned header text. - + - iOS 7.1. + Style used for centered header text. - + - iOS 8.0. + Style used for right aligned header text. - + - iOS 8.1. + Calculates a cell rect for a column and row using the visibleColumnIndex and rowRect parameters. + + - + - Unknown iOS version, managed by user. + Returns the column data for a given column index. + Column index. + + Column data. + - + - The lighting data asset used by the active scene. + Returns the header column Rect for a given visible column index. + Index of a visible column. - + - Bake quality setting for LightmapEditorSettings. + Convert from column index to visible column index. + Column index. + + Visible column index. + - + - High quality bake for final renderings. + Delegate used for events from the MultiColumnHeader. + The MultiColumnHeader that dispatched this event. - + - Low quality bake for preview renderings. + Check if a column is currently visible in the MultiColumnHeader. + Column index. - + - Various settings for the bake. + Check the sorting order state for a column. + Column index. + + True if sorted ascending. + - + - Beyond this distance a ray is considered to be unoccluded. + Render and handle input for the MultiColumnHeader at the given rect. + Horizontal scroll offset. + Rect where the MultiColumnHeader is drawn in. - + - The maximum height of an individual lightmap texture. - - - - - The maximum width of an individual lightmap texture. - - - - - Texel separation between shapes. - - - - - Determines how Unity will compress baked reflection cubemap. + Called when sorting changes and dispatches the sortingChanged event. - + - Lightmap resolution in texels per world unit. Higher resolution may take a long time to bake. + Called when the number of visible column changes and dispatches the visibleColumnsChanged event. - + - Whether to use DXT1 compression on the generated lightmaps. + Requests the window which contains the MultiColumnHeader to repaint. - + - A collection of parameters that impact lightmap and realtime GI computations. + 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. - + - The maximum number of times to supersample a texel to reduce aliasing. + Change sort direction for a given column. + Column index. + Direction of the sorting. - + - The percentage of rays shot from a ray origin that must hit front faces to be considered usable. + Sets the primary sorting column and its sorting order. + Column to sort. + Sorting order for the column specified. - + - 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. + Sets multiple sorting columns and the associated sorting orders. + Column indices of the sorted columns. + Sorting order for the column indices specified. - + - The radius (in texels) of the post-processing filter that blurs baked direct lighting. + Provides the button logic for a column header and the rendering of the sorting arrow (if visible). + Column data. + Column header rect. + Column index. - + - Controls the resolution at which Enlighten stores and can transfer input light. + Method for toggling the visibility of a column. + Toggle visibility for this column. - + - The number of rays used for lights with an area. Allows for accurate soft shadowing. + State used by the MultiColumnHeader. - + - Whether pairs of edges should be stitched together. + The array of column states used by the MultiColumnHeader class. - + - 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. + This property controls the maximum number of columns returned by the sortedColumns property. - + - The number of rays to cast for computing irradiance form factors. + This property holds the index to the primary sorted column. - + - If enabled, the object appears transparent during GlobalIllumination lighting calculations. + The array of column indices for multiple column sorting. - + - Maximum size of gaps that can be ignored for GI (multiplier on pixel size). + This is the array of currently visible column indices. - + - The texel resolution per meter used for realtime lightmaps. This value is multiplied by LightmapEditorSettings.resolution. + Returns the sum of all the widths of the visible columns in the visibleColumns array. - + - 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. + 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. + - + - The maximum number of times to supersample a texel to reduce aliasing in AO. + Column state. - + - The number of rays to cast for computing ambient occlusion. + Option to allow/disallow hiding the column from the context menu. - + - Allows to control the lightmapping job. + Option to allow the column to resize automatically when resizing the entire MultiColumnHeader. - + - Boost the albedo. + Is sorting enabled for this column. If false, left-clicking this column header has no effect. - + - Returns the current lightmapping build progress or 0 if Lightmapping.isRunning is false. + If this is set then it is used for the context menu for toggling visibility, if not set then the ::headerContent is used. - + - Delegate which is called when bake job is completed. + This is the GUIContent that will be rendered in the column header. - + - 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. + Alignment of the header content. - + - Scale for indirect lighting. + Maximum width of the column. - + - Returns true when the bake job is running, false otherwise (Read Only). + Minimum width of the column. - + - The lighting data asset used by the active scene. + Value that controls if this column is sorted ascending or descending. - + - Stars a synchronous bake job. + Alignment of the sorting arrow. - + - Starts an asynchronous bake job. + The width of the column. - + - Starts a synchronous bake job, but only bakes light probes. + Constructor. + Column data. - + - Starts an asynchronous bake job, but only bakes light probes. + 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. - + - Bakes an array of scenes. + Base class for a compound handle to edit a bounding volume in the Scene view. - The path of the scenes that should be baked. - + - Starts a synchronous bake job for the probe. + Flags specifying which axes should display control handles. - Target probe. - The location where cubemap will be saved. - - Returns true if baking was succesful. - - + - Starts a synchronous bake job for the selected objects. + Gets or sets the center of the bounding volume for the handle. - + - Starts an asynchronous bake job for the selected objects. + Specifies the color of the control handles. - + - Cancels the currently running asynchronous bake job. + An optional Handles.CapFunction to use when displaying the control handles. Defaults to Handles.DotHandleCap if no value is specified. - + - Deletes all lightmap assets and makes all lights behave as if they weren't baked yet. + An optional Handles.HandleSizeFunction to specify how large the control handles should be in the space of Handles.matrix. Defaults to a fixed screen-space size. - + - Clears the cache used by lightmaps, reflection probes and default reflection. + Specifies the color of the wireframe shape. - + - Remove the lighting data asset used by the current scene. + A flag enumeration for specifying which axes on a PrimitiveBoundsHandle object should be enabled. - + - Get how many chunks the terrain is divided into for GI baking. + All axes. - The terrain. - Number of chunks in terrain width. - Number of chunks in terrain length. - + - Workflow mode for lightmap baking. Default is Iterative. + No axes. - + - Always run lightmapping, changes to the scene are detected automatically. + X-axis (bit 0). - + - Deprecated 4.x lightmapping support. + Y-axis (bit 1). - + - Run lightmapping only when the user presses the bake button. + Z-axis (bit 2). - + - Delegate used by Lightmapping.completed callback. + Create a new instance of the PrimitiveBoundsHandle class. + An integer value used to generate consistent control IDs for each control handle on this instance. You may use any value you like, but should avoid using the same value for all of your PrimitiveBoundsHandle instances. - + - Calculates a Delaunay Tetrahedralization of the 'positions' point set - the same way the lightmapper. + A function to display this instance in the current handle camera using its current configuration. - - - - + - LOD Utility Helpers. + Draw a wireframe shape for this instance. Subclasses must implement this method. - + - Recalculate the bounding region for the given LODGroup. + Gets the current size of the bounding volume for this instance. - + + The current size of the bounding volume for this instance. + - + - Mac fullscreen mode. + An enumeration of directions the handle moves in. - + - Capture the display. + This value corresponds to the handle moving in a negative direction away from PrimitiveBoundsHandle.center along the x-axis. - + - Fullscreen window. + This value corresponds to the handle moving in a negative direction away from PrimitiveBoundsHandle.center along the y-axis. - + - Fullscreen window with Dock and Menu bar. + This value corresponds to the handle moving in a negative direction away from PrimitiveBoundsHandle.center along the z-axis. - + - The Unity Material Editor. + This value corresponds to the handle moving in a positive direction away from PrimitiveBoundsHandle.center along the x-axis. - + - Is the current material expanded. + This value corresponds to the handle moving in a positive direction away from PrimitiveBoundsHandle.center along the y-axis. - + - Useful for indenting shader properties that need the same indent as mini texture field. + This value corresponds to the handle moving in a positive direction away from PrimitiveBoundsHandle.center along the z-axis. - + - Apply initial MaterialPropertyDrawer values. + 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. + - + - Apply initial MaterialPropertyDrawer values. + 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. + - + - Called when the Editor is woken up. + 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. + - + - Draw a property field for a color shader property. + Set handleColor and wireframeColor to the same value. - Label for the property. - - + The color to use for the control handles and the wireframe shape. - + - Draw a property field for a color shader property. + Sets the current size of the bounding volume for this instance. - Label for the property. - - + A Vector3 specifying how large the bounding volume is along all of its axes. - + - Default handling of preview area for materials. + The SearchField control creates a text field for a user to input text that can be used for searching. - - - + - Default toolbar for material preview area. + Changes the keyboard focus to the search field when the user presses ‘Ctrl/Cmd + F’ when set to true. It is true by default. - + - Handles UI for one shader property ignoring any custom drawers. + 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. - - - + - + - Handles UI for one shader property ignoring any custom drawers. + This is the controlID used for the text field to obtain keyboard focus. - - - - + - Draw a property field for a float shader property. + This function returns true if the search field has keyboard focus. - Label for the property. - - - + - Draw a property field for a float shader property. + 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. - Label for the property. - - + 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. + - + - Calculate height needed for the property, ignoring custom drawers. + 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. + - + - Utility method for GUI layouting ShaderGUI. Used e.g for the rect after a left aligned Color field. + This function displays a search text field with the given Rect and UI style parameters. - Field Rect. + 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. - A sub rect of the input Rect. + The text entered in the SearchField. The original input string is returned instead if the search field text was not changed. - + - Utility method for GUI layouting ShaderGUI. + 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. - Field Rect. + 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. - A sub rect of the input Rect. + The text entered in the search field. The original input string is returned instead if the search field text was not changed. - + - Utility method for GUI layouting ShaderGUI. + This function displays the search field with a toolbar style in the given Rect. - Field Rect. + Rectangle to use for the search field. + Text string to display in the search field. - A sub rect of the input Rect. + The text entered in the search field. The original input string is returned instead if the search field text was not changed. - + - Get shader property information of the passed materials. + This is a generic callback delegate for SearchField events and does not take any parameters. - - + - Get information about a single shader property. + This function changes keyboard focus to the search field so a user can start typing. - Selected materials. - Property name. - Property index. - + - Get information about a single shader property. + A compound handle to edit a sphere-shaped bounding volume in the Scene view. - Selected materials. - Property name. - Property index. - + - Calculate height needed for the property. + Gets or sets the radius of the capsule bounding volume. - - - + - Calculate height needed for the property. + Create a new instance of the SphereBoundsHandle class. - - + An integer value used to generate consistent control IDs for each control handle on this instance. You may use any value you like, but should avoid using the same value for all of your PrimitiveBoundsHandle instances. - + - 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. + Draw a wireframe sphere for this instance. - Line Rect. - - A sub rect of the input Rect. - - + - Utility method for GUI layouting ShaderGUI. + A callback for when a control handle was dragged in the scene. - Field Rect. + 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. - A sub rect of the input Rect. + The bounds that should be applied to this instance, with any necessary modifications applied. - + - Get the value of a given texture offset for a given texture property. + The TreeView is an IMGUI control that lets you create tree views, list views and multi-column tables for Editor tools. - 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. + Indent used for all rows before the tree foldout arrows and content. - The total rect of the texture property. - + - Get the value of a given texture scale for a given texture property. + When using a MultiColumnHeader this value adjusts the cell rects provided for all columns except the tree foldout column. - 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? + When using a MultiColumnHeader this value should be set to the column index in which the foldout arrows should appear. - - 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. + Custom vertical offset of the foldout arrow. - The message text. - The button text. - - Returns true, if button was pressed. - - + - This function will draw the UI for the lightmap emission property. (None, Realtime, baked) - -See Also: MaterialLightmapFlags. + Value that returns how far the foldouts are indented for each increasing depth value. - + - This function will draw the UI for the lightmap emission property. (None, Realtime, baked) - -See Also: MaterialLightmapFlags. + 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. - + - This function will draw the UI for the lightmap emission property. (None, Realtime, baked) - -See Also: MaterialLightmapFlags. + Width of the built-in foldout arrow. - + - Called when the editor is disabled, if overridden please call the base OnDisable() to ensure that the material inspector is set up properly. + The current search state of the TreeView. - + - Called when the editor is enabled, if overridden please call the base OnEnable() to ensure that the material inspector is set up properly. + True if the user is currently dragging one or more items in the TreeView, and false otherwise. - + - 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. + The TreeView is initialized by calling Reload(). Therefore returns false until Reload() is called the first time. - + - Custom preview for Image component. + Get the MultiColumnHeader of the TreeView. Can be null if the TreeView was created without a MultiColumnHeader. - Rectangle in which to draw the preview. - Background image. - + - Whenever a material property is changed call this function. This will rebuild the inspector and validate the properties. + The hidden root item of the TreeView (it is never rendered). - + - Default rendering of shader properties. + The fixed height used for each row in the TreeView if GetCustomRowHeight have not been overridden. - 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. + Current search string of the TreeView. - - Returns true if any value was changed. - - + - Draw a range slider for a range shader property. + Enable this to show alternating row background colors. - Label for the property. - - - + - Draw a range slider for a range shader property. + Enable this to show a border around the TreeView. - Label for the property. - - - + - Call this when you change a material property. It will add an undo for the action. + Returns true if the horizontal scroll bar is showing, otherwise false. - Undo Label. - + - Does this edit require to be repainted constantly in its current state? + Returns true if the vertical scroll bar is showing, otherwise false. - + - Set EditorGUIUtility.fieldWidth and labelWidth to the default values that PropertiesGUI uses. + The state of the TreeView (expanded state, selection, scroll etc.) - + - Set the shader of the material. + Returns the sum of the TreeView row heights, the MultiColumnHeader height (if used) and the border (if used). - Shader to set. - Should undo be registered. - - + - Set the shader of the material. + The controlID used by the TreeView to obtain keyboard control focus. - Shader to set. - Should undo be registered. - - + - Set the offset of a given texture property. + The Rect the TreeView is being rendered to. - 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. + Adds the expanded rows of the full tree to the input list. Only use this method if a full tree was built in BuildRoot. - 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). + Root of the TreeView. + Rows that will be refilled using the expanded state of TreeView. - + - Handes UI for one shader property. + This is called after all rows have their RowGUI called. - - - - + - Handes UI for one shader property. + This is called before any rows have their RowGUI called. - - - - + - 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. + Shows the rename overlay for a TreeViewItem. - The texture property to check and display warning for, if necessary. + Item to rename. + Delay in seconds until the rename overlay shows. + + Returns true if renaming was started. Returns false if renaming was already active. + - + - Draw a property field for a texture shader property. + Shows the rename overlay for a TreeViewItem. - Label for the field. - Draw scale / offset. - - - + Item to rename. + Delay in seconds until the rename overlay shows. + + Returns true if renaming was started. Returns false if renaming was already active. + - + - Draw a property field for a texture shader property. + Abstract method that is required to be implemented. By default this method should create the full tree of TreeViewItems and return the root. - Label for the field. - Draw scale / offset. - - - + + The root of the tree. This item can later be accessed by 'rootItem'. + - + - Draw a property field for a texture shader property. + Override this method to take control of how the rows are generated. - Label for the field. - Draw scale / offset. - - - + Root item that was created in the BuildRoot method. + + The rows list shown in the TreeView. Can later be accessed using GetRows(). + - + - Draw a property field for a texture shader property. + Override this method to control which items are allowed to be parents. - Label for the field. - Draw scale / offset. - - - + Can this item be a parent? - + - Draw a property field for a texture shader property. + Override this method to control whether an item can be expanded or collapsed by key or mouse. - Label for the field. - Draw scale / offset. - - - + Can this item be expanded/collapsed. - + - Draw a property field for a texture shader property that only takes up a single line height. + Override this method to control whether the item can be part of a multiselection. - Rect that this control should be rendered in. - Label for the field. - - - - Returns total height used by this control. - + Can this item be part of a multiselection. - + - Method for showing a texture property control with additional inlined properites. + Override this method to control whether the item can be renamed using a keyboard shortcut or when clicking an already selected item. - 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. - + Can this item be renamed? - + - Method for showing a texture property control with additional inlined properites. + This function is called whenever a TreeViewItem is clicked and dragged. It returns false by default. - 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. + Method arguments for the CanStartDrag virtual method. - 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. + Item about to be dragged. - 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 multi-selection about to be dragged. - The label used for the texture property. - The texture property. - The color property (will be treated as a HDR color). - The HDR color configuration used by the HDR Color Picker. - 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. + Modifies the input rect so it is centered and have a height equal to EditorGUIUtility.singleLineHeight. - 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'. + Rect to be modified and centered. - + - Draws tiling and offset properties for a texture. + Collapse all expanded items in the TreeView. - 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. + This function is called automatically and handles the ExecuteCommand events for “SelectAll” and “FrameSelection”. Override this function to extend or avoid Command events. - - - - + - TODO. + Override this method to handle context clicks outside any items (but still in the TreeView rect). - - - - + - Draw a property field for a vector shader property. + Override this method to handle a context click on an item with ID TreeViewItem.id. - Label for the field. - - + TreeViewItem id. - + - Draw a property field for a vector shader property. + Creates a dummy TreeViewItem list. Useful when overriding BuildRows to prevent building a full tree of items. - Label for the field. - - - + - Describes information and value of a single shader property. + 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. - + - Color value of the property. + 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. - + - Display name of the property (Read Only). + Default GUI methods and properties for the TreeView class. - + - Flags that control how property is displayed (Read Only). + 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. - + - Float vaue of the property. + 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. - + - Does this property have multiple different values? (Read Only) + 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. - + - Name of the property (Read Only). + 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. - + - Min/max limits of a ranged float property (Read Only). + 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. - + - Material objects being edited by this property (Read Only). + Default styles used by the TreeView class. - + - Texture dimension (2D, Cubemap etc.) of the property (Read Only). + Background style used for alternating row background colors when enabling TreeView.showAlternatingRowBackgrounds. - + - Texture value of the property. + Background style used for alternating row background colors when enabling TreeView.showAlternatingRowBackgrounds. - + - Type of the property (Read Only). + Bold label with alternative text color when selected and/or focused. - + - Vector value of the property. + Right aligned bold label with alternative text color when selected and/or focused. - + - Flags that control how a MaterialProperty is displayed. + The label that is used for foldout label with alternative text color when selected and/or focused. - + - Signifies that values of this property contain High Dynamic Range (HDR) data. + Left aligned label with alternative text color when selected and/or focused. - + - Do not show the property in the inspector. + Right aligend label with alternative text color when selected and/or focused. - + - No flags are set. + 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. + + + + + 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. + + + + + 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. + + + + 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. + + + + + 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. + + + + + Supported iOS SDK versions. + + + + + Device SDK. + + + + + Simulator SDK. + + + + + Activity Indicator on loading. + + + + + Don't Show. + + + + + Gray. + + + + + White. + + + + + White Large. + + + + + iOS status bar style. + + + + + Black opaque. + + + + + Black translucent. + + + + + Default. + + + + + 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. + + + + + The lighting data asset used by the active scene. + + + + + 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. + + + + + Enable baked ambient occlusion (AO). + + + + + Determines which backend to use for baking lightmaps. + + + + + Determines the filtering kernel for the Progressive Path Tracer backend. + + + + + Determines which sampling strategy to use for baking lightmaps with the path tracing backend. + + + + + The maximum height of an individual lightmap texture. + + + + + The maximum width of an individual lightmap texture. + + + + + Texel separation between shapes. + + + + + 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. + + + + + Whether to use texture compression on the generated lightmaps. + + + + + Backends available for baking lightmaps. + + + + + Backend for baking lightmaps with path tracing. + + + + + Backend for baking lightmaps with the Enlighten radiosity middleware. + + + + + The available filter kernels for the Progressive Path Tracer GI backend. + + + + + Filter baked results of the Progressive Path Tracer with an A-Trous kernel. + + + + + Filter baked results of the Progressive Path Tracer with an Gauss kernel. + + + + + The available filtering modes for the Progressive Path Tracer GI backend. + + + + + Enables the advanced filtering mode for the Progressive Path Tracer GI backend. + + + + + The filtering is configured automatically. + + + + + Turn filtering off. + + + + + Available sampling strategies for baking lightmaps with the path tracing backend. + + + + + 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? + + + + + Stars 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. + + + + + 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. + + + + + 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. + + + + + 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. + + + + + + + + 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. + + + + + + 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. + + + + + 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). + The HDR color configuration used by the HDR Color Picker. + 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. + + + + + + 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 contain High Dynamic Range (HDR) data. + + + + + Do not show the property in the inspector. + + + + + No flags are set. + + - Signifies that values of this property contain Normal (normalized vector) data. + 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. + + + + 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. Currently only il2cpp-based players are able to provide memory snapshots. + + + + + 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 that a player has sent through the profiler connection. + + + + + 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. - + - Do not show UV scale/offset fields next to a texture. + Descriptions of all the C++ unity types the profiled player knows about. - + - 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. + Descriptions of all the managed types that were known to the virtual machine when the snapshot was taken. - + - Material property type. + Information about the virtual machine running executing the managade code inside the player. - + - Color property. + A description of a C++ unity type. - + - Float property. + Name of this C++ unity type. - + - Ranged float (with min/max values) property. + The index used to obtain the native C++ base class description from the PackedMemorySnapshot.nativeTypes array. - + - Texture property. + Description of a C++ unity object in memory. - + - Vector property. + The hideFlags this native object has. - + - Texture dimension of a property. + InstanceId of this object. - + - Texture property accepts any texture type. + Has this object has been marked as DontDestroyOnLoad? - + - Cubemap property. + Is this native object an internal Unity manager object? - + - No texture type is set. + Is this object persistent? (Assets are persistent, objects stored in scenes are persistent, dynamically created objects are not) - + - Texture2D property. + Name of this object. - + - Texture3D property. + The memory address of the native C++ object. This matches the "m_CachedPtr" field of UnityEngine.Object. - + - Base class to derive custom material property drawers from. + The index used to obtain the native C++ type description from the PackedMemorySnapshot.nativeTypes array. - + - Apply extra initial values to the material. + Size in bytes of this object. - The MaterialProperty to apply values for. - + - Override this method to specify how tall the GUI for this property is in pixels. + Description of a managed type. - 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. + 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) - 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. - + - A pair of from and to indices describing what thing keeps what other thing alive. + Name of the assembly this type was loaded from. - + - Index into a virtual list of all GC handles, followed by all native objects. + The base type for this type, pointed to by an index into PackedMemorySnapshot.typeDescriptions. - + - Index into a virtual list of all GC handles, followed by all native objects. + An array containing descriptions of all fields of this type. - + - Description of a field of a managed type. + Is this type an array? - + - Is this field static? + Is this type a value type? (if it's not a value type, it's a reference type) - + - Name of this field. + Name of this type. - + - Offset of this field. + 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 typeindex into PackedMemorySnapshot.typeDescriptions of the type this field belongs to. + The actual contents of the bytes that store this types static fields, at the point of time when the snapshot was taken. - + - A dump of a piece of memory from the player that's being profiled. + The typeIndex of this type. This index is an index into the PackedMemorySnapshot.typeDescriptions array. - + - The actual bytes of the memory dump. + 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 start address of this piece of memory. + 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. + + + + + 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. MenuCommand objects are passed to custom menu item functions defined using the MenuItem attribute. + + + + + 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. - + - MemorySnapshot is a profiling tool to help diagnose memory usage. + Info message. - + - Event that will be fired when a new memory snapshot comes in through the profiler connection. Its argument will be a PackedMemorySnapshot. + Neutral message. - - + - Requests a new snapshot from the currently connected target of the profiler. Currently only il2cpp-based players are able to provide memory snapshots. + Warning message. - + - A description of a GC handle used by the virtual machine. + Compressed texture format for target build platform. - + - The address of the managed object that the GC handle is referencing. + ASTC texture compression. - + - PackedMemorySnapshot is a compact representation of a memory snapshot that a player has sent through the profiler connection. + ATI texture compression. Available on devices running Adreno GPU, including HTC Nexus One, Droid Incredible, EVO, and others. - + - Connections is an array of from,to pairs that describe which things are keeping which other things alive. + S3 texture compression, nonspecific to DXT variant. Supported on devices running Nvidia Tegra2 platform, including Motorala Xoom, Motorola Atrix, Droid Bionic, and others. - + - All GC handles in use in the memorysnapshot. + ETC1 texture compression (or RGBA16 for textures with alpha), supported by all devices. - + - Array of actual managed heap memory sections. + ETC2 texture compression. - + - All native C++ objects that were loaded at time of the snapshot. + Don't override texture compression. - + - Descriptions of all the C++ unity types the profiled player knows about. + PowerVR texture compression. Available in devices running PowerVR SGX530/540 GPU, such as Motorola DROID series; Samsung Galaxy S, Nexus S, and Galaxy Tab; and others. - + - Descriptions of all the managed types that were known to the virtual machine when the snapshot was taken. + Model importer lets you modify import settings from editor scripts. - + - Information about the virtual machine running executing the managade code inside the player. + Add to imported meshes. - + - A description of a C++ unity type. + Animation compression setting. - + - ClassId of the base class of this C++ class. + Allowed error of animation position compression. - + - Name of this C++ unity type. + Allowed error of animation rotation compression. - + - Description of a C++ unity object in memory. + Allowed error of animation scale compression. - + - ClassId of this C++ object. Use this classId to index into PackedMemorySnapshot.nativeTypes. + Animator generation mode. - + - The hideFlags this native object has. + The default wrap mode for the generated animation clips. - + - InstanceId of this object. + Bake Inverse Kinematics (IK) when importing. - + - Has this object has been marked as DontDestroyOnLoad? + Animation clips to split animation into. See Also: ModelImporterClipAnimation. - + - Is this native object an internal Unity manager object? + Generate a list of all default animation clip based on TakeInfo. - + - Is this object persistent? (Assets are persistent, objects stored in scenes are persistent, dynamically created objects are not) + Animation optimization setting. - + - Name of this object. + File scale factor (if available) or default one. (Read-only). - + - Size in bytes of this object. + Animation generation options. - + - Description of a managed type. + Material generation options. - + - 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) + Generate secondary UV set for lightmapping. - + - Name of the assembly this type was loaded from. + Global scale factor for importing. - + - The base type for this type, pointed to by an index into PackedMemorySnapshot.typeDescriptions. + The human description that is used to generate an Avatar during the import process. - + - An array containing descriptions of all fields of this type. + Controls how much oversampling is used when importing humanoid animations for retargeting. - + - Is this type an array? + Import animation from file. - + - Is this type a value type? (if it's not a value type, it's a reference type) + Controls import of BlendShapes. - + - Name of this type. + Generates the list of all imported take. - + - 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. + Import materials from file. - + - The actual contents of the bytes that store this types static fields, at the point of time when the snapshot was taken. + Vertex normal import options. - + - The typeIndex of this type. This index is an index into the PackedMemorySnapshot.typeDescriptions array. + Vertex tangent import options. - + - 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. + Is Bake Inverse Kinematics (IK) supported by this importer. - + - Information about a virtual machine that provided a memory snapshot. + Is FileScale was used when importing. - + - Allocation granularity in bytes used by the virtual machine allocator. + Are mesh vertices and indices accessible from script? - + - Offset in bytes inside the object header of an array object where the bounds of the array is stored. + Is import of tangents supported by this importer. - + - Size in bytes of the header of an array object. + Is useFileUnits supported for this asset. - + - Offset in bytes inside the object header of an array object where the size of the array is stored. + 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. - + - A version number that will change when the object layout inside the managed heap will change. + Material naming setting. - + - Size in bytes of the header of each managed object. + Existing material search setting. - + - Size in bytes of a pointer. + Mesh compression setting. - + - Menu class to manipulate the menu item. + The path of the transform used to generation the motion of the animation. - + - Default constructor. + Normals import mode. - + - Get the check status of the given menu. + Smoothing angle (in degrees) for calculating normals. - - + - Set the check status of the given menu. + Animation optimization setting. - - - + - Used to extract the context for a MenuItem. MenuCommand objects are passed to custom menu item functions defined using the MenuItem attribute. + Vertex optimization setting. - + - Context is the object that is the target of a menu command. + Generates the list of all imported Animations. - + - An integer for passing custom information to a menu item. + 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. + - + - Creates a new MenuCommand object. + Threshold for angle distortion (in degrees) when generating secondary UV. - - - + - Creates a new MenuCommand object. + Threshold for area distortion when generating secondary UV. - - + - The MenuItem attribute allows you to add menu items to the main menu and inspector context menus. + Hard angle (in degrees) for generating secondary UV. - + - Creates a menu item and invokes the static function following it, when the menu item is selected. + Margin to be left between charts when packing secondary UV. - - - - + - Creates a menu item and invokes the static function following it, when the menu item is selected. + Imports the HumanDescription from the given Avatar. - - - + - Creates a menu item and invokes the static function following it, when the menu item is selected. + Should tangents be split across UV seams. - - + - Various utilities for mesh manipulation. + Swap primary and secondary UV channels when importing. - + - Returns the mesh compression setting for a Mesh. + Tangents import mode. - The mesh to get information on. - + - Optimizes the mesh for GPU access. + Generates the list of all imported Transforms. - - + - Change the mesh compression setting for a mesh. + Detect file units and import as 1FileUnit=1UnityUnit, otherwise it will import as 1cm=1UnityUnit. - 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. + Combine vertices that share the same position in space. - - - + - User message types. + Creates a mask that matches the model hierarchy, and applies it to the provided ModelImporterClipAnimation. + Clip to which the mask will be applied. - + - Error message. + Animation compression options for ModelImporter. - + - Info message. + Perform keyframe reduction. - + - Neutral message. + Perform keyframe reduction and compression. - + - Warning message. + No animation compression. - + - Compressed texture format for target build platform. + Perform keyframe reduction and choose the best animation curve representation at runtime to reduce memory footprint (default). - + - ASTC texture compression. + Animation mode for ModelImporter. - + - ATI texture compression. Available on devices running Adreno GPU, including HTC Nexus One, Droid Incredible, EVO, and others. + Generate a generic animator. - + - S3 texture compression, nonspecific to DXT variant. Supported on devices running Nvidia Tegra2 platform, including Motorala Xoom, Motorola Atrix, Droid Bionic, and others. + Generate a human animator. - + - ETC1 texture compression (or RGBA16 for textures with alpha), supported by all devices. + Generate a legacy animation type. - + - ETC2 texture compression. + Generate no animation data. - + - Don't override texture compression. + Animation clips to split animation into. - + - PowerVR texture compression. Available in devices running PowerVR SGX530/540 GPU, such as Motorola DROID series; Samsung Galaxy S, Nexus S, and Galaxy Tab; and others. + The additive reference pose frame. - + - Model importer lets you modify import settings from editor scripts. + Additionnal curves that will be that will be added during the import process. - + - Add to imported meshes. + Offset to the cycle of a looping animation, if a different time in it is desired to be the start. - + - Animation compression setting. + AnimationEvents that will be added during the import process. - + - Allowed error of animation position compression. + First frame of the clip. - + - Allowed error of animation rotation compression. + Enable to defines an additive reference pose. - + - Allowed error of animation scale compression. + Keeps the feet aligned with the root transform position. - + - Animator generation mode. + Offset to the vertical root position. - + - The default wrap mode for the generated animation clips. + Keeps the vertical position as it is authored in the source file. - + - Bake Inverse Kinematics (IK) when importing. + Keeps the vertical position as it is authored in the source file. - + - Animation clips to split animation into. + Keeps the vertical position as it is authored in the source file. - + - Generate a list of all default animation clip based on TakeInfo. + Last frame of the clip. - + - Animation optimization setting. + 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. - + - File scale factor (if available) or default one. (Read-only). + 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. - + - Animation generation options. + Enable to make root rotation be baked into the movement of the bones. Disable to make root rotation be stored as root motion. - + - Material generation options. + Is the clip a looping animation? - + - Generate secondary UV set for lightmapping. + Enable to make the motion loop seamlessly. - + - Global scale factor for importing. + Enable to make the clip loop. - + - The human description that is used to generate an Avatar during the import process. + 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. - + - Controls how much oversampling is used when importing humanoid animations for retargeting. + The AvatarMask used to mask transforms during the import process. - + - Import animation from file. + Define mask type. - + - Controls import of BlendShapes. + Mirror left and right in this clip. - + - Generates the list of all imported take. + Clip name. - + - Import materials from file. + Offset in degrees to the root rotation. - + - Use normals vectors from file. + Take name. - + - Use tangent vectors from file. + The wrap mode of the animation. - + - Is Bake Inverse Kinematics (IK) supported by this importer. + Copy the mask settings from an AvatarMask to the clip configuration. + AvatarMask from which the mask settings will be imported. - + - Is FileScale was used when importing. + Copy the current masking settings from the clip to an AvatarMask. + AvatarMask to which the masking values will be saved. - + - Are mesh vertices and indices accessible from script? + Animation generation options for ModelImporter. These options relate to the legacy Animation system, they should only be used when ModelImporter.animationType==ModelImporterAnimationType.Legacy. - + - Is import of tangents supported by this importer. + Default animation import mode (All animations are stored in the root object). - + - Is useFileUnits supported for this asset. + Generate animations in the objects that animate. - + - Material naming setting. + Generate animations in the root objects of the animation package. - + - Existing material search setting. + Generate animations in the transform root objects. - + - Mesh compression setting. + Do not generate animations. - + - The path of the transform used to generation the motion of the animation. + Material generation options for ModelImporter. - + - Normals import mode. + Do not generate materials. - + - Smoothing angle (in degrees) for calculating normals. + Generate a material for each material in the source asset. - + - Animation optimization setting. + Generate a material for each texture used. - + - Vertex optimization setting. + Humanoid Oversampling available multipliers. - + - Generates the list of all imported Animations. + Default Humanoid Oversampling multiplier = 1 which is equivalent to no oversampling. - + - If set to false, the importer will not resample animation 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. - + Humanoid Oversampling samples at 2 times the sampling rate found in the imported file. - + - Threshold for angle distortion (in degrees) when generating secondary UV. + Humanoid Oversampling samples at 4 times the sampling rate found in the imported file. - + - Threshold for area distortion when generating secondary UV. + Humanoid Oversampling samples at 8 times the sampling rate found in the imported file. - + - Hard angle (in degrees) for generating secondary UV. + Material naming options for ModelImporter. - + - Margin to be left between charts when packing secondary UV. + Use a material name of the form <materialName>.mat. - + - Imports the HumanDescription from the given Avatar. + Use material names in the form <modelFileName>-<materialName>.mat. - + - Should tangents be split across UV seams. + Use material names in the form <textureName>.mat. - + - Swap primary and secondary UV channels when importing. + <textureName>.mat or <modelFileName>-<materialName>.mat material name. - + - Tangents import mode. + Material search options for ModelImporter. - + - Generates the list of all imported Transforms. + Search in all project. - + - Detect file units and import as 1FileUnit=1UnityUnit, otherwise it will import as 1cm=1UnityUnit. + Search in local Materials folder. - + - Animation compression options for ModelImporter. + Recursive-up search in Materials folders. - + - Perform keyframe reduction. + Mesh compression options for ModelImporter. - + - Perform keyframe reduction and compression. + High amount of mesh compression. - + - No animation compression. + Low amount of mesh compression. - + - Perform keyframe reduction and choose the best animation curve representation at runtime to reduce memory footprint (default). + Medium amount of mesh compression. - + - Animation mode for ModelImporter. + No mesh compression (default). - + - Generate a generic animator. + Vertex normal generation options for ModelImporter. - + - Generate a human animator. + Calculate vertex normals. - + - Generate a legacy animation type. + Import vertex normals from model file (default). - + - Generate no animation data. + Do not import vertex normals. - + - Animation clips to split animation into. + Vertex tangent generation options for ModelImporter. - + - The additive reference pose frame. + Calculate tangents with legacy algorithm. - + - Additionnal curves that will be that will be added during the import process. + Calculate tangents with legacy algorithm, with splits across UV charts. - + - Offset to the cycle of a looping animation, if a different time in it is desired to be the start. + Calculate tangents using MikkTSpace (default). - + - AnimationEvents that will be added during the import process. + Import vertex tangents from model file. - + - First frame of the clip. + Do not import vertex tangents. - + - Enable to defines an additive reference pose. + Tangent space generation options for ModelImporter. - + - Keeps the feet aligned with the root transform position. + Calculate tangents. - + - Offset to the vertical root position. + Import normals/tangents from file. - + - Keeps the vertical position as it is authored in the source file. + Strip normals/tangents. - + - Keeps the vertical position as it is authored in the source file. + Representation of Script assets. - + - Keeps the vertical position as it is authored in the source file. + Returns the MonoScript object containing specified MonoBehaviour. + The MonoBehaviour whose MonoScript should be returned. - + - Last frame of the clip. + Returns the MonoScript object containing specified ScriptableObject. + The ScriptableObject whose MonoScript should be returned. - + - 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. + Returns the System.Type object of the class implemented by this script. - + - 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. + Custom mouse cursor shapes used with EditorGUIUtility.AddCursorRect. - + - Enable to make root rotation be baked into the movement of the bones. Disable to make root rotation be stored as root motion. + Normal pointer arrow. - + - Is the clip a looping animation? + Arrow with the minus symbol next to it. - + - Enable to make the motion loop seamlessly. + Arrow with the plus symbol next to it. - + - Enable to make the clip loop. + The current user defined cursor. - + - 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. + Cursor with an eye and stylized arrow keys for FPS navigation. - + - The AvatarMask used to mask transforms during the import process. + Arrow with a Link badge (for assigning pointers). - + - Define mask type. + Arrow with the move symbol next to it for the sceneview. - + - Mirror left and right in this clip. + Cursor with an eye for orbit. - + - Clip name. + Cursor with a dragging hand for pan. - + - Offset in degrees to the root rotation. + Horizontal resize arrows. - + - Take name. + Resize up-Left for window edges. - + - The wrap mode of the animation. + Resize up-right for window edges. - + - Animation generation options for ModelImporter. These options relate to the legacy Animation system, they should only be used when ModelImporter.animationType==ModelImporterAnimationType.Legacy. + Vertical resize arrows. - + - Default animation import mode (All animations are stored in the root object). + Arrow with the rotate symbol next to it for the sceneview. - + - Generate animations in the objects that animate. + Arrow with the scale symbol next to it for the sceneview. - + - Generate animations in the root objects of the animation package. + Arrow with small arrows for indicating sliding at number fields. - + - Generate animations in the transform root objects. + Left-Right resize arrows for window splitters. - + - Do not generate animations. + Up-Down resize arrows for window splitters. - + - Material generation options for ModelImporter. + Text cursor. - + - Do not generate materials. + Cursor with a magnifying glass for zoom. - + - Generate a material for each material in the source asset. + AssetImporter for importing MovieTextures. - + - Generate a material for each texture used. + Duration of the Movie to be imported in seconds. - + - Humanoid Oversampling available multipliers. + Is the movie texture storing non-color data? - + - Default Humanoid Oversampling multiplier = 1 which is equivalent to no oversampling. + Quality setting to use when importing the movie. This is a float value from 0 to 1. - + - Humanoid Oversampling samples at 2 times the sampling rate found in the imported file. + Information of the connected player. - + - Humanoid Oversampling samples at 4 times the sampling rate found in the imported file. + The Id of the player connected. - + - Humanoid Oversampling samples at 8 times the sampling rate found in the imported file. + Handles the connection from the Editor to the Player. - + - Material naming options for ModelImporter. + A list of the connected players. - + - Use a material name of the form <materialName>.mat. + Initializes the EditorConnection. - + - Use material names in the form <modelFileName>-<materialName>.mat. + 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. - + - Use material names in the form <textureName>.mat. + 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. - + - <textureName>.mat or <modelFileName>-<materialName>.mat material name. + Registers a callback on a Player when that Player disconnects. + The Action that is called when the Player with the given Player ID disconnects. - + - Material search options for ModelImporter. + Sends data to multiple or single Player(s). + Type ID of the message to send to the Player(s). + If set, the message will only send to the Player with this ID. + - + - Search in all project. + Sends data to multiple or single Player(s). + Type ID of the message to send to the Player(s). + If set, the message will only send to the Player with this ID. + - + - Search in local Materials folder. + Deregisters a registered callback. + Message ID associated with the callback that you wish to deregister. + The Action callback you wish to deregister. - + - Recursive-up search in Materials folders. + Helper class for constructing displayable names for objects. - + - Mesh compression options for ModelImporter. + Class name of an object. + - + - High amount of mesh compression. + Drag and drop title for an object. + - + - Low amount of mesh compression. + Inspector title for an object. + - + - Medium amount of mesh compression. + 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. + - + - No mesh compression (default). + Make a displayable name for a variable. + - + - This is legacy! + Sets the name of an Object. + + - + - This is Legacy. + Base Class to derive from when creating Custom Previews. - + - This is legacy! + The object currently being previewed. - + - This is legacy! + This is the first entry point for Preview Drawing. + The available area to draw the preview. - + - This is legacy. + Implement this method to show object information on top of the object preview. - + - This is legacy. + Override this method if you want to change the label of the Preview area. - + - This is legacy. + Can this component be Previewed in its current state? + + True if this component can be Previewed in its current state. + - + - This is legacy. + Called when the Preview gets created with the objects being previewed. + The objects being previewed. - + - This is legacy. + Called to iterate through the targets, this will be used when previewing more than one target. + + True if there is another target available. + - + - This is legacy. + 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. - + - Animation generation options for ModelImporter. + 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. - + - Calculate tangents. + Override this method if you want to show custom controls in the preview header. - + - Import normals/tangents from file. + Called to Reset the target before iterating through them. - + - Strip normals/tangents. + Displays the Physics Debug Visualization options. + +The Physics Debug Visualization is only displayed if this window is visible. + +See Also: PhysicsVisualizationSettings. - + - Representation of Script assets. + This class contains the settings controlling the Physics Debug Visualization. - + - Returns the MonoScript object containing specified MonoBehaviour. + Alpha amount used for transparency blending. - The MonoBehaviour whose MonoScript should be returned. - + - Returns the MonoScript object containing specified ScriptableObject. + Used to disinguish neighboring Colliders. - The ScriptableObject whose MonoScript should be returned. - + - Returns the System.Type object of the class implemented by this script. + Shows extra options used to develop and debug the physics visualization. - + - Custom mouse cursor shapes used with EditorGUIUtility.AddCursorRect. + Dirty marker used for refreshing the GUI. - + - Normal pointer arrow. + Enables the mouse-over highlighting and mouse selection modes. - + - Arrow with the minus symbol next to it. + See PhysicsVisualizationSettings.FilterWorkflow. - + - Arrow with the plus symbol next to it. + Forcing the drawing of Colliders on top of any other geometry, regardless of depth. - + - The current user defined cursor. + Color for kinematic Rigidbodies. - + - Cursor with an eye and stylized arrow keys for FPS navigation. + Color for Rigidbodies, primarily active ones. - + - Arrow with a Link badge (for assigning pointers). + Should the PhysicsDebugWindow display the collision geometry. - + - Arrow with the move symbol next to it for the sceneview. + Color for Rigidbodies that are controlled by the physics simulator, but are not currently being simulated. - + - Cursor with an eye for orbit. + Color for Colliders that do not have a Rigidbody component. - + - Cursor with a dragging hand for pan. + Maximum number of mesh tiles available to draw all Terrain Colliders. - + - Horizontal resize arrows. + Color for Colliders that are Triggers. - + - Resize up-Left for window edges. + Controls whether the SceneView or the GameView camera is used. Not shown in the UI. - + - Resize up-right for window edges. + Colliders within this distance will be displayed. - + - Vertical resize arrows. + Clears the highlighted Collider. - + - Arrow with the rotate symbol next to it for the sceneview. + Deinitializes the physics debug visualization system and tracking of changes Colliders. - + - Arrow with the scale symbol next to it for the sceneview. + 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>). - + - Arrow with small arrows for indicating sliding at number fields. + With HideSelectedItems you can hide selected filter items in order to easily discard uninteresting Collider properties thereby making overview and navigation easier. - + - Left-Right resize arrows for window splitters. + With ShowSelectedItems and the Select None button is it easy to monitor very specific Colliders. - + - Up-Down resize arrows for window splitters. + Should BoxColliders be shown. + - + - Text cursor. + Should CapsuleColliders be shown. + - + - Cursor with a magnifying glass for zoom. + Should the given layer for the given filterWorkflow be considered by the display filter. + + - + - AssetImporter for importing MovieTextures. + Should the mask representing the layers for the given filterWorkflow be considered by the display filter. + - + - Duration of the Movie to be imported in seconds. + Should the kinematic Rigidbodies for the given filterWorkflow be considered by the display filter. + - + - Is the movie texture storing non-color data? + Should MeshColliders be shown. + + - + - Quality setting to use when importing the movie. This is a float value from 0 to 1. + Should any Rigidbodies for the given filterWorkflow be considered by the display filter. + - + - Navigation mesh builder interface. + Should the sleeping Rigidbodies for the given filterWorkflow be considered by the display filter. + - + - Returns true if an asynchronous build is still running. + Should SphereColliders be shown. + - + - Build the Navmesh. + Should the Colliders without a Rigidbody component be considered by the display filter for the given filterWorkflow. + - + - Build the Navmesh Asyncronously. + Should TerrainColliders be shown. + - + - Builds the combined navmesh for the contents of multiple scenes. + Should the triggers for the given filterWorkflow be considered by the display filter. - Array of paths to scenes that are used for building the navmesh. + - + - Cancel Navmesh construction. + Returns true if there currently is any kind of physics object highlighted. - + - Clear all Navmeshes. + 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. - + - Helper class for constructing displayable names for objects. + Is a MeshCollider convex. - + - Class name of an object. + Corresponds to MeshCollider.convex is true. - - + - Drag and drop title for an object. + Corresponds to MeshCollider.convex is false. - - + - Inspector title for an object. + Resets the visualization options to their default state. - - + - Make a displayable name for a variable. + Should BoxColliders be shown. - + + - + - Sets the name of an Object. + Should CapsuleColliders be shown. - - + + - + - Base Class to derive from when creating Custom Previews. + Should the given layer for the given filterWorkflow be considered by the display filter. + + + - + - The object currently being previewed. + Should the mask representing the layers for the given filterWorkflow be considered by the display filter. + + - + - This is the first entry point for Preview Drawing. + Enables or disables all filtering items for the current filterWorkflow. - The available area to draw the preview. + + - + - Implement this method to show object information on top of the object preview. + Should the kinematic Rigidbodies for the given filterWorkflow be considered by the display filter. + + - + - Override this method if you want to change the label of the Preview area. + Should MeshColliders be shown. + + + - + - Can this component be Previewed in its current state? + Should any Rigidbodies for the given filterWorkflow be considered by the display filter. - - True if this component can be Previewed in its current state. - + + - + - Called when the Preview gets created with the objects being previewed. + Should the sleeping Rigidbodies for the given filterWorkflow be considered by the display filter. - The objects being previewed. + + - + - Called to iterate through the targets, this will be used when previewing more than one target. + Should SphereColliders be shown. - - 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. + Should the Colliders without a Rigidbody component be considered by the display filter for the given filterWorkflow. - 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. + Should TerrainColliders be shown. - Rectangle in which to draw the preview. - Background image. + + - + - Override this method if you want to show custom controls in the preview header. + Should the triggers for the given filterWorkflow be considered by the display filter. + + - + - Called to Reset the target before iterating through them. + Updates the mouse-over highlight at the given mouse position in screen space. + @@ -15764,17 +19521,17 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource - .NET API compatibility level. + Deprecated. Use PlayerSettings.GetApiCompatibilityLevel and PlayerSettings.SetApiCompatibilityLevel instead. - + - Pre bake collision meshes on player build. + The application identifier for the currently selected build target. - + - Application bundle identifier shared between iOS & Android platforms. + Pre bake collision meshes on player build. @@ -15802,6 +19559,11 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource 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). @@ -15812,6 +19574,11 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource Define how to handle fullscreen mode in Windows standalones (Direct3D 9 mode). + + + The default cursor for your application. + + Default screen orientation for mobiles. @@ -15872,6 +19639,16 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource 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. @@ -15899,7 +19676,12 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource - Define how to handle fullscreen mode in Mac OS X standalones. + Define how to handle fullscreen mode in macOS standalones. + + + + + Stops or allows audio from other applications to play in the background while your Unity application is running. @@ -15907,6 +19689,11 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource The name of your product. + + + Protect graphics memory. + + Which rendering path is enabled? @@ -15932,11 +19719,26 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource 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. + + Should status bar be hidden. Shared between iOS & Android platforms. + + + Active stereo rendering path + + Should player render in stereoscopic 3d on supported hardware? @@ -15972,6 +19774,11 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource Should Direct3D 11 be used when available? + + + Switch display to HDR mode (if available). + + Enable receipt validation for the Mac App Store. @@ -15997,71 +19804,11 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource On Windows, show the application in the background if Fullscreen Windowed mode is used. - - - Xbox 360 Kinect Head Orientation file deployment. - - - - - Xbox 360 Kinect Head Position file deployment. - - - - - Xbox 360 Kinect resource file deployment. - - Xbox 360 Avatars. - - - Xbox 360 Kinect title flag - if false, the Kinect APIs are inactive. - - - - - Xbox 360 Kinect automatic skeleton tracking. - - - - - Xbox 360 Kinect Enable Speech Engine. - - - - - Xbox 360 auto-generation of _SPAConfig.cs. - - - - - Xbox 360 ImageXex override configuration file path. - - - - - Xbox 360 SPA file path. - - - - - Xbox 360 Kinect Speech DB. - - - - - Xbox 360 splash screen. - - - - - Xbox 360 title id. - - Android specific player settings. @@ -16124,7 +19871,7 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource - Minimal Android SDK version. + The minimum API level required for your application to run. @@ -16132,30 +19879,57 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource Preferred application install location. - + + + Application should show ActivityIndicator when loading. + + + + + Android splash screen scale mode. + + + + + Android target device. + + + + + The target API level of your application. + + + + + 24-bit Depth Buffer is used. + + + - Application should show ActivityIndicator when loading. + Use APK Expansion Files. - + - Android splash screen scale mode. + Facebook specific Player settings. - + - Android target device. + Version of Facebook SDK to use for this project. - + - 24-bit Depth Buffer is used. + Gets .NET API compatibility level for specified BuildTargetGroup. + - + - Use APK Expansion Files. + Get the application identifier for the specified platform. + @@ -16247,6 +20021,12 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource + + + Get stack trace logging options. + + + Is a build platform using automatic graphics API choice? @@ -16272,14 +20052,39 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource 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. + The build number of the bundle + + + + + Describes the reason for access to the user's camera. @@ -16287,6 +20092,26 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource Application should exit when suspended to background. + + + Should hard shadows be enforced when running on (mobile) Metal. + + + + + A provisioning profile Universally Unique Identifier (UUID) that Xcode will use to build your iOS app in Manual Signing mode. + + + + + 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. @@ -16337,6 +20162,16 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource 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. + + Indicates whether application will use On Demand Resources (ODR) API. @@ -16347,301 +20182,196 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource Is multi-threaded rendering enabled? - + Nintendo 3DS player settings. - + The unique ID of the application, issued by Nintendo. (0x00300 -> 0xf7fff) - + Specify true to enable static memory compression or false to disable it. - + Disable depth/stencil buffers, to free up memory. - + Disable sterescopic (3D) view on the upper screen. - + Enable shared L/R command list, for increased performance with stereoscopic rendering. - + Enable vsync. - + Specify the expanded save data number using 20 bits. - + Application Logo Style. - + Distribution media size. - + Specifies the product code, or the add-on content code. - + Specifies the title region settings. - + Specify the stack size of the main thread, in bytes. - + The 3DS target platform. - + The title of the application. - + Specify true when using expanded save data. - + Nintendo 3DS logo style specification. - + For Chinese region titles. - + For titles for which Nintendo purchased the publishing license from the software manufacturer, etc. - + For all other titles. - + For Nintendo first-party titles. - + Nintendo 3DS distribution media size. - + 128MB - + 1GB - + 256MB - + 2GB - + 512MB - + Nintendo 3DS Title region. - + For all regions. - + For the American region. - + For the Chinese region. - + For the European region. - + For the Japanese region. - + For the Korean region. - + For the Taiwanese region. - + Nintendo 3DS target platform. - + Target the New Nintendo 3DS platform. - + Target the Nintendo 3DS platform. - - - PS3 specific player settings. - - - - - backgroundPath - - - - - bootCheckMaxSaveGameSizeKB - - - - - dlcConfigPath - - - - - npAgeRating - - - - - npCommunicationPassphrase - - - - - npTrophyCommId - - - - - npTrophyCommSig - - - - - npTrophyPackagePath - - - - - Texture to use for PS3 Splash Screen on boot. - - - - - saveGameSlots - - - - - soundPath - - - - - thumbnailPath - - - - - titleConfigPath - - - - - TrialMode. - - - - - Amount of video memory (in MB) to use as audio storage. - - - - - The amount of video memory (in MB) that is set aside for vertex data allocations. Allocations which do not fit into the area are allocated from system memory. - - - - - DisableDolbyEncoding - - - - - EnableMoveSupport - - - - - Toggle for verbose memory statistics. - - - - - UseSPUForUmbra - - PS4 application category. @@ -17107,6 +20837,20 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource The videos category. + + + Sets .NET API compatibility level for specified BuildTargetGroup. + + + + + + + Set the application identifier for the specified platform. + + + + Enables the specified aspect ratio. @@ -17159,6 +20903,14 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource + + + Set stack trace logging options. +Note: calling this function will implicitly call Application.SetStackTraceLogType. + + + + Should a build platform use automatic graphics API choice. @@ -17166,11 +20918,181 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource Platform to set the flag for. Should best available graphics API be used? + + + 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. + + Tizen specific player settings. + + + Currently chosen Tizen deployment target. + + + + + Choose a type of Tizen target to deploy to. Options are Device or Emulator. + + + + + Minimum Tizen OS version that this application is compatible with. + IMPORTANT: For example: if you choose Tizen 2.4 your application will only run on devices with Tizen 2.4 or later. + + Description of your project to be displayed in the Tizen Store. @@ -17181,6 +21103,11 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource URL of your project to be displayed in the Tizen Store. + + + Set or Get the style of application loading indicator. The available styles are TizenShowActivityIndicatorOnLoading. + + Name of the security profile to code sign Tizen applications with. @@ -17406,245 +21333,256 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource - + + + + + + + + + + + + + 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. - + - tvOS specific player settings. + Google Cardboard-specific Player Settings. - + - Active tvOS SDK version used for build. + Set the requested depth format for the Depth and Stencil Buffers. Options are 16bit Depth, 24bit Depth and 24bit Depth + 8bit Stencil. - + - Deployment minimal version of tvOS. + Google VR-specific Player Settings. - + - Compilation overrides for C# files. + Foreground image for the Daydream Launcher Home Screen. - + - C# files are compiled using Mono compiler. + Background image for the Daydream Launcher Home Screen. - + - 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. + Set the requested depth format for the Depth and Stencil Buffers. Options are 16bit Depth, 24bit Depth and 24bit Depth + 8bit Stencil. - + - 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. + WebGL specific player settings. - + - Various image scales, supported by Windows Store Apps. + CompressionFormat defines the compression type that the WebGL resources are encoded to. - + - Image types, supported by Windows Store Apps. + Enables automatic caching of asset data. - + - Xbox One Specific Player Settings. + Enables generation of debug symbols file in the build output directory. - + - Add a ProductId to the list of products that can load the content package created from your project. This setting is only available for content packages. + Exception support for WebGL builds. - - - Returns false if the product Id was already in the allowed list. - - + - Get the list of projects that can load this content package. This setting is only available for content packages. + Memory size for WebGL builds in MB. - + - Xbox One optional parameter that lets you use a specified Manifest file rather than generated for you. + Enables using MD5 hash of the uncompressed file contents as a filename for each file in the build. - + - Xbox One Content ID to be used in constructing game package. + Path to the WebGL template asset. - + - A friendly description that can be displayed to users. + Windows Store Apps specific player settings. - + - Disabling the kinect frees up additional GPU resources for use. + Specify how to compile C# files when building to Windows Store Apps. - + - Enable sampling profiler in development builds to provide better profile markers for PIX, including Start and Update markers for script behaviors. + Enable/Disable independent input source feature. - + - Turns on notifications that you are gaining/losing GPU resources. + Enable/Disable low latency presentation API. - + - (optional override) Location of Xbox One Game OS image file to link into ERA package being created. + Where Unity gets input from. - + - Returns a bool indicating if the given capability is enabled or not. Please see the XDK whitepaper titled "Xbox One Submission Validator" for valid capability names. + Windows Store Apps declarations. - - + - Get the rating value that is specified in the appxmanifest.xml file for the given ratings board. + Set information for file type associations. + +For more information - https:msdn.microsoft.comlibrarywindowsappshh779671https:msdn.microsoft.comlibrarywindowsappshh779671. - The name of the ratings board that you want the rating value for. - - The current rating level. The meaning of the value depends on the name of the ratings board. The value corresponds to the entries the rating board's drop down menu, top most entry being 0 and each item lower in the list being 1 higher than the previous. - - + - Get the values for the socket description with the given name. + + 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. - The name of the socket description. - The port or port range the socket can use. - The protocol the socket uses. - The allowed usage flags for this socket description. - The name of the device association template. - Mutiplayer requirement setting for the device association template. - The allowed usage flags for the device association template. - + - Indicates if the game is a standalone game or a content package to an existing game. + Get path for image, that will be populated to the Visual Studio solution and the package manifest. + + - + - The update granularity the package will be built with. + Set path for image, that will be populated to the Visual Studio solution and the package manifest. + + + - + - Xbox One optional parameter that causes the makepkg process to encrypt the package for performance testing or with final retail encryption. + Compilation overrides for C# files. - + - Xbox One optional parameter that causes the makepkg process to use your specified layout file rather than generating one for you. Required if working with asset bundles. + C# files are compiled using Mono compiler. - + - Sets the size of the persistent local storage. + 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. - + - Xbox One Product ID to use when building a streaming install package. + 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. - + - Remove a ProductId from the list of products that can load the content package created from your project. This setting is only available for content packages. + Describes File Type Association declaration. - - + - Remove the socket description with the given name. + Localizable string that will be displayed to the user as associated file handler. - - + - Xbox One makepkg option. Specifies the Sandbox ID to be used when building a streaming install package. + Supported file types for this association. - + - The service configuration ID for your title. + Various image scales, supported by Windows Store Apps. - + - Mark a specific capability as enabled or enabled in the appxmanifest.xml file. Please see the XDK whitepaper titled "Xbox One Submission Validator" for valid capability names. + Image types, supported by Windows Store Apps. - The name of the capability to set. - Whether or not to enable the capability. - + - Set the rating value that is specified in the appxmanifest.xml file. + Where Unity takes input from (subscripbes to events). - The name of the ratings board that you are setting the rating value for. - The new rating level. The meaning of the value depends on the name of the ratings board. The value corresponds to the entries the rating board's drop down menu, top most entry being 0 and each item lower in the list being 1 higher than the previous. - + - Set the values for the socket description with the given name. + Subscribe to CoreWindow events. - The name of the socket description. - The port or port range the socket can use. - The protocol the socket uses. - The allowed usage flags for this socket description. - The name of the device association template. - Mutiplayer requirement setting for the device association template. - The allowed usage flags for the device association template. - + - Get the names of the socket descriptions for the project. + Create Independent Input Source and receive input from it. - + - The TitleID uniquely identifying your title to Xbox Live services. + Subscribe to SwapChainPanel events. - + - Update the value at the given index in the list of products that can load this content package. You can use the PlayerSettings.XboxOne.AllowedProductIds property to get the existing productIds and determine their indexes. + Describes supported file type for File Type Association declaration. - - - + - Xbox One makepkg.exe option. Specifies the update key required when building game updates. + The 'Content Type' value for the file type's MIME content type. For example: 'image/jpeg'. Can also be left blank. - + - Xbox One Version Identifier used in the Application Manifest. + File type extension. For ex., .myUnityGame @@ -17657,6 +21595,11 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource 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. @@ -17697,6 +21640,25 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource 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. @@ -17711,6 +21673,11 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource 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. @@ -17762,6 +21729,28 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource 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. + + + Set platform specific data. @@ -17780,6 +21769,11 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource Data. + + + Identifies whether or not this plugin should be included in the current build target. + + Class used to display popup windows that inherit from PopupWindowContent. @@ -17828,7 +21822,7 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource - The type of a prefab object as returned by EditorUtility.GetPrefabType. + The type of a prefab object as returned by PrefabUtility.GetPrefabType. @@ -17920,19 +21914,29 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource Helper function to find the prefab root of an object (used for picking niceness). - + The object to check. + + The prefab root. + Returns the topmost game object that has the same prefab parent as target. + Scene to instantiate the prefab in. + + The GameObject at the root of the prefab. + Returns root game object 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. + @@ -18007,9 +22011,9 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource - Force record property modifications by comparing against the parent prefab. + Causes modifications made to the Prefab instance to be recorded. - + Object to process. @@ -18145,6 +22149,16 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource For general development, creates a build stored on the host PC which the Vita reads from. + + + 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 @@ -18160,6 +22174,172 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource 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. + + + + + Will return an array of Rendering.AlbedoSwatchInfo. + + + + + Will return PlatformShaderSettings for given platform and shader hardware tier. + + + + + + + Will return TierSettings for given platform and shader hardware tier. + + + + + + + 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. + + + + + + + + Used to set up shader settings, per-platorm 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. + + + + + Shader quality preset. + + + + + High quality shader preset. + + + + + Low quality shader preset. + + + + + Medium quality shader preset. + + + + + 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. + + + + + 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. + + + + + 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. @@ -18200,141 +22380,255 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource Hide the resolution dialog on first launch. - + - Target PS3 or PS4 build type. + SceneAsset is used to reference scene objects in the Editor. - + - Build a package suited for BluRay Submission. + Constructor. - + - Build a package suited for DLC Submission. + Scene management in the Editor. - + - Build package that it's hosted on the PC. + The number of loaded Scenes. - + - SceneAsset is used to reference scene objects in the Editor. + This event is called after a new Scene has been created. + - + - Constructor. + Controls whether cross-Scene references are allowed in the Editor. - + - Scene management in the editor. + 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. + + + + - The number of loaded scenes. + This event is called before a Scene is saved disk after you have requested the Scene to be saved. + - Close the scene. If removeScene flag is true, the closed scene will also be removed from EditorSceneManager. + 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. - The scene to be closed/removed. - Bool flag to indicate if the scene should be removed after closing. + Text shown in the save dialog. - Returns true if the scene is closed/removed. + 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. + - Mark all the loaded scenes as modified. + Mark all the loaded Scenes as modified. - Mark the scene as modified. + Mark the specified Scene as modified. - The scene to be marked 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. + 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. + 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. - Create a new 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. - Allows you to select whether or not the default set of Game Objects should be added to the new scene. See SceneManagement.NewSceneSetup for more information about the options. - Allows you to select how to open the new scene, and whether to keep existing scenes in the Hierarchy. See SceneManagement.NewSceneMode for more information about the options. + 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. + Open a Scene in the Editor. - Path of the scene. Should be relative to the project folder. Like: "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. + 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. + In this array, at least one Scene should be loaded, and there must be one active Scene. - Ask the user if they want to save the the modified scene(s). + 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. + - Ask the user if he wants to save any of the modfied input scenes. + 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. + Save all open Scenes. - Returns true if all open scenes are successfully saved. + Returns true if all open Scenes are successfully saved. - Save a scene. + Save a Scene. - The scene to be saved. - The file path to save at. If not 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 current scene and without clearing the unsaved changes marker. + 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. + 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. - List of scenes that should be saved. + 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. @@ -18502,6 +22796,21 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource Default setting. + + + Represents different C# compilers that can be used to compile C# scripts. + + + + + Mono C# Compiler. + + + + + Roslyn C# Compiler. + + Scripting implementation (backend). @@ -18527,6 +22836,11 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource 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). @@ -18604,6 +22918,13 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource 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. @@ -18659,11 +22980,21 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource SerializedObject and SerializedProperty are classes for editing properties on objects in a completely generic way that automatically handles undo and styling UI for prefabs. + + + The context used to store and resolve ExposedReference types. This is set by the SerializedObject constructor. + + 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). @@ -18702,6 +23033,20 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource + + + 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. @@ -18724,6 +23069,11 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource + + 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. @@ -18738,6 +23088,11 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource 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. @@ -18793,6 +23148,11 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource 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. + + Value of a float property. @@ -19050,6 +23410,11 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource 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. + + Float property. @@ -19105,6 +23470,131 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource 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. + + + + Abstract class to derive from for defining custom GUI for shader properties and for extending the material preview. @@ -19208,10 +23698,13 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource - Gets the ShaderPropertyTexDim of the texture at property index propertyIdx of Shader s. + Gets texture dimension of a shader property. - The shader to check against. + The shader to get the property from. The property index to use. + + Texture dimension. + @@ -19220,41 +23713,6 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource The shader to check against. The property index to use. - - - Representation of the texture dimensions. - - - - - 2D Texture. - - - - - 3D Texture. - - - - - Any texture dimension (catch all). - - - - - Texure Cube (Cubemap). - - - - - Texture Rect. - - - - - Unknown Texture dimension. - - Type of a given texture property. @@ -19506,6 +23964,21 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource Gets and sets an array of floats of each LOD's screen height value. + + + 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. @@ -19553,7 +24026,7 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource - Pivot point of the Sprite relative to its bounding rectangle. + The pivot point of the Sprite, relative to its bounding rectangle. @@ -19901,6 +24374,45 @@ To force a reload of the mask, simply set ModelImporterClipAnimation.maskSource 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. + + + + + Use the last known version control system status of the file. This is faster on average but less accurate than forcing an update, as it will cache the status of the file for a period of time. + +See Also: AssetDatabase.IsOpenForEdit, AssetDatabase.IsMetaFileOpenForEdit. + + + + + 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. @@ -20087,11 +24599,11 @@ Values match the ProceduralMaterial::ProceduralLoadingBehavior enum. - + - Set the import settings for the input ProceduralMaterial for the input platform (width and height, RAW/Compressed format, loading behavior). + Set the import settings for the input ProceduralMaterial for the input platform. - The name of the Procedural Material. + The name of the Procedural Material. The name of the platform (can be empty). The maximum texture width for this Procedural Material. The maximum texture height for this Procedural Material. @@ -20107,6 +24619,41 @@ Values match the ProceduralMaterial::ProceduralLoadingBehavior enum. + + + Describes the rendering features supported by a given renderloop. + + + + + The rendering features supported by the active renderloop. + + + + + Supported reflection probe rendering features. + + + + + Default rendering features (Read Only). + + + + + Reflection probe features. + + + + + No additional reflection probe features. + + + + + Reflection probes support rotation. + + A Takeinfo object contains all the information needed to describe a take. @@ -20152,6 +24699,21 @@ Values match the ProceduralMaterial::ProceduralLoadingBehavior enum. 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. + + Anisotropic filtering level of the texture. @@ -20172,6 +24734,11 @@ Values match the ProceduralMaterial::ProceduralLoadingBehavior enum. Convert heightmap to normal map? + + + Use crunched compression when available. + + Fade out mip levels to gray color? @@ -20204,7 +24771,7 @@ Values match the ProceduralMaterial::ProceduralLoadingBehavior enum. - Is texture data readable from scripts. + 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. @@ -20229,7 +24796,7 @@ Values match the ProceduralMaterial::ProceduralLoadingBehavior enum. - Generate mip maps for the texture? + Generate Mip Maps. @@ -20292,14 +24859,24 @@ Values match the ProceduralMaterial::ProceduralLoadingBehavior enum. 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. + + + - Scale factor for mapping pixels in the graphic to units in world space. + Is texture storing color data? - + - Array representing the sections of the atlas corresponding to individual sprite graphics. + Compression of imported texture. @@ -20307,6 +24884,11 @@ Values match the ProceduralMaterial::ProceduralLoadingBehavior enum. Format of imported texture. + + + Shape of imported texture. + + Which type of texture are we dealing with here. @@ -20341,14 +24923,47 @@ Values match the ProceduralMaterial::ProceduralLoadingBehavior enum. 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. - Data format of the texture. + 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. + @@ -20356,7 +24971,19 @@ Values match the ProceduralMaterial::ProceduralLoadingBehavior enum. The platform whose settings are required (see below). Maximum texture width/height in pixels. - Data format of the texture. + 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. + @@ -20382,7 +25009,7 @@ Values match the ProceduralMaterial::ProceduralLoadingBehavior enum. 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, equivalent to the standard JPEG quality setting. + 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). @@ -20392,15 +25019,66 @@ Values match the ProceduralMaterial::ProceduralLoadingBehavior enum. 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, equivalent to the standard JPEG quality setting. + 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. @@ -20428,17 +25106,17 @@ Values match the ProceduralMaterial::ProceduralLoadingBehavior enum. - Alpha 8 bit texture format. + TextureFormat.Alpha8 texture format. - RGBA 16 bit texture format. + TextureFormat.ARGB4444 texture format. - ARGB 32 bit texture format. + TextureFormat.ARGB32 texture format. @@ -20511,6 +25189,11 @@ Values match the ProceduralMaterial::ProceduralLoadingBehavior enum. ATC (Android) 8 bits/pixel compressed RGBA texture format. + + + Choose texture format automatically based on the texture parameters. + + Choose a 16 bit format automatically. @@ -20521,34 +25204,64 @@ Values match the ProceduralMaterial::ProceduralLoadingBehavior enum. 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. + + - DXT1 compresed texture format. + TextureFormat.DXT1 compressed texture format. - DXT1 compresed texture format with crunch compression for small storage sizes. + DXT1 compressed texture format with Crunch compression for small storage sizes. - DXT5 compresed texture format. + TextureFormat.DXT5 compressed texture format. - DXT5 compresed texture format with crunch compression for small storage sizes. + DXT5 compressed texture format with Crunch compression for small storage sizes. @@ -20593,42 +25306,47 @@ Values match the ProceduralMaterial::ProceduralLoadingBehavior enum. - PowerVR (iPhone) 2 bits/pixel compressed color texture format. + PowerVR/iOS TextureFormat.PVRTC_RGB2 compressed texture format. - PowerVR (iPhone) 4 bits/pixel compressed color texture format. + PowerVR/iOS TextureFormat.PVRTC_RGB4 compressed texture format. - PowerVR (iPhone) 2 bits/pixel compressed with alpha channel texture format. + PowerVR/iOS TextureFormat.PVRTC_RGBA2 compressed texture format. - PowerVR (iPhone) 4 bits/pixel compressed with alpha channel texture format. + PowerVR/iOS TextureFormat.PVRTC_RGBA4 compressed texture format. - RGB 16 bit texture format. + TextureFormat.RGB565 texture format. - RGB 24 bit texture format. + TextureFormat.RGB24 texture format. - RGBA 16 bit (4444) texture format. + TextureFormat.RGBA4444 texture format. - RGBA 32 bit texture format. + TextureFormat.RGBA32 texture format. + + + + + TextureFormat.RGBAHalf floating point texture format. @@ -20716,6 +25434,57 @@ Values match the ProceduralMaterial::ProceduralLoadingBehavior enum. 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). + + + + + 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. + + + + + Compression of imported texture. + + + + + Copy parameters into another TextureImporterPlatformSettings object. + + TextureImporterPlatformSettings object to copy settings to. + RGBM encoding mode for HDR textures in TextureImporter. @@ -20746,9 +25515,29 @@ Values match the ProceduralMaterial::ProceduralLoadingBehavior enum. 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. + + + + + Anisotropic filtering level of the texture. + + + - Allow Alpha splitting on the imported texture when needed (for example ETC1 compression for textures with transparency). + Enable this to avoid colors seeping out to the edge of the lower Mip levels. Used for light cookies. + + + + + Convert heightmap to normal map? @@ -20766,6 +25555,71 @@ Values match the ProceduralMaterial::ProceduralLoadingBehavior enum. 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. + + + + + 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. @@ -20806,6 +25660,32 @@ Values match the ProceduralMaterial::ProceduralLoadingBehavior enum. 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? + + + + + Shape of imported texture. + + + + + Which type of texture are we dealing with here. + + + + + Wrap mode (Repeat or Clamp) of the texture. + + Configure parameters to import a texture for a purpose of type, as described TextureImporterType|here. @@ -20826,29 +25706,29 @@ Values match the ProceduralMaterial::ProceduralLoadingBehavior enum. - + - Select this to set basic parameters depending on the purpose of your texture. + Select the kind of shape of your texture. - + - Select this when you want to have specific parameters on your texture and you want to have total control over your texture. + Texture is 2D. - + - Select this to turn the color channels into a format suitable for real-time normal mapping. + Texture is a Cubemap. - + - This sets up your texture with the basic parameters used for the Cookies of your lights. + Select this to set basic parameters depending on the purpose of your texture. - + - This converts your texture into Cubemap suitable for Skyboxes, Environment Reflections or Image Based Lighting (IBL). + This sets up your texture with the basic parameters used for the Cookies of your lights. @@ -20856,6 +25736,11 @@ Values match the ProceduralMaterial::ProceduralLoadingBehavior enum. 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. @@ -20871,11 +25756,61 @@ Values match the ProceduralMaterial::ProceduralLoadingBehavior enum. 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. + + + Tizen OS compatibility. + + + + + + + + + + Enumerator list of different activity indicators your game can show when loading. + + + + + Sets your game not to show any indicator while loading. + + + + + The loading indicator size is large and rotates counterclockwise. + + + + + The loading indicator size is small and rotates counterclockwise. + + + + + The loading indicator size is large and rotates clockwise. + + + + + The loading indicator size is small and rotates clockwise. + + Which tool is active in the editor. @@ -21210,8 +26145,8 @@ It is required that the GameObject is at the root of its current scene. 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). @@ -21332,16 +26267,22 @@ It is required that the GameObject is at the root of its current scene. - Will generate per-triangle uv (3 uv pairs for each triangle) with default settings. + 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 uv pairs for each triangle) with provided settings. + 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. + @@ -22455,6 +27396,367 @@ It is required that the GameObject is at the root of its current scene. Texture coordinate channel 3. + + + 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. + + + + + 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. + + + + + Whether to import a MovieTexture (legacy) or a VideoClip. + + + + + Clear the platform-specific import settings for the specified platform, causing them to go back to the default settings. + + Platform name. + + + + 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. @@ -22485,6 +27787,46 @@ It is required that the GameObject is at the root of its current scene. 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. + + + + + Disable exception support. + + Wii U Player debugging level. @@ -22573,6 +27915,31 @@ Optimization enabled, profiler code enabled. Specifies Windows SDK which used when building Windows Store Apps. + + + 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. diff --git a/Library/UnityAssemblies/UnityEngine.Networking.dll b/Library/UnityAssemblies/UnityEngine.Networking.dll index b64fd39..4a58233 100644 Binary files a/Library/UnityAssemblies/UnityEngine.Networking.dll and b/Library/UnityAssemblies/UnityEngine.Networking.dll differ diff --git a/Library/UnityAssemblies/UnityEngine.Networking.xml b/Library/UnityAssemblies/UnityEngine.Networking.xml index b674dc7..d09093f 100644 --- a/Library/UnityAssemblies/UnityEngine.Networking.xml +++ b/Library/UnityAssemblies/UnityEngine.Networking.xml @@ -9,9 +9,19 @@ An enumeration of the options that can be set on a network channel. + + + The option to allow packet fragmentation for a channel. + + + + + The option to set the maximum packet size allowed for a channel. + + - The option to set the numbet of pending buffers for a channel. + The option to set the number of pending buffers for a channel. @@ -51,7 +61,7 @@ - A client manager which contains non-instance centrict client information and functions. + A client manager which contains static client information and functions. @@ -66,7 +76,7 @@ - This is a dictionary of the prefabs that are registered on the client. + This is a dictionary of the prefabs that are registered on the client with ClientScene.RegisterPrefab(). @@ -76,7 +86,7 @@ - The NetworkConnection object that is currently "ready". This is the connection being used connect to the server where objects are spawned from. + The NetworkConnection object that is currently "ready". This is the connection to the server where objects are spawned from. @@ -91,7 +101,7 @@ - This adds a player object for this client. This causes an AddPlayer message to be sent to the server, and NetworkManager.OnServerAddPlayer will be called. If an extra message was passed to AddPlayer, then OnServerAddPlayer will be called with a NetworkReader that contains the contents of the message. + This adds a player GameObject for this client. This causes an AddPlayer message to be sent to the server, and NetworkManager.OnServerAddPlayer is called. If an extra message was passed to AddPlayer, then OnServerAddPlayer will be called with a NetworkReader that contains the contents of the message. The connection to become ready for this client. The local player ID number. @@ -102,7 +112,7 @@ - This adds a player object for this client. This causes an AddPlayer message to be sent to the server, and NetworkManager.OnServerAddPlayer will be called. If an extra message was passed to AddPlayer, then OnServerAddPlayer will be called with a NetworkReader that contains the contents of the message. + This adds a player GameObject for this client. This causes an AddPlayer message to be sent to the server, and NetworkManager.OnServerAddPlayer is called. If an extra message was passed to AddPlayer, then OnServerAddPlayer will be called with a NetworkReader that contains the contents of the message. The connection to become ready for this client. The local player ID number. @@ -113,7 +123,7 @@ - This adds a player object for this client. This causes an AddPlayer message to be sent to the server, and NetworkManager.OnServerAddPlayer will be called. If an extra message was passed to AddPlayer, then OnServerAddPlayer will be called with a NetworkReader that contains the contents of the message. + This adds a player GameObject for this client. This causes an AddPlayer message to be sent to the server, and NetworkManager.OnServerAddPlayer is called. If an extra message was passed to AddPlayer, then OnServerAddPlayer will be called with a NetworkReader that contains the contents of the message. The connection to become ready for this client. The local player ID number. @@ -129,7 +139,7 @@ - Create and connect a local client instance to the local server. + Create and connect a local client instance to the local server. This makes the client into a "host" - a client and server in the same process. A client object for communicating with the local server. @@ -140,11 +150,11 @@ Destroys all networked objects on the client. - + This finds the local NetworkIdentity object with the specified network Id. - The id of a networked object. + The id of the networked object. The game object that matches the netId. @@ -194,7 +204,7 @@ - This is an advanced spawning funciotn that registers a custom assetId with the UNET spawning system. + This is an advanced spawning function that registers a custom assetId with the UNET spawning system. Custom assetId string. A method to use as a custom spawnhandler on clients. @@ -202,14 +212,22 @@ - Remove the specified player ID from the game. + Removes the specified player ID from the game. - The local player ID number . - + The local playerControllerId number to be removed. Returns true if the player was successfully destoyed and removed. + + + Send a reconnect message to the new host, used during host migration. + + Any extra data to send. + + Returns true if the send succeeded. + + NetId is a unique number assigned to all objects with NetworkIdentity components in a game. @@ -226,15 +244,15 @@ - Removes a registered spawn prefab. + Removes a registered spawn prefab that was setup with ClientScene.RegisterPrefab. - + The prefab to be removed from registration. - Removes a registered spawn handler function. + Removes a registered spawn handler function that was registered with ClientScene.RegisterHandler(). - + The assetId for the handler to be removed for. @@ -321,6 +339,11 @@ Show log messages with priority Info and higher. This is the default setting. + + + Tells the NetworkManager to not set the filter level on startup. + + Show log messages with priority Warning and higher. @@ -403,6 +426,11 @@ Internal networking system message for communicating an error. + + + Internal networking system message for identifying fragmented packets. + + The highest value of built-in networking system message ids. User messages must be above this value. @@ -631,7 +659,7 @@ - The id of the player associated with thei behaviour. + The id of the player associated with the behaviour. @@ -710,7 +738,7 @@ - Virtual function to override to receive custom serialization data. + Virtual function to override to receive custom serialization data. The corresponding function to send serialization data is OnSerialize(). Reader to read from the stream. True if being sent initial state. @@ -732,7 +760,7 @@ - Virtual function to override to send custom serialization data. + Virtual function to override to send custom serialization data. The corresponding function to send serialization data is OnDeserialize(). Writer to use to write to the stream. If this is being called to send initial state. @@ -748,7 +776,7 @@ - This is invoked on behaviours that have authority, based on context and the LocalPlayerAuthority value on the NetworkIdentity. + This is invoked on behaviours that have authority, based on context and NetworkIdentity.localPlayerAuthority. @@ -763,7 +791,7 @@ - Called when the server starts listening. + This is invoked for NetworkBehaviour objects when they become active on the server. @@ -799,7 +827,7 @@ - High level UNET client. + This is a network client class used by the networking system. It contains a NetworkConnection that is used to connection to a network server. @@ -844,7 +872,7 @@ - The other network participants in the current game. + This is obsolete. This information is now in the NetworkMigrationManager. @@ -1048,7 +1076,7 @@ - High level network connection. + A High level network connection. This is used for connections from client-to-server and for connection from server-to-client. @@ -1063,7 +1091,7 @@ - Unique identifier for this connection. + Unique identifier for this connection that is assigned by the transport layer. @@ -1081,6 +1109,11 @@ Flag that tells if the connection has been marked as "ready" by a client calling ClientScene.Ready(). + + + The last error associated with this connection. + + The last time that a message was received on this connection. @@ -1156,13 +1189,10 @@ This inializes the internal data structures of a NetworkConnection object, including channel buffers. - The host or IP connected to. - The transport hostId for the connection. - The transport connectionId for the connection. The topology to be used. - - - + The host or IP connected to. + The transport hostId for the connection. + The transport connectionId for the connection. @@ -1303,7 +1333,7 @@ Returns a string representation of the NetworkConnection object state. - + This virtual function allows custom network connection classes to process data from the network before it is passed to the application. @@ -1509,7 +1539,7 @@ - A component used to add an object to the UNET networking system. + The NetworkIdentity identifies objects across the network, between server and clients. Its primary data is a NetworkInstanceId which is allocated by the server and then set on clients. This is used in network communications to be able to lookup game objects on different machines. @@ -1529,7 +1559,7 @@ - The UConnection associated with this NetworkIdentity. This is only valid for player objects on the server. + The connection associated with this NetworkIdentity. This is only valid for player objects on the server. @@ -1559,7 +1589,7 @@ - LocalPlayerAuthority means that the client of the "owning" player has authority over their own player object. + .localPlayerAuthority means that the client of the "owning" player has authority over their own player object. @@ -1574,7 +1604,7 @@ - The id of the player associated with this object. + The id of the player associated with this GameObject. @@ -1874,6 +1904,12 @@ This is a hook that is invoked on all player objects when exiting the lobby. + + + This is a hook that is invoked on clients when a LobbyPlayer switches between ready or not ready. + + Whether the player is ready or not. + This removes this player from the lobby. @@ -1971,7 +2007,7 @@ - The UMatch matchmaker object. + The UMatch MatchMaker object. @@ -2156,23 +2192,43 @@ The network connection that the scene change message arrived on. - + - This is invoked when a match has been created. + Callback that happens when a NetworkMatch.DestroyMatch request has been processed on the server. - Info about the match that has been created. + Indicates if the request succeeded. + A text description for the error if success is false. - + - This is invoked when a match is joined. + Callback that happens when a NetworkMatch.DropConnection match request has been processed on the server. - + Indicates if the request succeeded. + A text description for the error if success is false. - + - This is invoked when a list of matches is returned from ListMatches(). + Callback that happens when a NetworkMatch.CreateMatch request has been processed on the server. - A list of available matches. + Indicates if the request succeeded. + A text description for the error if success is false. + The information about the newly created match. + + + + Callback that happens when a NetworkMatch.JoinMatch request has been processed on the server. + + Indicates if the request succeeded. + A text description for the error if success is false. + The info for the newly joined match. + + + + Callback that happens when a NetworkMatch.ListMatches request has been processed on the server. + + Indicates if the request succeeded. + A text description for the error if success is false. + A list of matches corresponding to the filters set in the initial list request. @@ -2220,6 +2276,13 @@ The name of the new scene. + + + Callback that happens when a NetworkMatch.SetMatchAttributes has been processed on the server. + + Indicates if the request succeeded. + A text description for the error if success is false. + This is a hook that is invoked when the client is started. @@ -2265,11 +2328,11 @@ - This set the address of the matchmaker service. + This sets the address of the MatchMaker service. - Hostname of matchmaker service. - Port of matchmaker service. - Protocol used by matchmaker service. + Hostname of MatchMaker service. + Port of MatchMaker service. + Protocol used by MatchMaker service. @@ -2300,7 +2363,7 @@ - This starts matchmaker for the NetworkManager. + This starts MatchMaker for the NetworkManager. @@ -2323,7 +2386,7 @@ - Stops the matchmaker that the NetworkManager is using. + Stops the MatchMaker that the NetworkManager is using. @@ -2629,7 +2692,7 @@ All of the player objects in the game are disabled when the host is lost. Then, - The playerControllerId of the player object. + The playerControllerId of the player GameObject. @@ -2738,6 +2801,11 @@ All of the player objects in the game are disabled when the host is lost. Then, A buffer to construct the reader with, this buffer is NOT copied. + + + The current length of the buffer. + + The current position within the buffer. @@ -2800,6 +2868,14 @@ All of the player objects in the game are disabled when the host is lost. Then, The colo read from the stream. + + + Reads a decimal from the stream. + + + Value read. + + Reads a double from the stream. @@ -3057,7 +3133,7 @@ All of the player objects in the game are disabled when the host is lost. Then, - High level network server. + The NetworkServer uses a NetworkServerSimple for basic network functionality and adds more game-like functionality. @@ -3231,9 +3307,9 @@ All of the player objects in the game are disabled when the host is lost. Then, Disconnect all currently connected clients. - + - This finds the NetworkIdentity game object that matches a netId. + This finds the local NetworkIdentity object with the specified network Id. The netId of the NetworkIdentity object to find. @@ -3266,7 +3342,7 @@ All of the player objects in the game are disabled when the host is lost. Then, - Start the server on the given port number. Note that if a match has been created, this will listen using the relay server instead of a local socket. + Start the server on the given port number. Note that if a match has been created, this will listen using the Relay server instead of a local socket. The IP address to bind to (optional). Listen port number. @@ -3276,7 +3352,7 @@ All of the player objects in the game are disabled when the host is lost. Then, - Start the server on the given port number. Note that if a match has been created, this will listen using the relay server instead of a local socket. + Start the server on the given port number. Note that if a match has been created, this will listen using the Relay server instead of a local socket. The IP address to bind to (optional). Listen port number. @@ -3286,7 +3362,7 @@ All of the player objects in the game are disabled when the host is lost. Then, - Starts a server using a relay server. This is the manual way of using the relay server, as the regular NetworkServer.Connect() will automatically use the relay server if a match exists. + Starts a server using a Relay server. This is the manual way of using the Relay server, as the regular NetworkServer.Connect() will automatically use the Relay server if a match exists. Relay server IP Address. Relay server port. @@ -3366,7 +3442,7 @@ All of the player objects in the game are disabled when the host is lost. Then, This sends an array of bytes to a specific player. - The player to send he bytes to. + The player to send the bytes to. Array of bytes to send. Size of array. Transport layer channel id to send bytes on. @@ -3381,7 +3457,7 @@ All of the player objects in the game are disabled when the host is lost. Then, - This sends information about all participants in the current network game to the connection. + This is obsolete. This functionality is now part of the NetworkMigrationManager. Connection to send peer info to. @@ -3667,7 +3743,7 @@ All of the player objects in the game are disabled when the host is lost. Then, - Starts a server using a relay server. This is the manual way of using the relay server, as the regular NetworkServer.Connect() will automatically use the relay server if a match exists. + Starts a server using a Relay server. This is the manual way of using the Relay server, as the regular NetworkServer.Connect() will automatically use the Relay server if a match exists. Relay server IP Address. Relay server port. @@ -3921,7 +3997,7 @@ All of the player objects in the game are disabled when the host is lost. Then, - The playerControllerId of the player object. + The playerControllerId of the player GameObject. @@ -3981,7 +4057,7 @@ All of the player objects in the game are disabled when the host is lost. Then, - The player ID of the player object which should be removed. + The player ID of the player GameObject which should be removed. @@ -3996,7 +4072,7 @@ All of the player objects in the game are disabled when the host is lost. Then, - A component to synchronize the position of networked objects. + A component to synchronize the position and rotation of networked objects. @@ -4094,6 +4170,11 @@ All of the player objects in the game are disabled when the host is lost. Then, What method to use to sync the object's position. + + + The minimum velocity difference that will be synchronized over the network. + + An axis or set of axis. @@ -4334,11 +4415,335 @@ All of the player objects in the game are disabled when the host is lost. Then, Copy of data used by the writer. + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + - This writes the a reference to a GameObject with a NetworkIdentity component to the stream. The object should have been spawned for clients to know about it. + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. - The GameObject to write. + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. + + + + This writes a reference to an object, value, buffer or network message, together with a NetworkIdentity component to the stream. + + The object to write. + The byte buffer to write. + The number of bytes in the byte buffer to write. + The byte buffer array element to start writing from. + The network message to write. @@ -4466,6 +4871,24 @@ All of the player objects in the game are disabled when the host is lost. Then, Same as List:Clear() but the list is cleared on clients. + + + Determines whether the list contains item item. + + Item to search for. + + + + Copies the elements of the SyncList<T> to an Array, starting at a particular Array index. + + Array to copy elements to. + The zero-based index in array at which copying begins. + + + + Returns the number of elements in this SyncList<T>. + + This method is used when deserializing SyncList items from a stream. @@ -4481,6 +4904,11 @@ All of the player objects in the game are disabled when the host is lost. Then, Index of item to dirty. + + + Returns an enumerator that iterates through the SyncList<T>. + + Internal function used for remote list operations. @@ -4489,6 +4917,12 @@ All of the player objects in the game are disabled when the host is lost. Then, The index of the item being operated on. The item being operated on. + + + Determines the index of a specific item in the SyncList<T>. + + The item to return the index for. + Internal function. @@ -4503,6 +4937,11 @@ All of the player objects in the game are disabled when the host is lost. Then, Where to insert the item. Item to insert. + + + Reports whether the SyncList<T> is read-only. + + The types of operations that can occur for SyncLists. @@ -4639,8 +5078,7 @@ All of the player objects in the game are disabled when the host is lost. Then, - [SyncVar] is an attribute that can be put on member variables of UNeBehaviour classes. These variables will have their values sychronized from the server to clients in the game that are in the ready state. - + [SyncVar] is an attribute that can be put on member variables of NetworkBehaviour classes. These variables will have their values sychronized from the server to clients in the game that are in the ready state. @@ -4648,6 +5086,16 @@ All of the player objects in the game are disabled when the host is lost. Then, The hook attribute can be used to specify a function to be called when the sync var changes value on the client. + + + This is an attribute that can be put on methods of NetworkBehaviour classes to allow them to be invoked on clients from a server. Unlike the ClientRpc attribute, these functions are invoked on one individual target client, not all of the ready clients. + + + + + The channel ID which this RPC transmission will use. + + Delegate for a function which will handle destruction of objects created with NetworkServer.Spawn. diff --git a/Library/UnityAssemblies/UnityEngine.UI.dll b/Library/UnityAssemblies/UnityEngine.UI.dll index 3c03a3f..286aaa0 100644 Binary files a/Library/UnityAssemblies/UnityEngine.UI.dll and b/Library/UnityAssemblies/UnityEngine.UI.dll differ diff --git a/Library/UnityAssemblies/UnityEngine.UI.xml b/Library/UnityAssemblies/UnityEngine.UI.xml index 5c092b5..2e5eeb8 100644 --- a/Library/UnityAssemblies/UnityEngine.UI.xml +++ b/Library/UnityAssemblies/UnityEngine.UI.xml @@ -60,11 +60,97 @@ + + + Interface to the Input system used by the BaseInputModule. With this it is possible to bypass the Input system with your own but still use the same InputModule. For example this can be used to feed fake input into the UI or interface with a different input system. + + + + + Interface to Input.compositionCursorPos. Can be overridden to provide custom input instead of using the Input class. + + + + + Interface to Input.compositionString. Can be overridden to provide custom input instead of using the Input class. + + + + + Interface to Input.imeCompositionMode. Can be overridden to provide custom input instead of using the Input class. + + + + + Interface to Input.mousePosition. Can be overridden to provide custom input instead of using the Input class. + + + + + Interface to Input.mousePresent. Can be overridden to provide custom input instead of using the Input class. + + + + + Interface to Input.mouseScrollDelta. Can be overridden to provide custom input instead of using the Input class. + + + + + Interface to Input.touchCount. Can be overridden to provide custom input instead of using the Input class. + + + + + Interface to Input.touchSupported. Can be overridden to provide custom input instead of using the Input class. + + + + + Interface to Input.GetAxisRaw. Can be overridden to provide custom input instead of using the Input class. + + + + + + Interface to Input.GetButtonDown. Can be overridden to provide custom input instead of using the Input class. + + + + + + Interface to Input.GetMouseButton. Can be overridden to provide custom input instead of using the Input class. + + + + + + Interface to Input.GetMouseButtonDown. Can be overridden to provide custom input instead of using the Input class. + + + + + + Interface to Input.GetMouseButtonUp. Can be overridden to provide custom input instead of using the Input class. + + + + + + Interface to Input.GetTouch. Can be overridden to provide custom input instead of using the Input class. + + + A base module that raises events and sends them to GameObjects. + + + The current BaseInput being used by the input module. + + Called when the module is activated. Override this if you want custom code to execute when you activate your module. @@ -143,6 +229,11 @@ See MonoBehaviour.OnDisable. + + + See MonoBehaviour.OnEnable. + + Process the current tick for the module. @@ -296,7 +387,7 @@ - All the functions registered in this EventTrigger. + All the functions registered in this EventTrigger (deprecated). @@ -311,7 +402,7 @@ - The desired UnityEvent to be Invoked. + The desired TriggerEvent to be Invoked. @@ -321,105 +412,105 @@ - See IBeginDragHandler.OnBeginDrag. + Called before a drag is started. - + Current event data. - See ICancelHandler.OnCancel. + Called by the EventSystem when a Cancel event occurs. - + Current event data. - See IDeselectHandler.OnDeselect. + Called by the EventSystem when a new object is being selected. - + Current event data. - See IDragHandler.OnDrag. + Called by the EventSystem every time the pointer is moved during dragging. - + Current event data. - See IDropHandler.OnDrop. + Called by the EventSystem when an object accepts a drop. - + Current event data. - See See IBeginDragHandler.OnEndDrag. + Called by the EventSystem once dragging ends. - + Current event data. - Called by a BaseInputModule when a drag has been found but before it is valid to begin the drag. + Called by the EventSystem when a drag has been found, but before it is valid to begin the drag. - + Current event data. - See IMoveHandler.OnMove. + Called by the EventSystem when a Move event occurs. - + Current event data. - See IPointerClickHandler.OnPointerClick. + Called by the EventSystem when a Click event occurs. - + Current event data. - See IPointerDownHandler.OnPointerDown. + Called by the EventSystem when a PointerDown event occurs. - + Current event data. - See IPointerEnterHandler.OnPointerEnter. + Called by the EventSystem when the pointer enters the object associated with this EventTrigger. - + Current event data. - See IPointerExitHandler.OnPointerExit. + Called by the EventSystem when the pointer exits the object associated with this EventTrigger. - + Current event data. - See IPointerUpHandler.OnPointerUp. + Called by the EventSystem when a PointerUp event occurs. - + Current event data. - See IScrollHandler.OnScroll. + Called by the EventSystem when a Scroll event occurs. - + Current event data. - See ISelectHandler.OnSelect. + Called by the EventSystem when a Select event occurs. - + Current event data. - See ISubmitHandler.OnSubmit. + Called by the EventSystem when a Submit event occurs. - + Current event data. - See IUpdateSelectedHandler.OnUpdateSelected. + Called by the EventSystem when the object associated with this EventTrigger is updated. - + Current event data. @@ -646,7 +737,7 @@ - Starting the hierarchy (starting at root) for a GameObject that can handle <T> + Traverse the object hierarchy starting at root, and return the GameObject which implements the event handler of type <T>. Root GameObject. @@ -850,7 +941,7 @@ - + Called by the EventSystem when the object associated with this EventTrigger is updated. Current event data. @@ -921,6 +1012,14 @@ Logical and of Camera mask and eventMask. + + + Returns a ray going from camera through the event position and the distance between the near and far clipping planes along that ray. + + The pointer event for which we will cast a ray. + The ray. + The distance between the near and far clipping planes along the ray. + See: BaseRaycaster. @@ -1158,7 +1257,7 @@ - Seach the cache for currently active pointers, return true if found. + Search the cache for currently active pointers, return true if found. Touch ID. Found data. @@ -1226,7 +1325,7 @@ - A hit result from a BaseRaycastModule. + A hit result from a BaseRaycaster. @@ -1375,6 +1474,14 @@ The data pertaining to the current mouse state. + + + This method is called by Unity whenever a touch event is processed. Override this method with a custom implementation to process touch events yourself. + + Event data relating to the touch event, such as position and ID to be passed to the touch event destination object. + This is true for the first frame of a touch event, and false thereafter. This can therefore be used to determine the instant a touch event occurred. + This is true only for the last frame of a touch event. + Calculate and send a move event to the current selected object. @@ -1506,7 +1613,7 @@ - See MonoBehaviour.OnDidApplyAnimationProperties. + See UI.LayoutGroup.OnDidApplyAnimationProperties. @@ -1521,7 +1628,7 @@ - See MonoBehaviour.OnRectTransformDimensionsChange. + This callback is called if an associated RectTransform has its dimensions changed. The call is also made to all child rect transforms, even if the child transform itself doesn't change - as it could have, depending on its anchoring. @@ -1668,7 +1775,7 @@ - UnityEvent to be fired when the buttons is pressed. + UnityEvent that is triggered when the button is pressed. @@ -2641,14 +2748,14 @@ If you have modified the list of options, you should call this method afterwards Callback function when a UI element needs to generate vertices. Mesh to populate with UI data. - + VertexHelper utility. Callback function when a UI element needs to generate vertices. Mesh to populate with UI data. - + VertexHelper utility. @@ -2666,7 +2773,7 @@ If you have modified the list of options, you should call this method afterwards - When a GraphicRaycaster is raycasting into the scene it will first filter the elments using their RectTransform rect and then it will use this function to determine the elements hit mby the raycast. + When a GraphicRaycaster is raycasting into the scene it does two things. First it filters the elements using their RectTransform rect. Then it uses this Raycast function to determine the elements hit by the raycast. Screen point. Camera. @@ -2998,6 +3105,16 @@ If you have modified the list of options, you should call this method afterwards Abstract base class for HorizontalLayoutGroup and VerticalLayoutGroup. + + + Returns true if the Layout Group controls the heights of its children. Returns false if children control their own heights. + + + + + Returns true if the Layout Group controls the widths of its children. Returns false if children control their own widths. + + Whether to force the children to expand to fill additional available vertical space. @@ -3064,6 +3181,11 @@ Used if the native representation has been destroyed. Interface for elements that can be clipped if they are under an [[IClipper]. + + + GameObject of the IClippable. + + RectTransform of the clippable. @@ -3188,9 +3310,19 @@ Used if the native representation has been destroyed. Displays a Sprite for the UI System. + + + The alpha threshold specifies the minimum alpha a pixel must have for the event to considered a "hit" on the Image. + + + + + Cache of the default Canvas Ericsson Texture Compression 1 (ETC1) and alpha Material. + + - The alpha threshold specifying the minimum alpha a pixel must have for the event to be passed through. + The alpha threshold specifies the minimum alpha a pixel must have for the event to considered a "hit" on the Image. @@ -3243,6 +3375,11 @@ Used if the native representation has been destroyed. The image's texture. (ReadOnly). + + + The specified Material used by this Image. The default Material is used instead if one wasn't specified. + + See ILayoutElement.minHeight. @@ -3280,7 +3417,7 @@ Used if the native representation has been destroyed. - How the Image is draw. + How to display the image. @@ -3457,22 +3594,22 @@ Used if the native representation has been destroyed. - Display portion of the Image. + Displays only a portion of the Image. - Displayes the full Image. + Displays the full Image. - Displays the Image as a 9-sliced Image. + Displays the Image as a 9-sliced graphic. - Displays the Image Tiling the central part of the Sprite. + Displays a sliced Sprite with its resizable sections tiled instead of stretched. @@ -3627,7 +3764,7 @@ Used if the native representation has been destroyed. - This is an optional ‘empty’ graphic to show that InputField text field is empty. Note that this ‘empty' graphic still displays even when the InputField is selected (that is; when there is focus on it). + This is an optional ‘empty’ graphic to show that the InputField text field is empty. Note that this ‘empty' graphic still displays even when the InputField is selected (that is; when there is focus on it). A placeholder graphic can be used to show subtle hints or make it more obvious that the control is an InputField. @@ -3649,7 +3786,7 @@ A placeholder graphic can be used to show subtle hints or make it more obvious t - The the end point of the selection. + The end point of the selection. @@ -3768,7 +3905,7 @@ Characters 0-9, . (dot), and - (dash / minus sign) are allowed. The dash is only - The InputField is used for typing in a name and enforces capitalization. + The InputField is used for typing in a name, and enforces capitalization of the first letter of each word. Note that the user can circumvent the first letter capitalization rules by deleting automatically-capitalized letters. @@ -4132,6 +4269,15 @@ Characters 0-9, . (dot), and - (dash / minus sign) are allowed. The dash is only Called by the layout system. + + + Returns the alignment on the specified axis as a fraction where 0 is lefttop, 0.5 is middle, and 1 is rightbottom. + + The axis to get alignment along. 0 is horizontal and 1 is vertical. + + The alignment as a fraction where 0 is lefttop, 0.5 is middle, and 1 is rightbottom. + + Returns the calculated position of the first child layout element along the given axis. @@ -4407,7 +4553,7 @@ Characters 0-9, . (dot), and - (dash / minus sign) are allowed. The dash is only - A Graphic that is capable of being mased out. + A Graphic that is capable of being masked out. @@ -4479,6 +4625,7 @@ Characters 0-9, . (dot), and - (dash / minus sign) are allowed. The dash is only Find the correct RectMask2D for a given IClippable. Clippable to search from. + @@ -4494,6 +4641,16 @@ Characters 0-9, . (dot), and - (dash / minus sign) are allowed. The dash is only + + + Helper function to determine if the child is a descendant of father or is father. + + The transform to compare against. + The starting transform to search up the hierarchy. + + Is child equal to father or is a descendant. + + Notify all IClippables under the given component that they need to recalculate clipping. @@ -4518,27 +4675,27 @@ Characters 0-9, . (dot), and - (dash / minus sign) are allowed. The dash is only - Navitation mode. + Navigation mode. - Selectable to select on down. + Specify a Selectable UI GameObject to highlight when the down arrow key is pressed. - Selectable to select on left. + Specify a Selectable UI GameObject to highlight when the left arrow key is pressed. - Selectable to select on right. + Specify a Selectable UI GameObject to highlight when the right arrow key is pressed. - Selectable to select on up. + Specify a Selectable UI GameObject to highlight when the Up arrow key is pressed. @@ -4682,7 +4839,7 @@ Characters 0-9, . (dot), and - (dash / minus sign) are allowed. The dash is only - Coroutine function for handling continual press during OnPointerDown. + Coroutine function for handling continual press during Scrollbar.OnPointerDown. @@ -4770,6 +4927,18 @@ Characters 0-9, . (dot), and - (dash / minus sign) are allowed. The dash is only + + + Event triggered when pointer is pressed down on the scrollbar. + + + + + + Event triggered when pointer is released after pressing on the scrollbar. + + + Handling for when the canvas is rebuilt. @@ -4875,7 +5044,7 @@ Characters 0-9, . (dot), and - (dash / minus sign) are allowed. The dash is only - Callback executed when the scroll position of the slider is changed. + Callback executed when the position of the child changes. @@ -5065,11 +5234,28 @@ Characters 0-9, . (dot), and - (dash / minus sign) are allowed. The dash is only Called by the layout system. + + + Set the horizontal or vertical scroll position as a value between 0 and 1, with 0 being at the left or at the bottom. + + The position to set, between 0 and 1. + The axis to set: 0 for horizontal, 1 for vertical. + Sets the velocity to zero on both axes so the content stops moving. + + + Calculate the bounds the ScrollRect should be using. + + + + + Helper function to update the previous data fields on a ScrollRect. Call this before you change data in the ScrollRect. + + Simple selectable object - derived from to create a selectable control. @@ -5189,6 +5375,18 @@ Characters 0-9, . (dot), and - (dash / minus sign) are allowed. The dash is only UI.Selectable.IsInteractable. + + + Whether the current selectable is being pressed. + + + + + + Whether the current selectable is being pressed. + + + Unset selection and transition to appropriate state. @@ -5241,6 +5439,31 @@ Characters 0-9, . (dot), and - (dash / minus sign) are allowed. The dash is only Selects this Selectable. + + + An enumeration of selected states of objects. + + + + + The UI object cannot be selected. + + + + + The UI object is highlighted. + + + + + The UI object can be selected. + + + + + The UI object is pressed. + + Transition mode for a Selectable. diff --git a/Library/UnityAssemblies/UnityEngine.dll b/Library/UnityAssemblies/UnityEngine.dll index 975ef1c..cd500c3 100644 Binary files a/Library/UnityAssemblies/UnityEngine.dll and b/Library/UnityAssemblies/UnityEngine.dll differ diff --git a/Library/UnityAssemblies/UnityEngine.xml b/Library/UnityAssemblies/UnityEngine.xml index 57606e9..2957178 100644 --- a/Library/UnityAssemblies/UnityEngine.xml +++ b/Library/UnityAssemblies/UnityEngine.xml @@ -43,45171 +43,56646 @@ The path to the component. Where in the component menu to add the new item. - + - 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. + Enum mask of possible shader channel properties that can also be included when the Canvas mesh is created. - + - Global boolean for enabling or disabling the advertisement feature. + No additional shader parameters are needed. - + - Controls if the advertisement system should be initialized immediately on startup. + Include the normals on the mesh vertices. - + - Controls if testing advertisements are used instead of production advertisements. + Include the Tangent on the mesh vertices. - + - Gets the game identifier specified for a runtime platform. + Include UV1 on the mesh vertices. - - - The platform specific game identifier. - - + - Returns if a specific platform is enabled. + Include UV2 on the mesh vertices. - - - Boolean for the platform. - - + - Sets the game identifier for the specified platform. + Include UV3 on the mesh vertices. - - - + - Enable the specific platform. + Singleton class to access the baked NavMesh. - - - + - Parent class for all joints that have anchor points. + Describes how far in the future the agents predict collisions for avoidance. - + - The joint's anchor point on the object that has the joint component. + Set a function to be called before the NavMesh is updated during the frame update execution. - + - Should the connectedAnchor be calculated automatically? + The maximum amount of nodes processed each frame in the asynchronous pathfinding process. - + - The joint's anchor point on the second object (ie, the one which doesn't have the joint component). + Adds a link to the NavMesh. The link is described by the NavMeshLinkData struct. + Describing the properties of the link. + + Representing the added link. + - + - ActivityIndicator Style (Android Specific). + 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. + - + - Do not show ActivityIndicator. + Adds the specified NavMeshData to the game. + Contains the data for the navmesh. + + Representing the added navmesh. + - + - Large Inversed (android.R.attr.progressBarStyleLargeInverse). + 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. + - + - Small Inversed (android.R.attr.progressBarStyleSmallInverse). + Area mask constant that includes all NavMesh areas. - + - Large (android.R.attr.progressBarStyleLarge). + 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. + - + - Small (android.R.attr.progressBarStyleSmall). + 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. + - + - AndroidInput provides support for off-screen touch input, such as a touchpad. + Calculates triangulation of the current navmesh. - + - Property indicating whether the system provides secondary touch input. + Creates and returns a new entry of NavMesh build settings available for runtime NavMesh building. + + The created settings. + - + - Property indicating the height of the secondary touchpad. + 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. + - + - Property indicating the width of the secondary touchpad. + 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. + - + - Number of secondary touches. Guaranteed not to change throughout the frame. (Read Only). + Gets the cost for path finding over geometry of the area type. + Index of the area to get. - + - Returns object representing status of a specific touch on a secondary touchpad (Does not allocate temporary variables). + 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. + - + - AndroidJavaClass is the Unity representation of a generic instance of java.lang.Class. + Gets the cost for traversing over geometry of the layer type on all agents. + - + - Construct an AndroidJavaClass from the class name. + Returns the layer index for a named layer. - 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. + Returns an existing entry of NavMesh build settings. + The ID to look for. + + The settings found. + - + - Calls a Java method on an object (non-static). + Returns an existing entry of NavMesh build settings by its ordered index. - Specifies which method to call. - An array of parameters passed to the method. + The index to retrieve from. + + The found settings. + - + - Call a Java method on an object. + Returns the number of registered NavMesh build settings. - Specifies which method to call. - An array of parameters passed to the method. + + The number of registered entries. + - + - Call a static Java method on a class. + Returns the name associated with the NavMesh build settings matching the provided agent type ID. - Specifies which method to call. - An array of parameters passed to the method. + The ID to look for. + + The name associated with the ID found. + - + - Call a static Java method on a class. + A delegate which can be used to register callback methods to be invoked before the NavMesh system updates. - Specifies which method to call. - An array of parameters passed to the method. - + - Construct an AndroidJavaObject based on the name of the class. + Trace a line between two points on the NavMesh. - Specifies the Java class name (e.g. "<tt>java.lang.String<tt>" or "<tt>javalangString<tt>"). - An array of parameters passed to the constructor. + 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. + - + - IDisposable callback. + 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. + - + - Get the value of a field in an object (non-static). + Removes a link from the NavMesh. - The name of the field (e.g. int counter; would have fieldName = "counter"). + The instance of a link to remove. - + - Retrieve the raw jclass pointer to the Java class. + Removes the specified NavMeshDataInstance from the game, making it unavailable for agents and queries. + The instance of a NavMesh to remove. - + - Retrieve the raw jobject pointer to the Java object. + Removes the build settings matching the agent type ID. + The ID of the entry to remove. - + - Get the value of a static field in an object type. + Finds the closest point on NavMesh within specified range. - The name of the field (e.g. <i>int counter;</i> would have fieldName = "counter"). + 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. + - + - Set the value of a field in an object (non-static). + Samples the position closest to sourcePosition - on any NavMesh built for the agent type specified by the filter. - 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. + 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. + - + - Set the value of a static field in an object type. + Sets the cost for finding path over geometry of the area type on all agents. - 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. + Index of the area to set. + New cost. - + - 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. + Sets the cost for traversing over geometry of the layer type on all agents. + + - + - Java interface implemented by the proxy. + Navigation mesh agent. - + - + The maximum acceleration of an agent as it follows a path, given in units / sec^2. - Java interface to be implemented by the proxy. - + - + The type ID for the agent. - 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. + Maximum turning speed in (deg/s) while following a path. - 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. + Specifies which NavMesh areas are passable. Changing areaMask will make the path stale (see isPathStale). - 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. + Should the agent brake automatically to avoid overshooting the destination point? - + - 'Raw' JNI interface to Android Dalvik (Java) VM from Mono (CS/JS). + Should the agent attempt to acquire a new path if the existing path becomes invalid? - + - Allocates a new Java object without invoking any of the constructors for the object. + Should the agent move across OffMeshLinks automatically? - - + - Attaches the current thread to a Java (Dalvik) VM. + The avoidance priority level. - + - Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + The relative vertical displacement of the owning GameObject. - - - - + - Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + The current OffMeshLinkData. - - - - + - Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + The desired velocity of the agent including any potential contribution from avoidance. (Read Only) - - - - + - Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + Gets or attempts to set the destination of the agent in world-space units. - - - - + - Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + Does the agent currently have a path? (Read Only) - - - - + - Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + The height of the agent for purposes of passing under obstacles, etc. - - - - + - Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + Is the agent currently bound to the navmesh? (Read Only) - - - - + - Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + Is the agent currently positioned on an OffMeshLink? (Read Only) - - - - + - Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + Is the current path stale. (Read Only) - - - - + - 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. + This property holds the stop or resume condition of the NavMesh agent. - - - - + - 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. + Returns the owning object of the NavMesh the agent is currently placed on (Read Only). - - - - + - 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. + The next OffMeshLinkData on the current path. - - - - + - 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. + Gets or sets the simulation position of the navmesh agent. - - - - + - 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. + The level of quality of avoidance. - - - - + - 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. + Property to get and set the current path. - - - - + - 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. + Is a path in the process of being computed but not yet ready? (Read Only) - - - - + - 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. + The status of the current path (complete, partial or invalid). - - - - + - 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. + The avoidance radius for the agent. - - - - + - 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. + The distance between the agent's position and the destination on the current path. (Read Only) - - - - + - 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. + Maximum movement speed when following a path. - - - - + - Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + Get the current steering target along the path. (Read Only) - - - - + - Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + Stop within this distance from the target position. - - - - + - Deletes the global reference pointed to by <tt>obj</tt>. + Gets or sets whether the transform position is synchronized with the simulated agent position. The default value is true. - - + - Deletes the local reference pointed to by <tt>obj</tt>. + Should the agent update the transform orientation? - - + - Detaches the current thread from a Java (Dalvik) VM. + Allows you to specify whether the agent should be aligned to the up-axis of the NavMesh or link that it is placed on. - + - Ensures that at least a given number of local references can be created in the current thread. + Access the current velocity of the NavMeshAgent component, or set a velocity to control the agent manually. - - + - Clears any exception that is currently being thrown. + Specifies which NavMesh layers are passable (bitfield). Changing walkableMask will make the path stale (see isPathStale). - + - Prints an exception and a backtrace of the stack to the <tt>logcat</tt> + Enables or disables the current off-mesh link. + Is the link activated? - + - Determines if an exception is being thrown. + 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. + - + - Raises a fatal error and does not expect the VM to recover. This function does not return. + Completes the movement on the current OffMeshLink. - - + - This function loads a locally-defined class. + Locate the closest NavMesh edge. - + Holds the properties of the resulting location. + + True if a nearest edge is found. + - + - Convert a Java array of <tt>boolean</tt> to a managed array of System.Boolean. + Gets the cost for path calculation when crossing area of a particular type. - + Area Index. + + Current cost for specified area index. + - + - Convert a Java array of <tt>byte</tt> to a managed array of System.Byte. + Gets the cost for crossing ground of a particular type. - + Layer index. + + Current cost of specified layer. + - + - Convert a Java array of <tt>char</tt> to a managed array of System.Char. + Apply relative movement to current position. - + The relative movement vector. - + - Convert a Java array of <tt>double</tt> to a managed array of System.Double. + 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. + - + - Convert a Java array of <tt>float</tt> to a managed array of System.Single. + Clears the current path. - - + - Convert a Java array of <tt>int</tt> to a managed array of System.Int32. + Resumes the movement along the current path after a pause. - - + - Convert a Java array of <tt>long</tt> to a managed array of System.Int64. + 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. + - + - Convert a Java array of <tt>java.lang.Object</tt> to a managed array of System.IntPtr, representing Java objects. + Sets the cost for traversing over areas of the area type. - + Area cost. + New cost for the specified area index. - + - Converts a <tt>java.lang.reflect.Field</tt> to a field ID. + 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. + - + - Converts a <tt>java.lang.reflect.Method<tt> or <tt>java.lang.reflect.Constructor<tt> object to a method ID. + Sets the cost for traversing over geometry of the layer type. - + Layer index. + New cost for the specified layer. - + - Convert a Java array of <tt>short</tt> to a managed array of System.Int16. + Assign a new path to this agent. - + New path to follow. + + True if the path is succesfully assigned. + - + - Returns the number of elements in the array. + Stop movement of this agent along its current path. - - + - Returns the value of one element of a primitive array. + Warps agent to the provided position. - - + New position to warp the agent to. + + True if agent is successfully warped, otherwise false. + - + - This function returns the value of an instance (nonstatic) field of an object. + Navigation mesh builder interface. - - - + - Returns the value of one element of a primitive array. + Builds a NavMesh data object from the provided input sources. - - + 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. + - + - This function returns the value of an instance (nonstatic) field of an object. + Cancels an asynchronous update of the specified NavMesh data. See Also: UpdateNavMeshDataAsync. - - + The data associated with asynchronous updating. - + - Returns the value of one element of a primitive array. + Collects renderers or physics colliders, and terrains within a volume. - - + 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. - + - This function returns the value of an instance (nonstatic) field of an object. + Collects renderers or physics colliders, and terrains within a transform hierarchy. - - + 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. - + - Returns the value of one element of a primitive array. + Incrementally updates the NavMeshData based on the sources. - - + 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. Empty bounds is treated as no-bounds, that is, the NavMesh will cover all the inputs. + + Returns true if the update was successful. + - + - This function returns the value of an instance (nonstatic) field of an object. + Asynchronously and incrementally updates the NavMeshData based on the sources. - - + 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. Empty bounds is treated as no-bounds, that is, the NavMesh will cover all the inputs. + + Can be used to check the progress of the update. + - + - Returns the field ID for an instance (nonstatic) field of a class. + The NavMesh build markup allows you to control how certain objects are treated during the NavMesh build process, specifically when collecting sources for building. - - - - + - Returns the value of one element of a primitive array. + The area type to use when override area is enabled. - - - + - This function returns the value of an instance (nonstatic) field of an object. + Use this to specify whether the GameObject and its children should be ignored. - - - + - Returns the value of one element of a primitive array. + 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. - - - + - This function returns the value of an instance (nonstatic) field of an object. + Use this to specify which GameObject (including the GameObject’s children) the markup should be applied to. - - - + - Returns the value of one element of a primitive array. + The NavMeshBuildSettings struct allows you to specify a collection of settings which describe the dimensions and limitations of a particular agent type. - - - + - This function returns the value of an instance (nonstatic) field of an object. + The maximum vertical step size an agent can take. - - - + - Returns the method ID for an instance (nonstatic) method of a class or interface. + The height of the agent for baking in world units. - - - - + - Returns an element of an <tt>Object</tt> array. + The radius of the agent for baking in world units. - - - + - Returns the class of an object. + The maximum slope angle which is walkable (angle in degrees). - - + - This function returns the value of an instance (nonstatic) field of an object. + The agent type ID the NavMesh will be baked for. - - - + - Returns the value of one element of a primitive array. + Enables overriding the default tile size. See Also: tileSize. - - - + - This function returns the value of an instance (nonstatic) field of an object. + Enables overriding the default voxel size. See Also: voxelSize. - - - + - This function returns the value of a static field of an object. + Sets the tile size in voxel units. - - - + - This function returns the value of a static field of an object. + Sets the voxel size in world length units. - - - + - This function returns the value of a static field of an object. + Validates the properties of NavMeshBuildSettings. - - + Describes the volume to build NavMesh for. + + The list of violated constraints. + - + - This function returns the value of a static field of an object. + The input to the NavMesh builder is a list of NavMesh build sources. - - - + - Returns the field ID for a static field of a class. + Describes the area type of the NavMesh surface for this object. - - - - + - This function returns the value of a static field of an object. + Points to the owning component - if available, otherwise null. - - - + - This function returns the value of a static field of an object. + The type of the shape this source describes. See Also: NavMeshBuildSourceShape. - - - + - This function returns the value of a static field of an object. + Describes the dimensions of the shape. - - - + - Returns the method ID for a static method of a class. + Describes the object referenced for Mesh and Terrain types of input sources. - - - - + - This function returns the value of a static field of an object. + Describes the local to world transformation matrix of the build source. That is, position and orientation and scale of the shape. - - - + - This function returns the value of a static field of an object. + Used with NavMeshBuildSource to define the shape for building NavMesh. - - - + - This function returns the value of a static field of an object. + Describes a box primitive for use with NavMeshBuildSource. - - - + - This function returns the value of an instance (nonstatic) field of an object. + Describes a capsule primitive for use with NavMeshBuildSource. - - - + - Returns a managed string object representing the string in modified UTF-8 encoding. + Describes a Mesh source for use with NavMeshBuildSource. - - + - Returns the length in bytes of the modified UTF-8 representation of a string. + Describes a ModifierBox source for use with NavMeshBuildSource. - - + - 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>. + Describes a sphere primitive for use with NavMeshBuildSource. - - + - Returns the version of the native method interface. + Describes a TerrainData source for use with NavMeshBuildSource. - + - Determines whether an object of <tt>clazz1<tt> can be safely cast to <tt>clazz2<tt>. + Used for specifying the type of geometry to collect. Used with NavMeshBuilder.CollectSources. - - - + - Tests whether an object is an instance of a class. + Collect geometry from the 3D physics collision representation. - - - + - Tests whether two references refer to the same Java object. + Collect meshes form the rendered geometry. - - - + - Construct a new primitive array object. + Contains and represents NavMesh data. - - + - Construct a new primitive array object. + Gets or sets the world space position of the NavMesh data. - - + - Construct a new primitive array object. + Gets or sets the orientation of the NavMesh data. - - + - Construct a new primitive array object. + Returns the bounding volume of the input geometry used to build this NavMesh (Read Only). - - + - Construct a new primitive array object. + Constructs a new object for representing a NavMesh for the default agent type. - - + - Creates a new global reference to the object referred to by the <tt>obj</tt> argument. + Constructs a new object representing a NavMesh for the specified agent type. - + The agent type ID to create a NavMesh for. - + - Construct a new primitive array object. + The instance is returned when adding NavMesh data. - - + - Creates a new local reference that refers to the same object as <tt>obj</tt>. + Get or set the owning Object. - - + - Construct a new primitive array object. + True if the NavMesh data is added to the navigation system - otherwise false (Read Only). - - + - 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. + Removes this instance from the NavMesh system. - - - - + - Constructs a new array holding objects in class <tt>clazz<tt>. All elements are initially set to <tt>obj<tt>. + Result information for NavMesh queries. - - - - + - Construct a new primitive array object. + Distance to the point of hit. - - + - Constructs a new <tt>java.lang.String</tt> object from an array of characters in modified UTF-8 encoding. + Flag set when hit. - - + - 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. + Mask specifying NavMesh area at point of hit. - - + - Creates a new local reference frame, in which at least a given number of local references can be created. + Normal at the point of hit. - - + - Sets the value of one element in a primitive array. + Position of hit. - - - - + - This function sets the value of an instance (nonstatic) field of an object. + Used for runtime manipulation of links connecting polygons of the NavMesh. - - - - + - Sets the value of one element in a primitive array. + Specifies which agent type this link is available for. - - - - + - This function sets the value of an instance (nonstatic) field of an object. + Area type of the link. - - - - + - Sets the value of one element in a primitive array. + If true, the link can be traversed in both directions, otherwise only from start to end position. - - - - + - This function sets the value of an instance (nonstatic) field of an object. + If positive, overrides the pathfinder cost to traverse the link. - - - - + - Sets the value of one element in a primitive array. + End position of the link. - - - - + - This function sets the value of an instance (nonstatic) field of an object. + Start position of the link. - - - - + - Sets the value of one element in a primitive array. + If positive, the link will be rectangle aligned along the line from start to end. - - - - + - This function sets the value of an instance (nonstatic) field of an object. + An instance representing a link available for pathfinding. - - - - + - Sets the value of one element in a primitive array. + Get or set the owning Object. - - - - + - This function sets the value of an instance (nonstatic) field of an object. + True if the NavMesh link is added to the navigation system - otherwise false (Read Only). - - - - + - Sets the value of one element in a primitive array. + Removes this instance from the game. - - - - + - This function sets the value of an instance (nonstatic) field of an object. + An obstacle for NavMeshAgents to avoid. - - - - + - Sets an element of an <tt>Object</tt> array. + Should this obstacle be carved when it is constantly moving? - - - - + - This function sets the value of an instance (nonstatic) field of an object. + Should this obstacle make a cut-out in the navmesh. - - - - + - Sets the value of one element in a primitive array. + Threshold distance for updating a moving carved hole (when carving is enabled). - - - - + - This function sets the value of an instance (nonstatic) field of an object. + Time to wait until obstacle is treated as stationary (when carving and carveOnlyStationary are enabled). - - - - + - This function ets the value of a static field of an object. + The center of the obstacle, measured in the object's local space. - - - - + - This function ets the value of a static field of an object. + Height of the obstacle's cylinder shape. - - - - + - This function ets the value of a static field of an object. + Radius of the obstacle's capsule shape. - - - - + - This function ets the value of a static field of an object. + The shape of the obstacle. - - - - + - This function ets the value of a static field of an object. + The size of the obstacle, measured in the object's local space. - - - - + - This function ets the value of a static field of an object. + Velocity at which the obstacle moves around the NavMesh. - - - - + - This function ets the value of a static field of an object. + Shape of the obstacle. - - - - + - This function ets the value of a static field of an object. + Box shaped obstacle. - - - - + - This function ets the value of a static field of an object. + Capsule shaped obstacle. - - - - + - This function ets the value of a static field of an object. + A path as calculated by the navigation system. - - - - + - This function sets the value of an instance (nonstatic) field of an object. + Corner points of the path. (Read Only) - - - - + - Causes a <tt>java.lang.Throwable</tt> object to be thrown. + Status of the path. (Read Only) - - + - Constructs an exception object from the specified class with the <tt>message</tt> specified by message and causes that exception to be thrown. + Erase all corner points from path. - - - + - Convert a managed array of System.Boolean to a Java array of <tt>boolean</tt>. + NavMeshPath constructor. - - + - Convert a managed array of System.Byte to a Java array of <tt>byte</tt>. + Calculate the corners for the path. - + Array to store path corners. + + The number of corners along the path - including start and end points. + - + - Convert a managed array of System.Char to a Java array of <tt>char</tt>. + Status of path. - - + - Convert a managed array of System.Double to a Java array of <tt>double</tt>. + The path terminates at the destination. - - + - Convert a managed array of System.Single to a Java array of <tt>float</tt>. + The path is invalid. - - + - Convert a managed array of System.Int32 to a Java array of <tt>int</tt>. + The path cannot reach the destination. - - + - Convert a managed array of System.Int64 to a Java array of <tt>long</tt>. + Specifies which agent type and areas to consider when searching the NavMesh. - - + - Convert a managed array of System.IntPtr, representing Java objects, to a Java array of <tt>java.lang.Object</tt>. + The agent type ID, specifying which navigation meshes to consider for the query functions. - - + - Converts a field ID derived from cls to a <tt>java.lang.reflect.Field</tt> object. + A bitmask representing the traversable area types. - - - - + - Converts a method ID derived from clazz to a <tt>java.lang.reflect.Method<tt> or <tt>java.lang.reflect.Constructor<tt> object. + 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. + - + - Convert a managed array of System.Int16 to a Java array of <tt>short</tt>. + 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. - + - Helper interface for JNI interaction; signature creation and method lookups. + Contains data describing a triangulation of a navmesh. - + - Set debug to true to log calls through the AndroidJNIHelper. + NavMesh area indices for the navmesh triangulation. - + - Creates a managed array from a Java array. + Triangle indices for the navmesh triangulation. - Java array object to be converted into a managed array. - + - Creates a Java array from a managed array. + NavMeshLayer values for the navmesh triangulation. - Managed array to be converted into a Java array object. - + - Creates a java proxy object which connects to the supplied proxy implementation. + Vertices for the navmesh triangulation. - An implementatinon of a java interface in c#. - + - Creates a UnityJavaRunnable object (implements java.lang.Runnable). + Level of obstacle avoidance. - 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. + Good avoidance. High performance impact. - An array of objects that should be converted to Call parameters. - + - Deletes any local jni references previously allocated by CreateJNIArgArray(). + Enable highest precision. Highest performance impact. - 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. + Enable simple avoidance. Low performance impact. - 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. + Medium avoidance. Medium performance impact. - 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. + Disable avoidance. - 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. + Link allowing movement outside the planar navigation mesh. - 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. + Is link active. - 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. + NavMesh area index for this OffMeshLink component. - 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. + Automatically update endpoints. - 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. + Can link be traversed in both directions. - 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. + Modify pathfinding cost for the link. - 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. + The transform representing link end position. - 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. + NavMeshLayer for this OffMeshLink component. - 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. + Is link occupied. (Read Only) - 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. + The transform representing link start position. - Object for which a signature is to be produced. - + - Creates the JNI signature string for an object parameter list. + Explicitly update the link endpoints. - Array of object for which a signature is to be produced. - + - Creates the JNI signature string for an object parameter list. + State of OffMeshLink. - Array of object for which a signature is to be produced. - + - The animation component is used to play back animations. + Is link active (Read Only). - + - When turned on, Unity might stop animating if it thinks that the results of the animation won't be visible to the user. + Link end world position (Read Only). - + - When turned on, animations will be executed in the physics loop. This is only useful in conjunction with kinematic rigidbodies. + Link type specifier (Read Only). - + - The default animation. + The OffMeshLink if the link type is a manually placed Offmeshlink (Read Only). - + - Controls culling of this Animation component. + Link start world position (Read Only). - + - Are we playing any animations? + Is link valid (Read Only). - + - AABB of this Animation animation component in local space. + Link type specifier. - + - Should the default animation clip (the Animation.clip property) automatically start playing on startup? + Vertical drop. - + - How should time beyond the playback range of the clip be treated? + Horizontal jump. - + - Adds a clip to the animation with name newName. + Manually specified type of link. - - - + - Adds clip to the only play between firstFrame and lastFrame. The new clip will also be added to the animation with name newName. + Unity Analytics provides insight into your game users e.g. DAU, MAU. - 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. + Controls whether the sending of device stats at runtime is enabled. - 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. + Controls whether the Analytics service is enabled at runtime. - - - - + - Blends the animation named animation towards targetWeight over the next time seconds. + Controls whether to limit user tracking at runtime. - - - - + - Blends the animation named animation towards targetWeight over the next time seconds. + 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. - + - Fades the animation with name animation in over a period of time seconds and fades other animations out. + Custom Events (optional). - - - + - + - Fades the animation with name animation in over a period of time seconds and fades other animations out. + Custom Events (optional). - - - + + - + - Fades the animation with name animation in over a period of time seconds and fades other animations out. + Attempts to flush immediately all queued analytics events to the network and filesystem cache if possible (optional). - - - - + - Cross fades an animation after previous animations has finished playing. + User Demographics (optional). - - - - + Birth year of user. Must be 4-digit year format, only. - + - Cross fades an animation after previous animations has finished playing. + User Demographics (optional). - - - - + Gender of user can be "Female", "Male", or "Unknown". - + - Cross fades an animation after previous animations has finished playing. + User Demographics (optional). - - - - + User id. - + - Cross fades an animation after previous animations has finished playing. + 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. - + - Get the number of clips currently assigned to this animation. + 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. - + - Is the animation named name playing? + 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. - + - Plays an animation without any blending. + Analytics API result. - - - + - Plays an animation without any blending. + Analytics API result: Analytics is disabled. - - - + - Plays an animation without any blending. + Analytics API result: Invalid argument value. - - - + - Plays an animation without any blending. + Analytics API result: Analytics not initialized. - - - + - Plays an animation after previous animations has finished playing. + Analytics API result: Success. - - - - + - Plays an animation after previous animations has finished playing. + Analytics API result: Argument size limit. - - - - + - Plays an animation after previous animations has finished playing. + Analytics API result: Too many parameters. - - - - + - Remove clip from the animation list. + Analytics API result: Too many requests. - - + - Remove clip from the animation list. + Analytics API result: This platform doesn't support Analytics. - - + - Rewinds the animation named name. + User Demographics: Gender of a user. - - + - Rewinds all animations. + User Demographics: Female Gender of a user. - + - Samples animations at the current state. + User Demographics: Male Gender of a user. - + - Stops all playing animations that were started with this Animation. + User Demographics: Unknown Gender of a user. - + - Stops an animation named name. + Unity Performace provides insight into your game performace. - - + - Returns the animation state named name. + Controls whether the Performance Reporting service is enabled at runtime. - + - Used by Animation.Play function. + Parent class for all joints that have anchor points. - + - Animations will be added. + The joint's anchor point on the object that has the joint component. - + - Animations will be blended. + Should the connectedAnchor be calculated automatically? - + - Stores keyframe based animations. + The joint's anchor point on the second object (ie, the one which doesn't have the joint component). - + - Animation Events for this animation clip. + ActivityIndicator Style (Android Specific). - + - Frame rate at which keyframes are sampled. (Read Only) + Do not show ActivityIndicator. - + - Returns true if the animation contains curve that drives a humanoid rig. + Large Inversed (android.R.attr.progressBarStyleLargeInverse). - + - Set to true if the AnimationClip will be used with the Legacy Animation component ( instead of the Animator ). + Small Inversed (android.R.attr.progressBarStyleSmallInverse). - + - Animation length in seconds. (Read Only) + Large (android.R.attr.progressBarStyleLarge). - + - AABB of this Animation Clip in local space of Animation component that it is attached too. + Small (android.R.attr.progressBarStyleSmall). - + - Sets the default wrap mode used in the animation state. + AndroidInput provides support for off-screen touch input, such as a touchpad. - + - Adds an animation event to the clip. + Property indicating whether the system provides secondary touch input. - AnimationEvent to add. - + - Clears all curves from the clip. + Property indicating the height of the secondary touchpad. - + - Creates a new animation clip. + Property indicating the width of the secondary touchpad. - + - In order to insure better interpolation of quaternions, call this function after you are finished setting animation curves. + Number of secondary touches. Guaranteed not to change throughout the frame. (Read Only). - + - Samples an animation at a given time for any animated properties. + Returns object representing status of a specific touch on a secondary touchpad (Does not allocate temporary variables). - The animated game object. - The time to sample an animation. + - + - Assigns the curve to animate a specific property. + AndroidJavaClass is the Unity representation of a generic instance of java.lang.Class. - Path to the game object this curve applies to. 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. + Construct an AndroidJavaClass from the class name. + Specifies the Java class name (e.g. <tt>java.lang.String</tt>). - + - The original clip from the controller. + AndroidJavaObject is the Unity representation of a generic instance of java.lang.Object. - + - The override animation clip. + Calls a Java method on an object (non-static). + Specifies which method to call. + An array of parameters passed to the method. - + - This enum controlls culling of Animation component. + Call a Java method on an object. + Specifies which method to call. + An array of parameters passed to the method. - + - Animation culling is disabled - object is animated even when offscreen. + Call a static Java method on a class. + Specifies which method to call. + An array of parameters passed to the method. - + - Animation is disabled when renderers are not visible. + Call a static Java method on a class. + Specifies which method to call. + An array of parameters passed to the method. - + - A collection of curves form an AnimationClip. + 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. - + - All keys defined in the animation curve. + IDisposable callback. - + - The number of keys in the curve. (Read Only) + Get the value of a field in an object (non-static). + The name of the field (e.g. int counter; would have fieldName = "counter"). - + - The behaviour of the animation after the last keyframe. + 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. - + - The behaviour of the animation before the first keyframe. + 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. - + - Add a new key to the curve. + Get the value of a static field in an object type. - 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. - + The name of the field (e.g. <i>int counter;</i> would have fieldName = "counter"). - + - Add a new key to the curve. + Set the value of a field in an object (non-static). - The key to add to the curve. - - The index of the added key, or -1 if the key could not be added. - + 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. - + - Creates an animation curve from arbitrary number of keyframes. + 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. - + - Creates an empty animation curve. + 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. - + - Creates an ease-in and out curve starting at timeStart, valueStart and ending at timeEnd, valueEnd. + Java interface implemented by the proxy. - 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. - + Java interface to be implemented by the proxy. - + - 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 (straight) curve created from the values specified. - + Java interface to be implemented by the proxy. - + - Removes the keyframe at index and inserts key. + 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. - The index of the key to move. - The key (with its new time) to insert. - - The index of the keyframe after moving it. - + 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. - + - Removes a key. + 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. - The index of the key to remove. + 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. - + - Smooth the in and out tangents of the keyframe at index. + AndroidJavaRunnable is the Unity representation of a java.lang.Runnable object. - 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) + '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. - + - AnimationEvent lets you call a script function similar to SendMessage as part of playing back an animation. + Allocates a new Java object without invoking any of the constructors for the object. + - + - The animation state that fired this event (Read Only). + Attaches the current thread to a Java (Dalvik) VM. - + - The animator clip info related to this event (Read Only). + Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + - + - The animator state info related to this event (Read Only). + Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + - + - Float parameter that is stored in the event and will be sent to the function. + Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + - + - The name of the function that will be called. + Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + - + - Int parameter that is stored in the event and will be sent to the function. + Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + - + - Returns true if this Animation event has been fired by an Animator component. + Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + - + - Returns true if this Animation event has been fired by an Animation component. + Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + - + - Function call options. + Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + - + - Object reference parameter that is stored in the event and will be sent to the function. + Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + - + - String parameter that is stored in the event and will be sent to the function. + 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. + + + - + - The time at which the event will be fired off. + 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. + + + - + - Creates a new animation event. + 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. + + + - + - Information about what animation clips is played and its weight. + 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. + + + - + - Animation clip that is played. + 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. + + + - + - The weight of the animation clip. + 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. + + + - + - The AnimationState gives full control over animation blending. + 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. + + + - + - Which blend mode should be used? + 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. + + + - + - The clip that is being played by this animation state. + 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. + + + - + - Enables / disables the animation. + 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. + + + - + - The length of the animation clip in seconds. + 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. + + + - + - The name of the animation. + Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + - + - The normalized playback speed. + Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method. + + + - + - The normalized time of the animation. + Deletes the global reference pointed to by <tt>obj</tt>. + - + - The playback speed of the animation. 1 is normal playback speed. + Deletes the local reference pointed to by <tt>obj</tt>. + - + - The current time of the animation. + Detaches the current thread from a Java (Dalvik) VM. - + - The weight of animation. + Ensures that at least a given number of local references can be created in the current thread. + - + - Wrapping mode of the animation. + Clears any exception that is currently being thrown. - + - Adds a transform which should be animated. This allows you to reduce the number of animations you have to create. + Prints an exception and a backtrace of the stack to the <tt>logcat</tt> - 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. + Determines if an exception is being thrown. - The transform to animate. - Whether to also animate all children of the specified transform. - + - Removes a transform which should be animated. + Raises a fatal error and does not expect the VM to recover. This function does not return. - + - + - Interface to control the Mecanim animation system. + This function loads a locally-defined class. + - + - Gets the avatar angular velocity for the last evaluated frame. + Convert a Java array of <tt>boolean</tt> to a managed array of System.Boolean. + - + - When turned on, animations will be executed in the physics loop. This is only useful in conjunction with kinematic rigidbodies. + Convert a Java array of <tt>byte</tt> to a managed array of System.Byte. + - + - Should root motion be applied? + Convert a Java array of <tt>char</tt> to a managed array of System.Char. + - + - Gets/Sets the current Avatar. + Convert a Java array of <tt>double</tt> to a managed array of System.Double. + - + - The position of the body center of mass. + Convert a Java array of <tt>float</tt> to a managed array of System.Single. + - + - The rotation of the body center of mass. + Convert a Java array of <tt>int</tt> to a managed array of System.Int32. + - + - Controls culling of this Animator component. + Convert a Java array of <tt>long</tt> to a managed array of System.Int64. + - + - Gets the avatar delta position for the last evaluated frame. + Convert a Java array of <tt>java.lang.Object</tt> to a managed array of System.IntPtr, representing Java objects. + - + - Gets the avatar delta rotation for the last evaluated frame. + Converts a <tt>java.lang.reflect.Field</tt> to a field ID. + - + - Blends pivot point between body center of mass and feet pivot. At 0%, the blending point is body center of mass. At 100%, the blending point is feet pivot. + Converts a <tt>java.lang.reflect.Method<tt> or <tt>java.lang.reflect.Constructor<tt> object to a method ID. + - + - The current gravity weight based on current animations that are played. + Convert a Java array of <tt>short</tt> to a managed array of System.Int16. + - + - Returns true if the current rig has root motion. + Returns the number of elements in the array. + - + - Returns true if the object has a transform hierarchy. + Returns the value of one element of a primitive array. + + - + - Returns the scale of the current Avatar for a humanoid rig, (1 by default if the rig is generic). + This function returns the value of an instance (nonstatic) field of an object. + + - + - Returns true if the current rig is humanoid, false if it is generic. + Returns the value of one element of a primitive array. + + - + - Returns whether the animator is initialized successfully. + This function returns the value of an instance (nonstatic) field of an object. + + - + - If automatic matching is active. + Returns the value of one element of a primitive array. + + - + - Returns true if the current rig is optimizable with AnimatorUtility.OptimizeTransformHierarchy. + This function returns the value of an instance (nonstatic) field of an object. + + - + - See IAnimatorControllerPlayable.layerCount. + Returns the value of one element of a primitive array. + + - + - Additional layers affects the center of mass. + This function returns the value of an instance (nonstatic) field of an object. + + - + - Get left foot bottom height. + Returns the field ID for an instance (nonstatic) field of a class. + + + - + - When linearVelocityBlending is set to true, the root motion velocity and angular velocity will be blended linearly. + Returns the value of one element of a primitive array. + + - + - See IAnimatorControllerPlayable.parameterCount. + This function returns the value of an instance (nonstatic) field of an object. + + - + - Read only acces to the AnimatorControllerParameters used by the animator. + Returns the value of one element of a primitive array. + + - + - Get the current position of the pivot. + This function returns the value of an instance (nonstatic) field of an object. + + - + - Gets the pivot weight. + Returns the value of one element of a primitive array. + + - + - Sets the playback position in the recording buffer. + This function returns the value of an instance (nonstatic) field of an object. + + - + - Gets the mode of the Animator recorder. + Returns the method ID for an instance (nonstatic) method of a class or interface. + + + - + - Start time of the first frame of the buffer relative to the frame at which StartRecording was called. + Returns an element of an <tt>Object</tt> array. + + - + - End time of the recorded clip relative to when StartRecording was called. + Returns the class of an object. + - + - Get right foot bottom height. + This function returns the value of an instance (nonstatic) field of an object. + + - + - The root position, the position of the game object. + Returns the value of one element of a primitive array. + + - + - The root rotation, the rotation of the game object. + This function returns the value of an instance (nonstatic) field of an object. + + - + - The runtime representation of AnimatorController that controls the Animator. + This function returns the value of a static field of an object. + + - + - The playback speed of the Animator. 1 is normal playback speed. + This function returns the value of a static field of an object. + + - + - Automatic stabilization of feet during transition and blending. + This function returns the value of a static field of an object. + + - + - Returns the position of the target specified by SetTarget(AvatarTarget targetIndex, float targetNormalizedTime)). + This function returns the value of a static field of an object. + + - + - Returns the rotation of the target specified by SetTarget(AvatarTarget targetIndex, float targetNormalizedTime)). + Returns the field ID for a static field of a class. + + + - + - Specifies the update mode of the Animator. + This function returns the value of a static field of an object. + + - + - Gets the avatar velocity for the last evaluated frame. + This function returns the value of a static field of an object. + + - + - Apply the default Root Motion. + This function returns the value of a static field of an object. + + - + - See IAnimatorControllerPlayable.CrossFade. + Returns the method ID for a static method of a class. - - - - - + + + - + - See IAnimatorControllerPlayable.CrossFade. + This function returns the value of a static field of an object. - - - - - + + - + - See IAnimatorControllerPlayable.CrossFadeInFixedTime. + This function returns the value of a static field of an object. - - - - - + + - + - See IAnimatorControllerPlayable.CrossFadeInFixedTime. + This function returns the value of a static field of an object. - - - - - + + - + - See IAnimatorControllerPlayable.GetAnimatorTransitionInfo. + This function returns the value of an instance (nonstatic) field of an object. - + + - + - Return the first StateMachineBehaviour that match type T or derived from T. Return null if none are found. + Returns a managed string object representing the string in modified UTF-8 encoding. + - + - Returns all StateMachineBehaviour that match type T or are derived from T. Returns null if none are found. + Returns the length in bytes of the modified UTF-8 representation of a string. + - + - Returns transform mapped to this human bone id. + 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>. - The human bone that is queried, see enum HumanBodyBones for a list of possible values. + - + - See IAnimatorControllerPlayable.GetBool. + Returns the version of the native method interface. - - - + - See IAnimatorControllerPlayable.GetBool. + Determines whether an object of <tt>clazz1<tt> can be safely cast to <tt>clazz2<tt>. - - + + - + - Gets the list of AnimatorClipInfo currently played by the current state. + Tests whether an object is an instance of a class. - The layer's index. + + - + - See IAnimatorControllerPlayable.GetCurrentAnimatorClipInfo. + Tests whether two references refer to the same Java object. - + + - + - See IAnimatorControllerPlayable.GetCurrentAnimatorStateInfo. + Construct a new primitive array object. - + - + - See IAnimatorControllerPlayable.GetFloat. + Construct a new primitive array object. - - + - + - See IAnimatorControllerPlayable.GetFloat. + Construct a new primitive array object. - - + - + - Gets the position of an IK hint. + Construct a new primitive array object. - 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). + Construct a new primitive array object. - The AvatarIKHint that is queried. - - Return translative weight. - + - + - Gets the position of an IK goal. + Creates a new global reference to the object referred to by the <tt>obj</tt> argument. - 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). + Construct a new primitive array object. - The AvatarIKGoal that is queried. + - + - Gets the rotation of an IK goal. + Creates a new local reference that refers to the same object as <tt>obj</tt>. - The AvatarIKGoal that is is queried. + - + - Gets the rotational weight of an IK goal (0 = rotation before IK, 1 = rotation at the IK goal). + Construct a new primitive array object. - The AvatarIKGoal that is queried. + - + - See IAnimatorControllerPlayable.GetInteger. + 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. - - + + + - + - See IAnimatorControllerPlayable.GetInteger. + Constructs a new array holding objects in class <tt>clazz<tt>. All elements are initially set to <tt>obj<tt>. - - + + + - + - See IAnimatorControllerPlayable.GetLayerIndex. + Construct a new primitive array object. - + - + - See IAnimatorControllerPlayable.GetLayerName. + Constructs a new <tt>java.lang.String</tt> object from an array of characters in modified UTF-8 encoding. - + - + - See IAnimatorControllerPlayable.GetLayerWeight. + 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. - + - + - Gets the list of AnimatorClipInfo currently played by the next state. + Creates a new local reference frame, in which at least a given number of local references can be created. - The layer's index. + - + - See IAnimatorControllerPlayable.GetNextAnimatorClipInfo. + 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. - + - See IAnimatorControllerPlayable.GetNextAnimatorStateInfo. + This function sets the value of an instance (nonstatic) field of an object. - + + + - + - See AnimatorController.GetParameter. + Sets the value of one element in a primitive array. + + - + - Gets the value of a quaternion parameter. + This function sets the value of an instance (nonstatic) field of an object. - The name of the parameter. + + + - + - Gets the value of a quaternion parameter. + Sets the value of one element in a primitive array. - The id of the parameter. The id is generated using Animator::StringToHash. + + + - + - Gets the value of a vector parameter. + This function sets the value of an instance (nonstatic) field of an object. - The name of the parameter. + + + - + - Gets the value of a vector parameter. + Sets the value of one element in a primitive array. - The id of the parameter. The id is generated using Animator::StringToHash. + + + - + - See IAnimatorControllerPlayable.HasState. + This function sets the value of an instance (nonstatic) field of an object. - - + + + - + - Interrupts the automatic target matching. + Sets the value of one element in a primitive array. - + + + - + - Interrupts the automatic target matching. + This function sets the value of an instance (nonstatic) field of an object. - + + + - + - Returns true if the transform is controlled by the Animator\. + Sets the value of one element in a primitive array. - The transform that is queried. + + + - + - See IAnimatorControllerPlayable.IsInTransition. + This function sets the value of an instance (nonstatic) field of an object. - + + + - + - See IAnimatorControllerPlayable.IsParameterControlledByCurve. + Sets the value of one element in a primitive array. - - + + + - + - See IAnimatorControllerPlayable.IsParameterControlledByCurve. + This function sets the value of an instance (nonstatic) field of an object. - - + + + - + - Automatically adjust the gameobject position and rotation so that the AvatarTarget reaches the matchPosition when the current state is at the specified progress. + Sets an element of an <tt>Object</tt> array. - 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. + + + - + - See IAnimatorControllerPlayable.Play. + This function sets the value of an instance (nonstatic) field of an object. - - - - + + + - + - See IAnimatorControllerPlayable.Play. + Sets the value of one element in a primitive array. - - - - + + + - + - See IAnimatorControllerPlayable.PlayInFixedTime. + This function sets the value of an instance (nonstatic) field of an object. - - - - + + + - + - See IAnimatorControllerPlayable.PlayInFixedTime. + This function ets the value of a static field of an object. - - - - + + + - + - Rebind all the animated properties and mesh data with the Animator. + This function ets the value of a static field of an object. + + + - + - See IAnimatorControllerPlayable.ResetTrigger. + This function ets the value of a static field of an object. - - + + + - + - See IAnimatorControllerPlayable.ResetTrigger. + This function ets the value of a static field of an object. - - + + + - + - Sets local rotation of a human bone during a IK pass. + This function ets the value of a static field of an object. - The human bone Id. - The local rotation. + + + - + - See IAnimatorControllerPlayable.SetBool. + This function ets the value of a static field of an object. - - - + + + - + - See IAnimatorControllerPlayable.SetBool. + This function ets the value of a static field of an object. - - - + + + - + - See IAnimatorControllerPlayable.SetFloat. + This function ets the value of a static field of an object. - - - - - + + + - + - See IAnimatorControllerPlayable.SetFloat. + This function ets the value of a static field of an object. - - - - - + + + - + - See IAnimatorControllerPlayable.SetFloat. + This function ets the value of a static field of an object. - - - - - + + + - + - See IAnimatorControllerPlayable.SetFloat. + This function sets the value of an instance (nonstatic) field of an object. - - - - - + + + - + - Sets the position of an IK hint. + Causes a <tt>java.lang.Throwable</tt> object to be thrown. - 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). + Constructs an exception object from the specified class with the <tt>message</tt> specified by message and causes that exception to be thrown. - The AvatarIKHint that is set. - The translative weight. + + - + - Sets the position of an IK goal. + Convert a managed array of System.Boolean to a Java array of <tt>boolean</tt>. - 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). + Convert a managed array of System.Byte to a Java array of <tt>byte</tt>. - The AvatarIKGoal that is set. - The translative weight. + - + - Sets the rotation of an IK goal. + Convert a managed array of System.Char to a Java array of <tt>char</tt>. - 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). + Convert a managed array of System.Double to a Java array of <tt>double</tt>. - The AvatarIKGoal that is set. - The rotational weight. + - + - See IAnimatorControllerPlayable.SetInteger. + Convert a managed array of System.Single to a Java array of <tt>float</tt>. - - - + - + - See IAnimatorControllerPlayable.SetInteger. + Convert a managed array of System.Int32 to a Java array of <tt>int</tt>. - - - + - + - See IAnimatorControllerPlayable.SetLayerWeight. + Convert a managed array of System.Int64 to a Java array of <tt>long</tt>. - - + - + - Sets the look at position. + Convert a managed array of System.IntPtr, representing Java objects, to a Java array of <tt>java.lang.Object</tt>. - The position to lookAt. + - + - Set look at weights. + Converts a field ID derived from cls to a <tt>java.lang.reflect.Field</tt> object. - (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. + Converts a method ID derived from clazz to a <tt>java.lang.reflect.Method<tt> or <tt>java.lang.reflect.Constructor<tt> object. - (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. + Convert a managed array of System.Int16 to a Java array of <tt>short</tt>. - (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. + 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. - (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. + Set debug to true to log calls through the AndroidJNIHelper. - (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. + Creates a managed array from a Java array. - The name of the parameter. - The new value for the parameter. + Java array object to be converted into a managed array. - + - Sets the value of a quaternion parameter. + Creates a Java array from a managed array. - Of the parameter. The id is generated using Animator::StringToHash. - The new value for the parameter. + Managed array to be converted into a Java array object. - + - Sets an AvatarTarget and a targetNormalizedTime for the current state. + Creates a java proxy object which connects to the supplied proxy implementation. - The avatar body part that is queried. - The current state Time that is queried. + An implementatinon of a java interface in c#. - + - See IAnimatorControllerPlayable.SetTrigger. + Creates a UnityJavaRunnable object (implements java.lang.Runnable). - - + A delegate representing the java.lang.Runnable. + - + - See IAnimatorControllerPlayable.SetTrigger. + 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. - + - Sets the value of a vector parameter. + Deletes any local jni references previously allocated by CreateJNIArgArray(). - The name of the parameter. - The new value for the parameter. + The array of arguments used as a parameter to CreateJNIArgArray(). + The array returned by CreateJNIArgArray(). - + - Sets the value of a vector parameter. + Scans a particular Java class for a constructor method matching a signature. - The id of the parameter. The id is generated using Animator::StringToHash. - The new value for the parameter. + Raw JNI Java class object (obtained by calling AndroidJNI.FindClass). + Constructor method signature (e.g. obtained by calling AndroidJNIHelper.GetSignature). - + - Sets the animator in playback mode. + 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). - + - Sets the animator in recording mode, and allocates a circular buffer of size frameCount. + Get a JNI method ID for a constructor based on calling arguments. - 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. + Raw JNI Java class object (obtained by calling AndroidJNI.FindClass). + Array with parameters to be passed to the constructor when invoked. + - + - Stops the animator playback mode. When playback stops, the avatar resumes getting control from game logic. + 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. - + - Stops animator record mode. + 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. - + - Generates an parameter id from a string. + Scans a particular Java class for a field matching a name and a signature. - The string to convert to Id. + 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. - + - Evaluates the animator based on deltaTime. + Get a JNI field ID based on type detection. Generic parameter represents the field type. - The time delta. + 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. + - + - Information about clip been played and blended by the Animator. + 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. - - - Returns the animation clip played by the Animator. - - - + - Returns the blending weight used by the Animator to blend this clip. + 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. - + - 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. + 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. - + - The default bool value for the parameter. + 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. + - + - The default bool value for the parameter. + 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. + - + - The default bool value for the parameter. + Creates the JNI signature string for particular object type. + Object for which a signature is to be produced. - + - The name of the parameter. + Creates the JNI signature string for an object parameter list. + Array of object for which a signature is to be produced. - + - Returns the hash of the parameter based on its name. + Creates the JNI signature string for an object parameter list. + Array of object for which a signature is to be produced. - + - The type of the parameter. + The animation component is used to play back animations. - + - The type of the parameter. + When turned on, Unity might stop animating if it thinks that the results of the animation won't be visible to the user. - + - Boolean type parameter. + When turned on, animations will be executed in the physics loop. This is only useful in conjunction with kinematic rigidbodies. - + - Float type parameter. + The default animation. - + - Int type parameter. + Controls culling of this Animation component. - + - Trigger type parameter. + Are we playing any animations? - + - Culling mode for the Animator. + AABB of this Animation animation component in local space. - + - Always animate the entire character. Object is animated even when offscreen. + Should the default animation clip (the Animation.clip property) automatically start playing on startup? - + - Animation is completely disabled when renderers are not visible. + How should time beyond the playback range of the clip be treated? - + - Retarget, IK and write of Transforms are disabled when renderers are not visible. + Adds a clip to the animation with name newName. + + - + - Interface to control AnimatorOverrideController. + 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. + + + + - + - Returns the list of orignal clip from the controller and their override clip. + 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. + + + + - + - The Controller that the AnimatorOverrideController overrides. + Blends the animation named animation towards targetWeight over the next time seconds. + + + - + - Returns either the overriding clip if set or the original clip named name. + Blends the animation named animation towards targetWeight over the next time seconds. + + + - + - Returns either the overriding clip if set or the original clip named name. + Blends the animation named animation towards targetWeight over the next time seconds. + + + - + - The mode of the Animator's recorder. + Fades the animation with name animation in over a period of time seconds and fades other animations out. + + + - + - The Animator recorder is offline. + Fades the animation with name animation in over a period of time seconds and fades other animations out. + + + - + - The Animator recorder is in Playback. + Fades the animation with name animation in over a period of time seconds and fades other animations out. + + + - + - The Animator recorder is in Record. + Cross fades an animation after previous animations has finished playing. + + + + - + - Information about the current or next state. + Cross fades an animation after previous animations has finished playing. + + + + - + - The full path hash for this state. + Cross fades an animation after previous animations has finished playing. + + + + - + - Current duration of the state. + Cross fades an animation after previous animations has finished playing. + + + + - + - Is the state looping. + Get the number of clips currently assigned to this animation. - + - The hashed name of the State. + Is the animation named name playing? + - + - Normalized time of the State. + Plays an animation without any blending. + + - + - The hash is generated using Animator::StringToHash. The string to pass doest not include the parent layer's name. + Plays an animation without any blending. + + - + - The playback speed of the animation. 1 is the normal playback speed. + Plays an animation without any blending. + + - + - The speed multiplier for this state. + Plays an animation without any blending. + + - + - The Tag of the State. + Plays an animation after previous animations has finished playing. + + + - + - Does name match the name of the active state in the statemachine? + Plays an animation after previous animations has finished playing. - + + + - + - Does tag match the tag of the active state in the statemachine. + Plays an animation after previous animations has finished playing. - + + + - + - Information about the current transition. + Remove clip from the animation list. + - + - Returns true if the transition is from an AnyState node, or from Animator.CrossFade(). + Remove clip from the animation list. + - + - The unique name of the Transition. + Rewinds the animation named name. + - + - The simplified name of the Transition. + Rewinds all animations. - + - Normalized time of the Transition. + Samples animations at the current state. - + - The user-specidied name of the Transition. + Stops all playing animations that were started with this Animation. - + - Does name match the name of the active Transition. + Stops an animation named name. - + - Does userName match the name of the active Transition. + Returns the animation state named name. - - + - The update mode of the Animator. + Used by Animation.Play function. - + - Updates the animator during the physic loop in order to have the animation system synchronized with the physics engine. + Animations will be added. - + - Normal update of the animator. + Animations will be blended. - + - Animator updates independently of Time.timeScale. + Stores keyframe based animations. - + - Various utilities for animator manipulation. + Animation Events for this animation clip. - + - This function will recreate all transform hierarchy under GameObject. + Frame rate at which keyframes are sampled. (Read Only) - 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. + Returns true if the animation contains curve that drives a humanoid rig. - GameObject to Optimize. - List of transform name to expose. - + - Anisotropic filtering mode. + Set to true if the AnimationClip will be used with the Legacy Animation component ( instead of the Animator ). - + - Disable anisotropic filtering for all textures. + Animation length in seconds. (Read Only) - + - Enable anisotropic filtering, as set for each texture. + AABB of this Animation Clip in local space of Animation component that it is attached too. - + - Enable anisotropic filtering for all textures. + Sets the default wrap mode used in the animation state. - + - A class for Apple TV remote input configuration. + Adds an animation event to the clip. + AnimationEvent to add. - + - 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. + Clears all curves from the clip. - + - Configures if Apple TV Remote should autorotate all the inputs when Remote is being held in horizontal orientation. Default is false. + Creates a new animation clip. - + - 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. + Realigns quaternion keys to ensure shortest interpolation paths. - + - 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. + Samples an animation at a given time for any animated properties. + The animated game object. + The time to sample an animation. - + - Access to application run-time data. + 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. - + - The absolute path to the web player data file (Read Only). + This class defines a pair of clips used by AnimatorOverrideController. - + - Priority of background loading thread. + The original clip from the controller. - + - Returns application bundle identifier at runtime. + The override animation clip. - + - A unique cloud project identifier. It is unique for every project (Read Only). + This enum controlls culling of Animation component. - + - Return application company name (Read Only). + Animation culling is disabled - object is animated even when offscreen. - + - Contains the path to the game data folder (Read Only). + Animation is disabled when renderers are not visible. - + - Returns false if application is altered in any way after it was built. + Store a collection of Keyframes that can be evaluated over time. - + - Returns true if application integrity can be confirmed. + All keys defined in the animation curve. - + - Returns application install mode (Read Only). + The number of keys in the curve. (Read Only) - + - Returns the type of Internet reachability currently possible on the device. + The behaviour of the animation after the last keyframe. - + - Is the current Runtime platform a known console platform. + The behaviour of the animation before the first keyframe. - + - Are we running inside the Unity editor? (Read Only) + 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. + - + - Is some level being loaded? (Read Only) + 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. + - + - Is the current Runtime platform a known mobile platform. + Creates an animation curve from an arbitrary number of keyframes. + An array of Keyframes used to define the curve. - + - Returns true when in any kind of player (Read Only). + Creates an empty animation curve. - + - Checks whether splash screen is being shown. + 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. + - + - Are we running inside a web player? (Read Only) + 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. + - + - The total number of levels available (Read Only). + 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 (straight) curve created from the values specified. + - + - The level index that was last loaded (Read Only). + 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. + - + - The name of the level that was last loaded (Read Only). + Removes a key. + The index of the key to remove. - + - Event that is fired if a log message is received. + 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. - + - Event that is fired if a log message is received. + Retrieves the key at index. (Read Only) - - + - Contains the path to a persistent data directory (Read Only). + AnimationEvent lets you call a script function similar to SendMessage as part of playing back an animation. - + - Returns the platform the game is running on (Read Only). + The animation state that fired this event (Read Only). - + - Returns application product name (Read Only). + The animator clip info related to this event (Read Only). - + - Should the player be running when the application is in the background? + The animator state info related to this event (Read Only). - + - Returns application running in sandbox (Read Only). + Float parameter that is stored in the event and will be sent to the function. - + - The path to the web player data file relative to the html file (Read Only). + The name of the function that will be called. - + - Stack trace logging options. The default value is StackTraceLogType.ScriptOnly. + Int parameter that is stored in the event and will be sent to the function. - + - How many bytes have we downloaded from the main unity web stream (Read Only). + Returns true if this Animation event has been fired by an Animator component. - + - Contains the path to the StreamingAssets folder (Read Only). + Returns true if this Animation event has been fired by an Animation component. - + - The language the user's operating system is running in. + Function call options. - + - Instructs game to try to render at a specified frame rate. + Object reference parameter that is stored in the event and will be sent to the function. - + - Contains the path to a temporary data / cache directory (Read Only). + String parameter that is stored in the event and will be sent to the function. - + - The version of the Unity runtime used to play the content. + The time at which the event will be fired off. - + - Returns application version number (Read Only). + Creates a new animation event. - + - Indicates whether Unity's webplayer security model is enabled. + Information about what animation clips is played and its weight. - + - Delegate method for fetching advertising ID. + Animation clip that is played. - 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. + The weight of the animation clip. - + - Can the streamed level be loaded? + The AnimationState gives full control over animation blending. - - + - Can the streamed level be loaded? + Which blend mode should be used? - - + - Captures a screenshot at path filename as a PNG file. + The clip that is being played by this animation state. - Pathname to save the screenshot file to. - Factor by which to increase resolution. - + - Captures a screenshot at path filename as a PNG file. + Enables / disables the animation. - Pathname to save the screenshot file to. - Factor by which to increase resolution. - + - Calls a function in the containing web page (Web Player only). + The length of the animation clip in seconds. - - - + - Evaluates script function in the containing web page. + The name of the animation. - The Javascript function to call. - + - How far has the download progressed? [0...1]. + The normalized playback speed. - - + - How far has the download progressed? [0...1]. + The normalized time of the animation. - - + - Is Unity activated with the Pro license? + The playback speed of the animation. 1 is normal playback speed. - + - Check if the user has authorized use of the webcam or microphone in the Web Player. + The current time of the animation. - - + - Loads the level by its name or index. + The weight of animation. - The level to load. - The name of the level to load. - + - Loads the level by its name or index. + Wrapping mode of the animation. - The level to load. - The name of the level to load. - + - Loads a level additively. + 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. - + - Loads a level additively. + 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. - + - Loads the level additively and asynchronously in the background. + Removes a transform which should be animated. - - + - + - Loads the level additively and asynchronously in the background. + Interface to control the Mecanim animation system. - - - + - Loads the level asynchronously in the background. + Gets the avatar angular velocity for the last evaluated frame. - - - + - Loads the level asynchronously in the background. + When turned on, animations will be executed in the physics loop. This is only useful in conjunction with kinematic rigidbodies. - - - + - Use this delegate type with Application.logMessageReceived or Application.logMessageReceivedThreaded to monitor what gets logged. + Should root motion be applied? - - - - + - Opens the url in a browser. + Gets/Sets the current Avatar. - - + - Quits the player application. + The position of the body center of mass. - + - Request advertising ID for iOS, Android and Windows Store. + The rotation of the body center of mass. - Delegate method. - - Platforms that don't support Advertising Identifier return value is false and the delegate method is not invoked. - - + - Request authorization to use the webcam or microphone in the Web Player. + Controls culling of this Animator component. - - + - 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. + Gets the avatar delta position for the last evaluated frame. - 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. + Gets the avatar delta rotation for the last evaluated frame. - 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). + Blends pivot point between body center of mass and feet pivot. At 0%, the blending point is body center of mass. At 100%, the blending point is feet pivot. - + - Application installed via ad hoc distribution. + The current gravity weight based on current animations that are played. - + - Application installed via developer build. + Returns true if Animator has any playables assigned to it. - + - Application running in editor. + Returns true if the current rig has root motion. - + - Application installed via enterprise distribution. + Returns true if the object has a transform hierarchy. - + - Application installed via online store. + Returns the scale of the current Avatar for a humanoid rig, (1 by default if the rig is generic). - + - Application install mode unknown. + Returns true if the current rig is humanoid, false if it is generic. - + - Application sandbox type. + Returns whether the animator is initialized successfully. - + - Application not running in a sandbox. + If automatic matching is active. - + - Application is running in broken sandbox. + Returns true if the current rig is optimizable with AnimatorUtility.OptimizeTransformHierarchy. - + - Application is running in a sandbox. + See IAnimatorControllerPlayable.layerCount. - + - Application sandbox type is unknown. + Additional layers affects the center of mass. - + - Applies forces within an area. + Get left foot bottom height. - + - The angular drag to apply to rigid-bodies. + When linearVelocityBlending is set to true, the root motion velocity and angular velocity will be blended linearly. - + - The linear drag to apply to rigid-bodies. + See IAnimatorControllerPlayable.parameterCount. - + - The angle of the force to be applied. + Read only acces to the AnimatorControllerParameters used by the animator. - + - The magnitude of the force to be applied. + Get the current position of the pivot. - + - The target for where the effector applies any force. + Gets the pivot weight. - + - The variation of the magnitude of the force to be applied. + The PlayableGraph created by the Animator. - + - Should the forceAngle use global space? + Sets the playback position in the recording buffer. - + - Assembly level attribute. Any classes in an assembly with this attribute will be considered to be Editor Classes. + Gets the mode of the Animator recorder. - + - Constructor. + Start time of the first frame of the buffer relative to the frame at which StartRecording was called. - + - The Assert class contains assertion methods for setting invariants in the code. + End time of the recorded clip relative to when StartRecording was called. - + - Should an exception be thrown on a failure. + Get right foot bottom height. - + - Asserts that the values are approximately equal. An absolute error check is used for approximate equality check (|a-b| < tolerance). Default tolerance is 0.00001f. - -Note: Every time you call the method with tolerance specified, a new instance of Assertions.Comparers.FloatComparer is created. For performance reasons you might want to instance your own comparer and pass it to the AreEqual method. If the tolerance is not specifies, a default comparer is used and the issue does not occur. + The root position, the position of the game object. - Tolerance of approximation. - - - - + - Asserts that the values are approximately equal. An absolute error check is used for approximate equality check (|a-b| < tolerance). Default tolerance is 0.00001f. - -Note: Every time you call the method with tolerance specified, a new instance of Assertions.Comparers.FloatComparer is created. For performance reasons you might want to instance your own comparer and pass it to the AreEqual method. If the tolerance is not specifies, a default comparer is used and the issue does not occur. + The root rotation, the rotation of the game object. - Tolerance of approximation. - - - - + - Asserts that the values are approximately equal. An absolute error check is used for approximate equality check (|a-b| < tolerance). Default tolerance is 0.00001f. - -Note: Every time you call the method with tolerance specified, a new instance of Assertions.Comparers.FloatComparer is created. For performance reasons you might want to instance your own comparer and pass it to the AreEqual method. If the tolerance is not specifies, a default comparer is used and the issue does not occur. + The runtime representation of AnimatorController that controls the Animator. - Tolerance of approximation. - - - - + - Asserts that the values are approximately equal. An absolute error check is used for approximate equality check (|a-b| < tolerance). Default tolerance is 0.00001f. - -Note: Every time you call the method with tolerance specified, a new instance of Assertions.Comparers.FloatComparer is created. For performance reasons you might want to instance your own comparer and pass it to the AreEqual method. If the tolerance is not specifies, a default comparer is used and the issue does not occur. + The playback speed of the Animator. 1 is normal playback speed. - Tolerance of approximation. - - - - + - Asserts that the values are equal. If no comparer is specified, EqualityComparer<T>.Default is used. + Automatic stabilization of feet during transition and blending. - - - - - + - Asserts that the values are equal. If no comparer is specified, EqualityComparer<T>.Default is used. + Returns the position of the target specified by SetTarget(AvatarTarget targetIndex, float targetNormalizedTime)). - - - - - + - Asserts that the values are equal. If no comparer is specified, EqualityComparer<T>.Default is used. + Returns the rotation of the target specified by SetTarget(AvatarTarget targetIndex, float targetNormalizedTime)). - - - - - + - Asserts that the values are approximately not equal. An absolute error check is used for approximate equality check (|a-b| < tolerance). Default tolerance is 0.00001f. + Specifies the update mode of the Animator. - Tolerance of approximation. - - - - + - Asserts that the values are approximately not equal. An absolute error check is used for approximate equality check (|a-b| < tolerance). Default tolerance is 0.00001f. + Gets the avatar velocity for the last evaluated frame. - Tolerance of approximation. - - - - + - Asserts that the values are approximately not equal. An absolute error check is used for approximate equality check (|a-b| < tolerance). Default tolerance is 0.00001f. + Apply the default Root Motion. - Tolerance of approximation. - - - - + - Asserts that the values are approximately not equal. An absolute error check is used for approximate equality check (|a-b| < tolerance). Default tolerance is 0.00001f. + See IAnimatorControllerPlayable.CrossFade. - Tolerance of approximation. - - - + + + + + - + - Asserts that the values are not equal. + See IAnimatorControllerPlayable.CrossFade. - - - - + + + + + - + - Asserts that the values are not equal. + See IAnimatorControllerPlayable.CrossFadeInFixedTime. - - - - + + + + + - + - Asserts that the values are not equal. + See IAnimatorControllerPlayable.CrossFadeInFixedTime. - - - - + + + + + - + - Asserts that the condition is false. + See IAnimatorControllerPlayable.GetAnimatorTransitionInfo. - - + - + - Asserts that the condition is false. + Return the first StateMachineBehaviour that match type T or derived from T. Return null if none are found. - - - + - Asserts that the value is not null. + Returns all StateMachineBehaviour that match type T or are derived from T. Returns null if none are found. - - - + - Asserts that the value is not null. + Returns transform mapped to this human bone id. - - + The human bone that is queried, see enum HumanBodyBones for a list of possible values. - + - Asserts that the value is null. + See IAnimatorControllerPlayable.GetBool. - - + + - + - Asserts that the value is null. + See IAnimatorControllerPlayable.GetBool. - - + + - + - Asserts that the condition is true. + Gets the list of AnimatorClipInfo currently played by the current state. - - + The layer's index. - + - Asserts that the condition is true. + See IAnimatorControllerPlayable.GetCurrentAnimatorClipInfo. - - + - + - An exception that is thrown on a failure. Assertions.Assert._raiseExceptions needs to be set to true. + See IAnimatorControllerPlayable.GetCurrentAnimatorClipInfo. + + - + - A float comparer used by Assertions.Assert performing approximate comparison. + See IAnimatorControllerPlayable.GetCurrentAnimatorClipInfoCount. + - + - Default epsilon used by the comparer. + See IAnimatorControllerPlayable.GetCurrentAnimatorStateInfo. + - + - Default instance of a comparer class with deafult error epsilon and absolute error check. + See IAnimatorControllerPlayable.GetFloat. + + - + - Performs equality check with absolute error check. + See IAnimatorControllerPlayable.GetFloat. - Expected value. - Actual value. - Comparison error. - - Result of the comparison. - + + - + - Performs equality check with relative error check. + Gets the position of an IK hint. - Expected value. - Actual value. - Comparison error. + The AvatarIKHint that is queried. - Result of the comparison. + Return the current position of this IK hint in world space. - + - Creates an instance of the comparer. + Gets the translative weight of an IK Hint (0 = at the original animation before IK, 1 = at the hint). - 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. + The AvatarIKHint that is queried. + + Return translative weight. + - + - Creates an instance of the comparer. + Gets the position of an IK goal. - 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. + The AvatarIKGoal that is queried. + + Return the current position of this IK goal in world space. + - + - Creates an instance of the comparer. + Gets the translative weight of an IK goal (0 = at the original animation before IK, 1 = at the goal). - 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. + The AvatarIKGoal that is queried. - + - An extension class that serves as a wrapper for the Assert class. + Gets the rotation of an IK goal. + The AvatarIKGoal that is is queried. - + - An extension method for Assertions.Assert.AreApproximatelyEqual. + Gets the rotational weight of an IK goal (0 = rotation before IK, 1 = rotation at the IK goal). - - - - + The AvatarIKGoal that is queried. - + - An extension method for Assertions.Assert.AreApproximatelyEqual. + See IAnimatorControllerPlayable.GetInteger. - - - - + + - + - An extension method for Assertions.Assert.AreApproximatelyEqual. + See IAnimatorControllerPlayable.GetInteger. - - - - + + - + - An extension method for Assertions.Assert.AreApproximatelyEqual. + See IAnimatorControllerPlayable.GetLayerIndex. - - - - + - + - An extension method for Assertions.Assert.AreEqual. + See IAnimatorControllerPlayable.GetLayerName. - - - + - + - An extension method for Assertions.Assert.AreEqual. + See IAnimatorControllerPlayable.GetLayerWeight. - - - + - + - An extension method for Assertions.Assert.IsFalse. + Gets the list of AnimatorClipInfo currently played by the next state. - - + The layer's index. - + - An extension method for Assertions.Assert.IsFalse. + See IAnimatorControllerPlayable.GetNextAnimatorClipInfo. - - + - + - An extension method for Assertions.Assert.IsNull. + See IAnimatorControllerPlayable.GetNextAnimatorClipInfo. - - + + - + - An extension method for Assertions.Assert.IsNull. + See IAnimatorControllerPlayable.GetNextAnimatorClipInfoCount. - - + - + - An extension method for Assertions.Assert.IsTrue. + See IAnimatorControllerPlayable.GetNextAnimatorStateInfo. - - + - + - An extension method for Assertions.Assert.IsTrue. + See AnimatorController.GetParameter. - - + - + - An extension method for Assertions.Assert.AreNotApproximatelyEqual. + Gets the value of a quaternion parameter. - - - - + The name of the parameter. - + - An extension method for Assertions.Assert.AreNotApproximatelyEqual. + Gets the value of a quaternion parameter. - - - - + The id of the parameter. The id is generated using Animator::StringToHash. - + - An extension method for Assertions.Assert.AreNotApproximatelyEqual. + Gets the value of a vector parameter. - - - - + The name of the parameter. - + - An extension method for Assertions.Assert.AreNotApproximatelyEqual. + Gets the value of a vector parameter. - - - - + The id of the parameter. The id is generated using Animator::StringToHash. - + - An extension method for Assertions.Assert.AreNotEqual. + See IAnimatorControllerPlayable.HasState. - - - + + - + - An extension method for Assertions.Assert.AreNotEqual. + Interrupts the automatic target matching. - - - + - + - An extension method for Assertions.Assert.AreNotNull. + Interrupts the automatic target matching. - - + - + - An extension method for Assertions.Assert.AreNotNull. + Returns true if the transform is controlled by the Animator\. - - + The transform that is queried. - + - AssetBundles let you stream additional assets via the WWW class and instantiate them at runtime. AssetBundles are created via BuildPipeline.BuildAssetBundle. + See IAnimatorControllerPlayable.IsInTransition. + - + - Main asset that was supplied when building the asset bundle (Read Only). + See IAnimatorControllerPlayable.IsParameterControlledByCurve. + + - + - Check if an AssetBundle contains a specific object. + See IAnimatorControllerPlayable.IsParameterControlledByCurve. + - + - Loads an asset bundle from a disk. + Automatically adjust the gameobject position and rotation so that the AvatarTarget reaches the matchPosition when the current state is at the specified progress. - Path of the file on disk - -See Also: WWW.assetBundle, WWW.LoadFromCacheOrDownload. + 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. - + - Asynchronously create an AssetBundle from a memory region. + See IAnimatorControllerPlayable.Play. - + + + + - + - Synchronously create an AssetBundle from a memory region. + See IAnimatorControllerPlayable.Play. - Array of bytes with the AssetBundle data. + + + + - + - Return all asset names in the AssetBundle. + See IAnimatorControllerPlayable.PlayInFixedTime. + + + + - + - Return all the scene asset paths (paths to *.unity assets) in the AssetBundle. + See IAnimatorControllerPlayable.PlayInFixedTime. + + + + - + - Loads all assets contained in the asset bundle that inherit from type. + Rebind all the animated properties and mesh data with the Animator. - - + - Loads all assets contained in the asset bundle. + See IAnimatorControllerPlayable.ResetTrigger. + + - + - Loads all assets contained in the asset bundle that inherit from type T. + See IAnimatorControllerPlayable.ResetTrigger. + + - + - Loads all assets contained in the asset bundle asynchronously. + Sets local rotation of a human bone during a IK pass. + The human bone Id. + The local rotation. - + - Loads all assets contained in the asset bundle that inherit from T asynchronously. + See IAnimatorControllerPlayable.SetBool. + + + - + - Loads all assets contained in the asset bundle that inherit from type asynchronously. + See IAnimatorControllerPlayable.SetBool. - + + + - + - Loads asset with name from the bundle. + See IAnimatorControllerPlayable.SetFloat. + + + + - + - Loads asset with name of a given type from the bundle. + See IAnimatorControllerPlayable.SetFloat. - + + + + - + - Loads asset with name of type T from the bundle. + See IAnimatorControllerPlayable.SetFloat. + + + + - + - Asynchronously loads asset with name from the bundle. + See IAnimatorControllerPlayable.SetFloat. + + + + - + - Asynchronously loads asset with name of a given T from the bundle. + Sets the position of an IK hint. - + The AvatarIKHint that is set. + The position in world space. - + - Asynchronously loads asset with name of a given type from the bundle. + 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. - + - Loads asset and sub assets with name from the bundle. + Sets the position of an IK goal. - + The AvatarIKGoal that is set. + The position in world space. - + - Loads asset and sub assets with name of a given type from the bundle. + 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. - + - Loads asset and sub assets with name of type T from the bundle. + Sets the rotation of an IK goal. - + The AvatarIKGoal that is set. + The rotation in world space. - + - Loads asset with sub assets with name from the bundle asynchronously. + 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. - + - Loads asset with sub assets with name of type T from the bundle asynchronously. + See IAnimatorControllerPlayable.SetInteger. + + - + - Loads asset with sub assets with name of a given type from the bundle asynchronously. + See IAnimatorControllerPlayable.SetInteger. - + + - + - Synchronously loads an AssetBundle from a file on disk. + See IAnimatorControllerPlayable.SetLayerWeight. - 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. + Sets the look at position. - 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. - + The position to lookAt. - + - Synchronously create an AssetBundle from a memory region. + Set look at weights. - 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. - + (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). - + - Asynchronously create an AssetBundle from a memory region. + Set look at weights. - 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. - + (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). - + - Unloads all assets in the bundle. + 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). - + - Asynchronous create request for an AssetBundle. + 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). - + - Asset object being loaded (Read Only). + 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). - + - Manifest for all the assetBundle in the build. + Sets the value of a quaternion parameter. + The name of the parameter. + The new value for the parameter. - + - Get all the AssetBundles in the manifest. + Sets the value of a quaternion parameter. - - An array of asset bundle names. - + Of the parameter. The id is generated using Animator::StringToHash. + The new value for the parameter. - + - Get all the AssetBundles with variant in the manifest. + Sets an AvatarTarget and a targetNormalizedTime for the current state. - - An array of asset bundle names. - + The avatar body part that is queried. + The current state Time that is queried. - + - Get all the dependent AssetBundles for the given AssetBundle. + See IAnimatorControllerPlayable.SetTrigger. - Name of the asset bundle. + + - + - Get the hash for the given AssetBundle. + See IAnimatorControllerPlayable.SetTrigger. - Name of the asset bundle. - - The 128-bit hash for the asset bundle. - + + - + - Get the direct dependent AssetBundles for the given AssetBundle. + Sets the value of a vector parameter. - Name of the asset bundle. - - Array of asset bundle names this asset bundle depends on. - + The name of the parameter. + The new value for the parameter. - + - Asynchronous load request from an AssetBundle. + 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. - + - Asset objects with sub assets being loaded. (Read Only) + Sets the animator in playback mode. - + - Asset object being loaded (Read Only). + 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. - + - Asynchronous operation coroutine. + Stops the animator playback mode. When playback stops, the avatar resumes getting control from game logic. - + - Allow scenes to be activated as soon as it is ready. + Stops animator record mode. - + - Has the operation finished? (Read Only) + Generates an parameter id from a string. + The string to convert to Id. - + - Priority lets you tweak in which order async operation calls will be performed. + Evaluates the animator based on deltaTime. + The time delta. - + - What's the operation's progress. (Read Only) + Information about clip being played and blended by the Animator. - + - AudioMixer asset. + Returns the animation clip played by the Animator. - + - Routing target. + Returns the blending weight used by the Animator to blend this clip. - + - Resets an exposed parameter to its initial value. + 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. - 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. + The default bool value for the parameter. - 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. + The default bool value for the parameter. - 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. + The default bool value for the parameter. - 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. + The name of the parameter. - 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. + Returns the hash of the parameter based on its name. - 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. + The type of the parameter. - + - Object representing a snapshot in the mixer. + The type of the parameter. - + - Performs an interpolated transition towards this snapshot over the time interval specified. + Boolean type parameter. - Relative time after which this snapshot should be reached from any current state. - + - The Audio Chorus Filter takes an Audio Clip and processes it creating a chorus effect. + Float type parameter. - + - Chorus delay in ms. 0.1 to 100.0. Default = 40.0 ms. + Int type parameter. - + - Chorus modulation depth. 0.0 to 1.0. Default = 0.03. + Trigger type parameter. - + - Volume of original signal to pass to output. 0.0 to 1.0. Default = 0.5. + Culling mode for the Animator. - + - Chorus feedback. Controls how much of the wet signal gets fed back into the chorus buffer. 0.0 to 1.0. Default = 0.0. + Always animate the entire character. Object is animated even when offscreen. - + - Chorus modulation rate in hz. 0.0 to 20.0. Default = 0.8 hz. + Animation is completely disabled when renderers are not visible. - + - Volume of 1st chorus tap. 0.0 to 1.0. Default = 0.5. + Retarget, IK and write of Transforms are disabled when renderers are not visible. - + - 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. + Interface to control Animator Override Controller. - + - 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. + Returns the list of orignal Animation Clip from the controller and their override Animation Clip. - + - A container for audio data. + Returns the count of overrides. - + - The number of channels in the audio clip. (Read Only) + The Runtime Animator Controller that the Animator Override Controller overrides. - + - The sample frequency of the clip in Hertz. (Read Only) + Applies the list of overrides on this Animator Override Controller. + Overrides list to apply. - + - Returns true if the AudioClip is ready to play (read-only). + Creates an empty Animator Override Controller. - + - The length of the audio clip in seconds. (Read Only) + Creates an Animator Override Controller that overrides controller. + Runtime Animator Controller to override. - + - 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. + Gets the list of Animation Clip overrides currently defined in this Animator Override Controller. + Array to receive results. - + - Returns the current load state of the audio data associated with an AudioClip. + Returns either the overriding Animation Clip if set or the original Animation Clip named name. - + - The load type of the clip (read-only). + Returns either the overriding Animation Clip if set or the original Animation Clip named name. - + - 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 mode of the Animator's recorder. - + - The length of the audio clip in samples. (Read Only) + The Animator recorder is offline. - + - Creates a user AudioClip with a name and with the given length in samples, channels and frequency. + The Animator recorder is in Playback. - 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. + The Animator recorder is in Record. - 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. + Information about the current or next state. - 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. + The full path hash for this state. - 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. + Current duration of the state. - 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. + Is the state looping. - 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. + The hashed name of the State. - - - + - Loads the audio data of a clip. Clips that have "Preload Audio Data" set will load the audio data automatically. + Normalized time of the State. - - Returns true if loading succeeded. - - + - Delegate called each time AudioClip reads data. + The hash is generated using Animator::StringToHash. The string to pass doest not include the parent layer's name. - Array of floats containing data read from the clip. - + - Delegate called each time AudioClip changes read position. + The playback speed of the animation. 1 is the normal playback speed. - New position in the audio clip. - + - Set sample data in a clip. + The speed multiplier for this state. - - - + - Unloads the audio data associated with the clip. This works only for AudioClips that are based on actual sound file assets. + The Tag of the State. - - Returns false if unloading failed. - - + - Determines how the audio clip is loaded in. + Does name match the name of the active state in the statemachine? + - + - The audio data of the clip will be kept in memory in compressed form. + Does tag match the tag of the active state in the statemachine. + - + - The audio data is decompressed when the audio clip is loaded. + Information about the current transition. - + - Streams audio data from disk. + Returns true if the transition is from an AnyState node, or from Animator.CrossFade(). - + - An enum containing different compression types. + The unique name of the Transition. - + - AAC Audio Compression. + The simplified name of the Transition. - + - Adaptive differential pulse-code modulation. + Normalized time of the Transition. - + - Nintendo ADPCM audio compression format. + The user-specified name of the Transition. - + - Sony proprietory hardware codec. + Does name match the name of the active Transition. + - + - MPEG Audio Layer III. + Does userName match the name of the active Transition. + - + - Uncompressed pulse-code modulation. + The update mode of the Animator. - + - Sony proprietary hardware format. + Updates the animator during the physic loop in order to have the animation system synchronized with the physics engine. - + - Vorbis compression format. + Normal update of the animator. - + - Xbox One proprietary hardware format. + Animator updates independently of Time.timeScale. - + - Specifies the current properties or desired properties to be set for the audio system. + Various utilities for animator manipulation. - + - The length of the DSP buffer in samples determining the latency of sounds by the audio output device. + This function will recreate all transform hierarchy under GameObject. + GameObject to Deoptimize. - + - The current maximum number of simultaneously audible sounds in the game. + 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. - + - The maximum number of managed sounds in the game. Beyond this limit sounds will simply stop playing. + Anisotropic filtering mode. - + - The current sample rate of the audio output device used. + Disable anisotropic filtering for all textures. - + - The current speaker mode used by the audio output device. + Enable anisotropic filtering, as set for each texture. - + - Value describing the current load state of the audio data associated with an AudioClip. + Enable anisotropic filtering for all textures. - + - Value returned by AudioClip.loadState for an AudioClip that has failed loading its audio data. + ReplayKit is only available on certain iPhone, iPad and iPod Touch devices running iOS 9.0 or later. - + - Value returned by AudioClip.loadState for an AudioClip that has succeeded loading its audio data. + 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. - + - Value returned by AudioClip.loadState for an AudioClip that is currently loading audio data. + A string property that contains an URL used to redirect the user to an on-going or completed broadcast (Read Only). - + - Value returned by AudioClip.loadState for an AudioClip that has no audio data loaded and where loading has not been initiated yet. + Camera enabled status, true, if camera enabled, false otherwise. - + - The Audio Distortion Filter distorts the sound from an AudioSource or. + Boolean property that indicates whether a broadcast is currently in progress (Read Only). - + - Distortion value. 0.0 to 1.0. Default = 0.5. + A boolean that indicates whether ReplayKit is making a recording (where True means a recording is in progress). (Read Only) - + - The Audio Echo Filter repeats a sound after a given Delay, attenuating. + A string value of the last error incurred by the ReplayKit: Either 'Failed to get Screen Recorder' or 'No recording available'. (Read Only) - + - Echo decay per delay. 0 to 1. 1.0 = No decay, 0.0 = total decay (i.e. simple 1 line delay). Default = 0.5. + Microphone enabled status, true, if microhone enabled, false otherwise. - + - Echo delay in ms. 10 to 5000. Default = 500. + A boolean value that indicates that a new recording is available for preview (where True means available). (Read Only) - + - Volume of original signal to pass to output. 0.0 to 1.0. Default = 1.0. + A boolean that indicates whether the ReplayKit API is available (where True means available). (Read Only) - + - Volume of echo signal to pass to output. 0.0 to 1.0. Default = 1.0. + 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. - + - The Audio High Pass Filter passes high frequencies of an AudioSource and. + Discard the current recording. + + A boolean value of True if the recording was discarded successfully or False if an error occurred. + - + - Highpass cutoff frequency in hz. 10.0 to 22000.0. Default = 5000.0. + Hide the camera preview view. - + - Determines how much the filter's self-resonance isdampened. + Preview the current recording + + A boolean value of True if the video preview window opened successfully or False if an error occurred. + - + - Representation of a listener in 3D space. + Shows camera preview at coordinates posX and posY. + + - + - The paused state of the audio system. + 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. - + - This lets you set whether the Audio Listener should be updated in the fixed or dynamic update. + 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. + - + - Controls the game sound volume (0.0 to 1.0). + Stops current broadcast. +Will terminate currently on-going broadcast. If no broadcast is in progress, does nothing. - + - Provides a block of the listener (master)'s output data. + Stop the current recording. - The array to populate with audio samples. Its length must be a power of 2. - The channel to sample from. + + A boolean value of True if recording stopped successfully or False if an error occurred. + - + - Deprecated Version. Returns a block of the listener (master)'s output data. + A class for Apple TV remote input configuration. - - - + - Provides a block of the listener (master)'s spectrum data. + 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. - 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. + Configures if Apple TV Remote should autorotate all the inputs when Remote is being held in horizontal orientation. Default is false. - - - - + - The Audio Low Pass Filter filter passes low frequencies of an. + 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. - + - Returns or sets the current custom frequency cutoff curve. + 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. - + - Lowpass cutoff frequency in hz. 10.0 to 22000.0. Default = 5000.0. + Access to application run-time data. - + - Determines how much the filter's self-resonance is dampened. + The absolute path to the web player data file (Read Only). - + - The Audio Reverb Filter takes an Audio Clip and distortionates it in a. + Priority of background loading thread. - + - Decay HF Ratio : High-frequency to low-frequency decay time ratio. Ranges from 0.1 to 2.0. Default is 0.5. + Returns a GUID for this build (Read Only). - + - Reverberation decay time at low-frequencies in seconds. Ranges from 0.1 to 20.0. Default is 1.0. + A unique cloud project identifier. It is unique for every project (Read Only). - + - Reverberation density (modal density) in percent. Ranges from 0.0 to 100.0. Default is 100.0. + Return application company name (Read Only). - + - Reverberation diffusion (echo density) in percent. Ranges from 0.0 to 100.0. Default is 100.0. + Contains the path to the game data folder (Read Only). - + - Mix level of dry signal in output in mB. Ranges from -10000.0 to 0.0. Default is 0. + Returns false if application is altered in any way after it was built. - + - Reference high frequency in Hz. Ranges from 20.0 to 20000.0. Default is 5000.0. + Returns true if application integrity can be confirmed. - + - Reference low-frequency in Hz. Ranges from 20.0 to 1000.0. Default is 250.0. + 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. - + - Late reverberation level relative to room effect in mB. Ranges from -10000.0 to 2000.0. Default is 0.0. + Returns the name of the store or package that installed the application (Read Only). - + - Early reflections level relative to room effect in mB. Ranges from -10000.0 to 1000.0. Default is -10000.0. + Returns application install mode (Read Only). - + - Late reverberation delay time relative to first reflection in seconds. Ranges from 0.0 to 0.1. Default is 0.04. + Returns the type of Internet reachability currently possible on the device. - + - Late reverberation level relative to room effect in mB. Ranges from -10000.0 to 2000.0. Default is 0.0. + Is the current Runtime platform a known console platform. - + - Set/Get reverb preset properties. + Are we running inside the Unity editor? (Read Only) - + - Room effect level at low frequencies in mB. Ranges from -10000.0 to 0.0. Default is 0.0. + Whether the player currently has focus. Read-only. - + - Room effect high-frequency level re. low frequency level in mB. Ranges from -10000.0 to 0.0. Default is 0.0. + Is some level being loaded? (Read Only) - + - Room effect low-frequency level in mB. Ranges from -10000.0 to 0.0. Default is 0.0. + Is the current Runtime platform a known mobile platform. - + - Rolloff factor for room effect. Ranges from 0.0 to 10.0. Default is 10.0. + Returns true when in any kind of player (Read Only). - + - Reverb presets used by the Reverb Zone class and the audio reverb filter. + Checks whether splash screen is being shown. - + - Alley preset. + Are we running inside a web player? (Read Only) - + - Arena preset. + The total number of levels available (Read Only). - + - Auditorium preset. + The level index that was last loaded (Read Only). - + - Bathroom preset. + The name of the level that was last loaded (Read Only). - + - Carpeted hallway preset. + Event that is fired if a log message is received. + - + - Cave preset. + Event that is fired if a log message is received. + - + - City preset. + This event occurs when a mobile device notifies of low memory. You can release other non-critical assets from memory in response to this in order to avoid the app being terminated. For example, textures audio clips or also loading smaller versions of such assets. + - + - Concert hall preset. + Contains the path to a persistent data directory (Read Only). - + - Dizzy preset. + Returns the platform the game is running on (Read Only). - + - Drugged preset. + Returns application product name (Read Only). - + - Forest preset. + Should the player be running when the application is in the background? - + - Generic preset. + Returns application running in sandbox (Read Only). - + - Hallway preset. + The path to the web player data file relative to the html file (Read Only). - + - Hangar preset. + Stack trace logging options. The default value is StackTraceLogType.ScriptOnly. - + - Livingroom preset. + How many bytes have we downloaded from the main unity web stream (Read Only). - + - Mountains preset. + Contains the path to the StreamingAssets folder (Read Only). - + - No reverb preset selected. + The language the user's operating system is running in. - + - Padded cell preset. + Instructs game to try to render at a specified frame rate. - + - Parking Lot preset. + Contains the path to a temporary data / cache directory (Read Only). - + - Plain preset. + The version of the Unity runtime used to play the content. - + - Psychotic preset. + Returns application version number (Read Only). - + - Quarry preset. + Indicates whether Unity's webplayer security model is enabled. - + - Room preset. + Delegate method for fetching advertising ID. + Advertising ID. + Indicates whether user has chosen to limit ad tracking. + Error message. - + - Sewer pipe preset. + Cancels quitting the application. This is useful for showing a splash screen at the end of a game. - + - Stone corridor preset. + Can the streamed level be loaded? + - + - Stoneroom preset. + Can the streamed level be loaded? + - + - Underwater presset. + Captures a screenshot at path filename as a PNG file. + Pathname to save the screenshot file to. + Factor by which to increase resolution. - + - User defined preset. + Captures a screenshot at path filename as a PNG file. + Pathname to save the screenshot file to. + Factor by which to increase resolution. - + - Reverb Zones are used when you want to create location based ambient effects in the scene. + 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. - + - High-frequency to mid-frequency decay time ratio. + Execution of a script function in the contained web page. + The Javascript function to call. - + - Reverberation decay time at mid frequencies. + Returns an array of feature tags in use for this build (Read Only). - + - Value that controls the modal density in the late reverberation decay. + Get stack trace logging options. The default value is StackTraceLogType.ScriptOnly. + - + - Value that controls the echo density in the late reverberation decay. + How far has the download progressed? [0...1]. + - + - The distance from the centerpoint that the reverb will not have any effect. Default = 15.0. + How far has the download progressed? [0...1]. + - + - The distance from the centerpoint that the reverb will have full effect at. Default = 10.0. + Is Unity activated with the Pro license? - + - Early reflections level relative to room effect. + Check if the user has authorized use of the webcam or microphone in the Web Player. + - + - Initial reflection delay time. + Loads the level by its name or index. + The level to load. + The name of the level to load. - + - Late reverberation level relative to room effect. + Loads the level by its name or index. + The level to load. + The name of the level to load. - + - Late reverberation delay time relative to initial reflection. + Loads a level additively. + + - + - Set/Get reverb preset properties. + Loads a level additively. + + - + - Room effect level (at mid frequencies). + Loads the level additively and asynchronously in the background. + + - + - Relative room effect level at high frequencies. + Loads the level additively and asynchronously in the background. + + - + - Relative room effect level at low frequencies. + Loads the level asynchronously in the background. + + - + - Like rolloffscale in global settings, but for reverb room size effect. + Loads the level asynchronously in the background. + + - + - Reference high frequency (hz). + Use this delegate type with Application.logMessageReceived or Application.logMessageReceivedThreaded to monitor what gets logged. + + + - + - Reference low frequency (hz). + This is the delegate function when a mobile device notifies of low memory. - + - Rolloff modes that a 3D sound can have in an audio source. + Opens the url in a browser. + - + - Use this when you want to use a custom rolloff. + Quits the player application. - + - Use this mode when you want to lower the volume of your sound over the distance. + 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. + - + - Use this mode when you want a real-world rolloff. + Request authorization to use the webcam or microphone in the Web Player. + - + - Controls the global audio settings from script. + Set stack trace logging options. The default value is StackTraceLogType.ScriptOnly. + + - + - Returns the speaker mode capability of the current audio driver. (Read Only) + Unloads the Unity runtime. - + - Returns the current time of the audio system. + 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. + - + - Get the mixer's current output rate. + 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. + - + - Gets the current speaker mode. Default is 2 channel stereo. + Application installation mode (Read Only). - + - 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. + Application installed via ad hoc distribution. - 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. + Application installed via developer build. - - The new configuration to be applied. - - + - Get the mixer's buffer size in samples. + Application running in editor. - Is the length of each buffer in the ringbuffer. - Is number of buffers. - + - 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. + Application installed via enterprise distribution. - 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. + Application installed via online store. - The new configuration to be used. - - True if all settings could be successfully applied. - - + - A representation of audio sources in 3D. + Application install mode unknown. - + - Bypass effects (Applied from filter components or global listener filters). + Application sandbox type. - + - 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. + Application not running in a sandbox. - + - When set doesn't route the signal from an AudioSource into the global reverb associated with reverb zones. + Application is running in broken sandbox. - + - The default AudioClip to play. + Application is running in a sandbox. - + - Sets the Doppler scale for this AudioSource. + Application sandbox type is unknown. - + - 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. + Applies forces within an area. - + - This makes the audio source not take into account the volume of the audio listener. + The angular drag to apply to rigid-bodies. - + - Is the clip playing right now (Read Only)? + The linear drag to apply to rigid-bodies. - + - Is the audio clip looping? + The angle of the force to be applied. - + - (Logarithmic rolloff) MaxDistance is the distance a sound stops attenuating at. + The magnitude of the force to be applied. - + - Within the Min distance the AudioSource will cease to grow louder in volume. + The target for where the effector applies any force. - + - Un- / Mutes the AudioSource. Mute sets the volume=0, Un-Mute restore the original volume. + The variation of the magnitude of the force to be applied. - + - The target group to which the AudioSource should route its signal. + Should the forceAngle use global space? - + - Pan has been deprecated. Use panStereo instead. + Assembly level attribute. Any classes in an assembly with this attribute will be considered to be Editor Classes. - + - PanLevel has been deprecated. Use spatialBlend instead. + Constructor. - + - Pans a playing sound in a stereo way (left or right). This only applies to sounds that are Mono or Stereo. + The Assert class contains assertion methods for setting invariants in the code. - + - The pitch of the audio source. + Should an exception be thrown on a failure. - + - If set to true, the audio source will automatically start playing on awake. + Asserts that the values are approximately equal. An absolute error check is used for approximate equality check (|a-b| < tolerance). Default tolerance is 0.00001f. + +Note: Every time you call the method with tolerance specified, a new instance of Assertions.Comparers.FloatComparer is created. For performance reasons you might want to instance your own comparer and pass it to the AreEqual method. If the tolerance is not specifies, a default comparer is used and the issue does not occur. + Tolerance of approximation. + + + - + - Sets the priority of the AudioSource. + Asserts that the values are approximately equal. An absolute error check is used for approximate equality check (|a-b| < tolerance). Default tolerance is 0.00001f. + +Note: Every time you call the method with tolerance specified, a new instance of Assertions.Comparers.FloatComparer is created. For performance reasons you might want to instance your own comparer and pass it to the AreEqual method. If the tolerance is not specifies, a default comparer is used and the issue does not occur. + Tolerance of approximation. + + + - + - The amount by which the signal from the AudioSource will be mixed into the global reverb associated with the Reverb Zones. + Asserts that the values are approximately equal. An absolute error check is used for approximate equality check (|a-b| < tolerance). Default tolerance is 0.00001f. + +Note: Every time you call the method with tolerance specified, a new instance of Assertions.Comparers.FloatComparer is created. For performance reasons you might want to instance your own comparer and pass it to the AreEqual method. If the tolerance is not specifies, a default comparer is used and the issue does not occur. + Tolerance of approximation. + + + - + - Sets/Gets how the AudioSource attenuates over distance. + Asserts that the values are approximately equal. An absolute error check is used for approximate equality check (|a-b| < tolerance). Default tolerance is 0.00001f. + +Note: Every time you call the method with tolerance specified, a new instance of Assertions.Comparers.FloatComparer is created. For performance reasons you might want to instance your own comparer and pass it to the AreEqual method. If the tolerance is not specifies, a default comparer is used and the issue does not occur. + Tolerance of approximation. + + + - + - 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. + Asserts that the values are equal. If no comparer is specified, EqualityComparer<T>.Default is used. + + + + - + - Enables or disables spatialization. + Asserts that the values are equal. If no comparer is specified, EqualityComparer<T>.Default is used. + + + + - + - Sets the spread angle (in degrees) of a 3d stereo or multichannel sound in speaker space. + Asserts that the values are equal. If no comparer is specified, EqualityComparer<T>.Default is used. + + + + - + - Playback position in seconds. + Asserts that the values are approximately not equal. An absolute error check is used for approximate equality check (|a-b| < tolerance). Default tolerance is 0.00001f. + Tolerance of approximation. + + + - + - Playback position in PCM samples. + Asserts that the values are approximately not equal. An absolute error check is used for approximate equality check (|a-b| < tolerance). Default tolerance is 0.00001f. + Tolerance of approximation. + + + - + - Whether the Audio Source should be updated in the fixed or dynamic update. + Asserts that the values are approximately not equal. An absolute error check is used for approximate equality check (|a-b| < tolerance). Default tolerance is 0.00001f. + Tolerance of approximation. + + + - + - The volume of the audio source (0.0 to 1.0). + Asserts that the values are approximately not equal. An absolute error check is used for approximate equality check (|a-b| < tolerance). Default tolerance is 0.00001f. + Tolerance of approximation. + + + - + - Get the current custom curve for the given AudioSourceCurveType. + Asserts that the values are not equal. - 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. + Asserts that the values are not equal. - 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. + Asserts that the values are not equal. - - + + + + - + - Reads a user-defined parameter of a custom spatializer effect that is attached to an AudioSource. + Asserts that the condition is false. - 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. - - - - + + - + - Pauses playing the clip. + Asserts that the condition is false. + + - + - Plays the clip with an optional certain delay. + Asserts that the value is not null. - 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 with an optional certain delay. + Asserts that the value is not null. - 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. + Asserts that the value is null. - Audio data to play. - Position in world space from which sound originates. - Playback volume. + + - + - Plays an AudioClip at a given position in world space. + Asserts that the value is null. - 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. + Asserts that the condition is true. - Delay time specified in seconds. + + - + - Plays an AudioClip, and scales the AudioSource volume by volumeScale. + Asserts that the condition is true. - The clip being played. - The scale of the volume (0-1). + + - + - Plays an AudioClip, and scales the AudioSource volume by volumeScale. + An exception that is thrown on a failure. Assertions.Assert._raiseExceptions needs to be set to true. - 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. + A float comparer used by Assertions.Assert performing approximate comparison. - Time in seconds on the absolute time-line that AudioSettings.dspTime refers to for when the sound should start playing. - + - Set the custom curve for the given AudioSourceCurveType. + Default epsilon used by the comparer. - 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. + Default instance of a comparer class with deafult error epsilon and absolute error check. - Time in seconds. - + - Changes the time at which a sound that has already been scheduled to play will start. + Performs equality check with absolute error check. - Time in seconds. + Expected value. + Actual value. + Comparison error. + + Result of the comparison. + - + - Sets a user-defined parameter of a custom spatializer effect that is attached to an AudioSource. + Performs equality check with relative error check. - Zero-based index of user-defined parameter to be set. - New value of the user-defined parameter. + Expected value. + Actual value. + Comparison error. - True, if the parameter could be set. + Result of the comparison. - + - Stops playing the clip. + 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. - + - Unpause the paused playback of this AudioSource. + 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. - + - This defines the curve type of the different custom curves that can be queried and set within the AudioSource. + 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. - + - Custom Volume Rolloff. + 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. - + - Reverb Zone Mix. + An extension class that serves as a wrapper for the Assert class. - + - The Spatial Blend. + An extension method for Assertions.Assert.AreApproximatelyEqual. + + + + - + - The 3D Spread. + An extension method for Assertions.Assert.AreApproximatelyEqual. + + + + - + - These are speaker types defined for use with AudioSettings.speakerMode. + An extension method for Assertions.Assert.AreApproximatelyEqual. + + + + - + - Channel count is set to 6. 5.1 speaker setup. This includes front left, front right, center, rear left, rear right and a subwoofer. + An extension method for Assertions.Assert.AreApproximatelyEqual. + + + + - + - 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. + An extension method for Assertions.Assert.AreEqual. + + + - + - Channel count is set to 1. The speakers are monaural. + An extension method for Assertions.Assert.AreEqual. + + + - + - 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. + An extension method for Assertions.Assert.IsFalse. + + - + - Channel count is set to 4. 4 speaker setup. This includes front left, front right, rear left, rear right. + An extension method for Assertions.Assert.IsFalse. + + - + - Channel count is unaffected. + An extension method for Assertions.Assert.IsNull. + + - + - Channel count is set to 2. The speakers are stereo. This is the editor default. + An extension method for Assertions.Assert.IsNull. + + - + - Channel count is set to 5. 5 speaker setup. This includes front left, front right, center, rear left, rear right. + An extension method for Assertions.Assert.IsTrue. + + - + - Type of the imported(native) data. + An extension method for Assertions.Assert.IsTrue. + + - + - Acc - not supported. + An extension method for Assertions.Assert.AreNotApproximatelyEqual. + + + + - + - Aiff. + An extension method for Assertions.Assert.AreNotApproximatelyEqual. + + + + - + - iPhone hardware decoder, supports AAC, ALAC and MP3. Extracodecdata is a pointer to an FMOD_AUDIOQUEUE_EXTRACODECDATA structure. + An extension method for Assertions.Assert.AreNotApproximatelyEqual. + + + + - + - Impulse tracker. + An extension method for Assertions.Assert.AreNotApproximatelyEqual. + + + + - + - Protracker / Fasttracker MOD. + An extension method for Assertions.Assert.AreNotEqual. + + + - + - MP2/MP3 MPEG. + An extension method for Assertions.Assert.AreNotEqual. + + + - + - Ogg vorbis. + An extension method for Assertions.Assert.AreNotNull. + + - + - ScreamTracker 3. + An extension method for Assertions.Assert.AreNotNull. + + - + - 3rd party / unknown plugin format. + AssetBundles let you stream additional assets via the WWW class and instantiate them at runtime. AssetBundles are created via BuildPipeline.BuildAssetBundle. - + - VAG. + Return true if the AssetBundle is a streamed scene AssetBundle. - + - Microsoft WAV. + Main asset that was supplied when building the asset bundle (Read Only). - + - FastTracker 2 XM. + Check if an AssetBundle contains a specific object. + - + - Xbox360 XMA. + Loads an asset bundle from a disk. + Path of the file on disk + +See Also: WWW.assetBundle, WWW.LoadFromCacheOrDownload. - + - Describes when an AudioSource or AudioListener is updated. + Asynchronously create an AssetBundle from a memory region. + - + - Updates the source or listener in the fixed update loop if it is attached to a Rigidbody, dynamic otherwise. + Synchronously create an AssetBundle from a memory region. + Array of bytes with the AssetBundle data. - + - Updates the source or listener in the dynamic update loop. + Return all asset names in the AssetBundle. - + - Updates the source or listener in the fixed update loop. + Return all the scene asset paths (paths to *.unity assets) in the AssetBundle. - + - Avatar definition. + Loads all assets contained in the asset bundle that inherit from type. + - + - Return true if this avatar is a valid human avatar. + Loads all assets contained in the asset bundle. - + - Return true if this avatar is a valid mecanim avatar. It can be a generic avatar or a human avatar. + Loads all assets contained in the asset bundle that inherit from type T. - + - Class to build avatars from user scripts. + Loads all assets contained in the asset bundle asynchronously. - + - Create a new generic avatar. + Loads all assets contained in the asset bundle that inherit from T asynchronously. - 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. + Loads all assets contained in the asset bundle that inherit from type asynchronously. - Root object of your transform hierachy. - Description of the avatar. + - + - IK Goal. + Loads asset with name from the bundle. + - + - The left foot. + Loads asset with name of a given type from the bundle. + + - + - The left hand. + Loads asset with name of type T from the bundle. + - + - The right foot. + Asynchronously loads asset with name from the bundle. + - + - The right hand. + Asynchronously loads asset with name of a given T from the bundle. + - + - IK Hint. + Asynchronously loads asset with name of a given type from the bundle. + + - + - The left elbow IK hint. + Loads asset and sub assets with name from the bundle. + - + - The left knee IK hint. + Loads asset and sub assets with name of a given type from the bundle. + + - + - The right elbow IK hint. + Loads asset and sub assets with name of type T from the bundle. + - + - The right knee IK hint. + Loads asset with sub assets with name from the bundle asynchronously. + - + - Target. + Loads asset with sub assets with name of type T from the bundle asynchronously. + - + - The body, center of mass. + Loads asset with sub assets with name of a given type from the bundle asynchronously. + + - + - The left foot. + 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. + - + - The left hand. + 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. + - + - The right foot. + 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. + - + - The right hand. + 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. + - + - The root, the position of the game object. + 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. + - + - Behaviours are Components that can be enabled or disabled. + Unloads all assets in the bundle. + - + - Enabled Behaviours are Updated, disabled Behaviours are not. + Asynchronous create request for an AssetBundle. - + - Has the Behaviour had enabled called. + Asset object being loaded (Read Only). - + - BillboardAsset describes how a billboard is rendered. + Manifest for all the AssetBundles in the build. - + - Height of the billboard that is below ground. + Get all the AssetBundles in the manifest. + + An array of asset bundle names. + - + - Height of the billboard. + Get all the AssetBundles with variant in the manifest. + + An array of asset bundle names. + - + - Number of pre-baked images that can be switched when the billboard is viewed from different angles. + Get all the dependent AssetBundles for the given AssetBundle. + Name of the asset bundle. - + - Number of indices in the billboard mesh. The mesh is not necessarily a quad. It can be a more complex shape which fits the actual image more precisely. + Get the hash for the given AssetBundle. + Name of the asset bundle. + + The 128-bit hash for the asset bundle. + - + - The material used for rendering. + Get the direct dependent AssetBundles for the given AssetBundle. + Name of the asset bundle. + + Array of asset bundle names this asset bundle depends on. + - + - Number of vertices in the billboard mesh. The mesh is not necessarily a quad. It can be a more complex shape which fits the actual image more precisely. + Asynchronous load request from an AssetBundle. - + - Width of the billboard. + Asset objects with sub assets being loaded. (Read Only) - + - Constructs a new BillboardAsset. + Asset object being loaded (Read Only). - + - Renders a billboard. + Asynchronous operation coroutine. - + - The BillboardAsset to render. + Allow scenes to be activated as soon as it is ready. - + - Constructor. + Has the operation finished? (Read Only) - + - The BitStream class represents seralized variables, packed into a stream. + Priority lets you tweak in which order async operation calls will be performed. - + - Is the BitStream currently being read? (Read Only) + What's the operation's progress. (Read Only) - + - Is the BitStream currently being written? (Read Only) + AudioMixer asset. - + - Serializes different types of variables. + Routing target. - - - - + - Serializes different types of variables. + How time should progress for this AudioMixer. Used during Snapshot transitions. - - - - + - Serializes different types of variables. + Resets an exposed parameter to its initial value. - - - + Exposed parameter. + + Returns false if the parameter was not found or could not be set. + - + - Serializes different types of variables. + 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. + - + - Serializes different types of variables. + The name must be an exact match. - - - + Name of snapshot object to be returned. + + The snapshot identified by the name. + - + - Serializes different types of variables. + 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. + - + - Serializes different types of variables. + 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. + - + - Serializes different types of variables. + 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. - + - Serializes different types of variables. + Object representing a group in the mixer. - - - - + - Serializes different types of variables. + Object representing a snapshot in the mixer. - - - - + - Serializes different types of variables. + 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. - + - Serializes different types of variables. + The mode in which an AudioMixer should update its time. - - - - + - Blend weights. + Update the AudioMixer with scaled game time. - + - Four bones affect each vertex. + Update the AudioMixer with unscaled realtime. - + - One bone affects each vertex. + The Audio Chorus Filter takes an Audio Clip and processes it creating a chorus effect. - + - Two bones affect each vertex. + Chorus delay in ms. 0.1 to 100.0. Default = 40.0 ms. - + - Skinning bone weights of a vertex in the mesh. + Chorus modulation depth. 0.0 to 1.0. Default = 0.03. - + - Index of first bone. + Volume of original signal to pass to output. 0.0 to 1.0. Default = 0.5. - + - Index of second bone. + Chorus feedback. Controls how much of the wet signal gets fed back into the chorus buffer. 0.0 to 1.0. Default = 0.0. - + - Index of third bone. + Chorus modulation rate in hz. 0.0 to 20.0. Default = 0.8 hz. - + - Index of fourth bone. + Volume of 1st chorus tap. 0.0 to 1.0. Default = 0.5. - + - Skinning weight for first bone. + 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. - + - Skinning weight for second bone. + 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. - + - Skinning weight for third bone. + A container for audio data. - + - Skinning weight for fourth bone. + The number of channels in the audio clip. (Read Only) - + - Describes a single bounding sphere for use by a CullingGroup. + The sample frequency of the clip in Hertz. (Read Only) - + - The position of the center of the BoundingSphere. + Returns true if the AudioClip is ready to play (read-only). - + - The radius of the BoundingSphere. + The length of the audio clip in seconds. (Read Only) - + - Initializes a BoundingSphere. + 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. - 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. + Returns the current load state of the audio data associated with an AudioClip. - 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 load type of the clip (read-only). - + - The center of the bounding box. + 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 extents of the box. This is always half of the size. + The length of the audio clip in samples. (Read Only) - + - The maximal point of the box. This is always equal to center+extents. + 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. + - + - The minimal point of the box. This is always equal to center-extents. + 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. + - + - The total size of the box. This is always twice as large as the extents. + 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. + - + - The closest point on the bounding box. + Creates a user AudioClip with a name and with the given length in samples, channels and frequency. - Arbitrary point. + 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. - The point on the bounding box or inside the bounding box. + A reference to the created AudioClip. - + - Is point contained in the bounding box? + 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 new Bounds with a given center and total size. Bound extents will be half the given size. + 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. + - + - Grows the Bounds to include the point. + Fills an array with sample data from the clip. - + + - + - Grow the bounds to encapsulate the bounds. + 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. + - + - Expand the bounds by increasing its size by amount along each side. + Delegate called each time AudioClip reads data. - + Array of floats containing data read from the clip. - + - Expand the bounds by increasing its size by amount along each side. + Delegate called each time AudioClip changes read position. - + New position in the audio clip. - + - Does ray intersect this bounding box? + Set sample data in a clip. - + + - + - Does ray intersect this bounding box? + 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. + - + - Does another bounding box intersect with this bounding box? + Determines how the audio clip is loaded in. - - + - Sets the bounds to the min and max value of the box. + The audio data of the clip will be kept in memory in compressed form. - - - + - The smallest squared distance between the point and this bounding box. + The audio data is decompressed when the audio clip is loaded. - - + - Returns a nicely formatted string for the bounds. + Streams audio data from disk. - - + - Returns a nicely formatted string for the bounds. + An enum containing different compression types. - - + - A box-shaped primitive collider. + AAC Audio Compression. - + - The center of the box, measured in the object's local space. + Adaptive differential pulse-code modulation. - + - The size of the box, measured in the object's local space. + Sony proprietary hardware format. - + - Collider for 2D physics representing an axis-aligned rectangle. + Nintendo ADPCM audio compression format. - + - The center point of the collider in local space. + Sony proprietory hardware codec. - + - The width and height of the rectangle. + MPEG Audio Layer III. - + - Applies forces to simulate buoyancy, fluid-flow and fluid drag. + Uncompressed pulse-code modulation. - + - A force applied to slow angular movement of any Collider2D in contact with the effector. + Sony proprietary hardware format. - + - The density of the fluid used to calculate the buoyancy forces. + Vorbis compression format. - + - The angle of the force used to similate fluid flow. + Xbox One proprietary hardware format. - + - The magnitude of the force used to similate fluid flow. + Specifies the current properties or desired properties to be set for the audio system. - + - The random variation of the force used to similate fluid flow. + The length of the DSP buffer in samples determining the latency of sounds by the audio output device. - + - A force applied to slow linear movement of any Collider2D in contact with the effector. + The current maximum number of simultaneously audible sounds in the game. - + - Defines an arbitrary horizontal line that represents the fluid surface level. + The maximum number of managed sounds in the game. Beyond this limit sounds will simply stop playing. - + - The Caching class lets you manage cached AssetBundles, downloaded using WWW.LoadFromCacheOrDownload. + The current sample rate of the audio output device used. - + - Controls compression of cache data. Enabled by default. + The current speaker mode used by the audio output device. - + - Is Caching enabled? + Value describing the current load state of the audio data associated with an AudioClip. - + - The number of seconds that an AssetBundle may remain unused in the cache before it is automatically deleted. + Value returned by AudioClip.loadState for an AudioClip that has failed loading its audio data. - + - The total number of bytes that can potentially be allocated for caching. + Value returned by AudioClip.loadState for an AudioClip that has succeeded loading its audio data. - + - Is caching ready? + Value returned by AudioClip.loadState for an AudioClip that is currently loading audio data. - + - The number of currently unused bytes in the cache. + Value returned by AudioClip.loadState for an AudioClip that has no audio data loaded and where loading has not been initiated yet. - + - Used disk space in bytes. + The Audio Distortion Filter distorts the sound from an AudioSource or sounds reaching the AudioListener. - + - (This is a WebPlayer-only function). + Distortion value. 0.0 to 1.0. Default = 0.5. - Signature The authentification signature provided by Unity. - Size The number of bytes allocated to this cache. - - - - - - + - (This is a WebPlayer-only function). + The Audio Echo Filter repeats a sound after a given Delay, attenuating the repetitions based on the Decay Ratio. - Signature The authentification signature provided by Unity. - Size The number of bytes allocated to this cache. - - - - - - + - TODO. + Echo decay per delay. 0 to 1. 1.0 = No decay, 0.0 = total decay (i.e. simple 1 line delay). Default = 0.5. - - - - - - + - TODO. + Echo delay in ms. 10 to 5000. Default = 500. - - - - - - + - Delete all AssetBundle and Procedural Material content that has been cached by the current application. + Volume of original signal to pass to output. 0.0 to 1.0. Default = 1.0. - - True when cache cleaning succeeded, false if cache was in use. - - + - Checks if an AssetBundle is cached. + Volume of echo signal to pass to output. 0.0 to 1.0. Default = 1.0. - 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 WWW.LoadFromCacheOrDownload() 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. + The Audio High Pass Filter passes high frequencies of an AudioSource, and cuts off signals with frequencies lower than the Cutoff Frequency. - - - + - A Camera is a device through which the player views the world. + Highpass cutoff frequency in hz. 10.0 to 22000.0. Default = 5000.0. - + - The rendering path that is currently being used (Read Only). - -The actual rendering path might be different from the user-specified renderingPath if the underlying gpu/platform does not support the requested one, or some other situation caused a fallback (for example, deferred rendering is not supported with orthographic projection cameras). + Determines how much the filter's self-resonance isdampened. - + - Returns all enabled cameras in the scene. + Representation of a listener in 3D space. - + - The number of cameras in the current scene. + The paused state of the audio system. - + - The aspect ratio (width divided by height). + This lets you set whether the Audio Listener should be updated in the fixed or dynamic update. - + - The color with which the screen will be cleared. + Controls the game sound volume (0.0 to 1.0). - + - Matrix that transforms from camera space to world space (Read Only). + 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. - + - Identifies what kind of camera this is. + Deprecated Version. Returns a block of the listener (master)'s output data. + + - + - How the camera clears the background. + 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. - + - Should the camera clear the stencil buffer after the deferred light pass? + 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. - + - Number of command buffers set up on this camera (Read Only). + 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. - + - This is used to render parts of the scene selectively. + Returns or sets the current custom frequency cutoff curve. - + - The camera we are currently rendering with, for low-level render control only (Read Only). + Lowpass cutoff frequency in hz. 10.0 to 22000.0. Default = 5000.0. - + - Camera's depth in the camera rendering order. + Determines how much the filter's self-resonance is dampened. - + - How and if camera generates a depth texture. + The Audio Reverb Filter takes an Audio Clip and distorts it to create a custom reverb effect. - + - Mask to select which layers can trigger events on the camera. + Decay HF Ratio : High-frequency to low-frequency decay time ratio. Ranges from 0.1 to 2.0. Default is 0.5. - + - The far clipping plane distance. + Reverberation decay time at low-frequencies in seconds. Ranges from 0.1 to 20.0. Default is 1.0. - + - The field of view of the camera in degrees. + Reverberation density (modal density) in percent. Ranges from 0.0 to 100.0. Default is 100.0. - + - High dynamic range rendering. + Reverberation diffusion (echo density) in percent. Ranges from 0.0 to 100.0. Default is 100.0. - + - Per-layer culling distances. + Mix level of dry signal in output in mB. Ranges from -10000.0 to 0.0. Default is 0. - + - How to perform per-layer culling for a Camera. + Reference high frequency in Hz. Ranges from 20.0 to 20000.0. Default is 5000.0. - + - The first enabled camera tagged "MainCamera" (Read Only). + Reference low-frequency in Hz. Ranges from 20.0 to 1000.0. Default is 250.0. - + - The near clipping plane distance. + Late reverberation level relative to room effect in mB. Ranges from -10000.0 to 2000.0. Default is 0.0. - + - Event that is fired after any camera finishes rendering. + Early reflections level relative to room effect in mB. Ranges from -10000.0 to 1000.0. Default is -10000.0. - + - Event that is fired before any camera starts culling. + Late reverberation delay time relative to first reflection in seconds. Ranges from 0.0 to 0.1. Default is 0.04. - + - Event that is fired before any camera starts rendering. + Late reverberation level relative to room effect in mB. Ranges from -10000.0 to 2000.0. Default is 0.0. - + - Opaque object sorting mode. + Set/Get reverb preset properties. - + - Is the camera orthographic (true) or perspective (false)? + Room effect level at low frequencies in mB. Ranges from -10000.0 to 0.0. Default is 0.0. - + - Camera's half-size when in orthographic mode. + Room effect high-frequency level re. low frequency level in mB. Ranges from -10000.0 to 0.0. Default is 0.0. - + - How tall is the camera in pixels (Read Only). + Room effect low-frequency level in mB. Ranges from -10000.0 to 0.0. Default is 0.0. - + - Where on the screen is the camera rendered in pixel coordinates. + Reverb presets used by the Reverb Zone class and the audio reverb filter. - + - How wide is the camera in pixels (Read Only). + Alley preset. - + - Set a custom projection matrix. + Arena preset. - + - Where on the screen is the camera rendered in normalized coordinates. + Auditorium preset. - + - The rendering path that should be used, if possible. - -In some situations, it may not be possible to use the rendering path specified, in which case the renderer will automatically use a different path. For example, if the underlying gpu/platform does not support the requested one, or some other situation caused a fallback (for example, deferred rendering is not supported with orthographic projection cameras). - -For this reason, we also provide the read-only property actualRenderingPath which allows you to discover which path is actually being used. + Bathroom preset. - + - Distance to a point where virtual eyes converge. + Carpeted hallway preset. - + - Stereoscopic rendering. + Cave preset. - + - Render only once and use resulting image for both eyes. + City preset. - + - Distance between the virtual eyes. + Concert hall preset. - + - Set the target display for this Camera. + Dizzy preset. - + - Destination render texture. + Drugged preset. - + - Transparent object sorting mode. + Forest preset. - + - Whether or not the Camera will use occlusion culling during rendering. + Generic preset. - + - Get the world-space speed of the camera (Read Only). + Hallway preset. - + - Matrix that transforms from world to camera space. + Hangar preset. - + - Add a command buffer to be executed at a specified place. + Livingroom preset. - When to execute the command buffer during rendering. - The buffer to execute. - + - Calculates and returns oblique near-plane projection matrix. + Mountains preset. - Vector4 that describes a clip plane. - - Oblique near-plane projection matrix. - - + - Delegate type for camera callbacks. + No reverb preset selected. - - + - Makes this camera's settings match other camera. + Padded cell preset. - - + - Fills an array of Camera with the current cameras in the scene, without allocating a new array. + Parking Lot preset. - An array to be filled up with cameras currently in the scene. - + - Get command buffers to be executed at a specified place. + Plain preset. - When to execute the command buffer during rendering. - - Array of command buffers. - - + - Remove all command buffers set on this camera. + Psychotic preset. - + - Remove command buffer from execution at a specified place. + Quarry preset. - When to execute the command buffer during rendering. - The buffer to execute. - + - Remove command buffers from execution at a specified place. + Room preset. - When to execute the command buffer during rendering. - + - Render the camera manually. + Sewer pipe preset. - + - Render into a static cubemap from this camera. + Stone corridor preset. - The cube map to render to. - A bitmask which determines which of the six faces are rendered to. - - False is rendering fails, else true. - - + - Render into a cubemap from this camera. + Stoneroom preset. - A bitfield indicating which cubemap faces should be rendered into. - The texture to render to. - - False is rendering fails, else true. - - + - Render the camera with shader replacement. + Underwater presset. - - - + - Revert the aspect ratio to the screen's aspect ratio. + User defined preset. - + - Reset to the default field of view. + Reverb Zones are used when you want to create location based ambient effects in the scene. - + - Make the projection reflect normal camera's parameters. + High-frequency to mid-frequency decay time ratio. - + - Remove shader replacement from camera. + Reverberation decay time at mid frequencies. - + - Use the default projection matrix for both stereo eye. Only work in 3D flat panel display. + Value that controls the modal density in the late reverberation decay. - + - Use the default view matrix for both stereo eye. Only work in 3D flat panel display. + Value that controls the echo density in the late reverberation decay. - + - Make the rendering position reflect the camera's position in the scene. + The distance from the centerpoint that the reverb will not have any effect. Default = 15.0. - + - Returns a ray going from camera through a screen point. + The distance from the centerpoint that the reverb will have full effect at. Default = 10.0. - - + - Transforms position from screen space into viewport space. + Early reflections level relative to room effect. - - + - Transforms position from screen space into world space. + Initial reflection delay time. - - + - Make the camera render with shader replacement. + Late reverberation level relative to room effect. - - - + - Define the projection matrix for both stereo eye. Only work in 3D flat panel display. + Late reverberation delay time relative to initial reflection. - Projection matrix for the stereo left eye. - Projection matrix for the stereo left eye. - + - Define the view matrices for both stereo eye. Only work in 3D flat panel display. + Set/Get reverb preset properties. - View matrix for the stereo left eye. - View matrix for the stereo right eye. - + - Sets the Camera to render to the chosen buffers of one or more RenderTextures. + Room effect level (at mid frequencies). - 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. + Relative room effect level at high frequencies. - The RenderBuffer(s) to which color information will be rendered. - The RenderBuffer to which depth information will be rendered. - + - Returns a ray going from camera through a viewport point. + Relative room effect level at low frequencies. - - + - Transforms position from viewport space into screen space. + Like rolloffscale in global settings, but for reverb room size effect. - - + - Transforms position from viewport space into world space. + Reference high frequency (hz). - - + - Transforms position from world space into screen space. + Reference low frequency (hz). - - + - Transforms position from world space into viewport space. + Rolloff modes that a 3D sound can have in an audio source. - - + - Values for Camera.clearFlags, determining what to clear when rendering a Camera. + Use this when you want to use a custom rolloff. - + - Clear only the depth buffer. + Use this mode when you want to lower the volume of your sound over the distance. - + - Don't clear anything. + Use this mode when you want a real-world rolloff. - + - Clear with the skybox. + Controls the global audio settings from script. - + - Clear with a background color. + Returns the speaker mode capability of the current audio driver. (Read Only) - + - Describes different types of camera. + Returns the current time of the audio system. - + - Used to indicate a regular in-game camera. + Get the mixer's current output rate. - + - Used to indicate a camera that is used for rendering previews in the Editor. + Gets the current speaker mode. Default is 2 channel stereo. - + - Used to indicate that a camera is used for rendering the Scene View in the Editor. + 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. - + - Element that can be used for screen rendering. + 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. + - + - Cached calculated value based upon SortingLayerID. + Get the mixer's buffer size in samples. + Is the length of each buffer in the ringbuffer. + Is number of buffers. - + - Is this the root Canvas? + 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. - + - Allows for nested canvases to override pixelPerfect settings inherited from parent canvases. + 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. + - + - Override the sorting of canvas. + A representation of audio sources in 3D. - + - Force elements in the canvas to be aligned with pixels. Only applies with renderMode is Screen Space. + Bypass effects (Applied from filter components or global listener filters). - + - Get the render rect for the Canvas. + 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. - + - How far away from the camera is the Canvas generated. + When set doesn't route the signal from an AudioSource into the global reverb associated with reverb zones. - + - The number of pixels per unit that is considered the default. + The default AudioClip to play. - + - Is the Canvas in World or Overlay mode? + Sets the Doppler scale for this AudioSource. - + - The render order in which the canvas is being emitted to the scene. + 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. - + - Used to scale the entire canvas, while still making it fit the screen. Only applies with renderMode is Screen Space. + This makes the audio source not take into account the volume of the audio listener. - + - The normalized grid size that the canvas will split the renderable area into. + Is the clip playing right now (Read Only)? - + - Unique ID of the Canvas' sorting layer. + 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. - + - Name of the Canvas' sorting layer. + Is the audio clip looping? - + - Canvas' order within a sorting layer. + (Logarithmic rolloff) MaxDistance is the distance a sound stops attenuating at. - + - For Overlay mode, display index on which the UI canvas will appear. + Within the Min distance the AudioSource will cease to grow louder in volume. - + - Event that is called just before Canvas rendering happens. + Un- / Mutes the AudioSource. Mute sets the volume=0, Un-Mute restore the original volume. - - + - 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]. + The target group to which the AudioSource should route its signal. - + - Force all canvases to update their content. + Pan has been deprecated. Use panStereo instead. - + - Returns the default material that can be used for rendering normal elements on the Canvas. + PanLevel has been deprecated. Use spatialBlend instead. - + - Returns the default material that can be used for rendering text elements on the Canvas. + Pans a playing sound in a stereo way (left or right). This only applies to sounds that are Mono or Stereo. - + - A Canvas placable element that can be used to modify children Alpha, Raycasting, Enabled state. + The pitch of the audio source. - + - Set the alpha of the group. + If set to true, the audio source will automatically start playing on awake. - + - Does this group block raycasting (allow collision). + Sets the priority of the AudioSource. - + - Should the group ignore parent groups? + The amount by which the signal from the AudioSource will be mixed into the global reverb associated with the Reverb Zones. - + - Is the group interactable (are the elements beneath the group enabled). + Sets/Gets how the AudioSource attenuates over distance. - + - Returns true if the Group allows raycasts. + 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. - - - + - A component that will render to the screen after all normal rendering has completed when attached to a Canvas. Designed for GUI application. + Enables or disables spatialization. - + - Depth of the renderer relative to the root canvas. + Determines if the spatializer effect is inserted before or after the effect filters. - + - Indicates whether geometry emitted by this renderer is ignored. + Sets the spread angle (in degrees) of a 3d stereo or multichannel sound in speaker space. - + - True if any change has occured that would invalidate the positions of generated geometry. + Playback position in seconds. - + - Enable 'render stack' pop draw call. + Playback position in PCM samples. - + - True if rect clipping has been enabled on this renderer. -See Also: CanvasRenderer.EnableRectClipping, CanvasRenderer.DisableRectClipping. + Whether the Audio Source should be updated in the fixed or dynamic update. - + - Is the UIRenderer a mask component. + The volume of the audio source (0.0 to 1.0). - + - The number of materials usable by this renderer. + Get the current custom curve for the given AudioSourceCurveType. + The curve type to get. + + The custom AnimationCurve corresponding to the given curve type. + - + - (Editor Only) Event that gets fired whenever the data in the CanvasRenderer gets invalidated and needs to be rebuilt. + 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. - + - The number of materials usable by this renderer. Used internally for masking. + Deprecated Version. Returns a block of the currently playing source's output data. + + - + - Depth of the renderer realative to the parent canvas. + 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. + - + - Take the Vertex steam and split it corrisponding arrays (positions, colors, uv0s, uv1s, normals and tangents). + Provides a block of the currently playing audio source's spectrum data. - 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. + 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. - + - Remove all cached vertices. + 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. - + - Convert a set of vertex components into a stream of UIVertex. + Pauses playing the clip. - - - - - - - - - + - Disables rectangle clipping for this CanvasRenderer. + Plays the clip with an optional certain delay. + Delay in number of samples, assuming a 44100Hz sample rate (meaning that Play(44100) will delay the playing by exactly 1 sec). - + - Enables rect clipping on the CanvasRendered. Geometry outside of the specified rect will be clipped (not rendered). + Plays the clip with an optional certain delay. - + Delay in number of samples, assuming a 44100Hz sample rate (meaning that Play(44100) will delay the playing by exactly 1 sec). - + - Get the current alpha of the renderer. + Plays an AudioClip at a given position in world space. + Audio data to play. + Position in world space from which sound originates. + Playback volume. - + - Get the current color of the renderer. + Plays an AudioClip at a given position in world space. + Audio data to play. + Position in world space from which sound originates. + Playback volume. - + - Gets the current Material assigned to the CanvasRenderer. + 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. - The material index to retrieve (0 if this parameter is omitted). - - Result. - + Delay time specified in seconds. - + - Gets the current Material assigned to the CanvasRenderer. + Plays an AudioClip, and scales the AudioSource volume by volumeScale. - The material index to retrieve (0 if this parameter is omitted). - - Result. - + The clip being played. + The scale of the volume (0-1). - + - Gets the current Material assigned to the CanvasRenderer. Used internally for masking. + Plays an AudioClip, and scales the AudioSource volume by volumeScale. - + The clip being played. + The scale of the volume (0-1). - + - Set the alpha of the renderer. Will be multiplied with the UIVertex alpha and the Canvas alpha. + Plays the clip at a specific time on the absolute time-line that AudioSettings.dspTime reads from. - Alpha. + Time in seconds on the absolute time-line that AudioSettings.dspTime refers to for when the sound should start playing. - + - Set the color of the renderer. Will be multiplied with the UIVertex color and the Canvas color. + Set the custom curve for the given AudioSourceCurveType. - Renderer multiply color. + The curve type that should be set. + The curve that should be applied to the given curve type. - + - 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. + 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. - Material for rendering. - Material texture overide. - Material index. + Time in seconds. - + - 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. + Changes the time at which a sound that has already been scheduled to play will start. - Material for rendering. - Material texture overide. - Material index. + Time in seconds. - + - Sets the Mesh used by this renderer. + 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. + - + - Set the material for the canvas renderer. Used internally for masking. + Stops playing the clip. - - - + - Sets the texture used by this renderer's material. + Unpause the paused playback of this AudioSource. - - + - Set the vertices for the UIRenderer. + This defines the curve type of the different custom curves that can be queried and set within the AudioSource. - Array of vertices to set. - Number of vertices to set. - + - Set the vertices for the UIRenderer. + Custom Volume Rolloff. - Array of vertices to set. - Number of vertices to set. - + - Given a list of UIVertex, split the stream into it's component types. + Reverb Zone Mix. - - - - - - - - - + - A capsule-shaped primitive collider. + The Spatial Blend. - + - The center of the capsule, measured in the object's local space. + The 3D Spread. - + - The direction of the capsule. + These are speaker types defined for use with AudioSettings.speakerMode. - + - The height of the capsule meased in the object's local space. + Channel count is set to 6. 5.1 speaker setup. This includes front left, front right, center, rear left, rear right and a subwoofer. - + - The radius of the sphere, measured in the object's local space. + 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. - + - A CharacterController allows you to easily do movement constrained by collisions without having to deal with a rigidbody. + Channel count is set to 1. The speakers are monaural. - + - The center of the character's capsule relative to the transform's position. + 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. - + - What part of the capsule collided with the environment during the last CharacterController.Move call. + Channel count is set to 4. 4 speaker setup. This includes front left, front right, rear left, rear right. - + - Determines whether other rigidbodies or character controllers collide with this character controller (by default this is always enabled). + Channel count is unaffected. - + - The height of the character's capsule. + Channel count is set to 2. The speakers are stereo. This is the editor default. - + - Was the CharacterController touching the ground during the last move? + Channel count is set to 5. 5 speaker setup. This includes front left, front right, center, rear left, rear right. - + - The radius of the character's capsule. + Type of the imported(native) data. - + - The character's collision skin width. + Acc - not supported. - + - The character controllers slope limit in degrees. + Aiff. - + - The character controllers step offset in meters. + iPhone hardware decoder, supports AAC, ALAC and MP3. Extracodecdata is a pointer to an FMOD_AUDIOQUEUE_EXTRACODECDATA structure. - + - The current relative velocity of the Character (see notes). + Impulse tracker. - + - A more complex move function taking absolute movement deltas. + Protracker / Fasttracker MOD. - - + - Moves the character with speed. + MP2/MP3 MPEG. - - + - Specification for how to render a character from the font texture. See Font.characterInfo. + Ogg vorbis. - + - The horizontal distance from the origin of this character to the origin of the next character. + ScreamTracker 3. - + - The horizontal distance from the origin of this glyph to the begining of the glyph image. + 3rd party / unknown plugin format. - + - Is the character flipped? + VAG. - + - The height of the glyph image. + Microsoft WAV. - + - The width of the glyph image. + FastTracker 2 XM. - + - Unicode value of the character. + Xbox360 XMA. - + - The maximum extend of the glyph image in the x-axis. + Describes when an AudioSource or AudioListener is updated. - + - The maximum extend of the glyph image in the y-axis. + Updates the source or listener in the fixed update loop if it is attached to a Rigidbody, dynamic otherwise. - + - The minium extend of the glyph image in the x-axis. + Updates the source or listener in the dynamic update loop. - + - The minimum extend of the glyph image in the y-axis. + Updates the source or listener in the fixed update loop. - + - The size of the character or 0 if it is the default font size. + Avatar definition. - + - The style of the character. + Return true if this avatar is a valid human avatar. - + - UV coordinates for the character in the texture. + Return true if this avatar is a valid mecanim avatar. It can be a generic avatar or a human avatar. - + - The uv coordinate matching the bottom left of the glyph image in the font texture. + Class to build avatars from user scripts. - + - The uv coordinate matching the bottom right of the glyph image in the font texture. + 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. - + - The uv coordinate matching the top left of the glyph image in the font texture. + 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. + - + - The uv coordinate matching the top right of the glyph image in the font texture. + IK Goal. - + - Screen coordinates for the character in generated text meshes. + The left foot. - + - How far to advance between the beginning of this charcater and the next. + The left hand. - + - Character Joints are mainly used for Ragdoll effects. + The right foot. - + - Brings violated constraints back into alignment even when the solver fails. + The right hand. - + - The upper limit around the primary axis of the character joint. + IK Hint. - + - The lower limit around the primary axis of the character joint. + The left elbow IK hint. - + - Set the angular tolerance threshold (in degrees) for projection. + The left knee IK hint. - + - Set the linear tolerance threshold for projection. + The right elbow IK hint. - + - The angular limit of rotation (in degrees) around the primary axis of the character joint. + The right knee IK hint. - + - The angular limit of rotation (in degrees) around the primary axis of the character joint. + AvatarMask are used to mask out humanoid body parts and transforms. - + - The secondary axis around which the joint can rotate. + Number of transforms. - + - The configuration of the spring attached to the swing limits of the joint. + Adds a transform path into the AvatarMask. + The transform to add into the AvatarMask. + Whether to also add all children of the specified transform. - + - The configuration of the spring attached to the twist limits of the joint. + Creates a new AvatarMask. - + - Collider for 2D physics representing an circle. + Returns true if the humanoid body part at the given index is active. + The index of the humanoid body part. - + - The center point of the collider in local space. + Returns true if the transform at the given index is active. + The index of the transform. - + - Radius of the circle. + Returns the path of the transform at the given index. + The index of the transform. - + - The Cloth class provides an interface to cloth simulation physics. + 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. - + - Bending stiffness of the cloth. + Sets the humanoid body part at the given index to active or not. + The index of the humanoid body part. + Active or not. - + - An array of CapsuleColliders which this Cloth instance should collide with. + Sets the tranform at the given index to active or not. + The index of the transform. + Active or not. - + - The cloth skinning coefficients used to set up how the cloth interacts with the skinned mesh. + Sets the path of the transform at the given index. + The index of the transform. + The path of the transform. - + - How much to increase mass of colliding particles. + Avatar body part. - + - Damp cloth motion. + The Body. - + - Is this cloth enabled? + The Head. - + - A constant, external acceleration applied to the cloth. + Total number of body parts. - + - The friction of the cloth when colliding with the character. + The Left Arm. - + - The current normals of the cloth object. + Left Fingers. - + - A random, external acceleration applied to the cloth. + Left Foot IK. - + - Cloth's sleep threshold. + Left Hand IK. - + - Number of solver iterations per second. + The Left Leg. - + - An array of ClothSphereColliderPairs which this Cloth instance should collide with. + The Right Arm. - + - Stretching stiffness of the cloth. + Right Fingers. - + - Enable continuous collision to improve collision stability. + Right Foot IK. - + - Should gravity affect the cloth simulation? + Right Hand IK. - + - Add one virtual particle per triangle to improve collision stability. + The Right Leg. - + - The current vertex positions of the cloth object. + The Root. - + - How much world-space acceleration of the character will affect cloth vertices. + Target. - + - How much world-space movement of the character will affect cloth vertices. + The body, center of mass. - + - Clear the pending transform changes from affecting the cloth simulation. + The left foot. - + - Fade the cloth simulation in or out. + The left hand. - Fading enabled or not. - - + - 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. + The right foot. - + - Definition of a sphere a vertex is not allowed to enter. This allows collision against the animated cloth. + The right hand. - + - Distance a vertex is allowed to travel from the skinned mesh vertex position. + The root, the position of the game object. - + - A pair of SphereColliders used to define shapes for Cloth objects to collide against. + Enumeration for SystemInfo.batteryStatus which represents the current status of the device's battery. - + - The first SphereCollider of a ClothSphereColliderPair. + Device is plugged in and charging. - + - The second SphereCollider of a ClothSphereColliderPair. + Device is unplugged and discharging. - + - 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. + Device is plugged in and the battery is full. - 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. + Device is plugged in, but is not charging. - The first SphereCollider of a ClothSphereColliderPair. - The second SphereCollider of a ClothSphereColliderPair. - + - Interface for reading and writing inputs in a Unity Cluster. + The device's battery status cannot be determined. If battery status is not available on your target platform, SystemInfo.batteryStatus will return this value. - + - Add a new VRPN input entry. + Behaviours are Components that can be enabled or disabled. - 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. + Enabled Behaviours are Updated, disabled Behaviours are not. - Name of the input entry. - + - Edit an input entry which added via ClusterInput.AddInput. + Has the Behaviour had enabled called. - 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. + BillboardAsset describes how a billboard is rendered. - Name of input to poll.c. - + - Returns the binary value of a button. + Height of the billboard that is below ground. - Name of input to poll. - + - Return the position of a tracker as a Vector3. + Height of the billboard. - Name of input to poll. - + - Returns the rotation of a tracker as a Quaternion. + Number of pre-rendered images that can be switched when the billboard is viewed from different angles. - Name of input to poll. - + - Sets the axis value for this input. Only works for input typed Custom. + Number of indices in the billboard mesh. - Name of input to modify. - Value to set. - + - Sets the button value for this input. Only works for input typed Custom. + The material used for rendering. - Name of input to modify. - Value to set. - + - Sets the tracker position for this input. Only works for input typed Custom. + Number of vertices in the billboard mesh. - Name of input to modify. - Value to set. - + - Sets the tracker rotation for this input. Only works for input typed Custom. + Width of the billboard. - Name of input to modify. - Value to set. - + - Values to determine the type of input value to be expect from one entry of ClusterInput. + Constructs a new BillboardAsset. - + - Device is an analog axis that provides continuous value represented by a float. + Get the array of billboard image texture coordinate data. + The list that receives the array. - + - Device that return a binary result of pressed or not pressed. + Get the array of billboard image texture coordinate data. + The list that receives the array. - + - A user customized input. + Get the indices of the billboard mesh. + The list that receives the array. - + - Device that provide position and orientation values. + Get the indices of the billboard mesh. + The list that receives the array. - + - A helper class that contains static method to inquire status of Unity Cluster. + Get the vertices of the billboard mesh. + The list that receives the array. - + - Check whether the current instance is disconnected from the cluster network. + Get the vertices of the billboard mesh. + The list that receives the array. - + - Check whether the current instance is a master node in the cluster network. + Set the array of billboard image texture coordinate data. + The array of data to set. - + - To acquire or set the node index of the current machine from the cluster network. + Set the array of billboard image texture coordinate data. + The array of data to set. - + - A base class of all colliders. + Set the indices of the billboard mesh. + The array of data to set. - + - The rigidbody the collider is attached to. + Set the indices of the billboard mesh. + The array of data to set. - + - The world space bounding volume of the collider. + Set the vertices of the billboard mesh. + The array of data to set. - + - Contact offset value of this collider. + Set the vertices of the billboard mesh. + The array of data to set. - + - Enabled Colliders will collide with other colliders, disabled Colliders won't. + Renders a billboard from a BillboardAsset. - + - Is the collider a trigger? + The BillboardAsset to render. - + - The material used by the collider. + Constructor. - + - The shared physic material of this collider. + The BitStream class represents seralized variables, packed into a stream. - + - The closest point to the bounding box of the attached collider. + Is the BitStream currently being read? (Read Only) - - + - Casts a Ray that ignores all Colliders except this one. + Is the BitStream currently being written? (Read Only) - 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 length of the ray. - - True when the ray intersects any collider, otherwise false. - - + - Parent class for collider types used with 2D gameplay. + Serializes different types of variables. + + + - + - The Rigidbody2D attached to the Collider2D's GameObject. + Serializes different types of variables. + + + - + - The world space bounding area of the collider. + Serializes different types of variables. + + + - + - TThe density of the collider used to calculate its mass (when auto mass is enabled) + Serializes different types of variables. + + + - + - Is this collider configured as a trigger? + Serializes different types of variables. + + + - + - The local offset of the collider geometry. + Serializes different types of variables. + + + - + - The number of separate shaped regions in the collider. + Serializes different types of variables. + + + - + - The PhysicsMaterial2D that is applied to this collider. + Serializes different types of variables. + + + - + - Whether the collider is used by an attached effector or not. + Serializes different types of variables. + + + - + - Check whether this collider is touching the collider or not. + Serializes different types of variables. - The collider to check if it is touching this collider. - - Whether the collider is touching this collider or not. - + + + - + - Checks whether this collider is touching any colliders on the specified layerMask or not. + Serializes different types of variables. - Any colliders on any of these layers count as touching. - - Whether this collider is touching any collider on the specified layerMask or not. - + + + - + - Check if a collider overlaps a point in space. + Serializes different types of variables. - A point in world space. + + + - + - Describes a collision. + Blend weights. - + - The Collider we hit (Read Only). + Four bones affect each vertex. - + - The contact points generated by the physics engine. + One bone affects each vertex. - + - The GameObject whose collider we are colliding with. (Read Only). + Two bones affect each vertex. - + - The total impulse applied to this contact pair to resolve the collision. + Skinning bone weights of a vertex in the mesh. - + - The relative linear velocity of the two colliding objects (Read Only). + Index of first bone. - + - The Rigidbody we hit (Read Only). This is null if the object we hit is a collider with no rigidbody attached. + Index of second bone. - + - The Transform of the object we hit (Read Only). + Index of third bone. - + - Information returned by a collision in 2D physics. + Index of fourth bone. - + - The incoming Collider2D involved in the collision. + Skinning weight for first bone. - + - The specific points of contact with the incoming Collider2D. + Skinning weight for second bone. - + - Whether the collision was disabled or not. + Skinning weight for third bone. - + - The incoming GameObject involved in the collision. + Skinning weight for fourth bone. - + - The relative linear velocity of the two colliding objects (Read Only). + Describes a single bounding sphere for use by a CullingGroup. - + - The incoming Rigidbody2D involved in the collision. + The position of the center of the BoundingSphere. - + - The Transform of the incoming object involved in the collision. + The radius of the BoundingSphere. - + - The collision detection mode constants used for Rigidbody.collisionDetectionMode. + 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). - + - Continuous collision detection is on for colliding with static mesh geometry. + 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). - + - Continuous collision detection is on for colliding with static and dynamic geometry. + Represents an axis aligned bounding box. - + - Continuous collision detection is off for this Rigidbody. + The center of the bounding box. - + - Controls how collisions are detected when a Rigidbody2D moves. + The extents of the box. This is always half of the size. - + - Ensures that all collisions are detected when a Rigidbody2D moves. + The maximal point of the box. This is always equal to center+extents. - + - When a Rigidbody2D moves, only collisions at the new position are detected. + The minimal point of the box. This is always equal to center-extents. - + - This mode is obsolete. You should use Discrete mode. + The total size of the box. This is always twice as large as the extents. - + - CollisionFlags is a bitmask returned by CharacterController.Move. + The closest point on the bounding box. + Arbitrary point. + + The point on the bounding box or inside the bounding box. + - + - CollisionFlags is a bitmask returned by CharacterController.Move. + Is point contained in the bounding box? + - + - CollisionFlags is a bitmask returned by CharacterController.Move. + Creates a new Bounds. + The location of the origin of the Bounds. + The dimensions of the Bounds. - + - CollisionFlags is a bitmask returned by CharacterController.Move. + Grows the Bounds to include the point. + - + - CollisionFlags is a bitmask returned by CharacterController.Move. + Grow the bounds to encapsulate the bounds. + - + - Representation of RGBA colors. + Expand the bounds by increasing its size by amount along each side. + - + - Alpha component of the color. + Expand the bounds by increasing its size by amount along each side. + - + - Blue component of the color. + Does ray intersect this bounding box? + - + - Solid black. RGBA is (0, 0, 0, 1). + Does ray intersect this bounding box? + + - + - Solid blue. RGBA is (0, 0, 1, 1). + Does another bounding box intersect with this bounding box? + - + - Completely transparent. RGBA is (0, 0, 0, 0). + Sets the bounds to the min and max value of the box. + + - + - Cyan. RGBA is (0, 1, 1, 1). + The smallest squared distance between the point and this bounding box. + - + - Green component of the color. + Returns a nicely formatted string for the bounds. + - + - A version of the color that has had the gamma curve applied. + Returns a nicely formatted string for the bounds. + - + - Gray. RGBA is (0.5, 0.5, 0.5, 1). + A box-shaped primitive collider. - + - The grayscale value of the color. (Read Only) + The center of the box, measured in the object's local space. - + - Solid green. RGBA is (0, 1, 0, 1). + The size of the box, measured in the object's local space. - + - English spelling for gray. RGBA is the same (0.5, 0.5, 0.5, 1). + Collider for 2D physics representing an axis-aligned rectangle. - + - A linear value of an sRGB color. + Determines whether the BoxCollider2D's shape is automatically updated based on a SpriteRenderer's tiling properties. - + - Magenta. RGBA is (1, 0, 1, 1). + The center point of the collider in local space. - + - Returns the maximum color component value: Max(r,g,b). + Controls the radius of all edges created by the collider. - + - Red component of the color. + The width and height of the rectangle. - + - Solid red. RGBA is (1, 0, 0, 1). + Applies forces to simulate buoyancy, fluid-flow and fluid drag. - + - Solid white. RGBA is (1, 1, 1, 1). + A force applied to slow angular movement of any Collider2D in contact with the effector. - + - Yellow. RGBA is (1, 0.92, 0.016, 1), but the color is nice to look at! + The density of the fluid used to calculate the buoyancy forces. - + - Constructs a new Color with given r,g,b,a components. + The angle of the force used to similate fluid flow. - Red component. - Green component. - Blue component. - Alpha component. - + - Constructs a new Color with given r,g,b components and sets a to 1. + The magnitude of the force used to similate fluid flow. - Red component. - Green component. - Blue component. - + - Creates an RGB colour from HSV input. + The random variation of the force used to similate fluid flow. - Hue [0..1]. - Saturation [0..1]. - 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. + A force applied to slow linear movement of any Collider2D in contact with the effector. - Hue [0..1]. - Saturation [0..1]. - 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. + Defines an arbitrary horizontal line that represents the fluid surface level. - - + - Colors can be implicitly converted to and from Vector4. + The Caching class lets you manage cached AssetBundles, downloaded using WWW.LoadFromCacheOrDownload. - - + - Linearly interpolates between colors a and b by t. + Controls compression of cache data. Enabled by default. - - - - + - Linearly interpolates between colors a and b by t. + Is Caching enabled? - - - - + - Divides color a by the float b. Each color component is scaled separately. + The number of seconds that an AssetBundle may remain unused in the cache before it is automatically deleted. - - - + - Subtracts color b from color a. Each component is subtracted separately. + The total number of bytes that can potentially be allocated for caching. - - - + - Multiplies two colors together. Each component is multiplied separately. + Is caching ready? - - - - - - 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. + The number of currently unused bytes in the cache. - - - + - Calculates the hue, saturation and value of an RGB input color. + Used disk space in bytes. - 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. + This is a WebPlayer-only function. + Signature The authentification signature provided by Unity. + Size The number of bytes allocated to this cache. + + + + + - + - Returns a nicely formatted string of this color. + This is a WebPlayer-only function. - + Signature The authentification signature provided by Unity. + Size The number of bytes allocated to this cache. + + + + + - + - Returns a nicely formatted string of this color. + TODO. - + + + + + - + - Representation of RGBA colors in 32 bit format. + TODO. + + + + + - + - Alpha component of the color. + Delete all AssetBundle and Procedural Material content that has been cached by the current application. + + True when cache cleaning succeeded, false if cache was in use. + - + - Blue component of the color. + 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 WWW.LoadFromCacheOrDownload() 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. + - + - Green component of the color. + Bumps the timestamp of a cached file to be the current time. + + - + - Red component of the color. + A Camera is a device through which the player views the world. - + - Constructs a new Color with given r, g, b, a components. + Gets or sets the temporary RenderTexture target for this Camera. - - - - - + - Color32 can be implicitly converted to and from Color. + The rendering path that is currently being used (Read Only). - - + - Color32 can be implicitly converted to and from Color. + Returns all enabled cameras in the scene. - - + - Linearly interpolates between colors a and b by t. + The number of cameras in the current scene. - - - - + - Linearly interpolates between colors a and b by t. + High dynamic range rendering. - - - - + - Returns a nicely formatted string of this color. + MSAA rendering. - - + - Returns a nicely formatted string of this color. + The aspect ratio (width divided by height). - - + - Color space for player settings. + The color with which the screen will be cleared. - + - Gamma color space. + Matrix that transforms from camera space to world space (Read Only). - + - Linear color space. + Identifies what kind of camera this is. - + - Uninitialized color space. + How the camera clears the background. - + - Attribute used to configure the usage of the ColorField and Color Picker for a color. + Should the camera clear the stencil buffer after the deferred light pass? - + - If set to true the Color is treated as a HDR color. + Number of command buffers set up on this camera (Read Only). - + - Maximum allowed HDR color component value when using the HDR Color Picker. + This is used to render parts of the scene selectively. - + - Maximum exposure value allowed in the HDR Color Picker. + Sets a custom matrix for the camera to use for all culling queries. - + - Minimum allowed HDR color component value when using the Color Picker. + The camera we are currently rendering with, for low-level render control only (Read Only). - + - Minimum exposure value allowed in the HDR Color Picker. + Camera's depth in the camera rendering order. - + - If false then the alpha bar is hidden in the ColorField and the alpha value is not shown in the Color Picker. + How and if camera generates a depth texture. - + - Attribute for Color fields. Used for configuring the GUI for the color. + Mask to select which layers can trigger events on the camera. - 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. + The far clipping plane distance. - 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. + The field of view of the camera in degrees. - + - Returns the color as a hexadecimal string in the format "RRGGBB". + Should camera rendering be forced into a RenderTexture. - The color to be converted. - - Hexadecimal string representing the color. - - + - Returns the color as a hexadecimal string in the format "RRGGBBAA". + High dynamic range rendering. - The color to be converted. - - Hexadecimal string representing the color. - - + - Attempts to convert a html color string. + Per-layer culling distances. - 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. + How to perform per-layer culling for a Camera. - + - Mesh to combine. + The first enabled camera tagged "MainCamera" (Read Only). - + - Submesh index of the mesh. + The near clipping plane distance. - + - Matrix to transform the mesh with before combining. + Get or set the raw projection matrix with no camera offset (no jittering). - + - Interface into compass functionality. + Event that is fired after any camera finishes rendering. - + - 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(). + Event that is fired before any camera starts culling. - + - Accuracy of heading reading in degrees. + Event that is fired before any camera starts rendering. - + - The heading in degrees relative to the magnetic North Pole. (Read Only) + Opaque object sorting mode. - + - The raw geomagnetic data measured in microteslas. (Read Only) + Is the camera orthographic (true) or perspective (false)? - + - Timestamp (in seconds since 1970) when the heading was last time updated. (Read Only) + Camera's half-size when in orthographic mode. - + - The heading in degrees relative to the geographic North Pole. (Read Only) + How tall is the camera in pixels (Read Only). - + - Base class for everything attached to GameObjects. + Where on the screen is the camera rendered in pixel coordinates. - + - The Animation attached to this GameObject (null if there is none attached). + How wide is the camera in pixels (Read Only). - + - The AudioSource attached to this GameObject (null if there is none attached). + Set a custom projection matrix. - + - The Camera attached to this GameObject (null if there is none attached). + Where on the screen is the camera rendered in normalized coordinates. - + - The Collider attached to this GameObject (null if there is none attached). + The rendering path that should be used, if possible. - + - The Collider2D component attached to the object. + 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. - + - The ConstantForce attached to this GameObject (null if there is none attached). + Distance to a point where virtual eyes converge. - + - The game object this component is attached to. A component is always attached to a game object. + Stereoscopic rendering. - + - The GUIText attached to this GameObject (null if there is none attached). + Render only once and use resulting image for both eyes. - + - The GUITexture attached to this GameObject (Read Only). (null if there is none attached). + Distance between the virtual eyes. - + - The HingeJoint attached to this GameObject (null if there is none attached). + Defines which eye of a VR display the Camera renders into. - + - The Light attached to this GameObject (null if there is none attached). + Set the target display for this Camera. - + - The NetworkView attached to this GameObject (Read Only). (null if there is none attached). + Destination render texture. - + - The ParticleEmitter attached to this GameObject (null if there is none attached). + An axis that describes the direction along which the distances of objects are measured for the purpose of sorting. - + - The ParticleSystem attached to this GameObject (null if there is none attached). + Transparent object sorting mode. - + - The Renderer attached to this GameObject (null if there is none attached). + Should the jittered matrix be used for transparency rendering? - + - The Rigidbody attached to this GameObject (null if there is none attached). + Whether or not the Camera will use occlusion culling during rendering. - + - The Rigidbody2D that is attached to the Component's GameObject. + Get the world-space speed of the camera (Read Only). - + - The tag of this game object. + Matrix that transforms from world to camera space. - + - The Transform attached to this GameObject (null if there is none attached). + Add a command buffer to be executed at a specified place. + When to execute the command buffer during rendering. + The buffer to execute. - + - Calls the method named methodName on every MonoBehaviour in this game object or any of its children. + Given viewport coordinates, calculates the view space vectors pointing to the four frustum corners at the specified camera depth. - 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? + 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. - + - Calls the method named methodName on every MonoBehaviour in this game object or any of its children. + Calculates and returns oblique near-plane projection matrix. - 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? + Vector4 that describes a clip plane. + + Oblique near-plane projection matrix. + - + - Calls the method named methodName on every MonoBehaviour in this game object or any of its children. + Delegate type for camera callbacks. - 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. + Makes this camera's settings match other camera. - 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 ? + Fills an array of Camera with the current cameras in the scene, without allocating a new array. - The tag to compare. + An array to be filled up with cameras currently in the scene. - + - Returns the component of Type type if the game object has one attached, null if it doesn't. + Get command buffers to be executed at a specified place. - The type of Component to retrieve. + When to execute the command buffer during rendering. + + Array of command buffers. + - + - Generic version. See the page for more details. + Gets the projection matrix of a specific left or right stereoscopic eye. + Specifies the stereoscopic eye whose view matrix needs to be returned. + + The view matrix of the specified stereoscopic eye. + - + - Returns the component with name type if the game object has one attached, null if it doesn't. + 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. + - + - Returns the component of Type type in the GameObject or any of its children using depth first search. + 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. - The type of Component to retrieve. - - A component of the matching type, if found. - - + - Generic version. See the page for more details. + Camera eye corresponding to stereoscopic rendering of the left eye. - - - A component of the matching type, if found. - - + - Returns the component of Type type in the GameObject or any of its parents. + Camera eye corresponding to non-stereoscopic rendering. - The type of Component to retrieve. - - A component of the matching type, if found. - - + - Generic version. See the page for more details. + Camera eye corresponding to stereoscopic rendering of the right eye. - - A component of the matching type, if found. - - + - Returns all components of Type type in the GameObject. + Remove all command buffers set on this camera. - The type of Component to retrieve. - + - Generic version. See the page for more details. + Remove command buffer from execution at a specified place. + When to execute the command buffer during rendering. + The buffer to execute. - + - Returns all components of Type type in the GameObject or any of its children. + Remove command buffers from execution at a specified place. - The type of Component to retrieve. - Should Components on inactive GameObjects be included in the found set? + When to execute the command buffer during rendering. - + - Returns all components of Type type in the GameObject or any of its children. + Render the camera manually. - 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. + Render into a static cubemap from this camera. - Should inactive GameObjects be included in the found set? + The cube map to render to. + A bitmask which determines which of the six faces are rendered to. - A list of all found components matching the specified type. + False is rendering fails, else true. - + - Generic version. See the page for more details. + Render into a cubemap from this camera. + A bitfield indicating which cubemap faces should be rendered into. + The texture to render to. - A list of all found components matching the specified type. + False is rendering fails, else true. - + - Returns all components of Type type in the GameObject or any of its parents. + Render the camera with shader replacement. - The type of Component to retrieve. - Should inactive Components be included in the found set? + + - + - Generic version. See the page for more details. + Revert the aspect ratio to the screen's aspect ratio. - Should inactive Components be included in the found set? - + - Generic version. See the page for more details. + Make culling queries reflect the camera's built in parameters. - Should inactive Components be included in the found set? - + - Calls the method named methodName on every MonoBehaviour in this game object. + Reset to the default field of view. - 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. + Make the projection reflect normal camera's parameters. - 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. + Remove shader replacement from camera. - 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. + Reset the camera to using the Unity computed projection matrices for all stereoscopic eyes. - 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. + Reset the camera to using the Unity computed view matrices for all stereoscopic eyes. - 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. + Resets this Camera's transparency sort settings to the default. Default transparency settings are taken from GraphicsSettings instead of directly from this Camera. - 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. + Make the rendering position reflect the camera's position in the scene. - 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. + Returns a ray going from camera through a screen point. - 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? + - + - Data buffer to hold data for compute shaders. + Transforms position from screen space into viewport space. + - + - Number of elements in the buffer (Read Only). + Transforms position from screen space into world space. + - + - Size of one element in the buffer (Read Only). + Make the camera render with shader replacement. + + - + - Copy counter value of append/consume buffer into another buffer. + Sets custom projection matrices for both the left and right stereoscopic eyes. - Append/consume buffer to copy the counter from. - A buffer to copy the counter to. - Target byte offset in dst. + Projection matrix for the stereoscopic left eye. + Projection matrix for the stereoscopic right eye. - + - Create a Compute Buffer. + Sets a custom projection matrix for a specific stereoscopic eye. - 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. + Specifies the stereoscopic eye whose projection matrix needs to be set. + The matrix to be set. - + - Create a Compute Buffer. + Set custom view matrices for both eyes. - 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. + View matrix for the stereo left eye. + View matrix for the stereo right eye. - + - Read data values from the buffer into an array. + Sets a custom view matrix for a specific stereoscopic eye. - An array to receive the data. + Specifies the stereoscopic view matrix to set. + The matrix to be set. - + - Release a Compute Buffer. + 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. - + - Set the buffer with values from an array. + Sets the Camera to render to the chosen buffers of one or more RenderTextures. - Array of values to fill the buffer. + The RenderBuffer(s) to which color information will be rendered. + The RenderBuffer to which depth information will be rendered. - + - ComputeBuffer type. + Enum used to specify either the left or the right eye of a stereoscopic camera. - + - Append-consume ComputeBuffer type. + Specifies the target to be the left eye. - + - ComputeBuffer with a counter. + Specifies the target to be the right eye. - + - Default ComputeBuffer type. + Returns a ray going from camera through a viewport point. + - + - ComputeBuffer used for Graphics.DrawProceduralIndirect. + Transforms position from viewport space into screen space. + - + - ComputeBuffer is attempted to be located in GPU memory. + Transforms position from viewport space into world space. + The 3d vector in Viewport space. + + The 3d vector in World space. + - + - Raw ComputeBuffer type. + Transforms position from world space into screen space. + - + - Compute Shader asset. + Transforms position from world space into viewport space. + - + - Execute a compute shader. + Values for Camera.clearFlags, determining what to clear when rendering a Camera. - 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. - + - Find ComputeShader kernel index. + Clear only the depth buffer. - Name of kernel function. - - Kernel index, or -1 if not found. - - + - Sets an input or output compute buffer. + Don't clear anything. - For which kernel the buffer is being set. See FindKernel. - Name of the buffer variable in shader code. - Buffer to set. - + - Set a float parameter. + Clear with the skybox. - Variable name in shader code. - Value to set. - + - Set multiple consecutive float parameters at once. + Clear with a background color. - Array variable name in the shader code. - Value array to set. - + - Set an integer parameter. + Describes different types of camera. - Variable name in shader code. - Value to set. - + - Set multiple consecutive integer parameters at once. + Used to indicate a regular in-game camera. - Array variable name in the shader code. - Value array to set. - + - Set a texture parameter. + Used to indicate a camera that is used for rendering previews in the Editor. - For which kernel the texture is being set. See FindKernel. - Name of the buffer variable in shader code. - Texture to set. - + - Set a vector parameter. + Used to indicate that a camera is used for rendering the Scene View in the Editor. - Variable name in shader code. - Value to set. - + - The configurable joint is an extremely flexible joint giving you complete control over rotation and linear motion. + Used to indicate that a camera is used for rendering VR (in edit mode) in the Editor. - + - Definition of how the joint's rotation will behave around its local X axis. Only used if Rotation Drive Mode is Swing & Twist. + Element that can be used for screen rendering. - + - The configuration of the spring attached to the angular X limit of the joint. + Get or set the mask of additional shader channels to be used when creating the Canvas mesh. - + - Allow rotation around the X axis to be Free, completely Locked, or Limited according to Low and High Angular XLimit. + Cached calculated value based upon SortingLayerID. - + - Boundary defining rotation restriction, based on delta from original rotation. + Is this the root Canvas? - + - Allow rotation around the Y axis to be Free, completely Locked, or Limited according to Angular YLimit. + The normalized grid size that the canvas will split the renderable area into. - + - 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. + Allows for nested canvases to override pixelPerfect settings inherited from parent canvases. - + - The configuration of the spring attached to the angular Y and angular Z limits of the joint. + Override the sorting of canvas. - + - Boundary defining rotation restriction, based on delta from original rotation. + Force elements in the canvas to be aligned with pixels. Only applies with renderMode is Screen Space. - + - Allow rotation around the Z axis to be Free, completely Locked, or Limited according to Angular ZLimit. + Get the render rect for the Canvas. - + - If enabled, all Target values will be calculated in world space instead of the object's local space. + How far away from the camera is the Canvas generated. - + - Boundary defining upper rotation restriction, based on delta from original rotation. + The number of pixels per unit that is considered the default. - + - Boundary defining movement restriction, based on distance from the joint's origin. + Is the Canvas in World or Overlay mode? - + - The configuration of the spring attached to the linear limit of the joint. + The render order in which the canvas is being emitted to the scene. - + - Boundary defining lower rotation restriction, based on delta from original rotation. + 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. - + - 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). + Used to scale the entire canvas, while still making it fit the screen. Only applies with renderMode is Screen Space. - + - 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). + The normalized grid size that the canvas will split the renderable area into. - + - 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. + Unique ID of the Canvas' sorting layer. - + - Control the object's rotation with either X & YZ or Slerp Drive by itself. + Name of the Canvas' sorting layer. - + - The joint's secondary axis. + Canvas' order within a sorting layer. - + - Definition of how the joint's rotation will behave around all local axes. Only used if Rotation Drive Mode is Slerp Only. + For Overlay mode, display index on which the UI canvas will appear. - + - If enabled, the two connected rigidbodies will be swapped, as if the joint was attached to the other body. + Event that is called just before Canvas rendering happens. + - + - This is a Vector3. It defines the desired angular velocity that the joint should rotate into. + 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]. - + - The desired position that the joint should move into. + Force all canvases to update their content. - + - This is a Quaternion. It defines the desired rotation that the joint should rotate into. + Returns the default material that can be used for rendering normal elements on the Canvas. - + - The desired velocity that the joint should move along. + Returns the default material that can be used for rendering text elements on the Canvas. - + - Definition of how the joint's movement will behave along its local X axis. + Gets or generates the ETC1 Material. + + The generated ETC1 Material from the Canvas. + - + - Allow movement along the X axis to be Free, completely Locked, or Limited according to Linear Limit. + A Canvas placable element that can be used to modify children Alpha, Raycasting, Enabled state. - + - Definition of how the joint's movement will behave along its local Y axis. + Set the alpha of the group. - + - Allow movement along the Y axis to be Free, completely Locked, or Limited according to Linear Limit. + Does this group block raycasting (allow collision). - + - Definition of how the joint's movement will behave along its local Z axis. + Should the group ignore parent groups? - + - Allow movement along the Z axis to be Free, completely Locked, or Limited according to Linear Limit. + Is the group interactable (are the elements beneath the group enabled). - + - Constrains movement for a ConfigurableJoint along the 6 axes. + Returns true if the Group allows raycasts. + + - + - Motion along the axis will be completely free and completely unconstrained. + A component that will render to the screen after all normal rendering has completed when attached to a Canvas. Designed for GUI application. - + - Motion along the axis will be limited by the respective limit. + Depth of the renderer relative to the root canvas. - + - Motion along the axis will be locked. + Indicates whether geometry emitted by this renderer is ignored. - + - The various test results the connection tester may return with. + True if any change has occured that would invalidate the positions of generated geometry. - + - Some unknown error occurred. + Enable 'render stack' pop draw call. - + - Port-restricted NAT type, can do NAT punchthrough to everyone except symmetric. + True if rect clipping has been enabled on this renderer. +See Also: CanvasRenderer.EnableRectClipping, CanvasRenderer.DisableRectClipping. - + - Symmetric NAT type, cannot do NAT punchthrough to other symmetric types nor port restricted type. + Is the UIRenderer a mask component. - + - Address-restricted cone type, NAT punchthrough fully supported. + The number of materials usable by this renderer. - + - Full cone type, NAT punchthrough fully supported. + (Editor Only) Event that gets fired whenever the data in the CanvasRenderer gets invalidated and needs to be rebuilt. + - + - Public IP address detected and game listen port is accessible to the internet. + The number of materials usable by this renderer. Used internally for masking. - + - Public IP address detected but server is not initialized and no port is listening. + Depth of the renderer realative to the parent canvas. - + - Public IP address detected but the port is not connectable from the internet. + 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. - + - Test result undetermined, still in progress. + Remove all cached vertices. - + - A force applied constantly. + Convert a set of vertex components into a stream of UIVertex. + + + + + + + + - + - The force applied to the rigidbody every frame. + Disables rectangle clipping for this CanvasRenderer. - + - The force - relative to the rigid bodies coordinate system - applied every frame. + Enables rect clipping on the CanvasRendered. Geometry outside of the specified rect will be clipped (not rendered). + - + - The torque - relative to the rigid bodies coordinate system - applied every frame. + Get the current alpha of the renderer. - + - The torque applied to the rigidbody every frame. + Get the current color of the renderer. - + - Applies both linear and angular (torque) forces continuously to the rigidbody each physics update. + Gets the current Material assigned to the CanvasRenderer. + The material index to retrieve (0 if this parameter is omitted). + + Result. + - + - The linear force applied to the rigidbody each physics update. + Gets the current Material assigned to the CanvasRenderer. + The material index to retrieve (0 if this parameter is omitted). + + Result. + - + - The linear force, relative to the rigid-body coordinate system, applied each physics update. + Gets the current Material assigned to the CanvasRenderer. Used internally for masking. + - + - The torque applied to the rigidbody each physics update. + Set the alpha of the renderer. Will be multiplied with the UIVertex alpha and the Canvas alpha. + Alpha. - + - Describes a contact point where the collision occurs. + The Alpha Texture that will be passed to the Shader under the _AlphaTex property. + The Texture to be passed. - + - Normal of the contact point. + Set the color of the renderer. Will be multiplied with the UIVertex color and the Canvas color. + Renderer multiply color. - + - The other collider in contact at the point. + 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. - + - The point of contact. + 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. - + - The first collider in contact at the point. + Sets the Mesh used by this renderer. + - + - Details about a specific point of contact involved in a 2D physics collision. + Set the material for the canvas renderer. Used internally for masking. + + - + - The collider attached to the object receiving the collision message. + Sets the texture used by this renderer's material. + - + - Surface normal at the contact point. + Set the vertices for the UIRenderer. + Array of vertices to set. + Number of vertices to set. - + - The incoming collider involved in the collision at this contact point. + Set the vertices for the UIRenderer. + Array of vertices to set. + Number of vertices to set. - + - The point of contact between the two colliders in world space. + Given a list of UIVertex, split the stream into it's component types. + + + + + + + + - + - The ContextMenu attribute allows you to add commands to the context menu. + A capsule-shaped primitive collider. - + - Adds the function to the context menu of the component. + The center of the capsule, measured in the object's local space. - - + - Use this attribute to add a context menu to a field that calls a named method. + The direction of the capsule. - + - The name of the function that should be called. + The height of the capsule meased in the object's local space. - + - The name of the context menu item. + The radius of the sphere, measured in the object's local space. - + - Use this attribute to add a context menu to a field that calls a named method. + A capsule-shaped primitive collider. - 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 direction that the capsule sides can extend. - + - The collider that was hit by the controller. + The width and height of the capsule area. - + - The controller that hit the collider. + The direction that the capsule sides can extend. - + - The game object that was hit by the controller. + The capsule sides extend horizontally. - + - The direction the CharacterController was moving in when the collision occured. + The capsule sides extend vertically. - + - How far the character has travelled until it hit the collider. + A CharacterController allows you to easily do movement constrained by collisions without having to deal with a rigidbody. - + - The normal of the surface we collided with in world space. + The center of the character's capsule relative to the transform's position. - + - The impact point in world space. + What part of the capsule collided with the environment during the last CharacterController.Move call. - + - The rigidbody that was hit by the controller. + Determines whether other rigidbodies or character controllers collide with this character controller (by default this is always enabled). - + - The transform that was hit by the controller. + Enables or disables overlap recovery. + Enables or disables overlap recovery. Used to depenetrate character controllers from static objects when an overlap is detected. - + - 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. + The height of the character's capsule. - + - Holds data for a single application crash event and provides access to all gathered crash reports. + Was the CharacterController touching the ground during the last move? - + - Returns last crash report, or null if no reports are available. + Gets or sets the minimum move distance of the character controller. - + - Returns all currently available reports in a new array. + The radius of the character's capsule. - + - Crash report data as formatted text. + The character's collision skin width. - + - Time, when the crash occured. + The character controllers slope limit in degrees. - + - Remove report from available reports list. + The character controllers step offset in meters. - + - Remove all reports from available reports list. + The current relative velocity of the Character (see notes). - + - 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. + A more complex move function taking absolute movement deltas. + - + - The default file name used by newly created instances of this type. + Moves the character with speed. + - + - The display name for this type shown in the Assets/Create menu. + Specification for how to render a character from the font texture. See Font.characterInfo. - + - The position of the menu item within the Assets/Create menu. + The horizontal distance from the origin of this character to the origin of the next character. - + - Class for handling cube maps, Use this to create or modify existing. + The horizontal distance from the origin of this glyph to the begining of the glyph image. - + - The format of the pixel data in the texture (Read Only). + Is the character flipped? - + - How many mipmap levels are in this texture (Read Only). + The height of the glyph image. - + - Actually apply all previous SetPixel and SetPixels changes. + The width of the glyph image. - Should all mipmap levels be updated? - Should the Cubemap texture data be readable/modifiable after changes are applied? - + - Create a new empty cubemap texture. + Unicode value of the character. - 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). + The maximum extend of the glyph image in the x-axis. - - - - + - Returns pixel colors of a cubemap face. + The maximum extend of the glyph image in the y-axis. - The face from which pixel data is taken. - Mipmap level for the chosen face. - + - Sets pixel color at coordinates (face, x, y). + The minium extend of the glyph image in the x-axis. - - - - - + - Sets pixel colors of a cubemap face. + The minimum extend of the glyph image in the y-axis. - 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. + The size of the character or 0 if it is the default font size. - Pixel distance at edges over which to apply smoothing. - + - Cubemap face. + The style of the character. - + - Left facing side (-x). + UV coordinates for the character in the texture. - + - Downward facing side (-y). + The uv coordinate matching the bottom left of the glyph image in the font texture. - + - Backward facing side (-z). + The uv coordinate matching the bottom right of the glyph image in the font texture. - + - Right facing side (+x). + The uv coordinate matching the top left of the glyph image in the font texture. - + - Upwards facing side (+y). + The uv coordinate matching the top right of the glyph image in the font texture. - + - Forward facing side (+z). + Screen coordinates for the character in generated text meshes. - + - Cubemap face is unknown or unspecified. + How far to advance between the beginning of this charcater and the next. - + - Describes a set of bounding spheres that should have their visibility and distances maintained. + Character Joints are mainly used for Ragdoll effects. - + - Pauses culling group execution. + Brings violated constraints back into alignment even when the solver fails. - + - Sets the callback that will be called when a sphere's visibility and/or distance state has changed. + The upper limit around the primary axis of the character joint. - + - Locks the CullingGroup to a specific camera. + The lower limit around the primary axis of the character joint. - + - Create a CullingGroup. + Set the angular tolerance threshold (in degrees) for projection. - + - Clean up all memory used by the CullingGroup immediately. + Set the linear tolerance threshold for projection. - + - Erase a given bounding sphere by moving the final sphere on top of it. + The angular limit of rotation (in degrees) around the primary axis of the character joint. - 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 angular limit of rotation (in degrees) around the primary axis of the character joint. - 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 secondary axis around which the joint can rotate. - 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 configuration of the spring attached to the swing limits of the joint. - 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. + The configuration of the spring attached to the twist limits of the joint. - 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. + Collider for 2D physics representing an circle. - 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. + The center point of the collider in local space. - 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. + Radius of the circle. - 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. - + - 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. + The Cloth class provides an interface to cloth simulation physics. - 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. + Bending stiffness of the cloth. - The number of bounding spheres being used. - + - Sets the array of bounding sphere definitions that the CullingGroup should compute culling for. + An array of CapsuleColliders which this Cloth instance should collide with. - The BoundingSpheres to cull. - + - Set the reference point from which distance bands are measured. + The cloth skinning coefficients used to set up how the cloth interacts with the skinned mesh. - 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. + How much to increase mass of colliding particles. - 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. + Damp cloth motion. - 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. + Is this cloth enabled? - + - The current distance band index of the sphere, after the most recent culling pass. + A constant, external acceleration applied to the cloth. - + - Did this sphere change from being visible to being invisible in the most recent culling pass? + The friction of the cloth when colliding with the character. - + - Did this sphere change from being invisible to being visible in the most recent culling pass? + The current normals of the cloth object. - + - The index of the sphere that has changed. + A random, external acceleration applied to the cloth. - + - Was the sphere considered visible by the most recent culling pass? + Cloth's sleep threshold. - + - The distance band index of the sphere before the most recent culling pass. + An array of ClothSphereColliderPairs which this Cloth instance should collide with. - + - Was the sphere visible before the most recent culling pass? + Stretching stiffness of the cloth. - + - Cursor API for setting the cursor that is used for rendering. + Should gravity affect the cloth simulation? - + - How should the cursor be handled? + Add one virtual particle per triangle to improve collision stability. - + - Should the cursor be visible? + The current vertex positions of the cloth object. - + - Change the mouse cursor to the set texture OnMouseEnter. + How much world-space acceleration of the character will affect cloth vertices. - + - Specify a custom cursor that you wish to use as a cursor. + How much world-space movement of the character will affect cloth vertices. - The texture to use for the cursor or null to set the default cursor. Note that a texture needs to be imported with "Read/Write enabled" in the texture importer (or using the "Cursor" defaults), in order to be used as a cursor. - 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. + Clear the pending transform changes from affecting the cloth simulation. - + - Confine cursor to the game window. + Fade the cloth simulation in or out. + Fading enabled or not. + - + - Lock cursor to the center of the game window. + 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. - + - Cursor behavior is unmodified. + Definition of a sphere a vertex is not allowed to enter. This allows collision against the animated cloth. - + - How should the custom cursor be rendered. + Distance a vertex is allowed to travel from the skinned mesh vertex position. - + - Use hardware cursors on supported platforms. + A pair of SphereColliders used to define shapes for Cloth objects to collide against. - + - Force the use of software cursors. + The first SphereCollider of a ClothSphereColliderPair. - + - Base class for custom yield instructions to suspend coroutines. + The second SphereCollider of a ClothSphereColliderPair. - + - Indicates if coroutine should be kept suspended. + 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. - + - Class containing methods to ease debugging while developing a game. + 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. - + - Opens or closes developer console. + Interface for reading and writing inputs in a Unity Cluster. - + - In the Build Settings dialog there is a check box called "Development Build". + 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. + - + - Get default debug logger. + Check the connection status of the device to the VRPN server it connected to. + Name of the input entry. - + - Assert a condition and logs a formatted error message to the Unity console on failure. + Edit an input entry which added via ClusterInput.AddInput. - Condition you expect to be true. - Object to which the message applies. - String or object to be converted to string representation for display. + 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. - + - Assert a condition and logs a formatted error message to the Unity console on failure. + Returns the axis value as a continous float. - Condition you expect to be true. - Object to which the message applies. - String or object to be converted to string representation for display. + Name of input to poll.c. - + - Assert a condition and logs a formatted error message to the Unity console on failure. + Returns the binary value of a button. - Condition you expect to be true. - Object to which the message applies. - String or object to be converted to string representation for display. + Name of input to poll. - + - Assert a condition and logs a formatted error message to the Unity console on failure. + Return the position of a tracker as a Vector3. - Condition you expect to be true. - Object to which the message applies. - String or object to be converted to string representation for display. + Name of input to poll. - + - Assert a condition and logs a formatted error message to the Unity console on failure. + Returns the rotation of a tracker as a Quaternion. - Condition you expect to be true. - A composite format string. - Format arguments. - Object to which the message applies. + Name of input to poll. - + - Assert a condition and logs a formatted error message to the Unity console on failure. + Sets the axis value for this input. Only works for input typed Custom. - Condition you expect to be true. - A composite format string. - Format arguments. - Object to which the message applies. + Name of input to modify. + Value to set. - + - Pauses the editor. + Sets the button value for this input. Only works for input typed Custom. + Name of input to modify. + Value to set. - + - Clears errors from the developer console. + Sets the tracker position for this input. Only works for input typed Custom. + Name of input to modify. + Value to set. - + - Draws a line between specified start and end points. + Sets the tracker rotation for this input. Only works for input typed Custom. - 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? + Name of input to modify. + Value to set. - + - Draws a line between specified start and end points. + Values to determine the type of input value to be expect from one entry of ClusterInput. - 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. + Device is an analog axis that provides continuous value represented by a float. - 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. + Device that return a binary result of pressed or not pressed. - 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. + A user customized input. - 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. + Device that provide position and orientation values. - 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. + A helper class that contains static method to inquire status of Unity Cluster. - 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. + Check whether the current instance is disconnected from the cluster network. - 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? - + - Logs message to the Unity Console. + Check whether the current instance is a master node in the cluster network. - String or object to be converted to string representation for display. - Object to which the message applies. - + - Logs message to the Unity Console. + To acquire or set the node index of the current machine from the cluster network. - 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. + A base class of all colliders. - 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. + The rigidbody the collider is attached to. - 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. + The world space bounding volume of the collider. - A composite format string. - Format arguments. - Object to which the message applies. - + - Logs a formatted assertion message to the Unity console. + Contact offset value of this collider. - 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. + Enabled Colliders will collide with other colliders, disabled Colliders won't. - 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. + Is the collider a trigger? - 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. + The material used by the collider. - A composite format string. - Format arguments. - Object to which the message applies. - + - Logs a formatted error message to the Unity console. + The shared physic material of this collider. - 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. + Returns a point on the collider that is closest to a given location. - Object to which the message applies. - Runtime Exception. + Location you want to find the closest point to. + + The point on the collider that is closest to the specified location. + - + - A variant of Debug.Log that logs an error message to the console. + The closest point to the bounding box of the attached collider. - Object to which the message applies. - Runtime Exception. + - + - Logs a formatted message to the Unity Console. + Casts a Ray that ignores all Colliders except this one. - A composite format string. - Format arguments. - Object to which the message applies. + 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 length of the ray. + + True when the ray intersects any collider, otherwise false. + - + - Logs a formatted message to the Unity Console. + Parent class for collider types used with 2D gameplay. - 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. + The Rigidbody2D attached to the Collider2D's GameObject. - 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. + Get the bounciness used by the collider. - 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. + The world space bounding area of the collider. - A composite format string. - Format arguments. - Object to which the message applies. - + - Logs a formatted warning message to the Unity Console. + Get the CompositeCollider2D that is available to be attached to the collider. - 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. + The density of the collider used to calculate its mass (when auto mass is enabled). - + - Attribute used to make a float, int, or string variable in a script be delayed. + Get the friction used by the collider. - + - Depth texture generation mode for Camera. + Is this collider configured as a trigger? - + - Generate a depth texture. + The local offset of the collider geometry. - + - Generate a depth + normals texture. + The number of separate shaped regions in the collider. - + - Do not generate depth texture (Default). + The PhysicsMaterial2D that is applied to this collider. - + - Detail prototype used by the Terrain GameObject. + Sets whether the Collider will be used or not used by a CompositeCollider2D. - + - Bend factor of the detailPrototype. + Whether the collider is used by an attached effector or not. - + - Color when the DetailPrototypes are "dry". + 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. + - + - Color when the DetailPrototypes are "healthy". + 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. + - + - Maximum height of the grass billboards (if render mode is GrassBillboard). + 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. + - + - Maximum width of the grass billboards (if render mode is GrassBillboard). + 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. + - + - Minimum height of the grass billboards (if render mode is GrassBillboard). + 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. + - + - Minimum width of the grass billboards (if render mode is GrassBillboard). + 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. + - + - How spread out is the noise for the DetailPrototype. + 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. + - + - GameObject used by the DetailPrototype. + 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. + - + - Texture used by the DetailPrototype. + 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. + - + - Render mode for the DetailPrototype. + 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. + - + - Render mode for detail prototypes. + 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. + - + - The detail prototype will use the grass shader. + 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. + - + - The detail prototype will be rendered as billboards that are always facing the camera. + Check if a collider overlaps a point in space. + A point in world space. + + Does point overlap the collider? + - + - Will show the prototype using diffuse shading. + 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. + - + - Describes physical orientation of the device as determined by the OS. + 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. + - + - The device is held parallel to the ground with the screen facing downwards. + Represents the separation or overlap of two Collider2D. - + - The device is held parallel to the ground with the screen facing upwards. + Gets the distance between two colliders. - + - The device is in landscape mode, with the device held upright and the home button on the right side. + Gets whether the distance represents an overlap or not. - + - The device is in landscape mode, with the device held upright and the home button on the left side. + Gets whether the distance is valid or not. - + - The device is in portrait mode, with the device held upright and the home button at the bottom. + A normalized vector that points from pointB to pointA. - + - The device is in portrait mode but upside down, with the device held upright and the home button at the top. + A point on a Collider2D that is a specific distance away from pointB. - + - The orientation of the device cannot be determined. + A point on a Collider2D that is a specific distance away from pointA. - + - Enumeration for SystemInfo.deviceType, denotes a coarse grouping of kinds of devices. + Describes a collision. - + - A stationary gaming console. + The Collider we hit (Read Only). - + - Desktop or laptop computer. + The contact points generated by the physics engine. - + - A handheld device like mobile phone or a tablet. + The GameObject whose collider we are colliding with. (Read Only). - + - Device type is unknown. You should never see this in practice. + The total impulse applied to this contact pair to resolve the collision. - + - Prevents MonoBehaviour of same type (or subtype) to be added more than once to a GameObject. + The relative linear velocity of the two colliding objects (Read Only). - + - Provides access to a display / screen for rendering operations. + The Rigidbody we hit (Read Only). This is null if the object we hit is a collider with no rigidbody attached. - + - Color RenderBuffer. + The Transform of the object we hit (Read Only). - + - Depth RenderBuffer. + Collision details returned by 2D physics callback functions. - + - The list of currently connected Displays. Contains at least one (main) display. + The incoming Collider2D involved in the collision with the otherCollider. - + - Main Display. - + The specific points of contact with the incoming Collider2D. - + - Rendering Height. + Indicates whether the collision response or reaction is enabled or disabled. - + - Rendering Width. + The incoming GameObject involved in the collision. - + - System Height. + The other Collider2D involved in the collision with the collider. - + - System Width. + The other Rigidbody2D involved in the collision with the rigidbody. - + - Activate an external display. Eg. Secondary Monitors connected to the System. + The relative linear velocity of the two colliding objects (Read Only). - + - This overloaded function available for Windows allows specifying desired Window Width, Height and Refresh Rate. + The incoming Rigidbody2D involved in the collision with the otherRigidbody. - 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. + The Transform of the incoming object involved in the collision. - Mouse Input Position as Coordinates. - + - This Windows only function can be used to set Size and Position of the Screen when Multi-Display is enabled. + The collision detection mode constants used for Rigidbody.collisionDetectionMode. - 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. + Continuous collision detection is on for colliding with static mesh geometry. - Rendering width. - Rendering height. - + - Joint that keeps two Rigidbody2D objects a fixed distance apart. + Continuous collision detection is on for colliding with static and dynamic geometry. - + - Should the distance be calculated automatically? + Continuous collision detection is off for this Rigidbody. - + - The distance separating the two ends of the joint. + Controls how collisions are detected when a Rigidbody2D moves. - + - Whether to maintain a maximum distance only or not. If not then the absolute distance will be maintained instead. + Ensures that all collisions are detected when a Rigidbody2D moves. - + - A component can be designed drive a RectTransform. The DrivenRectTransformTracker struct is used to specify which RectTransforms it is driving. + When a Rigidbody2D moves, only collisions at the new position are detected. - + - Add a RectTransform to be driven. + This mode is obsolete. You should use Discrete mode. - The object to drive properties. - The RectTransform to be driven. - The properties to be driven. - + - Clear the list of RectTransforms being driven. + CollisionFlags is a bitmask returned by CharacterController.Move. - + - An enumeration of transform properties that can be driven on a RectTransform by an object. + CollisionFlags is a bitmask returned by CharacterController.Move. - + - Selects all driven properties. + CollisionFlags is a bitmask returned by CharacterController.Move. - + - Selects driven property RectTransform.anchoredPosition. + CollisionFlags is a bitmask returned by CharacterController.Move. - + - Selects driven property RectTransform.anchoredPosition3D. + CollisionFlags is a bitmask returned by CharacterController.Move. - + - Selects driven property RectTransform.anchoredPosition.x. + Representation of RGBA colors. - + - Selects driven property RectTransform.anchoredPosition.y. + Alpha component of the color. - + - Selects driven property RectTransform.anchoredPosition3D.z. + Blue component of the color. - + - Selects driven property combining AnchorMaxX and AnchorMaxY. + Solid black. RGBA is (0, 0, 0, 1). - + - Selects driven property RectTransform.anchorMax.x. + Solid blue. RGBA is (0, 0, 1, 1). - + - Selects driven property RectTransform.anchorMax.y. + Completely transparent. RGBA is (0, 0, 0, 0). - + - Selects driven property combining AnchorMinX and AnchorMinY. + Cyan. RGBA is (0, 1, 1, 1). - + - Selects driven property RectTransform.anchorMin.x. + Green component of the color. - + - Selects driven property RectTransform.anchorMin.y. + A version of the color that has had the gamma curve applied. - + - Selects driven property combining AnchorMinX, AnchorMinY, AnchorMaxX and AnchorMaxY. + Gray. RGBA is (0.5, 0.5, 0.5, 1). - + - Deselects all driven properties. + The grayscale value of the color. (Read Only) - + - Selects driven property combining PivotX and PivotY. + Solid green. RGBA is (0, 1, 0, 1). - + - Selects driven property RectTransform.pivot.x. + English spelling for gray. RGBA is the same (0.5, 0.5, 0.5, 1). - + - Selects driven property RectTransform.pivot.y. + A linear value of an sRGB color. - + - Selects driven property Transform.localRotation. + Magenta. RGBA is (1, 0, 1, 1). - + - Selects driven property combining ScaleX, ScaleY && ScaleZ. + Returns the maximum color component value: Max(r,g,b). - + - Selects driven property Transform.localScale.x. + Red component of the color. - + - Selects driven property Transform.localScale.y. + Solid red. RGBA is (1, 0, 0, 1). - + - Selects driven property Transform.localScale.z. + Solid white. RGBA is (1, 1, 1, 1). - + - Selects driven property combining SizeDeltaX and SizeDeltaY. + Yellow. RGBA is (1, 0.92, 0.016, 1), but the color is nice to look at! - + - Selects driven property RectTransform.sizeDelta.x. + Constructs a new Color with given r,g,b,a components. + Red component. + Green component. + Blue component. + Alpha component. - + - Selects driven property RectTransform.sizeDelta.y. + Constructs a new Color with given r,g,b components and sets a to 1. + Red component. + Green component. + Blue component. - + - Allows to control the dynamic Global Illumination. + Creates an RGB colour from HSV input. + Hue [0..1]. + Saturation [0..1]. + 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. + - + - Allows for scaling the contribution coming from realtime & static lightmaps. + Creates an RGB colour from HSV input. + Hue [0..1]. + Saturation [0..1]. + 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. + - + - When enabled, new dynamic Global Illumination output is shown in each frame. + Colors can be implicitly converted to and from Vector4. + - + - Threshold for limiting updates of realtime GI. + Colors can be implicitly converted to and from Vector4. + - + - Allows to set an emissive color for a given renderer quickly, without the need to render the emissive input for the entire system. + Linearly interpolates between colors a and b by t. - The Renderer that should get a new color. - The emissive Color. - The index of the submesh that should use the color. + Color a + Color b + Float for combining a and b - + - Schedules an update of the environment texture. + Linearly interpolates between colors a and b by t. + + + - + - Schedules an update of the albedo and emissive textures of a system that contains the renderer or the terrain. + Divides color a by the float b. Each color component is scaled separately. - 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. + Subtracts color b from color a. Each component is subtracted separately. - 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. + Multiplies two colors together. Each component is multiplied separately. - 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. + Multiplies color a by the float b. Each color component is scaled separately. + + - + - Gets the number of edges. + Multiplies color a by the float b. Each color component is scaled separately. + + - + - Gets the number of points. + Adds two colors together. Each component is added separately. + + - + - Get or set the points defining multiple continuous edges. + 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. - + - Reset to a single edge consisting of two points. + Access the r, g, b,a components using [0], [1], [2], [3] respectively. - + - A base class for all 2D effectors. + Returns a nicely formatted string of this color. + - + - The mask used to select specific layers allowed to interact with the effector. + Returns a nicely formatted string of this color. + - + - Should the collider-mask be used or the global collision matrix? + Representation of RGBA colors in 32 bit format. - + - The mode used to apply Effector2D forces. + Alpha component of the color. - + - The force is applied at a constant rate. + Blue component of the color. - + - The force is applied inverse-linear relative to a point. + Green component of the color. - + - The force is applied inverse-squared relative to a point. + Red component of the color. - + - Selects the source and/or target to be used by an Effector2D. + Constructs a new Color32 with given r, g, b, a components. + + + + - + - The source/target is defined by the Collider2D. + Color32 can be implicitly converted to and from Color. + - + - The source/target is defined by the Rigidbody2D. + Color32 can be implicitly converted to and from Color. + - + - Class used to allow GameObject.AddComponent / GameObject.GetComponent to be used. + Linearly interpolates between colors a and b by t. + + + - + - A UnityGUI event. + Linearly interpolates between colors a and b by t. + + + - + - Is Alt/Option key held down? (Read Only) + Returns a nicely formatted string of this color. + - + - Which mouse button was pressed. + Returns a nicely formatted string of this color. + - + - Is Caps Lock on? (Read Only) + Color space for player settings. - + - The character typed. + Gamma color space. - + - How many consecutive mouse clicks have we received. + Linear color space. - + - Is Command/Windows key held down? (Read Only) + Uninitialized color space. - + - The name of an ExecuteCommand or ValidateCommand Event. + Attribute used to configure the usage of the ColorField and Color Picker for a color. - + - Is Control key held down? (Read Only) + If set to true the Color is treated as a HDR color. - + - The current event that's being processed right now. + Maximum allowed HDR color component value when using the HDR Color Picker. - + - The relative movement of the mouse compared to last event. + Maximum exposure value allowed in the HDR Color Picker. - + - Index of display that the event belongs to. + Minimum allowed HDR color component value when using the Color Picker. - + - Is the current keypress a function key? (Read Only) + Minimum exposure value allowed in the HDR Color Picker. - + - Is this event a keyboard event? (Read Only) + If false then the alpha bar is hidden in the ColorField and the alpha value is not shown in the Color Picker. - + - Is this event a mouse event? (Read Only) + 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). - + - The raw key code for keyboard events. + 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). - + - Which modifier keys are held down. + A collection of common color functions. - + - The mouse position. + Returns the color as a hexadecimal string in the format "RRGGBB". + The color to be converted. + + Hexadecimal string representing the color. + - + - Is the current keypress on the numeric keyboard? (Read Only) + Returns the color as a hexadecimal string in the format "RRGGBBAA". + The color to be converted. + + Hexadecimal string representing the color. + - + - Is Shift held down? (Read Only) + 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. + - + - The type of event. + Struct used to describe meshes to be combined using Mesh.CombineMeshes. - + - Returns the current number of events that are stored in the event queue. + The baked lightmap UV scale and offset applied to the Mesh. - - Current number of events currently in the event queue. - - + - Get a filtered event type for a given control ID. + Mesh to combine. - The ID of the control you are querying from. - + - Create a keyboard event. + The realtime lightmap UV scale and offset applied to the Mesh. - - + - Get the next queued [Event] from the event system. + Sub-Mesh index of the Mesh. - Next Event. - + - Use this event. + Matrix to transform the Mesh with before combining. - + - Types of modifier key that can be active during a keystroke event. + Interface into compass functionality. - + - Alt key. + 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(). - + - Caps lock key. + Accuracy of heading reading in degrees. - + - Command key (Mac). + The heading in degrees relative to the magnetic North Pole. (Read Only) - + - Control key. + The raw geomagnetic data measured in microteslas. (Read Only) - + - Function key. + Timestamp (in seconds since 1970) when the heading was last time updated. (Read Only) - + - No modifier key pressed during a keystroke event. + The heading in degrees relative to the geographic North Pole. (Read Only) - + - Num lock key. + Base class for everything attached to GameObjects. - + - Shift key. + The Animation attached to this GameObject. (Null if there is none attached). - + - THe mode that a listener is operating in. + The AudioSource attached to this GameObject. (Null if there is none attached). - + - The listener will bind to one argument bool functions. + The Camera attached to this GameObject. (Null if there is none attached). - + - The listener will use the function binding specified by the even. + The Collider attached to this GameObject. (Null if there is none attached). - + - The listener will bind to one argument float functions. + The Collider2D component attached to the object. - + - The listener will bind to one argument int functions. + The ConstantForce attached to this GameObject. (Null if there is none attached). - + - The listener will bind to one argument Object functions. + The game object this component is attached to. A component is always attached to a game object. - + - The listener will bind to one argument string functions. + The GUIText attached to this GameObject. (Null if there is none attached). - + - The listener will bind to zero argument functions. + The GUITexture attached to this GameObject (Read Only). (null if there is none attached). - + - Zero argument delegate used by UnityEvents. + The HingeJoint attached to this GameObject. (Null if there is none attached). - + - One argument delegate used by UnityEvents. + The Light attached to this GameObject. (Null if there is none attached). - - + - Two argument delegate used by UnityEvents. + The NetworkView attached to this GameObject (Read Only). (null if there is none attached). - - - + - Three argument delegate used by UnityEvents. + The ParticleEmitter attached to this GameObject. (Null if there is none attached). - - - - + - Four argument delegate used by UnityEvents. + The ParticleSystem attached to this GameObject. (Null if there is none attached). - - - - - + - A zero argument persistent callback that can be saved with the scene. + The Renderer attached to this GameObject. (Null if there is none attached). - + - Add a non persistent listener to the UnityEvent. + The Rigidbody attached to this GameObject. (Null if there is none attached). - Callback function. - + - Constructor. + The Rigidbody2D that is attached to the Component's GameObject. - + - Invoke all registered callbacks (runtime and peristent). + The tag of this game object. - + - Remove a non persistent listener from the UnityEvent. + The Transform attached to this GameObject. - Callback function. - + - One argument version of UnityEvent. + 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? - + - Two argument version of UnityEvent. + 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? - + - Three argument version of UnityEvent. + 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? - + - Four argument version of UnityEvent. + 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? - + - Abstract base class for UnityEvents. + Is this game object tagged with tag ? + The tag to compare. - + - Get the number of registered persistent listeners. + Returns the component of Type type if the game object has one attached, null if it doesn't. + The type of Component to retrieve. - + - Get the target method name of the listener at index index. + Generic version. See the page for more details. - Index of the listener to query. - + - Get the target component of the listener at index index. + Returns the component with name type if the game object has one attached, null if it doesn't. - Index of the listener to query. + - + - Given an object, function name, and a list of argument types; find the method that matches. + Returns the component of Type type in the GameObject or any of its children using depth first search. - Object to search for the method. - Function name to search for. - Argument types for the function. + The type of Component to retrieve. + + A component of the matching type, if found. + - + - Remove all listeners from the event. + Generic version. See the page for more details. + + + A component of the matching type, if found. + - + - Modify the execution state of a persistent listener. + Returns the component of Type type in the GameObject or any of its parents. - Index of the listener to query. - State to set. + The type of Component to retrieve. + + A component of the matching type, if found. + - + - Controls the scope of UnityEvent callbacks. + Generic version. See the page for more details. + + A component of the matching type, if found. + - + - Callback is always issued. + Returns all components of Type type in the GameObject. + The type of Component to retrieve. - + - Callback is not issued. + Generic version. See the page for more details. - + - Callback is only issued in the Runtime and Editor playmode. + 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? - + - Types of UnityGUI input and processing events. + 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? - + - User has right-clicked (or control-clicked on the mac). + Generic version. See the page for more details. + Should Components on inactive GameObjects be included in the found set? + + A list of all found components matching the specified type. + - + - Editor only: drag & drop operation exited. + Generic version. See the page for more details. + + A list of all found components matching the specified type. + - + - Editor only: drag & drop operation performed. + 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? - + - Editor only: drag & drop operation updated. + Generic version. See the page for more details. + Should inactive Components be included in the found set? - + - Execute a special command (eg. copy & paste). + Generic version. See the page for more details. + Should inactive Components be included in the found set? - + - Event should be ignored. + 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? - + - A keyboard key was pressed. + 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? - + - A keyboard key was released. + 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? - + - A layout event. + 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? - + - Mouse button was pressed. + 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? - + - Mouse was dragged. + 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? - + - Mouse was moved (editor views only). + 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? - + - Mouse button was released. + 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 repaint event. One is sent every frame. + A Collider that can merge other Colliders together. - + - The scroll wheel was moved. + Controls the radius of all edges created by the Collider. - + - Already processed event. + Specifies when to generate the Composite Collider geometry. - + - Validates a special command (e.g. copy & paste). + Specifies the type of geometry the Composite Collider should generate. - + - Makes a script execute in edit mode. + The number of paths in the Collider. - + - Playable that plays an AnimationClip. Can be used as an input to an AnimationPlayable. + Gets the total number of points in all the paths within the Collider. - + - AnimationClip played by this playable. + Controls the minimum distance allowed between generated vertices. - + - The speed at which the AnimationClip is played. + Regenerates the Composite Collider geometry. - + - Playable used to mix AnimationPlayables. + Specifies when to generate the Composite Collider geometry. - + - Automatically creates an AnimationClipPlayable for each supplied AnimationClip, then sets them as inputs to the mixer. + Sets the Composite Collider geometry to not automatically update when a Collider used by the Composite Collider changes. - AnimationClips to be used as inputs. - - Returns false if the creation of the AnimationClipPlayables failed, or if the connection failed. - - + - Base class for all animation related Playable classes. + Sets the Composite Collider geometry to update synchronously immediately when a Collider used by the Composite Collider changes. - + - Adds an AnimationPlayable as an input. + Specifies the type of geometry the Composite Collider generates. - A playable to connect. - - Returns the index of the port the playable was connected to. - - + - Disconnects all input playables. + Sets the Composite Collider to generate closed outlines for the merged Collider geometry consisting of only edges. - - Returns false if the removal fails. - - + - Removes a playable from the list of inputs. + Sets the Composite Collider to generate closed outlines for the merged Collider geometry consisting of convex polygon shapes. - Index of the playable to remove. - AnimationPlayable to remove. - - Returns false if the removal could not be removed because it wasn't found. - - + - Removes a playable from the list of inputs. + Gets a path from the Collider by its index. - Index of the playable to remove. - AnimationPlayable to remove. + The index of the path from 0 to pathCount. + An ordered array of the vertices or points in the selected path. - Returns false if the removal could not be removed because it wasn't found. + Returns the number of points placed in the points array. - + - Sets an AnimationPlayable as an input. + Gets the number of points in the specified path from the Collider by its index. - AnimationPlayable to be used as input. - Index of the input. + The index of the path from 0 to pathCount. - Returns false if the operation could not be completed. + Returns the number of points in the path specified by index. - + - Replaces existing inputs with the supplied collection of AnimationPlayable. + GPU data buffer, mostly for use with compute shaders. - Collection of AnimationPlayables to be used as inputs. - - Returns false if the operation could not be completed. - - + - Playable that plays a RuntimeAnimatorController. Can be used as an input to an AnimationPlayable. + Number of elements in the buffer (Read Only). - + - RuntimeAnimatorController played by this playable. + Size of one element in the buffer (Read Only). - + - See IAnimatorControllerPlayable.layerCount. + 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. - + - See IAnimatorControllerPlayable.parameterCount. + 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). - + - See IAnimatorControllerPlayable.CrossFade. + 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). - + - See IAnimatorControllerPlayable.CrossFade. + Read data values from the buffer into an array. - - - - - + An array to receive the data. - + - See IAnimatorControllerPlayable.CrossFadeInFixedTime. + Retrieve a native (underlying graphics API) pointer to the buffer. - - - - - + + Pointer to the underlying graphics API buffer. + - + - See IAnimatorControllerPlayable.CrossFadeInFixedTime. + Release a Compute Buffer. - - - - - - + - See IAnimatorControllerPlayable.GetAnimatorTransitionInfo. + Sets counter value of append/consume buffer. - + Value of the append/consume counter. - + - See IAnimatorControllerPlayable.GetBool. + Set the buffer with values from an array. - - + Array of values to fill the buffer. - + - See IAnimatorControllerPlayable.GetBool. + ComputeBuffer type. - - - + - See IAnimatorControllerPlayable.GetCurrentAnimatorClipInfo. + Append-consume ComputeBuffer type. - - + - See IAnimatorControllerPlayable.GetCurrentAnimatorStateInfo. + ComputeBuffer with a counter. - - + - See IAnimatorControllerPlayable.GetFloat. + Default ComputeBuffer type (structured buffer). - - - + - See IAnimatorControllerPlayable.GetFloat. + ComputeBuffer is attempted to be located in GPU memory. - - - + - See IAnimatorControllerPlayable.GetInteger. + ComputeBuffer used for Graphics.DrawProceduralIndirect, ComputeShader.DispatchIndirect or Graphics.DrawMeshInstancedIndirect arguments. - - - + - See IAnimatorControllerPlayable.GetInteger. + Raw ComputeBuffer type (byte address buffer). - - - + - See IAnimatorControllerPlayable.GetLayerIndex. + Compute Shader asset. - - + - See IAnimatorControllerPlayable.GetLayerName. + 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. - + - See IAnimatorControllerPlayable.GetLayerWeight. + 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. - + - See IAnimatorControllerPlayable.GetNextAnimatorClipInfo. + Find ComputeShader kernel index. - + Name of kernel function. + + The Kernel index, or logs a "FindKernel failed" error message if the kernel is not found. + - + - See IAnimatorControllerPlayable.GetNextAnimatorStateInfo. + 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. - + - See AnimatorController.GetParameter. + Checks whether a shader contains a given kernel. - + The name of the kernel to look for. + + True if the kernel is found, false otherwise. + - + - See IAnimatorControllerPlayable.HasState. + Set a bool parameter. - - + Variable name in shader code. + Property name ID, use Shader.PropertyToID to get it. + Value to set. - + - See IAnimatorControllerPlayable.IsInTransition. + Set a bool parameter. - + Variable name in shader code. + Property name ID, use Shader.PropertyToID to get it. + Value to set. - + - See IAnimatorControllerPlayable.IsParameterControlledByCurve. + 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. - + - See IAnimatorControllerPlayable.IsParameterControlledByCurve. + 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. - + - See IAnimatorControllerPlayable.Play. + Set a float parameter. - - - - + Variable name in shader code. + Property name ID, use Shader.PropertyToID to get it. + Value to set. - + - See IAnimatorControllerPlayable.Play. + Set a float parameter. - - - - + Variable name in shader code. + Property name ID, use Shader.PropertyToID to get it. + Value to set. - + - See IAnimatorControllerPlayable.PlayInFixedTime. + 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. - + - See IAnimatorControllerPlayable.PlayInFixedTime. + 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. - + - See IAnimatorControllerPlayable.ResetTrigger. + Set an integer parameter. - - + Variable name in shader code. + Property name ID, use Shader.PropertyToID to get it. + Value to set. - + - See IAnimatorControllerPlayable.ResetTrigger. + Set an integer parameter. - - + Variable name in shader code. + Property name ID, use Shader.PropertyToID to get it. + Value to set. - + - See IAnimatorControllerPlayable.SetBool. + 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. - + - See IAnimatorControllerPlayable.SetBool. + 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. - + - See IAnimatorControllerPlayable.SetFloat. + 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. - + - See IAnimatorControllerPlayable.SetFloat. + 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. - + - See IAnimatorControllerPlayable.SetInteger. + 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. - + - See IAnimatorControllerPlayable.SetInteger. + 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. - + - See IAnimatorControllerPlayable.SetLayerWeight. + Set a vector parameter. - - + Variable name in shader code. + Property name ID, use Shader.PropertyToID to get it. + Value to set. - + - See IAnimatorControllerPlayable.SetTrigger. + Set a vector parameter. - - + Variable name in shader code. + Property name ID, use Shader.PropertyToID to get it. + Value to set. - + - See IAnimatorControllerPlayable.SetTrigger. + The configurable joint is an extremely flexible joint giving you complete control over rotation and linear motion. - - - + - The DirectorPlayer is the base class for all components capable of playing a Experimental.Director.Playable tree. + Definition of how the joint's rotation will behave around its local X axis. Only used if Rotation Drive Mode is Swing & Twist. - + - Returns the Player's current local time. + The configuration of the spring attached to the angular X limit of the joint. - - Current local time. - - + - Returns the current Experimental.Director.DirectorUpdateMode. + Allow rotation around the X axis to be Free, completely Locked, or Limited according to Low and High Angular XLimit. - - Current update mode for this player. - - + - Starts playing a Experimental.Director.Playable tree. + Boundary defining rotation restriction, based on delta from original rotation. - The root Experimental.Director.Playable in the tree. - + - Sets the Player's local time. + Allow rotation around the Y axis to be Free, completely Locked, or Limited according to Angular YLimit. - The new local time. - + - Specifies the way the Player's will increment when it is playing. + 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. - - + - Stop the playback of the Player and Experimental.Director.Playable. + The configuration of the spring attached to the angular Y and angular Z limits of the joint. - + - Defines what time source is used to update a Director graph. + Boundary defining rotation restriction, based on delta from original rotation. - + - Update is based on DSP (Digital Sound Processing) clock. Use this for graphs that need to be synchronized with Audio. + Allow rotation around the Z axis to be Free, completely Locked, or Limited according to Angular ZLimit. - + - 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. + If enabled, all Target values will be calculated in world space instead of the object's local space. - + - Update mode is manual. You need to manually call PlayerController.Tick with your own deltaTime. This can be useful for graphs that can be completely disconnected from the rest of the the game. Example: Localized Bullet time. + Boundary defining upper rotation restriction, based on delta from original rotation. - + - 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. + Boundary defining movement restriction, based on distance from the joint's origin. - + - This structure contains the frame information a Playable receives in Playable.PrepareFrame. + The configuration of the spring attached to the linear limit of the joint. - + - Time difference between this frame and the preceding frame in double precision. + Boundary defining lower rotation restriction, based on delta from original rotation. - + - Time difference between this frame and the preceding frame. + 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). - + - Time difference between this frame and the preceding frame in double precision. + 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). - + - Current time at the start of the frame in double precision. + 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. - + - Time speed multiplier in double precision. + Control the object's rotation with either X & YZ or Slerp Drive by itself. - + - Last frame's start time. + The joint's secondary axis. - + - Current time at the start of the frame. + Definition of how the joint's rotation will behave around all local axes. Only used if Rotation Drive Mode is Slerp Only. - + - Time speed multiplier. 1 is normal speed, 0 is stopped. + If enabled, the two connected rigidbodies will be swapped, as if the joint was attached to the other body. - + - Frame update counter. Can be used to know when to initialize your Playable (when updateid is 0). + This is a Vector3. It defines the desired angular velocity that the joint should rotate into. - + - Interface for objects that can control an AnimatorController. + The desired position that the joint should move into. - + - The AnimatorController layer count. + This is a Quaternion. It defines the desired rotation that the joint should rotate into. - + - The number of AnimatorControllerParameters used by the AnimatorController. + The desired velocity that the joint should move along. - + - Creates a dynamic transition between the current state and the destination state. + Definition of how the joint's movement will behave along its local X axis. - The name of the destination state. - The duration of the transition. Value is in source state normalized time. - Layer index containing the destination state. If no layer is specified or layer is -1, the first state that is found with the given name or hash will be played. - Start time of the current destination state. Value is in source state normalized time, should be between 0 and 1. If no explicit normalizedTime is specified or normalizedTime value is float.NegativeInfinity, the state will either be played from the start if it's not already playing, or will continue playing from its current time and no transition will happen. - The AnimatorState fullPathHash, nameHash or shortNameHash to play. Passing 0 will transition to self. - + - Creates a dynamic transition between the current state and the destination state. + Allow movement along the X axis to be Free, completely Locked, or Limited according to Linear Limit. - The name of the destination state. - The duration of the transition. Value is in source state normalized time. - Layer index containing the destination state. If no layer is specified or layer is -1, the first state that is found with the given name or hash will be played. - Start time of the current destination state. Value is in source state normalized time, should be between 0 and 1. If no explicit normalizedTime is specified or normalizedTime value is float.NegativeInfinity, the state will either be played from the start if it's not already playing, or will continue playing from its current time and no transition will happen. - The AnimatorState fullPathHash, nameHash or shortNameHash to play. Passing 0 will transition to self. - + - Same as IAnimatorControllerPlayable.CrossFade, but the duration and offset in the target state are in fixed time. + Definition of how the joint's movement will behave along its local Y axis. - The name of the destination state. - The duration of the transition. Value is in seconds. - Layer index containing the destination state. If no layer is specified or layer is -1, the first state that is found with the given name or hash will be played. - Start time of the current destination state. Value is in seconds. If no explicit fixedTime is specified or fixedTime value is float.NegativeInfinity, the state will either be played from the start if it's not already playing, or will continue playing from its current time and no transition will happen. - The AnimatorState fullPathHash, nameHash or shortNameHash to play. Passing 0 will transition to self. - + - Same as IAnimatorControllerPlayable.CrossFade, but the duration and offset in the target state are in fixed time. + Allow movement along the Y axis to be Free, completely Locked, or Limited according to Linear Limit. - The name of the destination state. - The duration of the transition. Value is in seconds. - Layer index containing the destination state. If no layer is specified or layer is -1, the first state that is found with the given name or hash will be played. - Start time of the current destination state. Value is in seconds. If no explicit fixedTime is specified or fixedTime value is float.NegativeInfinity, the state will either be played from the start if it's not already playing, or will continue playing from its current time and no transition will happen. - The AnimatorState fullPathHash, nameHash or shortNameHash to play. Passing 0 will transition to self. - + - Gets the Transition information on a specified AnimatorController layer. + Definition of how the joint's movement will behave along its local Z axis. - The layer's index. - + - See IAnimatorControllerPlayable.GetBool. + Allow movement along the Z axis to be Free, completely Locked, or Limited according to Linear Limit. - The name of the parameter. - The id of the parameter. The id is generated using Animator::StringToHash. - + - See IAnimatorControllerPlayable.GetBool. + Constrains movement for a ConfigurableJoint along the 6 axes. - The name of the parameter. - The id of the parameter. The id is generated using Animator::StringToHash. - + - Gets the list of AnimatorClipInfo currently played by the current state. + Motion along the axis will be completely free and completely unconstrained. - The layer's index. - + - Gets the current State information on a specified AnimatorController layer. + Motion along the axis will be limited by the respective limit. - The layer's index. - + - Gets the value of a float parameter. + Motion along the axis will be locked. - The name of the parameter. - The id of the parameter. The id is generated using Animator::StringToHash. - + - Gets the value of a float parameter. + The various test results the connection tester may return with. - The name of the parameter. - The id of the parameter. The id is generated using Animator::StringToHash. - + - Gets the value of an integer parameter. + Some unknown error occurred. - The name of the parameter. - The id of the parameter. The id is generated using Animator::StringToHash. - + - Gets the value of an integer parameter. + Port-restricted NAT type, can do NAT punchthrough to everyone except symmetric. - The name of the parameter. - The id of the parameter. The id is generated using Animator::StringToHash. - + - Gets the index of the layer with specified name. + Symmetric NAT type, cannot do NAT punchthrough to other symmetric types nor port restricted type. - The layer's name. - + - Gets name of the layer. + Address-restricted cone type, NAT punchthrough fully supported. - The layer's index. - + - Gets the layer's current weight. + Full cone type, NAT punchthrough fully supported. - The layer's index. - + - Gets the list of AnimatorClipInfo currently played by the next state. + Public IP address detected and game listen port is accessible to the internet. - The layer's index. - + - Gets the next State information on a specified AnimatorController layer. + Public IP address detected but server is not initialized and no port is listening. - The layer's index. - + - Read only access to the AnimatorControllerParameters used by the animator. + Public IP address detected but the port is not connectable from the internet. - The index of the parameter. - + - Returns true if the AnimatorState is present in the Animator's controller. + Test result undetermined, still in progress. - The layer's index. - The AnimatorState fullPathHash, nameHash or shortNameHash. - + - Is the specified AnimatorController layer in a transition. + A force applied constantly. - The layer's index. - + - Returns true if a parameter is controlled by an additional curve on an animation. + The force applied to the rigidbody every frame. - The name of the parameter. - The id of the parameter. The id is generated using Animator::StringToHash. - + - Returns true if a parameter is controlled by an additional curve on an animation. + The force - relative to the rigid bodies coordinate system - applied every frame. - The name of the parameter. - The id of the parameter. The id is generated using Animator::StringToHash. - + - Plays a state. + The torque - relative to the rigid bodies coordinate system - applied every frame. - The name of the state to play. - Layer index containing the destination state. If no layer is specified or layer is -1, the first state that is found with the given name or hash will be played. - Start time of the current destination state. Value is in normalized time. If no explicit normalizedTime is specified or value is float.NegativeInfinity, the state will either be played from the start if it's not already playing, or will continue playing from its current time. - The AnimatorState fullPathHash, nameHash or shortNameHash to play. Passing 0 will transition to self. - + - Plays a state. + The torque applied to the rigidbody every frame. - The name of the state to play. - Layer index containing the destination state. If no layer is specified or layer is -1, the first state that is found with the given name or hash will be played. - Start time of the current destination state. Value is in normalized time. If no explicit normalizedTime is specified or value is float.NegativeInfinity, the state will either be played from the start if it's not already playing, or will continue playing from its current time. - The AnimatorState fullPathHash, nameHash or shortNameHash to play. Passing 0 will transition to self. - + - Same as IAnimatorControllerPlayable.Play, but the offset in the target state is in fixed time. + Applies both linear and angular (torque) forces continuously to the rigidbody each physics update. - The name of the state to play. - Layer index containing the destination state. If no layer is specified or layer is -1, the first state that is found with the given name or hash will be played. - Start time of the current destination state. Value is in seconds. If no explicit fixedTime is specified or fixedTime value is float.NegativeInfinity, the state will either be played from the start if it's not already playing, or will continue playing from its current time. - The AnimatorState fullPathHash, nameHash or shortNameHash to play. Passing 0 will transition to self. - + - Same as IAnimatorControllerPlayable.Play, but the offset in the target state is in fixed time. + The linear force applied to the rigidbody each physics update. - The name of the state to play. - Layer index containing the destination state. If no layer is specified or layer is -1, the first state that is found with the given name or hash will be played. - Start time of the current destination state. Value is in seconds. If no explicit fixedTime is specified or fixedTime value is float.NegativeInfinity, the state will either be played from the start if it's not already playing, or will continue playing from its current time. - The AnimatorState fullPathHash, nameHash or shortNameHash to play. Passing 0 will transition to self. - + - Resets the trigger parameter to false. + The linear force, relative to the rigid-body coordinate system, applied each physics update. - The name of the parameter. - The id of the parameter. The id is generated using Animator::StringToHash. - + - Resets the trigger parameter to false. + The torque applied to the rigidbody each physics update. - The name of the parameter. - The id of the parameter. The id is generated using Animator::StringToHash. - + - See IAnimatorControllerPlayable.SetBool. + A set of parameters for filtering contact results. - The name of the parameter. - The new value for the parameter. - The id of the parameter. The id is generated using Animator::StringToHash. - + - See IAnimatorControllerPlayable.SetBool. + Given the current state of the contact filter, determine whether it would filter anything. - The name of the parameter. - The new value for the parameter. - The id of the parameter. The id is generated using Animator::StringToHash. - + - Sets the value of a float parameter. + Sets the contact filter to filter the results that only include Collider2D on the layers defined by the layer mask. - The name of the parameter. - The new value for the parameter. - The id of the parameter. The id is generated using Animator::StringToHash. - + - Sets the value of a float parameter. + Sets the contact filter to filter the results to only include Collider2D with a Z coordinate (depth) less than this value. - The name of the parameter. - The new value for the parameter. - The id of the parameter. The id is generated using Animator::StringToHash. - + - Sets the value of an integer parameter. + Sets the contact filter to filter the results to only include contacts with collision normal angles that are less than this angle. - The name of the parameter. - The new value for the parameter. - The id of the parameter. The id is generated using Animator::StringToHash. - + - Sets the value of an integer parameter. + Sets the contact filter to filter the results to only include Collider2D with a Z coordinate (depth) greater than this value. - The name of the parameter. - The new value for the parameter. - The id of the parameter. The id is generated using Animator::StringToHash. - + - Sets the layer's current weight. + Sets the contact filter to filter the results to only include contacts with collision normal angles that are greater than this angle. - The layer's index. - The weight of the layer. - + - Sets a trigger parameter to active. -A trigger parameter is a bool parameter that gets reset to false when it has been used in a transition. For state machines with multiple layers, the trigger will only get reset once all layers have been evaluated, so that the layers can synchronize their transitions on the same parameter. + Sets the contact filter to filter the results by depth using minDepth and maxDepth. - The name of the parameter. - The id of the parameter. The id is generated using Animator::StringToHash. - + - Sets a trigger parameter to active. -A trigger parameter is a bool parameter that gets reset to false when it has been used in a transition. For state machines with multiple layers, the trigger will only get reset once all layers have been evaluated, so that the layers can synchronize their transitions on the same parameter. + Sets the contact filter to filter results by layer mask. - The name of the parameter. - The id of the parameter. The id is generated using Animator::StringToHash. - + - Playables are customizable runtime objects that can be connected together in a tree to create complex behaviours. + Sets the contact filter to filter the results by the collision's normal angle using minNormalAngle and maxNormalAngle. - + - The count of inputs on the Playable. This count includes slots that aren't connected to anything. This is equivalent to, but much faster than calling GetInputs().Length. + Sets the contact filter to filter within the minDepth and maxDepth range, or outside that range. - + - The count of inputs on the Playable. This count includes slots that aren't connected to anything. This is equivalent to, but much faster than calling GetOutputs().Length. + Sets the contact filter to filter within the minNormalAngle and maxNormalAngle range, or outside that range. - + - Current Experimental.Director.PlayState of this playable. This indicates whether the Playable is currently playing or paused. + Sets to filter contact results based on trigger collider involvement. - + - Current local time for this Playable. + Turns off depth filtering by setting useDepth to false. The associated values of minDepth and maxDepth are not changed. - + - Safely disconnects all connected inputs and resizes the input array to 0. + Turns off layer mask filtering by setting useLayerMask to false. The associated value of layerMask is not changed. - + - Connects two Playables together. + Turns off normal angle filtering by setting useNormalAngle to false. The associated values of minNormalAngle and maxNormalAngle are not changed. - Playable to be used as input. - Playable on which the input will be connected. - Optional index of the output on the source Playable. - Optional index of the input on the target Playable. - - Returns false if the operation could not be completed. - - + - Disconnects an input from a Playable. + Checks if the Transform for obj is within the depth range to be filtered. - Playable from which the input will be disconnected. - Index of the input to disconnect. - + 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. + - + - Implements IDisposable. Call this method to release the resources allocated by the Playable. + 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. + - + - Returns the Playable connected at the specified index. + Checks if the angle of normal is within the normal angle range to be filtered. - Index of the input. + The normal used to calculate an angle. - 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 Playable::Disconnect. + Returns true when normal is excluded by the filter and false if otherwise. - + - Returns a lists of the input Playables. + Checks if the angle is within the normal angle range to be filtered. - List of Playables connected. This list can include nulls if Playables were disconnected from this Playable via Playable.Disconnect. + The angle used for comparison in the filter. + + Returns true when angle is excluded by the filter and false if otherwise. + - + - Get the weight of the Playable at a specified index. + Checks if the collider is a trigger and should be filtered by the useTriggers to be filtered. - Index of the Playable. + The Collider2D used to check for a trigger. - Weight of the input Playable. Returns -1 if there is no input connected at this input index. + Returns true when collider is excluded by the filter and false if otherwise. - + - Returns the Playable connected at the specified output index. + Sets the contact filter to not filter any ContactPoint2D. - Index of the output. - 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 Playable::Disconnect. + A copy of the contact filter set to not filter any ContactPoint2D. - + - Get the list of ouputs connected on this Playable. + Sets the minDepth and maxDepth filter properties and turns on depth filtering by setting useDepth to true. - List of output Playables. + The value used to set minDepth. + The value used to set maxDepth. - + - Callback called when the PlayState has changed + Sets the layerMask filter property using the layerMask parameter provided and also enables layer mask filtering by setting useLayerMask to true. - New PlayState + The value used to set the layerMask. - + - Callback called when the current time has changed + Sets the minNormalAngle and maxNormalAngle filter properties and turns on normal angle filtering by setting useNormalAngle to true. - New local time + The value used to set the minNormalAngle. + The value used to set the maxNormalAngle. - + - Prepares the Experimental.Director.Playable tree for the next frame. PrepareFrame is called before the tree is evaluated. + Describes a contact point where the collision occurs. - Data for the current frame. - + - Evaluates the Playable with a delta time. + Normal of the contact point. - The Experimental.Director.FrameData for the current frame. - Custom data passed down the tree, specified in DirectorPlayer.Play. - + - Set the weight of an input. + The other collider in contact at the point. - Index of the input. - Weight of the input. - - Returns false if there is no input Playable connected at that index. - - + - Status of a Playable. + The point of contact. - + - The Playable has been paused. Its local time will not advance. + The distance between the colliders at the contact point. - + - The Playable is currently Playing. + The first collider in contact at the point. - + - Manage and process HTTP response body data received from a remote server. + Details about a specific point of contact involved in a 2D physics collision. - + - Returns the raw bytes downloaded from the remote server, or null. (Read Only) + The incoming Collider2D involved in the collision with the otherCollider. - + - 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) + Indicates whether the collision response or reaction is enabled or disabled. - + - Convenience property. Returns the bytes from data interpreted as a UTF8 string. (Read Only) + Surface normal at the contact point. - + - Callback, invoked when all data has been received from the remote server. + Gets the impulse force applied at the contact point along the ContactPoint2D.normal. - + - Signals that this [DownloadHandler] is no longer being used, and should clean up any resources it is using. + The other Collider2D involved in the collision with the collider. - + - Callback, invoked when the data property is accessed. + The other Rigidbody2D involved in the collision with the rigidbody. - - Byte array to return as the value of the data property. - - + - Callback, invoked when UnityWebRequest.downloadProgress is accessed. + The point of contact between the two colliders in world space. - - The return value for UnityWebRequest.downloadProgress. - - + - Callback, invoked when the text property is accessed. + Gets the relative velocity of the two colliders at the contact point (Read Only). - - String to return as the return value of the text property. - - + - Callback, invoked with a Content-Length header is received. + The incoming Rigidbody2D involved in the collision with the otherRigidbody. - The value of the received Content-Length header. - + - Callback, invoked as data is received from the remote server. + Gets the distance between the colliders at the contact point. - 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. + Gets the impulse force applied at the contact point which is perpendicular to the ContactPoint2D.normal. - + - Returns the downloaded AssetBundle, or null. (Read Only) + The ContextMenu attribute allows you to add commands to the context menu. - + - Standard constructor for non-cached asset bundles. + Adds the function to the context menu of the component. - 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. + 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. - + - Simple versioned constructor. Caches downloaded asset bundles. + Adds the function to the context menu of the component. - 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. + 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. - + - Versioned constructor. Caches downloaded asset bundles. + Adds the function to the context menu of the component. - 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. + 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. - + - Returns the downloaded AssetBundle, or null. + Use this attribute to add a context menu to a field that calls a named method. - 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>. + The name of the function that should be called. - - Not implemented. - - + - Not implemented. Throws <a href="http:msdn.microsoft.comen-uslibrarysystem.notsupportedexception">NotSupportedException<a>. + The name of the context menu item. - - Not implemented. - - + - A general-purpose DownloadHandler implementation which stores received data in a native byte buffer. + 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. - + - Default constructor. + ControllerColliderHit is used by CharacterController.OnControllerColliderHit to give detailed information about the collision and how to deal with it. - + - Returns a copy of the native-memory buffer interpreted as a UTF8 string. + The collider that was hit by the controller. - 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. + The controller that hit the collider. - - A copy of the data which has been downloaded. - - + - Returns a copy of the native-memory buffer interpreted as a UTF8 string. + The game object that was hit by the controller. - - A string representing the data in the native-memory buffer. - - + - An abstract base class for user-created scripting-driven DownloadHandler implementations. + The direction the CharacterController was moving in when the collision occured. - + - Create a DownloadHandlerScript which allocates new buffers when passing data to callbacks. + How far the character has travelled until it hit the collider. - + - Create a DownloadHandlerScript which reuses a preallocated buffer to pass data to callbacks. + The normal of the surface we collided with in world space. - 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. + The impact point in world space. - + - Returns the downloaded Texture, or null. (Read Only) + The rigidbody that was hit by the controller. - + - Default constructor. + The transform that was hit by the controller. - + - Constructor, allows TextureImporter.isReadable property to be set. + 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. - Value to set for TextureImporter.isReadable. - + - Returns the downloaded Texture, or null. + Holds data for a single application crash event and provides access to all gathered crash reports. - 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. + Returns last crash report, or null if no reports are available. - - A copy of the downloaded data. - - + - An interface for composition of data into multipart forms. + Returns all currently available reports in a new array. - + - Returns the value to use in the Content-Type header for this form section. + Crash report data as formatted text. - - 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. + Time, when the crash occured. - - 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. + Remove report from available reports list. - - The raw binary data contained in this section. Must not be null or empty. - - + - Returns the name of this section, if any. + Remove all reports from available reports list. - - The section's name, or null. - - + - A helper object for form sections containing generic, non-file data. + Engine API for CrashReporting Service. - + - Returns the value to use in this section's Content-Type header. + This Boolean field will cause CrashReportHandler to capture exceptions when set to true. By default enable capture exceptions is true. - - The Content-Type header for this section, or null. - - + - Returns a string denoting the desired filename of this section on the destination server. + 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 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 default file name used by newly created instances of this type. - - The raw binary data contained in this section. Will not be null or empty. - - + - Returns the name of this section, if any. + The display name for this type shown in the Assets/Create menu. - - The section's name, or null. - - + - Raw data section, unnamed and no Content-Type header. + The position of the menu item within the Assets/Create menu. - Data payload of this section. - + - Raw data section with a section name, no Content-Type header. + Class for handling cube maps, Use this to create or modify existing. - Section name. - Data payload of this section. - + - A raw data section with a section name and a Content-Type header. + The format of the pixel data in the texture (Read Only). - 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. + How many mipmap levels are in this texture (Read Only). - 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. + Actually apply all previous SetPixel and SetPixels changes. - Section name. - String data payload for this section. - C. + When set to true, mipmap levels are recalculated. + When set to true, system memory copy of a texture is released. - + - A names raw data section whose payload is derived from a UTF8 string, with a default Content-Type. + Create a new empty cubemap texture. - Section name. - String data payload for this section. + Width/height of a cube face in pixels. + Pixel data format to be used for the Cubemap. + Should mipmaps be created? - + - An anonymous raw data section whose payload is derived from a UTF8 string, with a default Content-Type. + Returns pixel color at coordinates (face, x, y). - String data payload for this section. + + + - + - A helper object for adding file uploads to multipart forms via the [IMultipartFormSection] API. + Returns pixel colors of a cubemap face. + The face from which pixel data is taken. + Mipmap level for the chosen face. - + - Returns the value of the section's Content-Type header. + Sets pixel color at coordinates (face, x, y). - - The Content-Type header for this section, or null. - + + + + - + - Returns a string denoting the desired filename of this section on the destination server. + Sets pixel colors of a cubemap face. - - The desired file name of this section, or null if this is not a file section. - + Pixel data for the Cubemap face. + The face to which the new data should be applied. + The mipmap level for the face. - + - Returns the raw binary data contained in this section. Will not return null or a zero-length array. + Performs smoothing of near edge regions. - - The raw binary data contained in this section. Will not be null or empty. - + Pixel distance at edges over which to apply smoothing. - + - Returns the name of this section, if any. + Class for handling Cubemap arrays. - - 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. + Number of cubemaps in the array (Read Only). - 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. + Texture format (Read Only). - 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. + Actually apply all previous SetPixels changes. - Raw contents of the file to upload. - Name of the file uploaded by this form section. + When set to true, mipmap levels are recalculated. + When set to true, system memory copy of a texture is released. - + - 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. + Create a new cubemap array. - Name of this form section. - Contents of the file to upload. - A string encoding. - Name of the file uploaded by this form section. + 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. - + - 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. + Create a new cubemap array. - Contents of the file to upload. - A string encoding. - Name of the file uploaded by this form section. + 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. - + - An anonymous file section with data drawn from the UTF8 string data. Assigns a specific file name from fileName and a default Content-Type. + Returns pixel colors of a single array slice/face. - Contents of the file to upload. - Name of the file uploaded by this form section. + Cubemap face to read pixels from. + Array slice to read pixels from. + Mipmap level to read pixels from. + + Array of pixel colors. + - + - The UnityWebRequest object is used to communicate with web servers. + 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. + - + - Indicates whether the UnityWebRequest system should employ the HTTP/1.1 chunked-transfer encoding method. + 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. - + - If true, any DownloadHandler attached to this UnityWebRequest will have DownloadHandler.Dispose called automatically when UnityWebRequest.Dispose is called. + 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. - + - If true, any UploadHandler attached to this UnityWebRequest will have UploadHandler.Dispose called automatically when UnityWebRequest.Dispose is called. + Cubemap face. - + - Returns the number of bytes of body data the system has downloaded from the remote server. (Read Only) + Left facing side (-x). - + - Holds a reference to a DownloadHandler object, which manages body data received from the remote server by this UnityWebRequest. + Downward facing side (-y). - + - Returns a floating-point value between 0.0 and 1.0, indicating the progress of downloading body data from the server. (Read Only) + Backward facing side (-z). - + - A human-readable string describing any system errors encountered by this UnityWebRequest object while handling HTTP requests or responses. (Read Only) + Right facing side (+x). - + - Returns true after the UnityWebRequest has finished communicating with the remote server. (Read Only) + Upwards facing side (+y). - + - Returns true after this UnityWebRequest encounters a system error. (Read Only) + Forward facing side (+z). - + - Returns true while a UnityWebRequest’s configuration properties can be altered. (Read Only) + Cubemap face is unknown or unspecified. - + - The string "CREATE", commonly used as the verb for an HTTP CREATE request. + Describes a set of bounding spheres that should have their visibility and distances maintained. - + - The string "DELETE", commonly used as the verb for an HTTP DELETE request. + Pauses culling group execution. - + - The string "GET", commonly used as the verb for an HTTP GET request. + Sets the callback that will be called when a sphere's visibility and/or distance state has changed. - + - The string "HEAD", commonly used as the verb for an HTTP HEAD request. + Locks the CullingGroup to a specific camera. - + - The string "POST", commonly used as the verb for an HTTP POST request. + Create a CullingGroup. - + - The string "PUT", commonly used as the verb for an HTTP PUT request. + Clean up all memory used by the CullingGroup immediately. - + - Defines the HTTP verb used by this UnityWebRequest, such as GET or POST. + Erase a given bounding sphere by moving the final sphere on top of it. + The index of the entry to erase. - + - Indicates the number of redirects which this UnityWebRequest will follow before halting with a “Redirect Limit Exceeded” system error. + 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. - + - The numeric HTTP response code returned by the server, such as 200, 404 or 500. (Read Only) + Get the current distance band index of a given sphere. + The index of the sphere. + + The sphere's current distance band index. + - + - Returns the number of bytes of body data the system has uploaded to the remote server. (Read Only) + 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. + - + - Holds a reference to the UploadHandler object which manages body data to be uploaded to the remote server. + 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. + - + - Returns a floating-point value between 0.0 and 1.0, indicating the progress of uploading body data to the server. + 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. + - + - Defines the target URL for the UnityWebRequest to communicate with. + 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. + - + - Determines whether this UnityWebRequest will include Expect: 100-Continue in its outgoing request headers. (Default: true). + 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. - + - If in progress, halts the UnityWebRequest as soon as possible. + Sets the number of bounding spheres in the bounding spheres array that are actually being used. + The number of bounding spheres being used. - + - Creates a UnityWebRequest with the default options and no attached DownloadHandler or UploadHandler. Default method is GET. + Sets the array of bounding sphere definitions that the CullingGroup should compute culling for. - The target URL with which this UnityWebRequest will communicate. Also accessible via the url property. + The BoundingSpheres to cull. - + - Creates a UnityWebRequest with the default options and no attached DownloadHandler or UploadHandler. Default method is GET. + Set the reference point from which distance bands are measured. - The target URL with which this UnityWebRequest will communicate. Also accessible via the url property. + A fixed point to measure the distance from. + A transform to measure the distance from. The transform's position will be automatically tracked. - + - Creates a UnityWebRequest configured for HTTP DELETE. + Set the reference point from which distance bands are measured. - The URI to which a DELETE request should be sent. - - A UnityWebRequest configured to send an HTTP DELETE request. - + A fixed point to measure the distance from. + A transform to measure the distance from. The transform's position will be automatically tracked. - + - Signals that this [UnityWebRequest] is no longer being used, and should clean up any resources it is using. + 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. - + - Generate a random 40-byte array for use as a multipart form boundary. + Provides information about the current and previous states of one sphere in a CullingGroup. - - 40 random bytes, guaranteed to contain only printable ASCII values. - - + - Creates a UnityWebRequest configured for HTTP GET. + The current distance band index of the sphere, after the most recent culling pass. - The URI of the resource to retrieve via HTTP GET. - - A UnityWebRequest object configured to retrieve data from uri. - - + - Creates a UnityWebRequest optimized for downloading a Unity Asset Bundle via HTTP GET. + Did this sphere change from being visible to being invisible in the most recent culling pass? - 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 UnityWebRequest configured to downloading a Unity Asset Bundle. - - + - Creates a UnityWebRequest optimized for downloading a Unity Asset Bundle via HTTP GET. + Did this sphere change from being invisible to being visible in the most recent culling pass? - 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 UnityWebRequest configured to downloading a Unity Asset Bundle. - - + - Creates a UnityWebRequest optimized for downloading a Unity Asset Bundle via HTTP GET. + The index of the sphere that has changed. - 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 UnityWebRequest configured to downloading a Unity Asset Bundle. - - + - Retrieves the value of a custom request header. + Was the sphere considered visible by the most recent culling pass? - Name of the custom request header. Case-sensitive. - - 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 distance band index of the sphere before the most recent culling pass. - The name of the HTTP header to retrieve. Case-sensitive. - - 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. + Was the sphere visible before the most recent culling pass? - - A dictionary containing all the response headers received in the latest HTTP response. If no responses have been received, returns null. - - + - Create a UnityWebRequest intended to download an image via HTTP GET and create a Texture based on the retrieved data. + Cursor API for setting the cursor (mouse pointer). - 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. + Determines whether the hardware pointer is locked to the center of the view, constrained to the window, or not constrained at all. - 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. + Determines whether the hardware pointer is visible or not. - The URI to which to send a HTTP HEAD request. - - A UnityWebRequest configured to transmit a HTTP HEAD request. - - + - Create a UnityWebRequest configured to send form data to a server via HTTP POST. + Sets the mouse cursor to the given texture. - The target URI to which form data will be transmitted. - Form body data. Will be URLEncoded via WWWTranscoder.URLEncode 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. + Specify a custom cursor that you wish to use as a cursor. - 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. - + The texture to use for the cursor or null to set the default cursor. Note that a texture needs to be imported with "Read/Write enabled" in the texture importer (or using the "Cursor" defaults), in order to be used as a cursor. + 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. - + - Create a UnityWebRequest configured to send form data to a server via HTTP POST. + How the cursor should behave. - 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. + Confine cursor to the game window. - 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. + Lock cursor to the center of the game window. - 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. - - + - Create a UnityWebRequest configured to upload raw data to a remote server via HTTP PUT. + Cursor behavior is unmodified. - 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. - - + - Create a UnityWebRequest configured to upload raw data to a remote server via HTTP PUT. + Determines whether the mouse cursor is rendered using software rendering or, on supported platforms, hardware rendering. - 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. + Use hardware cursors on supported platforms. - - An AsyncOperation indicating the progress/completion state of the UnityWebRequest. Yield this object to wait until the UnityWebRequest is done. - - + - Converts a List of IMultipartFormSection objects into a byte array containing raw multipart form data. + Force the use of software cursors. - 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. + Specify the source of a Custom Render Texture initialization. - 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. + Custom Render Texture is initalized with a Material. - The key of the header to be set. Case-sensitive. - The header's intended value. - + - Helper object for UnityWebRequests. Manages the buffering and transmission of body data during HTTP requests. + Custom Render Texture is initialized by a Texture multiplied by a Color. - + - Determines the default Content-Type header which will be transmitted with the outbound HTTP request. + Frequency of update or initialization of a Custom Render Texture. - + - The raw data which will be transmitted to the remote server as body data. (Read Only) + Initialization/Update will only occur when triggered by the script. - + - Returns the proportion of data uploaded to the remote server compared to the total amount of data to upload. (Read Only) + Initialization/Update will occur once at load time and then can be triggered again by script. - + - Signals that this [UploadHandler] is no longer being used, and should clean up any resources it is using. + Initialization/Update will occur at every frame. - + - A general-purpose UploadHandler subclass, using a native-code memory buffer. + Space in which coordinates are provided for Update Zones. - + - General constructor. Contents of the input argument are copied into a native buffer. + Coordinates are normalized. (0, 0) is top left and (1, 1) is bottom right. - Raw data to transmit to the remote server. - + - Spectrum analysis windowing types. + Coordinates are expressed in pixels. (0, 0) is top left (width, height) is bottom right. - + - W[n] = 0.42 - (0.5 * COS(nN) ) + (0.08 * COS(2.0 * nN) ). + Base class for custom yield instructions to suspend coroutines. - + - W[n] = 0.35875 - (0.48829 * COS(1.0 * nN)) + (0.14128 * COS(2.0 * nN)) - (0.01168 * COS(3.0 * n/N)). + Indicates if coroutine should be kept suspended. - + - W[n] = 0.54 - (0.46 * COS(n/N) ). + Class containing methods to ease debugging while developing a game. - + - W[n] = 0.5 * (1.0 - COS(n/N) ). + Reports whether the development console is visible. The development console cannot be made to appear using: - + - W[n] = 1.0. + In the Build Settings dialog there is a check box called "Development Build". - + - W[n] = TRI(2n/N). + Get default debug logger. - + - Filtering mode for textures. Corresponds to the settings in a. + 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. - + - Bilinear filtering - texture samples are averaged. + 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. - + - Point filtering - texture pixels become blocky up close. + 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. - + - Trilinear filtering - texture samples are averaged and also blended between mipmap levels. + 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. - + - The Fixed joint groups together 2 rigidbodies, making them stick together in their bound position. + 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. - + - Connects two Rigidbody2D together at their anchor points using a configurable spring. + 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. - + - The amount by which the spring force is reduced in proportion to the movement speed. + Pauses the editor. - + - The frequency at which the spring oscillates around the distance between the objects. + Clears errors from the developer console. - + - The angle referenced between the two bodies used as the constraint for the joint. + 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? - + - A flare asset. Read more about flares in the. + 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? - + - FlareLayer component. + 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? - + - Used by GUIUtility.GetControlID to inform the UnityGUI system if a given control can get keyboard focus. + 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? - + - This is a proper keyboard control. It can have input focus on all platforms. Used for TextField and TextArea controls. + 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? - + - This control can get keyboard focus on Windows, but not on Mac. Used for buttons, checkboxes and other "pressable" things. + 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? - + - This control can never recieve keyboard focus. + 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? - + - Fog mode to use. + 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? - + - Exponential fog. + Logs message to the Unity Console. + String or object to be converted to string representation for display. + Object to which the message applies. - + - Exponential squared fog (default). + Logs message to the Unity Console. + String or object to be converted to string representation for display. + Object to which the message applies. - + - Linear fog. + 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. - + - Script interface for. + 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. - + - The ascent of the font. + Logs a formatted assertion message to the Unity console. + A composite format string. + Format arguments. + Object to which the message applies. - + - Access an array of all characters contained in the font texture. + Logs a formatted assertion message to the Unity console. + A composite format string. + Format arguments. + Object to which the message applies. - + - Is the font a dynamic font. + 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. - + - The default size of the font. + 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. - + - The line height of the font. + Logs a formatted error message to the Unity console. + A composite format string. + Format arguments. + Object to which the message applies. - + - The material used for the font display. + Logs a formatted error message to the Unity console. + A composite format string. + Format arguments. + Object to which the message applies. - + - Set a function to be called when the dynamic font texture is rebuilt. + A variant of Debug.Log that logs an error message to the console. - + Object to which the message applies. + Runtime Exception. - + - Creates a Font object which lets you render a font installed on the user machine. + A variant of Debug.Log that logs an error message to the console. - 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. - + Object to which the message applies. + Runtime Exception. - + - Creates a Font object which lets you render a font installed on the user machine. + Logs a formatted message to the Unity Console. - 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. - + A composite format string. + Format arguments. + Object to which the message applies. - + - Create a new Font. + Logs a formatted message to the Unity Console. - The name of the created Font object. + A composite format string. + Format arguments. + Object to which the message applies. - + - Create a new Font. + A variant of Debug.Log that logs a warning message to the console. - The name of the created Font object. + String or object to be converted to string representation for display. + Object to which the message applies. - + - Get rendering info for a specific character. + A variant of Debug.Log that logs a warning message to the console. - 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. + String or object to be converted to string representation for display. + Object to which the message applies. - + - Get rendering info for a specific character. + Logs a formatted warning message to the Unity Console. - 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. + A composite format string. + Format arguments. + Object to which the message applies. - + - Get rendering info for a specific character. + Logs a formatted warning message to the Unity Console. - 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. + A composite format string. + Format arguments. + Object to which the message applies. - + - Returns the maximum number of verts that the text generator may return for a given string. + Attribute used to make a float, int, or string variable in a script be delayed. - Input string. - + - Get names of fonts installed on the machine. + Attribute used to make a float, int, or string variable in a script be delayed. - - An array of the names of all fonts installed on the machine. - - + - Does this font have a specific character? + Depth texture generation mode for Camera. - 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). + Generate a depth texture. - 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. + Generate a depth + normals texture. - + - Bold style applied to your texts. + Specifies whether motion vectors should be rendered (if possible). - + - Bold and Italic styles applied to your texts. + Do not generate depth texture (Default). - + - Italic style applied to your texts. + Detail prototype used by the Terrain GameObject. - + - No special style is applied. + Bend factor of the detailPrototype. - + - Option for how to apply a force using Rigidbody.AddForce. + Color when the DetailPrototypes are "dry". - + - Add a continuous acceleration to the rigidbody, ignoring its mass. + Color when the DetailPrototypes are "healthy". - + - Add a continuous force to the rigidbody, using its mass. + Maximum height of the grass billboards (if render mode is GrassBillboard). - + - Add an instant force impulse to the rigidbody, using its mass. + Maximum width of the grass billboards (if render mode is GrassBillboard). - + - Add an instant velocity change to the rigidbody, ignoring its mass. + Minimum height of the grass billboards (if render mode is GrassBillboard). - + - Option for how to apply a force using Rigidbody2D.AddForce. + Minimum width of the grass billboards (if render mode is GrassBillboard). - + - Add a force to the Rigidbody2D, using its mass. + How spread out is the noise for the DetailPrototype. - + - Add an instant force impulse to the rigidbody2D, using its mass. + GameObject used by the DetailPrototype. - + - Applies both force and torque to reduce both the linear and angular velocities to zero. + Texture used by the DetailPrototype. - + - The maximum force that can be generated when trying to maintain the friction joint constraint. + Render mode for the DetailPrototype. - + - The maximum torque that can be generated when trying to maintain the friction joint constraint. + Render mode for detail prototypes. - + - Describes options for displaying movie playback controls. + The detail prototype will use the grass shader. - + - Do not display any controls, but cancel movie playback if input occurs. + The detail prototype will be rendered as billboards that are always facing the camera. - + - Display the standard controls for controlling movie playback. + Will show the prototype using diffuse shading. - + - Do not display any controls. + Describes physical orientation of the device as determined by the OS. - + - Display minimal set of controls controlling movie playback. + The device is held parallel to the ground with the screen facing downwards. - + - Describes scaling modes for displaying movies. + The device is held parallel to the ground with the screen facing upwards. - + - Scale the movie until the movie fills the entire screen. + The device is in landscape mode, with the device held upright and the home button on the right side. - + - Scale the movie until one dimension fits on the screen exactly. + The device is in landscape mode, with the device held upright and the home button on the left side. - + - Scale the movie until both dimensions fit the screen exactly. + The device is in portrait mode, with the device held upright and the home button at the bottom. - + - Do not scale the movie. + The device is in portrait mode but upside down, with the device held upright and the home button at the top. - + - Base class for all entities in Unity scenes. + The orientation of the device cannot be determined. - + - Is the GameObject active in the scene? + Enumeration for SystemInfo.deviceType, denotes a coarse grouping of kinds of devices. + +Windows Store Apps: tablets are treated as desktop machines, thus DeviceType.Handheld will only be returned for Windows Phones. - + - The local active state of this GameObject. (Read Only) + A stationary gaming console. - + - The Animation attached to this GameObject (Read Only). (null if there is none attached). + Desktop or laptop computer. - + - The AudioSource attached to this GameObject (Read Only). (null if there is none attached). + A handheld device like mobile phone or a tablet. - + - The Camera attached to this GameObject (Read Only). (null if there is none attached). + Device type is unknown. You should never see this in practice. - + - The Collider attached to this GameObject (Read Only). (null if there is none attached). + Class for handling the connection between Editor and Player. +This connection can be established by connecting the profiler to the player. - + - The Collider2D component attached to this object. + Returns true when Editor is connected to the player. When called in Editor, this function will always returns false. - + - The ConstantForce attached to this GameObject (Read Only). (null if there is none attached). + Send a file from the player to the editor and save it on disk. +You can specify either the absolute path or the relative path. When the path you specify is not absolute, it is relative to the project path. + File Path. + File contents. - + - The GUIText attached to this GameObject (Read Only). (null if there is none attached). + Prevents MonoBehaviour of same type (or subtype) to be added more than once to a GameObject. - + - The GUITexture attached to this GameObject (Read Only). (null if there is none attached). + Provides access to a display / screen for rendering operations. - + - The HingeJoint attached to this GameObject (Read Only). (null if there is none attached). + Gets the state of the display and returns true if the display is active and false if otherwise. - + - Editor only API that specifies if a game object is static. + Color RenderBuffer. - + - The layer the game object is in. A layer is in the range [0...31]. + Depth RenderBuffer. - + - The Light attached to this GameObject (Read Only). (null if there is none attached). + The list of currently connected Displays. Contains at least one (main) display. - + - The NetworkView attached to this GameObject (Read Only). (null if there is none attached). + Main Display. - + - The ParticleEmitter attached to this GameObject (Read Only). (null if there is none attached). + Vertical resolution that the display is rendering at. - + - The ParticleSystem attached to this GameObject (Read Only). (null if there is none attached). + Horizontal resolution that the display is rendering at. - + - The Renderer attached to this GameObject (Read Only). (null if there is none attached). + Vertical native display resolution. - + - The Rigidbody attached to this GameObject (Read Only). (null if there is none attached). + Horizontal native display resolution. - + - The Rigidbody2D component attached to this GameObject. (Read Only) + Activate an external display. Eg. Secondary Monitors connected to the System. - + - Scene that the GameObject is part of. + 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. - + - The tag of this game object. + Query relative mouse coordinates. + Mouse Input Position as Coordinates. - + - The Transform attached to this GameObject. (null if there is none attached). + 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). - + - Adds a component class named className to the game object. + Sets rendering resolution for the display. - + Rendering width in pixels. + Rendering height in pixels. - + - Adds a component class of type componentType to the game object. C# Users can use a generic version. + Joint that keeps two Rigidbody2D objects a fixed distance apart. - - + - Generic version. See the page for more details. + Should the distance be calculated automatically? - + - Calls the method named methodName on every MonoBehaviour in this game object or any of its children. + The distance separating the two ends of the joint. - - - - + - Calls the method named methodName on every MonoBehaviour in this game object or any of its children. + Whether to maintain a maximum distance only or not. If not then the absolute distance will be maintained instead. - - - - + - Calls the method named methodName on every MonoBehaviour in this game object or any of its children. + 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. - + - Is this game object tagged with tag ? + Clear the list of RectTransforms being driven. - The tag to compare. - + - Creates a game object with a primitive mesh renderer and appropriate collider. + An enumeration of transform properties that can be driven on a RectTransform by an object. - The type of primitive object to create. - + - Creates a new game object, named name. + Selects all driven properties. - - + - Creates a new game object. + Selects driven property RectTransform.anchoredPosition. - + - Creates a game object and attaches the specified components. + Selects driven property RectTransform.anchoredPosition3D. - - - + - Finds a game object by name and returns it. + Selects driven property RectTransform.anchoredPosition.x. - - + - Returns a list of active GameObjects tagged tag. Returns empty array if no GameObject was found. + Selects driven property RectTransform.anchoredPosition.y. - The name of the tag to search GameObjects for. - + - Returns one active GameObject tagged tag. Returns null if no GameObject was found. + Selects driven property RectTransform.anchoredPosition3D.z. - The tag to search for. - + - Returns the component of Type type if the game object has one attached, null if it doesn't. + Selects driven property combining AnchorMaxX and AnchorMaxY. - The type of Component to retrieve. - + - Generic version. See the page for more details. + Selects driven property RectTransform.anchorMax.x. - + - Returns the component with name type if the game object has one attached, null if it doesn't. + Selects driven property RectTransform.anchorMax.y. - The type of Component to retrieve. - + - Returns the component of Type type in the GameObject or any of its children using depth first search. + Selects driven property combining AnchorMinX and AnchorMinY. - The type of Component to retrieve. - - A component of the matching type, if found. - - + - Generic version. See the page for more details. + Selects driven property RectTransform.anchorMin.x. - - - A component of the matching type, if found. - - + - Returns the component of Type type in the GameObject or any of its parents. + Selects driven property RectTransform.anchorMin.y. - Type of component to find. - + - Returns the component of Type type in the GameObject or any of its parents. + Selects driven property combining AnchorMinX, AnchorMinY, AnchorMaxX and AnchorMaxY. - + - Returns all components of Type type in the GameObject. + Deselects all driven properties. - The type of Component to retrieve. - + - Generic version. See the page for more details. + Selects driven property combining PivotX and PivotY. - + - Returns all components of Type type in the GameObject or any of its children. + Selects driven property RectTransform.pivot.x. - 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. + Selects driven property RectTransform.pivot.y. - 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. + Selects driven property Transform.localRotation. - 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. + Selects driven property combining ScaleX, ScaleY && ScaleZ. - - A list of all found components matching the specified type. - - + - Returns all components of Type type in the GameObject or any of its parents. + Selects driven property Transform.localScale.x. - The type of Component to retrieve. - Should inactive Components be included in the found set? - + - Generic version. See the page for more details. + Selects driven property Transform.localScale.y. - Should inactive Components be included in the found set? - + - Generic version. See the page for more details. + Selects driven property Transform.localScale.z. - Should inactive Components be included in the found set? - + - Calls the method named methodName on every MonoBehaviour in this game object. + Selects driven property combining SizeDeltaX and SizeDeltaY. - 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. + Selects driven property RectTransform.sizeDelta.x. - 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. + Selects driven property RectTransform.sizeDelta.y. - 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? - + - + Allows to control the dynamic Global Illumination. - - - + - Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour. + Allows for scaling the contribution coming from realtime & static lightmaps. - 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. + When enabled, new dynamic Global Illumination output is shown in each frame. - 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. + Threshold for limiting updates of realtime GI. The unit of measurement is "percentage intensity change". - 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? - + - + 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. - + - Activates/Deactivates the GameObject. + Schedules an update of the environment texture. - Activate or deactivation the object. - + - Utility class for common geometric functions. + 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. - + - Calculates frustum planes. + 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. - + - Calculates frustum planes. + 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. - + - Returns true if bounds are inside the plane array. + Collider for 2D physics representing an arbitrary set of connected edges (lines) defined by its vertices. - - - + - Gizmos are used to give visual debugging or setup aids in the scene view. + Gets the number of edges. - + - Sets the color for the gizmos that will be drawn next. + Controls the radius of all edges created by the collider. - + - Set the gizmo matrix used to draw all gizmos. + Gets the number of points. - + - Draw a solid box with center and size. + Get or set the points defining multiple continuous edges. - - - + - Draw a camera frustum using the currently set Gizmos.matrix for it's location and rotation. + Reset to a single edge consisting of two points. - 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. + A base class for all 2D effectors. - 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 mask used to select specific layers allowed to interact with the effector. - 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. + Should the collider-mask be used or the global collision matrix? - 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 mode used to apply Effector2D forces. - 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. + The force is applied at a constant rate. - - - - + - Draw an icon at a position in the scene view. + The force is applied inverse-linear relative to a point. - - - - + - Draws a line starting at from towards to. + The force is applied inverse-squared relative to a point. - - - + - Draws a mesh. + Selects the source and/or target to be used by an Effector2D. - 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. + The source/target is defined by the Collider2D. - 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. + The source/target is defined by the Rigidbody2D. - - - - + - Draws a ray starting at from to from + direction. + Class used to allow GameObject.AddComponent / GameObject.GetComponent to be used. - - - - + - Draws a solid sphere with center and radius. + A UnityGUI event. - - - + - Draw a wireframe box with center and size. + Is Alt/Option key held down? (Read Only) - - - + - Draws a wireframe mesh. + Which mouse button was pressed. - 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. + Is Caps Lock on? (Read Only) - 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. + The character typed. - - - + - Low-level graphics library. + How many consecutive mouse clicks have we received. - + - Select whether to invert the backface culling (true) or not (false). + Is Command/Windows key held down? (Read Only) - + - The current modelview matrix. + The name of an ExecuteCommand or ValidateCommand Event. - + - Controls whether Linear-to-sRGB color conversion is performed while rendering. + Is Control key held down? (Read Only) - + - Should rendering be done in wireframe? + The current event that's being processed right now. - + - Begin drawing 3D primitives. + The relative movement of the mouse compared to last event. - Primitives to draw: can be TRIANGLES, TRIANGLE_STRIP, QUADS or LINES. - + - Clear the current render buffer. + Index of display that the event belongs to. - 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. + Is the current keypress a function key? (Read Only) - Should the depth buffer be cleared? - Camera to get projection parameters and skybox from. - + - Sets current vertex color. + Is this event a keyboard event? (Read Only) - - + - End drawing 3D primitives. + Is this event a mouse event? (Read Only) - + - Compute GPU projection matrix from camera's projection matrix. + The raw key code for keyboard events. - - - + - Invalidate the internally cached render state. + Which modifier keys are held down. - + - Send a user-defined event to a native code plugin. + The mouse position. - 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. + Is the current keypress on the numeric keyboard? (Read Only) - User defined id to send to the callback. - Native code callback to queue for Unity's renderer to invoke. - + - Mode for Begin: draw lines. + Is Shift held down? (Read Only) - + - Load the identity matrix to the current modelview matrix. + The type of event. - + - Helper function to set up an ortho perspective transform. + Returns the current number of events that are stored in the event queue. + + Current number of events currently in the event queue. + - + - Setup a matrix for pixel-correct rendering. + Get a filtered event type for a given control ID. + The ID of the control you are querying from. - + - Setup a matrix for pixel-correct rendering. + Create a keyboard event. - - - - + - + - Load an arbitrary matrix to the current projection matrix. + Get the next queued [Event] from the event system. - + Next Event. - + - Sets current texture coordinate (v.x,v.y,v.z) to the actual texture unit. + Use this event. - - - + - Sets current texture coordinate (x,y) for the actual texture unit. + Types of modifier key that can be active during a keystroke event. - - - - + - Sets current texture coordinate (x,y,z) to the actual texture unit. + Alt key. - - - - - + - Multiplies the current modelview matrix with the one specified. + Caps lock key. - - + - Restores both projection and modelview matrices off the top of the matrix stack. + Command key (Mac). - + - Saves both projection and modelview matrices to the matrix stack. + Control key. - + - Mode for Begin: draw quads. + Function key. - + - Resolves the render target for subsequent operations sampling from it. + No modifier key pressed during a keystroke event. - + - Sets current texture coordinate (v.x,v.y,v.z) for all texture units. + Num lock key. - - + - Sets current texture coordinate (x,y) for all texture units. + Shift key. - - - + - Sets current texture coordinate (x,y,z) for all texture units. + THe mode that a listener is operating in. - - - - + - Mode for Begin: draw triangle strip. + The listener will bind to one argument bool functions. - + - Mode for Begin: draw triangles. + The listener will use the function binding specified by the even. - + - Submit a vertex. + The listener will bind to one argument float functions. - - + - Submit a vertex. + The listener will bind to one argument int functions. - - - - + - Set the rendering viewport. + The listener will bind to one argument Object functions. - - + - Gradient used for animating colors. + The listener will bind to one argument string functions. - + - All alpha keys defined in the gradient. + The listener will bind to zero argument functions. - + - All color keys defined in the gradient. + Zero argument delegate used by UnityEvents. - + - Create a new Gradient object. + One argument delegate used by UnityEvents. + - + - Calculate color at a given time. + Two argument delegate used by UnityEvents. - Time of the key (0 - 1). + + - + - Setup Gradient with an array of color keys and alpha keys. + Three argument delegate used by UnityEvents. - Color keys of the gradient (maximum 8 color keys). - Alpha keys of the gradient (maximum 8 alpha keys). + + + - + - Alpha key used by Gradient. + Four argument delegate used by UnityEvents. + + + + - + - Alpha channel of key. + A zero argument persistent callback that can be saved with the scene. - + - Time of the key (0 - 1). + Add a non persistent listener to the UnityEvent. + Callback function. - + - Gradient alpha key. + Constructor. - Alpha of key (0 - 1). - Time of the key (0 - 1). - + - Color key used by Gradient. + Invoke all registered callbacks (runtime and persistent). - + - Color of key. + Remove a non persistent listener from the UnityEvent. + Callback function. - + - Time of the key (0 - 1). + One argument version of UnityEvent. - + - Gradient color key. + Two argument version of UnityEvent. - Color of key. - Time of the key (0 - 1). - - + - Raw interface to Unity's drawing functions. + Three argument version of UnityEvent. - + - Currently active color buffer (Read Only). + Four argument version of UnityEvent. - + - Currently active depth/stencil buffer (Read Only). + Abstract base class for UnityEvents. - + - Copies source texture into destination render texture with a shader. + Get the number of registered persistent listeners. - Source texture. - Destination RenderTexture, or null to blit directly to screen. - 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. - + - Copies source texture into destination render texture with a shader. + Get the target method name of the listener at index index. - Source texture. - Destination RenderTexture, or null to blit directly to screen. - 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. + Index of the listener to query. - + - Copies source texture into destination render texture with a shader. + Get the target component of the listener at index index. - Source texture. - Destination RenderTexture, or null to blit directly to screen. - 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. + Index of the listener to query. - + - Copies source texture into destination, for multi-tap shader. + Given an object, function name, and a list of argument types; find the method that matches. - 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. + Object to search for the method. + Function name to search for. + Argument types for the function. - + - Clear random write targets for Shader Model 5.0 level pixel shaders. + Remove all non-persisent (ie created from script) listeners from the event. - + - Draw a mesh. + Modify the execution state of a persistent listener. - 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. - Should the mesh cast shadows? - Should the mesh receive shadows? - - + Index of the listener to query. + State to set. - + - Draw a mesh. + Controls the scope of UnityEvent callbacks. - 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. - Should the mesh cast shadows? - Should the mesh receive shadows? - - - + - Draw a mesh. + Callback is always issued. - 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. - Should the mesh cast shadows? - Should the mesh receive shadows? - - - + - Draw a mesh. + Callback is not issued. - 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. - Should the mesh cast shadows? - Should the mesh receive shadows? - - - + - Draw a mesh. + Callback is only issued in the Runtime and Editor playmode. - 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. - Should the mesh cast shadows? - Should the mesh receive shadows? - - - + - Draw a mesh. + Types of UnityGUI input and processing events. - 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. - Should the mesh cast shadows? - Should the mesh receive shadows? - - - + - Draw a mesh. + User has right-clicked (or control-clicked on the mac). - 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. - Should the mesh cast shadows? - Should the mesh receive shadows? - - - + - Draw a mesh. + Editor only: drag & drop operation exited. - 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. - Should the mesh cast shadows? - Should the mesh receive shadows? - - - + - Draw a mesh immediately. + Editor only: drag & drop operation performed. - 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. + Editor only: drag & drop operation updated. - 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. + Execute a special command (eg. copy & paste). - 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. + Event should be ignored. - 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. + A keyboard key was pressed. - - - - + - Draws a fully procedural geometry on the GPU. + A keyboard key was released. - Topology of the procedural geometry. - Buffer with draw arguments. - Offset where in the buffer the draw arguments are. - + - Draw a texture in screen coordinates. + A layout event. - 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. - + - Draw a texture in screen coordinates. + Mouse button was pressed. - 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. - + - Draw a texture in screen coordinates. + Mouse was dragged. - 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. - + - Draw a texture in screen coordinates. + Mouse entered a window (Editor views only). - 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. - + - Execute a command buffer. + Mouse left a window (Editor views only). - The buffer to execute. - + - Set random write target for Shader Model 5.0 level pixel shaders. + Mouse was moved (Editor views only). - Index of the random write target in the shader. - RenderTexture/ComputeBuffer to set as write target. - + - Set random write target for Shader Model 5.0 level pixel shaders. + Mouse button was released. - Index of the random write target in the shader. - RenderTexture/ComputeBuffer to set as write target. - + - Sets current render target. + A repaint event. One is sent every frame. - - - - - - - - + - Sets current render target. + The scroll wheel was moved. - - - - - - - - + - Sets current render target. + Already processed event. - - - - - - - - + - Sets current render target. + Validates a special command (e.g. copy & paste). - - - - - - - - + - Sets current render target. + Makes all instances of a script execute in edit mode. - - - - - - - - + - Sets current render target. + Playable that plays an AnimationClip. Can be used as an input to an AnimationPlayable. - - - - - - - - + - Sets current render target. + Applies Humanoid FootIK solver. - - - - - - - - + - Sets current render target. + AnimationClip played by this Playable. - - - - - - - - + - The GUI class is the interface for Unity's GUI with manual positioning. + The speed at which the AnimationClip is played. - + - Global tinting color for all background elements rendered by the GUI. + Playable used to mix AnimationPlayables when used in Layers. - + - Returns true if any controls changed the value of the input data. + Playable used to mix AnimationPlayables. - + - Global tinting color for the GUI. + Base class for all animation related Playable classes. - + - Tinting color for all text rendered by the GUI. + Extends PlayableGraph for Animation. - + - The sorting depth of the currently executing GUI behaviour. + Creates an AnimationClipPlayable in the PlayableGraph. + The PlayableGraph object. + The AnimationClip that will be added in the graph. + + A PlayableHandle on the created Playable. + - + - Is the GUI enabled? + Creates an AnimationMixerPlayable in the PlayableGraph. + The number of inputs that the mixer will update. + Set to true if you want the system to force a weight normalization of the inputs. If true, the sum of all the inputs weights will always be 1.0. + The PlayableGraph object. + + A PlayableHandle on the created Playable. + - + - The GUI transform matrix. + Creates an AnimationPlayableOutput in the PlayableGraph. When the AnimationPlayableOutput.sourcePlayable is set, the Animator will be playing the Playable. + The name of output. + The target that will Play the AnimationPlayableOutput.sourcePlayable. + The PlayableGraph object. + + A PlayableHandle on the created Playable. + - + - The global skin to use. + Creates an AnimatorControllerPlayable in the PlayableGraph. + The RuntimeAnimatorController that will be added in the graph. + The PlayableGraph object. + + A PlayableHandle on the created Playable. + - + - The tooltip of the control the mouse is currently over, or which has keyboard focus. (Read Only). + Destroys the PlayableOutput. + The output that will be destroyed. + The PlayableGraph object. - + - Begin a group. Must be matched with a call to EndGroup. + Returns the AnimationPlayableOutput at the given index. - 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. + The index of the AnimationPlayableOutput. + - + - Begin a group. Must be matched with a call to EndGroup. + Gets the number of AnimationPlayableOutput in the PlayableGraph. - 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. + Animation output for the PlayableGraph. Defines how a Playable is connected to an Animator. - 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. + The Playable that is bound to the output. - 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. + The Animator component that is bound to this output. - 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. + Used to pass custom data to ScriptPlayable.ProcessFrame. - 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. + The blend weight of the sourcePlayable to the animator. - 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. + Returns true if the PlayableOutput has been properly constructed by the PlayableGraph and has not been destroyed. - 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. + Used to compare against AnimationPlayableOutput instances to check their validity. - 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. + Implements high-level utility methods to simplify use of the Playable API with Animations. - 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. + + + + 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. - The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. + A handle to the newly-created AnimatorControllerPlayable. - + - Begin a scrolling view inside your GUI. + Creates a PlayableGraph to be played on the given Animator. An AnimationClipPlayable is also created for the given AnimationClip. - 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. + Target Animator. + The AnimationClip to create an AnimationClipPlayable for. + The created PlayableGraph. - The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. + A handle to the newly-created AnimationClipPlayable. - + - Begin a scrolling view inside your GUI. + Creates a PlayableGraph to be played on the given Animator. An AnimationMixerPlayable is also created. - 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. + Target Animator. + The input count for the AnimationMixerPlayable. + The created PlayableGraph. - The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. + A handle to the newly-created AnimationMixerPlayable. - + - Make a graphical box. + Playable that plays a RuntimeAnimatorController. Can be used as an input to an AnimationPlayable. - 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. - + - Make a graphical box. + See IAnimatorControllerPlayable.layerCount. - 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. - + - Make a graphical box. + See IAnimatorControllerPlayable.parameterCount. - 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. - + - Make a graphical box. + See IAnimatorControllerPlayable.CrossFade. - 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. + + + + + - + - Make a graphical box. + See IAnimatorControllerPlayable.CrossFade. - 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. + + + + + - + - Make a graphical box. + See IAnimatorControllerPlayable.CrossFadeInFixedTime. - 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. + See IAnimatorControllerPlayable.CrossFadeInFixedTime. - The identifier used when you created the window in the Window call. + + + + + - + - Bring a specific window to front of the floating windows. + See IAnimatorControllerPlayable.GetAnimatorTransitionInfo. - 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. + See IAnimatorControllerPlayable.GetBool. - 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. + See IAnimatorControllerPlayable.GetBool. - 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. + See IAnimatorControllerPlayable.GetCurrentAnimatorClipInfo. - 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. + See IAnimatorControllerPlayable.GetCurrentAnimatorClipInfo. - 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. + See IAnimatorControllerPlayable.GetCurrentAnimatorClipInfoCount. - 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. + See IAnimatorControllerPlayable.GetCurrentAnimatorStateInfo. - 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. + See IAnimatorControllerPlayable.GetFloat. - 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. + See IAnimatorControllerPlayable.GetFloat. + + - + - Draw a texture within a rectangle. + See IAnimatorControllerPlayable.GetInteger. - 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. + See IAnimatorControllerPlayable.GetInteger. - 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. + See IAnimatorControllerPlayable.GetLayerIndex. - 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. + See IAnimatorControllerPlayable.GetLayerName. - 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 with the given texture coordinates. Use this function for clipping or tiling the image within the given rectangle. + See IAnimatorControllerPlayable.GetLayerWeight. - 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. Use this function for clipping or tiling the image within the given rectangle. + See IAnimatorControllerPlayable.GetNextAnimatorClipInfo. - 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. + See IAnimatorControllerPlayable.GetNextAnimatorClipInfo. + + - + - Ends a scrollview started with a call to BeginScrollView. + See IAnimatorControllerPlayable.GetNextAnimatorClipInfoCount. - + - + - Ends a scrollview started with a call to BeginScrollView. + See IAnimatorControllerPlayable.GetNextAnimatorStateInfo. - + - + - Move keyboard focus to a named control. + See AnimatorController.GetParameter. - Name set using SetNextControlName. + - + - Make a window become the active window. + See IAnimatorControllerPlayable.HasState. - The identifier used when you created the window in the Window call. + + - + - Get the name of named control that has focus. + See IAnimatorControllerPlayable.IsInTransition. + - + - Disposable helper class for managing BeginGroup / EndGroup. + See IAnimatorControllerPlayable.IsParameterControlledByCurve. + + - + - Create a new GroupScope and begin the corresponding group. + See IAnimatorControllerPlayable.IsParameterControlledByCurve. - 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. + See IAnimatorControllerPlayable.Play. - 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. + See IAnimatorControllerPlayable.Play. - 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. + See IAnimatorControllerPlayable.PlayInFixedTime. - 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. + See IAnimatorControllerPlayable.PlayInFixedTime. - 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. + See IAnimatorControllerPlayable.ResetTrigger. - 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. + See IAnimatorControllerPlayable.ResetTrigger. - 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. + See IAnimatorControllerPlayable.SetBool. - 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. + See IAnimatorControllerPlayable.SetBool. - 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. + See IAnimatorControllerPlayable.SetFloat. - 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. + See IAnimatorControllerPlayable.SetFloat. - 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. + See IAnimatorControllerPlayable.SetInteger. - 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. + See IAnimatorControllerPlayable.SetInteger. - 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. + See IAnimatorControllerPlayable.SetLayerWeight. - 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. + See IAnimatorControllerPlayable.SetTrigger. - 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. + See IAnimatorControllerPlayable.SetTrigger. - 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. + Extends PlayableGraph for Audio. - 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. + This structure contains the frame information a Playable receives in Playable.PrepareFrame. - 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. + Time difference between this frame and the preceding frame. - 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. + The accumulated speed of the Playable during the PlayableGraph traversal. - 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. + The accumulated weight of the Playable during the PlayableGraph traversal. - 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. + Indicates the type of evaluation that caused PlayableGraph.PrepareFrame to be called. - 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. + The current frame identifier. - 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. + Indicates that the local time was explicitly set. - 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. + The weight of the current Playable. - 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. + Describes the cause for the evaluation of a PlayableGraph. - 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. + Indicates the graph was updated due to a call to PlayableGraph.Evaluate. - 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. + Indicates the graph was called by the runtime during normal playback due to PlayableGraph.Play being called. - 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. + Interface for objects that can control an AnimatorController. - 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. + The AnimatorController layer count. - 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. + The number of AnimatorControllerParameters used by the AnimatorController. - 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. + Creates a dynamic transition between the current state and the destination state. - 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. - + The name of the destination state. + The duration of the transition. Value is in source state normalized time. + Layer index containing the destination state. If no layer is specified or layer is -1, the first state that is found with the given name or hash will be played. + Start time of the current destination state. Value is in source state normalized time, should be between 0 and 1. If no explicit normalizedTime is specified or normalizedTime value is float.NegativeInfinity, the state will either be played from the start if it's not already playing, or will continue playing from its current time and no transition will happen. + The AnimatorState fullPathHash, nameHash or shortNameHash to play. Passing 0 will transition to self. - + - Make a button that is active as long as the user holds it down. + Creates a dynamic transition between the current state and the destination state. - 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. - + The name of the destination state. + The duration of the transition. Value is in source state normalized time. + Layer index containing the destination state. If no layer is specified or layer is -1, the first state that is found with the given name or hash will be played. + Start time of the current destination state. Value is in source state normalized time, should be between 0 and 1. If no explicit normalizedTime is specified or normalizedTime value is float.NegativeInfinity, the state will either be played from the start if it's not already playing, or will continue playing from its current time and no transition will happen. + The AnimatorState fullPathHash, nameHash or shortNameHash to play. Passing 0 will transition to self. - + - Make a button that is active as long as the user holds it down. + Same as IAnimatorControllerPlayable.CrossFade, but the duration and offset in the target state are in fixed time. - 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. - + The name of the destination state. + The duration of the transition. Value is in seconds. + Layer index containing the destination state. If no layer is specified or layer is -1, the first state that is found with the given name or hash will be played. + Start time of the current destination state. Value is in seconds. If no explicit fixedTime is specified or fixedTime value is float.NegativeInfinity, the state will either be played from the start if it's not already playing, or will continue playing from its current time and no transition will happen. + The AnimatorState fullPathHash, nameHash or shortNameHash to play. Passing 0 will transition to self. - + - Make a button that is active as long as the user holds it down. + Same as IAnimatorControllerPlayable.CrossFade, but the duration and offset in the target state are in fixed time. - 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. - + The name of the destination state. + The duration of the transition. Value is in seconds. + Layer index containing the destination state. If no layer is specified or layer is -1, the first state that is found with the given name or hash will be played. + Start time of the current destination state. Value is in seconds. If no explicit fixedTime is specified or fixedTime value is float.NegativeInfinity, the state will either be played from the start if it's not already playing, or will continue playing from its current time and no transition will happen. + The AnimatorState fullPathHash, nameHash or shortNameHash to play. Passing 0 will transition to self. - + - Scrolls all enclosing scrollviews so they try to make position visible. + Gets the Transition information on a specified AnimatorController layer. - + The layer's index. - + - Disposable helper class for managing BeginScrollView / EndScrollView. + See IAnimatorControllerPlayable.GetBool. + The name of the parameter. + The id of the parameter. The id is generated using Animator::StringToHash. - + - Whether this ScrollView should handle scroll wheel events. (default: true). + See IAnimatorControllerPlayable.GetBool. + The name of the parameter. + The id of the parameter. The id is generated using Animator::StringToHash. - + - The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. + Gets the list of AnimatorClipInfo currently played by the current state. + The layer's index. - + - Create a new ScrollViewScope and begin the corresponding ScrollView. + Gets the list of AnimatorClipInfo currently played by the current state. - 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. + The layer's index. + Array to receive results. - + - Create a new ScrollViewScope and begin the corresponding ScrollView. + This function should be used when you want to use the allocation-free method IAnimatorControllerPlayable.GetCurrentAnimatorClipInfo. - 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. + Layer's Index. + + Returns the count of AnimatorClipInfo for the current state. + - + - Create a new ScrollViewScope and begin the corresponding ScrollView. + Gets the current State information on a specified AnimatorController layer. - 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. + The layer's index. - + - Create a new ScrollViewScope and begin the corresponding ScrollView. + Gets the value of a float parameter. - 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. + The name of the parameter. + The id of the parameter. The id is generated using Animator::StringToHash. - + - Make a grid of buttons. + Gets the value of a float parameter. - 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. - + The name of the parameter. + The id of the parameter. The id is generated using Animator::StringToHash. - + - Make a grid of buttons. + Gets the value of an integer parameter. - 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. - + The name of the parameter. + The id of the parameter. The id is generated using Animator::StringToHash. - + - Make a grid of buttons. + Gets the value of an integer parameter. - 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. - + The name of the parameter. + The id of the parameter. The id is generated using Animator::StringToHash. - + - Make a grid of buttons. + Gets the index of the layer with specified name. - 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 layer's name. - The index of the selected button. + The index of the layer. - + - Make a grid of buttons. + Gets name of the layer. - 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. - + The layer's index. - + - Make a grid of buttons. + Gets the layer's current weight. - 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. - + The layer's index. - + - Set the name of the next control. + Gets the list of AnimatorClipInfo currently played by the next state. - + The layer's index. - + - Make a Multi-line text area where the user can edit a string. + Gets the list of AnimatorClipInfo currently played by the next state. - 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. - + The layer's index. + Array to receive results. - + - Make a Multi-line text area where the user can edit a string. + This function should be used when you want to use the allocation-free method IAnimatorControllerPlayable.GetNextAnimatorClipInfo. - 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. + Layer's Index. - The edited string. + Returns the count of AnimatorClipInfo for the next state. - + - Make a Multi-line text area where the user can edit a string. + Gets the next State information on a specified AnimatorController layer. - 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. - + The layer's index. - + - Make a Multi-line text area where the user can edit a string. + Read only access to the AnimatorControllerParameters used by the animator. - 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. - + The index of the parameter. - + - Make a single-line text field where the user can edit a string. + Returns true if the AnimatorState is present in the Animator's controller. For a state named State in sub state machine SubStateMachine of state machine StateMachine, the shortNameHash can be generated using Animator.StringToHash("State"), and the fullPathHash can be generated using Animator.StringToHash("StateMachine.SubStateMachine.State"). Typically, the name of the top level state machine is the name of the Layer. - 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. - + The layer's index. + The AnimatorState fullPathHash or shortNameHash. - + - Make a single-line text field where the user can edit a string. + Is the specified AnimatorController layer in a transition. - 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. - + The layer's index. - + - Make a single-line text field where the user can edit a string. + Returns true if a parameter is controlled by an additional curve on an animation. - 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 name of the parameter. + The id of the parameter. The id is generated using Animator::StringToHash. + + + + Returns true if a parameter is controlled by an additional curve on an animation. + + The name of the parameter. + The id of the parameter. The id is generated using Animator::StringToHash. + + + + Plays a state. + + The name of the state to play. + Layer index containing the destination state. If no layer is specified or layer is -1, the first state that is found with the given name or hash will be played. + Start time of the current destination state. Value is in normalized time. If no explicit normalizedTime is specified or value is float.NegativeInfinity, the state will either be played from the start if it's not already playing, or will continue playing from its current time. + The AnimatorState fullPathHash, nameHash or shortNameHash to play. Passing 0 will transition to self. + + + + Plays a state. + + The name of the state to play. + Layer index containing the destination state. If no layer is specified or layer is -1, the first state that is found with the given name or hash will be played. + Start time of the current destination state. Value is in normalized time. If no explicit normalizedTime is specified or value is float.NegativeInfinity, the state will either be played from the start if it's not already playing, or will continue playing from its current time. + The AnimatorState fullPathHash, nameHash or shortNameHash to play. Passing 0 will transition to self. + + + + Same as IAnimatorControllerPlayable.Play, but the offset in the target state is in fixed time. + + The name of the state to play. + Layer index containing the destination state. If no layer is specified or layer is -1, the first state that is found with the given name or hash will be played. + Start time of the current destination state. Value is in seconds. If no explicit fixedTime is specified or fixedTime value is float.NegativeInfinity, the state will either be played from the start if it's not already playing, or will continue playing from its current time. + The AnimatorState fullPathHash, nameHash or shortNameHash to play. Passing 0 will transition to self. + + + + Same as IAnimatorControllerPlayable.Play, but the offset in the target state is in fixed time. + + The name of the state to play. + Layer index containing the destination state. If no layer is specified or layer is -1, the first state that is found with the given name or hash will be played. + Start time of the current destination state. Value is in seconds. If no explicit fixedTime is specified or fixedTime value is float.NegativeInfinity, the state will either be played from the start if it's not already playing, or will continue playing from its current time. + The AnimatorState fullPathHash, nameHash or shortNameHash to play. Passing 0 will transition to self. + + + + Resets the trigger parameter to false. + + The name of the parameter. + The id of the parameter. The id is generated using Animator::StringToHash. + + + + Resets the trigger parameter to false. + + The name of the parameter. + The id of the parameter. The id is generated using Animator::StringToHash. + + + + See IAnimatorControllerPlayable.SetBool. + + The name of the parameter. + The new value for the parameter. + The id of the parameter. The id is generated using Animator::StringToHash. + + + + See IAnimatorControllerPlayable.SetBool. + + The name of the parameter. + The new value for the parameter. + The id of the parameter. The id is generated using Animator::StringToHash. + + + + Sets the value of a float parameter. + + The name of the parameter. + The new value for the parameter. + The id of the parameter. The id is generated using Animator::StringToHash. + + + + Sets the value of a float parameter. + + The name of the parameter. + The new value for the parameter. + The id of the parameter. The id is generated using Animator::StringToHash. + + + + Sets the value of an integer parameter. + + The name of the parameter. + The new value for the parameter. + The id of the parameter. The id is generated using Animator::StringToHash. + + + + Sets the value of an integer parameter. + + The name of the parameter. + The new value for the parameter. + The id of the parameter. The id is generated using Animator::StringToHash. + + + + Sets the layer's current weight. + + The layer's index. + The weight of the layer. + + + + Sets a trigger parameter to active. +A trigger parameter is a bool parameter that gets reset to false when it has been used in a transition. For state machines with multiple layers, the trigger will only get reset once all layers have been evaluated, so that the layers can synchronize their transitions on the same parameter. + + The name of the parameter. + The id of the parameter. The id is generated using Animator::StringToHash. + + + + Sets a trigger parameter to active. +A trigger parameter is a bool parameter that gets reset to false when it has been used in a transition. For state machines with multiple layers, the trigger will only get reset once all layers have been evaluated, so that the layers can synchronize their transitions on the same parameter. + + The name of the parameter. + The id of the parameter. The id is generated using Animator::StringToHash. + + + + Playables are customizable runtime objects that can be connected together in a tree to create complex behaviours. + + + + + Returns the PlayableHandle for this playable. + + + + + Returns true if the Playable is valid. A playable can be invalid if it was disposed. This is different from a Null playable. + + + + + The PlayableGraph is used to manage PlayableHandle creation, destruction and connections. + + + + + Indicates that a graph has completed its operations. + + + + + Returns the number of PlayableHandle owned by the Graph. + + + + + Returns the number of PlayableHandle owned by the Graph that have no connected outputs. + + + + + Gets the number of ScriptPlayableOutput in the PlayableGraph. + + + + + Connects two Playable instances, either by referencing the Playable instances themselves or by their PlayableHandles. + + 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. - The edited string. + Returns true if connection is successful. - + - Make a single-line text field where the user can edit a string. + Connects two Playable instances, either by referencing the Playable instances themselves or by their PlayableHandles. - 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 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. - The edited string. + Returns true if connection is successful. - + - Make an on/off toggle button. + Creates a generic ScriptPlayable mixer. - 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 number of input. - The new value of the button. + The created Playable. - + - Make an on/off toggle button. + Creates a PlayableGraph. - 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. + The created graph. - + - Make an on/off toggle button. + This method allows you to create custom Playable instances. - 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. + The created Playable. - + - Make an on/off toggle button. + Creates a ScriptPlayableOutput in the [PlayableGraph]]. + + The name of the output. + + + + Creates a ScriptPlayable in the PlayableGraph. - 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. + A PlayableHandle on the created Playable. - + + + Destroys the graph. + + + + + Destroys the PlayableOutput. + + The output to destroy. + + + + Destroys the PlayableOutput. + + The output to destroy. + + + + Destroys the Playable associated with this PlayableHandle. + + The playable to destroy. + + + + Recursively destroys the given Playable and all children connected to its inputs. + + The playable to destroy. + + + + Disconnects PlayableHandle. The connections determine the topology of the PlayableGraph and how its is evaluated. + + The source playabe or its handle. + The port used in the source playable. + + + + Disconnects PlayableHandle. The connections determine the topology of the PlayableGraph and how its 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. + + + + Returns the PlayableHandle with no output connections at the given index. + + The index of the root PlayableHandle. + + + + Returns the ScriptPlayableOutput at the given index. + + The index of the ScriptPlayableOutput. + + + + Returns true if the PlayableGraph has been properly constructed using PlayableGraph.CreateGraph and is not deleted. + + + + + Plays the graph. + + + + + Stops the graph, if it is playing. + + + + + Handle representing a Playable created in a PlayableGraph. The PlayableHandle implements all general usage Playable methods. + + + + + The duration of the Playable in seconds. + + + + + The PlayableGraph that created the playable. + + + + + Gets and Sets the number of inputs for the Playable. + + + + + A flag indicating that a playable has completed its operation. + + + + + Gets and Sets the number of outputs for the Playable. + + + + + When playing, the time will advance in the Playable during evaluation of the graph. + + + + + Modulates how time is incremented when the Playable is playing. + + + + + The current time of the Playable. + + + + + Destroys the Playable associated with this PlayableHandle. + + + + + Returns the PlayableHandle connected at the given input port index. + + The port index. + + + + Returns the weight of the Playable connected at the given input port index. + + The port index. + + + + Returns a Playable representation of the handle. + + + The Playable represented by this handle. + + + + + Returns a Playable representation of the handle. + + + The Playable represented by this handle. + + + + + Returns the PlayableHandle connected at the given ouput port index. + + The port index. + + + + Returns true if the Playable is properly constructed by the PlayableGraph and has not been destroyed. + + + + + Used to compare PlayableHandles. + + + + + Sets the weight of the Playable connected at the given input port index. + + The port index. + The weight. Should be between 0 and 1. + + + + Status of a Playable. + + + + + The Playable has been paused. Its local time will not advance. + + + + + The Playable is currently Playing. + + + + + Base class for all user-defined playables. + + + + + Called when the Playable is destroyed. + + + + + Called when the PlayableGraph this Playable is owned by starts playing. + + + + + Called when the PlayableGraph this Playable is owned by is stopped. + + + + + Override this method to perform custom operations when the PlayState changes. + + The current frame information. + The new PlayState. + + + + Called during evaluation of the PlayableGraph. + + Information about the current frame. + + + + The ProcessFrame is the stage at which your Playable should do its work. + + Information about the current frame. + Data that is set on the playable output userData. + + + + Script output for the Graph. ScriptPlayable can be used to write custom Playable that implement their own PrepareFrame callback. + + + + + The Playable that is bound to the output. + + + + + Used to pass custom data to ScriptPlayable.ProcessFrame. + + + + + Returns true if the PlayableOutput is properly constructed by the PlayableGraph and has not been destroyed. + + + + + Used to compare ScriptPlayableOutput. + + + + + Parameters controlling culling process in CullResults. + + + + + Layer mask used for culling. + + + + + World to clip space matrix. + + + + + Number of culling planes to use. + + + + + True if camera is orthographic (this affects LOD culling). + + + + + LODGroup culling parameters. + + + + + Camera position. + + + + + Visible reflection probes sorting options. + + + + + Realtime shadows distance. + + + + + Get a culling plane. + + Plane index (up to cullingPlaneCount). + + Culling plane. + + + + + Get per-layer culling distance. + + Game object layer index (0 to 31). + + Distance beyond which objects in this layer are culled. + + + + + Set a culling plane. + + Plane index (up to cullingPlaneCount). + Culling plane. + + + + Set per-layer culling distance. + + Game object layer index (0 to 31). + Distance beyond which objects in this layer are culled. + + + + Culling results (visible objects, lights, reflection probes). + + + + + Array of visible lights. + + + + + Array of visible reflection probes. + + + + + 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. + Result culling parameters. + + Flag indicating whether culling parameters are valid. + + + + + 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. + + + + + Flags controlling RenderLoop.DrawRenderers. + + + + + When set, enables dynamic batching. + + + + + When set, enables GPU instancing. + + + + + No flags are set. + + + + + Settings for RenderLoop.DrawRenderers. + + + + + Culling results to use. + + + + + Other flags controlling object rendering. + + + + + Which subset of visible objects to render. + + + + + What kind of per-object data to setup during rendering. + + + + + Which shader pass to use. + + + + + How to sort objects during rendering. + + + + + Create a draw settings struct. + + Culling results to use. + Camera to use. Camera's transparency sort mode is used to determine whether to use orthographic or distance based sorting. + Shader pass to use. + + + + Describes how to sort objects during rendering. + + + + + Camera position, used to determine distances to objects. + + + + + What kind of sorting to do while rendering. + + + + + Should orthographic sorting be used? + + + + + Camera view matrix, used to determine distances to objects. + + + + + Settings for RenderLoop.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. + + + + Describes which subset of visible objects to render. + + + + + Only render objects in the given layer mask. + + + + + Render objects that have material render queue smaller or equal to this. + + + + + Render objects that have material render queue larger or equal to this. + + + + + Default input filter: render all objects. + + + + + Set to render only opaque objects. + + + + + Set to render only transparent objects. + + + + + 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. + + + + + LODGroup culling parameters. + + + + + Rendering view height in pixels. + + + + + Camera position. + + + + + Camera's field of view. + + + + + Indicates whether camera is orthographic. + + + + + Orhographic camera size. + + + + + 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 reflection probe data. + + + + + Setup per-object light indices. + + + + + An asset that produces a specific IRenderPipeline. + + + + + Create a IRenderPipeline specific to this asset. + + + Created pipeline. + + + + + Destroys all cached data and created IRenderLoop's. + + + + + Create a IRenderPipeline specific to this asset. + + + Created pipeline. + + + + + Defines state and drawing commands used in a custom render pipelines. + + + + + Draw subset of visible objects. + + Specifies which set of visible objects to draw, and how to draw them. + + + + 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. + + + + Execute a custom graphics command buffer. + + Command buffer to execute. + + + + Setup camera specific global shader variables. + + Camera to setup shader variables for. + + + + Submit rendering loop for execution. + + + + + 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. + + + + + Sort by material render queue. + + + + + Sort by renderer sorting layer. + + + + + 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. + + + + + 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. + + + + + 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. + + + + + 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. + + + + + Option for 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. + + + + + 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. + + + + + 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. + + + + + Is the GameObject 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. A layer is in the range [0...31]. + + + + + 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 ParticleEmitter 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? + + + + + + + + + + + Activates/Deactivates the GameObject. + + Activate or deactivation the object. + + + + Utility class for common geometric functions. + + + + + Calculates a bounding box given an array of positions and a transformation matrix. + + + + + + + Calculates frustum planes. + + + + + + Calculates frustum planes. + + + + + + Returns true if bounds are inside the plane array. + + + + + + + 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. + + + + + Set the gizmo matrix used to draw all 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. + + + + + + + + + Multiplies the current modelview matrix with 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. + + + + + Raw interface to Unity's drawing functions. + + + + + Currently active color buffer (Read Only). + + + + + 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. + Destination RenderTexture, or null to blit directly to screen. + 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. + + + + Copies source texture into destination render texture with a shader. + + Source texture. + Destination RenderTexture, or null to blit directly to screen. + 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. + + + + Copies source texture into destination render texture with a shader. + + Source texture. + Destination RenderTexture, or null to blit directly to screen. + 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. + + + + 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). + + + + 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). + + + + 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). + + + + Draw a mesh. + + The Mesh to draw. + Position of the mesh. + Rotation of the mesh. + Subset of the mesh to draw. + 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. + Should the mesh cast shadows? + Should the mesh 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. + + + + Draw a mesh. + + The Mesh to draw. + Position of the mesh. + Rotation of the mesh. + Subset of the mesh to draw. + 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. + Should the mesh cast shadows? + Should the mesh 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. + + + + Draw a mesh. + + The Mesh to draw. + Position of the mesh. + Rotation of the mesh. + Subset of the mesh to draw. + 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. + Should the mesh cast shadows? + Should the mesh 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. + + + + Draw a mesh. + + The Mesh to draw. + Position of the mesh. + Rotation of the mesh. + Subset of the mesh to draw. + 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. + Should the mesh cast shadows? + Should the mesh 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. + + + + Draw a mesh. + + The Mesh to draw. + Position of the mesh. + Rotation of the mesh. + Subset of the mesh to draw. + 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. + Should the mesh cast shadows? + Should the mesh 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. + + + + Draw a mesh. + + The Mesh to draw. + Position of the mesh. + Rotation of the mesh. + Subset of the mesh to draw. + 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. + Should the mesh cast shadows? + Should the mesh 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. + + + + Draw a mesh. + + The Mesh to draw. + Position of the mesh. + Rotation of the mesh. + Subset of the mesh to draw. + 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. + Should the mesh cast shadows? + Should the mesh 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. + + + + Draw a mesh. + + The Mesh to draw. + Position of the mesh. + Rotation of the mesh. + Subset of the mesh to draw. + 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. + Should the mesh cast shadows? + Should the mesh 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. + + + + Draw a mesh. + + The Mesh to draw. + Position of the mesh. + Rotation of the mesh. + Subset of the mesh to draw. + 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. + Should the mesh cast shadows? + Should the mesh 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. + + + + Draw a mesh. + + The Mesh to draw. + Position of the mesh. + Rotation of the mesh. + Subset of the mesh to draw. + 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. + Should the mesh cast shadows? + Should the mesh 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. + + + + Draw a mesh. + + The Mesh to draw. + Position of the mesh. + Rotation of the mesh. + Subset of the mesh to draw. + 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. + Should the mesh cast shadows? + Should the mesh 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. + + + + Draw a mesh. + + The Mesh to draw. + Position of the mesh. + Rotation of the mesh. + Subset of the mesh to draw. + 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. + Should the mesh cast shadows? + Should the mesh 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. + + + + 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 mesh cast shadows? + Should the mesh 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. + + + + 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 mesh cast shadows? + Should the mesh 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. + + + + 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. + Should the mesh cast shadows? + Should the mesh 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. + + + + 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. + + + + 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. + + + + 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. + + + + 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. + + + + 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. + + + + 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. + + + 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. + + + 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. + + + 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. + + + 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. + + + 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. + + + The index of the selected button. + + + + + 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. The user clicks them and something happens immediately. + + 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. The user clicks them and something happens immediately. + + 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. The user clicks them and something happens immediately. + + 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. The user clicks them and something happens immediately. + + 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. The user clicks them and something happens immediately. + + 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. The user clicks them and something happens immediately. + + 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. + + + 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. + + + 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. + + + 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. + + + 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. + + + 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. + + + 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 pasteboard. + + + + + 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. + + + + + + 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) + + + + + Construct the Hash128. + + + + + + + + + Convert the input string to Hash128. + + + + + + Convert Hash128 to string. + + + + + 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. + + + + + A combination of not shown in the hierarchy, not saved to to scenes and not unloaded by The object will not be 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 lower 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? + + + + + 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. + + + + + 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. + + + + + 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 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. + + + + 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. + + + + + + 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. Think auto fire. + + + + + + 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. + + + + + + Returns object representing status of a specific touch. (Does not allocate temporary variables). + + + + + + 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. + + + + + 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. + + + + + 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, first generation. + + + + + Yet unknown iPad. + + + + + iPhone, first generation. + + + + + 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 SE, first generation. + + + + + Yet unknown iPhone. + + + + + 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. + + + + + 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) + + + + + 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) + + + + + 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. + + + + + 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. + + + + + Position of the anchor relative to the connected Rigidbody. + + + + + A reference to another rigidbody this joint connects to. + + + + + 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. + + + + + Parent class for joints to connect Rigidbody2D objects. + + + + + 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 Parenthesis key '('. + + + + + Left shift key. + + + + + Left Windows key. + + + + + Less than '<' key. + + + + + 'm' key. + + + + + Menu key. + + + + + Minus '-' key. + + + + + First (primary) mouse button. + + + + + Second (secondary) mouse button. + + + + + Third mouse button. + + + + + Fourth mouse button. + + + + + Fifth mouse button. + + + + + Sixth mouse button. + + + + + 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. + + + + + Period '.' 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 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. + + + + + '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. + + + + + Describes the tangent when approaching this point from the previous point in the curve. + + + + + Describes the tangent when leaving this point towards the next point in the curve. + + + + + TangentMode is deprecated. Use AnimationUtility.SetKeyLeftTangentMode or AnimationUtility.SetKeyRightTangentMode instead. + + + + + The time of the keyframe. + + + + + The value of the curve at keyframe. + + + + + Create a keyframe. + + + + + + + Create a keyframe. + + + + + + + + + LayerMask allow you to display the LayerMask popup menu in the inspector. + + + + + 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. + + + + + + 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. + + + + + 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). + + + + + This property describes what part of a light's contribution can be baked. + + + + + The range of the light. + + + + + How to render the light. + + + + + Shadow mapping constant bias. + + + + + The custom resolution of the shadow map. + + + + + Near plane value to use for shadow frustums. + + + + + Shadow mapping normal-based bias. + + + + + 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. + + + + 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. + + + + 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. + + + + + Non-directional, Directional or Directional 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. + + + + + 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. + + + + + 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 way a Light Probe Proxy Volume refreshes in the Player. + + + - Make an on/off toggle button. + Automatically detects updates in Light Probes and triggers an update of the Light Probe volume. - 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. + Causes Unity to update the Light Probe Proxy Volume every frame. - 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. + Use this option to indicate that the Light Probe Proxy Volume is never to be automatically updated by Unity. - 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. - - - The index of the selected button. - - + - Make a toolbar. + The resolution mode for generating a grid of interpolated Light Probes. - 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. - - - The index of the selected button. - - + - Make a toolbar. + 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. - 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. - - - The index of the selected button. - - + - Make a toolbar. + The custom mode allows you to specify the 3D grid resolution. - 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. - - - The index of the selected button. - - + - Make a toolbar. + Triggers an update of the Light Probe Proxy Volume. - 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. - - - The index of the selected button. - - + - Make a toolbar. + Stores light probes for the scene. - 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. - - - The index of the selected button. - - + - Remove focus from all windows. + Coefficients of baked light probes. - + - Make a vertical scrollbar. Scrollbars are what you use to scroll through a document. Most likely, you want to use scrollViews instead. + The number of cells space is divided into (Read Only). - 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. + The number of light probes (Read Only). - 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. + Positions of the baked light probes (Read Only). - 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. + Returns an interpolated probe for the given position for both realtime and baked light probes combined. - 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. + How the Light is rendered. - 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. + Automatically choose the render mode. - 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. + Force the Light to be a pixel light. - 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. + Force the Light to be a vertex light. - 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. + Shadow casting options for a Light. - 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. + Cast "hard" shadows (with no shadow filtering). - 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). + Do not cast shadows (default). - - + - The contents of a GUI element. + Cast "soft" shadows (with 4x PCF filtering). - + - The icon image contained. + The type of a Light. - + - Shorthand for empty content. + The light is an area light. It affects only lightmaps and lightprobes. - + - The text contained. + The light is a directional light. - + - The tooltip of this element. + The light is a point light. - + - Constructor for GUIContent in all shapes and sizes. + The light is a spot light. - + - Build a GUIContent object containing only text. + Control the direction lines face, when using the LineRenderer or TrailRenderer. - - + - Build a GUIContent object containing only an image. + Lines face the direction of the Transform Component. - - + - Build a GUIContent object containing both text and an image. + Lines face the camera. - - - + - Build a GUIContent containing some text. When the user hovers the mouse over it, the global GUI.tooltip is set to the tooltip. + The line renderer is used to draw free-floating lines in 3D space. - - - + - Build a GUIContent containing an image. When the user hovers the mouse over it, the global GUI.tooltip is set to the tooltip. + Select whether the line will face the camera, or the orientation of the Transform Component. - - - + - 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. + Set the color gradient describing the color of the line at various points along its length. - - - - + - Build a GUIContent as a copy of another GUIContent. + Set the color at the end of the line. - - + - Base class for images & text strings displayed in a GUI. + Set the width at the end of the line. - + - Returns bounding rectangle of GUIElement in screen coordinates. + Connect the start and end positions of the line together to form a continuous loop. - - + - Returns bounding rectangle of GUIElement in screen coordinates. + Set this to a value greater than 0, to get rounded corners on each end of the line. - - + - Is a point on screen inside the element? + Set this to a value greater than 0, to get rounded corners between each segment of the line. - - - + - Is a point on screen inside the element? + Set the number of line segments. - - - + - Component added to a camera to make it render 2D GUI elements. + Set the number of line segments. - + - Get the GUI element at a specific screen position. + Set the color at the start of the line. - - + - The GUILayout class is the interface for Unity gui with automatic layout. + Set the width at the start of the line. - + - Disposable helper class for managing BeginArea / EndArea. + Choose whether the U coordinate of the line texture is tiled or stretched. - + - Create a new AreaScope and begin the corresponding Area. + If enabled, the lines are defined in world space. - 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. + Set the curve describing the width of the line at various points along its length. - 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. + Set an overall multiplier that is applied to the LineRenderer.widthCurve to get the final width of the line. - 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. + Get the position of a vertex in the line. - 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. - + The index of the position to retrieve. + + The position at the specified index in the array. + - + - Create a new AreaScope and begin the corresponding Area. + Get the positions of all vertices in the line. - 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. - + The array of positions to retrieve. The array passed should be of at least numPositions in size. + + How many positions were actually stored in the output array. + - + - Create a new AreaScope and begin the corresponding Area. + Set the line color at the start and at the end. - 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. + Set the position of a vertex in the line. - 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. - + Which position to set. + The new position. - + - Begin a GUILayout block of GUI controls in a fixed screen area. + Set the positions of all vertices in the line. - 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. - + The array of positions to set. - + - Begin a GUILayout block of GUI controls in a fixed screen area. + Set the number of line segments. - 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. + Set the line width at the start and at the end. - 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. + Choose how textures are applied to Lines and Trails. - 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. + Map the texture once along the entire length of the line, assuming all vertices are evenly spaced. - 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. + Repeat the texture along the line, repeating at a rate of once per line segment. To adjust the tiling rate, use Material.SetTextureScale. - 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. + Map the texture once along the entire length of the line. - 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. + Repeat the texture along the line, based on its length in world units. To set the tiling rate, use Material.SetTextureScale. - 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. + Structure describing device location. - 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. + Geographical device location altitude. - 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. + Horizontal accuracy of the location. - 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. + Geographical device location latitude. - 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. - + + + Geographical device location latitude. + + + + + Timestamp (in seconds since 1970) when location was last time updated. + + + - Begin a Horizontal control group. + Vertical accuracy of the location. - 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. + Interface into location functionality. - 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. + Specifies whether location service is enabled in user settings. - 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. + Last measured device geographical location. - 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. + Returns location service status. - 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. + Starts location service updates. Last location coordinates could be. - 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. + Starts location service updates. Last location coordinates could be. - 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. + Starts location service updates. Last location coordinates could be. - 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. + Stops location service updates. This could be useful for saving battery life. - 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. + Describes location service status. - 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. + Location service failed (user denied access to location service). - 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. + Location service is initializing, some time later it will switch to. - 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. + Location service is running and locations could be queried. - 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. + Location service is stopped. - 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. + Structure for building a LOD for passing to the SetLODs function. - 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. + Width of the cross-fade transition zone (proportion to the current LOD's whole length) [0-1]. Only used if it's not animated. - 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. + List of renderers for this LOD level. - 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. + The screen relative height to use for the transition [0-1]. - 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. + Construct a LOD. - 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. + The screen relative height to use for the transition [0-1]. + An array of renderers to use for this LOD level. - + - Make a single press button. The user clicks them and something happens immediately. + 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. - 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. The user clicks them and something happens immediately. + 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. - 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. The user clicks them and something happens immediately. + Indicates the LOD fading is turned 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. - - true when the users clicks the button. - - + - Make a single press button. The user clicks them and something happens immediately. + 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. - 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. The user clicks them and something happens immediately. + LODGroup lets you group multiple Renderers into LOD levels. - 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. The user clicks them and something happens immediately. + Specify if the cross-fading should be animated by time. The animation duration is specified globally as crossFadeAnimationDuration. - 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. + The cross-fading animation duration in seconds. ArgumentException will be thrown if it is set to zero or a negative value. - + - Close a group started with BeginHorizontal. + Enable / Disable the LODGroup - Disabling will turn off all renderers. - + - End a scroll view begun with a call to BeginScrollView. + The LOD fade mode used. - + - Close a group started with BeginVertical. + The local reference point against which the LOD distance is calculated. - + - Option passed to a control to allow or disallow vertical expansion. + The number of LOD levels. - - + - Option passed to a control to allow or disallow horizontal expansion. + The size of the LOD object in local space. - - + - Insert a flexible space element. + + The LOD level to use. Passing index < 0 will return to standard LOD processing. - + - Option passed to a control to give it an absolute height. + Returns the array of LODs. - + + The LOD array. + - + - Disposable helper class for managing BeginHorizontal / EndHorizontal. + Recalculate the bounding region for the LODGroup (Relatively slow, do not call often). - + - Create a new HorizontalScope and begin the corresponding horizontal group. + Set the LODs for the LOD group. This will remove any existing LODs configured on the LODGroup. - 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. + The LODs to use for this group. - + - Create a new HorizontalScope and begin the corresponding horizontal group. + Initializes a new instance of the Logger. - 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. + To selective enable debug log message. - 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. + To runtime toggle debug logging [ON/OFF]. - 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. + Set Logger.ILogHandler. - 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. + Create a custom Logger. - 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. - + Pass in default log handler or custom log handler. - + - Make a horizontal scrollbar. + Check logging is enabled based on the LogType. - 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 type of the log message. - The modified value. This can be changed by the user by dragging the scrollbar, or clicking the arrows at the end. + Retrun true in case logs of LogType will be logged otherwise returns false. - + - A horizontal slider the user can drag to change a value between a min and a max. + Logs message to the Unity Console using default logger. - 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. - + 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 horizontal slider the user can drag to change a value between a min and a max. + Logs message to the Unity Console using default logger. - 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. - + 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. - + - Make an auto-layout label. + Logs message to the Unity Console using default logger. - 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. + 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. - + - Make an auto-layout label. + Logs message to the Unity Console using default logger. - 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. + 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. - + - Make an auto-layout label. + Logs message to the Unity Console using default logger. - 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. + 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. - + - Make an auto-layout label. + Logs message to the Unity Console using default logger. - 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. + 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. - + - Make an auto-layout label. + Logs message to the Unity Console using default logger. - 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. + 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. - + - Make an auto-layout label. + A variant of Logger.Log that logs an error message. - 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. + 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. - + - Option passed to a control to specify a maximum height. + 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. - + - Option passed to a control to specify a maximum width. + A variant of Logger.Log that logs an exception message. - + Runtime Exception. + Object to which the message applies. - + - Option passed to a control to specify a minimum height. + A variant of Logger.Log that logs an exception message. - + Runtime Exception. + Object to which the message applies. - + - Option passed to a control to specify a minimum width. - + Logs a formatted message. - + The type of the log message. + Object to which the message applies. + A composite format string. + Format arguments. - + - Make a text field where the user can enter a password. + Logs a formatted message. - 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. - + The type of the log message. + Object to which the message applies. + A composite format string. + Format arguments. - + - Make a text field where the user can enter a password. + A variant of Logger.Log that logs an warning message. - 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. - + 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. - + - Make a text field where the user can enter a password. + A variant of Logger.Log that logs an warning message. - 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. - + 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. - + - Make a text field where the user can enter a password. + The type of the log message in Debug.logger.Log or delegate registered with Application.RegisterLogCallback. - 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. + LogType used for Asserts. (These could also indicate an error inside Unity itself.) - 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. + LogType used for Errors. - 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. + LogType used for Exceptions. - 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. + LogType used for regular log messages. - 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. + LogType used for Warnings. - 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. + The Master Server is used to make matchmaking between servers and clients easy. - 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. + Report this machine as a dedicated server. - + - Whether this ScrollView should handle scroll wheel events. (default: true). + The IP address of the master server. - + - The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. + The connection port of the master server. - + - Create a new ScrollViewScope and begin the corresponding ScrollView. + Set the minimum update rate for master server host information update. - 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. + Clear the host list which was received by MasterServer.PollHostList. - 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. + Check for the latest host list received by using MasterServer.RequestHostList. - 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. + Register this server on the master server. - 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. + Register this server on the master server. - 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. + Request a host list from the master server. - 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. + Unregister this server from the master server. - 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. + Describes status messages from the master server as returned in MonoBehaviour.OnMasterServerEvent|OnMasterServerEvent. - 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. + Received a host list from the master server. - 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. + Registration failed because an empty game name was given. - 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. + Registration failed because an empty game type was given. - 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. + Registration failed because no server is running. - 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. + Registration to master server succeeded, received confirmation. - - + - Make a multi-line text field where the user can edit a string. + To specify position and rotation weight mask for Animator::MatchTarget. - 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. + Position XYZ weight. - 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. + Rotation weight. - 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. + MatchTargetWeightMask contructor. - 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. - + Position XYZ weight. + Rotation weight. - + - Make a single-line text field where the user can edit a string. + The material class. - 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. + The main material's color. - 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. + Gets and sets whether GPU instancing is enabled for this material. - 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. - + Defines how the material should interact with lightmaps and lightprobes. + - + - Make an on/off toggle button. + The material's texture. - 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. + The texture offset of the main texture. - 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. + The texture scale of the main texture. - 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. + How many passes are in this material (Read Only). - 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. + Render queue of this material. - 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. + The shader used by the material. - 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. + Additional shader keywords set by this material. - 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. - - - The index of the selected button. - - + - Make a toolbar. + Copy properties from other material into this material. - 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. - - - 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. - - - The index of the selected button. - + - + - Make a toolbar. + Create a temporary Material. - 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. - - - The index of the selected button. - + Create a material with a given Shader. + Create a material by copying all properties from another material. - + - Make a toolbar. + Create a temporary Material. - 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. - - - The index of the selected button. - + Create a material with a given Shader. + Create a material by copying all properties from another material. - + - Make a toolbar. + Unset a shader keyword. - 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. - - - The index of the selected button. - + - + - Disposable helper class for managing BeginVertical / EndVertical. + Sets a shader keyword that is enabled by this material. + - + - Create a new VerticalScope and begin the corresponding vertical group. + Returns the index of the pass passName. - 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. + Get a named color value. - 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. + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. - + - Create a new VerticalScope and begin the corresponding vertical group. + Get a named color value. - 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. + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. - + - Create a new VerticalScope and begin the corresponding vertical group. + Get a named color array. - 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. + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. - + - Create a new VerticalScope and begin the corresponding vertical group. + Get a named color array. - 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. + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. - + - Make a vertical scrollbar. + Fetch a named color array into a list. - 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. - + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The list to hold the returned array. - + - Make a vertical scrollbar. + Fetch a named color array into a list. - 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. - + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The list to hold the returned array. - + - A vertical slider the user can drag to change a value between a min and a max. + Get a named float value. - 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. - + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. - + - A vertical slider the user can drag to change a value between a min and a max. + Get a named float value. - 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. - + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. - + - Option passed to a control to give it an absolute width. + Get a named float array. - + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. - + - Make a popup window that layouts its contents automatically. + Get a named float array. - 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. - + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. - + - Make a popup window that layouts its contents automatically. + Fetch a named float array into a list. - 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. - + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The list to hold the returned array. - + - Make a popup window that layouts its contents automatically. + Fetch a named float array into a list. - 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. - + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. + The list to hold the returned array. - + - Make a popup window that layouts its contents automatically. + Get a named integer value. - 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. - + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. - + - Make a popup window that layouts its contents automatically. + Get a named integer value. - 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. - + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. - + - Make a popup window that layouts its contents automatically. + Get a named matrix value from the shader. - 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. - + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. - + - 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. + Get a named matrix value from the shader. + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. - + - Utility functions for implementing and extending the GUILayout class. + Get a named matrix array. + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. - + - Reserve layout space for a rectangle with a specific aspect ratio. + Get a named matrix array. - 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. - + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. - + - Reserve layout space for a rectangle with a specific aspect ratio. + Fetch a named matrix array into a list. - 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. - + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The list to hold the returned array. - + - Reserve layout space for a rectangle with a specific aspect ratio. + Fetch a named matrix array into a list. - 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. - + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The list to hold the returned array. - + - Reserve layout space for a rectangle with a specific aspect ratio. + Returns the name of the shader pass at index pass. - 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. + Checks whether a given Shader pass is enabled on this Material. + Shader pass name (case insensitive). - The last used rectangle. + True if the Shader pass is enabled. - + - Reserve layout space for a rectangle for displaying some contents with a specific style. + Get the value of material's shader tag. - 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. + Get the value of material's shader tag. - 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. + Get a named texture. - 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. - + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. - + - Reserve layout space for a rectangle with a fixed content area. + Get a named texture. - 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. - + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. - + - Reserve layout space for a rectangle with a fixed content area. + Gets the placement offset of texture propertyName. - 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. - + The name of the property. - + - Reserve layout space for a rectangle with a fixed content area. + Gets the placement scale of texture propertyName. - 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. - + The name of the property. - + - Reserve layout space for a flexible rect. + Get a named vector value. - 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. - + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. - + - Reserve layout space for a flexible rect. + Get a named vector value. - 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. - + The name ID of the property retrieved by Shader.PropertyToID. + The name of the property. - + - Reserve layout space for a flexible rect. + Get a named vector array. - 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. - + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. - + - Reserve layout space for a flexible rect. + Get a named vector array. - 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. - + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. - + - General settings for how the GUI behaves. + 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. - + - The color of the cursor in text fields. + 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. - + - The speed of text field cursor flashes. + Checks if material's shader has a property of a given name. + + - + - Should double-clicking select words in text fields. + Checks if material's shader has a property of a given name. + + - + - The color of the selection rect in text fields. + Is the shader keyword enabled on this material? + - + - Should triple-clicking select whole text in text fields. + Interpolate properties between two materials. + + + - + - Defines how GUI looks and behaves. + Sets a named ComputeBuffer value. + Property name ID, use Shader.PropertyToID to get it. + Property name. + The ComputeBuffer value to set. - + - Style used by default for GUI.Box controls. + Sets a named ComputeBuffer value. + Property name ID, use Shader.PropertyToID to get it. + Property name. + The ComputeBuffer value to set. - + - Style used by default for GUI.Button controls. + Sets a named color value. + Property name ID, use Shader.PropertyToID to get it. + Property name, e.g. "_Color". + Color value to set. - + - Array of GUI styles for specific needs. + Sets a named color value. + Property name ID, use Shader.PropertyToID to get it. + Property name, e.g. "_Color". + Color value to set. - + - The default font to use for all styles. + Sets a color array property. + Property name. + Property name ID, use Shader.PropertyToID to get it. + Array of values to set. - + - Style used by default for the background part of GUI.HorizontalScrollbar controls. + Sets a color array property. + Property name. + Property name ID, use Shader.PropertyToID to get it. + Array of values to set. - + - Style used by default for the left button on GUI.HorizontalScrollbar controls. + Sets a color array property. + Property name. + Property name ID, use Shader.PropertyToID to get it. + Array of values to set. - + - Style used by default for the right button on GUI.HorizontalScrollbar controls. + Sets a color array property. + Property name. + Property name ID, use Shader.PropertyToID to get it. + Array of values to set. - + - Style used by default for the thumb that is dragged in GUI.HorizontalScrollbar controls. + Sets a named float value. + Property name ID, use Shader.PropertyToID to get it. + Float value to set. + Property name, e.g. "_Glossiness". - + - Style used by default for the background part of GUI.HorizontalSlider controls. + Sets a named float value. + Property name ID, use Shader.PropertyToID to get it. + Float value to set. + Property name, e.g. "_Glossiness". - + - Style used by default for the thumb that is dragged in GUI.HorizontalSlider controls. + Sets a float array property. + Property name. + Property name ID. Use Shader.PropertyToID to get this ID. + Array of values to set. - + - Style used by default for GUI.Label controls. + Sets a float array property. + Property name. + Property name ID. Use Shader.PropertyToID to get this ID. + Array of values to set. - + - Style used by default for the background of ScrollView controls (see GUI.BeginScrollView). + Sets a float array property. + Property name. + Property name ID. Use Shader.PropertyToID to get this ID. + Array of values to set. - + - Generic settings for how controls should behave with this skin. + Sets a float array property. + Property name. + Property name ID. Use Shader.PropertyToID to get this ID. + Array of values to set. - + - Style used by default for GUI.TextArea controls. + Sets a named integer value. + Property name ID, use Shader.PropertyToID to get it. + Integer value to set. + Property name, e.g. "_SrcBlend". - + - Style used by default for GUI.TextField controls. + Sets a named integer value. + Property name ID, use Shader.PropertyToID to get it. + Integer value to set. + Property name, e.g. "_SrcBlend". - + - Style used by default for GUI.Toggle controls. + 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. - + - Style used by default for the background part of GUI.VerticalScrollbar controls. + 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. - + - Style used by default for the down button on GUI.VerticalScrollbar controls. + Sets a matrix array property. + Property name. + Array of values to set. + Property name ID, use Shader.PropertyToID to get it. - + - Style used by default for the thumb that is dragged in GUI.VerticalScrollbar controls. + Sets a matrix array property. + Property name. + Array of values to set. + Property name ID, use Shader.PropertyToID to get it. - + - Style used by default for the up button on GUI.VerticalScrollbar controls. + Sets a matrix array property. + Property name. + Array of values to set. + Property name ID, use Shader.PropertyToID to get it. - + - Style used by default for the background part of GUI.VerticalSlider controls. + Sets a matrix array property. + Property name. + Array of values to set. + Property name ID, use Shader.PropertyToID to get it. - + - Style used by default for the thumb that is dragged in GUI.VerticalSlider controls. + 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. - + - Style used by default for Window controls (SA GUI.Window). + Activate the given pass for rendering. + Shader pass number to setup. + + If false is returned, no rendering should be done. + - + - Try to search for a GUIStyle. This functions returns NULL and does not give an error. + 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. - + - Get a named GUIStyle. + Sets a named texture. - + Property name ID, use Shader.PropertyToID to get it. + Property name, e.g. "_MainTex". + Texture to set. - + - Styling information for GUI elements. + Sets a named texture. + Property name ID, use Shader.PropertyToID to get it. + Property name, e.g. "_MainTex". + Texture to set. - + - Rendering settings for when the control is pressed down. + Sets the placement offset of texture propertyName. + Property name ID, use Shader.PropertyToID to get it. + Property name, for example: "_MainTex". + Texture placement offset. - + - Text alignment. + Sets the placement offset of texture propertyName. + Property name ID, use Shader.PropertyToID to get it. + Property name, for example: "_MainTex". + Texture placement offset. - + - The borders of all background images. + Sets the placement scale of texture propertyName. + Property name ID, use Shader.PropertyToID to get it. + Property name, e.g. "_MainTex". + Texture placement scale. - + - What to do when the contents to be rendered is too large to fit within the area given. + Sets the placement scale of texture propertyName. + Property name ID, use Shader.PropertyToID to get it. + Property name, e.g. "_MainTex". + Texture placement scale. - + - Pixel offset to apply to the content of this GUIstyle. + Sets a named vector value. + Property name ID, use Shader.PropertyToID to get it. + Property name, e.g. "_WaveAndDistance". + Vector value to set. - + - If non-0, any GUI elements rendered with this style will have the height specified here. + Sets a named vector value. + Property name ID, use Shader.PropertyToID to get it. + Property name, e.g. "_WaveAndDistance". + Vector value to set. - + - If non-0, any GUI elements rendered with this style will have the width specified here. + Sets a vector array property. + Property name. + Array of values to set. + Property name ID, use Shader.PropertyToID to get it. - + - Rendering settings for when the element has keyboard focus. + Sets a vector array property. + Property name. + Array of values to set. + Property name ID, use Shader.PropertyToID to get it. - + - The font to use for rendering. If null, the default font for the current GUISkin is used instead. + Sets a vector array property. + Property name. + Array of values to set. + Property name ID, use Shader.PropertyToID to get it. - + - The font size to use (for dynamic fonts). + Sets a vector array property. + Property name. + Array of values to set. + Property name ID, use Shader.PropertyToID to get it. - + - The font style to use (for dynamic fonts). + How the material interacts with lightmaps and lightprobes. - + - Rendering settings for when the mouse is hovering over the control. + Helper Mask to be used to query the enum only based on whether realtime GI or baked GI is set, ignoring all other bits. - + - How image and text of the GUIContent is combined. + The emissive lighting affects baked Global Illumination. It emits lighting into baked lightmaps and baked lightprobes. - + - The height of one line of text with this style, measured in pixels. (Read Only) + 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 margins between elements rendered in this style and any other GUI elements. + The emissive lighting does not affect Global Illumination at all. - + - The name of this GUIStyle. Used for getting them based on name. + The emissive lighting will affect realtime Global Illumination. It emits lighting into realtime lightmaps and realtime lightprobes. - + - Shortcut for an empty GUIStyle. + A block of material values to apply. - + - Rendering settings for when the component is displayed normally. + Is the material property block empty? (Read Only) - + - Rendering settings for when the element is turned on and pressed down. + Clear material property values. - + - Rendering settings for when the element has keyboard and is turned on. + Get a float from the property block. + + - + - Rendering settings for when the control is turned on and the mouse is hovering it. + Get a float from the property block. + + - + - Rendering settings for when the control is turned on. + Get a float array from the property block. + + - + - Extra space to be added to the background image. + Get a float array from the property block. + + - + - Space from the edge of GUIStyle to the start of the contents. + Fetch a float array from the property block into a list. + The list to hold the returned array. + + - + - Enable HTML-style tags for Text Formatting Markup. + Fetch a float array from the property block into a list. + The list to hold the returned array. + + - + - Can GUI elements of this style be stretched vertically for better layout? + Get a matrix from the property block. + + - + - Can GUI elements of this style be stretched horizontally for better layouting? + Get a matrix from the property block. + + - + - Should the text be wordwrapped? + Get a matrix array from the property block. + + - + - How tall this element will be when rendered with content and a specific width. + Get a matrix array from the property block. - - + + - + - Calculate the minimum and maximum widths for this style rendered with content. + Fetch a matrix array from the property block into a list. - - - + The list to hold the returned array. + + - + - Calculate the size of an element formatted with this style, and a given space to content. + Fetch a matrix array from the property block into a list. - + The list to hold the returned array. + + - + - Calculate the size of a some content if it is rendered with this style. + Get a texture from the property block. - + + - + - Constructor for empty GUIStyle. + Get a texture from the property block. + + - + - Constructs GUIStyle identical to given other GUIStyle. + Get a vector from the property block. - + + - + - Draw this GUIStyle on to the screen, internal version. + Get a vector from the property block. - - - - - + + - + - Draw the GUIStyle with a text string inside. + Get a vector array from the property block. - - - - - - + + - + - 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. + Get a vector array from the property block. - - - - - - + + - + - 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. + Fetch a vector array from the property block into a list. - - - - - - - + The list to hold the returned array. + + - + - 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. + Fetch a vector array from the property block into a list. - - - - - - - + The list to hold the returned array. + + - + - 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. + Set a ComputeBuffer property. - - - - - - - + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The ComputeBuffer to set. - + - Draw this GUIStyle with selected content. + Set a ComputeBuffer property. - - - - + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The ComputeBuffer to set. - + - Draw this GUIStyle with selected content. + Set a color property. - - - - - + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The Color value to set. - + - Get the pixel position of a given string index. + Set a color property. - - - + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The Color value to set. - + - Get the cursor position (indexing into contents.text) when the user clicked at cursorPixelPosition. + Set a float property. - - - + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The float value to set. - + - Get a named GUI style from the current skin. + Set a float property. - + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The float value to set. - + - Specialized values for the given states used by GUIStyle objects. + Set a float array property. + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The array to set. - + - The background image used by GUI elements in this given state. + Set a float array property. + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The array to set. - + - The text color used by GUI elements in this state. + Set a float array property. + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The array to set. - + - Allows to control for which display the OnGUI is called. + Set a float array property. + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The array to set. - + - Default constructor initializes the attribute for OnGUI to be called for all available displays. + Set a matrix property. - Display index. - Display index. - Display index list. + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The matrix value to set. - + - Default constructor initializes the attribute for OnGUI to be called for all available displays. + Set a matrix property. - Display index. - Display index. - Display index list. + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The matrix value to set. - + - Default constructor initializes the attribute for OnGUI to be called for all available displays. + Set a matrix array property. - Display index. - Display index. - Display index list. + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The array to set. - + - Default constructor initializes the attribute for OnGUI to be called for all available displays. + Set a matrix array property. - Display index. - Display index. - Display index list. + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The array to set. - + - A text string displayed in a GUI. + Set a matrix array property. + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The array to set. - + - The alignment of the text. + Set a matrix array property. + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The array to set. - + - The anchor of the text. + Set a texture property. + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The Texture to set. - + - The color used to render the text. + Set a texture property. + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The Texture to set. - + - The font used for the text. + Set a vector property. + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The Vector4 value to set. - + - The font size to use (for dynamic fonts). + Set a vector property. + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The Vector4 value to set. - + - The font style to use (for dynamic fonts). + Set a vector array property. + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The array to set. - + - The line spacing multiplier. + Set a vector array property. + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The array to set. - + - The Material to use for rendering. + Set a vector array property. + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The array to set. - + - The pixel offset of the text. + Set a vector array property. + The name of the property. + The name ID of the property retrieved by Shader.PropertyToID. + The array to set. - + - Enable HTML-style tags for Text Formatting Markup. + A collection of common math functions. - + - The tab width multiplier. + Returns the absolute value of f. + - + - The text to display. + Returns the absolute value of value. + - + - A texture image used in a 2D GUI. + Returns the arc-cosine of f - the angle in radians whose cosine is f. + - + - The border defines the number of pixels from the edge that are not affected by scale. + Compares two floating point values and returns true if they are similar. + + - + - The color of the GUI texture. + Returns the arc-sine of f - the angle in radians whose sine is f. + - + - Pixel inset used for pixel adjustments for size and position. + Returns the arc-tangent of f - the angle in radians whose tangent is f. + - + - The texture used for drawing. + Returns the angle in radians whose Tan is y/x. + + - + - Utility class for making new GUI controls. + Returns the smallest integer greater to or equal to f. + - + - A global property, which is true if a ModalWindow is being displayed, false otherwise. + Returns the smallest integer greater to or equal to f. + - + - The controlID of the current hot control. + Clamps a value between a minimum float and maximum float value. + + + - + - The controlID of the control that has keyboard focus. + Clamps value between min and max and returns value. + + + - + - Get access to the system-wide pasteboard. + Clamps value between 0 and 1 and returns value. + - + - Get a unique ID for a control. + Returns the closest power of two value. - - + - + - Get a unique ID for a control. + 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. + - + - Get a unique ID for a control, using an integer as a hint to help ensure correct matching of IDs to controls. + Returns the cosine of angle f in radians. - - - + - + - Get a unique ID for a control, using an integer as a hint to help ensure correct matching of IDs to controls. + Degrees-to-radians conversion constant (Read Only). - - - - + - Get a unique ID for a control, using a the label content as a hint to help ensure correct matching of IDs to controls. + Calculates the shortest difference between two given angles given in degrees. - - - + + - + - Get a unique ID for a control, using a the label content as a hint to help ensure correct matching of IDs to controls. + A tiny floating point value (Read Only). - - - - + - Get a state object from a controlID. + Returns e raised to the specified power. - - + - + - Convert a point from GUI position to screen space. + Returns the largest integer smaller to or equal to f. - + - + - Get an existing state object from a controlID. + Returns the largest integer smaller to or equal to f. - - + - + - Helper function to rotate the GUI around a point. + Converts the given value from gamma (sRGB) to linear color space. - - + - + - Helper function to scale the GUI around a point. + A representation of positive infinity (Read Only). - - - + - Convert a point from screen space to GUI position. + Calculates the linear parameter t that produces the interpolant value within the range [a, b]. - + + + - + - Interface into the Gyroscope. + Returns true if the value is power of two. + - + - Returns the attitude (ie, orientation in space) of the device. + 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. + - + - Sets or retrieves the enabled status of this gyroscope. + Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees. + + + - + - Returns the gravity acceleration vector expressed in the device's reference frame. + 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. + - + - Returns rotation rate as measured by the device's gyroscope. + Converts the given value from linear to gamma (sRGB) color space. + - + - Returns unbiased rotation rate as measured by the device's gyroscope. + Returns the logarithm of a specified number in a specified base. + + - + - Sets or retrieves gyroscope interval in seconds. + Returns the natural (base e) logarithm of a specified number. + - + - Returns the acceleration that the user is giving to the device. + Returns the base 10 logarithm of a specified number. + - + - Interface into functionality unique to handheld devices. + Returns largest of two or more values. + + + - + - Determines whether or not a 32-bit display buffer will be used. + Returns largest of two or more values. + + + - + - Gets the current activity indicator style. + Returns the largest of two or more values. + + + - + - Plays a full-screen movie. + Returns the largest of two or more values. - 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. + Returns the smallest of two or more values. - 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. + Returns the smallest of two or more values. - 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. + Returns the smallest of two or more values. - 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. + Returns the smallest of two or more values. - + + + - + - Sets the desired activity indicator style. + Moves a value current towards target. - + The current value. + The value to move towards. + The maximum change that should be applied to the value. - + - Starts os activity indicator. + Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees. + + + - + - Stops os activity indicator. + A representation of negative infinity (Read Only). - + - Triggers device vibration. + Returns the next power of two value. + - + - Represent the hash value. + Generate 2D Perlin noise. + X-coordinate of sample point. + Y-coordinate of sample point. + + Value between 0.0 and 1.0. + - + - Get if the hash value is valid or not. (Read Only) + The infamous 3.14159265358979... value (Read Only). - + - Construct the Hash128. + PingPongs the value t, so that it is never larger than length and never smaller than 0. - - - - + + - + - Convert the input string to Hash128. + Returns f raised to power p. - + + - + - Convert Hash128 to string. + Radians-to-degrees conversion constant (Read Only). - + - Use this PropertyAttribute to add a header above some fields in the Inspector. + Loops the value t, so that it is never larger than length and never smaller than 0. + + - + - The header text. + Returns f rounded to the nearest integer. + - + - Add a header above some fields in the Inspector. + Returns f rounded to the nearest integer. - The header text. + - + - Provide a custom documentation URL for a class. + Returns the sign of f. + - + - Initialize the HelpURL attribute with a documentation url. + Returns the sine of angle f in radians. - The custom documentation URL for this class. + The argument as a radian. + + The return value between -1 and +1. + - + - The documentation URL specified for this class. + 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. - + - Bit mask that controls object destruction, saving and visibility in inspectors. + 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. - + - 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. + 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. - + - The object will not be saved when building a player. + 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. - + - The object will not be saved to the scene in the editor. + 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. - + - The object will not be unloaded by Resources.UnloadUnusedAssets. + 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. - + - A combination of not shown in the hierarchy, not saved to to scenes and not unloaded by The object will not be unloaded by Resources.UnloadUnusedAssets. + Interpolates between min and max with smoothing at the limits. + + + - + - The object will not appear in the hierarchy. + Returns square root of f. + - + - It is not possible to view it in the inspector. + Returns the tangent of angle f in radians. + - + - A normal, visible object. This is the default. + A standard 4x4 transformation matrix. - + - The object is not be editable in the inspector. + The determinant of the matrix. - + - Makes a variable not show up in the inspector but be serialized. + Returns the identity matrix (Read Only). - + - The HingeJoint groups together 2 rigid bodies, constraining them to move like connected by a hinge. + The inverse of this matrix (Read Only). - + - The current angle in degrees of the joint relative to its rest position. (Read Only) + Is this the identity matrix? - + - Limit of angular rotation (in degrees) on the hinge joint. + Returns the transpose of this matrix (Read Only). - + - The motor will apply a force up to a maximum force to achieve the target velocity in degrees per second. + Returns a matrix with all elements set to zero (Read Only). - + - The spring attempts to reach a target angle by adding spring and damping forces. + Get a column of the matrix. + - + - Enables the joint's limits. Disabled by default. + Returns a row of the matrix. + - + - Enables the joint's motor. Disabled by default. + 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. + - + - Enables the joint's spring. Disabled by default. + Transforms a position by this matrix (generic). + - + - The angular velocity of the joint in degrees per second. + Transforms a position by this matrix (fast). + - + - Joint that allows a Rigidbody2D object to rotate around a point in space or a point on another object. + Transforms a direction by this matrix. + - + - The current joint angle (in degrees) with respect to the reference angle. + Multiplies two matrices. + + - + - The current joint speed. + Transforms a Vector4 by a matrix. + + - + - Limit of angular rotation (in degrees) on the joint. + Creates an orthogonal projection matrix. + + + + + + - + - Gets the state of the joint limit. + Creates a perspective projection matrix. + + + + - + - Parameters for the motor force applied to the joint. + Creates a scaling matrix. + - + - The angle (in degrees) referenced between the two bodies used as the constraint for the joint. + Sets a column of the matrix. + + - + - Should limits be placed on the range of rotation? + Sets a row of the matrix. + + - + - Should the joint be rotated automatically by a motor torque? + Sets this matrix to a translation, rotation and scaling matrix. + + + - + - Gets the motor torque of the joint given the specified timestep. + Access element at [row, column]. - The time to calculate the motor torque for. - + - Wrapping modes for text that reaches the horizontal boundary. + Access element at sequential index (0..15 inclusive). - + - Text can exceed the horizontal boundary. + Returns a nicely formatted string for this matrix. + - + - Text will word-wrap when reaching the horizontal boundary. + Returns a nicely formatted string for this matrix. + - + - This is the data structure for holding individual host information. + Creates a translation, rotation and scaling matrix. + + + - + - A miscellaneous comment (can hold data). + A class that allows creating or modifying meshes from scripts. - + - Currently connected players. + The bind poses. The bind pose at each index refers to the bone with the same index. - + - The name of the game (like John Doe's Game). + Returns BlendShape count on this mesh. - + - The type of the game (like "MyUniqueGameType"). + The bone weights of each vertex. - + - The GUID of the host, needed when connecting with NAT punchthrough. + The bounding volume of the mesh. - + - Server IP address. + Vertex colors of the Mesh. - + - Does the server require a password? + Vertex colors of the Mesh. - + - Maximum players limit. + Returns state of the Read/Write Enabled checkbox when model was imported. - + - Server port. + The normals of the Mesh. - + - Does this server require NAT punchthrough? + The number of sub-Meshes. Every Material has a separate triangle list. - + - Human Body Bones. + The tangents of the Mesh. - + - This is the Chest bone. + An array containing all triangles in the Mesh. - + - This is the Head bone. + The base texture coordinates of the Mesh. - + - This is the Hips bone. + The second texture coordinate set of the mesh, if present. - + - This is the Jaw bone. + The third texture coordinate set of the mesh, if present. - + - This is the Last bone index delimiter. + The fourth texture coordinate set of the mesh, if present. - + - This is the Left Eye bone. + Get the number of vertex buffers present in the Mesh. (Read Only) - + - This is the Left Ankle bone. + Returns the number of vertices in the Mesh (Read Only). - + - This is the Left Wrist bone. + Returns a copy of the vertex positions or assigns a new vertex positions array. - + - This is the left index 3rd phalange. + 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. - + - This is the left index 2nd phalange. + Clears all vertex data and all triangle indices. + - + - This is the left index 1st phalange. + Clears all blend shapes from Mesh. - + - This is the left little 3rd phalange. + 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. + - + - This is the left little 2nd phalange. + Creates an empty Mesh. - + - This is the left little 1st phalange. + Gets the bind poses for this instance. + A list of bind poses to populate. - + - This is the Left Elbow bone. + Returns the frame count for a blend shape. + The shape index to get frame count from. - + - This is the Left Knee bone. + 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. - + - This is the left middle 3rd phalange. + Returns the weight of a blend shape frame. + The shape index of the frame. + The frame index to get the weight from. - + - This is the left middle 2nd phalange. + Returns index of BlendShape by given name. + - + - This is the left middle 1st phalange. + Returns name of BlendShape by given index. + - + - This is the left ring 3rd phalange. + Gets the bone weights for this instance. + A list of bone weights to populate. - + - This is the left ring 2nd phalange. + Gets the vertex colors for this instance. + A list of vertex colors to populate. - + - This is the left ring 1st phalange. + Gets the vertex colors for this instance. + A list of vertex colors to populate. - + - This is the Left Shoulder bone. + Gets the index count of the given submesh. + - + - This is the left thumb 3rd phalange. + Gets the starting index location within the Mesh's index buffer, for the given submesh. + - + - This is the left thumb 2nd phalange. + Gets the index buffer for the specified sub mesh on this instance. + A list of indices to populate. + The sub mesh on this instance. See subMeshCount. - + - This is the left thumb 1st phalange. + Gets the index buffer for the specified sub mesh on this instance. + A list of indices to populate. + The sub mesh on this instance. See subMeshCount. - + - This is the Left Toes bone. + Retrieves a native (underlying graphics API) pointer to the index buffer. + + Pointer to the underlying graphics API index buffer. + - + - This is the Left Upper Arm bone. + 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. + - + - This is the Left Upper Leg bone. + Gets the vertex normals for this instance. + A list of vertex normals to populate. - + - This is the Neck bone. + Gets the tangents for this instance. + A list of tangents to populate. - + - This is the Right Eye bone. + Gets the topology of a sub-Mesh. + - + - This is the Right Ankle bone. + Gets the triangle list for the specified sub mesh on this instance. + A list of vertex indices to populate. + The sub mesh on this instance. See subMeshCount. - + - This is the Right Wrist bone. + Gets the triangle list for the specified sub mesh on this instance. + A list of vertex indices to populate. + The sub mesh on this instance. See subMeshCount. - + - This is the right index 3rd phalange. + Get the UVs for a given chanel. + The UV Channel (zero-indexed). + List of UVs to get for the given index. - + - This is the right index 2nd phalange. + Get the UVs for a given chanel. + The UV Channel (zero-indexed). + List of UVs to get for the given index. - + - This is the right index 1st phalange. + Get the UVs for a given chanel. + The UV Channel (zero-indexed). + List of UVs to get for the given index. - + - This is the right little 3rd phalange. + Gets the vertex positions for this instance. + A list of vertex positions to populate. - + - This is the right little 2nd phalange. + Optimize mesh for frequent updates. - + - This is the right little 1st phalange. + Optimizes the Mesh for display. - + - This is the Right Elbow bone. + Recalculate the bounding volume of the Mesh from the vertices. - + - This is the Right Knee bone. + Recalculates the normals of the Mesh from the triangles and vertices. - + - This is the right middle 3rd phalange. + Recalculates the tangents of the Mesh from the normals and texture coordinates. - + - This is the right middle 2nd phalange. + Vertex colors of the Mesh. + Per-Vertex Colours. - + - This is the right middle 1st phalange. + Vertex colors of the Mesh. + Per-Vertex Colours. - + - This is the right ring 3rd phalange. + 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 submesh 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. - + - This is the right ring 2nd phalange. + 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 submesh 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. - + - This is the right ring 1st phalange. + Set the normals of the Mesh. + Per-vertex normals. - + - This is the Right Shoulder bone. + Set the tangents of the Mesh. + Per-vertex tangents. - + - This is the right thumb 3rd phalange. + Sets the triangle list for the sub-Mesh. + The list of indices that define the triangles. + The submesh 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. - + - This is the right thumb 2nd phalange. + Sets the triangle list for the sub-Mesh. + The list of indices that define the triangles. + The submesh 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. - + - This is the right thumb 1st phalange. + Set the UVs for a given chanel. + The UV Channel (zero-indexed). + List of UVs to set for the given index. - + - This is the Right Toes bone. + Set the UVs for a given chanel. + The UV Channel (zero-indexed). + List of UVs to set for the given index. - + - This is the Right Upper Arm bone. + Set the UVs for a given chanel. + The UV Channel (zero-indexed). + List of UVs to set for the given index. - + - This is the Right Upper Leg bone. + Assigns a new vertex positions array. + Per-vertex position. - + - This is the first Spine bone. + Upload previously done Mesh modifications to the graphics API. + Frees up system memory copy of mesh data when set to true. + - + - The mapping between a bone in the model and the conceptual bone in the Mecanim human anatomy. + A mesh collider allows you to do between meshes and primitives. - + - The name of the bone to which the Mecanim human bone is mapped. + Use a convex collider from the mesh. - + - The name of the Mecanim human bone to which the bone from the model is mapped. + Allow the physics engine to increase the volume of the input mesh in attempt to generate a valid convex mesh. - + - The rotation limits that define the muscle for this bone. + The mesh object used for collision detection. - + - Class that holds humanoid avatar parameters to pass to the AvatarBuilder.BuildHumanAvatar function. + Used when set to inflateMesh to determine how much inflation is acceptable. - + - Amount by which the arm's length is allowed to stretch when using IK. + Uses interpolated normals for sphere collisions instead of flat polygonal normals. - + - Modification to the minimum distance between the feet of a humanoid model. + A class to access the Mesh of the. - + - True for any human that has a translation Degree of Freedom (DoF). It is set to false by default. + Returns the instantiated Mesh assigned to the mesh filter. - + - Mapping between Mecanim bone names and bone names in the rig. + Returns the shared mesh of the mesh filter. - + - Amount by which the leg's length is allowed to stretch when using IK. + Class used to allow GameObject.AddComponent / GameObject.GetComponent to be used. - + - Defines how the lower arm's roll/twisting is distributed between the elbow and wrist joints. + Renders meshes inserted by the MeshFilter or TextMesh. - + - Defines how the lower leg's roll/twisting is distributed between the knee and ankle. + Vertex attributes in this mesh will override or add attributes of the primary mesh in the MeshRenderer. - + - List of bone Transforms to include in the model. + Topology of Mesh faces. - + - Defines how the lower arm's roll/twisting is distributed between the shoulder and elbow joints. + Mesh is made from lines. - + - Defines how the upper leg's roll/twisting is distributed between the thigh and knee joints. + Mesh is a line strip. - + - This class stores the rotation limits that define the muscle for a single human bone. + Mesh is made from points. - + - Length of the bone to which the limit is applied. + Mesh is made from quads. - + - The default orientation of a bone when no muscle action is applied. + Mesh is made from triangles. - + - The maximum rotation away from the initial value that this muscle can apply. + Use this class to record to an AudioClip using a connected microphone. - + - The maximum negative rotation away from the initial value that this muscle can apply. + A list of available microphone devices, identified by name. - + - Should this limit use the default values? + Stops recording. + The name of the device. - + - Retargetable humanoid pose. + 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. - + - The human body position for that pose. + Get the position in samples of the recording. + The name of the device. - + - The human body orientation for that pose. + Query if a device is currently recording. + The name of the device. - + - The array of muscle values for that pose. + 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. + - + - A handler that lets you read or write a HumanPose from or to a humanoid avatar skeleton hierarchy. + MonoBehaviour is the base class from which every Unity script derives. - + - Creates a human pose handler from an avatar and a root transform. + Logs message to the Unity Console (identical to Debug.Log). - 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. + Allow a specific instance of a MonoBehaviour to run in edit mode (only available in the editor). - The output human pose. - + - Sets a human pose on the handled avatar skeleton. + Disabling this lets you skip the GUI layout phase. - The human pose to be set. - + - Details of all the human bone and muscle types defined by Mecanim. + Cancels all Invoke calls on this MonoBehaviour. - + - The number of human bone types defined by Mecanim. + Cancels all Invoke calls with name methodName on this behaviour. + - + - Return the bone to which a particular muscle is connected. + Invokes the method methodName in time seconds. - Muscle index. + + - + - Array of the names of all human bone types defined by Mecanim. + Invokes the method methodName in time seconds, then repeatedly every repeatRate seconds. + + + - + - Get the default maximum value of rotation for a muscle in degrees. + Is any invoke on methodName pending? - Muscle index. + - + - Get the default minimum value of rotation for a muscle in degrees. + Is any invoke pending on this MonoBehaviour? - Muscle index. - + - Returns parent humanoid bone index of a bone. + Starts a coroutine. - Humanoid bone index to get parent from. - - Humanoid bone index of parent. - + - + - The number of human muscle types defined by Mecanim. + Starts a coroutine named methodName. + + - + - Obtain the muscle index for a particular bone index and "degree of freedom". + Starts a coroutine named methodName. - 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. + Stops all coroutines running on this behaviour. - + - Is the bone a member of the minimal set of bones that Mecanim requires for a human model? + Stops the first coroutine named methodName, or the coroutine stored in routine running on this behaviour. - Index of the bone to test. + Name of coroutine. + Name of the function in code. - + - The number of bone types that are required by Mecanim for any human model. + 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. - + - This element can filter raycasts. If the top level element is hit it can further 'check' if the location is valid. + Base class for AnimationClips and BlendTrees. - + - Given a point and a camera is the raycast valid. + The type of motion vectors that should be generated. - Screen position. - Raycast camera. - - Valid. - - + - Interface for custom logger implementation. + Use only camera movement to track motion. - + - To selective enable debug log message. + Do not track motion. Motion vectors will be 0. - + - To runtime toggle debug logging [ON/OFF]. + Use a specific pass (if required) to track motion. - + - Set Logger.ILogHandler. + Movie Textures are textures onto which movies are played back. - + - Check logging is enabled based on the LogType. + Returns the AudioClip belonging to the MovieTexture. - - - Retrun true in case logs of LogType will be logged otherwise returns false. - - + - Logs message to the Unity Console using default logger. + The time, in seconds, that the movie takes to play back completely. - - - - - + - Logs message to the Unity Console using default logger. + Returns whether the movie is playing or not. - - - - - + - Logs message to the Unity Console using default logger. + If the movie is downloading from a web site, this returns if enough data has been downloaded so playback should be able to start without interruptions. - - - - - + - Logs message to the Unity Console using default logger. + Set this to true to make the movie loop. - - - - - + - Logs message to the Unity Console using default logger. + Pauses playing the movie. - - - - - + - Logs message to the Unity Console using default logger. + Starts playing the movie. - - - - - + - Logs message to the Unity Console using default logger. + Stops playing the movie, and rewinds it to the beginning. - - - - - + - A variant of ILogger.Log that logs an error message. + Attribute to make a string be edited with a multi-line textfield. - - - - + - A variant of ILogger.Log that logs an error message. + 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. - + - A variant of ILogger.Log that logs an exception message. + 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. - + - Logs a formatted message. + The network class is at the heart of the network implementation and provides the core functions. - - - - + - A variant of Logger.Log that logs an warning message. + All connected players. - - - - + - A variant of Logger.Log that logs an warning message. + The IP address of the connection tester used in Network.TestConnection. - - - - + - Interface for custom log handler implementation. + The port of the connection tester used in Network.TestConnection. - + - A variant of ILogHandler.LogFormat that logs an exception message. + Set the password for the server (for incoming connections). - Runtime Exception. - Object to which the message applies. - + - Logs a formatted message. + Returns true if your peer type is client. - The type of the log message. - Object to which the message applies. - A composite format string. - Format arguments. - + - Any Image Effect with this attribute will be rendered after opaque geometry but before transparent geometry. + Enable or disable the processing of network messages. - + - When using HDR rendering it can sometime be desirable to switch to LDR rendering during ImageEffect rendering. + Returns true if your peer type is server. - + - How image and text is placed inside GUIStyle. + Set the log level for network messages (default is Off). - + - Image is above the text. + Set the maximum amount of connections/players allowed. - + - Image is to the left of the text. + Get or set the minimum number of ViewID numbers in the ViewID pool given to clients by the server. - + - Only the image is displayed. + The IP address of the NAT punchthrough facilitator. - + - Only the text is displayed. + The port of the NAT punchthrough facilitator. - + - Controls IME input. + The status of the peer type, i.e. if it is disconnected, connecting, server or client. - + - Enable IME input only when a text field is selected (default). + Get the local NetworkPlayer instance. - + - Disable IME input. + The IP address of the proxy server. - + - Enable IME input. + Set the proxy server password. - + - Interface into the Input system. + The port of the proxy server. - + - Last measured linear acceleration of a device in three-dimensional space. (Read Only) + The default send rate of network updates for all Network Views. - + - Number of acceleration measurements which occurred during last frame. + Get the current network time (seconds). - + - Returns list of acceleration measurements which occurred during the last frame. (Read Only) (Allocates temporary variables). + Indicate if proxy support is needed, in which case traffic is relayed through the proxy server. - + - Is any key or mouse button currently held down? (Read Only) + Query for the next available network view ID number and allocate it (reserve). - + - Returns true the first frame the user hits any key or mouse button. (Read Only) + Close the connection to another system. + + - + - Should Back button quit the application? - -Only usable on Android, Windows Phone or Windows Tablets. + Connect to the specified host (ip or domain name) and server port. + + + - + - Property for accessing compass (handheld devices only). (Read Only) + Connect to the specified host (ip or domain name) and server port. + + + - + - This property controls if input sensors should be compensated for screen orientation. + This function is exactly like Network.Connect but can accept an array of IP addresses. + + + - + - The current text input position used by IMEs to open windows. + This function is exactly like Network.Connect but can accept an array of IP addresses. + + + - + - The current IME composition string being typed by the user. + Connect to a server GUID. NAT punchthrough can only be performed this way. + + - + - Device physical orientation as reported by OS. (Read Only) + Connect to a server GUID. NAT punchthrough can only be performed this way. + + - + - Property indicating whether keypresses are eaten by a textinput if it has focus (default true). + Connect to the host represented by a HostData structure returned by the Master Server. + + - + - Returns default gyroscope. + Connect to the host represented by a HostData structure returned by the Master Server. + + - + - Controls enabling and disabling of IME input composition. + Destroy the object associated with this view ID across the network. + - + - Does the user have an IME keyboard input source selected? + Destroy the object across the network. + - + - Returns the keyboard input entered this frame. (Read Only) + Destroy all the objects based on view IDs belonging to this player. + - + - Property for accessing device location (handheld devices only). (Read Only) + Close all open connections and shuts down the network interface. + - + - The current mouse position in pixel coordinates. (Read Only) + Close all open connections and shuts down the network interface. + - + - The current mouse scroll delta. (Read Only) + The last average ping time to the given player in milliseconds. + - + - Property indicating whether the system handles multiple touches. + The last ping time to the given player in milliseconds. + - + - Enables/Disables mouse simulation with touches. By default this option is enabled. + Check if this machine has a public IP address. - + - Returns true when Stylus Touch is supported by a device or platform. + Initializes security layer. - + - Number of touches. Guaranteed not to change throughout the frame. (Read Only) + Initialize the server. + + + - + - Returns list of objects representing status of all touches during last frame. (Read Only) (Allocates temporary variables). + Initialize the server. + + + - + - Bool value which let's users check if touch pressure is supported. + Network instantiate a prefab. + + + + - + - Returns whether the device on which application is currently running supports touch input. + Remove all RPC functions which belong to this player ID. + - + - Returns specific acceleration measurement which occurred during last frame. (Does not allocate temporary variables). + Remove all RPC functions which belong to this player ID and were sent based on the given group. - + + - + - Returns the value of the virtual axis identified by axisName. + Remove the RPC function calls accociated with this view ID number. - + - + - Returns the value of the virtual axis identified by axisName with no smoothing filtering applied. + Remove all RPC functions which belong to given group number. - + - + - Returns true while the virtual button identified by buttonName is held down. + Set the level prefix which will then be prefixed to all network ViewID numbers. - + - + - Returns true during the frame the user pressed down the virtual button identified by buttonName. + Enable or disables the reception of messages in a specific group number from a specific player. - + + + - + - Returns true the first frame the user releases the virtual button identified by buttonName. + Enables or disables transmission of messages and RPC calls on a specific network group number. - + + - + - Returns an array of strings describing the connected joysticks. + Enable or disable transmission of messages and RPC calls based on target network player as well as the network group. + + + - + - Returns true while the user holds down the key identified by name. Think auto fire. + Test this machines network connection. - + - + - Returns true while the user holds down the key identified by the key KeyCode enum parameter. + Test this machines network connection. - + - + - Returns true during the frame the user starts pressing down the key identified by name. + Test the connection specifically for NAT punch-through connectivity. - + - + - Returns true during the frame the user starts pressing down the key identified by the key KeyCode enum parameter. + Test the connection specifically for NAT punch-through connectivity. - + - + - Returns true during the frame the user releases the key identified by name. + Possible status messages returned by Network.Connect and in MonoBehaviour.OnFailedToConnect|OnFailedToConnect in case the error was not immediate. - - + - Returns true during the frame the user releases the key identified by the key KeyCode enum parameter. + Cannot connect to two servers at once. Close the connection before connecting again. - - + - Returns whether the given mouse button is held down. + We are already connected to this particular server (can happen after fast disconnect/reconnect). - - + - Returns true during the frame the user pressed the given mouse button. + We are banned from the system we attempted to connect to (likely temporarily). - - + - Returns true during the frame the user releases the given mouse button. + Connection attempt failed, possibly because of internal connectivity problems. - - + - Returns object representing status of a specific touch. (Does not allocate temporary variables). + Internal error while attempting to initialize network interface. Socket possibly already in use. - - + - Determine whether a particular joystick model has been preconfigured by Unity. (Linux-only). + No host target given in Connect. - 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. + Incorrect parameters given to Connect function. - + - ActivityIndicator Style (iOS Specific). + Client could not connect internally to same network NAT enabled server. - + - Do not show ActivityIndicator. + The server is using a password and has refused our connection because we did not set the correct password. - + - The standard gray style of indicator (UIActivityIndicatorViewStyleGray). + NAT punchthrough attempt has failed. The cause could be a too restrictive NAT implementation on either endpoints. - + - The standard white style of indicator (UIActivityIndicatorViewStyleWhite). + Connection lost while attempting to connect to NAT target. - + - The large white style of indicator (UIActivityIndicatorViewStyleWhiteLarge). + The NAT target we are trying to connect to is not connected to the facilitator server. - + - ADBannerView is a wrapper around the ADBannerView class found in the Apple iAd framework and is only available on iOS. + No error occurred. - + - Banner layout. + We presented an RSA public key which does not match what the system we connected to is using. - + - Checks if banner contents are loaded. + The server is at full capacity, failed to connect. - + - The position of the banner view. + The reason a disconnect event occured, like in MonoBehaviour.OnDisconnectedFromServer|OnDisconnectedFromServer. - + - The size of the banner view. + The connection to the system has been closed. - + - Banner visibility. Initially banner is not visible. + The connection to the system has been lost, no reliable packets could be delivered. - + - Will be fired when banner ad failed to load. + Defines parameters of channels. - + - Will be fired when banner was clicked. + UnderlyingModel.MemDoc.MemDocModel. + Requested type of quality of service (default Unreliable). + Copy constructor. - + - Will be fired when banner loaded new ad. + UnderlyingModel.MemDoc.MemDocModel. + Requested type of quality of service (default Unreliable). + Copy constructor. - + - Creates a banner view with given type and auto-layout params. + UnderlyingModel.MemDoc.MemDocModel. - - + Requested type of quality of service (default Unreliable). + Copy constructor. - + - Checks if the banner type is available (e.g. MediumRect is available only starting with ios6). + Channel quality of service. - - + - Specifies how banner should be layed out on screen. + Defines size of the buffer holding reliable messages, before they will be acknowledged. - + - Traditional Banner: align to screen bottom. + Ack buffer can hold 128 messages. - + - Rect Banner: align to screen bottom, placing at the center. + Ack buffer can hold 32 messages. - + - Rect Banner: place in bottom-left corner. + Ack buffer can hold 64 messages. - + - Rect Banner: place in bottom-right corner. + Ack buffer can hold 96 messages. - + - Rect Banner: place exactly at screen center. + This class defines parameters of connection between two peers, this definition includes various timeouts and sizes as well as channel configuration. - + - Rect Banner: align to screen left, placing at the center. + 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. - + - Rect Banner: align to screen right, placing at the center. + Determines the size of the buffer used to store reliable messages that are waiting for acknowledgement. It can be set to Ack32, Ack64, Ack96, or Ack128. 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. - + - Completely manual positioning. + 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. + - + - Traditional Banner: align to screen top. + 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. - + - Rect Banner: align to screen top, placing at the center. + Defines, when multiplied internally by InitialBandwidth, the maximum bandwidth that can be used under burst conditions. - + - Rect Banner: place in top-left corner. + (Read Only) The number of channels in the current configuration. - + - Rect Banner: place in top-right corner. + 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). - + - The type of the banner view. + Timeout in ms which library will wait before it will send another connection request. - + - Traditional Banner (it takes full screen width). + Will create default connection config or will copy them from another. + Connection config. - + - Rect Banner (300x250). + Will create default connection config or will copy them from another. + Connection config. - + - ADInterstitialAd is a wrapper around the ADInterstitialAd class found in the Apple iAd framework and is only available on iPad. + 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. - + - Checks if InterstitialAd is available (it is available on iPad since iOS 4.3, and on iPhone since iOS 7.0). + 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. - + - Has the interstitial ad object downloaded an advertisement? (Read Only) + Return the QoS set for the given channel or throw an out of range exception. + Index in array. + + Channel QoS. + - + - Creates an interstitial ad. + 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 1500MB/sec (1,536,000 bytes per second). The default value is intentionally a large number to allow all traffic to pass without delay. - - + - Creates an interstitial ad. + 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. - - + - Will be called when ad is ready to be shown. + 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. - + - Will be called when user did view ad contents: i.e. he went past initial screen. Please note that it is impossible to determine if he clicked on any links on ad sequence that follows initial screen. + 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. - + - Reload advertisement. + 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. - + - Shows full-screen advertisement to user. + 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. - + - Specify calendar types. + 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%. - + - Identifies the Buddhist calendar. + 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%. - + - Identifies the Chinese calendar. + 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. - + - Identifies the Gregorian calendar. + 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. - + - Identifies the Hebrew calendar. + 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. - + - Identifies the Indian calendar. + 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. - + - Identifies the Islamic calendar. + Defines the path to the file containing the certification authority (CA) certificate for WebSocket via SSL communication. - + - Identifies the Islamic civil calendar. + Defines path to SSL certificate file, for WebSocket via SSL communication. - + - Identifies the ISO8601. + Defines the path to the file containing the private key for WebSocket via SSL communication. - + - Identifies the Japanese calendar. + 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). - + - Identifies the Persian calendar. + When starting a server use protocols that make use of platform specific optimisations where appropriate rather than cross-platform protocols. (Sony consoles only). - + - Identifies the Republic of China (Taiwan) calendar. + Validate parameters of connection config. Will throw exceptions if parameters are incorrect. + - + - Specify calendrical units. + 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. - + - Specifies the day unit. + Create configuration for network simulator; You can use this class in editor and developer build only. - + - Specifies the era unit. + 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. - + - Specifies the hour unit. + Destructor. - + - Specifies the minute unit. + Manage and process HTTP response body data received from a remote server. - + - Specifies the month unit. + Returns the raw bytes downloaded from the remote server, or null. (Read Only) - + - Specifies the quarter of the calendar. + 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) - + - Specifies the second unit. + Convenience property. Returns the bytes from data interpreted as a UTF8 string. (Read Only) - + - Specifies the week unit. + Callback, invoked when all data has been received from the remote server. - + - Specifies the weekday unit. + Signals that this [DownloadHandler] is no longer being used, and should clean up any resources it is using. - + - Specifies the ordinal weekday unit. + Callback, invoked when the data property is accessed. + + Byte array to return as the value of the data property. + - + - Specifies the year unit. + Callback, invoked when UnityWebRequest.downloadProgress is accessed. + + The return value for UnityWebRequest.downloadProgress. + - + - Interface into iOS specific functionality. + Callback, invoked when the text property is accessed. + + String to return as the return value of the text property. + - + - Advertising ID. + Callback, invoked with a Content-Length header is received. + The value of the received Content-Length header. - + - Is advertising tracking enabled. + 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. + - + - The generation of the device. (Read Only) + A DownloadHandler subclass specialized for downloading AssetBundles. - + - iOS version. + Returns the downloaded AssetBundle, or null. (Read Only) - + - Vendor ID. + 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. - + - Reset "no backup" file flag: file will be synced with iCloud/iTunes backup and can be deleted by OS in low storage situations. + 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. - + - Set file flag to be excluded from iCloud/iTunes backup. + 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. - + - iOS device generation. + Returns the downloaded AssetBundle, or null. + A finished UnityWebRequest object with DownloadHandlerAssetBundle attached. + + The same as DownloadHandlerAssetBundle.assetBundle + - + - iPad, first generation. + Not implemented. Throws <a href="http:msdn.microsoft.comen-uslibrarysystem.notsupportedexception">NotSupportedException<a>. + + Not implemented. + - + - iPad, second generation. + Not implemented. Throws <a href="http:msdn.microsoft.comen-uslibrarysystem.notsupportedexception">NotSupportedException<a>. + + Not implemented. + - + - iPad, third generation. + A DownloadHandler subclass specialized for downloading audio data for use as AudioClip objects. - + - iPad, fourth generation. + Returns the downloaded AudioClip, or null. (Read Only) - + - iPad Air, fifth generation. + 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. - + - iPad Air. + Returns the downloaded AudioClip, or null. + A finished UnityWebRequest object with DownloadHandlerAudioClip attached. + + The same as DownloadHandlerAudioClip.audioClip + - + - iPad Air 2. + Called by DownloadHandler.data. Returns a copy of the downloaded clip data as raw bytes. + + A copy of the downloaded data. + - + - iPadMini, first generation. + A general-purpose DownloadHandler implementation which stores received data in a native byte buffer. - + - iPadMini Retina, second generation. + Default constructor. - + - iPad Mini 3. + 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 + - + - iPad Mini, fourth generation. + 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. + - + - iPad Pro 9.7", first generation. + Returns a copy of the native-memory buffer interpreted as a UTF8 string. + + A string representing the data in the native-memory buffer. + - + - iPad Pro, first generation. + An abstract base class for user-created scripting-driven DownloadHandler implementations. - + - Yet unknown iPad. + Create a DownloadHandlerScript which allocates new buffers when passing data to callbacks. - + - iPhone, first generation. + 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. - + - iPhone, second generation. + A DownloadHandler subclass specialized for downloading images for use as Texture objects. - + - iPhone, third generation. + Returns the downloaded Texture, or null. (Read Only) - + - iPhone, fourth generation. + Default constructor. - + - iPhone, fifth generation. + Constructor, allows TextureImporter.isReadable property to be set. + Value to set for TextureImporter.isReadable. - + - iPhone5. + Returns the downloaded Texture, or null. + A finished UnityWebRequest object with DownloadHandlerTexture attached. + + The same as DownloadHandlerTexture.texture + - + - iPhone 5C. + Called by DownloadHandler.data. Returns a copy of the downloaded image data as raw bytes. + + A copy of the downloaded data. + - + - iPhone 5S. + Defines global paramters for network library. - + - iPhone 6. + Create new global config object. - + - iPhone 6 plus. + Defines how many hosts you can use. Default Value = 16. Max value = 128. - + - iPhone 6S. + Deprecated. Defines maximum delay for network simulator. See Also: MaxTimerTimeout. - + - iPhone 6S Plus. + Defines maximum possible packet size in bytes for all network connections. - + - iPhone SE, first generation. + Defines the maximum timeout in milliseconds for any configuration. The default value is 12 seconds (12000ms). - + - Yet unknown iPhone. + Deprecated. Defines the minimal timeout for network simulator. You cannot set up any delay less than this value. See Also: MinTimerTimeout. - + - iPod Touch, first generation. + Defines the minimum timeout in milliseconds recognised by the system. The default value is 1 ms. - + - iPod Touch, second generation. + This property determines the initial size of the queue that holds messages received by Unity Multiplayer before they are processed. - + - iPod Touch, third generation. + Defines the initial size of the send queue. Messages are placed in this queue ready to be sent in packets to their destination. - + - iPod Touch, fourth generation. + Defines reactor model for the network library. - + - iPod Touch, fifth generation. + 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. - + - Yet unknown iPod Touch. + Defines how many worker threads are available to handle incoming and outgoing messages. - + - iOS.LocalNotification is a wrapper around the UILocalNotification class found in the Apple UIKit framework and is only available on iPhoneiPadiPod Touch. + 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). - + - The title of the action button or slider. + 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. + - + - The message displayed in the notification alert. + Create topology. + Default config. + Maximum default connections. - + - Identifies the image used as the launch image when the user taps the action button. + Defines config for default connections in the topology. - + - The number to display as the application's icon badge. + Return reference to special connection config. Parameters of this config can be changed. + Config id. + + Connection config. + - + - The default system sound. (Read Only) + Defines how many connection with default config be permitted. - + - The date and time when the system should deliver the notification. + Defines the maximum number of messages that each host can hold in its pool of received messages. The default size is 128. - + - A boolean value that controls whether the alert action is visible or not. + 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. - + - The calendar type (Gregorian, Chinese, etc) to use for rescheduling the notification. + List of special connection configs. - + - The calendar interval at which to reschedule the notification. + Returns count of special connection added to topology. - + - The name of the sound file to play when an alert is displayed. + An interface for composition of data into multipart forms. - + - The time zone of the notification's fire date. + 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. + - + - A dictionary for passing custom information to the notified application. + 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. + - + - Creates a new local notification. + 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. + - + - NotificationServices is only available on iPhoneiPadiPod Touch. + Returns the name of this section, if any. + + The section's name, or null. + - + - Device token received from Apple Push Service after calling NotificationServices.RegisterForRemoteNotificationTypes. (Read Only) + Details about a UNET MatchMaker match. - + - Enabled local and remote notification types. + The binary access token this client uses to authenticate its session for future commands. - + - The number of received local notifications. (Read Only) + IP address of the host of the match,. - + - The list of objects representing received local notifications. (Read Only) + The numeric domain for the match. - + - Returns an error that might occur on registration for remote notifications via NotificationServices.RegisterForRemoteNotificationTypes. (Read Only) + The unique ID of this match. - + - The number of received remote notifications. (Read Only) + NodeID for this member client in the match. - + - The list of objects representing received remote notifications. (Read Only) + Port of the host of the match. - + - All currently scheduled local notifications. + This flag indicates whether or not the match is using a Relay server. - + - Cancels the delivery of all scheduled local notifications. + A class describing the match information as a snapshot at the time the request was processed on the MatchMaker. - + - Cancels the delivery of the specified scheduled local notification. + The average Elo score of the match. - - + - Discards of all received local notifications. + The current number of players in the match. - + - Discards of all received remote notifications. + The collection of direct connect info classes describing direct connection information supplied to the MatchMaker. - + - Returns an object representing a specific local notification. (Read Only) + The NodeID of the host for this match. - - + - Returns an object representing a specific remote notification. (Read Only) + Describes if the match is private. Private matches are unlisted in ListMatch results. - - + - Presents a local notification immediately. + The collection of match attributes on this match. - - + - Register to receive local and remote notifications of the specified types from a provider via Apple Push Service. + The maximum number of players this match can grow to. - 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. + The text name for this match. - Notification types to register for. - Specify true to also register for remote notifications. - + - Schedules a local notification. + The network ID for this match. - - + - Unregister for remote notifications. + A class describing one member of a match and what direct connect information other clients have supplied. - + - Specifies local and remote notification types. + 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. - + - Notification is an alert message. + NodeID of the match member this info refers to. - + - Notification is a badge shown above the application's icon. + The private network address supplied for this direct connect info. - + - No notification types specified. + The public network address supplied for this direct connect info. - + - Notification is an alert sound. + A component for communicating with the Unity Multiplayer Matchmaking service. - + - On Demand Resources API. + The base URI of the MatchMaker that this NetworkMatch will communicate with. - + - Indicates whether player was built with "Use On Demand Resources" player setting enabled. + 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. - + - Creates an On Demand Resources (ODR) request. + Use this function to create a new match. The client which calls this function becomes the host of the match. - Tags for On Demand Resources that should be included in the request. + 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. - Object representing ODR request. + This function is asynchronous and will complete at some point in the future, when the coroutine has finished communicating with the service backend. - - - 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. + 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. - + - Sets the priority for request. + 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. + - + - Release all resources kept alive by On Demand Resources (ODR) request. + 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. + - + - Gets file system's path to the resource available in On Demand Resources (ODR) request. + The function used to tell MatchMaker the current client wishes to join a specific match. - Resource name. + 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. + - + - RemoteNotification is only available on iPhoneiPadiPod Touch. + 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. + - + - The message displayed in the notification alert. (Read Only) + 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. + - + - The number to display as the application's icon badge. (Read Only) + 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 boolean value that controls whether the alert action is visible or not. (Read Only) + A helper object for form sections containing generic, non-file data. - + - The name of the sound file to play when an alert is displayed. (Read Only) + Returns the value to use in this section's Content-Type header. + + The Content-Type header for this section, or null. + - + - A dictionary for passing custom information to the notified application. (Read Only) + 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. + - + - Interface to receive callbacks upon serialization and deserialization. + 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. + - + - See ISerializationCallbackReceiver.OnBeforeSerialize for documentation on how to use this method. + Returns the name of this section, if any. + + The section's name, or null. + - + - Implement this method to receive a callback after unity serialized your object. + Raw data section, unnamed and no Content-Type header. + Data payload of this section. - + - Joint is the base class for all joints. + Raw data section with a section name, no Content-Type header. + Section name. + Data payload of this section. - + - The Position of the anchor around which the joints motion is constrained. + 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. - + - Should the connectedAnchor be calculated automatically? + 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. - + - The Direction of the axis around which the body is constrained. + 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. - + - The force that needs to be applied for this joint to break. + 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. - + - The torque that needs to be applied for this joint to break. + An anonymous raw data section whose payload is derived from a UTF8 string, with a default Content-Type. + String data payload for this section. - + - Position of the anchor relative to the connected Rigidbody. + A helper object for adding file uploads to multipart forms via the [IMultipartFormSection] API. - + - A reference to another rigidbody this joint connects to. + Returns the value of the section's Content-Type header. + + The Content-Type header for this section, or null. + - + - Enable collision between bodies connected with the joint. + 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. + - + - Toggle preprocessing for this joint. + 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. + - + - Parent class for joints to connect Rigidbody2D objects. + Returns the name of this section, if any. + + The section's name, or null. + - + - The force that needs to be applied for this joint to break. + 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. - + - The torque that needs to be applied for this joint to break. + 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. - + - Can the joint collide with the other Rigidbody2D object to which it is attached? + 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. - + - The Rigidbody2D object to which the other end of the joint is attached (ie, the object without the joint component). + 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. - + - Should the two rigid bodies connected with this joint collide with each other? + 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. - + - Gets the reaction force of the joint. + 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. - + - Gets the reaction torque of the joint. + Possible Networking.NetworkTransport errors. - + - Gets the reaction force of the joint given the specified timeStep. + Not a data message. - 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 Networking.ConnectionConfig does not match the other endpoint. - 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. + The address supplied to connect to was invalid or could not be resolved. - + - Upper angular limit of rotation. + The message is too long to fit the buffer. - + - Lower angular limit of rotation. + Not enough resources are available to process this request. - + - How the joint's movement will behave along its local X axis. + The operation completed successfully. - + - Amount of force applied to push the object toward the defined direction. + Connection timed out. - + - Whether the drive should attempt to reach position, velocity, both or nothing. + This error will occur if any function is called with inappropriate parameter values. - + - Resistance strength against the Position Spring. Only used if mode includes Position. + The protocol versions are not compatible. Check your library versions. - + - Strength of a rubber-band pull toward the defined direction. Only used if mode includes Position. + The specified channel doesn't exist. - + - The ConfigurableJoint attempts to attain position / velocity targets based on this flag. + The specified connectionId doesn't exist. - + - Don't apply any forces to reach the target. + The specified host not available. - + - Try to reach the specified target position. + Operation is not supported. - + - Try to reach the specified target position and velocity. + Event that is returned when calling the Networking.NetworkTransport.Receive and Networking.NetworkTransport.ReceiveFromHost functions. - + - Try to reach the specified target velocity. + Broadcast discovery event received. +To obtain sender connection info and possible complimentary message from them, call Networking.NetworkTransport.GetBroadcastConnectionInfo() and Networking.NetworkTransport.GetBroadcastConnectionMessage() functions. - + - JointLimits is used by the HingeJoint to limit the joints angle. + Connection event received. Indicating that a new connection was established. - + - The minimum impact velocity which will cause the joint to bounce. + Data event received. Indicating that data was received. - + - Determines the size of the bounce when the joint hits it's limit. Also known as restitution. + Disconnection event received. - + - Distance inside the limit value at which the limit will be considered to be active by the solver. + No new event was received. - + - The upper angular limit (in degrees) of the joint. + Transport Layer API. - + - The lower angular limit (in degrees) of the joint. + 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. + - + - Represents the state of a joint limit. + 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. + - + - Represents a state where the joint limit is at the specified lower and upper limits (they are identical). + Created web socket host. + Port to bind to. + The Networking.HostTopology associated with the host. + IP address to bind to. + + Web socket host id. + - + - Represents a state where the joint limit is inactive. + Created web socket host. + Port to bind to. + The Networking.HostTopology associated with the host. + IP address to bind to. + + Web socket host id. + - + - Represents a state where the joint limit is at the specified lower limit. + 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). + - + - Represents a state where the joint limit is at the specified upper limit. + 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. - + - The JointMotor is used to motorize a joint. + 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). + - + - The motor will apply a force. - + 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). + - + - If freeSpin is enabled the motor will only accelerate but never slow down. - + 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). + - + - The motor will apply a force up to force to achieve targetVelocity. + 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). + - + - Parameters for the optional motor force applied to a Joint2D. + 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). - + - The maximum force that can be applied to the Rigidbody2D at the joint to attain the target speed. + 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). - + - The desired speed for the Rigidbody2D to reach as it moves with the joint. + 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). - + - Determines how to snap physics joints back to its constrained position when it drifts off too much. + 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. + - + - Don't snap at all. + 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. + - + - Snap both position and rotation. + 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). - + - Snap Position only. + 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). - + - JointSpring is used add a spring force to HingeJoint and PhysicMaterial. + 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. - + - The damper force uses to dampen the spring. + Returns the number of unread messages in the read-queue. - + - The spring forces used to reach the target position. + Returns the total number of messages still in the write-queue. - + - The target position the joint attempts to reach. + 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. + - + - Joint suspension is used to define how suspension works on a WheelJoint2D. + 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. + - + - The world angle (in degrees) along which the suspension will move. + 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. + - + - The amount by which the suspension spring force is reduced in proportion to the movement speed. + Returns how many packets have been received from start. (from Networking.NetworkTransport.Init call). + + Packets count received from start for all hosts. + - + - The frequency at which the suspension spring oscillates. + How many packets have been dropped due lack space in incoming queue (absolute value, countinf from start). + + Dropping packet count. + - + - Motion limits of a Rigidbody2D object along a SliderJoint2D. + 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. + - + - Maximum distance the Rigidbody2D object can move from the Slider Joint's anchor. + 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. + - + - Minimum distance the Rigidbody2D object can move from the Slider Joint's anchor. + Function returns time spent on network I/O operations in microseconds. + + Time in micro seconds. + - + - Utility functions for working with JSON data. + 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). - + - Create an object from its JSON representation. + Get a network timestamp. Can be used in your messages to investigate network delays together with Networking.GetRemoteDelayTimeMS. - The JSON representation of the object. - The type of object represented by the JSON. - An instance of the object. + Timestamp. - + - Create an object from its JSON representation. + Returns how much raw data (in bytes) have been sent from start for all hosts (from Networking.NetworkTransport.Init call). - The JSON representation of the object. - The type of object represented by the JSON. - An instance of the object. + Total data (user payload, protocol specific data, ip and udp headers) (in bytes) sent from start for all hosts. - - - 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. + 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). - 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. + Host ID associated with this connection. + ID of the connection. + Error (can be cast to Networking.NetworkError for more information). - The object's data in JSON format. + Total data (user payload, protocol specific data, ip and udp headers) (in bytes) sent from start for connection. - + - Generate a JSON representation of the public fields of an object. + Returns how much raw data (in bytes) have been sent from start for the host (from call Networking.NetworkTransport.AddHost). - 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. + ID of the host. + Error (can be cast to Networking.NetworkError for more information). - The object's data in JSON format. + Total data (user payload, protocol specific data, ip and udp headers) (in bytes) sent from start for the host. - + - Key codes returned by Event.keyCode. These map directly to a physical key on the keyboard. + 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. + - + - 'a' key. + 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. + - + - The '0' key on the top of the alphanumeric keyboard. + 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. + - + - The '1' key on the top of the alphanumeric keyboard. + 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. + - + - The '2' key on the top of the alphanumeric keyboard. + 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. + - + - The '3' key on the top of the alphanumeric keyboard. + 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. + - + - The '4' key on the top of the alphanumeric keyboard. + 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. + - + - The '5' key on the top of the alphanumeric keyboard. + 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. + - + - The '6' key on the top of the alphanumeric keyboard. + 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. + - + - The '7' key on the top of the alphanumeric keyboard. + 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. + - + - The '8' key on the top of the alphanumeric keyboard. + 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. + - + - The '9' key on the top of the alphanumeric keyboard. + 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. + - + - Alt Gr key. + 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. + - + - Ampersand key '&'. + 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. + - + - Asterisk key '*'. + 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. + - + - At key '@'. + 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). - + - 'b' key. + 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). - + - Back quote key '`'. + 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). - + - Backslash key '\'. + 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). - + - The backspace key. + Initializes the NetworkTransport. Should be called before any other operations on the NetworkTransport are done. - + - Break key. + Check if the broadcast discovery sender is running. + + True if it is running. False if it is not running. + - + - 'c' key. + Deprecated. - + - Capslock key. + 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. + - + - Caret key '^'. + 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. + - + - The Clear key. + 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. + - + - Colon ':' key. + 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. + - + - Comma ',' key. + Closes the opened socket, and closes all connections belonging to that socket. + Host ID to remove. - + - 'd' key. + 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). - + - The forward delete key. + 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). - + - Dollar sign key '$'. + 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. + - + - Double quote key '"'. + 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). - + - Down arrow key. + Used to inform the profiler of network packet statistics. + The ID of the message being reported. + Number of message being reported. + Number of bytes used by reported messages. - + - 'e' key. + Shut down the NetworkTransport. - + - End key. + 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. + - + - Equals '=' key. + 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). - + - Escape key. + Stop sending the broadcast discovery message. - + - Exclamation mark key '!'. + Arguments passed to Action callbacks registered in PlayerConnection. - + - 'f' key. + Data that is received. - + - F1 function key. + The Player ID that the data is received from. - + - F10 function key. + Used for handling the network connection from the Player to the Editor. - + - F11 function key. + Singleton instance. - + - F12 function key. + Returns true when Editor is connected to the player. - + - F13 function key. + 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. - + - F14 function key. + Registers a callback that is invoked when the Editor connects to the Player. + Action called when Player connects, with the Player ID of the Editor. - + - F15 function key. + Registers a callback to be called when Editor disconnects. + The Action that is called when a Player disconnects. - + - F2 function key. + Sends data to the Editor. + The type ID of the message that is sent to the Editor. + - + - F3 function key. + Deregisters a message listener. + Message ID associated with the callback that you wish to deregister. + The associated callback function you wish to deregister. - + - F4 function key. + Enumeration of all supported quality of service channel modes. - + - F5 function key. + A reliable message that will be re-sent with a high frequency until it is acknowledged. - + - F6 function key. + Each message is guaranteed to be delivered but not guaranteed to be in order. - + - F7 function key. + Each message is guaranteed to be delivered, also allowing fragmented messages with up to 32 fragments per message. - + - F8 function key. + Each message is guaranteed to be delivered and in order. - + - F9 function key. + 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. - + - 'g' key. + 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. - + - Greater than '>' key. + There is no guarantee of delivery or ordering. - + - 'h' key. + There is no guarantee of delivery or ordering, but allowing fragmented messages with up to 32 fragments per message. - + - Hash key '#'. + There is no guarantee of delivery and all unordered messages will be dropped. Example: VoIP. - + - Help key. + Define how unet will handle network io operation. - + - Home key. + 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. - + - 'i' key. + 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). - + - Insert key key. + The AppID identifies the application on the Unity Cloud or UNET servers. - + - 'j' key. + Invalid AppID. - + - Button 0 on first joystick. + An Enum representing the priority of a client in a match, starting at 0 and increasing. - + - Button 1 on first joystick. + The Invalid case for a HostPriority. An Invalid host priority is not a valid host. - + - Button 10 on first joystick. + Describes the access levels granted to this client. - + - Button 11 on first joystick. + Administration access level, generally describing clearence to perform game altering actions against anyone inside a particular match. - + - Button 12 on first joystick. + Invalid access level, signifying no access level has been granted/specified. - + - Button 13 on first joystick. + Access level Owner, generally granting access for operations key to the peer host server performing it's work. - + - Button 14 on first joystick. + User access level. This means you can do operations which affect yourself only, like disconnect yourself from the match. - + - Button 15 on first joystick. + Access token used to authenticate a client session for the purposes of allowing or disallowing match operations requested by that client. - + - Button 16 on first joystick. + Binary field for the actual token. - + - Button 17 on first joystick. + Accessor to get an encoded string from the m_array data. - + - Button 18 on first joystick. + 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). - + - Button 19 on first joystick. + Network ID, used for match making. - + - Button 2 on first joystick. + Invalid NetworkID. - + - Button 3 on first joystick. + The NodeID is the ID used in Relay matches to track nodes in a network. - + - Button 4 on first joystick. + The invalid case of a NodeID. - + - Button 5 on first joystick. + Identifies a specific game instance. - + - Button 6 on first joystick. + Invalid SourceID. - + - Button 7 on first joystick. + The UnityWebRequest object is used to communicate with web servers. - + - Button 8 on first joystick. + Indicates whether the UnityWebRequest system should employ the HTTP/1.1 chunked-transfer encoding method. - + - Button 9 on first joystick. + If true, any DownloadHandler attached to this UnityWebRequest will have DownloadHandler.Dispose called automatically when UnityWebRequest.Dispose is called. - + - Button 0 on second joystick. + If true, any UploadHandler attached to this UnityWebRequest will have UploadHandler.Dispose called automatically when UnityWebRequest.Dispose is called. - + - Button 1 on second joystick. + Returns the number of bytes of body data the system has downloaded from the remote server. (Read Only) - + - Button 10 on second joystick. + Holds a reference to a DownloadHandler object, which manages body data received from the remote server by this UnityWebRequest. - + - Button 11 on second joystick. + Returns a floating-point value between 0.0 and 1.0, indicating the progress of downloading body data from the server. (Read Only) - + - Button 12 on second joystick. + A human-readable string describing any system errors encountered by this UnityWebRequest object while handling HTTP requests or responses. (Read Only) - + - Button 13 on second joystick. + Returns true after the UnityWebRequest has finished communicating with the remote server. (Read Only) - + - Button 14 on second joystick. + Returns true after this UnityWebRequest encounters a system error. (Read Only) - + - Button 15 on second joystick. + Returns true while a UnityWebRequest’s configuration properties can be altered. (Read Only) - + - Button 16 on second joystick. + The string "CREATE", commonly used as the verb for an HTTP CREATE request. - + - Button 17 on second joystick. + The string "DELETE", commonly used as the verb for an HTTP DELETE request. - + - Button 18 on second joystick. + The string "GET", commonly used as the verb for an HTTP GET request. - + - Button 19 on second joystick. + The string "HEAD", commonly used as the verb for an HTTP HEAD request. - + - Button 2 on second joystick. + The string "POST", commonly used as the verb for an HTTP POST request. - + - Button 3 on second joystick. + The string "PUT", commonly used as the verb for an HTTP PUT request. - + - Button 4 on second joystick. + Defines the HTTP verb used by this UnityWebRequest, such as GET or POST. - + - Button 5 on second joystick. + Indicates the number of redirects which this UnityWebRequest will follow before halting with a “Redirect Limit Exceeded” system error. - + - Button 6 on second joystick. + The numeric HTTP response code returned by the server, such as 200, 404 or 500. (Read Only) - + - Button 7 on second joystick. + Returns the number of bytes of body data the system has uploaded to the remote server. (Read Only) - + - Button 8 on second joystick. + Holds a reference to the UploadHandler object which manages body data to be uploaded to the remote server. - + - Button 9 on second joystick. + Returns a floating-point value between 0.0 and 1.0, indicating the progress of uploading body data to the server. - + - Button 0 on third joystick. + Defines the target URL for the UnityWebRequest to communicate with. - + - Button 1 on third joystick. + Determines whether this UnityWebRequest will include Expect: 100-Continue in its outgoing request headers. (Default: true). - + - Button 10 on third joystick. + If in progress, halts the UnityWebRequest as soon as possible. - + - Button 11 on third joystick. + 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. - + - Button 12 on third joystick. + 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. - + - Button 13 on third joystick. + 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. + - + - Button 14 on third joystick. + Signals that this [UnityWebRequest] is no longer being used, and should clean up any resources it is using. - + - Button 15 on third joystick. + Generate a random 40-byte array for use as a multipart form boundary. + + 40 random bytes, guaranteed to contain only printable ASCII values. + - + - Button 16 on third joystick. + Creates a UnityWebRequest configured for HTTP GET. + The URI of the resource to retrieve via HTTP GET. + + A UnityWebRequest object configured to retrieve data from uri. + - + - Button 17 on third joystick. + 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 UnityWebRequest configured to downloading a Unity Asset Bundle. + - + - Button 18 on third joystick. + 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 UnityWebRequest configured to downloading a Unity Asset Bundle. + - + - Button 19 on third joystick. + 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 UnityWebRequest configured to downloading a Unity Asset Bundle. + - + - Button 2 on third joystick. + Create a UnityWebRequest intended 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. + - + - Button 3 on third joystick. + 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. + - + - Button 4 on third joystick. + 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. + - + - Button 5 on third joystick. + 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. + - + - Button 6 on third joystick. + 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. + - + - Button 7 on third joystick. + 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. + - + - Button 8 on third joystick. + 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. + - + - Button 9 on third joystick. + 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 body data. Will be URLEncoded via WWWTranscoder.URLEncode prior to transmission. + + A UnityWebRequest configured to send form data to uri via POST. + - + - Button 0 on forth joystick. + 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. + - + - Button 1 on forth joystick. + 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. + - + - Button 10 on forth joystick. + 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. + - + - Button 11 on forth joystick. + 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. + - + - Button 12 on forth joystick. + Create 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. + - + - Button 13 on forth joystick. + Create 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. + - + - Button 14 on forth joystick. + 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. + - + - Button 15 on forth joystick. + 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. + - + - Button 16 on forth joystick. + 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. + - + - Button 17 on forth joystick. + Set a HTTP request header to a custom value. + The key of the header to be set. Case-sensitive. + The header's intended value. - + - Button 18 on forth joystick. + Helper object for UnityWebRequests. Manages the buffering and transmission of body data during HTTP requests. - + - Button 19 on forth joystick. + Determines the default Content-Type header which will be transmitted with the outbound HTTP request. - + - Button 2 on forth joystick. + The raw data which will be transmitted to the remote server as body data. (Read Only) - + - Button 3 on forth joystick. + Returns the proportion of data uploaded to the remote server compared to the total amount of data to upload. (Read Only) - + - Button 4 on forth joystick. + Signals that this [UploadHandler] is no longer being used, and should clean up any resources it is using. - + - Button 5 on forth joystick. + A general-purpose UploadHandler subclass, using a native-code memory buffer. - + - Button 6 on forth joystick. + General constructor. Contents of the input argument are copied into a native buffer. + Raw data to transmit to the remote server. - + - Button 7 on forth joystick. + Networking Utility. - + - Button 8 on forth joystick. + This property is deprecated and does not need to be set or referenced. - + - Button 9 on forth joystick. + Utility function to get this client's access token for a particular network, if it has been set. + - + - Button 0 on fifth joystick. + Utility function to fetch the program's ID for UNET Cloud interfacing. - + - Button 1 on fifth joystick. + Utility function to get the client's SourceID for unique identification. - + - Button 10 on fifth joystick. + Utility function that accepts the access token for a network after it's received from the server. + + - + - Button 11 on fifth joystick. + Deprecated; Setting the AppID is no longer necessary. Please log in through the editor and set up the project there. + - + - Button 12 on fifth joystick. + Describes different levels of log information the network layer supports. - + - Button 13 on fifth joystick. + Full debug level logging down to each individual message being reported. - + - Button 14 on fifth joystick. + Report informational messages like connectivity events. - + - Button 15 on fifth joystick. + Only report errors, otherwise silent. - + - Button 16 on fifth joystick. + This data structure contains information on a message just received from the network. - + - Button 17 on fifth joystick. + The NetworkView who sent this message. - + - Button 18 on fifth joystick. + The player who sent this network message (owner). - + - Button 19 on fifth joystick. + The time stamp when the Message was sent in seconds. - + - Button 2 on fifth joystick. + Describes the status of the network interface peer type as returned by Network.peerType. - + - Button 3 on fifth joystick. + Running as client. - + - Button 4 on fifth joystick. + Attempting to connect to a server. - + - Button 5 on fifth joystick. + No client connection running. Server not initialized. - + - Button 6 on fifth joystick. + Running as server. - + - Button 7 on fifth joystick. + The NetworkPlayer is a data structure with which you can locate another player over the network. - + - Button 8 on fifth joystick. + Returns the external IP address of the network interface. - + - Button 9 on fifth joystick. + Returns the external port of the network interface. - + - Button 0 on sixth joystick. + The GUID for this player, used when connecting with NAT punchthrough. - + - Button 1 on sixth joystick. + The IP address of this player. - + - Button 10 on sixth joystick. + The port of this player. - + - Button 11 on sixth joystick. + Returns true if two NetworkPlayers are the same player. + + - + - Button 12 on sixth joystick. + Returns true if two NetworkPlayers are not the same player. + + - + - Button 13 on sixth joystick. + Returns the index number for this network player. - + - Button 14 on sixth joystick. + Describes network reachability options. - + - Button 15 on sixth joystick. + Network is not reachable. - + - Button 16 on sixth joystick. + Network is reachable via carrier data network. - + - Button 17 on sixth joystick. + Network is reachable via WiFi or cable. - + - Button 18 on sixth joystick. + Different types of synchronization for the NetworkView component. - + - Button 19 on sixth joystick. + No state data will be synchronized. - + - Button 2 on sixth joystick. + All packets are sent reliable and ordered. - + - Button 3 on sixth joystick. + Brute force unreliable state sending. - + - Button 4 on sixth joystick. + The network view is the binding material of multiplayer games. - + - Button 5 on sixth joystick. + The network group number of this network view. - + - Button 6 on sixth joystick. + Is the network view controlled by this object? - + - Button 7 on sixth joystick. + The component the network view is observing. - + - Button 8 on sixth joystick. + The NetworkPlayer who owns this network view. - + - Button 9 on sixth joystick. + The type of NetworkStateSynchronization set for this network view. - + - Button 0 on seventh joystick. + The ViewID of this network view. - + - Button 1 on seventh joystick. + Find a network view based on a NetworkViewID. + - + - Button 10 on seventh joystick. + Call a RPC function on all connected peers. + + + - + - Button 11 on seventh joystick. + Call a RPC function on a specific player. + + + - + - Button 12 on seventh joystick. + Set the scope of the network view in relation to a specific network player. + + - + - Button 13 on seventh joystick. + The NetworkViewID is a unique identifier for a network view instance in a multiplayer game. - + - Button 14 on seventh joystick. + True if instantiated by me. - + - Button 15 on seventh joystick. + The NetworkPlayer who owns the NetworkView. Could be the server. - + - Button 16 on seventh joystick. + Represents an invalid network view ID. - + - Button 17 on seventh joystick. + Returns true if two NetworkViewIDs are identical. + + - + - Button 18 on seventh joystick. + Returns true if two NetworkViewIDs are not identical. + + - + - Button 19 on seventh joystick. + Returns a formatted string with details on this NetworkViewID. - + - Button 2 on seventh joystick. + NPOT Texture2D|textures support. - + - Button 3 on seventh joystick. + Full NPOT support. - + - Button 4 on seventh joystick. + NPOT textures are not supported. Will be upscaled/padded at loading time. - + - Button 5 on seventh joystick. + Limited NPOT support: no mip-maps and clamp TextureWrapMode|wrap mode will be forced. - + - Button 6 on seventh joystick. + Base class for all objects Unity can reference. - + - Button 7 on seventh joystick. + Should the object be hidden, saved with the scene or modifiable by the user? - + - Button 8 on seventh joystick. + The name of the object. - + - Button 9 on seventh joystick. + Removes a gameobject, component or asset. + The object to destroy. + The optional amount of time to delay before destroying the object. - + - Button 0 on eighth joystick. + Removes a gameobject, component or asset. + The object to destroy. + The optional amount of time to delay before destroying the object. - + - Button 1 on eighth joystick. + 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 destoyed. - + - Button 10 on eighth joystick. + 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 destoyed. - + - Button 11 on eighth joystick. + Makes the object target not be destroyed automatically when loading a new scene. + - + - Button 12 on eighth joystick. + Returns the first active loaded object of Type type. + The type of object to find. + + An array of objects which matched the specified type, cast as Object. + - + - Button 13 on eighth joystick. + 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. + - + - Button 14 on eighth joystick. + 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. + - + - Button 15 on eighth joystick. + 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. + - + - Button 16 on eighth joystick. + Returns the instance id of the object. - + - Button 17 on eighth joystick. + Does the object exist? + - + - Button 18 on eighth joystick. + 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. + - + - Button 19 on eighth joystick. + 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. + - + - Button 2 on eighth joystick. + 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. + - + - Button 3 on eighth joystick. + 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. + - + - Button 4 on eighth joystick. + 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. + - + - Button 5 on eighth joystick. + 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. + - + - Button 6 on eighth joystick. + 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. + - + - Button 7 on eighth joystick. + 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. + - + - Button 8 on eighth joystick. + 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. + - + - Button 9 on eighth joystick. + 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. + - + - Button 0 on any joystick. + Compares two object references to see if they refer to the same object. + The first Object. + The Object to compare against the first. - + - Button 1 on any joystick. + Compares if two objects refer to a different object. + + - + - Button 10 on any joystick. + Returns the name of the game object. - + - Button 11 on any joystick. + OcclusionArea is an area in which occlusion culling is performed. - + - Button 12 on any joystick. + Center of the occlusion area relative to the transform. - + - Button 13 on any joystick. + Size that the occlusion area will have. - + - Button 14 on any joystick. + The portal for dynamically changing occlusion at runtime. - + - Button 15 on any joystick. + Gets / sets the portal's open state. - + - Button 16 on any joystick. + Enumeration for SystemInfo.operatingSystemFamily. - + - Button 17 on any joystick. + Linux operating system family. - + - Button 18 on any joystick. + macOS operating system family. - + - Button 19 on any joystick. + Returned for operating systems that do not fall into any other category. - + - Button 2 on any joystick. + Windows operating system family. - + - Button 3 on any joystick. + (Legacy Particle system). - + - Button 4 on any joystick. + The angular velocity of the particle. - + - Button 5 on any joystick. + The color of the particle. - + - Button 6 on any joystick. + The energy of the particle. - + - Button 7 on any joystick. + The position of the particle. - + - Button 8 on any joystick. + The rotation of the particle. - + - Button 9 on any joystick. + The size of the particle. - + - 'k' key. + The starting energy of the particle. - + - Numeric keypad 0. + The velocity of the particle. - + - Numeric keypad 1. + (Legacy Particles) Particle animators move your particles over time, you use them to apply wind, drag & color cycling to your particle emitters. - + - Numeric keypad 2. + Does the GameObject of this particle animator auto destructs? - + - Numeric keypad 3. + Colors the particles will cycle through over their lifetime. - + - Numeric keypad 4. + How much particles are slowed down every frame. - + - Numeric keypad 5. + Do particles cycle their color over their lifetime? - + - Numeric keypad 6. + The force being applied to particles every frame. - + - Numeric keypad 7. + Local space axis the particles rotate around. - + - Numeric keypad 8. + A random force added to particles every frame. - + - Numeric keypad 9. + How the particle sizes grow over their lifetime. - + - Numeric keypad '/'. + World space axis the particles rotate around. - + - Numeric keypad enter. + Information about a particle collision. - + - Numeric keypad '='. + The Collider for the GameObject struck by the particles. - + - Numeric keypad '-'. + The Collider or Collider2D for the GameObject struck by the particles. - + - Numeric keypad '*'. + Intersection point of the collision in world coordinates. - + - Numeric keypad '.'. + Geometry normal at the intersection point of the collision. - + - Numeric keypad '+'. + Incident velocity at the intersection point of the collision. - + - 'l' key. + (Legacy Particles) Script interface for particle emitters. - + - Left Alt key. + The angular velocity of new particles in degrees per second. - + - Left Command key. + Should particles be automatically emitted each frame? - + - Left arrow key. + The amount of the emitter's speed that the particles inherit. - + - Left square bracket key '['. + Turns the ParticleEmitter on or off. - + - Left Command key. + The starting speed of particles along X, Y, and Z, measured in the object's orientation. - + - Left Control key. + The maximum number of particles that will be spawned every second. - + - Left Parenthesis key '('. + The maximum lifetime of each particle, measured in seconds. - + - Left shift key. + The maximum size each particle can be at the time when it is spawned. - + - Left Windows key. + The minimum number of particles that will be spawned every second. - + - Less than '<' key. + The minimum lifetime of each particle, measured in seconds. - + - 'm' key. + The minimum size each particle can be at the time when it is spawned. - + - Menu key. + The current number of particles (Read Only). - + - Minus '-' key. + Returns a copy of all particles and assigns an array of all particles to be the current particles. - + - First (primary) mouse button. + A random angular velocity modifier for new particles. - + - Second (secondary) mouse button. + If enabled, the particles will be spawned with random rotations. - + - Third mouse button. + A random speed along X, Y, and Z that is added to the velocity. - + - Fourth mouse button. + If enabled, the particles don't move when the emitter moves. If false, when you move the emitter, the particles follow it around. - + - Fifth mouse button. + The starting speed of particles in world space, along X, Y, and Z. - + - Sixth mouse button. + Removes all particles from the particle emitter. - + - Seventh mouse button. + Emit a number of particles. - + - 'n' key. + Emit count particles immediately. + - + - Not assigned (never returned as the result of a keystroke). + Emit a single particle with given parameters. + The position of the particle. + The velocity of the particle. + The size of the particle. + The remaining lifetime of the particle. + The color of the particle. - + - Numlock key. + + The initial rotation of the particle in degrees. + The angular velocity of the particle in degrees per second. + + + + + - + - 'o' key. + Advance particle simulation by given time. + - + - 'p' key. + Method extension for Physics in Particle System. - + - Page down. + 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. + - + - Page up. + Safe array size for use with ParticleSystem.GetCollisionEvents. + - + - Pause on PC machines. + 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. + - + - Period '.' key. + 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. + - + - Plus key '+'. + 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. - + - Print key. + 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. - + - 'q' key. + (Legacy Particles) Renders particles on to the screen. - + - Question mark '?' key. + How much are the particles strected depending on the Camera's speed. - + - Quote key '. + How much are the particles stretched in their direction of motion. - + - 'r' key. + Clamp the maximum particle size. - + - Return key. + How particles are drawn. - + - Right Alt key. + Set uv animation cycles. - + - Right Command key. + Set horizontal tiling count. - + - Right arrow key. + Set vertical tiling count. - + - Right square bracket key ']'. + How much are the particles strectched depending on "how fast they move". - + - Right Command key. + The rendering mode for legacy particles. - + - Right Control key. + Render the particles as billboards facing the player. (Default) - + - Right Parenthesis key ')'. + Render the particles as billboards always facing up along the y-Axis. - + - Right shift key. + Sort the particles back-to-front and render as billboards. - + - Right Windows key. + Stretch particles in the direction of motion. - + - 's' key. + Render the particles as billboards always facing the player, but not pitching along the x-Axis. - + - Scroll lock key. + Script interface for particle systems (Shuriken). - + - Semicolon ';' key. + Access the particle system collision module. - + - Slash '/' key. + Access the particle system color by lifetime module. - + - Space key. + Access the particle system color over lifetime module. - + - Sys Req key. + Access the particle system Custom Data module. - + - 't' key. + The duration of the particle system in seconds (Read Only). - + - The tab key. + Access the particle system emission module. - + - 'u' key. + The rate of emission. - + - Underscore '_' key. + When set to false, the particle system will not emit particles. - + - Up arrow key. + Access the particle system external forces module. - + - 'v' key. + Access the particle system force over lifetime module. - + - 'w' key. + Scale being applied to the gravity defined by Physics.gravity. - + - 'x' key. + Access the particle system velocity inheritance module. - + - 'y' key. + Is the particle system currently 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. - + - 'z' key. + Is the particle system paused right now ? - + - A single keyframe that can be injected into an animation curve. + Is the particle system playing right now ? - + - Describes the tangent when approaching this point from the previous point in the curve. + Is the particle system stopped right now ? - + - Describes the tangent when leaving this point towards the next point in the curve. + Access the particle system lights module. - + - The time of the keyframe. + Access the particle system limit velocity over lifetime module. - + - The value of the curve at keyframe. + Is the particle system looping? - + - Create a keyframe. + Access the main particle system settings. - - - + - Create a keyframe. + The maximum number of particles to emit. - - - - - + - LayerMask allow you to display the LayerMask popup menu in the inspector. + Access the particle system noise module. - + - Converts a layer mask value to an integer value. + The current number of particles (Read Only). - + - 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. + The playback speed of the particle system. 1 is normal playback speed. - List of layer names to convert to a layer mask. - - The layer mask created from the layerNames. - - + - Implicitly converts an integer to a LayerMask. + If set to true, the particle system will automatically start playing on startup. - - + - Given a layer number, returns the name of the layer as defined in either a Builtin or a User Layer in the. + Override the random seed used for the particle system emission. - - + - Given a layer name, returns the layer index as defined by either a Builtin or a User Layer in the. + Access the particle system rotation by speed module. - - + - Script interface for a. + Access the particle system rotation over lifetime module. - + - The strength of the flare. + The scaling mode applied to particle sizes and positions. - + - The color of the flare. + Access the particle system shape module. - + - The fade speed of the flare. + This selects the space in which to simulate particles. It can be either world or local space. - + - The to use. + Access the particle system size by speed module. - + - Script interface for. + Access the particle system size over lifetime module. - + - Has the light already been lightmapped. + The initial color of particles when emitted. - + - The size of the area light. Editor only. + Start delay in seconds. - + - The multiplier that defines the strength of the bounce lighting. + The total lifetime in seconds that particles will have when emitted. When using curves, this values acts as a scale on the curve. This value is set in the particle when it is created by the particle system. - + - The color of the light. + The initial rotation of particles when emitted. When using curves, this values acts as a scale on the curve. - + - Number of command buffers set up on this light (Read Only). + The initial 3D rotation of particles when emitted. When using curves, this values acts as a scale on the curves. - + - The cookie texture projected by the light. + The initial size of particles when emitted. When using curves, this values acts as a scale on the curve. - + - The size of a directional light's cookie. + The initial speed of particles when emitted. When using curves, this values acts as a scale on the curve. - + - This is used to light certain objects in the scene selectively. + Access the particle system sub emitters module. - + - The to use for this light. + Access the particle system texture sheet animation module. - + - The Intensity of a light is multiplied with the Light color. + Playback position in seconds. - + - The range of the light. + Access the particle system trails module. - + - How to render the light. + Access the particle system trigger module. - + - Shadow mapping constant bias. + Controls whether the Particle System uses an automatically-generated random number to seed the random number generator. - + - Near plane value to use for shadow frustums. + Access the particle system velocity over lifetime module. - + - Shadow mapping normal-based bias. + Script interface for a Burst. - + - How this light casts shadows + How many times to play the burst. (0 means infinitely). - + - Strength of light's shadows. + Maximum number of bursts to be emitted. - + - The angle of the light's spotlight cone in degrees. + Minimum number of bursts to be emitted. - + - The type of the light. + How often to repeat the burst, in seconds. - + - Add a command buffer to be executed at a specified place. + The time that each burst occurs. - When to execute the command buffer during rendering. - The buffer to execute. - + - Get command buffers to be executed at a specified place. + Construct a new Burst with a time and count. - When to execute the command buffer during rendering. - - Array of command buffers. - + Time to emit the burst. + Minimum number of particles to emit. + Maximum number of particles to emit. + Number of particles to emit. - + - Remove all command buffers set on this light. + 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. - + - Remove command buffer from execution at a specified place. + Remove all particles in the particle system. - When to execute the command buffer during rendering. - The buffer to execute. + Clear all child particle systems as well. - + - Remove command buffers from execution at a specified place. + Script interface for the Collision module. - When to execute the command buffer during rendering. - + - Data of a lightmap. + How much force is applied to each particle after a collision. - + - Lightmap storing the full incoming light. + Change the bounce multiplier. - + - Lightmap storing only the indirect incoming light. + Control which layers this particle system collides with. - + - Stores lightmaps of the scene. + How much speed is lost from each particle after a collision. - + - Lightmap array. + Change the dampen multiplier. - + - Non-directional, Directional or Directional Specular lightmaps rendering mode. + Enable/disable the Collision module. - + - Holds all data needed by the light probes. + Allow particles to collide with dynamic colliders when using world collision mode. - + - Lightmap (and lighting) configuration mode, controls how lightmaps interact with lighting and what kind of information they store. + Allow particles to collide when inside colliders. - + - Directional information for direct light is combined with directional information for indirect light, encoded as 2 lightmaps. + How much a particle's lifetime is reduced after a collision. - + - Light intensity (no directional information), encoded as 1 lightmap. + Change the lifetime loss multiplier. - + - Directional information for direct light is stored separately from directional information for indirect light, encoded as 4 lightmaps. + The maximum number of collision shapes that will be considered for particle collisions. Excess shapes will be ignored. Terrains take priority. - + - Single, dual, or directional lightmaps rendering mode, used only in GIWorkflowMode.Legacy + Kill particles whose speed goes above this threshold, after a collision. - + - Directional rendering mode. + The maximum number of planes it is possible to set as colliders. - + - Dual lightmap rendering mode. + Kill particles whose speed falls below this threshold, after a collision. - + - Single, traditional lightmap rendering mode. + Choose between 2D and 3D world collisions. - + - Light Probe Group. + Specifies the accuracy of particle collisions against colliders in the scene. - + - Editor only function to access and modify probe positions. + A multiplier applied to the size of each particle before collisions are processed. - + - Stores light probes for the scene. + Send collision callback messages. - + - Coefficients of baked light probes. + The type of particle collision to perform. - + - The number of cells space is divided into (Read Only). + Size of voxels in the collision cache. - + - The number of light probes (Read Only). + Get a collision plane associated with this particle system. + Specifies which plane to access. + + The plane. + - + - Positions of the baked light probes (Read Only). + Set a collision plane to be used with this particle system. + Specifies which plane to set. + The plane to set. - + - Returns an interpolated probe for the given position for both realtime and baked light probes combined. + Script interface for the Color By Speed module. - - - - + - How the Light is rendered. + The gradient controlling the particle colors. - + - Automatically choose the render mode. + Enable/disable the Color By Speed module. - + - Force the Light to be a pixel light. + Apply the color gradient between these minimum and maximum speeds. - + - Force the Light to be a vertex light. + Script interface for the Color Over Lifetime module. - + - Shadow casting options for a Light. + The gradient controlling the particle colors. - + - Cast "hard" shadows (with no shadow filtering). + Enable/disable the Color Over Lifetime module. - + - Do not cast shadows (default). + Script interface for the Custom Data module. - + - Cast "soft" shadows (with 4x PCF filtering). + Enable/disable the Custom Data module. - + - The type of a Light. + 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. + - + - The light is an area light. It affects only lightmaps and lightprobes. + 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. + - + - The light is a directional light. + 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. + - + - The light is a point light. + 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. + - + - The light is a spot light. + 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. - + - The line renderer is used to draw free-floating lines in 3D space. + 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. - + - If enabled, the lines are defined in world space. + 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. - + - Set the line color at the start and at the end. + 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. + - + - Set the position of the vertex in the line. + Script interface for the Emission module. - - - + - Set the positions of all vertices in the line. + The current number of bursts. - - + - Set the number of line segments. + Enable/disable the Emission module. - - + - Set the line width at the start and at the end. + The rate at which new particles are spawned. - - - + - Structure describing device location. + Change the rate multiplier. - + - Geographical device location altitude. + The rate at which new particles are spawned, over distance. - + - Horizontal accuracy of the location. + Change the rate over distance multiplier. - + - Geographical device location latitude. + The rate at which new particles are spawned, over time. - + - Geographical device location latitude. + Change the rate over time multiplier. - + - Timestamp (in seconds since 1970) when location was last time updated. + The emission type. - + - Vertical accuracy of the location. + Get the burst array. + Array of bursts to be filled in. + + The number of bursts in the array. + - + - Interface into location functionality. + Set the burst array. + Array of bursts. + Optional array size, if burst count is less than array size. - + - Specifies whether location service is enabled in user settings. + Set the burst array. + Array of bursts. + Optional array size, if burst count is less than array size. - + - Last measured device geographical location. + Emit count particles immediately. + Number of particles to emit. - + - Returns location service status. + Emit a number of particles from script. + Overidden particle properties. + Number of particles to emit. - + - 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. + Script interface for particle emission parameters. - - - + - Stops location service updates. This could be useful for saving battery life. + Override the angular velocity of emitted particles. - + - Describes location service status. + Override the 3D angular velocity of emitted particles. - + - Location service failed (user denied access to location service). + When overriding the position of particles, setting this flag to true allows you to retain the influence of the shape module. - + - Location service is initializing, some time later it will switch to. + Override the axis of rotation of emitted particles. - + - Location service is running and locations could be queried. + Override the position of emitted particles. - + - Location service is stopped. + Override the random seed of emitted particles. - + - Structure for building a LOD for passing to the SetLODs function. + Override the rotation of emitted particles. - + - Width of the cross-fade transition zone (proportion to the current LOD's whole length) [0-1]. Only used if it's not animated. + Override the 3D rotation of emitted particles. - + - List of renderers for this LOD level. + Override the initial color of emitted particles. - + - The screen relative height to use for the transition [0-1]. + Override the lifetime of emitted particles. - + - Construct a LOD. + Override the initial size of emitted particles. - 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. + Override the initial 3D size of emitted particles. - + - 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. + Override the velocity of emitted particles. - + - Indicates the LOD fading is turned off. + Reverts angularVelocity and angularVelocity3D back to the values specified in the inspector. - + - 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. + Revert the axis of rotation back to the value specified in the inspector. - + - LODGroup lets you group multiple Renderers into LOD levels. + Revert the position back to the value specified in the inspector. - + - Specify if the cross-fading should be animated by time. The animation duration is specified globally as crossFadeAnimationDuration. + Revert the random seed back to the value specified in the inspector. - + - The cross-fading animation duration in seconds. ArgumentException will be thrown if it is set to zero or a negative value. + Reverts rotation and rotation3D back to the values specified in the inspector. - + - Enable / Disable the LODGroup - Disabling will turn off all renderers. + Revert the initial color back to the value specified in the inspector. - + - The LOD fade mode used. + Revert the lifetime back to the value specified in the inspector. - + - The local reference point against which the LOD distance is calculated. + Revert the initial size back to the value specified in the inspector. - + - The number of LOD levels. + Revert the velocity back to the value specified in the inspector. - + - The size of the LOD object in local space. + Script interface for the External Forces module. - + - + Enable/disable the External Forces module. - The LOD level to use. Passing index < 0 will return to standard LOD processing. - + - Returns the array of LODs. + Multiplies the magnitude of applied external forces. - - The LOD array. - - + - Recalculate the bounding region for the LODGroup (Relatively slow, do not call often). + Script interface for the Force Over Lifetime module. - + - Set the LODs for the LOD group. This will remove any existing LODs configured on the LODGroup. + Enable/disable the Force Over Lifetime module. - The LODs to use for this group. - + - Initializes a new instance of the Logger. + When randomly selecting values between two curves or constants, this flag will cause a new random force to be chosen on each frame. - + - To selective enable debug log message. + Are the forces being applied in local or world space? - + - To runtime toggle debug logging [ON/OFF]. + The curve defining particle forces in the X axis. - + - Set Logger.ILogHandler. + Change the X axis mulutiplier. - + - Create a custom Logger. + The curve defining particle forces in the Y axis. - Pass in default log handler or custom log handler. - + - Check logging is enabled based on the LogType. + Change the Y axis multiplier. - 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 curve defining particle forces in the Z axis. - 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. + Change the Z axis multiplier. - 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. + Get a stream of custom per-particle data. - 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. + The array of per-particle data. + Which stream to retrieve the data from. + + The amount of valid per-particle data. + - + - Logs message to the Unity Console using default logger. + Get the particles of this particle system. - 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. + Particle buffer that is used for writing particle state to. The return value is the number of particles written to this array. + + The number of particles written to the input particle array (the number of particles currently alive). + - + - Logs message to the Unity Console using default logger. + The Inherit Velocity Module controls how the velocity of the emitter is transferred to the particles as they are emitted. - 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. + Curve to define how much emitter velocity is applied during the lifetime of a particle. - 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. + Change the curve multiplier. - 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. + Enable/disable the InheritVelocity module. - 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. + How to apply emitter velocity to particles. - 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. + Does the system have any live particles (or will produce more)? - Runtime Exception. - Object to which the message applies. + Check all child particle systems as well. + + True if the particle system is still "alive", false if the particle system is done emitting particles and all particles are dead. + - + - A variant of Logger.Log that logs an exception message. + Access the ParticleSystem Lights Module. - Runtime Exception. - Object to which the message applies. - + - Logs a formatted message. + Toggle whether the particle alpha gets multiplied by the light intensity, when computing the final light intensity. - The type of the log message. - Object to which the message applies. - A composite format string. - Format arguments. - + - Logs a formatted message. + Enable/disable the Lights module. - 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. + Define a curve to apply custom intensity scaling to particle lights. - 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. + Intensity multiplier. - 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.logger.Log or delegate registered with Application.RegisterLogCallback. + Select what Light prefab you want to base your particle lights on. - + - LogType used for Asserts. (These could also indicate an error inside Unity itself.) + Set a limit on how many lights this Module can create. - + - LogType used for Errors. + Define a curve to apply custom range scaling to particle lights. - + - LogType used for Exceptions. + Range multiplier. - + - LogType used for regular log messages. + Choose what proportion of particles will receive a dynamic light. - + - LogType used for Warnings. + Toggle where the particle size will be multiplied by the light range, to determine the final light range. - + - The Master Server is used to make matchmaking between servers and clients easy. + Toggle whether the particle lights will have their color multiplied by the particle color. - + - Report this machine as a dedicated server. + Randomly assign lights to new particles based on ParticleSystem.LightsModule.ratio. - + - The IP address of the master server. + Script interface for the Limit Velocity Over Lifetime module. - + - The connection port of the master server. + Controls how much the velocity that exceeds the velocity limit should be dampened. - + - Set the minimum update rate for master server host information update. + Enable/disable the Limit Force Over Lifetime module. - + - Clear the host list which was received by MasterServer.PollHostList. + Maximum velocity curve, when not using one curve per axis. - + - Check for the latest host list received by using MasterServer.RequestHostList. + Change the limit multiplier. - + - Register this server on the master server. + Maximum velocity curve for the X axis. - - - - + - Register this server on the master server. + Change the limit multiplier on the X axis. - - - - + - Request a host list from the master server. + Maximum velocity curve for the Y axis. - - + - Unregister this server from the master server. + Change the limit multiplier on the Y axis. - + - Describes status messages from the master server as returned in MonoBehaviour.OnMasterServerEvent|OnMasterServerEvent. + Maximum velocity curve for the Z axis. - + - Received a host list from the master server. + Change the limit multiplier on the Z axis. - + - Registration failed because an empty game name was given. + Set the velocity limit on each axis separately. - + - Registration failed because an empty game type was given. + Specifies if the velocity limits are in local space (rotated with the transform) or world space. - + - Registration failed because no server is running. + Script interface for the main module. - + - Registration to master server succeeded, received confirmation. + Simulate particles relative to a custom transform component. - + - To specify position and rotation weight mask for Animator::MatchTarget. + The duration of the particle system in seconds. - + - Position XYZ weight. + Scale applied to the gravity, defined by Physics.gravity. - + - Rotation weight. + Change the gravity mulutiplier. - + - MatchTargetWeightMask contructor. + Is the particle system looping? - Position XYZ weight. - Rotation weight. - + - The material class. + The maximum number of particles to emit. - + - The main material's color. + If set to true, the particle system will automatically start playing on startup. - + - Defines how the material should interact with lightmaps and lightprobes. + When looping is enabled, this controls whether this particle system will look like it has already simulated for one loop when first becoming visible. - + - The material's texture. + Cause some particles to spin in the opposite direction. - + - The texture offset of the main texture. + Control how the particle system's Transform Component is applied to the particle system. - + - The texture scale of the main texture. + This selects the space in which to simulate particles. It can be either world or local space. - + - How many passes are in this material (Read Only). + Override the default playback speed of the Particle System. - + - Render queue of this material. + The initial color of particles when emitted. - + - The shader used by the material. + Start delay in seconds. - + - Additional shader keywords set by this material. + Start delay multiplier in seconds. - + - Copy properties from other material into this material. + The total lifetime in seconds that each new particle will have. - - + - + Start lifetime multiplier. - - + - Create a temporary Material. + The initial rotation of particles when emitted. - Create a material with a given Shader. - Create a material by copying all properties from another material. - + - Create a temporary Material. + A flag to enable 3D particle rotation. - Create a material with a given Shader. - Create a material by copying all properties from another material. - + - Unset a shader keyword. + Start rotation multiplier. - - + - Set a shader keyword that is enabled by this material. + The initial rotation of particles around the X axis when emitted. - - + - Get a named color value. + Start rotation multiplier around the X axis. - - - + - Get a named color value. + The initial rotation of particles around the Y axis when emitted. - - - + - Get a named float value. + Start rotation multiplier around the Y axis. - - - + - Get a named float value. + The initial rotation of particles around the Z axis when emitted. - - - + - Get a named integer value. + Start rotation multiplier around the Z axis. - - - + - Get a named integer value. + The initial size of particles when emitted. - - - + - Get a named matrix value from the shader. + A flag to enable specifying particle size individually for each axis. - - - + - Get a named matrix value from the shader. + Start size multiplier. - - - + - Get the value of material's shader tag. + The initial size of particles along the X axis when emitted. - - - - + - Get the value of material's shader tag. + Start rotation multiplier along the X axis. - - - - + - Get a named texture. + The initial size of particles along the Y axis when emitted. - - - + - Get a named texture. + Start rotation multiplier along the Y axis. - - - + - Gets the placement offset of texture propertyName. + The initial size of particles along the Z axis when emitted. - - + - Gets the placement scale of texture propertyName. + Start rotation multiplier along the Z axis. - - + - Get a named vector value. + The initial speed of particles when emitted. - - - + - Get a named vector value. + A multiplier of the initial speed of particles when emitted. - - - + - Checks if material's shader has a property of a given name. + Script interface for a Min-Max Curve. - - - + - Checks if material's shader has a property of a given name. + Set the constant value. - - - + - Is the shader keyword enabled on this material? + Set a constant for the upper bound. - - + - Interpolate properties between two materials. + Set a constant for the lower bound. - - - - + - Set a ComputeBuffer value. + Set the curve. - - - + - Set a named color value. + Set a curve for the upper bound. - - - - + - Set a named color value. + Set a curve for the lower bound. - - - - + - Set a named float value. + Set a multiplier to be applied to the curves. - - - - + - Set a named float value. + Set the mode that the min-max curve will use to evaluate values. - - - - + - Set a named integer value. - -When setting values on materials using the Standard Shader, you should be aware that you may need to use EnableKeyword to enable features of the shader that were not previously in use. For more detail, read wiki: -MaterialsAccessingViaScript|Accessing Materials via Script. + A single constant value for the entire curve. - - - + Constant value. - + - Set a named integer value. - -When setting values on materials using the Standard Shader, you should be aware that you may need to use EnableKeyword to enable features of the shader that were not previously in use. For more detail, read wiki: -MaterialsAccessingViaScript|Accessing Materials via Script. + 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. + - + - Set a named matrix for the shader. + 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. + - + - Set a named matrix for the shader. + 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. - + - Sets an override tag/value on the material. + Manually query the curve to calculate values based on what mode it is in. - Name of the tag to set. - Name of the value to set. Empty string to clear the override flag. + 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. + - + - Activate the given pass for rendering. + Manually query the curve to calculate values based on what mode it is in. - Shader pass number to setup. + 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). - If false is returned, no rendering should be done. + Calculated curve/constant value. - + - Set a named texture. + 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 named texture. + Set a constant color. - - - - + - Sets the placement offset of texture propertyName. + Set a constant color for the upper bound. - - - + - Sets the placement scale of texture propertyName. + Set a constant color for the lower bound. - - - + - Set a named vector value. + Set the gradient. - - - - + - Set a named vector value. + Set a gradient for the upper bound. - - - - + - How the material should interact with lightmaps and lightprobes. + Set a gradient for the lower bound. - + - The emissive lighting should affect Global Illumination. It should emit lighting into baked lightmaps and baked lightprobes. + Set the mode that the min-max gradient will use to evaluate colors. - + - 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. + A single constant color for the entire gradient. + Constant color. - + - The emissive lighting should not affect Global Illumination at all. + Use one gradient when evaluating numbers along this Min-Max gradient. + A single gradient for evaluating against. - + - The emissive lighting should affect Global Illumination. It should emit lighting into realtime lightmaps and realtime lightprobes. + 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. - + - A block of material values to apply. + 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. - + - Is the material property block empty? (Read Only) + 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. + - + - Clear material property values. + 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. + - + - Get a float from the property block. + 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. - - - + - Get a float from the property block. + Higher frequency noise will reduce the strength by a proportional amount, if enabled. - - - + - Get a matrix from the property block. + Enable/disable the Noise module. - - - + - Get a matrix from the property block. + Low values create soft, smooth noise, and high values create rapidly changing noise. - - - + - Get a texture from the property block. + Layers of noise that combine to produce final noise. - - - + - Get a texture from the property block. + When combining each octave, scale the intensity by this amount. - - - + - Get a vector from the property block. + When combining each octave, zoom in by this amount. - - - + - Get a vector from the property block. + Generate 1D, 2D or 3D noise. - - - + - Set a color property. + Define how the noise values are remapped. - - - - + - Set a color property. + Enable remapping of the final noise values, allowing for noise values to be translated into different values. - - - - + - Set a float property. + Remap multiplier. - - - - + - Set a float property. + Define how the noise values are remapped on the X axis, when using the ParticleSystem.NoiseModule.separateAxes option. - - - - + - Set a matrix property. + X axis remap multiplier. - - - - + - Set a matrix property. + Define how the noise values are remapped on the Y axis, when using the ParticleSystem.NoiseModule.separateAxes option. - - - - + - Set a texture property. + Y axis remap multiplier. - - - - + - Set a texture property. + Define how the noise values are remapped on the Z axis, when using the ParticleSystem.NoiseModule.separateAxes option. - - - - + - Set a vector property. + Z axis remap multiplier. - - - - + - Set a vector property. + Scroll the noise map over the particle system. - - - - + - A collection of common math functions. + Scroll speed multiplier. - + - Returns the absolute value of f. + Control the noise separately for each axis. - - + - Returns the absolute value of value. + How strong the overall noise effect is. - - + - Returns the arc-cosine of f - the angle in radians whose cosine is f. + Strength multiplier. - - + - Compares two floating point values if they are similar. + Define the strength of the effect on the X axis, when using the ParticleSystem.NoiseModule.separateAxes option. - - - + - Returns the arc-sine of f - the angle in radians whose sine is f. + X axis strength multiplier. - - + - Returns the arc-tangent of f - the angle in radians whose tangent is f. + Define the strength of the effect on the Y axis, when using the ParticleSystem.NoiseModule.separateAxes option. - - + - Returns the angle in radians whose Tan is y/x. + Y axis strength multiplier. - - - + - Returns the smallest integer greater to or equal to f. + Define the strength of the effect on the Z axis, when using the ParticleSystem.NoiseModule.separateAxes option. - - + - Returns the smallest integer greater to or equal to f. + Z axis strength multiplier. - - + - Clamps a value between a minimum float and maximum float value. + Script interface for a Particle. - - - - + - Clamps value between min and max and returns value. + The angular velocity of the particle. - - - - + - Clamps value between 0 and 1 and returns value. + The 3D angular velocity of the particle. - - + - Returns the closest power of two value. + The lifetime of the particle. - - + - Returns the cosine of angle f in radians. + The position of the particle. - - + - Degrees-to-radians conversion constant (Read Only). + The random seed of the particle. - + - Calculates the shortest difference between two given angles given in degrees. + The random value of the particle. - - - + - A tiny floating point value (Read Only). + The remaining lifetime of the particle. - + - Returns e raised to the specified power. + The rotation of the particle. - - + - Returns the largest integer smaller to or equal to f. + The 3D rotation of the particle. - - + - Returns the largest integer smaller to or equal to f. + The initial color of the particle. The current color of the particle is calculated procedurally based on this value and the active color modules. - - + - Converts the given value from gamma (sRGB) to linear color space. + The starting lifetime of the particle. - - + - A representation of positive infinity (Read Only). + The initial size of the particle. The current size of the particle is calculated procedurally based on this value and the active size modules. - + - Calculates the linear parameter t that produces the interpolant value within the range [a, b]. + 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. - - - - + - Returns true if the value is power of two. + The velocity of the particle. - - + - Linearly interpolates between a and b by t. + 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. + - + - Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees. + 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. + - + - Linearly interpolates between a and b by t. + 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. + - + - Converts the given value from linear to gamma (sRGB) color space. + Pauses the system so no new particles are emitted and the existing particles are not updated. - + Pause all child particle systems as well. - + - Returns the logarithm of a specified number in a specified base. + Starts the particle system. - - + Play all child particle systems as well. - + - Returns the natural (base e) logarithm of a specified number. + Script interface for the Rotation By Speed module. - - + - Returns the base 10 logarithm of a specified number. + Enable/disable the Rotation By Speed module. - - + - Returns largest of two or more values. + Apply the rotation curve between these minimum and maximum speeds. - - - - + - Returns largest of two or more values. + Set the rotation by speed on each axis separately. - - - - + - Returns the largest of two or more values. + Rotation by speed curve for the X axis. - - - - + - Returns the largest of two or more values. + Speed multiplier along the X axis. - - - - + - Returns the smallest of two or more values. + Rotation by speed curve for the Y axis. - - - - + - Returns the smallest of two or more values. + Speed multiplier along the Y axis. - - - - + - Returns the smallest of two or more values. + Rotation by speed curve for the Z axis. - - - - + - Returns the smallest of two or more values. + Speed multiplier along the Z axis. - - - - + - Moves a value current towards target. + Script interface for the Rotation Over Lifetime module. - 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. + Enable/disable the Rotation Over Lifetime module. - - - - + - A representation of negative infinity (Read Only). + Set the rotation over lifetime on each axis separately. - + - Returns the next power of two value. + Rotation over lifetime curve for the X axis. - - + - Generate 2D Perlin noise. + Rotation multiplier around the X axis. - X-coordinate of sample point. - Y-coordinate of sample point. - - Value between 0.0 and 1.0. - - + - The infamous 3.14159265358979... value (Read Only). + Rotation over lifetime curve for the Y axis. - + - PingPongs the value t, so that it is never larger than length and never smaller than 0. + Rotation multiplier around the Y axis. - - - + - Returns f raised to power p. + Rotation over lifetime curve for the Z axis. - - - + - Radians-to-degrees conversion constant (Read Only). + Rotation multiplier around the Z axis. - + - Loops the value t, so that it is never larger than length and never smaller than 0. + Set a stream of custom per-particle data. + + The array of per-particle data. + Which stream to assign the data to. + + + + Set the particles of this particle system. size is the number of particles that is set. + + + + + + + Script interface for the Shape module. - - - + - Returns f rounded to the nearest integer. + Align particles based on their initial direction of travel. - - + - Returns f rounded to the nearest integer. + Angle of the cone. - - + - Returns the sign of f. + Circle arc angle. - - + - Returns the sine of angle f in radians. + The mode used for generating particles around the arc. - - + - Gradually changes a value towards a desired goal over time. + When using one of the animated modes, how quickly to move the emission position around the arc. - 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. + A multiplier of the arc speed of the emission shape. - 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. + Control the gap between emission points around the arc. - 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. + Scale of the box. - 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. + Enable/disable the Shape module. - 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. + Length of the cone. - 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. + Mesh to emit particles from. - - - - + - Returns square root of f. + Emit particles from a single material of a mesh. - - + - Returns the tangent of angle f in radians. + MeshRenderer to emit particles from. - - + - A standard 4x4 transformation matrix. + Apply a scaling factor to the mesh used for generating source positions. - + - The determinant of the matrix. + Where on the mesh to emit particles from. - + - Returns the identity matrix (Read Only). + Move particles away from the surface of the source mesh. - + - The inverse of this matrix (Read Only). + Radius of the shape. - + - Is this the identity matrix? + The mode used for generating particles along the radius. - + - Returns the transpose of this matrix (Read Only). + When using one of the animated modes, how quickly to move the emission position along the radius. - + - Returns a matrix with all elements set to zero (Read Only). + A multiplier of the radius speed of the emission shape. - + - Get a column of the matrix. + Control the gap between emission points along the radius. - - + - Returns a row of the matrix. + Randomizes the starting direction of particles. - - + - Transforms a position by this matrix (generic). + Randomizes the starting direction of particles. - - + - Transforms a position by this matrix (fast). + Type of shape to emit particles from. - - + - Transforms a direction by this matrix. + SkinnedMeshRenderer to emit particles from. - - + - Multiplies two matrices. + Spherizes the starting direction of particles. - - - + - Transforms a Vector4 by a matrix. + Modulate the particle colors with the vertex colors, or the material color if no vertex colors exist. - - - + - Creates an orthogonal projection matrix. + Emit from a single material, or the whole mesh. - - - - - - - + - Creates a perspective projection matrix. + Fastforwards the particle system by simulating particles over 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. + Fastforward 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. - + - Creates a scaling matrix. + Script interface for the Size By Speed module. - - + - Sets a column of the matrix. + Enable/disable the Size By Speed module. - - - + - Sets a row of the matrix. + Apply the size curve between these minimum and maximum speeds. - - - + - Sets this matrix to a translation, rotation and scaling matrix. + Set the size by speed on each axis separately. - - - - + - Access element at [row, column]. + Curve to control particle size based on speed. - + - Access element at sequential index (0..15 inclusive). + Size multiplier. - + - Returns a nicely formatted string for this matrix. + Size by speed curve for the X axis. - - + - Returns a nicely formatted string for this matrix. + X axis size multiplier. - - + - Creates a translation, rotation and scaling matrix. + Size by speed curve for the Y axis. - - - - + - A class that allows creating or modifying meshes from scripts. + Y axis size multiplier. - + - The bind poses. The bind pose at each index refers to the bone with the same index. + Size by speed curve for the Z axis. - + - Returns BlendShape count on this mesh. + Z axis size multiplier. - + - The bone weights of each vertex. + Script interface for the Size Over Lifetime module. - + - The bounding volume of the mesh. + Enable/disable the Size Over Lifetime module. - + - Vertex colors of the mesh. + Set the size over lifetime on each axis separately. - + - Vertex colors of the mesh. + Curve to control particle size based on lifetime. - + - Returns state of the Read/Write Enabled checkbox when model was imported. + Size multiplier. - + - The normals of the mesh. + Size over lifetime curve for the X axis. - + - The number of submeshes. Every material has a separate triangle list. + X axis size multiplier. - + - The tangents of the mesh. + Size over lifetime curve for the Y axis. - + - An array containing all triangles in the mesh. + Y axis size multiplier. - + - The base texture coordinates of the mesh. + Size over lifetime curve for the Z axis. - + - The second texture coordinate set of the mesh, if present. + Z axis size multiplier. - + - The third texture coordinate set of the mesh, if present. + 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. - + - The fourth texture coordinate set of the mesh, if present. + 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. - + - Returns the number of vertices in the mesh (Read Only). + Script interface for the Sub Emitters module. - + - Returns a copy of the vertex positions or assigns a new vertex positions array. + Sub particle system which spawns at the locations of the birth of the particles from the parent system. - + - Adds a new blend shape frame. + Sub particle system which spawns at the locations of the birth of the particles from the parent system. - 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. + Sub particle system which spawns at the locations of the collision of the particles from the parent system. - - + - Clears all blend shapes from Mesh. + Sub particle system which spawns at the locations of the collision of the particles from the parent system. - + - Combines several meshes into this mesh. + Sub particle system which spawns at the locations of the death of the particles from the parent system. - Descriptions of the meshes to combine. - Should all meshes be combined into a single submesh? - Should the transforms supplied in the CombineInstance array be used or ignored? - + - Creates an empty mesh. + Sub particle system to spawn on death of the parent system's particles. - + - Returns the frame count for a blend shape. + Enable/disable the Sub Emitters module. - The shape index to get frame count from. - + - Retreives deltaVertices, deltaNormals and deltaTangents of a blend shape frame. + The total number of sub-emitters. - 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. + Add a new sub-emitter. - The shape index of the frame. - The frame index to get the weight from. + The sub-emitter to be added. + The event that creates new particles. + The properties of the new particles. - + - Returns index of BlendShape by given name. + 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. + - + - Returns name of BlendShape by given index. + Get the sub-emitter Particle System at the given index. - + The index of the desired sub-emitter. + + The sub-emitter being requested. + - + - Returns the index buffer for the submesh. + 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. + - + - Gets the topology of a submesh. + Remove a sub-emitter from the given index in the array. - + The index from which to remove a sub-emitter. - + - Returns the triangle list for the submesh. + 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. - + - Get the UVs for a given chanel. + Set the Particle System to use as the sub-emitter at the given index. - The UV Channel (zero-indexed). - List of UVs to get for the given index. + The index of the sub-emitter being modified. + The Particle System being used as this sub-emitter. - + - Get the UVs for a given chanel. + Set the type of the sub-emitter at the given index. - The UV Channel (zero-indexed). - List of UVs to get for the given index. + The index of the sub-emitter being modified. + The new spawning type to assign to this sub-emitter. - + - Get the UVs for a given chanel. + Script interface for the Texture Sheet Animation module. - The UV Channel (zero-indexed). - List of UVs to get for the given index. - + - Optimize mesh for frequent updates. + Specifies the animation type. - + - Optimizes the mesh for display. + Specifies how many times the animation will loop during the lifetime of the particle. - + - Recalculate the bounding volume of the mesh from the vertices. + Enable/disable the Texture Sheet Animation module. - + - Recalculates the normals of the mesh from the triangles and vertices. + Flip the U coordinate on particles, causing them to appear mirrored horizontally. - + - Vertex colors of the mesh. + Flip the V coordinate on particles, causing them to appear mirrored vertically. - Per-Vertex Colours. - + - Vertex colors of the mesh. + Curve to control which frame of the texture sheet animation to play. - Per-Vertex Colours. - + - Sets the index buffer for the submesh. + Frame over time mutiplier. - - - - + - Set the normals of the mesh. + Defines the tiling of the texture in the X axis. - Per-vertex normals. - + - Set the tangents of the mesh. + Defines the tiling of the texture in the Y axis. - Per-vertex tangents. - + - Sets the triangle list for the submesh. + Explicitly select which row of the texture sheet is used, when ParticleSystem.TextureSheetAnimationModule.useRandomRow is set to false. - - - - + - Sets the triangle list for the submesh. + Define a random starting frame for the texture sheet animation. - - - - + - Set the UVs for a given chanel. + Starting frame multiplier. - The UV Channel (zero-indexed). - List of UVs to set for the given index. - + - Set the UVs for a given chanel. + Use a random row of the texture sheet for each particle emitted. - The UV Channel (zero-indexed). - List of UVs to set for the given index. - + - Set the UVs for a given chanel. + Choose which UV channels will receive texture animation. - The UV Channel (zero-indexed). - List of UVs to set for the given index. - + - Assigns a new vertex positions array. + Access the particle system trails module. - Per-vertex position. - + - Upload previously done mesh modifications to the graphics API. + The gradient controlling the trail colors during the lifetime of the attached particle. - Frees up system memory copy of mesh data when set to true. - + - A mesh collider allows you to do between meshes and primitives. + The gradient controlling the trail colors over the length of the trail. - + - Use a convex collider from the mesh. + 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. - + - The mesh object used for collision detection. + Enable/disable the Trail module. - + - Uses interpolated normals for sphere collisions instead of flat polygonal normals. + Toggle whether the trail will inherit the particle color as its starting color. - + - A class to access the Mesh of the. + The curve describing the trail lifetime, throughout the lifetime of the particle. - + - Returns the instantiated Mesh assigned to the mesh filter. + Change the lifetime multiplier. - + - Returns the shared mesh of the mesh filter. + Set the minimum distance each trail can travel before a new vertex is added to it. - + - Class used to allow GameObject.AddComponent / GameObject.GetComponent to be used. + Choose what proportion of particles will receive a trail. - + - Renders meshes inserted by the MeshFilter or TextMesh. + Set whether the particle size will act as a multiplier on top of the trail lifetime. - + - Vertex attributes in this mesh will override or add attributes of the primary mesh in the MeshRenderer. + Set whether the particle size will act as a multiplier on top of the trail width. - + - Topology of Mesh faces. + Choose whether the U coordinate of the trail texture is tiled or stretched. - + - Mesh is made from lines. + The curve describing the width, of each trail point. - + - Mesh is a line strip. + Change the width multiplier. - + - Mesh is made from points. + Drop new trail points in world space, regardless of Particle System Simulation Space. - + - Mesh is made from quads. + Script interface for the Trigger module. - + - Mesh is made from triangles. + Enable/disable the Trigger module. - + - Use this class to record to an AudioClip using a connected microphone. + Choose what action to perform when particles enter the trigger volume. - + - A list of available microphone devices, identified by name. + Choose what action to perform when particles leave the trigger volume. - + - Stops recording. + Choose what action to perform when particles are inside the trigger volume. - The name of the device. - + - Get the frequency capabilities of a device. + The maximum number of collision shapes that can be attached to this particle system trigger. - 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. + Choose what action to perform when particles are outside the trigger volume. - The name of the device. - + - Query if a device is currently recording. + A multiplier applied to the size of each particle before overlaps are processed. - The name of the device. - + - Start Recording with device. + Get a collision shape associated with this particle system trigger. - 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. + Which collider to return. - The function returns null if the recording fails to start. + The collider at the given index. - - - MonoBehaviour is the base class every script derives from. - - - + - Logs message to the Unity Console (identical to Debug.Log). + Set a collision shape associated with this particle system trigger. - + Which collider to set. + The collider to associate with this trigger. - + - Disabling this lets you skip the GUI layout phase. + Script interface for the Velocity Over Lifetime module. - + - Cancels all Invoke calls on this MonoBehaviour. + Enable/disable the Velocity Over Lifetime module. - + - Cancels all Invoke calls with name methodName on this behaviour. + Specifies if the velocities are in local space (rotated with the transform) or world space. - - + - Invokes the method methodName in time seconds. + Curve to control particle speed based on lifetime, on the X axis. - - - + - Invokes the method methodName in time seconds, then repeatedly every repeatRate seconds. + X axis speed multiplier. - - - - + - Is any invoke on methodName pending? + Curve to control particle speed based on lifetime, on the Y axis. - - + - Is any invoke pending on this MonoBehaviour? + Y axis speed multiplier. - + - Starts a coroutine. + Curve to control particle speed based on lifetime, on the Z axis. - - + - Starts a coroutine named methodName. + Z axis speed multiplier. - - - + - Starts a coroutine named methodName. + The animation type. - - - + - Stops all coroutines running on this behaviour. + Animate a single row in the sheet from left to right. - + - Stops the first coroutine named methodName, or the coroutine stored in routine running on this behaviour. + Animate over the whole texture sheet from left to right, top to bottom. - Name of coroutine. - Name of the function in code. - + - Stops the first coroutine named methodName, or the coroutine stored in routine running on this behaviour. + Whether to use 2D or 3D colliders for particle collisions. - Name of coroutine. - Name of the function in code. - + - Base class for AnimationClips and BlendTrees. + Use 2D colliders to collide particles against. - + - Movie Textures are textures onto which movies are played back. + Use 3D colliders to collide particles against. - + - Returns the AudioClip belonging to the MovieTexture. + Quality of world collisions. Medium and low quality are approximate and may leak particles. - + - The time, in seconds, that the movie takes to play back completely. + The most accurate world collisions. - + - Returns whether the movie is playing or not. + Fastest and most approximate world collisions. - + - If the movie is downloading from a web site, this returns if enough data has been downloaded so playback should be able to start without interruptions. + Approximate world collisions. - + - Set this to true to make the movie loop. + The type of collisions to use for a given particle system. - + - Pauses playing the movie. + Collide with a list of planes. - + - Starts playing the movie. + Collide with the world geometry. - + - Stops playing the movie, and rewinds it to the beginning. + The particle curve mode (Shuriken). - + - Attribute to make a string be edited with a multi-line textfield. + Use a single constant for the ParticleSystem.MinMaxCurve. - + - Attribute used to make a string value be shown in a multiline textarea. + Use a single curve for the ParticleSystem.MinMaxCurve. - 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. + Use a random value between 2 constants for the ParticleSystem.MinMaxCurve. - How many lines of text to make room for. Default is 3. - + - Singleton class to access the baked NavMesh. + Use a random value between 2 curves for the ParticleSystem.MinMaxCurve. - + - Describes how far in the future the agents predict collisions for avoidance. + Which stream of custom particle data to set. - + - The maximum amount of nodes processed each frame in the asynchronous pathfinding process. + The first stream of custom per-particle data. - + - Area mask constant that includes all NavMesh areas. + The second stream of custom per-particle data. - + - Calculate a path between two points and store the resulting path. + Which mode the Custom Data module uses to generate its data. - 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 triangulation of the current navmesh. + Generate data using ParticleSystem.MinMaxGradient. - + - Locate the closest NavMesh edge from a point on the NavMesh. + Don't generate any data. - 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. - - + - Gets the cost for path finding over geometry of the area type. + Generate data using ParticleSystem.MinMaxCurve. - Index of the area to get. - + - Returns the area index for a named NavMesh area type. + The mode in which particles are emitted. - 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. + Emit when emitter moves. - - + - Returns the layer index for a named layer. + Emit over time. - - + - Trace a line between two points on the NavMesh. + The particle gradient mode (Shuriken). - 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. - - + - Finds the closest point on NavMesh within specified range. + Use a single color for the ParticleSystem.MinMaxGradient. - 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. - - + - Sets the cost for finding path over geometry of the area type on all agents. + Use a single color gradient for the ParticleSystem.MinMaxGradient. - Index of the area to set. - New cost. - + - Sets the cost for traversing over geometry of the layer type on all agents. + Define a list of colors in the ParticleSystem.MinMaxGradient, to be chosen from at random. - - - + - Navigation mesh agent. + Use a random value between 2 colors for the ParticleSystem.MinMaxGradient. - + - The maximum acceleration of an agent as it follows a path, given in units / sec^2. + Use a random value between 2 color gradients for the ParticleSystem.MinMaxGradient. - + - Maximum turning speed in (deg/s) while following a path. + How to apply emitter velocity to particles. - + - Specifies which NavMesh areas are passable. Changing areaMask will make the path stale (see isPathStale). + Each particle's velocity is set to the emitter's current velocity value, every frame. - + - Should the agent brake automatically to avoid overshooting the destination point? + Each particle inherits the emitter's velocity on the frame when it was initially emitted. - + - Should the agent attempt to acquire a new path if the existing path becomes invalid? + The mesh emission type. - + - Should the agent move across OffMeshLinks automatically? + Emit from the edges of the mesh. - + - The avoidance priority level. + Emit from the surface of the mesh. - + - The relative vertical displacement of the owning GameObject. + Emit from the vertices of the mesh. - + - The current OffMeshLinkData. + The quality of the generated noise. - + - The desired velocity of the agent including any potential contribution from avoidance. (Read Only) + High quality 3D noise. - + - Gets or attempts to set the destination of the agent in world-space units. + Low quality 1D noise. - + - Does the agent currently have a path? (Read Only) + Medium quality 2D noise. - + - The height of the agent for purposes of passing under obstacles, etc. + What action to perform when the particle trigger module passes a test. - + - Is the agent currently bound to the navmesh? (Read Only) + Send the OnParticleTrigger command to the particle system's script. - + - Is the agent currently positioned on an OffMeshLink? (Read Only) + Do nothing. - + - Is the current path stale. (Read Only) + Kill all particles that pass this test. - + - The next OffMeshLinkData on the current path. + Renders particles on to the screen (Shuriken). - + - Gets or sets the simulation position of the navmesh agent. + The number of currently active custom vertex streams. - + - The level of quality of avoidance. + Control the direction that particles face. - + - Property to get and set the current path. + How much are the particles stretched depending on the Camera's speed. - + - Is a path in the process of being computed but not yet ready? (Read Only) + How much are the particles stretched in their direction of motion. - + - The status of the current path (complete, partial or invalid). + Clamp the maximum particle size. - + - The avoidance radius for the agent. + Mesh used as particle instead of billboarded texture. - + - The distance between the agent's position and the destination on the current path. (Read Only) + The number of meshes being used for particle rendering. - + - Maximum movement speed when following a path. + Clamp the minimum particle size. - + - Get the current steering target along the path. (Read Only) + How much are billboard particle normals oriented towards the camera. - + - Stop within this distance from the target position. + Modify the pivot point used for rotating particles. - + - Gets or sets whether the transform position is synchronized with the simulated agent position. The default value is true. + How particles are drawn. - + - Should the agent update the transform orientation? + Biases particle system sorting amongst other transparencies. - + - Access the current velocity of the NavMeshAgent component, or set a velocity to control the agent manually. + Sort particles within a system. - + - Specifies which NavMesh layers are passable (bitfield). Changing walkableMask will make the path stale (see isPathStale). + Set the material used by the Trail module for attaching trails to particles. - + - Enables or disables the current off-mesh link. + How much are the particles stretched depending on "how fast they move". - Is the link activated? - + - Calculate a path to a specified point and store the resulting path. + Query whether the particle system renderer uses a particular set of vertex streams. - The final position of the path requested. - The resulting path. + Streams to query. - True if a path is found. + Whether all the queried streams are enabled or not. - + - Completes the movement on the current OffMeshLink. + 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. - + - Locate the closest NavMesh edge. + Enable a set of vertex shader streams on the particle system renderer. - Holds the properties of the resulting location. - - True if a nearest edge is found. - + Streams to enable. - + - Gets the cost for path calculation when crossing area of a particular type. + Query which vertex shader streams are enabled on the ParticleSystemRenderer. - Area Index. - - Current cost for specified area index. - + The array of streams to be populated. - + - Gets the cost for crossing ground of a particular type. + Query whether the particle system renderer uses a particular set of vertex streams. - Layer index. + Streams to query. - Current cost of specified layer. + Returns the subset of the queried streams that are actually enabled. - + - 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. + Set the array of meshes used as particles. - The desired end position of movement. - Properties of the obstacle detected by the ray (if any). + This array will be populated with the list of meshes being used for particle rendering. - True if there is an obstacle between the agent and the target position, otherwise false. + The number of meshes actually written to the destination array. - + - Clears the current path. + Enable a set of vertex shader streams on the ParticleSystemRenderer. + The new array of enabled vertex streams. - + - Resumes the movement along the current path after a pause. + Set an array of meshes used as particles instead of a billboarded texture. + Array of meshes to be used. + Number of elements from the mesh array to be applied. - + - Sample a position along the current path. + Set an array of meshes used as particles instead of a billboarded texture. - 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. - + Array of meshes to be used. + Number of elements from the mesh array to be applied. - + - Sets the cost for traversing over areas of the area type. + The rendering mode for particle systems (Shuriken). - Area cost. - New cost for the specified area index. - + - Sets or updates the destination thus triggering the calculation for a new path. + Render particles as billboards facing the active camera. (Default) - 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. + Render particles as billboards always facing up along the y-Axis. - Layer index. - New cost for the specified layer. - + - Assign a new path to this agent. + Render particles as meshes. - New path to follow. - - True if the path is succesfully assigned. - - + - Stop movement of this agent along its current path. + Do not render particles. - + - Warps agent to the provided position. + Stretch particles in the direction of motion. - New position to warp the agent to. - - True if agent is successfully warped, otherwise false. - - + - Result information for NavMesh queries. + Render particles as billboards always facing the player, but not pitching along the x-Axis. - + - Distance to the point of hit. + How particles are aligned when rendered. - + - Flag set when hit. + Particles face the eye position. - + - Mask specifying NavMesh area at point of hit. + Particles align with their local transform. - + - Normal at the point of hit. + Particles face the camera plane. - + - Position of hit. + Particles align with the world. - + - An obstacle for NavMeshAgents to avoid. + Control how particle systems apply transform scale. - + - Should this obstacle be carved when it is constantly moving? + Scale the particle system using the entire transform hierarchy. - + - Should this obstacle make a cut-out in the navmesh. + Scale the particle system using only its own transform scale. (Ignores parent scale). - + - Threshold distance for updating a moving carved hole (when carving is enabled). + Only apply transform scale to the shape component, which controls where + particles are spawned, but does not affect their size or movement. + - + - Time to wait until obstacle is treated as stationary (when carving and carveOnlyStationary are enabled). + The mode used to generate new points in a shape (Shuriken). - + - The center of the obstacle, measured in the object's local space. + Distribute new particles around the shape evenly. - + - Height of the obstacle's cylinder shape. + Animate the emission point around the shape. - + - Radius of the obstacle's capsule shape. + Animate the emission point around the shape, alternating between clockwise and counter-clockwise directions. - + - Shape of the obstacle. + Generate points randomly. (Default) - + - The size of the obstacle, measured in the object's local space. + The emission shape (Shuriken). - + - Velocity at which the obstacle moves around the NavMesh. + Emit from the volume of a box. - + - Shape of the obstacle. + Emit from the surface of a box. - + - Box shaped obstacle. + Emit from the edges of a box. - + - Capsule shaped obstacle. + Emit from a circle. - + - A path as calculated by the navigation system. + Emit from the edge of a circle. - + - Corner points of the path. (Read Only) + Emit from the base surface of a cone. - + - Status of the path. (Read Only) + Emit from the base surface of a cone. - + - Erase all corner points from path. + Emit from the volume of a cone. - + - NavMeshPath constructor. + Emit from the surface of a cone. - + - Calculate the corners for the path. + Emit from the volume of a half-sphere. - Array to store path corners. - - The number of corners along the path - including start and end points. - - + - Status of path. + Emit from the surface of a half-sphere. - + - The path terminates at the destination. + Emit from a mesh. - + - The path is invalid. + Emit from a mesh renderer. - + - The path cannot reach the destination. + Emit from an edge. - + - Contains data describing a triangulation of a navmesh. + Emit from a skinned mesh renderer. - + - NavMesh area indices for the navmesh triangulation. + Emit from the volume of a sphere. - + - Triangle indices for the navmesh triangulation. + Emit from the surface of a sphere. - + - NavMeshLayer values for the navmesh triangulation. + The space to simulate particles in. - + - Vertices for the navmesh triangulation. + Simulate particles relative to a custom transform component, defined by ParticleSystem.MainModule.customSimulationSpace. - + - The network class is at the heart of the network implementation and provides the core functions. + Simulate particles in local space. - + - All connected players. + Simulate particles in world space. - + - The IP address of the connection tester used in Network.TestConnection. + The sorting mode for particle systems. - + - The port of the connection tester used in Network.TestConnection. + Sort based on distance. - + - Set the password for the server (for incoming connections). + No sorting. - + - Returns true if your peer type is client. + Sort the oldest particles to the front. - + - Enable or disable the processing of network messages. + Sort the youngest particles to the front. - + - Returns true if your peer type is server. + The behavior to apply when calling ParticleSystem.Stop|Stop. - + - Set the log level for network messages (default is Off). + Stops particle system emitting any further particles. All existing particles will remain until they expire. - + - Set the maximum amount of connections/players allowed. + Stops particle system emitting and removes all existing emitted particles. - + - Get or set the minimum number of ViewID numbers in the ViewID pool given to clients by the server. + The properties of sub-emitter particles. - + - The IP address of the NAT punchthrough facilitator. + When spawning new particles, multiply the start color by the color of the parent particles. - + - The port of the NAT punchthrough facilitator. + When spawning new particles, inherit all available properties from the parent particles. - + - The status of the peer type, i.e. if it is disconnected, connecting, server or client. + When spawning new particles, do not inherit any properties from the parent particles. - + - Get the local NetworkPlayer instance. + When spawning new particles, add the start rotation to the rotation of the parent particles. - + - The IP address of the proxy server. + When spawning new particles, multiply the start size by the size of the parent particles. - + - Set the proxy server password. + The events that cause new particles to be spawned. - + - The port of the proxy server. + Spawn new particles when particles from the parent system are born. - + - The default send rate of network updates for all Network Views. + Spawn new particles when particles from the parent system collide with something. - + - Get the current network time (seconds). + Spawn new particles when particles from the parent system die. - + - Indicate if proxy support is needed, in which case traffic is relayed through the proxy server. + Choose how textures are applied to Particle Trails. - + - Query for the next available network view ID number and allocate it (reserve). + Map the texture once along the entire length of the trail, assuming all vertices are evenly spaced. - + - Close the connection to another system. + Repeat the texture along the trail, repeating at a rate of once per trail segment. To adjust the tiling rate, use Material.SetTextureScale. - - - + - Connect to the specified host (ip or domain name) and server port. + Map the texture once along the entire length of the trail. - - - - + - Connect to the specified host (ip or domain name) and server port. + Repeat the texture along the trail. To set the tiling rate, use Material.SetTextureScale. - - - - + - This function is exactly like Network.Connect but can accept an array of IP addresses. + The different types of particle triggers. - - - - + - This function is exactly like Network.Connect but can accept an array of IP addresses. + Trigger when particles enter the collision volume. - - - - + - Connect to a server GUID. NAT punchthrough can only be performed this way. + Trigger when particles leave the collision volume. - - - + - Connect to a server GUID. NAT punchthrough can only be performed this way. + Trigger when particles are inside the collision volume. - - - + - Connect to the host represented by a HostData structure returned by the Master Server. + Trigger when particles are outside the collision volume. - - - + - Connect to the host represented by a HostData structure returned by the Master Server. + All possible particle system vertex shader inputs. - - - + - Destroy the object associated with this view ID across the network. + The normalized age of each particle, from 0 to 1. - - + - Destroy the object across the network. + The amount to blend between animated texture frames, from 0 to 1. - - + - Destroy all the objects based on view IDs belonging to this player. + The current animation frame index of each particle. - - + - Close all open connections and shuts down the network interface. + The center position of the entire particle, in world space. - - + - Close all open connections and shuts down the network interface. + The color of each particle. - - + - The last average ping time to the given player in milliseconds. + One custom value for each particle, defined by the Custom Data Module, or ParticleSystem.SetCustomParticleData. - - + - The last ping time to the given player in milliseconds. + Two custom values for each particle, defined by the Custom Data Module, or ParticleSystem.SetCustomParticleData. - - + - Check if this machine has a public IP address. + Three custom values for each particle, defined by the Custom Data Module, or ParticleSystem.SetCustomParticleData. - + - Initializes security layer. + Four custom values for each particle, defined by the Custom Data Module, or ParticleSystem.SetCustomParticleData. - + - Initialize the server. + One custom value for each particle, defined by the Custom Data Module, or ParticleSystem.SetCustomParticleData. - - - - + - Initialize the server. + Two custom values for each particle, defined by the Custom Data Module, or ParticleSystem.SetCustomParticleData. - - - - + - Network instantiate a prefab. + Three custom values for each particle, defined by the Custom Data Module, or ParticleSystem.SetCustomParticleData. - - - - - + - Remove all RPC functions which belong to this player ID. + Four custom values for each particle, defined by the Custom Data Module, or ParticleSystem.SetCustomParticleData. - - + - Remove all RPC functions which belong to this player ID and were sent based on the given group. + The reciprocal of the starting lifetime, in seconds (1.0f / startLifetime). - - - + - Remove the RPC function calls accociated with this view ID number. + The vertex normal of each particle. - - + - Remove all RPC functions which belong to given group number. + The position of each particle vertex, in world space. - - + - Set the level prefix which will then be prefixed to all network ViewID numbers. + The Z axis rotation of each particle. - - + - Enable or disables the reception of messages in a specific group number from a specific player. + The 3D rotation of each particle. - - - - + - Enables or disables transmission of messages and RPC calls on a specific network group number. + The Z axis rotational speed of each particle. - - - + - Enable or disable transmission of messages and RPC calls based on target network player as well as the network group. + The 3D rotational speed of each particle. - - - - + - Test this machines network connection. + The X axis size of each particle. - - + - Test this machines network connection. + The X and Y axis sizes of each particle. - - + - Test the connection specifically for NAT punch-through connectivity. + The 3D size of each particle. - - + - Test the connection specifically for NAT punch-through connectivity. + The speed of each particle, calculated by taking the magnitude of the velocity. - - + - Possible status messages returned by Network.Connect and in MonoBehaviour.OnFailedToConnect|OnFailedToConnect in case the error was not immediate. + A random number for each particle, which remains constant during their lifetime. - + - Cannot connect to two servers at once. Close the connection before connecting again. + Two random numbers for each particle, which remain constant during their lifetime. - + - We are already connected to this particular server (can happen after fast disconnect/reconnect). + Three random numbers for each particle, which remain constant during their lifetime. - + - We are banned from the system we attempted to connect to (likely temporarily). + Four random numbers for each particle, which remain constant during their lifetime. - + - Connection attempt failed, possibly because of internal connectivity problems. + The tangent vector for each particle (for normal mapping). - + - Internal error while attempting to initialize network interface. Socket possibly already in use. + The first UV stream of each particle. - + - No host target given in Connect. + The second UV stream of each particle. - + - Incorrect parameters given to Connect function. + The third UV stream of each particle (only for meshes). - + - Client could not connect internally to same network NAT enabled server. + The fourth UV stream of each particle (only for meshes). - + - The server is using a password and has refused our connection because we did not set the correct password. + A random number for each particle, which changes during their lifetime. - + - NAT punchthrough attempt has failed. The cause could be a too restrictive NAT implementation on either endpoints. + Two random numbers for each particle, which change during their lifetime. - + - Connection lost while attempting to connect to NAT target. + Three random numbers for each particle, which change during their lifetime. - + - The NAT target we are trying to connect to is not connected to the facilitator server. + Four random numbers for each particle, which change during their lifetime. - + - No error occurred. + The velocity of each particle, in world space. - + - We presented an RSA public key which does not match what the system we connected to is using. + The vertex ID of each particle. - + - The server is at full capacity, failed to connect. + All possible particle system vertex shader inputs. - + - The reason a disconnect event occured, like in MonoBehaviour.OnDisconnectedFromServer|OnDisconnectedFromServer. + A mask with all vertex streams enabled. - + - The connection to the system has been closed. + The center position of each particle, with the vertex ID of each particle, from 0-3, stored in the w component. - + - The connection to the system has been lost, no reliable packets could be delivered. + The color of each particle. - + - Defines parameters of channels. + The first stream of custom data, supplied from script. - + - UnderlyingModel.MemDoc.MemDocModel. + The second stream of custom data, supplied from script. - Requested type of quality of service (default Unreliable). - Copy constructor. - + - UnderlyingModel.MemDoc.MemDocModel. + 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. - Requested type of quality of service (default Unreliable). - Copy constructor. - + - UnderlyingModel.MemDoc.MemDocModel. + A mask with no vertex streams enabled. - Requested type of quality of service (default Unreliable). - Copy constructor. - + - Channel quality of service. + The normal of each particle. - + - This class defines parameters of connection between two peers, this definition includes various timeouts and sizes as well as channel configuration. + The world space position of each particle. - + - How long in ms receiver will wait before it will force send acknowledgements back without waiting any payload. + 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. - Add new channel to configuration. - - Channel id, user can use this id to send message via this channel. - - + - Defines timeout in ms after that message with AllCost deliver qos will force resend without acknowledgement waiting. + The size of each particle. - + - Return amount of channels for current configuration. + Tangent vectors for normal mapping. - + - Allow access to channels list. + The texture coordinates of each particle. - + - Timeout in ms which library will wait before it will send another connection request. + 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. - + - Will create default connection config or will copy them from another. + The 3D velocity of each particle. - Connection config. - + - Will create default connection config or will copy them from another. + Physics material describes how to handle colliding objects (friction, bounciness). - Connection config. - + - How long (in ms) library will wait before it will consider connection as disconnected. + Determines how the bounciness is combined. - + - What should be maximum fragment size (in Bytes) for fragmented messages. + How bouncy is the surface? A value of 0 will not bounce. A value of 1 will bounce without any loss of energy. - + - Return the QoS set for the given channel or throw an out of range exception. + The friction used when already moving. This value has to be between 0 and 1. - Index in array. - - Channel QoS. - - + - If it is true, connection will use 64 bit mask to acknowledge received reliable messages. + If anisotropic friction is enabled, dynamicFriction2 will be applied along frictionDirection2. - + - Maximum amount of small reliable messages which will combine in one "array of messages". Useful if you are going to send a lot of small reliable messages. + Determines how the friction is combined. - + - Maximum size of reliable message which library will consider as small and will try to combine in one "array of messages" message. + The direction of anisotropy. Anisotropic friction is enabled if the vector is not zero. - + - How many attempt library will get before it will consider the connection as disconnected. + The friction coefficient used when an object is lying on a surface. - + - Defines maximum messages which will wait for sending before user will receive error on Send() call. + If anisotropic friction is enabled, staticFriction2 will be applied along frictionDirection2. - + - Minimal send update timeout (in ms) for connection. this timeout could be increased by library if flow control will required. + Creates a new material. - + - How many (in %) packet need to be dropped due network condition before library will throttle send rate. + Creates a new material named name. + - + - How many (in %) packet need to be dropped due lack of internal bufferes before library will throttle send rate. + Describes how physic materials of colliding objects are combined. - + - What is a maximum packet size (in Bytes) (including payload and all header). Packet can contain multiple messages inside. + Averages the friction/bounce of the two colliding materials. - + - Timeout in ms between control protocol messages. + Uses the larger friction/bounce of the two colliding materials. - + - Timeout in ms for control messages which library will use before it will accumulate statistics. + Uses the smaller friction/bounce of the two colliding materials. - + - Minimum timeout (in ms) which library will wait before it will resend reliable message. + Multiplies the friction/bounce of the two colliding materials. - + - When starting a server use protocols that make use of platform specific optimisations where appropriate rather than cross-platform protocols. (Sony consoles only). + Global physics properties and helper methods. - + - Validate parameters of connection config. Will throw exceptions if parameters are incorrect. + Two colliding objects with a relative velocity below this will not bounce (default 2). Must be positive. - - + - Create configuration for network simulator; You can use this class in editor and developer build only. + The default contact offset of the newly created colliders. - + - Will create object describing network simulation parameters. + The defaultSolverIterations determines how accurately Rigidbody joints and collision contacts are resolved. (default 6). Must be positive. - 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. + The defaultSolverVelocityIterations affects how accurately the Rigidbody joints and collision contacts are resolved. (default 1). Must be positive. - + - Defines global paramters for network library. + The gravity applied to all rigid bodies in the scene. - + - Create new global config object. + The default maximum angular velocity permitted for any rigid bodies (default 7). Must be positive. - + - Defines maximum possible packet size in bytes for all network connections. + The minimum contact penetration value in order to apply a penalty force (default 0.05). Must be positive. - + - Defines maximum amount of messages in the receive queue. + Whether physics queries should hit back-face triangles. - + - Defines maximum message count in sent queue. + Specifies whether queries (raycasts, spherecasts, overlap tests, etc.) hit Triggers by default. - + - Defines reactor model for the network library. + The default angular velocity, below which objects start sleeping (default 0.14). Must be positive. - + - 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. + The mass-normalized energy threshold, below which objects start going to sleep. - + - 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). + The default linear velocity, below which objects start going to sleep (default 0.15). Must be positive. - + - 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. + Layer mask constant to select all layers. - Connection config for special connection. - - Id of this connection, user should use this id when he calls Networking.NetworkTransport.Connect. - - + - Create topology. + Casts the box along a ray and returns detailed information on what was hit. - Default config. - Maximum default connections. + 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. + - + - Defines config for default connections in the topology. + 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. + - + - Return reference to special connection config. Parameters of this config can be changed. + Like Physics.BoxCast, but returns all hits. - Config id. + 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. - Connection config. + All colliders that were hit. - + - Defines how many connection with default config be permitted. + 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. + - + - Library keep and reuse internal pools of messages. By default they have size 128. If this value is not enough pools will be automatically increased. This value defines how they will increase. Default value is 0.75, so if original pool size was 128, the new pool size will be 128 * 1.75 = 224. + 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. + - + - What is the size of received messages pool (default 128 bytes). + + 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. - + - Defines size of sent message pool (default value 128). + 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. + - + - List of special connection configs. + 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. + - + - Returns count of special connection added to topology. + 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. + - + - JSON response for types that only require a basic indication of success. + 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. - + - Constructor for response class. + 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. - + - JSON object to request a UNET match creation. + 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. + - + - Bool to describe if the created match should be advertised. + 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. + - + - The optional game defined Elo score for the client making the request. The Elo score is averaged against all clients in a match and that value is used to produce better search results when listing available matches. -If the Elo is provided the result set will be ordered according to the magnitude of the absoloute value of the difference of the a client searching for a match and the network average for all clients in each match. If the Elo score is not provided (and therefore 0 for all matches) the Elo score will not affect the search results. -Each game can calculate this value as they wish according to whatever scale is best for that game. + Layer mask constant to select default raycast layers. - + - Match attributes describing game specific features for this match. Each attribute is a key/value pair of a string key with a long value. Each match may have up to 10 of these values. -The game is free to use this as desired to assist in finding better match results when clients search for matches to join. + Are collisions between layer1 and layer2 being ignored? + + - + - Name of the match to create. + Makes the collision detection system ignore all collisions between collider1 and collider2. + + + - + - Password for the match to create. Leave blank for no password. Cannot be null. + 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. + + + - + - The (optional) private network address for the client making the request. This is the local network available private address another client on the same network could use to connect directly to the client making the request and may be used to better connect multiple clients. If it is not supplied the networking layer will still be completely functional. + Layer mask constant to select ignore raycast layer. - + - The (optional) public network address for the client making the request. This is the internet available public address another client on the internet (but not the local network) could use to connect directly to the client making the request and may be used to better connect multiple clients. If it is not supplied the networking layer will still be completely functional. + 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. - + - Max number of clients that may join the match to create, including the host. + 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). - + - Class constructor. + 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. + - + - Accessor to verify if the contained data is a valid request with respect to initialized variables and accepted parameters. + 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. + - + - Provides string description of current class data. + 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. + - + - JSON response for a CreateMatchRequest. It contains all information necessdary to continue joining a match. + 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. + - + - JSON encoding for the binary access token this client uses to authenticate its session for future commands. + 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. - + - Network address to connect to in order to join the match. + 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. + - + - The network id for the match created. + 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. + - + - NodeId for the requesting client in the created match. + 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. + - + - Network port to connect to in order to join the match. + 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. + - + - If the match is hosted by a relay server. + 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. + - + - Constructor for response class. + 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. - + - Provides string description of current class data. + 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. - + - JSON object to join an ongoing match or to create a new one if it doesn't exist. + 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. + - + - Constructor for CreateOrJoinMatchRequest class. + 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. + - + - JSON object to request a UNET match destruction. + 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. + - + - NetworkID of the match to destroy. + 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. + - + - Class constructor. + + 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. - + - Accessor to verify if the contained data is a valid request with respect to initialized variables and accepted parameters. + 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. + - + - Provides string description of current class data. + 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. - + - JSON object to request a UNET match drop a client. + 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. + - + - NetworkID of the match the client to drop is in. + 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. + - + - NodeID of the connection to drop. + Global settings and helpers for 2D physics. - + - Class constructor. + Should the collider gizmos always be shown even when they are not selected? - + - Accessor to verify if the contained data is a valid request with respect to initialized variables and accepted parameters. + A rigid-body cannot sleep if its angular velocity is above this tolerance. - + - Provides string description of current class data. + The scale factor that controls how fast overlaps are resolved. - + - Response Interface class to define necessary interfaces on a server Response. + The scale factor that controls how fast TOI overlaps are resolved. - + - JSON object to request joining an existing UNET match. + Use this to control whether or not the appropriate OnCollisionExit2D or OnTriggerExit2D callbacks should be called when a Collider2D is disabled. - + - The optional game defined Elo score for the client making the request. The Elo score is averaged against all clients in a match and that value is used to produce better search results when listing available matches. -If the Elo is provided the result set will be ordered according to the magnitude of the absoloute value of the difference of the a client searching for a match and the network average for all clients in each match. If the Elo score is not provided (and therefore 0 for all matches) the Elo score will not affect the search results. -Each game can calculate this value as they wish according to whatever scale is best for that game. + Whether or not to stop reporting collision callbacks immediately if any of the objects involved in the collision are deleted/moved. - + - NetworkID of the match to join. + Sets the color used by the gizmos to show all Collider axis-aligned bounding boxes (AABBs). - + - Password for the match to join. Leave blank for no password. Cannot be null. + The color used by the gizmos to show all asleep colliders (collider is asleep when the body is asleep). - + - The (optional) private network address for the client making the request. This is the local network available private address another client on the same network could use to connect directly to the client making the request and may be used to better connect multiple clients. If it is not supplied the networking layer will still be completely functional. + The color used by the gizmos to show all awake colliders (collider is awake when the body is awake). - + - The (optional) public network address for the client making the request. This is the internet available public address another client on the internet (but not the local network) could use to connect directly to the client making the request and may be used to better connect multiple clients. If it is not supplied the networking layer will still be completely functional. + The color used by the gizmos to show all collider contacts. - + - Class constructor. + The scale of the contact arrow used by the collider gizmos. - + - Accessor to verify if the contained data is a valid request with respect to initialized variables and accepted parameters. + The default contact offset of the newly created colliders. - + - Provides string description of current class data. + Ets the collision callbacks to stop or continue processing if any of the objects involved in the collision are deleted. - + - JSON response for a JoinMatchRequest. It contains all information necessdary to continue joining a match. + Acceleration due to gravity. - + - JSON encoding for the binary access token this client uses to authenticate its session for future commands. + A rigid-body cannot sleep if its linear velocity is above this tolerance. - + - Network address to connect to in order to join the match. + The maximum angular position correction used when solving constraints. This helps to prevent overshoot. - + - NetworkID of the match. + The maximum linear position correction used when solving constraints. This helps to prevent overshoot. - + - NodeID for the requesting client in the mach that it is joining. + The maximum angular speed of a rigid-body per physics update. Increasing this can cause numerical problems. - + - Network port to connect to in order to join the match. + The maximum linear speed of a rigid-body per physics update. Increasing this can cause numerical problems. - + - If the match is hosted by a relay server. + This property is obsolete. You should use defaultContactOffset instead. - + - Constructor for response class. + The number of iterations of the physics solver when considering objects' positions. - + - Provides string description of current class data. + Do raycasts detect Colliders configured as triggers? - + - JSON object to request a list of UNET matches. This list is page based with a 1 index. + Sets the raycasts or linecasts that start inside Colliders to detect or not detect those Colliders. - + - The optional game defined Elo score for the client making the request. The Elo score is averaged against all clients in a match and that value is used to produce better search results when listing available matches. -If the Elo is provided the result set will be ordered according to the magnitude of the absoloute value of the difference of the a client searching for a match and the network average for all clients in each match. If the Elo score is not provided (and therefore 0 for all matches) the Elo score will not affect the search results. -Each game can calculate this value as they wish according to whatever scale is best for that game. + Sets the raycasts to either detect or not detect Triggers. - + - Only return matches that have a password if this is true, only return matches without a password if this is false. + Do ray/line casts that start inside a collider(s) detect those collider(s)? - + - List of match attributes to filter against. This will filter down to matches that both have a name that contains the entire text string provided and the value specified in the filter is equal to the attribute value for the matching name. -No additional wildcards are allowed in the name. A maximum of 10 filters can be specified between all 3 filter lists. + Should the collider gizmos show the AABBs for each collider? - + - List of match attributes to filter against. This will filter down to matches that both have a name that contains the entire text string provided and the value specified in the filter is greater than the attribute value for the matching name. -No additional wildcards are allowed in the name. A maximum of 10 filters can be specified between all 3 filter lists. + Should the collider gizmos show current contacts for each collider? - + - List of match attributes to filter against. This will filter down to matches that both have a name that contains the entire text string provided and the value specified in the filter is less than the attribute value for the matching name. -No additional wildcards are allowed in the name. A maximum of 10 filters can be specified between all 3 filter lists. + Should the collider gizmos show the sleep-state for each collider? - + - Name filter to apply to the match list. + The time in seconds that a rigid-body must be still before it will go to sleep. - + - 1 based page number requested. + The number of iterations of the physics solver when considering objects' velocities. - + - Number of results per page to be returned. + Any collisions with a relative linear velocity below this threshold will be treated as inelastic. - + - Class constructor. + Layer mask constant that includes all layers. - + - Accessor to verify if the contained data is a valid request with respect to initialized variables and accepted parameters. + 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. + - + - Provides string description of current class data. + 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 or depth buffer, or normal angle. + + Returns the number of results placed in the results array. + - + - JSON response for a ListMatchRequest. It contains a list of matches that can be parsed through to describe a page of matches. + 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. + - + - List of matches fitting the requested description. + 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. + - + - Constructor for response class. + Casts a capsule against colliders in the scene, returning the first collider to contact with it. - A list of matches to give to the object. Only used when generating a new response and not used by callers of a ListMatchRequest. - + 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. + - + - Constructor for response class. + Casts a capsule against the colliders in the Scene and returns all colliders that are in contact with it. - A list of matches to give to the object. Only used when generating a new response and not used by callers of a ListMatchRequest. - + 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 or depth buffer, 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. + - + - Provides string description of current class data. + 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. + - + - A member contained in a ListMatchResponse.matches list. Each element describes an individual match. + 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. + - + - The optional game defined Elo score for the match as a whole. The Elo score is averaged against all clients in a match and that value is used to produce better search results when listing available matches. -If the Elo is provided the result set will be ordered according to the magnitude of the absoloute value of the difference of the a client searching for a match and the network average for all clients in each match. If the Elo score is not provided (and therefore 0 for all matches) the Elo score will not affect the search results. -Each game can calculate this value as they wish according to whatever scale is best for that game. + 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. + - + - Current number of users connected to a match. + 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 or depth buffer, 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. + - + - Direct connection info for network games; This is not required for games utilizing matchmaker. + 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. + - + - The NodeID of the host in a matchmaker match. + 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. + - + - Describes if this match is considered private. + Layer mask constant that includes all layers participating in raycasts by default. - + - Match attributes describing game specific features for this match. Each attribute is a key/value pair of a string key with a long value. Each match may have up to 10 of these values. -The game is free to use this as desired to assist in finding better match results when clients search for matches to join. + 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. + - + - Max number of users that may connect to a match. + 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. + - + - Name of the match. + 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. + - + - NetworkID of the match. + 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. + - + - Provides string description of current class data. + 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. + - + - Class describing a client in a network match. + 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. + - + - NodeID of the client described in this direct connect info. + 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. + - + - Private address the client described by this class provided. + 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. + - + - Public address the client described by this class provided. + 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. + - + - Details about a UNET Matchmaker match. + 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. + - + - The binary access token this client uses to authenticate its session for future commands. + 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. + - + - IP address of the host of the match,. + 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. + - + - The unique ID of this match. + 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. + - + - NodeID for this member client in the match. + 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. + - + - Port of the host of the match. + 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. + - + - Flag to say if the math uses a relay server. + 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. - + - A component for communicating with the UNET Matchmaking service. + 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? - + - The base URI of the UNET MatchMaker that this NetworkMatch will communicate with. + Layer mask constant for the default layer that ignores raycasts. - + - A match accessor to create a new match hosted on this client. + Checks whether the passed colliders are in contact or not. - A CreateMatchRequest describing the match to create. - A callback delegate that takes a CreateMatchResponse that indicates the return of the request after coroutine processing. - Name of match to create. - Maximum number of users in the match. - Flag to advertise this match in searches. - Password required to enter the match. + The collider to check if it is touching collider2. + The collider to check if it is touching collider1. - A coroutine for managing the async operation. if using the callback, this can be ignored. + Whether collider1 is touching collider2 or not. - + - A match accessor to create a new match hosted on this client. + Checks whether the passed colliders are in contact or not. - A CreateMatchRequest describing the match to create. - A callback delegate that takes a CreateMatchResponse that indicates the return of the request after coroutine processing. - Name of match to create. - Maximum number of users in the match. - Flag to advertise this match in searches. - Password required to enter the match. + 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. - A coroutine for managing the async operation. if using the callback, this can be ignored. + Whether the collider is touching any other collider filtered by the contactFilter or not. - + - Destroy a match (that this client owns) on the UNET Matchmaker. + Checks whether the passed colliders are in contact or not. - A callback delegate that takes a BasicResponse that indicates the return of the request after coroutine processing. - A CreateMatchRequest describing the match to destroy. - Id of the match to destroy. + 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. - A coroutine for managing the async operation. if using the callback, this can be ignored. + Whether collider1 is touching collider2 or not. - + - Destroy a match (that this client owns) on the UNET Matchmaker. + Checks whether the collider is touching any colliders on the specified layerMask or not. - A callback delegate that takes a BasicResponse that indicates the return of the request after coroutine processing. - A CreateMatchRequest describing the match to destroy. - Id of the match to destroy. + The collider to check if it is touching colliders on the layerMask. + Any colliders on any of these layers count as touching. - A coroutine for managing the async operation. if using the callback, this can be ignored. + Whether the collider is touching any colliders on the specified layerMask or not. - + - This causes a client to be dropped from a UNET Matchmaker match. + Casts a line segment against colliders in the Scene. - A callback delegate that takes a BasicResponse that indicates the return of the request after coroutine processing. - A DropConnectionRequest describing the match to destroy. - Id of the match to drop from. - NodeId of the client to drop. + 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. - A coroutine for managing the async operation. if using the callback, this can be ignored. + The cast results returned. - + - This causes a client to be dropped from a UNET Matchmaker match. + Casts a line segment against colliders in the Scene with results filtered by ContactFilter2D. - A callback delegate that takes a BasicResponse that indicates the return of the request after coroutine processing. - A DropConnectionRequest describing the match to destroy. - Id of the match to drop from. - NodeId of the client to drop. + 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 or depth buffer, or normal angle. - A coroutine for managing the async operation. if using the callback, this can be ignored. + Returns the number of results placed in the results array. - + - Join a match on the UNET Matchmaker. + Casts a line against colliders in the scene. - A callback delegate that takes a JoinMatchResponse that indicates the return of the request after coroutine processing. - A JoinMatchRequest describing the match to destroy. - Id of the match to join. - Password to join with. + 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. - A coroutine for managing the async operation. if using the callback, this can be ignored. + The cast results returned. - + - Join a match on the UNET Matchmaker. + Casts a line against colliders in the scene. - A callback delegate that takes a JoinMatchResponse that indicates the return of the request after coroutine processing. - A JoinMatchRequest describing the match to destroy. - Id of the match to join. - Password to join with. + 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. - A coroutine for managing the async operation. if using the callback, this can be ignored. + Returns the number of results placed in the results array. - + - This requests a list of the active matches from a UNET MatchMaker. + Checks if a collider falls within a rectangular area. - A callback delegate that takes a JoinMatchResponse that indicates the return of the request after coroutine processing. - A ListMatchRequest describing the match to destroy. - First page of results. - Number of matches in each page. - String to filter names on. + 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. - A coroutine for managing the async operation. if using the callback, this can be ignored. + The collider overlapping the area. - + - This requests a list of the active matches from a UNET MatchMaker. + Checks if a collider falls within a rectangular area. - A callback delegate that takes a JoinMatchResponse that indicates the return of the request after coroutine processing. - A ListMatchRequest describing the match to destroy. - First page of results. - Number of matches in each page. - String to filter names on. + 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, and Z or depth buffer. Note that normal angle is not used for overlap testing. - A coroutine for managing the async operation. if using the callback, this can be ignored. + Returns the number of results placed in the results array. - - - Delegate for responses from matchmaker. - - - - - - Set this before calling any UNET functions. Must match AppID for this program from the Cloud API. - - AppID that corresponds to the Cloud API AppID for this app. - - - - Abstract base for requests, which includes common info in all requests. - - - - - The JSON encoded binary access token this client uses to authenticate its session for future commands. - - - + - AppID for the current game, required in every request. This is generated from the Cloud API. + 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. + - + - Domain for the request. All commands will be sandboxed to their own domain; For example no clients with domain 1 will see matches with domain 2. This can be used to prevent incompatible client versions from communicating. + 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. + - + - The Cloud Project Id for this game, required in every request. This is used to match games of the same type. + 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. + - + - SourceID for the current client, required in every request. This is generated from the Cloud API. + 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, and Z or depth buffer. 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. + - + - Matchmaker protocol version info. + 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. + - + - Accessor to verify if the contained data is a valid request with respect to initialized variables and accepted parameters. + 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. + - + - Provides string description of current class data. + 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. + - + - Abstract class that contains shared accessors for any response. + 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, and Z or depth buffer. 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. + - + - Extended string information that is returned when the server encounters an error processing a request. + 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. + - + - Bool describing if the request was successful. + 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. + - + - Provides string description of current class data. + 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. + - + - A response object base. + 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, and Z or depth buffer. 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. + - + - Possible transport layer erors. + 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. + - + - Obsolete. + 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. + - + - Two ends of connection have different agreement about channels, channels qos and network parameters. + 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. + - + - The address supplied to connect to was invalid or could not be resolved. + 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. + - + - Sending message too long to fit internal buffers, or user doesn't present buffer with length enouf to contain receiving message. + 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, and Z or depth buffer. 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. + - + - No internal resources ro acomplish request. + 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. + - + - Everything good so far. + 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. + - + - Timeout happened. + 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. + - + - Different version of protocol on ends of connection. + 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 or depth buffer, 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. + - + - Channel doesn't exist. + 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. + - + - Connection doesn't exist. + 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. + - + - Host doesn't exist. + 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. - + - Operation is not supported. + Asset type that defines the surface properties of a Collider2D. - + - Type of events returned from Receive() function. + The degree of elasticity during collisions. - + - Broadcast discovery event received. To obtain sender connection info and possible complimentary message from him call GetBroadcastConnectionInfo() and GetBroadcastConnectionMessage() functions. + Coefficient of friction. - + - New connection has been connected. + A base type for 2D physics components that required a callback during FixedUpdate. - + - New data come in. + Ping any given IP address (given in dot notation). - + - Connection has been disconnected. + The IP target of the ping. - + - Nothing happened. + Has the ping function completed? - + - Low level (transport layer) API. + This property contains the ping time result after isDone returns true. - + - Will create a host (open socket) with given topology and optionally port and IP. + Perform a ping to the supplied target IP address. - The host topology for this host. - Bind to specific port, if 0 is selected the port will chosen by OS. - Bind to specific IP address. - - Returns host ID just created. - + - + - Create a host (open socket) and configure them to simulate internet latency (works on editor and development build only). + Representation of a plane in 3D space. - The host topology for this host. - Minimum simulated delay. - Maximum simulated delay. - Bind to specific port, if 0 is selected the port will chosen by OS. - Bind to specific IP address. - - Returns host ID just created. - - + - Created web socket host. -This function is supported only for Editor (Win, Linux, Mac) and StandalonePlayers (Win, Linux, Mac) -Topology is used to define how many client can connect, and how many messages should be preallocated in send and receive pool, all other parameters are ignored. + Distance from the origin to the plane. - Listening tcp port. - Topology. - - - Web socket host id. - - + - Try to establish connection to other peer. + Normal vector of the plane. - Host (actually socket) id for this connection. - Ip4 address. - Port. - 0 in the case of a default connection. - Possible error, kOK if it is good. - - ConnectionId on success (otherwise zero). - - + - Create dedicated connection to relay server. + Creates a plane. - Id of udp socket used to establish connection. - Ip4. - Port. - Guid of relay network. - Guid of user. - Possible error (<a href="Networking.NetworkError.html>NetworkError</a>.Ok if success). - Slot id for this user. + + - + - Try to establish connection to other peer, where the peer is specified using a C# System.EndPoint. + Creates a plane. - Host (actually socket) id for this connection. - Return kOk on success, otherwise a one-byte error code. - A valid System.EndPoint. - 0 in the case of a default connection. - - - ConnectionId on success (otherwise zero). - + + - + - Create connection to other peer in the relay group. + Creates a plane. - Id of udp socket used to establish connection. - IP. - Port. - Id of exception, default in case 0. - Id of remote peer in relay. - Guid of relay network. - Guid of user who want to establish connect (serve as tmp password). - Possible error. - Slot id reserved for user. - 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). - - ConnectionId on success (otherwise zero). - + + + - + - Create connection to other peer in the relay group. + Returns a signed distance from plane to point. - Id of udp socket used to establish connection. - IP. - Port. - Id of exception, default in case 0. - Id of remote peer in relay. - Guid of relay network. - Guid of user who want to establish connect (serve as tmp password). - Possible error. - Slot id reserved for user. - 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). - - ConnectionId on success (otherwise zero). - + - + - Connect with simulated latency. + Is a point on the positive side of the plane? - Host id. - Peer ip. - Peer port. - Special connection id or 0 for default. - Returned error. - Simulation configuration definec latency for this connection. - - ConnectionId on success (otherwise zero). - + - + - Send disconnect signal to peer and close connection. user should call Receive() to be notified that connection is closed. This signal will send only once (best effort delivery) iif this packet will dropped by some reason, peer will close connection by timeout. + Intersects a ray with the plane. - Id of udp socket used to establish connection. - Id of closing connection. - kOK if it was successful. + + - + - Aplyed only for client which has been already owner of the same group of relay server. it will disconnect this owner from the group, group will be distracted or (if it supported) one of the member of this group should became new owner (owner migration). + Are two points on the same side of the plane? - Id of udp socket used to. - kOk in case success. + + - + - Function will finalize sending message to group of connection. (only one multicast message per time is allowed for host). + 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. - Id of udp socket used to establish connection. - Possible error (kOK in case success). + First point in clockwise order. + Second point in clockwise order. + Third point in clockwise order. - + - The UNet spawning system uses assetIds to identify how spawn remote objects. This function allows you to get the assetId for the prefab associated with an object. + Sets a plane using a point that lies within it along with a normal to orient it. - Target game object to get asset Id for. - - The assetId of the game object's prefab. - + The plane's normal vector. + A point that lies on the plane. - + - If Receive() function returns BroadcastEvent, immedeately this function will return connection info of broadcast sender. This info can be used for connection to broadcast sender. + Applies "platform" behaviour such as one-way collisions etc. - Id of broadcast receiver (returns with Receve() function). - Ip address of broadcast sender. - Port of broadcast sender. - Possible error. - + - If Receive() function returns BroadcastEvent, immedeately this function will return complimentary message of broadcast sender. + Whether to use one-way collision behaviour or not. - Id of broadcast receiver (returns with Receve() function). - Message buffer provided by caller. - Buffer size. - Received size (if received size > bufferSize, corresponding error will be set). - Possible error. - + - Return connection parameters of connected connection, this parameters can be sent to other user which can establish direct connection to this peer. If peer connected via relay, relay related parameters will be not invalid. + The rotational offset angle from the local 'up'. - Id of udp socket used to. - Id of connection. - Ip4. - Port. - Relay network guid. - Possible error. - Destination slot id. - + - Return value of messages waiting for reading. + The angle variance centered on the sides of the platform. Zero angle only matches sides 90-degree to the platform "top". - + - Return total message amount waiting for sending. + 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. - + - Return round trip time for connection. + Whether bounce should be used on the platform sides or not. - Id of udp socket used to. - Id of connection. - Possible error. - + - Function returns time spent on network io operations in micro seconds. + Whether friction should be used on the platform sides or not. - - Time in micro seconds. - - + - Return total number of packets has been lost from start. + The angle of an arc that defines the surface of the platform centered of the local 'up' of the effector. - Id of udp socket used to. - Id of connection. - Possible error. - + - Get UNET timestamp which can be added to message for further definitions of packet delaying. + Should the one-way collision behaviour be used? - + - Return current receive rate in bytes per sec. + Ensures that all contacts controlled by the one-way behaviour act the same. - Id of udp socket used to. - Id of connection. - Possible error. - + - Reurn outgoing rate in bytes per second. + Should bounce be used on the platform sides? - Id of udp socket used to. - Connection id. - Possible error. - + - Return time delay for timestamp received from message (previously created by GetNetworkTimestamp()). + Should friction be used on the platform sides? - Id of udp socket used to. - Id of connection. - Timestamp delivered from peer. - Possible error. - + - Obsolete will be removed. Use GetNetworkLostPacketNum() instead. + Stores and accesses player preferences between game sessions. - Id of udp socket used to. - Id of connection. - Possible error. - + - First function which should be called before any other NetworkTransport function. + Removes all keys and values from the preferences. Use with caution. - + - Check if broadcastdiscovery sender works. + Removes key and its corresponding value from the preferences. - - True if it works. - + - + - Obsolete, will be removed. + Returns the value corresponding to key in the preference file if it exists. + + - + - Delivered different network events to user. kConnectionEvent will notify about new connection established, kDisconnectEvent will report about disconnection happened, kDataEvent will report about new information delivered. Use must represent buffer for delivered data. + Returns the value corresponding to key in the preference file if it exists. - Id of udp socket where event happened. - Connection id for event. - Channel id for data event. - Prepared incoming buffer. - Prepared buffer size. - Actually received length. - Possible error. + + - + - Similar to Receive() but will ask only provided host. It for example allows to mix server/client in the same game. + Returns the value corresponding to key in the preference file if it exists. - Id of udp socket used to check for event. - Connection id for event. - Channel id for data event. - Prepared incoming buffer. - Prepared buffer size. - Actually received length. - Possible error. + + - + - Function delivered relay group event for group owner. + Returns the value corresponding to key in the preference file if it exists. - Id of udp socket used to check for event. - Possible error. + + - + - Close opened socket, close all connection belonging this socket. + Returns the value corresponding to key in the preference file if it exists. - If of opened udp socket. + + - + - Send data to peer. + Returns the value corresponding to key in the preference file if it exists. - Id of udp socket using for send. - Id of connection. - If for channel. - Binary buffer containing data for sending. - Buffer size. - Possible error. + + - + - Function adds another connection to multy peer sends. + Returns true if key exists in the preferences. - Id of udp socket used for sending. - Connection id. - Possible error. + - + - Set credentials for received broadcast message. If one of credentials is wrong, received brodcast discovery message will drop. + Writes all modified preferences to disk. - Id of the host whihc will receive broadcast discovery message. - Credential. - Credential. - Credential. - Possible error. - + - Used to inform the profiler of network packet statistics. + Sets the value of the preference identified by key. - The Id of the message being reported. - Number of message being reported. - Number of bytes used by reported messages. + + - + - Shutdown the transport layer, after calling this function no any other function can be called. + Sets the value of the preference identified by key. + + - + - Function starts send broadcasting message in all local subnets. + Sets the value of the preference identified by key. - Host id which should be reported via broadcast (broadcast receivers will connect to this host). - Port using for broadcast message (usuall port of broadcast receivers). - Part of credentials, if key of receiver will not be equal to key of sender broadcast message will drop. - Part of credentials. - Part of credentials. - Complimentary message. This message will delivered to receiver with Broadcast event. - Size of message. - How often broadcast message shoule be sent (ms). - Error. - - Return true if broadcasting request has been submitted. - + + - + - Start process sending message per group of connected connection. + An exception thrown by the PlayerPrefs class in a web player build. - Id of udp socket used to establish connection. - First connection id from group connection. - Data buffer. - Data buffer length. - Possible error. - + - Stop sending broadcast discovery message. + Used by Animation.Play function. - + - Descibed allowed types of quality of service for channels. + Will stop all animations that were started with this component before playing. - + - Reliable message will resend almost with each frame, without waiting delivery notification. usefull for important urgent short messages, like a shoot. + Will stop all animations that were started in the same layer. This is the default when playing animations. - + - Channel will be configured as relaiable, each message sent in this channel will be delivered or connection will be disconnected. + Applies forces to attract/repulse against a point. - + - Same as reliable, but big messages are allowed (up to 32 fragment with fragmentsize each for message). + The angular drag to apply to rigid-bodies. - + - The same as reliable, but with granting message order. + The scale applied to the calculated distance between source and target. - + - The same as StateUpdate, but reliable. + The linear drag to apply to rigid-bodies. - + - Unreliable, only last message in send buffer will be sent, only most recent message in reading buffer will be delivered. + The magnitude of the force to be applied. - + - Just sending message, no grants. + The mode used to apply the effector force. - + - The same as unreliable, but big message (up to 32 fragment per message) can be sent. + The source which is used to calculate the centroid point of the effector. The distance from the target is defined from this point. - + - The same as unrelaible but all unorder messages will be dropped. Example: VoIP. + The target for where the effector applies any force. - + - Define how unet will handle network io operation. + The variation of the magnitude of the force to be applied. - + - 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. + Collider for 2D physics representing an arbitrary polygon defined by its vertices. - + - 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). + Determines whether the PolygonCollider2D's shape is automatically updated based on a SpriteRenderer's tiling properties. - + - The AppID identifies the application on the Unity Cloud or UNET servers. + The number of paths in the polygon. - + - Invalid AppID. + Corner points that define the collider's shape in local space. - + - Describes the access levels granted to this client. + 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. - + - Administration access level, generally describing clearence to perform game altering actions against anyone inside a particular match. + 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. + - + - Invalid access level, signifying no access level has been granted/specified. + Return the total number of points in the polygon in all paths. - + - Access level Owner, generally granting access for operations key to the peer host server performing it's work. + Define a path by its constituent points. + Index of the path to set. + Points that define the path. - + - User access level. This means you can do operations which affect yourself only, like disconnect yourself from the match. + Prefer ScriptableObject derived type to use binary serialization regardless of project's asset serialization mode. - + - Access token used to authenticate a client session for the purposes of allowing or disallowing match operations requested by that client. + The various primitives that can be created using the GameObject.CreatePrimitive function. - + - Binary field for the actual token. + A capsule primitive. - + - Accessor to get an encoded string from the m_array data. + A cube primitive. - + - 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). + A cylinder primitive. - + - Network ID, used for match making. + A plane primitive. - + - Invalid NetworkID. + A Quad primitive. - + - The NodeID is the ID used in relay matches to track nodes in a network. + A sphere primitive. - + - The invalid case of a NodeID. + Substance memory budget. - + - Identifies a specific game instance. + A limit of 512MB for the cache or the working memory. - + - Invalid SourceID. + A limit of 256MB for the cache or the working memory. - + - Describes different levels of log information the network layer supports. + No limit for the cache or the working memory. - + - Full debug level logging down to each individual message being reported. + A limit of 1B (one byte) for the cache or the working memory. - + - Report informational messages like connectivity events. + A limit of 128MB for the cache or the working memory. - + - Only report errors, otherwise silent. + ProceduralMaterial loading behavior. - + - This data structure contains information on a message just received from the network. + Bake the textures to speed up loading and discard the ProceduralMaterial data (default on unsupported platform). - + - The NetworkView who sent this message. + Bake the textures to speed up loading and keep the ProceduralMaterial data so that it can still be tweaked and regenerated later on. - + - The player who sent this network message (owner). + Generate the textures when loading and cache them to diskflash to speed up subsequent gameapplication startups. - + - The time stamp when the Message was sent in seconds. + Does not generate the textures automatically when the scene is loaded as it is set to "DoNothing". RebuildTextures() or RebuildTexturesImmediately() must be called to generate the textures. - + - Describes the status of the network interface peer type as returned by Network.peerType. + Does not generate the textures automatically when the scene is loaded as it is set to "DoNothing". RebuildTextures() or RebuildTexturesImmediately() must be called to generate the textures. After the textures have been generrated for the first time, they are cached to diskflash to speed up subsequent gameapplication startups. This setting will not load the cached textures automatically when the scene is loaded as it is still set to "DoNothing". RebuildTextures() or RebuildTexturesImmediately() must be called again to load the previously cached textures. - + - Running as client. + Generate the textures when loading to favor application's size (default on supported platform). - + - Attempting to connect to a server. + Class for ProceduralMaterial handling. - + - No client connection running. Server not initialized. + Set or get the update rate in millisecond of the animated substance. - + - Running as server. + Set or get the Procedural cache budget. - + - The NetworkPlayer is a data structure with which you can locate another player over the network. + Indicates whether cached data is available for this ProceduralMaterial's textures (only relevant for Cache and DoNothingAndCache loading behaviors). - + - Returns the external IP address of the network interface. + Returns true if FreezeAndReleaseSourceData was called on this ProceduralMaterial. - + - Returns the external port of the network interface. + Should the ProceduralMaterial be generated at load time? - + - The GUID for this player, used when connecting with NAT punchthrough. + Check if the ProceduralTextures from this ProceduralMaterial are currently being rebuilt. - + - The IP address of this player. + Set or get the "Readable" flag for a ProceduralMaterial. - + - The port of this player. + Check if ProceduralMaterials are supported on the current platform. - + - Returns true if two NetworkPlayers are the same player. + Get ProceduralMaterial loading behavior. - - - + - Returns true if two NetworkPlayers are not the same player. + Set or get an XML string of "input/value" pairs (setting the preset rebuilds the textures). - - - + - Returns the index number for this network player. + Used to specify the Substance engine CPU usage. - + - Describes network reachability options. + Specifies if a named ProceduralProperty should be cached for efficient runtime tweaking. + + - + - Network is not reachable. + Clear the Procedural cache. - + - Network is reachable via carrier data network. + Render a ProceduralMaterial immutable and release the underlying data to decrease the memory footprint. - + - Network is reachable via WiFi or cable. + This allows to get a reference to a ProceduralTexture generated by a ProceduralMaterial using its name. + The name of the ProceduralTexture to get. - + - Different types of synchronization for the NetworkView component. + Get generated textures. - + - No state data will be synchronized. + Get a named Procedural boolean property. + - + - All packets are sent reliable and ordered. + Get a named Procedural color property. + - + - Brute force unreliable state sending. + Get a named Procedural enum property. + - + - The network view is the binding material of multiplayer games. + Get a named Procedural float property. + - + - The network group number of this network view. + Get an array of descriptions of all the ProceduralProperties this ProceduralMaterial has. - + - Is the network view controlled by this object? + Get a named Procedural texture property. + - + - The component the network view is observing. + Get a named Procedural vector property. + - + - The NetworkPlayer who owns this network view. + Checks if the ProceduralMaterial has a ProceduralProperty of a given name. + - + - The type of NetworkStateSynchronization set for this network view. + Checks if a named ProceduralProperty is cached for efficient runtime tweaking. + - + - The ViewID of this network view. + Checks if a given ProceduralProperty is visible according to the values of this ProceduralMaterial's other ProceduralProperties and to the ProceduralProperty's visibleIf expression. + The name of the ProceduralProperty whose visibility is evaluated. - + - Find a network view based on a NetworkViewID. + Triggers an asynchronous rebuild of this ProceduralMaterial's dirty textures. - - + - Call a RPC function on all connected peers. + Triggers an immediate (synchronous) rebuild of this ProceduralMaterial's dirty textures. - - - - + - Call a RPC function on a specific player. + Set a named Procedural boolean property. - - - + + - + - Set the scope of the network view in relation to a specific network player. + Set a named Procedural color property. - - + + - + - The NetworkViewID is a unique identifier for a network view instance in a multiplayer game. + Set a named Procedural enum property. + + - + - True if instantiated by me. + Set a named Procedural float property. + + - + - The NetworkPlayer who owns the NetworkView. Could be the server. + Set a named Procedural texture property. + + - + - Represents an invalid network view ID. + Set a named Procedural vector property. + + - + - Returns true if two NetworkViewIDs are identical. + Discard all the queued ProceduralMaterial rendering operations that have not started yet. - - - + - Returns true if two NetworkViewIDs are not identical. + The type of generated image in a ProceduralMaterial. - - - + - Returns a formatted string with details on this NetworkViewID. + Ambient occlusion map. - + - NPOT Texture2D|textures support. + Detail mask map. - + - Full NPOT support. + Diffuse map. - + - NPOT textures are not supported. Will be upscaled/padded at loading time. + Emissive map. - + - Limited NPOT support: no mip-maps and clamp TextureWrapMode|wrap mode will be forced. + Height map. - + - Base class for all objects Unity can reference. + Metalness map. - + - Should the object be hidden, saved with the scene or modifiable by the user? + Normal (Bump) map. - + - The name of the object. + Opacity (Tranparency) map. - + - Removes a gameobject, component or asset. + Roughness map. - The object to destroy. - The optional amount of time to delay before destroying the object. - + - Removes a gameobject, component or asset. + Smoothness map (formerly referred to as Glossiness). - 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. + Specular map. - Object to be destroyed. - Set to true to allow assets to be destoyed. - + - Destroys the object obj immediately. You are strongly recommended to use Destroy instead. + Undefined type. - Object to be destroyed. - Set to true to allow assets to be destoyed. - + - Makes the object target not be destroyed automatically when loading a new scene. + The global Substance engine processor usage (as used for the ProceduralMaterial.substanceProcessorUsage property). - - + - Returns the first active loaded object of Type type. + All physical processor cores are used for ProceduralMaterial generation. - The type of object to find. - - An array of objects which matched the specified type, cast as Object. - - + - Returns a list of all active loaded objects of Type type. + Half of all physical processor cores are used for ProceduralMaterial generation. - 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. + A single physical processor core is used for ProceduralMaterial generation. - 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. + Exact control of processor usage is not available. - 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. + Describes a ProceduralProperty. - + - Does the object exist? + The names of the individual components of a Vector234 ProceduralProperty. - - + - Clones the object original and returns the clone. + The available options for a ProceduralProperty of type Enum. - An existing object that you want to make a copy of. - Position for the new object. - Orientation of the new object. - + - Clones the object original and returns the clone. + The name of the GUI group. Used to display ProceduralProperties in groups. - An existing object that you want to make a copy of. - Position for the new object. - Orientation of the new object. - + - Generic version. See the page for more details. + If true, the Float or Vector property is constrained to values within a specified range. - - + - Compares two object references to see if they refer to the same object. + The label of the ProceduralProperty. Can contain space and be overall more user-friendly than the 'name' member. - The first Object. - The Object to compare against the first. - + - Compares if two objects refer to a different object. + If hasRange is true, maximum specifies the maximum allowed value for this Float or Vector property. - - - + - Returns the name of the game object. + If hasRange is true, minimum specifies the minimum allowed value for this Float or Vector property. - + - Level of obstacle avoidance. + The name of the ProceduralProperty. Used to get and set the values. - + - Good avoidance. High performance impact. + Specifies the step size of this Float or Vector property. Zero is no step. - + - Enable highest precision. Highest performance impact. + The ProceduralPropertyType describes what type of property this is. - + - Enable simple avoidance. Low performance impact. + The type of a ProceduralProperty. - + - Medium avoidance. Medium performance impact. + Procedural boolean property. Use with ProceduralMaterial.GetProceduralBoolean. - + - Disable avoidance. + Procedural Color property without alpha. Use with ProceduralMaterial.GetProceduralColor. - + - OcclusionArea is an area in which occlusion culling is performed. + Procedural Color property with alpha. Use with ProceduralMaterial.GetProceduralColor. - + - Center of the occlusion area relative to the transform. + Procedural Enum property. Use with ProceduralMaterial.GetProceduralEnum. - + - Size that the occlusion area will have. + Procedural float property. Use with ProceduralMaterial.GetProceduralFloat. - + - The portal for dynamically changing occlusion at runtime. + Procedural Texture property. Use with ProceduralMaterial.GetProceduralTexture. - + - Gets / sets the portal's open state. + Procedural Vector2 property. Use with ProceduralMaterial.GetProceduralVector. - + - Link allowing movement outside the planar navigation mesh. + Procedural Vector3 property. Use with ProceduralMaterial.GetProceduralVector. - + - Is link active. + Procedural Vector4 property. Use with ProceduralMaterial.GetProceduralVector. - + - NavMesh area index for this OffMeshLink component. + Class for ProceduralTexture handling. - + - Automatically update endpoints. + The format of the pixel data in the texture (Read Only). - + - Can link be traversed in both directions. + Check whether the ProceduralMaterial that generates this ProceduralTexture is set to an output format with an alpha channel. - + - Modify pathfinding cost for the link. + Grab pixel values from a ProceduralTexture. + + X-coord of the top-left corner of the rectangle to grab. + Y-coord of the top-left corner of the rectangle to grab. + Width of rectangle to grab. + Height of the rectangle to grab. +Get the pixel values from a rectangular area of a ProceduralTexture into an array. +The block is specified by its x,y offset in the texture and by its width and height. The block is "flattened" into the array by scanning the pixel values across rows one by one. - + - The transform representing link end position. + The output type of this ProceduralTexture. - + - NavMeshLayer for this OffMeshLink component. + Custom CPU Profiler label used for profiling arbitrary code blocks. - + - Is link occupied. (Read Only) + Begin profiling a piece of code with a custom label defined by this instance of CustomSampler. + - + - The transform representing link start position. + Begin profiling a piece of code with a custom label defined by this instance of CustomSampler. + - + - Explicitly update the link endpoints. + 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. + - + - State of OffMeshLink. + End profiling a piece of code with a custom label. - + - Is link active (Read Only). + Controls the from script. - + - Link end world position (Read Only). + Sets profiler output file in built players. - + - Link type specifier (Read Only). + Enables the Profiler. - + - The OffMeshLink if the link type is a manually placed Offmeshlink (Read Only). + Sets profiler output file in built players. - + - Link start world position (Read Only). + Resize the profiler sample buffers to allow the desired amount of samples per thread. - + - Is link valid (Read Only). + Heap size used by the program. + + Size of the used heap in bytes, (or 0 if the profiler is disabled). + - + - Link type specifier. + 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). + - + - Vertical drop. + Displays the recorded profiledata in the profiler. + - + - Horizontal jump. + Begin profiling a piece of code with a custom label. + + - + - Manually specified type of link. + Begin profiling a piece of code with a custom label. + + - + - (Legacy Particle system). + End profiling a piece of code with a custom label. - + - The angular velocity of the particle. + Returns the size of the mono heap. - + - The color of the particle. + 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. + - + - The energy of the particle. + Returns the used size from mono. - + - The position of the particle. + 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. + - + - The rotation of the particle. + Returns the runtime memory usage of the resource. + - + - The size of the particle. + 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. + - + - The starting energy of the particle. + Returns the size of the temp allocator. + + Size in bytes. + - + - The velocity of the particle. + Returns the amount of allocated and used system memory. - + - (Legacy Particles) Particle animators move your particles over time, you use them to apply wind, drag & color cycling to your particle emitters. + 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. + - + - Does the GameObject of this particle animator auto destructs? + Returns the amount of reserved system memory. - + - Colors the particles will cycle through over their lifetime. + The total memory Unity has reserved. + + Memory reserved by Unity in bytes. This returns 0 if the Profiler is not available. + - + - How much particles are slowed down every frame. + Returns the amount of reserved but not used system memory. - + - Do particles cycle their color over their lifetime? + 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. + - + - The force being applied to particles every frame. + 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). + - + - Local space axis the particles rotate around. + Records profiling data produced by a specific Sampler. - + - A random force added to particles every frame. + Accumulated time of Begin/End pairs for the previous frame in nanoseconds. (Read Only) - + - How the particle sizes grow over their lifetime. + Enables recording. - + - World space axis the particles rotate around. + Returns true if Recorder is valid and can collect data. (Read Only) - + - Information about a particle collision. + Number of time Begin/End pairs was called during the previous frame. (Read Only) - + - The Collider for the GameObject struck by the particles. + Use this function to get a Recorder for the specific Profiler label. + Sampler name. + + Recorder object for the specified Sampler. + - + - The Collider or Collider2D for the GameObject struck by the particles. + Provides control over a CPU Profiler label. - + - Intersection point of the collision in world coordinates. + Returns true if Sampler is valid. (Read Only) - + - Geometry normal at the intersection point of the collision. + Sampler name. (Read Only) - + - Incident velocity at the intersection point of the collision. + Returns Sampler object for the specific CPU Profiler label. + Profiler Sampler name. + + Sampler object which represents specific profiler label. + - + - (Legacy Particles) Script interface for particle emitters. + 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. + - + - The angular velocity of new particles in degrees per second. + Returns Recorder associated with the Sampler. + + Recorder object associated with the Sampler. + - + - Should particles be automatically emitted each frame? + A script interface for a. - + - The amount of the emitter's speed that the particles inherit. + The aspect ratio of the projection. - + - Turns the ParticleEmitter on or off. + The far clipping plane distance. - + - The starting speed of particles along X, Y, and Z, measured in the object's orientation. + The field of view of the projection in degrees. - + - The maximum number of particles that will be spawned every second. + Which object layers are ignored by the projector. - + - The maximum lifetime of each particle, measured in seconds. + The material that will be projected onto every object. - + - The maximum size each particle can be at the time when it is spawned. + The near clipping plane distance. - + - The minimum number of particles that will be spawned every second. + Is the projection orthographic (true) or perspective (false)? - + - The minimum lifetime of each particle, measured in seconds. + Projection's half-size when in orthographic mode. - + - The minimum size each particle can be at the time when it is spawned. + Base class to derive custom property attributes from. Use this to create custom attributes for script variables. - + - The current number of particles (Read Only). + Optional field to specify the order that multiple DecorationDrawers should be drawn in. - + - Returns a copy of all particles and assigns an array of all particles to be the current particles. + 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". - + - A random angular velocity modifier for new particles. + Initializes the PropertyName using a string. + - + - If enabled, the particles will be spawned with random rotations. + Determines whether this instance and a specified object, which must also be a PropertyName object, have the same value. + - + - A random speed along X, Y, and Z that is added to the velocity. + Returns the hash code for this PropertyName. - + - If enabled, the particles don't move when the emitter moves. If false, when you move the emitter, the particles follow it around. + Converts the string passed into a PropertyName. See Also: PropertyName.ctor(System.String). + - + - The starting speed of particles in world space, along X, Y, and Z. + Indicates whether the specified PropertyName is an Empty string. + - + - Removes all particles from the particle emitter. + 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. + + - + - Emit a number of particles. + Determines whether two specified PropertyName have a different string value. + + - + - Emit count particles immediately. + For debugging purposes only. Returns the string value representing the string in the Editor. +Returns "UnityEngine.PropertyName" in the player. - - + - Emit a single particle with given parameters. + Script interface for. - The position of the particle. - The velocity of the particle. - The size of the particle. - The remaining lifetime of the particle. - The color of the particle. - + - + Active color space (Read Only). - The initial rotation of the particle in degrees. - The angular velocity of the particle in degrees per second. - - - - - - + - Advance particle simulation by given time. + Global anisotropic filtering mode. - - + - Method extension for Physics in Particle System. + Set The AA Filtering option. - + - Get the particle collision events for a GameObject. Returns the number of events written to the array. + 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. - The GameObject for which to retrieve collision events. - Array to write collision events to. - - + - Safe array size for use with ParticleSystem.GetCollisionEvents. + 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. - - + - (Legacy Particles) Renders particles on to the screen. + If enabled, billboards will face towards camera position rather than camera orientation. - + - How much are the particles strected depending on the Camera's speed. + Blend weights. - + - How much are the particles stretched in their direction of motion. + Desired color space (Read Only). - + - Clamp the maximum particle size. + Global multiplier for the LOD's switching distance. - + - How particles are drawn. + A texture size limit applied to all textures. - + - Set uv animation cycles. + A maximum LOD level. All LOD groups. - + - Set horizontal tiling count. + Maximum number of frames queued up by graphics driver. - + - Set vertical tiling count. + The indexed list of available Quality Settings. - + - How much are the particles strectched depending on "how fast they move". + Budget for how many ray casts can be performed per frame for approximate collision testing. - + - The rendering mode for legacy particles. + The maximum number of pixel lights that should affect any object. - + - Render the particles as billboards facing the player. (Default) + Enables realtime reflection probes. - + - Render the particles as billboards always facing up along the y-Axis. + The normalized cascade distribution for a 2 cascade setup. The value defines the position of the cascade with respect to Zero. - + - Sort the particles back-to-front and render as billboards. + 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. - + - Stretch particles in the direction of motion. + Number of cascades to use for directional light shadows. - + - Render the particles as billboards always facing the player, but not pitching along the x-Axis. + Shadow drawing distance. - + - Script interface for particle systems (Shuriken). + Offset shadow frustum near plane. - + - Access the particle system collision module. + Directional light shadow projection. - + - Access the particle system color by lifetime module. + The default resolution of the shadow maps. - + - Access the particle system color over lifetime module. + Realtime Shadows type to be used. - + - The duration of the particle system in seconds (Read Only). + Should soft blending be used for particles? - + - Access the particle system emission module. + Use a two-pass shader for the vegetation in the terrain engine. - + - The rate of emission. + The VSync Count. - + - When set to false, the particle system will not emit particles. + Decrease the current quality level. + Should expensive changes be applied (Anti-aliasing etc). - + - Access the particle system external forces module. + Returns the current graphics quality level. - + - Access the particle system force over lifetime module. + Increase the current quality level. + Should expensive changes be applied (Anti-aliasing etc). - + - Scale being applied to the gravity defined by Physics.gravity. + Sets a new graphics quality level. + Quality index to set. + Should expensive changes be applied (Anti-aliasing etc). - + - Access the particle system velocity inheritance module. + Quaternions are used to represent rotations. - + - Is the particle system paused right now ? + Returns the euler angle representation of the rotation. - + - Is the particle system playing right now ? + The identity rotation (Read Only). - + - Is the particle system stopped right now ? + W component of the Quaternion. Don't modify this directly unless you know quaternions inside out. - + - Access the particle system limit velocity over lifetime module. + X component of the Quaternion. Don't modify this directly unless you know quaternions inside out. - + - Is the particle system looping? + Y component of the Quaternion. Don't modify this directly unless you know quaternions inside out. - + - The maximum number of particles to emit. + Z component of the Quaternion. Don't modify this directly unless you know quaternions inside out. - + - The current number of particles (Read Only). + Returns the angle in degrees between two rotations a and b. + + - + - The playback speed of the particle system. 1 is normal playback speed. + Creates a rotation which rotates angle degrees around axis. + + - + - If set to true, the particle system will automatically start playing on startup. + Constructs new Quaternion with given x,y,z,w components. + + + + - + - Random seed used for the particle system emission. If set to 0, it will be assigned a random value on awake. + The dot product between two rotations. + + - + - Access the particle system rotation by speed module. + Returns a rotation that rotates z degrees around the z axis, x degrees around the x axis, and y degrees around the y axis (in that order). + + + - + - Access the particle system rotation over lifetime module. + Returns a rotation that rotates z degrees around the z axis, x degrees around the x axis, and y degrees around the y axis (in that order). + - + - The scaling mode applied to particle sizes and positions. + Creates a rotation which rotates from fromDirection to toDirection. + + - + - Access the particle system shape module. + Returns the Inverse of rotation. + - + - This selects the space in which to simulate particles. It can be either world or local space. + Interpolates between a and b by t and normalizes the result afterwards. The parameter t is clamped to the range [0, 1]. + + + - + - Access the particle system size by speed module. + Interpolates between a and b by t and normalizes the result afterwards. The parameter t is not clamped. + + + - + - Access the particle system size over lifetime module. + Creates a rotation with the specified forward and upwards directions. + The direction to look in. + The vector that defines in which direction up is. - + - The initial color of particles when emitted. + Creates a rotation with the specified forward and upwards directions. + The direction to look in. + The vector that defines in which direction up is. - + - Start delay in seconds. + Are two quaternions equal to each other? + + - + - The total lifetime in seconds that particles will have when emitted. When using curves, this values acts as a scale on the curve. This value is set in the particle when it is create by the particle system. + Combines rotations lhs and rhs. + Left-hand side quaternion. + Right-hand side quaternion. - + - The initial rotation of particles when emitted. When using curves, this values acts as a scale on the curve. + Rotates the point point with rotation. + + - + - The initial 3D rotation of particles when emitted. When using curves, this values acts as a scale on the curves. + Rotates a rotation from towards to. + + + - + - The initial size of particles when emitted. When using curves, this values acts as a scale on the curve. + Set x, y, z and w components of an existing Quaternion. + + + + - + - The initial speed of particles when emitted. When using curves, this values acts as a scale on the curve. + Creates a rotation which rotates from fromDirection to toDirection. + + - + - Access the particle system sub emitters module. + Creates a rotation with the specified forward and upwards directions. + The direction to look in. + The vector that defines in which direction up is. - + - Access the particle system texture sheet animation module. + Creates a rotation with the specified forward and upwards directions. + The direction to look in. + The vector that defines in which direction up is. - + - Playback position in seconds. + Spherically interpolates between a and b by t. The parameter t is clamped to the range [0, 1]. + + + - + - Access the particle system velocity over lifetime module. + Spherically interpolates between a and b by t. The parameter t is not clamped. + + + - + - Script interface for a Burst. + Access the x, y, z, w components using [0], [1], [2], [3] respectively. - + - Maximum number of bursts to be emitted. + Converts a rotation to angle-axis representation (angles in degrees). + + - + - Minimum number of bursts to be emitted. + Returns a nicely formatted string of the Quaternion. + - + - The time that each burst occurs. + Returns a nicely formatted string of the Quaternion. + - + - Construct a new Burst with a time and count. + Overrides the global Physics.queriesHitTriggers. - Time to emit the burst. - Minimum number of particles to emit. - Maximum number of particles to emit. - - + - Remove all particles in the particle system. + Queries always report Trigger hits. - Clear all child particle systems as well. - + - Script interface for the Collision module. + Queries never report Trigger hits. - + - How much force is applied to each particle after a collision. + Queries use the global Physics.queriesHitTriggers setting. - + - Control which layers this particle system collides with. + Used by Animation.Play function. - + - How much speed is lost from each particle after a collision. + Will start playing after all other animations have stopped playing. - + - Enable/disable the Collision module. + Starts playing immediately. This can be used if you just want to quickly create a duplicate animation. - + - Allow particles to collide with dynamic colliders when using world collision mode. + Class for generating random data. - + - Allow particles to collide when inside colliders. + Returns a random point inside a circle with radius 1 (Read Only). - + - How much a particle's lifetime is reduced after a collision. + Returns a random point inside a sphere with radius 1 (Read Only). - + - The maximum number of collision shapes that will be considered for particle collisions. Excess shapes will be ignored. Terrains take priority. + Returns a random point on the surface of a sphere with radius 1 (Read Only). - + - The maximum number of planes it is possible to set as colliders. + Returns a random rotation (Read Only). - + - Kill particles whose speed falls below this threshold, after a collision. + Returns a random rotation with uniform distribution (Read Only). - + - Choose between 2D and 3D world collisions. + Gets/Sets the full internal state of the random number generator. - + - Specifies the accuracy of particle collisions against colliders in the scene. + Returns a random number between 0.0 [inclusive] and 1.0 [inclusive] (Read Only). - + - A multiplier applied to the size of each particle before collisions are processed. + 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. + - + - Send collision callback messages. + 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. + - + - The type of particle collision to perform. + 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. + - + - Size of voxels in the collision cache. + 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. + - + - Get a collision plane associated with this particle system. + Generates a random color from HSV and alpha ranges. - Specifies which plane to access. + 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]. - The plane. + A random color with HSV and alpha values in the input ranges. - + - Set a collision plane to be used with this particle system. + Initializes the random number generator state with a seed. - Specifies which plane to set. - The plane to set. + Seed used to initialize the random number generator. - + - Script interface for the Color By Speed module. + Returns a random float number between and min [inclusive] and max [inclusive] (Read Only). + + - + - The curve controlling the particle colors. + Returns a random integer number between min [inclusive] and max [exclusive] (Read Only). + + - + - Enable/disable the Color By Speed module. + Serializable structure used to hold the full internal state of the random number generator. See Also: Random.state. - + - Apply the color gradient between these minimum and maximum speeds. + Attribute used to make a float or int variable in a script be restricted to a specific range. - + - Script interface for the Color Over Lifetime module. + 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. - + - The curve controlling the particle colors. + Describes an integer range. - + - Enable/disable the Color Over Lifetime module. + The end index of the range (not inclusive). - + - Script interface for the Emission module. + The length of the range. - + - The current number of bursts. + The starting index of the range, where 0 is the first position, 1 is the second, 2 is the third, and so on. - + - Enable/disable the Emission module. + Constructs a new RangeInt with given start, length values. + The starting index of the range. + The length of the range. - + - The rate at which new particles are spawned. + Representation of rays. - + - The emission type. + The direction of the ray. - + - Get the burst array. + The origin point of the ray. - Array of bursts to be filled in. - - The number of bursts in the array. - - + - Set the burst array. + Creates a ray starting at origin along direction. - Array of bursts. - Optional array size, if burst count is less than array size. + + - + - Set the burst array. + Returns a point at distance units along the ray. - Array of bursts. - Optional array size, if burst count is less than array size. + - + - + Returns a nicely formatted string for this ray. - - - - - + - + - + Returns a nicely formatted string for this ray. - + - + - Emit count particles immediately. + A ray in 2D space. - Number of particles to emit. - + - Emit a number of particles from script. + The direction of the ray in world space. - Overidden particle properties. - Number of particles to emit. - + - Script interface for particle emission parameters. + The starting point of the ray in world space. - + - Override the angular velocity of emitted particles. + Creates a 2D ray starting at origin along direction. + origin + direction + + - + - Override the 3D angular velocity of emitted particles. + Get a point that lies a given distance along a ray. + Distance of the desired point along the path of the ray. - + - Override the axis of rotation of emitted particles. + Structure used to get information back from a raycast. - + - Override the position of emitted particles. + The barycentric coordinate of the triangle we hit. - + - Override the random seed of emitted particles. + The Collider that was hit. - + - Override the rotation of emitted particles. + The distance from the ray's origin to the impact point. - + - Override the 3D rotation of emitted particles. + The uv lightmap coordinate at the impact point. - + - Override the initial color of emitted particles. + The normal of the surface the ray hit. - + - Override the lifetime of emitted particles. + The impact point in world space where the ray hit the collider. - + - Override the initial size of emitted particles. + The Rigidbody of the collider that was hit. If the collider is not attached to a rigidbody then it is null. - + - Override the velocity of emitted particles. + The uv texture coordinate at the collision location. - + - Reverts angularVelocity and angularVelocity3D back to the values specified in the inspector. + The secondary uv texture coordinate at the impact point. - + - Revert the axis of rotation back to the value specified in the inspector. + The Transform of the rigidbody or collider that was hit. - + - Revert the position back to the value specified in the inspector. + The index of the triangle that was hit. - + - Revert the random seed back to the value specified in the inspector. + Information returned about an object detected by a raycast in 2D physics. - + - Reverts rotation and rotation3D back to the values specified in the inspector. + The centroid of the primitive used to perform the cast. - + - Revert the initial color back to the value specified in the inspector. + The collider hit by the ray. - + - Revert the lifetime back to the value specified in the inspector. + The distance from the ray origin to the impact point. - + - Revert the initial size back to the value specified in the inspector. + Fraction of the distance along the ray that the hit occurred. - + - Revert the velocity back to the value specified in the inspector. + The normal vector of the surface hit by the ray. - + - Script interface for the External Forces module. + The point in world space where the ray hit the collider's surface. - + - Enable/disable the External Forces module. + The Rigidbody2D attached to the object that was hit. - + - Multiplies the magnitude of applied external forces. + The Transform of the object that was hit. - + - Script interface for the Force Over Lifetime module. + A 2D Rectangle defined by X and Y position, width and height. - + - Enable/disable the Force Over Lifetime module. + The position of the center of the rectangle. - + - When randomly selecting values between two curves or constants, this flag will cause a new random force to be chosen on each frame. + The height of the rectangle, measured from the Y position. - + - Are the forces being applied in local or world space? + The position of the maximum corner of the rectangle. - + - The curve defining particle forces in the X axis. + The position of the minimum corner of the rectangle. - + - The curve defining particle forces in the Y axis. + The X and Y position of the rectangle. - + - The curve defining particle forces in the Z axis. + The width and height of the rectangle. - + - Get the particles of this particle system. + The width of the rectangle, measured from the X position. - Particle buffer that is used for writing particle state to. The return value is the number of particles written to this array. - - 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. + The X coordinate of the rectangle. - + - Curve to define how much emitter velocity is applied during the lifetime of a particle. + The maximum X coordinate of the rectangle. - + - Enable/disable the InheritVelocity module. + The minimum X coordinate of the rectangle. - + - How to apply emitter velocity to particles. + The Y coordinate of the rectangle. - + - Does the system have any live particles (or will produce more)? + The maximum Y coordinate of the rectangle. - Check all child particle systems as well. - - True if the particle system is still "alive", false if the particle system is done emitting particles and all particles are dead. - - + - Script interface for the Limit Velocity Over Lifetime module. + The minimum Y coordinate of the rectangle. - + - Controls how much the velocity that exceeds the velocity limit should be dampened. + Shorthand for writing new Rect(0,0,0,0). - + - Enable/disable the Limit Force Over Lifetime module. + 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. + - + - Maximum velocity curve, when not using one curve per axis. + 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. + - + - Maximum velocity curve for the X axis. + 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. + - + - Maximum velocity curve for the Y axis. + 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. - + - Maximum velocity curve for the Z axis. + + - + - Set the velocity limit on each axis separately. + Creates a rectangle given a size and position. + The position of the minimum corner of the rect. + The width and height of the rect. - + - Specifies if the velocity limits are in local space (rotated with the transform) or world space. + 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. + - + - Script interface for a Min-Max Curve. + Returns a point inside a rectangle, given normalized coordinates. + Rectangle to get a point inside. + Normalized coordinates to get a point for. - + - Set a constant for the upper bound. + Returns true if the rectangles are the same. + + - + - Set a constant for the lower bound. + 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? - + - Set a curve for the upper bound. + 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? - + - Set a curve for the lower bound. + 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 a multiplier to be applied to the curves. + Set components of an existing Rect. + + + + - + - Set the mode that the min-max curve will use to evaluate values. + Returns a nicely formatted string for this Rect. + - + - A single constant value for the entire curve. + Returns a nicely formatted string for this Rect. - Constant value. + - + - Use one curve when evaluating numbers along this Min-Max curve. + Offsets for rectangles, borders, etc. - 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. + Bottom edge size. - 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. + Shortcut for left + right. (Read Only) - The constant describing the minimum values to be evaluated. - The constant describing the maximum values to be evaluated. - + - Script interface for a Min-Max Gradient. + Left edge size. - + - Set a constant color for the upper bound. + Right edge size. - + - Set a constant color for the lower bound. + Top edge size. - + - Set a gradient for the upper bound. + Shortcut for top + bottom. (Read Only) - + - Set a gradient for the lower bound. + Add the border offsets to a rect. + - + - Set the mode that the min-max gradient will use to evaluate colors. + Creates a new rectangle with offsets. + + + + - + - A single constant color for the entire gradient. + Creates a new rectangle with offsets. - Constant color. + + + + - + - Use one gradient when evaluating numbers along this Min-Max gradient. + Remove the border offsets from a rect. - A single gradient for evaluating against. + - + - Randomly select colors based on the interval between the minimum and maximum constants. + Position, size, anchor and pivot information for a rectangle. - 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 position of the pivot of this RectTransform relative to the anchor reference point. - The gradient describing the minimum colors to be evaluated. - The gradient describing the maximum colors to be evaluated. - + - Script interface for a Particle. + The 3D position of the pivot of this RectTransform relative to the anchor reference point. - + - The angular velocity of the particle. + The normalized position in the parent RectTransform that the upper right corner is anchored to. - + - The 3D angular velocity of the particle. + The normalized position in the parent RectTransform that the lower left corner is anchored to. - + - The lifetime of the particle. + The offset of the upper right corner of the rectangle relative to the upper right anchor. - + - The position of the particle. + The offset of the lower left corner of the rectangle relative to the lower left anchor. - + - The random seed of the particle. + The normalized position in this RectTransform that it rotates around. - + - The random value of the particle. + Event that is invoked for RectTransforms that need to have their driven properties reapplied. + - + - The rotation of the particle. + The calculated rectangle in the local space of the Transform. - + - The 3D rotation of the particle. + The size of this RectTransform relative to the distances between the anchors. - + - The initial color of the particle. The current color of the particle is calculated procedurally based on this value and the active color modules. + An axis that can be horizontal or vertical. - + - The starting lifetime of the particle. + Horizontal. - + - The initial size of the particle. The current size of the particle is calculated procedurally based on this value and the active size modules. + Vertical. - + - The velocity of the particle. + Enum used to specify one edge of a rectangle. - + - Calculate the current color of the particle by applying the relevant curves to its startColor property. + The bottom edge. - 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 left edge. - The particle system from which this particle was emitted. - - Current size. - - + - Pauses playing the particle system. + The right edge. - Pause all child particle systems as well. - + - Plays the particle system. + The top edge. - Play all child particle systems as well. - + - Script interface for the Rotation By Speed module. + Get the corners of the calculated rectangle in the local space of its Transform. + Array that corners should be filled into. - + - Enable/disable the Rotation By Speed module. + Get the corners of the calculated rectangle in world space. + Array that corners should be filled into. - + - Apply the rotation curve between these minimum and maximum speeds. + Delegate used for the reapplyDrivenProperties event. + - + - Set the rotation by speed on each axis separately. + 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. - + - Rotation by speed curve for the X axis. + 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. - + - Rotation by speed curve for the Y axis. + Utility class containing helper methods for working with RectTransform. - + - Rotation by speed curve for the Z axis. + 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? - + - Script interface for the Rotation Over Lifetime module. + 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. - + - Enable/disable the Rotation Over Lifetime module. + Convert a given point in screen space into a pixel correct point. + + + + + Pixel adjusted point. + - + - Set the rotation over lifetime on each axis separately. + Given a rect transform, return the corner points in pixel accurate coordinates. + + + + Pixel adjusted rect. + - + - Rotation over lifetime curve for the X axis. + 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. + - + - Rotation over lifetime curve for the Y axis. + 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. + - + - Rotation over lifetime curve for the Z axis. + 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. + - + - Set the particles of this particle system. size is the number of particles that is set. + The reflection probe is used to capture the surroundings into a texture which is passed to the shaders and used for reflections. - - - + - Script interface for the Shape module. + The color with which the texture of reflection probe will be cleared. - + - Angle of the cone. + Reference to the baked texture of the reflection probe's surrounding. - + - Circle arc angle. + Distance around probe used for blending (used in deferred probes). - + - Scale of the box. + The bounding volume of the reflection probe (Read Only). - + - Enable/disable the Shape module. + Should this reflection probe use box projection? - + - Length of the cone. + The center of the box area in which reflections will be applied to the objects. Measured in the probes's local space. - + - Mesh to emit particles from. + How the reflection probe clears the background. - + - Emit particles from a single material of a mesh. + This is used to render parts of the reflecion probe's surrounding selectively. - + - MeshRenderer to emit particles from. + Reference to the baked texture of the reflection probe's surrounding. Use this to assign custom reflection texture. - + - Where on the mesh to emit particles from. + Texture which is used outside of all reflection probes (Read Only). - + - Move particles away from the surface of the source mesh. + HDR decode values of the default reflection probe texture. - + - Radius of the shape. + The far clipping plane distance when rendering the probe. - + - Randomizes the starting direction of particles. + Should this reflection probe use HDR rendering? - + - Type of shape to emit particles from. + Reflection probe importance. - + - SkinnedMeshRenderer to emit particles from. + The intensity modifier that is applied to the texture of reflection probe in the shader. - + - Modulate the particle colours with the vertex colors, or the material color if no vertex colors exist. + Should reflection probe texture be generated in the Editor (ReflectionProbeMode.Baked) or should probe use custom specified texure (ReflectionProbeMode.Custom)? - + - Emit from a single material, or the whole mesh. + The near clipping plane distance when rendering the probe. - + - Fastforwards the particle system by simulating particles over given period of time, then pauses it. + Sets the way the probe will refresh. + +See Also: ReflectionProbeRefreshMode. - Time to fastforward the particle system. - Fastforward all child particle systems as well. - Restart and start from the beginning. - + - Script interface for the Size By Speed module. + Resolution of the underlying reflection texture in pixels. - + - Enable/disable the Size By Speed module. + Shadow drawing distance when rendering the probe. - + - Apply the size curve between these minimum and maximum speeds. + The size of the box area in which reflections will be applied to the objects. Measured in the probes's local space. - + - Curve to control particle size based on speed. + Texture which is passed to the shader of the objects in the vicinity of the reflection probe (Read Only). - + - Script interface for the Size Over Lifetime module. + HDR decode values of the reflection probe texture. - + - Enable/disable the Size Over Lifetime module. + Sets this probe time-slicing mode + +See Also: ReflectionProbeTimeSlicingMode. - + - Curve to control particle size based on lifetime. + 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. + - + - Stops playing the particle system. + Checks if a probe has finished a time-sliced render. - Stop all child particle systems as well. + An integer representing the RenderID as returned by the RenderProbe method. + + + True if the render has finished, false otherwise. + + See Also: timeSlicingMode + + - + - Script interface for the Sub Emitters module. + 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 + + - + - Sub particle system to spawn on birth of the parent system's particles. + Keeps two Rigidbody2D at their relative orientations. - + - Sub particle system to spawn on birth of the parent system's particles. + The current angular offset between the Rigidbody2D that the joint connects. - + - Sub particle system to spawn on collision of the parent system's particles. + Should both the linearOffset and angularOffset be calculated automatically? - + - Sub particle system to spawn on collision of the parent system's particles. + Scales both the linear and angular forces used to correct the required relative orientation. - + - Sub particle system to spawn on death of the parent system's particles. + The current linear offset between the Rigidbody2D that the joint connects. - + - Sub particle system to spawn on death of the parent system's particles. + The maximum force that can be generated when trying to maintain the relative joint constraint. - + - Enable/disable the Sub Emitters module. + The maximum torque that can be generated when trying to maintain the relative joint constraint. - + - Script interface for the Texture Sheet Animation module. + The world-space position that is currently trying to be maintained. - + - Specifies the animation type. + Accesses remote settings (common for all game instances). - + - Specifies how many times the animation will loop during the lifetime of the particle. + Returns the value corresponding to key in the remote settings if it exists. + + - + - Enable/disable the Texture Sheet Animation module. + Returns the value corresponding to key in the remote settings if it exists. + + - + - Curve to control which frame of the texture sheet animation to play. + Returns number of keys in remote settings. - + - Defines the tiling of the texture in the X axis. + Returns the value corresponding to key in the remote settings if it exists. + + - + - Defines the tiling of the texture in the Y axis. + Returns the value corresponding to key in the remote settings if it exists. + + - + - Explicitly select which row of the texture sheet is used, when ParticleSystem.TextureSheetAnimationModule.useRandomRow is set to false. + Returns the value corresponding to key in the remote settings if it exists. + + - + - Use a random row of the texture sheet for each particle emitted. + Returns the value corresponding to key in the remote settings if it exists. + + - + - Script interface for the Velocity Over Lifetime module. + Returns all the keys in remote settings. - + - Enable/disable the Velocity Over Lifetime module. + Returns the value corresponding to key in the remote settings if it exists. + + - + - Specifies if the velocities are in local space (rotated with the transform) or world space. + Returns the value corresponding to key in the remote settings if it exists. + + - + - Curve to control particle speed based on lifetime, on the X axis. + Returns true if key exists in the remote settings. + - + - Curve to control particle speed based on lifetime, on the Y axis. + This event occurs when a new RemoteSettings is fetched and successfully parsed from the server. + - + - Curve to control particle speed based on lifetime, on the Z axis. + This event occurs when a new RemoteSettings is fetched and successfully parsed from the server. - + - The animation type. + Color or depth buffer part of a RenderTexture. - + - Animate a single row in the sheet from left to right. + 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. - + - Animate over the whole texture sheet from left to right, top to bottom. + General functionality for all renderers. - + - Whether to use 2D or 3D colliders for particle collisions. + The bounding volume of the renderer (Read Only). - + - Use 2D colliders to collide particles against. + Makes the rendered 3D object visible if enabled. - + - Use 3D colliders to collide particles against. + Has this renderer been statically batched with any other renderers? - + - Quality of world collisions. Medium and low quality are approximate and may leak particles. + Is this renderer visible in any camera? (Read Only) - + - The most accurate world collisions. + The index of the baked lightmap applied to this renderer. - + - Fastest and most approximate world collisions. + The UV scale & offset used for a lightmap. - + - Approximate world collisions. + If set, the Renderer will use the Light Probe Proxy Volume component attached to the source GameObject. - + - The type of collisions to use for a given particle system. + The light probe interpolation type. - + - Collide with a list of planes. + Matrix that transforms a point from local space into world space (Read Only). - + - Collide with the world geometry. + Returns the first instantiated Material assigned to the renderer. - + - The particle curve mode (Shuriken). + Returns all the instantiated materials of this object. - + - Use a single constant for the ParticleSystem.MinMaxCurve. + Specifies the mode for motion vector rendering. - + - Use a single curve for the ParticleSystem.MinMaxCurve. + Specifies whether this renderer has a per-object motion vector pass. - + - Use a random value between 2 constants for the ParticleSystem.MinMaxCurve. + If set, Renderer will use this Transform's position to find the light or reflection probe. - + - Use a random value between 2 curves for the ParticleSystem.MinMaxCurve. + The index of the realtime lightmap applied to this renderer. - + - The mode in which particles are emitted. + The UV scale & offset used for a realtime lightmap. - + - Emit when emitter moves. + Does this object receive shadows? - + - Emit over time. + Should reflection probes be used for this Renderer? - + - The particle gradient mode (Shuriken). + Does this object cast shadows? - + - Use a single color for the ParticleSystem.MinMaxGradient. + The shared material of this object. - + - Use a single color gradient for the ParticleSystem.MinMaxGradient. + All the shared materials of this object. - + - Use a random value between 2 colors for the ParticleSystem.MinMaxGradient. + Unique ID of the Renderer's sorting layer. - + - Use a random value between 2 color gradients for the ParticleSystem.MinMaxGradient. + Name of the Renderer's sorting layer. - + - How to apply emitter velocity to particles. + Renderer's order within a sorting layer. - + - Apply the current emitter velocity to a particle, on every frame during its lifetime. + Should light probes be used for this Renderer? - + - Apply the emitter velocity at the time the particle was born, on every frame during its lifetime. + Matrix that transforms a point from world space into local space (Read Only). - + - The mesh emission type. + 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. + - + - Emit from the edges of the mesh. + Get per-renderer material property block. + - + - Emit from the surface of the mesh. + Lets you add per-renderer material parameters without duplicating a material. + - + - Emit from the vertices of the mesh. + Extension methods to the Renderer class, used only for the UpdateGIMaterials method used by the Global Illumination System. - + - Renders particles on to the screen (Shuriken). + Schedules an update of the albedo and emissive Textures of a system that contains the Renderer. + - + - Control the direction that particles face. + Ambient lighting mode. - + - How much are the particles stretched depending on the Camera's speed. + Ambient lighting is defined by a custom cubemap. - + - How much are the particles stretched in their direction of motion. + Flat ambient lighting. - + - Clamp the maximum particle size. + Skybox-based or custom ambient lighting. - + - Mesh used as particle instead of billboarded texture. + Trilight ambient lighting. - + - Clamp the minimum particle size. + Blend mode for controlling the blending. - + - How much are billboard particle normals oriented towards the camera. + Blend factor is (Ad, Ad, Ad, Ad). - + - Modify the pivot point used for rotating particles. + Blend factor is (Rd, Gd, Bd, Ad). - + - How particles are drawn. + Blend factor is (1, 1, 1, 1). - + - Biases particle system sorting amongst other transparencies. + Blend factor is (1 - Ad, 1 - Ad, 1 - Ad, 1 - Ad). - + - Sort particles within a system. + Blend factor is (1 - Rd, 1 - Gd, 1 - Bd, 1 - Ad). - + - How much are the particles stretched depending on "how fast they move". + Blend factor is (1 - As, 1 - As, 1 - As, 1 - As). - + - The rendering mode for particle systems (Shuriken). + Blend factor is (1 - Rs, 1 - Gs, 1 - Bs, 1 - As). - + - Render particles as billboards facing the player. (Default) + Blend factor is (As, As, As, As). - + - Render particles as billboards always facing up along the y-Axis. + Blend factor is (f, f, f, 1); where f = min(As, 1 - Ad). - + - Render particles as meshes. + Blend factor is (Rs, Gs, Bs, As). - + - Stretch particles in the direction of motion. + Blend factor is (0, 0, 0, 0). - + - Render particles as billboards always facing the player, but not pitching along the x-Axis. + Blend operation. - + - How particles are aligned when rendered. + Add (s + d). - + - Particles align with their local transform. + Color burn (Advanced OpenGL blending). - + - Particles face the camera. + Color dodge (Advanced OpenGL blending). - + - Particles align with the world. + Darken (Advanced OpenGL blending). - + - Control how particle systems apply transform scale. + Difference (Advanced OpenGL blending). - + - Scale the particle system using the entire transform hierarchy. + Exclusion (Advanced OpenGL blending). - + - Scale the particle system using only its own transform scale. (Ignores parent scale). + Hard light (Advanced OpenGL blending). - + - Only apply transform scale to the shape component, which cotnrols where particles are spawned, but does not affect their size or movement. + HSL color (Advanced OpenGL blending). - + - The emission shape (Shuriken). + HSL Hue (Advanced OpenGL blending). - + - Emit from the volume of a box. + HSL luminosity (Advanced OpenGL blending). - + - Emit from a circle. + HSL saturation (Advanced OpenGL blending). - + - Emit from the edge of a circle. + Lighten (Advanced OpenGL blending). - + - Emit from the base surface of a cone. + Logical AND (s & d) (D3D11.1 only). - + - Emit from the base surface of a cone. + Logical inverted AND (!s & d) (D3D11.1 only). - + - Emit from the volume of a cone. + Logical reverse AND (s & !d) (D3D11.1 only). - + - Emit from the surface of a cone. + Logical Clear (0). - + - Emit from the volume of a half-sphere. + Logical Copy (s) (D3D11.1 only). - + - Emit from the surface of a half-sphere. + Logical inverted Copy (!s) (D3D11.1 only). - + - Emit from a mesh. + Logical Equivalence !(s XOR d) (D3D11.1 only). - + - Emit from a mesh renderer. + Logical Inverse (!d) (D3D11.1 only). - + - Emit from an edge. + Logical NAND !(s & d). D3D11.1 only. - + - Emit from a skinned mesh renderer. + Logical No-op (d) (D3D11.1 only). - + - Emit from the volume of a sphere. + Logical NOR !(s | d) (D3D11.1 only). - + - Emit from the surface of a sphere. + Logical OR (s | d) (D3D11.1 only). - + - The space to simulate particles in. + Logical inverted OR (!s | d) (D3D11.1 only). - + - Simulate particles in local space. + Logical reverse OR (s | !d) (D3D11.1 only). - + - Simulate particles in world space. + Logical SET (1) (D3D11.1 only). - + - The sorting mode for particle systems. + Logical XOR (s XOR d) (D3D11.1 only). - + - Sort based on distance. + Max. - + - No sorting. + Min. - + - Sort the oldest particles to the front. + Multiply (Advanced OpenGL blending). - + - Sort the youngest particles to the front. + Overlay (Advanced OpenGL blending). - + - Physics material describes how to handle colliding objects (friction, bounciness). + Reverse subtract. - + - Determines how the bounciness is combined. + Screen (Advanced OpenGL blending). - + - How bouncy is the surface? A value of 0 will not bounce. A value of 1 will bounce without any loss of energy. + Soft light (Advanced OpenGL blending). - + - The friction used when already moving. This value has to be between 0 and 1. + Subtract. - + - If anisotropic friction is enabled, dynamicFriction2 will be applied along frictionDirection2. + Built-in temporary render textures produced during camera's rendering. - + - Determines how the friction is combined. + Target texture of currently rendering camera. - + - The direction of anisotropy. Anisotropic friction is enabled if the vector is not zero. + Currently active render target. - + - The friction coefficient used when an object is lying on a surface. + Camera's depth texture. - + - If anisotropic friction is enabled, staticFriction2 will be applied along frictionDirection2. + Camera's depth+normals texture. - + - Creates a new material. + Deferred shading G-buffer #0 (typically diffuse color). - + - Creates a new material named name. + Deferred shading G-buffer #1 (typically specular + roughness). - - + - Describes how physic materials of colliding objects are combined. + Deferred shading G-buffer #2 (typically normals). - + - Averages the friction/bounce of the two colliding materials. + Deferred shading G-buffer #3 (typically emission/lighting). - + - Uses the larger friction/bounce of the two colliding materials. + Deferred shading G-buffer #4 (typically occlusion mask for static lights if any). - + - Uses the smaller friction/bounce of the two colliding materials. + G-buffer #5 Available. - + - Multiplies the friction/bounce of the two colliding materials. + G-buffer #6 Available. - + - Global physics properties and helper methods. + G-buffer #7 Available. - + - Two colliding objects with a relative velocity below this will not bounce (default 2). Must be positive. + Motion Vectors generated when the camera has motion vectors enabled. - + - The default contact offset of the newly created colliders. + Deferred lighting light buffer. - + - The gravity applied to all rigid bodies in the scene. + Deferred lighting HDR specular light buffer (Xbox 360 only). - + - The default maximum angular velocity permitted for any rigid bodies (default 7). Must be positive. + Deferred lighting (normals+specular) G-buffer. - + - The minimum contact penetration value in order to apply a penalty force (default 0.05). Must be positive. + Reflections gathered from default reflection and reflections probes. - + - Specifies whether queries (raycasts, spherecasts, overlap tests, etc.) hit Triggers by default. + Resolved depth buffer from deferred. - + - The default angular velocity, below which objects start sleeping (default 0.14). Must be positive. + Built-in shader modes used by Rendering.GraphicsSettings. - + - The mass-normalized energy threshold, below which objects start going to sleep. + Don't use any shader, effectively disabling the functionality. - + - The default linear velocity, below which objects start going to sleep (default 0.15). Must be positive. + Use built-in shader (default). - + - The default solver iteration count permitted for any rigid bodies (default 7). Must be positive. + Use custom shader instead of built-in one. - + - Layer mask constant to select all layers. + Built-in shader types used by Rendering.GraphicsSettings. - + - Casts the box along a ray and returns detailed information on what was hit. + Shader used for deferred reflection probes. - 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. + Shader used for deferred shading calculations. - 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. + Shader used for depth and normals texture when enabled on a Camera. - 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. + Shader used for legacy deferred lighting calculations. - 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. + Default shader used for lens flares. - 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. - - + - Casts a capsule against all colliders in the scene and returns detailed information on what was hit. + Default shader used for light halos. - 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. - - + - Casts a capsule against all colliders in the scene and returns detailed information on what was hit. + Shader used for Motion Vectors when enabled on a Camera. - 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. - - + - Casts a capsule against all colliders in the scene and returns detailed information on what was hit. + Shader used for screen-space cascaded shadows. - 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. - - + - + Defines a place in camera's rendering to attach Rendering.CommandBuffer objects to. - 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. - + - + After camera's depth+normals texture is generated. - 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. - + - + After camera's depth texture is generated. - 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. - + - + After camera has done rendering everything. - 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. + After final geometry pass in deferred lighting. - 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. - - + - Like Physics.CapsuleCast, but this function will return all hits the capsule sweep intersects. + After transparent objects in forward rendering. - 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. - - + - Like Physics.CapsuleCast, but this function will return all hits the capsule sweep intersects. + After opaque objects in forward rendering. - 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. - - + - Like Physics.CapsuleCast, but this function will return all hits the capsule sweep intersects. + After deferred rendering G-buffer is rendered. - 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. + After image effects. - 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. + After image effects that happen between opaque & transparent objects. - 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. + After lighting pass in deferred rendering. - 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. - + - Checks if any colliders overlap a capsule-shaped volume in world space. + After reflections pass in deferred rendering. - 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. - + - Checks if any colliders overlap a capsule-shaped volume in world space. + After skybox is drawn. - 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. + Before camera's depth+normals texture is generated. - 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 true if there are any colliders overlapping the sphere defined by position and radius in world coordinates. + Before camera's depth texture is generated. - 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 true if there are any colliders overlapping the sphere defined by position and radius in world coordinates. + Before final geometry pass in deferred lighting. - 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. - + - Layer mask constant to select default raycast layers. + Before transparent objects in forward rendering. - + - Are collisions between layer1 and layer2 being ignored? + Before opaque objects in forward rendering. - - - + - Makes the collision detection system ignore all collisions between collider1 and collider2. + Before deferred rendering G-buffer is rendered. - - - - + - Makes the collision detection system ignore all collisions between collider1 and collider2. + Before image effects. - - - - + - 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. + Before image effects that happen between opaque & transparent objects. - - - - + - 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. + Before lighting pass in deferred rendering. - - - - + - Layer mask constant to select ignore raycast layer. + Before reflections pass in deferred rendering. - + - Returns true if there is any collider intersecting the line between start and end. + Before skybox is drawn. - 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. + The HDR mode to use for rendering. - 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. + Uses RenderTextureFormat.ARGBHalf. - 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. + Uses RenderTextureFormat.RGB111110Float. - 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). - + - Returns true if there is any collider intersecting the line between start and end. + Specifies which color components will get written into the target framebuffer. - 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). - + - Returns true if there is any collider intersecting the line between start and end. + Write all components (R, G, B and Alpha). - 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. + Write alpha component. - 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. + Write blue component. - 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. - - + - Returns an array with all colliders touching or inside the sphere. + Write green component. - 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. - + - Returns an array with all colliders touching or inside the sphere. + Write red component. - 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. - + - Returns an array with all colliders touching or inside the sphere. + List of graphics commands to execute. - 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. + Name of this command 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 against all colliders in the scene. + Size of this command buffer in bytes (Read Only). - 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. - - True when the ray intersects any collider, otherwise false. - - + - Casts a ray against all colliders in the scene. + Adds a command to begin profile sampling. - 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. - - True when the ray intersects any collider, otherwise false. - + Name of the profile information used for sampling. - + - Casts a ray against all colliders in the scene. + Add a "blit into a render texture" command. - 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. - - True when the ray intersects any collider, otherwise false. - + 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"). - + - Casts a ray against all colliders in the scene. + Add a "blit into a render texture" command. - 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. - - True when the ray intersects any collider, otherwise false. - + 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"). - + - Casts a ray against all colliders in the scene and returns detailed information on what was hit. + Add a "blit into a render texture" command. - 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 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. - - True when the ray intersects any collider, otherwise false. - + 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"). - + - Casts a ray against all colliders in the scene and returns detailed information on what was hit. + Add a "blit into a render texture" command. - 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 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. - - True when the ray intersects any collider, otherwise false. - + 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"). - + - Casts a ray against all colliders in the scene and returns detailed information on what was hit. + Add a "blit into a render texture" command. - 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 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. - - True when the ray intersects any collider, otherwise false. - + 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"). - + - Casts a ray against all colliders in the scene and returns detailed information on what was hit. + Add a "blit into a render texture" command. - 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 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. - - True when the ray intersects any collider, otherwise false. - + 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"). - + - Same as above using ray.origin and ray.direction instead of origin and direction. + Clear all commands in the buffer. - 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. - - True when the ray intersects any collider, otherwise false. - - + - Same as above using ray.origin and ray.direction instead of origin and direction. + Adds a "clear render target" command. - 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. - - True when the ray intersects any collider, otherwise false. - + Should clear depth buffer? + Should clear color buffer? + Color to clear with. + Depth to clear with (default is 1.0). - + - Same as above using ray.origin and ray.direction instead of origin and direction. + Adds a command to copy ComputeBuffer counter value. - 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. - - True when the ray intersects any collider, otherwise false. - + 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). - + - Same as above using ray.origin and ray.direction instead of origin and direction. + Create a new empty command buffer. - 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. - - True when the ray intersects any collider, otherwise false. - - + - Same as above using ray.origin and ray.direction instead of origin and direction. + Adds a command to disable global shader keyword. - 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 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. - - True when the ray intersects any collider, otherwise false. - + Shader keyword to disable. - + - Same as above using ray.origin and ray.direction instead of origin and direction. + Add a command to execute a ComputeShader. - 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 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. - - True when the ray intersects any collider, otherwise false. - + 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. - + - Same as above using ray.origin and ray.direction instead of origin and direction. + Add a command to execute a ComputeShader. - 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 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. - - True when the ray intersects any collider, otherwise false. - + 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. - + - Same as above using ray.origin and ray.direction instead of origin and direction. + Add a "draw mesh" command. - 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 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. - - True when the ray intersects any collider, otherwise false. - + 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. - + - Casts a ray through the scene and returns all hits. Note that order is not guaranteed. + 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 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. + 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. - + - Casts a ray through the scene and returns all hits. Note that order is not guaranteed. + Add a "draw mesh with indirect instancing" command. - 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. + 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. - + - Casts a ray through the scene and returns all hits. Note that order is not guaranteed. + Add a "draw procedural geometry" command. - 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. + 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. - + - Casts a ray through the scene and returns all hits. Note that order is not guaranteed. + Add a "draw procedural geometry" command. - 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. + 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. - + - See Also: Raycast. + Add a "draw renderer" command. - 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. + 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). - + - See Also: Raycast. + Adds a command to enable global shader keyword. - 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. + Shader keyword to enable. - + - See Also: Raycast. + Adds a command to begin profile sampling. - 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. + Name of the profile information used for sampling. - + - See Also: Raycast. + Add a "get a temporary render texture" command. - 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. + 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). - + - Cast a ray through the scene and store the hits into the buffer. + Send a user-defined event to a native code plugin. - 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. - + Native code callback to queue for Unity's renderer to invoke. + User defined id to send to the callback. - + - Cast a ray through the scene and store the hits into the buffer. + Add a "release a temporary render texture" command. - 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. - + Shader property name for this texture. - + - Casts a sphere along a ray and returns detailed information on what was hit. + Adds a command to set an input or output buffer parameter on a ComputeShader. - 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. - + ComputeShader to set parameter for. + Which kernel the buffer is being set for. See ComputeShader.FindKernel. + Name of the buffer variable in shader code. + Buffer to set. - + - Casts a sphere along a ray and returns detailed information on what was hit. + Adds a command to set a float parameter on a ComputeShader. - 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. - + ComputeShader to set parameter for. + Name of the variable in shader code. + Value to set. - + - Casts a sphere along a ray and returns detailed information on what was hit. + Adds a command to set multiple consecutive float parameters on a ComputeShader. - 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. - + ComputeShader to set parameter for. + Name of the variable in shader code. + Values to set. - + - Casts a sphere along a ray and returns detailed information on what was hit. + Adds a command to set an integer parameter on a ComputeShader. - 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. - + ComputeShader to set parameter for. + Name of the variable in shader code. + Value to set. - + - Casts a sphere along a ray and returns detailed information on what was hit. + Adds a command to set multiple consecutive integer parameters on a ComputeShader. - 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. - + ComputeShader to set parameter for. + Name of the variable in shader code. + Values to set. - + - Casts a sphere along a ray and returns detailed information on what was hit. + Adds a command to set a texture parameter on a ComputeShader. - 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. - + ComputeShader to set parameter for. + Which kernel the texture is being set for. See ComputeShader.FindKernel. + Name of the texture variable in shader code. + Texture value or identifier to set, see RenderTargetIdentifier. - + - Casts a sphere along a ray and returns detailed information on what was hit. + Adds a command to set a vector parameter on a ComputeShader. - 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. - + ComputeShader to set parameter for. + Name of the variable in shader code. + Value to set. - + - Casts a sphere along a ray and returns detailed information on what was hit. + Add a "set global shader buffer property" command. - 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. - + + + - + - + Add a "set global shader buffer property" command. - 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. + + + - + - + Add a "set global shader color property" command. - 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. + + + - + - + Add a "set global shader color property" command. - 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. + + + - + - + Add a command to set global depth bias. - 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. + Constant depth bias. + Slope-dependent depth bias. - + - Like Physics.SphereCast, but this function will return all hits the sphere sweep intersects. + Add a "set global shader float property" command. - 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. + Add a "set global shader float property" command. - 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. + Add a "set global shader float array property" command. - 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. + Add a "set global shader float array property" command. - 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. + Add a "set global shader float array property" command. - 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. + + + - + - Like Physics.SphereCast, but this function will return all hits the sphere sweep intersects. + Add a "set global shader float array property" command. - 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. + + + - + - Like Physics.SphereCast, but this function will return all hits the sphere sweep intersects. + Add a "set global shader matrix property" command. - 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. + + + - + - Like Physics.SphereCast, but this function will return all hits the sphere sweep intersects. + Add a "set global shader matrix property" command. - 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. + Add a "set global shader matrix array property" command. - 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. + Add a "set global shader matrix array property" command. - 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. - + + + - + - Global settings and helpers for 2D physics. + Add a "set global shader matrix array property" command. + + + - + - A rigid-body cannot sleep if its angular velocity is above this tolerance. + Add a "set global shader matrix array property" command. + + + - + - The scale factor that controls how fast overlaps are resolved. + Add a "set global shader texture property" command, referencing a RenderTexture. + + + + + + + + Add a "set global shader texture property" command, referencing a RenderTexture. + + + - + - The scale factor that controls how fast TOI overlaps are resolved. + Add a "set global shader vector property" command. + + + - + - Whether or not to stop reporting collision callbacks immediately if any of the objects involved in the collision are deleted/moved. + Add a "set global shader vector property" command. + + + - + - Whether to stop processing collision callbacks if any of the objects involved in the collision are deleted or not. + Add a "set global shader vector array property" command. + + + - + - Acceleration due to gravity. + Add a "set global shader vector array property" command. + + + - + - A rigid-body cannot sleep if its linear velocity is above this tolerance. + Add a "set global shader vector array property" command. + + + - + - The maximum angular position correction used when solving constraints. This helps to prevent overshoot. + Add a "set global shader vector array property" command. + + + - + - The maximum linear position correction used when solving constraints. This helps to prevent overshoot. + Add a command to set the projection matrix. + Projection (camera to clip space) matrix. - + - The maximum angular speed of a rigid-body per physics update. Increasing this can cause numerical problems. + 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. - + - The maximum linear speed of a rigid-body per physics update. Increasing this can cause numerical problems. + 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. - + - The minimum contact penetration radius allowed before any separation impulse force is applied. Extreme caution should be used when modifying this value as making this smaller means that polygons will have an insufficient buffer for continuous collision and making it larger may create artefacts for vertex collision. + 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. - + - The number of iterations of the physics solver when considering objects' positions. + 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. - + - Do raycasts detect Colliders configured as triggers? + 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. - + - Do ray/line casts that start inside a collider(s) detect those collider(s)? + 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. - + - Do raycasts detect Colliders configured as triggers? + 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. - + - Do ray/line casts that start inside a collider(s) detect those collider(s)? + 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. - + - The time in seconds that a rigid-body must be still before it will go to sleep. + 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. - + - The number of iterations of the physics solver when considering objects' velocities. + Add a "set shadow sampling mode" command. + Shadowmap render target to change the sampling mode on. + New sampling mode. - + - Any collisions with a relative linear velocity below this threshold will be treated as inelastic. + Add a command to set the view matrix. + View (world to camera space) matrix. - + - Layer mask constant that includes all layers. + Add a command to set the rendering viewport. + Viewport rectangle in pixel coordinates. - + - Casts a box against colliders in the scene, returning the first collider to contact with it. + Add a command to set the view and projection matrices. - The point in 2D space where the shape originates. - The size of the shape. - The angle of the shape (in degrees). - Vector representing the direction of the shape. - Maximum distance over which to cast the shape. - 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. - + View (world to camera space) matrix. + Projection (camera to clip space) matrix. - + - Casts a box against colliders in the scene, returning all colliders that contact with it. + Depth or stencil comparison function. - The point in 2D space where the shape originates. - The size of the shape. - The angle of the shape (in degrees). - Vector representing the direction of the shape. - Maximum distance over which to cast the shape. - 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 box into the scene, returning colliders that contact with it into the provided results array. + Always pass depth or stencil test. - The point in 2D space where the shape originates. - The size of the shape. - The angle of the shape (in degrees). - Vector representing the direction of the shape. - Array to receive results. - Maximum distance over which to cast the shape. - 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 number of results returned. - - + - Casts a circle against colliders in the scene, returning the first collider to contact with it. + Depth or stencil test is disabled. - The point in 2D space where the shape originates. - The radius of the shape. - Vector representing the direction of the shape. - Maximum distance over which to cast the shape. - 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 circle against colliders in the scene, returning all colliders that contact with it. + Pass depth or stencil test when values are equal. - The point in 2D space where the shape originates. - The radius of the shape. - Vector representing the direction of the shape. - Maximum distance over which to cast the shape. - 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 circle into the scene, returning colliders that contact with it into the provided results array. + Pass depth or stencil test when new value is greater than old one. - The point in 2D space where the shape originates. - The radius of the shape. - Vector representing the direction of the shape. - Array to receive results. - Maximum distance over which to cast the shape. - 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 number of results returned. - - + - Layer mask constant that includes all layers participating in raycasts by default. + Pass depth or stencil test when new value is greater or equal than old one. - + - Checks whether the collision detection system will ignore all collisionstriggers between collider1 and collider2/ or not. + Pass depth or stencil test when new value is less than old one. - The first collider to compare to collider2. - The second collider to compare to collider1. - + - Should collisions between the specified layers be ignored? + Pass depth or stencil test when new value is less or equal than old one. - ID of first layer. - ID of second layer. - + - Cast a 3D ray against the colliders in the scene returning the first collider along the ray. + Never pass depth or stencil test. - 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. + Pass depth or stencil test when values are different. - 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. + Support for various Graphics.CopyTexture cases. - 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/. + Basic Graphics.CopyTexture support. - 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. + Support for Texture3D in Graphics.CopyTexture. - 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. + Support for Graphics.CopyTexture between different texture types. - + - Check whether collider1 is touching collider2 or not. + No support for Graphics.CopyTexture. - 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 collider is touching any colliders on the specified layerMask or not. + Support for RenderTexture to Texture copies in Graphics.CopyTexture. - 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 against colliders in the scene. + Support for Texture to RenderTexture copies in Graphics.CopyTexture. - 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 this value. - Only include objects with a Z coordinate (depth) less than this value. - - The cast results returned. - - + - Casts a line against colliders in the scene. + Backface culling mode. - 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 this value. - Only include objects with a Z coordinate (depth) less than this value. - - The cast results returned. - - + - Casts a line against colliders in the scene. + Cull back-facing geometry. - 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 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. - - The number of results returned. - - + - Check if a collider falls within a rectangular area. + Cull front-facing geometry. - One corner of the rectangle. - Diagonally opposite corner of the rectangle. - 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. - + - Get a list of all colliders that fall within a rectangular area. + Disable culling. - One corner of the rectangle. - Diagonally opposite corner of the rectangle. - 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. - + - Get a list of all colliders that fall within a specified area. + Default reflection mode. - One corner of the rectangle. - Diagonally opposite 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 this value. - Only include objects with a Z coordinate (depth) less than this value. - - The number of results returned. - - + - Check if a collider falls within a circular area. + Custom default reflection. - 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 this value. - Only include objects with a Z coordinate (depth) less than this value. - + - Get a list of all colliders that fall within a circular area. + Skybox-based default reflection. - Only include objects with a Z coordinate (depth) greater than this value. - Only include objects with a Z coordinate (depth) less than this value. - Center of the circle. - Radius of the circle. - Filter to check objects only on specified layers. - + - Get a list of all colliders that fall within a circular area. + Graphics device API type. - Only include objects with a Z coordinate (depth) greater than this value. - Only include objects with a Z coordinate (depth) less than this value. - Center of the circle. - Radius of the circle. - Array to receive results. - Filter to check objects only on specific layers. - - The number of results returned. - - + - Check if a collider overlaps a point in space. + Direct3D 11 graphics API. - A point in world space. - 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. - + - Get a list of all colliders that overlap a point in space. + Direct3D 12 graphics API. - Only include objects with a Z coordinate (depth) greater than this value. - Only include objects with a Z coordinate (depth) less than this value. - A point in space. - Filter to check objects only on specific layers. - + - Get a list of all colliders that overlap a point in space. + Direct3D 9 graphics API. - Only include objects with a Z coordinate (depth) greater than this value. - Only include objects with a Z coordinate (depth) less than this value. - A point in space. - Array to receive results. - Filter to check objects only on specific layers. - - The number of results returned. - - + - Casts a ray against colliders in the scene. + iOS Metal graphics API. - The point in 2D space where the ray originates. - 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 this value. - Only include objects with a Z coordinate (depth) less than this value. - - The cast results returned. - - + - Casts a ray against colliders in the scene, returning all colliders that contact with it. + Nintendo 3DS graphics API. - The point in 2D space where the ray originates. - 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 this value. - Only include objects with a Z coordinate (depth) less than this value. - - The cast results returned. - - + - Casts a ray into the scene. + No graphics API. - 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 point in 2D space where the ray originates. - 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. - - The number of results returned. - - + - Asset type that defines the surface properties of a Collider2D. + OpenGL 2.x graphics API. (deprecated, only available on Linux and MacOSX) - + - The degree of elasticity during collisions. + OpenGL (Core profile - GL3 or later) graphics API. - + - Coefficient of friction. + OpenGL ES 2.0 graphics API. - + - A base type for 2D physics components that required a callback during FixedUpdate. + OpenGL ES 3.0 graphics API. - + - Ping any given IP address (given in dot notation). + PlayStation 3 graphics API. - + - The IP target of the ping. + PlayStation 4 graphics API. - + - Has the ping function completed? + PlayStation Mobile (PSM) graphics API. - + - This property contains the ping time result after isDone returns true. + PlayStation Vita graphics API. - + - Perform a ping to the supplied target IP address. + Vulkan (EXPERIMENTAL). - - + - Representation of a plane in 3D space. + Xbox One graphics API. - + - Distance from the origin to the plane. + Script interface for. - + - Normal vector of the plane. + Whether to use a Light's color temperature when calculating the final color of that Light." - + - Creates a plane. + If this is true, Light intensity is multiplied against linear color values. If it is false, gamma color values are used. - - - + - Creates a plane. + The RenderPipelineAsset that describes how the Scene should be rendered. - - - + - Creates a plane. + An axis that describes the direction along which the distances of objects are measured for the purpose of sorting. - - - - + - Returns a signed distance from plane to point. + Transparent object sorting mode. - - + - Is a point on the positive side of the plane? + Get custom shader used instead of a built-in shader. - + Built-in shader type to query custom shader for. + + The shader used. + - + - Intersects a ray with the plane. + Get built-in shader mode. - - + Built-in shader type to query. + + Mode used for built-in shader. + - + - Are two points on the same side of the plane? + Set custom shader to use instead of a built-in shader. - - + Built-in shader type to set custom shader to. + The shader to use. - + - 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. + Set built-in shader mode. - First point in clockwise order. - Second point in clockwise order. - Third point in clockwise order. + Built-in shader type to change. + Mode to use for built-in shader. - + - Sets a plane using a point that lies within it along with a normal to orient it. + Graphics Tier. +See Also: Graphics.activeTier. - The plane's normal vector. - A point that lies on the plane. - + - Applies "platform" behaviour such as one-way collisions etc. + The first graphics tier (Low) - corresponds to shader define UNITY_HARDWARE_TIER1. - + - Whether to use one-way collision behaviour or not. + The second graphics tier (Medium) - corresponds to shader define UNITY_HARDWARE_TIER2. - + - The angle variance centered on the sides of the platform. Zero angle only matches sides 90-degree to the platform "top". + The third graphics tier (High) - corresponds to shader define UNITY_HARDWARE_TIER3. - + - 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. + Defines a place in light's rendering to attach Rendering.CommandBuffer objects to. - + - Whether bounce should be used on the platform sides or not. + After directional light screenspace shadow mask is computed. - + - Whether friction should be used on the platform sides or not. + After shadowmap is rendered. - + - The angle of an arc that defines the surface of the platform centered of the local 'up' of the effector. + After shadowmap pass is rendered. - + - Should the one-way collision behaviour be used? + Before directional light screenspace shadow mask is computed. - + - Ensures that all contacts controlled by the one-way behaviour act the same. + Before shadowmap is rendered. - + - Should bounce be used on the platform sides? + Before shadowmap pass is rendered. - + - Should friction be used on the platform sides? + Light probe interpolation type. - + - Stores and accesses player preferences between game sessions. + Simple light probe interpolation is used. - + - Removes all keys and values from the preferences. Use with caution. + Light Probes are not used. - + - Removes key and its corresponding value from the preferences. + Uses a 3D grid of interpolated light probes. - - + - Returns the value corresponding to key in the preference file if it exists. + Shadow resolution options for a Light. - - - + - Returns the value corresponding to key in the preference file if it exists. + Use resolution from QualitySettings (default). - - - + - Returns the value corresponding to key in the preference file if it exists. + High shadow map resolution. - - - + - Returns the value corresponding to key in the preference file if it exists. + Low shadow map resolution. - - - + - Returns the value corresponding to key in the preference file if it exists. + Medium shadow map resolution. - - - + - Returns the value corresponding to key in the preference file if it exists. + Very high shadow map resolution. - - - + - Returns true if key exists in the preferences. + Opaque object sorting mode of a Camera. - - + - Writes all modified preferences to disk. + Default opaque sorting mode. - + - Sets the value of the preference identified by key. + Do rough front-to-back sorting of opaque objects. - - - + - Sets the value of the preference identified by key. + Do not sort opaque objects by distance. - - - + - Sets the value of the preference identified by key. + Shader pass type for Unity's lighting pipeline. - - - + - An exception thrown by the PlayerPrefs class in a web player build. + Deferred Shading shader pass. - + - Used by Animation.Play function. + Forward rendering additive pixel light pass. - + - Will stop all animations that were started with this component before playing. + Forward rendering base pass. - + - Will stop all animations that were started in the same layer. This is the default when playing animations. + Legacy deferred lighting (light pre-pass) base pass. - + - Applies forces to attract/repulse against a point. + Legacy deferred lighting (light pre-pass) final pass. - + - The angular drag to apply to rigid-bodies. + Shader pass used to generate the albedo and emissive values used as input to lightmapping. - + - The scale applied to the calculated distance between source and target. + Motion vector render pass. - + - The linear drag to apply to rigid-bodies. + Regular shader pass that does not interact with lighting. - + - The magnitude of the force to be applied. + Shadow caster & depth texure shader pass. - + - The mode used to apply the effector force. + Legacy vertex-lit shader pass. - + - The source which is used to calculate the centroid point of the effector. The distance from the target is defined from this point. + Legacy vertex-lit shader pass, with mobile lightmaps. - + - The target for where the effector applies any force. + Legacy vertex-lit shader pass, with desktop (RGBM) lightmaps. - + - The variation of the magnitude of the force to be applied. + How much CPU usage to assign to the final lighting calculations at runtime. - + - Collider for 2D physics representing an arbitrary polygon defined by its vertices. + 75% of the allowed CPU threads are used as worker threads. - + - The number of paths in the polygon. + 25% of the allowed CPU threads are used as worker threads. - + - Corner points that define the collider's shape in local space. + 50% of the allowed CPU threads are used as worker threads. - + - Creates as regular primitive polygon with the specified number of sides. + 100% of the allowed CPU threads are used as worker threads. - 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. - + - Get a path from the polygon by its index. + Determines how Unity will compress baked reflection cubemap. - The index of the path to retrieve. - + - Return the total number of points in the polygon in all paths. + Baked Reflection cubemap will be compressed if compression format is suitable. - + - Define a path by its constituent points. + Baked Reflection cubemap will be compressed. - Index of the path to set. - Points that define the path. - + - The various primitives that can be created using the GameObject.CreatePrimitive function. + Baked Reflection cubemap will be left uncompressed. - + - A capsule primitive. + ReflectionProbeBlendInfo contains information required for blending probes. - + - A cube primitive. + Reflection Probe used in blending. - + - A cylinder primitive. + Specifies the weight used in the interpolation between two probes, value varies from 0.0 to 1.0. - + - A plane primitive. + Values for ReflectionProbe.clearFlags, determining what to clear when rendering a ReflectionProbe. - + - A Quad primitive. + Clear with the skybox. - + - A sphere primitive. + Clear with a background color. - + - Substance memory budget. + Reflection probe's update mode. - + - A limit of 512MB for the cache or the working memory. + Reflection probe is baked in the Editor. - + - A limit of 256MB for the cache or the working memory. + Reflection probe uses a custom texture specified by the user. - + - No limit for the cache or the working memory. + Reflection probe is updating in realtime. - + - A limit of 1B (one byte) for the cache or the working memory. + An enum describing the way a realtime reflection probe refreshes in the Player. - + - A limit of 128MB for the cache or the working memory. + 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. - + - ProceduralMaterial loading behavior. + 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. - + - Bake the textures to speed up loading and discard the ProceduralMaterial data (default on unsupported platform). + 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. - + - Bake the textures to speed up loading and keep the ProceduralMaterial data so that it can still be tweaked and regenerated later on. + 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. - + - Generate the textures when loading and cache them to diskflash to speed up subsequent gameapplication startups. + 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. - + - Do not generate the textures. RebuildTextures() or RebuildTexturesImmediately() must be called to generate the textures. + 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. - + - Do not generate the textures. RebuildTextures() or RebuildTexturesImmediately() must be called to generate the textures. After the textures have been generrated for the first time, they are cached to diskflash to speed up subsequent gameapplication startups. + Unity will render the probe entirely in one frame. - + - Generate the textures when loading to favor application's size (default on supported platform). + Reflection Probe usage. - + - Class for ProceduralMaterial handling. + 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. - + - Set or get the update rate in millisecond of the animated substance. + Reflection probes are enabled. Blending occurs between probes or probes and default reflection, useful for outdoor environments. - + - Set or get the Procedural cache budget. + Reflection probes are disabled, skybox will be used for reflection. - + - Indicates whether cached data is available for this ProceduralMaterial's textures (only relevant for Cache and DoNothingAndCache loading behaviors). + Reflection probes are enabled, but no blending will occur between probes when there are two overlapping volumes. - + - Returns true if FreezeAndReleaseSourceData was called on this ProceduralMaterial. + Handling of loading RenderBuffer contents on setting as active RenderTarget. - + - Should the ProceduralMaterial be generated at load time? + RenderBuffer will try to skip loading its contents on setting as Render Target. - + - Check if the ProceduralTextures from this ProceduralMaterial are currently being rebuilt. + Make RenderBuffer to Load its contents when setting as RenderTarget. - + - Set or get the "Readable" flag for a ProceduralMaterial. + Handling of storing RenderBuffer contents after it was an active RenderTarget and another RenderTarget was set. - + - Check if ProceduralMaterials are supported on the current platform. + RenderBuffer will try to skip storing its contents. - + - Get ProceduralMaterial loading behavior. + Make RenderBuffer to Store its contents. - + - Set or get an XML string of "input/value" pairs (setting the preset rebuilds the textures). + Determine in which order objects are renderered. - + - Used to specify the Substance engine CPU usage. + Alpha tested geometry uses this queue. - + - Specifies if a named ProceduralProperty should be cached for efficient runtime tweaking. + This render queue is rendered before any others. - - - + - Clear the Procedural cache. + Opaque geometry uses this queue. - + - Render a ProceduralMaterial immutable and release the underlying data to decrease the memory footprint. + Last render queue that is considered "opaque". - + - This allows to get a reference to a ProceduralTexture generated by a ProceduralMaterial using its name. + This render queue is meant for overlay effects. - The name of the ProceduralTexture to get. - + - Get generated textures. + This render queue is rendered after Geometry and AlphaTest, in back-to-front order. - + - Get a named Procedural boolean property. + Identifies a RenderTexture for a Rendering.CommandBuffer. - - + - Get a named Procedural color property. + 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. - + - Get a named Procedural enum property. + 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. - + - Get a named Procedural float property. + 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. - + - Get an array of descriptions of all the ProceduralProperties this ProceduralMaterial has. + 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. - + - Get a named Procedural texture property. + How shadows are cast from this object. - - + - Get a named Procedural vector property. + No shadows are cast from this object. - - + - Checks if the ProceduralMaterial has a ProceduralProperty of a given name. + Shadows are cast from this object. - - + - Checks if a named ProceduralProperty is cached for efficient runtime tweaking. + Object casts shadows, but is otherwise invisible in the scene. - - + - Checks if a given ProceduralProperty is visible according to the values of this ProceduralMaterial's other ProceduralProperties and to the ProceduralProperty's visibleIf expression. + Shadows are cast from this object, treating it as two-sided. - The name of the ProceduralProperty whose visibility is evaluated. - + - Triggers an asynchronous rebuild of this ProceduralMaterial's dirty textures. + Allows precise control over which shadow map passes to execute Rendering.CommandBuffer objects attached using Light.AddCommandBuffer. - + - Triggers an immediate (synchronous) rebuild of this ProceduralMaterial's dirty textures. + All shadow map passes. - + - Set a named Procedural boolean property. + All directional shadow map passes. - - - + - Set a named Procedural color property. + First directional shadow map cascade. - - - + - Set a named Procedural enum property. + Second directional shadow map cascade. - - - + - Set a named Procedural float property. + Third directional shadow map cascade. - - - + - Set a named Procedural texture property. + Fourth directional shadow map cascade. - - - + - Set a named Procedural vector property. + All point light shadow passes. - - - + - Discard all the queued ProceduralMaterial rendering operations that have not started yet. + -X point light shadow cubemap face. - + - The type of generated image in a ProceduralMaterial. + -Y point light shadow cubemap face. - + - Ambient occlusion map. + -Z point light shadow cubemap face. - + - Detail mask map. + +X point light shadow cubemap face. - + - Diffuse map. + +Y point light shadow cubemap face. - + - Emissive map. + +Z point light shadow cubemap face. - + - Height map. + Spotlight shadow pass. - + - Metalness map. + Used by CommandBuffer.SetShadowSamplingMode. - + - Normal (Bump) map. + Default shadow sampling mode: sampling with a comparison filter. - + - Opacity (Tranparency) map. + Shadow sampling mode for sampling the depth value. - + - Roughness map. + Adding a SortingGroup component to a GameObject will ensure that all Renderers within the GameObject's descendants will be sorted and rendered together. - + - Smoothness map (formerly referred to as Glossiness). + Unique ID of the Renderer's sorting layer. - + - Specular map. + Name of the Renderer's sorting layer. - + - Undefined type. + Renderer's order within a sorting layer. - + - The global Substance engine processor usage (as used for the ProceduralMaterial.substanceProcessorUsage property). + Spherical harmonics up to the second order (3 bands, 9 coefficients). - + - All physical processor cores are used for ProceduralMaterial generation. + Add ambient lighting to probe data. + - + - Half of all physical processor cores are used for ProceduralMaterial generation. + Add directional light to probe data. + + + - + - A single physical processor core is used for ProceduralMaterial generation. + Clears SH probe to zero. - + - Exact control of processor usage is not available. + 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. - + - Describes a ProceduralProperty. + Returns true if SH probes are equal. + + - + - The names of the individual components of a Vector234 ProceduralProperty. + Scales SH by a given factor. + + - + - The available options for a ProceduralProperty of type Enum. + Scales SH by a given factor. + + - + - The name of the GUI group. Used to display ProceduralProperties in groups. + Returns true if SH probes are different. + + - + - If true, the Float or Vector property is constrained to values within a specified range. + Adds two SH probes. + + - + - The label of the ProceduralProperty. Can contain space and be overall more user-friendly than the 'name' member. + Access individual SH coefficients. - + - If hasRange is true, maximum specifies the maximum allowed value for this Float or Vector property. + Provides an interface to the Unity splash screen. - + - If hasRange is true, minimum specifies the minimum allowed value for this Float or Vector property. + Returns true once the splash screen as finished. This is once all logos have been shown for their specified duration. - + - The name of the ProceduralProperty. Used to get and set the values. + 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. - + - Specifies the step size of this Float or Vector property. Zero is no step. + Immediately draws the splash screen. Ensure you have called Rendering.SplashScreen.Begin before you start calling this. - + - The ProceduralPropertyType describes what type of property this is. + Specifies the operation that's performed on the stencil buffer when rendering. - + - The type of a ProceduralProperty. + Decrements the current stencil buffer value. Clamps to 0. - + - Procedural boolean property. Use with ProceduralMaterial.GetProceduralBoolean. + Decrements the current stencil buffer value. Wraps stencil buffer value to the maximum representable unsigned value when decrementing a stencil buffer value of zero. - + - Procedural Color property without alpha. Use with ProceduralMaterial.GetProceduralColor. + Increments the current stencil buffer value. Clamps to the maximum representable unsigned value. - + - Procedural Color property with alpha. Use with ProceduralMaterial.GetProceduralColor. + Increments the current stencil buffer value. Wraps stencil buffer value to zero when incrementing the maximum representable unsigned value. - + - Procedural Enum property. Use with ProceduralMaterial.GetProceduralEnum. + Bitwise inverts the current stencil buffer value. - + - Procedural float property. Use with ProceduralMaterial.GetProceduralFloat. + Keeps the current stencil value. - + - Procedural Texture property. Use with ProceduralMaterial.GetProceduralTexture. + Replace the stencil buffer value with reference value (specified in the shader). - + - Procedural Vector2 property. Use with ProceduralMaterial.GetProceduralVector. + Sets the stencil buffer value to zero. - + - Procedural Vector3 property. Use with ProceduralMaterial.GetProceduralVector. + Texture "dimension" (type). - + - Procedural Vector4 property. Use with ProceduralMaterial.GetProceduralVector. + Any texture type. - + - Class for ProceduralTexture handling. + Cubemap texture. - + - The format of the pixel data in the texture (Read Only). + Cubemap array texture (CubemapArray). - + - Check whether the ProceduralMaterial that generates this ProceduralTexture is set to an output format with an alpha channel. + No texture is assigned. - + - Grab pixel values from a ProceduralTexture. - + 2D texture (Texture2D). - X-coord of the top-left corner of the rectangle to grab. - Y-coord of the top-left corner of the rectangle to grab. - Width of rectangle to grab. - Height of the rectangle to grab. -Get the pixel values from a rectangular area of a ProceduralTexture into an array. -The block is specified by its x,y offset in the texture and by its width and height. The block is "flattened" into the array by scanning the pixel values across rows one by one. - + - The output type of this ProceduralTexture. + 2D array texture (Texture2DArray). - + - Controls the from script. + 3D volume texture (Texture3D). - + - Sets profiler output file in built players. + Texture type is not initialized or unknown. - + - Enables the Profiler. + A flag representing each UV channel. - + - Sets profiler output file in built players. + First UV channel. - + - Resize the profiler sample buffers to allow the desired amount of samples per thread. + Second UV channel. - + - Heap size used by the program. + Third UV channel. - - Size of the used heap in bytes, (or 0 if the profiler is disabled). - - + - Displays the recorded profiledata in the profiler. + Fourth UV channel. - - + - Begin profiling a piece of code with a custom label. + Rendering path of a Camera. - - - + - Begin profiling a piece of code with a custom label. + Deferred Lighting (Legacy). - - - + - End profiling a piece of code with a custom label. + Deferred Shading. - + - Returns the size of the mono heap. + Forward Rendering. - + - Returns the used size from mono. + Use Player Settings. - + - Returns the runtime memory usage of the resource. + Vertex Lit. - - + - A script interface for a. + RenderMode for the Canvas. - + - The aspect ratio of the projection. + Render using the Camera configured on the Canvas. - + - The far clipping plane distance. + Render at the end of the scene using a 2D Canvas. - + - The field of view of the projection in degrees. + Render using any Camera in the scene that can render the layer. - + - Which object layers are ignored by the projector. + The Render Settings contain values for a range of visual elements in your scene, like fog and ambient light. - + - The material that will be projected onto every object. + Ambient lighting coming from the sides. - + - The near clipping plane distance. + Ambient lighting coming from below. - + - Is the projection orthographic (true) or perspective (false)? + How much the light from the Ambient Source affects the scene. - + - Projection's half-size when in orthographic mode. + Flat ambient lighting color. - + - Base class to derive custom property attributes from. Use this to create custom attributes for script variables. + Ambient lighting mode. - + - Optional field to specify the order that multiple DecorationDrawers should be drawn in. + Custom or skybox ambient lighting data. - + - Script interface for. + Ambient lighting coming from above. - + - Active color space (Read Only). + Custom specular reflection cubemap. - + - Global anisotropic filtering mode. + Default reflection mode. - + - Set The AA Filtering option. + Cubemap resolution for default reflection. - + - 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. + The fade speed of all flares in the scene. - + - 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. + The intensity of all flares in the scene. - + - If enabled, billboards will face towards camera position rather than camera orientation. + Is fog enabled? - + - Blend weights. + The color of the fog. - + - Desired color space (Read Only). + The density of the exponential fog. - + - Global multiplier for the LOD's switching distance. + The ending distance of linear fog. - + - A texture size limit applied to all textures. + Fog mode to use. - + - A maximum LOD level. All LOD groups. + The starting distance of linear fog. - + - Maximum number of frames queued up by graphics driver. + Size of the Light halos. - + - The indexed list of available Quality Settings. + The number of times a reflection includes other reflections. - + - Budget for how many ray casts can be performed per frame for approximate collision testing. + How much the skybox / custom cubemap reflection affects the scene. - + - The maximum number of pixel lights that should affect any object. + The global skybox to use. - + - Enables realtime reflection probes. + The color used for the sun shadows in the Subtractive lightmode. - + - The normalized cascade distribution for a 2 cascade setup. The value defines the position of the cascade with respect to Zero. + The light used by the procedural skybox. - + - 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. + Fully describes setup of RenderTarget. - + - Number of cascades to use for directional light shadows. + Color Buffers to set. - + - Shadow drawing distance. + Load Actions for Color Buffers. It will override any actions set on RenderBuffers themselves. - + - Offset shadow frustum near plane. + Store Actions for Color Buffers. It will override any actions set on RenderBuffers themselves. - + - Directional light shadow projection. + Cubemap face to render to. - + - Use a two-pass shader for the vegetation in the terrain engine. + Depth Buffer to set. - + - The VSync Count. + Load Action for Depth Buffer. It will override any actions set on RenderBuffer itself. - + - Decrease the current quality level. + Slice of a Texture3D or Texture2DArray to set as a render target. - Should expensive changes be applied (Anti-aliasing etc). - + - Returns the current graphics quality level. + Store Actions for Depth Buffer. It will override any actions set on RenderBuffer itself. - + - Increase the current quality level. + Mip Level to render to. - Should expensive changes be applied (Anti-aliasing etc). - + - Sets a new graphics quality level. + Constructs RenderTargetSetup. - Quality index to set. - Should expensive changes be applied (Anti-aliasing etc). + Color Buffer(s) to set. + Depth Buffer to set. + Mip Level to render to. + Cubemap face to render to. + - + - Quaternions are used to represent rotations. + Constructs RenderTargetSetup. + Color Buffer(s) to set. + Depth Buffer to set. + Mip Level to render to. + Cubemap face to render to. + - + - Returns the euler angle representation of the rotation. + Constructs RenderTargetSetup. + Color Buffer(s) to set. + Depth Buffer to set. + Mip Level to render to. + Cubemap face to render to. + - + - The identity rotation (Read Only). + Constructs RenderTargetSetup. + Color Buffer(s) to set. + Depth Buffer to set. + Mip Level to render to. + Cubemap face to render to. + - + - W component of the Quaternion. Don't modify this directly unless you know quaternions inside out. + Constructs RenderTargetSetup. + Color Buffer(s) to set. + Depth Buffer to set. + Mip Level to render to. + Cubemap face to render to. + - + - X component of the Quaternion. Don't modify this directly unless you know quaternions inside out. + Constructs RenderTargetSetup. + Color Buffer(s) to set. + Depth Buffer to set. + Mip Level to render to. + Cubemap face to render to. + - + - Y component of the Quaternion. Don't modify this directly unless you know quaternions inside out. + Render textures are textures that can be rendered to. - + - Z component of the Quaternion. Don't modify this directly unless you know quaternions inside out. + Currently active render texture. - + - Returns the angle in degrees between two rotations a and b. + The antialiasing level for the RenderTexture. - - - + - Creates a rotation which rotates angle degrees around axis. + Mipmap levels are generated automatically when this flag is set. - - - + - Constructs new Quaternion with given x,y,z,w components. + Color buffer of the render texture (Read Only). - - - - - + - The dot product between two rotations. + The precision of the render texture's depth buffer in bits (0, 16, 24/32 are supported). - - - + - Returns a rotation that rotates z degrees around the z axis, x degrees around the x axis, and y degrees around the y axis (in that order). + Depth/stencil buffer of the render texture (Read Only). - - - - + - Returns a rotation that rotates z degrees around the z axis, x degrees around the x axis, and y degrees around the y axis (in that order). + Dimensionality (type) of the render texture. - - + - Creates a rotation which rotates from fromDirection to toDirection. + Enable random access write into this render texture on Shader Model 5.0 level shaders. - - - + - Returns the Inverse of rotation. + The color format of the render texture. - - + - Interpolates between a and b by t and normalizes the result afterwards. The parameter t is clamped to the range [0, 1]. + The height of the render texture in pixels. - - - - + - Interpolates between a and b by t and normalizes the result afterwards. The parameter t is not clamped. + If enabled, this Render Texture will be used as a Texture3D. - - - - + - Creates a rotation with the specified forward and upwards directions. + Does this render texture use sRGB read/write conversions (Read Only). - The direction to look in. - The vector that defines in which direction up is. - + - Creates a rotation with the specified forward and upwards directions. + Render texture has mipmaps when this flag is set. - The direction to look in. - The vector that defines in which direction up is. - + - Are two quaternions equal to each other? + Volume extent of a 3D render texture. - - - + - Combines rotations lhs and rhs. + The width of the render texture in pixels. - Left-hand side quaternion. - Right-hand side quaternion. - + - Rotates the point point with rotation. + Actually creates the RenderTexture. - - - + - Are two quaternions different from each other? + 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. - + - Rotates a rotation from towards to. + 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. - + - Set x, y, z and w components of an existing Quaternion. + 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. - + - Creates a rotation which rotates from fromDirection to toDirection. + Discards the contents of the RenderTexture. - - + Should the colour buffer be discarded? + Should the depth buffer be discarded? - + - Creates a rotation with the specified forward and upwards directions. + Discards the contents of the RenderTexture. - The direction to look in. - The vector that defines in which direction up is. + Should the colour buffer be discarded? + Should the depth buffer be discarded? - + - Creates a rotation with the specified forward and upwards directions. + Generate mipmap levels of a render texture. - 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]. + Retrieve a native (underlying graphics API) pointer to the depth buffer resource. - - - + + Pointer to an underlying graphics API depth buffer resource. + - + - Spherically interpolates between a and b by t. The parameter t is not clamped. + 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. + Anti-aliasing (1,2,4,8). - + - Access the x, y, z, w components using [0], [1], [2], [3] respectively. + Is the render texture actually created? - + - Converts a rotation to angle-axis representation (angles in degrees). + Indicate that there's a RenderTexture restore operation expected. - - - + - Returns a nicely formatted string of the Quaternion. + Releases the RenderTexture. - - + - Returns a nicely formatted string of the Quaternion. + Release a temporary texture allocated with GetTemporary. - + - + - Overrides the global Physics.queriesHitTriggers. + Assigns this RenderTexture as a global shader property named propertyName. + - + - Queries always report Trigger hits. + Does a RenderTexture have stencil buffer? + Render texture, or null for main screen. - + - Queries never report Trigger hits. + Format of a RenderTexture. - + - Queries use the global Physics.queriesHitTriggers setting. + Color render texture format, 1 bit for Alpha channel, 5 bits for Red, Green and Blue channels. - + - Used by Animation.Play function. + Color render texture format. 10 bits for colors, 2 bits for alpha. - + - Will start playing after all other animations have stopped playing. + Color render texture format, 8 bits per channel. - + - Starts playing immediately. This can be used if you just want to quickly create a duplicate animation. + Color render texture format, 4 bit per channel. - + - Class for generating random data. + Four color render texture format, 16 bits per channel, fixed point, unsigned normalized. - + - Returns a random point inside a circle with radius 1 (Read Only). + Color render texture format, 32 bit floating point per channel. - + - Returns a random point inside a sphere with radius 1 (Read Only). + Color render texture format, 16 bit floating point per channel. - + - Returns a random point on the surface of a sphere with radius 1 (Read Only). + Four channel (ARGB) render texture format, 32 bit signed integer per channel. - + - Returns a random rotation (Read Only). + Color render texture format, 8 bits per channel. - + - Returns a random rotation with uniform distribution (Read Only). + Default color render texture format: will be chosen accordingly to Frame Buffer format and Platform. - + - Sets the seed for the random number generator. + Default HDR color render texture format: will be chosen accordingly to Frame Buffer format and Platform. - + - Returns a random number between 0.0 [inclusive] and 1.0 [inclusive] (Read Only). + A depth render texture format. - + - Generates a random color from HSV and alpha ranges. + Scalar (R) render texture format, 8 bit fixed point. - 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. + Scalar (R) render texture format, 32 bit floating point. - 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. + Two color (RG) render texture format, 16 bits per channel, fixed point, unsigned normalized. - 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. + Color render texture format. R and G channels are 11 bit floating point, B channel is 10 bit floating point. - 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. + Color render texture format. - 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. - - + - Returns a random float number between and min [inclusive] and max [inclusive] (Read Only). + Two color (RG) render texture format, 32 bit floating point per channel. - - - + - Returns a random integer number between min [inclusive] and max [exclusive] (Read Only). + Two color (RG) render texture format, 16 bit floating point per channel. - - - + - Attribute used to make a float or int variable in a script be restricted to a specific range. + Two channel (RG) render texture format, 32 bit signed integer per channel. - + - Attribute used to make a float or int variable in a script be restricted to a specific range. + Scalar (R) render texture format, 16 bit floating point. - The minimum allowed value. - The maximum allowed value. - + - Representation of rays. + Scalar (R) render texture format, 32 bit signed integer. - + - The direction of the ray. + A native shadowmap render texture format. - + - The origin point of the ray. + Color space conversion mode of a RenderTexture. - + - Creates a ray starting at origin along direction. + Render texture contains sRGB (color) data, perform Linear<->sRGB conversions on it. - - - + - Returns a point at distance units along the ray. + Default color space conversion based on project settings. - - + - Returns a nicely formatted string for this ray. + Render texture contains linear (non-color) data; don't perform color conversions on it. - - + - Returns a nicely formatted string for this ray. + The RequireComponent attribute automatically adds required components as dependencies. - - + - A ray in 2D space. + Require a single component. + - + - The direction of the ray in world space. + Require a two components. + + - + - The starting point of the ray in world space. + Require three components. + + + - + - Get a point that lies a given distance along a ray. + Represents a display resolution. - Distance of the desired point along the path of the ray. - + - Structure used to get information back from a raycast. + Resolution height in pixels. - + - The barycentric coordinate of the triangle we hit. + Resolution's vertical refresh rate in Hz. - + - The Collider that was hit. + Resolution width in pixels. - + - The distance from the ray's origin to the impact point. + Returns a nicely formatted string of the resolution. + + A string with the format "width x height @ refreshRateHz". + - + - The uv lightmap coordinate at the impact point. + Asynchronous load request from the Resources bundle. - + - The normal of the surface the ray hit. + Asset object being loaded (Read Only). - + - The impact point in world space where the ray hit the collider. + The Resources class allows you to find and access Objects including assets. - + - The Rigidbody of the collider that was hit. If the collider is not attached to a rigidbody then it is null. + 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. + - + - The uv texture coordinate at the impact point. + Returns a list of all objects of Type T. - + - The secondary uv texture coordinate at the impact point. + 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 Transform of the rigidbody or collider that was hit. + 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 index of the triangle that was hit. + 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. - + - Information returned about an object detected by a raycast in 2D physics. + 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. - + - The centroid of the primitive used to perform the cast. + 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. - + - The collider hit by the ray. + 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. - + - The distance from the ray origin to the impact point. + Returns a resource at an asset path (Editor Only). + Pathname of the target asset. + Type filter for objects returned. - + - Fraction of the distance along the ray that the hit occurred. + Returns a resource at an asset path (Editor Only). + Pathname of the target asset. - + - The normal vector of the surface hit by the ray. + 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. + - + - The point in world space where the ray hit the collider's surface. + 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. + - + - The Rigidbody2D attached to the object that was hit. + 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. - + - The Transform of the object that was hit. + Unloads assetToUnload from memory. + - + - A 2D Rectangle defined by X and Y position, width and height. + Unloads assets that are not used. + + Object on which you can yield to wait until the operation completes. + - + - The position of the center of the rectangle. + Control of an object's position through physics simulation. - + - The height of the rectangle, measured from the Y position. + The angular drag of the object. - + - The position of the maximum corner of the rectangle. + The angular velocity vector of the rigidbody measured in radians per second. - + - The position of the minimum corner of the rectangle. + The center of mass relative to the transform's origin. - + - The X and Y position of the rectangle. + The Rigidbody's collision detection mode. - + - The width and height of the rectangle. + Controls which degrees of freedom are allowed for the simulation of this Rigidbody. - + - The width of the rectangle, measured from the X position. + Should collision detection be enabled? (By default always enabled). - + - The X coordinate of the rectangle. + The drag of the object. - + - The maximum X coordinate of the rectangle. + Controls whether physics will change the rotation of the object. - + - The minimum X coordinate of the rectangle. + The diagonal inertia tensor of mass relative to the center of mass. - + - The Y coordinate of the rectangle. + The rotation of the inertia tensor. - + - The maximum Y coordinate of the rectangle. + Interpolation allows you to smooth out the effect of running physics at a fixed frame rate. - + - The minimum Y coordinate of the rectangle. + Controls whether physics affects the rigidbody. - + - 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. + The mass of the rigidbody. - 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. + The maximimum angular velocity of the rigidbody. (Default 7) range { 0, infinity }. - 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. + Maximum velocity of a rigidbody when moving out of penetrating state. - 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 position of the rigidbody. - 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. - + - + The rotation of the rigidbody. - - + - Creates a rectangle given a size and position. + The angular velocity below which objects start going to sleep. (Default 0.14) range { 0, infinity }. - 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 mass-normalized energy threshold, below which objects start going to sleep. - 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. + The linear velocity below which objects start going to sleep. (Default 0.14) range { 0, infinity }. - Rectangle to get a point inside. - Normalized coordinates to get a point for. - + - Returns true if the rectangles are the same. + The solverIterations determines how accurately Rigidbody joints and collision contacts are resolved. Overrides Physics.defaultSolverIterations. Must be positive. - - - + - Returns true if the rectangles are different. + The solverVelocityIterations affects how how accurately Rigidbody joints and collision contacts are resolved. Overrides Physics.defaultSolverVelocityIterations. Must be positive. - - - + - 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. + Force cone friction to be used for this rigidbody. - Other rectangle to test overlapping with. - Does the test allow the Rects' widths and heights 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. + Controls whether gravity affects this rigidbody. - Other rectangle to test overlapping with. - Does the test allow the Rects' widths and heights to be negative? - + - Returns the normalized coordinates cooresponding the the point. + The velocity vector of the rigidbody. - Rectangle to get normalized coordinates inside. - A point inside the rectangle to get normalized coordinates for. - + - Set components of an existing Rect. + The center of mass of the rigidbody in world space (Read Only). - - - - - + - Returns a nicely formatted string for this Rect. + 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. - + - Returns a nicely formatted string for this Rect. + 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. - + - Offsets for rectangles, borders, etc. + 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. - + - Bottom edge size. + Adds a force to the Rigidbody. + Force vector in world coordinates. + Type of force to apply. - + - Shortcut for left + right. (Read Only) + Adds a force to the Rigidbody. + Force vector in world coordinates. + Type of force to apply. - + - Left edge size. + 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. - + - Right edge size. + 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. - + - Top edge size. + 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. + - + - Shortcut for top + bottom. (Read Only) + 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. + - + - Add the border offsets to a rect. + Adds a force to the rigidbody relative to its coordinate system. - + Force vector in local coordinates. + - + - Creates a new rectangle with offsets. + Adds a force to the rigidbody relative to its coordinate system. - - - - + Force vector in local coordinates. + - + - Creates a new rectangle with offsets. + 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. + - + - Remove the border offsets from a rect. + 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. + - + - Position, size, anchor and pivot information for a rectangle. + Adds a torque to the rigidbody relative to its coordinate system. + Torque vector in local coordinates. + - + - The position of the pivot of this RectTransform relative to the anchor reference point. + Adds a torque to the rigidbody relative to its coordinate system. + Torque vector in local coordinates. + - + - The 3D position of the pivot of this RectTransform relative to the anchor reference point. + 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. + - + - The normalized position in the parent RectTransform that the upper right corner is anchored to. + 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. + - + - The normalized position in the parent RectTransform that the lower left corner is anchored to. + Adds a torque to the rigidbody. + Torque vector in world coordinates. + - + - The offset of the upper right corner of the rectangle relative to the upper right anchor. + Adds a torque to the rigidbody. + Torque vector in world coordinates. + - + - The offset of the lower left corner of the rectangle relative to the lower left anchor. + 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 normalized position in this RectTransform that it rotates around. + 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. + - + - Event that is invoked for RectTransforms that need to have their driven properties reapplied. + The closest point to the bounding box of the attached colliders. - + - + - The calculated rectangle in the local space of the Transform. + The velocity of the rigidbody at the point worldPoint in global space. + - + - The size of this RectTransform relative to the distances between the anchors. + The velocity relative to the rigidbody at the point relativePoint. + - + - An axis that can be horizontal or vertical. + Is the rigidbody sleeping? - + - Horizontal. + Moves the rigidbody to position. + The new position for the Rigidbody object. - + - Vertical. + Rotates the rigidbody to rotation. + The new rotation for the Rigidbody. - + - Enum used to specify one edge of a rectangle. + Reset the center of mass of the rigidbody. - + - The bottom edge. + Reset the inertia tensor value and rotation. - + - The left edge. + Sets the mass based on the attached colliders assuming a constant density. + - + - The right edge. + Forces a rigidbody to sleep at least one frame. - + - The top edge. + 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. + - + - Get the corners of the calculated rectangle in the local space of its Transform. + Like Rigidbody.SweepTest, but returns all hits. - Array that corners should be filled into. + 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. + - + - Get the corners of the calculated rectangle in world space. + Forces a rigidbody to wake up. - Array that corners should be filled into. - + - Delegate used for the reapplyDrivenProperties event. + Rigidbody physics component for 2D sprites. - - + - Set the distance of this rectangle relative to a specified edge of the parent rectangle, while also setting its size. + Coefficient of angular drag. - 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. + Angular velocity in degrees per second. - The axis to specify the size along. - The desired size along the specified axis. - + - Utility class containing helper methods for working with RectTransform. + Returns the number of Collider2D attached to this Rigidbody2D. - + - Flips the horizontal and vertical axes of the RectTransform size and alignment, and optionally its children as well. + The physical behaviour type of the Rigidbody2D. - 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 center of mass of the rigidBody in local space. - 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. + The method used by the physics engine to check if two objects have collided. - - - - - Pixel adjusted point. - - + - Given a rect transform, return the corner points in pixel accurate coordinates. + Controls which degrees of freedom are allowed for the simulation of this Rigidbody2D. - - - - Pixel adjusted rect. - - + - Does the RectTransform contain the screen point as seen from the given camera? + Coefficient of drag. - The RectTransform to test with. - The screen point to test. - The camera from which the test is performed from. - - 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. + Should the rigidbody be prevented from rotating? - 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. + Controls whether physics will change the rotation of the object. - 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 degree to which this object is affected by gravity. - + - The color with which the texture of reflection probe will be cleared. + The rigidBody rotational inertia. - + - Reference to the baked texture of the reflection probe's surrounding. + Physics interpolation used between updates. - + - Distance around probe used for blending (used in deferred probes). + Should this rigidbody be taken out of physics control? - + - The bounding volume of the reflection probe (Read Only). + Mass of the rigidbody. - + - Should this reflection probe use box projection? + The position of the rigidbody. - + - The center of the box area in which reflections will be applied to the objects. Measured in the probes's local space. + The rotation of the rigidbody. - + - How the reflection probe clears the background. + The PhysicsMaterial2D that is applied to all Collider2D attached to this Rigidbody2D. - + - This is used to render parts of the reflecion probe's surrounding selectively. + Indicates whether the rigid body should be simulated or not by the physics system. - + - Reference to the baked texture of the reflection probe's surrounding. Use this to assign custom reflection texture. + The sleep state that the rigidbody will initially be in. - + - The far clipping plane distance when rendering the probe. + Should the total rigid-body mass be automatically calculated from the Collider2D.density of attached colliders? - + - Should this reflection probe use HDR rendering? + Should kinematickinematic and kinematicstatic collisions be allowed? - + - Reflection probe importance. + Linear velocity of the rigidbody. - + - The intensity modifier that is applied to the texture of reflection probe in the shader. + Gets the center of mass of the rigidBody in global space. - + - Should reflection probe texture be generated in the Editor (ReflectionProbeMode.Baked) or should probe use custom specified texure (ReflectionProbeMode.Custom)? + Apply a force to the rigidbody. + Components of the force in the X and Y axes. + The method used to apply the specified force. - + - The near clipping plane distance when rendering the probe. + 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. - + - Sets the way the probe will refresh. - -See Also: ReflectionProbeRefreshMode. + 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. - + - Resolution of the underlying reflection texture in pixels. + Apply a torque at the rigidbody's centre of mass. + Torque to apply. + The force mode to use. - + - Shadow drawing distance when rendering the probe. + 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. + - + - The size of the box area in which reflections will be applied to the objects. Measured in the probes's local space. + 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. + - + - Texture which is passed to the shader of the objects in the vicinity of the reflection probe (Read Only). + 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. + - + - Sets this probe time-slicing mode - -See Also: ReflectionProbeTimeSlicingMode. + 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. + - + - Reflection probe type. + 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. + - + - Utility method to blend 2 cubemaps into a target render texture. + Retrieves all colliders in contact with any of the collider(s) attached to this rigidbody. - Cubemap to blend from. - Cubemap to blend to. - Blend weight. - RenderTexture which will hold the result of the blend. + An array of Collider2D used to receive the results. - Returns trues if cubemaps were blended, false otherwise. + Returns the number of colliders placed in the colliders array. - + - Checks if a probe has finished a time-sliced render. + Retrieves all contact points for all of the collider(s) attached to this rigidbody, with the results filtered by the ContactFilter2D. - An integer representing the RenderID as returned by the RenderProbe method. + 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. - - True if the render has finished, false otherwise. - - See Also: timeSlicingMode - + Returns the number of contacts placed in the contacts array. - + - Refreshes the probe's cubemap. + Retrieves all colliders in contact with any of the collider(s) attached to this rigidbody, with the results filtered by the ContactFilter2D. - Target RendeTexture in which rendering should be done. Specifying null will update the probe's default texture. + 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. - - 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 - + Returns the number of colliders placed in the colliders array. - + - Keeps two Rigidbody2D at their relative orientations. + Get a local space point given the point point in rigidBody global space. + The global space point to transform into local space. - + - The current angular offset between the Rigidbody2D that the joint connects. + The velocity of the rigidbody at the point Point in global space. + The global space point to calculate velocity for. - + - Should both the linearOffset and angularOffset be calculated automatically? + 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. - + - Scales both the linear and angular forces used to correct the required relative orientation. + Get a global space vector given the vector relativeVector in rigidBody local space. + The local space vector to transform into a global space vector. - + - The current linear offset between the Rigidbody2D that the joint connects. + Get a local space vector given the vector vector in rigidBody global space. + The global space vector to transform into a local space vector. - + - The maximum force that can be generated when trying to maintain the relative joint constraint. + Is the rigidbody "awake"? - + - The maximum torque that can be generated when trying to maintain the relative joint constraint. + Is the rigidbody "sleeping"? - + - The world-space position that is currently trying to be maintained. + 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. + - + - Color or depth buffer part of a RenderTexture. + 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. + - + - 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. + 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. + - + - General functionality for all renderers. + 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. + - + - The bounding volume of the renderer (Read Only). + Moves the rigidbody to position. + The new position for the Rigidbody object. - + - Makes the rendered 3D object visible if enabled. + Rotates the rigidbody to angle (given in degrees). + The new rotation angle for the Rigidbody object. - + - Has this renderer been statically batched with any other renderers? + 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. + - + - Is this renderer visible in any camera? (Read Only) + 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. + - + - The index of the baked lightmap applied to this renderer. + Make the rigidbody "sleep". - + - The UV scale & offset used for a lightmap. + Disables the "sleeping" state of a rigidbody. - + - Matrix that transforms a point from local space into world space (Read Only). + Use these flags to constrain motion of Rigidbodies. - + - Returns the first instantiated Material assigned to the renderer. + Freeze rotation and motion along all axes. - + - Returns all the instantiated materials of this object. + Freeze motion along all axes. - + - If set, Renderer will use this Transform's position to find the light or reflection probe. + Freeze motion along the X-axis. - + - The index of the realtime lightmap applied to this renderer. + Freeze motion along the Y-axis. - + - The UV scale & offset used for a realtime lightmap. + Freeze motion along the Z-axis. - + - Does this object receive shadows? + Freeze rotation along all axes. - + - Should reflection probes be used for this Renderer? + Freeze rotation along the X-axis. - + - Does this object cast shadows? + Freeze rotation along the Y-axis. - + - The shared material of this object. + Freeze rotation along the Z-axis. - + + + No constraints. + + + + + Use these flags to constrain motion of the Rigidbody2D. + + + - All the shared materials of this object. + Freeze rotation and motion along all axes. - + - Unique ID of the Renderer's sorting layer. + Freeze motion along the X-axis and Y-axis. - + - Name of the Renderer's sorting layer. + Freeze motion along the X-axis. - + - Renderer's order within a sorting layer. + Freeze motion along the Y-axis. - + - Should light probes be used for this Renderer? + Freeze rotation along the Z-axis. - + - Matrix that transforms a point from world space into local space (Read Only). + No constraints. - + - 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. + Rigidbody interpolation mode. - - + - Get per-renderer material property block. + Extrapolation will predict the position of the rigidbody based on the current velocity. - - + - Lets you add per-renderer material parameters without duplicating a material. + Interpolation will always lag a little bit behind but can be smoother than extrapolation. - - + - Ambient lighting mode. + No Interpolation. - + - Ambient lighting is defined by a custom cubemap. + Interpolation mode for Rigidbody2D objects. - + - Flat ambient lighting. + Smooth an object's movement based on an estimate of its position in the next frame. - + - Skybox-based or custom ambient lighting. + Smooth movement based on the object's positions in previous frames. - + - Trilight ambient lighting. + Do not apply any smoothing to the object's movement. - + - Blend mode for controlling the blending. + Settings for a Rigidbody2D's initial sleep state. - + - Blend factor is (Ad, Ad, Ad, Ad). + Rigidbody2D never automatically sleeps. - + - Blend factor is (Rd, Gd, Bd, Ad). + Rigidbody2D is initially asleep. - + - Blend factor is (1, 1, 1, 1). + Rigidbody2D is initially awake. - + - Blend factor is (1 - Ad, 1 - Ad, 1 - Ad, 1 - Ad). + The physical behaviour type of the Rigidbody2D. - + - Blend factor is (1 - Rd, 1 - Gd, 1 - Bd, 1 - Ad). + Sets the Rigidbody2D to have dynamic behaviour. - + - Blend factor is (1 - As, 1 - As, 1 - As, 1 - As). + Sets the Rigidbody2D to have kinematic behaviour. - + - Blend factor is (1 - Rs, 1 - Gs, 1 - Bs, 1 - As). + Sets the Rigidbody2D to have static behaviour. - + - Blend factor is (As, As, As, As). + Control ConfigurableJoint's rotation with either X & YZ or Slerp Drive. - + - Blend factor is (f, f, f, 1); where f = min(As, 1 - Ad). + Use Slerp drive. - + - Blend factor is (Rs, Gs, Bs, As). + Use XY & Z Drive. - + - Blend factor is (0, 0, 0, 0). + Attribute for setting up RPC functions. - + - Blend operation. + Option for who will receive an RPC, used by NetworkView.RPC. - + - Add (s + d). + Sends to everyone. - + - Color burn (Advanced OpenGL blending). + Sends to everyone and adds to the buffer. - + - Color dodge (Advanced OpenGL blending). + Sends to everyone except the sender. - + - Darken (Advanced OpenGL blending). + Sends to everyone except the sender and adds to the buffer. - + - Difference (Advanced OpenGL blending). + Sends to the server only. - + - Exclusion (Advanced OpenGL blending). + Runtime representation of the AnimatorController. It can be used to change the Animator's controller during runtime. - + - Hard light (Advanced OpenGL blending). + Retrieves all AnimationClip used by the controller. - + - HSL color (Advanced OpenGL blending). + Set RuntimeInitializeOnLoadMethod type. - + - HSL Hue (Advanced OpenGL blending). + After scene is loaded. - + - HSL luminosity (Advanced OpenGL blending). + Before scene is loaded. - + - HSL saturation (Advanced OpenGL blending). + Allow a runtime class method to be initialized when a game is loaded at runtime + without action from the user. - + - Lighten (Advanced OpenGL blending). + Set RuntimeInitializeOnLoadMethod type. - + - Logical AND (s & d) (D3D11.1 only). + Creation of the runtime class used when scenes are loaded. + Determine whether methods are called before or after the + scene is loaded. - + - Logical inverted AND (!s & d) (D3D11.1 only). + Creation of the runtime class used when scenes are loaded. + Determine whether methods are called before or after the + scene is loaded. - + - Logical reverse AND (s & !d) (D3D11.1 only). + The platform application is running. Returned by Application.platform. - + - Logical Clear (0). + In the player on the Apple's tvOS. - + - Logical Copy (s) (D3D11.1 only). + In the player on Android devices. - + - Logical inverted Copy (!s) (D3D11.1 only). + In the player on the iPhone. - + - Logical Equivalence !(s XOR d) (D3D11.1 only). + In the Unity editor on Linux. - + - Logical Inverse (!d) (D3D11.1 only). + In the player on Linux. - + - Logical NAND !(s & d). D3D11.1 only. + In the Dashboard widget on macOS. - + - Logical No-op (d) (D3D11.1 only). + In the Unity editor on macOS. - + - Logical NOR !(s | d) (D3D11.1 only). + In the player on macOS. - + - Logical OR (s | d) (D3D11.1 only). + In the web player on macOS. - + - Logical inverted OR (!s | d) (D3D11.1 only). + In the player on the Playstation 4. - + - Logical reverse OR (s | !d) (D3D11.1 only). + In the player on the PS Vita. - + - Logical SET (1) (D3D11.1 only). + In the player on Samsung Smart TV. - + - Logical XOR (s XOR d) (D3D11.1 only). + In the player on Nintendo Switch. - + - Max. + In the player on Tizen. - + - Min. + In the player on WebGL? - + - Multiply (Advanced OpenGL blending). + In the player on Wii U. - + - Overlay (Advanced OpenGL blending). + In the Unity editor on Windows. - + - Reverse subtract. + In the player on Windows. - + - Screen (Advanced OpenGL blending). + In the web player on Windows. - + - Soft light (Advanced OpenGL blending). + In the player on Windows Store Apps when CPU architecture is ARM. - + - Subtract. + In the player on Windows Store Apps when CPU architecture is X64. - + - Built-in temporary render textures produced during camera's rendering. + In the player on Windows Store Apps when CPU architecture is X86. - + - Target texture of currently rendering camera. + In the player on Xbox One. - + - Currently active render target. + Interface into SamsungTV specific functionality. - + - Camera's depth texture. + Returns true if there is an air mouse available. - + - Camera's depth+normals texture. + Changes the type of input the gamepad produces. - + - Deferred shading G-buffer #0 (typically diffuse color). + Changes the type of input the gesture camera produces. - + - Deferred shading G-buffer #1 (typically specular + roughness). + Returns true if the camera sees a hand. - + - Deferred shading G-buffer #2 (typically normals). + The type of input the remote's touch pad produces. - + - Deferred shading G-buffer #3 (typically emission/lighting). + Types of input the gamepad can produce. - + - Deferred lighting light buffer. + Joystick style input. - + - Deferred lighting HDR specular light buffer (Xbox 360 only). + Mouse style input. - + - Deferred lighting (normals+specular) G-buffer. + Types of input the gesture camera can produce. - + - Reflections gathered from default reflection and reflections probes. + Two hands control two joystick axes. - + - Built-in shader modes used by Rendering.GraphicsSettings. + Hands control the mouse pointer. - + - Don't use any shader, effectively disabling the functionality. + No gesture input from the camera. - + - Use built-in shader (default). + Access to TV specific information. - + - Use custom shader instead of built-in one. + The server type. Possible values: +Developing, Development, Invalid, Operating. - + - Built-in shader types used by Rendering.GraphicsSettings. + Get local time on TV. - + - Shader used for deferred reflection probes. + Get UID from TV. - + - Shader used for deferred shading calculations. + Set the system language that is returned by Application.SystemLanguage. + - + - Shader used for legacy deferred lighting calculations. + Types of input the remote's touchpad can produce. - + - Defines a place in camera's rendering to attach Rendering.CommandBuffer objects to. + Remote dependent. On 2013 TVs dpad directions are determined by swiping in the correlating direction. On 2014 and 2015 TVs the remote has dpad buttons. - + - After camera's depth+normals texture is generated. + Touchpad works like an analog joystick. Not supported on the 2015 TV as there is no touchpad. - + - After camera's depth texture is generated. + Touchpad controls a remote curosr like a laptop's touchpad. This can be replaced by airmouse functionality which is available on 2014 and 2015 TVs. - + - After camera has done rendering everything. + Scaling mode to draw textures with. - + - After final geometry pass in deferred lighting. + 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. - + - After transparent objects in forward rendering. + Scales the texture, maintaining aspect ratio, so it completely fits withing the position rectangle passed to GUI.DrawTexture. - + - After opaque objects in forward rendering. + Stretches the texture to fill the complete rectangle passed in to GUI.DrawTexture. - + - After deferred rendering G-buffer is rendered. + Used when loading a scene in a player. - + - After image effects. + Adds the scene to the current loaded scenes. - + - After image effects that happen between opaque & transparent objects. + Closes all current loaded scenes and loads a scene. - + - After lighting pass in deferred rendering. + Run-time data structure for *.unity file. - + - After reflections pass in deferred rendering. + Returns the index of the scene in the Build Settings. Always returns -1 if the scene was loaded through an AssetBundle. - + - After skybox is drawn. + Returns true if the scene is modifed. - + - Before camera's depth+normals texture is generated. + Returns true if the scene is loaded. - + - Before camera's depth texture is generated. + Returns the name of the scene. - + - Before final geometry pass in deferred lighting. + Returns the relative path of the scene. Like: "AssetsMyScenesMyScene.unity". - + - Before transparent objects in forward rendering. + The number of root transforms of this scene. - + - Before opaque objects in forward rendering. + Returns all the root game objects in the scene. + + An array of game objects. + - + - Before deferred rendering G-buffer is rendered. + Returns all the root game objects in the scene. + A list which is used to return the root game objects. - + - Before image effects. + 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. + - + - Before image effects that happen between opaque & transparent objects. + Returns true if the Scenes are equal. + + - + - Before lighting pass in deferred rendering. + Returns true if the Scenes are different. + + - + - Before reflections pass in deferred rendering. + Scene management at run-time. - + - Before skybox is drawn. + Add a delegate to this to get notifications when the active scene has changed + - + - Specifies which color components will get written into the target framebuffer. + The total number of currently loaded scenes. - + - Write all components (R, G, B and Alpha). + Number of scenes in Build Settings. - + - Write alpha component. + Add a delegate to this to get notifications when a scene has loaded + - + - Write blue component. + Add a delegate to this to get notifications when a scene has unloaded + - + - Write green component. + 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. + + A reference to the new scene that was created, or an invalid scene if creation failed. + - + - Write red component. + Gets the currently active scene. + + The active scene. + - + - List of graphics commands to execute. + Returns an array of all the scenes currently open in the hierarchy. + + Array of Scenes in the Hierarchy. + - + - Name of this command buffer. + Get the scene at index in the SceneManager's list of added 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. + - + - Size of this command buffer in bytes (Read Only). + 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. + - + - Add a "blit into a render texture" command. + Searches through the scenes added to the SceneManager for a scene with the given name. - 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"). + Name of scene to find. + + A reference to the scene, if valid. If not, an invalid scene is returned. + - + - Add a "blit into a render texture" command. + Searches all scenes added to the SceneManager for a scene that has the given asset path. - 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"). + 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. + - + - Add a "blit into a render texture" command. + Loads the scene by its name or index in Build Settings. - 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"). + 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. - + - Add a "blit into a render texture" command. + Loads the scene by its name or index in Build Settings. - 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"). + 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. - + - Add a "blit into a render texture" command. + Loads the scene asynchronously in the background. - 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"). + 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. + + Use the AsyncOperation to determine if the operation has completed. + - + - Add a "blit into a render texture" command. + Loads the scene asynchronously in the background. - 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"). + 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. + + Use the AsyncOperation to determine if the operation has completed. + - + - Clear all commands in the buffer. + 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. - + - Adds a "clear render target" command. + Move a GameObject from its current scene to a new Scene. - Should clear depth buffer? - Should clear color buffer? - Color to clear with. - Depth to clear with (default is 1.0). + GameObject to move. + Scene to move into. - + - Create a new empty command buffer. + Set the scene to be active. + The scene to be set. + + Returns false if the scene is not loaded yet. + - + - Add a "draw mesh" command. + Destroys all GameObjects associated with the given scene and removes the scene from the SceneManager. - 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. + 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. + - + - Add a "draw procedural geometry" command. + Destroys all GameObjects associated with the given scene and removes the scene from the SceneManager. - 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. + 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. + - + - Add a "draw procedural geometry" command. + Destroys all GameObjects associated with the given scene and removes the scene from the SceneManager. - 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. - Offset where in the buffer the draw arguments are. + 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. + - + - Add a "draw renderer" command. + Destroys all GameObjects associated with the given scene and removes the scene from the SceneManager. - 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). + Index of the scene in BuildSettings. + Name or path of the scene to unload. + Scene to unload. + + Use the AsyncOperation to determine if the operation has completed. + - + - Add a "get a temporary render texture" command. + Destroys all GameObjects associated with the given scene and removes the scene from the SceneManager. - 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). + Index of the scene in BuildSettings. + Name or path of the scene to unload. + Scene to unload. + + Use the AsyncOperation to determine if the operation has completed. + - + - Send a user-defined event to a native code plugin. + Destroys all GameObjects associated with the given scene and removes the scene from the SceneManager. - Native code callback to queue for Unity's renderer to invoke. - User defined id to send to the callback. + Index of the scene in BuildSettings. + Name or path of the scene to unload. + Scene to unload. + + Use the AsyncOperation to determine if the operation has completed. + - + - Add a "release a temporary render texture" command. + Scene and Build Settings related utilities. - Shader property name for this texture. - + - Add a "set global shader color property" command. + Get the build index from a scene path. - - - + Scene path (e.g: "AssetsScenesScene1.unity"). + + Build index. + - + - Add a "set global shader color property" command. + Get the scene path from a build index. - - - + + + Scene path (e.g "AssetsScenesScene1.unity"). + - + - Add a "set global shader float property" command. + Access to display information. - - - - + - Add a "set global shader float property" command. + Allow auto-rotation to landscape left? - - - - + - Add a "set global shader matrix property" command. + Allow auto-rotation to landscape right? - - - - + - Add a "set global shader matrix property" command. + Allow auto-rotation to portrait? - - - - + - Add a "set global shader texture property" command. + Allow auto-rotation to portrait, upside down? - - - - + - Add a "set global shader texture property" command. + The current screen resolution (Read Only). - - - - + - Add a "set global shader vector property" command. + The current DPI of the screen / device (Read Only). - - - - + - Add a "set global shader vector property" command. + Is the game running fullscreen? - - - - + - Add a "set active render target" command. + The current height of the screen window in pixels (Read Only). - 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. - + - Add a "set active render target" command. + Should the cursor be locked? - 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. - + - Add a "set active render target" command. + Specifies logical orientation of the screen. - 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. - + - Add a "set active render target" command. + All fullscreen resolutions supported by the monitor (Read Only). - 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. - + - Add a "set active render target" command. + Should the cursor be visible? - 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. - + - Add a "set active render target" command. + A power saving setting, allowing the screen to dim some time after the last active user interaction. - 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. - + - Add a "set active render target" command. + The current width of the screen window in pixels (Read Only). - 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. - + - Add a "set shadow sampling mode" command. + Switches the screen resolution. - Shadowmap render target to change the sampling mode on. - New sampling mode. + + + + - + - Depth or stencil comparison function. + Switches the screen resolution. + + + + - + - Always pass depth or stencil test. + Describes screen orientation. - + - Depth or stencil test is disabled. + Auto-rotates the screen as necessary toward any of the enabled orientations. - + - Pass depth or stencil test when values are equal. + Landscape orientation, counter-clockwise from the portrait orientation. - + - Pass depth or stencil test when new value is greater than old one. + Landscape orientation, clockwise from the portrait orientation. - + - Pass depth or stencil test when new value is greater or equal than old one. + Portrait orientation. - + - Pass depth or stencil test when new value is less than old one. + Portrait orientation, upside down. - + - Pass depth or stencil test when new value is less or equal than old one. + A class you can derive from if you want to create objects that don't need to be attached to game objects. - + - Never pass depth or stencil test. + 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. + - + - Pass depth or stencil test when values are different. + 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. + - + - Backface culling mode. + Creates an instance of a scriptable object. + + The created ScriptableObject. + - + - Cull back-facing geometry. + PreserveAttribute prevents byte code stripping from removing a class, method, field, or property. - + - Cull front-facing geometry. + Webplayer security related class. Not supported from 5.4.0 onwards. - + - Disable culling. + 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. + - + - Default reflection mode. + 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. + - + - Custom default reflection. + 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. - + - Skybox-based default reflection. + 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. - + - Graphics device API type. + Add this attribute to a script class to mark its GameObject as a selection base object for Scene View picking. - + - Direct3D 11 graphics API. + Options for how to send a message. - + - Direct3D 12 graphics API. + No receiver is required for SendMessage. - + - Direct3D 9 graphics API. + A receiver is required for SendMessage. - + - iOS Metal graphics API. + Use this attribute to rename a field without losing its serialized value. - + - Nintendo 3DS graphics API. + The name of the field before the rename. - + - No graphics API. + + The name of the field before renaming. - + - OpenGL 2.x graphics API. + Force Unity to serialize a private field. - + - OpenGL (Core profile - GL3 or later) graphics API. + Shader scripts used for all rendering. - + - OpenGL ES 2.0 graphics API. + Shader LOD level for all shaders. - + - OpenGL ES 3.0 graphics API. + Render pipeline currently in use. - + - PlayStation 3 graphics API. + Shader hardware tier classification for current device. - + - PlayStation 4 graphics API. + Can this shader run on the end-users graphics card? (Read Only) - + - PlayStation Mobile (PSM) graphics API. + Shader LOD level for this shader. - + - PlayStation Vita graphics API. + Render queue of this shader. (Read Only) - + - Xbox 360 graphics API. + Unset a global shader keyword. + - + - Xbox One graphics API. + Set a global shader keyword. + - + - Script interface for. + Finds a shader with the given name. + - + - Get custom shader used instead of a built-in shader. + Gets a global color property for all shaders previously set using SetGlobalColor. - Built-in shader type to query custom shader for. - - The shader used. - + + - + - Get built-in shader mode. + Gets a global color property for all shaders previously set using SetGlobalColor. - Built-in shader type to query. - - Mode used for built-in shader. - + + - + - Set custom shader to use instead of a built-in shader. + Gets a global float property for all shaders previously set using SetGlobalFloat. - Built-in shader type to set custom shader to. - The shader to use. + + - + - Set built-in shader mode. + Gets a global float property for all shaders previously set using SetGlobalFloat. - Built-in shader type to change. - Mode to use for built-in shader. + + - + - Defines a place in light's rendering to attach Rendering.CommandBuffer objects to. + Gets a global float array for all shaders previously set using SetGlobalFloatArray. + + - + - After directional light screenspace shadow mask is computed. + Gets a global float array for all shaders previously set using SetGlobalFloatArray. + + - + - After shadowmap is rendered. + Fetches a global float array into a list. + The list to hold the returned array. + + - + - Before directional light screenspace shadow mask is computed. + Fetches a global float array into a list. + The list to hold the returned array. + + - + - Before shadowmap is rendered. + Gets a global int property for all shaders previously set using SetGlobalInt. + + - + - Opaque object sorting mode of a Camera. + Gets a global int property for all shaders previously set using SetGlobalInt. + + - + - Default opaque sorting mode. + Gets a global matrix property for all shaders previously set using SetGlobalMatrix. + + - + - Do rough front-to-back sorting of opaque objects. + Gets a global matrix property for all shaders previously set using SetGlobalMatrix. + + - + - Do not sort opaque objects by distance. + Gets a global matrix array for all shaders previously set using SetGlobalMatrixArray. + + - + - Shader pass type for Unity's lighting pipeline. + Gets a global matrix array for all shaders previously set using SetGlobalMatrixArray. + + - + - Deferred Shading shader pass. + Fetches a global matrix array into a list. + The list to hold the returned array. + + - + - Forward rendering additive pixel light pass. + Fetches a global matrix array into a list. + The list to hold the returned array. + + - + - Forward rendering base pass. + Gets a global texture property for all shaders previously set using SetGlobalTexture. + + - + - Legacy deferred lighting (light pre-pass) base pass. + Gets a global texture property for all shaders previously set using SetGlobalTexture. + + - + - Legacy deferred lighting (light pre-pass) final pass. + Gets a global vector property for all shaders previously set using SetGlobalVector. + + - + - Shader pass used to generate the albedo and emissive values used as input to lightmapping. + Gets a global vector property for all shaders previously set using SetGlobalVector. + + - + - Regular shader pass that does not interact with lighting. + Gets a global vector array for all shaders previously set using SetGlobalVectorArray. + + - + - Shadow caster & depth texure shader pass. + Gets a global vector array for all shaders previously set using SetGlobalVectorArray. + + - + - Legacy vertex-lit shader pass. + Fetches a global vector array into a list. + The list to hold the returned array. + + - + - Legacy vertex-lit shader pass, with mobile lightmaps. + Fetches a global vector array into a list. + The list to hold the returned array. + + - + - Legacy vertex-lit shader pass, with desktop (RGBM) lightmaps. + Is global shader keyword enabled? + - + - Determines how Unity will compress baked reflection cubemap. + Gets unique identifier for a shader property name. + Shader property name. + + Unique integer for the name. + - + - Baked Reflection cubemap will be compressed if compression format is suitable. + Sets a global compute buffer property for all shaders. + + + - + - Baked Reflection cubemap will be compressed. + Sets a global compute buffer property for all shaders. + + + - + - Baked Reflection cubemap will be left uncompressed. + Sets a global color property for all shaders. + + + - + - ReflectionProbeBlendInfo contains information required for blending probes. + Sets a global color property for all shaders. + + + - + - Reflection Probe used in blending. + Sets a global float property for all shaders. + + + - + - Specifies the weight used in the interpolation between two probes, value varies from 0.0 to 1.0. + Sets a global float property for all shaders. + + + - + - Values for ReflectionProbe.clearFlags, determining what to clear when rendering a ReflectionProbe. + Sets a global float array property for all shaders. + + + - + - Clear with the skybox. + Sets a global float array property for all shaders. + + + - + - Clear with a background color. + Sets a global float array property for all shaders. + + + - + - Reflection probe's update mode. + Sets a global float array property for all shaders. + + + - + - Reflection probe is baked in the Editor. + Sets a global int property for all shaders. + + + - + - Reflection probe uses a custom texture specified by the user. + Sets a global int property for all shaders. + + + - + - Reflection probe is updating in realtime. + Sets a global matrix property for all shaders. + + + - + - An enum describing the way a realtime reflection probe refreshes in the Player. + Sets a global matrix property for all shaders. + + + - + - 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. + Sets a global matrix array property for all shaders. + + + - + - 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 a global matrix array property for all shaders. + + + - + - Using this option indicates that the probe will never be automatically updated by Unity. This is useful if you wish to completely control the probe refresh behavior via scripting. - -See Also: ReflectionProbe.RenderProbe. + Sets a global matrix array property for all shaders. + + + - + - 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. + Sets a global matrix array property for all shaders. + + + - + - 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. + Sets a global texture property for all shaders. + + + - + - 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. + Sets a global texture property for all shaders. + + + - + - Unity will render the probe entirely in one frame. + Sets a global vector property for all shaders. + + + - + - Reflection probe type: cube or card. + Sets a global vector property for all shaders. + + + - + - Surrounding of the reflection probe is rendered onto a quad. + Sets a global vector array property for all shaders. + + + - + - Surrounding of the reflection probe is rendered into cubemap. + Sets a global vector array property for all shaders. + + + - + - Reflection Probe usage. + Sets a global vector array property for all shaders. + + + - + - 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. + Sets a global vector array property for all shaders. + + + - + - Reflection probes are enabled. Blending occurs between probes or probes and default reflection, useful for outdoor environments. + Fully load all shaders to prevent future performance hiccups. - + - Reflection probes are disabled, skybox will be used for reflection. + ShaderVariantCollection records which shader variants are actually used in each shader. - + - Reflection probes are enabled, but no blending will occur between probes when there are two overlapping volumes. + Is this ShaderVariantCollection already warmed up? (Read Only) - + - Handling of loading RenderBuffer contents on setting as active RenderTarget. + Number of shaders in this collection (Read Only). - + - RenderBuffer will try to skip loading its contents on setting as Render Target. + Number of total varians in this collection (Read Only). - + - Make RenderBuffer to Load its contents when setting as RenderTarget. + Adds a new shader variant to the collection. + Shader variant to add. + + False if already in the collection. + - + - Handling of storing RenderBuffer contents after it was an active RenderTarget and another RenderTarget was set. + Remove all shader variants from the collection. - + - RenderBuffer will try to skip storing its contents. + Checks if a shader variant is in the collection. + Shader variant to check. + + True if the variant is in the collection. + - + - Make RenderBuffer to Store its contents. + Create a new empty shader variant collection. - + - Identifies a RenderTexture for a Rendering.CommandBuffer. + Adds shader variant from the collection. + Shader variant to add. + + False if was not in the collection. + - + - Creates a render target identifier. + Identifies a specific variant of a shader. - RenderTexture object to use. - Built-in temporary render texture type. - Temporary render texture name. - Temporary render texture name (as integer, see Shader.PropertyToID). - + - Creates a render target identifier. + Array of shader keywords to use in this variant. - RenderTexture object to use. - Built-in temporary render texture type. - Temporary render texture name. - Temporary render texture name (as integer, see Shader.PropertyToID). - + - Creates a render target identifier. + Pass type to use in this variant. - RenderTexture object to use. - Built-in temporary render texture type. - Temporary render texture name. - Temporary render texture name (as integer, see Shader.PropertyToID). - + - Creates a render target identifier. + Shader to use in this variant. - RenderTexture object to use. - Built-in temporary render texture type. - Temporary render texture name. - Temporary render texture name (as integer, see Shader.PropertyToID). - + - How shadows are cast from this object. + Creates a ShaderVariant structure. + + + - + - No shadows are cast from this object. + Fully load shaders in ShaderVariantCollection. - + - Shadows are cast from this object. + Shadow projection type for. - + - Object casts shadows, but is otherwise invisible in the scene. + Close fit shadow maps with linear fadeout. - + - Shadows are cast from this object, treating it as two-sided. + Stable shadow maps with spherical fadeout. - + - Used by CommandBuffer.SetShadowSamplingMode. + Determines which type of shadows should be used. - + - Default shadow sampling mode: sampling with a comparison filter. + Hard and Soft Shadows. - + - Shadow sampling mode for sampling the depth value. + Disable Shadows. - + - Spherical harmonics up to the second order (3 bands, 9 coefficients). + Hard Shadows Only. - + - Add ambient lighting to probe data. + Default shadow resolution. - - + - Add directional light to probe data. + High shadow map resolution. - - - - + - Clears SH probe to zero. + Low shadow map resolution. - + - Returns true if SH probes are equal. + Medium shadow map resolution. - - - + - Scales SH by a given factor. + Very high shadow map resolution. - - - + - Scales SH by a given factor. + 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. - - - + - Returns true if SH probes are different. + Details of the Transform name mapped to a model's skeleton bone and its default position and rotation in the T-pose. - - - + - Adds two SH probes. + The name of the Transform mapped to the bone. - - - + - Access individual SH coefficients. + The T-pose position of the bone in local space. - + - Specifies the operation that's performed on the stencil buffer when rendering. + The T-pose rotation of the bone in local space. - + - Decrements the current stencil buffer value. Clamps to 0. + The T-pose scaling of the bone in local space. - + - Decrements the current stencil buffer value. Wraps stencil buffer value to the maximum representable unsigned value when decrementing a stencil buffer value of zero. + The Skinned Mesh filter. - + - Increments the current stencil buffer value. Clamps to the maximum representable unsigned value. + The bones used to skin the mesh. - + - Increments the current stencil buffer value. Wraps stencil buffer value to zero when incrementing the maximum representable unsigned value. + AABB of this Skinned Mesh in its local space. - + - Bitwise inverts the current stencil buffer value. + The maximum number of bones affecting a single vertex. - + - Keeps the current stencil value. + The mesh used for skinning. - + - Replace the stencil buffer value with reference value (specified in the shader). + Specifies whether skinned motion vectors should be used for this renderer. - + - Sets the stencil buffer value to zero. + If enabled, the Skinned Mesh will be updated when offscreen. If disabled, this also disables updating animations. - + - Rendering path of a Camera. + Creates a snapshot of SkinnedMeshRenderer and stores it in mesh. + A static mesh that will receive the snapshot of the skinned mesh. - + - Deferred Lighting (Legacy). + Returns weight of BlendShape on this renderer. + - + - Deferred Shading. + Sets the weight in percent of a BlendShape on this Renderer. + The index of the BlendShape to modify. + The weight in percent for this BlendShape. - + - Forward Rendering. + The maximum number of bones affecting a single vertex. - + - Use Player Settings. + Chooses the number of bones from the number current QualitySettings. (Default) - + - Vertex Lit. + Use only 1 bone to deform a single vertex. (The most important bone will be used). - + - RenderMode for the Canvas. + Use 2 bones to deform a single vertex. (The most important bones will be used). - + - Render using the Camera configured on the Canvas. + Use 4 bones to deform a single vertex. - + - Render at the end of the scene using a 2D Canvas. + A script interface for the. - + - Render using any Camera in the scene that can render the layer. + The material used by the skybox. - + - The Render Settings contain values for a range of visual elements in your scene, like fog and ambient light. + Constants for special values of Screen.sleepTimeout. - + - Ambient lighting coming from the sides. + Prevent screen dimming. - + - Ambient lighting coming from below. + Set the sleep timeout to whatever the user has specified in the system settings. - + - How much the light from the Ambient Source affects the scene. + Joint that restricts the motion of a Rigidbody2D object to a single line. - + - Flat ambient lighting color. + The angle of the line in space (in degrees). - + - Ambient lighting mode. + Should the angle be calculated automatically? - + - Custom or skybox ambient lighting data. + The current joint speed. - + - Ambient lighting coming from above. + The current joint translation. - + - Custom specular reflection cubemap. + Restrictions on how far the joint can slide in each direction along the line. - + - Default reflection mode. + Gets the state of the joint limit. - + - Cubemap resolution for default reflection. + Parameters for a motor force that is applied automatically to the Rigibody2D along the line. - + - The fade speed of all flares in the scene. + The angle (in degrees) referenced between the two bodies used as the constraint for the joint. - + - The intensity of all flares in the scene. + Should motion limits be used? - + - Is fog enabled? + Should a motor force be applied automatically to the Rigidbody2D? - + - The color of the fog. + Gets the motor force of the joint given the specified timestep. + The time to calculate the motor force for. - + - The density of the exponential fog. + Generic access to the Social API. - + - The ending distance of linear fog. + The local user (potentially not logged in). - + - Fog mode to use. + This is the currently active social platform. - + - The starting distance of linear fog. + Create an IAchievement instance. - + - Size of the Light halos. + Create an ILeaderboard instance. - + - The number of times a reflection includes other reflections. + Loads the achievement descriptions accociated with this application. + - + - How much the skybox / custom cubemap reflection affects the scene. + Load the achievements the logged in user has already achieved or reported progress on. + - + - The global skybox to use. + Load a default set of scores from the given leaderboard. + + - + - Fully describes setup of RenderTarget. + Load the user profiles accociated with the given array of user IDs. + + - + - Color Buffers to set. + Reports the progress of an achievement. + + + - + - Load Actions for Color Buffers. It will override any actions set on RenderBuffers themselves. + Report a score to a specific leaderboard. + + + - + - Store Actions for Color Buffers. It will override any actions set on RenderBuffers themselves. + Show a default/system view of the games achievements. - + - Cubemap face to render to. + Show a default/system view of the games leaderboards. - + - Depth Buffer to set. + iOS GameCenter implementation for network services. - + - Load Action for Depth Buffer. It will override any actions set on RenderBuffer itself. + Reset all the achievements for the local user. + - + - Store Actions for Depth Buffer. It will override any actions set on RenderBuffer itself. + Show the default iOS banner when achievements are completed. + - + - Mip Level to render to. + Show the leaderboard UI with a specific leaderboard shown initially with a specific time scope selected. + + - + - Constructs RenderTargetSetup. + Information for a user's achievement. - Color Buffer(s) to set. - Depth Buffer to set. - Mip Level to render to. - Cubemap face to render to. - - + - Constructs RenderTargetSetup. + Set to true when percentCompleted is 100.0. - Color Buffer(s) to set. - Depth Buffer to set. - Mip Level to render to. - Cubemap face to render to. - - + - Constructs RenderTargetSetup. + This achievement is currently hidden from the user. - Color Buffer(s) to set. - Depth Buffer to set. - Mip Level to render to. - Cubemap face to render to. - - + - Constructs RenderTargetSetup. + The unique identifier of this achievement. - Color Buffer(s) to set. - Depth Buffer to set. - Mip Level to render to. - Cubemap face to render to. - - + - Constructs RenderTargetSetup. + Set by server when percentCompleted is updated. - Color Buffer(s) to set. - Depth Buffer to set. - Mip Level to render to. - Cubemap face to render to. - - + - Constructs RenderTargetSetup. + Progress for this achievement. - 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. + Send notification about progress on this achievement. + - + - Currently active render texture. + Static data describing an achievement. - + - The antialiasing level for the RenderTexture. + Description when the achivement is completed. - + - Color buffer of the render texture (Read Only). + Hidden achievement are not shown in the list until the percentCompleted has been touched (even if it's 0.0). - + - The precision of the render texture's depth buffer in bits (0, 16, 24 are supported). + Unique identifier for this achievement description. - + - Depth/stencil buffer of the render texture (Read Only). + Image representation of the achievement. - + - Enable random access write into this render texture on Shader Model 5.0 level shaders. + Point value of this achievement. - + - The color format of the render texture. + Human readable title. - + - Should mipmap levels be generated automatically? + Description when the achivement has not been completed. - + - The height of the render texture in pixels. + The leaderboard contains the scores of all players for a particular game. - + - If enabled, this Render Texture will be used as a Cubemap. + Unique identifier for this leaderboard. - + - If enabled, this Render Texture will be used as a Texture3D. + The leaderboad is in the process of loading scores. - + - Does this render texture use sRGB read/write conversions (Read Only). + The leaderboard score of the logged in user. - + - Use mipmaps on a render texture? + The total amount of scores the leaderboard contains. - + - Volume extent of a 3D render texture. + The rank range this leaderboard returns. - + - The width of the render texture in pixels. + The leaderboard scores returned by a query. - + - Actually creates the RenderTexture. + The time period/scope searched by this leaderboard. - + - Creates a new RenderTexture object. + The human readable title of this leaderboard. - 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. - + - Creates a new RenderTexture object. + The users scope searched by this leaderboard. - 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. - + - Creates a new RenderTexture object. + Load scores according to the filters set on this leaderboard. - 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. + - + - Discards the contents of the RenderTexture. + Only search for these user IDs. - Should the colour buffer be discarded? - Should the depth buffer be discarded? + List of user ids. - + - Discards the contents of the RenderTexture. + Represents the local or currently logged in user. - Should the colour buffer be discarded? - Should the depth buffer be discarded? - + - Allocate a temporary render texture. + Checks if the current user has been authenticated. - 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. - Anti-aliasing (1,2,4,8). - + - Is the render texture actually created? + The users friends list. - + - Indicate that there's a RenderTexture restore operation expected. + Is the user underage? - + - Releases the RenderTexture. + 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. - + - Release a temporary texture allocated with GetTemporary. + 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. - + - Assigns this RenderTexture as a global shader property named propertyName. + 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. - + - + - Does a RenderTexture have stencil buffer? + A game score. - Render texture, or null for main screen. - + - Format of a RenderTexture. + The date the score was achieved. - + - Color render texture format, 1 bit for Alpha channel, 5 bits for Red, Green and Blue channels. + The correctly formatted value of the score, like X points or X kills. - + - Color render texture format. 10 bits for colors, 2 bits for alpha. + The ID of the leaderboard this score belongs to. - + - Color render texture format, 8 bits per channel. + The rank or position of the score in the leaderboard. - + - Color render texture format, 4 bit per channel. + The user who owns this score. - + - Color render texture format, 32 bit floating point per channel. + The score value achieved. - + - Color render texture format, 16 bit floating point per channel. + Report this score instance. + - + - Four channel (ARGB) render texture format, 32 bit signed integer per channel. + The generic Social API interface which implementations must inherit. - + - Default color render texture format: will be chosen accordingly to Frame Buffer format and Platform. + See Social.localUser. - + - Default HDR color render texture format: will be chosen accordingly to Frame Buffer format and Platform. + See Social.CreateAchievement.. - + - A depth render texture format. + See Social.CreateLeaderboard. - + - Scalar (R) render texture format, 8 bit fixed point. + See Social.LoadAchievementDescriptions. + - + - Scalar (R) render texture format, 32 bit floating point. + See Social.LoadAchievements. + - + - Color render texture format. + See Social.LoadScores. + + + - + - Two color (RG) render texture format, 32 bit floating point per channel. + See Social.LoadScores. + + + - + - Two color (RG) render texture format, 16 bit floating point per channel. + See Social.LoadUsers. + + - + - Two channel (RG) render texture format, 32 bit signed integer per channel. + See Social.ReportProgress. + + + - + - Scalar (R) render texture format, 16 bit floating point. + See Social.ReportScore. + + + - + - Scalar (R) render texture format, 32 bit signed integer. + See Social.ShowAchievementsUI. - + - A native shadowmap render texture format. + See Social.ShowLeaderboardUI. - + - Color space conversion mode of a RenderTexture. + Represents generic user instances, like friends of the local user. - + - Render texture contains sRGB (color) data, perform Linear<->sRGB conversions on it. + This users unique identifier. - + - Default color space conversion based on project settings. + Avatar image of the user. - + - Render texture contains linear (non-color) data; don't perform color conversions on it. + Is this user a friend of the current logged in user? - + - The RequireComponent attribute lets automatically add required component as a dependency. + Presence state of the user. - + - Require a single component. + This user's username or alias. - - + - Require a two components. + The score range a leaderboard query should include. - - - + - Require three components. + The total amount of scores retreived. - - - - + - Represents a display resolution. + The rank of the first score which is returned. - + - Resolution height in pixels. + 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. - + - Resolution's vertical refresh rate in Hz. + The scope of time searched through when querying the leaderboard. - + - Resolution width in pixels. + The scope of the users searched through when querying the leaderboard. - + - Returns a nicely formatted string of the resolution. + User presence state. - - A string with the format "width x height @ refreshRateHz". - - + - Asynchronous load request from the Resources bundle. + The user is offline. - + - Asset object being loaded (Read Only). + The user is online. - + - The Resources class allows you to find and access Objects including assets. + The user is online but away from their computer. - + - Returns a list of all objects of Type type. + The user is online but set their status to busy. - 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. + The user is playing a game. - + - Loads an asset stored at path in a Resources folder. + The limits defined by the CharacterJoint. - 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 an asset stored at path in a Resources folder. + When the joint hits the limit, it can be made to bounce off it. - 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 an asset stored at path in a Resources folder. + Determines how far ahead in space the solver can "see" the joint limit. - Pathname of the target folder. When using the empty string (i.e., ""), the function will load the entire contents of the Resources folder. - + - Loads all assets in a folder or file at path in a Resources folder. + If spring is greater than zero, the limit is soft. - 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. + The limit position/angle of the joint (in degrees). - 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. + If greater than zero, the limit is soft. The spring will pull the joint back. - 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). + The configuration of the spring attached to the joint's limits: linear and angular. Used by CharacterJoint and ConfigurableJoint. - Pathname of the target asset. - Type filter for objects returned. - + - Returns a resource at an asset path (Editor Only). + The damping of the spring limit. In effect when the stiffness of the sprint limit is not zero. - Pathname of the target asset. - + - Asynchronously loads an asset stored at path in a Resources folder. + The stiffness of the spring limit. When stiffness is zero the limit is hard, otherwise soft. - 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. + 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. - 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. + 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. - 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. + Returns all the layers defined in this project. - - + - Unloads assets that are not used. + Returns the name of the layer as defined in the TagManager. - - Object on which you can yield to wait until the operation completes. - - + - Control of an object's position through physics simulation. + This is the relative value that indicates the sort order of this layer relative to the other layers. - + - The angular drag of the object. + 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. + - + - The angular velocity vector of the rigidbody. + 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. + - + - The center of mass relative to the transform's origin. + 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. + - + - The Rigidbody's collision detection mode. + 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. + - + - Controls which degrees of freedom are allowed for the simulation of this Rigidbody. + 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. + - + - Should collision detection be enabled? (By default always enabled). + The coordinate space in which to operate. - + - The drag of the object. + Applies transformation relative to the local coordinate system. - + - Controls whether physics will change the rotation of the object. + Applies transformation relative to the world coordinate system. - + - The diagonal inertia tensor of mass relative to the center of mass. + Use this PropertyAttribute to add some spacing in the Inspector. - + - The rotation of the inertia tensor. + The spacing in pixels. - + - Interpolation allows you to smooth out the effect of running physics at a fixed frame rate. + Use this DecoratorDrawer to add some spacing in the Inspector. + The spacing in pixels. - + - Controls whether physics affects the rigidbody. + Class for handling Sparse Textures. - + - The mass of the rigidbody. + Is the sparse texture actually created? (Read Only) - + - The maximimum angular velocity of the rigidbody. (Default 7) range { 0, infinity }. + Get sparse texture tile height (Read Only). - + - Maximum velocity of a rigidbody when moving out of penetrating state. + Get sparse texture tile width (Read Only). - + - The position of the rigidbody. + 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). - + - The rotation of the rigdibody. + 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). - + - The angular velocity below which objects start going to sleep. (Default 0.14) range { 0, infinity }. + Unload sparse texture tile. + Tile X coordinate. + Tile Y coordinate. + Mipmap level of the texture. - + - The mass-normalized energy threshold, below which objects start going to sleep. + Update sparse texture tile with color values. + Tile X coordinate. + Tile Y coordinate. + Mipmap level of the texture. + Tile color data. - + - The linear velocity below which objects start going to sleep. (Default 0.14) range { 0, infinity }. + Update sparse texture tile with raw pixel values. + Tile X coordinate. + Tile Y coordinate. + Mipmap level of the texture. + Tile raw pixel data. - + - Allows you to override the solver iteration count per rigidbody. + A sphere-shaped primitive collider. - + - Force cone friction to be used for this rigidbody. + The center of the sphere in the object's local space. - + - Controls whether gravity affects this rigidbody. + The radius of the sphere measured in the object's local space. - + - The velocity vector of the rigidbody. + A Splat prototype is just a texture that is used by the TerrainData. - + - The center of mass of the rigidbody in world space (Read Only). + The metallic value of the splat layer. - + - Applies a force to a rigidbody that simulates explosion effects. + Normal map of the splat applied to the Terrain. - 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 smoothness value of the splat layer when the main texture has no alpha channel. - 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. + Texture of the splat applied to the Terrain. - 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. + Offset of the tile texture of the SplatPrototype. - Force vector in world coordinates. - - + - Adds a force to the rigidbody. + Size of the tile used in the texture of the SplatPrototype. - Force vector in world coordinates. - - + - Adds a force to the rigidbody. + The spring joint ties together 2 rigid bodies, spring forces will be automatically applied to keep the object at the given distance. - Size of force along the world x-axis. - Size of force along the world y-axis. - Size of force along the world z-axis. - - + - Adds a force to the rigidbody. + The damper force used to dampen the spring force. - Size of force along the world x-axis. - Size of force along the world y-axis. - Size of force along the world z-axis. - - + - Applies force at position. As a result this will apply a torque and force on the object. + The maximum distance between the bodies relative to their initial distance. - 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. + The minimum distance between the bodies relative to their initial distance. - Force vector in world coordinates. - Position in world coordinates. - - + - Adds a force to the rigidbody relative to its coordinate system. + The spring force used to keep the two objects together. - Force vector in local coordinates. - - + - Adds a force to the rigidbody relative to its coordinate system. + The maximum allowed error between the current spring length and the length defined by minDistance and maxDistance. - Force vector in local coordinates. - - + - Adds a force to the rigidbody relative to its coordinate system. + Joint that attempts to keep two Rigidbody2D objects a set distance apart by applying a force between them. - 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. + Should the distance be calculated automatically? - 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. + The amount by which the spring force is reduced in proportion to the movement speed. - Torque vector in local coordinates. - - + - Adds a torque to the rigidbody relative to its coordinate system. + The distance the spring will try to keep between the two objects. - Torque vector in local coordinates. - - + - Adds a torque to the rigidbody relative to its coordinate system. + The frequency at which the spring oscillates around the distance distance between the objects. - 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. + Represents a Sprite object for use in 2D gameplay. - 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. + 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. - Torque vector in world coordinates. - - + - Adds a torque to the rigidbody. + Returns the border sizes of the sprite. - Torque vector in world coordinates. - - + - Adds a torque to the rigidbody. + Bounds of the Sprite, specified by its center and extents in world space units. - 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. + Returns true if this Sprite is packed in an atlas. - 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. + If Sprite is packed (see Sprite.packed), returns its SpritePackingMode. - - + - The velocity of the rigidbody at the point worldPoint in global space. + If Sprite is packed (see Sprite.packed), returns its SpritePackingRotation. - - + - The velocity relative to the rigidbody at the point relativePoint. + Location of the Sprite's center point in the Rect on the original Texture, specified in pixels. - - + - Is the rigidbody sleeping? + The number of pixels in the sprite that correspond to one unit in world space. (Read Only) - + - Moves the rigidbody to position. + Location of the Sprite on the original Texture, specified in pixels. - The new position for the Rigidbody object. - + - Rotates the rigidbody to rotation. + Get the reference to the used texture. If packed this will point to the atlas, if not packed will point to the source sprite. - The new rotation for the Rigidbody. - + - Reset the center of mass of the rigidbody. + Get the rectangle this sprite uses on its texture. Raises an exception if this sprite is tightly packed in an atlas. - + - Reset the inertia tensor value and rotation. + 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. - + - Sets the mass based on the attached colliders assuming a constant density. + Returns a copy of the array containing sprite mesh triangles. - - + - Forces a rigidbody to sleep at least one frame. + The base texture coordinates of the sprite mesh. - + - Tests if a rigidbody would collide with anything, if it was moved through the scene. + Returns a copy of the array containing sprite mesh vertex positions. - 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. + Create a new Sprite object. - 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. - + 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). - + - Forces a rigidbody to wake up. + Sets up new Sprite geometry. + Array of vertex positions in Sprite Rect space. + Array of sprite mesh triangle indices. - + - Rigidbody physics component for 2D sprites. + How a Sprite's graphic rectangle is aligned with its pivot point. - + - Coefficient of angular drag. + Pivot is at the center of the bottom edge of the graphic rectangle. - + - Angular velocity in degrees per second. + Pivot is at the bottom left corner of the graphic rectangle. - + - The center of mass of the rigidBody in local space. + Pivot is at the bottom right corner of the graphic rectangle. - + - The method used by the physics engine to check if two objects have collided. + Pivot is at the center of the graphic rectangle. - + - Controls which degrees of freedom are allowed for the simulation of this Rigidbody2D. + Pivot is at a custom position within the graphic rectangle. - + - Coefficient of drag. + Pivot is at the center of the left edge of the graphic rectangle. - + - Should the rigidbody be prevented from rotating? + Pivot is at the center of the right edge of the graphic rectangle. - + - Controls whether physics will change the rotation of the object. + Pivot is at the center of the top edge of the graphic rectangle. - + - The degree to which this object is affected by gravity. + Pivot is at the top left corner of the graphic rectangle. - + - The rigidBody rotational inertia. + Pivot is at the top right corner of the graphic rectangle. - + - Physics interpolation used between updates. + SpriteRenderer draw mode. - + - Should this rigidbody be taken out of physics control? + Displays the full sprite. - + - Mass of the rigidbody. + The SpriteRenderer will render the sprite as a 9-slice image where the corners will remain constant and the other sections will scale. - + - The position of the rigidbody. + The SpriteRenderer will render the sprite as a 9-slice image where the corners will remain constant and the other sections will tile. - + - The rotation of the rigdibody. + Defines the type of mesh generated for a sprite. - + - Indicates whether the rigid body should be simulated or not by the physics system. + Rectangle mesh equal to the user specified sprite size. - + - The sleep state that the rigidbody will initially be in. + Tight mesh based on pixel alpha values. As many excess pixels are cropped as possible. - + - Should the total rigid-body mass be automatically calculated from the Collider2D.density of attached colliders? + Sprite packing modes for the Sprite Packer. - + - Linear velocity of the rigidbody. + Alpha-cropped ractangle packing. - + - Gets the center of mass of the rigidBody in global space. + Tight mesh based packing. - + - Apply a force to the rigidbody. + Sprite rotation modes for the Sprite Packer. - 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. + Any rotation. - 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. + No rotation. - 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. + Renders a Sprite for 2D graphics. - Torque to apply. - The force mode to use. - + - Get a local space point given the point point in rigidBody global space. + The current threshold for Sprite Renderer tiling. - The global space point to transform into local space. - + - The velocity of the rigidbody at the point Point in global space. + Rendering color for the Sprite graphic. - The global space point to calculate velocity for. - + - Get a global space point given the point relativePoint in rigidBody local space. + The current draw mode of the Sprite Renderer. - The local space point to transform into global space. - + - The velocity of the rigidbody at the point Point in local space. + Flips the sprite on the X axis. - The local space point to calculate velocity for. - + - Get a global space vector given the vector relativeVector in rigidBody local space. + Flips the sprite on the Y axis. - The local space vector to transform into a global space vector. - + - Get a local space vector given the vector vector in rigidBody global space. + Property to set/get the size to render when the SpriteRenderer.drawMode is set to SpriteDrawMode.NineSlice. - The global space vector to transform into a local space vector. - + - Is the rigidbody "awake"? + The Sprite to render. - + - Is the rigidbody "sleeping"? + The current tile mode of the Sprite Renderer. - + - Check whether any of the collider(s) attached to this rigidbody are touching the collider or not. + Helper utilities for accessing Sprite data. - 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 any of the collider(s) attached to this rigidbody are touching any colliders on the specified layerMask or not. + Inner UV's of the Sprite. - 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. + Minimum width and height of the Sprite. - The new position for the Rigidbody object. + - + - Rotates the rigidbody to angle (given in degrees). + Outer UV's of the Sprite. - The new rotation angle for the Rigidbody object. + - + - Make the rigidbody "sleep". + Return the padding on the sprite. + - + - Disables the "sleeping" state of a rigidbody. + Tiling mode for SpriteRenderer.tileMode. - + - Use these flags to constrain motion of Rigidbodies. + Sprite Renderer tiles the sprite once the Sprite Renderer size is above SpriteRenderer.adaptiveModeThreshold. - + - Freeze rotation and motion along all axes. + Sprite Renderer tiles the sprite continuously when is set to SpriteRenderer.tileMode. - + - Freeze motion along all axes. + Stack trace logging options. - + - Freeze motion along the X-axis. + Native and managed stack trace will be logged. - + - Freeze motion along the Y-axis. + No stack trace will be outputed to log. - + - Freeze motion along the Z-axis. + Only managed stack trace will be outputed. - + - Freeze rotation along all axes. + 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. - + - Freeze rotation along the X-axis. + Called on the first Update frame when a statemachine evaluate this state. - + - Freeze rotation along the Y-axis. + Called on the last update frame when a statemachine evaluate this state. - + - Freeze rotation along the Z-axis. + Called right after MonoBehaviour.OnAnimatorIK. - + - No constraints. + Called on the first Update frame when making a transition to 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. - + - Use these flags to constrain motion of the Rigidbody2D. + 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. - + - Freeze rotation and motion along all axes. + Called right after MonoBehaviour.OnAnimatorMove. - + - Freeze motion along the X-axis and Y-axis. + Called at each Update frame except for the first and last frame. - + - Freeze motion along the X-axis. + StaticBatchingUtility can prepare your objects to take advantage of Unity's static batching. - + - Freeze motion along the Y-axis. + StaticBatchingUtility.Combine prepares all children of the staticBatchRoot for static batching. + - + - Freeze rotation along the Z-axis. + StaticBatchingUtility.Combine prepares all gos for static batching. staticBatchRoot is treated as their parent. + + - + - No constraints. + Enum values for the Camera's targetEye property. - + - Rigidbody interpolation mode. + Render both eyes to the HMD. - + - Extrapolation will predict the position of the rigidbody based on the current velocity. + Render only the Left eye to the HMD. - + - Interpolation will always lag a little bit behind but can be smoother than extrapolation. + Do not render either eye to the HMD. - + - No Interpolation. + Render only the right eye to the HMD. - + - Interpolation mode for Rigidbody2D objects. + Applies tangent forces along the surfaces of colliders. - + - Smooth an object's movement based on an estimate of its position in the next frame. + The scale of the impulse force applied while attempting to reach the surface speed. - + - Smooth movement based on the object's positions in previous frames. + The speed to be maintained along the surface. - + - Do not apply any smoothing to the object's movement. + The speed variation (from zero to the variation) added to base speed to be applied. - + - Settings for a Rigidbody2D's initial sleep state. + Should bounce be used for any contact with the surface? - + - Rigidbody2D never automatically sleeps. + Should the impulse force but applied to the contact point? - + - Rigidbody2D is initially asleep. + Should friction be used for any contact with the surface? - + - Rigidbody2D is initially awake. + Access system and hardware information. - + - Control ConfigurableJoint's rotation with either X & YZ or Slerp Drive. + The current battery level (Read Only). - + - Use Slerp drive. + Returns the current status of the device's battery (Read Only). - + - Use XY & Z Drive. + Support for various Graphics.CopyTexture cases (Read Only). - + - Attribute for setting up RPC functions. + The model of the device (Read Only). - + - Option for who will receive an RPC, used by NetworkView.RPC. + The user defined name of the device (Read Only). - + - Sends to everyone. + Returns the kind of device the application is running on (Read Only). - + - Sends to everyone and adds to the buffer. + A unique device identifier. It is guaranteed to be unique for every device (Read Only). - + - Sends to everyone except the sender. + The identifier code of the graphics device (Read Only). - + - Sends to everyone except the sender and adds to the buffer. + The name of the graphics device (Read Only). - + - Sends to the server only. + The graphics API type used by the graphics device (Read Only). - + - Runtime representation of the AnimatorController. It can be used to change the Animator's controller during runtime. + The vendor of the graphics device (Read Only). - + - Retrieves all AnimationClip used by the controller. + The identifier code of the graphics device vendor (Read Only). - + - Set RuntimeInitializeOnLoadMethod type. + The graphics API type and driver version used by the graphics device (Read Only). - + - After scene is loaded. + Amount of video memory present (Read Only). - + - Before scene is loaded. + Is graphics device using multi-threaded rendering (Read Only)? - + - Allow an runtime class method to be initialized when Unity game loads runtime without action from the user. + Graphics device shader capability level (Read Only). - + - Set RuntimeInitializeOnLoadMethod type. + Returns true if the texture UV coordinate convention for this platform has Y starting at the top of the image. - + - Allow an runtime class method to be initialized when Unity game loads runtime without action from the user. + Maximum Cubemap texture size (Read Only). - RuntimeInitializeLoadType: Before or After scene is loaded. - + - Allow an runtime class method to be initialized when Unity game loads runtime without action from the user. + Maximum texture size (Read Only). - RuntimeInitializeLoadType: Before or After scene is loaded. - + - The platform application is running. Returned by Application.platform. + What NPOT (non-power of two size) texture support does the GPU provide? (Read Only) - + - In the player on the Apple's tvOS. + Operating system name with version (Read Only). - + - In the player on Android devices. + Returns the operating system family the game is running on (Read Only). - + - In the player on the iPhone. + Number of processors present (Read Only). - + - In the player on Linux. + Processor frequency in MHz (Read Only). - + - In the Dashboard widget on Mac OS X. + Processor name (Read Only). - + - In the Unity editor on Mac OS X. + How many simultaneous render targets (MRTs) are supported? (Read Only) - + - In the player on Mac OS X. + Are 2D Array textures supported? (Read Only) - + - In the web player on Mac OS X. + Are 3D (volume) RenderTextures supported? (Read Only) - + - In the player on the Play Station 3. + Are 3D (volume) textures supported? (Read Only) - + - In the player on the Playstation 4. + Is an accelerometer available on the device? - + - In the player on the PS Vita. + Is there an Audio device available for playback? - + - In the player on Samsung Smart TV. + Are compute shaders supported? (Read Only) - + - In the player on Tizen. + Are Cubemap Array textures supported? (Read Only) - + - In the player on WebGL? + Is a gyroscope available on the device? - + - In the player on Wii U. + Are image effects supported? (Read Only) - + - In the Unity editor on Windows. + Is GPU draw call instancing supported? (Read Only) - + - In the player on Windows. + Is the device capable of reporting its location? - + - In the web player on Windows. + Whether motion vectors are supported on this platform. - + - In the player on Windows Store Apps when CPU architecture is ARM. + Is sampling raw depth from shadowmaps supported? (Read Only) - + - In the player on Windows Store Apps when CPU architecture is X64. + Are render textures supported? (Read Only) - + - In the player on Windows Store Apps when CPU architecture is X86. + Are cubemap render textures supported? (Read Only) - + - In the player on the XBOX360. + Are built-in shadows supported? (Read Only) - + - In the player on Xbox One. + Are sparse textures supported? (Read Only) - + - Interface into SamsungTV specific functionality. + Is the stencil buffer supported? (Read Only) - + - Returns true if there is an air mouse available. + Is the device capable of providing the user haptic feedback by vibration? - + - Changes the type of input the gamepad produces. + Amount of system memory present (Read Only). - + - Changes the type of input the gesture camera produces. + Value returned by SystemInfo string properties which are not supported on the current platform. - + - Returns true if the camera sees a hand. + 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) - + - The type of input the remote's touch pad produces. + Is render texture format supported? + The format to look up. + + True if the format is supported. + - + - Types of input the gamepad can produce. + Is texture format supported on this device? + The TextureFormat format to look up. + + True if the format is supported. + - + - Joystick style input. + The language the user's operating system is running in. Returned by Application.systemLanguage. - + - Mouse style input. + Afrikaans. - + - Types of input the gesture camera can produce. + Arabic. - + - Two hands control two joystick axes. + Basque. - + - Hands control the mouse pointer. + Belarusian. - + - No gesture input from the camera. + Bulgarian. - + - Access to TV specific information. + Catalan. - + - The server type. Possible values: -Developing, Development, Invalid, Operating. + Chinese. - + - Get local time on TV. + ChineseSimplified. - + - Get UID from TV. + ChineseTraditional. - + - Set the system language that is returned by Application.SystemLanguage. + Czech. - - + - Types of input the remote's touchpad can produce. + Danish. - + - Remote dependent. On 2013 TVs dpad directions are determined by swiping in the correlating direction. On 2014 and 2015 TVs the remote has dpad buttons. + Dutch. - + - Touchpad works like an analog joystick. Not supported on the 2015 TV as there is no touchpad. + English. - + - Touchpad controls a remote curosr like a laptop's touchpad. This can be replaced by airmouse functionality which is available on 2014 and 2015 TVs. + Estonian. - + - Scaling mode to draw textures with. + Faroese. - + - 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. + Finnish. - + - Scales the texture, maintaining aspect ratio, so it completely fits withing the position rectangle passed to GUI.DrawTexture. + French. - + - Stretches the texture to fill the complete rectangle passed in to GUI.DrawTexture. + German. - + - Used when loading a scene in a player. + Greek. - + - Adds the scene to the current loaded scenes. + Hebrew. - + - Closes all current loaded scenes and loads a scene. + Hungarian. - + - Run-time data structure for *.unity file. + Icelandic. - + - Returns the index of the scene in the Build Settings. Always returns -1 if the scene was loaded through an AssetBundle. + Indonesian. - + - Returns true if the scene is modifed. + Italian. - + - Returns true if the scene is loaded. + Japanese. - + - Returns the name of the scene. + Korean. - + - Returns the relative path of the scene. Like: "AssetsMyScenesMyScene.unity". + Latvian. - + - The number of root transforms of this scene. + Lithuanian. - + - Returns all the root game objects in the scene. + Norwegian. - - An array of game objects. - - + - Returns all the root game objects in the scene. + Polish. - A list which is used to return the root game objects. - + - Tells if the scene is valid. -A scene can be invalid if you eg. tried to open a scene that does not exists in that case the scene returnen from EditorSceneManager.OpenScene would be invalid. + Portuguese. - - Returns true if the scene is valid. - - + - Returns true if the Scenes are equal. + Romanian. - - - + - Returns true if the Scenes are different. + Russian. - - - + - Scene management at run-time. + Serbo-Croatian. - + - The total number of scenes. + Slovak. - + - Number of scenes in Build Settings. + Slovenian. - + - Create an empty new scene with the given name additively. + Spanish. - The name of the new scene. It cannot be empty or null, or same as the name of the existing scenes. - + - Get the active scene. + Swedish. - + - Get the scene at index in the SceneManager's list of added scenes. + Thai. - Index of the scene to get. Index must be greater than or equal to 0 and less than SceneManager.sceneCount. - + - Searches through the scenes added to the SceneManager for a scene with the given name. + Turkish. - Name of scene to find. - - The scene if found or an invalid scene if not. - - + - Searches all scenes added to the SceneManager for a scene that has the given asset path. + Ukrainian. - Path of the scene. Should be relative to the project folder. Like: "AssetsMyScenesMyScene.unity". - + - Loads the scene by its name or index in Build Settings. + Unknown. - Name 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. + Vietnamese. - Name 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 asynchronously in the background. + The joint attempts to move a Rigidbody2D to a specific target position. - Name 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. - + - Loads the scene asynchronously in the background. + The local-space anchor on the rigid-body the joint is attached to. - Name 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. - + - This will merge the source scene into the destinationScene. -This function merges the contents of the source scene into the destination scene, and deletes the source scene. All GameObjects at the root of the source scene are moved to the root of the destination scene. -NOTE: This function is destructive: The source scene will be destroyed once the merge has been completed. + Should the target be calculated automatically? - 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. -It is required that the GameObject is at the root of its current scene. + The amount by which the target spring force is reduced in proportion to the movement speed. - GameObject to move. - Scene to move into. - + - Set the scene to be active. + 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 scene to be set. - - Returns false if the scene is not loaded yet. - - + - Unloads all GameObjects associated with the given scene. + The world-space position that the joint will attempt to move the body to. - Index of the scene in the Build Settings to unload. - Name of the scene to unload. - Scene to unload. - - Returns true if the scene is unloaded. - - + - Unloads all GameObjects associated with the given scene. + The Terrain component renders the terrain. - Index of the scene in the Build Settings to unload. - Name of the scene to unload. - Scene to unload. - - Returns true if the scene is unloaded. - - + - Unloads all GameObjects associated with the given scene. + The active terrain. This is a convenience function to get to the main terrain in the scene. - Index of the scene in the Build Settings to unload. - Name of the scene to unload. - Scene to unload. - - Returns true if the scene is unloaded. - - + - Access to display information. + The active terrains in the scene. - + - Allow auto-rotation to landscape left? + Specifies if an array of internal light probes should be baked for terrain trees. Available only in editor. - + - Allow auto-rotation to landscape right? + Heightmap patches beyond basemap distance will use a precomputed low res basemap. - + - Allow auto-rotation to portrait? + Should terrain cast shadows?. - + - Allow auto-rotation to portrait, upside down? + Collect detail patches from memory. - + - The current screen resolution (Read Only). + Density of detail objects. - + - The current DPI of the screen / device (Read Only). + Detail objects will be displayed up to this distance. - + - Is the game running fullscreen? + Specify if terrain heightmap should be drawn. - + - The current height of the screen window in pixels (Read Only). + Specify if terrain trees and details should be drawn. - + - Should the cursor be locked? + Controls what part of the terrain should be rendered. - + - Specifies logical orientation of the screen. + Lets you essentially lower the heightmap resolution used for rendering. - + - All fullscreen resolutions supported by the monitor (Read Only). + An approximation of how many pixels the terrain will pop in the worst case when switching lod. - + - Should the cursor be visible? + The shininess value of the terrain. - + - A power saving setting, allowing the screen to dim some time after the last active user interaction. + The specular color of the terrain. - + - The current width of the screen window in pixels (Read Only). + The index of the baked lightmap applied to this terrain. - + - Switches the screen resolution. + The UV scale & offset used for a baked lightmap. - - - - - + - Switches the screen resolution. + The custom material used to render the terrain. - - - - - + - Describes screen orientation. + The type of the material used to render the terrain. Could be one of the built-in types or custom. See Terrain.MaterialType. - + - Auto-rotates the screen as necessary toward any of the enabled orientations. + The index of the realtime lightmap applied to this terrain. - + - Landscape orientation, counter-clockwise from the portrait orientation. + The UV scale & offset used for a realtime lightmap. - + - Landscape orientation, clockwise from the portrait orientation. + How reflection probes are used for terrain. See Rendering.ReflectionProbeUsage. - + - Portrait orientation. + The Terrain Data that stores heightmaps, terrain textures, detail meshes and trees. - + - Portrait orientation, upside down. + Distance from the camera where trees will be rendered as billboards only. - + - A class you can derive from if you want to create objects that don't need to be attached to game objects. + Total distance delta that trees will use to transition from billboard orientation to mesh orientation. - + - Creates an instance of a scriptable object. + The maximum distance at which trees are rendered. - 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 multiplier to the current LOD bias used for rendering LOD trees (i.e. SpeedTree trees). - 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. + Maximum number of trees rendered at full LOD. - 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. - - + - PreserveAttribute prevents byte code stripping from removing a class, method, field, or property. + Adds a tree instance to the terrain. + - + - Webplayer security related class. + Update the terrain's LOD and vegetation information after making changes with TerrainData.SetHeightsDelayLOD. - + - Get secret from Chain of Trust system. + Creates a Terrain including collider from TerrainData. - The name of the secret. - - The secret. - + - + - Loads an assembly and checks that it is allowed to be used in the webplayer. -Note: The single argument version of this API will always issue an error message. An authorisation key is always needed. + Flushes any change done in the terrain so it takes effect. - 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. -Note: The single argument version of this API will always issue an error message. An authorisation key is always needed. + 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. - Assembly to verify. - Public key used to verify assembly. - - Loaded, verified, assembly, or null if the assembly cannot be verfied. - + [in / out] A list to hold the returned reflection probes and their weights. See ReflectionProbeBlendInfo. - + - Prefetch the webplayer socket security policy from a non-default port number. + Get the position of the terrain. - 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. + Get the previously set splat material properties by copying to the dest MaterialPropertyBlock object. - 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. + The type of the material used to render a terrain object. Could be one of the built-in types or custom. - + - Options for how to send a message. + A built-in material that uses the legacy Lambert (diffuse) lighting model and has optional normal map support. - + - No receiver is required for SendMessage. + A built-in material that uses the legacy BlinnPhong (specular) lighting model and has optional normal map support. - + - A receiver is required for SendMessage. + A built-in material that uses the standard physically-based lighting model. Inputs supported: smoothness, metallic / specular, normal. - + - Use this attribute to rename a field without losing its serialized value. + Use a custom material given by Terrain.materialTemplate. - + - The name of the field before the rename. + Samples the height at the given position defined in world space, relative to the terrain space. + - + - + Lets you setup the connection between neighboring Terrains. - The name of the field before renaming. + + + + - + - Force Unity to serialize a private field. + Set the additional material properties when rendering the terrain heightmap using the splat material. + - + - Shader scripts used for all rendering. + Indicate the types of changes to the terrain in OnTerrainChanged callback. - + - Shader LOD level for all shaders. + Indicates a change to the heightmap data without computing LOD. - + - Can this shader run on the end-users graphics card? (Read Only) + Indicates that a change was made to the terrain that was so significant that the internal rendering data need to be flushed and recreated. - + - Shader LOD level for this shader. + Indicates a change to the heightmap data. - + - Render queue of this shader. (Read Only) + Indicates a change to the detail data. - + - Unset a global shader keyword. + Indicates a change to the tree data. - - + - Set a global shader keyword. + Indicates that the TerrainData object is about to be destroyed. - - + - Finds a shader with the given name. + A heightmap based collider. - - + - Is global shader keyword enabled? + The terrain that stores the heightmap. - - + - Gets unique identifier for a shader property name. + The TerrainData class stores heightmaps, detail mesh positions, tree instances, and terrain texture alpha maps. - - + - Sets a global compute buffer property for all shaders. + Height of the alpha map. - - - + - Sets a global color property for all shaders. + Number of alpha map layers. - - - - + - Sets a global color property for all shaders. + Resolution of the alpha map. - - - - + - Sets a global float property for all shaders. + Alpha map textures used by the Terrain. Used by Terrain Inspector for undo. - - - - + - Sets a global float property for all shaders. + Width of the alpha map. - - - - + - Sets a global int property for all shaders. + Resolution of the base map used for rendering far patches on the terrain. - - - - + - Sets a global int property for all shaders. + The local bounding box of the TerrainData object. - - - - + - Sets a global matrix property for all shaders. + Detail height of the TerrainData. - - - - + - Sets a global matrix property for all shaders. + Contains the detail texture/meshes that the terrain has. - - - - + - Sets a global texture property for all shaders. + Detail Resolution of the TerrainData. - - - - + - Sets a global texture property for all shaders. + Detail width of the TerrainData. - - - - + - Sets a global vector property for all shaders. + Height of the terrain in samples (Read Only). - - - - + - Sets a global vector property for all shaders. + Resolution of the heightmap. - - - - + - Fully load all shaders to prevent future performance hiccups. + The size of each heightmap sample. - + - ShaderVariantCollection records which shader variants are actually used in each shader. + Width of the terrain in samples (Read Only). - + - Is this ShaderVariantCollection already warmed up? (Read Only) + The total size in world units of the terrain. - + - Number of shaders in this collection (Read Only). + Splat texture used by the terrain. - + - Number of total varians in this collection (Read Only). + The thickness of the terrain used for collision detection. - + - Adds a new shader variant to the collection. + Returns the number of tree instances. - Shader variant to add. - - False if already in the collection. - - + - Remove all shader variants from the collection. + Contains the current trees placed in the terrain. - + - Checks if a shader variant is in the collection. + The list of tree prototypes this are the ones available in the inspector. - Shader variant to check. - - True if the variant is in the collection. - - + - Create a new empty shader variant collection. + Amount of waving grass in the terrain. - + - Adds shader variant from the collection. + Speed of the waving grass. - Shader variant to add. - - False if was not in the collection. - - + - Identifies a specific variant of a shader. + Strength of the waving grass in the terrain. - + - Array of shader keywords to use in this variant. + Color of the waving grass that the terrain has. - + - Pass type to use in this variant. + 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. + - + - Shader to use in this variant. + Returns a 2D array of the detail object density in the specific location. + + + + + - + - Creates a ShaderVariant structure. + Gets the height at a certain point x,y. - - - + + - + - Fully load shaders in ShaderVariantCollection. + 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. - + - Shadow projection type for. + Gets an interpolated height at a point x,y. + + - + - Close fit shadow maps with linear fadeout. + Get an interpolated normal at a given location. + + - + - Stable shadow maps with spherical fadeout. + Gets the gradient of the terrain at point (x,y). + + - + - 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. + Returns an array of all supported detail layer indices in the area. + + + + - + - Details of the Transform name mapped to a model's skeleton bone and its default position and rotation in the T-pose. + 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. - + - The name of the Transform mapped to the bone. + Reloads all the values of the available prototypes (ie, detail mesh assets) in the TerrainData Object. - + - The T-pose position of the bone in local space. + Assign all splat values in the given map area. + + + - + - The T-pose rotation of the bone in local space. + Sets the detail layer density map. + + + + - + - The T-pose scaling of the bone in local space. + 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. - + - The Skinned Mesh filter. + 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]). - + - The bones used to skin the mesh. + 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]). - + - AABB of this Skinned Mesh in its local space. + 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. - + - The maximum number of bones affecting a single vertex. + Extension methods to the Terrain class, used only for the UpdateGIMaterials method used by the Global Illumination System. - + - The mesh used for skinning. + Schedules an update of the albedo and emissive Textures of a system that contains the Terrain. + + + + + - + - If enabled, the Skinned Mesh will be updated when offscreen. If disabled, this also disables updating animations. + Schedules an update of the albedo and emissive Textures of a system that contains the Terrain. + + + + + - + - Creates a snapshot of SkinnedMeshRenderer and stores it in mesh. + Enum provding terrain rendering options. - A static mesh that will receive the snapshot of the skinned mesh. - + - Returns weight of BlendShape on this renderer. + Render all options. - - + - Sets weight of BlendShape on this renderer. + Render terrain details. - - - + - The maximum number of bones affecting a single vertex. + Render heightmap. - + - Chooses the number of bones from the number current QualitySettings. (Default) + Render trees. - + - Use only 1 bone to deform a single vertex. (The most important bone will be used). + How multiline text should be aligned. - + - Use 2 bones to deform a single vertex. (The most important bones will be used). + Text lines are centered. - + - Use 4 bones to deform a single vertex. + Text lines are aligned on the left side. - + - A script interface for the. + Text lines are aligned on the right side. - + - The material used by the skybox. + Where the anchor of the text is placed. - + - Constants for special values of Screen.sleepTimeout. + Text is anchored in lower side, centered horizontally. - + - Prevent screen dimming. + Text is anchored in lower left corner. - + - Set the sleep timeout to whatever the user has specified in the system settings. + Text is anchored in lower right corner. - + - Joint that restricts the motion of a Rigidbody2D object to a single line. + Text is centered both horizontally and vertically. - + - The angle of the line in space (in degrees). + Text is anchored in left side, centered vertically. - + - Should the angle be calculated automatically? + Text is anchored in right side, centered vertically. - + - The current joint speed. + Text is anchored in upper side, centered horizontally. - + - The current joint translation. + Text is anchored in upper left corner. - + - Restrictions on how far the joint can slide in each direction along the line. + Text is anchored in upper right corner. - + - Gets the state of the joint limit. + Attribute to make a string be edited with a height-flexible and scrollable text area. - + - Parameters for a motor force that is applied automatically to the Rigibody2D along the line. + The maximum amount of lines the text area can show before it starts using a scrollbar. - + - The angle (in degrees) referenced between the two bodies used as the constraint for the joint. + The minimum amount of lines the text area will use. - + - Should motion limits be used? + 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. - + - Should a motor force be applied automatically to the Rigidbody2D? + 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. - + - Gets the motor force of the joint given the specified timestep. + Text file assets. - The time to calculate the motor force for. - + - Generic access to the Social API. + The raw bytes of the text asset. (Read Only) - + - The local user (potentially not logged in). + The text contents of the .txt file as a string. (Read Only) - + - This is the currently active social platform. + Different methods for how the GUI system handles text being too large to fit the rectangle allocated. - + - Create an IAchievement instance. + Text gets clipped to be inside the element. - + - Create an ILeaderboard instance. + Text flows freely outside the element. - + - Loads the achievement descriptions accociated with this application. + A struct that stores the settings for TextGeneration. - - + - Load the achievements the logged in user has already achieved or reported progress on. + Use the extents of glyph geometry to perform horizontal alignment rather than glyph metrics. - - + - Load a default set of scores from the given leaderboard. + The base color for the text generation. - - - + - Load the user profiles accociated with the given array of user IDs. + Font to use for generation. - - - + - Reports the progress of an achievement. + Font size. - - - - + - Report a score to a specific leaderboard. + Font style. - - - - + - Show a default/system view of the games achievements. + Continue to generate characters even if the text runs out of bounds. - + - Show a default/system view of the games leaderboards. + Extents that the generator will attempt to fit the text in. - + - iOS GameCenter implementation for network services. + What happens to text when it reaches the horizontal generation bounds. - + - Reset all the achievements for the local user. + The line spacing multiplier. - - + - Show the default iOS banner when achievements are completed. + Generated vertices are offset by the pivot. - - + - Show the leaderboard UI with a specific leaderboard shown initially with a specific time scope selected. + Should the text be resized to fit the configured bounds? - - - + - Information for a users achievement. + Maximum size for resized text. - + - Set to true when percentCompleted is 100.0. + Minimum size for resized text. - + - This achievement is currently hidden from the user. + Allow rich text markup in generation. - + - The unique identifier of this achievement. + A scale factor for the text. This is useful if the Text is on a Canvas and the canvas is scaled. - + - Set by server when percentCompleted is updated. + How is the generated text anchored. - + - Progress for this achievement. + Should the text generator update the bounds from the generated text. - + - Send notification about progress on this achievement. + What happens to text when it reaches the bottom generation bounds. - - + - Static data describing an achievement. + Class that can be used to generate text for rendering. - + - Description when the achivement is completed. + The number of characters that have been generated. - + - Hidden achievement are not shown in the list until the percentCompleted has been touched (even if it's 0.0). + The number of characters that have been generated and are included in the visible lines. - + - Unique identifier for this achievement description. + Array of generated characters. - + - Image representation of the achievement. + The size of the font that was found if using best fit mode. - + - Point value of this achievement. + Number of text lines generated. - + - Human readable title. + Information about each generated text line. - + - Description when the achivement has not been completed. + Extents of the generated text in rect format. - + - The leaderboard contains the scores of all players for a particular game. + Number of vertices generated. - + - Unique identifier for this leaderboard. + Array of generated vertices. - + - The leaderboad is in the process of loading scores. + Create a TextGenerator. + - + - The leaderboard score of the logged in user. + Create a TextGenerator. + - + - The total amount of scores the leaderboard contains. + Populate the given List with UICharInfo. + List to populate. - + - The rank range this leaderboard returns. + Returns the current UICharInfo. + + Character information. + - + - The leaderboard scores returned by a query. + Populate the given list with UILineInfo. + List to populate. - + - The time period/scope searched by this leaderboard. + Returns the current UILineInfo. + + Line information. + - + - The human readable title of this leaderboard. + Given a string and settings, returns the preferred height for a container that would hold this text. + Generation text. + Settings for generation. + + Preferred height. + - + - The users scope searched by this leaderboard. + Given a string and settings, returns the preferred width for a container that would hold this text. + Generation text. + Settings for generation. + + Preferred width. + - + - Load scores according to the filters set on this leaderboard. + Populate the given list with generated Vertices. - + List to populate. - + - Only search for these user IDs. + Returns the current UILineInfo. - List of user ids. + + Vertices. + - + - Represents the local or currently logged in user. + Mark the text generator as invalid. This will force a full text generation the next time Populate is called. - + - Checks if the current user has been authenticated. + Will generate the vertices and other data for the given string with the given settings. + String to generate. + Settings. - + - The users friends list. + 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. + - + - Is the user underage? + A script interface for the. - + - Authenticate the local user to the current active Social API implementation and fetch his profile data. + How lines of text are aligned (Left, Right, Center). - Callback that is called whenever authentication operation is finished. - + - 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. + Which point of the text shares the position of the Transform. - - + - A game score. + The size of each character (This scales the whole text). - + - The date the score was achieved. + The color used to render the text. - + - The correctly formatted value of the score, like X points or X kills. + The Font used. - + - The ID of the leaderboard this score belongs to. + The font size to use (for dynamic fonts). - + - The rank or position of the score in the leaderboard. + The font style to use (for dynamic fonts). - + - The user who owns this score. + How much space will be in-between lines of text. - + - The score value achieved. + How far should the text be offset from the transform.position.z when drawing. - + - Report this score instance. + Enable HTML-style tags for Text Formatting Markup. - - + - The generic Social API interface which implementations must inherit. + How much space will be inserted for a tab '\t' character. This is a multiplum of the 'spacebar' character offset. - + - See Social.localUser. + The text that is displayed. - + - See Social.CreateAchievement.. + Base class for texture handling. Contains functionality that is common to both Texture2D and RenderTexture classes. - + - See Social.CreateLeaderboard. + Anisotropic filtering level of the texture. - + - See Social.LoadAchievementDescriptions. + Dimensionality (type) of the texture (Read Only). - - + - See Social.LoadAchievements. + Filtering mode of the texture. - - + - See Social.LoadScores. + Height of the texture in pixels. (Read Only) - - - - + - See Social.LoadScores. + Mip map bias of the texture. - - - - + - See Social.LoadUsers. + Width of the texture in pixels. (Read Only) - - - + - See Social.ReportProgress. + Wrap mode (Repeat or Clamp) of the texture. - - - - + - See Social.ReportScore. + Retrieve a native (underlying graphics API) pointer to the texture resource. - - - + + Pointer to an underlying graphics API texture resource. + - + - See Social.ShowAchievementsUI. + Sets Anisotropic limits. + + - + - See Social.ShowLeaderboardUI. + Class for texture handling. - + - Represents generic user instances, like friends of the local user. + Get a small texture with all black pixels. - + - This users unique identifier. + The format of the pixel data in the texture (Read Only). - + - Avatar image of the user. + How many mipmap levels are in this texture (Read Only). - + - Is this user a friend of the current logged in user? + Get a small texture with all white pixels. - + - Presence state of the user. + 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. - + - This user's username or alias. + Compress texture into DXT format. + - + - The score range a leaderboard query should include. + 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? - + - The total amount of scores retreived. + Create a new empty texture. + + - + - The rank of the first score which is returned. + Create a new empty texture. + + + + - + - Constructor for a score range, the range starts from a specific value and contains a maxium score count. + See Also: SetPixel, SetPixels, Apply functions. - The minimum allowed value. - The number of possible values. + + + + + - + - The scope of time searched through when querying the leaderboard. + Encodes this texture into the EXR format. + Flags used to control compression and the output format. - + - The scope of the users searched through when querying the leaderboard. + Encodes this texture into JPG format. + JPG quality to encode with, 1..100 (default 75). - + - User presence state. + Encodes this texture into JPG format. + JPG quality to encode with, 1..100 (default 75). - + - The user is offline. + Encodes this texture into PNG format. - + - The user is online. + Flags used to control the encoding to an EXR file. - + - The user is online but away from his computer. + This texture will use Wavelet compression. This is best used for grainy images. - + - The user is only but set his status to busy. + The texture will use RLE (Run Length Encoding) EXR compression format (similar to Targa RLE compression). - + - The user is playing a game. + The texture will use the EXR ZIP compression format. - + - The limits defined by the CharacterJoint. + No flag. This will result in an uncompressed 16-bit float EXR file. - + - When the joint hits the limit, it can be made to bounce off it. + The texture will be exported as a 32-bit float EXR file (default is 16-bit). - + - Determines how far ahead in space the solver can "see" the joint limit. + 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. + - + - If spring is greater than zero, the limit is soft. + Returns pixel color at coordinates (x, y). + + - + - The limit position/angle of the joint (in degrees). + Returns filtered pixel color at normalized coordinates (u, v). + + - + - If greater than zero, the limit is soft. The spring will pull the joint back. + 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. + - + - The configuration of the spring attached to the joint's limits: linear and angular. Used by CharacterJoint and ConfigurableJoint. + 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. + - + - The damping of the spring limit. In effect when the stiffness of the sprint limit is not zero. + Get a block of pixel colors in Color32 format. + - + - The stiffness of the spring limit. When stiffness is zero the limit is hard, otherwise soft. + Get raw data from a texture. + + Raw texture data as a byte array. + - + - 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. + 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. + + Returns true if the data can be loaded, false otherwise. + - + - 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. + Fills texture pixels with raw preformatted data. + Byte array to initialize texture pixels with. + Size of data in bytes. - + - Returns all the layers defined in this project. + Fills texture pixels with raw preformatted data. + Byte array to initialize texture pixels with. + Size of data in bytes. - + - Returns the name of the layer as defined in the TagManager. + 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. + - + - This is the relative value that indicates the sort order of this layer relative to the other layers. + 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? - + - 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. + Resizes the texture. - 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. + Resizes the texture. - 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. + Sets pixel color at coordinates (x,y). - 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. + Set a block of pixel colors. - The unique id of a layer. - - True if the id provided is valid and assigned to a layer. - + The array of pixel colours to assign (a 2D image flattened to a 1D array). + The mip level of the texture to write to. - + - Returns the id given the name. Will return 0 if an invalid name was given. + Set a block of pixel colors. - The name of the layer. - - The unique id of the layer with name. - + + + + + + - + - The coordinate space in which to operate. + Set a block of pixel colors. + + - + - Applies transformation relative to the local coordinate system. + Set a block of pixel colors. + + + + + + - + - Applies transformation relative to the world coordinate system. + Updates Unity texture to use different native texture object. + Native 2D texture object. - + - Use this PropertyAttribute to add some spacing in the Inspector. + Class for handling 2D texture arrays. - + - The spacing in pixels. + Number of elements in a texture array (Read Only). - + - Use this DecoratorDrawer to add some spacing in the Inspector. + Texture format (Read Only). - The spacing in pixels. - + - Class for handling Sparse Textures. + 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. - + - Is the sparse texture actually created? (Read Only) + 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. - + - Get sparse texture tile height (Read Only). + 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. - + - Get sparse texture tile width (Read Only). + Returns pixel colors of a single array slice. + Array slice to read pixels from. + Mipmap level to read pixels from. + + Array of pixel colors. + - + - Create a sparse texture. + Returns pixel colors of a single array slice. - 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). + Array slice to read pixels from. + Mipmap level to read pixels from. + + Array of pixel colors in low precision (8 bits/channel) format. + - + - Create a sparse texture. + Set pixel colors for the whole mip level. - 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). + An array of pixel colors. + The texture array element index. + The mip level. - + - Unload sparse texture tile. + Set pixel colors for the whole mip level. - Tile X coordinate. - Tile Y coordinate. - Mipmap level of the texture. + An array of pixel colors. + The texture array element index. + The mip level. - + - Update sparse texture tile with color values. + Class for handling 3D Textures, Use this to create. - Tile X coordinate. - Tile Y coordinate. - Mipmap level of the texture. - Tile color data. - + - Update sparse texture tile with raw pixel values. + The depth of the texture (Read Only). - Tile X coordinate. - Tile Y coordinate. - Mipmap level of the texture. - Tile raw pixel data. - + - A sphere-shaped primitive collider. + The format of the pixel data in the texture (Read Only). - + - The center of the sphere in the object's local space. + 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. - + - The radius of the sphere measured in the object's local space. + 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? - + - A Splat prototype is just a texture that is used by the TerrainData. + Returns an array of pixel colors representing one mip level of the 3D texture. + - + - The metallic value of the splat layer. + Returns an array of pixel colors representing one mip level of the 3D texture. + - + - Normal map of the splat applied to the Terrain. + Sets pixel colors of a 3D texture. + The colors to set the pixels to. + The mipmap level to be affected by the new colors. - + - The smoothness value of the splat layer when the main texture has no alpha channel. + Sets pixel colors of a 3D texture. + The colors to set the pixels to. + The mipmap level to be affected by the new colors. - + - Texture of the splat applied to the Terrain. + Compression Quality. - + - Offset of the tile texture of the SplatPrototype. + Best compression. - + - Size of the tile used in the texture of the SplatPrototype. + Fast compression. - + - The spring joint ties together 2 rigid bodies, spring forces will be automatically applied to keep the object at the given distance. + Normal compression (default). - + - The damper force used to dampen the spring force. + Format used when creating textures from scripts. - + - The maximum distance between the bodies relative to their initial distance. + Alpha-only texture format. - + - The minimum distance between the bodies relative to their initial distance. + Color with alpha texture format, 8-bits per channel. - + - The spring force used to keep the two objects together. + A 16 bits/pixel texture format. Texture stores color with an alpha channel. - + - The maximum allowed error between the current spring length and the length defined by minDistance and maxDistance. + ASTC (10x10 pixel block in 128 bits) compressed RGB texture format. - + - Joint that attempts to keep two Rigidbody2D objects a set distance apart by applying a force between them. + ASTC (12x12 pixel block in 128 bits) compressed RGB texture format. - + - Should the distance be calculated automatically? + ASTC (4x4 pixel block in 128 bits) compressed RGB texture format. - + - The amount by which the spring force is reduced in proportion to the movement speed. + ASTC (5x5 pixel block in 128 bits) compressed RGB texture format. - + - The distance the spring will try to keep between the two objects. + ASTC (6x6 pixel block in 128 bits) compressed RGB texture format. - + - The frequency at which the spring oscillates around the distance distance between the objects. + ASTC (8x8 pixel block in 128 bits) compressed RGB texture format. - + - Represents a Sprite object for use in 2D gameplay. + ASTC (10x10 pixel block in 128 bits) compressed RGBA texture format. - + - 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. + ASTC (12x12 pixel block in 128 bits) compressed RGBA texture format. - + - Returns the border sizes of the sprite. + ASTC (4x4 pixel block in 128 bits) compressed RGBA texture format. - + - Bounds of the Sprite, specified by its center and extents in world space units. + ASTC (5x5 pixel block in 128 bits) compressed RGBA texture format. - + - Returns true if this Sprite is packed in an atlas. + ASTC (6x6 pixel block in 128 bits) compressed RGBA texture format. - + - If Sprite is packed (see Sprite.packed), returns its SpritePackingMode. + ASTC (8x8 pixel block in 128 bits) compressed RGBA texture format. - + - If Sprite is packed (see Sprite.packed), returns its SpritePackingRotation. + ATC (ATITC) 4 bits/pixel compressed RGB texture format. - + - Location of the Sprite's center point in the Rect on the original Texture, specified in pixels. + ATC (ATITC) 8 bits/pixel compressed RGB texture format. - + - The number of pixels in the sprite that correspond to one unit in world space. (Read Only) + Compressed one channel (R) texture format. - + - Location of the Sprite on the original Texture, specified in pixels. + Compressed two-channel (RG) texture format. - + - Get the reference to the used texture. If packed this will point to the atlas, if not packed will point to the source sprite. + HDR compressed color texture format. - + - Get the rectangle this sprite uses on its texture. Raises an exception if this sprite is tightly packed in an atlas. + High quality compressed color texture format. - + - 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. + Color with alpha texture format, 8-bits per channel. - + - Returns a copy of the array containing sprite mesh triangles. + Compressed color texture format. - + - The base texture coordinates of the sprite mesh. + Compressed color texture format with Crunch compression for small storage sizes. - + - Returns a copy of the array containing sprite mesh vertex positions. + Compressed color with alpha channel texture format. - + - Create a new Sprite object. + Compressed color with alpha channel texture format with Crunch compression for small storage sizes. - 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. - Scaling to map pixels in the image to world space units. - - - - - + - Sets up new Sprite geometry. + ETC2 EAC (GL ES 3.0) 4 bitspixel compressed unsigned single-channel texture format. - Array of vertex positions in Sprite Rect space. - Array of sprite mesh triangle indices. - + - How a Sprite's graphic rectangle is aligned with its pivot point. + ETC2 EAC (GL ES 3.0) 4 bitspixel compressed signed single-channel texture format. - + - Pivot is at the center of the bottom edge of the graphic rectangle. + ETC2 EAC (GL ES 3.0) 8 bitspixel compressed unsigned dual-channel (RG) texture format. - + - Pivot is at the bottom left corner of the graphic rectangle. + ETC2 EAC (GL ES 3.0) 8 bitspixel compressed signed dual-channel (RG) texture format. - + - Pivot is at the bottom right corner of the graphic rectangle. + ETC (GLES2.0) 4 bits/pixel compressed RGB texture format. - + - Pivot is at the center of the graphic rectangle. + ETC 4 bits/pixel compressed RGB texture format. - + - Pivot is at a custom position within the graphic rectangle. + ETC 4 bitspixel RGB + 4 bitspixel Alpha compressed texture format. - + - Pivot is at the center of the left edge of the graphic rectangle. + ETC2 (GL ES 3.0) 4 bits/pixel compressed RGB texture format. - + - Pivot is at the center of the right edge of the graphic rectangle. + ETC2 (GL ES 3.0) 4 bits/pixel RGB+1-bit alpha texture format. - + - Pivot is at the center of the top edge of the graphic rectangle. + ETC2 (GL ES 3.0) 8 bits/pixel compressed RGBA texture format. - + - Pivot is at the top left corner of the graphic rectangle. + PowerVR (iOS) 2 bits/pixel compressed color texture format. - + - Pivot is at the top right corner of the graphic rectangle. + PowerVR (iOS) 4 bits/pixel compressed color texture format. - + - Defines the type of mesh generated for a sprite. + PowerVR (iOS) 2 bits/pixel compressed with alpha channel texture format. - + - Rectangle mesh equal to the user specified sprite size. + PowerVR (iOS) 4 bits/pixel compressed with alpha channel texture format. - + - Tight mesh based on pixel alpha values. As many excess pixels are cropped as possible. + A 16 bit color texture format that only has a red channel. - + - Sprite packing modes for the Sprite Packer. + Scalar (R) texture format, 32 bit floating point. - + - Alpha-cropped ractangle packing. + Color texture format, 8-bits per channel. - + - Tight mesh based packing. + A 16 bit color texture format. - + - Sprite rotation modes for the Sprite Packer. + RGB HDR format, with 9 bit mantissa per channel and a 5 bit shared exponent. - + - Any rotation. + Color with alpha texture format, 8-bits per channel. - + - No rotation. + Color and alpha texture format, 4 bit per channel. - + - Renders a Sprite for 2D graphics. + RGB color and alpha texture format, 32-bit floats per channel. - + - Rendering color for the Sprite graphic. + RGB color and alpha texture format, 16 bit floating point per channel. - + - Flips the sprite on the X axis. + Two color (RG) texture format, 32 bit floating point per channel. - + - Flips the sprite on the Y axis. + Two color (RG) texture format, 16 bit floating point per channel. - + - The Sprite to render. + Scalar (R) texture format, 16 bit floating point. - + - Helper utilities for accessing Sprite data. + A format that uses the YUV color space and is often used for video encoding or playback. - + - Inner UV's of the Sprite. + Wrap mode for textures. - - + - Minimum width and height of the Sprite. + Clamps the texture to the last pixel at the border. - - + - Outer UV's of the Sprite. + Tiles the texture, creating a repeating pattern. - - + - Return the padding on the sprite. + Priority of a thread. - - + - Stack trace logging options. + Below normal thread priority. - + - Native and managed stack trace will be logged. + Highest thread priority. - + - No stack trace will be outputed to log. + Lowest thread priority. - + - Only managed stack trace will be outputed. + Normal thread priority. - + - 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. + The interface to get time information from Unity. - + - Called on the first Update frame when a statemachine evaluate this state. + Slows game playback time to allow screenshots to be saved between frames. - + - Called on the last update frame when a statemachine evaluate this state. + The time in seconds it took to complete the last frame (Read Only). - + - Called right after MonoBehaviour.OnAnimatorIK. + The interval in seconds at which physics and other fixed frame rate updates (like MonoBehaviour's MonoBehaviour.FixedUpdate) are performed. - + - Called on the first Update frame when making a transition to a StateMachine. This is not called when making a transition into a StateMachine sub-state. + The time the latest MonoBehaviour.FixedUpdate has started (Read Only). This is the time in seconds since the start of the game. - 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 timeScale-independent interval in seconds from the last fixed frame to the current one (Read Only). - The Animator playing this state machine. - The full path hash for this state machine. - + - Called right after MonoBehaviour.OnAnimatorMove. + The timeScale-independent time the latest MonoBehaviour.FixedUpdate has started (Read Only). This is the time in seconds since the start of the game. - + - Called at each Update frame except for the first and last frame. + The total number of frames that have passed (Read Only). - + - StaticBatchingUtility can prepare your objects to take advantage of Unity's static batching. + Returns true if called inside a fixed time step callback (like MonoBehaviour's MonoBehaviour.FixedUpdate), otherwise returns false. - + - Combine will prepare all children of the staticBatchRoot for static batching. + The maximum time a frame can take. Physics and other fixed frame rate updates (like MonoBehaviour's MonoBehaviour.FixedUpdate). - - + - Combine will prepare all gos for the static batching. staticBatchRoot will be treated as their parent. + 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. - - - + - Applies tangent forces along the surfaces of colliders. + The real time in seconds since the game started (Read Only). - + - The scale of the impulse force applied while attempting to reach the surface speed. + A smoothed out Time.deltaTime (Read Only). - + - The speed to be maintained along the surface. + The time at the beginning of this frame (Read Only). This is the time in seconds since the start of the game. - + - The speed variation (from zero to the variation) added to base speed to be applied. + The scale at which the time is passing. This can be used for slow motion effects. - + - Should bounce be used for any contact with the surface? + The time this frame has started (Read Only). This is the time in seconds since the last level has been loaded. - + - Should the impulse force but applied to the contact point? + The timeScale-independent interval in seconds from the last frame to the current one (Read Only). - + - Should friction be used for any contact with the surface? + The timeScale-independent time for this frame (Read Only). This is the time in seconds since the start of the game. - + - Access system and hardware information. + Interface into Tizen specific functionality. - + - The model of the device (Read Only). + Get pointer to the Tizen EvasGL object.. - + - The user defined name of the device (Read Only). + Get pointer to the native window handle. - + - Returns the kind of device the application is running on (Read Only). + Enumerator list of different activity indicators your game can show when loading. - + - A unique device identifier. It is guaranteed to be unique for every device (Read Only). + Sets your game not to show any indicator while loading. - + - The identifier code of the graphics device (Read Only). + The loading indicator size is large and rotates counterclockwise (progress_large and inverted). - + - The name of the graphics device (Read Only). + The loading indicator size is small and rotates counterclockwise (process_small and inverted). - + - The graphics API type used by the graphics device (Read Only). + The loading indicator size is large and rotates clockwise (progress_large). - + - The vendor of the graphics device (Read Only). + The loading indicator size is small and rotates clockwise (process_small). - + - The identifier code of the graphics device vendor (Read Only). + Specify a tooltip for a field in the Inspector window. - + - The graphics API type and driver version used by the graphics device (Read Only). + The tooltip text. - + - Amount of video memory present (Read Only). + Specify a tooltip for a field. + The tooltip text. - + - Is graphics device using multi-threaded rendering (Read Only)? + Structure describing the status of a finger touching the screen. - + - Graphics device shader capability level (Read Only). + Value of 0 radians indicates that the stylus is parallel to the surface, pi/2 indicates that it is perpendicular. - + - Maximum texture size (Read Only). + Value of 0 radians indicates that the stylus is pointed along the x-axis of the device. - + - What NPOT (non-power of two size) texture support does the GPU provide? (Read Only) + The position delta since last change. - + - Operating system name with version (Read Only). + Amount of time that has passed since the last recorded change in Touch values. - + - Number of processors present (Read Only). + The unique index for the touch. - + - Processor frequency in MHz (Read Only). + The maximum possible pressure value for a platform. If Input.touchPressureSupported returns false, the value of this property will always be 1.0f. - + - Processor name (Read Only). + Describes the phase of the touch. - + - How many simultaneous render targets (MRTs) are supported? (Read Only) + The position of the touch in pixel coordinates. - + - Are 3D (volume) textures supported? (Read Only) + 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. - + - Is an accelerometer available on the device? + 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. - + - Are compute shaders supported? (Read Only) + The amount that the radius varies by for a touch. - + - Is a gyroscope available on the device? + The raw position used for the touch. - + - Are image effects supported? (Read Only) + Number of taps. - + - Is GPU draw call instancing supported? (Read Only) + A value that indicates whether a touch was of Direct, Indirect (or remote), or Stylus type. - + - Is the device capable of reporting its location? + Describes phase of a finger touch. - + - Is sampling raw depth from shadowmaps supported? (Read Only) + A finger touched the screen. - + - Are render textures supported? (Read Only) + The system cancelled tracking for the touch. - + - Are cubemap render textures supported? (Read Only) + A finger was lifted from the screen. This is the final phase of a touch. - + - Are built-in shadows supported? (Read Only) + A finger moved on the screen. - + - Are sparse textures supported? (Read Only) + A finger is touching the screen but hasn't moved. - + - Is the stencil buffer supported? (Read Only) + Interface into the native iPhone, Android, Windows Phone and Windows Store Apps on-screen keyboards - it is not available on other platforms. - + - Is the device capable of providing the user haptic feedback by vibration? + Is the keyboard visible or sliding into the position on the screen? - + - Amount of system memory present (Read Only). + Returns portion of the screen which is covered by the keyboard. - + - Is render texture format supported? + Specifies whether the TouchScreenKeyboard supports the selection property. (Read Only) - The format to look up. - - True if the format is supported. - - + - Is texture format supported on this device? + Specifies if input process was finished. (Read Only) - 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. + Will text input field above the keyboard be hidden when the keyboard is on screen? - + - Afrikaans. + Is touch screen keyboard supported. - + - Arabic. + Returns the character range of the selected text within the string currently being edited. (Read Only) - + - Basque. + Specified on which display the software keyboard will appear. - + - Belarusian. + Returns the text displayed by the input field of the keyboard. - + - Bulgarian. + Returns true whenever any keyboard is completely visible on the screen. - + - Catalan. + Specifies if input process was canceled. (Read Only) - + - Chinese. + 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. - + - ChineseSimplified. + 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. - + - ChineseTraditional. + 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. - + - Czech. + 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. - + - Danish. + 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. - + - Dutch. + 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. - + - English. + 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. - + - Estonian. + Describes the type of keyboard. - + - Faroese. + Keyboard displays standard ASCII characters. - + - Finnish. + Default keyboard for the current input method. - + - French. + Keyboard optimized for specifying email addresses. - + - German. + Keypad designed for entering a person's name or phone number. - + - Greek. + Keyboard designed for Nintendo Network Accounts (available on Wii U only). - + - Hebrew. + Numeric keypad designed for PIN entry. - + - Hungarian. + Keyboard with numbers and punctuation. - + - Icelandic. + Keypad designed for entering telephone numbers. - + - Indonesian. + Keyboard optimized for URL entry. - + - Italian. + Describes whether a touch is direct, indirect (or remote), or from a stylus. - + - Japanese. + A direct touch on a device. - + - Korean. + An Indirect, or remote, touch on a device. - + - Latvian. + A touch from a stylus on a device. - + - Lithuanian. + The trail renderer is used to make trails behind objects in the scene as they move about. - + - Norwegian. + Select whether the trail will face the camera, or the orientation of the Transform Component. - + - Polish. + Does the GameObject of this trail renderer auto destructs? - + - Portuguese. + Set the color gradient describing the color of the trail at various points along its length. - + - Romanian. + Set the color at the end of the trail. - + - Russian. + The width of the trail at the end of the trail. - + - Serbo-Croatian. + Set the minimum distance the trail can travel before a new vertex is added to it. - + - Slovak. + Set this to a value greater than 0, to get rounded corners on each end of the trail. - + - Slovenian. + Set this to a value greater than 0, to get rounded corners between each segment of the trail. - + - Spanish. + Get the number of line segments in the trail. - + - Swedish. + Get the number of line segments in the trail. - + - Thai. + Set the color at the start of the trail. - + - Turkish. + The width of the trail at the spawning point. - + - Ukrainian. + Choose whether the U coordinate of the trail texture is tiled or stretched. - + - Unknown. + How long does the trail take to fade out. - + - Vietnamese. + Set the curve describing the width of the trail at various points along its length. - + - The joint attempts to move a Rigidbody2D to a specific target position. + Set an overall multiplier that is applied to the TrailRenderer.widthCurve to get the final width of the trail. - + - The local-space anchor on the rigid-body the joint is attached to. + Removes all points from the TrailRenderer. +Useful for restarting a trail from a new position. - + - Should the target be calculated automatically? + 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. + - + - The amount by which the target spring force is reduced in proportion to the movement speed. + 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. + - + - The frequency at which the target spring oscillates around the target position. + Position, rotation and scale of an object. - + - The maximum force that can be generated when trying to maintain the target joint constraint. + The number of children the Transform has. - + - The world-space position that the joint will attempt to move the body to. + The rotation as Euler angles in degrees. - + - The Terrain component renders the terrain. + The blue axis of the transform in world space. - + - The active terrain. This is a convenience function to get to the main terrain in the scene. + Has the transform changed since the last time the flag was set to 'false'? - + - The active terrains in the scene. + The transform capacity of the transform's hierarchy data structure. - + - Specifies if an array of internal light probes should be baked for terrain trees. Available only in editor. + The number of transforms in the transform's hierarchy data structure. - + - Heightmap patches beyond basemap distance will use a precomputed low res basemap. + The rotation as Euler angles in degrees relative to the parent transform's rotation. - + - Should terrain cast shadows?. + Position of the transform relative to the parent transform. - + - Collect Detail patches from memory. + The rotation of the transform relative to the parent transform's rotation. - + - Density of detail objects. + The scale of the transform relative to the parent. - + - Detail objects will be displayed up to this distance. + Matrix that transforms a point from local space into world space (Read Only). - + - Specify if terrain heightmap should be drawn. + The global scale of the object (Read Only). - + - Specify if terrain trees and details should be drawn. + The parent of the transform. - + - Lets you essentially lower the heightmap resolution used for rendering. + The position of the transform in world space. - + - An approximation of how many pixels the terrain will pop in the worst case when switching lod. + The red axis of the transform in world space. - + - The shininess value of the terrain. + Returns the topmost transform in the hierarchy. - + - The specular color of the terrain. + The rotation of the transform in world space stored as a Quaternion. - + - The index of the baked lightmap applied to this terrain. + The green axis of the transform in world space. - + - The UV scale & offset used for a baked lightmap. + Matrix that transforms a point from world space into local space (Read Only). - + - The custom material used to render the terrain. + Unparents all children. - + - The type of the material used to render the terrain. Could be one of the built-in types or custom. See Terrain.MaterialType. + Finds a child by name and returns it. + Name of child to be found. - + - The index of the realtime lightmap applied to this terrain. + Returns a transform child by index. + Index of the child transform to return. Must be smaller than Transform.childCount. + + Transform child by index. + - + - The UV scale & offset used for a realtime lightmap. + Gets the sibling index. - + - How reflection probes are used for terrain. See Rendering.ReflectionProbeUsage. + Transforms a direction from world space to local space. The opposite of Transform.TransformDirection. + - + - The Terrain Data that stores heightmaps, terrain textures, detail meshes and trees. + Transforms the direction x, y, z from world space to local space. The opposite of Transform.TransformDirection. + + + - + - Distance from the camera where trees will be rendered as billboards only. + Transforms position from world space to local space. + - + - Total distance delta that trees will use to transition from billboard orientation to mesh orientation. + Transforms the position x, y, z from world space to local space. The opposite of Transform.TransformPoint. + + + - + - The maximum distance at which trees are rendered. + Transforms a vector from world space to local space. The opposite of Transform.TransformVector. + - + - Maximum number of trees rendered at full LOD. + Transforms the vector x, y, z from world space to local space. The opposite of Transform.TransformVector. + + + - + - Adds a tree instance to the terrain. + Is this transform a child of parent? - + - + - Update the terrain's LOD and vegetation information after making changes with TerrainData.SetHeightsDelayLOD. + Rotates the transform so the forward vector points at target's current position. + Object to point towards. + Vector specifying the upward direction. - + - Creates a Terrain including collider from TerrainData. + Rotates the transform so the forward vector points at target's current position. - + Object to point towards. + Vector specifying the upward direction. - + - Flushes any change done in the terrain so it takes effect. + Rotates the transform so the forward vector points at worldPosition. + Point to look at. + Vector specifying the upward direction. - + - 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. + Rotates the transform so the forward vector points at worldPosition. - [in / out] A list to hold the returned reflection probes and their weights. See ReflectionProbeBlendInfo. + Point to look at. + Vector specifying the upward direction. - + - Get the position of the terrain. + 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). + Rotation to apply. + Rotation is local to object or World. - + - The type of the material used to render a terrain object. Could be one of the built-in types or custom. + 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). + Degrees to rotate around the X axis. + Degrees to rotate around the Y axis. + Degrees to rotate around the Z axis. + Rotation is local to object or World. - + - A built-in material that uses the legacy Lambert (diffuse) lighting model and has optional normal map support. + Rotates the object around axis by angle degrees. + Axis to apply rotation to. + Degrees to rotation to apply. + Rotation is local to object or World. - + - A built-in material that uses the legacy BlinnPhong (specular) lighting model and has optional normal map support. + Rotates the transform about axis passing through point in world coordinates by angle degrees. + + + - + - 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. + Move the transform to the start of the local transform list. - + - Samples the height at the given position defined in world space, relative to the terrain space. + Move the transform to the end of the local transform list. - - + - Lets you setup the connection between neighboring Terrains. + 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. - + - A heightmap based collider. + 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. - + - The terrain that stores the heightmap. + Sets the world space position and rotation of the Transform component. + + - + - The TerrainData class stores heightmaps, detail mesh positions, tree instances, and terrain texture alpha maps. + Sets the sibling index. + Index to set. - + - Height of the alpha map. + Transforms direction from local space to world space. + - + - Number of alpha map layers. + Transforms direction x, y, z from local space to world space. + + + - + - Resolution of the alpha map. + Transforms position from local space to world space. + - + - Alpha map textures used by the Terrain. Used by Terrain Inspector for undo. + Transforms the position x, y, z from local space to world space. + + + - + - Width of the alpha map. + Transforms vector from local space to world space. + - + - Resolution of the base map used for rendering far patches on the terrain. + Transforms vector x, y, z from local space to world space. + + + - + - Detail height of the TerrainData. + Moves the transform in the direction and distance of translation. + + - + - Contains the detail texture/meshes that the terrain has. + Moves the transform in the direction and distance of translation. + + - + - Detail Resolution of the TerrainData. + Moves the transform by x along the x axis, y along the y axis, and z along the z axis. + + + + - + - Detail width of the TerrainData. + Moves the transform by x along the x axis, y along the y axis, and z along the z axis. + + + + - + - Height of the terrain in samples (Read Only). + Moves the transform in the direction and distance of translation. + + - + - Resolution of the heightmap. + Moves the transform by x along the x axis, y along the y axis, and z along the z axis. + + + + - + - The size of each heightmap sample. + Transparent object sorting mode of a Camera. - + - Width of the terrain in samples (Read Only). + Sort objects based on distance along a custom axis. - + - The total size in world units of the terrain. + Default transparency sorting mode. - + - Splat texture used by the terrain. + Orthographic transparency sorting mode. - + - The thickness of the terrain used for collision detection. + Perspective transparency sorting mode. - + - Returns the number of tree instances. + Tree Component for the tree creator. - + - Contains the current trees placed in the terrain. + Data asociated to the Tree. - + - The list of tree prototypes this are the ones available in the inspector. + Tells if there is wind data exported from SpeedTree are saved on this component. - + - Amount of waving grass in the terrain. + Contains information about a tree placed in the Terrain game object. - + - Speed of the waving grass. + Color of this instance. - + - Strength of the waving grass in the terrain. + Height scale of this instance (compared to the prototype's size). - + - Color of the waving grass that the terrain has. + Lightmap color calculated for this instance. - + - Returns the alpha map at a position x, y given a width and height. + Position of the tree. - - - - - + - Returns a 2D array of the detail object density in the specific location. + Index of this instance in the TerrainData.treePrototypes array. - - - - - - + - Gets the height at a certain point x,y. + Read-only. + +Rotation of the tree on X-Z plane (in radians). - - - + - Get an array of heightmap samples. + Width scale of this instance (compared to the prototype's size). - 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. + Simple class that contains a pointer to a tree prototype. - - - + - Get an interpolated normal at a given location. + Bend factor of the tree prototype. - - - + - Gets the gradient of the terrain at point &amp;amp;amp;lt;x,y&amp;amp;amp;gt;. + Retrieves the actual GameObect used by the tree. - - - + - Returns an array of all supported detail layer indices in the area. + Class that specifies some information about a renderable character. - - - - - + - 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. + Character width. - The index of the tree instance. - + - Reloads all the values of the available prototypes (ie, detail mesh assets) in the TerrainData Object. + Position of the character cursor in local (text generated) space. - + - Assign all splat values in the given map area. + Information about a generated line of text. - - - - + - Sets the detail layer density map. + Height of the line. - - - - - + - Set the resolution of the detail map. + Space in pixels between this line and the next line. - 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. + Index of the first character in the line. - 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. + 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. - 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. + Vertex class used by a Canvas for managing vertices. - The index of the tree instance. - The new TreeInstance value. - + - Enum provding terrain rendering options. + Vertex color. - + - Render all options. + Normal. - + - Render terrain details. + Vertex position. - + - Render heightmap. + Simple UIVertex with sensible settings for use in the UI system. - + - Render trees. + Tangent. - + - How multiline text should be aligned. + The first texture coordinate set of the mesh. Used by UI elements by default. - + - Text lines are centered. + The second texture coordinate set of the mesh, if present. - + - Text lines are aligned on the left side. + The Third texture coordinate set of the mesh, if present. - + - Text lines are aligned on the right side. + The forth texture coordinate set of the mesh, if present. - + - Where the anchor of the text is placed. + 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. - + - Text is anchored in lower side, centered horizontally. + Version of Unity API. - + - Text is anchored in lower left corner. + Initializes a new instance of UnityAPICompatibilityVersionAttribute. + Unity version that this assembly with compatible with. - + - Text is anchored in lower right corner. + Constants to pass to Application.RequestUserAuthorization. - + - Text is centered both horizontally and vertically. + Request permission to use any audio input sources attached to the computer. - + - Text is anchored in left side, centered vertically. + Request permission to use any video input sources attached to the computer. - + - Text is anchored in right side, centered vertically. + Representation of 2D vectors and points. - + - Text is anchored in upper side, centered horizontally. + Shorthand for writing Vector2(0, -1). - + - Text is anchored in upper left corner. + Shorthand for writing Vector2(-1, 0). - + - Text is anchored in upper right corner. + Returns the length of this vector (Read Only). - + - Attribute to make a string be edited with a height-flexible and scrollable text area. + Returns this vector with a magnitude of 1 (Read Only). - + - The maximum amount of lines the text area can show before it starts using a scrollbar. + Shorthand for writing Vector2(1, 1). - + - The minimum amount of lines the text area will use. + Shorthand for writing Vector2(1, 0). - + - Attribute to make a string be edited with a height-flexible and scrollable text area. + Returns the squared length of this vector (Read Only). - 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. + Shorthand for writing Vector2(0, 1). - 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. + X component of the vector. - + - The raw bytes of the text asset. (Read Only) + Y component of the vector. - + - The text contents of the .txt file as a string. (Read Only) + Shorthand for writing Vector2(0, 0). - + - Different methods for how the GUI system handles text being too large to fit the rectangle allocated. + Returns the angle in degrees between from and to. + + - + - Text gets clipped to be inside the element. + Returns a copy of vector with its magnitude clamped to maxLength. + + - + - Text flows freely outside the element. + Constructs a new vector with given x, y components. + + - + - A struct that stores the settings for TextGeneration. + Returns the distance between a and b. + + - + - Use the extents of glyph geometry to perform horizontal alignment rather than glyph metrics. + Dot Product of two vectors. + + - + - The base color for the text generation. + Returns true if the given vector is exactly equal to this vector. + - + - Font to use for generation. + Converts a Vector3 to a Vector2. + - + - Font size. + Converts a Vector2 to a Vector3. + - + - Font style. + Linearly interpolates between vectors a and b by t. + + + - + - Continue to generate characters even if the text runs out of bounds. + Linearly interpolates between vectors a and b by t. + + + - + - Extents that the generator will attempt to fit the text in. + Returns a vector that is made from the largest components of two vectors. + + - + - What happens to text when it reaches the horizontal generation bounds. + Returns a vector that is made from the smallest components of two vectors. + + - + - The line spacing multiplier. + Moves a point current towards target. + + + - + - Generated vertices are offset by the pivot. + Makes this vector have a magnitude of 1. - + - Should the text be resized to fit the configured bounds? + Divides a vector by a number. + + - + - Maximum size for resized text. + Returns true if two vectors are approximately equal. + + - + - Minimum size for resized text. + Subtracts one vector from another. + + - + - Allow rich text markup in generation. + Negates a vector. + - + - A scale factor for the text. This is useful if the Text is on a Canvas and the canvas is scaled. + Multiplies a vector by a number. + + - + - How is the generated text anchored. + Multiplies a vector by a number. + + - + - Should the text generator update the bounds from the generated text. + Adds two vectors. + + - + - What happens to text when it reaches the bottom generation bounds. + Reflects a vector off the vector defined by a normal. + + - + - Class that can be used to generate text for rendering. + Multiplies two vectors component-wise. + + - + - The number of characters that have been generated. + Multiplies every component of this vector by the same component of scale. + - + - The number of characters that have been generated and are included in the visible lines. + Set x and y components of an existing Vector2. + + - + - Array of generated characters. + 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. - + - The size of the font that was found if using best fit mode. + 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. - + - Number of text lines generated. + 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. - + - Information about each generated text line. + Access the x or y component using [0] or [1] respectively. - + - Extents of the generated text in rect format. + Returns a nicely formatted string for this vector. + - + - Number of vertices generated. + Returns a nicely formatted string for this vector. + - + - Array of generated vertices. + Representation of 3D vectors and points. - + - Create a TextGenerator. + Shorthand for writing Vector3(0, 0, -1). - - + - Create a TextGenerator. + Shorthand for writing Vector3(0, -1, 0). - - + - Populate the given List with UICharInfo. + Shorthand for writing Vector3(0, 0, 1). - List to populate. - + - Returns the current UICharInfo. + Shorthand for writing Vector3(-1, 0, 0). - - Character information. - - + - Populate the given list with UILineInfo. + Returns the length of this vector (Read Only). - List to populate. - + - Returns the current UILineInfo. + Returns this vector with a magnitude of 1 (Read Only). - - Line information. - - + - Given a string and settings, returns the preferred height for a container that would hold this text. + Shorthand for writing Vector3(1, 1, 1). - Generation text. - Settings for generation. - - Preferred height. - - + - Given a string and settings, returns the preferred width for a container that would hold this text. + Shorthand for writing Vector3(1, 0, 0). - Generation text. - Settings for generation. - - Preferred width. - - + - Populate the given list with generated Vertices. + Returns the squared length of this vector (Read Only). - List to populate. - + - Returns the current UILineInfo. + Shorthand for writing Vector3(0, 1, 0). - - Vertices. - - + - Mark the text generator as invalid. This will force a full text generation the next time Populate is called. + X component of the vector. - + - Will generate the vertices and other data for the given string with the given settings. + Y component of the vector. - String to generate. - Settings. - + - A script interface for the. + Z component of the vector. - + - How lines of text are aligned (Left, Right, Center). + Shorthand for writing Vector3(0, 0, 0). - + - Which point of the text shares the position of the Transform. + Returns the angle in degrees between from and to. + The angle extends round from this vector. + The angle extends round to this vector. - + - The size of each character (This scales the whole text). + Returns a copy of vector with its magnitude clamped to maxLength. + + - + - The color used to render the text. + Cross Product of two vectors. + + - + - The Font used. + Creates a new vector with given x, y, z components. + + + - + - The font size to use (for dynamic fonts). + Creates a new vector with given x, y components and sets z to zero. + + - + - The font style to use (for dynamic fonts). + Returns the distance between a and b. + + - + - How much space will be in-between lines of text. + Dot Product of two vectors. + + - + - How far should the text be offset from the transform.position.z when drawing. + Returns true if the given vector is exactly equal to this vector. + - + - Enable HTML-style tags for Text Formatting Markup. + Linearly interpolates between two vectors. + + + - + - How much space will be inserted for a tab '\t' character. This is a multiplum of the 'spacebar' character offset. + Linearly interpolates between two vectors. + + + - + - The text that is displayed. + Returns a vector that is made from the largest components of two vectors. + + - + - Base class for texture handling. Contains functionality that is common to both Texture2D and RenderTexture classes. + Returns a vector that is made from the smallest components of two vectors. + + - + - Anisotropic filtering level of the texture. + Moves a point current in a straight line towards a target point. + + + - + - Filtering mode of the texture. + + - + - Height of the texture in pixels. (Read Only) + Makes this vector have a magnitude of 1. - + - Mip map bias of the texture. + Divides a vector by a number. + + - + - Width of the texture in pixels. (Read Only) + Returns true if two vectors are approximately equal. + + - + - Wrap mode (Repeat or Clamp) of the texture. + Subtracts one vector from another. + + - + - Retrieve native ('hardware') pointer to a texture. + Negates a vector. + - + - Sets Anisotropic limits. + Multiplies a vector by a number. - - + + - + - Class for texture handling. + Multiplies a vector by a number. + + - + - Get a small texture with all black pixels. + Adds two vectors. + + - + - The format of the pixel data in the texture (Read Only). + Makes vectors normalized and orthogonal to each other. + + - + - How many mipmap levels are in this texture (Read Only). + Makes vectors normalized and orthogonal to each other. + + + - + - Get a small texture with all white pixels. + Projects a vector onto another vector. + + - + - Actually apply all previous SetPixel and SetPixels changes. + Projects a vector onto a plane defined by a normal orthogonal to the plane. - - + + - + - Compress texture into DXT format. + Reflects a vector off the plane defined by a normal. - + + - + - Creates Unity Texture out of externally created native texture object. + Rotates a vector current towards target. - 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. + Multiplies two vectors component-wise. - - + + - + - Create a new empty texture. + Multiplies every component of this vector by the same component of scale. - - - - + - + - See Also: SetPixel, SetPixels, Apply functions. + Set x, y and z components of an existing Vector3. - - - - - + + + - + - Encodes this texture into JPG format. + Spherically interpolates between two vectors. - JPG quality to encode with, 1..100 (default 75). + + + - + - Encodes this texture into JPG format. + Spherically interpolates between two vectors. - JPG quality to encode with, 1..100 (default 75). + + + - + - Encodes this texture into PNG format. + 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. - + - Returns pixel color at coordinates (x, y). + 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. - + - Returns filtered pixel color at normalized coordinates (u, v). + 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. - + - Get a block of pixel colors. + Access the x, y, z components using [0], [1], [2] respectively. - - + - Get a block of pixel colors. + Returns a nicely formatted string for this vector. - - - - - + - + - Get a block of pixel colors in Color32 format. + Returns a nicely formatted string for this vector. - + - + - Get raw data from a texture. + Representation of four-dimensional vectors. - - Raw texture data as a byte array. - - + - Loads PNG/JPG image byte array into a texture. + Returns the length of this vector (Read Only). - The byte array containing the image data to load. - Set to false by default, pass true to optionally mark the texture as non-readable. - - Returns true if the data can be loaded, false otherwise. - - + - Fills texture pixels with raw preformatted data. + Returns this vector with a magnitude of 1 (Read Only). - Byte array to initialize texture pixels with. - Size of data in bytes. - + - Fills texture pixels with raw preformatted data. + Shorthand for writing Vector4(1,1,1,1). - Byte array to initialize texture pixels with. - Size of data in bytes. - + - Packs multiple Textures into a texture atlas. + Returns the squared length of this vector (Read Only). - 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. + W component of the vector. - 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. + X component of the vector. - - - - - + - Resizes the texture. + Y component of the vector. - - - + - Sets pixel color at coordinates (x,y). + Z component of the vector. - - - - + - Set a block of pixel colors. + Shorthand for writing Vector4(0,0,0,0). - - - + - Set a block of pixel colors. + Creates a new vector with given x, y, z, w components. - - - - - - - - Set a block of pixel colors. - - - + + - + - Set a block of pixel colors. + Creates a new vector with given x, y, z components and sets w to zero. - - - - + - + - Updates Unity texture to use different native texture object. + Creates a new vector with given x, y components and sets z and w to zero. - Native 2D texture object. + + - + - Class for handling 3D Textures, Use this to create. + Returns the distance between a and b. + + - + - The depth of the texture (Read Only). + Dot Product of two vectors. + + - + - The format of the pixel data in the texture (Read Only). + Returns true if the given vector is exactly equal to this vector. + - + - Actually apply all previous SetPixels changes. + Converts a Vector4 to a Vector2. - + - + - Create a new empty 3D Texture. + Converts a Vector4 to a Vector3. - 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. + Converts a Vector2 to a Vector4. - + - + - Returns an array of pixel colors representing one mip level of the 3D texture. + Converts a Vector3 to a Vector4. - + - + - Sets pixel colors of a 3D texture. + Linearly interpolates between two vectors. - The colors to set the pixels to. - The mipmap level to be affected by the new colors. + + + - + - Sets pixel colors of a 3D texture. + Linearly interpolates between two vectors. - The colors to set the pixels to. - The mipmap level to be affected by the new colors. + + + - + - Compression Quality. + Returns a vector that is made from the largest components of two vectors. + + - + - Best compression. + Returns a vector that is made from the smallest components of two vectors. + + - + - Fast compression. + Moves a point current towards target. + + + - + - Normal compression (default). + + - + - Format used when creating textures from scripts. + Makes this vector have a magnitude of 1. - + - Alpha-only texture format. + Divides a vector by a number. + + - + - Color with an alpha channel texture format. + Returns true if two vectors are approximately equal. + + - + - A 16 bits/pixel texture format. Texture stores color with an alpha channel. + Subtracts one vector from another. + + - + - ASTC (10x10 pixel block in 128 bits) compressed RGB texture format. + Negates a vector. + - + - ASTC (12x12 pixel block in 128 bits) compressed RGB texture format. + Multiplies a vector by a number. + + - + - ASTC (4x4 pixel block in 128 bits) compressed RGB texture format. + Multiplies a vector by a number. + + - + - ASTC (5x5 pixel block in 128 bits) compressed RGB texture format. + Adds two vectors. + + - + - ASTC (6x6 pixel block in 128 bits) compressed RGB texture format. + Projects a vector onto another vector. + + - + - ASTC (8x8 pixel block in 128 bits) compressed RGB texture format. + Multiplies two vectors component-wise. + + - + - ASTC (10x10 pixel block in 128 bits) compressed RGBA texture format. + Multiplies every component of this vector by the same component of scale. + - + - ASTC (12x12 pixel block in 128 bits) compressed RGBA texture format. + Set x, y, z and w components of an existing Vector4. + + + + - + - ASTC (4x4 pixel block in 128 bits) compressed RGBA texture format. + Access the x, y, z, w components using [0], [1], [2], [3] respectively. - + - ASTC (5x5 pixel block in 128 bits) compressed RGBA texture format. + Returns a nicely formatted string for this vector. + - + - ASTC (6x6 pixel block in 128 bits) compressed RGBA texture format. + Returns a nicely formatted string for this vector. + - + - ASTC (8x8 pixel block in 128 bits) compressed RGBA texture format. + Wrapping modes for text that reaches the vertical boundary. - + - ATC (ATITC) 4 bits/pixel compressed RGB texture format. + Text well continue to generate when reaching vertical boundary. - + - ATC (ATITC) 8 bits/pixel compressed RGB texture format. + Text will be clipped when reaching the vertical boundary. - + - Format returned by iPhone camera. + Methods used to fit a video in the target area. - + - Compressed color texture format. + Resize proportionally so that width fits the target area, cropping or adding black bars above and below if needed. - + - Compressed color texture format with crunch compression for small storage sizes. + Resize proportionally so that content fits the target area, adding black bars if needed. - + - Compressed color with alpha channel texture format. + Resize proportionally so that content fits the target area, cropping if needed. - + - Compressed color with alpha channel texture format with crunch compression for small storage sizes. + Resize proportionally so that height fits the target area, cropping or adding black bars on each side if needed. - + - ETC2 EAC (GL ES 3.0) 4 bitspixel compressed unsigned single-channel texture format. + Preserve the pixel size without adjusting for target area. - + - ETC2 EAC (GL ES 3.0) 4 bitspixel compressed signed single-channel texture format. + Resize non-proportionally to fit the target area. - + - ETC2 EAC (GL ES 3.0) 8 bitspixel compressed unsigned dual-channel (RG) texture format. + Places where the audio embedded in a video can be sent. - + - ETC2 EAC (GL ES 3.0) 8 bitspixel compressed signed dual-channel (RG) texture format. + Send the embedded audio into a specified AudioSource. - + - ETC (GLES2.0) 4 bits/pixel compressed RGB texture format. + Send the embedded audio direct to the platform's audio hardware. - + - ETC (Nintendo 3DS) 4 bits/pixel compressed RGB texture format. + Disable the embedded audio. - + - ETC (Nintendo 3DS) 4 bitspixel RGB + 4 bitspixel Alpha compressed texture format. + A container for video data. - + - ETC2 (GL ES 3.0) 4 bits/pixel compressed RGB texture format. + Number of audio tracks in the clip. - + - ETC2 (GL ES 3.0) 4 bits/pixel RGB+1-bit alpha texture format. + The length of the VideoClip in frames. (Read Only). - + - ETC2 (GL ES 3.0) 8 bits/pixel compressed RGBA texture format. + The frame rate of the clip in frames/second. (Read Only). - + - PowerVR (iOS) 2 bits/pixel compressed color texture format. + The height of the images in the video clip in pixels. (Read Only). - + - PowerVR (iOS) 4 bits/pixel compressed color texture format. + The length of the video clip in seconds. (Read Only). - + - PowerVR (iOS) 2 bits/pixel compressed with alpha channel texture format. + The video clip path in the project's assets. (Read Only). - + - PowerVR (iOS) 4 bits/pixel compressed with alpha channel texture format. + The width of the images in the video clip in pixels. (Read Only). - + - A 16 bit color texture format that only has a red channel. + 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. + - + - Scalar (R) texture format, 32 bit floating point. + Get the audio track language. Can be unknown. + Index of the audio queried audio track. + + The abbreviated name of the language. + - + - A color texture format. + Get the audio track sampling rate in Hertz. + Index of the audio queried audio track. + + The sampling rate in Hertz. + - + - A 16 bit color texture format. + Plays video content onto a target. - + - Color with alpha texture format, 8-bits per channel. + Defines how the video content will be stretched to fill the target area. - + - Color and alpha texture format, 4 bit per channel. + Destination for the audio embedded in the video. - + - RGB color and alpha etxture format, 32-bit floats per channel. + Number of audio tracks found in the data source currently configured. - + - RGB color and alpha texture format, 16 bit floating point per channel. + Whether direct-output volume controls are supported for the current platform and video format. (Read Only) - + - Two color (RG) texture format, 32 bit floating point per channel. + Whether the playback speed can be changed. (Read Only) - + - Two color (RG) texture format, 16 bit floating point per channel. + Determines whether the VideoPlayer skips frames to catch up with current time. (Read Only) - + - Scalar (R) texture format, 16 bit floating point. + Whether current time can be changed using the time or timeFrames property. (Read Only) - + - A format that uses the YUV color space and is often used for video encoding. Currently, this texture format is only useful for native code plugins as there is no support for texture importing or pixel access for this format. YUY2 is implemented for Direct3D 9, Direct3D 11, and Xbox One. + Whether the time source followed by the VideoPlayer can be changed. (Read Only) - + - Wrap mode for textures. + Returns true if the VideoPlayer can step forward through the video content. (Read Only) - + - Clamps the texture to the last pixel at the border. + The clip being played by the VideoPlayer. - + - Tiles the texture, creating a repeating pattern. + Number of audio tracks that this VideoPlayer will take control of. The other ones will be silenced. A maximum of 64 tracks are allowed. +The actual number of audio tracks cannot be known in advance when playing URLs, which is why this value is independent of the Video.VideoPlayer.audioTrackCount property. - + - Priority of a thread. + Maximum number of audio tracks that can be controlled. - + - Below normal thread priority. + Errors such as HTTP connection problems are reported through this callback. + - + - Highest thread priority. + The frame index currently being displayed by the VideoPlayer. - + - Lowest thread priority. + Number of frames in the current video content. - + - Normal thread priority. + [NOT YET IMPLEMENTED] Invoked when the video decoder does not produce a frame as per the time source during playback. + - + - The interface to get time information from Unity. + The frame rate of the clip or URL in frames/second. (Read Only). - + - Slows game playback time to allow screenshots to be saved between frames. + Invoked when a new frame is ready. + - + - The time in seconds it took to complete the last frame (Read Only). + Determines whether the VideoPlayer restarts from the beginning when it reaches the end of the clip. - + - The interval in seconds at which physics and other fixed frame rate updates (like MonoBehaviour's MonoBehaviour.FixedUpdate) are performed. + Whether content is being played. (Read Only) - + - The time the latest MonoBehaviour.FixedUpdate has started (Read Only). This is the time in seconds since the start of the game. + Whether the VideoPlayer has successfully prepared the content to be played. (Read Only) - + - The total number of frames that have passed (Read Only). + Invoked when the VideoPlayer reaches the end of the content to play. + - + - The maximum time a frame can take. Physics and other fixed frame rate updates (like MonoBehaviour's MonoBehaviour.FixedUpdate). + Factor by which the basic playback rate will be multiplied. - + - The real time in seconds since the game started (Read Only). + Whether the content will start playing back as soon as the component awakes. - + - A smoothed out Time.deltaTime (Read Only). + Invoked when the VideoPlayer preparation is complete. + - + - The time at the beginning of this frame (Read Only). This is the time in seconds since the start of the game. + Where the video content will be drawn. - + - The scale at which the time is passing. This can be used for slow motion effects. + Invoke after a seek operation completes. + - + - The time this frame has started (Read Only). This is the time in seconds since the last level has been loaded. + Enables the frameReady events. - + - The timeScale-independent time in seconds it took to complete the last frame (Read Only). + Whether the VideoPlayer is allowed to skip frames to catch up with current time. - + - The timeScale-independant time at the beginning of this frame (Read Only). This is the time in seconds since the start of the game. + The source that the VideoPlayer uses for playback. - + - Interface into Tizen specific functionality. + Invoked immediately after Play is called. + - + - Get pointer to the native window handle. + Camera component to draw to when Video.VideoPlayer.renderMode is set to either Video.VideoTarget.CameraBackPlane or Video.VideoTarget.CameraFrontPlane. - + - Specify a tooltip for a field. + Overall transparency level of the target camera plane video. - + - The tooltip text. + Material texture property which is targeted when Video.VideoPlayer.renderMode is set to Video.VideoTarget.MaterialOverride. - + - Specify a tooltip for a field. + Renderer which is targeted when Video.VideoPlayer.renderMode is set to Video.VideoTarget.MaterialOverride - The tooltip text. - + - Structure describing the status of a finger touching the screen. + RenderTexture to draw to when Video.VideoPlayer.renderMode is set to Video.VideoTarget.RenderTexture. - + - Value of 0 radians indicates that the stylus is parallel to the surface, pi/2 indicates that it is perpendicular. + Internal texture in which video content is placed. - + - Value of 0 radians indicates that the stylus is pointed along the x-axis of the device. + The VideoPlayer current time in seconds. - + - The position delta since last change. + [NOT YET IMPLEMENTED] The source used used by the VideoPlayer to derive its current time. - + - Amount of time that has passed since the last recorded change in Touch values. + The file or HTTP URL that the VideoPlayer will read content from. - + - The unique index for the touch. + 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 maximum possible pressure value for a platform. If Input.touchPressureSupported returns false, the value of this property will always be 1.0f. + 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. - + - Describes the phase of the touch. + Delegate type for VideoPlayer events that contain an error message. + The VideoPlayer that is emitting the event. + Message describing the error just encountered. - + - The position of the touch in pixel coordinates. + Delegate type for all parameter-less events emitted by VideoPlayers. + The VideoPlayer that is emitting the event. - + - 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. + Delegate type for VideoPlayer events that carry a frame number. + The VideoPlayer that is emitting the event. + The frame the VideoPlayer is now at. + - + - 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. + The number of audio channels in the specified audio track. + Index for the audio track being queried. + + Number of audio channels. + - + - The amount that the radius varies by for a touch. + Returns the language code, if any, for the specified track. + Index of the audio track to query. + + Language code. + - + - Number of taps. + Get the direct-output audio mute status for the specified track. + - + - A value that indicates whether a touch was of Direct, Indirect (or remote), or Stylus type. + Return the direct-output volume for specified track. + Track index for which the volume is queried. + + Volume, between 0 and 1. + - + - Describes phase of a finger touch. + 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. + - + - A finger touched the screen. + Returns whether decoding for the specified audio track is enabled. See Video.VideoPlayer.EnableAudioTrack for distinction with mute. + Index of the audio track being queried. + + True if decoding for the specified audio track is enabled. + - + - The system cancelled tracking for the touch. + Pauses the playback and leaves the current time intact. - + - A finger was lifted from the screen. This is the final phase of a touch. + Starts playback. - + - A finger moved on the screen. + Initiates playback engine prepration. - + - A finger is touching the screen but hasn't moved. + Set the direct-output audio mute status for the specified track. + Track index for which the mute is set. + Mute on/off. - + - Interface into the native iPhone, Android, Windows Phone and Windows Store Apps on-screen keyboards - it is not available on other platforms. + Set the direct-output audio volume for the specified track. + Track index for which the volume is set. + New volume, between 0 and 1. - + - Is the keyboard visible or sliding into the position on the screen? + 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. - + - Returns portion of the screen which is covered by the keyboard. + Advances the current time by one frame immediately. - + - Specifies if input process was finished. (Read Only) + Pauses the playback and sets the current time to 0. - + - Will text input field above the keyboard be hidden when the keyboard is on screen? + Type of destination for the images read by a VideoPlayer. - + - Is touch screen keyboard supported. + Don't draw the video content anywhere, but still make it available via the VideoPlayer's texture property in the API. - + - Specified on which display the software keyboard will appear. + Draw video content behind a camera's scene. - + - Returns the text displayed by the input field of the keyboard. + Draw video content in front of a camera's scene. - + - Returns true whenever any keyboard is completely visible on the screen. + Draw the video content into a user-specified property of the current GameObject's material. - + - Specifies if input process was canceled. (Read Only) + Draw video content into a RenderTexture. - + - Opens the native keyboard provided by OS on the screen. + Source of the video content for a VideoPlayer. - 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. - + - Opens the native keyboard provided by OS on the screen. + Use the current URL as the video content source. - 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. - + - Opens the native keyboard provided by OS on the screen. + Use the current clip as the video content source. - 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. - + - Opens the native keyboard provided by OS on the screen. + Time source followed by the Video.VideoPlayer when reading content. - 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. - + - Opens the native keyboard provided by OS on the screen. + The audio hardware clock. - 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. - + - Opens the native keyboard provided by OS on the screen. + The unscaled game time as defined by Time.realtimeSinceStartup. - 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. - + - Opens the native keyboard provided by OS on the screen. + A collection of methods and properties for interacting with the VR tracking system. - 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. - + - Describes the type of keyboard. + Disables positional tracking in VR. If set to true the camera only tracks headset rotation state. - + - Keyboard displays standard ASCII characters. + 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. + - + - Default keyboard for the current input method. + 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. + - + - Keyboard optimized for specifying email addresses. + Center tracking to the current position and orientation of the HMD. - + - Keypad designed for entering a person's name or phone number. + Represents the size of physical space available for VR. - + - Keyboard designed for Nintendo Network Accounts (available on Wii U only). + Represents a space large enough for free movement. - + - Numeric keypad designed for PIN entry. + Represents a small space where movement may be constrained or positional tracking is unavailable. - + - Keyboard with numbers and punctuation. + Contains all functionality related to a VR device. - + - Keypad designed for entering telephone numbers. + The name of the family of the loaded VR device. - + - Keyboard optimized for URL entry. + Successfully detected a VR device in working order. - + - Describes whether a touch is direct, indirect (or remote), or from a stylus. + Specific model of loaded VR device. - + - A direct touch on a device. + Refresh rate of the display in Hertz. - + - An Indirect, or remote, touch on a device. + This method returns an IntPtr representing the native pointer to the VR device if one is available, otherwise the value will be IntPtr.Zero. + + The native pointer to the VR device. + - + - A touch from a stylus on a 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. + - + - The trail renderer is used to make trails behind objects in the scene as they move about. + 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. + - + - Does the GameObject of this trail renderer auto destructs? + Supported VR devices. - + - The width of the trail at the end of the trail. + Sony's Project Morpheus VR device for Playstation 4. (Obsolete please use VRDeviceType.PlayStationVR instead). - + - The width of the trail at the spawning point. + No VR Device. - + - How long does the trail take to fade out. + Oculus family of VR devices. - + - Removes all points from the TrailRenderer. -Useful for restarting a trail from a new position. + Sony's PlayStation VR device for Playstation 4 (formerly called Project Morpheus VR).Sony's PlayStation VR device for Playstation 4 (formerly called Project Morpheus VR). - + - Position, rotation and scale of an object. + Split screen stereo 3D (the left and right cameras are rendered side by side). - + - The number of children the Transform has. + Stereo 3D via D3D11 or OpenGL. - + - The rotation as Euler angles in degrees. + This value is returned when running on a device that does not have its own value in this VRDeviceType enum. To find out the device name, you can use VRSettings.loadedDeviceName. - + - The blue axis of the transform in world space. + Enumeration of nodes which can be updated by VR input. - + - Has the transform changed since the last time the flag was set to 'false'? + Node representing a point between the left and right eyes. - + - The rotation as Euler angles in degrees relative to the parent transform's rotation. + Node representing the user's head. - + - Position of the transform relative to the parent transform. + Node representing the left eye. - + - The rotation of the transform relative to the parent transform's rotation. + Node representing the left hand. - + - The scale of the transform relative to the parent. + Node representing the right eye. - + - Matrix that transforms a point from local space into world space (Read Only). + Node representing the right hand. - + - The global scale of the object (Read Only). + Global VR related settings. - + - The parent of the transform. + Globally enables or disables VR for the application. - + - The position of the transform in world space. + The current height of an eye texture for the loaded device. - + - The red axis of the transform in world space. + The current width of an eye texture for the loaded device. - + - Returns the topmost transform in the hierarchy. + Read-only value that can be used to determine if the VR device is active. - + - The rotation of the transform in world space stored as a Quaternion. + Type of VR device that is currently in use. - + - The green axis of the transform in world space. + Type of VR device that is currently loaded. - + - Matrix that transforms a point from world space into local space (Read Only). + Controls the texel:pixel ratio before lens correction, trading performance for sharpness. - + - Unparents all children. + Controls the texel:pixel ratio before lens correction, trading performance for sharpness. - + - Finds a child by name and returns it. + Mirror what is shown on the device to the main display, if possible. - Name of child to be found. - + - Returns a transform child by index. + Returns a list of supported VR devices that were included at build time. - Index of the child transform to return. Must be smaller than Transform.childCount. - - Transform child by index. - - + - Gets the sibling index. + Loads the requested device at the beginning of the next frame. + Name of the device from VRSettings.supportedDevices. + Prioritized list of device names from VRSettings.supportedDevices. - + - Transforms a direction from world space to local space. The opposite of Transform.TransformDirection. + Loads the requested device at the beginning of the next frame. - + Name of the device from VRSettings.supportedDevices. + Prioritized list of device names from VRSettings.supportedDevices. - + - Transforms the direction x, y, z from world space to local space. The opposite of Transform.TransformDirection. + Timing and other statistics from the VR subsystem. - - - - + - Transforms position from world space to local space. + Total GPU time utilized last frame as measured by the VR subsystem. - - + - Transforms the position x, y, z from world space to local space. The opposite of Transform.TransformPoint. + Retrieves the number of dropped frames reported by the VR SDK. - - - + Outputs the number of frames dropped since the last update. + + True if the dropped frame count is available, false otherwise. + - + - Transforms a vector from world space to local space. The opposite of Transform.TransformVector. + Retrieves the number of times the current frame has been drawn to the device as reported by the VR SDK. - + Outputs the number of times the current frame has been presented. + + True if the frame present count is available, false otherwise. + - + - Transforms the vector x, y, z from world space to local space. The opposite of Transform.TransformVector. + Retrieves the time spent by the GPU last frame, in seconds, as reported by the VR SDK. - - - + Outputs the time spent by the GPU last frame. + + True if the GPU time spent last frame is available, false otherwise. + - + - Is this transform a child of parent? + The Holographic Settings contain functions which effect the performance and presentation of Holograms on Windows Holographic platforms. - - + - Rotates the transform so the forward vector points at target's current position. + Option to allow developers to achieve higher framerate at the cost of high latency. By default this option is off. - Object to point towards. - Vector specifying the upward direction. + True to enable or false to disable Low Latent Frame Presentation. - + - Rotates the transform so the forward vector points at target's current position. + Returns true if Holographic rendering is currently running with Latent Frame Presentation. Default value is false. - Object to point towards. - Vector specifying the upward direction. - + - Rotates the transform so the forward vector points at worldPosition. + 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. - Point to look at. - Vector specifying the upward direction. + 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. - + - Rotates the transform so the forward vector points at worldPosition. + 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. - Point to look at. - Vector specifying the upward direction. + 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. - + - 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). + 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. - + - 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). + Manager class with API for recognizing user gestures. - - - + - 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). + Cancels any pending gesture events. Additionally this will call StopCapturingGestures. - - - - - + - 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). + Create a GestureRecognizer. - - - - - + - Rotates the transform around axis by angle degrees. + Disposes the resources used by gesture recognizer. - - - - + - Rotates the transform around axis by angle degrees. + Callback indicating an error or warning occurred. - - - + A readable error string (when possible). + The HRESULT code from the platform. - + - Rotates the transform about axis passing through point in world coordinates by angle degrees. + 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. + - + - Move the transform to the start of the local transform list. + 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. - + - Move the transform to the end of the local transform list. + Callback indicating a cancel event. + Indicates which input medium triggered this event. + Ray (with normalized direction) from user at the time this gesture began. - + - Set the parent of the transform. + Fired when users complete a hold gesture. - The parent Transform to use. - If true, the parent-relative position, scale and rotation is modified such that the object keeps the same world space position, rotation and scale as before. + Delegate to be triggered when the user completes a hold gesture. - + - Sets the sibling index. + Callback indicating a hold completed event. - Index to set. + Indicates which input medium triggered this event. + Ray (with normalized direction) from user at the time this gesture began. - + - Transforms direction from local space to world space. + Fired when users start a hold gesture. - + The delegate to be triggered when a user starts a hold gesture. - + - Transforms direction x, y, z from local space to world space. + 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. - + - Transforms position from local space to world space. + Used to query if the GestureRecognizer is currently receiving Gesture events. - + + True if the GestureRecognizer is receiving events or false otherwise. + - + - Transforms the position x, y, z from local space to world space. + Fires when a Manipulation gesture is canceled. - - - + Delegate to be triggered when a cancel event is triggered. - + - Transforms vector from local space to world space. + 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. - + - Transforms vector x, y, z from local space to world space. + Fires when a Manipulation gesture is completed. - - - + Delegate to be triggered when a completed event is triggered. - + - Moves the transform in the direction and distance of translation. + 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. - + - Moves the transform in the direction and distance of translation. + Fires when an interaction becomes a Manipulation gesture. - - + Delegate to be triggered when a started event is triggered. - + - Moves the transform by x along the x axis, y along the y axis, and z along the z axis. + 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. - + - Moves the transform by x along the x axis, y along the y axis, and z along the z axis. + Fires when a Manipulation gesture is updated due to hand movement. - - - - + Delegate to be triggered when a updated event is triggered. - + - Moves the transform in the direction and distance of translation. + 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. - + - Moves the transform by x along the x axis, y along the y axis, and z along the z axis. + Fires when a Navigation gesture is canceled. - - - - + Delegate to be triggered when a cancel event is triggered. - + - Transparent object sorting mode of a Camera. + 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. - + - Default transparency sorting mode. + Fires when a Navigation gesture is completed. + Delegate to be triggered when a complete event is triggered. - + - Orthographic transparency sorting mode. + 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. - + - Perspective transparency sorting mode. + Fires when an interaction becomes a Navigation gesture. + Delegate to be triggered when a started event is triggered. - + - Tree Component for the tree creator. + 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. - + - Data asociated to the Tree. + Fires when a Navigation gesture is updated due to hand or controller movement. + Delegate to be triggered when a update event is triggered. - + - Tells if there is wind data exported from SpeedTree are saved on this component. + 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. - + - Contains information about a tree placed in the Terrain game object. + 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. - + - Color of this instance. + 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. - + - Height scale of this instance (compared to the prototype's size). + Fires when recognition of gestures begins. + Delegate to be triggered when a start event is triggered. - + - Lightmap color calculated for this instance. + 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. - + - Position of the tree. + 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. + - + - Index of this instance in the TerrainData.treePrototypes array. + Call to begin receiving gesture events on this recognizer. No events will be received until this method is called. - + - Rotation of the tree on X-Z plane (in radians). + Call to stop receiving gesture events on this recognizer. - + - Width scale of this instance (compared to the prototype's size). + Occurs when a Tap gesture is recognized. + Delegate to be triggered when a tap event is triggered. - + - Simple class that contains a pointer to a tree prototype. + 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. - + - Bend factor of the tree prototype. + This enumeration represents the set of gestures that may be recognized by GestureRecognizer. - + - Retrieves the actual GameObect used by the tree. + Enable support for the double-tap gesture. - + - Class that specifes some information about a renderable character. + Enable support for the hold gesture. - + - Character width. + 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. - + - Position of the character cursor in local (text generated) space. + Enable support for the navigation gesture, in the horizontal axis using rails (guides). - + - Information about a generated line of text. + Enable support for the navigation gesture, in the vertical axis using rails (guides). - + - Height of the line. + Enable support for the navigation gesture, in the depth axis using rails (guides). - + - Index of the first character in the line. + Enable support for the navigation gesture, in the horizontal axis. - + - 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. + Enable support for the navigation gesture, in the vertical axis. - + - Vertex class used by a Canvas for managing vertices. + Enable support for the navigation gesture, in the depth axis. - + - Vertex color. + Disable support for gestures. - + - Normal. + Enable support for the tap gesture. - + - Vertex position. + Provides access to user input from hands, controllers, and system voice commands. - + - Simple UIVertex with sensible settings for use in the UI system. + (Read Only) The number of InteractionSourceState snapshots available for reading with InteractionManager.GetCurrentReading. - + - Tangent. + Get the current SourceState. + + An array of InteractionSourceState snapshots. + - + - UV0. + 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. + - + - UV1. + Occurs when a new hand, controller, or source of voice commands has been detected. + - + - 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. + Callback to handle InteractionManager events. + - + - Version of Unity API. + Occurs when a hand, controller, or source of voice commands is no longer available. + - + - Initializes a new instance of UnityAPICompatibilityVersionAttribute. + Occurs when a hand or controller has entered the pressed state. - Unity version that this assembly with compatible with. + - + - Constants to pass to Application.RequestUserAuthorization. + Occurs when a hand or controller has exited the pressed state. + - + - Request permission to use any audio input sources attached to the computer. + Occurs when a hand or controller has experienced a change to its SourceState. + - + - Request permission to use any video input sources attached to the computer. + Represents one detected instance of a hand, controller, or user's voice that can cause interactions and gestures. - + - Representation of 2D vectors and points. + The identifier for the hand, controller, or user's voice. - + - Shorthand for writing Vector2(0, -1). + The kind of the interaction source. - + - Shorthand for writing Vector2(-1, 0). + Specifies the kind of an interaction source. - + - Returns the length of this vector (Read Only). + The interaction source is a controller. - + - Returns this vector with a magnitude of 1 (Read Only). + The interaction source is one of the user's hands. - + - Shorthand for writing Vector2(1, 1). + The interaction source is of a kind not known in this version of the API. - + - Shorthand for writing Vector2(1, 0). + The interaction source is the user's speech. - + - Returns the squared length of this vector (Read Only). + Represents the position and velocity of a hand or controller. - + - Shorthand for writing Vector2(0, 1). + Get the position of the interaction. + Supplied Vector3 to be populated with interaction position. + + True if the position is successfully returned. + - + - X component of the vector. + Get the velocity of the interaction. + Supplied Vector3 to be populated with interaction velocity. + + True if the velocity is successfully returned. + - + - Y component of the vector. + Represents the set of properties available to explore the current state of a hand or controller. - + - Shorthand for writing Vector2(0, 0). + The position and velocity of the hand, expressed in the specified coordinate system. - + - Returns the angle in degrees between from and to. + The direction you should suggest that the user move their hand if it is nearing the edge of the detection area. - - - + - Returns a copy of vector with its magnitude clamped to maxLength. + Gets the risk that detection of the hand will be lost as a value from 0.0 to 1.0. - - - + - Constructs a new vector with given x, y components. + Represents a snapshot of the state of a spatial interaction source (hand, voice or controller) at a given time. - - - + - Returns the distance between a and b. + The Ray at the time represented by this InteractionSourceState. - - - + - Dot Product of two vectors. + True if the source is in the pressed state. - - - + - Converts a Vector3 to a Vector2. + Additional properties to explore the state of the interaction source. - - + - Converts a Vector2 to a Vector3. + The interaction source that this state describes. - - + - Linearly interpolates between vectors a and b by t. + The storage object for persisted WorldAnchors. - - - - + - Linearly interpolates between vectors a and b by t. + (Read Only) Gets the number of persisted world anchors in this WorldAnchorStore. - - - - + - Returns a vector that is made from the largest components of two vectors. + Clears all persisted WorldAnchors. - - - + - Returns a vector that is made from the smallest components of two vectors. + Deletes a persisted WorldAnchor from the store. - - + The identifier of the WorldAnchor to delete. + + Whether or not the WorldAnchor was found and deleted. + - + + + 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. + + + - Moves a point current towards target. + Gets the WorldAnchorStore instance. - - - + The handler to be called when the WorldAnchorStore is loaded. - + - Makes this vector have a magnitude of 1. + The handler for when getting the WorldAnchorStore from GetAsync. + The instance of the WorldAnchorStore once loaded. - + - Divides a vector by a number. + 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. + - + - Returns true if the vectors are equal. + 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. + - + - Subtracts one vector from another. + Indicates the lifecycle state of the device's spatial location system. - - - + - Negates a vector. + The device is reporting its orientation and is preparing to locate its position in the user's surroundings. - - + - Multiplies a vector by a number. + The device is reporting its orientation and position in the user's surroundings. - - - + - Multiplies a vector by a number. + The device is reporting its orientation but cannot locate its position in the user's surroundings due to external factors like poor lighting conditions. - - - + - Returns true if vectors different. + The device is reporting its orientation and has not been asked to report its position in the user's surroundings. - - - + - Adds two vectors. + The device's spatial location system is not available. - - - + - Reflects a vector off the vector defined by a normal. + This enum represents the result of a WorldAnchorTransferBatch operation. - - - + - Multiplies two vectors component-wise. + The operation has failed because access was denied. This occurs typically because the transfer batch was not readable when deserializing or writable when serializing. - - - + - Multiplies every component of this vector by the same component of scale. + The operation has failed because it was not supported. - - + - Set x and y components of an existing Vector2. + The operation has completed successfully. - - - + - Gradually changes a vector towards a desired goal over time. + The operation has failed in an unexpected way. - 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. + A batch of WorldAnchors which can be exported and imported between apps. - 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. + (Read Only) Gets the number of world anchors in this WorldAnchorTransferBatch. - 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. + 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. + - + - Returns a nicely formatted string for this vector. + 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. - + - Returns a nicely formatted string for this vector. + Cleans up the WorldAnchorTransferBatch and releases memory. - - + - Representation of 3D vectors and points. + 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). - + - Shorthand for writing Vector3(0, 0, -1). + Gets all of the identifiers currently mapped in this WorldAnchorTransferBatch. + + The identifiers of all of the WorldAnchors in this WorldAnchorTransferBatch. + - + - Shorthand for writing Vector3(0, -1, 0). + 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. + - + - Shorthand for writing Vector3(0, 0, 1). + 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. - + - Shorthand for writing Vector3(-1, 0, 0). + 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. - + - Returns the length of this vector (Read Only). + 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. + - + - Returns this vector with a magnitude of 1 (Read Only). + The handler for when serialization is completed. + Why the serialization completed (success or failure reason). - + - Shorthand for writing Vector3(1, 1, 1). + The handler for when some data is available from serialization. + A set of bytes from the exported transfer batch. - + - Shorthand for writing Vector3(1, 0, 0). + Enumeration of the different types of SurfaceChange events. - + - Returns the squared length of this vector (Read Only). + Surface was Added. - + - Shorthand for writing Vector3(0, 1, 0). + Surface was removed. - + - X component of the vector. + Surface was updated. - + - Y component of the vector. + SurfaceData is a container struct used for requesting baked spatial mapping data and receiving that data once baked. - + - Z component of the vector. + 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. - + - Shorthand for writing Vector3(0, 0, 0). + This is the ID for the surface to be baked or the surface that was baked and being returned to the user. - + - Returns the angle in degrees between from and to. + 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. - The angle extends round from this vector. - The angle extends round to this vector. - + - Returns a copy of vector with its magnitude clamped to maxLength. + 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. - - - + - Cross Product of two vectors. + 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. - - - + - Creates a new vector with given x, y, z components. + 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. - - - - + - Creates a new vector with given x, y components and sets z to zero. + 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. - + - Returns the distance between a and b. + 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. - - - + - Dot Product of two vectors. + The actual integer ID referring to a single surface. - - - + - Linearly interpolates between two vectors. + SurfaceObserver is the main API portal for spatial mapping functionality in Unity. - - - - + - Linearly interpolates between two vectors. + Basic constructor for SurfaceObserver. - - - - + - Returns a vector that is made from the largest components of two vectors. + 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. - - - + - Returns a vector that is made from the smallest components of two vectors. + 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. + - + - Moves a point current in a straight line towards a target point. + 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. - + - Makes this vector have a magnitude of 1. + 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. - + - Divides a vector by a number. + 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. - + - Returns true if the vectors are equal. + 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. - + - Subtracts one vector from another. + 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. - + - Negates a vector. + 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. - + - Multiplies a vector by a number. + When calling PhotoCapture.StartPhotoModeAsync, you must pass in a CameraParameters object that contains the various settings that the web camera will use. - - - + - Multiplies a vector by a number. + A valid height resolution for use with the web camera. - - - + - Returns true if vectors different. + A valid width resolution for use with the web camera. - - - + - Adds two vectors. + The framerate at which to capture video. This is only for use with VideoCapture. - - - + - Makes vectors normalized and orthogonal to each other. + The opacity of captured holograms. - - - + - Makes vectors normalized and orthogonal to each other. + The pixel format used to capture and record your image data. - - - - + - Projects a vector onto another vector. + The encoded image or video pixel format to use for PhotoCapture and VideoCapture. - - - + - Projects a vector onto a plane defined by a normal orthogonal to the plane. + 8 bits per channel (blue, green, red, and alpha). - - - + - Reflects a vector off the plane defined by a normal. + Encode photo in JPEG format. - - - + - Rotates a vector current towards target. + 8-bit Y plane followed by an interleaved U/V plane with 2x2 subsampling. - - - - - + - Multiplies two vectors component-wise. + Portable Network Graphics Format. - - - + - Multiplies every component of this vector by the same component of scale. + Captures a photo from the web camera and stores it in memory or on disk. - - + - Set x, y and z components of an existing Vector3. + Contains the result of the capture request. - - - - + - Spherically interpolates between two vectors. + Specifies that the desired operation was successful. - - - - + - Spherically interpolates between two vectors. + Specifies that an unknown error occurred. - - - - + - Gradually changes a vector towards a desired goal over time. + Asynchronously creates an instance of a PhotoCapture object that can be used to capture photos. - 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. + 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. - + - Gradually changes a vector towards a desired goal over time. + Dispose must be called to shutdown the PhotoCapture instance. - 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. + Provides a COM pointer to the native IVideoDeviceController. - 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. + + A native COM pointer to the IVideoDeviceController. + - + - Access the x, y, z components using [0], [1], [2] respectively. + Called when a photo has been saved to the file system. + Indicates whether or not the photo was successfully saved to the file system. - + - Returns a nicely formatted string for this vector. + 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. - + - Returns a nicely formatted string for this vector. + Called when a PhotoCapture resource has been created. - + The PhotoCapture instance. - + - Representation of four-dimensional vectors. + Called when photo mode has been started. + Indicates whether or not photo mode was successfully activated. - + - Returns the length of this vector (Read Only). + Called when photo mode has been stopped. + Indicates whether or not photo mode was successfully deactivated. - + - Returns this vector with a magnitude of 1 (Read Only). + A data container that contains the result information of a photo capture operation. - + - Shorthand for writing Vector4(1,1,1,1). + The specific HResult value. - + - Returns the squared length of this vector (Read Only). + A generic result that indicates whether or not the PhotoCapture operation succeeded. - + - W component of the vector. + Indicates whether or not the operation was successful. - + - X component of the vector. + 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. - + - Y component of the vector. + Asynchronously stops photo mode. + This callback will be invoked once photo mode has been deactivated. - + - Z component of the vector. + A list of all the supported device resolutions for taking pictures. - + - Shorthand for writing Vector4(0,0,0,0). + 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. - + - Creates a new vector with given x, y, z, w components. + 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. - + - Creates a new vector with given x, y, z components and sets w to zero. + Image Encoding Format. - - - - + - Creates a new vector with given x, y components and sets z and w to zero. + JPEG Encoding. - - - + - Returns the distance between a and b. + PNG Encoding. - - - + - Dot Product of two vectors. + Contains information captured from the web camera. - - - + - Converts a Vector4 to a Vector2. + The length of the raw IMFMediaBuffer which contains the image captured. - - + - Converts a Vector4 to a Vector3. + Specifies whether or not spatial data was captured. - - + - Converts a Vector2 to a Vector4. + The raw image data pixel format. - - + - Converts a Vector3 to a Vector4. + 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. - + - Linearly interpolates between two vectors. + Disposes the PhotoCaptureFrame and any resources it uses. - - - - + - Linearly interpolates between two vectors. + 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. + - + - Returns a vector that is made from the largest components of two vectors. + 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. + - + - Returns a vector that is made from the smallest components of two vectors. + 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. + - + - Moves a point current towards target. + 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. - + - Makes this vector have a magnitude of 1. + Records a video from the web camera directly to disk. - + - Divides a vector by a number. + Specifies what audio sources should be recorded while recording the video. - - - + - Returns true if the vectors are equal. + Include both the application audio as well as the mic audio in the video recording. - - - + - Subtracts one vector from another. + Only include the application audio in the video recording. - - - + - Negates a vector. + Only include the mic audio in the video recording. - - + - Multiplies a vector by a number. + Do not include any audio in the video recording. - - - + - Multiplies a vector by a number. + Contains the result of the capture request. - - - + - Returns true if vectors different. + Specifies that the desired operation was successful. - - - + - Adds two vectors. + Specifies that an unknown error occurred. - - - + - Projects a vector onto another vector. + 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. - + - Multiplies two vectors component-wise. + Dispose must be called to shutdown the PhotoCapture instance. - - - + - Multiplies every component of this vector by the same component of scale. + 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. + - + - Set x, y, z and w components of an existing Vector4. + Provides a COM pointer to the native IVideoDeviceController. - - - - + + A native COM pointer to the IVideoDeviceController. + - + - Access the x, y, z, w components using [0], [1], [2], [3] respectively. + Indicates whether or not the VideoCapture instance is currently recording video. - + - Returns a nicely formatted string for this vector. + Called when the web camera begins recording the video. - + Indicates whether or not video recording started successfully. - + - Returns a nicely formatted string for this vector. + 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. - + - Wrapping modes for text that reaches the vertical boundary. + Called when a VideoCapture resource has been created. + The VideoCapture instance. - + - Text well continue to generate when reaching vertical boundary. + Called when video mode has been started. + Indicates whether or not video mode was successfully activated. - + - Text will be clipped when reaching the vertical boundary. + Called when video mode has been stopped. + Indicates whether or not video mode was successfully deactivated. - + - VR Input tracking data. + 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. - + - The current position of the requested VRNode. + Asynchronously starts video mode. - Node index. - - Position of node local to its tracking space. - + 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. - + - The current rotation of the requested VRNode. + Asynchronously stops recording a video from the web camera to the file system. - Node index. - - Rotation of node local to its tracking space. - + Invoked as soon as video recording has finished. - + - Center tracking on the current pose. + Asynchronously stops video mode. + This callback will be invoked once video mode has been deactivated. - + - Contains all functionality related to a VR device. + A list of all the supported device resolutions for recording videos. - + - The name of the family of the loaded VR device. + A data container that contains the result information of a video recording operation. - + - Successfully detected a VR device in working order. + The specific HResult value. - + - Specific model of loaded VR device. + A generic result that indicates whether or not the VideoCapture operation succeeded. - + - Native pointer to the VR device structure, if available. + Indicates whether or not the operation was successful. - - Native pointer to VR device if available, else 0. - - + - Supported VR devices. + Contains general information about the current state of the web camera. - + - Sony's Project Morpheus VR device for Playstation 4. (Obsolete please use VRDeviceType.PlayStationVR instead). + Specifies what mode the Web Camera is currently in. - + - No VR Device. + Describes the active mode of the Web Camera resource. - + - Oculus family of VR devices. + Resource is not in use. - + - Sony's PlayStation VR device for Playstation 4 (formerly called Project Morpheus VR). + Resource is in Photo Mode. - + - Split screen stereo 3D (the left and right cameras are rendered side by side). + Resource is in Video Mode. - + - Stereo 3D via D3D11 or OpenGL. + The WorldAnchor component allows a GameObject's position to be locked in physical space. - + - Enumeration of nodes which can be updated by VR input. + Returns true if this WorldAnchor is located (read only). A return of false typically indicates a loss of tracking. - + - Node between left and right eyes. + 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. + - + - Head node. + OnTrackingChanged notifies listeners when this object's tracking state changes. + Event that fires when this object's tracking state changes. - + - Left Eye node. + 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. - + - Right Eye node. + 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. - + - Global VR related settings. + This class represents the state of the real world tracking system. - + - Globally enables or disables VR for the application. + The current state of the world tracking systems. - + - Type of VR device that is currently in use. + 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. + - + - Controls the texel:pixel ratio before lens correction, trading performance for sharpness. + Event fired when the world tracking systems state has changed. + - + - Mirror what is shown on the device to the main display, if possible. + 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. @@ -45221,15 +56696,26 @@ Useful for restarting a trail from a new position. - Suspends the coroutine execution for the given amount of seconds. + Suspends the coroutine execution for the given amount of seconds using scaled time. - Creates a yield instruction to wait for a given number of seconds. + Creates a yield instruction to wait for a given number of seconds using scaled time. + + + Suspends the coroutine execution for the given amount of seconds using unscaled time. + + + + + 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. @@ -45610,9 +57096,19 @@ Useful for restarting a trail from a new position. 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 speed. + The current joint rotational speed in degrees/sec. @@ -45641,6 +57137,453 @@ Useful for restarting a trail from a new position. The time to calculate the motor torque for. + + + 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 semaning 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. @@ -45688,12 +57631,12 @@ Useful for restarting a trail from a new position. - Wind zone only has an effect inside the radius, and has a falloff from the center towards the edge. + Wind zone affects the entire scene in one direction. - 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. @@ -46431,121 +58374,152 @@ Useful for restarting a trail from a new position. A string with characters to be escaped. The text encoding to use. - + - Returns an AudioClip generated from the downloaded data (Read Only). + 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. - 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 your downloading. If this is not set Unity will try to determine the type from URL. + 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. + 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. - The returned AudioClip. + 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. + 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. + + + + Loads the new web player data file. + + + + + 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. + + + + Provides methods to access AudioClip or MovieTexture objects from WWW streams. + + + 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 your downloading. If this is not set Unity will try to determine the type from URL. + Use this to specify whether the clip should be a 2D or 3D clip. +The threeD parameter defaults to true. + Sets whether the clip should be completely downloaded before it's ready to play (false), or whether the stream can be played even if only part of the clip is downloaded (true). +Setting this to true will disable seeking (with .time and/or .timeSamples) on the clip. + 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 your downloading. If this is not set Unity will try to determine the type from URL. + Use this to specify whether the clip should be a 2D or 3D clip. +The threeD parameter defaults to true. + Sets whether the clip should be completely downloaded before it's ready to play (false), or whether the stream can be played even if only part of the clip is downloaded (true). +Setting this to true will disable seeking (with .time and/or .timeSamples) on the clip. + 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). + 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 AudioType of the content your downloading. If this is not set Unity will try to determine the type from URL. + Use this to specify whether the clip should be a 2D or 3D clip. +The threeD parameter defaults to true. + Sets whether the clip should be completely downloaded before it's ready to play (false), or whether the stream can be played even if only part of the clip is downloaded (true). +Setting this to true will disable seeking (with .time and/or .timeSamples) on the clip. + 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). + 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 AudioType of the content your downloading. If this is not set Unity will try to determine the type from URL. + Use this to specify whether the clip should be a 2D or 3D clip. +The threeD parameter defaults to true. + Sets whether the clip should be completely downloaded before it's ready to play (false), or whether the stream can be played even if only part of the clip is downloaded (true). +Setting this to true will disable seeking (with .time and/or .timeSamples) on the clip. + 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 AudioType of the content you are downloading. If this is not set Unity will try to determine the type from URL. + The returned AudioClip. - + - 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. + Returns an AudioClip generated from the downloaded data that is compressed in memory (Read Only). - 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. - 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. + Use this to specify whether the clip should be a 2D or 3D clip. + The AudioType of the content you are downloading. If this is not set Unity will try to determine the type from URL. + - A WWW instance, which can be used to access the data once the load/download operation is completed. + The returned AudioClip. - + - 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. + Returns an AudioClip generated from the downloaded data that is compressed in memory (Read Only). - 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. - 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. + Use this to specify whether the clip should be a 2D or 3D clip. + The AudioType of the content you are downloading. If this is not set Unity will try to determine the type from URL. + - A WWW instance, which can be used to access the data once the load/download operation is completed. + The returned AudioClip. - + - 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. - - - - Loads the new web player data file. - - - - - 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. + Returns a MovieTexture generated from the downloaded data (Read Only). - A string containing escaped characters. - The text encoding to use. + diff --git a/Library/UnityAssemblies/nunit.framework.dll b/Library/UnityAssemblies/nunit.framework.dll index d8748ae..675e6ce 100644 Binary files a/Library/UnityAssemblies/nunit.framework.dll and b/Library/UnityAssemblies/nunit.framework.dll differ diff --git a/Library/UnityAssemblies/nunit.framework.xml b/Library/UnityAssemblies/nunit.framework.xml index d79975c..f937a2a 100644 --- a/Library/UnityAssemblies/nunit.framework.xml +++ b/Library/UnityAssemblies/nunit.framework.xml @@ -4,9209 +4,15935 @@ nunit.framework - + - Delegate used by tests that execute code and - capture any thrown exception. + The different targets a test action attribute can be applied to - + - The Assert class contains a collection of static methods that - implement the most common assertions used in NUnit. + Default target, which is determined by where the action attribute is attached - + - 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. + Target a individual test case - + - The Equals method throws an AssertionException. This is done - to make sure there is no mistake by calling this function. + Target a suite of test cases - - - + - override the default ReferenceEquals to throw an AssertionException. This - implementation makes sure there is no mistake in calling this function - as part of Assert. + FrameworkController provides a facade for use in loading, browsing + and running tests without requiring a reference to the NUnit + framework. All calls are encapsulated in constructors for + this class and its nested classes, which only require the + types of the Common Type System as arguments. + + The controller supports four actions: Load, Explore, Count and Run. + They are intended to be called by a driver, which should allow for + proper sequencing of calls. Load must be called before any of the + other actions. The driver may support other actions, such as + reload on run, by combining these calls. - - - + - 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. + Construct a FrameworkController using the default builder and runner. - The message to initialize the with. - Arguments to be used in formatting the message + The AssemblyName or path to the test assembly + A prefix used for all test ids created under this controller. + A Dictionary of settings to use in loading and running the tests - + - 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. + Construct a FrameworkController using the default builder and runner. - The message to initialize the with. + The test assembly + A prefix used for all test ids created under this controller. + A Dictionary of settings to use in loading and running the tests - + - 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. + Construct a FrameworkController, specifying the types to be used + for the runner and builder. This constructor is provided for + purposes of development. + The full AssemblyName or the path to the test assembly + A prefix used for all test ids created under this controller. + A Dictionary of settings to use in loading and running the tests + The Type of the test runner + The Type of the test builder - + - Throws an with the message and arguments - that are passed in. This is used by the other Assert functions. + Construct a FrameworkController, specifying the types to be used + for the runner and builder. This constructor is provided for + purposes of development. - The message to initialize the with. - Arguments to be used in formatting the message + The test assembly + A prefix used for all test ids created under this controller. + A Dictionary of settings to use in loading and running the tests + The Type of the test runner + The Type of the test builder - + - Throws an with the message that is - passed in. This is used by the other Assert functions. + Gets the ITestAssemblyBuilder used by this controller instance. - The message to initialize the with. + The builder. - + - Throws an . - This is used by the other Assert functions. + Gets the ITestAssemblyRunner used by this controller instance. + The runner. - + - Throws an with the message and arguments - that are passed in. This causes the test to be reported as ignored. + Gets the AssemblyName or the path for which this FrameworkController was created - 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. + Gets the Assembly for which this - The message to initialize the with. - + - Throws an . - This causes the test to be reported as ignored. + Gets a dictionary of settings for the FrameworkController - + - Throws an with the message and arguments - that are passed in. This causes the test to be reported as inconclusive. + Loads the tests in the assembly - 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. + Returns info about the tests in an assembly - The message to initialize the with. + A string containing the XML representation of the filter to use + The XML result of exploring the tests - + - Throws an . - This causes the test to be reported as Inconclusive. + Runs the tests in an assembly + A string containing the XML representation of the filter to use + The XML result of the test run - + - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. + Runs the tests in an assembly syncronously reporting back the test results through the callback + or through the return value - The actual value to test - A Constraint to be applied + The callback that receives the test results + A string containing the XML representation of the filter to use + The XML result of the test run - + - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. + Runs the tests in an assembly asyncronously reporting back the test results through the callback - The actual value to test - A Constraint to be applied - The message that will be displayed on failure + The callback that receives the test results + A string containing the XML representation of the filter to use - + - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. + Stops the test run - The actual value to test - A Constraint expression to be applied - The message that will be displayed on failure - Arguments to be used in formatting the message + True to force the stop, false for a cooperative stop - + - 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 + Counts the number of test cases in the loaded TestSuite + + A string containing the XML representation of the filter to use + The number of tests - + - Asserts that a condition is true. If the condition is false the method throws - an . + Inserts environment element - The evaluated condition - The message to display if the condition is false + Target node + The new node - + - Asserts that a condition is true. If the condition is false the method throws - an . + Inserts settings element - The evaluated condition + Target node + Settings dictionary + The new node - + - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. + FrameworkControllerAction is the base class for all actions + performed against a FrameworkController. - An ActualValueDelegate returning the value to be tested - A Constraint expression to be applied - + - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. + LoadTestsAction loads a test into the FrameworkController - An ActualValueDelegate returning the value to be tested - A Constraint expression to be applied - 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. + LoadTestsAction loads the tests in an assembly. - 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 + The controller. + The callback handler. - + - Apply a constraint to a referenced value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. + ExploreTestsAction returns info about the tests in an assembly - The actual value to test - A Constraint to be applied - + - Apply a constraint to a referenced value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. + Initializes a new instance of the class. - The actual value to test - A Constraint to be applied - The message that will be displayed on failure + The controller for which this action is being performed. + Filter used to control which tests are included (NYI) + The callback handler. - + - Apply a constraint to a referenced value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. + CountTestsAction counts the number of test cases in the loaded TestSuite + held by the FrameworkController. - The actual value to test - A Constraint to be applied - The message that will be displayed on failure - Arguments to be used in formatting the message - + - Asserts that the code represented by a delegate throws an exception - that satisfies the constraint provided. + Construct a CountsTestAction and perform the count of test cases. - A TestDelegate to be executed - A ThrowsConstraint used in the test + A FrameworkController holding the TestSuite whose cases are to be counted + A string containing the XML representation of the filter to use + A callback handler used to report results - + - 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. + RunTestsAction runs the loaded TestSuite held by the FrameworkController. - The actual value to test - A Constraint to be applied - + - 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. + Construct a RunTestsAction and run all tests in the loaded TestSuite. - The actual value to test - A Constraint to be applied - The message that will be displayed on failure + A FrameworkController holding the TestSuite to run + A string containing the XML representation of the filter to use + A callback handler used to report results - + - 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. + RunAsyncAction initiates an asynchronous test run, returning immediately - - This method is provided for use by VB developers needing to test - the value of properties with private setters. - - The actual value to test - A Constraint expression to be applied - 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. + Construct a RunAsyncAction and run all tests in the loaded TestSuite. - A constraint to be satisfied by the exception - A TestDelegate - The message that will be displayed on failure - Arguments to be used in formatting the message + A FrameworkController holding the TestSuite to run + A string containing the XML representation of the filter to use + A callback handler used to report results - + - Verifies that a delegate throws a particular exception when called. + StopRunAction stops an ongoing run. - A constraint to be satisfied by the exception - A TestDelegate - The message that will be displayed on failure - + - Verifies that a delegate throws a particular exception when called. + Construct a StopRunAction and stop any ongoing run. If no + run is in process, no error is raised. - A constraint to be satisfied by the exception - A TestDelegate + The FrameworkController for which a run is to be stopped. + True the stop should be forced, false for a cooperative stop. + >A callback handler used to report results + A forced stop will cause threads and processes to be killed as needed. - + - Verifies that a delegate throws a particular exception when called. + Implementation of ITestAssemblyRunner - The exception Type expected - A TestDelegate - 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. + Initializes a new instance of the class. - The exception Type expected - A TestDelegate - The message that will be displayed on failure + The builder. - + - Verifies that a delegate throws a particular exception when called. + The tree of tests that was loaded by the builder - The exception Type expected - A TestDelegate - + - Verifies that a delegate throws a particular exception when called. + The test result, if a run has completed - Type of the expected exception - A TestDelegate - 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. + Indicates whether a test is loaded - Type of the expected exception - A TestDelegate - The message that will be displayed on failure - + - Verifies that a delegate throws a particular exception when called. + Indicates whether a test is running - Type of the expected exception - A TestDelegate - + - Verifies that a delegate throws an exception when called - and returns it. + Indicates whether a test run is complete - 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. + Our settings, specified when loading the assembly - A TestDelegate - The message that will be displayed on failure - + - Verifies that a delegate throws an exception when called - and returns it. + The top level WorkItem created for the assembly as a whole - A TestDelegate - + - Verifies that a delegate throws an exception of a certain Type - or one derived from it when called and returns it. + The TestExecutionContext for the top level WorkItem - 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. + Loads the tests found in an Assembly - The expected Exception Type - A TestDelegate - The message that will be displayed on failure + File name of the assembly to load + Dictionary of option settings for loading the assembly + True if the load was successful - + - Verifies that a delegate throws an exception of a certain Type - or one derived from it when called and returns it. + Loads the tests found in an Assembly - The expected Exception Type - A TestDelegate + The assembly to load + Dictionary of option settings for loading the assembly + True if the load was successful - + - Verifies that a delegate throws an exception of a certain Type - or one derived from it when called and returns it. + Count Test Cases using a filter - The expected Exception Type - A TestDelegate - The message that will be displayed on failure - Arguments to be used in formatting the message + The filter to apply + The number of test cases found - + - Verifies that a delegate throws an exception of a certain Type - or one derived from it when called and returns it. + Run selected tests and return a test result. The test is run synchronously, + and the listener interface is notified as it progresses. - The expected Exception Type - A TestDelegate - The message that will be displayed on failure + Interface to receive EventListener notifications. + A test filter used to select tests to be run + - + - Verifies that a delegate throws an exception of a certain Type - or one derived from it when called and returns it. + Run selected tests asynchronously, notifying the listener interface as it progresses. - The expected Exception Type - A TestDelegate + Interface to receive EventListener notifications. + A test filter used to select tests to be run + + RunAsync is a template method, calling various abstract and + virtual methods to be overridden by derived classes. + - + - Verifies that a delegate does not throw an exception + Wait for the ongoing run to complete. - A TestDelegate - The message that will be displayed on failure - Arguments to be used in formatting the message + Time to wait in milliseconds + True if the run completed, otherwise false - + - Verifies that a delegate does not throw an exception. + Signal any test run that is in process to stop. Return without error if no test is running. - A TestDelegate - The message that will be displayed on failure + If true, kill any tests that are currently running - + - Verifies that a delegate does not throw an exception. + Initiate the test run. - A TestDelegate - + - Asserts that a condition is true. If the condition is false the method throws - an . + Create the initial TestExecutionContext used to run tests - The evaluated condition - The message to display in case of failure - Array of objects to be used in formatting the message + The ITestListener specified in the RunAsync call - + - Asserts that a condition is true. If the condition is false the method throws - an . + Handle the the Completed event for the top level work item - 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 ITestAssemblyBuilder interface is implemented by a class + that is able to build a suite of tests given an assembly or + an assembly filename. - The evaluated condition - + - Asserts that a condition is true. If the condition is false the method throws - an . + Build a suite of tests from a provided assembly - The evaluated condition - The message to display in case of failure - Array of objects to be used in formatting the message + The assembly from which tests are to be built + A dictionary of options to use in building the suite + A TestSuite containing the tests found in the assembly - + - Asserts that a condition is true. If the condition is false the method throws - an . + Build a suite of tests given the filename of an assembly - The evaluated condition - The message to display in case of failure + The filename of the assembly from which tests are to be built + A dictionary of options to use in building the suite + A TestSuite containing the tests found in the assembly - + - Asserts that a condition is true. If the condition is false the method throws - an . + The ITestAssemblyRunner interface is implemented by classes + that are able to execute a suite of tests loaded + from an assembly. - 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 + Gets the tree of loaded tests, or null if + no tests have been loaded. + - + - 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 + Gets the tree of test results, if the test + run is completed, otherwise null. + - + - Asserts that a condition is false. If the condition is true the method throws - an . - - The evaluated condition + Indicates whether a test has been loaded + - + - 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 + Indicates whether a test is currently running + - + - 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 + Indicates whether a test run is complete + - + - Asserts that a condition is false. If the condition is true the method throws - an . - - The evaluated condition + Loads the tests found in an Assembly, returning an + indication of whether or not the load succeeded. + + File name of the assembly to load + Dictionary of options to use in loading the test + An ITest representing the loaded tests - + - Verifies that the object that is passed in is not equal to null - If the object is null then an - is thrown. + Loads the tests found in an Assembly, returning an + indication of whether or not the load succeeded. - 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 + The assembly to load + Dictionary of options to use in loading the test + An ITest representing the loaded tests - + - Verifies that the object that is passed in is not equal to null - If the object is null then an - is thrown. + Count Test Cases using a filter - The object that is to be tested - The message to display in case of failure + The filter to apply + The number of test cases found - + - Verifies that the object that is passed in is not equal to null - If the object is null then an - is thrown. + Run selected tests and return a test result. The test is run synchronously, + and the listener interface is notified as it progresses. - The object that is to be tested + Interface to receive ITestListener notifications. + A test filter used to select tests to be run - + - Verifies that the object that is passed in is not equal to null - If the object is null then an - is thrown. + Run selected tests asynchronously, notifying the listener interface as it progresses. - 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 + Interface to receive EventListener notifications. + A test filter used to select tests to be run - + - Verifies that the object that is passed in is not equal to null - If the object is null then an - is thrown. + Wait for the ongoing run to complete. - The object that is to be tested - The message to display in case of failure + Time to wait in milliseconds + True if the run completed, otherwise false - + - Verifies that the object that is passed in is not equal to null - If the object is null then an - is thrown. + Signal any test run that is in process to stop. Return without error if no test is running. - The object that is to be tested + If true, kill any test-running threads - + - Verifies that the object that is passed in is equal to null - If the object is not null then an - is thrown. + DefaultTestAssemblyBuilder loads a single assembly and builds a TestSuite + containing test fixtures present in the assembly. - 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 default suite builder used by the test assembly builder. - 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. + Initializes a new instance of the class. - 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. + Build a suite of tests from a provided assembly - 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 + The assembly from which tests are to be built + A dictionary of options to use in building the suite + + A TestSuite containing the tests found in the assembly + - + - Verifies that the object that is passed in is equal to null - If the object is not null then an - is thrown. + Build a suite of tests given the filename of an assembly - The object that is to be tested - The message to display in case of failure + The filename of the assembly from which tests are to be built + A dictionary of options to use in building the suite + + A TestSuite containing the tests found in the assembly + - + - Verifies that the object that is passed in is equal to null - If the object is not null then an - is thrown. + Marks a test that must run in a particular threading apartment state, causing it + to run in a separate thread if necessary. - The object that is to be tested - + - Verifies that two ints are equal. If they are not, then an - is thrown. + Construct an ApartmentAttribute - The expected value - The actual value - The message to display in case of failure - Array of objects to be used in formatting the message + The apartment state that this test must be run under. You must pass in a valid apartment state. - + - Verifies that two ints are equal. If they are not, then an - is thrown. + Provides the Author of a test or test fixture. - The expected value - The actual value - The message to display in case of failure - + - Verifies that two ints are equal. If they are not, then an - is thrown. + Initializes a new instance of the class. - The expected value - The actual value + The name of the author. - + - Verifies that two longs are equal. If they are not, then an - is thrown. + Initializes a new instance of the class. - The expected value - The actual value - The message to display in case of failure - Array of objects to be used in formatting the message + The name of the author. + The email address of the author. - + - Verifies that two longs are equal. If they are not, then an - is thrown. + Marks a test to use a particular CombiningStrategy to join + any parameter data provided. Since this is the default, the + attribute is optional. - The expected value - The actual value - The message to display in case of failure - + - Verifies that two longs are equal. If they are not, then an - is thrown. + Construct a CombiningStrategyAttribute incorporating an + ICombiningStrategy and an IParamterDataProvider. - The expected value - The actual value + Combining strategy to be used in combining data + An IParameterDataProvider to supply data - + - Verifies that two unsigned ints are equal. If they are not, then an - is thrown. + Construct a CombiningStrategyAttribute incorporating an object + that implements ICombiningStrategy and an IParameterDataProvider. + This constructor is provided for CLS compliance. - The expected value - The actual value - The message to display in case of failure - Array of objects to be used in formatting the message + Combining strategy to be used in combining data + An IParameterDataProvider to supply data - + - Verifies that two unsigned ints are equal. If they are not, then an - is thrown. + Construct one or more TestMethods from a given MethodInfo, + using available parameter data. - The expected value - The actual value - The message to display in case of failure + The MethodInfo for which tests are to be constructed. + The suite to which the tests will be added. + One or more TestMethods - + - Verifies that two unsigned ints are equal. If they are not, then an - is thrown. + Modify the test by adding the name of the combining strategy + to the properties. - The expected value - The actual value + The test to modify - + - Verifies that two unsigned longs are equal. If they are not, then an - is thrown. + SingleThreadedAttribute applies to a test fixture and indicates + that all the child tests must be run on the same thread as the + OneTimeSetUp and OneTimeTearDown. It sets a flag in the + TestExecutionContext and forces all tests to be run sequentially + on the current thread. Any ParallelScope setting is ignored. - 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 unsigned longs are equal. If they are not, then an - is thrown. + Apply changes to the TestExecutionContext - The expected value - The actual value - The message to display in case of failure + The TestExecutionContext - + - Verifies that two unsigned longs are equal. If they are not, then an - is thrown. + TestAssemblyDirectoryResolveAttribute is used to mark a test assembly as needing a + special assembly resolution hook that will explicitly search the test assembly's + directory for dependent assemblies. This works around a conflict between mixed-mode + assembly initialization and tests running in their own AppDomain in some cases. - The expected value - The actual value - + - Verifies that two decimals are equal. If they are not, then an - is thrown. + Defines the order that the test will run in - 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 decimals are equal. If they are not, then an - is thrown. + Defines the order that the test will run in - The expected value - The actual value - The message to display in case of failure - + - Verifies that two decimals are equal. If they are not, then an - is thrown. + Defines the order that the test will run in - 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. + Modifies a test as defined for the specific attribute. - 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 + The test to modify - + - 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. + RepeatAttribute may be applied to test case in order + to run it multiple times. - 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. + Construct a RepeatAttribute - The expected value - The actual value - The maximum acceptable difference between the - the expected and the actual + The number of times to run the test - + - 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. + Wrap a command and return the result. - 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 + The command to be wrapped + The wrapped command - + - 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 test command for the RetryAttribute - 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. + Initializes a new instance of the class. - The expected value - The actual value - The maximum acceptable difference between the - the expected and the actual + The inner command. + The number of repetitions - + - 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. + Runs the test, saving a TestResult in the supplied TestExecutionContext. - 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 + The context in which the test should run. + A TestResult - + - 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. + Attribute used to identify a method that is called once + after all the child tests have run. The method is + guaranteed to be called, even if an exception 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. + Attribute used to identify a method that is called once + to perform setup before any child tests are run. - The value that is expected - The actual value - + - Verifies that two ints are not equal. If they are equal, then an - is thrown. + LevelOfParallelismAttribute is used to set the number of worker threads + that may be allocated by the framework for running tests. - 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 ints are not equal. If they are equal, then an - is thrown. + Construct a LevelOfParallelismAttribute. - The expected value - The actual value - The message to display in case of failure + The number of worker threads to be created by the framework. - + - Verifies that two ints are not equal. If they are equal, then an - is thrown. + ParallelizableAttribute is used to mark tests that may be run in parallel. - The expected value - The actual value - + - Verifies that two longs are not equal. If they are equal, then an - is thrown. + Construct a ParallelizableAttribute using default ParallelScope.Self. - 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 longs are not equal. If they are equal, then an - is thrown. + Construct a ParallelizableAttribute with a specified scope. - The expected value - The actual value - The message to display in case of failure + The ParallelScope associated with this attribute. - + - Verifies that two longs are not equal. If they are equal, then an - is thrown. + Modify the context to be used for child tests - The expected value - The actual value + The current TestExecutionContext - + - Verifies that two unsigned ints are not equal. If they are equal, then an - is thrown. + The ParallelScope enumeration permits specifying the degree to + which a test and its descendants may be run in parallel. - 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 unsigned ints are not equal. If they are equal, then an - is thrown. + No Parallelism is permitted - The expected value - The actual value - The message to display in case of failure - + - Verifies that two unsigned ints are not equal. If they are equal, then an - is thrown. + The test itself may be run in parallel with others at the same level - The expected value - The actual value - + - Verifies that two unsigned longs are not equal. If they are equal, then an - is thrown. + Descendants of the test may be run in parallel with one another - 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 unsigned longs are not equal. If they are equal, then an - is thrown. + Descendants of the test down to the level of TestFixtures may be run in parallel - The expected value - The actual value - The message to display in case of failure - + - Verifies that two unsigned longs are not equal. If they are equal, then an - is thrown. + Provide actions to execute before and after tests. - The expected value - The actual value - + - Verifies that two decimals are not equal. If they are equal, then an - is thrown. + Executed before each test is run - The expected value - The actual value - The message to display in case of failure - Array of objects to be used in formatting the message + The test that is going to be run. - + - Verifies that two decimals are not equal. If they are equal, then an - is thrown. + Executed after each test is run - The expected value - The actual value - The message to display in case of failure + The test that has just been run. - + - Verifies that two decimals are not equal. If they are equal, then an - is thrown. + Provides the target for the action attribute - The expected value - The actual value - + - Verifies that two floats are not equal. If they are equal, then an - is thrown. + TestCaseSourceAttribute indicates the source to be used to + provide test fixture instances for a test class. - 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 floats are not equal. If they are equal, then an - is thrown. + Error message string is public so the tests can use it - The expected value - The actual value - The message to display in case of failure - + - Verifies that two floats are not equal. If they are equal, then an - is thrown. + Construct with the name of the method, property or field that will provide data - The expected value - The actual value + The name of a static method, property or field that will provide data. - + - Verifies that two doubles are not equal. If they are equal, then an - is thrown. + Construct with a Type and name - The expected value - The actual value - The message to display in case of failure - Array of objects to be used in formatting the message + The Type that will provide data + The name of a static method, property or field that will provide data. - + - Verifies that two doubles are not equal. If they are equal, then an - is thrown. + Construct with a Type - The expected value - The actual value - The message to display in case of failure + The type that will provide data - + - Verifies that two doubles are not equal. If they are equal, then an - is thrown. + The name of a the method, property or fiend to be used as a source - 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. + A Type to be used as a source - 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. + Gets or sets the category associated with every fixture created from + this attribute. May be a single category or a comma-separated list. - 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. + Construct one or more TestFixtures from a given Type, + using available parameter data. - The value that is expected - The actual value + The TypeInfo for which fixures are to be constructed. + One or more TestFixtures as TestSuite - + - Asserts that two objects refer to the same object. If they - are not the same an is thrown. + Returns a set of ITestFixtureData items for use as arguments + to a parameterized test fixture. - The expected object - The actual object - The message to display in case of failure - Array of objects to be used in formatting the message + The type for which data is needed. + - + - Asserts that two objects refer to the same object. If they - are not the same an is thrown. + Indicates which class the test or test fixture is testing - 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. + Initializes a new instance of the class. - The expected object - The actual object + The type that is being tested. - + - Asserts that two objects do not refer to the same object. If they - are the same an is thrown. + Initializes a new instance of the class. - The expected object - The actual object - The message to display in case of failure - Array of objects to be used in formatting the message + The type that is being tested. - + - Asserts that two objects do not refer to the same object. If they - are the same an is thrown. + CollectionSupersetConstraint is used to determine whether + one collection is a superset of another - 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. + Construct a CollectionSupersetConstraint - The expected object - The actual object + The collection that the actual value is expected to be a superset of - - - Verifies that the double that is passed in is an NaN value. - If the object is not NaN then an - is thrown. + + + 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. - 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 Description of what this constraint tests, for + use in messages and in the ConstraintResult. - 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. + Test whether the actual collection is a superset of + the expected collection provided. - 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. + Flag the constraint to use the supplied predicate function - 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 + The comparison function to use. + Self. - + - Verifies that the double that is passed in is an NaN value. - If the object is not NaN then an - is thrown. + DictionaryContainsValueConstraint is used to test whether a dictionary + contains an expected object as a value. - 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. + Construct a DictionaryContainsValueConstraint - The value that is to be tested + - - - Assert that a string is empty - that is equal to string.Empty + + + 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. - 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 Description of what this constraint tests, for + use in messages and in the ConstraintResult. - 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 + Test whether the expected value is contained in the dictionary - The string to be tested - + - Assert that an array, list or other collection is empty + The EqualConstraintResult class is tailored for formatting + and displaying the result of an EqualConstraint. - 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 + Construct an EqualConstraintResult - 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 + Write a failure message. Overridden to provide custom + failure messages for EqualConstraint. - An array, list or other collection implementing ICollection + The MessageWriter to write to - + - Assert that a string is not empty - that is not equal to string.Empty + Display the failure information for two collections that did not match. - The string to be tested - The message to display in case of failure - Array of objects to be used in formatting the message + The MessageWriter on which to display + The expected collection. + The actual collection + The depth of this failure in a set of nested collections - + - Assert that a string is not empty - that is not equal to string.Empty + Displays a single line showing the types and sizes of the expected + and actual collections or arrays. If both are identical, the value is + only shown once. - The string to be tested - The message to display in case of failure + The MessageWriter on which to display + The expected collection or array + The actual collection or array + The indentation level for the message line - + - 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 + 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. - 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 + 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 - + - Assert that an array, list or other collection is not empty + Display the failure information for two IEnumerables that did not match. - An array, list or other collection implementing ICollection - The message to display in case of failure + The MessageWriter on which to display + The expected enumeration. + The actual enumeration + The depth of this failure in a set of nested collections - + - Assert that an array, list or other collection is not empty + The Description of what this constraint tests, for + use in messages and in the ConstraintResult. - An array, list or other collection implementing ICollection - + - Assert that a string is either null or equal to string.Empty + Applies the constraint to an actual value, returning a ConstraintResult. - The string to be tested - The message to display in case of failure - Array of objects to be used in formatting the message + The value to be tested + A ConstraintResult - + - Assert that a string is either null or equal to string.Empty + FileExistsConstraint is used to determine if a file exists - 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 + Initializes a new instance of the class. - The string to be tested - + - Assert that a string is not null or empty + The Description of what this constraint tests, for + use in messages and in the ConstraintResult. - 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 + FileOrDirectoryExistsConstraint is used to determine if a file or directory exists - The string to be tested - The message to display in case of failure - + - Assert that a string is not null or empty + If true, the constraint will only check if files exist, not directories - The string to be tested - + - Asserts that an object may be assigned a value of a given Type. + If true, the constraint will only check if directories exist, not files - 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. + Initializes a new instance of the class that + will check files and directories. - 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. + Initializes a new instance of the class that + will only check files if ignoreDirectories is true. - The expected Type. - The object under examination + if set to true [ignore directories]. - + - Asserts that an object may be assigned a value of a given Type. + The Description of what this constraint tests, for + use in messages and in the ConstraintResult. - 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. + Applies the constraint to an actual value, returning a ConstraintResult. - The expected Type. - The object under examination - The message to display in case of failure + The value to be tested + A ConstraintResult - + - Asserts that an object may be assigned a value of a given Type. + Interface for all constraints - The expected Type. - The object under examination - + - Asserts that an object may not be assigned a value of a given Type. + The display name of this Constraint for use by ToString(). - 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 Description of what this constraint tests, for + use in messages and in the ConstraintResult. - 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. + Arguments provided to this Constraint, for use in + formatting the description. - The expected Type. - The object under examination - + - Asserts that an object may not be assigned a value of a given Type. + The ConstraintBuilder holding this constraint - 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. + Applies the constraint to an actual value, returning a ConstraintResult. - The expected Type. - The object under examination - The message to display in case of failure + The value to be tested + A ConstraintResult - + - Asserts that an object may not be assigned a value of a given Type. + Applies the constraint to 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. - The expected Type. - The object under examination + An ActualValueDelegate + A ConstraintResult - + - Asserts that an object is an instance of a given type. + 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. - 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 + A reference to the value to be tested + A ConstraintResult - + - Asserts that an object is an instance of a given type. + Represents a constraint that succeeds if all the + members of a collection match a base constraint. - 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. + Returns a constraint that will apply the argument + to the members of a collection, succeeding if + they all succeed. - The expected Type - The object being examined - + - Asserts that an object is an instance of a given type. + Represents a constraint that succeeds if none of the + members of a collection match a base constraint. - 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. + Returns a constraint that will apply the argument + to the members of a collection, succeeding if + none of them succeed. - 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. + Represents a constraint that succeeds if any of the + members of a collection match a base constraint. - The expected Type - The object being examined - + - Asserts that an object is an instance of a given type. + Returns a constraint that will apply the argument + to the members of a collection, succeeding if + any of them succeed. - 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. + SubPathConstraint tests that the actual path is under the expected path - 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. + Initializes a new instance of the class. - The expected Type - The object being examined + The expected path - + - Asserts that an object is not an instance of a given type. + The Description of what this constraint tests, for + use in messages and in the ConstraintResult. - 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. + Test whether the constraint is satisfied by a given value - The expected Type - The object being examined - The message to display in case of failure + The value to be tested + True for success, false for failure - + - Asserts that an object is not an instance of a given type. + ThrowsExceptionConstraint tests that an exception has + been thrown, without any further tests. - The expected Type - The object being examined - + - Asserts that an object is not an instance of a given type. + The Description of what this constraint tests, for + use in messages and in the ConstraintResult. - 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. + Executes the code and returns success if an exception is thrown. - The expected Type - The object being examined - The message to display in case of failure + A delegate representing the code to be tested + True if an exception is thrown, otherwise false - + - Asserts that an object is not an instance of a given type. + Returns the ActualValueDelegate itself as the value to be tested. - The expected Type - The object being examined + A delegate representing the code to be tested + The delegate itself - + - Asserts that an object is not an instance of a given type. + AllItemsConstraint applies another constraint to each + item in a collection, succeeding if they all succeed. - 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. + Construct an AllItemsConstraint on top of an existing constraint - 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 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. - The expected Type - The object being examined - + - Verifies that the first value is greater than the second - value. If it is not, then an - is thrown. + Apply the item constraint to each item in the collection, + failing if any item fails. - 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. + AndConstraint succeeds only if both members succeed. - 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. + Create an AndConstraint from two other constraints - The first value, expected to be greater - The second value, expected to be less + The first constraint + The second constraint - + - Verifies that the first value is greater than the second - value. If it is not, then an - is thrown. + Gets text describing a constraint - 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. + Apply both member constraints to an actual value, succeeding + succeeding only if both of them succeed. - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure + The actual value + True if the constraints both succeeded - + - Verifies that the first value is greater than the second - value. If it is not, then an + 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 + + + + AssignableFromConstraint is used to test that an object + can be assigned from a given Type. + + + + + Construct an AssignableFromConstraint for the type provided + + + + + + Apply the constraint to an actual value, returning true if it succeeds + + The actual argument + True if the constraint succeeds, otherwise false. + + + + AssignableToConstraint is used to test that an object + can be assigned to a given Type. + + + + + Construct an AssignableToConstraint for the type provided + + + + + + Apply the constraint to an actual value, returning true if it succeeds + + The actual argument + True if the constraint succeeds, otherwise false. + + + + 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. + + + + + Constructs an AttributeConstraint for a specified attribute + Type and base constraint. + + + + + + + Determines whether the Type or other provider has the + expected attribute and if its value matches the + additional constraint specified. + + + + + Returns a string representation of the constraint. + + + + + AttributeExistsConstraint tests for the presence of a + specified attribute on a Type. + + + + + Constructs an AttributeExistsConstraint for a specific attribute Type + + + + + + The Description of what this constraint tests, for + use in messages and in the ConstraintResult. + + + + + Tests whether the object provides the expected attribute. + + A Type, MethodInfo, or other ICustomAttributeProvider + True if the expected attribute is present, otherwise false + + + + 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 + + + + BinarySerializableConstraint tests whether + an object is serializable in binary format. + + + + + The Description of what this constraint tests, for + use in messages and in the ConstraintResult. + + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + Returns the string representation + + + + + 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 + + + + + + + CollectionContainsConstraint is used to test whether a collection + contains an expected object as a member. + + + + + Construct a CollectionContainsConstraint + + + + + + 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. + + + + + The Description of what this constraint tests, for + use in messages and in the ConstraintResult. + + + + + Gets the expected object + + + + + Test whether the expected item is contained in the collection + + + + + + + Flag the constraint to use the supplied predicate function + + The comparison function to use. + Self. + + + + CollectionEquivalentConstraint is used to determine whether two + collections are equivalent. + + + + + Construct a CollectionEquivalentConstraint + + + + + + 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. + + + + + The Description of what this constraint tests, for + use in messages and in the ConstraintResult. + + + + + Test whether two collections are equivalent + + + + + + + Flag the constraint to use the supplied predicate function + + The comparison function to use. + Self. + + + + 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 ignore case and return 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. + + + + Compares two collection members for equality + + + + + Return a new CollectionTally for use in making tests + + The collection to be included in the tally + + + + CollectionOrderedConstraint is used to test whether a collection is ordered. + + + + + Construct a CollectionOrderedConstraint + + + + + 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. + + + + + If used performs a default ascending comparison + + + + + If used performs a reverse comparison + + + + + Modifies the constraint to use an and returns self. + + + + + Modifies the constraint to use an and returns self. + + + + + Modifies the constraint to use a and returns self. + + + + + Modifies the constraint to test ordering by the value of + a specified property and returns self. + + + + + Then signals a break between two ordering steps + + + + + The Description of what this constraint tests, for + use in messages and in the ConstraintResult. + + + + + Test whether the collection is ordered + + + + + + + Returns the string representation of the constraint. + + + + + + An OrderingStep represents one stage of the sort + + + + + 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 + + + + 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. + + + + + The Description of what this constraint tests, for + use in messages and in the ConstraintResult. + + + + + Test whether the actual collection is a subset of + the expected collection provided. + + + + + + + Flag the constraint to use the supplied predicate function + + The comparison function to use. + Self. + + + + CollectionTally counts (tallies) the number of + occurrences of each object in one or more enumerations. + + + + + Construct a CollectionTally object from a comparer and a collection + + + + + The number of objects remaining in the tally + + + + + 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 + + + + ComparisonAdapter class centralizes all comparisons of + _values in NUnit, adapting to the use of any provided + , + or . + + + + + Gets the default ComparisonAdapter, which wraps an + NUnitComparer object. + + + + + Returns a ComparisonAdapter that wraps an + + + + + Returns a ComparisonAdapter that wraps an + + + + + Returns a ComparisonAdapter that wraps a + + + + + Compares two objects + + + + + Construct a default ComparisonAdapter + + + + + Construct a ComparisonAdapter for an + + + + + Compares two objects + + + + + + + + ComparerAdapter extends and + allows use of an or + to actually perform the comparison. + + + + + Construct a ComparisonAdapter for an + + + + + Compare a Type T to an object + + + + + Construct a ComparisonAdapter for a + + + + + 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. + + + + + The value against which a comparison is to be made + + + + + If true, less than returns success + + + + + if true, equal returns success + + + + + if true, greater than returns success + + + + + ComparisonAdapter to be used in making the comparison + + + + + Initializes a new instance of the class. + + The value against which to make a comparison. + if set to true less succeeds. + if set to true equal succeeds. + if set to true greater succeeds. + String used in describing the constraint. + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + Modifies the constraint to use an and returns self + + The comparer used for comparison tests + A constraint modified to use the given comparer + + + + Modifies the constraint to use an and returns self + + The comparer used for comparison tests + A constraint modified to use the given comparer + + + + Modifies the constraint to use a and returns self + + The comparer used for comparison tests + A constraint modified to use the given comparer + + + + Delegate used to delay evaluation of the actual value + to be used in evaluating a constraint + + + + + The Constraint class is the base of all built-in constraints + within NUnit. It provides the operator overloads used to combine + constraints. + + + + + Construct a constraint with optional arguments + + Arguments to be saved + + + + 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. + + + + + The Description of what this constraint tests, for + use in messages and in the ConstraintResult. + + + + + Arguments provided to this Constraint, for use in + formatting the description. + + + + + The ConstraintBuilder holding this constraint + + + + + Applies the constraint to an actual value, returning a ConstraintResult. + + The value to be tested + A ConstraintResult + + + + Applies the constraint to 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 + A ConstraintResult + + + + 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 + A ConstraintResult + + + + Retrieves the value to be tested from an ActualValueDelegate. + The default implementation simply evaluates the delegate but derived + classes may override it to provide for delayed processing. + + An ActualValueDelegate + Delegate evaluation result + + + + 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 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. + + + + + 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. + + + + + Resolves any pending operators and returns the resolved 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 reorganized. a ConstraintStack holds + input constraints as well as the results of each + operator applied. + + + + + OperatorStack is a type-safe stack for holding ConstraintOperators + + + + + Initializes a new instance of the class. + + The ConstraintBuilder using this stack. + + + + Gets a value indicating whether this is empty. + + true if empty; otherwise, false. + + + + Gets the topmost operator without modifying the stack. + + + + + Pushes the specified operator onto the stack. + + The operator to put onto the stack. + + + + Pops the topmost operator from the stack. + + The topmost operator on the stack + + + + ConstraintStack is a type-safe stack for holding Constraints + + + + + Initializes a new instance of the class. + + The ConstraintBuilder using this stack. + + + + Gets a value indicating whether this is empty. + + true if empty; otherwise, false. + + + + Pushes the specified constraint. As a side effect, + the constraint's Builder field is set to the + ConstraintBuilder owning this stack. + + The constraint to put onto the stack + + + + Pops this topmost constraint from the stack. + As a side effect, the constraint's Builder + field is set to null. + + The topmost contraint on the stack + + + + 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 expression 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. + + + + + 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 + reorganized. When a constraint is appended, it is returned as the + value of the operation so that modifiers may be applied. However, + any partially built expression is attached to the constraint for + later resolution. When an operator is appended, the partial + expression is returned. If it's a self-resolving operator, then + a ResolvableConstraintExpression is returned. + + + + + 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. Note that the constraint + is not reduced at this time. For example, if there + is a NotOperator on the stack we don't reduce and + return a NotConstraint. The original constraint must + be returned because it may support modifiers that + are yet to be applied. + + + + + 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 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 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 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. + + + + + With is currently a NOP - reserved for future use. + + + + + 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 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 if item is equal to zero + + + + + 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 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 supplied argument + + + + + Returns a constraint that tests whether the + actual value is greater than or equal to the supplied argument + + + + + Returns a constraint that tests whether the + actual value is greater than or equal to the supplied argument + + + + + Returns a constraint that tests whether the + actual value is less than the supplied argument + + + + + Returns a constraint that tests whether the + actual value is less than or equal to the supplied argument + + + + + Returns a constraint that tests whether the + actual value is less than or equal to the supplied 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 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 tests whether the actual value + is a superset of the collection supplied as an argument. + + + + + Returns a constraint that tests whether a collection is ordered + + + + + 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 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 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 ends with the substring supplied as an argument. + + + + + Returns a constraint that succeeds if the actual + value matches the regular expression supplied as an argument. + + + + + Returns a constraint that succeeds if the actual + value matches the regular expression supplied as an argument. + + + + + Returns a constraint that succeeds if the actual + value matches the regular expression 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 a subpath of the 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 constraint that succeeds if the value + is a file or directory and it exists. + + + + + Helper class with properties and methods that supply + a number of constraints used in Asserts. + + + + + 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 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 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 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 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 equality with zero + + + + + 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 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 supplied argument + + + + + Returns a constraint that tests whether the + actual value is greater than or equal to the supplied argument + + + + + Returns a constraint that tests whether the + actual value is greater than or equal to the supplied argument + + + + + Returns a constraint that tests whether the + actual value is less than the supplied argument + + + + + Returns a constraint that tests whether the + actual value is less than or equal to the supplied argument + + + + + Returns a constraint that tests whether the + actual value is less than or equal to the supplied 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 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 tests whether the actual value + is a superset of the collection supplied as an argument. + + + + + Returns a constraint that tests whether a collection is ordered + + + + + 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 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 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 regular expression supplied as an argument. + + + + + Returns a constraint that succeeds if the actual + value matches the regular expression supplied as an argument. + + + + + Returns a constraint that succeeds if the actual + value matches the regular expression 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 a subpath of the 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. + + + + + 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. + + + + The Description of what this constraint tests, for + use in messages and in the ConstraintResult. + + + + + Flag the constraint to ignore case and return self. + + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + Applies a delay to the match so that a match can be evaluated in the future. + + + + + Creates a new DelayedConstraint + + The inner constraint to 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 to decorate + The time interval after which the match is performed, in milliseconds + The time interval used for polling, in milliseconds + If the value of is less than 0 + + + + Gets text describing a constraint + + + + + 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 + A ConstraintResult + + + + 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 + + + + Returns the string representation of the constraint. + + + + + Adjusts a Timestamp by a given TimeSpan + + + + + + + + Returns the difference between two Timestamps as a TimeSpan + + + + + + + + DictionaryContainsKeyConstraint is used to test whether a dictionary + contains an expected object as a key. + + + + + Construct a DictionaryContainsKeyConstraint + + + + + + 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. + + + + + The Description of what this constraint tests, for + use in messages and in the ConstraintResult. + + + + + Test whether the expected key is contained in the dictionary + + + + + EmptyCollectionConstraint tests whether a collection is empty. + + + + + The Description of what this constraint tests, for + use in messages and in the ConstraintResult. + + + + + Check that the collection is empty + + + + + + + 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. + + + + + The Description of what this constraint tests, for + use in messages and in the ConstraintResult. + + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + EmptyDirectoryConstraint is used to test that a directory is empty + + + + + The Description of what this constraint tests, for + use in messages and in the ConstraintResult. + + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + EmptyStringConstraint tests whether a string is empty. + + + + + The Description of what this constraint tests, for + use in messages and in the ConstraintResult. + + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + 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. + + + + + + + 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. + + + + + NUnitEqualityComparer used to test equality. + + + + + Initializes a new instance of the class. + + The expected value. + + + + Gets the tolerance for this comparison. + + + The tolerance. + + + + + Gets a value indicating whether to compare case insensitive. + + + true if comparing case insensitive; otherwise, false. + + + + + Gets a value indicating whether or not to clip strings. + + + true if set to clip strings otherwise, false. + + + + + Gets the failure points. + + + The failure points. + + + + + 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. + + + + + Flag the constraint to use a tolerance when determining equality. + + Tolerance value to be used + Self. + + + + Flags the constraint to include + property in comparison of two values. + + + Using this modifier does not allow to use the + constraint modifier. + + + + + 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 + + + + 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 + + + + The Description of what this constraint tests, for + use in messages and in the ConstraintResult. + + + + + EqualityAdapter class handles all equality comparisons + that use an , + or a . + + + + + 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 that wraps an . + + + + + that wraps an . + + + + + Returns an that wraps an . + + + + + Returns an EqualityAdapter that uses a predicate function for items comparison. + + + + + + + + + Returns true if the two objects can be compared by this adapter. + The base adapter cannot handle IEnumerables except for strings. + + + + + Compares two objects, returning true if they are equal + + + + + Returns true if the two objects can be compared by this adapter. + Generic adapter requires objects of the specified type. + + + + + Returns an that wraps an . + + + + + Returns an that wraps an . + + + + + that wraps an . + + + + + Returns an that wraps a . + + + + + 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. + + + + 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. + + + + + Apply the constraint to an actual value, returning true if it succeeds + + The actual argument + True if the constraint succeeds, otherwise false. + + + + FalseConstraint tests that the actual value is false + + + + + Initializes a new instance of the class. + + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + 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. + + + + + 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 + + + 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 + + + + + Tests whether a value is greater than the value supplied to its constructor + + + + + Initializes a new instance of the class. + + The expected value. + + + + Tests whether a value is greater than or equal to the value supplied to its constructor + + + + + Initializes a new instance of the class. + + The expected value. + + + + ConstraintStatus represents the status of a ConstraintResult + returned by a Constraint being applied to an actual value. + + + + + The status has not yet been set + + + + + The constraint succeeded + + + + + The constraint failed + + + + + An error occured in applying the constraint (reserved for future use) + + + + + Contain the result of matching a against an actual value. + + + + + Constructs a for a particular . + + The Constraint to which this result applies. + The actual value to which the Constraint was applied. + + + + Constructs a for a particular . + + The Constraint to which this result applies. + The actual value to which the Constraint was applied. + The status of the new ConstraintResult. + + + + Constructs a for a particular . + + The Constraint to which this result applies. + The actual value to which the Constraint was applied. + If true, applies a status of Success to the result, otherwise Failure. + + + + The actual value that was passed to the method. + + + + + Gets and sets the ResultStatus for this result. + + + + + True if actual value meets the Constraint criteria otherwise false. + + + + + Display friendly name of the constraint. + + + + + Description of the constraint may be affected by the state the constraint had + when was performed against the actual value. + + + + + Write the failure message to the MessageWriter provided + as an argument. The default implementation simply passes + the result 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 + + + + 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 + + + + 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 + + + + 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. + + + + + Apply the constraint to an actual value, returning true if it succeeds + + The actual argument + True if the constraint succeeds, otherwise false. + + + + The IResolveConstraint interface is implemented by all + complete and resolvable constraints and expressions. + + + + + Return the top-level constraint for this expression + + + + + + Tests whether a value is less than the value supplied to its constructor + + + + + Initializes a new instance of the class. + + The expected value. + + + + Tests whether a value is less than or equal to the value supplied to its constructor + + + + + Initializes a new instance of the class. + + The expected value. + + + + 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 + + + + + Abstract method to get the max line length + + + + + 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 failing constraint result + + + + 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 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 + + + + Custom value formatter function + + The value + + + + + Custom value formatter factory function + + The next formatter function + ValueFormatter + If the given formatter is unable to handle a certain format, it must call the next formatter in the chain + + + + Static methods used in creating messages + + + + + Static string used when strings are clipped + + + + + Formatting strings used for expected and actual _values + + + + + Current head of chain of value formatters. Public for testing. + + + + + Add a formatter to the chain of responsibility. + + + + + + Formats text to represent a generalized value. + + The value + The formatted text + + + + Formats 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 + + + + 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 + + + + Converts any null 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 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 + + + + NaNConstraint tests that the actual value is a double or float NaN + + + + + The Description of what this constraint tests, for + use in messages and in the ConstraintResult. + + + + + Test that the actual value is an NaN + + + + + + + NoItemConstraint applies another constraint to each + item in a collection, failing if any of them succeeds. + + + + + Construct a SomeItemsConstraint on top of an existing 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. + + + + + Apply the item constraint to each item in the collection, + failing if any item fails. + + + + + + + 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 + + + + NullConstraint tests that the actual value is null + + + + + Initializes a new instance of the class. + + + + + Applies the constraint to an actual value, returning a ConstraintResult. + + The value to be tested + A ConstraintResult + + + + 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. + + + + + Returns the default NUnitComparer. + + + + + Compares two objects + + + + + + + + NUnitEqualityComparer encapsulates NUnit's handling of + equality tests between objects. + + + + + 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. + + + + + List of points at which a failure occurred. + + + + + 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 the list of external comparers to be used to + test for equality. They are applied to members of + collections, in place of NUnit's own logic. + + + + + Gets the list of failure points for the last Match performed. + The list consists of objects to be interpreted by the caller. + This generally means that the caller may only make use of + objects it has placed on the list at a particular depthy. + + + + + Flags the comparer to include + property in comparison of two values. + + + Using this modifier does not allow to use the + modifier. + + + + + 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 + + + + 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 + + + + + Operator that requires both it's arguments to succeed + + + + + Construct an AndOperator + + + + + Apply the operator to produce an AndConstraint + + + + + 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. + + + + + 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. + + + + + + Gets the left precedence of the operator + + + + + Gets the right precedence of the operator + + + + + Abstract method that produces a constraint by applying + the operator to its left and right constraint arguments. + + + + + Abstract base for operators that indicate how to + apply a constraint to items in a collection. + + + + + Constructs a CollectionOperator + + + + + 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. + + + + + The syntax element preceding this operator + + + + + The syntax element following 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. + + + + + 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. + + + + + + Negates the test of the constraint it wraps. + + + + + Constructs a new NotOperator + + + + + Returns a NotConstraint applied to its argument. + + + + + Operator that requires at least one of it's arguments to succeed + + + + + Construct an OrOperator + + + + + Apply the operator to produce an OrConstraint + + + + + 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. + + + + + + + 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. + + + + + Gets the name of the property to which the operator applies + + + + + 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. + + + + + + Abstract base class for operators that are able to reduce to a + constraint whether or not another syntactic element follows. + + + + + 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. + + + + + Represents a constraint that simply wraps the + constraint provided as an argument, without any + further functionality, but which modifies the + order of evaluation because of its precedence. + + + + + Constructor for the WithOperator + + + + + Returns a constraint that wraps its argument + + + + + OrConstraint succeeds if either member succeeds + + + + + Create an OrConstraint from two other constraints + + The first constraint + The second constraint + + + + Gets text describing a 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 + + + + PathConstraint serves as the abstract base of constraints + that operate on paths and provides several helper methods. + + + + + Construct a PathConstraint for a give expected path + + The expected path + + + + Modifies the current instance to be case-sensitive + and returns it. + + + + + Returns the string representation of this constraint + + + + + Canonicalize the provided path + + + The path in standardized form + + + + Test whether one path in canonical form is a subpath of another path + + The first path - supposed to be the parent path + The second path - supposed to be the child path + + + + + Predicate constraint wraps a Predicate in a constraint, + returning success if the predicate is true. + + + + + Construct a PredicateConstraint from a predicate + + + + + Gets text describing a constraint + + + + + Determines whether the predicate succeeds when applied + to the actual value. + + + + + Abstract base class used for prefixes + + + + + The base constraint + + + + + Prefix used in forming the constraint description + + + + + Construct given a base constraint + + + + + + The Description of what this constraint tests, for + use in messages and in the ConstraintResult. + + + + + 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 + + + + Returns the string representation of the constraint. + + + + + + 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 value + of the property. The two constraints are now separate. + + + + + Initializes a new instance of the class. + + The name of the property. + + + + The Description of what this constraint tests, for + use in messages and in the ConstraintResult. + + + + + Test whether the property exists for a given object + + The object to be tested + True for success, false for failure + + + + Returns the string representation of the constraint. + + + + + + RangeConstraint tests whether two _values are within a + specified range. + + + + + Initializes a new instance of the class. + + from must be less than or equal to true + Inclusive beginning of the range. Must be less than or equal to to. + Inclusive end of the range. Must be greater than or equal to from. + + + + Gets text describing a constraint + + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + Modifies the constraint to use an and returns self. + + + + + Modifies the constraint to use an and returns self. + + + + + Modifies the constraint to use a and returns self. + + + + + 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 + + + + 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. + + + + + Appends an And Operator to the expression + + + + + Appends an Or operator to the expression. + + + + + Resolve the current expression to a Constraint + + + + + ReusableConstraint wraps a constraint expression after + resolving it so that it can be reused consistently. + + + + + Construct a ReusableConstraint from a constraint expression + + The expression to be resolved and reused + + + + Converts a constraint to a ReusableConstraint + + The constraint to be converted + A ReusableConstraint + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Return the top-level constraint for this expression + + + + + + SameAsConstraint tests whether an object is identical to + the object passed to its constructor + + + + + Initializes a new instance of the class. + + The expected object. + + + + The Description of what this constraint tests, for + use in messages and in the ConstraintResult. + + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + Summary description for SamePathConstraint. + + + + + Initializes a new instance of the class. + + The expected path + + + + The Description of what this constraint tests, for + use in messages and in the ConstraintResult. + + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + SamePathOrUnderConstraint tests that one path is under another + + + + + Initializes a new instance of the class. + + The expected path + + + + The Description of what this constraint tests, for + use in messages and in the ConstraintResult. + + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + 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 + + + + + + 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. + + + + + Apply the item constraint to each item in the collection, + succeeding if any item succeeds. + + + + + + + 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. + + + + + + + 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 + + + + + Description of this constraint + + + + + The Description of what this constraint tests, for + use in messages and in the ConstraintResult. + + + + + Constructs a StringConstraint without an expected value + + + + + Constructs a StringConstraint given an expected value + + The expected value + + + + Modify the constraint to ignore case in matching. + + + + + 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 a given string + + The string to be tested + True for success, false for failure + + + + 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 + + + + 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. + + + + Get the actual exception thrown - used by Assert.Throws. + + + + + Gets text describing a constraint + + + + + 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 actual value for a failing constraint test to a + MessageWriter. This override only handles the special message + used when an exception is expected but none is thrown. + + The writer on which the actual value is displayed + + + + ThrowsNothingConstraint tests that a delegate does not + throw an exception. + + + + + Gets text describing a constraint + + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True if no exception is thrown, otherwise false + + + + Applies the constraint to 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 + A ConstraintResult + + + + 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. + + + + + Returns a default Tolerance object, equivalent to + specifying an exact match unless + is set, in which case, the + will be used. + + + + + Returns an empty Tolerance object, equivalent to + specifying an exact match even if + is set. + + + + + Constructs a linear tolerance of a specified amount + + + + + Constructs a tolerance given an amount and + + + + + Gets the for the current Tolerance + + + + + Tests that the current Tolerance is linear with a + numeric value, throwing an exception if it is not. + + + + + 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 as the amount, using + the current amount as a number of days. + + + + + Returns a new tolerance with a as the amount, using + the current amount as a number of hours. + + + + + Returns a new tolerance with a as the amount, using + the current amount as a number of minutes. + + + + + Returns a new tolerance with a as the amount, using + the current amount as a number of seconds. + + + + + Returns a new tolerance with a as the amount, using + the current amount as a number of milliseconds. + + + + + Returns a new tolerance with a as the amount, using + the current amount as a number of clock ticks. + + + + + Returns true if the current tolerance has not been set or is using the . + + + + + 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. + + + + + TrueConstraint tests that the actual value is true + + + + + Initializes a new instance of the class. + + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + TypeConstraint is the abstract base for constraints + that take a Type as their expected value. + + + + + The expected Type used by the constraint + + + + + The type of the actual argument to which the constraint was applied + + + + + Construct a TypeConstraint for a given Type + + The expected type for the constraint + Prefix used in forming the constraint description + + + + Applies the constraint to an actual value, returning a ConstraintResult. + + The value to be tested + A ConstraintResult + + + + Apply the constraint to an actual value, returning true if it succeeds + + The actual argument + True if the constraint succeeds, otherwise false. + + + + UniqueItemsConstraint tests whether all the items in a + collection are unique. + + + + + The Description of what this constraint tests, for + use in messages and in the ConstraintResult. + + + + + Check that all items are unique. + + + + + + + XmlSerializableConstraint tests whether + an object is serializable in xml format. + + + + + Gets text describing a constraint + + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + Returns the string representation of this constraint + + + + + ExactCountConstraint 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. + + + + + + + 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. + + + + + ExceptionTypeConstraint is a special version of ExactTypeConstraint + used to provided detailed info about the exception thrown in + an error message. + + + + + Constructs an ExceptionTypeConstraint + + + + + Applies the constraint to an actual value, returning a ConstraintResult. + + The value to be tested + A ConstraintResult + + + + The Assert class contains a collection of static methods that + implement the most common assertions used in NUnit. + + + The Assert class contains a collection of static methods that + implement the most common assertions used in NUnit. + + + + + 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 + + + + Verifies that a delegate throws a particular exception when called. + + The exception Type expected + A TestDelegate + 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 TestDelegate + + + + Verifies that a delegate throws a particular exception when called. + + Type of the expected exception + A TestDelegate + 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 TestDelegate + + + + 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 + + + + 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 + + + + Verifies that a delegate throws an exception of a certain Type + or one derived from it 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 of a certain Type + or one derived from it when called and returns it. + + A TestDelegate + + + + Verifies that a delegate does not throw an exception + + A TestDelegate + 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 TestDelegate + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + Asserts that a condition is true. If the condition is false the method throws + an . + + The evaluated condition + A function to build the message included with the Exception + + + + Asserts that a condition is true. If the condition is false the method throws + an . + + A lambda that returns a Boolean + 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 . + + A lambda that returns a Boolean + + + + Asserts that a condition is true. If the condition is false the method throws + an . + + A lambda that returns a Boolean + A function to build the message included with the Exception + + + + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an assertion exception on failure. + + The Type being compared. + An ActualValueDelegate returning the value to be tested + A Constraint expression to be applied + + + + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an assertion exception on failure. + + The Type being compared. + 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 an actual value, succeeding if the constraint + is satisfied and throwing an assertion exception on failure. + + The Type being compared. + An ActualValueDelegate returning the value to be tested + A Constraint expression to be applied + A function to build the message included with the Exception + + + + 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 + + + + 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 + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + 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 function to build the message included with the Exception + + + + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an assertion exception on failure. + + The Type being compared. + The actual value to test + A Constraint to be applied + + + + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an assertion exception on failure. + + The Type being compared. + The actual value to test + 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 an actual value, succeeding if the constraint + is satisfied and throwing an assertion exception on failure. + + The Type being compared. + The actual value to test + A Constraint expression to be applied + A function to build the message included with the Exception + + + + 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. + + The actual value to test + A Constraint to be applied + + + + 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. + + The actual value to test + A Constraint expression to be applied + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Verifies that the first int is greater than the second + int. 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 int is greater than the second + int. 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + Verifies that the first value is greater than or equal to 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 or equal to 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 or equal to 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 or equal to 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 or equal to 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 or equal to 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 or equal to 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 or equal to 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 or equal to 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 or equal to 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 or equal to 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 or equal to 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 or equal to 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 or equal to 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 or equal to 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 or equal to 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 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 greater - The second value, expected to be less + The first value, expected to be less + The second value, expected to be greater + + + + 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 + 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 + + + + 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 + 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 + + + + 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 + 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 + + + + 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 + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + 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 + + + + Asserts that an int is zero. + + The number to be examined + + + + Asserts that an int is zero. + + The number to be examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that an unsigned int is zero. + + The number to be examined + + + + Asserts that an unsigned int is zero. + + The number to be examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that a Long is zero. + + The number to be examined + + + + Asserts that a Long is zero. + + The number to be examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that an unsigned Long is zero. + + The number to be examined + + + + Asserts that an unsigned Long is zero. + + The number to be examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that a decimal is zero. + + The number to be examined + + + + Asserts that a decimal is zero. + + The number to be examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that a double is zero. + + The number to be examined + + + + Asserts that a double is zero. + + The number to be examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that a float is zero. + + The number to be examined + + + + Asserts that a float is zero. + + The number to be examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that an int is not zero. + + The number to be examined + + + + Asserts that an int is not zero. + + The number to be examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that an unsigned int is not zero. + + The number to be examined + + + + Asserts that an unsigned int is not zero. + + The number to be examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that a Long is not zero. + + The number to be examined + + + + Asserts that a Long is not zero. + + The number to be examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that an unsigned Long is not zero. + + The number to be examined + + + + Asserts that an unsigned Long is not zero. + + The number to be examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that a decimal is zero. + + The number to be examined + + + + Asserts that a decimal is zero. + + The number to be examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that a double is zero. + + The number to be examined + + + + Asserts that a double is zero. + + The number to be examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that a float is zero. + + The number to be examined + + + + Asserts that a float is zero. + + The number to be examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that an int is negative. + + The number to be examined + + + + Asserts that an int is negative. + + The number to be examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that an unsigned int is negative. + + The number to be examined + + + + Asserts that an unsigned int is negative. + + The number to be examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that a Long is negative. + + The number to be examined + + + + Asserts that a Long is negative. + + The number to be examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that an unsigned Long is negative. + + The number to be examined + + + + Asserts that an unsigned Long is negative. + + The number to be examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that a decimal is negative. + + The number to be examined + + + + Asserts that a decimal is negative. + + The number to be examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that a double is negative. + + The number to be examined + + + + Asserts that a double is negative. + + The number to be examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that a float is negative. + + The number to be examined + + + + Asserts that a float is negative. + + The number to be examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that an int is negative. + + The number to be examined + + + + Asserts that an int is negative. + + The number to be examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that an unsigned int is negative. + + The number to be examined + + + + Asserts that an unsigned int is negative. + + The number to be examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that a Long is negative. + + The number to be examined + + + + Asserts that a Long is negative. + + The number to be examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that an unsigned Long is negative. + + The number to be examined + + + + Asserts that an unsigned Long is negative. + + The number to be examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that a decimal is negative. + + The number to be examined + + + + Asserts that a decimal is negative. + + The number to be examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that a double is negative. + + The number to be examined + + + + Asserts that a double is negative. + + The number to be examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that a float is negative. + + The number to be examined + + + + Asserts that a float is negative. + + The number to be examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + 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 InvalidOperationException. This is done + to make sure there is no mistake by calling this function. + + + + + + + override the default ReferenceEquals to throw an InvalidOperationException. This + implementation makes sure there is no mistake in calling this function + as part of Assert. + + + + + + + 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. + + + + + 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 + + + + Class used to guard against unexpected argument values + or operations by throwing an appropriate exception. + + + + + Throws an exception if an argument is null + + The value to be tested + The name of the argument + + + + Throws an exception if a string argument is null or empty + + The value to be tested + The name of the argument + + + + Throws an ArgumentOutOfRangeException if the specified condition is not met. + + The condition that must be met + The exception message to be used + The name of the argument + + + + Throws an ArgumentException if the specified condition is not met. + + The condition that must be met + The exception message to be used + The name of the argument + + + + Throws an InvalidOperationException if the specified condition is not met. + + The condition that must be met + The exception message to be used + + + + Any ITest that implements this interface is at a level that the implementing + class should be disposed at the end of the test run + + + + + The IMethodInfo class is used to encapsulate information + about a method in a platform-independent manner. + + + + + Gets the Type from which this method was reflected. + + + + + Gets the MethodInfo for this method. + + + + + Gets the name of the method. + + + + + Gets a value indicating whether the method is abstract. + + + + + Gets a value indicating whether the method is public. + + + + + Gets a value indicating whether the method contains unassigned generic type parameters. + + + + + Gets a value indicating whether the method is a generic method. + + + + + Gets a value indicating whether the MethodInfo represents the definition of a generic method. + + + + + Gets the return Type of the method. + + + + + Gets the parameters of the method. + + + + + + Returns the Type arguments of a generic method or the Type parameters of a generic method definition. + + + + + Replaces the type parameters of the method with the array of types provided and returns a new IMethodInfo. + + The type arguments to be used + A new IMethodInfo with the type arguments replaced + + + + Invokes the method, converting any TargetInvocationException to an NUnitException. + + The object on which to invoke the method + The argument list for the method + The return value from the invoked method + + + + The IParameterInfo interface is an abstraction of a .NET parameter. + + + + + Gets a value indicating whether the parameter is optional + + + + + Gets an IMethodInfo representing the method for which this is a parameter + + + + + Gets the underlying .NET ParameterInfo + + + + + Gets the Type of the parameter + + + + + The IReflectionInfo interface is implemented by NUnit wrapper objects that perform reflection. + + + + + Returns an array of custom attributes of the specified type applied to this object + + + + + Returns a value indicating whether an attribute of the specified type is defined on this object. + + + + + The ITypeInfo interface is an abstraction of a .NET Type + + + + + Gets the underlying Type on which this ITypeInfo is based + + + + + Gets the base type of this type as an ITypeInfo + + + + + Returns true if the Type wrapped is equal to the argument + + + + + Gets the Name of the Type + + + + + Gets the FullName of the Type + + + + + Gets the assembly in which the type is declared + + + + + Gets the Namespace of the Type + + + + + Gets a value indicating whether the type is abstract. + + + + + Gets a value indicating whether the Type is a generic Type + + + + + Gets a value indicating whether the Type has generic parameters that have not been replaced by specific Types. + + + + + Gets a value indicating whether the Type is a generic Type definition + + + + + Gets a value indicating whether the type is sealed. + + + + + Gets a value indicating whether this type is a static class. + + + + + Get the display name for this typeInfo. + + + + + Get the display name for an oject of this type, constructed with specific arguments + + + + + Returns a Type representing a generic type definition from which this Type can be constructed. + + + + + Returns a new ITypeInfo representing an instance of this generic Type using the supplied Type arguments + + + + + Returns a value indicating whether this type has a method with a specified public attribute + + + + + Returns an array of IMethodInfos for methods of this Type + that match the specified flags. + + + + + Gets the public constructor taking the specified argument Types + + + + + Returns a value indicating whether this Type has a public constructor taking the specified argument Types. + + + + + Construct an object of this Type, using the specified arguments. + + + + + The TestOutput class holds a unit of output from + a test to a specific output stream + + + + + Construct with text, ouput destination type and + the name of the test that produced the output. + + Text to be output + Name of the stream or channel to which the text should be written + FullName of test that produced the output + + + + Return string representation of the object for debugging + + + + + + Get the text + + + + + Get the output type + + + + + Get the name of the test that created the output + + + + + Convert the TestOutput object to an XML string + + + + + CombiningStrategy is the abstract base for classes that + know how to combine values provided for individual test + parameters to create a set of test cases. + + + + + Gets the test cases generated by the CombiningStrategy. + + The test cases. + + + + The ISimpleTestBuilder interface is exposed by a class that knows how to + build a single TestMethod from a suitable MethodInfo Types. In general, + it is exposed by an attribute, but may be implemented in a helper class + used by the attribute in some cases. + + + + + Build a TestMethod from the provided MethodInfo. + + The method to be used as a test + The TestSuite to which the method will be added + A TestMethod object + + + + The ITestBuilder interface is exposed by a class that knows how to + build one or more TestMethods from a MethodInfo. In general, it is exposed + by an attribute, which has additional information available to provide + the necessary test parameters to distinguish the test cases built. + + + + + Build one or more TestMethods from the provided MethodInfo. + + The method to be used as a test + The TestSuite to which the method will be added + A TestMethod object + + + + The IDataPointProvider interface is used by extensions + that provide data for a single test parameter. + + + + + Determine whether any data is available for a parameter. + + An IParameterInfo representing one + argument to a parameterized test + True if any data is available, otherwise false. + + + + Return an IEnumerable providing data for use with the + supplied parameter. + + An IParameterInfo representing one + argument to a parameterized test + An IEnumerable providing the required data + + + + The IParameterDataSource interface is implemented by types + that can provide data for a test method parameter. + + + + + Gets an enumeration of data items for use as arguments + for a test method parameter. + + The parameter for which data is needed + An enumeration containing individual data items + + + + A PropertyBag represents a collection of name/value pairs + that allows duplicate entries with the same key. Methods + are provided for adding a new pair as well as for setting + a key to a single value. All keys are strings but _values + may be of any type. Null _values are not permitted, since + a null entry represents the absence of the key. + + The entries in a PropertyBag are of two kinds: those that + take a single value and those that take multiple _values. + However, the PropertyBag has no knowledge of which entries + fall into each category and the distinction is entirely + up to the code using the PropertyBag. + + When working with multi-valued properties, client code + should use the Add method to add name/value pairs and + indexing to retrieve a list of all _values for a given + key. For example: + + bag.Add("Tag", "one"); + bag.Add("Tag", "two"); + Assert.That(bag["Tag"], + Is.EqualTo(new string[] { "one", "two" })); + + When working with single-valued propeties, client code + should use the Set method to set the value and Get to + retrieve the value. The GetSetting methods may also be + used to retrieve the value in a type-safe manner while + also providing default. For example: + + bag.Set("Priority", "low"); + bag.Set("Priority", "high"); // replaces value + Assert.That(bag.Get("Priority"), + Is.EqualTo("high")); + Assert.That(bag.GetSetting("Priority", "low"), + Is.EqualTo("high")); + + + + + Adds a key/value pair to the property bag + + The key + The value + + + + Sets the value for a key, removing any other + _values that are already in the property set. + + + + + + + Gets a single value for a key, using the first + one if multiple _values are present and returning + null if the value is not found. + + + + + Gets a flag indicating whether the specified key has + any entries in the property set. + + The key to be checked + True if their are _values present, otherwise false + + + + Gets or sets the list of _values for a particular key + + The key for which the _values are to be retrieved or set + + + + Gets a collection containing all the keys in the property set + + + + + Common interface supported by all representations + of a test. Only includes informational fields. + The Run method is specifically excluded to allow + for data-only representations of a test. + + + + + Gets the id of the test + + + + + Gets the name of the test + + + + + Gets the fully qualified name of the test + + + + + Gets the name of the class containing this test. Returns + null if the test is not associated with a class. + + + + + Gets the name of the method implementing this test. + Returns null if the test is not implemented as a method. + + + + + Gets the Type of the test fixture, if applicable, or + null if no fixture type is associated with this test. + + + + + Gets an IMethod for the method implementing this test. + Returns null if the test is not implemented as a method. + + + + + Gets the RunState of the test, indicating whether it can be run. + + + + + Count of the test cases ( 1 if this is a test case ) + + + + + Gets the properties of the test + + + + + Gets the parent test, if any. + + The parent test or null if none exists. + + + + Returns true if this is a test suite + + + + + Gets a bool indicating whether the current test + has any descendant tests. + + + + + Gets this test's child tests + + A list of child tests + + + + Gets a fixture object for running this test. + + + + + The ITestData interface is implemented by a class that + represents a single instance of a parameterized test. + + + + + Gets the name to be used for the test + + + + + Gets the RunState for this test case. + + + + + Gets the argument list to be provided to the test + + + + + Gets the property dictionary for the test case + + + + + The ITestCaseData interface is implemented by a class + that is able to return the data required to create an + instance of a parameterized test fixture. + + + + + Get the TypeArgs if separately set + + + + + The ITestCaseData interface is implemented by a class + that is able to return complete testcases for use by + a parameterized test method. + + + + + Gets the expected result of the test case + + + + + Returns true if an expected result has been set + + + + + Interface to be implemented by filters applied to tests. + The filter applies when running the test, after it has been + loaded, since this is the only time an ITest exists. + + + + + Determine if a particular test passes the filter criteria. Pass + may examine the parents and/or descendants of a test, depending + on the semantics of the particular filter + + The test to which the filter is applied + True if the test passes the filter, otherwise false + + + + Determine if a test matches the filter expicitly. That is, it must + be a direct match of the test itself or one of it's children. + + The test to which the filter is applied + True if the test matches the filter explicityly, otherwise false + + + + The ITestListener interface is used internally to receive + notifications of significant events while a test is being + run. The events are propagated to clients by means of an + AsyncCallback. NUnit extensions may also monitor these events. + + + + + Called when a test has just started + + The test that is starting + + + + Called when a test has finished + + The result of the test + + + + Called when a test produces output for immediate display + + A TestOutput object containing the text to display + + + + The ITestResult interface represents the result of a test. + + + + + Gets the ResultState of the test result, which + indicates the success or failure of the test. + + + + + Gets the name of the test result + + + + + Gets the full name of the test result + + + + + Gets the elapsed time for running the test in seconds + + + + + Gets or sets the time the test started running. + + + + + Gets or sets the time the test finished running. + + + + + Gets the message associated with a test + failure or with not running the test + + + + + Gets any stacktrace associated with an + error or failure. Not available in + the Compact Framework 1.0. + + + + + Gets the number of asserts executed + when running the test and all its children. + + + + + Gets the number of test cases that failed + when running the test and all its children. + + + + + Gets the number of test cases that passed + when running the test and all its children. + + + + + Gets the number of test cases that were skipped + when running the test and all its children. + + + + + Gets the number of test cases that were inconclusive + when running the test and all its children. + + + + + Indicates whether this result has any child results. + Accessing HasChildren should not force creation of the + Children collection in classes implementing this interface. + + + + + Gets the the collection of child results. + + + + + Gets the Test to which this result applies. + + + + + Gets any text output written to this result. + + + + + An object implementing IXmlNodeBuilder is able to build + an XML representation of itself and any children. + + + + + Returns a TNode representing the current object. + + If true, children are included where applicable + A TNode representing the result + + + + Returns a TNode representing the current object after + adding it as a child of the supplied parent node. + + The parent node. + If true, children are included, where applicable + + + + + The ResultState class represents the outcome of running a test. + It contains two pieces of information. The Status of the test + is an enum indicating whether the test passed, failed, was + skipped or was inconclusive. The Label provides a more + detailed breakdown for use by client runners. + + + + + Initializes a new instance of the class. + + The TestStatus. + + + + Initializes a new instance of the class. + + The TestStatus. + The label. + + + + Initializes a new instance of the class. + + The TestStatus. + The stage at which the result was produced - + - Verifies that the first value is greater than the second - value. If it is not, then an - is thrown. + Initializes a new instance of the class. - 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 + The TestStatus. + The label. + The stage at which the result was produced - + - Verifies that the first value is greater than the second - value. If it is not, then an - is thrown. + The result is inconclusive - 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 test has been skipped. - 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 test has been ignored. - 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 test was skipped because it is explicit - 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 test succeeded - 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 test failed - 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 test encountered an unexpected exception - 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 test was cancelled by the user - 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 test was not runnable. - 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. + A suite failed because one or more child tests failed or had errors - 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. + A suite failed in its OneTimeSetUp + + + + + A suite had an unexpected exception in its OneTimeSetUp + + + + + A suite had an unexpected exception in its OneTimeDown + + + + + Gets the TestStatus for the test. + + The status. + + + + Gets the label under which this test result is + categorized, if any. + + + + + Gets the stage of test execution in which + the failure or other result took place. + + + + + Get a new ResultState, which is the same as the current + one but with the FailureSite set to the specified value. + + The FailureSite to use + A new ResultState + + + + 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. + + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + The FailureSite enum indicates the stage of a test + in which an error or failure occurred. + + + + + Failure in the test itself + + + + + Failure in the SetUp method + + + + + Failure in the TearDown method + + + + + Failure of a parent test + + + + + Failure of a child test + + + + + The RunState enum indicates whether a test can be executed. + + + + + The test is not runnable. + + + + + The test is runnable. + + + + + The test can only be run explicitly + + + + + The test has been skipped. This value may + appear on a Test when certain attributes + are used to skip the test. + + + + + The test has been ignored. May appear on + a Test, when the IgnoreAttribute is used. + + + + + The TestStatus enum indicates the result of running a test + + + + + The test was inconclusive + + + + + The test has skipped + + + + + The test succeeded + + + + + The test failed + + + + + TNode represents a single node in the XML representation + of a Test or TestResult. It replaces System.Xml.XmlNode and + System.Xml.Linq.XElement, providing a minimal set of methods + for operating on the XML in a platform-independent manner. + + + + + Constructs a new instance of TNode + + The name of the node + + + + Constructs a new instance of TNode with a value + + The name of the node + The text content of the node + + + + Constructs a new instance of TNode with a value + + The name of the node + The text content of the node + Flag indicating whether to use CDATA when writing the text + + + + Gets the name of the node + + + + + Gets the value of the node + + + + + Gets a flag indicating whether the value should be output using CDATA. + + + + + Gets the dictionary of attributes + + + + + Gets a list of child nodes + + + + + Gets the first ChildNode + + + + + Gets the XML representation of this node. + + + + + Create a TNode from it's XML text representation + + The XML text to be parsed + A TNode + + + + Adds a new element as a child of the current node and returns it. + + The element name. + The newly created child element + + + + Adds a new element with a value as a child of the current node and returns it. + + The element name + The text content of the new element + The newly created child element + + + + Adds a new element with a value as a child of the current node and returns it. + The value will be output using a CDATA section. + + The element name + The text content of the new element + The newly created child element + + + + Adds an attribute with a specified name and value to the XmlNode. + + The name of the attribute. + The value of the attribute. + + + + Finds a single descendant of this node matching an xpath + specification. The format of the specification is + limited to what is needed by NUnit and its tests. + + + + + + + Finds all descendants of this node matching an xpath + specification. The format of the specification is + limited to what is needed by NUnit and its tests. + + + + + Writes the XML representation of the node to an XmlWriter + + + + + + Class used to represent a list of XmlResults + + + + + Class used to represent the attributes of a node + + + + + Gets or sets the value associated with the specified key. + Overridden to return null if attribute is not found. + + The key. + Value of the attribute or null + + + + The IFixtureBuilder interface is exposed by a class that knows how to + build a TestFixture from one or more Types. In general, it is exposed + by an attribute, but may be implemented in a helper class used by the + attribute in some cases. + + + + + Build one or more TestFixtures from type provided. At least one + non-null TestSuite must always be returned, since the method is + generally called because the user has marked the target class as + a fixture. If something prevents the fixture from being used, it + will be returned nonetheless, labelled as non-runnable. + + The type info of the fixture to be used. + A TestSuite object or one derived from TestSuite. + + + + IImplyFixture is an empty marker interface used by attributes like + TestAttribute that cause the class where they are used to be treated + as a TestFixture even without a TestFixtureAttribute. + + Marker interfaces are not usually considered a good practice, but + we use it here to avoid cluttering the attribute hierarchy with + classes that don't contain any extra implementation. - 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 IApplyToContext interface is implemented by attributes + that want to make changes to the execution context before + a test is run. - 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. + Apply changes to the execution context - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure + The execution context - + - Verifies that the first value is greater than the second - value. If it is not, then an - is thrown. + The IApplyToTest interface is implemented by self-applying + attributes that modify the state of a test in some way. - 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. + Modifies a test as defined for the specific attribute. - 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 + The test to modify - + - Verifies that the first value is greater than the second - value. If it is not, then an - is thrown. + The ISuiteBuilder interface is exposed by a class that knows how to + build a suite from one or more Types. - 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. + Examine the type and determine if it is suitable for + this builder to use in building a TestSuite. + + Note that returning false will cause the type to be ignored + in loading the tests. If it is desired to load the suite + but label it as non-runnable, ignored, etc., then this + method must return true. - The first value, expected to be greater - The second value, expected to be less + The type of the fixture to be used + True if the type can be used to build a TestSuite - + - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. + Build a TestSuite from type provided. - 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 + The type of the fixture to be used + A TestSuite - + - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. + The ITestCaseBuilder interface is exposed by a class that knows how to + build a test case from certain methods. - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure + + This interface is not the same as the ITestCaseBuilder interface in NUnit 2.x. + We have reused the name because the two products don't interoperate at all. + - + - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. + Examine the method and determine if it is suitable for + this builder to use in building a TestCase to be + included in the suite being populated. + + Note that returning false will cause the method to be ignored + in loading the tests. If it is desired to load the method + but label it as non-runnable, ignored, etc., then this + method must return true. - The first value, expected to be less - The second value, expected to be greater + The test method to examine + The suite being populated + True is the builder can use this method - + - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. + Build a TestCase from the provided MethodInfo for + inclusion in the suite being constructed. - 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 + The method to be used as a test case + The test suite being populated, or null + A TestCase or null - + - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. + ICommandWrapper is implemented by attributes and other + objects able to wrap a TestCommand with another command. - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure + + Attributes or other objects should implement one of the + derived interfaces, rather than this one, since they + indicate in which part of the command chain the wrapper + should be applied. + - + - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. + Wrap a command and return the result. - The first value, expected to be less - The second value, expected to be greater + The command to be wrapped + The wrapped command - + - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. + Objects implementing this interface are used to wrap + the TestMethodCommand itself. They apply after SetUp + has been run and before TearDown. - 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. + Objects implementing this interface are used to wrap + the entire test, including SetUp and TearDown. - 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. + AssemblyHelper provides static methods for working + with assemblies. - 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. + Gets the path from which an assembly was loaded. + For builds where this is not possible, returns + the name of the assembly. - 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 + The assembly. + The path. - + - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. + Gets the path to the directory from which an assembly was loaded. - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure + The assembly. + The path. - + - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. + Gets the AssemblyName of an assembly. - The first value, expected to be less - The second value, expected to be greater + The assembly + An AssemblyName - + - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. + Loads an assembly given a string, which may be the + path to the assembly or the AssemblyName - 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. + Gets the assembly path from code base. - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure + Public for testing purposes + The code base. + - + - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. + The ParameterDataProvider class implements IParameterDataProvider + and hosts one or more individual providers. - 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. + Construct with a collection of individual providers - 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. + Determine whether any data is available for a parameter. - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure + An IParameterInfo representing one + argument to a parameterized test + True if any data is available, otherwise false. - + - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. + Return an IEnumerable providing data for use with the + supplied parameter. - The first value, expected to be less - The second value, expected to be greater + An IParameterInfo representing one + argument to a parameterized test + An IEnumerable providing the required data - + - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. + Built-in SuiteBuilder for all types of test classes. - 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. + Checks to see if the provided Type is a fixture. + To be considered a fixture, it must be a non-abstract + class with one or more attributes implementing the + IFixtureBuilder interface or one or more methods + marked as tests. - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure + The fixture type to check + True if the fixture can be built, false if not - + - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. + Build a TestSuite from TypeInfo provided. - The first value, expected to be less - The second value, expected to be greater + The fixture type to build + A TestSuite built from that type - + - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. + We look for attributes implementing IFixtureBuilder at one level + of inheritance at a time. Attributes on base classes are not used + unless there are no fixture builder attributes at all on the derived + class. This is by design. - 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 + The type being examined for attributes + A list of the attributes found. - + - Verifies that the first value is less than the second - value. If it is not, then an - is thrown. + NUnitTestCaseBuilder is a utility class used by attributes + that build test cases. - 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. + Constructs an - 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. + Builds a single NUnitTestMethod, either as a child of the fixture + or as one of a set of test cases under a ParameterizedTestMethodSuite. - 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 + The MethodInfo from which to construct the TestMethod + The suite or fixture to which the new test will be added + The ParameterSet to be used, or null + + + + + Helper method that checks the signature of a TestMethod and + any supplied parameters to determine if the test is valid. + + Currently, NUnitTestMethods are required to be public, + non-abstract methods, either static or instance, + returning void. They may take arguments but the _values must + be provided or the TestMethod is not considered runnable. + + Methods not meeting these criteria will be marked as + non-runnable and the method will return false in that case. + + The TestMethod to be checked. If it + is found to be non-runnable, it will be modified. + Parameters to be used for this test, or null + True if the method signature is valid, false if not + + The return value is no longer used internally, but is retained + for testing purposes. + - + - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. + Class that can build a tree of automatic namespace + suites from a group of fixtures. - 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. + NamespaceDictionary of all test suites we have created to represent + namespaces. Used to locate namespace parent suites for fixtures. - 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 root of the test suite being created by this builder. - 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. + Initializes a new instance of the class. - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure + The root suite. - + - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. + Gets the root entry in the tree created by the NamespaceTreeBuilder. - The first value, expected to be greater - The second value, expected to be less + The root suite. - + - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. + Adds the specified fixtures to the tree. - 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 + The fixtures to be added. - + - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. + Adds the specified fixture to the tree. - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure + The fixture to be added. - + - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. + CombinatorialStrategy creates test cases by using all possible + combinations of the parameter data. - 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. + Gets the test cases generated by the CombiningStrategy. - 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 + The test cases. - + - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. + Provides data from fields marked with the DatapointAttribute or the + DatapointsAttribute. - 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. + Determine whether any data is available for a parameter. - The first value, expected to be greater - The second value, expected to be less + A ParameterInfo representing one + argument to a parameterized test + + True if any data is available, otherwise false. + - + - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. + Return an IEnumerable providing data for use with the + supplied parameter. - 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 + A ParameterInfo representing one + argument to a parameterized test + + An IEnumerable providing the required data + - + - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. + Class to build ether a parameterized or a normal NUnitTestMethod. + There are four cases that the builder must deal with: + 1. The method needs no params and none are provided + 2. The method needs params and they are provided + 3. The method needs no params but they are provided in error + 4. The method needs params but they are not provided + This could have been done using two different builders, but it + turned out to be simpler to have just one. The BuildFrom method + takes a different branch depending on whether any parameters are + provided, but all four cases are dealt with in lower-level methods - 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. + Determines if the method can be used to build an NUnit test + test method of some kind. The method must normally be marked + with an identifying attribute for this to be true. + + Note that this method does not check that the signature + of the method for validity. If we did that here, any + test methods with invalid signatures would be passed + over in silence in the test run. Since we want such + methods to be reported, the check for validity is made + in BuildFrom rather than here. - The first value, expected to be greater - The second value, expected to be less + An IMethodInfo for the method being used as a test method + True if the builder can create a test case from this method - + - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. + Build a Test from the provided MethodInfo. Depending on + whether the method takes arguments and on the availability + of test case data, this method may return a single test + or a group of tests contained in a ParameterizedMethodSuite. - 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 + The method for which a test is to be built + A Test representing one or more method invocations - + - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. + Determines if the method can be used to build an NUnit test + test method of some kind. The method must normally be marked + with an identifying attribute for this to be true. + + Note that this method does not check that the signature + of the method for validity. If we did that here, any + test methods with invalid signatures would be passed + over in silence in the test run. Since we want such + methods to be reported, the check for validity is made + in BuildFrom rather than here. - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure + An IMethodInfo for the method being used as a test method + The test suite being built, to which the new test would be added + True if the builder can create a test case from this method - + - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. + Build a Test from the provided MethodInfo. Depending on + whether the method takes arguments and on the availability + of test case data, this method may return a single test + or a group of tests contained in a ParameterizedMethodSuite. - The first value, expected to be greater - The second value, expected to be less + The method for which a test is to be built + The test fixture being populated, or null + A Test representing one or more method invocations - + - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. + Builds a ParameterizedMethodSuite containing individual test cases. - 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 + The method for which a test is to be built. + The list of test cases to include. + A ParameterizedMethodSuite populated with test cases - + - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. + Build a simple, non-parameterized TestMethod for this method. - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure + The MethodInfo for which a test is to be built + The test suite for which the method is being built + A TestMethod. - + - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. + NUnitTestFixtureBuilder is able to build a fixture given + a class marked with a TestFixtureAttribute or an unmarked + class containing test methods. In the first case, it is + called by the attribute and in the second directly by + NUnitSuiteBuilder. - 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. + Build a TestFixture from type provided. A non-null TestSuite + must always be returned, since the method is generally called + because the user has marked the target class as a fixture. + If something prevents the fixture from being used, it should + be returned nonetheless, labelled as non-runnable. - 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 + An ITypeInfo for the fixture to be used. + A TestSuite object or one derived from TestSuite. - + - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. + Overload of BuildFrom called by tests that have arguments. + Builds a fixture using the provided type and information + in the ITestFixtureData object. - The first value, expected to be greater - The second value, expected to be less - The message to display in case of failure + The TypeInfo for which to construct a fixture. + An object implementing ITestFixtureData or null. + - + - Verifies that the first value is greater than or equal tothe second - value. If it is not, then an - is thrown. + Method to add test cases to the newly constructed fixture. - The first value, expected to be greater - The second value, expected to be less + The fixture to which cases should be added - + - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. + Method to create a test case from a MethodInfo and add + it to the fixture being built. It first checks to see if + any global TestCaseBuilder addin wants to build the + test case. If not, it uses the internal builder + collection maintained by this fixture builder. + + The default implementation has no test case builders. + Derived classes should add builders to the collection + in their constructor. - 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 + The method for which a test is to be created + The test suite being built. + A newly constructed Test - + - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. + PairwiseStrategy creates test cases by combining the parameter + data so that all possible pairs of data items are used. - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure + + + The number of test cases that cover all possible pairs of test function + parameters values is significantly less than the number of test cases + that cover all possible combination of test function parameters values. + And because different studies show that most of software failures are + caused by combination of no more than two parameters, pairwise testing + can be an effective ways to test the system when it's impossible to test + all combinations of parameters. + + + The PairwiseStrategy code is based on "jenny" tool by Bob Jenkins: + http://burtleburtle.net/bob/math/jenny.html + + - + - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. + FleaRand is a pseudo-random number generator developed by Bob Jenkins: + http://burtleburtle.net/bob/rand/talksmall.html#flea - 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. + Initializes a new instance of the FleaRand class. - 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 + The seed. - + - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. + FeatureInfo represents coverage of a single value of test function + parameter, represented as a pair of indices, Dimension and Feature. In + terms of unit testing, Dimension is the index of the test parameter and + Feature is the index of the supplied value in that parameter's list of + sources. - 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. + Initializes a new instance of FeatureInfo class. - The first value, expected to be less - The second value, expected to be greater + Index of a dimension. + Index of a feature. - + - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. + A FeatureTuple represents a combination of features, one per test + parameter, which should be covered by a test case. In the + PairwiseStrategy, we are only trying to cover pairs of features, so the + tuples actually may contain only single feature or pair of features, but + the algorithm itself works with triplets, quadruples and so on. - 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. + Initializes a new instance of FeatureTuple class for a single feature. - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure + Single feature. - + - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. + Initializes a new instance of FeatureTuple class for a pair of features. - The first value, expected to be less - The second value, expected to be greater + First feature. + Second feature. - + - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. + TestCase represents a single test case covering a list of features. - 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. + Initializes a new instance of TestCaseInfo class. - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure + A number of features in the test case. - + - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. + PairwiseTestCaseGenerator class implements an algorithm which generates + a set of test cases which covers all pairs of possible values of test + function. - The first value, expected to be less - The second value, expected to be greater + + + The algorithm starts with creating a set of all feature tuples which we + will try to cover (see method). This set + includes every single feature and all possible pairs of features. We + store feature tuples in the 3-D collection (where axes are "dimension", + "feature", and "all combinations which includes this feature"), and for + every two feature (e.g. "A" and "B") we generate both ("A", "B") and + ("B", "A") pairs. This data structure extremely reduces the amount of + time needed to calculate coverage for a single test case (this + calculation is the most time-consuming part of the algorithm). + + + Then the algorithm picks one tuple from the uncovered tuple, creates a + test case that covers this tuple, and then removes this tuple and all + other tuples covered by this test case from the collection of uncovered + tuples. + + + Picking a tuple to cover + + + There are no any special rules defined for picking tuples to cover. We + just pick them one by one, in the order they were generated. + + + Test generation + + + Test generation starts from creating a completely random test case which + covers, nevertheless, previously selected tuple. Then the algorithm + tries to maximize number of tuples which this test covers. + + + Test generation and maximization process repeats seven times for every + selected tuple and then the algorithm picks the best test case ("seven" + is a magic number which provides good results in acceptable time). + + Maximizing test coverage + + To maximize tests coverage, the algorithm walks thru the list of mutable + dimensions (mutable dimension is a dimension that are not included in + the previously selected tuple). Then for every dimension, the algorithm + walks thru the list of features and checks if this feature provides + better coverage than randomly selected feature, and if yes keeps this + feature. + + + This process repeats while it shows progress. If the last iteration + doesn't improve coverage, the process ends. + + + In addition, for better results, before start every iteration, the + algorithm "scrambles" dimensions - so for every iteration dimension + probes in a different order. + + - + - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. + Creates a set of test cases for specified dimensions. - 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 + + An array which contains information about dimensions. Each element of + this array represents a number of features in the specific dimension. + + + A set of test cases. + - + - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. + Gets the test cases generated by this strategy instance. - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure + A set of test cases. - + - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. + ParameterDataSourceProvider supplies individual argument _values for + single parameters using attributes implementing IParameterDataSource. - 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. + Determine whether any data is available for a parameter. - 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 + A ParameterInfo representing one + argument to a parameterized test + + True if any data is available, otherwise false. + - + - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. + Return an IEnumerable providing data for use with the + supplied parameter. - The first value, expected to be less - The second value, expected to be greater - The message to display in case of failure + An IParameterInfo representing one + argument to a parameterized test + + An IEnumerable providing the required data + - + - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. + SequentialStrategy creates test cases by using all of the + parameter data sources in parallel, substituting null + when any of them run out of data. - 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. + Gets the test cases generated by the CombiningStrategy. - 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 + The test cases. - + - Verifies that the first value is less than or equal to the second - value. If it is not, then an - is thrown. + EventListenerTextWriter sends text output to the currently active + ITestEventListener in the form of a TestOutput object. If no event + listener is active in the contet, or if there is no context, + the output is forwarded to the supplied default writer. - 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. + Construct an EventListenerTextWriter + + The name of the stream to use for events + The default writer to use if no listener is available + + + + Write a single char - 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. + Write a string - 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. + Write a string followed by a newline - 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. + Get the Encoding for this TextWriter - The first value, expected to be less - The second value, expected to be greater - + - Asserts that an object is contained in a list. + A utility class to create TestCommands - 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. + Gets the command to be executed before any of + the child tests are run. - The expected object - The list to be examined - The message to display in case of failure + A TestCommand - + - Asserts that an object is contained in a list. + Gets the command to be executed after all of the + child tests are run. - The expected object - The list to be examined + A TestCommand - + - Helper for Assert.AreEqual(double expected, double actual, ...) - allowing code generation to work consistently. + Creates a test command for use in running this test. - 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 + - + - Gets the number of assertions executed so far and - resets the counter to zero. + Creates a command for skipping a test. The result returned will + depend on the test RunState. - + - 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. + Builds the set up tear down list. + Type of the fixture. + Type of the set up attribute. + Type of the tear down attribute. + A list of SetUpTearDownItems - + - Helper class with properties and methods that supply - a number of constraints used in Asserts. + An IWorkItemDispatcher handles execution of work items. - + - Returns a ConstraintExpression, which will apply - the following constraint to all members of a collection, - succeeding only if a specified number of them succeed. + Dispatch a single work item for execution. The first + work item dispatched is saved as the top-level + work item and used when stopping the run. + The item to dispatch - + - 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. + Cancel the ongoing run completely. + If no run is in process, the call has no effect. + true if the IWorkItemDispatcher should abort all currently running WorkItems, false if it should allow all currently running WorkItems to complete - + - Returns a new AttributeConstraint checking for the - presence of a particular attribute on an object. + SimpleWorkItemDispatcher handles execution of WorkItems by + directly executing them. It is provided so that a dispatcher + is always available in the context, thereby simplifying the + code needed to run child tests. - + - Returns a new AttributeConstraint checking for the - presence of a particular attribute on an object. + Dispatch a single work item for execution. The first + work item dispatched is saved as the top-level + work item and a thread is created on which to + run it. Subsequent calls come from the top level + item or its descendants on the proper thread. + The item to dispatch - + - Returns a constraint that tests two items for equality + Cancel (abort or stop) the ongoing run. + If no run is in process, the call has no effect. + true if the run should be aborted, false if it should allow its currently running test to complete - + - Returns a constraint that tests that two references are the same object + The TextCapture class intercepts console output and writes it + to the current execution context, if one is present on the thread. + If no execution context is found, the output is written to a + default destination, normally the original destination of the + intercepted output. - + - Returns a constraint that tests whether the - actual value is greater than the suppled argument + Construct a TextCapture object + The default destination for non-intercepted output - + - Returns a constraint that tests whether the - actual value is greater than or equal to the suppled argument + Gets the Encoding in use by this TextWriter - + - Returns a constraint that tests whether the - actual value is greater than or equal to the suppled argument + Writes a single character + The char to write - + - Returns a constraint that tests whether the - actual value is less than the suppled argument + Writes a string + The string to write - + - Returns a constraint that tests whether the - actual value is less than or equal to the suppled argument + Writes a string followed by a line terminator + The string to write - + - Returns a constraint that tests whether the - actual value is less than or equal to the suppled argument + A CompositeWorkItem represents a test suite and + encapsulates the execution of the suite as well + as all its child tests. - + - Returns a constraint that tests whether the actual - value is of the exact type supplied as an argument. + List of Child WorkItems - + - Returns a constraint that tests whether the actual - value is of the exact type supplied as an argument. + A count of how many tests in the work item have a value for the Order Property - + - Returns a constraint that tests whether the actual value - is of the type supplied as an argument or a derived type. + Construct a CompositeWorkItem for executing a test suite + using a filter to select child tests. + The TestSuite to be executed + A filter used to select child tests - + - Returns a constraint that tests whether the actual value - is of the type supplied as an argument or a derived type. + Method that actually performs the work. Overridden + in CompositeWorkItem to do setup, run all child + items and then do teardown. - + - Returns a constraint that tests whether the actual value - is of the type supplied as an argument or a derived type. + Compares two objects and returns a value indicating whether one is less than, equal to, or greater than the other. + + A signed integer that indicates the relative values of and , as shown in the following table.Value Meaning Less than zero is less than .Zero equals .Greater than zero is greater than . + + The first object to compare.The second object to compare. - + - Returns a constraint that tests whether the actual value - is of the type supplied as an argument or a derived type. + Sorts tests under this suite. - + - Returns a constraint that tests whether the actual value - is assignable from the type supplied as an argument. + Cancel (abort or stop) a CompositeWorkItem and all of its children + true if the CompositeWorkItem and all of its children should be aborted, false if it should allow all currently running tests to complete - + - Returns a constraint that tests whether the actual value - is assignable from the type supplied as an argument. + A simplified implementation of .NET 4 CountdownEvent + for use in earlier versions of .NET. Only the methods + used by NUnit are implemented. - + - Returns a constraint that tests whether the actual value - is assignable from the type supplied as an argument. + Construct a CountdownEvent + The initial count - + - Returns a constraint that tests whether the actual value - is assignable from the type supplied as an argument. + Gets the initial count established for the CountdownEvent - + - Returns a constraint that tests whether the actual value - is a collection containing the same elements as the - collection supplied as an argument. + Gets the current count remaining for the CountdownEvent - + - Returns a constraint that tests whether the actual value - is a subset of the collection supplied as an argument. + Decrement the count by one - + - Returns a new CollectionContainsConstraint checking for the - presence of a particular object in the collection. + Block the thread until the count reaches zero - + - Returns a new CollectionContainsConstraint checking for the - presence of a particular object in the collection. + A SimpleWorkItem represents a single test case and is + marked as completed immediately upon execution. This + class is also used for skipped or ignored test suites. - + - 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. + Construct a simple work item for a test. + The test to be executed + The filter used to select this test - + - Returns a constraint that succeeds if the actual - value contains the substring supplied as an argument. + Method that performs actually performs the work. - + + + A WorkItem may be an individual test case, a fixture or + a higher level grouping of tests. All WorkItems inherit + from the abstract WorkItem class, which uses the template + pattern to allow derived classes to perform work in + whatever way is needed. + + A WorkItem is created with a particular TestExecutionContext + and is responsible for re-establishing that context in the + current thread before it begins or resumes execution. + + + - Returns a constraint that succeeds if the actual - value contains the substring supplied as an argument. + Creates a work item. + The test for which this WorkItem is being created. + The filter to be used in selecting any child Tests. + - + - Returns a constraint that fails if the actual - value contains the substring supplied as an argument. + Construct a WorkItem for a particular test. + The test that the WorkItem will run - + - Returns a constraint that succeeds if the actual - value starts with the substring supplied as an argument. + Initialize the TestExecutionContext. This must be done + before executing the WorkItem. + + Originally, the context was provided in the constructor + but delaying initialization of the context until the item + is about to be dispatched allows changes in the parent + context during OneTimeSetUp to be reflected in the child. + + The TestExecutionContext to use - + - Returns a constraint that succeeds if the actual - value starts with the substring supplied as an argument. + Event triggered when the item is complete - + - Returns a constraint that fails if the actual - value starts with the substring supplied as an argument. + Gets the current state of the WorkItem - + - Returns a constraint that succeeds if the actual - value ends with the substring supplied as an argument. + The test being executed by the work item - + - Returns a constraint that succeeds if the actual - value ends with the substring supplied as an argument. + The execution context - + - Returns a constraint that fails if the actual - value ends with the substring supplied as an argument. + The unique id of the worker executing this item. - + - Returns a constraint that succeeds if the actual - value matches the regular expression supplied as an argument. + The test actions to be performed before and after this test - + - Returns a constraint that succeeds if the actual - value matches the regular expression supplied as an argument. + The test result - + - Returns a constraint that fails if the actual - value matches the pattern supplied as an argument. + Execute the current work item, including any + child work items. - + - Returns a constraint that tests whether the path provided - is the same as an expected path after canonicalization. + Cancel (abort or stop) a WorkItem + true if the WorkItem should be aborted, false if it should run to completion - + - Returns a constraint that tests whether the path provided - is the same path or under an expected path after canonicalization. + Method that performs actually performs the work. It should + set the State to WorkItemState.Complete when done. - + - Returns a constraint that tests whether the path provided - is the same path or under an expected path after canonicalization. + Method called by the derived class when all work is complete - + - Returns a constraint that tests whether the actual value falls - within a specified range. + The current state of a work item - + - Returns a ConstraintExpression that negates any - following constraint. + Ready to run or continue - + - Returns a ConstraintExpression that negates any - following constraint. + Work Item is executing - + - Returns a ConstraintExpression, which will apply - the following constraint to all members of a collection, - succeeding if all of them succeed. + Complete - + - Returns a ConstraintExpression, which will apply - the following constraint to all members of a collection, - succeeding if at least one of them succeeds. + A base class for multi-part filters - + - Returns a ConstraintExpression, which will apply - the following constraint to all members of a collection, - succeeding if all of them fail. + Constructs an empty CompositeFilter - + - Returns a new ConstraintExpression, which will apply the following - constraint to the Length property of the object being tested. + Constructs a CompositeFilter from an array of filters + - + - Returns a new ConstraintExpression, which will apply the following - constraint to the Count property of the object being tested. + Adds a filter to the list of filters + The filter to be added - + - Returns a new ConstraintExpression, which will apply the following - constraint to the Message property of the object being tested. + Return a list of the composing filters. - + - Returns a new ConstraintExpression, which will apply the following - constraint to the InnerException property of the object being tested. + Checks whether the CompositeFilter is matched by a test. + The test to be matched - + - Returns a constraint that tests for null + Checks whether the CompositeFilter is matched by a test. + The test to be matched - + - Returns a constraint that tests for True + Checks whether the CompositeFilter is explicit matched by a test. + The test to be matched - + - Returns a constraint that tests for False + Adds an XML node + Parent node + True if recursive + The added XML node - + - Returns a constraint that tests for a positive value + Gets the element name + Element name - + - Returns a constraint that tests for a negative value + PropertyFilter is able to select or exclude tests + based on their properties. + - + - Returns a constraint that tests for NaN + Construct a PropertyFilter using a property name and expected value + A property name + The expected value of the property - + - Returns a constraint that tests for empty + Check whether the filter matches a test + The test to be matched + - + - Returns a constraint that tests whether a collection - contains all unique items. + Adds an XML node + Parent node + True if recursive + The added XML node - + - Returns a constraint that tests whether an object graph is serializable in binary format. + Gets the element name + Element name - + - Returns a constraint that tests whether an object graph is serializable in xml format. + TestName filter selects tests based on their Name - + - Returns a constraint that tests whether a collection is ordered + Construct a TestNameFilter for a single name + The name the filter will recognize. - + - 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. + Match a test against a single value. - The actual value to test - A Constraint to be applied - + - 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. + Gets the element name - The actual value to test - A Constraint to be applied - The message to be displayed in case of failure + Element name - + - 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. + ClassName filter selects tests based on the class FullName - The actual value to test - A Constraint to be applied - The message to be displayed in case of failure - Arguments to use in formatting the message - + - Asserts that a condition is true. If the condition is false the method throws - an . Works Identically to - . - - The evaluated condition - The message to display if the condition is false - Arguments to be used in formatting the message + Construct a FullNameFilter for a single name + + The name the filter will recognize. - + - Asserts that a condition is true. If the condition is false the method throws - an . Works Identically to - . + Match a test against a single value. - 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 to . + Gets the element name - The evaluated condition + Element name - + - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. + FullName filter selects tests based on their FullName - 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. + Construct a MethodNameFilter for a single name - A Constraint expression to be applied - An ActualValueDelegate returning the value to be tested - The message that will be displayed on failure + The name the filter will recognize. - + - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. + Match a test against a single value. - 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. + Gets the element name - The actual value to test - A Constraint to be applied + Element name - + - Apply a constraint to a referenced value, succeeding if the constraint - is satisfied and throwing an assertion exception on failure. + IdFilter selects tests based on their id - The actual value to test - A Constraint to be applied - 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. + Construct an IdFilter for a single value - The actual value to test - A Constraint to be applied - The message that will be displayed on failure - Arguments to be used in formatting the message + The id the filter will recognize. - + - Asserts that the code represented by a delegate throws an exception - that satisfies the constraint provided. + Match a test against a single value. - A TestDelegate to be executed - A ThrowsConstraint used in the test - + - Returns a ListMapper based on a collection. + Gets the element name - The original collection - + Element name - + - 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. + ValueMatchFilter selects tests based on some value, which + is expected to be contained in the test. - + - The Equals method throws an AssertionException. This is done - to make sure there is no mistake by calling this function. + Returns the value matched by the filter - used for testing - - - + - override the default ReferenceEquals to throw an AssertionException. This - implementation makes sure there is no mistake in calling this function - as part of Assert. + Indicates whether the value is a regular expression - - - + - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an InconclusiveException on failure. + Construct a ValueMatchFilter for a single value. - A Constraint expression to be applied - The actual value to test + The value to be included. - + - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an InconclusiveException on failure. + Match the input provided by the derived class - A Constraint expression to be applied - The actual value to test - The message that will be displayed on failure + The value to be matchedT + True for a match, false otherwise. - + - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an InconclusiveException on failure. + Adds an XML node - 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 + Parent node + True if recursive + The added XML node - + - 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 + Gets the element name + + Element name - + - Asserts that a condition is true. If the condition is false the method throws - an . + Combines multiple filters so that a test must pass all + of them in order to pass this filter. - 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 . + Constructs an empty AndFilter - The evaluated condition - + - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an InconclusiveException on failure. + Constructs an AndFilter from an array of filters - 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. + Checks whether the AndFilter is matched by a test - A Constraint expression to be applied - An ActualValueDelegate returning the value to be tested - The message that will be displayed on failure + The test to be matched + True if all the component filters pass, otherwise false - + - Apply a constraint to an actual value, succeeding if the constraint - is satisfied and throwing an InconclusiveException on failure. + Checks whether the AndFilter is matched by a test - 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 + The test to be matched + True if all the component filters match, otherwise false - + - Apply a constraint to a referenced value, succeeding if the constraint - is satisfied and throwing an InconclusiveException on failure. + Checks whether the AndFilter is explicit matched by a test. - A Constraint expression to be applied - The actual value to test + The test to be matched + True if all the component filters explicit match, otherwise false - + - Apply a constraint to a referenced value, succeeding if the constraint - is satisfied and throwing an InconclusiveException on failure. + Gets the element name - A Constraint expression to be applied - The actual value to test - The message that will be displayed on failure + Element name - + - Apply a constraint to a referenced value, succeeding if the constraint - is satisfied and throwing an InconclusiveException on failure. + CategoryFilter is able to select or exclude tests + based on their categories. - 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 the code represented by a delegate throws an exception - that satisfies the constraint provided. + Construct a CategoryFilter using a single category name - A TestDelegate to be executed - A ThrowsConstraint used in the test + A category name - + - The different targets a test action attribute can be applied to + Check whether the filter matches a test + The test to be matched + - + - Default target, which is determined by where the action attribute is attached + Gets the element name + Element name - + - Target a individual test case + NotFilter negates the operation of another filter - + - Target a suite of test cases + Construct a not filter on another filter + The filter to be negated - + - Waits for pending asynchronous operations to complete, if appropriate, - and returns a proper result of the invocation by unwrapping task results + Gets the base filter - The raw result of the method invocation - The unwrapped result, if necessary - + - Attribute used to apply a category to a test + Determine if a particular test passes the filter criteria. The default + implementation checks the test itself, its parents and any descendants. + + Derived classes may override this method or any of the Match methods + to change the behavior of the filter. + The test to which the filter is applied + True if the test passes the filter, otherwise false - + - The name of the category + Check whether the filter matches a test + The test to be matched + True if it matches, otherwise false - + - 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. + Determine if a test matches the filter expicitly. That is, it must + be a direct match of the test itself or one of it's children. - The name of the category + The test to which the filter is applied + True if the test matches the filter explicityly, otherwise false - + - Protected constructor uses the Type name as the name - of the category. + Adds an XML node + Parent node + True if recursive + The added XML node - + - The name of the category + Combines multiple filters so that a test must pass one + of them in order to pass this filter. - + - 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. + Constructs an empty OrFilter - + - 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. + Constructs an AndFilter from an array of filters + - + - Attribute used to provide descriptive text about a - test case or fixture. + Checks whether the OrFilter is matched by a test + The test to be matched + True if any of the component filters pass, otherwise false - + - Construct the attribute + Checks whether the OrFilter is matched by a test - Text describing the test + The test to be matched + True if any of the component filters match, otherwise false - + - Gets the test description + Checks whether the OrFilter is explicit matched by a test + The test to be matched + True if any of the component filters explicit match, otherwise false - + - Enumeration indicating how the expected message parameter is to be used + Gets the element name + Element name - - Expect an exact match + + + FullName filter selects tests based on their FullName + - - Expect a message containing the parameter string + + + Construct a FullNameFilter for a single name + + The name the filter will recognize. - - Match the regular expression provided as a parameter + + + Match a test against a single value. + - - Expect a message that starts with the parameter string + + + Gets the element name + + Element name - + - ExpectedExceptionAttribute + Interface for logging within the engine - - + - Constructor for a non-specific exception + Logs the specified message at the error level. + The message. - + - Constructor for a given type of exception + Logs the specified message at the error level. - The type of the expected exception + The message. + The arguments. - + - Constructor for a given exception name + Logs the specified message at the warning level. - The full name of the expected exception + The message. - + - Gets or sets the expected exception type + Logs the specified message at the warning level. + The message. + The arguments. - + - Gets or sets the full Type name of the expected exception + Logs the specified message at the info level. + The message. - + - Gets or sets the expected message text + Logs the specified message at the info level. + The message. + The arguments. - + - Gets or sets the user message displayed in case of failure + Logs the specified message at the debug level. + The message. - + - Gets or sets the type of match to be performed on the expected message + Logs the specified message at the debug level. + The message. + The arguments. - + - Gets the name of a method to be used as an exception handler + InternalTrace provides facilities for tracing the execution + of the NUnit framework. Tests and classes under test may make use + of Console writes, System.Diagnostics.Trace or various loggers and + NUnit itself traps and processes each of them. For that reason, a + separate internal trace is needed. + + Note: + InternalTrace uses a global lock to allow multiple threads to write + trace messages. This can easily make it a bottleneck so it must be + used sparingly. Keep the trace Level as low as possible and only + insert InternalTrace writes where they are needed. + TODO: add some buffering and a separate writer thread as an option. + TODO: figure out a way to turn on trace in specific classes only. - + - 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. + Gets a flag indicating whether the InternalTrace is initialized - + - Default constructor + Initialize the internal trace facility using the name of the log + to be written to and the trace level. + The log name + The trace level - + - Constructor with a reason + Initialize the internal trace using a provided TextWriter and level - The reason test is marked explicit + A TextWriter + The InternalTraceLevel - + - The reason test is marked explicit + Get a named Logger + - + - Attribute used to mark a test that is to be ignored. - Ignored tests result in a warning message when the - tests are run. + Get a logger named for a particular Type. - + - Constructs the attribute without giving a reason - for ignoring the test. + InternalTraceLevel is an enumeration controlling the + level of detailed presented in the internal log. - + - Constructs the attribute giving a reason for ignoring the test + Use the default settings as specified by the user. - The reason for ignoring the test - + - The reason for ignoring a test + Do not display any trace messages - + - Abstract base for Attributes that are used to include tests - in the test run based on environmental settings. + Display Error messages only - + - Constructor with no included items specified, for use - with named property syntax. + Display Warning level and higher messages - + - Constructor taking one or more included items + Display informational and higher messages - 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. + Display debug messages and higher - i.e. all messages - + - Name of the item to be excluded. Multiple items - may be given, separated by a comma. + Display debug messages and higher - i.e. all messages - + - The reason for including or excluding the test + A trace listener that writes to a separate file per domain + and process using it. - + - PlatformAttribute is used to mark a test fixture or an - individual method as applying to a particular platform only. + Construct an InternalTraceWriter that writes to a file. + Path to the file to use - + - Constructor with no platforms specified, for use - with named property syntax. + Construct an InternalTraceWriter that writes to a + TextWriter provided by the caller. + - + - Constructor taking one or more platforms + Returns the character encoding in which the output is written. - Comma-deliminted list of platforms + The character encoding in which the output is written. - + - CultureAttribute is used to mark a test fixture or an - individual method as applying to a particular Culture only. + Writes a character to the text string or stream. + The character to write to the text stream. - + - Constructor with no cultures specified, for use - with named property syntax. + Writes a string to the text string or stream. + The string to write. - + - Constructor taking one or more cultures + Writes a string followed by a line terminator to the text string or stream. - Comma-deliminted list of cultures + The string to write. If is null, only the line terminator is written. - + - 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. + Releases the unmanaged resources used by the and optionally releases the managed resources. + true to release both managed and unmanaged resources; false to release only unmanaged resources. - + - PropertyAttribute is used to attach information to a test as a name/value pair.. + Clears all buffers for the current writer and causes any buffered data to be written to the underlying device. - + - Construct a PropertyAttribute with a name and string value + Provides internal logging to the NUnit framework - The name of the property - The property value - + - Construct a PropertyAttribute with a name and int value + Initializes a new instance of the class. - The name of the property - The property value + The name. + The log level. + The writer where logs are sent. - + - Construct a PropertyAttribute with a name and double value + Logs the message at error level. - The name of the property - The property value + The message. - + - Constructor for derived classes that set the - property dictionary directly. + Logs the message at error level. + + The message. + The message arguments. + + + + Logs the message at warm level. + + The message. + + + + Logs the message at warning level. + The message. + The message arguments. - + - 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. + Logs the message at info level. + The message. - + - Gets the property dictionary for this attribute + Logs the message at info level. + The message. + The message arguments. - + - Default constructor + Logs the message at debug level. + The message. - + - 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. + Logs the message at debug level. + The message. + The message arguments. - + - Default constructor + The MethodWrapper class wraps a MethodInfo so that it may + be used in a platform-independent manner. - + - 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. + Construct a MethodWrapper for a Type and a MethodInfo. - + - Default constructor + Construct a MethodInfo for a given Type and method name. - + - Summary description for MaxTimeAttribute. + Gets the Type from which this method was reflected. - + - Construct a MaxTimeAttribute, given a time in milliseconds. + Gets the MethodInfo for this method. - The maximum elapsed time in milliseconds - + - RandomAttribute is used to supply a set of random values - to a single parameter of a parameterized test. + Gets the name of the method. - + - ValuesAttribute is used to provide literal arguments for - an individual parameter of a test. + Gets a value indicating whether the method is abstract. - + - Abstract base class for attributes that apply to parameters - and supply data for the parameter. + Gets a value indicating whether the method is public. - + - Gets the data to be provided to the specified parameter + Gets a value indicating whether the method contains unassigned generic type parameters. - + - 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. + Gets a value indicating whether the method is a generic method. - + - Construct with one argument + Gets a value indicating whether the MethodInfo represents the definition of a generic method. - - + - Construct with two arguments + Gets the return Type of the method. - - - + - Construct with three arguments + Gets the parameters of the method. - - - + - + - Construct with an array of arguments + Returns the Type arguments of a generic method or the Type parameters of a generic method definition. - - + - Get the collection of values to be used as arguments + Replaces the type parameters of the method with the array of types provided and returns a new IMethodInfo. + The type arguments to be used + A new IMethodInfo with the type arguments replaced - + - Construct a set of doubles from 0.0 to 1.0, - specifying only the count. + Returns an array of custom attributes of the specified type applied to this method - - + - Construct a set of doubles from min to max + Gets a value indicating whether one or more attributes of the spcified type are defined on the method. - - - - + - Construct a set of ints from min to max + Invokes the method, converting any TargetInvocationException to an NUnitException. - - - + The object on which to invoke the method + The argument list for the method + The return value from the invoked method - + - Get the collection of values to be used as arguments + Override ToString() so that error messages in NUnit's own tests make sense - + - RangeAttribute is used to supply a range of values to an - individual parameter of a parameterized test. + The ParameterWrapper class wraps a ParameterInfo so that it may + be used in a platform-independent manner. - + - Construct a range of ints using default step of 1 + Construct a ParameterWrapper for a given method and parameter - - + + - + - Construct a range of ints specifying the step size + Gets a value indicating whether the parameter is optional - - - - + - Construct a range of longs + Gets an IMethodInfo representing the method for which this is a parameter. - - - - + - Construct a range of doubles + Gets the underlying ParameterInfo - - - - + - Construct a range of floats + Gets the Type of the parameter - - - - + - RepeatAttribute may be applied to test case in order - to run it multiple times. + Returns an array of custom attributes of the specified type applied to this method - + - Construct a RepeatAttribute + Gets a value indicating whether one or more attributes of the specified type are defined on the parameter. - 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. + TestNameGenerator is able to create test names according to + a coded pattern. - + - Initializes a new instance of the class. + Default pattern used to generate names - The required addin. - + - Gets the name of required addin. + Construct a TestNameGenerator - The required addin name. - + - Summary description for SetCultureAttribute. + Construct a TestNameGenerator + The pattern used by this generator. - + - Construct given the name of a culture + Get the display name for a TestMethod and it's arguments - + A TestMethod + The display name - + - Summary description for SetUICultureAttribute. + Get the display name for a TestMethod and it's arguments + A TestMethod + Arguments to be used + The display name - + - Construct given the name of a culture + The TypeWrapper class wraps a Type so it may be used in + a platform-independent manner. - - + - 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. + Construct a TypeWrapper for a specified Type. - + - 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. + Gets the underlying Type on which this TypeWrapper is based. - + - Attribute used to mark a static (shared in VB) property - that returns a list of tests. + Gets the base type of this type as an ITypeInfo - + - 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. + Gets the Name of the Type - + - Provide actions to execute before and after tests. + Gets the FullName of the Type - + - When implemented by an attribute, this interface implemented to provide actions to execute before and after tests. + Gets the assembly in which the type is declared - + - Executed before each test is run + Gets the namespace of the Type - Provides details about the test that is going to be run. - + - Executed after each test is run + Gets a value indicating whether the type is abstract. - Provides details about the test that has just been run. - + - Provides the target for the action attribute + Gets a value indicating whether the Type is a generic Type - The target for the action attribute - + - Method called before each test + Returns true if the Type wrapped is T - Info about the test to be run - + - Method called after each test + Gets a value indicating whether the Type has generic parameters that have not been replaced by specific Types. - Info about the test that was just run - + - Gets or sets the ActionTargets for this attribute + Gets a value indicating whether the Type is a generic Type definition - + - 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. + Gets a value indicating whether the type is sealed. - - - [TestFixture] - public class Fixture - { - [Test] - public void MethodToTest() - {} - - [Test(Description = "more detailed description")] - publc void TestDescriptionMethod() - {} - } - - - + - Descriptive text for this test + Gets a value indicating whether this type represents a static class. - + - TestCaseAttribute is used to mark parameterized test cases - and provide them with their arguments. + Get the display name for this type - + - 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. + Get the display name for an object of this type, constructed with the specified args. - + - Gets the argument list to be provided to the test + Returns a new ITypeInfo representing an instance of this generic Type using the supplied Type arguments - + - Gets the expected result + Returns a Type representing a generic type definition from which this Type can be constructed. - + - Indicates whether a result has been specified. - This is necessary because the result may be - null, so it's value cannot be checked. + Returns an array of custom attributes of the specified type applied to this type - + - Gets the expected exception Type + Returns a value indicating whether the type has an attribute of the specified type. + + + - + - Gets the FullName of the expected exception + Returns a flag indicating whether this type has a method with an attribute of the specified type. + + - + - Gets the name to be used for the test + Returns an array of IMethodInfos for methods of this Type + that match the specified flags. - + - Gets the description of the test + Gets the public constructor taking the specified argument Types - + - Gets a value indicating whether this is ignored. + Returns a value indicating whether this Type has a public constructor taking the specified argument Types. - true if ignored; otherwise, false. - + - Gets a value indicating whether this is explicit. + Construct an object of this Type, using the specified arguments. - true if explicit; otherwise, false. - + - Gets the ignore reason. + Override ToString() so that error messages in NUnit's own tests make sense - The ignore reason. - + - Construct a TestCaseAttribute with a list of arguments. - This constructor is not CLS-Compliant + SetUpTearDownItem holds the setup and teardown methods + for a single level of the inheritance hierarchy. - - + - Construct a TestCaseAttribute with a single argument + Construct a SetUpTearDownNode - + A list of setup methods for this level + A list teardown methods for this level - + - Construct a TestCaseAttribute with a two arguments + Returns true if this level has any methods at all. + This flag is used to discard levels that do nothing. - - - + - Construct a TestCaseAttribute with a three arguments + Run SetUp on this level. - - - + The execution context to use for running. - + - Gets the list of arguments to a test case + Run TearDown for this level. + - + - Gets or sets the expected result. Use - ExpectedResult by preference. + TestActionCommand runs the BeforeTest actions for a test, + then runs the test and finally runs the AfterTestActions. - The result. - + - Gets or sets the expected result. + Initializes a new instance of the class. - The result. + The inner command. - + - Gets a flag indicating whether an expected - result has been set. + Runs the test, saving a TestResult in the supplied TestExecutionContext. + The context in which the test should run. + A TestResult - + - Gets a list of categories associated with this test; + TestActionItem represents a single execution of an + ITestAction. It is used to track whether the BeforeTest + method has been called and suppress calling the + AfterTest method if it has not. - + - Gets or sets the category associated with this test. - May be a single category or a comma-separated list. + Construct a TestActionItem + The ITestAction to be included - + - Gets or sets the expected exception. + Run the BeforeTest method of the action and remember that it has been run. - The expected exception. + The test to which the action applies - + - Gets or sets the name the expected exception. + Run the AfterTest action, but only if the BeforeTest + action was actually run. - The expected name of the exception. + The test to which the action applies - + - Gets or sets the expected message of the expected exception + ContextSettingsCommand applies specified changes to the + TestExecutionContext prior to running a test. No special + action is needed after the test runs, since the prior + context will be restored automatically. - The expected message of the exception. - + - Gets or sets the type of match to be performed on the expected message + TODO: Documentation needed for class - + + TODO: Documentation needed for field + + - Gets or sets the description. + TODO: Documentation needed for constructor - The description. + - + - Gets or sets the name of the test. + TODO: Documentation needed for class - The name of the test. - + - Gets or sets the ignored status of the test + Initializes a new instance of the class. + The inner command. + The max time allowed in milliseconds - + - Gets or sets the ignored status of the test + Runs the test, saving a TestResult in the supplied TestExecutionContext + The context in which the test should run. + A TestResult - + - Gets or sets the explicit status of the test + OneTimeSetUpCommand runs any one-time setup methods for a suite, + constructing the user test object if necessary. - + - Gets or sets the reason for not running the test + Constructs a OneTimeSetUpCommand for a suite + The suite to which the command applies + A SetUpTearDownList for use by the command + A List of TestActionItems to be run after Setup - + - Gets or sets the reason for not running the test. - Set has the side effect of marking the test as ignored. + Overridden to run the one-time setup for a suite. - The ignore reason. + The TestExecutionContext to be used. + A TestResult - + - FactoryAttribute indicates the source to be used to - provide test cases for a test method. + OneTimeTearDownCommand performs any teardown actions + specified for a suite and calls Dispose on the user + test object, if any. - + - Construct with the name of the data source, which must - be a property, field or method of the test class itself. + Construct a OneTimeTearDownCommand - An array of the names of the factories that will provide data + The test suite to which the command applies + A SetUpTearDownList for use by the command + A List of TestActionItems to be run before teardown. - + - Construct with a Type, which must implement IEnumerable + Overridden to run the teardown methods specified on the test. - The Type that will provide data + The TestExecutionContext to be used. + A TestResult - + - Construct with a Type and name. - that don't support params arrays. + SetUpTearDownCommand runs any SetUp methods for a suite, + runs the test and then runs any TearDown methods. - 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 + Initializes a new instance of the class. + The inner command. - + - A Type to be used as a source + Runs the test, saving a TestResult in the supplied TestExecutionContext. + The context in which the test should run. + A TestResult - + - Gets or sets the category associated with this test. - May be a single category or a comma-separated list. + TODO: Documentation needed for class - - - [TestFixture] - public class ExampleClass - {} - - - + - Default constructor + Initializes a new instance of the class. + The test being skipped. - + - 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. + Overridden to simply set the CurrentResult to the + appropriate Skipped state. - + The execution context for the test + A TestResult - + - Descriptive text for this fixture + TestCommand is the abstract base class for all test commands + in the framework. A TestCommand represents a single stage in + the execution of a test, e.g.: SetUp/TearDown, checking for + Timeout, verifying the returned result from a method, etc. + + TestCommands may decorate other test commands so that the + execution of a lower-level command is nested within that + of a higher level command. All nested commands are executed + synchronously, as a single unit. Scheduling test execution + on separate threads is handled at a higher level, using the + task dispatcher. - + - Gets and sets the category for this fixture. - May be a comma-separated list of categories. + Construct a TestCommand for a test. + The test to be executed - + - Gets a list of categories for this fixture + Gets the test associated with this command. - + - The arguments originally provided to the attribute + Runs the test in a specified context, returning a TestResult. + The TestExecutionContext to be used for running the test. + A TestResult - + - Gets or sets a value indicating whether this should be ignored. + TestMethodCommand is the lowest level concrete command + used to run actual test cases. - true if ignore; otherwise, false. - + - Gets or sets the ignore reason. May set Ignored as a side effect. + Initializes a new instance of the class. - The ignore reason. + The test. - + - Get or set the type arguments. If not set - explicitly, any leading arguments that are - Types are taken as type arguments. + Runs the test, saving a TestResult in the execution context, as + well as returning it. If the test has an expected result, it + is asserts on that value. Since failed tests and errors throw + an exception, this command must be wrapped in an outer command, + will handle that exception and records the failure. This role + is usually played by the SetUpTearDown command. + The execution context - + - Attribute used to identify a method that is - called before any tests in a fixture are run. + TheoryResultCommand adjusts the result of a Theory so that + it fails if all the results were inconclusive. - + - 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. + Constructs a TheoryResultCommand + The command to be wrapped by this one - + - 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. + Overridden to call the inner command and adjust the result + in case all chlid results were inconclusive. - - - [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. + The CommandStage enumeration represents the defined stages + of execution for a series of TestCommands. The int _values + of the enum are used to apply decorators in the proper + order. Lower _values are applied first and are therefore + "closer" to the actual test execution. + + No CommandStage is defined for actual invocation of the test or + for creation of the context. Execution may be imagined as + proceeding from the bottom of the list upwards, with cleanup + after the test running in the opposite order. + - + - Construct a TimeoutAttribute given a time in milliseconds + Use an application-defined default value. - 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. + Make adjustments needed before and after running + the raw test - that is, after any SetUp has run + and before TearDown. - + - Construct a RequiresSTAAttribute + Run SetUp and TearDown for the test. This stage is used + internally by NUnit and should not normally appear + in user-defined decorators. - + - 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. + Make adjustments needed before and after running + the entire test - including SetUp and TearDown. - + - Construct a RequiresMTAAttribute + 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. - + - Marks a test that must run on a separate thread. + Prefix used for the expected value line of a message - + - Construct a RequiresThreadAttribute + Prefix used for the actual value line of a message - + - Construct a RequiresThreadAttribute, specifying the apartment + Length of a message prefix - + - ValueSourceAttribute indicates the source to be used to - provide data for one parameter of a test method. + Construct a TextMessageWriter - + - Construct with the name of the factory - for use with languages - that don't support params arrays. + Construct a TextMessageWriter, specifying a user message + and optional formatting arguments. - 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. + Gets or sets the maximum line length for this writer - 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 + Method to write single line message with optional args, usually + written to precede the general failure message, at a given + indentation level. + The indentation level of the message + The message to be written + Any arguments used in formatting the message - + - A Type to be used as a source + 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 result of the constraint that failed - + - A set of Assert methods operationg on one or more collections + 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 - + - The Equals method throws an AssertionException. This is done - to make sure there is no mistake by calling this function. + 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 - + - override the default ReferenceEquals to throw an AssertionException. This - implementation makes sure there is no mistake in calling this function - as part of Assert. + 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 - + - Asserts that all items contained in collection are of the type specified by expectedType. + Writes the text for an actual value. - IEnumerable containing objects to be considered - System.Type that all objects in collection must be instances of + The actual value. - + - Asserts that all items contained in collection are of the type specified by expectedType. + Writes the text for a generalized value. - 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 + The value. - + - Asserts that all items contained in collection are of the type specified by expectedType. + Writes the text for a collection value, + starting at a particular point, to a max length - 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 + The collection containing elements to write. + The starting point of the elements to write + The maximum number of elements to write - + - Asserts that all items contained in collection are not equal to null. + Write the generic 'Expected' line for a constraint - IEnumerable containing objects to be considered + The constraint that failed - + - Asserts that all items contained in collection are not equal to null. + Write the generic 'Expected' line for a given value - IEnumerable containing objects to be considered - The message that will be displayed on failure + The expected value - + - Asserts that all items contained in collection are not equal to null. + Write the generic 'Expected' line for a given value + and tolerance. - IEnumerable of objects to be considered - The message that will be displayed on failure - Arguments to be used in formatting the message + The expected value + The tolerance within which the test was made - + - Ensures that every object contained in collection exists within the collection - once and only once. + Write the generic 'Actual' line for a constraint - IEnumerable of objects to be considered + The ConstraintResult for which the actual value is to be written - + - Ensures that every object contained in collection exists within the collection - once and only once. + Write the generic 'Actual' line for a given value - IEnumerable of objects to be considered - The message that will be displayed on failure + The actual value causing a failure - + - Ensures that every object contained in collection exists within the collection - once and only once. + GenericMethodHelper is able to deduce the Type arguments for + a generic method from the actual arguments provided. - 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. + Construct a GenericMethodHelper for a method - The first IEnumerable of objects to be considered - The second IEnumerable of objects to be considered + MethodInfo for the method to examine - + - 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. + Return the type argments for the method, deducing them + from the arguments actually provided. - 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 arguments to the method + An array of type arguments. - + - 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. + InvalidTestFixtureException is thrown when an appropriate test + fixture constructor using the provided arguments cannot be found. - 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. + Initializes a new instance of the class. - 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. + Initializes a new instance of the class. - 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 + 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. + Initializes a new instance of the class. - 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 + The message. + The inner. - + - Asserts that expected and actual are equivalent, containing the same objects but the match may be in any order. + Serialization Constructor - 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. + Randomizer returns a set of random _values in a repeatable + way, to allow re-running of tests if necessary. It extends + the .NET Random class, providing random values for a much + wider range of types. + + The class is used internally by the framework to generate + test case data and is also exposed for use by users through + the TestContext.Random property. - The first IEnumerable of objects to be considered - The second IEnumerable of objects to be considered - The message that will be displayed on failure + + For consistency with the underlying Random Type, methods + returning a single value use the prefix "Next..." Those + without an argument return a non-negative value up to + the full positive range of the Type. Overloads are provided + for specifying a maximum or a range. Methods that return + arrays or strings use the prefix "Get..." to avoid + confusion with the single-value methods. + - + - Asserts that expected and actual are equivalent, containing the same objects but the match may be in any order. + Initial seed used to create randomizers for this run - 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. + 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. - 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. + 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. - 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. + Create a new Randomizer using the next seed + available to ensure that each randomizer gives + a unique sequence of values. - 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. + Default constructor - 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. + Construct based on seed value - 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. + Returns a random unsigned int. - 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. + Returns a random unsigned int less than the specified maximum. - The first IEnumerable of objects to be considered - The second IEnumerable of objects to be considered - + - Asserts that expected and actual are not equivalent. + Returns a random unsigned int within a specified range. - 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. + Returns a non-negative random short. - 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. + Returns a non-negative random short less than the specified maximum. - IEnumerable of objects to be considered - Object to be found within collection - + - Asserts that collection contains actual as an item. + Returns a non-negative random short within a specified range. - 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. + Returns a random unsigned short. - 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. + Returns a random unsigned short less than the specified maximum. - IEnumerable of objects to be considered - Object that cannot exist within collection - + - Asserts that collection does not contain actual as an item. + Returns a random unsigned short within a specified range. - 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. + Returns a random long. - 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 the superset does not contain the subset + Returns a random long less than the specified maximum. - The IEnumerable subset to be considered - The IEnumerable superset to be considered - + - Asserts that the superset does not contain the subset + Returns a non-negative random long within a specified range. - The IEnumerable subset to be considered - The IEnumerable superset to be considered - The message that will be displayed on failure - + - Asserts that the superset does not contain the subset + Returns a random ulong. - The IEnumerable subset to be considered - The IEnumerable superset to be considered - The message that will be displayed on failure - Arguments to be used in formatting the message - + - Asserts that the superset contains the subset. + Returns a random ulong less than the specified maximum. - The IEnumerable subset to be considered - The IEnumerable superset to be considered - + - Asserts that the superset contains the subset. + Returns a non-negative random long within a specified range. - The IEnumerable subset to be considered - The IEnumerable superset to be considered - The message that will be displayed on failure - + - Asserts that the superset contains the subset. + Returns a random Byte - The IEnumerable subset to be considered - The IEnumerable superset 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 + Returns a random Byte less than the specified maximum. - 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 + Returns a random Byte within a specified range - 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 + Returns a random SByte - An array, list or other collection implementing IEnumerable - + - Assert that an array, list or other collection is empty + Returns a random sbyte less than the specified maximum. - 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 + Returns a random sbyte within a specified range - 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 + Returns a random bool - An array, list or other collection implementing IEnumerable - + - Assert that an array, list or other collection is ordered + Returns a random bool based on the probablility a true result - 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 + Returns a random double between 0.0 and the specified maximum. - 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 + Returns a random double within a specified range. - An array, list or other collection implementing IEnumerable - + - Assert that an array, list or other collection is ordered + Returns a random float. - 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 + Returns a random float between 0.0 and the specified maximum. - 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 + Returns a random float within a specified range. - An array, list or other collection implementing IEnumerable - A custom comparer to perform the comparisons - + - AllItemsConstraint applies another constraint to each - item in a collection, succeeding if they all succeed. + Returns a random enum value of the specified Type as an object. - + - Abstract base class used for prefixes + Returns a random enum value of the specified Type. - + - The Constraint class is the base of all built-in constraints - within NUnit. It provides the operator overloads used to combine - constraints. + Default characters for random functions. + Default characters are the English alphabet (uppercase & lowercase), arabic numerals, and underscore - + - The IConstraintExpression interface is implemented by all - complete and resolvable constraints and expressions. + Generate a random string based on the characters from the input string. + desired length of output string. + string representing the set of characters from which to construct the resulting string + A random string of arbitrary length - + - Return the top-level constraint for this expression + Generate a random string based on the characters from the input string. - + desired length of output string. + A random string of arbitrary length + Uses DefaultStringChars as the input character set - + - Static UnsetObject used to detect derived constraints - failing to set the actual value. + Generate a random string based on the characters from the input string. + A random string of the default length + Uses DefaultStringChars as the input character set - + - The actual value being tested against a constraint + Returns a random decimal. - + - The display name of this Constraint for use by ToString() + Returns a random decimal between positive zero and the specified maximum. - + - Argument fields used by ToString(); + Returns a random decimal within a specified range, which is not + permitted to exceed decimal.MaxVal in the current implementation. + + A limitation of this implementation is that the range from min + to max must not exceed decimal.MaxVal. + - + - The builder holding this constraint + StackFilter class is used to remove internal NUnit + entries from a stack trace so that the resulting + trace provides better information about the test. - + - Construct a constraint with no arguments + Filters a raw stack trace and returns the result. + The original stack trace + A filtered stack trace - + - Construct a constraint with one argument + Provides methods to support legacy string comparison methods. - + - Construct a constraint with two arguments + Compares two strings for equality, ignoring case if requested. + The first string. + The second string.. + if set to true, the case of the letters in the strings is ignored. + Zero if the strings are equivalent, a negative number if strA is sorted first, a positive number if + strB is sorted first - + - Sets the ConstraintBuilder holding this constraint + Compares two strings for equality, ignoring case if requested. + The first string. + The second string.. + if set to true, the case of the letters in the strings is ignored. + True if the strings are equivalent, false if not. - + - 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 TestCaseParameters class encapsulates method arguments and + other selected parameters needed for constructing + a parameterized test case. - The MessageWriter on which to display the message - + - Test whether the constraint is satisfied by a given value + Default Constructor creates an empty parameter set - 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. + Construct a non-runnable ParameterSet, specifying + the provider exception that made it invalid. - An - 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. + Construct a parameter set with a list of arguments - A reference to the value to be tested - True for success, false for failure + - + - Write the constraint description to a MessageWriter + Construct a ParameterSet from an object implementing ITestCaseData - 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. + Type arguments used to create a generic fixture instance - The writer on which the actual value is displayed - + - Default override of ToString returns the constraint DisplayName - followed by any arguments within angle brackets. + TestParameters is the abstract base class for all classes + that know how to provide data for constructing a test. - - + - Returns the string representation of this constraint + Default Constructor creates an empty parameter set - + - This operator creates a constraint that is satisfied only if both - argument constraints are satisfied. + Construct a parameter set with a list of arguments + - + - This operator creates a constraint that is satisfied if either - of the argument constraints is satisfied. + Construct a non-runnable ParameterSet, specifying + the provider exception that made it invalid. - + - This operator creates a constraint that is satisfied if the - argument constraint is not satisfied. + Construct a ParameterSet from an object implementing ITestData + - + - Returns a DelayedConstraint with the specified delay time. + The RunState for this set of parameters. - The delay in milliseconds. - - + - Returns a DelayedConstraint with the specified delay time - and polling interval. + The arguments to be used in running the test, + which must match the method signature. - 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. + A name to be used for this test case in lieu + of the standard generated name containing + the argument list. - + - Returns a ConstraintExpression by appending And - to the current constraint. + Gets the property dictionary for this test - + - Returns a ConstraintExpression by appending And - to the current constraint. + Applies ParameterSet _values to the test itself. + A test. - + - Returns a ConstraintExpression by appending Or - to the current constraint. + The original arguments provided by the user, + used for display purposes. - + - Class used to detect any derived constraints - that fail to set the actual value in their - Matches override. + Enumeration indicating whether the tests are + running normally or being cancelled. - + - The base constraint + Running normally with no stop requested - + - Construct given a base constraint + A graceful stop has been requested - - + - Construct an AllItemsConstraint on top of an existing constraint + A forced stop has been requested - - + - Apply the item constraint to each item in the collection, - failing if any item fails. + The PropertyNames class provides static constants for the + standard property ids that NUnit uses on tests. - - - + - Write a description of this constraint to a MessageWriter + The FriendlyName of the AppDomain in which the assembly is running - - + - AndConstraint succeeds only if both members succeed. + The selected strategy for joining parameter data into test cases - + - BinaryConstraint is the abstract base of all constraints - that combine two other constraints in some fashion. + The process ID of the executing assembly - + - The first constraint being combined + The stack trace from any data provider that threw + an exception. - + - The second constraint being combined + The reason a test was not run - + - Construct a BinaryConstraint from two other constraints + The author of the tests - The first constraint - The second constraint - + - Create an AndConstraint from two other constraints + The ApartmentState required for running the test - The first constraint - The second constraint - + - Apply both member constraints to an actual value, succeeding - succeeding only if both of them succeed. + The categories applying to a test - The actual value - True if the constraints both succeeded - + - Write a description for this contraint to a MessageWriter + The Description of a test - 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 number of threads to be used in running tests - The writer on which the actual value is displayed - + - AssignableFromConstraint is used to test that an object - can be assigned from a given Type. + The maximum time in ms, above which the test is considered to have failed - + - TypeConstraint is the abstract base for constraints - that take a Type as their expected value. + The ParallelScope associated with a test - + - The expected Type used by the constraint + The number of times the test should be repeated - + - Construct a TypeConstraint for a given Type + Indicates that the test should be run on a separate thread - - + - Write the actual value for a failing constraint test to a - MessageWriter. TypeConstraints override this method to write - the name of the type. + The culture to be set for a test - The writer on which the actual value is displayed - + - Construct an AssignableFromConstraint for the type provided + The UI culture to be set for a test - - + - Test whether an object can be assigned from the specified type + The type that is under test - 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 timeout value for the test - The MessageWriter to use - + - AssignableToConstraint is used to test that an object - can be assigned to a given Type. + The test will be ignored until the given date - + - Construct an AssignableToConstraint for the type provided + The optional Order the test will run in - - + - Test whether an object can be assigned to the specified type + CultureDetector is a helper class used by NUnit to determine + whether a test should be run based on the current culture. - 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 + Default constructor uses the current culture. - The MessageWriter to use - + - 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. + Construct a CultureDetector for a particular culture for testing. + The culture to be used - + - Constructs an AttributeConstraint for a specified attriute - Type and base constraint. + Test to determine if one of a collection of cultures + is being used currently. - - + + - + - Determines whether the Type or other provider has the - expected attribute and if its value matches the - additional constraint specified. + Tests to determine if the current culture is supported + based on a culture attribute. + The attribute to examine + - + - Writes a description of the attribute to the specified writer. + Test to determine if the a particular culture or comma- + delimited set of cultures is in use. + Name of the culture or comma-separated list of culture ids + True if the culture is in use on the system - + - Writes the actual value supplied to the specified writer. + Return the last failure reason. Results are not + defined if called before IsSupported( Attribute ) + is called. - + - Returns a string representation of the constraint. + ExceptionHelper provides static methods for working with exceptions + + + + + Rethrows an exception, preserving its stack trace + The exception to rethrow - + - AttributeExistsConstraint tests for the presence of a - specified attribute on a Type. + Builds up a message, using the Message field of the specified exception + as well as any InnerExceptions. + The exception. + A combined message string. - + - Constructs an AttributeExistsConstraint for a specific attribute Type + Builds up a message, using the Message field of the specified exception + as well as any InnerExceptions. - + The exception. + A combined stack trace. - + - Tests whether the object provides the expected attribute. + Gets the stack trace of the exception. - A Type, MethodInfo, or other ICustomAttributeProvider - True if the expected attribute is present, otherwise false + The exception. + A string representation of the stack trace. - + - Writes the description of the constraint to the specified writer + InvalidTestFixtureException is thrown when an appropriate test + fixture constructor using the provided arguments cannot be found. - + - BasicConstraint is the abstract base for constraints that - perform a simple comparison to a constant value. + Initializes a new instance of the class. - + - Initializes a new instance of the class. + Initializes a new instance of the class. - The expected. - The description. + The message. - + - Test whether the constraint is satisfied by a given value + Initializes a new instance of the class. - The value to be tested - True for success, false for failure + The message. + The inner. - + - Write the constraint description to a MessageWriter + Serialization Constructor - The writer on which the description is displayed - + - CollectionConstraint is the abstract base class for - constraints that operate on collections. + Thrown when an assertion failed. Here to preserve the inner + exception and hence its stack trace. - + - Construct an empty CollectionConstraint + Initializes a new instance of the class. - + - Construct a CollectionConstraint + Initializes a new instance of the class. - + The error message that explains + the reason for the exception - + - Determines whether the specified enumerable is empty. + Initializes a new instance of the class. - The enumerable. - - true if the specified enumerable is empty; otherwise, false. - + The error message that explains + the reason for the exception + The exception that caused the + current exception - + - Test whether the constraint is satisfied by a given value + Serialization Constructor - The value to be tested - True for success, false for failure - + - Protected method to be implemented by derived classes + OSPlatform represents a particular operating system platform - - - + - CollectionContainsConstraint is used to test whether a collection - contains an expected object as a member. + Platform ID for Unix as defined by Microsoft .NET 2.0 and greater - + - CollectionItemsEqualConstraint is the abstract base class for all - collection constraints that apply some notion of item equality - as a part of their operation. + Platform ID for Unix as defined by Mono - + - Construct an empty CollectionConstraint + Platform ID for XBox as defined by .NET and Mono, but not CF - + - Construct a CollectionConstraint + Platform ID for MacOSX as defined by .NET and Mono, but not CF - - + - Flag the constraint to use the supplied EqualityAdapter. - NOTE: For internal use only. + Get the OSPlatform under which we are currently running - The EqualityAdapter to use. - Self. - + - Flag the constraint to use the supplied IComparer object. + Gets the actual OS Version, not the incorrect value that might be + returned for Win 8.1 and Win 10 - The IComparer object to use. - Self. + + If an application is not manifested as Windows 8.1 or Windows 10, + the version returned from Environment.OSVersion will not be 6.3 and 10.0 + respectively, but will be 6.2 and 6.3. The correct value can be found in + the registry. + + The original version + The correct OS version - + - Flag the constraint to use the supplied IComparer object. + Product Type Enumeration used for Windows - The IComparer object to use. - Self. - + - Flag the constraint to use the supplied Comparison object. + Product type is unknown or unspecified - The IComparer object to use. - Self. - + - Flag the constraint to use the supplied IEqualityComparer object. + Product type is Workstation - The IComparer object to use. - Self. - + - Flag the constraint to use the supplied IEqualityComparer object. + Product type is Domain Controller - The IComparer object to use. - Self. - + - Compares two collection members for equality + Product type is Server - + - Return a new CollectionTally for use in making tests + Construct from a platform ID and version - The collection to be included in the tally - + - Flag the constraint to ignore case and return self. + Construct from a platform ID, version and product type - + - Construct a CollectionContainsConstraint + Get the platform ID of this instance - - + - Test whether the expected item is contained in the collection + Get the Version of this instance - - - + - Write a descripton of the constraint to a MessageWriter + Get the Product Type of this instance - - + - CollectionEquivalentCOnstraint is used to determine whether two - collections are equivalent. + Return true if this is a windows platform - + - Construct a CollectionEquivalentConstraint + Return true if this is a Unix or Linux platform - - + - Test whether two collections are equivalent + Return true if the platform is Win32S - - - + - Write a description of this constraint to a MessageWriter + Return true if the platform is Win32Windows - - + - CollectionSubsetConstraint is used to determine whether - one collection is a subset of another + Return true if the platform is Win32NT - + - Construct a CollectionSubsetConstraint + Return true if the platform is Windows CE - 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. + Return true if the platform is Xbox - - - + - Write a description of this constraint to a MessageWriter + Return true if the platform is MacOSX - - + - CollectionTally counts (tallies) the number of - occurences of each object in one or more enumerations. + Return true if the platform is Windows 95 - + - Construct a CollectionTally object from a comparer and a collection + Return true if the platform is Windows 98 - + - Try to remove an object from the tally + Return true if the platform is Windows ME - The object to remove - True if successful, false if the object was not found - + - Try to remove a set of objects from the tally + Return true if the platform is NT 3 - The objects to remove - True if successful, false if any object was not found - + - The number of objects remaining in the tally + Return true if the platform is NT 4 - + - ComparisonAdapter class centralizes all comparisons of - values in NUnit, adapting to the use of any provided - IComparer, IComparer<T> or Comparison<T> + Return true if the platform is NT 5 - + - Returns a ComparisonAdapter that wraps an IComparer + Return true if the platform is Windows 2000 - + - Returns a ComparisonAdapter that wraps an IComparer<T> + Return true if the platform is Windows XP - + - Returns a ComparisonAdapter that wraps a Comparison<T> + Return true if the platform is Windows 2003 Server - + - Compares two objects + Return true if the platform is NT 6 - + - Gets the default ComparisonAdapter, which wraps an - NUnitComparer object. + Return true if the platform is NT 6.0 - + - Construct a ComparisonAdapter for an IComparer + Return true if the platform is NT 6.1 - + - Compares two objects + Return true if the platform is NT 6.2 - - - - + - Construct a default ComparisonAdapter + Return true if the platform is NT 6.3 - + - ComparisonAdapter<T> extends ComparisonAdapter and - allows use of an IComparer<T> or Comparison<T> - to actually perform the comparison. + Return true if the platform is Vista - + - Construct a ComparisonAdapter for an IComparer<T> + Return true if the platform is Windows 2008 Server (original or R2) - + - Compare a Type T to an object + Return true if the platform is Windows 2008 Server (original) - + - Construct a ComparisonAdapter for a Comparison<T> + Return true if the platform is Windows 2008 Server R2 - + - Compare a Type T to an object + Return true if the platform is Windows 2012 Server (original or R2) - + - 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. + Return true if the platform is Windows 2012 Server (original) - + - ComparisonAdapter to be used in making the comparison + Return true if the platform is Windows 2012 Server R2 - + - Initializes a new instance of the class. + Return true if the platform is Windows 7 - + - Initializes a new instance of the class. + Return true if the platform is Windows 8 - + - Modifies the constraint to use an IComparer and returns self + Return true if the platform is Windows 8.1 - + - Modifies the constraint to use an IComparer<T> and returns self + Return true if the platform is Windows 10 - + - Modifies the constraint to use a Comparison<T> and returns self + Return true if the platform is Windows Server. This is named Windows + Server 10 to distinguish it from previous versions of Windows Server. - + - Delegate used to delay evaluation of the actual value - to be used in evaluating a constraint + The TestCaseParameters class encapsulates method arguments and + other selected parameters needed for constructing + a parameterized test case. - + - 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. + The expected result to be returned - + - Initializes a new instance of the class. + Default Constructor creates an empty parameter set - + - Appends the specified operator to the expression by first - reducing the operator stack and then pushing the new - operator on the stack. + Construct a non-runnable ParameterSet, specifying + the provider exception that made it invalid. - The operator to push. - + - Appends the specified constraint to the expresson by pushing - it on the constraint stack. + Construct a parameter set with a list of arguments - The constraint to push. + - + - Sets the top operator right context. + Construct a ParameterSet from an object implementing ITestCaseData - The right context. + - + - Reduces the operator stack until the topmost item - precedence is greater than or equal to the target precedence. + The expected result of the test, which + must match the method return type. - The target precedence. - + - Resolves this instance, returning a Constraint. If the builder - is not currently in a resolvable state, an exception is thrown. + Gets a value indicating whether an expected result was specified. - The resolved constraint - + - Gets a value indicating whether this instance is resolvable. + PlatformHelper class is used by the PlatformAttribute class to + determine whether a platform is supported. - - true if this instance is resolvable; otherwise, false. - - + - OperatorStack is a type-safe stack for holding ConstraintOperators + Comma-delimited list of all supported OS platform constants - + - Initializes a new instance of the class. + Comma-delimited list of all supported Runtime platform constants - The builder. - + - Pushes the specified operator onto the stack. + Default constructor uses the operating system and + common language runtime of the system. - The op. - + - Pops the topmost operator from the stack. + Construct a PlatformHelper for a particular operating + system and common language runtime. Used in testing. - + OperatingSystem to be used + RuntimeFramework to be used - + - Gets a value indicating whether this is empty. + Test to determine if one of a collection of platforms + is being used currently. - true if empty; otherwise, false. + + - + - Gets the topmost operator without modifying the stack. + Tests to determine if the current platform is supported + based on a platform attribute. - The top. + The attribute to examine + - + - ConstraintStack is a type-safe stack for holding Constraints + Tests to determine if the current platform is supported + based on a platform attribute. + The attribute to examine + - + - Initializes a new instance of the class. + Test to determine if the a particular platform or comma- + delimited set of platforms is in use. - The builder. + Name of the platform or comma-separated list of platform ids + True if the platform is in use on the system - + - Pushes the specified constraint. As a side effect, - the constraint's builder field is set to the - ConstraintBuilder owning this stack. + Return the last failure reason. Results are not + defined if called before IsSupported( Attribute ) + is called. - The constraint. - + - Pops this topmost constrait from the stack. - As a side effect, the constraint's builder - field is set to null. + A PropertyBag represents a collection of name value pairs + that allows duplicate entries with the same key. Methods + are provided for adding a new pair as well as for setting + a key to a single value. All keys are strings but _values + may be of any type. Null _values are not permitted, since + a null entry represents the absence of the key. - - + - Gets a value indicating whether this is empty. + Adds a key/value pair to the property set - true if empty; otherwise, false. + The key + The value - + - Gets the topmost constraint without modifying the stack. + Sets the value for a key, removing any other + _values that are already in the property set. - 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. + Gets a single value for a key, using the first + one if multiple _values are present and returning + null if the value is not found. + + - + - 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. + Gets a flag indicating whether the specified key has + any entries in the property set. + The key to be checked + + True if their are _values present, otherwise false + - + - The ConstraintBuilder holding the elements recognized so far + Gets a collection containing all the keys in the property set + - + - Initializes a new instance of the class. + Gets or sets the list of _values for a particular key - + - Initializes a new instance of the - class passing in a ConstraintBuilder, which may be pre-populated. + Returns an XmlNode representating the current PropertyBag. - The builder. + Not used + An XmlNode representing the PropertyBag - + - 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. + Returns an XmlNode representing the PropertyBag after + adding it as a child of the supplied parent node. + The parent node. + Not used - + - Appends an operator to the expression and returns the - resulting expression itself. + Helper methods for inspecting a type by reflection. + + Many of these methods take ICustomAttributeProvider as an + argument to avoid duplication, even though certain attributes can + only appear on specific types of members, like MethodInfo or Type. + + In the case where a type is being examined for the presence of + an attribute, interface or named member, the Reflect methods + operate with the full name of the member being sought. This + removes the necessity of the caller having a reference to the + assembly that defines the item being sought and allows the + NUnit core to inspect assemblies that reference an older + version of the NUnit framework. - + - Appends a self-resolving operator to the expression and - returns a new ResolvableConstraintExpression. + Examine a fixture type and return an array of methods having a + particular attribute. The array is order with base methods first. + The type to examine + The attribute Type to look for + Specifies whether to search the fixture type inheritance chain + The array of methods found - + - Appends a constraint to the expression and returns that - constraint, which is associated with the current state - of the expression being built. + Examine a fixture type and return true if it has a method with + a particular attribute. + The type to examine + The attribute Type to look for + True if found, otherwise false - + - Initializes a new instance of the class. + Invoke the default constructor on a Type + The Type to be constructed + An instance of the Type - + - Initializes a new instance of the - class passing in a ConstraintBuilder, which may be pre-populated. + Invoke a constructor on a Type with arguments - The builder. + The Type to be constructed + Arguments to the constructor + An instance of the Type - + - 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 an array of types from an array of objects. + Used because the compact framework doesn't support + Type.GetTypeArray() - - - - 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. + An array of objects + An array of Types + + + + Invoke a parameterless method returning void on an object. + A MethodInfo for the method to be invoked + The object on which to invoke the method - + - Returns a new AttributeConstraint checking for the - presence of a particular attribute on an object. + Invoke a method, converting any TargetInvocationException to an NUnitException. + A MethodInfo for the method to be invoked + The object on which to invoke the method + The argument list for the method + The return value from the invoked method - + - 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. + The TestResult class represents the result of a test. - + - Returns the constraint provided as an argument - used to allow custom - custom constraints to easily participate in the syntax. + Error message for when child tests have errors - + - Returns a constraint that tests two items for equality + Error message for when child tests are ignored - + - Returns a constraint that tests that two references are the same object + The minimum duration for tests - + - Returns a constraint that tests whether the - actual value is greater than the suppled argument + Aggregate assertion count - + - Returns a constraint that tests whether the - actual value is greater than or equal to the suppled argument + Construct a test result given a Test + The test to be used - + - Returns a constraint that tests whether the - actual value is greater than or equal to the suppled argument + Gets the test with which this result is associated. - + - Returns a constraint that tests whether the - actual value is less than the suppled argument + Gets the ResultState of the test result, which + indicates the success or failure of the test. - + - Returns a constraint that tests whether the - actual value is less than or equal to the suppled argument + Gets the name of the test result - + - Returns a constraint that tests whether the - actual value is less than or equal to the suppled argument + Gets the full name of the test result - + - Returns a constraint that tests whether the actual - value is of the exact type supplied as an argument. + Gets or sets the elapsed time for running the test in seconds - + - Returns a constraint that tests whether the actual - value is of the exact type supplied as an argument. + Gets or sets the time the test started running. - + - Returns a constraint that tests whether the actual value - is of the type supplied as an argument or a derived type. + Gets or sets the time the test finished running. - + - Returns a constraint that tests whether the actual value - is of the type supplied as an argument or a derived type. + Gets the message associated with a test + failure or with not running the test - + - Returns a constraint that tests whether the actual value - is of the type supplied as an argument or a derived type. + Gets any stacktrace associated with an + error or failure. - + - Returns a constraint that tests whether the actual value - is of the type supplied as an argument or a derived type. + Gets or sets the count of asserts executed + when running the test. - + - Returns a constraint that tests whether the actual value - is assignable from the type supplied as an argument. + Gets the number of test cases that failed + when running the test and all its children. - + - Returns a constraint that tests whether the actual value - is assignable from the type supplied as an argument. + Gets the number of test cases that passed + when running the test and all its children. - + - Returns a constraint that tests whether the actual value - is assignable from the type supplied as an argument. + Gets the number of test cases that were skipped + when running the test and all its children. - + - Returns a constraint that tests whether the actual value - is assignable from the type supplied as an argument. + Gets the number of test cases that were inconclusive + when running the test and all its children. - + - Returns a constraint that tests whether the actual value - is a collection containing the same elements as the - collection supplied as an argument. + Indicates whether this result has any child results. - + - Returns a constraint that tests whether the actual value - is a subset of the collection supplied as an argument. + Gets the collection of child results. - + - Returns a new CollectionContainsConstraint checking for the - presence of a particular object in the collection. + Gets a TextWriter, which will write output to be included in the result. - + - Returns a new CollectionContainsConstraint checking for the - presence of a particular object in the collection. + Gets any text output written to this result. - + - 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 the Xml representation of the result. + If true, descendant results are included + An XmlNode representing the result - + - Returns a constraint that succeeds if the actual - value contains the substring supplied as an argument. + Adds the XML representation of the result as a child of the + supplied parent node.. + The parent node. + If true, descendant results are included + - + - Returns a constraint that succeeds if the actual - value contains the substring supplied as an argument. + Set the result of the test + The ResultState to use in the result - + - Returns a constraint that succeeds if the actual - value starts with the substring supplied as an argument. + Set the result of the test + The ResultState to use in the result + A message associated with the result state - + - Returns a constraint that succeeds if the actual - value starts with the substring supplied as an argument. + Set the result of the test + The ResultState to use in the result + A message associated with the result state + Stack trace giving the location of the command - + - Returns a constraint that succeeds if the actual - value ends with the substring supplied as an argument. + Set the test result based on the type of exception thrown + The exception that was thrown - + - Returns a constraint that succeeds if the actual - value ends with the substring supplied as an argument. + Set the test result based on the type of exception thrown + The exception that was thrown + THe FailureSite to use in the result - + - Returns a constraint that succeeds if the actual - value matches the regular expression supplied as an argument. + RecordTearDownException appends the message and stacktrace + from an exception arising during teardown of the test + to any previously recorded information, so that any + earlier failure information is not lost. Note that + calling Assert.Ignore, Assert.Inconclusive, etc. during + teardown is treated as an error. If the current result + represents a suite, it may show a teardown error even + though all contained tests passed. + The Exception to be recorded - + - Returns a constraint that succeeds if the actual - value matches the regular expression supplied as an argument. + Adds a reason element to a node and returns it. + The target node. + The new reason element. - + - Returns a constraint that tests whether the path provided - is the same as an expected path after canonicalization. + Adds a failure element to a node and returns it. + The target node. + The new failure element. - + - Returns a constraint that tests whether the path provided - is the same path or under an expected path after canonicalization. + Enumeration identifying a common language + runtime implementation. - + + Any supported runtime framework + + + Microsoft .NET Framework + + + Microsoft .NET Compact Framework + + + Microsoft Shared Source CLI + + + Mono + + + Silverlight + + + MonoTouch + + - Returns a constraint that tests whether the path provided - is the same path or under an expected path after canonicalization. + RuntimeFramework represents a particular version + of a common language runtime implementation. - + - Returns a constraint that tests whether the actual value falls - within a specified range. + DefaultVersion is an empty Version, used to indicate that + NUnit should select the CLR version to use for the test. - + - Returns a ConstraintExpression that negates any - following constraint. + Construct from a runtime type and version. If the version has + two parts, it is taken as a framework version. If it has three + or more, it is taken as a CLR version. In either case, the other + version is deduced based on the runtime type and provided version. + The runtime type of the framework + The version of the framework - + - Returns a ConstraintExpression that negates any - following constraint. + Static method to return a RuntimeFramework object + for the framework that is currently in use. - + - Returns a ConstraintExpression, which will apply - the following constraint to all members of a collection, - succeeding if all of them succeed. + The type of this runtime framework - + - Returns a ConstraintExpression, which will apply - the following constraint to all members of a collection, - succeeding if at least one of them succeeds. + The framework version for this runtime framework - + - Returns a ConstraintExpression, which will apply - the following constraint to all members of a collection, - succeeding if all of them fail. + The CLR version for this runtime framework - + - Returns a new ConstraintExpression, which will apply the following - constraint to the Length property of the object being tested. + Return true if any CLR version may be used in + matching this RuntimeFramework object. - + - Returns a new ConstraintExpression, which will apply the following - constraint to the Count property of the object being tested. + Returns the Display name for this framework - + - Returns a new ConstraintExpression, which will apply the following - constraint to the Message property of the object being tested. + Parses a string representing a RuntimeFramework. + The string may be just a RuntimeType name or just + a Version or a hyphenated RuntimeType-Version or + a Version prefixed by 'versionString'. + + - + - Returns a new ConstraintExpression, which will apply the following - constraint to the InnerException property of the object being tested. + Overridden to return the short name of the framework + - + - With is currently a NOP - reserved for future use. + Returns true if the current framework matches the + one supplied as an argument. Two frameworks match + if their runtime types are the same or either one + is RuntimeType.Any and all specified version components + are equal. Negative (i.e. unspecified) version + components are ignored. + The RuntimeFramework to be matched. + True on match, otherwise false - + + + Helper class used to save and restore certain static or + singleton settings in the environment that affect tests + or which might be changed by the user tests. + + An internal class is used to hold settings and a stack + of these objects is pushed and popped as Save and Restore + are called. + + + - Returns a constraint that tests for null + Link to a prior saved context - + - Returns a constraint that tests for True + Indicates that a stop has been requested - + - Returns a constraint that tests for False + The event listener currently receiving notifications - + - Returns a constraint that tests for a positive value + The number of assertions for the current test - + - Returns a constraint that tests for a negative value + The current culture - + - Returns a constraint that tests for NaN + The current UI culture - + - Returns a constraint that tests for empty + The current test result - + - Returns a constraint that tests whether a collection - contains all unique items. + The current Principal. - + - Returns a constraint that tests whether an object graph is serializable in binary format. + Initializes a new instance of the class. - + - Returns a constraint that tests whether an object graph is serializable in xml format. + Initializes a new instance of the class. + An existing instance of TestExecutionContext. - + - Returns a constraint that tests whether a collection is ordered + Gets and sets the current context. - + - 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. + Get the current context or return null if none is found. + - + - Initializes a new instance of the class. + Clear the current context. This is provided to + prevent "leakage" of the CallContext containing + the current context back to any runners. - The expected. - + - Test whether the constraint is satisfied by a given value + Gets or sets the current test - The value to be tested - True for success, false for failure - + - Write the constraint description to a MessageWriter + The time the current test started execution - The writer on which the description is displayed - + - Flag the constraint to use the supplied IComparer object. + The time the current test started in Ticks - The IComparer object to use. - Self. - + - Flag the constraint to use the supplied IComparer object. + Gets or sets the current test result - The IComparer object to use. - Self. - + - Flag the constraint to use the supplied Comparison object. + Gets a TextWriter that will send output to the current test result. - The IComparer object to use. - Self. - + - Flag the constraint to use the supplied IEqualityComparer object. + The current test object - that is the user fixture + object on which tests are being executed. - The IComparer object to use. - Self. - + - Flag the constraint to use the supplied IEqualityComparer object. + Get or set the working directory - The IComparer object to use. - Self. - + - Flag the constraint to ignore case and return self. + Get or set indicator that run should stop on the first error - + - Applies a delay to the match so that a match can be evaluated in the future. + Gets an enum indicating whether a stop has been requested. - + - Creates a new DelayedConstraint + The current test event listener - 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 current WorkItemDispatcher. Made public for + use by nunitlite.tests - 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 ParallelScope to be used by tests running in this context. + For builds with out the parallel feature, it has no effect. - 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 unique name of the worker that spawned the context. + For builds with out the parallel feature, it is null. - 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. + Gets the RandomGenerator specific to this Test - A reference to the value to be tested - True for success, false for failure - + - Write the constraint description to a MessageWriter + Gets the assert count. - The writer on which the description is displayed + The assert count. - + - Write the actual value for a failing constraint test to a MessageWriter. + Gets or sets the test case timeout value - The writer on which the actual value is displayed - + - Returns the string representation of the constraint. + Gets a list of ITestActions set by upstream tests - + - EmptyCollectionConstraint tests whether a collection is empty. + Saves or restores the CurrentCulture - + - Check that the collection is empty + Saves or restores the CurrentUICulture - - - + - Write the constraint description to a MessageWriter + Gets or sets the current for the Thread. - - + - 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. + The current head of the ValueFormatter chain, copied from MsgUtils.ValueFormatter - + - Test whether the constraint is satisfied by a given value + If true, all tests must run on the same thread. No new thread may be spawned. - The value to be tested - True for success, false for failure - + - Write the constraint description to a MessageWriter + Record any changes in the environment made by + the test code in the execution context so it + will be passed on to lower level tests. - The writer on which the description is displayed - + - EmptyDirectoryConstraint is used to test that a directory is empty + Set up the execution environment to match a context. + Note that we may be running on the same thread where the + context was initially created or on a different thread. - + - Test whether the constraint is satisfied by a given value + Increments the assert count by one. - The value to be tested - True for success, false for failure - + - Write the constraint description to a MessageWriter + Increments the assert count by a specified amount. - 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. + Adds a new ValueFormatterFactory to the chain of formatters - The writer on which the actual value is displayed + The new factory - + - EmptyStringConstraint tests whether a string is empty. + Obtain lifetime service object + - + - Test whether the constraint is satisfied by a given value + Interface to be implemented by filters applied to tests. + The filter applies when running the test, after it has been + loaded, since this is the only time an ITest exists. - The value to be tested - True for success, false for failure - + - Write the constraint description to a MessageWriter + Unique Empty filter. - The writer on which the description is displayed - + - EndsWithConstraint can test whether a string ends - with an expected substring. + Indicates whether this is the EmptyFilter - + - StringConstraint is the abstract base for constraints - that operate on strings. It supports the IgnoreCase - modifier for string operations. + Indicates whether this is a top-level filter, + not contained in any other filter. - + - The expected value + Determine if a particular test passes the filter criteria. The default + implementation checks the test itself, its parents and any descendants. + + Derived classes may override this method or any of the Match methods + to change the behavior of the filter. + The test to which the filter is applied + True if the test passes the filter, otherwise false - + - Indicates whether tests should be case-insensitive + Determine if a test matches the filter expicitly. That is, it must + be a direct match of the test itself or one of it's children. + The test to which the filter is applied + True if the test matches the filter explicityly, otherwise false - + - Constructs a StringConstraint given an expected value + Determine whether the test itself matches the filter criteria, without + examining either parents or descendants. This is overridden by each + different type of filter to perform the necessary tests. - The expected value + The test to which the filter is applied + True if the filter matches the any parent of the test - + - Test whether the constraint is satisfied by a given value + Determine whether any ancestor of the test matches the filter criteria - The value to be tested - True for success, false for failure + The test to which the filter is applied + True if the filter matches the an ancestor of the test - + - Test whether the constraint is satisfied by a given string + Determine whether any descendant of the test matches the filter criteria. - The string to be tested - True for success, false for failure + The test to be matched + True if at least one descendant matches the filter criteria - + - Modify the constraint to ignore case in matching. + Create a TestFilter instance from an xml representation. - + - Initializes a new instance of the class. + Create a TestFilter from it's TNode representation - 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. + Nested class provides an empty filter - one that always + returns true when called. It never matches explicitly. - - - + - Write the constraint description to a MessageWriter + Adds an XML node - The writer on which the description is displayed + True if recursive + The added XML node - + - 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. + Adds an XML node + Parent node + True if recursive + The added XML node - + - If true, strings in error messages will be clipped + TestListener provides an implementation of ITestListener that + does nothing. It is used only through its NULL property. - + - NUnitEqualityComparer used to test equality. + Called when a test has just started + The test that is starting - + - Initializes a new instance of the class. + Called when a test case has finished - The expected value. + The result of the test - + - Flag the constraint to use a tolerance when determining equality. + Called when a test produces output for immediate display - Tolerance value to be used - Self. + A TestOutput object containing the text to display - + - Flag the constraint to use the supplied IComparer object. + Construct a new TestListener - private so it may not be used. - The IComparer object to use. - Self. - + - Flag the constraint to use the supplied IComparer object. + Get a listener that does nothing - The IComparer object to use. - Self. - + - Flag the constraint to use the supplied IComparer object. + TestProgressReporter translates ITestListener events into + the async callbacks that are used to inform the client + software about the progress of a test run. - The IComparer object to use. - Self. - + - Flag the constraint to use the supplied Comparison object. + Initializes a new instance of the class. - The IComparer object to use. - Self. + The callback handler to be used for reporting progress. - + - Flag the constraint to use the supplied IEqualityComparer object. + Called when a test has just started - The IComparer object to use. - Self. + The test that is starting - + - Flag the constraint to use the supplied IEqualityComparer object. + Called when a test has finished. Sends a result summary to the callback. + to - The IComparer object to use. - Self. + The result of the test - + - Test whether the constraint is satisfied by a given value + Called when a test produces output for immediate display - The value to be tested - True for success, false for failure + A TestOutput object containing the text to display - + - Write a failure message. Overridden to provide custom - failure messages for EqualConstraint. + Returns the parent test item for the targer test item if it exists - The MessageWriter to write to + + parent test item - + - Write description of this constraint + Makes a string safe for use as an attribute, replacing + characters characters that can't be used with their + corresponding xml representations. - The MessageWriter to write to + The string to be used + A new string with the _values replaced - + - Display the failure information for two collections that did not match. + ParameterizedFixtureSuite serves as a container for the set of test + fixtures created from a given Type using various parameters. - 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. + Initializes a new instance of the class. - The MessageWriter on which to display - The expected collection or array - The actual collection or array - The indentation level for the message line + The ITypeInfo for the type that represents the suite. - + - 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. + Gets a string representing the type of test - 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. + ParameterizedMethodSuite holds a collection of individual + TestMethods with their arguments applied. - 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. + Construct from a MethodInfo + - + - Flag the constraint to suppress string clipping - and return self. + Gets a string representing the type of test + - + - Flag the constraint to compare arrays as collections - and return self. + SetUpFixture extends TestSuite and supports + Setup and TearDown methods. - + - Switches the .Within() modifier to interpret its tolerance as - a distance in representable values (see remarks). + Initializes a new instance of the class. - 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. - + The type. - + - Switches the .Within() modifier to interpret its tolerance as - a percentage that the actual values is allowed to deviate from - the expected value. + The Test abstract class represents a test within the framework. - Self - + - Causes the tolerance to be interpreted as a TimeSpan in days. + Static value to seed ids. It's started at 1000 so any + uninitialized ids will stand out. - Self - + - Causes the tolerance to be interpreted as a TimeSpan in hours. + The SetUp methods. - Self - + - Causes the tolerance to be interpreted as a TimeSpan in minutes. + The teardown methods - Self - + - Causes the tolerance to be interpreted as a TimeSpan in seconds. + Used to cache the declaring type for this MethodInfo - Self - + - Causes the tolerance to be interpreted as a TimeSpan in milliseconds. + Method property backing field - Self - + - Causes the tolerance to be interpreted as a TimeSpan in clock ticks. + Constructs a test given its name - Self + The name of the test - + - EqualityAdapter class handles all equality comparisons - that use an IEqualityComparer, IEqualityComparer<T> - or a ComparisonAdapter. + Constructs a test given the path through the + test hierarchy to its parent and a name. + The parent tests full name + The name of the test - + - Compares two objects, returning true if they are equal + TODO: Documentation needed for constructor + - + - Returns true if the two objects can be compared by this adapter. - The base adapter cannot handle IEnumerables except for strings. + Construct a test from a MethodInfo + - + - Returns an EqualityAdapter that wraps an IComparer. + Gets or sets the id of the test + - + - Returns an EqualityAdapter that wraps an IEqualityComparer. + Gets or sets the name of the test - + - Returns an EqualityAdapter that wraps an IEqualityComparer<T>. + Gets or sets the fully qualified name of the test + - + - Returns an EqualityAdapter that wraps an IComparer<T>. + Gets the name of the class where this test was declared. + Returns null if the test is not associated with a class. - + - Returns an EqualityAdapter that wraps a Comparison<T>. + Gets the name of the method implementing this test. + Returns null if the test is not implemented as a method. - + - EqualityAdapter that wraps an IComparer. + Gets the TypeInfo of the fixture used in running this test + or null if no fixture type is associated with it. - + - Returns true if the two objects can be compared by this adapter. - Generic adapter requires objects of the specified type. + Gets a MethodInfo for the method implementing this test. + Returns null if the test is not implemented as a method. - + - EqualityAdapter that wraps an IComparer. + Whether or not the test should be run - + - EqualityAdapterList represents a list of EqualityAdapters - in a common class across platforms. + Gets the name used for the top-level element in the + XML representation of this test - + - ExactCountConstraint applies another constraint to each - item in a collection, succeeding only if a specified - number of items succeed. + Gets a string representing the type of test. Used as an attribute + value in the XML representation of a test and has no other + function in the framework. - + - Construct an ExactCountConstraint on top of an existing constraint + Gets a count of test cases represented by + or contained under this test. - - - + - Apply the item constraint to each item in the collection, - succeeding only if the expected number of items pass. + Gets the properties for this test - - - + - Write a description of this constraint to a MessageWriter + Returns true if this is a TestSuite - - + - ExactTypeConstraint is used to test that an object - is of the exact type provided in the constructor + Gets a bool indicating whether the current test + has any descendant tests. - + - Construct an ExactTypeConstraint for a given Type + Gets the parent as a Test object. + Used by the core to set the parent. - The expected Type. - + - Test that an object is of the exact type specified + Gets this test's child tests - The actual value. - True if the tested object is of the exact type provided, otherwise false. + A list of child tests - + - Write the description of this constraint to a MessageWriter + Gets or sets a fixture object for running this test. - The MessageWriter to use - + - ExceptionTypeConstraint is a special version of ExactTypeConstraint - used to provided detailed info about the exception thrown in - an error message. + Static prefix used for ids in this AppDomain. + Set by FrameworkController. - + - Constructs an ExceptionTypeConstraint + Gets or Sets the Int value representing the seed for the RandomGenerator + - + - Write the actual value for a failing constraint test to a - MessageWriter. Overriden to write additional information - in the case of an Exception. + Creates a TestResult for this test. - The MessageWriter to use + A TestResult suitable for this type of test. - + - FailurePoint class represents one point of failure - in an equality test. + Modify a newly constructed test by applying any of NUnit's common + attributes, based on a supplied ICustomAttributeProvider, which is + usually the reflection element from which the test was constructed, + but may not be in some instances. The attributes retrieved are + saved for use in subsequent operations. + An object implementing ICustomAttributeProvider - + - The location of the failure + Add standard attributes and members to a test node. + + - + - The expected value + Returns the Xml representation of the test + If true, include child tests recursively + - + - The actual value + Returns an XmlNode representing the current result after + adding it as a child of the supplied parent node. + The parent node. + If true, descendant results are included + - + - Indicates whether the expected value is valid + Compares this test to another test for sorting purposes + The other test + Value of -1, 0 or +1 depending on whether the current test is less than, equal to or greater than the other test - + - Indicates whether the actual value is valid + TestAssembly is a TestSuite that represents the execution + of tests in a managed assembly. - + - FailurePointList represents a set of FailurePoints - in a cross-platform way. + Initializes a new instance of the class + specifying the Assembly and the path from which it was loaded. + The assembly this test represents. + The path used to load the assembly. - + - FalseConstraint tests that the actual value is false + Initializes a new instance of the class + for a path which could not be loaded. + The path used to load the assembly. - + - Initializes a new instance of the class. + Gets the Assembly represented by this instance. - - 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/ - - + + + Gets the name used for the top-level element in the + XML representation of this test + - + - Reinterprets the memory contents of a floating point value as an integer value + TestFixture is a surrogate for a user test fixture class, + containing one or more tests. - - 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 + Initializes a new instance of the class. - - Double precision floating point value whose memory contents to reinterpret - - - The memory contents of the double precision floating point value - interpreted as an integer - + Type of the fixture. - + - Reinterprets the memory contents of an integer as a floating point value + The TestMethod class represents a Test implemented as a method. - 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 + The ParameterSet used to create this test method - 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 + + + Initializes a new instance of the class. + + The method to be used as a test. - - The union's value as a floating point variable + + + Initializes a new instance of the class. + + The method to be used as a test. + The suite or fixture to which the new test will be added - - The union's value as an integer + + + Overridden to return a TestCaseResult. + + A TestResult for this test. - - The union's value as an unsigned integer + + + Gets a bool indicating whether the current test + has any descendant tests. + - - Union of a double precision floating point variable and a long + + + Returns a TNode representing the current result after + adding it as a child of the supplied parent node. + + The parent node. + If true, descendant results are included + - - The union's value as a double precision floating point variable + + + Gets this test's child tests + + A list of child tests - - The union's value as a long + + + Gets the name used for the top-level element in the + XML representation of this test + - - The union's value as an unsigned long + + + Returns the name of the method + - + - Tests whether a value is greater than the value supplied to its constructor + TestSuite represents a composite test, which contains other tests. - + - The value against which a comparison is to be made + Our collection of child tests - + - Initializes a new instance of the class. + Initializes a new instance of the class. - The expected value. + The name of the suite. - + - Write the constraint description to a MessageWriter + Initializes a new instance of the class. - The writer on which the description is displayed + Name of the parent suite. + The name of the suite. - + - Test whether the constraint is satisfied by a given value + Initializes a new instance of the class. - The value to be tested - True for success, false for failure + Type of the fixture. - + - Tests whether a value is greater than or equal to the value supplied to its constructor + Initializes a new instance of the class. + Type of the fixture. - + - The value against which a comparison is to be made + Sorts tests under this suite. - + - Initializes a new instance of the class. + Adds a test to the suite. - The expected value. + The test. - + - Write the constraint description to a MessageWriter + Gets this test's child tests - The writer on which the description is displayed + The list of child tests - + - Test whether the constraint is satisfied by a given value + Gets a count of test cases represented by + or contained under this test. - The value to be tested - True for success, false for failure + - + - InstanceOfTypeConstraint is used to test that an object - is of the same type provided or derived from it. + The arguments to use in creating the fixture - + - Construct an InstanceOfTypeConstraint for the type provided + Set to true to suppress sorting this suite's contents - The expected Type - + - Test whether an object is of the specified type or a derived type + Overridden to return a TestSuiteResult. - The object to be tested - True if the object is of the provided type or derives from it, otherwise false. + A TestResult for this test. - + - Write a description of this constraint to a MessageWriter + Gets a bool indicating whether the current test + has any descendant tests. - The MessageWriter to use - + - Tests whether a value is less than the value supplied to its constructor + Gets the name used for the top-level element in the + XML representation of this test - + - The value against which a comparison is to be made + Returns an XmlNode representing the current result after + adding it as a child of the supplied parent node. + The parent node. + If true, descendant results are included + - + - Initializes a new instance of the class. + Check that setup and teardown methods marked by certain attributes + meet NUnit's requirements and mark the tests not runnable otherwise. - The expected value. + The attribute type to check for - + - Write the constraint description to a MessageWriter + ThreadUtility provides a set of static methods convenient + for working with threads. - The writer on which the description is displayed - + - Test whether the constraint is satisfied by a given value + Do our best to Kill a thread - The value to be tested - True for success, false for failure + The thread to kill - + - Tests whether a value is less than or equal to the value supplied to its constructor + Do our best to kill a thread, passing state info + The thread to kill + Info for the ThreadAbortException handler - + - The value against which a comparison is to be made + TypeHelper provides static methods that operate on Types. - + - Initializes a new instance of the class. + A special value, which is used to indicate that BestCommonType() method + was unable to find a common type for the specified arguments. - The expected value. - + - Write the constraint description to a MessageWriter + Gets the display name for a Type as used by NUnit. - The writer on which the description is displayed + The Type for which a display name is needed. + The display name for the Type - + - Test whether the constraint is satisfied by a given value + Gets the display name for a Type as used by NUnit. - The value to be tested - True for success, false for failure + The Type for which a display name is needed. + The arglist provided. + The display name for the Type - + - 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. + Returns the best fit for a common type to be used in + matching actual arguments to a methods Type parameters. + The first type. + The second type. + Either type1 or type2, depending on which is more general. - + - Construct a MessageWriter given a culture + Determines whether the specified type is numeric. + The type to be examined. + + true if the specified type is numeric; otherwise, false. + - + - Method to write single line message with optional args, usually - written to precede the general failure message. + Convert an argument list to the required parameter types. + Currently, only widening numeric conversions are performed. - The message to be written - Any arguments used in formatting the message + An array of args to be converted + A ParameterInfo[] whose types will be used as targets - + - Method to write single line message with optional args, usually - written to precede the general failure message, at a givel - indentation level. + Determines whether this instance can deduce type args for a generic type from the supplied arguments. - The indentation level of the message - The message to be written - Any arguments used in formatting the message + The type to be examined. + The arglist. + The type args to be used. + + true if this the provided args give sufficient information to determine the type args to be used; otherwise, false. + - + - 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. + Gets the _values for an enumeration, using Enum.GetTypes + where available, otherwise through reflection. - 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. + Gets the ids of the _values for an enumeration, + using Enum.GetNames where available, otherwise + through reflection. - 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. + Represents the result of running a single test case. - 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. + Construct a TestCaseResult based on a TestMethod - 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 + A TestMethod to which the result applies. - + - Writes the text for a connector. + Gets the number of test cases that failed + when running the test and all its children. - The connector. - + - Writes the text for a predicate. + Gets the number of test cases that passed + when running the test and all its children. - The predicate. - + - Writes the text for an expected value. + Gets the number of test cases that were skipped + when running the test and all its children. - The expected value. - + - Writes the text for a modifier + Gets the number of test cases that were inconclusive + when running the test and all its children. - The modifier. - + - Writes the text for an actual value. + Indicates whether this result has any child results. - The actual value. - + - Writes the text for a generalized value. + Gets the collection of child results. - The value. - + - Writes the text for a collection value, - starting at a particular point, to a max length + Represents the result of running a test suite - 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 + Construct a TestSuiteResult base on a TestSuite + The TestSuite to which the result applies - + - Static methods used in creating messages + Gets the number of test cases that failed + when running the test and all its children. - + - Static string used when strings are clipped + Gets the number of test cases that passed + when running the test and all its children. - + - 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. + Gets the number of test cases that were skipped + when running the test and all its children. - - - + - Converts any control characters in a string - to their escaped representation. + Gets the number of test cases that were inconclusive + when running the test and all its children. - The string to be converted - The converted string - + - Return the a string representation for a set of indices into an array + Indicates whether this result has any child results. - 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. + Gets the collection of child results. - 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 + Adds a child result to this result, setting this result's + ResultState to Failure if the child result failed. - The string to be clipped - The maximum permitted length of the result string - The point at which to start clipping - The clipped string + The result to be added - + - Clip the expected and actual strings in a coordinated fashion, - so that they may be displayed together. + The TestFixtureData class represents a set of arguments + and other parameter info to be used for a parameterized + fixture. It is derived from TestFixtureParameters and adds a + fluent syntax for use in initializing the fixture. - - - - - + - Shows the position two strings start to differ. Comparison - starts at the start index. + Initializes a new instance of the class. - 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 arguments. - + - NaNConstraint tests that the actual value is a double or float NaN + Initializes a new instance of the class. + + The argument. + + + + Initializes a new instance of the class. + The first argument. + The second argument. - + - Test that the actual value is an NaN + Initializes a new instance of the class. - + The first argument. + The second argument. + The third argument. + + + + Marks the test fixture as explicit. + + + + + Marks the test fixture as explicit, specifying the reason. + + + + + Ignores this TestFixture, specifying the reason. + + The reason. - + + + Asserts on Directories + + + + + The Equals method throws an InvalidOperationException. This is done + to make sure there is no mistake by calling this function. + + + + + + + override the default ReferenceEquals to throw an InvalidOperationException. This + implementation makes sure there is no mistake in calling this function + as part of Assert. + + + + + - Write the constraint description to a specified writer + Verifies that two directories are equal. Two directories are considered + equal if both are null, or if both point to the same directory. + 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 the directories are not equal + Arguments to be used in formatting the message - + - NoItemConstraint applies another constraint to each - item in a collection, failing if any of them succeeds. + Verifies that two directories are equal. Two directories are considered + equal if both are null, or if both point to the same directory. + If they are not equal an is thrown. + A directory containing the value that is expected + A directory containing the actual value - + - Construct a NoItemConstraint on top of an existing constraint + 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 - + - Apply the item constraint to each item in the collection, - failing if any item fails. + 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 - + - Write a description of this constraint to a MessageWriter + Asserts that the directory exists. If it does not exist + an is thrown. - + A directory containing the actual value + The message to display if directories are not equal + Arguments to be used in formatting the message - + - NotConstraint negates the effect of some other constraint + Asserts that the directory exists. If it does not exist + an is thrown. + A directory containing the actual value - + - Initializes a new instance of the class. + Asserts that the directory exists. If it does not exist + an is thrown. - The base constraint to be negated. + The path to a directory containing the actual value + The message to display if directories are not equal + Arguments to be used in formatting the message - + - Test whether the constraint is satisfied by a given value + Asserts that the directory exists. If it does not exist + an is thrown. - The value to be tested - True for if the base constraint fails, false if it succeeds + The path to a directory containing the actual value - + - Write the constraint description to a MessageWriter + Asserts that the directory does not exist. If it does exist + an is thrown. - The writer on which the description is displayed + A directory containing the actual value + The message to display if directories are not equal + Arguments to be used in formatting the message - + - Write the actual value for a failing constraint test to a MessageWriter. + Asserts that the directory does not exist. If it does exist + an is thrown. - The writer on which the actual value is displayed + A directory containing the actual value - + - NullConstraint tests that the actual value is null + Asserts that the directory does not exist. If it does exist + an is thrown. + The path to a directory containing the actual value + The message to display if directories are not equal + Arguments to be used in formatting the message - + - Initializes a new instance of the class. + Asserts that the directory does not exist. If it does exist + an is thrown. + The path to a directory containing the actual value - + - NullEmptyStringConstraint tests whether a string is either null or empty. + Helper class with properties and methods that supply + a number of constraints used in Asserts. - + - Constructs a new NullOrEmptyStringConstraint + Returns a ConstraintExpression that negates any + following constraint. - + - Test whether the constraint is satisfied by a given value + Returns a constraint that succeeds if the value + is a file or directory and it exists. - The value to be tested - True for success, false for failure - + - Write the constraint description to a MessageWriter + Returns a new CollectionContainsConstraint checking for the + presence of a particular object in the collection. - The writer on which the description is displayed - + - The Numerics class contains common operations on numeric values. + 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. - + - Checks the type of the object, returning true if - the object is a numeric type. + Returns a constraint that succeeds if the actual + value starts with the substring supplied as an argument. - 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. + Returns a constraint that succeeds if the actual + value ends with the substring supplied as an argument. - 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. + Returns a constraint that succeeds if the actual + value matches the regular expression supplied as an argument. - 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. + Abstract base for Exceptions that terminate a test and provide a ResultState. - The expected value - The actual value - A reference to the tolerance in effect - True if the values are equal - + + 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 + + - Compare two numeric values, performing the usual numeric conversions. + Serialization Constructor - The expected value - The actual value - The relationship of the values to each other - + - NUnitComparer encapsulates NUnit's default behavior - in comparing two objects. + Gets the ResultState provided by this exception - + - Compares two objects + When implemented by an attribute, this interface implemented to provide actions to execute before and after tests. - - - - + - Returns the default NUnitComparer. + Executed before each test is run + The test that is going to be run. - + - Generic version of NUnitComparer + Executed after each test is run - + The test that has just been run. - + - Compare two objects of the same type + Provides the target for the action attribute + The target for the action attribute - + - NUnitEqualityComparer encapsulates NUnit's handling of - equality tests between objects. + Delegate used by tests that execute code and + capture any thrown exception. - + - + AssertionHelper is an optional base class for user tests, + allowing the use of shorter ids for constraints and + asserts and avoiding conflict with the definition of + , from which it inherits much of its + behavior, in certain mock object frameworks. - + - 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 - + Asserts that a condition is true. If the condition is false the method throws + an . Works Identically to + . + + The evaluated condition + The message to display if the condition is false + Arguments to be used in formatting the message - + - If true, all string comparisons will ignore case + Asserts that a condition is true. If the condition is false the method throws + an . Works Identically to . + The evaluated condition - + - If true, arrays will be treated as collections, allowing - those of different dimensions to be compared + 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 - + - Comparison objects used in comparisons for some constraints. + 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 - + - List of points at which a failure occured. + 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 - + - RecursionDetector used to check for recursion when - evaluating self-referencing enumerables. + 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 - + - Compares two objects for equality within a tolerance, setting - the tolerance to the actual tolerance used if an empty - tolerance is supplied. + 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 - + - Helper method to compare two arrays + Returns a ListMapper based on a collection. + The original collection + - + - Method to compare two DirectoryInfo objects + 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. - first directory to compare - second directory to compare - true if equivalent, false if not - + - Returns the default NUnitEqualityComparer + The Equals method throws an InvalidOperationException. This is done + to make sure there is no mistake by calling this function. + The left object. + The right object. + Not applicable - + - Gets and sets a flag indicating whether case should - be ignored in determining equality. + override the default ReferenceEquals to throw an InvalidOperationException. This + implementation makes sure there is no mistake in calling this function + as part of Assert. + The left object. + The right object. - + - Gets and sets a flag indicating that arrays should be - compared as collections, without regard to their shape. + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an InconclusiveException on failure. + The Type being compared. + An ActualValueDelegate returning the value to be tested + A Constraint expression to be applied - + - Gets the list of external comparers to be used to - test for equality. They are applied to members of - collections, in place of NUnit's own logic. + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an InconclusiveException on failure. + The Type being compared. + 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 - + - Gets the list of failure points for the last Match performed. - The list consists of objects to be interpreted by the caller. - This generally means that the caller may only make use of - objects it has placed on the list at a particular depthy. + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an InconclusiveException on failure. + The Type being compared. + An ActualValueDelegate returning the value to be tested + A Constraint expression to be applied + A function to build the message included with the Exception - + - RecursionDetector detects when a comparison - between two enumerables has reached a point - where the same objects that were previously - compared are again being compared. This allows - the caller to stop the comparison if desired. - + 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 - + - Check whether two objects have previously - been compared, returning true if they have. - The two objects are remembered, so that a - second call will always return true. + Asserts that a condition is true. If the condition is false the + method throws an . + The evaluated condition - + - Represents a constraint that succeeds if all the - members of a collection match a base constraint. - + Asserts that a condition is true. If the condition is false the method throws + an . + + The evaluated condition + A function to build the message included with the Exception - + - Abstract base for operators that indicate how to - apply a constraint to items in a collection. - + Asserts that a condition is true. If the condition is false the method throws + an . + + A lambda that returns a Boolean + The message to display if the condition is false + Arguments to be used in formatting the message - + - PrefixOperator takes a single constraint and modifies - it's action in some way. + Asserts that a condition is true. If the condition is false the method throws + an . + A lambda that returns a Boolean - + - 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. - + Asserts that a condition is true. If the condition is false the method throws + an . + + A lambda that returns a Boolean + A function to build the message included with the Exception - + - The precedence value used when the operator - is about to be pushed to the stack. + 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 - + - The precedence value used when the operator - is on the top of the stack. + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an InconclusiveException on failure. + The Type being compared. + The actual value to test + A Constraint to be applied - + - 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. + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an InconclusiveException on failure. - + The Type being compared. + The actual value to test + A Constraint expression to be applied + The message that will be displayed on failure + Arguments to be used in formatting the message - + - The syntax element preceding this operator + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an InconclusiveException on failure. + The Type being compared. + The actual value to test + A Constraint to be applied + A function to build the message included with the Exception - + - The syntax element folowing this operator + Attribute used to apply a category to a test - + - The precedence value used when the operator - is about to be pushed to the stack. + The name of the category - + - The precedence value used when the operator - is on the top of the stack. + 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 - + - 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. + Protected constructor uses the Type name as the name + of the category. - - + - Returns the constraint created by applying this - prefix to another constraint. + The name of the category - - - + - Constructs a CollectionOperator + Modifies a test by adding a category to it. + The test to modify - + - Returns a constraint that will apply the argument - to the members of a collection, succeeding if - they all succeed. + Marks a test to use a combinatorial join of any argument + data provided. Since this is the default, the attribute is + optional. - + - Operator that requires both it's arguments to succeed + Default constructor - + - Abstract base class for all binary operators + CultureAttribute is used to mark a test fixture or an + individual method as applying to a particular Culture only. - + - 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. + Constructor with no cultures specified, for use + with named property syntax. - - + - Abstract method that produces a constraint by applying - the operator to its left and right constraint arguments. + Constructor taking one or more cultures + Comma-deliminted list of cultures - + - Gets the left precedence of the operator + Causes a test to be skipped if this CultureAttribute is not satisfied. + The test to modify - + - Gets the right precedence of the operator + Tests to determine if the current culture is supported + based on the properties of this attribute. + True, if the current culture is supported - + - Construct an AndOperator + Test to determine if the a particular culture or comma- + delimited set of cultures is in use. + Name of the culture or comma-separated list of culture ids + True if the culture is in use on the system - + - Apply the operator to produce an AndConstraint + Test to determine if one of a collection of cultures + is being used currently. + + - + - Operator that tests for the presence of a particular attribute - on a type and optionally applies further tests to the attribute. + The abstract base class for all data-providing attributes + defined by NUnit. Used to select all data sources for a + method, class or parameter. - + - Abstract base class for operators that are able to reduce to a - constraint whether or not another syntactic element follows. + Default constructor - + - Construct an AttributeOperator for a particular Type + 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. - 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. + Used to mark a field, property or method providing a set of datapoints to + be used in executing any theories within the same fixture that require an + argument of the Type provided. The data source may provide an array of + the required Type or an . + Synonymous with DatapointSourceAttribute. - + - CollectionOrderedConstraint is used to test whether a collection is ordered. + Used to mark a field, property or method providing a set of datapoints to + be used in executing any theories within the same fixture that require an + argument of the Type provided. The data source may provide an array of + the required Type or an . + Synonymous with DatapointsAttribute. - + - Construct a CollectionOrderedConstraint + Attribute used to provide descriptive text about a + test case or fixture. - + - Modifies the constraint to use an IComparer and returns self. + Construct a description Attribute + The text of the description - + - Modifies the constraint to use an IComparer<T> and returns self. + 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. - + - Modifies the constraint to use a Comparison<T> and returns self. + Default constructor - + - Modifies the constraint to test ordering by the value of - a specified property and returns self. + Constructor with a reason + The reason test is marked explicit - + - Test whether the collection is ordered + Modifies a test by marking it as explicit. - - + The test to modify - + - Write a description of the constraint to a MessageWriter + Attribute used to mark a test that is to be ignored. + Ignored tests result in a warning message when the + tests are run. - - + - Returns the string representation of the constraint. + Constructs the attribute giving a reason for ignoring the test - + The reason for ignoring the test - + - If used performs a reverse comparison + - + - Represents a constraint that succeeds if the specified - count of members of a collection match a base constraint. + The date in the future to stop ignoring the test as a string in UTC time. + For example for a date and time, "2014-12-25 08:10:00Z" or for just a date, + "2014-12-25". If just a date is given, the Ignore will expire at midnight UTC. + + Once the ignore until date has passed, the test will be marked + as runnable. Tests with an ignore until date will have an IgnoreUntilDate + property set which will appear in the test results. + + The string does not contain a valid string representation of a date and time. - + - Construct an ExactCountOperator for a specified count + Modifies a test by marking it as Ignored. - The expected count + The test to modify - + - Returns a constraint that will apply the argument - to the members of a collection, succeeding if - none of them succeed. + Abstract base for Attributes that are used to include tests + in the test run based on environmental settings. - + - Represents a constraint that succeeds if none of the - members of a collection match a base constraint. + Constructor with no included items specified, for use + with named property syntax. - + - Returns a constraint that will apply the argument - to the members of a collection, succeeding if - none of them succeed. + Constructor taking one or more included items + Comma-delimited list of included items - + - Negates the test of the constraint it wraps. + Name of the item that is needed in order for + a test to run. Multiple items may be given, + separated by a comma. - + - Constructs a new NotOperator + Name of the item to be excluded. Multiple items + may be given, separated by a comma. - + - Returns a NotConstraint applied to its argument. + The reason for including or excluding the test - + - Operator that requires at least one of it's arguments to succeed + Summary description for MaxTimeAttribute. - + - Construct an OrOperator + Construct a MaxTimeAttribute, given a time in milliseconds. + The maximum elapsed time in milliseconds - + - Apply the operator to produce an OrConstraint + The abstract base class for all custom attributes defined by NUnit. - - - 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. + + + Default constructor - + - Constructs a PropOperator for a particular named property + Marks a test to use a pairwise join of any argument + data provided. Arguments will be combined in such a + way that all possible pairs of arguments are used. - + - 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. + Default constructor - - + - Gets the name of the property to which the operator applies + PlatformAttribute is used to mark a test fixture or an + individual method as applying to a particular platform only. - + - Operator that tests that an exception is thrown and - optionally applies further tests to the exception. + Constructor with no platforms specified, for use + with named property syntax. - + - Construct a ThrowsOperator + Constructor taking one or more platforms + Comma-delimited list of platforms - + - 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. + Causes a test to be skipped if this PlatformAttribute is not satisfied. + The test to modify - + - 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. + PropertyAttribute is used to attach information to a test as a name/value pair.. - + - Constructor for the WithOperator + Construct a PropertyAttribute with a name and string value + The name of the property + The property value - + - Returns a constraint that wraps its argument + Construct a PropertyAttribute with a name and int value + The name of the property + The property value - + - OrConstraint succeeds if either member succeeds + Construct a PropertyAttribute with a name and double value + The name of the property + The property value - + - Create an OrConstraint from two other constraints + Constructor for derived classes that set the + property dictionary directly. - The first constraint - The second constraint - + - Apply the member constraints to an actual value, succeeding - succeeding as soon as one of them succeeds. + 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. - The actual value - True if either constraint succeeded - + - Write a description for this contraint to a MessageWriter + Gets the property dictionary for this attribute - The MessageWriter to receive the description - + - PathConstraint serves as the abstract base of constraints - that operate on paths and provides several helper methods. + Modifies a test by adding properties to it. + The test to modify - + - The expected path used in the constraint + RandomAttribute is used to supply a set of random _values + to a single parameter of a parameterized test. - + - Flag indicating whether a caseInsensitive comparison should be made + Construct a random set of values appropriate for the Type of the + parameter on which the attribute appears, specifying only the count. + - + - Construct a PathConstraint for a give expected path + Construct a set of ints within a specified range - The expected path - + - Test whether the constraint is satisfied by a given value + Construct a set of unsigned ints within a specified range - The value to be tested - True for success, false for failure - + - Returns true if the expected path and actual path match + Construct a set of longs within a specified range - + - Returns the string representation of this constraint + Construct a set of unsigned longs within a specified range - + - Transform the provided path to its canonical form so that it - may be more easily be compared with other paths. + Construct a set of shorts within a specified range - The original path - The path in canonical form - + - Test whether one path in canonical form is under another. + Construct a set of unsigned shorts within a specified range - The first path - supposed to be the parent path - The second path - supposed to be the child path - Indicates whether case should be ignored - - + - Modifies the current instance to be case-insensitve - and returns it. + Construct a set of doubles within a specified range - + - Modifies the current instance to be case-sensitve - and returns it. + Construct a set of floats within a specified range - + - Predicate constraint wraps a Predicate in a constraint, - returning success if the predicate is true. + Construct a set of bytes within a specified range - + - Construct a PredicateConstraint from a predicate + Construct a set of sbytes within a specified range - + - Determines whether the predicate succeeds when applied - to the actual value. + Get the collection of _values to be used as arguments. - + - Writes the description to a MessageWriter + RangeAttribute is used to supply a range of _values to an + individual parameter of a parameterized test. - + - PropertyConstraint extracts a named property and uses - its value as the actual value for a chained constraint. + Construct a range of ints using default step of 1 + + - + - Initializes a new instance of the class. + Construct a range of ints specifying the step size - The name. - The constraint to apply to the property. + + + - + - Test whether the constraint is satisfied by a given value + Construct a range of unsigned ints using default step of 1 - The value to be tested - True for success, false for failure + + - + - Write the constraint description to a MessageWriter + Construct a range of unsigned ints specifying the step size - 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. + Construct a range of longs using a default step of 1 - The writer on which the actual value is displayed + + - + - Returns the string representation of the constraint. + Construct a range of longs - + + + - + - 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. + Construct a range of unsigned longs using default step of 1 + + - + - Initializes a new instance of the class. + Construct a range of unsigned longs specifying the step size - The name of the property. + + + - + - Test whether the property exists for a given object + Construct a range of doubles - The object to be tested - True for success, false for failure + + + - + - Write the constraint description to a MessageWriter + Construct a range of floats - The writer on which the description is displayed + + + - + - Write the actual value for a failing constraint test to a - MessageWriter. + RepeatAttribute may be applied to test case in order + to run it multiple times. - The writer on which the actual value is displayed - + - Returns the string representation of the constraint. + Construct a RepeatAttribute - + The number of times to run the test - + - RangeConstraint tests whether two values are within a - specified range. + Wrap a command and return the result. + The command to be wrapped + The wrapped command - + - Initializes a new instance of the class. + The test command for the RepeatAttribute - From. - To. - + - Test whether the constraint is satisfied by a given value + Initializes a new instance of the class. - The value to be tested - True for success, false for failure + The inner command. + The number of repetitions - + - Write the constraint description to a MessageWriter + Runs the test, saving a TestResult in the supplied TestExecutionContext. - The writer on which the description is displayed + The context in which the test should run. + A TestResult - + - RegexConstraint can test whether a string matches - the pattern provided. + 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. - + - Initializes a new instance of the class. + Construct a RequiresMTAAttribute - The pattern. - + - Test whether the constraint is satisfied by a given value + Marks a test that must run in the STA, causing it + to run in a separate thread if necessary. - The value to be tested - True for success, false for failure - + - Write the constraint description to a MessageWriter + Construct a RequiresSTAAttribute - 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. + Marks a test that must run on a separate thread. - + - Create a new instance of ResolvableConstraintExpression + Construct a RequiresThreadAttribute - + - Create a new instance of ResolvableConstraintExpression, - passing in a pre-populated ConstraintBuilder. + Construct a RequiresThreadAttribute, specifying the apartment - + - Resolve the current expression to a Constraint + Marks a test to use a Sequential join of any argument + data provided. Arguments will be combined into test cases, + taking the next value of each argument until all are used. - + - This operator creates a constraint that is satisfied only if both - argument constraints are satisfied. + Default constructor - + - This operator creates a constraint that is satisfied only if both - argument constraints are satisfied. + Summary description for SetCultureAttribute. - + - This operator creates a constraint that is satisfied only if both - argument constraints are satisfied. + Construct given the name of a culture + - + - This operator creates a constraint that is satisfied if either - of the argument constraints is satisfied. + Summary description for SetUICultureAttribute. - + - This operator creates a constraint that is satisfied if either - of the argument constraints is satisfied. + Construct given the name of a culture + - + - This operator creates a constraint that is satisfied if either - of the argument constraints is satisfied. + 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. - + - This operator creates a constraint that is satisfied if the - argument constraint is not satisfied. + 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. - + - Appends an And Operator to the expression + 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. - + - Appends an Or operator to the expression. + SetUpFixtureAttribute is used to identify a SetUpFixture - + - ReusableConstraint wraps a constraint expression after - resolving it so that it can be reused consistently. + Build a SetUpFixture from type provided. Normally called for a Type + on which the attribute has been placed. + The type info of the fixture to be used. + A SetUpFixture object as a TestSuite. - + - Construct a ReusableConstraint from a constraint expression + Attribute used to identify a method that is called + immediately after each test is run. The method is + guaranteed to be called, even if an exception is thrown. - The expression to be resolved and reused - + - Converts a constraint to a ReusableConstraint + 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. - The constraint to be converted - A ReusableConstraint + + + [TestFixture] + public class Fixture + { + [Test] + public void MethodToTest() + {} + + [Test(Description = "more detailed description")] + public void TestDescriptionMethod() + {} + } + + - + - Returns the string representation of the constraint. + Descriptive text for this test - A string representing the constraint - + - Resolves the ReusableConstraint by returning the constraint - that it originally wrapped. + The author of this test - A resolved constraint - + - SameAsConstraint tests whether an object is identical to - the object passed to its constructor + The type that this test is testing - + - Initializes a new instance of the class. + Modifies a test by adding a description, if not already set. - The expected object. + The test to modify - + - Test whether the constraint is satisfied by a given value + Gets or sets the expected result. - The value to be tested - True for success, false for failure + The result. - + - Write the constraint description to a MessageWriter + Returns true if an expected result has been set - The writer on which the description is displayed - + - Summary description for SamePathConstraint. + Construct a TestMethod from a given method. + The method for which a test is to be constructed. + The suite to which the test will be added. + A TestMethod - + - Initializes a new instance of the class. + TestCaseAttribute is used to mark parameterized test cases + and provide them with their arguments. - The expected path - + - Test whether the constraint is satisfied by a given value + Construct a TestCaseAttribute with a list of arguments. + This constructor is not CLS-Compliant - The expected path - The actual path - True for success, false for failure + - + - Write the constraint description to a MessageWriter + Construct a TestCaseAttribute with a single argument - The writer on which the description is displayed + - + - SamePathOrUnderConstraint tests that one path is under another + Construct a TestCaseAttribute with a two arguments + + - + - Initializes a new instance of the class. + Construct a TestCaseAttribute with a three arguments - The expected path + + + - + - Test whether the constraint is satisfied by a given value + Gets or sets the name of the test. - The expected path - The actual path - True for success, false for failure + The name of the test. - + - Write the constraint description to a MessageWriter + Gets or sets the RunState of this test case. - The writer on which the description is displayed - + - BinarySerializableConstraint tests whether - an object is serializable in binary format. + Gets the list of arguments to a test case - + - Test whether the constraint is satisfied by a given value + Gets the properties of the test case - The value to be tested - True for success, false for failure - + - Write the constraint description to a MessageWriter + Gets or sets the expected result. - The writer on which the description is displayed + The result. - + - 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. + Returns true if the expected result has been set - The writer on which the actual value is displayed - + - Returns the string representation + Gets or sets the description. + The description. - + - Represents a constraint that succeeds if any of the - members of a collection match a base constraint. + The author of this test - + - Returns a constraint that will apply the argument - to the members of a collection, succeeding if - any of them succeed. + The type that this test is testing - + - SomeItemsConstraint applies another constraint to each - item in a collection, succeeding if any of them succeeds. + Gets or sets the reason for ignoring the test - + - Construct a SomeItemsConstraint on top of an existing constraint + Gets or sets a value indicating whether this is explicit. - + + true if explicit; otherwise, false. + - + - Apply the item constraint to each item in the collection, - succeeding if any item succeeds. + Gets or sets the reason for not running the test. - - + The reason. - + - Write a description of this constraint to a MessageWriter + Gets or sets the ignore reason. When set to a non-null + non-empty value, the test is marked as ignored. - + The ignore reason. - + - StartsWithConstraint can test whether a string starts - with an expected substring. + Comma-delimited list of platforms to run the test for - + - Initializes a new instance of the class. + Comma-delimited list of platforms to not run the test for - 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. + Gets and sets the category for this test case. + May be a comma-separated list of categories. - - - + - Write the constraint description to a MessageWriter + Performs several special conversions allowed by NUnit in order to + permit arguments with types that cannot be used in the constructor + of an Attribute such as TestCaseAttribute or to simplify their use. - The writer on which the description is displayed + The arguments to be converted + The ParameterInfo array for the method - + - SubPathConstraint tests that the actual path is under the expected path + Construct one or more TestMethods from a given MethodInfo, + using available parameter data. + The MethodInfo for which tests are to be constructed. + The suite to which the tests will be added. + One or more TestMethods - + - Initializes a new instance of the class. + TestCaseSourceAttribute indicates the source to be used to + provide test cases for a test method. - The expected path - + - Test whether the constraint is satisfied by a given value + Construct with the name of the method, property or field that will provide data - The expected path - The actual path - True for success, false for failure + The name of a static method, property or field that will provide data. - + - Write the constraint description to a MessageWriter + Construct with a Type and name - The writer on which the description is displayed + The Type that will provide data + The name of a static method, property or field that will provide data. + A set of parameters passed to the method, works only if the Source Name is a method. + If the source name is a field or property has no effect. - + - SubstringConstraint can test whether a string contains - the expected substring. + Construct with a Type and name + The Type that will provide data + The name of a static method, property or field that will provide data. - + - Initializes a new instance of the class. + Construct with a Type - The expected. + The type that will provide data - + - Test whether the constraint is satisfied by a given value + A set of parameters passed to the method, works only if the Source Name is a method. + If the source name is a field or property has no effect. - The value to be tested - True for success, false for failure - + - Write the constraint description to a MessageWriter + The name of a the method, property or fiend to be used as a source - 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. + A Type to be used as a source - + - Initializes a new instance of the class, - using a constraint to be applied to the exception. + Gets or sets the category associated with every fixture created from + this attribute. May be a single category or a comma-separated list. - 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. + Construct one or more TestMethods from a given MethodInfo, + using available parameter data. - A delegate representing the code to be tested - True if an exception is thrown and the constraint succeeds, otherwise false + The IMethod for which tests are to be constructed. + The suite to which the tests will be added. + One or more TestMethods - + - Converts an ActualValueDelegate to a TestDelegate - before calling the primary overload. + Returns a set of ITestCaseDataItems for use as arguments + to a parameterized test method. + The method for which data is needed. + - + - Write the constraint description to a MessageWriter + TestFixtureAttribute is used to mark a class that represents a TestFixture. - 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. + Default constructor - The writer on which the actual value is displayed - + - Returns the string representation of this constraint + 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. + - + - Get the actual exception thrown - used by Assert.Throws. + Gets or sets the name of the test. + The name of the test. - + - ThrowsNothingConstraint tests that a delegate does not - throw an exception. + Gets or sets the RunState of this test fixture. - + - Test whether the constraint is satisfied by a given value + The arguments originally provided to the attribute - The value to be tested - True if no exception is thrown, otherwise false - + - Test whether the constraint is satisfied by a given delegate + Properties pertaining to this fixture - Delegate returning the value to be tested - True if no exception is thrown, otherwise false - + - Write the constraint description to a MessageWriter + Get or set the type arguments. If not set + explicitly, any leading arguments that are + Types are taken as type arguments. - The writer on which the description is displayed - + - Write the actual value for a failing constraint test to a - MessageWriter. Overridden in ThrowsNothingConstraint to write - information about the exception that was actually caught. + Descriptive text for this fixture - The writer on which the actual value is displayed - + - 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. + The author of this fixture - + - Constructs a linear tolerance of a specdified amount + The type that this fixture is testing - + - Constructs a tolerance given an amount and ToleranceMode + Gets or sets the ignore reason. May set RunState as a side effect. + The ignore reason. - + - Tests that the current Tolerance is linear with a - numeric value, throwing an exception if it is not. + Gets or sets the reason for not running the fixture. + The reason. - + - 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. + Gets or sets the ignore reason. When set to a non-null + non-empty value, the test is marked as ignored. + The ignore reason. - + - Returns a zero Tolerance object, equivalent to - specifying an exact match. + Gets or sets a value indicating whether this is explicit. + + true if explicit; otherwise, false. + - + - Gets the ToleranceMode for the current Tolerance + Gets and sets the category for this fixture. + May be a comma-separated list of categories. - + - Gets the value of the current Tolerance instance. + Build a fixture from type provided. Normally called for a Type + on which the attribute has been placed. + The type info of the fixture to be used. + A an IEnumerable holding one TestFixture object. - + - Returns a new tolerance, using the current amount as a percentage. + Attribute used to identify a method that is + called before any tests in a fixture are run. - + - Returns a new tolerance, using the current amount in Ulps. + 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. - + - Returns a new tolerance with a TimeSpan as the amount, using - the current amount as a number of days. + 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")] + public void TestDescriptionMethod() + {} + } + + - + - Returns a new tolerance with a TimeSpan as the amount, using - the current amount as a number of hours. + Construct the attribute, specifying a combining strategy and source of parameter data. - + - Returns a new tolerance with a TimeSpan as the amount, using - the current amount as a number of minutes. + 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 class or assembly, sets the default timeout + for all contained test methods. - + - Returns a new tolerance with a TimeSpan as the amount, using - the current amount as a number of seconds. + Construct a TimeoutAttribute given a time in milliseconds + The timeout value in milliseconds - + - Returns a new tolerance with a TimeSpan as the amount, using - the current amount as a number of milliseconds. + ValuesAttribute is used to provide literal arguments for + an individual parameter of a test. - + - Returns a new tolerance with a TimeSpan as the amount, using - the current amount as a number of clock ticks. + 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 - + - Returns true if the current tolerance is empty. + Constructs for use with an Enum parameter. Will pass every enum + value in to the test. - + - Modes in which the tolerance value for a comparison can be interpreted. + Construct with one argument + - + - 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. + Construct with two arguments + + - + - The tolerance is used as a numeric range within which - two compared values are considered to be equal. + Construct with three arguments + + + - + - Interprets the tolerance as the percentage by which - the two compared values my deviate from each other. + Construct with an array of arguments + - + - Compares two values based in their distance in - representable numbers. + Get the collection of _values to be used as arguments - + - TrueConstraint tests that the actual value is true + ValueSourceAttribute indicates the source to be used to + provide data for one parameter of a test method. - + - Initializes a new instance of the class. + Construct with the name of the factory - for use with languages + that don't support params arrays. + The name of a static method, property or field that will provide data. - + - UniqueItemsConstraint tests whether all the items in a - collection are unique. + 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 a static method, property or field that will provide data. - + - Check that all items are unique. + The name of a the method, property or fiend to be used as a source - - - + - Write a description of this constraint to a MessageWriter + A Type to be used as a source - - + - XmlSerializableConstraint tests whether - an object is serializable in XML format. + Gets an enumeration of data items for use as arguments + for a test method parameter. + The parameter for which data is needed + + An enumeration containing individual data items + - + - Test whether the constraint is satisfied by a given value + A set of Assert methods operating on one or more collections - The value to be tested - True for success, false for failure - + - Write the constraint description to a MessageWriter + The Equals method throws an InvalidOperationException. This is done + to make sure there is no mistake by calling this function. - 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. + override the default ReferenceEquals to throw an InvalidOperationException. This + implementation makes sure there is no mistake in calling this function + as part of Assert. - The writer on which the actual value is displayed + + - + - Returns the string representation of this constraint + 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 - + - Helper class with properties and methods that supply - a number of constraints used in Asserts. + 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 - + - Returns a new CollectionContainsConstraint checking for the - presence of a particular object in the collection. + Asserts that all items contained in collection are not equal to null. + IEnumerable containing objects to be considered - + - Returns a constraint that succeeds if the actual - value contains the substring supplied as an argument. + 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 - + - Summary description for DirectoryAssert + Ensures that every object contained in collection exists within the collection + once and only once. + IEnumerable of objects to be considered - + - The Equals method throws an AssertionException. This is done - to make sure there is no mistake by calling this function. + 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 - + - 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 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 - + - 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. + 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 - + - 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. + 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. - A directory containing the value that is expected - A directory containing the actual value - The message to display if directories are not 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 - + - 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. + 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. - A directory containing the value that is expected - A directory containing the actual value - The message to display if directories are not equal + 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 - + - 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. + Asserts that expected and actual are equivalent, containing the same objects but the match may be in any order. - A directory containing the value that is expected - A directory containing the actual value + The first IEnumerable of objects to be considered + The second IEnumerable of objects to be considered - + - 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. + Asserts that expected and actual are equivalent, containing the same objects but the match may be in any order. - 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 + 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 - + - 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. + Asserts that expected and actual are not exactly equal. - 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 + The first IEnumerable of objects to be considered + The second IEnumerable of objects to be considered - + - 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. + Asserts that expected and actual are not exactly equal. + If comparer is not null then it will be used to compare the objects. - A directory path string containing the value that is expected - A directory path string containing the actual value + 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 two directories are not equal. If they are equal - an is thrown. + Asserts that expected and actual are not exactly equal. - A directory containing the value that is expected - A directory containing the actual value - The message to display if directories are not 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 two directories are not equal. If they are equal - an is thrown. + Asserts that expected and actual are not exactly equal. + If comparer is not null then it will be used to compare the objects. - A directory containing the value that is expected - A directory containing the actual value - The message to display if directories are not equal + 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 two directories are not equal. If they are equal - an is thrown. + Asserts that expected and actual are not equivalent. - A directory containing the value that is expected - A directory containing the actual value + The first IEnumerable of objects to be considered + The second IEnumerable of objects to be considered - + - Asserts that two directories are not equal. If they are equal - an is thrown. + Asserts that expected and actual are not equivalent. - 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 + 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 two directories are not equal. If they are equal - an is thrown. + Asserts that collection contains actual as an item. - 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 + IEnumerable of objects to be considered + Object to be found within collection - + - Asserts that two directories are not equal. If they are equal - an is thrown. + Asserts that collection contains actual as an item. - A directory path string containing the value that is expected - A directory path string containing the actual value + 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 the directory is empty. If it is not empty - an is thrown. + Asserts that collection does not contain actual as an item. - A directory to search - The message to display if directories are not equal - Arguments to be used in formatting the message + IEnumerable of objects to be considered + Object that cannot exist within collection - + - Asserts that the directory is empty. If it is not empty - an is thrown. + Asserts that collection does not contain actual as an item. - A directory to search - The message to display if directories are not equal + 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 the directory is empty. If it is not empty - an is thrown. + Asserts that the superset does not contain the subset - A directory to search + The IEnumerable subset to be considered + The IEnumerable superset to be considered - + - Asserts that the directory is empty. If it is not empty - an is thrown. + Asserts that the superset does not contain the subset - A directory to search - The message to display if directories are not equal + The IEnumerable subset to be considered + The IEnumerable superset to be considered + The message that will be displayed on failure Arguments to be used in formatting the message - + - Asserts that the directory is empty. If it is not empty - an is thrown. + Asserts that the superset contains the subset. - A directory to search - The message to display if directories are not equal + The IEnumerable subset to be considered + The IEnumerable superset to be considered - + - Asserts that the directory is empty. If it is not empty - an is thrown. + Asserts that the superset contains the subset. - A directory to search + The IEnumerable subset to be considered + The IEnumerable superset to be considered + The message that will be displayed on failure + Arguments to be used in formatting the message - + - Asserts that the directory is not empty. If it is empty - an is thrown. + Asserts that the subset does not contain the superset - A directory to search - The message to display if directories are not equal - Arguments to be used in formatting the message + The IEnumerable superset to be considered + The IEnumerable subset to be considered - + - Asserts that the directory is not empty. If it is empty - an is thrown. + Asserts that the subset does not contain the superset - A directory to search - The message to display if directories are not equal + 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 the directory is not empty. If it is empty - an is thrown. + Asserts that the subset contains the superset. - A directory to search + The IEnumerable superset to be considered + The IEnumerable subset to be considered - + - Asserts that the directory is not empty. If it is empty - an is thrown. + Asserts that the subset contains the superset. - A directory to search - The message to display if directories are not equal + 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 the directory is not empty. If it is empty - an is thrown. + Assert that an array, list or other collection is empty - A directory to search - The message to display if directories are not equal + An array, list or other collection implementing IEnumerable + The message to be displayed on failure + Arguments to be used in formatting the message - + - Asserts that the directory is not empty. If it is empty - an is thrown. + Assert that an array,list or other collection is empty - A directory to search + An array, list or other collection implementing IEnumerable - + - Asserts that path contains actual as a subdirectory or - an is thrown. + Assert that an array, list or other collection is empty - A directory to search - sub-directory asserted to exist under directory - The message to display if directory is not within the path + An array, list or other collection implementing IEnumerable + The message to be displayed on failure 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. + Assert that an array,list or other collection is empty - A directory to search - sub-directory asserted to exist under directory + An array, list or other collection implementing IEnumerable - + - Asserts that path contains actual as a subdirectory or - an is thrown. + Assert that an array, list or other collection is ordered - A directory to search - sub-directory asserted to exist under directory - The message to display if directory is not within the path + An array, list or other collection implementing IEnumerable + The message to be displayed on failure Arguments to be used in formatting the message - + - Asserts that path contains actual as a subdirectory or - an is thrown. + Assert that an array, list or other collection is ordered - A directory to search - sub-directory asserted to exist under directory - The message to display if directory is not within the path + An array, list or other collection implementing IEnumerable - + - Asserts that path contains actual as a subdirectory or - an is thrown. + Assert that an array, list or other collection is ordered - A directory to search - sub-directory asserted to exist under directory + 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 - + - Asserts that path does not contain actual as a subdirectory or - an is thrown. + Assert that an array, list or other collection is ordered - 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 + An array, list or other collection implementing IEnumerable + A custom comparer to perform the comparisons - + - Asserts that path does not contain actual as a subdirectory or - an is thrown. + Helper class with properties and methods that supply + a number of constraints used in Asserts. - 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. + Returns a new CollectionContainsConstraint checking for the + presence of a particular object in the collection. - 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. + Returns a new DictionaryContainsKeyConstraint checking for the + presence of a particular key in the dictionary. - 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. + Returns a new DictionaryContainsValueConstraint checking for the + presence of a particular value in the dictionary. - 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. + Returns a constraint that succeeds if the actual + value contains the substring supplied as an argument. - A directory to search - sub-directory asserted to exist under directory @@ -9228,6 +15954,11 @@ Serialization Constructor + + + Gets the ResultState provided by this exception + + Thrown when an assertion failed. @@ -9247,6 +15978,11 @@ Serialization Constructor + + + Gets the ResultState provided by this exception + + Thrown when a test executes inconclusively. @@ -9267,6 +16003,11 @@ Serialization Constructor + + + Gets the ResultState provided by this exception + + Thrown when an assertion failed. @@ -9286,14 +16027,19 @@ Serialization Constructor + + + Gets the ResultState provided by this exception + + - Summary description for FileAssert. + Asserts on Files - The Equals method throws an AssertionException. This is done + The Equals method throws an InvalidOperationException. This is done to make sure there is no mistake by calling this function. @@ -9301,20 +16047,13 @@ - override the default ReferenceEquals to throw an AssertionException. This + override the default ReferenceEquals to throw an InvalidOperationException. 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 @@ -9326,16 +16065,6 @@ 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 @@ -9356,16 +16085,6 @@ 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 @@ -9386,16 +16105,6 @@ 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 @@ -9415,15 +16124,6 @@ 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 @@ -9442,15 +16142,6 @@ 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 @@ -9469,15 +16160,6 @@ 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 @@ -9486,73 +16168,87 @@ 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. + Asserts that the file exists. If it does not exist + an is thrown. + A file containing the actual value + The message to display if Streams are not equal + Arguments to be used in formatting the message - + - Default tolerance for floating point equality + Asserts that the file exists. If it does not exist + an is thrown. + A file containing the actual value - + - Class used to guard against unexpected argument values - by throwing an appropriate exception. + Asserts that the file exists. If it does not exist + an is thrown. + 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 - + - Throws an exception if an argument is null + Asserts that the file exists. If it does not exist + an is thrown. - The value to be tested - The name of the argument + The path to a file containing the actual value - + - Throws an exception if a string argument is null or empty + Asserts that the file does not exist. If it does exist + an is thrown. - The value to be tested - The name of the argument + A file containing the actual value + The message to display if Streams are not equal + Arguments to be used in formatting the message - + - Helper class with properties and methods that supply - a number of constraints used in Asserts. + Asserts that the file does not exist. If it does exist + an is thrown. + A file containing the actual value - + - Returns a ConstraintExpression, which will apply - the following constraint to all members of a collection, - succeeding only if a specified number of them succeed. + Asserts that the file does not exist. If it does exist + an is thrown. + 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 - + - 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. + Asserts that the file does not exist. If it does exist + an is thrown. + The path to a file containing the actual value - + - Returns a new AttributeConstraint checking for the - presence of a particular attribute on an object. + GlobalSettings is a place for setting default values used + by the framework in performing asserts. Anything set through + this class applies to the entire test run. It should not normally + be used from within a test, since it is not thread-safe. - + - Returns a new AttributeConstraint checking for the - presence of a particular attribute on an object. + Default tolerance for floating point equality - + - Returns a new CollectionContainsConstraint checking for the - presence of a particular object in the collection. + Helper class with properties and methods that supply + a number of constraints used in Asserts. @@ -9582,6 +16278,20 @@ succeeding if all of them fail. + + + 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 ConstraintExpression, which will apply the following @@ -9606,79 +16316,97 @@ constraint to the InnerException property of the object being tested. - + - + 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. - - + - Compares two objects of a given Type for equality within a tolerance + Returns a new CollectionContainsConstraint checking for the + presence of a particular object in the collection. - The first object to compare - The second object to compare - The tolerance to use in the comparison - - + - 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. + Helper class with properties and methods that supply + a number of constraints used in Asserts. - + - Method to handle an expected exception + Returns a ConstraintExpression that negates any + following constraint. - The exception to be handled - + - Provides details about a test + Returns a ConstraintExpression, which will apply + the following constraint to all members of a collection, + succeeding if all of them succeed. - + - Creates an instance of TestDetails + Returns a constraint that tests for null - 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. + Returns a constraint that tests for True - + - The method that implements the test, if available. + Returns a constraint that tests for False - + - The full name of the test. + Returns a constraint that tests for a positive value - + - A string representing the type of test, e.g. "Test Case". + Returns a constraint that tests for a negative value - + - Indicates if the test represents a suite of tests. + Returns a constraint that tests for equality with zero - + - Helper class with properties and methods that supply - a number of constraints used in Asserts. + 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. @@ -9694,37 +16422,37 @@ Returns a constraint that tests whether the - actual value is greater than the suppled argument + actual value is greater than the supplied argument Returns a constraint that tests whether the - actual value is greater than or equal to the suppled argument + actual value is greater than or equal to the supplied argument Returns a constraint that tests whether the - actual value is greater than or equal to the suppled argument + actual value is greater than or equal to the supplied argument Returns a constraint that tests whether the - actual value is less than the suppled argument + actual value is less than the supplied argument Returns a constraint that tests whether the - actual value is less than or equal to the suppled argument + actual value is less than or equal to the supplied argument Returns a constraint that tests whether the - actual value is less than or equal to the suppled argument + actual value is less than or equal to the supplied argument @@ -9751,18 +16479,6 @@ 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 @@ -9778,13 +16494,13 @@ Returns a constraint that tests whether the actual value - is assignable from the type supplied as an argument. + is assignable to the type supplied as an argument. Returns a constraint that tests whether the actual value - is assignable from the type supplied as an argument. + is assignable to the type supplied as an argument. @@ -9800,6 +16516,17 @@ is a subset of the collection supplied as an argument. + + + Returns a constraint that tests whether the actual value + is a superset of the collection supplied as an argument. + + + + + Returns a constraint that tests whether a collection is ordered + + Returns a constraint that succeeds if the actual @@ -9830,10 +16557,10 @@ is the same as an expected path after canonicalization. - + Returns a constraint that tests whether the path provided - is under an expected path after canonicalization. + is a subpath of the expected path after canonicalization. @@ -9842,80 +16569,15 @@ 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 + Returns a constraint that tests whether the actual value falls + inclusively within a specified range. + from must be less than or equal to true + Inclusive beginning of the range. Must be less than or equal to to. + Inclusive end of the range. Must be greater than or equal to from. + @@ -9931,84 +16593,30 @@ - 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. + List.Map returns a ListMapper, which can be used to map + the original collection to another collection. - + - + - Return an array of random doubles with values in a specified range. + ListMapper is used to transform a collection used as an actual argument + producing another collection to be used in the assertion. - + - Return an array of random ints with values in a specified range. + Construct a ListMapper based on a collection + The collection to be transformed - + - Get a random seed for use in creating a randomizer. + Produces a collection containing all the _values of a property + The collection of property _values + @@ -10019,7 +16627,7 @@ Null represents a null value, which cannot be used as an - argument to an attribute under .NET 1.x + argument to an attriute under .NET 1.x @@ -10029,7 +16637,7 @@ - The Equals method throws an AssertionException. This is done + The Equals method throws an InvalidOperationException. This is done to make sure there is no mistake by calling this function. @@ -10037,7 +16645,7 @@ - override the default ReferenceEquals to throw an AssertionException. This + override the default ReferenceEquals to throw an InvalidOperationException. This implementation makes sure there is no mistake in calling this function as part of Assert. @@ -10053,14 +16661,6 @@ 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. @@ -10077,14 +16677,6 @@ 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. @@ -10101,14 +16693,6 @@ 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. @@ -10125,14 +16709,6 @@ 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. @@ -10149,14 +16725,6 @@ 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. @@ -10173,14 +16741,6 @@ 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. @@ -10197,14 +16757,6 @@ 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. @@ -10221,14 +16773,6 @@ 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. @@ -10245,14 +16789,6 @@ 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. @@ -10269,14 +16805,6 @@ 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. @@ -10288,697 +16816,1093 @@ 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. + test case. It is derived from TestCaseParameters and adds a + fluent syntax for use in initializing the test case. - + - The argument list to be provided to the test + Initializes a new instance of the class. + The arguments. - + - The expected result to be returned + Initializes a new instance of the class. + The argument. - + - Set to true if this has an expected result + Initializes a new instance of the class. + The first argument. + The second argument. - + - The expected exception Type + Initializes a new instance of the class. + The first argument. + The second argument. + The third argument. - + - The FullName of the expected exception + Sets the expected result for the test + The expected result + A modified TestCaseData - + - The name to be used for the test + Sets the name of the test case + The modified TestCaseData instance - + - The description of the test + Sets the description for the test case + being constructed. + The description. + The modified TestCaseData instance. - + - A dictionary of properties, used to add information - to tests without requiring the class to change. + Applies a category to the test + + - + - If true, indicates that the test case is to be ignored + Applies a named property to the test + + + - + - If true, indicates that the test case is marked explicit + Applies a named property to the test + + + - + - The reason for ignoring a test case + Applies a named property to the test + + + - + - Initializes a new instance of the class. + Marks the test case as explicit. - The arguments. - + - Initializes a new instance of the class. + Marks the test case as explicit, specifying the reason. - The argument. - + - Initializes a new instance of the class. + Ignores this TestCase, specifying the reason. - The first argument. - The second argument. + The reason. + - + - Initializes a new instance of the class. + Provide the context information of the current test. + This is an adapter for the internal ExecutionContext + class, hiding the internals from the user test. + + + + + Construct a TestContext for an ExecutionContext + + The ExecutionContext to adapt + + + + 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 TextWriter that will send output to the current test result. + + + + + Gets a TextWriter that will send output directly to Console.Error + + + + + Gets a TextWriter for use in displaying immediate progress messages + + + + + TestParameters object holds parameters for the test run, if any are specified + + + + + Get a representation of the current test. + + + + + Gets a Representation of the TestResult for the current test. + + + + + Gets the unique name of the Worker that is executing this test. + + + + + Gets the directory containing the current test assembly. + + + + + Gets the directory to be used for outputting files created + by this test run. + + + + + Gets the random generator. + + + The random generator. + + + + Write the string representation of a boolean value to the current result + + + Write a char to the current result + + + Write a char array to the current result + + + Write the string representation of a double to the current result + + + Write the string representation of an Int32 value to the current result + + + Write the string representation of an Int64 value to the current result + + + Write the string representation of a decimal value to the current result + + + Write the string representation of an object to the current result + + + Write the string representation of a Single value to the current result + + + Write a string to the current result + + + Write the string representation of a UInt32 value to the current result + + + Write the string representation of a UInt64 value to the current result + + + Write a formatted string to the current result + + + Write a formatted string to the current result + + + Write a formatted string to the current result + + + Write a formatted string to the current result + + + Write a line terminator to the current result + + + Write the string representation of a boolean value to the current result followed by a line terminator + + + Write a char to the current result followed by a line terminator + + + Write a char array to the current result followed by a line terminator + + + Write the string representation of a double to the current result followed by a line terminator + + + Write the string representation of an Int32 value to the current result followed by a line terminator + + + Write the string representation of an Int64 value to the current result followed by a line terminator + + + Write the string representation of a decimal value to the current result followed by a line terminator + + + Write the string representation of an object to the current result followed by a line terminator + + + Write the string representation of a Single value to the current result followed by a line terminator + + + Write a string to the current result followed by a line terminator + + + Write the string representation of a UInt32 value to the current result followed by a line terminator + + + Write the string representation of a UInt64 value to the current result followed by a line terminator + + + Write a formatted string to the current result followed by a line terminator + + + Write a formatted string to the current result followed by a line terminator + + + Write a formatted string to the current result followed by a line terminator + + + Write a formatted string to the current result followed by a line terminator + + + + This method adds the a new ValueFormatterFactory to the + chain of responsibility used for fomatting values in messages. + The scope of the change is the current TestContext. + + The factory delegate + + + + This method provides a simplified way to add a ValueFormatter + delegate to the chain of responsibility, creating the factory + delegate internally. It is useful when the Type of the object + is the only criterion for selection of the formatter, since + it can be used without getting involved with a compould function. + + The type supported by this formatter + The ValueFormatter delegate + + + + TestAdapter adapts a Test for consumption by + the user test code. + + + + + Construct a TestAdapter for a Test + + The Test to be adapted + + + + Gets the unique Id of a test + + + + + The name of the test, which may or may not be + the same as the method name. + + + + + The name of the method representing the test. + + + + + The FullName of the test + + + + + The ClassName of the test - The first argument. - The second argument. - The third argument. - + - Sets the expected result for the test + The properties of the test. - The expected result - A modified TestCaseData - + - Sets the expected exception type for the test + ResultAdapter adapts a TestResult for consumption by + the user test code. - Type of the expected exception. - The modified TestCaseData instance - + - Sets the expected exception type for the test + Construct a ResultAdapter for a TestResult - FullName of the expected exception. - The modified TestCaseData instance + The TestResult to be adapted - + - Sets the name of the test case + Gets a ResultState representing the outcome of the test. - The modified TestCaseData instance - + - Sets the description for the test case - being constructed. + Gets the message associated with a test + failure or with not running the test - The description. - The modified TestCaseData instance. - + - Applies a category to the test + Gets any stacktrace associated with an + error or failure. - - - + - Applies a named property to the test + Gets the number of test cases that failed + when running the test and all its children. - - - - + - Applies a named property to the test + Gets the number of test cases that passed + when running the test and all its children. - - - - + - Applies a named property to the test + Gets the number of test cases that were skipped + when running the test and all its children. - - - - + - Ignores this TestCase. + Gets the number of test cases that were inconclusive + when running the test and all its children. - - + - Ignores this TestCase, specifying the reason. + TestParameters class holds any named parameters supplied to the test run - The reason. - - + - Marks this TestCase as Explicit + Gets the number of test parameters - - + - Marks this TestCase as Explicit, specifying the reason. + Gets a collection of the test parameter names - The reason. - - + - Gets the argument list to be provided to the test + Gets a flag indicating whether a parameter with the specified name exists.N + Name of the parameter + True if it exists, otherwise false - + - Gets the expected result + Indexer provides access to the internal dictionary + Name of the parameter + Value of the parameter or null if not present - + - Returns true if the result has been set + Get method is a simple alternative to the indexer + Name of the paramter + Value of the parameter or null if not present - + - Gets the expected exception Type + Get the value of a parameter or a default string + Name of the parameter + Default value of the parameter + Value of the parameter or default value if not present - + - Gets the FullName of the expected exception + Get the value of a parameter or return a default + The return Type + Name of the parameter + Default value of the parameter + Value of the parameter or default value if not present - + - Gets the name to be used for the test + Adds a parameter to the list + Name of the parameter + Value of the parameter - + - Gets the description of the test + Helper class with properties and methods that supply + constraints that operate on exceptions. - + - Gets a value indicating whether this is ignored. + Creates a constraint specifying an expected exception - true if ignored; otherwise, false. - + - Gets a value indicating whether this is explicit. + Creates a constraint specifying an exception with a given InnerException - true if explicit; otherwise, false. - + - Gets the ignore reason. + Creates a constraint specifying an expected TargetInvocationException - The ignore reason. - + - Gets a list of categories associated with this test. + Creates a constraint specifying an expected ArgumentException - + - Gets the property dictionary for this test + Creates a constraint specifying an expected ArgumentNUllException - + - Provide the context information of the current test + Creates a constraint specifying an expected InvalidOperationException - + - Constructs a TestContext using the provided context dictionary + Creates a constraint specifying that no exception is thrown - 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. + Creates a constraint specifying the exact type of exception expected - + - Gets a TestAdapter representing the currently executing test in this context. + Creates a constraint specifying the exact type of exception expected - + - Gets a ResultAdapter representing the current result for the test - executing in this context. + Creates a constraint specifying the type of exception expected - + - Gets the directory containing the current test assembly. + Creates a constraint specifying the type of exception expected - + - Gets the directory to be used for outputing files created - by this test run. + FrameworkPackageSettings is a static class containing constant values that + are used as keys in setting up a TestPackage. These values are used in + the framework, and set in the runner. Setting values may be a string, int or bool. - + - TestAdapter adapts a Test for consumption by - the user test code. + Flag (bool) indicating whether tests are being debugged. - + - Constructs a TestAdapter for this context + Flag (bool) indicating whether to pause execution of tests to allow + the user to attache a debugger. - The context dictionary - + - The name of the test. + The InternalTraceLevel for this run. Values are: "Default", + "Off", "Error", "Warning", "Info", "Debug", "Verbose". + Default is "Off". "Debug" and "Verbose" are synonyms. - + - The FullName of the test + Full path of the directory to be used for work and result files. + This path is provided to tests by the frameowrk TestContext. - + - The properties of the test. + Integer value in milliseconds for the default timeout value + for test cases. If not specified, there is no timeout except + as specified by attributes on the tests themselves. - + - ResultAdapter adapts a TestResult for consumption by - the user test code. + A TextWriter to which the internal trace will be sent. - + - Construct a ResultAdapter for a context + A list of tests to be loaded. - 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 number of test threads to run for the assembly. If set to + 1, a single queue is used. If set to 0, tests are executed + directly, without queuing. - + - 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. + The random seed to be used for this assembly. If specified + as the value reported from a prior run, the framework should + generate identical random values for tests as were used for + that run, provided that no change has been made to the test + assembly. Default is a random value itself. - + - The ResultState enum indicates the result of running a test + If true, execution stops after the first error or failure. - + - The result is inconclusive + If true, use of the event queue is suppressed and test events are synchronous. - + - The test was not runnable. + The default naming pattern used in generating test names - + - The test has been skipped. + Parameters to be passed on to the test - + - The test has been ignored. + Provides a platform-independent methods for getting attributes + for use by AttributeConstraint and AttributeExistsConstraint. - + - The test succeeded + Gets the custom attributes from the given object. + Portable libraries do not have an ICustomAttributeProvider, so we need to cast to each of + it's direct subtypes and try to get attributes off those instead. + The actual. + Type of the attribute. + if set to true [inherit]. + A list of the given attribute on the given object. - + - The test failed + A MarshalByRefObject that lives forever - + - The test encountered an unexpected exception + Obtains a lifetime service object to control the lifetime policy for this instance. - + - The test was cancelled by the user + Provides NUnit specific extensions to aid in Reflection + across multiple frameworks + + This version of the class supplies GetTypeInfo() on platforms + that don't support it. + - + - The TestStatus enum indicates the result of running a test + GetTypeInfo gives access to most of the Type information we take for granted + on .NET Core and Windows Runtime. Rather than #ifdef different code for different + platforms, it is easiest to just code all platforms as if they worked this way, + thus the simple passthrough. + + - + - The test was inconclusive + Extensions for Assembly that are not available in pre-4.5 .NET releases - + - The test has skipped + An easy way to get a single custom attribute from an assembly + The attribute Type + The assembly + An attribute of Type T - + - The test succeeded + Type extensions that apply to all target frameworks - + - The test failed + Determines if the given array is castable/matches the array. + + + - + - Helper class with static methods used to supply constraints - that operate on strings. + Determines if one type can be implicitly converted from another + + + - + - Returns a constraint that succeeds if the actual - value contains the substring supplied as an argument. + This class is used as a flag when we get a parameter list for a method/constructor, but + we do not know one of the types because null was passed in. - + - Returns a constraint that fails if the actual - value contains the substring supplied as an argument. + Env is a static class that provides some of the features of + System.Environment that are not available under all runtimes - + - Returns a constraint that succeeds if the actual - value starts with the substring supplied as an argument. + The newline sequence in the current environment. - + - Returns a constraint that fails if the actual - value starts with the substring supplied as an argument. + Path to the 'My Documents' folder - + - Returns a constraint that succeeds if the actual - value ends with the substring supplied as an argument. + Directory used for file output if not specified on commandline. - + - Returns a constraint that fails if the actual - value ends with the substring supplied as an argument. + Represents a thread-safe first-in, first-out collection of objects. + Specifies the type of elements in the queue. + + All public and protected members of are thread-safe and may be used + concurrently from multiple threads. + - + - Returns a constraint that succeeds if the actual - value matches the Regex pattern supplied as an argument. + Initializes a new instance of the class. - + - Returns a constraint that fails if the actual - value matches the pattern supplied as an argument. + Initializes a new instance of the + class that contains elements copied from the specified collection + The collection whose elements are copied to the new . + The argument is + null. - + - Returns a ConstraintExpression, which will apply - the following constraint to all members of a collection, - succeeding if all of them succeed. + Adds an object to the end of the . + The object to add to the end of the . The value can be a null reference + (Nothing in Visual Basic) for reference types. + - + - 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. + Attempts to add an object to the . + The object to add to the . The value can be a null + reference (Nothing in Visual Basic) for reference types. + + true if the object was added successfully; otherwise, false. + For , this operation will always add the object to the + end of the + and return true. - + - Prefix used for the expected value line of a message + Attempts to remove and return the object at the beginning of the . + + When this method returns, if the operation was successful, contains the + object removed. If no object was available to be removed, the value is unspecified. + + true if an element was removed and returned from the beginning of the + successfully; otherwise, false. - + - Prefix used for the actual value line of a message + Attempts to return an object from the beginning of the + without removing it. + When this method returns, contains an object from + the beginning of the or an + unspecified value if the operation failed. + true if and object was returned successfully; otherwise, false. - + - Length of a message prefix + Returns an enumerator that iterates through a collection. + An that can be used to iterate through the collection. - + - Construct a TextMessageWriter + Returns an enumerator that iterates through the . + An enumerator for the contents of the . + + The enumeration represents a moment-in-time snapshot of the contents + of the queue. It does not reflect any updates to the collection after + was called. The enumerator is safe to use + concurrently with reads from and writes to the queue. + - + + + Copies the elements of the to an , starting at a particular + index. + + The one-dimensional Array that is the + destination of the elements copied from the + . The Array must have zero-based indexing. + The zero-based index in at which copying + begins. + is a null reference (Nothing in + Visual Basic). + is less than + zero. + + is multidimensional. -or- + does not have zero-based indexing. -or- + is equal to or greater than the length of the + -or- The number of elements in the source is + greater than the available space from to the end of the destination + . -or- The type of the source cannot be cast automatically to the type of the + destination . + + + + + Copies the elements to an existing one-dimensional Array, starting at the specified array index. + + The one-dimensional Array that is the + destination of the elements copied from the + . The Array must have zero-based + indexing. + The zero-based index in at which copying + begins. + is a null reference (Nothing in + Visual Basic). + is less than + zero. + is equal to or greater than the + length of the + -or- The number of elements in the source is greater than the + available space from to the end of the destination . + + + + + Copies the elements stored in the to a new array. + + A new array containing a snapshot of elements copied from the . + + + + Gets a value indicating whether access to the is + synchronized with the SyncRoot. + + true if access to the is synchronized + with the SyncRoot; otherwise, false. For , this property always + returns false. + + + + Attempts to remove and return an object from the . + + + When this method returns, if the operation was successful, contains the + object removed. If no object was available to be removed, the value is unspecified. + + true if an element was removed and returned successfully; otherwise, false. + For , this operation will attempt to remove the object + from the beginning of the . + + + - Construct a TextMessageWriter, specifying a user message - and optional formatting arguments. + Gets an object that can be used to synchronize access to the . This property is not supported. - - + The SyncRoot property is not supported. - + - Method to write single line message with optional args, usually - written to precede the general failure message, at a givel - indentation level. + Gets the number of elements contained in the . - The indentation level of the message - The message to be written - Any arguments used in formatting the message + The number of elements contained in the . + + For determining whether the collection contains any items, use of the + property is recommended rather than retrieving the number of items from the + property and comparing it to 0. + - + - 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. + Gets a value that indicates whether the is empty. - The constraint that failed + true if the is empty; otherwise, false. + + For determining whether the collection contains any items, use of this property is recommended + rather than retrieving the number of items from the property and comparing it + to 0. However, as this collection is intended to be accessed concurrently, it may be the case + that another thread will modify the collection after returns, thus invalidating + the result. + - + - 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. + Defines methods to manipulate thread-safe collections intended for producer/consumer usage. - The expected value - The actual value causing the failure + Specifies the type of elements in the collection. + + All implementations of this interface must enable all members of this interface + to be used concurrently from multiple threads. + - + - Display Expected and Actual lines for given values, including - a tolerance value on the expected line. + Attempts to add an object to the . - The expected value - The actual value causing the failure - The tolerance within which the test was made + The object to add to the . + true if the object was added successfully; otherwise, false. + The was invalid for this collection. - + - 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. + Attempts to remove and return an object from the . - 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 + + When this method returns, if the object was removed and returned successfully, contains the removed object. If no object was available to be removed, the value is + unspecified. + + true if an object was removed and returned successfully; otherwise, false. - + - Writes the text for a connector. + Copies the elements contained in the to a new array. - The connector. + A new array containing the elements copied from the . - + - Writes the text for a predicate. + Copies the elements of the to + an + , starting at a specified index. - The predicate. + The one-dimensional that is the destination of + the elements copied from the . + The array must have zero-based indexing. + The zero-based index in at which copying + begins. + is a null reference (Nothing in + Visual Basic). + is less than + zero. + is equal to or greater than the + length of the + -or- The number of elements in the source is greater than the + available space from to the end of the destination . + - + - 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/Library/UnityAssemblies/version.txt b/Library/UnityAssemblies/version.txt index c9f0606..7d6ff69 100644 --- a/Library/UnityAssemblies/version.txt +++ b/Library/UnityAssemblies/version.txt @@ -1,15 +1,37 @@ -5.3.5f1:2.2.0.0 -StandaloneWindows -C:/Program Files/Unity 5.3.5f1/Editor/Data/Managed/UnityEngine.dll -C:/Program Files/Unity 5.3.5f1/Editor/Data/UnityExtensions/Unity/GUISystem/UnityEngine.UI.dll -C:/Program Files/Unity 5.3.5f1/Editor/Data/UnityExtensions/Unity/Networking/UnityEngine.Networking.dll -C:/Program Files/Unity 5.3.5f1/Editor/Data/Managed/UnityEditor.dll -C:/Program Files/Unity 5.3.5f1/Editor/Data/UnityExtensions/Unity/Advertisements/Editor/UnityEditor.Advertisements.dll -C:/Program Files/Unity 5.3.5f1/Editor/Data/UnityExtensions/Unity/EditorTestsRunner/Editor/nunit.framework.dll -C:/Program Files/Unity 5.3.5f1/Editor/Data/UnityExtensions/Unity/EditorTestsRunner/Editor/UnityEditor.EditorTestsRunner.dll -C:/Program Files/Unity 5.3.5f1/Editor/Data/UnityExtensions/Unity/GUISystem/Editor/UnityEditor.UI.dll -C:/Program Files/Unity 5.3.5f1/Editor/Data/UnityExtensions/Unity/Networking/Editor/UnityEditor.Networking.dll -C:/Program Files/Unity 5.3.5f1/Editor/Data/UnityExtensions/Unity/TreeEditor/Editor/UnityEditor.TreeEditor.dll -C:/Program Files/Unity 5.3.5f1/Editor/Data/Managed/UnityEditor.Graphs.dll -C:/Program Files/Unity 5.3.5f1/Editor/Data/PlaybackEngines/WindowsStandaloneSupport/UnityEditor.WindowsStandalone.Extensions.dll -C:/Program Files (x86)/Microsoft Visual Studio Tools for Unity/2015/Editor/SyntaxTree.VisualStudio.Unity.Bridge.dll \ No newline at end of file +5.6.1f1:3.1.0.0 +StandaloneWindows64 +C:/Program Files/Unity/Editor/Data/Managed/UnityEngine.dll +C:/Program Files/Unity/Editor/Data/UnityExtensions/Unity/GUISystem/UnityEngine.UI.dll +C:/Program Files/Unity/Editor/Data/UnityExtensions/Unity/Networking/UnityEngine.Networking.dll +C:/Program Files/Unity/Editor/Data/UnityExtensions/Unity/TestRunner/UnityEngine.TestRunner.dll +C:/Program Files/Unity/Editor/Data/UnityExtensions/Unity/TestRunner/nunit.framework.dll +C:/Program Files/Unity/Editor/Data/UnityExtensions/Unity/UnityAnalytics/UnityEngine.Analytics.dll +C:/Program Files/Unity/Editor/Data/UnityExtensions/Unity/UnityHoloLens/RuntimeEditor/UnityEngine.HoloLens.dll +C:/Program Files/Unity/Editor/Data/UnityExtensions/Unity/UnityVR/RuntimeEditor/UnityEngine.VR.dll +C:/Program Files/Unity/Editor/Data/Managed/UnityEditor.dll +C:/Program Files/Unity/Editor/Data/Managed/Mono.Cecil.dll +C:/Program Files/Unity/Editor/Data/PlaybackEngines/AppleTVSupport/UnityEditor.iOS.Extensions.Xcode.dll +C:/Program Files/Unity/Editor/Data/PlaybackEngines/iOSSupport/UnityEditor.iOS.Extensions.Xcode.dll +C:/Program Files/Unity/Editor/Data/PlaybackEngines/iOSSupport/UnityEditor.iOS.Extensions.Common.dll +C:/Program Files/Unity/Editor/Data/UnityExtensions/Unity/Advertisements/Editor/UnityEditor.Advertisements.dll +C:/Program Files/Unity/Editor/Data/UnityExtensions/Unity/GUISystem/Editor/UnityEditor.UI.dll +C:/Program Files/Unity/Editor/Data/UnityExtensions/Unity/Networking/Editor/UnityEditor.Networking.dll +C:/Program Files/Unity/Editor/Data/UnityExtensions/Unity/TestRunner/Editor/UnityEditor.TestRunner.dll +C:/Program Files/Unity/Editor/Data/UnityExtensions/Unity/TreeEditor/Editor/UnityEditor.TreeEditor.dll +C:/Program Files/Unity/Editor/Data/UnityExtensions/Unity/UnityAnalytics/Editor/UnityEditor.Analytics.dll +C:/Program Files/Unity/Editor/Data/UnityExtensions/Unity/UnityHoloLens/Editor/UnityEditor.HoloLens.dll +C:/Program Files/Unity/Editor/Data/UnityExtensions/Unity/UnityPurchasing/Editor/UnityEditor.Purchasing.dll +C:/Program Files/Unity/Editor/Data/UnityExtensions/Unity/UnityVR/Editor/UnityEditor.VR.dll +C:/Program Files/Unity/Editor/Data/Managed/UnityEditor.Graphs.dll +C:/Program Files/Unity/Editor/Data/PlaybackEngines/AndroidPlayer/UnityEditor.Android.Extensions.dll +C:/Program Files/Unity/Editor/Data/PlaybackEngines/iOSSupport/UnityEditor.iOS.Extensions.dll +C:/Program Files/Unity/Editor/Data/PlaybackEngines/AppleTVSupport/UnityEditor.AppleTV.Extensions.dll +C:/Program Files/Unity/Editor/Data/PlaybackEngines/MetroSupport/UnityEditor.WSA.Extensions.dll +C:/Program Files/Unity/Editor/Data/PlaybackEngines/TizenPlayer/UnityEditor.Tizen.Extensions.dll +C:/Program Files/Unity/Editor/Data/PlaybackEngines/STVPlayer/UnityEditor.SamsungTV.Extensions.dll +C:/Program Files/Unity/Editor/Data/PlaybackEngines/WebGLSupport/UnityEditor.WebGL.Extensions.dll +C:/Program Files/Unity/Editor/Data/PlaybackEngines/LinuxStandaloneSupport/UnityEditor.LinuxStandalone.Extensions.dll +C:/Program Files/Unity/Editor/Data/PlaybackEngines/windowsstandalonesupport/UnityEditor.WindowsStandalone.Extensions.dll +C:/Program Files/Unity/Editor/Data/PlaybackEngines/MacStandaloneSupport/UnityEditor.OSXStandalone.Extensions.dll +C:/Program Files/Unity/Editor/Data/PlaybackEngines/Facebook/UnityEditor.Facebook.Extensions.dll +C:/Program Files (x86)/Microsoft Visual Studio Tools for Unity/15.0/Editor/SyntaxTree.VisualStudio.Unity.Bridge.dll \ No newline at end of file diff --git a/Library/assetDatabase3 b/Library/assetDatabase3 index 5875acd..9542fdf 100644 Binary files a/Library/assetDatabase3 and b/Library/assetDatabase3 differ diff --git a/Library/expandedItems b/Library/expandedItems index 4a73691..3bf9427 100644 Binary files a/Library/expandedItems and b/Library/expandedItems differ diff --git a/Library/metadata/00/00000000000000002000000000000000 b/Library/metadata/00/00000000000000002000000000000000 index ca1c2d8..407f993 100644 Binary files a/Library/metadata/00/00000000000000002000000000000000 and b/Library/metadata/00/00000000000000002000000000000000 differ diff --git a/Library/metadata/00/00000000000000002000000000000000.info b/Library/metadata/00/00000000000000002000000000000000.info index 82ff5c9..650a329 100644 Binary files a/Library/metadata/00/00000000000000002000000000000000.info and b/Library/metadata/00/00000000000000002000000000000000.info differ diff --git a/Library/metadata/00/00000000000000003000000000000000 b/Library/metadata/00/00000000000000003000000000000000 index 57c0666..de80ef1 100644 Binary files a/Library/metadata/00/00000000000000003000000000000000 and b/Library/metadata/00/00000000000000003000000000000000 differ diff --git a/Library/metadata/00/00000000000000003000000000000000.info b/Library/metadata/00/00000000000000003000000000000000.info index e220c12..6f1239c 100644 Binary files a/Library/metadata/00/00000000000000003000000000000000.info and b/Library/metadata/00/00000000000000003000000000000000.info differ diff --git a/Library/metadata/00/00000000000000004000000000000000 b/Library/metadata/00/00000000000000004000000000000000 index 4a8cb74..08d1a8d 100644 Binary files a/Library/metadata/00/00000000000000004000000000000000 and b/Library/metadata/00/00000000000000004000000000000000 differ diff --git a/Library/metadata/00/00000000000000004000000000000000.info b/Library/metadata/00/00000000000000004000000000000000.info index fab67de..963c9de 100644 Binary files a/Library/metadata/00/00000000000000004000000000000000.info and b/Library/metadata/00/00000000000000004000000000000000.info differ diff --git a/Library/metadata/00/00000000000000004100000000000000 b/Library/metadata/00/00000000000000004100000000000000 index cf76613..2eb15bf 100644 Binary files a/Library/metadata/00/00000000000000004100000000000000 and b/Library/metadata/00/00000000000000004100000000000000 differ diff --git a/Library/metadata/00/00000000000000004100000000000000.info b/Library/metadata/00/00000000000000004100000000000000.info index 4ed8d67..98a4ff9 100644 Binary files a/Library/metadata/00/00000000000000004100000000000000.info and b/Library/metadata/00/00000000000000004100000000000000.info differ diff --git a/Library/metadata/00/00000000000000005000000000000000 b/Library/metadata/00/00000000000000005000000000000000 index f8627ab..75a0ab9 100644 Binary files a/Library/metadata/00/00000000000000005000000000000000 and b/Library/metadata/00/00000000000000005000000000000000 differ diff --git a/Library/metadata/00/00000000000000005000000000000000.info b/Library/metadata/00/00000000000000005000000000000000.info index d9df32d..fade0c9 100644 Binary files a/Library/metadata/00/00000000000000005000000000000000.info and b/Library/metadata/00/00000000000000005000000000000000.info differ diff --git a/Library/metadata/00/00000000000000005100000000000000 b/Library/metadata/00/00000000000000005100000000000000 index 5283b47..da23748 100644 Binary files a/Library/metadata/00/00000000000000005100000000000000 and b/Library/metadata/00/00000000000000005100000000000000 differ diff --git a/Library/metadata/00/00000000000000005100000000000000.info b/Library/metadata/00/00000000000000005100000000000000.info index 5660ffb..baae292 100644 Binary files a/Library/metadata/00/00000000000000005100000000000000.info and b/Library/metadata/00/00000000000000005100000000000000.info differ diff --git a/Library/metadata/00/00000000000000006000000000000000 b/Library/metadata/00/00000000000000006000000000000000 index ae94f5b..3f0058e 100644 Binary files a/Library/metadata/00/00000000000000006000000000000000 and b/Library/metadata/00/00000000000000006000000000000000 differ diff --git a/Library/metadata/00/00000000000000006000000000000000.info b/Library/metadata/00/00000000000000006000000000000000.info index eec1374..020e772 100644 Binary files a/Library/metadata/00/00000000000000006000000000000000.info and b/Library/metadata/00/00000000000000006000000000000000.info differ diff --git a/Library/metadata/00/00000000000000006100000000000000 b/Library/metadata/00/00000000000000006100000000000000 index 062f91b..ef4f527 100644 Binary files a/Library/metadata/00/00000000000000006100000000000000 and b/Library/metadata/00/00000000000000006100000000000000 differ diff --git a/Library/metadata/00/00000000000000006100000000000000.info b/Library/metadata/00/00000000000000006100000000000000.info index affc8ee..b58d6a3 100644 Binary files a/Library/metadata/00/00000000000000006100000000000000.info and b/Library/metadata/00/00000000000000006100000000000000.info differ diff --git a/Library/metadata/00/00000000000000007000000000000000 b/Library/metadata/00/00000000000000007000000000000000 index 3b076ed..de1604d 100644 Binary files a/Library/metadata/00/00000000000000007000000000000000 and b/Library/metadata/00/00000000000000007000000000000000 differ diff --git a/Library/metadata/00/00000000000000007000000000000000.info b/Library/metadata/00/00000000000000007000000000000000.info index 6fc5794..5289be6 100644 Binary files a/Library/metadata/00/00000000000000007000000000000000.info and b/Library/metadata/00/00000000000000007000000000000000.info differ diff --git a/Library/metadata/00/00000000000000007100000000000000 b/Library/metadata/00/00000000000000007100000000000000 index 32521fc..7a56dee 100644 Binary files a/Library/metadata/00/00000000000000007100000000000000 and b/Library/metadata/00/00000000000000007100000000000000 differ diff --git a/Library/metadata/00/00000000000000007100000000000000.info b/Library/metadata/00/00000000000000007100000000000000.info index 2e75dd7..a0a78b5 100644 Binary files a/Library/metadata/00/00000000000000007100000000000000.info and b/Library/metadata/00/00000000000000007100000000000000.info differ diff --git a/Library/metadata/00/00000000000000008000000000000000 b/Library/metadata/00/00000000000000008000000000000000 index 98cf39d..6204932 100644 Binary files a/Library/metadata/00/00000000000000008000000000000000 and b/Library/metadata/00/00000000000000008000000000000000 differ diff --git a/Library/metadata/00/00000000000000008000000000000000.info b/Library/metadata/00/00000000000000008000000000000000.info index de5d9a3..94385d4 100644 Binary files a/Library/metadata/00/00000000000000008000000000000000.info and b/Library/metadata/00/00000000000000008000000000000000.info differ diff --git a/Library/metadata/00/00000000000000008100000000000000 b/Library/metadata/00/00000000000000008100000000000000 deleted file mode 100644 index 1810ca2..0000000 Binary files a/Library/metadata/00/00000000000000008100000000000000 and /dev/null differ diff --git a/Library/metadata/00/00000000000000008100000000000000.info b/Library/metadata/00/00000000000000008100000000000000.info deleted file mode 100644 index 39b42c9..0000000 Binary files a/Library/metadata/00/00000000000000008100000000000000.info and /dev/null differ diff --git a/Library/metadata/00/00000000000000009000000000000000 b/Library/metadata/00/00000000000000009000000000000000 index 6c1cd36..85dbcbb 100644 Binary files a/Library/metadata/00/00000000000000009000000000000000 and b/Library/metadata/00/00000000000000009000000000000000 differ diff --git a/Library/metadata/00/00000000000000009000000000000000.info b/Library/metadata/00/00000000000000009000000000000000.info index 90cbf24..5347fb6 100644 Binary files a/Library/metadata/00/00000000000000009000000000000000.info and b/Library/metadata/00/00000000000000009000000000000000.info differ diff --git a/Library/metadata/00/0000000000000000a000000000000000 b/Library/metadata/00/0000000000000000a000000000000000 index 0e8761d..32fcc1f 100644 Binary files a/Library/metadata/00/0000000000000000a000000000000000 and b/Library/metadata/00/0000000000000000a000000000000000 differ diff --git a/Library/metadata/00/0000000000000000a000000000000000.info b/Library/metadata/00/0000000000000000a000000000000000.info index 917cffe..32a7c62 100644 Binary files a/Library/metadata/00/0000000000000000a000000000000000.info and b/Library/metadata/00/0000000000000000a000000000000000.info differ diff --git a/Library/metadata/00/0000000000000000a100000000000000 b/Library/metadata/00/0000000000000000a100000000000000 index 60d9b50..38db741 100644 Binary files a/Library/metadata/00/0000000000000000a100000000000000 and b/Library/metadata/00/0000000000000000a100000000000000 differ diff --git a/Library/metadata/00/0000000000000000a100000000000000.info b/Library/metadata/00/0000000000000000a100000000000000.info index e2ae1e7..0827fee 100644 Binary files a/Library/metadata/00/0000000000000000a100000000000000.info and b/Library/metadata/00/0000000000000000a100000000000000.info differ diff --git a/Library/metadata/00/0000000000000000b000000000000000 b/Library/metadata/00/0000000000000000b000000000000000 index 3e152dc..119d89e 100644 Binary files a/Library/metadata/00/0000000000000000b000000000000000 and b/Library/metadata/00/0000000000000000b000000000000000 differ diff --git a/Library/metadata/00/0000000000000000b000000000000000.info b/Library/metadata/00/0000000000000000b000000000000000.info index bd903b2..54067b1 100644 Binary files a/Library/metadata/00/0000000000000000b000000000000000.info and b/Library/metadata/00/0000000000000000b000000000000000.info differ diff --git a/Library/metadata/00/0000000000000000c000000000000000 b/Library/metadata/00/0000000000000000c000000000000000 index 109cad4..f74a123 100644 Binary files a/Library/metadata/00/0000000000000000c000000000000000 and b/Library/metadata/00/0000000000000000c000000000000000 differ diff --git a/Library/metadata/00/0000000000000000c000000000000000.info b/Library/metadata/00/0000000000000000c000000000000000.info index 36cd403..e71d9d3 100644 Binary files a/Library/metadata/00/0000000000000000c000000000000000.info and b/Library/metadata/00/0000000000000000c000000000000000.info differ diff --git a/Library/metadata/00/003cb17d6edd28b4d88df6f35f9c03ab b/Library/metadata/00/003cb17d6edd28b4d88df6f35f9c03ab deleted file mode 100644 index e2409ec..0000000 Binary files a/Library/metadata/00/003cb17d6edd28b4d88df6f35f9c03ab and /dev/null differ diff --git a/Library/metadata/00/003cb17d6edd28b4d88df6f35f9c03ab.info b/Library/metadata/00/003cb17d6edd28b4d88df6f35f9c03ab.info deleted file mode 100644 index 4f72c02..0000000 Binary files a/Library/metadata/00/003cb17d6edd28b4d88df6f35f9c03ab.info and /dev/null differ diff --git a/Library/metadata/00/005ed5a6df2f5ff468efd6497d37fefa b/Library/metadata/00/005ed5a6df2f5ff468efd6497d37fefa index 5a4cb29..8b17cb7 100644 Binary files a/Library/metadata/00/005ed5a6df2f5ff468efd6497d37fefa and b/Library/metadata/00/005ed5a6df2f5ff468efd6497d37fefa differ diff --git a/Library/metadata/00/005ed5a6df2f5ff468efd6497d37fefa.info b/Library/metadata/00/005ed5a6df2f5ff468efd6497d37fefa.info index a9cc00e..a5d6bd5 100644 Binary files a/Library/metadata/00/005ed5a6df2f5ff468efd6497d37fefa.info and b/Library/metadata/00/005ed5a6df2f5ff468efd6497d37fefa.info differ diff --git a/Library/metadata/02/021228b76f139394fae4afb56cd6bf29 b/Library/metadata/02/021228b76f139394fae4afb56cd6bf29 deleted file mode 100644 index 89181d2..0000000 Binary files a/Library/metadata/02/021228b76f139394fae4afb56cd6bf29 and /dev/null differ diff --git a/Library/metadata/02/021228b76f139394fae4afb56cd6bf29.info b/Library/metadata/02/021228b76f139394fae4afb56cd6bf29.info deleted file mode 100644 index ff1dd03..0000000 Binary files a/Library/metadata/02/021228b76f139394fae4afb56cd6bf29.info and /dev/null differ diff --git a/Library/metadata/09/09db43b3b77bf744287ba587fea02f8b b/Library/metadata/09/09db43b3b77bf744287ba587fea02f8b index e26ef24..5e2c54d 100644 Binary files a/Library/metadata/09/09db43b3b77bf744287ba587fea02f8b and b/Library/metadata/09/09db43b3b77bf744287ba587fea02f8b differ diff --git a/Library/metadata/09/09db43b3b77bf744287ba587fea02f8b.info b/Library/metadata/09/09db43b3b77bf744287ba587fea02f8b.info index d33e5ad..aef98d6 100644 Binary files a/Library/metadata/09/09db43b3b77bf744287ba587fea02f8b.info and b/Library/metadata/09/09db43b3b77bf744287ba587fea02f8b.info differ diff --git a/Library/metadata/0f/0f799ebe0ba5b864da2f39fb010ff53f b/Library/metadata/0f/0f799ebe0ba5b864da2f39fb010ff53f index b0507b1..aaaebdc 100644 Binary files a/Library/metadata/0f/0f799ebe0ba5b864da2f39fb010ff53f and b/Library/metadata/0f/0f799ebe0ba5b864da2f39fb010ff53f differ diff --git a/Library/metadata/0f/0f799ebe0ba5b864da2f39fb010ff53f.info b/Library/metadata/0f/0f799ebe0ba5b864da2f39fb010ff53f.info index d3e37f7..4d312d2 100644 Binary files a/Library/metadata/0f/0f799ebe0ba5b864da2f39fb010ff53f.info and b/Library/metadata/0f/0f799ebe0ba5b864da2f39fb010ff53f.info differ diff --git a/Library/metadata/12/128449277d8f96b46a3816056eee4067 b/Library/metadata/12/128449277d8f96b46a3816056eee4067 deleted file mode 100644 index 1062f4f..0000000 Binary files a/Library/metadata/12/128449277d8f96b46a3816056eee4067 and /dev/null differ diff --git a/Library/metadata/12/128449277d8f96b46a3816056eee4067.info b/Library/metadata/12/128449277d8f96b46a3816056eee4067.info deleted file mode 100644 index d4cff33..0000000 Binary files a/Library/metadata/12/128449277d8f96b46a3816056eee4067.info and /dev/null differ diff --git a/Library/metadata/1b/1bf3d2921db44a045acc548754a7c797 b/Library/metadata/1b/1bf3d2921db44a045acc548754a7c797 index a848230..02a39ee 100644 Binary files a/Library/metadata/1b/1bf3d2921db44a045acc548754a7c797 and b/Library/metadata/1b/1bf3d2921db44a045acc548754a7c797 differ diff --git a/Library/metadata/1b/1bf3d2921db44a045acc548754a7c797.info b/Library/metadata/1b/1bf3d2921db44a045acc548754a7c797.info index c262821..7ca74ab 100644 Binary files a/Library/metadata/1b/1bf3d2921db44a045acc548754a7c797.info and b/Library/metadata/1b/1bf3d2921db44a045acc548754a7c797.info differ diff --git a/Library/metadata/1e/1edaba0e604d1244a9245cd9a8306816 b/Library/metadata/1e/1edaba0e604d1244a9245cd9a8306816 deleted file mode 100644 index 8a452f1..0000000 Binary files a/Library/metadata/1e/1edaba0e604d1244a9245cd9a8306816 and /dev/null differ diff --git a/Library/metadata/1e/1edaba0e604d1244a9245cd9a8306816.info b/Library/metadata/1e/1edaba0e604d1244a9245cd9a8306816.info deleted file mode 100644 index 4e91a3b..0000000 Binary files a/Library/metadata/1e/1edaba0e604d1244a9245cd9a8306816.info and /dev/null differ diff --git a/Library/metadata/38/386eb143d0a5a0947a0f4bad889c3e6f b/Library/metadata/38/386eb143d0a5a0947a0f4bad889c3e6f index 71ac745..20ad057 100644 Binary files a/Library/metadata/38/386eb143d0a5a0947a0f4bad889c3e6f and b/Library/metadata/38/386eb143d0a5a0947a0f4bad889c3e6f differ diff --git a/Library/metadata/38/386eb143d0a5a0947a0f4bad889c3e6f.info b/Library/metadata/38/386eb143d0a5a0947a0f4bad889c3e6f.info index d8c0635..129f1cd 100644 Binary files a/Library/metadata/38/386eb143d0a5a0947a0f4bad889c3e6f.info and b/Library/metadata/38/386eb143d0a5a0947a0f4bad889c3e6f.info differ diff --git a/Library/metadata/3c/3c0ad459c1534645b5d603b7cc258f97 b/Library/metadata/3c/3c0ad459c1534645b5d603b7cc258f97 deleted file mode 100644 index ab46c34..0000000 Binary files a/Library/metadata/3c/3c0ad459c1534645b5d603b7cc258f97 and /dev/null differ diff --git a/Library/metadata/3c/3c0ad459c1534645b5d603b7cc258f97.info b/Library/metadata/3c/3c0ad459c1534645b5d603b7cc258f97.info deleted file mode 100644 index ed2a6d5..0000000 Binary files a/Library/metadata/3c/3c0ad459c1534645b5d603b7cc258f97.info and /dev/null differ diff --git a/Library/metadata/43/4336b0f89b9f24808bfc781a1e52b6f0 b/Library/metadata/43/4336b0f89b9f24808bfc781a1e52b6f0 index 17a7416..0ef8683 100644 Binary files a/Library/metadata/43/4336b0f89b9f24808bfc781a1e52b6f0 and b/Library/metadata/43/4336b0f89b9f24808bfc781a1e52b6f0 differ diff --git a/Library/metadata/43/4336b0f89b9f24808bfc781a1e52b6f0.info b/Library/metadata/43/4336b0f89b9f24808bfc781a1e52b6f0.info index 9bc86d2..ecd3a7a 100644 Binary files a/Library/metadata/43/4336b0f89b9f24808bfc781a1e52b6f0.info and b/Library/metadata/43/4336b0f89b9f24808bfc781a1e52b6f0.info differ diff --git a/Library/metadata/46/46fe9e0b23166454c8cb73040321d78c b/Library/metadata/46/46fe9e0b23166454c8cb73040321d78c index d2cafd8..6461312 100644 Binary files a/Library/metadata/46/46fe9e0b23166454c8cb73040321d78c and b/Library/metadata/46/46fe9e0b23166454c8cb73040321d78c differ diff --git a/Library/metadata/46/46fe9e0b23166454c8cb73040321d78c.info b/Library/metadata/46/46fe9e0b23166454c8cb73040321d78c.info index c806381..cbf2613 100644 Binary files a/Library/metadata/46/46fe9e0b23166454c8cb73040321d78c.info and b/Library/metadata/46/46fe9e0b23166454c8cb73040321d78c.info differ diff --git a/Library/metadata/49/49a86c1078ce4314b9c4224560e031b9 b/Library/metadata/49/49a86c1078ce4314b9c4224560e031b9 index 1fa4253..145d99f 100644 Binary files a/Library/metadata/49/49a86c1078ce4314b9c4224560e031b9 and b/Library/metadata/49/49a86c1078ce4314b9c4224560e031b9 differ diff --git a/Library/metadata/49/49a86c1078ce4314b9c4224560e031b9.info b/Library/metadata/49/49a86c1078ce4314b9c4224560e031b9.info index bd0d84c..af378a0 100644 Binary files a/Library/metadata/49/49a86c1078ce4314b9c4224560e031b9.info and b/Library/metadata/49/49a86c1078ce4314b9c4224560e031b9.info differ diff --git a/Library/metadata/4f/4f35fa249b5008c44ac2998be6f82d4d b/Library/metadata/4f/4f35fa249b5008c44ac2998be6f82d4d index 042b434..e3b80c8 100644 Binary files a/Library/metadata/4f/4f35fa249b5008c44ac2998be6f82d4d and b/Library/metadata/4f/4f35fa249b5008c44ac2998be6f82d4d differ diff --git a/Library/metadata/4f/4f35fa249b5008c44ac2998be6f82d4d.info b/Library/metadata/4f/4f35fa249b5008c44ac2998be6f82d4d.info index 1dc93da..08dd1e3 100644 Binary files a/Library/metadata/4f/4f35fa249b5008c44ac2998be6f82d4d.info and b/Library/metadata/4f/4f35fa249b5008c44ac2998be6f82d4d.info differ diff --git a/Library/metadata/58/5828f252c3c228f4b931f66c21e525c4 b/Library/metadata/58/5828f252c3c228f4b931f66c21e525c4 index 788fcba..4693d46 100644 Binary files a/Library/metadata/58/5828f252c3c228f4b931f66c21e525c4 and b/Library/metadata/58/5828f252c3c228f4b931f66c21e525c4 differ diff --git a/Library/metadata/58/5828f252c3c228f4b931f66c21e525c4.info b/Library/metadata/58/5828f252c3c228f4b931f66c21e525c4.info index 4c0b9cc..2dc9363 100644 Binary files a/Library/metadata/58/5828f252c3c228f4b931f66c21e525c4.info and b/Library/metadata/58/5828f252c3c228f4b931f66c21e525c4.info differ diff --git a/Library/metadata/5b/5ba22c80948c94e44a82b9fd1b3abd0d b/Library/metadata/5b/5ba22c80948c94e44a82b9fd1b3abd0d index e5a2942..85615ba 100644 Binary files a/Library/metadata/5b/5ba22c80948c94e44a82b9fd1b3abd0d and b/Library/metadata/5b/5ba22c80948c94e44a82b9fd1b3abd0d differ diff --git a/Library/metadata/5b/5ba22c80948c94e44a82b9fd1b3abd0d.info b/Library/metadata/5b/5ba22c80948c94e44a82b9fd1b3abd0d.info index ce986b7..af56e03 100644 Binary files a/Library/metadata/5b/5ba22c80948c94e44a82b9fd1b3abd0d.info and b/Library/metadata/5b/5ba22c80948c94e44a82b9fd1b3abd0d.info differ diff --git a/Library/metadata/5f/5f32cd94baa94578a686d4b9d6b660f7 b/Library/metadata/5f/5f32cd94baa94578a686d4b9d6b660f7 index 8d8c1d6..eb61548 100644 Binary files a/Library/metadata/5f/5f32cd94baa94578a686d4b9d6b660f7 and b/Library/metadata/5f/5f32cd94baa94578a686d4b9d6b660f7 differ diff --git a/Library/metadata/5f/5f32cd94baa94578a686d4b9d6b660f7.info b/Library/metadata/5f/5f32cd94baa94578a686d4b9d6b660f7.info index 74b22f1..a744203 100644 Binary files a/Library/metadata/5f/5f32cd94baa94578a686d4b9d6b660f7.info and b/Library/metadata/5f/5f32cd94baa94578a686d4b9d6b660f7.info differ diff --git a/Library/metadata/64/64b48e8bdcc9e0541aa902936def9faa b/Library/metadata/64/64b48e8bdcc9e0541aa902936def9faa deleted file mode 100644 index e5987b3..0000000 Binary files a/Library/metadata/64/64b48e8bdcc9e0541aa902936def9faa and /dev/null differ diff --git a/Library/metadata/64/64b48e8bdcc9e0541aa902936def9faa.info b/Library/metadata/64/64b48e8bdcc9e0541aa902936def9faa.info deleted file mode 100644 index 155426a..0000000 Binary files a/Library/metadata/64/64b48e8bdcc9e0541aa902936def9faa.info and /dev/null differ diff --git a/Library/metadata/68/68a19ebe3f7a2b947b8c7720fbc82b59 b/Library/metadata/68/68a19ebe3f7a2b947b8c7720fbc82b59 index c6bdb37..71c8fb7 100644 Binary files a/Library/metadata/68/68a19ebe3f7a2b947b8c7720fbc82b59 and b/Library/metadata/68/68a19ebe3f7a2b947b8c7720fbc82b59 differ diff --git a/Library/metadata/68/68a19ebe3f7a2b947b8c7720fbc82b59.info b/Library/metadata/68/68a19ebe3f7a2b947b8c7720fbc82b59.info index 3a8be2e..c8b7475 100644 Binary files a/Library/metadata/68/68a19ebe3f7a2b947b8c7720fbc82b59.info and b/Library/metadata/68/68a19ebe3f7a2b947b8c7720fbc82b59.info differ diff --git a/Library/metadata/6b/6bca9ccf900ccc84c887d783321d27e2 b/Library/metadata/6b/6bca9ccf900ccc84c887d783321d27e2 index 9abe9ed..0e9ea37 100644 Binary files a/Library/metadata/6b/6bca9ccf900ccc84c887d783321d27e2 and b/Library/metadata/6b/6bca9ccf900ccc84c887d783321d27e2 differ diff --git a/Library/metadata/6b/6bca9ccf900ccc84c887d783321d27e2.info b/Library/metadata/6b/6bca9ccf900ccc84c887d783321d27e2.info index 5b6797c..6c18746 100644 Binary files a/Library/metadata/6b/6bca9ccf900ccc84c887d783321d27e2.info and b/Library/metadata/6b/6bca9ccf900ccc84c887d783321d27e2.info differ diff --git a/Library/metadata/6e/6ec40637fcf97bb4094e5db6edfe344d b/Library/metadata/6e/6ec40637fcf97bb4094e5db6edfe344d index a3fa19c..3ad9ab2 100644 Binary files a/Library/metadata/6e/6ec40637fcf97bb4094e5db6edfe344d and b/Library/metadata/6e/6ec40637fcf97bb4094e5db6edfe344d differ diff --git a/Library/metadata/6e/6ec40637fcf97bb4094e5db6edfe344d.info b/Library/metadata/6e/6ec40637fcf97bb4094e5db6edfe344d.info index bbbc837..f5e1534 100644 Binary files a/Library/metadata/6e/6ec40637fcf97bb4094e5db6edfe344d.info and b/Library/metadata/6e/6ec40637fcf97bb4094e5db6edfe344d.info differ diff --git a/Library/metadata/73/7312850033767144bb8b56eac9e62164 b/Library/metadata/73/7312850033767144bb8b56eac9e62164 index 385e53b..4d90b4b 100644 Binary files a/Library/metadata/73/7312850033767144bb8b56eac9e62164 and b/Library/metadata/73/7312850033767144bb8b56eac9e62164 differ diff --git a/Library/metadata/73/7312850033767144bb8b56eac9e62164.info b/Library/metadata/73/7312850033767144bb8b56eac9e62164.info index 8eaa8e7..c15414e 100644 Binary files a/Library/metadata/73/7312850033767144bb8b56eac9e62164.info and b/Library/metadata/73/7312850033767144bb8b56eac9e62164.info differ diff --git a/Library/metadata/73/7314d480a23bf4049a0a7aecc9c92ca2 b/Library/metadata/73/7314d480a23bf4049a0a7aecc9c92ca2 index 9b4f1e9..f2c3eac 100644 Binary files a/Library/metadata/73/7314d480a23bf4049a0a7aecc9c92ca2 and b/Library/metadata/73/7314d480a23bf4049a0a7aecc9c92ca2 differ diff --git a/Library/metadata/73/7314d480a23bf4049a0a7aecc9c92ca2.info b/Library/metadata/73/7314d480a23bf4049a0a7aecc9c92ca2.info index ed091b6..db1747a 100644 Binary files a/Library/metadata/73/7314d480a23bf4049a0a7aecc9c92ca2.info and b/Library/metadata/73/7314d480a23bf4049a0a7aecc9c92ca2.info differ diff --git a/Library/metadata/73/739bbd9f364b4268874f9fd86ab3beef b/Library/metadata/73/739bbd9f364b4268874f9fd86ab3beef index a02999b..b2feb35 100644 Binary files a/Library/metadata/73/739bbd9f364b4268874f9fd86ab3beef and b/Library/metadata/73/739bbd9f364b4268874f9fd86ab3beef differ diff --git a/Library/metadata/73/739bbd9f364b4268874f9fd86ab3beef.info b/Library/metadata/73/739bbd9f364b4268874f9fd86ab3beef.info index 215c5c8..74e70e4 100644 Binary files a/Library/metadata/73/739bbd9f364b4268874f9fd86ab3beef.info and b/Library/metadata/73/739bbd9f364b4268874f9fd86ab3beef.info differ diff --git a/Library/metadata/73/73a0556bda803bf4e898751dcfcf21a8 b/Library/metadata/73/73a0556bda803bf4e898751dcfcf21a8 index 193d77e..2c12beb 100644 Binary files a/Library/metadata/73/73a0556bda803bf4e898751dcfcf21a8 and b/Library/metadata/73/73a0556bda803bf4e898751dcfcf21a8 differ diff --git a/Library/metadata/73/73a0556bda803bf4e898751dcfcf21a8.info b/Library/metadata/73/73a0556bda803bf4e898751dcfcf21a8.info index eddbc4d..33a23e5 100644 Binary files a/Library/metadata/73/73a0556bda803bf4e898751dcfcf21a8.info and b/Library/metadata/73/73a0556bda803bf4e898751dcfcf21a8.info differ diff --git a/Library/metadata/73/73d5d79effb76f84491567f3c473b810 b/Library/metadata/73/73d5d79effb76f84491567f3c473b810 deleted file mode 100644 index eb82b7c..0000000 Binary files a/Library/metadata/73/73d5d79effb76f84491567f3c473b810 and /dev/null differ diff --git a/Library/metadata/73/73d5d79effb76f84491567f3c473b810.info b/Library/metadata/73/73d5d79effb76f84491567f3c473b810.info deleted file mode 100644 index 84c7d7c..0000000 Binary files a/Library/metadata/73/73d5d79effb76f84491567f3c473b810.info and /dev/null differ diff --git a/Library/metadata/76/7687f525efe9f4b449dfe5a7fe0b7c8e b/Library/metadata/76/7687f525efe9f4b449dfe5a7fe0b7c8e deleted file mode 100644 index da5f0b9..0000000 Binary files a/Library/metadata/76/7687f525efe9f4b449dfe5a7fe0b7c8e and /dev/null differ diff --git a/Library/metadata/76/7687f525efe9f4b449dfe5a7fe0b7c8e.info b/Library/metadata/76/7687f525efe9f4b449dfe5a7fe0b7c8e.info deleted file mode 100644 index 348846b..0000000 Binary files a/Library/metadata/76/7687f525efe9f4b449dfe5a7fe0b7c8e.info and /dev/null differ diff --git a/Library/metadata/7c/7cbab2be89b54486bbd23a6fe637d30e b/Library/metadata/7c/7cbab2be89b54486bbd23a6fe637d30e deleted file mode 100644 index 0366e83..0000000 Binary files a/Library/metadata/7c/7cbab2be89b54486bbd23a6fe637d30e and /dev/null differ diff --git a/Library/metadata/7c/7cbab2be89b54486bbd23a6fe637d30e.info b/Library/metadata/7c/7cbab2be89b54486bbd23a6fe637d30e.info deleted file mode 100644 index 34e8c73..0000000 Binary files a/Library/metadata/7c/7cbab2be89b54486bbd23a6fe637d30e.info and /dev/null differ diff --git a/Library/metadata/7f/7f38d614fcfa3b541bde2acda92af7ca b/Library/metadata/7f/7f38d614fcfa3b541bde2acda92af7ca deleted file mode 100644 index 12b29c2..0000000 Binary files a/Library/metadata/7f/7f38d614fcfa3b541bde2acda92af7ca and /dev/null differ diff --git a/Library/metadata/7f/7f38d614fcfa3b541bde2acda92af7ca.info b/Library/metadata/7f/7f38d614fcfa3b541bde2acda92af7ca.info deleted file mode 100644 index 924e83a..0000000 Binary files a/Library/metadata/7f/7f38d614fcfa3b541bde2acda92af7ca.info and /dev/null differ diff --git a/Library/metadata/7f/7fae0ddab09ac324c85494471274d6a4 b/Library/metadata/7f/7fae0ddab09ac324c85494471274d6a4 index 9506491..bdf95da 100644 Binary files a/Library/metadata/7f/7fae0ddab09ac324c85494471274d6a4 and b/Library/metadata/7f/7fae0ddab09ac324c85494471274d6a4 differ diff --git a/Library/metadata/7f/7fae0ddab09ac324c85494471274d6a4.info b/Library/metadata/7f/7fae0ddab09ac324c85494471274d6a4.info index ffe3748..e50d93d 100644 Binary files a/Library/metadata/7f/7fae0ddab09ac324c85494471274d6a4.info and b/Library/metadata/7f/7fae0ddab09ac324c85494471274d6a4.info differ diff --git a/Library/metadata/80/80a3616ca19596e4da0f10f14d241e9f b/Library/metadata/80/80a3616ca19596e4da0f10f14d241e9f index 7df107c..68d49b9 100644 Binary files a/Library/metadata/80/80a3616ca19596e4da0f10f14d241e9f and b/Library/metadata/80/80a3616ca19596e4da0f10f14d241e9f differ diff --git a/Library/metadata/80/80a3616ca19596e4da0f10f14d241e9f.info b/Library/metadata/80/80a3616ca19596e4da0f10f14d241e9f.info index b9ed1c4..beedd87 100644 Binary files a/Library/metadata/80/80a3616ca19596e4da0f10f14d241e9f.info and b/Library/metadata/80/80a3616ca19596e4da0f10f14d241e9f.info differ diff --git a/Library/metadata/85/852e56802eb941638acbb491814497b0 b/Library/metadata/85/852e56802eb941638acbb491814497b0 index 17ec4f4..493265a 100644 Binary files a/Library/metadata/85/852e56802eb941638acbb491814497b0 and b/Library/metadata/85/852e56802eb941638acbb491814497b0 differ diff --git a/Library/metadata/85/852e56802eb941638acbb491814497b0.info b/Library/metadata/85/852e56802eb941638acbb491814497b0.info index 986d407..8c4d6a6 100644 Binary files a/Library/metadata/85/852e56802eb941638acbb491814497b0.info and b/Library/metadata/85/852e56802eb941638acbb491814497b0.info differ diff --git a/Library/metadata/87/870353891bb340e2b2a9c8707e7419ba b/Library/metadata/87/870353891bb340e2b2a9c8707e7419ba index 7ad19bd..903712d 100644 Binary files a/Library/metadata/87/870353891bb340e2b2a9c8707e7419ba and b/Library/metadata/87/870353891bb340e2b2a9c8707e7419ba differ diff --git a/Library/metadata/87/870353891bb340e2b2a9c8707e7419ba.info b/Library/metadata/87/870353891bb340e2b2a9c8707e7419ba.info index 8a64cbb..a35de2a 100644 Binary files a/Library/metadata/87/870353891bb340e2b2a9c8707e7419ba.info and b/Library/metadata/87/870353891bb340e2b2a9c8707e7419ba.info differ diff --git a/Library/metadata/8d/8d26b9eddedb33d48be044bb268a57c7 b/Library/metadata/8d/8d26b9eddedb33d48be044bb268a57c7 index 59c9a7c..f04a7ee 100644 Binary files a/Library/metadata/8d/8d26b9eddedb33d48be044bb268a57c7 and b/Library/metadata/8d/8d26b9eddedb33d48be044bb268a57c7 differ diff --git a/Library/metadata/8d/8d26b9eddedb33d48be044bb268a57c7.info b/Library/metadata/8d/8d26b9eddedb33d48be044bb268a57c7.info index a3e8d36..56a27cd 100644 Binary files a/Library/metadata/8d/8d26b9eddedb33d48be044bb268a57c7.info and b/Library/metadata/8d/8d26b9eddedb33d48be044bb268a57c7.info differ diff --git a/Library/metadata/8e/8e0cd8ed44d4412cbe0642067abc9e44 b/Library/metadata/8e/8e0cd8ed44d4412cbe0642067abc9e44 index 061ca73..dd6cdfc 100644 Binary files a/Library/metadata/8e/8e0cd8ed44d4412cbe0642067abc9e44 and b/Library/metadata/8e/8e0cd8ed44d4412cbe0642067abc9e44 differ diff --git a/Library/metadata/8e/8e0cd8ed44d4412cbe0642067abc9e44.info b/Library/metadata/8e/8e0cd8ed44d4412cbe0642067abc9e44.info index 89be8d9..074026e 100644 Binary files a/Library/metadata/8e/8e0cd8ed44d4412cbe0642067abc9e44.info and b/Library/metadata/8e/8e0cd8ed44d4412cbe0642067abc9e44.info differ diff --git a/Library/metadata/94/941dde9a9ca65d74489c024e76c8bfe8 b/Library/metadata/94/941dde9a9ca65d74489c024e76c8bfe8 deleted file mode 100644 index 1500f2b..0000000 Binary files a/Library/metadata/94/941dde9a9ca65d74489c024e76c8bfe8 and /dev/null differ diff --git a/Library/metadata/94/941dde9a9ca65d74489c024e76c8bfe8.info b/Library/metadata/94/941dde9a9ca65d74489c024e76c8bfe8.info deleted file mode 100644 index da0c9c9..0000000 Binary files a/Library/metadata/94/941dde9a9ca65d74489c024e76c8bfe8.info and /dev/null differ diff --git a/Library/metadata/94/94fb4a9fda44f4b40a63908a3e471012 b/Library/metadata/94/94fb4a9fda44f4b40a63908a3e471012 index bd795b9..c998bb5 100644 Binary files a/Library/metadata/94/94fb4a9fda44f4b40a63908a3e471012 and b/Library/metadata/94/94fb4a9fda44f4b40a63908a3e471012 differ diff --git a/Library/metadata/94/94fb4a9fda44f4b40a63908a3e471012.info b/Library/metadata/94/94fb4a9fda44f4b40a63908a3e471012.info index 6276b0a..64e86b3 100644 Binary files a/Library/metadata/94/94fb4a9fda44f4b40a63908a3e471012.info and b/Library/metadata/94/94fb4a9fda44f4b40a63908a3e471012.info differ diff --git a/Library/metadata/95/95553d89c282bf141b499a612fd87915 b/Library/metadata/95/95553d89c282bf141b499a612fd87915 deleted file mode 100644 index 083313f..0000000 Binary files a/Library/metadata/95/95553d89c282bf141b499a612fd87915 and /dev/null differ diff --git a/Library/metadata/95/95553d89c282bf141b499a612fd87915.info b/Library/metadata/95/95553d89c282bf141b499a612fd87915.info deleted file mode 100644 index cf56215..0000000 Binary files a/Library/metadata/95/95553d89c282bf141b499a612fd87915.info and /dev/null differ diff --git a/Library/metadata/97/97decbdab0634cdd991f8d23ddf0dead b/Library/metadata/97/97decbdab0634cdd991f8d23ddf0dead index 41d3471..363da93 100644 Binary files a/Library/metadata/97/97decbdab0634cdd991f8d23ddf0dead and b/Library/metadata/97/97decbdab0634cdd991f8d23ddf0dead differ diff --git a/Library/metadata/97/97decbdab0634cdd991f8d23ddf0dead.info b/Library/metadata/97/97decbdab0634cdd991f8d23ddf0dead.info index 4cbe3c7..fc19d4e 100644 Binary files a/Library/metadata/97/97decbdab0634cdd991f8d23ddf0dead.info and b/Library/metadata/97/97decbdab0634cdd991f8d23ddf0dead.info differ diff --git a/Library/metadata/9d/9d42e4d46d897b648a1d6ed58a18e8a6 b/Library/metadata/9d/9d42e4d46d897b648a1d6ed58a18e8a6 deleted file mode 100644 index 9703c7d..0000000 Binary files a/Library/metadata/9d/9d42e4d46d897b648a1d6ed58a18e8a6 and /dev/null differ diff --git a/Library/metadata/9d/9d42e4d46d897b648a1d6ed58a18e8a6.info b/Library/metadata/9d/9d42e4d46d897b648a1d6ed58a18e8a6.info deleted file mode 100644 index 2f21826..0000000 Binary files a/Library/metadata/9d/9d42e4d46d897b648a1d6ed58a18e8a6.info and /dev/null differ diff --git a/Library/metadata/a5/a51c3dbd81ecb6741b7a2c5b06dbcb2e b/Library/metadata/a5/a51c3dbd81ecb6741b7a2c5b06dbcb2e index ffa60e6..864a84a 100644 Binary files a/Library/metadata/a5/a51c3dbd81ecb6741b7a2c5b06dbcb2e and b/Library/metadata/a5/a51c3dbd81ecb6741b7a2c5b06dbcb2e differ diff --git a/Library/metadata/a5/a51c3dbd81ecb6741b7a2c5b06dbcb2e.info b/Library/metadata/a5/a51c3dbd81ecb6741b7a2c5b06dbcb2e.info index 5290654..4a13e10 100644 Binary files a/Library/metadata/a5/a51c3dbd81ecb6741b7a2c5b06dbcb2e.info and b/Library/metadata/a5/a51c3dbd81ecb6741b7a2c5b06dbcb2e.info differ diff --git a/Library/metadata/a5/a57cd5c56c9d75c4ba0ee9fbc6e1d8df b/Library/metadata/a5/a57cd5c56c9d75c4ba0ee9fbc6e1d8df index 139d97b..88e007a 100644 Binary files a/Library/metadata/a5/a57cd5c56c9d75c4ba0ee9fbc6e1d8df and b/Library/metadata/a5/a57cd5c56c9d75c4ba0ee9fbc6e1d8df differ diff --git a/Library/metadata/a5/a57cd5c56c9d75c4ba0ee9fbc6e1d8df.info b/Library/metadata/a5/a57cd5c56c9d75c4ba0ee9fbc6e1d8df.info index deccb22..0f012f4 100644 Binary files a/Library/metadata/a5/a57cd5c56c9d75c4ba0ee9fbc6e1d8df.info and b/Library/metadata/a5/a57cd5c56c9d75c4ba0ee9fbc6e1d8df.info differ diff --git a/Library/metadata/ad/adebbd281f1a4ef3a30be7f21937e02f b/Library/metadata/ad/adebbd281f1a4ef3a30be7f21937e02f index 1197989..a90f41a 100644 Binary files a/Library/metadata/ad/adebbd281f1a4ef3a30be7f21937e02f and b/Library/metadata/ad/adebbd281f1a4ef3a30be7f21937e02f differ diff --git a/Library/metadata/ad/adebbd281f1a4ef3a30be7f21937e02f.info b/Library/metadata/ad/adebbd281f1a4ef3a30be7f21937e02f.info index 1c132e9..c70deee 100644 Binary files a/Library/metadata/ad/adebbd281f1a4ef3a30be7f21937e02f.info and b/Library/metadata/ad/adebbd281f1a4ef3a30be7f21937e02f.info differ diff --git a/Library/metadata/b2/b2d1785fa0c551e408b6c94398847b76 b/Library/metadata/b2/b2d1785fa0c551e408b6c94398847b76 index 4d4720c..dc6966a 100644 Binary files a/Library/metadata/b2/b2d1785fa0c551e408b6c94398847b76 and b/Library/metadata/b2/b2d1785fa0c551e408b6c94398847b76 differ diff --git a/Library/metadata/b2/b2d1785fa0c551e408b6c94398847b76.info b/Library/metadata/b2/b2d1785fa0c551e408b6c94398847b76.info index 1017bea..fefc61e 100644 Binary files a/Library/metadata/b2/b2d1785fa0c551e408b6c94398847b76.info and b/Library/metadata/b2/b2d1785fa0c551e408b6c94398847b76.info differ diff --git a/Library/metadata/b3/b31dbc11539eece42a44d36236d52617 b/Library/metadata/b3/b31dbc11539eece42a44d36236d52617 index c4f0c52..9bb0b64 100644 Binary files a/Library/metadata/b3/b31dbc11539eece42a44d36236d52617 and b/Library/metadata/b3/b31dbc11539eece42a44d36236d52617 differ diff --git a/Library/metadata/b3/b31dbc11539eece42a44d36236d52617.info b/Library/metadata/b3/b31dbc11539eece42a44d36236d52617.info index 1340754..78dfa50 100644 Binary files a/Library/metadata/b3/b31dbc11539eece42a44d36236d52617.info and b/Library/metadata/b3/b31dbc11539eece42a44d36236d52617.info differ diff --git a/Library/metadata/b4/b45c3effcfd797840bd8ce4b155dc277 b/Library/metadata/b4/b45c3effcfd797840bd8ce4b155dc277 index 34584df..ac53724 100644 Binary files a/Library/metadata/b4/b45c3effcfd797840bd8ce4b155dc277 and b/Library/metadata/b4/b45c3effcfd797840bd8ce4b155dc277 differ diff --git a/Library/metadata/b4/b45c3effcfd797840bd8ce4b155dc277.info b/Library/metadata/b4/b45c3effcfd797840bd8ce4b155dc277.info index c499a32..daf64a1 100644 Binary files a/Library/metadata/b4/b45c3effcfd797840bd8ce4b155dc277.info and b/Library/metadata/b4/b45c3effcfd797840bd8ce4b155dc277.info differ diff --git a/Library/metadata/be/be3c3a084f7b29b4880b42b4cfbf4d8f b/Library/metadata/be/be3c3a084f7b29b4880b42b4cfbf4d8f index 9523b62..9762c1c 100644 Binary files a/Library/metadata/be/be3c3a084f7b29b4880b42b4cfbf4d8f and b/Library/metadata/be/be3c3a084f7b29b4880b42b4cfbf4d8f differ diff --git a/Library/metadata/be/be3c3a084f7b29b4880b42b4cfbf4d8f.info b/Library/metadata/be/be3c3a084f7b29b4880b42b4cfbf4d8f.info index 27e1753..bcd4f28 100644 Binary files a/Library/metadata/be/be3c3a084f7b29b4880b42b4cfbf4d8f.info and b/Library/metadata/be/be3c3a084f7b29b4880b42b4cfbf4d8f.info differ diff --git a/Library/metadata/be/be96d45fe21847a4a805d408a8015c84 b/Library/metadata/be/be96d45fe21847a4a805d408a8015c84 index 361b71e..33771a1 100644 Binary files a/Library/metadata/be/be96d45fe21847a4a805d408a8015c84 and b/Library/metadata/be/be96d45fe21847a4a805d408a8015c84 differ diff --git a/Library/metadata/be/be96d45fe21847a4a805d408a8015c84.info b/Library/metadata/be/be96d45fe21847a4a805d408a8015c84.info index b5da977..2166284 100644 Binary files a/Library/metadata/be/be96d45fe21847a4a805d408a8015c84.info and b/Library/metadata/be/be96d45fe21847a4a805d408a8015c84.info differ diff --git a/Library/metadata/c9/c9da270df5147d24597cc106058c1fa7 b/Library/metadata/c9/c9da270df5147d24597cc106058c1fa7 index 8d09bc8..5b3cb33 100644 Binary files a/Library/metadata/c9/c9da270df5147d24597cc106058c1fa7 and b/Library/metadata/c9/c9da270df5147d24597cc106058c1fa7 differ diff --git a/Library/metadata/c9/c9da270df5147d24597cc106058c1fa7.info b/Library/metadata/c9/c9da270df5147d24597cc106058c1fa7.info index c700f2d..d35663f 100644 Binary files a/Library/metadata/c9/c9da270df5147d24597cc106058c1fa7.info and b/Library/metadata/c9/c9da270df5147d24597cc106058c1fa7.info differ diff --git a/Library/metadata/ce/ce57571128519544da2f66ec0a7a36fb b/Library/metadata/ce/ce57571128519544da2f66ec0a7a36fb index c942bdc..ade3cac 100644 Binary files a/Library/metadata/ce/ce57571128519544da2f66ec0a7a36fb and b/Library/metadata/ce/ce57571128519544da2f66ec0a7a36fb differ diff --git a/Library/metadata/ce/ce57571128519544da2f66ec0a7a36fb.info b/Library/metadata/ce/ce57571128519544da2f66ec0a7a36fb.info index 22fd89e..40d0a78 100644 Binary files a/Library/metadata/ce/ce57571128519544da2f66ec0a7a36fb.info and b/Library/metadata/ce/ce57571128519544da2f66ec0a7a36fb.info differ diff --git a/Library/metadata/d1/d1defc434452f5b478b19909d1e5fc8b b/Library/metadata/d1/d1defc434452f5b478b19909d1e5fc8b index eafb908..a6a8b15 100644 Binary files a/Library/metadata/d1/d1defc434452f5b478b19909d1e5fc8b and b/Library/metadata/d1/d1defc434452f5b478b19909d1e5fc8b differ diff --git a/Library/metadata/d1/d1defc434452f5b478b19909d1e5fc8b.info b/Library/metadata/d1/d1defc434452f5b478b19909d1e5fc8b.info index d8b4c50..da6c7d2 100644 Binary files a/Library/metadata/d1/d1defc434452f5b478b19909d1e5fc8b.info and b/Library/metadata/d1/d1defc434452f5b478b19909d1e5fc8b.info differ diff --git a/Library/metadata/d2/d2244eee8a3a4784fb40d1123ff69301 b/Library/metadata/d2/d2244eee8a3a4784fb40d1123ff69301 index 015b1fe..a8fb21b 100644 Binary files a/Library/metadata/d2/d2244eee8a3a4784fb40d1123ff69301 and b/Library/metadata/d2/d2244eee8a3a4784fb40d1123ff69301 differ diff --git a/Library/metadata/d2/d2244eee8a3a4784fb40d1123ff69301.info b/Library/metadata/d2/d2244eee8a3a4784fb40d1123ff69301.info index 4b252e1..dbdba82 100644 Binary files a/Library/metadata/d2/d2244eee8a3a4784fb40d1123ff69301.info and b/Library/metadata/d2/d2244eee8a3a4784fb40d1123ff69301.info differ diff --git a/Library/metadata/d3/d37c2cf88f7c59f4c8cf5d3812568143 b/Library/metadata/d3/d37c2cf88f7c59f4c8cf5d3812568143 index 4a24576..82ae0b5 100644 Binary files a/Library/metadata/d3/d37c2cf88f7c59f4c8cf5d3812568143 and b/Library/metadata/d3/d37c2cf88f7c59f4c8cf5d3812568143 differ diff --git a/Library/metadata/d3/d37c2cf88f7c59f4c8cf5d3812568143.info b/Library/metadata/d3/d37c2cf88f7c59f4c8cf5d3812568143.info index ed2abfd..c13758e 100644 Binary files a/Library/metadata/d3/d37c2cf88f7c59f4c8cf5d3812568143.info and b/Library/metadata/d3/d37c2cf88f7c59f4c8cf5d3812568143.info differ diff --git a/Library/metadata/d4/d4aa343e31277cd45b2c3096d3318b90 b/Library/metadata/d4/d4aa343e31277cd45b2c3096d3318b90 deleted file mode 100644 index e4989c6..0000000 Binary files a/Library/metadata/d4/d4aa343e31277cd45b2c3096d3318b90 and /dev/null differ diff --git a/Library/metadata/d4/d4aa343e31277cd45b2c3096d3318b90.info b/Library/metadata/d4/d4aa343e31277cd45b2c3096d3318b90.info deleted file mode 100644 index a1d56a5..0000000 Binary files a/Library/metadata/d4/d4aa343e31277cd45b2c3096d3318b90.info and /dev/null differ diff --git a/Library/metadata/d7/d7ab6cdb4ba1e4c41bf8a76d2eca7717 b/Library/metadata/d7/d7ab6cdb4ba1e4c41bf8a76d2eca7717 index aff3cb9..0406280 100644 Binary files a/Library/metadata/d7/d7ab6cdb4ba1e4c41bf8a76d2eca7717 and b/Library/metadata/d7/d7ab6cdb4ba1e4c41bf8a76d2eca7717 differ diff --git a/Library/metadata/d7/d7ab6cdb4ba1e4c41bf8a76d2eca7717.info b/Library/metadata/d7/d7ab6cdb4ba1e4c41bf8a76d2eca7717.info index d09689f..4f10a4a 100644 Binary files a/Library/metadata/d7/d7ab6cdb4ba1e4c41bf8a76d2eca7717.info and b/Library/metadata/d7/d7ab6cdb4ba1e4c41bf8a76d2eca7717.info differ diff --git a/Library/metadata/d8/d878ba61b185a30408789526a14fa025 b/Library/metadata/d8/d878ba61b185a30408789526a14fa025 deleted file mode 100644 index 781a01a..0000000 Binary files a/Library/metadata/d8/d878ba61b185a30408789526a14fa025 and /dev/null differ diff --git a/Library/metadata/d8/d878ba61b185a30408789526a14fa025.info b/Library/metadata/d8/d878ba61b185a30408789526a14fa025.info deleted file mode 100644 index bb2b0b9..0000000 Binary files a/Library/metadata/d8/d878ba61b185a30408789526a14fa025.info and /dev/null differ diff --git a/Library/metadata/de/def2782dd412c1f499fdd7e389f5c97b b/Library/metadata/de/def2782dd412c1f499fdd7e389f5c97b index bb83b8a..00dabc9 100644 Binary files a/Library/metadata/de/def2782dd412c1f499fdd7e389f5c97b and b/Library/metadata/de/def2782dd412c1f499fdd7e389f5c97b differ diff --git a/Library/metadata/de/def2782dd412c1f499fdd7e389f5c97b.info b/Library/metadata/de/def2782dd412c1f499fdd7e389f5c97b.info index 94a0e09..a1ed0f6 100644 Binary files a/Library/metadata/de/def2782dd412c1f499fdd7e389f5c97b.info and b/Library/metadata/de/def2782dd412c1f499fdd7e389f5c97b.info differ diff --git a/Library/metadata/e9/e979227f3384fac4b8ca0b3550bf005c b/Library/metadata/e9/e979227f3384fac4b8ca0b3550bf005c index 4bcfa80..33b4a30 100644 Binary files a/Library/metadata/e9/e979227f3384fac4b8ca0b3550bf005c and b/Library/metadata/e9/e979227f3384fac4b8ca0b3550bf005c differ diff --git a/Library/metadata/e9/e979227f3384fac4b8ca0b3550bf005c.info b/Library/metadata/e9/e979227f3384fac4b8ca0b3550bf005c.info index ef415b2..738f803 100644 Binary files a/Library/metadata/e9/e979227f3384fac4b8ca0b3550bf005c.info and b/Library/metadata/e9/e979227f3384fac4b8ca0b3550bf005c.info differ diff --git a/Library/metadata/ef/efed635ae0049ee4c825ce2cf3ab50b0 b/Library/metadata/ef/efed635ae0049ee4c825ce2cf3ab50b0 index e460975..2168f98 100644 Binary files a/Library/metadata/ef/efed635ae0049ee4c825ce2cf3ab50b0 and b/Library/metadata/ef/efed635ae0049ee4c825ce2cf3ab50b0 differ diff --git a/Library/metadata/ef/efed635ae0049ee4c825ce2cf3ab50b0.info b/Library/metadata/ef/efed635ae0049ee4c825ce2cf3ab50b0.info index 0c1f6de..102d037 100644 Binary files a/Library/metadata/ef/efed635ae0049ee4c825ce2cf3ab50b0.info and b/Library/metadata/ef/efed635ae0049ee4c825ce2cf3ab50b0.info differ diff --git a/Library/metadata/f0/f0032bd9499af5e4aa85ea41615843a0 b/Library/metadata/f0/f0032bd9499af5e4aa85ea41615843a0 index 3684f95..7dcbe96 100644 Binary files a/Library/metadata/f0/f0032bd9499af5e4aa85ea41615843a0 and b/Library/metadata/f0/f0032bd9499af5e4aa85ea41615843a0 differ diff --git a/Library/metadata/f0/f0032bd9499af5e4aa85ea41615843a0.info b/Library/metadata/f0/f0032bd9499af5e4aa85ea41615843a0.info index 26fb18b..f270722 100644 Binary files a/Library/metadata/f0/f0032bd9499af5e4aa85ea41615843a0.info and b/Library/metadata/f0/f0032bd9499af5e4aa85ea41615843a0.info differ diff --git a/Library/metadata/f4/f4d909dcb749c45459770e058a2efac3 b/Library/metadata/f4/f4d909dcb749c45459770e058a2efac3 deleted file mode 100644 index a0ace53..0000000 Binary files a/Library/metadata/f4/f4d909dcb749c45459770e058a2efac3 and /dev/null differ diff --git a/Library/metadata/f4/f4d909dcb749c45459770e058a2efac3.info b/Library/metadata/f4/f4d909dcb749c45459770e058a2efac3.info deleted file mode 100644 index 892fb50..0000000 Binary files a/Library/metadata/f4/f4d909dcb749c45459770e058a2efac3.info and /dev/null differ diff --git a/Library/metadata/f5/f5be45115742b07478e21c85fcc233ec b/Library/metadata/f5/f5be45115742b07478e21c85fcc233ec index 2498072..d71edd4 100644 Binary files a/Library/metadata/f5/f5be45115742b07478e21c85fcc233ec and b/Library/metadata/f5/f5be45115742b07478e21c85fcc233ec differ diff --git a/Library/metadata/f5/f5be45115742b07478e21c85fcc233ec.info b/Library/metadata/f5/f5be45115742b07478e21c85fcc233ec.info index 2c1e42c..f2e3620 100644 Binary files a/Library/metadata/f5/f5be45115742b07478e21c85fcc233ec.info and b/Library/metadata/f5/f5be45115742b07478e21c85fcc233ec.info differ diff --git a/Library/metadata/f5/f5f67c52d1564df4a8936ccd202a3bd8 b/Library/metadata/f5/f5f67c52d1564df4a8936ccd202a3bd8 index 2f51fec..acbe111 100644 Binary files a/Library/metadata/f5/f5f67c52d1564df4a8936ccd202a3bd8 and b/Library/metadata/f5/f5f67c52d1564df4a8936ccd202a3bd8 differ diff --git a/Library/metadata/f5/f5f67c52d1564df4a8936ccd202a3bd8.info b/Library/metadata/f5/f5f67c52d1564df4a8936ccd202a3bd8.info index 7b08f1c..311e931 100644 Binary files a/Library/metadata/f5/f5f67c52d1564df4a8936ccd202a3bd8.info and b/Library/metadata/f5/f5f67c52d1564df4a8936ccd202a3bd8.info differ diff --git a/Library/metadata/f9/f9c6e0c408020c341b3c329ec30355a1 b/Library/metadata/f9/f9c6e0c408020c341b3c329ec30355a1 index 69789ac..1cbd3ee 100644 Binary files a/Library/metadata/f9/f9c6e0c408020c341b3c329ec30355a1 and b/Library/metadata/f9/f9c6e0c408020c341b3c329ec30355a1 differ diff --git a/Library/metadata/f9/f9c6e0c408020c341b3c329ec30355a1.info b/Library/metadata/f9/f9c6e0c408020c341b3c329ec30355a1.info index 6090024..9f9c2ae 100644 Binary files a/Library/metadata/f9/f9c6e0c408020c341b3c329ec30355a1.info and b/Library/metadata/f9/f9c6e0c408020c341b3c329ec30355a1.info differ diff --git a/Library/shadercompiler-UnityShaderCompiler.exe0.log b/Library/shadercompiler-UnityShaderCompiler.exe0.log index d32cd55..5be4fab 100644 --- a/Library/shadercompiler-UnityShaderCompiler.exe0.log +++ b/Library/shadercompiler-UnityShaderCompiler.exe0.log @@ -1,2 +1,2 @@ -Base path: C:/Program Files/Unity 5.3.5f1/Editor/Data -Cmd: getPlatforms +Base path: C:/Program Files/Unity/Editor/Data +Cmd: initializeCompiler diff --git a/ProjectSettings/ProjectSettings.asset b/ProjectSettings/ProjectSettings.asset index efca6a5..7ac0ca7 100644 Binary files a/ProjectSettings/ProjectSettings.asset and b/ProjectSettings/ProjectSettings.asset differ diff --git a/ProjectSettings/ProjectVersion.txt b/ProjectSettings/ProjectVersion.txt index 558807b..6e4d03d 100644 --- a/ProjectSettings/ProjectVersion.txt +++ b/ProjectSettings/ProjectVersion.txt @@ -1,2 +1 @@ -m_EditorVersion: 5.3.5f1 -m_StandardAssetsVersion: 0 +m_EditorVersion: 5.6.1f1