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_20d91750bb91
unity_docs
rendering
What is `CustomRenderTextureUpdateZone.passIndex` in Unity? Explain its purpose and usage.
CustomRenderTextureUpdateZone.passIndex public int passIndex ; Description Shader Pass used to update the Custom Render Texture for this Update Zone. Additional resources: CustomRenderTexture .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b565028c6e4c
unity_docs
rendering
What is `QualitySettings.billboardsFaceCameraPosition` in Unity? Explain its purpose and usage.
QualitySettings.billboardsFaceCameraPosition public static bool billboardsFaceCameraPosition ; Description If enabled, billboards will face towards camera position rather than camera orientation.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1adb72bde795
unity_docs
xr
Give me an overview of the `VRTextureUsage` class in Unity.
VRTextureUsage enumeration Description This enum describes how the RenderTexture is used as a VR eye texture. Instead of using the values of this enum manually, use the value returned by eyeTextureDesc or other VR functions returning a RenderTextureDescriptor . Properties Property Description None The Rend...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_30a527345f17
unity_docs
editor
Show me a Unity C# example demonstrating `Search.SearchExpression.CreateItem`.
el ); Parameters Parameter Description label Optional label of the SearchItem. This will be displayed in the search Window. value Initial value of the SearchItem. description Optional description of the SearchItem. This will be displayed in the search Window. Returns SearchItem Returns a new SearchItem. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_290addf5758c
unity_docs
rendering
Explain 'Set up a panoramic video' in Unity.
Use a panoramic video to create a more immersive environment in your application. To set up a panoramic video for use in Unity, follow these steps: Create a Video Player for your panoramic video . If your video has an equirectangular layout, render an equirectangular video to a render texture . If your video has a cube...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_59099a0d22d9
unity_docs
rendering
What is `Experimental.GlobalIllumination.LightType.Rectangle` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. LightType.Rectangle Description A light shaped like a rectangle emitting light into the hemisphere that it is facing.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7f97efd47282
unity_docs
scripting
Show me a Unity C# example demonstrating `ControllerColliderHit.collider`.
ControllerColliderHit.collider public Collider collider ; Description The collider that was hit by the controller. ```csharp using UnityEngine;public class Example : MonoBehaviour { void OnControllerColliderHit(ControllerColliderHit hit) { // Call a damage function on the object we hit. hit.gameObject.Sen...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5fdd5bf724f2
unity_docs
editor
In Unity's 'Contextual menu events', what is 'Examples' and how does it work?
The following example creates a custom Editor window with two labels and adds contextual menus for each label. The example demonstrates how to add, remove, and update a contextual menu. Create a Unity project with any template. In the Project window , create a folder named Editor . In the Editor window, create a C# scr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_df8200eb7bc1
unity_docs
editor
What are the parameters of `HandleUtility.PickGameObject` in Unity?
Returns GameObject The GameObject that is under the requested position. Description Pick game object closest to specified position. HandleUtility.PickGameObject must not be called during a repaint. In most cases it is appropriate to call during EventType.MouseDown or EventType.MouseUp . ```csharp using UnityEditor; usi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9fbb82900eb2
unity_docs
rendering
Show me a Unity C# example demonstrating `LightingSettings`.
m or the Enlighten Realtime Global Illumination system, it uses settings from a LightingSettings object. The same LightingSettings object can be assigned to more than one Scene, which makes it possible to share settings across multiple Scenes. The following example shows how to create a LightingSettings object an...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1a1fd0c07d0c
unity_docs
ui
What is `TerrainTools.TerrainPaintTool_1.OnPaint` in Unity? Explain its purpose and usage.
TerrainPaintTool<T0>.OnPaint Declaration public bool OnPaint ( Terrain terrain , TerrainTools.IOnPaint editContext ); Parameters Parameter Description terrain Active Terrain object. editContext Interface used to communicate between Editor and Paint tools. Returns bool Return true to temporarily hid...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_08f5b44b9c14
unity_docs
scripting
In Unity's 'Introduction to SerializedObject data binding', what is 'CallBind()' and how does it work?
You can call Bind() to bind an element to a SerializedObject . Before you bind an element, you must set the binding path and create a SerializedObject. Use this method if you don’t have easy access to the SerializedProperty for the binding. Refer to Create a binding with a C# script for an example. The Bind() extension...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6f8855dec05a
unity_docs
scripting
In Unity's 'AssetBundle file format reference', what is 'AssetBundle files' and how does it work?
The AssetBundle file is an archive file that contains multiple files which loads in assets at runtime. The following diagram contains an example of an AssetBundle file layout: It contains a series of nested containers, where the outermost is an instance of the archive file system with the same name as the AssetBundle. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_44bf28e44874_doc_1
github
scripting
What does `ResetInteractable` do in this Unity script? Explain its purpose and signature.
Call this function to update interactable state of the button. Signature: ```csharp private void ResetInteractable(bool boolean) ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_afe0fcb8337e
unity_docs
editor
What is `TerrainTools.TerrainPaintTool_1.OnSceneGUI` in Unity? Explain its purpose and usage.
TerrainPaintTool<T0>.OnSceneGUI Declaration public void OnSceneGUI ( Terrain terrain , TerrainTools.IOnSceneGUI editContext ); Parameters Parameter Description terrain Active Terrain object. editContext Interface for communication between Editor and Paint tools. Description Custom terrain tool OnScen...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4bed9e025617
unity_docs
rendering
What is `LightTransport.InputExtraction.ExtractFromScene` in Unity? Explain its purpose and usage.
InputExtraction.ExtractFromScene Declaration public static bool ExtractFromScene (out LightTransport.InputExtraction.BakeInput bakeInput ); Parameters Parameter Description bakeInput Output parameter that receives the extracted scene data. Returns bool True if extraction completed successfully, false i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_627ef8ffa308
unity_docs
rendering
What is `Texture3D.SetPixels32` in Unity? Explain its purpose and usage.
Texture3D.SetPixels32 Declaration public void SetPixels32 (Color32[] colors , int miplevel ); Declaration public void SetPixels32 (Color32[] colors ); Parameters Parameter Description colors The array of pixel colours to use. This is a 3D texture flattened to a 1D array. miplevel The mipmap level to...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_799bded27504
github
scripting
Write a Unity C# MonoBehaviour script called Random Spawn
```csharp using UnityEngine; using System.Collections; public class RandomSpawn : MonoBehaviour { public GameObject spawnPrefab; public float rate = 10f; public float chance = 75f; private float min = 0f; private float max = 100f; void Start() { InvokeRepeating("CheckSpawn", 0f, ra...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_man_3b93ea8f36f7
unity_docs
rendering
In Unity's 'Localization', what is 'Description' and how does it work?
Use the Localization package to easily configure localization settings for your application. Add support for multiple languages and regional variants, including: String localization: Set different strings to display based on locale. Use the Smart Strings feature to add logic to automatically replace specific strings, s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c9dce3546dce
unity_docs
math
Show me a Unity C# example demonstrating `Mathf.Deg2Rad`.
Mathf.Deg2Rad public static float Deg2Rad ; Description Degrees-to-radians conversion constant (Read Only). This is equal to (PI * 2) / 360 . Additional resources: Rad2Deg constant. ```csharp using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { public float deg = 30.0F; ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6d0115138568
unity_docs
rendering
Explain 'Frame Debugger window reference' in Unity.
The Frame Debugger window is the user interface for Unity’s Frame Debugger. It shows the rendering event information and controls the playback of the frame under construction. You can access the Frame Debugger window via the Game view control bar or the Window > Analysis > Frame Debugger menu. Label Description A Enabl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_af1b4033e78d
unity_docs
scripting
What is `Playables.PlayableExtensions.IsValid` in Unity? Explain its purpose and usage.
PlayableExtensions.IsValid Declaration public static bool IsValid (U playable ); Parameters Parameter Description playable The Playable used by this operation. Returns bool True if the Playable is properly constructed by the PlayableGraph and has not been destroyed, false otherwise. Description ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fb6e7146a901
unity_docs
scripting
What is `UIElements.PanelScreenMatchMode` in Unity? Explain its purpose and usage.
PanelScreenMatchMode enumeration Description Options that specify how to scale the panel area when the aspect ratio of the current screen resolution does not match the reference resolution. See PanelSettings.screenMatchMode . Properties Property Description MatchWidthOrHeight Scales the panel area using ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5ddb2033b4d3
unity_docs
rendering
In Unity's 'Set the color channels the GPU renders to', what is 'Examples' and how does it work?
``` Shader "Examples/CommandExample" { SubShader { // The rest of the code that defines the SubShader goes here. Pass { // Enable writing only to the RGB channels for this Pass, which disables writing to the alpha channel ColorMask RGB // The rest of the code that defines the Pass goes here. } } } ``` This...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a18a31c5321a
unity_docs
performance
In Unity's 'Job dependencies', what is 'Combining dependencies' and how does it work?
If a job has a lot of dependencies, you can use the method JobHandle.CombineDependencies to merge them. CombineDependencies allows you to pass dependencies onto the Schedule method. ``` NativeArray<JobHandle> handles = new NativeArray<JobHandle>(numJobs, Allocator.TempJob); // Populate `handles` with `JobHandles` from...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_adfb9b23fe60
unity_docs
scripting
What is `Pool.GenericPool_1` in Unity? Explain its purpose and usage.
GenericPool<T0> class in UnityEngine.Pool / Implemented in: UnityEngine.CoreModule Description Provides a static implementation of ObjectPool<T0> . The GenericPool has collection checks enabled that ensure that when an instance is released it is not already in the pool. Note this is not thread-safe. Additional...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_25450698e7e6
unity_docs
rendering
Explain 'ShaderLab: legacy lighting' in Unity.
The material and lighting parameters are used to control the built-in vertex lighting. Vertex lighting is the standard Direct3D/OpenGL lighting model that is computed for each vertex. Lighting on turns it on. Lighting is affected by Material block, ColorMaterial and SeparateSpecular commands. Vertex Coloring & Lighting...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c933759de98a
unity_docs
editor
What are the parameters of `AssetDatabase.UnregisterCustomDependencyPrefixFilter` in Unity?
Returns uint Number of custom dependencies removed. Description Removes custom dependencies that match the prefixFilter. ```csharp using UnityEngine; using UnityEditor; using UnityEngine.Assertions; public class CustomDependenciesExample { public static void AddAndRemoveCustomDependencies() { // Example...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_50860e479930
unity_docs
scripting
What are the parameters of `Handles.DrawLine` in Unity?
Description Draws a line from p1 to p2 . The Handles.color and Handles.matrix properties colorize and additionally transform the line position. Unity ignores DrawLine (that is, nothing happens) when the current GUI event type is not Repaint . Draw Line in the Scene View. Below is an example of an Editor script that dra...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_65c28d909ef0
unity_docs
physics
Give me an overview of the `CustomRenderTextureManager` class in Unity.
CustomRenderTextureManager class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Custom Render Texture Manager. It will allow you to retrieve a lot of information about running Custom Render Textures. Static Methods Method Description GetAllCustomRenderTextures Populate the list in param...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d6d9f8ff775f
unity_docs
scripting
Show me a Unity C# example demonstrating `Search.SearchProvider`.
SearchProvider class in UnityEditor.Search Implements interfaces: ISerializationCallbackReceiver Description SearchProvider manages search for specific types of items and manages all fields of a SearchItem such as thumbnails, descriptions, subfilters. A first example that allows to search for specific prefabs an...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7082edb2b9e8
unity_docs
rendering
Explain 'Set the color channels the GPU renders to' in Unity.
By default, the GPU writes to all channels (RGBA). For some effects you might want to leave certain channels unmodified; for example, you can disable color rendering to render uncolored shadows. Another common use case is to disable color writes completely so that you can populate one buffer with data without writing t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_6910d9d9a9ea_doc_19
github
scripting
What does `OnMouseUpAsButtonAsObservable` do in this Unity script? Explain its purpose and signature.
OnMouseUpAsButton is only called when the mouse is released over the same GUIElement or Collider as it was pressed. Signature: ```csharp public static IObservable<Unit> OnMouseUpAsButtonAsObservable(this Component component) ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_672a44e51a1d
unity_docs
rendering
What is `TrailRenderer.SetPosition` in Unity? Explain its purpose and usage.
TrailRenderer.SetPosition Declaration public void SetPosition (int index , Vector3 position ); Parameters Parameter Description index Which position to set. position The new position. Description Set the position of a vertex in the trail. You can only use this method to modify existing positions in ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_08935a4dd169
unity_docs
editor
What is `EditorGUILayout.HelpBox` in Unity? Explain its purpose and usage.
EditorGUILayout.HelpBox Declaration public static void HelpBox (string message , MessageType type ); Declaration public static void HelpBox ( GUIContent content , bool wide ); Declaration public static void HelpBox (string message , MessageType type , bool wide ); Parameters Parameter Descri...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2929186ea14c
unity_docs
ui
Show me a Unity C# example demonstrating `GUISkin.horizontalSlider`.
GUISkin.horizontalSlider public GUIStyle horizontalSlider ; Description Style used by default for the background part of GUI.HorizontalSlider controls. The padding property is used to determine the size of the area the thumb can be dragged within. ```csharp using UnityEngine;public class Example : MonoBeh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_55884aba1caa
unity_docs
rendering
Show me a Unity C# example demonstrating `EditorUtility.FocusProjectWindow`.
EditorUtility.FocusProjectWindow Declaration public static void FocusProjectWindow (); Description Brings the project window to the front and focuses it. This is commonly called after a menu item that creates and selects an asset is invoked. Changes the color of the selected GameObjects. ```csharp using Unity...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e9af0ff62455
unity_docs
scripting
In Unity's 'How Unity uses serialization', what is 'Hot reloading' and how does it work?
Hot reloading of script code is performed as part of an asset database refresh. It refers to the process of reloading and applying code changes directly while the Editor is running, without having to restart it. For more information, refer to Refreshing the Asset Database and Hot reloading . Note : Hot reloading is a s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_60225862f23e
unity_docs
xr
What is `XR.InputDevices.GetDevices` in Unity? Explain its purpose and usage.
InputDevices.GetDevices Declaration public static void GetDevices (List<InputDevice> inputDevices ); Parameters Parameter Description inputDevices A List of type InputDevices to receive the available input devices. Description Gets a list of active input devices available to the XR Input Subsystem.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8d670d1d27b5
unity_docs
ui
What is `UIElements.ListView.unbindItem` in Unity? Explain its purpose and usage.
ListView.unbindItem public Action<VisualElement,int> unbindItem ; Description Callback for unbinding a data item from the VisualElement. The method called by this callback receives the VisualElement to unbind, and the index of the element to unbind it from. Note: : Setting this callback without also sett...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1e08dd35c9fe
unity_docs
animation
What is `ModelImporterAnimationType` in Unity? Explain its purpose and usage.
ModelImporterAnimationType enumeration Description Animation mode for ModelImporter . Additional resources: ModelImporter.animationType . Properties Property Description None Generate no animation data. Legacy Generate a legacy animation type. Generic Generate a generic animator. Human Generate a human an...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9589b33935ac
unity_docs
rendering
In Unity's 'Set a shader to require GPU features', what is 'DirectX12 (DX12), Vulkan and Metal graphics APIs features' and how does it work?
Note: If you use the following shader keywords, Unity compiles shaders using the DXC compiler. DXC support in Unity is experimental, not supported on all platforms, and not ready for production use. If you use the DirectX12 (DX12), Vulkan or Metal graphics APIs, you can use a shader keyword to target the following GPU ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f9623147cb46
unity_docs
editor
In Unity's 'Web development and publishing process', what is 'Set up a testing environment' and how does it work?
Browser security policies restrict loading scripts from file:// URLs, so you can’t open a Web build directly from your file system by double-clicking index.html . To test your project, do either of the following: Use the Build and Run option in the Unity Editor’s Build Profiles window. Run your own web server. If you r...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c206adb68dbe
unity_docs
physics
What is `AI.NavMesh` in Unity? Explain its purpose and usage.
NavMesh class in UnityEngine.AI / Implemented in: UnityEngine.AIModule Description Singleton class to access the baked NavMesh. Use the NavMesh class to perform spatial queries such as pathfinding and walkability tests. This class also lets you set the pathfinding cost for specific area types, and tweak the glo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_97c1aa6f4bac
unity_docs
scripting
Show me a Unity code example for 'Managed plug-ins'.
f the project. Make the Unity DLLs available to your script. In Visual Studio, open the contextual menu for References in the Solution Explorer and select Add Reference > Browse > Select File . Select the required .dll file, located in the UnityEngine folder. ## Coding the DLL For this example, rename the default cla...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b31e2a0569c7
unity_docs
rendering
What is `GUILayout.Toggle` in Unity? Explain its purpose and usage.
GUILayout.Toggle Declaration public static bool Toggle (bool value , Texture image , params GUILayoutOption[] options ); Declaration public static bool Toggle (bool value , string text , params GUILayoutOption[] options ); Declaration public static bool Toggle (bool value , GUIContent content , p...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9591876805b0
unity_docs
performance
What is `Unity.Collections.NativeArray_1.ReadOnly.AsReadOnlySpan` in Unity? Explain its purpose and usage.
NativeArray<T0>.AsReadOnlySpan Declaration public ReadOnlySpan<T> AsReadOnlySpan (); Returns ReadOnlySpan<T> A System.ReadOnlySpan<T> . Description Exposes ReadOnly data as a System.ReadOnlySpan<T> .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_aa2830fd791f
unity_docs
scripting
Show me a Unity C# example demonstrating `Application.unloading`.
Application.unloading Description Unity raises this event when the Player is unloading. Add an event handler to this event if you want to trigger events to Application.Unload calls. The event is raised after a call to Application.Unload is made, right before the unloading starts. Note: The Application.unloadi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_2985ad9ed13a
github
scripting
Write a Unity C# XR/VR script for OVR Mesh
```csharp /* * Copyright (c) Meta Platforms, Inc. and affiliates. * All rights reserved. * * Licensed under the Oculus SDK License Agreement (the "License"); * you may not use the Oculus SDK except in compliance with the License, * which is provided at the time of installation or download, or which * otherwise a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9849c596ceb5
unity_docs
rendering
What is `Tilemaps.TilemapRenderer.Mode.SRPBatch` in Unity? Explain its purpose and usage.
TilemapRenderer.Mode.SRPBatch Description Sends batchable Sprites from the Tilemap in chunks to be rendered and can be batched using the Scriptable Render Pipeline (SRP) batching system. Use this mode if you are using a Scriptable Render Pipeline (SRP) and want Sprites on the Tilemap batch with other related Rend...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0e11c95fc0a7
unity_docs
scripting
What is `XR.InputDevices.deviceConnected` in Unity? Explain its purpose and usage.
InputDevices.deviceConnected Parameters Parameter Description value The InputDevice that just connected. Description Defines the delegate to use to register events when an InputDevice is connected. This delegate allows you to receive device connection events, so you know when the list of devices changes.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_29b6b2a8ea03
unity_docs
scripting
What is `ParticleSystem.Particle.axisOfRotation` in Unity? Explain its purpose and usage.
ParticleSystem.Particle.axisOfRotation public Vector3 axisOfRotation ; Description Mesh particles rotate around this axis. Mesh particles travel around an axis set up for each particle. ```csharp using UnityEngine;[RequireComponent(typeof(ParticleSystem))] public class ExampleClass : MonoBehaviour { pub...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bed84a8934e0
unity_docs
physics
What are the parameters of `Collider2D.OnCollisionEnter2D` in Unity?
Description Sent when an incoming collider makes contact with this object's collider (2D physics only). Further information about the collision is reported in the Collision 2D parameter passed during the call. Notes: Collision events will be sent to disabled MonoBehaviours, to allow enabling Behaviours in response to c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7c0bdda40cbb
unity_docs
physics
In Unity's 'The Package Manager window', what is 'Status bar' and how does it work?
The Package Manager displays messages in the status bar at the bottom of the Package Manager window. There are typically four status messages that the Package Manager might display: The first time you open the Package Manager window in a new project, the Refreshing list message appears briefly: Message for refreshing p...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_743ff1d5b001
unity_docs
xr
Explain 'Player' in Unity.
The Player settings window (menu: Edit > Project Settings > Player ) contain settings that determine how Unity builds and displays your final application. You can use the PlayerSettings API to control most of the settings available in this window. ## General settings The Player settings differ between the platform mo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b571da33dfdc
unity_docs
scripting
What is `UIElements.ToolbarPopupSearchField` in Unity? Explain its purpose and usage.
ToolbarPopupSearchField class in UnityEditor.UIElements / Inherits from: UIElements.ToolbarSearchField Implements interfaces: IToolbarMenuElement Description The pop-up search field for the toolbar. The search field includes a menu button. For more information, refer to UXML element ToolbarPopupSearchField . ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ae4e74cd25b9
unity_docs
editor
What is `InSceneAssetUtility.CreateAssetFromInSceneAsset` in Unity? Explain its purpose and usage.
InSceneAssetUtility.CreateAssetFromInSceneAsset Declaration public static bool CreateAssetFromInSceneAsset ( Object inSceneAsset , string filePath ); Parameters Parameter Description inSceneAsset The in-scene asset object to convert to a project asset. filePath The file path for the new asset. The path i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_931cea5d2542
unity_docs
xr
In Unity's 'Garbage collector overview', what is 'Temporary allocations' and how does it work?
It’s common for an application to allocate temporary data to the managed heap in each frame but temporary allocations can affect the performance of the application. For example, if a program allocates 1 KB of temporary memory each frame, and it runs at 60 frames per second , then it must allocate 60 KB of temporary mem...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_11a6347ed910
unity_docs
editor
In Unity's 'Create your own overlay', what is 'Example' and how does it work?
This example is of an overlay named Element Toolbars Example that demonstrates these toolbar elements: EditorToolbarButton EditorToolbarToggle EditorToolbarDropdown EditorToolbarDropdownToggle Each toolbar element is created as a standalone class and then added to the overlay panel. This overlay: Can be arranged as a p...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f4f8f99689a8
unity_docs
scripting
What is `Categorization.CategoryInfoAttribute` in Unity? Explain its purpose and usage.
CategoryInfoAttribute class in UnityEngine.Categorization / Implemented in: UnityEngine.CoreModule Description Provide a information to order and categorize at category level. Categories will be sorted using first the Order property, and if equals, using then the Name. See also IRenderPipelineGraphicsSettings ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4f4d6b6d45c3
unity_docs
scripting
Show me a Unity code example for 'Format of text serialized files'.
d the documentation on UnityYAML . The file writes each Object in a Scene as a separate YAML document. The --- sequence introduces each Object in the file. In this context, the term “Object” refers to GameObjects , Components and other scene data collectively: each of these items needs its own YAML document in the scen...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_30526fd8fe74
unity_docs
scripting
Give me an overview of the `AudioSource` class in Unity.
AudioSource class in UnityEngine / Inherits from: Behaviour / Implemented in: UnityEngine.AudioModule Description A representation of audio sources in 3D. Attach an AudioSource to a GameObject to play back sounds in a 3D environment. To play 3D sounds you also need to have an AudioListener . Usually, you ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ccef38c6e311
unity_docs
networking
What is `Networking.PlayerConnection.EditorConnection.Register` in Unity? Explain its purpose and usage.
EditorConnection.Register Declaration public void Register (Guid messageId , UnityAction<MessageEventArgs> callback ); Parameters Parameter Description messageId The message ID that invokes the callback when received by the Editor. callback Action that is executed when a message with ID messageId is rec...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ce1523793a26
unity_docs
ui
Show me a Unity code example for 'Introduction to USS'.
sists of the following: Style rules that include a selector and a declaration block. Selectors that identify which visual element the style rule affects. A declaration block, inside curly braces, that has one or more style declarations. Each style declaration has a property and a value. Each style declaration ends with...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c5ccaafb18cb
unity_docs
math
What are the parameters of `Graphics.RenderPrimitivesIndexedIndirect` in Unity?
Description Renders indexed primitives with GPU instancing and a custom shader with rendering command arguments from commandBuffer . This function allows you to control rendering command arguments from the GPU to render a given number of indexed primitives and instances. Use RenderParams.worldBounds to define bounds to...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_94395804edb1
unity_docs
performance
What are the parameters of `Unity.Profiling.ProfilerRecorder.CopyTo` in Unity?
Returns int Returns the count of the copied elements. Description Copies collected samples to the destination array. ```csharp using Unity.Profiling;public class ExampleScript { static double GetRecorderFrameAverage(ProfilerRecorder recorder) { var samplesCount = recorder.Capacity; if (samplesCo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9ec09986164d
unity_docs
rendering
What is `Search.FetchPreviewOptions.Large` in Unity? Explain its purpose and usage.
FetchPreviewOptions.Large Description Indicates that the preview resolution should be higher than 256x256. ``` static Texture2D FetchPreview(SearchItem item, SearchContext context, Vector2 size, FetchPreviewOptions options) { var obj = ObjectFromItem(item); if (obj == null) return item.thumbnail; var assetPath...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_29320295c6f3
unity_docs
editor
What is `MPE.ChannelClient.Tick` in Unity? Explain its purpose and usage.
ChannelClient.Tick Declaration public void Tick (); Description Ticks the ChannelClient. When you call this method, it checks whether any incoming messages from the server need to be processed, and whether any outgoing messages need to be sent to the server. Call this method from the main thread. Call it only i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7e9631268ab1
unity_docs
scripting
Explain 'Windows Player: IL2CPP Scripting Backend' in Unity.
You can use IL2CPP as an alternative to Mono for scripting backend when building projects for Windows Player. When you build a Project using IL2CPP, Unity converts IL code from scripts and assemblies to C++ before creating a native binary. See IL2CPP for more information. ## C++ source code plugins for IL2CPP You can...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b87ed20fdcef
unity_docs
ui
Show me a Unity code example for 'Get custom styles in C# scripts'.
ty (variables) applied to an element. However, you can’t directly query it as you would with VisualElement.style or VisualElement.resolvedStyle . Instead, do the following: Register to the CustomStyleResolvedEvent event. Call the TryGetValues method to query the returned object of the element.customStyle property. Assu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1dd73ec447be
unity_docs
rendering
What is `ShaderUtil.GetRayGenerationShaderName` in Unity? Explain its purpose and usage.
ShaderUtil.GetRayGenerationShaderName Declaration public static string GetRayGenerationShaderName ( Rendering.RayTracingShader s , int shaderIndex ); Parameters Parameter Description s The RayTracingShader instance. shaderIndex The ray generation Shader index for which to retrieve the name. The ray gen...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9c4eea1d008b
unity_docs
scripting
Give me an overview of the `TransferFunction` class in Unity.
TransferFunction enumeration Description Contains electro-optical transfer function options. Properties Property Description sRGB sRGB transfer function. BT1886 ITU-R BT.1886 transfer function. PQ SMPTE ST 2084 transfer function. Linear Linear transfer function. Gamma22 Gamma 2.2 transfer function.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_331a79d7a51b
unity_docs
animation
What is `Animator.SetLookAtPosition` in Unity? Explain its purpose and usage.
Animator.SetLookAtPosition Declaration public void SetLookAtPosition ( Vector3 lookAtPosition ); Parameters Parameter Description lookAtPosition The position to lookAt. Description Sets the look at position.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bd27c06c4f4a
unity_docs
scripting
Show me a Unity C# example demonstrating `Space.Self`.
wn local axes, taking its orientation into account. For example, Transform.Translate(Vector3.forward, Space.Self) adds one unit to the object's Transform.localPosition on the z-axis of the object, which may differ from the z-axis of the scene depending on the object's orientation. To transform a GameObject relat...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1c99d3e40b9f
unity_docs
ui
What is `GUIStyle.font` in Unity? Explain its purpose and usage.
GUIStyle.font public Font font ; Description The font to use for rendering. If null, the default font for the current GUISkin is used instead. ```csharp using UnityEngine;public class Example : MonoBehaviour { // Prints name of the font that button is using. void OnGUI() { Debug.Log("Font name: " + GUI....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d8a1a64035d6
unity_docs
editor
Show me a Unity code example for 'Build an iOS application'.
Xcode project, you can build and run the Xcode project from the command line. To do this, use the following steps: Open a Terminal window. Navigate to the Xcode project directory. Find the device ID of the device you want to run the application on. You can find this in Xcode under Window > Devices and Simulators . Ente...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c764515edde6
unity_docs
editor
What is `Device.SystemInfo.supportsAsyncGPUReadback` in Unity? Explain its purpose and usage.
SystemInfo.supportsAsyncGPUReadback public static bool supportsAsyncGPUReadback ; Description This has the same functionality as SystemInfo.supportsAsyncGPUReadback 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_eb1ba7969e92
unity_docs
editor
What is `CacheServerConnectionChangedParameters` in Unity? Explain its purpose and usage.
CacheServerConnectionChangedParameters struct in UnityEditor Description Struct used for AssetDatabase.cacheServerConnectionChanged . ```csharp using UnityEngine; using UnityEditor;public class CacheServerConnectionChangedExample { [MenuItem("AssetDatabase/Correct connection to the Cache Server")] static void ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d53fe97dbf68
unity_docs
rendering
Show me a Unity C# example demonstrating `Shader.EnableKeyword`.
that takes a string as a parameter is slower than the version that takes a GlobalKeyword . If you call this function more than once, it is best practice to create a GlobalKeyword struct, cache it, and use that. The keyword is case-sensitive. The following example creates a GlobalKeyword struct with the name EXAMP...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ec3aaf8016e9
unity_docs
input
What is `TouchScreenKeyboard.hideInput` in Unity? Explain its purpose and usage.
TouchScreenKeyboard.hideInput public static bool hideInput ; Description Will text input field above the keyboard be hidden when the keyboard is on screen? This property is applicable for single line text fields that have assigned keyboard with alphanumeric keys. When TouchScreenKeyboard.hideInputs is set to tr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5d2d06cd909c
unity_docs
scripting
What is `Rendering.SupportedOnRenderPipelineAttribute.isSupportedOnCurrentPipeline` in Unity? Explain its purpose and usage.
SupportedOnRenderPipelineAttribute.isSupportedOnCurrentPipeline public bool isSupportedOnCurrentPipeline ; Description The value is true if the current RenderPipelineAsset supports the attribute.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ddb093e977f8
unity_docs
rendering
Explain 'Best practice for DOTS Instancing shaders in URP' in Unity.
It is best practice to initialize the first 64 bytes of all unity_DOTSInstanceData buffers to zero and leave them unused. This is because the default metadata value that Unity uses for all metadata values not specified during batch creation is zero. Specifically, when a shader loads a zero metadata value from the UNITY...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_6717c2b2efae
github
scripting
Write a Unity C# MonoBehaviour script called Keyboard Input
```csharp using System.Security.Cryptography.X509Certificates; using UnityEngine; namespace RollABall.Components { public class KeyboardInput : MonoBehaviour { public float Horizontal; public float Vertical; } } ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_83eac0c12851
unity_docs
scripting
What is `ReflectionProbe.defaultReflectionSet` in Unity? Explain its purpose and usage.
ReflectionProbe.defaultReflectionSet Description Adds a delegate to get notifications when the default specular Cubemap is changed. This event is now obsolete. You should instead use the defaultReflectionTexture event. Note that mixing this callback and the new defaultReflectionTexture event might cause the event ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_df7a314e4aef
unity_docs
scripting
What is `DisplayInfo` in Unity? Explain its purpose and usage.
DisplayInfo struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description Represents a connected display. Properties Property Description height The display height in pixels. name Human-friendly display name. refreshRate The current refresh rate of the display. width The display width in pixe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0245ef61af70
unity_docs
scripting
What is `XR.XRMeshSubsystem.GetUpdatedMeshTransforms` in Unity? Explain its purpose and usage.
XRMeshSubsystem.GetUpdatedMeshTransforms Declaration public NativeArray<MeshTransform> GetUpdatedMeshTransforms ( Unity.Collections.Allocator allocator ); Parameters Parameter Description allocator The allocator to use for the returned NativeArray. Returns NativeArray<MeshTransform> A new NativeArray of...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5cfd0a3e911e
unity_docs
xr
What are the parameters of `Caching.GetCachedVersions` in Unity?
Description Returns all cached versions of the given AssetBundle. ```csharp using System.Collections; using System.Collections.Generic; using UnityEngine; using UnityEngine.Networking;public class Example : MonoBehaviour { IEnumerator GetCachedVersionExample(string uri) { //Download the bundle U...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_729780fd5ab0
unity_docs
editor
Give me an overview of the `PlayModeStateChange` class in Unity.
PlayModeStateChange enumeration Description Enumeration specifying a change in the Editor's play mode state. Additional resources: PauseState , EditorApplication.playModeStateChanged , EditorApplication.isPlaying . Properties Property Description EnteredEditMode Occurs during the next update of the Editor ap...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a2b81ca4e5cf
unity_docs
scripting
What is `Application.temporaryCachePath` in Unity? Explain its purpose and usage.
Application.temporaryCachePath public static string temporaryCachePath ; Description Contains the path to a temporary data / cache directory (Read Only). This path is unique per Unity project, but it isn't unique for multiple concurrent instances of the same project. To obtain unique temporary paths, use File...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_561a850f3ad5
unity_docs
scripting
What is `Coroutine` in Unity? Explain its purpose and usage.
Coroutine class in UnityEngine / Inherits from: YieldInstruction / Implemented in: UnityEngine.CoreModule Description MonoBehaviour.StartCoroutine returns a Coroutine. Instances of this class are only used to reference these coroutines, and do not hold any exposed properties or functions. A coroutine is a fu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_51d12c5667ab
unity_docs
physics
What is `ColliderErrorState2D` in Unity? Explain its purpose and usage.
ColliderErrorState2D enumeration Description Indicates what (if any) error was encountered when creating a 2D Collider. This error state can be read directly from the 2D Collider via the property: Collider2D.errorState . Properties Property Description None Indicates that no error was encountered, therefore t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9e6f26f4831e
unity_docs
editor
What is `EditorGUI.DisabledScope.ctor` in Unity? Explain its purpose and usage.
EditorGUI.DisabledScope Constructor Declaration public EditorGUI.DisabledScope (bool disabled ); Parameters Parameter Description disabled Boolean specifying if the controls inside the group should be disabled. Description Create a new DisabledScope and begin the corresponding group.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5b10ab9d65b2
unity_docs
physics
In Unity's 'Panel Settings properties reference', what is 'Constant Physical Size' and how does it work?
Set elements stay the same physical size regardless of screen size and resolution.| Parameters Description Reference DPI Set the Reference DPI value to the screen density that your UI was designed for. When the system renders your UI, it tries to find the actual DPI value of the screen, and compares it to the Reference...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6c649c3041db
unity_docs
rendering
What is `Rendering.TierSettings.enableLPPV` in Unity? Explain its purpose and usage.
TierSettings.enableLPPV public bool enableLPPV ; Description Whether Light Probe Proxy Volume should be used. Enabling or disabling this setting will add or remove the UNITY_LIGHT_PROBE_PROXY_VOLUME shader compiler define.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_af59e5e73545
github
scripting
Write a Unity C# script called Plain Mesh
```csharp using UnityEngine; using System.Collections.Generic; using System.Text; namespace PlainSaveLoad { /// <summary> /// Example of a "Plain" version of a Unity component. In this case, PlainMesh stores only /// the vertices, uvs and triangles of its Mesh equivalent, which is enough for many applic...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_6032dcd738eb
unity_docs
scripting
What is `ParticleSystem.LimitVelocityOverLifetimeModule.limitX` in Unity? Explain its purpose and usage.
ParticleSystem.LimitVelocityOverLifetimeModule.limitX public ParticleSystem.MinMaxCurve limitX ; Description Maximum velocity curve for the x-axis. Additional resources: MinMaxCurve . ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(ParticleSystem))] public class ExampleClass ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e1ce46f04492
unity_docs
editor
Show me a Unity C# example demonstrating `AssetDatabase.GetDefaultImporter`.
(string path ); Parameters Parameter Description path Project relative path for the asset. Returns Type Importer type. Description Returns the Default Importer associated with the asset located at the supplied path. When no Importer override is set, then the default importer is used. Additional resource...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_a892fda9d17e
github
scripting
Write a Unity Editor script for Gaussian Splat Validator
```csharp // SPDX-License-Identifier: MIT using System.IO; using GaussianSplatting.Runtime; using Unity.Burst; using Unity.Collections; using Unity.Collections.LowLevel.Unsafe; using Unity.Jobs; using Unity.Mathematics; using UnityEditor; using UnityEngine; using UnityEngine.Experimental.Rendering; namespace Gaussian...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_b6cac67b372b
unity_docs
scripting
What is `Microphone.devices` in Unity? Explain its purpose and usage.
Microphone.devices public static string[] devices ; Description A list of available microphone devices, identified by name. You can use the name with the Start and End functions to specify which microphone you wish to start/stop recording. ```csharp using UnityEngine;public class Example : MonoBehaviour {...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9b818be94bbe
unity_docs
scripting
What is `SearchService.ObjectSelectorSearchContext.editedObjects` in Unity? Explain its purpose and usage.
ObjectSelectorSearchContext.editedObjects public Object[] editedObjects ; Description When the object selector is opened from an Inspector, this property indicates which objects are currently being edited.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.