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_207a23b31e56
unity_docs
performance
What is `Profiling.RawFrameDataView.GetSampleTimeMs` in Unity? Explain its purpose and usage.
RawFrameDataView.GetSampleTimeMs Declaration public float GetSampleTimeMs (int sampleIndex ); Parameters Parameter Description sampleIndex Index of the Profiler sample. Returns float Returns sample duration in milliseconds. Description Gets the duration of sample. The amount of time is expressed in m...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_aed6a9ce2e15
unity_docs
rendering
What is `Rendering.LightProbeUsage` in Unity? Explain its purpose and usage.
LightProbeUsage enumeration Description Light probe interpolation type. Additional resources: Light Probes , Light Probe Proxy Volume . Properties Property Description Off Light Probes are not used. The Scene's ambient probe is provided to the shader. BlendProbes Simple light probe interpolation is used. U...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_72e5797988db
unity_docs
scripting
What is `PlayerPrefs.GetFloat` in Unity? Explain its purpose and usage.
PlayerPrefs.GetFloat Declaration public static float GetFloat (string key ); Parameters Parameter Description key The key used to retrieve the corresponding float value in the player preferences. Returns float The float value corresponding to the given key . Returns 0,0f if no float value is found for...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0a900b4ebe85
unity_docs
rendering
What is `Search.SearchAction.ctor` in Unity? Explain its purpose and usage.
SearchAction Constructor Declaration public SearchAction (string providerId , string id , GUIContent content ); Declaration public SearchAction (string providerId , string id , GUIContent content , Action<SearchItem[]> handler ); Declaration public SearchAction (string providerId , string id , ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_c2852abd5b91
github
scripting
Write a Unity C# XR/VR script for Passthrough Manager
```csharp namespace Tilia.CameraRigs.OpenXR { using System.Collections; using UnityEngine; using UnityEngine.XR.ARFoundation; /// <summary> /// The base class for a Passthrough Manager /// </summary> public abstract class BasePassthroughManager : MonoBehaviour { /// <summary> ...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_man_dd3c743bd002
unity_docs
scripting
In Unity's 'Yield instruction reference', what is 'UnityTest yield instructions' and how does it work?
Unity Test Framework tests marked with the [UnityTest] attribute run as coroutines. The Test Framework package adds support for additional yield instructions to control the Unity Editor from tests and provides the possibility to define custom yield instructions. Instruction Description EnterPlayMode Creates a yield ins...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b9d9713cec92
unity_docs
rendering
What is `ModelImporter.keepQuads` in Unity? Explain its purpose and usage.
ModelImporter.keepQuads public bool keepQuads ; Description If this is true, any quad faces that exist in the mesh data before it is imported are kept as quads instead of being split into two triangles, for the purposes of tessellation. Set this to false to disable this behavior.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d789a55570bb
unity_docs
rendering
What is `Tilemaps.TilemapRenderer.SortOrder.TopLeft` in Unity? Explain its purpose and usage.
TilemapRenderer.SortOrder.TopLeft Description Sorts tiles for rendering starting from the tile with the lowest X and the highest Y cell positions. The TilemapRenderer will iterate through tiles by the next higher X value first before tiles with a lower Y value.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_45147b2c254d
unity_docs
scripting
What is `Build.Player.ScriptCompilationOptions` in Unity? Explain its purpose and usage.
ScriptCompilationOptions enumeration Description Script compilation options. Note: this enum and its values exist to provide low-level support for the Scriptable Build Pipeline package. This is intended for internal use only; use the Scriptable Build Pipeline package to implement a fully featured build pipelin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_fc4a58965cf8_doc_1
github
scripting
What does `OrderedDictionary` do in this Unity script? Explain its purpose and signature.
Initializes a new instance of the class. Signature: ```csharp public OrderedDictionary() : base(typeof(TKey), typeof(TValue)) ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_e3deb926f7b1
unity_docs
physics
What is `PhysicsVisualizationSettings.SetShowTriggers` in Unity? Explain its purpose and usage.
PhysicsVisualizationSettings.SetShowTriggers Declaration public static void SetShowTriggers (bool show ); Description Should the triggers be considered by the display filter. Additional resources: Collider.isTrigger .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a6c69e78034b
unity_docs
scripting
What is `Rigidbody2D.angularDamping` in Unity? Explain its purpose and usage.
Rigidbody2D.angularDamping public float angularDamping ; Description The angular damping of the Rigidbody2D angular velocity. Damping can be used to reduce the Rigidbody2D.angularVelocity (angular speed) of a Rigidbody2D over time. Zero indicates that no damping should be used whereas higher values increase...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_09937a033f1c
unity_docs
animation
What is `Animations.PropertyStreamHandle.GetFloat` in Unity? Explain its purpose and usage.
PropertyStreamHandle.GetFloat Declaration public float GetFloat ( Animations.AnimationStream stream ); Parameters Parameter Description stream The AnimationStream that holds the animated values. Returns float The float property value. Description Gets the float property value from a stream. If th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_330ba31f3e1b
unity_docs
input
What is `TouchScreenKeyboard.InputFieldAppearance` in Unity? Explain its purpose and usage.
InputFieldAppearance enumeration Description Options to define the visibility status of the on-screen keyboard's input field. TouchScreenKeyboard.inputFieldAppearance uses values of this enum to indicate visibility status of the input field. Properties Property Description Customizable Customize the visibilit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f3357cf8987e
unity_docs
rendering
What is `CustomRenderTextureManager.GetAllCustomRenderTextures` in Unity? Explain its purpose and usage.
CustomRenderTextureManager.GetAllCustomRenderTextures Declaration public static void GetAllCustomRenderTextures (List<CustomRenderTexture> currentCustomRenderTextures ); Description Populate the list in parameter with all currently loaded custom render textures.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_84f725109f86
unity_docs
scripting
What is `Search.ParseResult_1.ctor` in Unity? Explain its purpose and usage.
ParseResult<T0> Constructor Declaration public ParseResult<T0> (bool success , T value ); Parameters Parameter Description success Flag indicating if the parsing succeeded or not. value The parsing result. Description Create a ParseResult.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c288143a4e8f
unity_docs
rendering
What is `MaterialEditor.EmissionEnabledProperty` in Unity? Explain its purpose and usage.
MaterialEditor.EmissionEnabledProperty Declaration public bool EmissionEnabledProperty (); Returns bool Returns true if enabled, or false if disabled or mixed due to multi-editing. Description This function will draw the UI for controlling whether emission is enabled or not on a material.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_af8908ec4aba
unity_docs
performance
What is `FrameTiming.cpuMainThreadFrameTime` in Unity? Explain its purpose and usage.
FrameTiming.cpuMainThreadFrameTime public double cpuMainThreadFrameTime ; Description Total time between start of the frame and when the main thread finished the job, in ms. This metric is also exposed as CPU Main Thread Frame Time profiler counter. Additional resources: Get frame timing data .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_39fe030d7ce2
unity_docs
physics
What is `Physics2D.queriesStartInColliders` in Unity? Explain its purpose and usage.
Physics2D.queriesStartInColliders public static bool queriesStartInColliders ; Description Set the raycasts or linecasts that start inside Colliders to detect or not detect those Colliders. When performing a ray/line cast, the start point can begin inside a Collider. When this occurs, this property controls whe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7442bf50f788
unity_docs
physics
What is `PhysicsVisualizationSettings.GetShowSleepingBodies` in Unity? Explain its purpose and usage.
PhysicsVisualizationSettings.GetShowSleepingBodies Declaration public static bool GetShowSleepingBodies (); Description Should the sleeping Rigidbodies be considered by the display filter. Rigidbody.IsSleeping .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c71a0dc627b5
unity_docs
scripting
What is `Unity.Collections.LowLevel.Unsafe.UnsafeUtility.FreeTracked` in Unity? Explain its purpose and usage.
UnsafeUtility.FreeTracked Declaration public static void FreeTracked (void* memory , Unity.Collections.Allocator allocator ); Parameters Parameter Description memory Memory pointer. allocator Allocator. Description Free memory with leak tracking.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f29a406e8dae
unity_docs
rendering
In Unity's 'Editing scene templates', what is 'Thumbnail' and how does it work?
The Thumbnail section contains options for creating a preview image for the template. Property: Description: Badge Specifies a Texture asset to use as a badge thumbnail for this template. You can use any Texture asset in the project. Badge thumbnails are commonly used as a quick way to identify what type of scene this ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_062bd7d61ed9
unity_docs
ui
Show me a Unity C# example demonstrating `UIElements.Clickable.clicked`.
Clickable.clicked Description Callback triggered when the target element is clicked. Encapsulates a method that has no parameters and does not return a value. ```csharp using UnityEngine; using UnityEditor; using UnityEngine.UIElements;public class ButtonExample : EditorWindow { [MenuItem("Window/Button Exa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3ac651128164
unity_docs
xr
What is `SubsystemManager.reloadSubsytemsStarted` in Unity? Explain its purpose and usage.
SubsystemManager.reloadSubsytemsStarted Description Called from SubsystemManager before reloading all XR SDK Provider packaged subsystems. When the Editor starts or when packages are installed or removed, the SubsystemManager searches the packages and loads all XR SDK packages that it finds. Handling this event...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_28666383775f
unity_docs
performance
Show me a Unity C# example demonstrating `Profiling.Profiler.EmitFrameMetaData`.
Parameters Parameter Description id Module identifier. Used to distinguish metadata streams between different plugins, packages or modules. tag Data stream index. data Binary data. Description Write metadata associated with the current frame to the Profiler stream. Use EmitFrameMetaData to write arbitrary ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_be70f5671fb5
unity_docs
editor
What is `EditorGUILayout.LongField` in Unity? Explain its purpose and usage.
EditorGUILayout.LongField Declaration public static long LongField (long value , params GUILayoutOption[] options ); Declaration public static long LongField (long value , GUIStyle style , params GUILayoutOption[] options ); Declaration public static long LongField (string label , long value , param...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_93e4606f2f71
unity_docs
editor
What are the parameters of `QualitySettings.GetAllRenderPipelineAssetsForPlatform` in Unity?
Description [Editor Only] Fills the given list with all the Render Pipeline Assets on any Quality Level for the given platform. Without filtering by Render Pipeline Asset type or null. ```csharp public RenderPipelineAsset[] GetAllRenderPipelineAssets(BuildTarget platform) { var activeBuildTargetGroup = BuildPipelin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_11504358d876
unity_docs
editor
What is `Device.SystemInfo.maxComputeBufferInputsFragment` in Unity? Explain its purpose and usage.
SystemInfo.maxComputeBufferInputsFragment public static int maxComputeBufferInputsFragment ; Description This has the same functionality as SystemInfo.maxComputeBufferInputsFragment and also mimics platform-specific behavior in the Unity Editor.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e55b6e92fa87
unity_docs
scripting
Give me an overview of the `PropertyAttribute` class in Unity.
PropertyAttribute class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Base class to derive custom property attributes from. Use this to create custom attributes for script variables. A custom attributes can be hooked up with a custom PropertyDrawer class to control how a script variable ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1a67e93d5fb6
unity_docs
rendering
In Unity's 'Console window reference', what is 'Console toolbar options' and how does it work?
The toolbar of the Console window has options for controlling how to display messages, and for searching and filtering messages. Option : Function : Clear Removes any messages generated from your code but retains compiler errors. Opens a dropdown menu with clearing options. Clear On Play Clears the Console automaticall...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8cb486bbaf55
unity_docs
math
What is `AndroidJNI.GetIntArrayElement` in Unity? Explain its purpose and usage.
AndroidJNI.GetIntArrayElement Declaration public static int GetIntArrayElement (IntPtr array , int index ); Description Returns the value of one element of a primitive array. This function is a special case of GetIntArrayRegion(), called with region size set to 1. 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_ef2e03cbb7bb
unity_docs
networking
What is `Android.AndroidConfiguration.screenLayoutSize` in Unity? Explain its purpose and usage.
AndroidConfiguration.screenLayoutSize public Android.AndroidScreenLayoutSize screenLayoutSize ; Description Mirrors the Android property screenLayout based on the SCREENLAYOUT_SIZE_MASK value. For information about this property, refer to the Android developer documentation on screenLayout and SCREENLA...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_573a10d67caa
unity_docs
rendering
In Unity's 'Transparent Cutout Bumped Specular', what is 'Transparent Cutout Properties' and how does it work?
Note. Unity 5 introduced the Standard Shader which replaces this shader. Cutout shader is an alternative way of displaying transparent objects. Differences between Cutout and regular Transparent shaders are: This shader cannot have partially transparent areas. Everything will be either fully opaque or fully transparent...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e71b18434ff0
unity_docs
scripting
Show me a Unity C# example demonstrating `WindZoneMode.Directional`.
WindZoneMode.Directional Description Wind zone affects the entire Scene in one direction. ```csharp // Creates a Directional Wind Zone that blows wind up. using UnityEngine;public class ExampleScript : MonoBehaviour { void Start() { var wind = gameObject.AddComponent<WindZone>(); wind.mode = WindZoneMode.Direct...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f15a10f4d428
unity_docs
rendering
Show me a Unity C# example demonstrating `Shader.isSupported`.
Shader.isSupported public bool isSupported ; Description Can this shader run on the end-users graphics card? (Read Only) Returns true if the shader itself or any fallbacks setup in the shader are supported. Most often you use this when implementing special effects. ```csharp using UnityEngine;public class Exa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e8e7921637b3
unity_docs
scripting
Show me a Unity C# example demonstrating `Vector4.operator_divide`.
Vector4.operator / public static Vector4 operator / ( Vector4 a , float d ); Description Divides a vector by a number. Divides each component of a by a number d . ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() { //Prints (0.5, 1.0, 1.5, 2.5) print(new Vector4(1, 2, ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_136e9e21cbfa
unity_docs
editor
Show me a Unity C# example demonstrating `Rendering.SupportedOnRenderPipelineAttribute`.
enderPipeline(typeof(HDRenderPipelineAsset)) . [SupportedOnRenderPipeline] works only with some attributes - for example, CustomEditor . You can use [SupportedOnRenderPipeline] without an argument if you want all Scriptable Render Pipeline Assets to make the class active. The following example makes the Beha...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2745a09c8f25
unity_docs
rendering
What is `TextureImporterRGBMMode` in Unity? Explain its purpose and usage.
TextureImporterRGBMMode enumeration Description RGBM encoding mode for HDR textures in TextureImporter . HDR texture data (i.e. coming from .exr or .hdr files) can be encoded into RGBM format by Unity. This setting controls how the encoding is done. Default is "Auto", which means do RGBM encoding when source data...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_fb6c5bf60ed3
unity_docs
rendering
Explain 'Prebuilt shaders render pipeline compatibility reference' in Unity.
Shaders Universal Render Pipeline (URP) High Definition Render Pipeline (HDRP) Custom SRP Built-in Render Pipeline URP shaders Yes No No No HDRP shaders No Yes No No Standard Shader No Can convert Standard Shader to equivalent on import No Can convert Standard Shader to equivalent on import No Yes Standard Particle Sha...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_35af4a82a7f1
github
scripting
Write a Unity C# XR/VR script for AR Feathered Plane Mesh Visualizer
```csharp using System.Collections.Generic; using UnityEngine; using UnityEngine.XR.ARFoundation; namespace UnityEngine.XR.ARFoundation.Samples { [RequireComponent(typeof(ARPlaneMeshVisualizer), typeof(MeshRenderer), typeof(ARPlane))] public class ARFeatheredPlaneMeshVisualizer : MonoBehaviour { ...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_b728ad8a2ed2
unity_docs
rendering
What is `Shader.GetPropertyTextureDefaultName` in Unity? Explain its purpose and usage.
Shader.GetPropertyTextureDefaultName Declaration public string GetPropertyTextureDefaultName (int propertyIndex ); Parameters Parameter Description propertyIndex The index of the shader property. Description Returns the default Texture name of a Texture shader property at the specified index. If Unity ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b3e55b0d2c6b
unity_docs
rendering
What is `LightingSettings.ao` in Unity? Explain its purpose and usage.
LightingSettings.ao public bool ao ; Description Whether to apply ambient occlusion to lightmaps. (Editor only). Ambient occlusion (AO) is an effect that approximates how much ambient light a given point on a surface receives. When you apply AO to a Scene, areas of concavity - such as creases, holes and adjace...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6106d9ed0ef5
unity_docs
editor
Show me a Unity C# example demonstrating `Handles.DrawAAConvexPolygon`.
Handles.DrawAAConvexPolygon Declaration public static void DrawAAConvexPolygon (params Vector3[] points ); Parameters Parameter Description points List of points describing the convex polygon. Description Draw anti-aliased convex polygon specified with point array. ```csharp using UnityEditor; using Unity...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6e41cdc1f8ab
unity_docs
ui
What is `Overlays.Overlay` in Unity? Explain its purpose and usage.
Overlay class in UnityEditor.Overlays Description Overlays are persistent and customizable panels and toolbars that are available within Editor Windows. Use Overlays to expose actions and tool options in a convenient and user-controllable way. This is the base class that all overlays inherit from. To create an ov...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3eef56b94cc8
unity_docs
scripting
What is `UIElements.NavigationEventBase_1.commandKey` in Unity? Explain its purpose and usage.
NavigationEventBase<T0>.commandKey public bool commandKey ; Description Gets a boolean value that indicates whether the Windows/Cmd key is pressed. True means the Windows/Cmd key is pressed. False means it isn't.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_3f60a6e382e1
github
scripting
Write a Unity C# MonoBehaviour script called System Manager Observer
```csharp using TinyECS.Interfaces; using UnityEngine; namespace TinyECSUnityIntegration.Impls { /// <summary> /// class SystemManagerObserver /// /// The class is used for integration of TinyECS with Unity3D and stores a reference to some /// ISystemManager implementation /// </summary> ...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_aef03acc7935
unity_docs
physics
What is `ParticleSystemGravitySource` in Unity? Explain its purpose and usage.
ParticleSystemGravitySource enumeration Description Options for which physics system to use the gravity setting from. Properties Property Description Physics3D Use gravity from the 3D physics system. Physics2D Use gravity from the 2D physics system.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c01bf4638dcc
unity_docs
physics
What is `ArticulationBody.automaticCenterOfMass` in Unity? Explain its purpose and usage.
ArticulationBody.automaticCenterOfMass public bool automaticCenterOfMass ; Description Whether or not to calculate the center of mass automatically. If enabled, the center of mass is calculated automatically based on the settings of attached Collider s. If no colliders are present, the center of mass has a de...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_753f87c0f9c3
unity_docs
scripting
Show me a Unity C# example demonstrating `KeyCode.D`.
KeyCode.D Description 'd' key. ```csharp //Attach this to a GameObject //This script tells when the D arrow key is pressed down and when it is released using UnityEngine;public class Example : MonoBehaviour { void Update() { //Detect when the D arrow key is pressed down if (Input.GetKeyDown(KeyCode.D)) Debug.L...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5737a978b6c2
unity_docs
scripting
What is `Terrain.detailObjectDensity` in Unity? Explain its purpose and usage.
Terrain.detailObjectDensity public float detailObjectDensity ; Description Density of detail objects. This number goes from 0.0 to 1.0, with 1.0 being the original density, and lower numbers resulting in less detail objects being rendered. Additional resources: detailObjectDistance . ```csharp using UnityEngi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7cc67ae8f7a0
unity_docs
animation
What is `ModelImporterClipAnimation.keepOriginalPositionXZ` in Unity? Explain its purpose and usage.
ModelImporterClipAnimation.keepOriginalPositionXZ public bool keepOriginalPositionXZ ; Description If true, uses the root horizontal position from the source animation without modification. If false, Unity derives and applies root horizontal motion based on the clip's import settings.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e9bd1d25e07e
unity_docs
physics
What is `MonoBehaviour.InvokeRepeating` in Unity? Explain its purpose and usage.
MonoBehaviour.InvokeRepeating Declaration public void InvokeRepeating (string methodName , float time , float repeatRate ); Parameters Parameter Description methodName The name of a method to invoke. time Time to wait in seconds before the first invocation. repeatRate Interval in seconds between metho...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_93b3614d381a
unity_docs
scripting
What is `Search.SearchProvider.filterId` in Unity? Explain its purpose and usage.
SearchProvider.filterId public string filterId ; Description Text token used to "filter" by search provider (ex: "me:", "p:", "s:"). Note that it is mandatory to use the filter for an explicit provider (see SearchProvider.isExplicitProvider for an example).
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_78cd31bd3b63
unity_docs
input
What is `KeyCode.Mouse3` in Unity? Explain its purpose and usage.
KeyCode.Mouse3 Description Additional (fourth) mouse button. Use this for detecting mouse button presses. The “3” mouse button is the fourth button on the user’s mouse if any additional buttons exist, for example, extra volume buttons. Unity defines this as the "3" mouse button, as the mouse button numbering begins...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_c24ffea30041_doc_1
github
scripting
What does `NullComparer` do in this Unity script? Explain its purpose and signature.
A value against which any can be compared to determine whether or not it is or an which has been destroyed.using static Sisus.NullExtensions;public class EventListener : MonoBehaviour{IEvent}, IEventListener{ private IEvent trigger; protected override void Init(IEventBroadcaster trigger) { this.trigger = trigger; } ...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_9b7d50120976
unity_docs
rendering
What is `LightingSettings.filteringAtrousPositionSigmaAO` in Unity? Explain its purpose and usage.
LightingSettings.filteringAtrousPositionSigmaAO public float filteringAtrousPositionSigmaAO ; Description Specifies the threshold the Progressive Lightmapper uses to filter direct light stored in the lightmap when using the A-Trous filter. (Editor only). The range is 0 through 2. The default value is 0.5. A hi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_140f3f42ed38
github
scripting
Write a Unity C# UI script for Use Sim Time
```csharp using System.Collections; using System.Collections.Generic; using UnityEngine; using Unity.Robotics.ROSTCPConnector; public class UseSimTime : MonoBehaviour { private TMPro.TextMeshProUGUI label; // Start is called before the first frame update void Start() { bool useSimTime = Player...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_e1a0584c8efa
unity_docs
editor
What is `TrueTypeFontImporter.fontReferences` in Unity? Explain its purpose and usage.
TrueTypeFontImporter.fontReferences public Font[] fontReferences ; Description References to other fonts to be used looking for fallbacks. This is a list of references to other Font assets in your project, which will be used when looking for the fallback fonts listed in fontNames when trying to render a charact...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9a113a7877e0
unity_docs
scripting
What is `Rigidbody.OnCollisionEnter` in Unity? Explain its purpose and usage.
Rigidbody.OnCollisionEnter(Collision) Description OnCollisionEnter is called when this collider/rigidbody has begun touching another rigidbody/collider. In contrast to OnTriggerEnter, OnCollisionEnter is passed the Collision class and not a Collider. The Collision class contains information about contact point...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ba71959d3c7c
unity_docs
ui
Explain 'Visual elements reference' in Unity.
The following tables outline the visual elements available in the UnityEngine.UIElements and UnityEditor.UIElements namespaces. ## Base elements Element Namespace C# class BindableElement UnityEngine.UIElements UnityEngine.UIElements.BindableElement VisualElement UnityEngine.UIElements UnityEngine.UIElements.VisualEl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_50f58053924e
unity_docs
editor
What is `iOS.Xcode.PBXProject.RemoveBuildConfig` in Unity? Explain its purpose and usage.
PBXProject.RemoveBuildConfig Declaration public void RemoveBuildConfig (string name ); Parameters Parameter Description name The name of the build configuration. Description Removes all build configurations with the given name from all targets in the project. The number and names of the build configuratio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a38d522a7b07
unity_docs
editor
In Unity's 'Troubleshooting the Linux Editor issues', what is 'Unity Editor crashes with Pipe error ! message' and how does it work?
Opening projects with large number of assets crashes the Editor and logs a Pipe error ! message. The error message appears in the terminal if you opened the Editor via the terminal, otherwise it’s logged in the Editor.log file located in ~/.config/unity3d directory.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_928ae1e19c5b
unity_docs
rendering
What is `ShaderKeywordFilter.TagConstraintAttribute.ctor` in Unity? Explain its purpose and usage.
TagConstraintAttribute Constructor Declaration public TagConstraintAttribute (bool negate , params string[] tags ); Parameters Parameter Description negate Set to true to enable filter attributes when shader tags do not match any of the tags . tags The array of tag name-value pairs to match to. Descri...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9be81438638d
unity_docs
animation
What is `Playables.FrameData.deltaTime` in Unity? Explain its purpose and usage.
FrameData.deltaTime public float deltaTime ; Description The interval between this frame and the preceding frame. The interval is unscaled and expressed in seconds. To time-scale the interval, multiple the interval by FrameData.effectiveSpeed . ```csharp //Attach this script to a GameObject that has an Ani...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_24321b3f88f0
unity_docs
rendering
What are the parameters of `Resources.Load` in Unity?
Returns T An object of the requested generic parameter type. Description Loads the asset of the requested type stored at path in a Resources folder using a generic parameter type filter of type T . This method returns the asset at path if it can be found and if its type matches the requested generic parameter type, oth...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a5726e2cd31b
unity_docs
math
What is `Matrix4x4.GetRow` in Unity? Explain its purpose and usage.
Matrix4x4.GetRow Declaration public Vector4 GetRow (int index ); Description Returns a row of the matrix. The i-th row is returned as a Vector4 . i must be from 0 to 3 inclusive. Additional resources: SetRow .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_27b4fe13e3e8
unity_docs
rendering
Give me an overview of the `BuildAssetBundleOptions` class in Unity.
BuildAssetBundleOptions enumeration Description Asset Bundle building options. These flags allows you to configure options when calling BuildPipeline.BuildAssetBundles . Additional resources: AssetBundle , BuildPipeline.BuildAssetBundles ```csharp //Create a folder (right click in the Assets folder and go to C...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1a42306e622d
unity_docs
rendering
Show me a Unity C# example demonstrating `ParticleSystemRenderer.maskInteraction`.
ult, particles do not interact with SpriteMasks and are visible regardless of whether you assign a SpriteMask or not. You can make the ParticleSystemRenderer visible either inside or outside a SpriteMask. To do the former, set this to SpriteMaskInteraction.VisibleInsideMask . To do the latter, set this to SpriteMaskI...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d3ec9b31e031
unity_docs
rendering
What is `Terrain.realtimeLightmapScaleOffset` in Unity? Explain its purpose and usage.
Terrain.realtimeLightmapScaleOffset public Vector4 realtimeLightmapScaleOffset ; Description The UV scale & offset used for a realtime lightmap. Additional resources: Renderer.realtimeLightmapScaleOffset .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ecec98d469c3
unity_docs
scripting
What is `ThreadPriority` in Unity? Explain its purpose and usage.
ThreadPriority enumeration Description Priority of a thread. Lower priority means a background operation will run less often and will take up less time, but will progress more slowly. Additional resources: Application.backgroundLoadingPriority . Properties Property Description Low Lowest thread priority. Bel...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_88d0544568e4
unity_docs
scripting
Show me a Unity C# example demonstrating `Rendering.SplashScreen.Stop`.
SplashScreen.Stop Declaration public static void Stop ( Rendering.SplashScreen.StopBehavior stopBehavior ); Description Stop the SplashScreen rendering. ```csharp using System.Collections; using UnityEngine; using UnityEngine.Rendering;// This example shows how the SplashScreen can be canceled early via the u...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_52909938af3a
unity_docs
scripting
In Unity's 'Rotation Constraint component', what is 'Constraint Settings' and how does it work?
Property: Description Lock Enable to let the Constraint rotate the GameObject. Disable this property to edit the rotation of this GameObject. You can also edit the Rotation At Rest and Rotation Offset properties. If Is Active is enabled, the Constraint updates the Rotation At Rest or Rotation Offset properties for you ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fbb36e5e619c
unity_docs
editor
What is `EditorUserSettings.idleImportWorkerShutdownDelayMilliseconds` in Unity? Explain its purpose and usage.
EditorUserSettings.idleImportWorkerShutdownDelayMilliseconds public static int idleImportWorkerShutdownDelayMilliseconds ; Description Time in milliseconds that the Editor waits before shutting down idle import workers. The Editor shuts down any import workers that are idle for any time longer than the specifie...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fc60a9d13176
unity_docs
input
Show me a Unity C# example demonstrating `Compass.timestamp`.
Compass.timestamp public double timestamp ; Description Indicates the time elapsed since the compass heading was last updated. (Read Only) Android : The time elapsed is represented in seconds since the device was last turned on. iOS : The time elapsed is represented in seconds since the Unix epoch January 1, 19...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_77232c48418c
unity_docs
scripting
What is `Video.VideoPlayer.playbackSpeed` in Unity? Explain its purpose and usage.
VideoPlayer.playbackSpeed public float playbackSpeed ; Description Factor by which the basic playback rate will be multiplied. Only works if VideoPlayer.canSetPlaybackSpeed is true . Setting this to 2.0 will play the clip twice as fast as its normal speed. Support for negative values is platform dependent.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2f4beb0e49b4
unity_docs
editor
What is `EditorGUI.LongField` in Unity? Explain its purpose and usage.
EditorGUI.LongField Declaration public static long LongField ( Rect position , string label , long value , GUIStyle style = EditorStyles.numberField); Declaration public static long LongField ( Rect position , GUIContent label , long value , GUIStyle style = EditorStyles.numberField); Parame...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3982b24db6a3
unity_docs
scripting
What is `SceneManagement.Stage.CreateHeaderContent` in Unity? Explain its purpose and usage.
Stage.CreateHeaderContent Declaration protected GUIContent CreateHeaderContent (); Returns GUIContent The header content for this Stage. Description Creates the header content for this Stage. Both the Hierarchy window header and Scene view breadcrumb bar use this content. Classes inheriting from Stage s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4a3f74da2b59
unity_docs
scripting
What is `Device.Application.streamingAssetsPath` in Unity? Explain its purpose and usage.
Application.streamingAssetsPath public static string streamingAssetsPath ; Description This has the same functionality as Application.streamingAssetsPath . At the moment, the Device Simulator doesn't support simulation of this property.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dbdcc1107057
unity_docs
scripting
What is `VideoResizeMode` in Unity? Explain its purpose and usage.
VideoResizeMode enumeration Description How the video clip's images will be resized during transcoding. When choosing a mode that may result in a change in aspect ratio, use the VideoClipImporter.keepRatio property to control the addition of padding. Properties Property Description OriginalSize Same width and ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e8655df5fffb
unity_docs
scripting
What is `UIElements.DragAndDropEventBase_1` in Unity? Explain its purpose and usage.
DragAndDropEventBase<T0> class in UnityEngine.UIElements / Inherits from: UIElements.MouseEventBase_1 / Implemented in: UnityEngine.UIElementsModule Implements interfaces: IDragAndDropEvent Description Base class for drag and drop events. Inherited Members Properties Property Description bubbles Retur...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_238a6c02e42f
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormat.R16G16B16_UNorm` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormat.R16G16B16_UNorm Description A three-component, 48-bit unsigned normalized format that has a 16-bit R component in bytes 0..1, a 16-bit G component in bytes 2..3, and a 16-bit B component in bytes 4..5.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_524a49d6b469
unity_docs
rendering
What is `DrawCameraMode.GIContributorsReceivers` in Unity? Explain its purpose and usage.
DrawCameraMode.GIContributorsReceivers Description Draw Mesh Renderers and Terrains in different colors to show their StaticEditorFlags.ContributeGI / ReceiveGI properties. With default colors: Yellow means 'ContributeGI' is off. Blue means that 'ContributeGI' is on and the object receives GI from lightmaps. A...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_08ecbec5d4e7
unity_docs
ui
What is `UIElements.RadioButtonGroup.choices` in Unity? Explain its purpose and usage.
RadioButtonGroup.choices public IEnumerable<string> choices ; Description The list of available choices in the group. Writing to this property removes existing RadioButton elements, except those added explicitly to hierarchy, and re-creates them to display the new list.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0c82076910c4
unity_docs
input
What is `XR.InputDeviceCharacteristics.TrackedDevice` in Unity? Explain its purpose and usage.
InputDeviceCharacteristics.TrackedDevice Description The InputDevice provides 3DOF or 6DOF tracking data. Devices of this type have their tracking data reported through UnityEngine.XR.InputTracking.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6582a534f265
unity_docs
ui
Show me a Unity C# example demonstrating `GUISkin.button`.
GUISkin.button public GUIStyle button ; Description Style used by default for GUI.Button controls. ```csharp using UnityEngine;public class Example : MonoBehaviour { // Modifies only the button style of the current GUISkin GUIStyle style; void OnGUI() { GUI.skin.box = style; GUILayout.Button("This is a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_921d47299ba6
unity_docs
rendering
What is `Texture2DArray.GetPixels` in Unity? Explain its purpose and usage.
Texture2DArray.GetPixels Declaration public Color[] GetPixels (int arrayElement , int miplevel ); Declaration public Color[] GetPixels (int arrayElement ); Parameters Parameter Description arrayElement The array slice to read pixel data from. miplevel The mipmap level to get. The range is 0 throug...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_efed0326fd06
unity_docs
animation
What is `Animations.NotKeyableAttribute` in Unity? Explain its purpose and usage.
NotKeyableAttribute class in UnityEngine.Animations / Implemented in: UnityEngine.AnimationModule Description Use this attribute in a script to mark a property as non-animatable. A non-animatable property cannot have key animation (not keyable). It does not appear as animatable in the Animation window and it ca...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a671d538ed42
unity_docs
rendering
What is `Material.GetPassName` in Unity? Explain its purpose and usage.
Material.GetPassName Declaration public string GetPassName (int pass ); Description Returns the name of the shader pass at index pass . Returns the name of the shader pass at index pass . It will return an empty string if the pass does not exist. Additional resources: FindPass .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7a25abd2788c
unity_docs
scripting
Explain 'Scripting with assets' in Unity.
Access different types of assets from your C# code to use or change them as part of your runtime application. Topic Description Stream assets directly into a build Use a StreamingAssets folder to make runtime-ready assets available directly to your built application, bypassing the regular project build process. Modify ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dd57922dd65d
unity_docs
rendering
What is `SortingLayer.GetLayerValueFromName` in Unity? Explain its purpose and usage.
SortingLayer.GetLayerValueFromName Declaration public static int GetLayerValueFromName (string name ); Parameters Parameter Description name The unique value of the sorting layer as returned by any renderer's sortingLayerID property. Returns int The final sorting value of the layer relative to other laye...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2070faf99a15
unity_docs
rendering
Explain 'Lighting reference' in Unity.
Explore lighting properties and settings, for example in the Lighting window, the Lighting Settings Asset, and Debug Draw Modes. Page Description Lighting window reference Explore the properties and settings in the Lighting window to customize lighting. Lighting Settings Asset Inspector window reference Explore the pro...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0bb1fd3ff854
unity_docs
input
Explain 'Android application entry points' in Unity.
The application entry point fundamentally defines how Android runs your application. It defines things such as the type of game loop thread your application runs on and the implementation of lifecycle events, input events, and the onscreen keyboard. It’s important to understand the purpose, benefits, and limitations of...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_28923bc77c02
unity_docs
editor
In Unity's 'Modify the Gradle project files for a Unity application', what is 'Android Project Configuration Manager' and how does it work?
The Android Project Configuration Manager is a set of classes that you can use to set up and modify custom Gradle project files in C#. You cannot directly modify the Gradle project files that the build process creates in the default unityLibrary and launcher modules. You can create custom modules inside these modules t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7f90906f7bc9
unity_docs
physics
What is `Unity.CodeEditor.CodeEditor.QuoteForProcessStart` in Unity? Explain its purpose and usage.
CodeEditor.QuoteForProcessStart Declaration public static string QuoteForProcessStart (string argument ); Description Quotes a string to pass to Process.Start as a single argument, and appends it to this string builder. On Windows systems, quote using the Win32 CommandLineToArgvW API scheme. Most Windows appli...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e70fdf8c4721
unity_docs
rendering
What is `MaterialEditor.RangeProperty` in Unity? Explain its purpose and usage.
MaterialEditor.RangeProperty Declaration public float RangeProperty ( MaterialProperty prop , string label ); Declaration public float RangeProperty ( Rect position , MaterialProperty prop , string label ); Parameters Parameter Description label Label for the property. prop The property to edit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c01795877b49
unity_docs
math
What is `ComputeShader.SetInt` in Unity? Explain its purpose and usage.
ComputeShader.SetInt Declaration public void SetInt (string name , int val ); Declaration public void SetInt (int nameID , int val ); Parameters Parameter Description name Variable name in shader code. nameID Property name ID, use Shader.PropertyToID to get it. val Value to set. Description S...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_cad5a531503a
github
scripting
Write a Unity Editor script for Project Detail Cache Data
```csharp // /*=============================================================================== // Copyright (C) 2020 PhantomsXR Ltd. All Rights Reserved. // // This file is part of the XR-MOD SDK. // // The XR-MOD SDK cannot be copied, distributed, or made available to // third-parties for commercial purposes without...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_f9885aca42d1
unity_docs
math
What is `Unity.Android.Gradle.PropertyStringArray` in Unity? Explain its purpose and usage.
PropertyStringArray class in Unity.Android.Gradle / Inherits from: Unity.Android.Gradle.Property_1 Description String array property type. Inherited Members Public Methods Method Description AddElementDependencies Adds a list of dependencies by ID to this element. AddElementDependency Adds a dependency to th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a3a0496f3d9e
unity_docs
ui
What is `PropertyDrawer.CreatePropertyGUI` in Unity? Explain its purpose and usage.
PropertyDrawer.CreatePropertyGUI Declaration public UIElements.VisualElement CreatePropertyGUI ( SerializedProperty property ); Parameters Parameter Description property The SerializedProperty to make the custom GUI for. Returns VisualElement The element containing the custom GUI. Description Crea...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8b30a65c8d82
unity_docs
scripting
What is `Rendering.SupportedRenderingFeatures.overridesRealtimeReflectionProbes` in Unity? Explain its purpose and usage.
SupportedRenderingFeatures.overridesRealtimeReflectionProbes public bool overridesRealtimeReflectionProbes ; Description Specifies whether the render pipeline overrides the real-time Reflection Probes settings in the Quality settings. If It does, the render pipeline does not need the built-in UI for real-time Re...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.