id
stringlengths
15
22
source
stringclasses
2 values
category
stringclasses
12 values
instruction
stringlengths
22
180
response
stringlengths
100
46.1k
system
stringclasses
5 values
local_man_61cd994b0b42
unity_docs
rendering
Explain 'macOS' in Unity.
This section of the User Manual has information on Unity development for macOS. Topic Description macOS requirements and compatibility Learn about system requirements and compatibility information for macOS. macOS Player settings reference Reference documentation for macOS Player settings . Developing for macOS Details...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ef4c49746aa9
unity_docs
scripting
What is `XR.MeshGenerationOptions` in Unity? Explain its purpose and usage.
MeshGenerationOptions enumeration Description Options for generating meshes. Use this enum with XRMeshSubsystem.GenerateMeshAsync to tell Unity how to handle data from the mesh provider. The mesh provider can supply a transform along with the mesh data. When this happens, the value of MeshGenerationOptions d...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_09d41c7074e2
unity_docs
scripting
What is `HeaderAttribute` in Unity? Explain its purpose and usage.
HeaderAttribute class in UnityEngine / Inherits from: PropertyAttribute / Implemented in: UnityEngine.CoreModule Description Use this PropertyAttribute to add a header above some fields in the Inspector. The header is done using a DecoratorDrawer . ```csharp using UnityEngine;public class Example : MonoBe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8ddd412566c5
unity_docs
editor
Show me a Unity C# example demonstrating `AssetDatabase.GetSubFolders`.
AssetDatabase.GetSubFolders Declaration public static string[] GetSubFolders (string path ); Parameters Parameter Description path The path of a directory in the Assets folder relative to the project folder root. Returns string[] Returns an array of the folder's subdirectories. Description Obtains th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9d218220132f
unity_docs
editor
What is `EditorGUILayout.BeginVertical` in Unity? Explain its purpose and usage.
EditorGUILayout.BeginVertical Declaration public static Rect BeginVertical (params GUILayoutOption[] options ); Declaration public static Rect BeginVertical ( GUIStyle style , params GUILayoutOption[] options ); Parameters Parameter Description style Optional GUIStyle . options An optional list...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_519ed52a68c7
unity_docs
rendering
Explain 'Blend command in ShaderLab reference' in Unity.
Determines how the GPU combines the output of the fragment shader with the render target. The functionality of this command depends on the blending operation, which you can set using the BlendOp command. Note that while blending itself is supported on all graphics APIs and hardware, some blending operations have more l...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_14e8b0702dfa_doc_0
github
scripting
What does `BackplateMaterial` do in this Unity script? Explain its purpose and signature.
Backplate material for a object bar. Signature: ```csharp public Material BackplateMaterial => backplateMaterial; ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1337f6b3f780
unity_docs
audio
Explain 'Audio Clip Import Settings reference' in Unity.
Explore the properties and settings to specify the sampling rate, compression format, and quality of your imported audio assets. For a list of the audio files Unity supports and information about how to import these files, refer to Audio file format compatibility and Import audio files into Unity . The audio file used ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b98497f646e9
unity_docs
physics
What is `SimulationMode.Update` in Unity? Explain its purpose and usage.
SimulationMode.Update Description Use this enumeration to instruct Unity to execute the physics simulation immediately after MonoBehaviour.Update . Executing the physics simulation during MonoBehaviour.Update provides a less stable and deterministic physics simulation due to the unpredictable fluctuations in fra...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b0453880b676
unity_docs
physics
Give me an overview of the `AndroidPreferredInstallLocation` class in Unity.
AndroidPreferredInstallLocation enumeration Description Options for preferred storage location for the application installation on Android devices. These options indicate whether the application should be installed on an internal or external storage of the Android device. You can pass a value from this enum to Pl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c68b79d1eaee
unity_docs
input
Give me an overview of the `GUIStyle` class in Unity.
GUIStyle class in UnityEngine / Implemented in: UnityEngine.IMGUIModule Description Styling information for GUI elements. Most GUI functions accept an optional GUIStyle parameter to override the default style. This allows coloring, fonts and other details to be changed and switched for different states (eg, wh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f582caa5bc77
unity_docs
rendering
Explain 'Linear color space' in Unity.
Resources and techniques for working in the linear color space. Page Description Linear color space in Unity Understand the linear color space in Unity. Gamma Textures in linear color space Learn how to use textures authored in the gamma color space inside a project that uses the linear color space. Linear textures Lea...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_61c79e657ba6
unity_docs
rendering
Explain 'Use HLSL and ShaderLab in a compute shader' in Unity.
## Use texture samplers Textures and samplers aren’t separate objects in Unity, so to use them in compute shaders you must follow one of the following Unity-specific rules: Use the same name as the Texture name, with sampler at the beginning (for example, Texture2D MyTex ; SamplerState samplerMyTex ). In this case, th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b3e4b07b0e8a
unity_docs
scripting
What is `Presets.Preset.GetDefaultPresetsForObject` in Unity? Explain its purpose and usage.
Preset.GetDefaultPresetsForObject Declaration public static Preset[] GetDefaultPresetsForObject ( Object target ); Parameters Parameter Description target The object instance tested against each DefaultPreset.m_Filter search filter. Returns Preset[] Returns an ordered list of Presets that match the spec...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b4ae7f6fbd4d
unity_docs
editor
Give me an overview of the `SelectionMode` class in Unity.
SelectionMode enumeration Description Determine the selection returned by Selection.GetTransforms . The default transform selection mode is: SelectionMode.TopLevel | SelectionMode.ExcludePrefab | SelectionMode.Editable , which returns all parent transforms of objects that can be edited, and aren't prefabs. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5a52af30cdcf
unity_docs
animation
What is `Animations.ScaleConstraint.SetSources` in Unity? Explain its purpose and usage.
ScaleConstraint.SetSources Declaration public void SetSources (List<ConstraintSource> sources ); Parameters Parameter Description sources The list of sources to set. Description Sets the list of sources on the component. Throws ArgumentNullException, if the list of sources is null.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f839046a4ba1
unity_docs
scripting
What are the parameters of `Unity.IO.LowLevel.Unsafe.FileHandle.Close` in Unity?
Returns JobHandle The JobHandle for the asynchronous close operation. You can use this JobHandle as a dependency when scheduling other jobs that must not run before the close operation is finished. Description Asynchronously closes the file referenced by this FileHandle and disposes the FileHandle instance. Always clos...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ad73af5c342e
unity_docs
editor
Show me a Unity C# example demonstrating `AssetDatabase.Refresh`.
me, you don't need to call this method yourself, because the Editor automatically detects changes to assets on disk and imports them as needed. You might need to call this method if you have disabled Auto Refresh in the Asset Pipeline Preferences, or if you have made changes to assets on disk from an external applic...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c8532c185f95
unity_docs
scripting
What is `PlayerSettings.iOS.SetiPhoneLaunchScreenType` in Unity? Explain its purpose and usage.
PlayerSettings.iOS.SetiPhoneLaunchScreenType Declaration public static void SetiPhoneLaunchScreenType ( iOSLaunchScreenType type ); Description Sets the mode which will be used to generate the app's launch screen Interface Builder (.xib) file for iPhone. The launch screen image defaults to an default colored...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_71286c0d9d41
unity_docs
scripting
Show me a Unity C# example demonstrating `Input.accelerationEvents`.
ionEvent[] accelerationEvents ; Description Returns list of acceleration measurements which occurred during the last frame. (Read Only) (Allocates temporary variables). Note : This API is part of the legacy Input Manager. The recommended best practice is that you don't use this API in new projects. For new projec...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7b749453c202
unity_docs
editor
What is `BuildPlayerOptions.scenes` in Unity? Explain its purpose and usage.
BuildPlayerOptions.scenes public string[] scenes ; Description The Scenes to be included in the build. If empty, the currently open Scene will be built. Paths are relative to the project folder, for example "Assets/MyLevels/MyScene.unity". If any scene is currently open and has unsaved changes, the editor will ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_8f542aebd9f9_doc_1
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
The path to this prefab's location in the resource folder Signature: ```csharp public string folder; ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_636613064751
unity_docs
math
What is `XR.Bone.TryGetPosition` in Unity? Explain its purpose and usage.
Bone.TryGetPosition Declaration public bool TryGetPosition (out Vector3 position ); Parameters Parameter Description position Vector3 to receive the position of the bone in Unity world space. Returns bool true if the rotation was retrieved, false otherwise.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_abbf31f509dc
unity_docs
math
What is `Terrain.treeMotionVectorModeOverride` in Unity? Explain its purpose and usage.
Terrain.treeMotionVectorModeOverride public TreeMotionVectorModeOverride treeMotionVectorModeOverride ; Description The motion vector rendering mode for all SpeedTree models painted on the terrain.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2688f27e6800
unity_docs
scripting
What is `Rendering.ReflectionProbeRefreshMode` in Unity? Explain its purpose and usage.
ReflectionProbeRefreshMode enumeration Description An enum describing the way a real-time reflection probe refreshes in the Player. Properties Property Description OnAwake Causes the probe to update only on the first frame it becomes visible. The probe will no longer update automatically, however you may subseq...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7c773a7f8408
unity_docs
math
In Unity's 'Using common math functions', what is 'Interpolation' and how does it work?
Unity’s interpolation functions allows you to calculate a value that is some way between two given points. Each of these functions behaves in a different way, suitable for different situations. See the examples in each for more information: Lerp LerpAngle LerpUnclamped InverseLerp MoveTowards MoveTowardsAngle SmoothDam...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_870893742548
unity_docs
scripting
What is `Collider.bounds` in Unity? Explain its purpose and usage.
Collider.bounds public Bounds bounds ; Description The world space bounding volume of the collider (Read Only). Note that this will be an empty bounding box if the collider is disabled or the game object is inactive. ```csharp using UnityEngine;public class ColliderBounds : MonoBehaviour { Collider m_Collid...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f2c0d3d2ac79
unity_docs
scripting
What is `ILogHandler.LogException` in Unity? Explain its purpose and usage.
ILogHandler.LogException Declaration public void LogException (Exception exception , Object context ); Parameters Parameter Description exception Runtime Exception. context Object to which the message applies. Description A variant of ILogHandler.LogFormat that logs an exception message.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c9699306a3c1
unity_docs
math
What is `UIElements.Painter2D.Arc` in Unity? Explain its purpose and usage.
Painter2D.Arc Declaration public void Arc ( Vector2 center , float radius , UIElements.Angle startAngle , UIElements.Angle endAngle , UIElements.ArcDirection direction ); Parameters Parameter Description center The center position of the arc. radius The radius of the arc. startAngle The starti...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b4a9820811c5
unity_docs
math
What is `AndroidJNI.GetStringUTFChars` in Unity? Explain its purpose and usage.
AndroidJNI.GetStringUTFChars Declaration public static string GetStringUTFChars (IntPtr str ); Description Returns a managed string object representing the string in modified UTF-8 encoding. This method is a modification of the original GetStringUTFChars , which returns a pointer to an array of bytes. Additio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_56b5779a92bf
unity_docs
physics
Show me a Unity C# example demonstrating `PackageManager.RegistryInfo.isDefault`.
packages in the default registry unless a project manifest contains one or more scoped registries. When a manifest declares a scoped registry, the Package Manager uses the scope to determine whether to look for a package in that registry. You can configure scoped registries inside a scopedRegistries element of your P...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_23c46652e27d
unity_docs
physics
Give me an overview of the `EffectorSelection2D` class in Unity.
EffectorSelection2D enumeration Description Selects the source and/or target to be used by an Effector2D . Properties Property Description Rigidbody The source/target is defined by the Rigidbody2D. Collider The source/target is defined by the Collider2D.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_72c7e0028d9f
unity_docs
scripting
What is `Unity.IntegerTime.RationalTimeExtensions.Subtract` in Unity? Explain its purpose and usage.
RationalTimeExtensions.Subtract Declaration public static Unity.IntegerTime.RationalTime Subtract ( Unity.IntegerTime.RationalTime lhs , Unity.IntegerTime.RationalTime rhs ); Parameters Parameter Description t The left hand side. r The right hand side. Returns RationalTime A new instance that is ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_39e8eb0b33c5
unity_docs
rendering
What is `LightingExplorerTableColumn` in Unity? Explain its purpose and usage.
LightingExplorerTableColumn class in UnityEditor Description This is used when defining how a column should look and behave in the Lighting Explorer. Constructors Constructor Description LightingExplorerTableColumn Constructor. Delegates Delegate Description ComparePropertiesDelegate A delegate for compari...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e943c365c20a
unity_docs
math
What is `Vector4.LerpUnclamped` in Unity? Explain its purpose and usage.
Vector4.LerpUnclamped Declaration public static Vector4 LerpUnclamped ( Vector4 a , Vector4 b , float t ); Description Linearly interpolates between two vectors. Interpolates between a and b by amount t . When t = 0 returns a . When t = 1 returns b . When t = 0.5 returns the midpoint of...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a0d20a3c5746
unity_docs
audio
What is `Microphone.GetPosition` in Unity? Explain its purpose and usage.
Microphone.GetPosition Declaration public static int GetPosition (string deviceName ); Parameters Parameter Description deviceName The name of the device. Returns int The current position in the recording buffer, in samples. To convert to seconds, divide by the clip's sample rate (frequency). Descrip...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_6b6b1e0734cf
github
scripting
Write a Unity Editor script for Build Target Setup Step
```csharp #region using System; using MagicLeap.SetupTool.Editor.Interfaces; using MagicLeap.SetupTool.Editor.Utilities; using UnityEditor; using UnityEditor.Build; using UnityEngine; #endregion namespace MagicLeap.SetupTool.Editor.Setup { /// <summary> /// Switches the build platform to Android /// </summary> ...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_68573f04dbe9
unity_docs
scripting
What is `Experimental.GraphView.Port.OnStartEdgeDragging` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Port.OnStartEdgeDragging Declaration public void OnStartEdgeDragging (); Description Called when an edge is dragged.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_18cac3578f8b
unity_docs
rendering
Show me a Unity C# example demonstrating `ImageConversion.EncodeToPNG`.
further processing. This function does not work on any compressed format. Texture.isReadable must be true . The encoded PNG data will be either 8bit grayscale, RGB or RGBA (depending on the passed in format). For single-channel red textures ( R8 , R16 , RFloat and RHalf ), the encoded PNG data will be in grays...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1e64f311f0a2
unity_docs
physics
What is `RaycastHit2D.transform` in Unity? Explain its purpose and usage.
RaycastHit2D.transform public Transform transform ; Description The Transform on the GameObject that the Collider2D is attached to. When the RaycastHit2D result is returned from a physics query, the collider refers to the specific Collider2D that was detected however transform refers to the Tra...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_efb1af9eead1
unity_docs
xr
What is `WSA.Tile.GetSecondaries` in Unity? Explain its purpose and usage.
Tile.GetSecondaries Declaration public static Tile[] GetSecondaries (); Returns Tile[] An array of Tile objects. Description Gets all secondary tiles. Secondary tile exists if it's pinned to start screen or a request to pin it is not yet complete.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b98c55addae0
unity_docs
scripting
What is `GameObjectUtility.SetParentAndAlign` in Unity? Explain its purpose and usage.
GameObjectUtility.SetParentAndAlign Declaration public static void SetParentAndAlign ( GameObject child , GameObject parent ); Parameters Parameter Description child The GameObject that should have a new parent set. parent The GameObject that the child should get as a parent and have position and layer...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_df1a1e85a4f7
unity_docs
editor
Explain 'Create list and tree views' in Unity.
List and tree views are common features in UI design. You can use UI Toolkit to create list and tree views inside a custom Editor window or runtime. This example demonstrates how to create list and tree views inside a custom Editor window. You configure the structure of lists and trees with UXML and then dynamically po...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4b69a97d8ac4
unity_docs
input
What is `HDROutputSettings.maxFullFrameToneMapLuminance` in Unity? Explain its purpose and usage.
HDROutputSettings.maxFullFrameToneMapLuminance public int maxFullFrameToneMapLuminance ; Description Maximum input luminance at which gradation is preserved even when the entire screen is bright. Measured in nits. This value is -1 if Unity cannot obtain a value from the HDR display. Accessing this member result...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_f522b91ce703_doc_17
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Represents an object which can receive six arguments as part of its initialization process.Base interface of . Signature: ```csharp public interface ISixArguments ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_98df72825c17
unity_docs
math
Show me a Unity C# example demonstrating `Tilemaps.Tilemap.GetTilesBlockNonAlloc`.
iles retrieved, including null entries. Description Retrieves an array of Tiles with the given bounds. This is meant for more a performant way to get Tiles as a batch, when compared to calling GetTile for every single position. If the size of the arrays passed in as parameters are less than the number of Tiles wit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_716a88e21310
unity_docs
xr
Explain 'System requirements for Unity 6.0' in Unity.
This page outlines the system requirements you need to run Unity 6.0 on all supported platforms. Unity Editor system requirements Unity Editor platform limitations Unity Player system requirements : Mobile Console Desktop Server platform Web platform XR platform Standalone XR devices Meta OpenXR Windows Mixed Reality M...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5c46acae122e
unity_docs
scripting
What is `Experimental.GraphView.Resizer.ctor` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Resizer Constructor Declaration public Resizer (); Parameters Parameter Description minimumSize Minimum element size. Description Resizer's constructor.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1a6cb06daae4
unity_docs
math
Show me a Unity C# example demonstrating `Texture2D.GetPixel`.
o decompress compressed textures, and use memory to store the decompressed area. To get pixel data more quickly, use GetPixelData instead. If you need to get a large block of pixels, it might be faster to use GetPixels32 or GetPixels . You can't use GetPixel with textures that use Crunch texture compression. Add...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1b666b40fc3d
unity_docs
scripting
What is `ObjectChangeKind.ChangeGameObjectOrComponentProperties` in Unity? Explain its purpose and usage.
ObjectChangeKind.ChangeGameObjectOrComponentProperties Description A change of this type indicates that a property of a GameObject or Component has changed. This happens for example when Undo.RecordObject is used with an instance of a Component .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_85ba85fcee51
unity_docs
networking
What is `Unity.Android.Gradle.Manifest.PersistableMode` in Unity? Explain its purpose and usage.
PersistableMode enumeration Description Mirrors the PersistableMode enum. For more information about the attribute, see Android's documentation: PersistableMode attribute Properties Property Description Null Attribute is not set and will not appear in the element. PersistRootOnly Mirrors android:persista...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1628f02400c6
unity_docs
scripting
What is `Playables.PlayableExtensions.GetPlayState` in Unity? Explain its purpose and usage.
PlayableExtensions.GetPlayState Declaration public static Playables.PlayState GetPlayState (U playable ); Parameters Parameter Description playable The Playable used by this operation. Returns PlayState The current PlayState of the Playable . Description Returns the current PlayState of the Pla...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_359de078fb6e
unity_docs
rendering
What is `SystemInfo.maxTexture3DSize` in Unity? Explain its purpose and usage.
SystemInfo.maxTexture3DSize public static int maxTexture3DSize ; Description Maximum 3D texture size in pixels (Read Only). The largest 3D texture width, height and depth that your graphics hardware supports. Unity only supports textures up to a size of 16384, even if maxTexture3DSize returns a larger size. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_53e736b416ce
unity_docs
performance
What is `Rendering.CommandBuffer.EndSample` in Unity? Explain its purpose and usage.
CommandBuffer.EndSample Declaration public void EndSample (string name ); Declaration public void EndSample ( Profiling.CustomSampler sampler ); Declaration public void EndSample ( Unity.Profiling.ProfilerMarker marker ); Parameters Parameter Description name Name of the profile information used ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_53bf6a43ec10
unity_docs
scripting
What is `Events.UnityEvent_4` in Unity? Explain its purpose and usage.
UnityEvent<T0,T1,T2,T3> class in UnityEngine.Events / Inherits from: Events.UnityEventBase / Implemented in: UnityEngine.CoreModule Description Four argument version of UnityEvent . Generics are supported, specify type parameters on initialization as shown in the example. Refer to Configure callbacks in the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1332406bf827
unity_docs
scripting
What is `DragAndDrop.InspectorDropHandler` in Unity? Explain its purpose and usage.
DragAndDrop.InspectorDropHandler Declaration public delegate DragAndDropVisualMode InspectorDropHandler (Object[] targets , bool perform ); Parameters Parameter Description targets Target objects of the drag operation. perform True if the event is of type EventType.DragPerform . Returns DragAndDropVi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_da74e8ebead8
unity_docs
rendering
What is `BuildAssetBundleOptions` in Unity? Explain its purpose and usage.
BuildAssetBundleOptions enumeration Description Asset Bundle building options. These flags allows you to configure options when calling BuildPipeline.BuildAssetBundles . Additional resources: AssetBundle , BuildPipeline.BuildAssetBundles ```csharp //Create a folder (right click in the Assets folder and go to C...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_20445369daf4
unity_docs
scripting
Give me an overview of the `ApplicationMemoryUsageChange` class in Unity.
ApplicationMemoryUsageChange struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description Contains information about a change in the application's memory usage. See Application.memoryUsageChanged . Properties Property Description memoryUsage The memory usage level for the application.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9bbfa1196ffa
unity_docs
scripting
What is `PatchExtents` in Unity? Explain its purpose and usage.
PatchExtents struct in UnityEngine / Implemented in: UnityEngine.TerrainModule Description Structure containing minimum and maximum terrain patch height values. Properties Property Description max Maximum height of a terrain patch. min Minimum height of a terrain patch.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a1799872d5f7
unity_docs
ui
What is `EditorWindow.ShowPopup` in Unity? Explain its purpose and usage.
EditorWindow.ShowPopup Declaration public void ShowPopup (); Description Shows an Editor window using popup-style framing. This means the window has no frame, and is not draggable. It is intended for showing something like a popup menu within an existing window. Opening a window using this method will not give ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3fdfb579f4cd
unity_docs
rendering
What is `Experimental.GlobalIllumination.Cookie.sizes` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Cookie.sizes public Vector2 sizes ; Description The scale factors controlling how the directional light's cookie is projected into the scene. This parameter should be set to 1 for all other light types.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6f141edfbc00
unity_docs
physics
What is `Physics.GetIgnoreLayerCollision` in Unity? Explain its purpose and usage.
Physics.GetIgnoreLayerCollision Declaration public static bool GetIgnoreLayerCollision (int layer1 , int layer2 ); Description Are collisions between layer1 and layer2 being ignored? Returns the value set by Physics.IgnoreLayerCollision or in the Physics inspector.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_05edd90b7f1f
unity_docs
input
What is `Input` in Unity? Explain its purpose and usage.
Input class in UnityEngine / Implemented in: UnityEngine.InputLegacyModule Description Interface into the Legacy Input system. Note : The Input class is part of the legacy Input Manager. The recommended best practice is that you don't use this API in new projects. For new projects, use the new Input System...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b5d174bdf6bf
unity_docs
scripting
What is `U2D.SpriteAtlasUtility.PackAllAtlases` in Unity? Explain its purpose and usage.
SpriteAtlasUtility.PackAllAtlases Declaration public static void PackAllAtlases ( BuildTarget target , bool canCancel ); Parameters Parameter Description target The target build platform. canCancel Whether the user can cancel the operation. Description Pack all the SpriteAtlas Assets in the Project f...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c7da010995d4
unity_docs
math
Show me a Unity C# example demonstrating `SerializedProperty`.
edProperty and SerializedObject are classes for editing properties on objects in a completely generic way that automatically handles undo, multi-object editing and Prefab overrides. SerializedProperty is primarily used to read or change the value of a property. It can also iterate through the properties of an object...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_beb39e6a98eb
unity_docs
scripting
What is `Video.VideoPlayer.EventHandler` in Unity? Explain its purpose and usage.
VideoPlayer.EventHandler Declaration public delegate void EventHandler ( Video.VideoPlayer source ); Parameters Parameter Description source The VideoPlayer that emits the event. Description Delegate type for all events without parameters emitted by VideoPlayer s. Use this EventHandler to define what ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_305c4453bc0e
unity_docs
rendering
What is `Rendering.BuiltinShaderDefine.UNITY_METAL_SHADOWS_USE_POINT_FILTERING` in Unity? Explain its purpose and usage.
BuiltinShaderDefine.UNITY_METAL_SHADOWS_USE_POINT_FILTERING Description UNITY_METAL_SHADOWS_USE_POINT_FILTERING is set if shadow sampler should use point filtering on iOS Metal. Additional resources: PlayerSettings.iOS.forceHardShadowsOnMetal .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d75da487f9aa
unity_docs
rendering
Show me a Unity code example for 'Search GameObjects with the Hierarchy search provider'.
with a GameObject you’re editing in the Inspector window: right-click the property in the Inspector window and select Search Same Property Value . For more information about components and properties in the Hierarchy search provider, and how they differ from the Project search provider, refer to Search your project and...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_65ac3f9838d1
unity_docs
editor
What is `Search.SearchExpressionEvaluationHints.ThreadNotSupported` in Unity? Explain its purpose and usage.
SearchExpressionEvaluationHints.ThreadNotSupported Description Specifies that an evaluator does not support worker thread evaluation and should only be evaluated in the main thread. This could be the case if an evaluator is using non-tread safe Unity API (like AssetDatabase ). ```csharp [Description("Returns asset...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_ecac194c16fb_doc_6
github
scripting
What does `SetOriginPoint` do in this Unity script? Explain its purpose and signature.
This function has different behaviour depending on the coordinate system in use.UnityWorld - Resets the root latitude and longitude of the map so that the local space origin (0,0,0) of the map&apos;s game object is centered at that point.ECEF - Sets the maps world position to that latitude and longitude so that the cam...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_d79a48f24a86
unity_docs
rendering
What is `LightProbeProxyVolume.ProbePositionMode` in Unity? Explain its purpose and usage.
ProbePositionMode enumeration Description The mode in which the interpolated Light Probe positions are generated. Additional resources: Light Probes , Light Probe Proxy Volume . Properties Property Description CellCorner Divide the volume in cells based on resolution, and generate interpolated Light Probes ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_da95ca563cb7
unity_docs
physics
Explain 'Introduction to compound colliders' in Unity.
A compound collider is a collection of colliders on the same Rigidbody GameObject . Compound colliders collectively behave like a single Rigidbody collider. They are useful when you need an accurate collider for a concave shape, or if you have a model that would be too computationally demanding to simulate with a Mesh ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_5b4f24fd97a1
github
scripting
Write a Unity C# script called Private Singleton
```csharp using System; using UnityEngine; namespace GameUtil { /// <summary> /// Lazy. Thread safe. Support private constructor /// </summary> public abstract class PrivateSingleton<T> where T : PrivateSingleton<T> { private static readonly object lockObj = new object(); private st...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_5ca438028b29
unity_docs
editor
What is `EditorUtility.NaturalCompare` in Unity? Explain its purpose and usage.
EditorUtility.NaturalCompare Declaration public static int NaturalCompare (string a , string b ); Description Human-like sorting. Sorts strings alphabetically, but with numbers in strings numerically, so "xx11" comes after "xx2".
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_785c2d52d413
github
scripting
Write a Unity Editor script for Smart Reference Utils
```csharp using System; using System.Collections.Generic; using System.Reflection; using UnityEditor; using UnityEngine; namespace SmartReference.Editor { public static class SmartReferenceUtils { [MenuItem("Tools/SmartReference/Update All References", priority = 100)] public static void Updat...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_d89284a12df1
unity_docs
xr
Show me a Unity C# example demonstrating `Mesh.indexBufferTarget`.
Mesh.indexBufferTarget public GraphicsBuffer.Target indexBufferTarget ; Description The intended target usage of the Mesh GPU index buffer. By default, Mesh index buffers have GraphicsBuffer.Target.Index usage target. If you want to access the mesh index buffer from a compute shader, additional targets nee...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2f64fed29c25
unity_docs
input
Show me a Unity C# example demonstrating `KeyCode.Mouse1`.
KeyCode.Mouse1 Description Right mouse button (or secondary mouse button). Use this to detect right mouse button presses. The “1” mouse button is the secondary button on the user’s mouse, which is usually the right mouse button. Unity defines this as the "1" mouse button, as the mouse button numbering begins at 0. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_4427805634f1_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
JPG image sequence recorder.This recorder is currently supported on macOS and Windows.This recorder is NOT thread-safe, and as such it is not fully compliant with the `IMediaRecorder` interfacex. Signature: ```csharp public sealed class JPGRecorder : IMediaRecorder ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
gh_5242dfca4b88
github
scripting
Write a Unity C# ScriptableObject for Asset Setup
```csharp using NUnit.Framework; using UnityEditor; using UnityEngine; using UnityEngine.TestTools; namespace SmartReference.Runtime.Tests { /// <summary> /// Creates test assets BEFORE entering Play Mode (but still part of the test pipeline), /// and cleans them up afterward. /// </summary> publi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_76e86f09bc1e
unity_docs
scripting
Give me an overview of the `VideoResizeMode` class in Unity.
VideoResizeMode enumeration Description How the video clip's images will be resized during transcoding. When choosing a mode that may result in a change in aspect ratio, use the VideoClipImporter.keepRatio property to control the addition of padding. Properties Property Description OriginalSize Same width and ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_848da830ac99
unity_docs
scripting
Show me a Unity C# example demonstrating `ForceMode2D`.
ForceMode2D enumeration Description Option for how to apply a force using Rigidbody2D.AddForce . Use this to apply a certain type of force to a 2D RigidBody. There are two types of forces to apply: Force mode and Impulse Mode. For a 3D Rigidbody see ForceMode . ```csharp //This script adds force to a Rigidbody....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9e99176824a4
unity_docs
ui
What is `UIElements.UxmlElementAttribute.ctor` in Unity? Explain its purpose and usage.
UxmlElementAttribute Constructor Declaration public UxmlElementAttribute (); Description Exposes a type of VisualElement to UXML and UI Builder Declaration public UxmlElementAttribute (string uxmlName ); Parameters Parameter Description uxmlName Provides a custom name for the element. Description ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_419ebc2ab86b
unity_docs
physics
What is `PlayerSettings.Android.forceSDCardPermission` in Unity? Explain its purpose and usage.
PlayerSettings.Android.forceSDCardPermission public static bool forceSDCardPermission ; Description Force SD card permission. ```csharp using UnityEngine; using UnityEditor; using UnityEditor.Build;public class ForceSDCardPermissionSample : MonoBehaviour { [MenuItem("Build/ForceSDCardPermission Sample")] pub...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ee75f6a9f75b
unity_docs
rendering
What is `Rendering.RayTracingInstanceCullingFlags.EnablePlaneCulling` in Unity? Explain its purpose and usage.
RayTracingInstanceCullingFlags.EnablePlaneCulling Description Causes RayTracingAccelerationStructure.CullInstances to perform plane culling. The Plane list is defined by RayTracingInstanceCullingConfig.planes . A Renderer in the Scene is accepted to the acceleration structure if its AABB lies completely or par...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2de5778ca9bc
unity_docs
scripting
Show me a Unity C# example demonstrating `Editor`.
Editor class in UnityEditor / Inherits from: ScriptableObject Description Derive from this base class to create a custom inspector or editor for your custom object. ```csharp using UnityEngine; using System.Collections;// This is not an editor script. public class MyPlayer : MonoBehaviour { public int armor = ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7908408591ef
unity_docs
rendering
What is `ShaderUtil.ShaderPropertyType` in Unity? Explain its purpose and usage.
ShaderPropertyType enumeration Description Type of a given texture property. Properties Property Description Color Color Property. Vector Vector Property. Float Float Property. Range Range Property. TexEnv Texture Property. Int Int Property.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b87ab2422f09
unity_docs
rendering
What is `Search.SearchViewFlags.DisableBuilderModeToggle` in Unity? Explain its purpose and usage.
SearchViewFlags.DisableBuilderModeToggle Description This flag disables the ability to switch between text mode and builder mode. This flag is not set by default. When it is set, the Search Picker window will not be able to switch between text mode and builder mode, no matter what mode it is already in. ```csharp ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0be061cd7215
unity_docs
scripting
What is `IMGUI.Controls.MultiColumnHeader.canSort` in Unity? Explain its purpose and usage.
MultiColumnHeader.canSort public bool canSort ; Description Use this property to control whether sorting is enabled for all the columns. This property controls whether sorting is enabled for all columns and is set to true by default. If false, left-clicking any column header will have no effect. Use the MultiC...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_55be39f85f7e
unity_docs
performance
Explain 'Copying NativeContainer structures' in Unity.
Native containers are value types, which means that when they’re assigned to a variable, Unity copies the NativeContainer structure, which contains pointers to where the native container’s data is stored, including its AtomicSafetyHandle . It doesn’t copy the entire contents of the NativeContainer . This scenario means...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f1be244f32a4
unity_docs
audio
What is `Windows.Speech.DictationRecognizer.AutoSilenceTimeoutSeconds` in Unity? Explain its purpose and usage.
DictationRecognizer.AutoSilenceTimeoutSeconds public float AutoSilenceTimeoutSeconds ; Description The time length in seconds before dictation recognizer session ends due to lack of audio input. The default value is 20 seconds.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b36ccc97d237
unity_docs
editor
What is `PrefabUtility.ReplacePrefabAssetOfPrefabInstances` in Unity? Explain its purpose and usage.
PrefabUtility.ReplacePrefabAssetOfPrefabInstances Declaration public static void ReplacePrefabAssetOfPrefabInstances (GameObject[] prefabInstanceRoots , GameObject prefabAssetRoot , InteractionMode mode ); Declaration public static void ReplacePrefabAssetOfPrefabInstances (GameObject[] prefabInstanceRoot...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a188786e895f
unity_docs
scripting
What is `Unity.Android.Gradle.AfterEvaluate` in Unity? Explain its purpose and usage.
AfterEvaluate class in Unity.Android.Gradle / Inherits from: Unity.Android.Gradle.BaseBlock Description The C# definition of the AfterEvaluate element in a gradle file. For more information about the element, see Gradle's documentation: afterEvaluate element Properties Property Description Publishing Mav...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e0f86edccb8c
unity_docs
scripting
Show me a Unity code example for 'Create a Video Player component'.
ne Hierarchy, in the Scene view , or in the Inspector. As a result, Unity creates a GameObject that contains a Video Player component and automatically assigns your video clip to the component. ## Use C# scripting to add the component at runtime You can also use scripting to add a VideoPlayer component to a GameObjec...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_28ef23f48692
unity_docs
editor
What is `SceneManagement.PrefabStage.Mode` in Unity? Explain its purpose and usage.
Mode enumeration Description Specifies the mode that Unity uses to open a Prefab stage. You can open the stage either in isolation or in context. You can only open a Prefab stage in context if you open it via an instance of the Prefab Asset. Properties Property Description InIsolation Editing in isolation mean...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c45ecebbc5a0
unity_docs
scripting
Explain 'Property Binder component' in Unity.
A Property Binder is a C# Behaviour which you can attach to a GameObject with a Visual Effect component . Property Binders allow for connections between Scene values and Exposed Properties for the attached Visual Effect instance. This component only works when you install the Visual Effect Graph package. For informatio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_fc6aff50626a
unity_docs
ui
Explain 'Child selectors' in Unity.
USS child selectors match elements that are the child of another element in the visual tree . ## Syntax A child selector consists of multiple simple selectors separated by > . ``` selector1 > selector2 {...} ``` You can include the wildcard selector in complex selectors. For example, the following USS rule uses the w...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_433db7034302
unity_docs
scripting
Give me an overview of the `AnimationUtility` class in Unity.
AnimationUtility class in UnityEditor Description Editor utility functions for modifying animation clips. Static Properties Property Description onCurveWasModified Called when an animation curve, in an animation clip, is modified. Static Methods Method Description CalculateTransformPath Retrieves the path ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_44f154734572
unity_docs
scripting
What is `Accessibility.AccessibilityHierarchy.GetLowestCommonAncestor` in Unity? Explain its purpose and usage.
AccessibilityHierarchy.GetLowestCommonAncestor Declaration public Accessibility.AccessibilityNode GetLowestCommonAncestor ( Accessibility.AccessibilityNode firstNode , Accessibility.AccessibilityNode secondNode ); Parameters Parameter Description firstNode The first node to find the lowest common ances...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e6c705edefdd
unity_docs
scripting
What is `Experimental.GraphView.SelectionDropper.clampToParentEdges` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. SelectionDropper.clampToParentEdges public bool clampToParentEdges ; Description Clamp element being dragged to the parent's (usually the graph) edges.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6d83d10da1e5
unity_docs
scripting
Show me a Unity C# example demonstrating `QualitySettings.globalTextureMipmapLimit`.
ads all loaded textures affected by the global texture mipmap limit. At the same time, Unity requests an asynchronous re-upload for textures that are using the Texture Streaming system and affected by the global texture mipmap limit. Be aware: the system may take a few frames to apply a new globalTextureMipmapLimit v...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.