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_2299ffab0425
unity_docs
scripting
What is `AudioSettings.Reset` in Unity? Explain its purpose and usage.
AudioSettings.Reset Declaration public static bool Reset ( AudioConfiguration config ); Parameters Parameter Description config The new configuration to be used. Returns bool True if all settings could be successfully applied. Description Changes the device configuration and invokes the AudioSetti...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_866176942aae
unity_docs
editor
In Unity's 'Create a command file to set environment variables and open applications', what is 'Create a command file (Windows)' and how does it work?
These instructions create an executable file named launchUnityHub.cmd . Close the Unity Hub, if it’s running. Open a text editor such as Notepad. Enter the following text, adjusting as necessary: Include only the required environment variables, and set their values properly. Refer to Before you begin . Set the Hub path...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f12c0a1e8765
unity_docs
audio
Explain 'Vivox' in Unity.
com.unity.services.vivox ## Description Unity’s voice and text chat service for multiplayer communication offers voice chat and direct message text service with a managed hosted solution. Plug into your game and configure your project settings to add communications to your project immediately. Connect an unlimited nu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fb6571210bcd
unity_docs
rendering
What is `Rendering.RayTracingMeshInstanceConfig.materialProperties` in Unity? Explain its purpose and usage.
RayTracingMeshInstanceConfig.materialProperties public MaterialPropertyBlock materialProperties ; Description Additional Material properties to apply onto Material. Additional resources: RayTracingAccelerationStructure.UpdateInstancePropertyBlock .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_de2a9d117e7e
unity_docs
animation
What is `Animations.AnimatorStateMachine.RemoveEntryTransition` in Unity? Explain its purpose and usage.
AnimatorStateMachine.RemoveEntryTransition Declaration public bool RemoveEntryTransition ( Animations.AnimatorTransition transition ); Parameters Parameter Description transition The transition to remove. Description Utility function to remove an entry transition from the state machine. If the transition...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a50db1c36f39
unity_docs
editor
Show me a Unity C# example demonstrating `Selection.objects`.
Selection.objects public static Object[] objects ; Description The actual unfiltered selection from the Scene. All objects will be returned, including assets in projects. You can also assign objects to the selection. Additional resources: Selection.instanceIDs . Scriptable Wizard that lets you select GameObje...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e566e57771fd
unity_docs
editor
Explain 'Install Unity using the Hub' in Unity.
The Unity Hub is the best way to install the Unity Editor, manage your project, and access learning resources. To download the Hub, go to Download Unity . To learn how to install the Hub on different operating systems, refer to Install the Unity Hub .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dc25cda689d3
unity_docs
scripting
What is `ArticulationBody.useGravity` in Unity? Explain its purpose and usage.
ArticulationBody.useGravity public bool useGravity ; Description Controls whether gravity affects this articulation body. If you set this property to False, the articulation body will behave as if it was in outer space.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ee195d096069
unity_docs
rendering
What is `Rendering.LightShadowCasterCullingInfo.splitExclusionMask` in Unity? Explain its purpose and usage.
LightShadowCasterCullingInfo.splitExclusionMask public ushort splitExclusionMask ; Description A bitmask that represents the shadow splits in LightShadowCasterCullingInfo.splitRange Unity discards. The bitmask is 8 bits. A bit value of 1 means Unity doesn't render the shadow split, so the CPU can end the cull...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cee81e00a875
unity_docs
math
What is `Jobs.TransformAccess.GetPositionAndRotation` in Unity? Explain its purpose and usage.
TransformAccess.GetPositionAndRotation Declaration public void GetPositionAndRotation (out Vector3 position , out Quaternion rotation ); Description Gets the position and rotation of the transform in world space. When getting both the position and rotation of a transform, calling this method is more effic...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_aedf65f012e8
unity_docs
editor
In Unity's 'Creating assembly assets', what is 'Create a platform-specific assembly' and how does it work?
To create an assembly for a specific platform: Create an Assembly Definition . Select the new Assembly Definition to view its properties in the Inspector . In the Platforms section, check the Any Platform option and choose specific platforms to exclude or uncheck Any Platform and choose specific platforms to include. C...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ed16cba51a3b
unity_docs
scripting
What is `Experimental.GraphView.SelectionDropper.UnregisterCallbacksFromTarget` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. SelectionDropper.UnregisterCallbacksFromTarget Declaration protected void UnregisterCallbacksFromTarget (); Description Called to unregister event callbacks from the target element.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c657d3fcf062
unity_docs
ui
Show me a Unity C# example demonstrating `GUI.HorizontalSlider`.
the dragging area. If left out, the horizontalSlider style from the current GUISkin is used. thumb The GUIStyle to use for displaying draggable thumb. If left out, the horizontalSliderThumb style from the current GUISkin is used. Returns float The value that has been set by the user. Description A h...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3e77579c006c
unity_docs
scripting
What is `Rendering.CommandBuffer.SetExecutionFlags` in Unity? Explain its purpose and usage.
CommandBuffer.SetExecutionFlags Declaration public void SetExecutionFlags ( Rendering.CommandBufferExecutionFlags flags ); Parameters Parameter Description flags The flags to set. Description Set flags describing the intention for how the command buffer will be executed. Setting execution flags to any va...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_422fb0310246
unity_docs
scripting
Give me an overview of the `ObjectFactory` class in Unity.
ObjectFactory class in UnityEditor Description Use the DefaultObject to create a new UnityEngine.Object in the editor. The creation process handles Undo registration and applies default values from your project. Static Methods Method Description AddComponent Creates a new component and adds it to the specifie...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2b855e7f2f3a
unity_docs
scripting
What is `GridBrushBase.ChangeZPosition` in Unity? Explain its purpose and usage.
GridBrushBase.ChangeZPosition Declaration public void ChangeZPosition (int change ); Parameters Parameter Description change Modify the Z position of GridBrushBase by this value. Description Changes the Z position of the GridBrushBase .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_16e5745f1515
unity_docs
rendering
What is `ShaderKeywordFilter.GraphicsAPIConstraintAttribute.ctor` in Unity? Explain its purpose and usage.
GraphicsAPIConstraintAttribute Constructor Declaration public GraphicsAPIConstraintAttribute (bool negate , params GraphicsDeviceType[] graphicsDeviceTypes ); Parameters Parameter Description negate Set to true to enable filter attributes when the graphics API doesn't match any of the graphicsDeviceTypes...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_bf5cf5c5d6e1
github
scripting
Write a Unity C# XR/VR script for Poke Gesture Detector
```csharp using System.Collections.Generic; using UnityEngine.Events; #if XR_HANDS_1_1_OR_NEWER using UnityEngine.XR.Hands; #endif namespace UnityEngine.XR.Interaction.Toolkit.Samples.Hands { /// <summary> /// Behavior that provides events for when an <see cref="XRHand"/> starts and ends a poke gesture. The g...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_d5982f550d9c
unity_docs
input
What is `XR.InputFeatureUsage_1.operator_InputFeatureUsage` in Unity? Explain its purpose and usage.
InputFeatureUsage<T0>.InputFeatureUsage Parameters Parameter Description self The generic InputFeatureUsage_1 to conver into an InputFeatureUsage . Description Converts a generic InputFeatureUsage<T> into an InputFeatureUsage.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ab9ea5f54d73
unity_docs
scripting
Explain 'Create a new keystore' in Unity.
This page explains how to use the Keystore Manager window to create a new keystore. This is relevant if you want to publish your application, because you must provide a key from a keystore when you sign the application. To create a new keystore: Open the Keystore Manager window . In the top-left of the window, select K...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e5ac365b5971
unity_docs
scripting
What is `Experimental.GraphView.MiniMap` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. MiniMap class in UnityEditor.Experimental.GraphView / Inherits from: Experimental.GraphView.GraphElement Description MiniMap. Shows all nodes in the graph in a small window. Properties Property Description anchored True ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_66ffb669a4db
unity_docs
scripting
What is `AndroidJNI.GetStringField` in Unity? Explain its purpose and usage.
AndroidJNI.GetStringField Declaration public static string GetStringField (IntPtr obj , IntPtr fieldID ); Description Returns the value of an instance (nonstatic) field of an object. This is a convenience function that calls GetObjectField() with the same parameters, but creates a managed string from the resu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0815202c87cc
unity_docs
rendering
What is `Rendering.EditorCameraUtils.GetRenderersFilteringResults` in Unity? Explain its purpose and usage.
EditorCameraUtils.GetRenderersFilteringResults Declaration public static void GetRenderersFilteringResults (ReadOnlySpan<int> rendererIDs , Span<bool> results ); Parameters Parameter Description rendererIDs Span containing Renderers' instance IDs. results Output Span. If an element is true , it indicates...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_41cfcdf1ca7f
unity_docs
rendering
What is `Light.shadowNormalBias` in Unity? Explain its purpose and usage.
Light.shadowNormalBias public float shadowNormalBias ; Description Shadow mapping normal-based bias. Shadow caster surfaces are pushed inwards along their normals by this amount, to help prevent self-shadowing ("shadow acne") artifacts. Units of normal-based bias are expressed in terms of shadowmap texel size;...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_db14a27cf668
unity_docs
physics
Show me a Unity code example for 'Optimize raycasts and other physics queries'.
n the heap for their results. This allocation can contribute to garbage collection pauses, especially if they are called frequently. Instead, use the non-allocating counterparts of these queries that write their results into a pre-allocated array that you provide. Non-allocating counterparts can include: Physics.Raycas...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_21c399be8ba8
unity_docs
scripting
What is `SerializedProperty.exposedReferenceValue` in Unity? Explain its purpose and usage.
SerializedProperty.exposedReferenceValue public Object exposedReferenceValue ; Description A reference to another Object in the Scene. This reference is resolved in the context of the SerializedObject containing the SerializedProperty. Additional resources: ExposedReference<T0> , SerializedPropertyType.Expose...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_788d787d1763
unity_docs
rendering
What is `AssetDatabase.CreateFolder` in Unity? Explain its purpose and usage.
AssetDatabase.CreateFolder Declaration public static string CreateFolder (string parentFolder , string newFolderName ); Parameters Parameter Description parentFolder The path to the parent folder. Must start with "Assets/". newFolderName The name of the new folder. Returns string The GUID of the newly...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_12f13fd29215
unity_docs
rendering
Explain 'Standard Shader Material Inspector window reference for the Built-In Render Pipeline' in Unity.
The standard shader presents you with a list of Material Properties. These Properties vary slightly depending on whether you have chosen to work in the Metallic workflow mode or the Specular workflow mode. Most of the Properties are the same across both modes, and this page covers all the Properties for both modes. The...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_615fa6f3933c
unity_docs
scripting
What is `UIElements.UIDocument.parentUI` in Unity? Explain its purpose and usage.
UIDocument.parentUI public UIElements.UIDocument parentUI ; Description If the GameObject that this UIDocument component is attached to has a parent GameObject, and that parent GameObject also has a UIDocument component attached to it, this value is set to the parent GameObject's UIDocument component automa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_36143f2527f2
unity_docs
rendering
What is `UIElements.ICustomStyle.TryGetValue` in Unity? Explain its purpose and usage.
ICustomStyle.TryGetValue Declaration public bool TryGetValue (CustomStyleProperty<float> property , out float value ); Returns bool True if the property is found, false if not. Description Gets the value associated with the specified CustomStyleProperty_1. Declaration public bool TryGetValue (Custom...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2a75c61e3f0d
unity_docs
rendering
Show me a Unity C# example demonstrating `ParticleSystem.MainModule.startRotationXMultiplier`.
ParticleSystem.MainModule.startRotationXMultiplier public float startRotationXMultiplier ; Description The initial rotation multiplier of particles around the x-axis when the Particle System first spawns them. Changing this property is more efficient than accessing the entire curve, if you only want to change ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1a707f6dddb9
unity_docs
rendering
Explain 'Recommended Graphics settings to optimize your Web build' in Unity.
Use the following recommended Graphics settings to optimize your builds for the Unity Web platform. Find these settings under Edit > Project Settings > Graphics . For more information on each setting, refer to the details in Graphics . Setting Recommended setting Description Lightmap modes Automatic (default) Automatic...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ace08858c2e2
unity_docs
physics
What is `Physics.OverlapCapsule` in Unity? Explain its purpose and usage.
Physics.OverlapCapsule Declaration public static Collider[] OverlapCapsule ( Vector3 point0 , Vector3 point1 , float radius , int layerMask = AllLayers, QueryTriggerInteraction queryTriggerInteraction = QueryTriggerInteraction.UseGlobal); Parameters Parameter Description point0 The center of the s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8a72882d69e1
unity_docs
scripting
What is `SkinWeights.Unlimited` in Unity? Explain its purpose and usage.
SkinWeights.Unlimited Description An unlimited number of bones affect each vertex. The count is only limited by the number of bones per vertex in the Mesh, which can be adjusted in its Import Setttings. When used to access Mesh.GetBoneWeightBuffer the Bone Weight buffer will contain the following data: * Element ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9c905851f240
unity_docs
rendering
In Unity's 'GPU texture format fundamentals', what is 'Texture compression overview' and how does it work?
Bits per pixel (bpp) is the amount of storage required for a single texture pixel. Textures with a lower bpp value have a smaller size on disk and in memory. A lower bpp value also means that the GPU uses less memory bandwidth to read the texture pixels. GPU memory bandwidth can often be a frame rate bottleneck, and th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2e0e826d7d94
unity_docs
scripting
What is `Unity.Hierarchy.HierarchyPropertyString.ClearValue` in Unity? Explain its purpose and usage.
HierarchyPropertyString.ClearValue Declaration public void ClearValue (ref Unity.Hierarchy.HierarchyNode node ); Parameters Parameter Description node The hierarchy node. Description Removes the property value for a HierarchyNode .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7e36bb6b82f4
unity_docs
editor
Show me a Unity code example for 'Web native plug-ins for Emscripten'.
t (.bc ) With Emscripten versions before Emscripten 2.0, Unity recommends building Bitcode plug-ins (files of type.bc ). From Emscripten 2.0 onwards, Unity recommends to build Wasm Object File plug-ins that are Wasm object files of type.o , bundled into GNU archive files of type.a . You can determine the path to the ex...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_466e34ab3b8c
unity_docs
physics
What is `EditorApplication.UpdateMainWindowTitle` in Unity? Explain its purpose and usage.
EditorApplication.UpdateMainWindowTitle Declaration public static void UpdateMainWindowTitle (); Description Force Unity Editor to update its window title. This function is automatically called when a new scene is loaded or when the editor starts. A user having register a callback on EditorApplication.updateMai...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d3161b7ad8f2
unity_docs
rendering
What is `MaterialEditor.GetLeftAlignedFieldRect` in Unity? Explain its purpose and usage.
MaterialEditor.GetLeftAlignedFieldRect Declaration public static Rect GetLeftAlignedFieldRect ( Rect r ); Parameters Parameter Description r Field Rect. Returns Rect A sub rect of the input Rect. Description Utility method for GUI layouting ShaderGUI.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_54d126de3043
unity_docs
scripting
What is `UIElements.Experimental.StyleValues.backgroundColor` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. StyleValues.backgroundColor public Color backgroundColor ; Description Background color to paint in the element's box.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_9bc40c46e9ff_doc_2
github
scripting
What does `charAsset` do in this Unity script? Explain its purpose and signature.
/ -------------------------------------------------------------------------------------------/ Properties and Fields/ ------------------------------------------------------------------------------------------- Signature: ```csharp public CharacterAsset charAsset => _charAsset; ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_aec0402b678e
unity_docs
scripting
Show me a Unity C# example demonstrating `Color32.Index_operator`.
Color32.this[int] public byte this[int] ; Description Access the red (r), green (g), blue (b), and alpha (a) color components using [0], [1], [2], [3] respectively. ```csharp using UnityEngine;public class Example : MonoBehaviour { Color32 color = new Color32(0, 0, 0, 0); void Start() { //The same as color....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_42c34500507b
unity_docs
math
What is `LightTransport.BufferSlice_1` in Unity? Explain its purpose and usage.
BufferSlice<T0> struct in UnityEngine.LightTransport Description Represents a typed view into a portion of a device buffer, enabling efficient memory management and type-safe buffer operations. Unity uses the BufferSlice struct to split one large buffer allocation into smaller buffers, each with explicit types. T...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c13c48920d5c
unity_docs
rendering
What is `SceneViewCameraWindow.OnGUI` in Unity? Explain its purpose and usage.
SceneViewCameraWindow.OnGUI Declaration public void OnGUI ( Rect rect ); Parameters Parameter Description rect The rectangle where the GUI controls are drawn. Description A callback used for drawing the GUI controls of the SceneViewCameraWindow window.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8a057207018c
unity_docs
physics
What is `Rigidbody.rotation` in Unity? Explain its purpose and usage.
Rigidbody.rotation public Quaternion rotation ; Description The rotation of the Rigidbody. Use Rigidbody.rotation to get and set the rotation of a Rigidbody using the physics engine. Changing the rotation of a Rigidbody using Rigidbody.rotation updates the Transform after the next physics simulation step. Th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_589adb6258d2
unity_docs
scripting
What is `UIElements.UxmlNamespacePrefixAttribute.ctor` in Unity? Explain its purpose and usage.
UxmlNamespacePrefixAttribute Constructor Declaration public UxmlNamespacePrefixAttribute (string ns , string prefix ); Parameters Parameter Description ns The XML/C# namespace to which a prefix will be associated. prefix The prefix to associate to the namespace. Description Constructor.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_546cd5059fa2
unity_docs
scripting
What is `WaitForFixedUpdate` in Unity? Explain its purpose and usage.
WaitForFixedUpdate class in UnityEngine / Inherits from: YieldInstruction / Implemented in: UnityEngine.CoreModule Description Suspends coroutine execution until the next fixed update. WaitForFixedUpdate can only be used with a yield statement in coroutines. Additional resources: AsyncOperation , WaitFor...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fbfb3428b082
unity_docs
ui
Show me a Unity C# example demonstrating `EditorWindow.ShowNotification`.
The contents of the notification message. fadeoutWait The duration the notification is displayed. Measured in seconds. Description Show a notification message. Displays notification message on the window. Unlike message boxes or log messages notification will fade out automatically after some time. Call RemoveNot...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_55d22efcb583
unity_docs
scripting
Give me an overview of the `Handles` class in Unity.
Handles class in UnityEditor Description Custom 3D GUI controls and drawing in the Scene view. Handles are the 3D controls that Unity uses to manipulate items in the Scene view. There are a number of built-in Handle GUIs, such as the familiar tools to position, scale and rotate an object via the Transform compone...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e9c201938f23
unity_docs
scripting
What is `AnimationModeDriver` in Unity? Explain its purpose and usage.
AnimationModeDriver class in UnityEditor / Inherits from: ScriptableObject Description AnimationMode uses AnimationModeDriver to identify the animation driver. The Animation window, Timeline window, and custom previewers use the AnimationModeDriver to lock the AnimationMode until released. Additional re...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4c72f4c5ca1e
unity_docs
performance
What is `Profiling.Profiler.EmitFrameMetaData` in Unity? Explain its purpose and usage.
Profiler.EmitFrameMetaData Declaration public static void EmitFrameMetaData (Guid id , int tag , Array data ); Declaration public static void EmitFrameMetaData (Guid id , int tag , List<T> data ); Declaration public static void EmitFrameMetaData (Guid id , int tag , NativeArray<T> data ); Paramet...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_649a90e9d7af
unity_docs
audio
What are the parameters of `AudioClip.SetData` in Unity?
Returns bool Returns whether all samples were successfully written to the audio clip. This can return false if offsetSamples isn't a valid offset within the existing AudioClip, or if the data is empty. Description Fills an audio clip with sample data from an array or Span. Overwrites existing data if necessary. This is...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0a3ab1d105a3
unity_docs
physics
Show me a Unity C# example demonstrating `RaycastHit.normal`.
the collider type and settings. For primitive colliders such as BoxCollider or SphereCollider, the normal is calculated based on their simple geometric shape. For MeshCollider, if convex is set to false (non-convex), Unity can return the actual interpolated normal from the mesh surface at the hit point. If convex is...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ca828e322894
unity_docs
input
What is `GUI.Label` in Unity? Explain its purpose and usage.
GUI.Label Declaration public static void Label ( Rect position , string text ); Declaration public static void Label ( Rect position , Texture image ); Declaration public static void Label ( Rect position , GUIContent content ); Declaration public static void Label ( Rect position , string...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0f4c04e5329a
unity_docs
editor
Show me a Unity code example for 'Create a tabbed menu'.
tal of Canada for the third Label ## Define the tabbed menu styles Define the layout for tabs and tab content using USS. You can style the tabs and the tab content the way you like. This example adds a background color for the selected tab and hides the tab header underline. In the Assets folder, create a stylesheet ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_880d64a232d5
unity_docs
scripting
What is `Unity.IO.LowLevel.Unsafe.AsyncReadManagerMetrics.StartCollectingMetrics` in Unity? Explain its purpose and usage.
AsyncReadManagerMetrics.StartCollectingMetrics Declaration public static void StartCollectingMetrics (); Description Begin recording metrics data for AsyncReadManager read operations. Stop collection with StopCollectingMetrics . You can also enable metrics collection when your program first launches using t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f869ed60175d
unity_docs
physics
What is `Cloth.capsuleColliders` in Unity? Explain its purpose and usage.
Cloth.capsuleColliders public CapsuleCollider[] capsuleColliders ; Description An array of CapsuleColliders which this Cloth instance should collide with. Any capsule colliders specified in Cloth.capsuleColliders will collide with the cloth vertices. A maximum of 32 capsules are supported.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b72a01c8fc85
unity_docs
scripting
What is `Rendering.CommandBuffer.ThrowOnSetRenderTarget` in Unity? Explain its purpose and usage.
CommandBuffer.ThrowOnSetRenderTarget public static bool ThrowOnSetRenderTarget ; Description Throw an exception when SetRenderTarget is recorded on a command buffer. This is mainly usefull when using native renderpasses to avoid inadvertently recording SetRenderTarget commands on the command buffer.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6a040a2ba4fc
unity_docs
editor
What is `Actions.EditorAction.OnFinish` in Unity? Explain its purpose and usage.
EditorAction.OnFinish Declaration protected void OnFinish ( Actions.EditorActionResult result ); Parameters Parameter Description result The state that the EditorAction was finished in. Description Callback raised when the EditorAction is finished. This function is responsible for finalizing and clea...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7315cab8b6f4
unity_docs
scripting
What is `SerializedPropertyNumericType` in Unity? Explain its purpose and usage.
SerializedPropertyNumericType enumeration Description Returns the precise type for Integer or Floating point properties. Additional resources: SerializedProperty.numericType , SerializedProperty.intValue , SerializedProperty.uintValue , SerializedProperty.longValue , SerializedProperty.ulongValue , Serialize...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0584ce0e568b
unity_docs
input
Show me a Unity C# example demonstrating `Gyroscope.enabled`.
Gyroscope.enabled public bool enabled ; Description Sets or retrieves the enabled status of this gyroscope. ```csharp using UnityEngine;public class Example : MonoBehaviour { bool enableTilt; void OnGUI() { if (Input.gyro.enabled) { GUILayout.Toggle(enableTilt, "Enable tilt control"); } // Other GUI eleme...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_63761ed4c79d
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormat.R32G32B32_UInt` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormat.R32G32B32_UInt Description A three-component, 96-bit unsigned integer format that has a 32-bit R component in bytes 0..3, a 32-bit G component in bytes 4..7, and a 32-bit B component in bytes 8..11.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8e74af843e38
unity_docs
ui
What is `Canvas.normalizedSortingGridSize` in Unity? Explain its purpose and usage.
Canvas.normalizedSortingGridSize public float normalizedSortingGridSize ; Description The normalized grid size that the canvas will split the renderable area into. During rendering, the canvas splits the renderable area (bounds of all UI elements) into a grid. This is the normalized size of that grid. For examp...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_89234acdf9a5
unity_docs
scripting
What is `Vector3.down` in Unity? Explain its purpose and usage.
Vector3.down public static Vector3 down ; Description Shorthand for writing Vector3(0, -1, 0) . ```csharp using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { void Example() { transform.position += Vector3.down * Time.deltaTime; } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_4ebf4cc23f2e_doc_2
github
scripting
What does `SketchBinaryReader` do in this Unity script? Explain its purpose and signature.
Pass: stream - base stream; may be null. Does not take ownership of the stream; it will not be closed upon Dispose(). Signature: ```csharp public SketchBinaryReader(Stream stream) ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_0b4b88d57bcf
unity_docs
scripting
What is `SerializedPropertyNumericType.Float` in Unity? Explain its purpose and usage.
SerializedPropertyNumericType.Float Description Represents a single precision (32 bit) floating point type. Additional resources: SerializedProperty.numericType , SerializedProperty.floatValue .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_322d3f23ddd6
unity_docs
ui
Show me a Unity code example for 'Keyboard events'.
ents. ## KeyDownEvent A KeyDownEvent is sent each time you press a key on the keyboard. The key pressed contains the keyCode property for that event. If that key press has text input associated with it, additional events are sent for each character of text input. The character property contains the character for thos...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9f000235612f
unity_docs
rendering
What is `Rendering.GraphicsTextureDescriptorFlags.RandomWriteTarget` in Unity? Explain its purpose and usage.
GraphicsTextureDescriptorFlags.RandomWriteTarget Description Allows random write access into this GraphicsTexture on Shader Model 5.0 level shaders. Allows Shader Model 5.0 level pixel or compute shaders to write into arbitrary locations on this texture, called "unordered access views" in UsingDX11GL3Features . ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_27fd0dafc165
github
scripting
Write a Unity C# script called Passthrough Camera Debugger
```csharp // Copyright (c) Meta Platforms, Inc. and affiliates. using Meta.XR.Samples; using UnityEngine; namespace PassthroughCameraSamples { [MetaCodeSample("PassthroughCameraApiSamples-PassthroughCamera")] public static class PassthroughCameraDebugger { public enum DebuglevelEnum { ...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_man_36a5d03dc27a
unity_docs
rendering
Explain 'Introduction to materials' in Unity.
To draw something in Unity, you must provide information that describes its shape, and information that describes the appearance of its surface. You use meshes to describe shapes, and materials to describe the appearance of surfaces. Materials and shaders are closely linked; you always use materials with shaders. ## R...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8f869854f545
unity_docs
rendering
What is `AssetDatabase.FindAssetGUIDs` in Unity? Explain its purpose and usage.
AssetDatabase.FindAssetGUIDs Declaration public static GUID[] FindAssetGUIDs (string filter ); Declaration public static GUID[] FindAssetGUIDs (string filter , string[] searchInFolders ); Parameters Parameter Description filter The filter string can contain search data. See below for details about this...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7612b5f7c19f
unity_docs
scripting
Show me a Unity C# example demonstrating `ParticleSystem.CustomDataModule.SetMode`.
tomData stream , ParticleSystemCustomDataMode mode ); Parameters Parameter Description stream The name of the custom data stream to enable data generation on. mode The type of data to generate. Description Choose the type of custom data to generate for the chosen data stream. Additional resources: Par...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_24983f4d9c0a
unity_docs
animation
What is `Animations.AnimatorControllerPlayable.Create` in Unity? Explain its purpose and usage.
AnimatorControllerPlayable.Create Declaration public static Animations.AnimatorControllerPlayable Create ( Playables.PlayableGraph graph , RuntimeAnimatorController controller ); Parameters Parameter Description graph The PlayableGraph object that will own the AnimatorControllerPlayable. controller ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c55ea2c7dd1c
unity_docs
xr
Show me a Unity code example for 'Project manifest file'.
y. This allows you to host your own packages. Refer to Scoped Registries for more details. testables Array of Strings Lists the names of packages whose tests you want to load in the Unity Test Framework . For more information, see Adding tests to a package . Note : You do not need to specify embedded packages here beca...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e0bc7c8d7947
unity_docs
scripting
What is `Video.VideoAspectRatio.FitOutside` in Unity? Explain its purpose and usage.
VideoAspectRatio.FitOutside Description Resize the image proportionally so that the content fits the target area. The VideoPlayer automatically crops the image if needed. Use this setting to make the video cover the entire object, but keep the video’s dimensions. This setting avoids distortion and black bars. Use...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_32febd413f11
unity_docs
rendering
What is `Rendering.CommandBuffer.DrawMeshInstancedProcedural` in Unity? Explain its purpose and usage.
CommandBuffer.DrawMeshInstancedProcedural Declaration public void DrawMeshInstancedProcedural ( Mesh mesh , int submeshIndex , Material material , int shaderPass , int count , MaterialPropertyBlock properties ); Parameters Parameter Description mesh The Mesh to draw. submeshIndex Which subset o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_913fa9a89cf6
unity_docs
physics
In Unity's 'Configure a Web Canvas size', what is 'Override DPI scale' and how does it work?
If you want to override the DPI scale, open the index.html file and add the Unity Instance configuration variable devicePixelRatio=<double> . For example, setting devicePixelRatio=1 on the Web site template page will force Unity to always apply low DPI rendering. Refer to Web template build configuration and interactio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f4e98ecad14d
unity_docs
scripting
What is `AssetBundleManifest` in Unity? Explain its purpose and usage.
AssetBundleManifest class in UnityEngine / Inherits from: Object / Implemented in: UnityEngine.AssetBundleModule Description Manifest for all the AssetBundles in the build. Additional resources: BuildPipeline.BuildAssetBundles , AssetBundle.GetAllAssetNames Public Methods Method Description GetAllAssetB...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_74392612e2a5
unity_docs
scripting
What is `Experimental.GraphView.Port.ConnectTo` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Port.ConnectTo Declaration public Experimental.GraphView.Edge ConnectTo ( Experimental.GraphView.Port other ); Parameters Parameter Description other Other port to connect to. Returns Edge Newly created edge. De...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_020237bab3f0
unity_docs
editor
Show me a Unity C# example demonstrating `Callbacks.RunBeforeAssemblyAttribute.ctor`.
s a dependency graph and uses topological sorting to ensure that all dependencies are run in sequence based on their dependencies. If callbacks dependencies are not present in the project then the instruction will be ignored during the generation of the dependency graph. Note: Defining callback dependencies is current...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0cfbf4ba3c79
unity_docs
rendering
What is `ScalableBufferManager` in Unity? Explain its purpose and usage.
ScalableBufferManager class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Scales render textures to support dynamic resolution if the target platform/graphics API supports it. The ScalableBufferManager class handles the scaling of any render textures that you have marked as DynamicallyS...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_68860ef14b13
unity_docs
editor
What is `Device.SystemInfo.supportsGraphicsFence` in Unity? Explain its purpose and usage.
SystemInfo.supportsGraphicsFence public static bool supportsGraphicsFence ; Description This has the same functionality as SystemInfo.supportsGraphicsFence 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_47129d9a4b51
unity_docs
math
What is `Vector2Int` in Unity? Explain its purpose and usage.
Vector2Int struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description Representation of 2D vectors and points using integers. This structure is used in some places to represent 2D 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_sr_e40820ff63e8
unity_docs
scripting
What is `UIElements.Foldout` in Unity? Explain its purpose and usage.
Foldout class in UnityEngine.UIElements / Inherits from: UIElements.BindableElement / Implemented in: UnityEngine.UIElementsModule Implements interfaces: INotifyValueChanged<T0> Description A Foldout control is a collapsible section of a user interface. When toggled, it expands or collapses, which hides or r...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c7341df4357c
unity_docs
rendering
What is `ParticleSystemRenderer.lengthScale` in Unity? Explain its purpose and usage.
ParticleSystemRenderer.lengthScale public float lengthScale ; Description How much are the particles stretched in their direction of motion, defined as the length of the particle compared to its width. This determines the base length of particles when they don't move. A value of 1 is neutral, causing no stretch...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_91d7508f707c
unity_docs
editor
Show me a Unity C# example demonstrating `PlayerSettings.Android.bundleVersionCode`.
PlayerSettings.Android.bundleVersionCode public static int bundleVersionCode ; Description Android bundle version code. Should be less than 100000 for buildApkPerCpuArchitecture to generate valid version codes. ```csharp using UnityEngine; using UnityEditor; using UnityEditor.Build;public class BundleVersio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7a72a85edf31
unity_docs
scripting
What is `AudioListener` in Unity? Explain its purpose and usage.
AudioListener class in UnityEngine / Inherits from: Behaviour / Implemented in: UnityEngine.AudioModule Description Representation of a listener in 3D space. This class implements a microphone-like device. It records the sounds around it and plays that through the player's speakers. You can only have one lis...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ac3e04edd798
unity_docs
scripting
What is `ParticleSystem.ColorOverLifetimeModule.color` in Unity? Explain its purpose and usage.
ParticleSystem.ColorOverLifetimeModule.color public ParticleSystem.MinMaxGradient color ; Description The gradient that controls the particle colors. Additional resources: MinMaxGradient . ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(ParticleSystem))] public class ExampleC...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_883ed3caf920
unity_docs
rendering
What is `QualitySettings.shadowCascade2Split` in Unity? Explain its purpose and usage.
QualitySettings.shadowCascade2Split public static float shadowCascade2Split ; Description The normalized cascade distribution for a 2 cascade setup. The value defines the position of the cascade with respect to Zero. Additional resources: Quality Settings .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_39e71cd53b12
unity_docs
input
What is `XR.TrackingOriginModeFlags.Unbounded` in Unity? Explain its purpose and usage.
TrackingOriginModeFlags.Unbounded Description XRInputSubsystem tracks all InputDevice s in relation to a world anchor. This world anchor can change at any time, and is chosen by the runtime. Use XRInputSubsystem.trackingOriginUpdated to be notified when the anchor has been updated.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_be36ec1247d2
unity_docs
rendering
What is `Camera.areVRStereoViewMatricesWithinSingleCullTolerance` in Unity? Explain its purpose and usage.
Camera.areVRStereoViewMatricesWithinSingleCullTolerance public bool areVRStereoViewMatricesWithinSingleCullTolerance ; Description Determines whether the stereo view matrices are suitable to allow for a single pass cull. If the stereo view matrices are set manually by calling Camera.SetStereoViewMatrix , the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_aa3732df976b
unity_docs
scripting
Show me a Unity C# example demonstrating `GridLayout.WorldToCell`.
GridLayout.WorldToCell Declaration public Vector3Int WorldToCell ( Vector3 worldPosition ); Parameters Parameter Description worldPosition World Position to convert. Returns Vector3Int Cell position of the world position. Description Converts a world position to cell position. ```csharp // Snap t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5ea0eadf8cb8
unity_docs
input
What is `LocationInfo` in Unity? Explain its purpose and usage.
LocationInfo struct in UnityEngine / Implemented in: UnityEngine.InputLegacyModule Description Structure describing device location. Properties Property Description altitude Geographical device location altitude in meters. horizontalAccuracy Horizontal accuracy radius of the location in meters. latitude Ge...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1c983c361a92
unity_docs
scripting
What is `Unity.Collections.LowLevel.Unsafe.AtomicSafetyHandle.GetWriterName` in Unity? Explain its purpose and usage.
AtomicSafetyHandle.GetWriterName Declaration public static string GetWriterName ( Unity.Collections.LowLevel.Unsafe.AtomicSafetyHandle handle ); Parameters Parameter Description handle The AtomicSafetyHandle to check. Returns string The name of the writer, if there is any. Description Gets the debug...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b97013c52095
unity_docs
editor
What is `AssetDatabase.TryGetGUIDAndLocalFileIdentifier` in Unity? Explain its purpose and usage.
AssetDatabase.TryGetGUIDAndLocalFileIdentifier Declaration public static bool TryGetGUIDAndLocalFileIdentifier ( Object obj , out string guid , out long localId ); Declaration public static bool TryGetGUIDAndLocalFileIdentifier (int instanceID , out string guid , out long localId ); Declaration public ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ca905b5da082
unity_docs
scripting
What is `Experimental.GraphView.Node.RefreshExpandedState` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Node.RefreshExpandedState Declaration public void RefreshExpandedState (); Description After adding custom elements to the extensionContainer, call this method in order for them to become visible.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d4547402136e
unity_docs
scripting
In Unity's 'Naming scripts', what is 'Script file names' and how does it work?
The file name you enter on creation of a script will also be used for the name of the class defined inside it. It’s good practice for a script’s file name to match the name of the class defined inside it. For scripts derived from the built-in Unity types MonoBehaviour and ScriptableObject , Unity can still resolve a cl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ce4469cb1fdd
unity_docs
rendering
Explain 'AlphaToMask command in ShaderLab reference' in Unity.
Enables or disables alpha-to-coverage mode on the GPU. ## Render pipeline compatibility Feature name Universal Render Pipeline (URP) High Definition Render Pipeline (HDRP) Custom SRP Built-in Render Pipeline AlphaToMask Yes Yes Yes Yes ## Syntax This command makes a change to the render state. Use it in a Pass bloc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7c50780d8004
unity_docs
rendering
In Unity's 'New in Unity 6.0 Preview', what is 'UI Toolkit' and how does it work?
Added missing UxmlAttribute converters to support UXML authoring: Gradient , AnimationCurve , ToggleButtonGroupState , Unsigned Int, and Unsigned Long. Added support in PropertyField for ToggleButtonGroupState serialized properties. Native Text Generator Rewrite. With the Text Generator, you can use a wide array of lan...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_514661e9c85e
unity_docs
scripting
What is `Profiling.Recorder.gpuElapsedNanoseconds` in Unity? Explain its purpose and usage.
Recorder.gpuElapsedNanoseconds public long gpuElapsedNanoseconds ; Description Gets the accumulated GPU time, in nanoseconds, for a frame. The Recorder has a three frame delay so this gives the timings for the frame that was three frames before the one that you access this property on. (Read Only). To get valid...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.