id
stringlengths
15
22
source
stringclasses
2 values
category
stringclasses
12 values
instruction
stringlengths
22
180
response
stringlengths
100
46.1k
system
stringclasses
5 values
local_man_b6367cafd2ea
unity_docs
scripting
In Unity's 'Instantiate projectiles and explosions', what is 'Create a script to launch the projectiles' and how does it work?
To launch the projectiles, you need to create a script that instantiates projectiles when the fire key is pressed, and add that script to a GameObject. Create a script called FireProjectile and add the following contents to it: ```csharp using UnityEngine; using UnityEngine.InputSystem; public class FireProjectile : M...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f673242dfd79
unity_docs
rendering
In Unity's 'Transparent Cutout Bumped Specular', what is 'Creating Normal maps' and how does it work?
You can import normal maps created outside of Unity, or you can import a regular grayscale image and convert it to a Normal Map from within Unity. (This page refers to a legacy shader which has been superseded by the Standard Shader , but you can learn more about how to use Normal Maps in the Standard Shader )
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2fce877c13f0
unity_docs
editor
What is `PrefabReplacingSettings` in Unity? Explain its purpose and usage.
PrefabReplacingSettings class in UnityEditor Description Settings controlling the behavior of PrefabUtility.ReplacePrefabAssetOfPrefabInstance . Properties Property Description changeRootNameToAssetName Change the name of the root GameObject to match the name of the Prefab Asset used when replacing the Prefab...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_967a6307b5d9_doc_9
github
scripting
What does `GetTileData` do in this Unity script? Explain its purpose and signature.
Retrieves any tile rendering data from the scripted tile.Position of the Tile on the Tilemap.The Tilemap the tile is present on.Data to render the tile. Signature: ```csharp public override void GetTileData(Vector3Int position, ITilemap tilemap, ref TileData tileData) ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_dc0541d40965
unity_docs
rendering
What is `ParticleSystem.SubEmittersModule.RemoveSubEmitter` in Unity? Explain its purpose and usage.
ParticleSystem.SubEmittersModule.RemoveSubEmitter Declaration public void RemoveSubEmitter (int index ); Parameters Parameter Description index The index from which to remove a sub-emitter. Description Removes a sub-emitter from the given index in the array. Additional resources: ParticleSystem.SubEmitt...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_20f5b46462f4
unity_docs
scripting
In Unity's 'Adding profiler counters to your code', what is 'Creating and defining a counter' and how does it work?
To create a new counter: Write a script that defines the value type of the new counter. Assign a name and a unit to this type. Important: When you create a counter you must specify which Profiler category your new counter belongs to. To do this, use an existing Unity category from the ProfilerCategory class. The script...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_195a813ffcd9
unity_docs
physics
What is `FrictionJoint2D` in Unity? Explain its purpose and usage.
FrictionJoint2D class in UnityEngine / Inherits from: AnchoredJoint2D / Implemented in: UnityEngine.Physics2DModule Description Applies both force and torque to reduce both the linear and angular velocities to zero. The joint constantly tries to reduce both the ::Rigidbody2D::velocity and ::Rigidbody2D::angul...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8665f8df76f7
unity_docs
editor
Show me a Unity C# example demonstrating `EditorWindow.GetWindow`.
her to give the window focus, if it already exists. (If GetWindow creates a new window, it will always get focus). Returns EditorWindow An EditorWindow instance of windowType . Description Returns the first EditorWindow of type windowType which is currently on the screen. If there is none, creates and shows...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_546de35f6695
unity_docs
performance
What is `PlayerSettings.enableInternalProfiler` in Unity? Explain its purpose and usage.
PlayerSettings.enableInternalProfiler public static bool enableInternalProfiler ; Description Enables internal profiler. Enables the internal profiler which collects performance data of the application and prints a report to the console. The report contains the number of milliseconds that it took for each Unit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0bc271600f54
unity_docs
math
What is `Mathf.NegativeInfinity` in Unity? Explain its purpose and usage.
Mathf.NegativeInfinity public static float NegativeInfinity ; Description A representation of negative infinity (Read Only). ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() { Debug.Log(Mathf.NegativeInfinity); } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_37ce2570efd8
unity_docs
rendering
In Unity's 'Introduction to the BatchRendererGroup API in URP', what is 'How BatchRendererGroup works' and how does it work?
To render to the screen, BatchRendererGroup (BRG) generates draw commands which are a BRG-specific concept that contains everything Unity needs to efficiently create optimized, instanced draw calls. To determine when to render the instances in a draw command, BRG uses filter settings . Filter settings control when to r...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bdb5e0cb00cd
unity_docs
rendering
What is `Rendering.RayTracingMeshInstanceConfig.subMeshFlags` in Unity? Explain its purpose and usage.
RayTracingMeshInstanceConfig.subMeshFlags public Rendering.RayTracingSubMeshFlags subMeshFlags ; Description Flags that determine how rays intersect the geometry for each submesh relative to Material type during ray tracing. The Material type can influence the value of this flag. For example if Unity consider...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3d9451b8179a
unity_docs
scripting
What is `UIElements.BaseTreeView.RemoveFromSelectionById` in Unity? Explain its purpose and usage.
BaseTreeView.RemoveFromSelectionById Declaration public void RemoveFromSelectionById (int id ); Parameters Parameter Description id The item id. Description Removes an item from the current selection by id.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_10c7e252ce48
unity_docs
rendering
Give me an overview of the `DetailPrototype` class in Unity.
DetailPrototype class in UnityEngine / Implemented in: UnityEngine.TerrainModule Description Detail prototype used by the Terrain GameObject. Properties Property Description alignToGround Rotate detail axis parallel to the ground's normal direction, so that the detail is perpendicular to the ground. density...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8ffca5ae9f4f
unity_docs
rendering
Explain 'Working with Heightmaps' in Unity.
Terrain tools that affect height, such as Raise or Lower Terrain and Set Height , use a grayscale texture called a heightmap. Unity represents the height of each point on the Terrain as a value in a rectangular array. It represents this array using a grayscale heightmap . Heightmaps are built into the Terrain, and the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f9d967bbf9ed
unity_docs
scripting
What is `HeadDof` in Unity? Explain its purpose and usage.
HeadDof enumeration Description Enumeration of all the muscles in the head. These muscles are a sub-part of a human part. Additional resources: HumanPartDof . Properties Property Description NeckFrontBack The neck front-back muscle. NeckLeftRight The neck left-right muscle. NeckRollLeftRight The neck roll l...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fd66a7b13e61
unity_docs
scripting
What is `Progress.Item.Remove` in Unity? Explain its purpose and usage.
Progress.Item.Remove Declaration public int Remove (); Returns int -1 if the progress indicator is removed, otherwise returns the progress indicator's id. Description Finishes and removes an active progress indicator. Additional resources: Progress.Remove .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_695f43fac8c3
unity_docs
math
What is `Rendering.RayTracingAccelerationStructure.ManagementMode.Manual` in Unity? Explain its purpose and usage.
RayTracingAccelerationStructure.ManagementMode.Manual Description Gives user control over populating and updating the RayTracingAccelerationStructure. If the ManagementMode is set to Manual, then you must call RayTracingAccelerationStructure.AddInstance to add an instance to the RayTracingAccelerationStructure. C...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f354618923c8
unity_docs
rendering
In Unity's 'DirectX', what is 'Feature comparison of DirectX 11 and DirectX 12 in Unity' and how does it work?
The following lists include the features introduced with the DirectX 12 graphics API, which are unavailable in DirectX 11. APIs DirectX 11 DirectX 12 Dynamic resolution Unsupported Supported Asynchronous compute Unsupported Supported Native render pass Unsupported Supported Ray tracing acceleration Unsupported Supporte...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_02829b61ea02
unity_docs
networking
What is `Networking.MultipartFormDataSection.ctor` in Unity? Explain its purpose and usage.
MultipartFormDataSection Constructor Declaration public MultipartFormDataSection (byte[] data ); Parameters Parameter Description data Data payload of this section. Description Raw data section, unnamed and no Content-Type header. Will not include either a filename or a Content-Type section header. D...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_6910d9d9a9ea_doc_29
github
scripting
What does `OnBeforeTransformParentChangedAsObservable` do in this Unity script? Explain its purpose and signature.
Callback sent to the graphic before a Transform parent change occurs. Signature: ```csharp public static IObservable<Unit> OnBeforeTransformParentChangedAsObservable(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_0670b9fa9372
unity_docs
rendering
Show me a Unity C# example demonstrating `AssetPostprocessor.OnPostprocessTexture2DArray`.
ssion format at this point. If you want to change compression format based on filename or other attributes of the texture, use AssetPostprocessor.OnPreprocessTexture . However, if you modify the TextureImporter settings in this way, it has no effect on the texture that Unity is currently importing, but it does apply ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c6a8b5f4283b
unity_docs
rendering
What is `LightProbes.CalculateInterpolatedLightAndOcclusionProbes` in Unity? Explain its purpose and usage.
LightProbes.CalculateInterpolatedLightAndOcclusionProbes Declaration public static void CalculateInterpolatedLightAndOcclusionProbes (Vector3[] positions , SphericalHarmonicsL2[] lightProbes , Vector4[] occlusionProbes ); Declaration public static void CalculateInterpolatedLightAndOcclusionProbes (List<Vector...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e0e61e34e2f2
unity_docs
editor
In Unity's 'UITK Text Settings assets', what is 'Dynamic Font System Settings' and how does it work?
Project-wide settings to handle missing glyphs. Property Description Missing Character Unicode Unicode of the character to use when a missing glyph isn’t in any of the fallback fonts. The default value of 0 produces the outline of a square. Clear Dynamic Data on Build Clear all dynamic data and restore the font asset b...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_94d91260af8e
unity_docs
physics
What is `PhysicsVisualizationSettings.viewDistance` in Unity? Explain its purpose and usage.
PhysicsVisualizationSettings.viewDistance public static float viewDistance ; Description Colliders within this distance will be displayed. Lowering this distance will speed up the drawing of the Colliders.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_78bdc026abaa
unity_docs
scripting
What is `UIElements.MeshGenerationContext.GetTempMeshAllocator` in Unity? Explain its purpose and usage.
MeshGenerationContext.GetTempMeshAllocator Declaration public void GetTempMeshAllocator (out UIElements.TempMeshAllocator allocator ); Parameters Parameter Description allocator The allocator. Description Returns an allocator that can be used to safely allocate temporary meshes from the job system. The ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3d4545a73b70
unity_docs
physics
What is `ArticulationBody.GetJointAccelerations` in Unity? Explain its purpose and usage.
ArticulationBody.GetJointAccelerations Declaration public int GetJointAccelerations (List<float> accelerations ); Parameters Parameter Description accelerations Supplied list of floats to read back and store the joint accelerations data. Returns int Total degrees of freedom for the entire hierarchy of ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_120ce81216c5
unity_docs
rendering
What is `Texture2D.Compress` in Unity? Explain its purpose and usage.
Texture2D.Compress Declaration public void Compress (bool highQuality ); Description Compress texture at runtime to DXT/BCn or ETC formats. Use this to compress textures at runtime. Compressed textures use less graphics memory and are faster to render. For more information on texture compression, see Texture ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2475718b1b79
unity_docs
xr
In Unity's 'AssetBundle compression formats', what is 'LZMA compression' and how does it work?
LZMA compresses the entire content section of the AssetBundle file as a single stream. This full content approach results in smaller file sizes than chunk-based LZ4 compression. LZMA is the preferred format for AssetBundles downloaded from a Content Delivery Network (CDN). However, you must decompress the entire file i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2c3468152132
unity_docs
math
What is `Mathf.Ceil` in Unity? Explain its purpose and usage.
Mathf.Ceil Declaration public static float Ceil (float f ); Description Returns the smallest integer greater than or equal to f . ```csharp using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { void Example() { // Prints 10 Debug.Log(Mathf.Ceil(10.0F)); // Prints 11 De...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a44416427cec
unity_docs
scripting
What is `Profiling.HierarchyFrameDataView.GetItemMergedSamplesColumnDataAsFloats` in Unity? Explain its purpose and usage.
HierarchyFrameDataView.GetItemMergedSamplesColumnDataAsFloats Declaration public void GetItemMergedSamplesColumnDataAsFloats (int id , int column , List<float> outValues ); Parameters Parameter Description id Hierarchy item identifier. column Column identifier. outValues The merged samples for the spec...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0e26970d81a8
unity_docs
physics
What is `ShaderKeywordFilter.FilterAttribute.ctor` in Unity? Explain its purpose and usage.
FilterAttribute Constructor Declaration public FilterAttribute ( ShaderKeywordFilter.FilterAction action , ShaderKeywordFilter.FilterAttribute.Precedence precedence , ShaderKeywordFilter.FilterAttribute.EvaluationMode evaluationMode , object condition , string fileName , int lineNumber , params string[] ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3c9a8d4df44d
unity_docs
animation
What is `Animations.AnimatorControllerLayer.SetOverrideMotion` in Unity? Explain its purpose and usage.
AnimatorControllerLayer.SetOverrideMotion Declaration public void SetOverrideMotion ( Animations.AnimatorState state , Motion motion ); Parameters Parameter Description state The state which we want to set the motion. motion The motion that will be set. Description Sets the override motion for the st...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f9003d77e303
unity_docs
performance
What is `Profiling.HierarchyFrameDataView.GetItemMergedSampleCallstack` in Unity? Explain its purpose and usage.
HierarchyFrameDataView.GetItemMergedSampleCallstack Declaration public void GetItemMergedSampleCallstack (int id , int sampleIndex , List<ulong> outCallstack ); Parameters Parameter Description sampleIndex Merged sample index. id Hierarchy item identifier. outCallstack List filled with callstack pointe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0f07eb4f0bb5
unity_docs
audio
Explain 'Introduction to transcoding video files' in Unity.
Video transcoding converts video files between different formats. The Video Clip Importer can transcode video files that you import into Unity. This is useful when your video files use a codec that the Editor platform supports , but isn’t compatible with your target platforms . For instructions on how to transcode your...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_250da6d4a30d
unity_docs
editor
Show me a Unity C# example demonstrating `Selection.activeGameObject`.
Selection.activeGameObject public static GameObject activeGameObject ; Description Returns the active game object. (The one shown in the inspector). It will also return game objects that might be Prefabs or non-modifiable objects. ```csharp using UnityEngine; using UnityEditor;class Example : EditorWindow { ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_bb915357b862
unity_docs
physics
In Unity's 'Collider surface friction', what is 'Friction calculation' and how does it work?
You can choose the type of calculation that PhysX uses to simulate friction between colliders. To do this, go to the Physics Settings ( Edit > Project Settings > Physics ) and use the Friction Type property. See the Physics Settings documentation for more information on each friction type. The choice of friction type i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_24cd741347dc
unity_docs
editor
Show me a Unity C# example demonstrating `ExpressionEvaluator`.
the result. Supported number types are: int , float , long , double . The expressions that can be evaluated support: arithmetic operators a+b , a-b , a*b , a/b , power ( a^b ) and modulo ( a%b ) operators, parentheses, math functions sqrt(a) , floor(a) , ceil(a) , round(a) , trigonometic functions cos...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a3afb50fffcb
unity_docs
rendering
What is `Rendering.CommandBuffer.DrawMesh` in Unity? Explain its purpose and usage.
CommandBuffer.DrawMesh Declaration public void DrawMesh ( Mesh mesh , Matrix4x4 matrix , Material material , int submeshIndex = 0, int shaderPass = -1, MaterialPropertyBlock properties = null); Parameters Parameter Description mesh Mesh to draw. matrix Transformation matrix to use. material...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8433e1f9d908
unity_docs
physics
Show me a Unity C# example demonstrating `EditorUtility.SetCustomDiffTool`.
string threeWayDiff , string mergeCommand , bool forceEnableCustomTool ); Parameters Parameter Description path Diff tool path. twoWayDiff Two - way diff command line. threeWayDiff Three - way diff command line. mergeCommand Merge command line. forceEnableCustomTool Sets Custom Tool as current active ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7de0540dd88c
unity_docs
scripting
In Unity's 'Achievements Building Block', what is 'Deploy the cloud code modules' and how does it work?
The test scene uses the BlocksGameModule.ccmr Cloud Code module to update the global score. To use this module: Set up deployment in your project . Go to Services > Deployment . In the Deployment window, expand the Blocks.CloudCode section. Select the BlocksGameModule.ccmr and BlocksAdminModule.ccmr checkboxes. Select ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_38e1fc17ecd9_doc_6
github
scripting
What does `SaveToFile` do in this Unity script? Explain its purpose and signature.
Save to folder with Signature: ```csharp public static bool SaveToFile(string folderPath, GeneratedScript generatedScript) ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_68cbe42fd65b
unity_docs
input
What is `IMGUI.Controls.TreeView.CanChangeExpandedState` in Unity? Explain its purpose and usage.
TreeView.CanChangeExpandedState Declaration protected bool CanChangeExpandedState ( IMGUI.Controls.TreeViewItem item ); Parameters Parameter Description item Can this item be expanded/collapsed. Description Override this method to control whether an item can be expanded or collapsed by key or mouse. If t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_7fe5a06be3f4
github
scripting
Write a Unity C# XR/VR script for Singleton
```csharp // Copyright 2024 URAV ADVANCED LEARNING SYSTEMS PRIVATE LIMITED // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unles...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4bbfca13a3a5
unity_docs
rendering
In Unity's 'OpenGL Core', what is 'macOS OpenGL driver limitations' and how does it work?
The macOS OpenGL backend for the Editor and Standalone supports OpenGL 3.x and 4.x features such as tessellation and geometry shaders . However, as Apple restricts the OpenGL version on OS X desktop to 4.1 at most, it does not support all DirectX 11 features (such as Unordered Access Views or Compute Shaders). This mea...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_159ba61725a7
unity_docs
editor
What is `Application.isFocused` in Unity? Explain its purpose and usage.
Application.isFocused public static bool isFocused ; Description Whether the Player currently has focus (Read Only). In the Editor, this corresponds to whether the Game view has focus (regardless of whether the Editor is in Play mode or not). Additional resources: MonoBehaviour.OnApplicationFocus .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_fd92b0f63d52
unity_docs
editor
In Unity's 'Create list and tree views', what is 'Create the data in C#' and how does it work?
Create data in a C# script that’s made up of two groups of planets and the root nodes for the tree view. Create a project in Unity with any template. In your Project window , create a folder named Editor . In the Editor folder, create a C# script named PlanetsWindow.cs . Replace the contents of PlanetsWindow.cs with th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c22d1d5d2ea3
unity_docs
input
What is `TouchScreenKeyboard.active` in Unity? Explain its purpose and usage.
TouchScreenKeyboard.active public bool active ; Description Is the keyboard visible or sliding into the position on the screen? Use this property to bring previously hidden keyboard back on the screen. ```csharp using UnityEngine;public class Example : MonoBehaviour { // Hides the keyboard if the device is fa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_af019e8f1bc1
unity_docs
editor
What is `iOS.Xcode.PBXProject.AddBuildPropertyForConfig` in Unity? Explain its purpose and usage.
PBXProject.AddBuildPropertyForConfig Declaration public void AddBuildPropertyForConfig (string configGuid , string name , string value ); Declaration public void AddBuildPropertyForConfig (IEnumerable<string> configGuids , string name , string value ); Parameters Parameter Description configGuid The...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a85bb3a7a2a8
unity_docs
editor
What is `AssetImporters.AssetImporterEditor.useAssetDrawPreview` in Unity? Explain its purpose and usage.
AssetImporterEditor.useAssetDrawPreview protected bool useAssetDrawPreview ; Description Determines if the asset preview is handled by the AssetEditor or the Importer DrawPreview We usually want to redirect the DrawPreview to the AssetEditor, but there are few cases we don't want that. If you want to use the Im...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b912c177b6bb
unity_docs
scripting
What is `Rendering.VirtualTexturing.Streaming.SetCPUCacheSize` in Unity? Explain its purpose and usage.
Virtual Texturing is experimental and not ready for production use. The feature and documentation might be changed or removed in the future. Streaming.SetCPUCacheSize Declaration public static void SetCPUCacheSize (int sizeInMegabytes ); Description Sets the CPU cache size (in MegaBytes) used by Streaming Virt...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7d9b420cf1aa
unity_docs
xr
In Unity's 'Run an XR application', what is 'Mock HMD' and how does it work?
The Mock HMD package provides a simulated HMD in the Unity Game view in Play mode. The Mock HMD is a provider plug-in that simulates the presence of a head-mounted device. Enable the Mock HMD in the XR Plug-in Management settings section. Input and tracking are not simulated. Refer to the Mock HMD documentation for mor...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_49da60b085d1
unity_docs
scripting
What is `Mesh.OptimizeReorderVertexBuffer` in Unity? Explain its purpose and usage.
Mesh.OptimizeReorderVertexBuffer Declaration public void OptimizeReorderVertexBuffer (); Description Optimizes the vertices of the Mesh to improve rendering performance. This function causes the vertices of the mesh to be reordered internally in an attempt to improve vertex cache utilisation on the graphics ha...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ee3ec1366448
unity_docs
rendering
Give me an overview of the `ShaderVariantCollection` class in Unity.
ShaderVariantCollection class in UnityEngine / Inherits from: Object / Implemented in: UnityEngine.CoreModule Description ShaderVariantCollection records which shader variants are actually used in each shader. This is used for shader preloading ("warmup"), so that a game can make sure "actually required" shad...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7354a9d25526
unity_docs
editor
What is `PrefabUtility.prefabInstanceUpdated` in Unity? Explain its purpose and usage.
PrefabUtility.prefabInstanceUpdated public static PrefabUtility.PrefabInstanceUpdated prefabInstanceUpdated ; Description Unity calls this method automatically when Prefab instances in the Scene have been updated.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f849d006c110
unity_docs
math
Show me a Unity C# example demonstrating `GL.Vertex`.
GL.Vertex Declaration public static void Vertex ( Vector3 v ); Description Submit a vertex. In OpenGL this matches glVertex3f(v.x,v.y,v.z) ; on other graphics APIs the same functionality is emulated. This function can only be called between GL.Begin and GL.End functions. ```csharp using UnityEngine;publ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_6b945cbccb82_doc_5
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Calls the methods in its invocation list when the menu button is triggered by a palm pinch gesture.This is triggered by the non-dominant hand, which is the one with the menu icon (&#x2630;).The universal menu (Oculus icon) on the dominant hand does not trigger this event. Signature: ```csharp public UnityEvent menuPre...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_1ad559a8a9b5
unity_docs
rendering
What is `ComputeBufferType` in Unity? Explain its purpose and usage.
ComputeBufferType enumeration Description ComputeBuffer type. Different types of compute buffers map to different usage and declarations in HLSL shaders. Default type is "structured buffer" ( StructuredBuffer<T> or RWStructuredBuffer<T> ). Additional resources: ComputeBuffer , ComputeShader , Material.SetBuf...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cb998288260c
unity_docs
rendering
Give me an overview of the `AndroidDisplayOptions` class in Unity.
AndroidDisplayOptions enumeration Description Options to configure how your application renders on Android devices. Set the value of this enum to displayOptions property. ```csharp // This example demonstrates how to disable the default rendering behavior for secondary screens using UnityEditor; using UnityEdit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_879def9e7d1b
unity_docs
math
What is `GridLayout.GetLayoutCellCenter` in Unity? Explain its purpose and usage.
GridLayout.GetLayoutCellCenter Declaration public Vector3 GetLayoutCellCenter (); Returns Vector3 Cell Center coordinate. Description Get the default center coordinate of a cell for the set layout of the Grid .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_457f863f962e
unity_docs
xr
What is `StereoTargetEyeMask` in Unity? Explain its purpose and usage.
StereoTargetEyeMask enumeration Description Enum values for the Camera's targetEye property. Properties Property Description None Do not render either eye to the HMD. Left Render only the Left eye to the HMD. Right Render only the right eye to the HMD. Both Render both eyes to the HMD.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b97396257f73
unity_docs
math
Give me an overview of the `Vector3Int` class in Unity.
Vector3Int struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description Representation of 3D vectors and points using integers. This structure is used in some places to represent 3D positions and vectors that don't require the precision of floating-point. Static Properties Property Description ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_89768b597a59
unity_docs
scripting
Show me a Unity code example for 'Invoke from the main menu'.
To create a custom menu item that invokes a search, use the MenuItem attribute. The following example creates a menu item that searches the Asset Store for free assets: ```csharp [MenuItem("Search/Free Asset Gifts")] static void SearchStore() { var storeContext = SearchService.CreateContext("store", "price=0"); var v...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_89e770dfbfa8
unity_docs
editor
Show me a Unity C# example demonstrating `SerializedProperty.DuplicateCommand`.
SerializedProperty.DuplicateCommand Declaration public bool DuplicateCommand (); Description Duplicates the array element referenced by the SerializedProperty. Used to insert another element in the array, initialized to the same contents as the SerializedProperty. Additional resources: InsertArrayElementAtInd...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ffee175d45ae
unity_docs
editor
Explain 'Native memory' in Unity.
The Unity engine’s internal C/C++ core has its own memory management system, which is referred to as native memory. In most situations, you can’t directly access or modify this memory type, but you can customize some of the memory allocators. Topic Description Native memory introduction Understand how Unity’s internal ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f72845165572
unity_docs
ui
What are the parameters of `Presets.PresetSelector.ShowSelector` in Unity?
Description Opens a modal window to select a Preset . Declaration public static Search.ISearchView ShowSelector ( Presets.PresetType presetType , Presets.Preset currentSelection , SerializedProperty presetProperty , bool createNewAllowed ); Parameters Parameter Description presetType Filters the list of Presets based o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b6b726edc219
unity_docs
rendering
What is `ParticleSystem.ShapeModule.textureClipChannel` in Unity? Explain its purpose and usage.
ParticleSystem.ShapeModule.textureClipChannel public ParticleSystemShapeTextureChannel textureClipChannel ; Description Selects which channel of the Texture to use for discarding particles. Additional resources: ParticleSystem.ShapeModule.textureClipThreshold , ParticleSystem.ShapeModule.texture .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b6ec61ae7576
unity_docs
scripting
Show me a Unity C# example demonstrating `SerializedObject`.
lized fields so they will be processed by the Undo system and styled correctly for Prefab overrides when drawn in the Inspector. In many cases, you may create tools to modify objects in your project. For instance, the following script example creates a menu item that resets the local position of all GameObjects curr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_f522b91ce703_doc_16
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Represents an object which can receive five arguments as part of its initialization process.Base interface of . Signature: ```csharp public interface IFiveArguments ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
gh_631922c40522_doc_2
github
scripting
What does `InitWithCustomLoader` do in this Unity script? Explain its purpose and signature.
Use this method to initialize the loader with a custom implementation of ISmartReferenceLoader.The custom loader implementation. Signature: ```csharp public static void InitWithCustomLoader(ISmartReferenceLoader loader) ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_30f69eacd938
unity_docs
rendering
What is `HandleUtility.GetPickingIncludeExcludeList` in Unity? Explain its purpose and usage.
HandleUtility.GetPickingIncludeExcludeList Declaration public static PickingIncludeExcludeList GetPickingIncludeExcludeList ( Unity.Collections.Allocator allocator ); Parameters Parameter Description allocator The allocator to use to create the PickingIncludeExcludeList object. Returns PickingIncludeE...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3e27937668fe
unity_docs
animation
What is `AnimationMode.recordedPropertyColor` in Unity? Explain its purpose and usage.
AnimationMode.recordedPropertyColor public static Color recordedPropertyColor ; Description The color used to show that an animated property automatically records changes in the animation clip.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e13ef4020d77
unity_docs
physics
What is `Unity.Profiling.Memory.MemoryProfiler` in Unity? Explain its purpose and usage.
MemoryProfiler class in Unity.Profiling.Memory / Implemented in: UnityEngine.CoreModule Description The memory profiler API provides functionality for taking memory snapshots or adding metadata to them. The API is available at runtime. When you call this API to take snapshots, it stores the snapshots locally on...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_73eb73192658
github
scripting
Write a Unity Editor script for Unity Package Upload Workflow View
```csharp using AssetStoreTools.Exporter; using AssetStoreTools.Utility; using AssetStoreTools.Utility.Json; using System; using System.IO; using System.Threading.Tasks; using UnityEditor; using UnityEngine; using UnityEngine.UIElements; namespace AssetStoreTools.Uploader.UIElements { internal class UnityPackageU...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_man_510d8a23fa03
unity_docs
rendering
Show me a Unity code example for 'Decals Surface Shader example in the Built-In Render Pipeline'.
Decals are commonly used to add details to Materials at run time (for example, bullet impacts). They are especially useful in deferred rendering, because they alter the GBuffer before it is lit, therefore saving on performance. In a typical scenario, Decals should be rendered after the opaque objects and should not be ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_400776c26109_doc_1
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Will this type of 's life circle methods executed in editor mode?Use or to make this happen.or monified this field by . Signature: ```csharp public bool isExecuteInEditorMode; ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_man_e3eefce01c68
unity_docs
rendering
Explain 'Frame timing API counter reference' in Unity.
The following table describes the purpose of the counters that the FrameTiming API provides. FrameTiming API field Profiler counter Description cpuFrameTime CPU Total Frame Time The total CPU frame time, in nanoseconds. Unity calculates this as the time between the ends of two frames, including any overheads or time sp...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f47d29a7f95e
unity_docs
scripting
What is `DynamicGI.synchronousMode` in Unity? Explain its purpose and usage.
DynamicGI.synchronousMode public static bool synchronousMode ; Description When enabled, new dynamic Global Illumination output is shown in each frame. This affects performance a lot and should mostly be used for automated testing.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_385fbe8d3453
unity_docs
scripting
What is `Color.gamma` in Unity? Explain its purpose and usage.
Color.gamma public Color gamma ; Description A version of the color that has had the gamma curve applied. ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() { Color newColor = new Color(0.3f, 0.4f, 0.6f); print(newColor.gamma); } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_711604d7fd58
unity_docs
rendering
Show me a Unity code example for 'Vertex modifier Surface Shader example in the Built-In Render Pipeline'.
tex modifier” function that will modify the incoming vertex data in the vertex Shader . This can be used for things like procedural animation and extrusion along normals. Surface Shader compilation directive vertex:functionName is used for that, with a function that takes inout appdata_full parameter. Here’s a Shader t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_662918c9201c
unity_docs
performance
In Unity's 'Visual Studio project generation for Windows', what is 'Project retarget wizard' and how does it work?
Unity generates a Visual Studio Solution that targets Visual Studio 2015. If you are using a newer version of Visual Studio, you might see the Retarget Projects dialog box when you open your Visual Studio Solution. The Retarget Projects dialog prompts you to upgrade your Visual Studio Solution to match the Visual Studi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_62370708c8bb
unity_docs
editor
What is `EditorWindow.OnBackingScaleFactorChanged` in Unity? Explain its purpose and usage.
EditorWindow.OnBackingScaleFactorChanged Declaration protected void OnBackingScaleFactorChanged (); Description Called when the UI scaling for this EditorWindow is changed. Use this method to refresh UI elements that have multiple resolutions.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_87ec3c3ac0fb
unity_docs
scripting
What is `AI.NavMeshPathStatus` in Unity? Explain its purpose and usage.
NavMeshPathStatus enumeration Description Status of path. Properties Property Description PathComplete The path terminates at the destination. PathPartial The path cannot reach the destination. PathInvalid The path is not valid.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_db55d5319b9d
unity_docs
rendering
What is `Windows.WebCam.PhotoCaptureFrame` in Unity? Explain its purpose and usage.
PhotoCaptureFrame class in UnityEngine.Windows.WebCam / Implemented in: UnityEngine.CoreModule Description Contains information captured from the web camera. Information captured can include the image has well as spatial data. Properties Property Description dataLength The length of the raw IMFMediaBuffer w...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_857bbba83cec
unity_docs
rendering
What is `UIElements.MeshGenerationContext` in Unity? Explain its purpose and usage.
MeshGenerationContext class in UnityEngine.UIElements / Implemented in: UnityEngine.UIElementsModule Description Provides methods for generating a visual element's visual content during the VisualElement.generateVisualContent callback. Visual content is generated by using the Painter2D object, or manual...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_3517ad59c786
unity_docs
editor
In Unity's 'Editor script determinism', what is 'Pre-serialized runtime data determinism' and how does it work?
In some workflows, tools generate pre-serialized runtime data such as Protobuf message binaries, JSON blobs, or other binary payloads during the build process and embed them into the build as assets or resources. Even if the generated code is deterministic, the serialized data might not be. Review the official document...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1cc8853a61b4
unity_docs
rendering
What is `TextureImporterSwizzle.G` in Unity? Explain its purpose and usage.
TextureImporterSwizzle.G Description Use the green color channel. Additional resources: TextureImporter.swizzleR , TextureImporter.swizzleG , TextureImporter.swizzleB , TextureImporter.swizzleA .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6ebe3e44e306
unity_docs
rendering
What is `GameObjectUtility.ModifyMaskIfGameObjectIsHiddenForPrefabModeInContext` in Unity? Explain its purpose and usage.
GameObjectUtility.ModifyMaskIfGameObjectIsHiddenForPrefabModeInContext Declaration public static ulong ModifyMaskIfGameObjectIsHiddenForPrefabModeInContext (ulong sceneCullingMask , GameObject gameObject ); Parameters Parameter Description sceneCullingMask The scene culling mask intended to be used with t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7b5ffe1ea5c1
unity_docs
ui
What is `GUILayout.ExpandWidth` in Unity? Explain its purpose and usage.
GUILayout.ExpandWidth Declaration public static GUILayoutOption ExpandWidth (bool expand ); Description Option passed to a control to allow or disallow horizontal expansion. If this is true, the enclosed UI elements can expand to fill the available horizontal width. . ```csharp using UnityEngine; using Syst...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3dfac2d78b87
unity_docs
math
What are the parameters of `Vector2.ToString` in Unity?
Description Returns a formatted string for this vector. Defaults to two digits displayed (format="F2"). For more information, see Microsoft's documentation on Standard numeric format strings . ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() { Vector2 vector = new Vector2(...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_a5889bb29b1c_doc_36
github
scripting
What does `OnPaintSceneGUI` do in this Unity script? Explain its purpose and signature.
Callback for painting the GUI for the GridBrush in the Scene View.The GameObjectBrush Editor overrides this to draw the preview of the brush when drawing lines.Grid that the brush is being used on.Target of the GameObjectBrush::ref::Tool operation. By default the currently selected GameObject.Current selected location ...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_23ede9790665
unity_docs
scripting
What are the parameters of `Playables.PlayableOutputExtensions.PushNotification` in Unity?
Description Queues a notification to be sent through the Playable system. ```csharp using UnityEngine; using UnityEngine.Playables; class ExamplePlayableBehaviour : PlayableBehaviour { private static readonly Notification s_BlendNotification = new Notification("BlendComplete"); private float m_lastWeight = 0; ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_3829cae4d4f9
unity_docs
scripting
In Unity's 'Troubleshooting automatically generated lightmap UVs', what is 'Min Lightmap Resolution and Min Object Scale' and how does it work?
Placing UV charts too close together may cause cross-chart texel bleeding in the final lightmap. Placing charts too far away from each other wastes memory. The ideal packing margin of an object depends on how many lightmap texels are allotted to it. The number of texels that Unity uses for a MeshRenderer depends on the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ab4e6f1138e9
unity_docs
rendering
Explain 'Introduction to 2D texture arrays' in Unity.
A texture array is a collection of 2D textures with the same size, format, and flags. The individual texture in the array are called slices or layers. In a shader , you can use an index to sample each slice. Texture arrays are useful for implementing custom terrain rendering systems or other special effects where you n...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d3fb857769d6
unity_docs
scripting
What is `ViewTool` in Unity? Explain its purpose and usage.
ViewTool enumeration Description Enum for Tools.viewTool. Properties Property Description None View tool is not selected. Orbit The orbit tool is selected. Pan The pan tool is selected. Zoom The zoom tool is selected. FPS The FPS tool is selected.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_518886b28cc0
unity_docs
rendering
Show me a Unity C# example demonstrating `Shader.Find`.
to use shader references instead of finding them by name. To make sure a shader is included into the game build, do either of: 1) reference it from some of the materials used in your Scene, 2) add it under "Always Included Shaders" list in ProjectSettings/Graphics or 3) put shader or something that references it (e.g. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7bebb6d0fe36
unity_docs
rendering
Give me an overview of the `Renderer` class in Unity.
Renderer class in UnityEngine / Inherits from: Component / Implemented in: UnityEngine.CoreModule Description General functionality for all renderers. A renderer is what makes an object appear on the screen. Use this class to access the renderer of any object, mesh or Particle System. Renderers can be disable...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8a7cb54adf2c
unity_docs
rendering
What is `Material.RevertAllPropertyOverrides` in Unity? Explain its purpose and usage.
Material.RevertAllPropertyOverrides Declaration public void RevertAllPropertyOverrides (); Description Removes all property overrides on this material. After reverting all Property overrides, the material will be in the same state as it's direct parent. Note that this method is Editor-only. Additional resource...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ee919df817a5
unity_docs
editor
What is `Handles.yAxisColor` in Unity? Explain its purpose and usage.
Handles.yAxisColor public static Color yAxisColor ; Description Color to use for handles that manipulates the Y coordinate of something. This is for used for example in the position, rotation, and scale gizmos, as well as in the Scene View gizmo.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_87b7f43e87bf
unity_docs
scripting
What is `UIElements.TextOverflow` in Unity? Explain its purpose and usage.
TextOverflow enumeration Description Specifies how the text Element treats hidden overflow content. Properties Property Description Clip The Element clips overflow content and hides it. This is the default value. Ellipsis The Element clips overflow content and hides it, but displays an ellipsis ("..."...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.