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_c94139e9c647
unity_docs
scripting
What is `AvatarMask.AddTransformPath` in Unity? Explain its purpose and usage.
AvatarMask.AddTransformPath Declaration public void AddTransformPath ( Transform transform , bool recursive = true); Parameters Parameter Description transform The transform to add into the AvatarMask. recursive Whether to also add all children of the specified transform. Description Adds a transform...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_07fbcc4c75e4
unity_docs
rendering
Explain '2D texture arrays' in Unity.
Resources for creating and using an array of 2D textures with the same size, format and flags. Page Description Introduction to texture arrays Learn about the structure of 2D texture arrays, and which platforms and graphics APIs support them. Create a texture array Import 2D texture arrays from source texture files tha...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_592c83a4d429
unity_docs
rendering
In Unity's 'Shader loading', what is 'Which shaders Unity loads' and how does it work?
Unity only loads compiled shaders that are compatible with the platform’s graphics API, hardware and graphics tier . If Unity can’t find the shader variant it needs because you or Unity stripped the shader variant from your built application, Unity tries to select a similar shader variant. If Unity can’t find a similar...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f74cc528ae4a
unity_docs
performance
What is `Unity.Profiling.ProfilerRecorderOptions.SumAllSamplesInFrame` in Unity? Explain its purpose and usage.
ProfilerRecorderOptions.SumAllSamplesInFrame Description Use to sum all samples within a frame and collect those as one sample per frame. ```csharp using System; using Unity.Profiling; using UnityEngine;public class CollectGCAllocCountExample2 { static void PrintGCAllocCount(Action a) { using (var gcAllocRecorde...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c6fc66e57807
unity_docs
rendering
In Unity's 'Activate and deactivate search providers', what is 'Toggle providers on and off in the Search window' and how does it work?
You can temporarily toggle search providers off in the Search window. Toggling a search provider off: Reduces the number of results in the All tab, because the search provider doesn’t return results. Reduces the number of tabs in the Search window, because the inactive search provider’s tab isn’t displayed. Removes the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4d377171e65f
unity_docs
scripting
What is `Mesh.MeshData.indexFormat` in Unity? Explain its purpose and usage.
Mesh.MeshData.indexFormat public Rendering.IndexFormat indexFormat ; Description Gets the format of the index buffer data in the MeshData . (Read Only) A Mesh's index buffer format can be either 16 bit (which supports up to 65535 vertices), or 32 bit (which supports up to 4 billion vertices). The default in...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_f559b1caf660
github
scripting
Write a Unity Editor script for Intersection Result
```csharp using System.Collections; using System.Collections.Generic; using UnityEngine; namespace EzySlice { /** * A Basic Structure which contains intersection information * for Plane->Triangle Intersection Tests * TO-DO -> This structure can be optimized to hold less data * via an optional ...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_2f8cbb41970f
unity_docs
scripting
What is `MonoBehaviour.OnTransformParentChanged` in Unity? Explain its purpose and usage.
MonoBehaviour.OnTransformParentChanged() Description Called when a direct or indirect parent of a GameObject's Transform changes. Changes to the parent includes both direct and indirect changes to the hierarchy: whether the GameObject is reparented to a new Transform, or if any ancestor in its hierarchy is reparen...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7ec93d62b412
unity_docs
scripting
What are the parameters of `GameObject.FindWithTag` in Unity?
Description Retrieves the first active GameObject tagged with the specified tag. Returns null if no GameObject has the tag. Tags must be declared in the tag manager before using them. A UnityException is thrown if the tag does not exist or if an empty string or null is supplied as the tag parameter. Note: This method r...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_41a3f7a53272
unity_docs
editor
Show me a Unity C# example demonstrating `iOS.Xcode.PBXProject.SetBuildPropertyForConfig`.
ds The GUIDs of the build configurations as returned by BuildConfigByName . name The name of the build property. value The value of the build property. Description Sets a build property to the given value in the specified build configuration(s). Duplicate build properties are ignored. Values for names LIBRARY...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4ba93c850ace
unity_docs
scripting
What is `UIElements.InspectorElement.iMGUICustomVariantUssClassName` in Unity? Explain its purpose and usage.
InspectorElement.iMGUICustomVariantUssClassName public static string iMGUICustomVariantUssClassName ; Description USS class name of elements of this type, when they are displayed in IMGUI custom mode.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_744199da3c31
unity_docs
performance
What is `Profiling.ProfilerArea.UIDetails` in Unity? Explain its purpose and usage.
ProfilerArea.UIDetails Description Detailed UI statistics. NOTE: Collecting the detailed UI samples adds a particularly high amount of profiling overhead. Consider turning this area off when you don't need it. See Profiler.SetAreaEnabled .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_de018a047292
unity_docs
scripting
What is `Space.World` in Unity? Explain its purpose and usage.
Space.World Description World coordinate space, relative to the origin point (0,0,0) of the x-, y-, and z-axes of the scene. Use Space.World to transform a GameObject relative to its Transform.position and the scene axes, ignoring the GameObject's own orientation. For example, Transform.Translate(Vector3.forw...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b8d174e96700
unity_docs
rendering
What is `Camera.aspect` in Unity? Explain its purpose and usage.
Camera.aspect public float aspect ; Description The aspect ratio (width divided by height). By default the aspect ratio is automatically calculated from the screen's aspect ratio, even if the camera is not rendering to full area. If you modify the aspect ratio of the camera, the value will stay until you cal...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2b565b9050ee
unity_docs
scripting
Show me a Unity C# example demonstrating `Vector3.y`.
Vector3.y public float y ; Description Y component of the vector. ```csharp // Attach this script to a GameObject // Create two Input Fields in the Scene (Create>UI>Input Field) // Click on the GameObject and attach both Input Fields in the Inspector windowusing UnityEngine; using UnityEngine.UI;public class Ex...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d1d5af90f805
unity_docs
rendering
Show me a Unity C# example demonstrating `AssetDatabase.LoadMainAssetAtPath`.
main asset object at assetPath . The main asset is the asset at the root of a hierarchy (such as a Maya file which might contain multiple meshes and GameObjects). All paths are relative to the project folder, for example: Assets/MyTextures/hello.png . Additional resources: AssetDatabase.LoadAssetAtPath , AssetData...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_709764ac1a3f
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormat.R_EAC_SNorm` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormat.R_EAC_SNorm Description A one-component, ETC2 compressed format where each 64-bit compressed texel block encodes a 4×4 rectangle of signed normalized red texel data.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e43c50c6b024
unity_docs
animation
What is `Animations.AnimationMixerPlayable.Create` in Unity? Explain its purpose and usage.
AnimationMixerPlayable.Create Declaration public static Animations.AnimationMixerPlayable Create ( Playables.PlayableGraph graph , int inputCount ); Parameters Parameter Description graph The PlayableGraph that will contain the new AnimationMixerPlayable . inputCount The number of inputs that the mi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_808cd8914c28
unity_docs
rendering
What is `ShaderVariantCollection.ShaderVariant` in Unity? Explain its purpose and usage.
ShaderVariant struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description Identifies a specific variant of a shader. In Unity, many shaders internally have multiple "variants", to account for different light modes, lightmaps, shadows and so on. These variants are indentified by a shader pass type...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_91a313718fad
unity_docs
scripting
What is `Build.Player.ScriptCompilationSettings.options` in Unity? Explain its purpose and usage.
ScriptCompilationSettings.options public Build.Player.ScriptCompilationOptions options ; Description Specific compiler options to use when compiling scripts. Internal use only. See Build.Content.ScriptCompilationSettings.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e3a1af5f51bc
unity_docs
scripting
Explain '2D game art style reference' in Unity.
Decide what art style you want your game to have. The following table describes the main types of 2D art style: Art style / technique Description Minimalist Flat colors, clean lines and high readability, for example a mobile puzzle game. Pixel art Pixelated graphics, for example a retro gaming art style. Illustrative A...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9ff08ef448e6
unity_docs
math
Show me a Unity C# example demonstrating `Quaternion.LookRotation`.
aligned with cross product between Z and X. If the forward vector is zero, the method logs an error in the console and returns identity . If forward and upwards are colinear, or if the magnitude of upwards is zero, the result is the same as Quaternion.FromToRotation with fromDirection set to the positive...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1b5c1b23dd52
unity_docs
physics
What are the parameters of `PrefabUtility.MergePrefabInstance` in Unity?
Description Forces a Prefab instance to merge with changes from the Prefab Asset. Unity will in most cases handle re-merging of the Prefab instance when you make changes in the Editor or via scripting. However, as shown in the example below, there are some rare cases where editing a Prefab instance from script requires...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d7ce7123103c
unity_docs
scripting
What is `ParticleSystem.sizeBySpeed` in Unity? Explain its purpose and usage.
ParticleSystem.sizeBySpeed public ParticleSystem.SizeBySpeedModule sizeBySpeed ; Description Script interface for the SizeBySpeedModule of a Particle System. This module controls the size of particles based on their speeds. Particle System modules do not need to be reassigned back to the system; they are int...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_548e1eab6d38
unity_docs
editor
What is `AssetDatabase.onImportPackageItemsCompleted` in Unity? Explain its purpose and usage.
AssetDatabase.onImportPackageItemsCompleted public static Action<string[]> onImportPackageItemsCompleted ; Description Callback raised whenever a package import successfully completes that lists the items selected to be imported.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e0bb0e69e63f
unity_docs
xr
Show me a Unity code example for 'Dual thread allocator example'.
## Customize block size You can customize the block sizes of the two dynamic heap allocators: ## Usage report example The usage report contains information for all three parts of the allocator. For example: ``` [ALLOC_DEFAULT] Dual Thread Allocator Peak main deferred allocation count 135 [ALLOC_BUCKET] Large Bloc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a9e44689a804
unity_docs
rendering
What is `MaterialEditor.DefaultShaderProperty` in Unity? Explain its purpose and usage.
MaterialEditor.DefaultShaderProperty Declaration public void DefaultShaderProperty ( MaterialProperty prop , string label ); Declaration public void DefaultShaderProperty ( Rect position , MaterialProperty prop , string label ); Description Handles UI for one shader property ignoring any custom draw...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d4612e92adc6
unity_docs
rendering
In Unity's 'Shape module reference', what is 'Sphere, Hemisphere, Circle' and how does it work?
Sphere , Hemisphere , and Circle have the same properties. Property Description Radius Sets the radius of the circular aspect of the shape. Radius Thickness Sets the proportion of the volume that emits particles. A value of 0 emits particles from the outer surface of the shape. A value of 1 emits particles from the ent...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_1d3c0d7ac608_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
abstract class with automatic registration in .Instances will register themselves for updates in the OnEnable message and unregister in the OnDisable message.Implement , and/or to be updated every frame using . Signature: ```csharp public abstract class AManagedBehaviour : MonoBehaviour, IManagedObject ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_man_a8f1f7f7c359
unity_docs
scripting
In Unity's 'Using a custom update manager', what is 'When to use a custom update manager' and how does it work?
A custom update manager can be beneficial when the number of MonoBehaviour instances with per-frame update callbacks reaches the hundreds or thousands. You can improve performance significantly by eliminating callbacks that rarely execute. Consider the following example: ```csharp void Update() { if(!someVeryRareCondi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_42355ae0a3a4
unity_docs
scripting
In Unity's 'Define a data source for runtime binding', what is 'Property bags' and how does it work?
UI Toolkit uses the Unity.Properties module to create property bags for binding data between two objects. It generates the property bags based on the available C# type information. However, for certain built-in Unity types, the generated property bag might not contain the expected properties. This can occur when these ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_35b7ed04d384
unity_docs
scripting
Show me a Unity C# example demonstrating `WaitForSeconds.ctor`.
ution for the given amount of seconds using scaled time. Create a yield instruction. Wait for seconds multiplied by Time.scaledTime . If seconds is set to 2.0f and Time.scaledTime is set to 0.5f , the wait is 4.0f ( 2.0f divided by 0.5f seconds). The example WaitForSeconds has a value of 1.0f . The...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_be19d68f0bd1_doc_1
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Get or set the ARHumanBodyManager. Signature: ```csharp public ARHumanBodyManager humanBodyManager ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_man_4868ae4ff05d
unity_docs
input
Explain 'The SearchProvider class' in Unity.
The SearchProvider class executes searches for specific types of items, and manages thumbnails, descriptions, and sub-filters. It has the following basic API: ```csharp public class SearchProvider { public SearchProvider(string id, string displayName = null); // Creates an Item bound to this provider. public Search...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_38aab2876be3
unity_docs
scripting
What is `AI.NavMeshAgent.currentOffMeshLinkData` in Unity? Explain its purpose and usage.
NavMeshAgent.currentOffMeshLinkData public AI.OffMeshLinkData currentOffMeshLinkData ; Description The current OffMeshLinkData . In the case that this agent is not on an OffMeshLink the OffMeshLinkData is marked as invalid.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_97e791ec3b49
unity_docs
ui
What is `UIElements.IVisualElementScheduledItem` in Unity? Explain its purpose and usage.
IVisualElementScheduledItem interface in UnityEngine.UIElements Description Represents a scheduled task created with a VisualElement's schedule interface. Properties Property Description element Returns the VisualElement this object is associated with. isActive Will be true when this item is schedule...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4c43db50fbf7
unity_docs
audio
Explain 'Audio Random Container reference' in Unity.
Use an Audio Random Container to set up, play, and randomize a list of audio clips. Unless otherwise stated, the following table describes each Audio Random Container property and the effect of modifying its value in Edit mode. Property Description Play Start or stop the playlist and preview the selected Playback mode....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_cf917b9efcd1
unity_docs
rendering
In Unity's 'Optimize Web platform for mobile', what is 'Optimization quick reference' and how does it work?
Use these recommended settings to make optimizations specific to Unity Web platform for mobile: Recommendation Description Optimize for size Disable development build settings and optimize your build for disk size (Disk Size with LTO). Use Brotli compression Use the Brotli compression method to compress your Player bui...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_d026e173d3f5
github
scripting
Write a Unity Editor script for Java Script Asset Drop Util
```csharp using Baxter.ClusterScriptExtensions.Editor.ScriptUpdater; using ClusterVR.CreatorKit.Item.Implements; using UnityEditor; using UnityEngine; namespace Baxter.ClusterScriptExtensions.Editor { public static class JavaScriptAssetInspectorDropUtil { [InitializeOnLoadMethod] public static ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4ea4fc9f7b7e
unity_docs
editor
What is `Search.IQueryNode` in Unity? Explain its purpose and usage.
IQueryNode interface in UnityEditor.Search Description Interface representing a query node. Properties Property Description children The node's children. Can be null. identifier A string representing this node and its children. leaf True if this node is a leaf. A leaf doesn't have any children. parent Paren...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_75092765b72e
unity_docs
scripting
Give me an overview of the `AssetDeleteResult` class in Unity.
AssetDeleteResult enumeration Description Result of Asset delete operation Properties Property Description DidNotDelete Tells the internal implementation that the callback did not delete the asset. The asset will be delete by the internal implementation. FailedDelete Tells Unity that the file cannot be deleted...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7a0714f0a31a
unity_docs
editor
Show me a Unity C# example demonstrating `SearchService.ObjectSelectorSearch`.
IObjectSelectorEngine interface. When a custom ObjectSelector search engine is active, the object selector calls registered ObjectSelector search engines. When the default ObjectSelector search engine is active, the window uses the default object selector, and the internal searches use the active Scene and Project se...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6bfa7ba70a78
unity_docs
rendering
What is `RenderSettings.ambientSkyColor` in Unity? Explain its purpose and usage.
RenderSettings.ambientSkyColor public static Color ambientSkyColor ; Description Ambient lighting coming from above. Trilight ambient lighing mode uses this color to affect upwards-facing object parts. Additional resources: ambientMode , ambientGroundColor , ambientEquatorColor .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ab647a99a657
unity_docs
math
What are the parameters of `ScriptableWizard.DisplayWizard` in Unity?
Returns T The wizard. Description Creates a wizard. When the user hits the Create button OnWizardCreate function will be called. DisplayWizard will only show one wizard for every wizard class. Simple Wizard window that copies a GameObject several times. ```csharp // Simple Wizard that clones an object.using UnityEngine...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_338f49bc6000
unity_docs
scripting
What is `GameObject.GetScene` in Unity? Explain its purpose and usage.
GameObject.GetScene Declaration public static SceneManagement.Scene GetScene (int instanceID ); Parameters Parameter Description instanceID The instance ID of the GameObject. Returns Scene The Scene the GameObject with the specified instance ID is part of. Description Retrieves the Scene which con...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_27dfdf6ac22f
unity_docs
scripting
Explain 'Scene Camera reference' in Unity.
The Camera settings menu contains options for configuring the Scene Camera. These adjustments do not affect the settings on GameObjects with Camera components. To open the Scene Camera settings menu, click the Camera icon in the View options overlay in the Scene view . You can also configure the Scene Camera in script ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d047adbcf791
unity_docs
scripting
What is `Unity.IO.LowLevel.Unsafe.AsyncReadManagerSummaryMetrics.LongestWaitSubsystem` in Unity? Explain its purpose and usage.
AsyncReadManagerSummaryMetrics.LongestWaitSubsystem public Unity.IO.LowLevel.Unsafe.AssetLoadingSubsystem LongestWaitSubsystem ; Description The Subsystem tag for the longest wait time included in the summary calculation.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_59a527a06063
unity_docs
scripting
What is `FullScreenMode.MaximizedWindow` in Unity? Explain its purpose and usage.
FullScreenMode.MaximizedWindow Description Windows and macOS platforms only. Sets your application window to the operating system's definition of maximized. On Windows, it's a full-screen window with a title bar. On macOS, it is a full-screen window with a hidden menu bar and dock. On other platforms, this mode fa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_48442653b609
unity_docs
scripting
What is `ShortcutManagement.ShortcutAttribute.displayName` in Unity? Explain its purpose and usage.
ShortcutAttribute.displayName public string displayName ; Description Optional override of the Shortcut ID when listing the Shortcut in the configuration interface. Allows the shortcut to be displayed in a different category and with a different name than the Shortcut ID, so allows developers to rename or recat...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_76ac938f7cf5
unity_docs
scripting
What is `UIElements.GroupBox.ctor` in Unity? Explain its purpose and usage.
GroupBox Constructor Declaration public GroupBox (); Description Creates a GroupBox with no label. Declaration public GroupBox (string text ); Parameters Parameter Description text The title text. Description Creates a GroupBox with a title.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_988edf55ca41
unity_docs
input
What is `UIElements.MouseEnterWindowEvent.ctor` in Unity? Explain its purpose and usage.
MouseEnterWindowEvent Constructor Declaration public MouseEnterWindowEvent (); Description Constructor. Avoid creating new event instances. Instead, use GetPooled() to get an instance from a pool of reusable event instances.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_65f49d63b24b
unity_docs
xr
Explain 'Ambisonic Audio' in Unity.
Ambisonics are a type of audio that provide a representation of sound that can completely surround a listener. They can provide an audio skybox for distant ambient sounds, and are particularly useful for 360-degree videos and applications. Ambisonics are stored in a multi-channel format. Instead of mapping each channel...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e9810ed9b5fa
unity_docs
input
What is `TouchScreenKeyboard.characterLimit` in Unity? Explain its purpose and usage.
TouchScreenKeyboard.characterLimit public int characterLimit ; Description How many characters the keyboard input field is limited to. 0 = infinite. This property is supported on Android and iOS only.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_732aa7bda379
unity_docs
scripting
What is `BuildAssetBundlesParameters.extraScriptingDefines` in Unity? Explain its purpose and usage.
BuildAssetBundlesParameters.extraScriptingDefines public string[] extraScriptingDefines ; Description User-specified preprocessor defines used while compiling assemblies during the AssetBundle build. (optional) Preprocessor defines may be used to exclude serialized fields from class definitions, so this can be...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1615bc86c3e9
unity_docs
scripting
What is `ObjectPreview` in Unity? Explain its purpose and usage.
ObjectPreview class in UnityEditor Description Base Class to derive from when creating Custom Previews. You specify which type is the preview for by using the CustomPreview attribute derived from ObjectPreview . Below you can see an small example that will display the name of the object being inspected. The prev...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bcdf3331dff7
unity_docs
rendering
What is `Rendering.RendererUtils.RendererListDesc.renderQueueRange` in Unity? Explain its purpose and usage.
RendererListDesc.renderQueueRange public Rendering.RenderQueueRange renderQueueRange ; Description The material render queue range to use for the RendererList. For more information, see RenderQueueRange .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_78e34d3e00cf
unity_docs
scripting
What is `BuildPlayerOptions.extraScriptingDefines` in Unity? Explain its purpose and usage.
BuildPlayerOptions.extraScriptingDefines public string[] extraScriptingDefines ; Description The additional preprocessor defines you can specify while compiling assemblies for the Player. These defines are appended to the existing Scripting Define Symbols list configured in the Player settings.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9d7bc82edb8f
unity_docs
scripting
What is `AsyncOperation` in Unity? Explain its purpose and usage.
AsyncOperation class in UnityEngine / Inherits from: YieldInstruction / Implemented in: UnityEngine.CoreModule Description Suspends a coroutine until an asynchronous operation completes. WaitForSecondsRealtime can only be used with a yield statement in coroutines. You can yield until the AsyncOperation ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_94efbd645a76
unity_docs
rendering
What is `ParticleSystem.ShapeModule.meshSpawnMode` in Unity? Explain its purpose and usage.
ParticleSystem.ShapeModule.meshSpawnMode public ParticleSystemShapeMultiModeValue meshSpawnMode ; Description The mode to use to generate particles on a Mesh. Additional resources: ParticleSystem.ShapeModule.shapeType .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dc9e8cd75925
unity_docs
physics
What is `Physics2D.IgnoreRaycastLayer` in Unity? Explain its purpose and usage.
Physics2D.IgnoreRaycastLayer public static int IgnoreRaycastLayer ; Description Layer mask constant for the default layer that ignores raycasts. The value of the mask is the bitwise complement of the DefaultRaycastLayers mask. Additional resources: Raycast , DefaultRaycastLayers , AllLayers .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5bc7a8d091f4
unity_docs
scripting
What is `Rendering.BatchDrawCommand.flags` in Unity? Explain its purpose and usage.
BatchDrawCommand.flags public Rendering.BatchDrawCommandFlags flags ; Description Specifies rendering options for the draw command. This includes rendering options like whether Unity should individually depth sort the instances in the draw command, or whether to render instances into per-object motion passes.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_956bda95d4ea
unity_docs
editor
What are the parameters of `ModelImporter.GetReferencedClipsForModelPath` in Unity?
Returns string[] Array of referenced clip GUIDs matching the given model. Description Returns all the referenced clips matching the given model name. Note: referenced clips are matched against the given model by respecting the EditorSettings.referencedClipsExactNaming project setting. ```csharp using UnityEditor; using...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_210e26cadcbf
unity_docs
scripting
What is `SceneManagement.SceneManagerAPI.LoadSceneAsyncByNameOrIndex` in Unity? Explain its purpose and usage.
SceneManagerAPI.LoadSceneAsyncByNameOrIndex Declaration protected AsyncOperation LoadSceneAsyncByNameOrIndex (string sceneName , int sceneBuildIndex , SceneManagement.LoadSceneParameters parameters , bool mustCompleteNextFrame ); Description Override for customizing the behavior of the SceneManager.Load...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1c9f4fc5b123
unity_docs
scripting
Show me a Unity C# example demonstrating `ParticleSystem.colorOverLifetime`.
time public ParticleSystem.ColorOverLifetimeModule colorOverLifetime ; Description Script interface for the ColorOverLifetimeModule of a Particle System. This module changes the colors assigned to particles over time, based on how long each particle has been alive. Particle System modules do not need to be r...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b393060b45ba
unity_docs
physics
In Unity's 'Define binding mode and update trigger', what is 'Define update triggers' and how does it work?
You can update binding objects on every frame or when a change occurs in the data source. The following update triggers are available: Every frame On change detection or every frame if change detection is impossible. Refer to Define data sources for more details. When explicitly marked as dirty To define update trigger...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_86716080e366
unity_docs
scripting
What is `Unity.Properties.TypeGenerationOptions` in Unity? Explain its purpose and usage.
TypeGenerationOptions enumeration Description A set of options to customize the behaviour of the code generator. Properties Property Description None If this option is selected, no property bags will be generated. ValueType If this option is selected, any inherited value types will have property bags ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_23f61522a7f7_doc_3
github
scripting
What does `RightHand2UnityLeftHand` do in this Unity script? Explain its purpose and signature.
runtime右手坐标系结果转换成Unity左手系结果 Signature: ```csharp static public void RightHand2UnityLeftHand(XRRotation rotation) ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_11d69a21225f
unity_docs
editor
What is `Events.UnityEventCallState` in Unity? Explain its purpose and usage.
UnityEventCallState enumeration Description Controls the scope of UnityEvent callbacks. Properties Property Description Off Callback is not issued. EditorAndRuntime Callback is always issued. RuntimeOnly Callback is only issued in the Runtime and Editor playmode.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9c3d9e47616a
unity_docs
scripting
What is `AndroidJNI.ToReflectedField` in Unity? Explain its purpose and usage.
AndroidJNI.ToReflectedField Declaration public static IntPtr ToReflectedField (IntPtr clazz , IntPtr fieldID , bool isStatic ); Description Converts a field ID derived from cls to a java.lang.reflect.Field object. Additional resources: Java Native Interface Specification (Oracle)
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6d8d71aee0a8
unity_docs
scripting
What are the parameters of `Vector3.SignedAngle` in Unity?
Returns float Returns the signed angle between from and to in degrees. Description Calculates the signed angle between two vectors, using a third vector to determine the sign. The angle returned is the angle of rotation from the first vector to the second inside the plane that contains both vectors. The returned angle ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_af1b642081f7
unity_docs
scripting
What is `Compilation.CompilationPipeline.assemblyCompilationStarted` in Unity? Explain its purpose and usage.
CompilationPipeline.assemblyCompilationStarted Parameters Parameter Description value Parameter is the output assembly path. Description An event that is invoked on the main thread when the assembly build starts.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b313d05814d2
unity_docs
rendering
What is `Light.dilatedRange` in Unity? Explain its purpose and usage.
Light.dilatedRange public float dilatedRange ; Description The Light.range property describes the range of each point on the light. However, area lights consist of several light-emitting points, and so the effective range is a bit larger, and depends on the size of the area light. This property returns this ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4fe0888c6081
unity_docs
editor
Show me a Unity code example for 'Create custom Editor Windows with IMGUI'.
wing simple steps: Create a script that derives from EditorWindow. Use code to trigger the window to display itself. Implement the GUI code for your tool. ## Derive From EditorWindow In order to make your Editor Window, your script must be stored inside a folder called “Editor”. Make a class in this script that deriv...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b17a3d5707d2
unity_docs
scripting
What is `Search.ISearchView.ShowItemContextualMenu` in Unity? Explain its purpose and usage.
ISearchView.ShowItemContextualMenu Declaration public void ShowItemContextualMenu ( Search.SearchItem item , Rect contextualActionPosition ); Parameters Parameter Description item Item affected by the contextual menu. contextualActionPosition The position that a menu should be drawn on screen (generall...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_19d2f1f71c5c
unity_docs
physics
What is `PhysicsShapeGroup2D` in Unity? Explain its purpose and usage.
PhysicsShapeGroup2D class in UnityEngine / Implemented in: UnityEngine.Physics2DModule Description Represents a group of PhysicsShape2D and their geometry. A shape group represents multiple PhysicsShape2D of the same or mixed PhysicsShapeType2D along with their geometry. It is comprised of a single list o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8c707cde004a
unity_docs
rendering
Explain 'Secondary Maps (Detail Maps) and Detail Mask' in Unity.
Secondary Maps (or Detail maps) allow you to overlay a second set of textures on top of the main textures listed above. You can apply a second Albedo colour map, and a second Normal map . Typically, these would be mapped on a much smaller scale repeated many times across the object’s surface, compared with the main Alb...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_780d07f0f5ef
unity_docs
editor
What are the parameters of `EditorGUILayout.Toggle` in Unity?
Returns bool The selected state of the toggle. Description Make a toggle. Show a button if the toggle control is selected. ```csharp using UnityEngine; using UnityEditor;public class EditorGUILayoutToggle : UnityEditor.EditorWindow { bool showBtn = true; [MenuItem("Examples/Editor GUILayout Toggle Usage")] s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_d580c03076b5_doc_10
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
The principal point from the top-left corner of the image, expressed in pixels Signature: ```csharp public Vector2 PrincipalPoint; ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_d620e494d41d
unity_docs
rendering
What is `ShaderUtil.GetMissShaderCount` in Unity? Explain its purpose and usage.
ShaderUtil.GetMissShaderCount Declaration public static int GetMissShaderCount ( Rendering.RayTracingShader s ); Parameters Parameter Description s The RayTracingShader instance. Returns int The number of miss Shaders defined in the RayTracingShader instance passed as argument. Description Retur...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c6d107239648
unity_docs
editor
What is `IMGUI.Controls.TreeView.CommandEventHandling` in Unity? Explain its purpose and usage.
TreeView.CommandEventHandling Declaration protected void CommandEventHandling (); Description This function is called automatically and handles the ExecuteCommand events for “SelectAll” and “FrameSelection”. Override this function to extend or avoid Command events.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f984fd7ebd04
unity_docs
math
What is `LineRenderer.GetPositions` in Unity? Explain its purpose and usage.
LineRenderer.GetPositions Declaration public int GetPositions (out Vector3[] positions ); Declaration public int GetPositions (out NativeArray<Vector3> positions ); Declaration public int GetPositions (out NativeSlice<Vector3> positions ); Parameters Parameter Description positions The array of po...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c15006e76bb5
unity_docs
xr
In Unity's 'Submit a license request from a command line and browser (Windows)', what is '1) Create a license request file from the command line' and how does it work?
Important : You must run this command from the computer where you installed Unity, but the computer doesn’t need internet access for this step to work. Open a Command Prompt as an administrator. If you lack administrator privilege, make sure you run this procedure’s command from within your user profile folder. Make su...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_af65056b3061
unity_docs
rendering
What is `Rendering.RayTracingInstanceMaterialConfig.renderQueueUpperBound` in Unity? Explain its purpose and usage.
RayTracingInstanceMaterialConfig.renderQueueUpperBound public int renderQueueUpperBound ; Description The upper limit of a render queue interval. Together with the RayTracingInstanceMaterialConfig.renderQueueLowerBound value, this value is used to determine the Material type. Additional resources: RayTracing...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4e814b82c1b9
unity_docs
xr
In Unity's 'Details panel reference (feature sets)', what is 'Package version overrides' and how does it work?
Feature sets are collections of packages that work well together for a specific version of Unity, which means the Package Manager installs specific package versions that your feature set requires. However, there are a couple of reasons why the Package Manager might actually install a different version (override the req...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0fd8fc7c4b24
unity_docs
editor
Show me a Unity C# example demonstrating `Android.AndroidProjectFiles.AdditionalLibrariesBuildGradleFiles`.
adle files that were added to plug-ins (libraries) that didn't have a build.gradle file. Files are located in unityLibrary/{pluginName}/build.gradle . If you have a plug-in called myLibrary that doesn't contain build.gradle file, the file will be generated and placed in unityLibrary/mylibrary.androidlib/buil...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_122424ea0c11
unity_docs
rendering
What is `LightTransport.BufferSlice_1.UnsafeReinterpret` in Unity? Explain its purpose and usage.
BufferSlice<T0>.UnsafeReinterpret Declaration public BufferSlice<U> UnsafeReinterpret (); Returns BufferSlice<U> An alias of the same slice, but reinterpreted as the target type. Description Reinterpret the slice as having a different data type (type punning), but does not check if the reinterpret is valid...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8ac7362b53a2
unity_docs
scripting
What is `Search.PropertyDatabase.CreateRecordKey` in Unity? Explain its purpose and usage.
PropertyDatabase.CreateRecordKey Declaration public static Search.PropertyDatabaseRecordKey CreateRecordKey (string documentId , string propertyPath ); Parameters Parameter Description documentId A document identifier. propertyPath A property path or name. Returns PropertyDatabaseRecordKey The recor...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6fbb0ab2a95c
unity_docs
scripting
What is `UIElements.NavigationEventBase_1.actionKey` in Unity? Explain its purpose and usage.
NavigationEventBase<T0>.actionKey public bool actionKey ; Description Gets a boolean value that indicates whether the platform-specific action key is pressed. True means the action key is pressed. False means it isn't. The platform-specific action key is Cmd on macOS, and Ctrl on all other platforms.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4bbb3da9474d
unity_docs
scripting
What is `AndroidJNIHelper.Unbox` in Unity? Explain its purpose and usage.
AndroidJNIHelper.Unbox Declaration public static void Unbox (IntPtr obj , out sbyte value ); Declaration public static void Unbox (IntPtr obj , out short value ); Declaration public static void Unbox (IntPtr obj , out int value ); Declaration public static void Unbox (IntPtr obj , out long value ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1aada5c722d7
unity_docs
animation
What is `Animations.AnimationClipPlayable.SetApplyPlayableIK` in Unity? Explain its purpose and usage.
AnimationClipPlayable.SetApplyPlayableIK Declaration public void SetApplyPlayableIK (bool value ); Description Requests OnAnimatorIK to be called on the animated GameObject. When OnAnimatorIK is called the layer index parameter will always be zero.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c90ac8bd094e
unity_docs
ui
In Unity's 'SliderInt', what is 'Keyboard Shortcuts' and how does it work?
You can use keyboard shortcuts to navigate and adjust the SliderInt control. The following table lists the keyboard shortcuts: Shortcut Action Arrow Keys Move by 1/100 of the entire range. Arrow Keys + Shift Move by 1/10 of the entire range. Home Jump to the start of the slider. End Jump to the end of the slider. Page ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f94e8b2646c9
unity_docs
input
What is `Touch.maximumPossiblePressure` in Unity? Explain its purpose and usage.
Touch.maximumPossiblePressure public float maximumPossiblePressure ; Description The maximum possible pressure value for a platform. If Input.touchPressureSupported returns false, the value of this property will always be 1.0f.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1917a63f6e40
unity_docs
scripting
What is `DrivenRectTransformTracker` in Unity? Explain its purpose and usage.
DrivenRectTransformTracker struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description A component can be designed to drive a RectTransform. The DrivenRectTransformTracker struct is used to specify which RectTransforms it is driving. Driving a RectTransform means that the values of the driven Rec...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_82f8168bf09a
unity_docs
ui
Show me a Unity code example for 'ToolbarPopupSearchField'.
arMenu and ToolbarSearchField . You can add logic to the dropdown menu to filter the search results. To pop up the menu, the user hovers over the magnifying glass icon. ## Create a ToolbarPopupSearchField You can create a ToolbarPopupSearchField with UI Builder, UXML, or C#. The following C# example creates a Toolbar...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_195a346e5636
unity_docs
physics
What is `Collider2D.OnCollisionExit2D` in Unity? Explain its purpose and usage.
Collider2D.OnCollisionExit2D(Collision2D) Parameters Parameter Description other The Collision2D data associated with this collision. Description Sent when a collider on another object stops touching this object's collider (2D physics only). Further information about the objects involved is reported in the Col...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f4d1ec206d0b
unity_docs
xr
In Unity's 'Set up your IIS server configuration for Web builds', what is 'Configure your IIS server for compressed Web builds without decompression fallback' and how does it work?
To update your IIS server configuration file so that it works with a compressed Web build without decompression fallback, follow these steps: Use the following server configuration: ```csharp <?xml version="1.0" encoding="UTF-8"?> <configuration> <system.webServer> <!-- Compressed Unity builds without decompression ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_577ef7b50134
unity_docs
rendering
Show me a Unity C# example demonstrating `GL.MultiTexCoord`.
ionality is emulated. The Z component is used only when: 1. You access a cubemap (which you access with a vector coordinate, hence x,y & z). 2. You do "projective texturing", where the X & Y coordinates are divided by Z to get the final coordinate. This would be mostly useful for water reflections and similar thing...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_085e5c1acacb
unity_docs
editor
Show me a Unity C# example demonstrating `Material.parent`.
heir properties from their parent, and can override them on a per property basis. Changing the value of a property of a material will therefore impact all variants below in the hierarchy. This property is only available in the Editor, in a built project all material hierarchies are flattened. Additional resources: Mat...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_47cc29bdfe8b
unity_docs
physics
What is `Physics2D.Raycast` in Unity? Explain its purpose and usage.
Physics2D.Raycast Declaration public static RaycastHit2D Raycast ( Vector2 origin , Vector2 direction , float distance = Mathf.Infinity, int layerMask = DefaultRaycastLayers, float minDepth = -Mathf.Infinity, float maxDepth = Mathf.Infinity); Parameters Parameter Description origin The point in...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1d5684f83359
unity_docs
rendering
What is `TerrainTools.TerrainPaintUtility.EndPaintTexture` in Unity? Explain its purpose and usage.
TerrainPaintUtility.EndPaintTexture Declaration public static void EndPaintTexture ( TerrainTools.PaintContext ctx , string editorUndoName ); Parameters Parameter Description ctx The texture paint context to complete. editorUndoName Unique name used for the undo stack. Description Helper function to co...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.