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_9d5479cdddda
unity_docs
physics
What are the parameters of `EditorGUI.Popup` in Unity?
Returns int The index of the option that has been selected by the user. Description Makes a generic popup selection field. Takes the currently selected index as a parameter and returns the index selected by the user. Popup in and Editor Window. ```csharp using UnityEngine; using UnityEditor; // Adds a component to the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c988fa1a3a43
unity_docs
ui
Explain 'Develop a native DSP audio plug-in' in Unity.
You can use the native Digital Signal Processing (DSP) plug-in to process audio and expose parameters for a user to experiment with audio effects . The example plug-ins that Unity provides are a good place to experiment with plug-ins and to get ideas about parameters you need. To develop a native audio plug-in for Unit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b6a1e03ac1fb
unity_docs
scripting
Give me an overview of the `D3D11FullscreenMode` class in Unity.
D3D11FullscreenMode enumeration Description Direct3D 11 fullscreen mode. This defines how fullscreen mode is handled in Windows standalone builds when using Direct3D 11. Properties Property Description ExclusiveMode Exclusive mode. FullscreenWindow Fullscreen window.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a8d2b205bcc2
unity_docs
scripting
What are the parameters of `VersionControl.Provider.Add` in Unity?
Description Allows you to add files to version control via script. If you have selected a version control integration in Unity's project settings panel, the default setting is for new files to be automatically added to version control . However, you can disable the "Automatic add" option to prevent this. This method is...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_6910d9d9a9ea_doc_15
github
scripting
What does `OnMouseEnterAsObservable` do in this Unity script? Explain its purpose and signature.
OnMouseEnter is called when the mouse entered the GUIElement or Collider. Signature: ```csharp public static IObservable<Unit> OnMouseEnterAsObservable(this Component component) ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_1ffb7d7c6d03
unity_docs
ui
What is `GUIStyle.clipping` in Unity? Explain its purpose and usage.
GUIStyle.clipping public TextClipping clipping ; Description What to do when the contents to be rendered is too large to fit within the area given. ```csharp using UnityEngine;public class Example : MonoBehaviour { // Prints how is managed the text when the contents rendered // are too large to fir in the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e93c22068661
unity_docs
scripting
Show me a Unity C# example demonstrating `AnimatorOverrideController.ctor`.
AnimatorOverrideController ( RuntimeAnimatorController controller ); Parameters Parameter Description controller Runtime Animator Controller to override. Description Creates an Animator Override Controller that overrides controller . Although the Animator Override Controller doesn't support nested Animator...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_3f184f81a289
unity_docs
rendering
Show me a Unity code example for 'Disable writing to the depth buffer in a shader'.
ZWrite sets whether the depth buffer contents are updated during rendering. Normally, ZWrite is enabled for opaque objects and disabled for semi-transparent ones. Disabling ZWrite can lead to incorrect depth ordering. In this case, you need to sort geometry on the CPU. ## Examples This example code demonstrates the s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3bbaf1ff8108
unity_docs
scripting
What is `AnimationEvent.animationState` in Unity? Explain its purpose and usage.
AnimationEvent.animationState public AnimationState animationState ; Description The animation state that fired this event (Read Only). Returns null when the method is called outside of an animation event callback. Note: This member will only be set when called from an Animation component(legacy). Additional ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e9370f88d8f9
unity_docs
physics
What is `Physics.OverlapBox` in Unity? Explain its purpose and usage.
Physics.OverlapBox Declaration public static Collider[] OverlapBox ( Vector3 center , Vector3 halfExtents , Quaternion orientation = Quaternion.identity, int layerMask = AllLayers, QueryTriggerInteraction queryTriggerInteraction = QueryTriggerInteraction.UseGlobal); Parameters Parameter Descripti...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_b9740d8ff2b8
github
scripting
Write a Unity Editor script for Debug Menu Settings Provider
```csharp using System.Collections.Generic; using System.Reflection; using UnityEditor; using UnityEngine; namespace DebugMenu { public class DebugMenuSettingsProvider : Editor { private const string Name = "Debug Menu"; [SettingsProvider] public static SettingsProvider GetDebugMenuSe...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_7053982f6970
unity_docs
scripting
What is `TerrainTools.TerrainToolShortcutContext.SelectPaintToolWithOverlays` in Unity? Explain its purpose and usage.
TerrainToolShortcutContext.SelectPaintToolWithOverlays Declaration public void SelectPaintToolWithOverlays (); Description Changes the selected Terrain paint tool if that paint tool is a TerrainPaintToolWithOverlays. Selects the Terrain paint tool with overlays implemented by type T.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_80bb8499f3fc
unity_docs
rendering
What is `RendererExtensions` in Unity? Explain its purpose and usage.
RendererExtensions class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Extension methods to the Renderer class, used only for the UpdateGIMaterials method used by the Global Illumination System. Static Methods Method Description UpdateGIMaterials Schedules an update of the albedo and em...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_97220fbdcfe5
unity_docs
ui
Show me a Unity C# example demonstrating `GUISkin.horizontalScrollbarRightButton`.
GUISkin.horizontalScrollbarRightButton public GUIStyle horizontalScrollbarRightButton ; Description Style used by default for the right button on GUI.HorizontalScrollbar controls. ```csharp using UnityEngine;public class Example : MonoBehaviour { // Modifies only the horizontal scrollbar // left button o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1791e0205644
unity_docs
scripting
Show me a Unity C# example demonstrating `Tilemaps.TileBase.StartUp`.
rameter Description position Position of the Tile on the Tilemap . tilemap The Tilemap the tile is present on. go The GameObject instantiated for the Tile. Returns bool Whether the call was successful. Description StartUp is called on the first frame of the running Scene. Use this to set values for...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b035351e2f11
unity_docs
ui
What is `RangeAttribute.ctor` in Unity? Explain its purpose and usage.
RangeAttribute Constructor Declaration public RangeAttribute (float min , float max ); Parameters Parameter Description min The minimum allowed value. max The maximum allowed value. Description Attribute used to make a float or int variable in a script be restricted to a specific range. When this attri...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_44e8fd45009c
unity_docs
scripting
In Unity's 'Custom package legal requirements', what is 'Third Party Notices' and how does it work?
If your package has third-party elements, you can include the licenses in a Third Party Notices.md file. You can include a Component Name , License Type , Version Number , and Provide License Details section for each license you want to include. For example: ``` This package contains third-party software components gov...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b16cfdb58b9e
unity_docs
scripting
What is `UIElements.PointerManipulator.CanStartManipulation` in Unity? Explain its purpose and usage.
PointerManipulator.CanStartManipulation Declaration protected bool CanStartManipulation ( UIElements.IPointerEvent e ); Parameters Parameter Description e The PointerEvent to validate. Returns bool True if the event satisfies the requirements. False otherwise. Description Checks whether PointerEven...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2c8dd98daba7
unity_docs
editor
Show me a Unity C# example demonstrating `MouseCursor.ScaleArrow`.
MouseCursor.ScaleArrow Description Arrow with the scale symbol next to it for the sceneview. ```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 displa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_39b662609422
github
scripting
Write a Unity C# script called Face User Constraint
```csharp // Copyright (c) Mixed Reality Toolkit Contributors // Licensed under the BSD 3-Clause using UnityEngine; namespace MixedReality.Toolkit.SpatialManipulation { /// <summary> /// Component for fixing the rotation of a manipulated object such that /// it always faces or faces away from the user. ...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_man_df6b553a2ede
unity_docs
networking
In Unity's 'Mirror multiple Unity Accelerator instances', what is 'Mirror example' and how does it work?
In the following example, server A has an ip:port of 1.1.1.1:1111 and server B is 2.2.2.2:2222 . Both have no data to start with, so the following puts an item into A and notes that it’s not in B: ``` $ echo test1 | unity-accelerator cache put 1.1.1.1:1111 namespace1 key1 $ unity-accelerator cache get 1.1.1.1:1111 name...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8951b48647e8
unity_docs
editor
What are the parameters of `TypeCache.GetMethodsWithAttribute` in Unity?
Returns MethodCollection Returns an unordered MethodInfo collection of methods marked with the T attribute. If assemblyName is specified, returns only methods defined in this assembly. Description Retrieves an unordered collection of methods marked with the T attribute. This method provides fast access to all methods l...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_771d4aeab75a
unity_docs
rendering
In Unity's 'Shader compilation', what is 'The Caching Shader Preprocessor' and how does it work?
Shader compilation involves several steps. One of the first steps is preprocessing. During this step, a program called a preprocessor prepares the shader source code for the compiler. In previous versions of Unity, the Editor used the preprocessor provided by the shader compiler for the current platform. Now, Unity use...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_518a4e7e9138
unity_docs
scripting
Show me a Unity C# example demonstrating `AssetPostprocessor.OnPostprocessModel`.
d before it is written to disk, thus you have full control over the generated game objects and components. Any references to game objects or meshes will become invalid after the import has been completed. Thus it is not possible to create a new Prefab in a different file from OnPostprocessModel that references meshes ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7b66cdf450c3
unity_docs
rendering
Explain 'Ambient light shader example in the Built-In Render Pipeline' in Unity.
The example above does not take any ambient lighting or light probes into account. Let’s fix this! It turns out we can do this by adding just a single line of code. Both ambient and light probe data is passed to shaders in Spherical Harmonics form, and ShadeSH9 function from UnityCG.cginc include file does all the work...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_230b54792fb5
unity_docs
editor
What is `AI.NavMeshBuildDebugFlags.SimplifiedContours` in Unity? Explain its purpose and usage.
NavMeshBuildDebugFlags.SimplifiedContours Description Contours bounding each of the surface regions, described through fewer vertices and straighter edges compared to RawContours . Additional resources: NavMeshBuildSettings.debug , NavMeshEditorHelpers.DrawBuildDebug .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4e1ae0bd05f4
unity_docs
scripting
What is `ModelImporter.isUseFileUnitsSupported` in Unity? Explain its purpose and usage.
ModelImporter.isUseFileUnitsSupported public bool isUseFileUnitsSupported ; Description Is useFileUnits supported for this asset. UseFileUnits is supported only on .max files. Additional resources: useFileUnits .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a1bb04a090c5
unity_docs
math
Show me a Unity C# example demonstrating `Handles.ScaleSlider`.
ion Make a directional scale slider. This method will draw a 3D-draggable handle on the screen that looks like one axis on Unity's built-in scale tool. The handle will stretch and will scale a single float up and down. Scale slider handle in the Scene View. Add the following script to your Assets folder as ScaleSlid...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a829a1c2f09b
unity_docs
scripting
Give me an overview of the `WebGLExceptionSupport` class in Unity.
WebGLExceptionSupport enumeration Description Options for Exception support in WebGL. Properties Property Description None Disable exception support. ExplicitlyThrownExceptionsOnly Enable throw support. FullWithoutStacktrace Enable exception support for all exceptions, without stack trace information. FullWi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a9d88c67c47b
unity_docs
physics
What is `ColliderDistance2D.pointB` in Unity? Explain its purpose and usage.
ColliderDistance2D.pointB public Vector2 pointB ; Description A point on a Collider2D that is a specific distance away from pointA . This point lies on the exterior surface of a Collider2D .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2ab2ce2ce79d
unity_docs
rendering
What is `Camera.RemoveCommandBuffers` in Unity? Explain its purpose and usage.
Camera.RemoveCommandBuffers Declaration public void RemoveCommandBuffers ( Rendering.CameraEvent evt ); Parameters Parameter Description evt When to execute the command buffer during rendering. Description Remove command buffers from execution at a specified place. This function removes all command buff...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_edcf10aa816f
unity_docs
scripting
What is `UIElements.ConverterGroups` in Unity? Explain its purpose and usage.
ConverterGroups class in UnityEngine.UIElements / Implemented in: UnityEngine.UIElementsModule Description Provides a set of static methods to register and use converter groups and registers a set of global converters. ConverterGroup . DataBinding . Static Methods Method Description RegisterConverterG...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_34ff228578aa
unity_docs
physics
What is `UIElements.BaseTreeView.SetRootItems` in Unity? Explain its purpose and usage.
BaseTreeView.SetRootItems Declaration public void SetRootItems (IList<TreeViewItemData<T>> rootItems ); Parameters Parameter Description rootItems The TreeView root items. Description Sets the root items to use with the default tree view controller. Root items can include their children directly. Thi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_97aea41e272f
unity_docs
scripting
Show me a Unity C# example demonstrating `SystemInfo.processorCount`.
). Returns the number of "logical processors" (threads) as reported by the operating system. This is distinct from the number of physical cores. On CPUs with Hyper-Threading or simultaneous multithreading (SMT), a single physical core is split into two logical cores. For example, a CPU with 4 physical cores and 8 thr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6041b2f345ef
unity_docs
math
What is `AI.NavMeshBuildSource.size` in Unity? Explain its purpose and usage.
NavMeshBuildSource.size public Vector3 size ; Description Describes the dimensions of the shape. Used only for the primitive shapes: Sphere, Capsule, Box. • Sphere: size is the dimensions of a box enclosing the sphere (i.e., x, y, and z are all equal to the diameter). • Box: size is the dimensions of the box....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fb64d1ae0601
unity_docs
math
What are the parameters of `Mesh.SetTangents` in Unity?
Description Set the tangents of the Mesh. Additional resources: tangents property. Declaration public void SetTangents (Vector4[] inTangents , int start , int length , Rendering.MeshUpdateFlags flags = MeshUpdateFlags.Default); Declaration public void SetTangents (List<Vector4> inTangents , int start , int length , Ren...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b587347aa29c
unity_docs
editor
What is `PlayerSettings.WSA.GetCapability` in Unity? Explain its purpose and usage.
PlayerSettings.WSA.GetCapability Declaration public static bool GetCapability ( PlayerSettings.WSACapability capability ); Parameters Parameter Description capability UWP Capability type to check. Returns bool Returns true if your project sets the specified capability. Otherwise, returns false. Des...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_27be2811d090
unity_docs
physics
Show me a Unity C# example demonstrating `GameObject.CompareTag`.
ject.CompareTag Declaration public bool CompareTag (string tag ); Parameters Parameter Description tag The tag to check for on the GameObject. Returns bool true if the GameObject has the given tag, false otherwise. Description Checks if the specified tag is attached to the GameObject. The example...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f7bcddf694d0
unity_docs
math
In Unity's 'Create a property visitor with low-level APIs', what is 'Get the properties' and how does it work?
To call the Accept method on the property using this , implement the IPropertyVisitor interface. This interface allows you to specify the visitation behavior when visiting a property, similar to the PropertyVisitorVisitProperty method: In the LowLevelVisitor class, override the IPropertyBagVisitor.Visit and IPropertyVi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_aaa738365592
unity_docs
editor
Explain 'Install Unity' in Unity.
The Hub is the primary way to install the Unity Editor, create projects, and manage your Unity experience. It provides a central location to manage your Editor installations, accounts, licenses, and projects. For information on installing Unity using Hub, refer to Install and uninstall Editor versions . Apart from usin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f2180dbc22af
unity_docs
scripting
In Unity's 'Troubleshooting on iOS devices', what is 'Xcode console shows WARNING -> applicationDidReceiveMemoryWarning() and then the application crashes' and how does it work?
You might encounter a warning message like Program received signal: "0" . This warning message is often not fatal, and indicates that iOS is low on memory. Typically, background processes like Mail will free some memory and your application can continue to run. However, if your application continues to use memory or as...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bb0541aac3f6
unity_docs
physics
Give me an overview of the `PhysicsSceneExtensions2D` class in Unity.
PhysicsSceneExtensions2D class in UnityEngine / Implemented in: UnityEngine.Physics2DModule Description Scene extensions to access the underlying physics scene. Static Methods Method Description GetPhysicsScene2D An extension method that returns the 2D physics Scene from the Scene.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6ca6dd58757d
unity_docs
rendering
What is `LightProbeProxyVolume.originCustom` in Unity? Explain its purpose and usage.
LightProbeProxyVolume.originCustom public Vector3 originCustom ; Description The local-space origin of the bounding box in which the 3D grid of interpolated Light Probes is generated. This is used when the boundingBoxMode property is set to Custom .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cd152ebe170b
unity_docs
performance
What is `Unity.Profiling.ProfilerMarker.Begin` in Unity? Explain its purpose and usage.
ProfilerMarker.Begin Declaration public void Begin (); Declaration public void Begin ( Object contextUnityObject ); Parameters Parameter Description contextUnityObject Object associated with the operation. Description Begin profiling a piece of code marked with a custom name defined by this instance o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8576acc0f674
unity_docs
animation
In Unity's 'Animation States', what is 'Any State' and how does it work?
Use Any State to add a transition from any state to a specific state. Any State is a special state that represents all states. Adding a transition from Any State is an efficient way of adding the same transition from all states. For example, your game has a timer and you want to transition to a time expired animation w...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5ad8bf4e63ee
unity_docs
scripting
In Unity's 'Bind a custom control to custom data type', what is 'Create a custom data type' and how does it work?
Create a custom data type Temperature , and use it as a serialized property. Create a Unity project with any template. Create a folder named bind-custom-data-type to store all the files. Create a C# script named Temperature.cs and replace its contents with the following: ```csharp using System; namespace UIToolkitExam...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_37f3c3680873
github
scripting
Write a Unity Editor script for Debug Log Utils
```csharp using Esprima; using Esprima.Ast; using UnityEngine; namespace Baxter.Internal.ClusterScriptExtensions.Editor { public static class DebugLogUtils { public static void LogCommentAndTokenAndStatements(string code) { var parser = new JavaScriptParser(new ParserOptions() ...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
gh_e89298814fc3
github
scripting
Write a Unity C# ScriptableObject for Open XR Profile Config
```csharp namespace Tilia.CameraRigs.OpenXR.Config { using System.Collections.Generic; using UnityEngine; public class OpenXRProfileConfig : ScriptableObject { public string vendorGroup; public List<string> interactionProfiles = new List<string>(); public List<string> enabledFea...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_e3295437e394
unity_docs
rendering
Show me a Unity C# example demonstrating `AssetDatabase.WriteImportSettingsIfDirty`.
Declaration public static bool WriteImportSettingsIfDirty (string path ); Parameters Parameter Description path The path to write the import settings to. Returns bool Returns true if the operation was successful. Description Writes the import settings to disk. This method writes unsaved settings to di...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8f1977a4df24
unity_docs
ui
What are the parameters of `UIElements.ToggleButtonGroupState.GetActiveOptions` in Unity?
Description Retrieves a Span of integers containing the active options as indices. ```csharp public void HandleActiveOptions() { var value = myToggleButtonGroup.value; var options = value.GetActiveOptions(stackalloc int[value.length]); foreach (option in options) { // handle option } ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a444f48f8d83
unity_docs
input
In Unity's 'Deploy an Embedded Linux project', what is 'Setup on IVI-shell extension' and how does it work?
You can deploy your project using IVI-shell extension, which is an alternative shell extension for Weston. Set up IVI Surface IDs that the Unity Player needs to use with the environment variable UNITY_IVI_SURFACE_IDS . If this isn’t set, the Unity Player uses ID 4711 and upwards for the newly created surfaces (for exam...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7c6c882550bb
unity_docs
rendering
In Unity's 'Rendering Profiler module reference', what is 'Module details pane' and how does it work?
When you click on the Rendering Profiler module, the details pane in the lower half of the window displays detailed rendering statistics. These statistics are similar to the statistics shown in the Rendering Statistics window. In the top left of the details pane, select Open Frame Debugger to open the Frame Debugger , ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dae68fd3bc23
unity_docs
ui
What is `UIElements.VisualElement.viewDataKey` in Unity? Explain its purpose and usage.
VisualElement.viewDataKey public string viewDataKey ; Description Used for view data persistence, such as tree expanded states, scroll position, or zoom level. This key is used to save and load the view data from the view data store. If you don't set this key, the persistence is disabled for the associated ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8469e9a4a2f7
unity_docs
rendering
What is `Rendering.DrawingSettings.overrideShader` in Unity? Explain its purpose and usage.
DrawingSettings.overrideShader public Shader overrideShader ; Description Sets the shader to use for all drawers that would render in this group. Override shaders do not override existing material properties.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9981a1d5b1a4
unity_docs
rendering
Show me a Unity code example for 'Pass tags in ShaderLab reference'.
lid only in the Built-in Render Pipeline, when the rendering path is set to Forward, in a Pass with a LightMode tag value of ForwardBase . Unity provides only the main directional light and ambient/light probe data to this Pass. This means that data of non-important lights is not passed into vertex-light or spherical h...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_adbaa0ba114c
unity_docs
editor
In Unity's 'Introduction to debugging Unity in Windows', what is 'C# managed debugging' and how does it work?
Managed debugging refers to debugging high-level code that runs within a managed runtime environment. In Unity, this primarily involves debugging the logic of C# scripts written to extend game behavior using MonoBehaviour classes and other Unity APIs. You can use debugging tools such as Visual Studio to debug your Unit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_85d525793c9d
unity_docs
rendering
Give me an overview of the `ShaderInfo` class in Unity.
ShaderInfo struct in UnityEditor Description Contains the following information about a shader: -If the shader has compilation errors or warnings. -If the shader is supported on the currently selected platform. -The name of the shader. Properties Property Description hasErrors Indicates whether the shader has ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_30f84cba8bff
unity_docs
scripting
What is `AI.OffMeshLinkData.owner` in Unity? Explain its purpose and usage.
OffMeshLinkData.owner public Object owner ; Description Get the object used to create the NavMesh link represented by the data in this struct. If the link has been instantiated by a call to NavMesh.AddLink then this property returns the object that might have been associated to that instance with a call to N...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_679a743c51a7
unity_docs
rendering
What is `SkinnedMeshRenderer.vertexBufferTarget` in Unity? Explain its purpose and usage.
SkinnedMeshRenderer.vertexBufferTarget public GraphicsBuffer.Target vertexBufferTarget ; Description The intended target usage of the skinned mesh GPU vertex buffer. By default, skinned mesh renderer vertex buffers have GraphicsBuffer.Target.Vertex usage target. If you want to access the vertex buffer from...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_3ed825011b9d
unity_docs
scripting
Explain 'Transforms' in Unity.
The Transform stores a GameObject ’s Position , Rotation , Scale and parenting state. A GameObject always has a Transform component attached: you can’t remove a Transform or create a GameObject without a Transform component. ## The Transform Component The Transform component determines the Position , Rotation , and S...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9dfb75e36af6
unity_docs
xr
What is `Resources.LoadAsync` in Unity? Explain its purpose and usage.
Resources.LoadAsync Declaration public static ResourceRequest LoadAsync (string path ); Declaration public static ResourceRequest LoadAsync (string path , Type type ); Parameters Parameter Description path Pathname of the target folder. When using the empty string (i.e., ""), the function will load...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_d5f9d370f872_doc_11
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Name of an input control scheme that defines the grouping of bindings that should remain enabled when applying the noncontinuous movement control scheme.Control schemes are created and named in the Input Actions window. Can be an empty string, which means only bindings that match thebase control scheme will be enabled....
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_74b747641adc
unity_docs
scripting
What is `QualitySettings.resolutionScalingFixedDPIFactor` in Unity? Explain its purpose and usage.
QualitySettings.resolutionScalingFixedDPIFactor public static float resolutionScalingFixedDPIFactor ; Description In resolution scaling mode, this factor is used to multiply with the target Fixed DPI specified to get the actual Fixed DPI to use for this quality setting. Additional resources: Multi-Resolution ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_5f8b22f292e7
github
scripting
Write a Unity C# UI script for Game View
```csharp using System.Threading; using Cysharp.Threading.Tasks; using UnityEngine; using UnityEngine.UI; namespace AntiMonoBehaviour.Views { public interface IGameView { UniTask FinishButtonClickAsync(CancellationToken cancel); } public class GameView : UnityViewBase, IGameView { ...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_man_fa02ade3282b
unity_docs
scripting
Explain 'Customize IMGUI controls' in Unity.
Although Unity’s IMGUI system is mainly intended for creating developer tools and debugging interfaces, you can still customize and style them in many ways. In Unity’s IMGUI system, you can fine-tune the appearance of your Controls with many details. Control appearances are dictated with GUIStyles . By default, when yo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_97e62a219d3e
unity_docs
scripting
What is `Resolution.ToString` in Unity? Explain its purpose and usage.
Resolution.ToString Declaration public string ToString (); Returns string A string with the format "width x height @ refreshRateHz". Description Returns a nicely formatted string of the resolution.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_66c29548ff79
unity_docs
scripting
What are the parameters of `Component.SendMessageUpwards` in Unity?
Description Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour. The receiving method can choose to ignore the argument by having zero arguments. If the options parameter is set to SendMessageOptions.RequireReceiver an error is printed when the message is ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_57e38df3b8cb
unity_docs
scripting
What is `PlayerSettings.resizableWindow` in Unity? Explain its purpose and usage.
PlayerSettings.resizableWindow public static bool resizableWindow ; Description Use resizable window in standalone player builds. By default standalone Windows, Mac and Linux builds use a non-resizable game window. Enabling this makes the window resizable.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_6b945cbccb82
github
scripting
Write a Unity C# XR/VR script for Meta System Gesture Detector
```csharp using System; using Unity.XR.CoreUtils.Bindings.Variables; using UnityEngine.Events; using UnityEngine.InputSystem; using UnityEngine.XR.Interaction.Toolkit.Inputs; #if XR_HANDS_1_1_OR_NEWER using UnityEngine.XR.Hands; #endif namespace UnityEngine.XR.Interaction.Toolkit.Samples.Hands { /// <summary> ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6a951a6deb7c
unity_docs
scripting
Show me a Unity C# example demonstrating `Vector2.operator_add`.
Vector2.operator + public static Vector2 operator + ( Vector2 a , Vector2 b ); Description Adds two vectors. Adds corresponding components together. ```csharp using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { void Start() { print(new Vector2(1, 2) + new Vector2(2...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_f3ea0a2466ba
github
scripting
Write a Unity C# UI script for Global Persistent Data Manager
```csharp using Newtonsoft.Json; using Newtonsoft.Json.Linq; using System; using System.Collections.Generic; using System.IO; using UnityEngine; using UnityEngine.SceneManagement; namespace PlainSaveLoad { public class GlobalPersistentDataManager : MonoBehaviour { /// <summary> /// Custom clas...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_a217f9967683
unity_docs
xr
What is `Profiling.ProfilerArea.Memory` in Unity? Explain its purpose and usage.
ProfilerArea.Memory Description Memory statistics. The detail pane (bottom half) of the ProfilerWindow includes the ability to take detailed snapshots of type PackedMemorySnapshot via MemorySnapshot.RequestNewSnapshot and display it.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_60e8b268c8bc
unity_docs
math
What is `AndroidJNI.CallShortMethodUnsafe` in Unity? Explain its purpose and usage.
AndroidJNI.CallShortMethodUnsafe Declaration public static short CallShortMethodUnsafe (IntPtr obj , IntPtr methodID , jvalue* args ); Description Calls a Java instance method defined by methodID , optionally passing an array of arguments ( args ) to the method. Additional resources: Java Native Interface ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_78dfa12e872d
unity_docs
editor
What is `SerializedObject.Update` in Unity? Explain its purpose and usage.
SerializedObject.Update Declaration public void Update (); Description Update serialized object's representation. When a SerializedObject is constructed, the target objects are serialized, and the SerializeObject and SerializedProperty API provide read and write access to that serialized representation. If one...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c49ac475b065
unity_docs
math
What is `ArrayUtility.ArrayEquals` in Unity? Explain its purpose and usage.
ArrayUtility.ArrayEquals Declaration public static bool ArrayEquals (T[] lhs , T[] rhs ); Returns bool True if both have the same number of elements and the contents are equal. Description Compares two arrays.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_f14dfa5f3879_doc_0
github
scripting
What does `Setting` do in this Unity script? Explain its purpose and signature.
The type that is used to store the data is inferred from . Signature: ```csharp public Setting(string key, string displayName, object defaultValue, string tooltip = default) ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_5cc34711f583
unity_docs
editor
What is `TerrainTools.TerrainPaintToolWithOverlaysBase.OnSceneGUI` in Unity? Explain its purpose and usage.
TerrainPaintToolWithOverlaysBase.OnSceneGUI Declaration public void OnSceneGUI ( Terrain terrain , TerrainTools.IOnSceneGUI editContext ); Parameters Parameter Description terrain Active Terrain object.Active Terrain object. editContext Interface used to communicate between Editor and Paint tools. Des...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0863d2a64b3d
unity_docs
scripting
What is `UIElements.BaseTreeView.GetParentIdForIndex` in Unity? Explain its purpose and usage.
BaseTreeView.GetParentIdForIndex Declaration public int GetParentIdForIndex (int index ); Parameters Parameter Description index The TreeView item index. Returns int The TreeView item's parent identifier. Description Gets the specified TreeView item's parent identifier.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e821bc9caf1f
unity_docs
math
What is `HandleUtility.ProjectPointLine` in Unity? Explain its purpose and usage.
HandleUtility.ProjectPointLine Declaration public static Vector3 ProjectPointLine ( Vector3 point , Vector3 lineStart , Vector3 lineEnd ); Description Project point onto a line. Additional resources: DistancePointLine . Additional resources: PointOnLineParameter .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b3a78e4257ef
unity_docs
rendering
What are the parameters of `Cubemap.SetPixels` in Unity?
Description Sets the pixel colors of an entire mipmap level of a face. This method sets pixel data for the texture in CPU memory. Texture.isReadable must be true , and you must call Apply after SetPixels to upload the changed pixels to the GPU. Apply is an expensive operation because it copies all the pixels in the tex...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0b856627e7c2
unity_docs
rendering
Explain 'YAML class ID reference' in Unity.
A reference of common class ID numbers used by the YAML file format is given below, both in numerical order of class IDs and alphabetical order of class names. Note that some ranges of numbers are intentionally omitted from the sequence - these may represent classes that have been removed from the API or may be reserve...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_1ae44e2f7238_doc_0
github
scripting
What does `ManagedUpdate` do in this Unity script? Explain its purpose and signature.
Implement this for receiving managed updates from . Signature: ```csharp public abstract void ManagedUpdate(); ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_man_9148444c5a14
unity_docs
ui
In Unity's 'Structure UI with C# scripts', what is 'Register a callback' and how does it work?
Controls that have value properties send an event if the value changes. You can register a callback to receive this event. The following example creates a Toggle control and registers a callback: ``` // Create a toggle and register callback m_MyToggle = new Toggle("Test Toggle") { name = "My Toggle" }; m_MyToggle.Regis...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_18a999c2d964
unity_docs
ui
What is `Overlays.ToolbarOverlay.CreatePanelContent` in Unity? Explain its purpose and usage.
ToolbarOverlay.CreatePanelContent Declaration public UIElements.VisualElement CreatePanelContent (); Returns VisualElement Root element of ToolbarOverlay's panel content. Description Creates the root VisualElement of the ToolbarOverlay's content in panel layout.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_843a6819d657
unity_docs
scripting
What is `Search.IQueryEngineFilter.ClearMetaInfo` in Unity? Explain its purpose and usage.
IQueryEngineFilter.ClearMetaInfo Declaration public Search.IQueryEngineFilter ClearMetaInfo (); Returns IQueryEngineFilter The current filter. Description Removes all additional information specific to the filter. ``` filter.ClearMetaInfo(); var filtersWithMetaInfo = queryEngine.GetAllFilters().Where(f ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_175aa3f49fbc
unity_docs
scripting
What are the parameters of `Unity.IO.LowLevel.Unsafe.AsyncReadManagerMetrics.GetMetrics` in Unity?
Returns AsyncReadManagerRequestMetric[] Array of read request metrics currently stored in the AsyncReadManager, which can be filtered by passing AsyncReadManagerMetricsFilters . Description Returns the current AsyncReadManager metrics. This function can filter the metrics collected by passing AsyncReadManagerMetricsFil...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ef24ad1c5045
unity_docs
scripting
What is `Video.VideoPlayer.height` in Unity? Explain its purpose and usage.
VideoPlayer.height public uint height ; Description The height of the images in the VideoClip , or URL, in pixels. (Read Only) For URL sources, this will only be set once the source preparation is completed. See VideoPlayer.Prepare .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2f637a793d96
unity_docs
scripting
What is `UIElements.IMGUIContainer.onGUIHandler` in Unity? Explain its purpose and usage.
IMGUIContainer.onGUIHandler public Unity.Android.Gradle.Manifest.Action onGUIHandler ; Description The function that's called to render and handle IMGUI events. This is assigned to onGUIHandler and is similar to MonoBehaviour.OnGUI .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cce54befc66b
unity_docs
rendering
What is `RenderSettings.ambientProbe` in Unity? Explain its purpose and usage.
RenderSettings.ambientProbe public static Rendering.SphericalHarmonicsL2 ambientProbe ; Description An ambient probe that captures environment lighting. Unity generates the ambient probe when you generate lighting for a scene. If you haven't yet generated lighting in a scene, Unity uses a default ambient prob...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b1207665fbf0
unity_docs
rendering
In Unity's 'Lens flares', what is 'Render pipeline information' and how does it work?
How you work with lens flare depends on the render pipeline you use. Feature name Universal Render Pipeline (URP) High Definition Render Pipeline (HDRP) Built-in Render Pipeline Lens flares Yes Use a Lens Flare (SRP) Data Asset and a Lens Flare (SRP) component , or a Screen Space Lens Flare override . Yes Use a Lens Fl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_22b6e3a04e86
unity_docs
editor
What is `PackageManager.AuthorInfo` in Unity? Explain its purpose and usage.
AuthorInfo class in UnityEditor.PackageManager Description Identifies the author of a package. Properties Property Description email The email address of the author (optional). name The name of the author. url The url address of the author (optional).
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d99434c41e31
unity_docs
math
What is `Mesh.GetTangents` in Unity? Explain its purpose and usage.
Mesh.GetTangents Declaration public void GetTangents (List<Vector4> tangents ); Parameters Parameter Description tangents A list of tangents to populate. Description Gets the tangents of the Mesh. The tangent at each index corresponds to the vertex with the same index. Use this method instead of tangent...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_00727c2c3fe2
unity_docs
rendering
What is `RenderTextureDescriptor.useDynamicScaleExplicit` in Unity? Explain its purpose and usage.
RenderTextureDescriptor.useDynamicScaleExplicit public bool useDynamicScaleExplicit ; Description Set to true to enable dynamic resolution scaling on this render texture and control when this scaling happens. Mutually exclusive with RenderTextureDescriptor.useDynamicScale Additional resources: RenderTexture.us...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_93f4e8bb895f
unity_docs
physics
Explain 'Optimize transform value syncing' in Unity.
Optimize the synchronization of Transform values with the physics system to improve performance and query accuracy. By default, Unity defers physics transform syncing. If you change a Transform value and then immediately query the physics world, the physics system might not become aware of the change unless it’s explic...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_519c97ebd224
unity_docs
physics
Give me an overview of the `ImportAssetOptions` class in Unity.
ImportAssetOptions enumeration Description Asset importing options. Additional resources: AssetDatabase.ImportAsset , AssetDatabase.Refresh . Properties Property Description Default Default import options. ForceUpdate User initiated asset import. ForceSynchronousImport Import all assets synchronously. Imp...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7c3baf9a5e59
unity_docs
scripting
Explain 'APK expansion files in Unity' in Unity.
This page describes how APK expansion files work in the context of a Unity Android application. Unity can automatically split an application into a main APK and a single APK expansion file that uses the.obb file extension. In Unity, this process is called splitting the application binary. The APK expansion file this pr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_55ec96640f29
unity_docs
scripting
What is `Video.VideoClip.originalPath` in Unity? Explain its purpose and usage.
VideoClip.originalPath public string originalPath ; Description Gets the original video clip file path as it was imported into Unity. (Read Only). Use this property to find the original location of the file when you imported it into Unity. If you move the video clip file, this property’s value remains as the or...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7f57e5c9f7d2
unity_docs
editor
Show me a Unity C# example demonstrating `Unity.Profiling.LowLevel.Unsafe.ProfilerRecorderDescription`.
ProfilerRecorderDescription struct in Unity.Profiling.LowLevel.Unsafe / Implemented in: UnityEngine.CoreModule Description Gets the description of a Profiler metric. Provides information about Profiler metrics that are accessible with the ProfilerRecorder . Use Name and Category to create an instance of P...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5b7b85975068
unity_docs
scripting
What is `UIElements.Experimental.StyleValues.borderTopWidth` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. StyleValues.borderTopWidth public float borderTopWidth ; Description Space reserved for the top edge of the border during the layout phase.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_6910d9d9a9ea_doc_25
github
scripting
What does `OnTriggerStayAsObservable` do in this Unity script? Explain its purpose and signature.
OnTriggerStay is called once per frame for every Collider other that is touching the trigger. Signature: ```csharp public static IObservable<Collider> OnTriggerStayAsObservable(this Component component) ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.