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_sr_88102d70680d
unity_docs
scripting
Show me a Unity C# example demonstrating `SceneManagement.SceneManager.activeSceneChanged`.
ion Subscribe to this event to get notified when the active Scene has changed. This script added to activeSceneChanged takes two hidden arguments. These are the replaced Scene and the next Scene. The arguments are not visible. In the Editor this event is sent only in Play mode (not in Edit mode). If the event is ne...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cd69d72585a8
unity_docs
physics
What is `CustomRenderTextureUpdateMode` in Unity? Explain its purpose and usage.
CustomRenderTextureUpdateMode enumeration Description Frequency of update or initialization of a Custom Render Texture. Additional resources: CustomRenderTexture . Properties Property Description OnLoad Initialization/Update will occur once at load time and then can be triggered again by script. Realtime Ini...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e1fa495d6bf6
unity_docs
editor
What is `Device.SystemInfo.graphicsDeviceType` in Unity? Explain its purpose and usage.
SystemInfo.graphicsDeviceType public static Rendering.GraphicsDeviceType graphicsDeviceType ; Description This has the same functionality as SystemInfo.graphicsDeviceType and also mimics platform-specific behavior in the Unity Editor.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_ac4475661729_doc_11
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Represents an object which can be initialized using eleven arguments.-derived classes that implement this interface can be instantiated with arguments using the function.-derived classes that implement this interface can be added to a with arguments using the GameObject.AddComponent function.These functions can automat...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_man_ec9af07b4d85
unity_docs
physics
In Unity's 'Line Renderer Scene Tools panel reference', what is 'Scene Editing Mode: Create Points' and how does it work?
To set the Scene Editing Mode to Create Points , select the Create Points button. Select it again to set the Scene Editing Mode to None . Control Description Input Set the input method you want to use to create points. The options are: Mouse position : Create points based on the mouse position in the Scene view. Physic...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_016c8afec72f
unity_docs
scripting
What are the parameters of `Unity.Collections.LowLevel.Unsafe.UnsafeUtility.PinGCArrayAndGetDataAddress` in Unity?
Returns void* A pointer to the first element of the pinned array. Use this pointer for direct memory access to the array elements. Description Pins a garbage-collected (GC) array and returns the address of its first element, ensuring the array's memory location remains fixed. The PinGCArrayAndGetDataAddress method pins...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3bb5277d31a3
unity_docs
scripting
What is `Sprite.Create` in Unity? Explain its purpose and usage.
Sprite.Create Declaration public static Sprite Create ( Texture2D texture , Rect rect , Vector2 pivot , float pixelsPerUnit , uint extrude ); Declaration public static Sprite Create ( Texture2D texture , Rect rect , Vector2 pivot , float pixelsPerUnit , uint extrude , SpriteMeshType m...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_8d3047045e4b
github
scripting
Write a Unity Editor script for Set Vector Editor
```csharp using System.Collections; using System.Collections.Generic; using UnityEngine; using UnityEditor; using MBT; namespace MBTEditor { [CustomEditor(typeof(SetVector))] public class SetVectorEditor : Editor { SerializedProperty titleProp; SerializedProperty typeProp; Serializ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d0a792abafc1
unity_docs
editor
Show me a Unity C# example demonstrating `EditorWindow.focusedWindow`.
EditorWindow.focusedWindow public static EditorWindow focusedWindow ; Description The EditorWindow which currently has keyboard focus. (Read Only) focusedWindow can be null if no window has focus. Additional resources: mouseOverWindow , Focus . Focus other windows with a mouse click. ```csharp using Unit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a7ccc7c45044
unity_docs
rendering
What is `LightProbeGroup.dering` in Unity? Explain its purpose and usage.
LightProbeGroup.dering public bool dering ; Description Removes ringing from probes if enabled (Editor only). Ringing is an artifact that can occur on probes if they are subject to drastic changes in lighting. Light may overshoot and appear in the opposite end of the probe. This feature can remove ringing on p...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_24031f0c597f
unity_docs
scripting
What is `AI.NavMeshTriangulation` in Unity? Explain its purpose and usage.
NavMeshTriangulation struct in UnityEngine.AI / Implemented in: UnityEngine.AIModule Description Contains data describing a triangulation of a navmesh. Properties Property Description areas NavMesh area indices for the navmesh triangulation. indices Triangle indices for the navmesh triangulation. vertices ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3eee8114327c
unity_docs
scripting
What is `Networking.UnityWebRequest.Get` in Unity? Explain its purpose and usage.
UnityWebRequest.Get Declaration public static Networking.UnityWebRequest Get (string uri ); Declaration public static Networking.UnityWebRequest Get (Uri uri ); Parameters Parameter Description uri The URI of the resource to retrieve via HTTP GET. Returns UnityWebRequest An object that retrieves...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9ad42682878b
unity_docs
scripting
What is `UIElements.IPointerEvent.azimuthAngle` in Unity? Explain its purpose and usage.
IPointerEvent.azimuthAngle public float azimuthAngle ; Description Gets the angle of the stylus relative to the x-axis, in radians. A value of 0 indicates that the stylus is pointed along the x-axis of the device.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_feb181a6a312
unity_docs
scripting
What is `PackageManager.PackageRegistrationEventArgs.changedTo` in Unity? Explain its purpose and usage.
PackageRegistrationEventArgs.changedTo public ReadOnlyCollection<PackageInfo> changedTo ; Description A collection of PackageInfo entries describing packages that will override a previously registered version during the Package Manager registration process.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5104c76793bd
unity_docs
scripting
Show me a Unity C# example demonstrating `ParticleSystem.MainModule.emitterVelocityMode`.
ParticleSystem.MainModule.emitterVelocityMode public ParticleSystemEmitterVelocityMode emitterVelocityMode ; Description Control how the Particle System calculates its velocity, when moving in the world. ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(ParticleSystem))] public c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dc1c702cad76
unity_docs
math
Show me a Unity C# example demonstrating `Vector2.ToString`.
tring (string format , IFormatProvider formatProvider ); Parameters Parameter Description format A numeric format string. formatProvider An object that specifies culture-specific formatting. Description Returns a formatted string for this vector. Defaults to two digits displayed (format="F2"). For more in...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_49fb8f7ea2b1
unity_docs
rendering
Explain 'Change particle color' in Unity.
Understand how the Particle System can change a particle’s rotation based on its speed or lifetime. ## Color by speed The Color by Speed module can change a particle’s color based on its speed in distance units per second. Burning or glowing particles (such as sparks) tend to burn more brightly when they move quickly...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_597910e24a37
unity_docs
scripting
In Unity's 'Unity programming best practices', what is 'Unity Object lifecycle and references' and how does it work?
When writing C# in Unity, be careful when comparing objects for equality with other objects or with null. For types that inherit from UnityEngine.Object , Unity uses a custom version of the C# equality and inequality operators . This means the null check myGameObject == null can evaluate true (and conversely myGameObje...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_13c86823b217
unity_docs
math
Explain 'Introduction to Unity Properties' in Unity.
Unity Properties is a system that allows you to explore and modify the properties of C# types at runtime. It uses a visitor-style API that traverses the properties of an object graph in a predictable, controllable way. You can use Unity Properties to read from or write to C# types generically, with minimal type-specifi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6c2a6d44ebd2
unity_docs
editor
What is `Awaitable.FixedUpdateAsync` in Unity? Explain its purpose and usage.
Awaitable.FixedUpdateAsync Declaration public static Awaitable FixedUpdateAsync (CancellationToken cancellationToken ); Description Resumes execution on the next fixed update frame. Note: This method can only be called from the main thread and always completes on main thread. Also, in the Editor, this Await...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e175f9776e22
unity_docs
rendering
What is `Build.IPreprocessComputeShaders.OnProcessComputeShader` in Unity? Explain its purpose and usage.
IPreprocessComputeShaders.OnProcessComputeShader Declaration public void OnProcessComputeShader ( ComputeShader shader , string kernelName , IList<ShaderCompilerData> data ); Parameters Parameter Description shader The compute shader that Unity is about to compile. kernelName The name of the kernel that...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0c02474b96b9
unity_docs
editor
Explain 'PolySpatial Extensions' in Unity.
com.unity.polyspatial.extensions ## Description The PolySpatial Extensions package offers a range of additional features that may prove useful to some users enhancing the overall functionality of the PolySpatial package. Unity PolySpatial and visionOS support is only available to Unity Pro, Unity Enterprise, and Unit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b9ce863f6b7f
unity_docs
animation
What are the parameters of `HumanTrait.RequiredBone` in Unity?
Description Is the bone a member of the minimal set of bones that Mecanim requires for a human model? The indexing order of the bones is the same as that used for the BoneName array. ```csharp using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { void Start() { string[]...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_db17cb8edb1d
unity_docs
rendering
Show me a Unity C# example demonstrating `WebCamTexture.isPlaying`.
WebCamTexture.isPlaying public bool isPlaying ; Description Returns if the camera is currently playing. ```csharp using UnityEngine;public class Example : MonoBehaviour { // Tries to start the camera and outputs to the console if is was sucessful or not. void Start() { WebCamTexture webcamTexture = new WebC...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f36cec4e15aa
unity_docs
rendering
What is `Rendering.RayTracingShader.SetFloat` in Unity? Explain its purpose and usage.
RayTracingShader.SetFloat Declaration public void SetFloat (string name , float val ); Declaration public void SetFloat (int nameID , float val ); Parameters Parameter Description name The name of the property being set. nameID The ID of the property as given by Shader.PropertyToID. val The float ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b399df891cc6
unity_docs
scripting
What is `ContactFilter2D.IsFilteringLayerMask` in Unity? Explain its purpose and usage.
ContactFilter2D.IsFilteringLayerMask Declaration public bool IsFilteringLayerMask ( GameObject obj ); Parameters Parameter Description obj The GameObject used to check the GameObject.layer . Returns bool Returns true when obj is excluded by the filter and false if otherwise. Description Checks ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_92fc5e517cdc
unity_docs
math
What is `SerializedPropertyType.Generic` in Unity? Explain its purpose and usage.
SerializedPropertyType.Generic Description Represents an array, list, struct or class. The Generic type is used for compound types that are serialized in-line: - Arrays and lists. - Structs that are user defined (e.g. not a built in Unity type). - Classes that are serialized 'by value' (e.g. referenced wit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0d9f869b3fa7
unity_docs
scripting
What is `Unity.Android.Gradle.Manifest.Application` in Unity? Explain its purpose and usage.
Application class in Unity.Android.Gradle.Manifest / Inherits from: Unity.Android.Gradle.Manifest.BaseElement Description The C# definition of the <application> Android Manifest element. For more information about the element, see Android's documentation: Application element Properties Property Descript...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_07c2a39ecc64
unity_docs
animation
What is `Animations.PropertyStreamHandle.SetFloat` in Unity? Explain its purpose and usage.
PropertyStreamHandle.SetFloat Declaration public void SetFloat ( Animations.AnimationStream stream , float value ); Parameters Parameter Description stream The AnimationStream that holds the animated values. value The new float property value. Description Sets the float property value into a stream. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c5f3ffcbc341
unity_docs
rendering
What is `Rendering.RenderPipeline.ProcessRenderRequests` in Unity? Explain its purpose and usage.
RenderPipeline.ProcessRenderRequests Declaration protected void ProcessRenderRequests ( Rendering.ScriptableRenderContext context , Camera camera , RequestData renderRequest ); Parameters Parameter Description renderRequests The list of RenderRequests to execute. Description Executes RenderRequests...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_76ef1200f765
unity_docs
rendering
What is `Texture3D.SetPixelData` in Unity? Explain its purpose and usage.
Texture3D.SetPixelData Declaration public void SetPixelData (T[] data , int mipLevel , int sourceDataStartIndex = 0); Declaration public void SetPixelData (NativeArray<T> data , int mipLevel , int sourceDataStartIndex = 0); Parameters Parameter Description data The array of data to use. mipLevel...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5180dc68e8d1
unity_docs
rendering
What are the parameters of `LightTransport.InputExtraction.ComputeOcclusionLightIndicesFromBakeInput` in Unity?
Returns int[] Flattened array of light indices where each consecutive group of maxLightsPerProbe indices corresponds to one probe position. Description Determines the most influential lights for occlusion calculations at each probe position. This method analyzes the light sources in the scene and selects the most influ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_98b3b8bd5332
unity_docs
physics
What are the parameters of `PhysicsShapeGroup2D.AddPolygon` in Unity?
Returns int Returns the shape index the shape was added to in the PhysicsShapeGroup2D . This index is used as the main reference when retrieving a shape. Description Adds a polygon shape ( PhysicsShapeType2D.Polygon ) to the shape group. A polygon shape is comprised of multiple edges (line segments) defined by all the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_518fad369938
unity_docs
scripting
What is `AI.NavMeshBuildSettings.agentClimb` in Unity? Explain its purpose and usage.
NavMeshBuildSettings.agentClimb public float agentClimb ; Description The maximum vertical step size an agent can take. Must be less than agent height. This parameter is used to detect sharp discontinuities in the level (i.e. stairs, steps), and allow the agent to pass them.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c0bcdcc8ee84
unity_docs
scripting
What are the parameters of `Mesh.Clear` in Unity?
Description Clears all vertex data and all triangle indices. You should call this function before rebuilding triangles array. ```csharp // Convert any GameObject into a single triangleusing UnityEngine;public class meshClear : MonoBehaviour { private bool once = false; void Update() { if (Time.time >...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_863b7d5faccc
unity_docs
editor
What is `UIElements.AssetMonitoringUtilities.GetResetPanelRenderingOnAssetChange` in Unity? Explain its purpose and usage.
AssetMonitoringUtilities.GetResetPanelRenderingOnAssetChange Declaration public static bool GetResetPanelRenderingOnAssetChange ( EditorWindow window ); Description Gets the state that controls if the panel of the EditorWindow should reset its rendering data when an asset changes.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ca0a008bbe5a
unity_docs
scripting
What is `Presets.PresetType.GetManagedTypeName` in Unity? Explain its purpose and usage.
PresetType.GetManagedTypeName Declaration public string GetManagedTypeName (); Returns string Returns the full namespace and type of the target class. Description Retrieves a human readable namespace and the name of the target class, regardless of whether it's a managed C# class or a native C++ class.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_aad6fa8da2c4
unity_docs
scripting
Give me an overview of the `YieldInstruction` class in Unity.
YieldInstruction class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Base class for all yield instructions. See WaitForSeconds , WaitForFixedUpdate , Coroutine and MonoBehaviour.StartCoroutine for more information.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_a5889bb29b1c_doc_15
github
scripting
What does `Flip` do in this Unity script? Explain its purpose and signature.
Flips the brush in the given axis.Axis to flip by.Cell Layout for flipping. Signature: ```csharp public override void Flip(FlipAxis flip, Grid.CellLayout layout) ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_b0d1e9135961
unity_docs
ui
What is `UIElements.VisualElement.localBound` in Unity? Explain its purpose and usage.
VisualElement.localBound public Rect localBound ; Description Returns a Rect representing the Axis-aligned Bounding Box (AABB) after applying the transform, but before applying the layout translation.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_15efe15ed53c
unity_docs
rendering
What is `AssetPostprocessor.OnPostprocessTexture` in Unity? Explain its purpose and usage.
AssetPostprocessor.OnPostprocessTexture(Texture2D) Description Add this function to a subclass to get a notification when a texture2D has completed importing just before Unity compresses it. You can't choose a compression format at this point. If you want to change compression format based on filename or other att...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ab36cff33b07
unity_docs
math
What are the parameters of `HumanPoseHandler.ctor` in Unity?
Description Creates a human pose handler from an avatar and a root transform and either a list of joint paths. Specify an avatar and a root transform to create a human pose from the skeleton hierarchy (avatar). Specify an avatar and a list of joint paths to create a human pose handler that is not bound to a skeleton tr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8c07cbe8a4ec
unity_docs
rendering
What is `SpeedTreeImporter.enableHue` in Unity? Explain its purpose and usage.
SpeedTreeImporter.enableHue public bool[] enableHue ; Description Gets and sets an array of booleans to enable hue variation effect for each LOD. Because the hue variation effect comes with an increased performance cost, you may want to only enable it on the SpeedTree assets that are nearest to the player. You...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_39639674aff9
unity_docs
editor
Show me a Unity C# example demonstrating `iOS.Xcode.PBXProject.ProjectGuid`.
PBXProject.ProjectGuid Declaration public string ProjectGuid (); Returns string The GUID of the project. Description Returns the GUID of the project. The project GUID identifies a project-wide native target which is used to set project-wide properties. This GUID can be passed to any functions that accepts...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0ab94a4f75d8
unity_docs
rendering
What are the parameters of `Texture2D.GetPixels32` in Unity?
Returns Color32[] An array that contains the pixel colors. Description Gets the pixel color data for a mipmap level as Color32 structs. This method gets pixel data from the texture in CPU memory. Texture.isReadable must be true . The array contains the pixels row by row, starting at the bottom left of the texture. The ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ed33b29c3c2e
unity_docs
scripting
What is `Windows.Speech.DictationRecognizer.Start` in Unity? Explain its purpose and usage.
DictationRecognizer.Start Declaration public void Start (); Description Starts the dictation recognization session. Dictation recognizer can only be started if PhraseRecognitionSystem is not running. DictationRecognizer requires that dictation is permitted in the user's Speech privacy policy (Settings->Privacy-...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_737a553bf32f
unity_docs
rendering
Give me an overview of the `LightShadowCasterMode` class in Unity.
LightShadowCasterMode enumeration Description Allows mixed lights to control shadow caster culling when Shadowmasks are present. Properties Property Description Default Use the global Shadowmask Mode from the quality settings. NonLightmappedOnly Render only non-lightmapped objects into the shadow map. This cor...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_71cc0fd884ce
unity_docs
editor
What is `AssetBundleBuild` in Unity? Explain its purpose and usage.
AssetBundleBuild struct in UnityEditor Description AssetBundle building map entry. This structure is used with BuildPipeline.BuildAssetBundles to specify the name of a bundle and the names of the assets that it will contain. The array of AssetBundleBuild elements that is passed to the function is known as the "...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_635ad947487d
unity_docs
physics
Show me a Unity C# example demonstrating `OverlapBoxCommand`.
lt array size accordingly to store all hits. Use  QueryParameters  to control hit flags. QueryParameters.hitBackfaces and QueryParameters.hitMultipleFaces flags are not supported and won’t have any impact on overlap results. Note: Only BatchQuery.ExecuteOverlapBoxJob is logged into the profiler. Query count informa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0d71c1ec0f2d
unity_docs
math
What is `Rendering.RayTracingAABBsInstanceConfig.mask` in Unity? Explain its purpose and usage.
RayTracingAABBsInstanceConfig.mask public uint mask ; Description The ray tracing instance mask. During acceleration structure traversal, the GPU accepts or rejects geometry based on the instance mask and InstanceInclusionMask specified when you call the TraceRay HLSL function, or when you execute ray queries...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_047364e5c68d
unity_docs
math
What are the parameters of `Mathf.SmoothDamp` in Unity?
Returns float The current value after moving one step towards the target value. Description Gradually moves the current value towards a target value, over a specified time and at a specified velocity. This method smoothes the current value towards a target value with a spring-damper like algorithm. This algorithm is ba...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a2ca0d117ca3
unity_docs
rendering
What are the parameters of `MonoBehaviour.OnRenderImage` in Unity?
Description Event function that Unity calls after a Camera has finished rendering, that allows you to modify the Camera's final image. In the Built-in Render Pipeline, Unity calls OnRenderImage on MonoBehaviours that are attached to the same GameObject as an enabled Camera component, after the Camera finished rendering...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d223ad0da216
unity_docs
scripting
What is `Search.SearchResult.ctor` in Unity? Explain its purpose and usage.
SearchResult Constructor Declaration public SearchResult (string id , int index , int score ); Declaration public SearchResult (int index ); Declaration public SearchResult (int index , int score ); Parameters Parameter Description id ID of the document containing the result. index Index of th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9976d67e223a
unity_docs
rendering
What is `Experimental.Lightmapping.GetCustomBakeResults` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Lightmapping.GetCustomBakeResults Declaration public static bool GetCustomBakeResults (out Vector4[] results ); Parameters Parameter Description results The unnormalized amount of sky visibility for the input points (in x...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_55ac909617b3
unity_docs
physics
What is `Physics2D.OverlapBoxAll` in Unity? Explain its purpose and usage.
Physics2D.OverlapBoxAll Declaration public static Collider2D[] OverlapBoxAll ( Vector2 point , Vector2 size , float angle , int layerMask = DefaultRaycastLayers, float minDepth = -Mathf.Infinity, float maxDepth = Mathf.Infinity); Parameters Parameter Description point The center of the box. size ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_746eed25577c
unity_docs
scripting
Show me a Unity code example for 'Label'.
A Label is a text element that you can use to display text. You can use a Label to display a title or a description for a control. ## Create a Label You can create a Label with UI Builder, UXML, or C#. The following C# example creates a Label with the text “Hello World” and sets the font size, font style, text alignm...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4aed5b0c39e2
unity_docs
scripting
Explain 'Search files and presets' in Unity.
The Files and Presets search providers run implicitly as part of the Project and Asset Database search providers, but you can also run them as their own providers. Provider Description Search for files Finds files in the Assets folder. Search for presets Finds presets in the project.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_33fdba5c0360
unity_docs
rendering
Show me a Unity code example for 'Calculate the size of the frustum at a distance'.
ulate the size of this rectangle at a given distance, or find the distance where the rectangle is a given size. For example, if a moving camera needs to keep an object (such as the player) completely in shot at all times then it must not get so close that part of that object is cut off. The height of the frustum at a g...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7a9e9a2a81ff
unity_docs
input
Show me a Unity C# example demonstrating `Input.GetMouseButtonUp`.
that you don't use this API in new projects. For new projects, use the Input System package. To learn more about input, refer to Input . Call this function from the Update function, since the state gets reset each frame. It will not return true until the user has pressed the mouse button and released it again. butt...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_613bb26990df
unity_docs
physics
What is `LazyLoadReference_1.operator_T` in Unity? Explain its purpose and usage.
LazyLoadReference<T0>.LazyLoadReference<T> Parameters Parameter Description asset The asset reference. Description Implicit conversion from asset reference to LazyLoadReference. Note that this may trigger loading the referenced object into memory if the object is not already loaded.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_af5e9e0557df
unity_docs
editor
What is `Unity.CodeEditor.CodeEditor.GetFoundScriptEditorPaths` in Unity? Explain its purpose and usage.
CodeEditor.GetFoundScriptEditorPaths Declaration public Dictionary<string,string> GetFoundScriptEditorPaths (); Returns Dictionary<string,string> A Dictionary that maps names to editor paths. Description Collects all installations from registered instances of IExternalCodeEditor . This is done using IExt...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9977bd0a2231
unity_docs
editor
Show me a Unity C# example demonstrating `MouseCursor.ArrowMinus`.
MouseCursor.ArrowMinus Description Arrow with the minus symbol next to it. ```csharp //Create a folder and name it “Editor” if this doesn’t already exist //Put this script in the folder//This script creates a new menu (“Examples”) and a menu item (“Mouse Cursor”). Click on this option. This displays a small window ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ffaf0a1ebd8e
unity_docs
physics
Show me a Unity code example for 'Link XML formatting reference'.
tadata assembly . For example usages of all these attributes, refer to Usage examples . ## Usage examples The following examples demonstrate valid usage of the supported XML elements and attributes. ## Different ways to declare the root types of an assembly The following examples illustrate the different ways that ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_780bfb7dd45b
unity_docs
scripting
Show me a Unity C# example demonstrating `UIElements.VisualElement.resolvedStyle`.
eUpdate phase at runtime if you have access to MonoBehaviours. For a list of all the style properties supported by UI Toolkit, refer to USS properties reference . For more information about how to use this property and an example of how style changes when layout updates, refer to Apply styles in C# scripts...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a3de8ae46c5c
unity_docs
rendering
Explain 'Text-based scene files' in Unity.
Unity provides a text-based format for scene data, in addition to the default binary format. This can be useful when working with version control software, because text files generated separately can be merged more easily than binary files. Also, the text data can be generated and parsed by tools, making it possible to...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_664d8940e9f9
unity_docs
editor
What are the parameters of `AssetDatabase.IsForeignAsset` in Unity?
Returns bool Returns true if the asset is a foreign asset, and false otherwise. Description Determines whether a given asset is an external asset, also known as a foreign asset. A foreign asset is any asset that isn't created within Unity, for example a .png texture file. An asset created in Unity is a Native asset imp...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b610a19343c7
unity_docs
editor
What is `PrefabUnpackMode.OutermostRoot` in Unity? Explain its purpose and usage.
PrefabUnpackMode.OutermostRoot Description Use this mode to only unpack the outermost layer of a Prefab. A Regular Prefab instance will turn into regular GameObject and any nesting will turn into new Prefab instances. A Variant Prefab will turn into its base Prefab. A Model Prefab will turn into regular GameObjects...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c83ff0290e45
unity_docs
rendering
What is `LightProbeProxyVolume.probePositionMode` in Unity? Explain its purpose and usage.
LightProbeProxyVolume.probePositionMode public LightProbeProxyVolume.ProbePositionMode probePositionMode ; Description The mode in which the interpolated Light Probe positions are generated.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_645b5debdb64
unity_docs
physics
What are the parameters of `Collider2D.OnCollisionStay2D` in Unity?
Description Sent each frame where a collider on another object is touching this object's collider (2D physics only). Further information about the objects involved is reported in the Collision2D parameter passed during the call. If you don't need this information then you can declare OnCollisionStay2D without the param...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a07eaca70902
unity_docs
scripting
What is `Vector4.Min` in Unity? Explain its purpose and usage.
Vector4.Min Declaration public static Vector4 Min ( Vector4 lhs , Vector4 rhs ); Description Returns a vector that is made from the smallest components of two vectors. Additional resources: Max function. ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() { Vector4 a = n...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9879e5347252
unity_docs
input
What is `Experimental.GraphView.SelectionDropper.OnMouseMove` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. SelectionDropper.OnMouseMove Declaration protected void OnMouseMove ( UIElements.MouseMoveEvent e ); Parameters Parameter Description e The event. Description Called on mouse move event.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c2fa6e602d52
unity_docs
ui
Explain 'Set Height' in Unity.
Use the Set Height tool to adjust the height of an area on the Terrain to a specific value. To access the tool, click on the Paint Terrain icon, and select the Set Height tool from the drop-down menu. To access the Set Height tool from an overlay: In the Terrain Tools overlay, select Sculpt Mode . Sculpt Mode tools dis...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d44164f14b85
unity_docs
animation
In Unity's 'Mecanim FAQ', what is 'General questions' and how does it work?
What’s the difference between the Animation window and the Animator window ? Use the Animation Window to create and edit animation clips within Unity. You can use it to animate almost every property that you can edit in the inspector , from a Game Object’s position, a material color, a light’s brightness, a sound’s vol...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0b9bbac571d3
unity_docs
math
What is `Embree.GpuBvhBuildOptions.allowPrimitiveSplits` in Unity? Explain its purpose and usage.
GpuBvhBuildOptions.allowPrimitiveSplits public bool allowPrimitiveSplits ; Description With this option enabled, Unity performs spatial splits. This increases the memory footprint, but the resulting BVH makes the ray tracing stage faster.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_75318a4d215f
unity_docs
editor
What is `MouseCursor.Zoom` in Unity? Explain its purpose and usage.
MouseCursor.Zoom Description Cursor with a magnifying glass for zoom. ```csharp //Create a folder and name it “Editor” if this doesn’t already exist //Put this script in the folder//This script creates a new menu (“Examples”) and a menu item (“Mouse Cursor”). Click on this option. This displays a small window that ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b0b482ab9982
unity_docs
scripting
What is `Windows.WebCam.PhotoCapture.OnCapturedToDiskCallback` in Unity? Explain its purpose and usage.
PhotoCapture.OnCapturedToDiskCallback Declaration public delegate void OnCapturedToDiskCallback ( Windows.WebCam.PhotoCapture.PhotoCaptureResult result ); Parameters Parameter Description result Indicates whether or not the photo was successfully saved to the file system. Description Called when a photo h...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2cb737354829
unity_docs
rendering
What is `Experimental.GlobalIllumination.LightType.SpotPyramidShape` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. LightType.SpotPyramidShape Description A pyramid-shaped spot light. This type is only compatible with Scriptable Render Pipelines; it is not compatible with the built-in render pipeline.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7b8c24f39c83
unity_docs
rendering
What is `RenderTextureFormat.RGB111110Float` in Unity? Explain its purpose and usage.
RenderTextureFormat.RGB111110Float Description Color render texture format. R and G channels are 11 bit floating point, B channel is 10 bit floating point. Note that not all graphics cards support this format. Use SystemInfo.SupportsRenderTextureFormat to check for support. Additional resources: RenderTexture c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a90b9ff15899
unity_docs
rendering
Explain 'Introduction to surface shaders in the Built-In Render Pipeline' in Unity.
Writing shaders that interact with lighting is complex. There are different light types, different shadow options, different rendering paths (forward and deferred rendering), and the shader should somehow handle all that complexity. Surface Shaders is a code generation approach that makes it much easier to write lit sh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_982c85173185_doc_5
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Called if the player pinched the screen. The arguments are the distance between the fingers before and after. Signature: ```csharp public event Action<float, float> onPinch; ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_691e92282151
unity_docs
audio
What is `AudioCurveRendering.AudioCurveAndColorEvaluator` in Unity? Explain its purpose and usage.
AudioCurveRendering.AudioCurveAndColorEvaluator Declaration public delegate float AudioCurveAndColorEvaluator (float x , out Color col ); Parameters Parameter Description x Normalized x-position in the range [0; 1] at which the curve should be evaluated. col Color of the curve at the evaluated point. D...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e8f1d0c2d26c
unity_docs
rendering
What is `Rendering.CullingOptions` in Unity? Explain its purpose and usage.
CullingOptions enumeration Description Flags used by ScriptableCullingParameters.cullingOptions to configure a culling operation. Unity sets some of the CullingOptions flags with default values, and others depending on the properties of the Camera from which you obtained the ScriptableCullingParameters str...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_853ecfbb7788
unity_docs
scripting
What is `PlayModeWindow.SetPlayModeFocused` in Unity? Explain its purpose and usage.
PlayModeWindow.SetPlayModeFocused Declaration public static void SetPlayModeFocused (bool focused ); Parameters Parameter Description focused If true, sets the view to Focused, otherwise to maximized. Description Changes the enter play mode behavior of the selected PlayModeView window.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3b83b0e3f637
unity_docs
input
What is `UIElements.MouseCaptureEventBase_1.relatedTarget` in Unity? Explain its purpose and usage.
MouseCaptureEventBase<T0>.relatedTarget public UIElements.IEventHandler relatedTarget ; Description In the case of a MouseCaptureEvent, this property is the IEventHandler that loses the capture. In the case of a MouseCaptureOutEvent, this property is the IEventHandler that gains the capture.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_14593328d1e4
unity_docs
rendering
What is `Rendering.RayTracingShader.SetAccelerationStructure` in Unity? Explain its purpose and usage.
RayTracingShader.SetAccelerationStructure Declaration public void SetAccelerationStructure (int nameID , Rendering.RayTracingAccelerationStructure accelerationStructure ); Declaration public void SetAccelerationStructure (string name , Rendering.RayTracingAccelerationStructure accelerationStructure ); ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_39ee1831dac2
unity_docs
rendering
What is `ModelImporterMaterialName` in Unity? Explain its purpose and usage.
ModelImporterMaterialName enumeration Description Material naming options for ModelImporter . Additional resources: ModelImporter.materialName . Properties Property Description BasedOnTextureName Use material names in the form <textureName>.mat. BasedOnMaterialName Use a material name of the form <materialN...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8893d801146a
unity_docs
rendering
Show me a Unity code example for 'Tab'.
rmation on how to reference an image asset, refer to Assets . Do one of the following to add an icon to a Tab with UI Builder: From the Tab’s Inspector panel, select an icon from the Icon Image dropdown list. Drag an icon from the Assets window to the Icon Image field located in the Tab’s Inspector panel. To add an ico...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8c511a652f14
unity_docs
scripting
What is `PlayerSettings.Android.keyaliasName` in Unity? Explain its purpose and usage.
PlayerSettings.Android.keyaliasName public static string keyaliasName ; Description Android key alias name. It helps identify a specific key stored in a keystore file used for signing an Android application. For a detailed code example, refer to the useCustomKeystore API documentation.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_84fd75fa686d
unity_docs
animation
Explain 'How Root Motion works' in Unity.
## Body Transform The Body Transform is the mass center of the character. It is used in Mecanim’s retargeting engine and provides the most stable displacement model. The Body Orientation is an average of the lower and upper body orientation relative to the Avatar T-Pose . The Body Transform and Orientation are stored ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0c8f65540a20
unity_docs
editor
Show me a Unity C# example demonstrating `EditorGUILayout.BeginScrollView`.
left out, the verticalScrollbar style from the current GUISkin is used. Returns Vector2 The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. Description Begin an automatically laid out scrollview. These work just like GUILayout.BeginScrollView but feel more ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6f493a34db97
unity_docs
scripting
In Unity's 'LayerMaskField', what is 'Example' and how does it work?
The following UXML example creates a LayerMaskField: ``` <UXML xmlns="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements"> <uie:LayerMaskField label="UXML Field" name="the-uxml-field" /> </UXML> ``` The following C# example illustrates some of the customizable functionalities of the LayerMaskField: ``` /// <sam...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_702105371487
github
scripting
Write a Unity C# script called Text Area
```csharp using System.Collections.Generic; using shadcnui.GUIComponents.Core.Base; using shadcnui.GUIComponents.Core.Styling; using shadcnui.GUIComponents.Core.Utils; using UnityEngine; #if IL2CPP_MELONLOADER_PRE57 using UnhollowerBaseLib; #endif namespace shadcnui.GUIComponents.Data { public class TextArea : Bas...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
gh_70767284d394_doc_1
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Wrap Unity implementation for convenience Signature: ```csharp private Unity.Services.CloudSave.ICloudSaveService UnityCloudSaveService ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
gh_efeab6c8927a
github
scripting
Write a Unity C# MonoBehaviour script called Title Process Installer
```csharp using UnityEngine; using VContainer; namespace AntiMonoBehaviour.Processes.Installers { [CreateAssetMenu(fileName = "TitleProcessInstaller", menuName = "AntiMonoBehaviour/TitleProcessInstaller", order = 1)] public class TitleProcessInstaller : ProcessInstallerBase<TitleProcess>, ITitleProces...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_029378c5059b
unity_docs
scripting
What is `UIElements.UxmlAssetAttributeDescription_1.GetValueFromBag` in Unity? Explain its purpose and usage.
UxmlAssetAttributeDescription<T0>.GetValueFromBag Declaration public T GetValueFromBag ( UIElements.IUxmlAttributes bag , UIElements.CreationContext cc ); Parameters Parameter Description bag The bag of attributes. cc The context in which the values are retrieved. Returns T The value of the attribu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dd329a8dfbc3
unity_docs
ui
Show me a Unity C# example demonstrating `UIElements.MeshWriteData.SetAllVertices`.
array of vertices to copy from. The length of the array must match the allocated vertex count. Description Fills the values of the allocated vertices with values copied directly from an array. When this method is called, it is not possible to use SetNextVertex to fill the allocated vertices array. When this met...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_50b60c3b4090
unity_docs
audio
Explain 'Specifics on the Audio Mixer window' in Unity.
## Mixers panel The Mixers panel displays a complete list of all Audio Mixers in the project. Select the Audio Mixers in the Mixers panel to quickly switch between them. You can also route one Audio Mixer into the AudioGroup of another Audio Mixer from this panel. Select + in the top right of the panel to create a new...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_c24ffea30041
github
scripting
Write a Unity C# MonoBehaviour script called Event Listener
```csharp using System; using System.Diagnostics; using UnityEngine; using Object = UnityEngine.Object; namespace Sisus { /// <summary> /// Helper class for checking whether the value of a variable that is of <see cref="object"/>, interface or generic /// type is <see langword="null"/>, <see cref="Object.Destroy">...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_73b84ea3be07
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormat.R10G10B10_XRUNormPack32` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormat.R10G10B10_XRUNormPack32 Description A four-component, 32-bit packed unsigned normalized format that has a 10-bit R component in bits 20..29, a 10-bit G component in bits 10..19, and a 10-bit B component in bits 0.....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_26657d11ba5d
unity_docs
xr
What is `Cubemap.ClearRequestedMipmapLevel` in Unity? Explain its purpose and usage.
Cubemap.ClearRequestedMipmapLevel Declaration public void ClearRequestedMipmapLevel (); Description Resets the requestedMipmapLevel field. Resetting the requestedMipmapLevel allows the mipmap streaming system to start choosing which mipmap should be loaded based on the position of cameras.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.