id
stringlengths
15
22
source
stringclasses
2 values
category
stringclasses
12 values
instruction
stringlengths
22
180
response
stringlengths
100
46.1k
system
stringclasses
5 values
local_man_a7b4de42e68c
unity_docs
rendering
Explain 'Trails module reference' in Unity.
Add trails to a percentage of your particles using this module. ## Properties For some properties in this section, you can use different modes to set their value. For information on the modes you can use, refer to Vary Particle System properties over time . Property: Function: Mode Choose how trails are generated for...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b710f49d359c
unity_docs
rendering
What are the parameters of `AssetDatabase.FindAssets` in Unity?
Returns string[] An array containing the GUIDs of any matching assets in string format. If no matching assets were found, returns empty array. Description Search the asset database using the search filter string. FindAssets allows you to search for Assets. The string argument can provide names, labels or types...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c827e2d5d466
unity_docs
rendering
What is `DetailRenderMode.Grass` in Unity? Explain its purpose and usage.
DetailRenderMode.Grass Description The detail prototype will use the grass shader. When using custom meshes in this mode, control the wave amount by setting vertex color's alpha channel. Grass will take normals from terrain directly underneath it, so that the shading matches the terrain.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_fae3faed32e2
unity_docs
ui
In Unity's 'Receive callbacks when a bound property changes', what is 'Test the binding' and how does it work?
In Unity, select Window > UIToolkitExamples > Simple Binding Property Tracking Example . A custom Editor window appears with a text field. Select any GameObject in your scene. The name of the GameObject appears in your Editor window’s text field. Change the name of the GameObject in the text field. If the name is GameO...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_71cb5d227952
github
scripting
Write a Unity Editor script for Thread Safe
```csharp #if UNITY_EDITOR using UnityEngine; using UnityEditor; namespace Sisus.Init.EditorOnly { /// <summary> /// Provides thread safe alternatives to some of Unity's static properties. /// </summary> public static class ThreadSafe { private static readonly object threadLock = new(); private static bool i...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
gh_6910d9d9a9ea_doc_32
github
scripting
What does `OnCanvasGroupChangedAsObservable` do in this Unity script? Explain its purpose and signature.
Callback that is sent if the canvas group is changed. Signature: ```csharp public static IObservable<Unit> OnCanvasGroupChangedAsObservable(this Component component) ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_man_a61941d3ede1
unity_docs
rendering
Explain 'iOS requirements and compatibility' in Unity.
Learn about the system requirements and compatibility information for iOS to make sure you’re aware of any limitations for developing a Unity application for this platform. ## iOS version support Unity supports iOS 13 and above. For more information, see PlayerSettings.iOS-targetOSVersionString . ## Xcode version su...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_35f8fb3212ea_doc_16
github
scripting
What does `SetToggle` do in this Unity script? Explain its purpose and signature.
Set the toggle state programmatically and invoke the OnToggle event if state changes.Note: This always fires OnToggle, never OnUntoggle, regardless of previous state.True to set toggle ON, false to set toggle OFF. Signature: ```csharp public void SetToggle(bool toggle) ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_man_d197c2cba6e9
unity_docs
ui
In Unity's 'Apply masking effects in UI Toolkit', what is 'Reduce batch breaks for nested masking' and how does it work?
Nested masking occurs when both an element and one or more ancestors define a mask. The intersection of these masks defines the final visibility. You can use this technique to create intricate visual effects or selectively reveal parts of an image based on various criteria. For example, you can define masks to display ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_777a88b9bbb3
unity_docs
editor
What is `PlayerSettings.Android.appCategory` in Unity? Explain its purpose and usage.
PlayerSettings.Android.appCategory public static string appCategory ; Description Specify the category for your application that best represents its primary functionality. Refer to the Android documentation for the available category options. Notes: For new projects, this property is enabled and set to Gam...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_696b93289057
unity_docs
scripting
What is `Unity.Hierarchy.HierarchyNodeTypeHandlerBaseEnumerable` in Unity? Explain its purpose and usage.
HierarchyNodeTypeHandlerBaseEnumerable struct in Unity.Hierarchy / Implemented in: UnityEngine.HierarchyCoreModule Description A read-only collection of hierarchy node type handler base. Public Methods Method Description GetEnumerator Gets an enumerator for the node type handlers.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0c20dd0ae02a
unity_docs
editor
Explain 'Create custom Profiler modules' in Unity.
Customize the Profiler to capture and visualize specific performance data in your application, either with the Profiler Module Editor or through scripts . Topic Description Create a Profiler module Add custom Profiler modules to the Profiler window to collect and display specific data about your application. Create a P...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_798cc847fa25
unity_docs
scripting
What is `UIElements.EventInterestOptions.AllEventTypes` in Unity? Explain its purpose and usage.
EventInterestOptions.AllEventTypes Description Use the EventInterestOptions.AllEventTypes option when the method with an EventInterestAttribute doesn't have a specific filter for the event types it uses, or wants to receive all possible event types. For example, a class that overrides CallbackEventHandler.H...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8430d30add20
unity_docs
scripting
Show me a Unity C# example demonstrating `Pool.ObjectPool_1.Get`.
ct or a new instance if the pool is empty. Description Get an instance from the pool. If the pool is empty then a new instance is created. Calls to Get invoke the delegate passed to the constructor as the actionOnGet parameter. New instances are created according to the logic defined in the delegate passed to ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_80b8c89b505d
unity_docs
scripting
What is `ModelImporter.tangentImportMode` in Unity? Explain its purpose and usage.
Method group is Obsolete ModelImporter.tangentImportMode Obsolete tangentImportMode is deprecated. Use importTangents instead. public ModelImporterTangentSpaceMode tangentImportMode ; Description Tangents import mode. Additional resources: ModelImporterTangentSpaceMode .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_521e7040f5f6
unity_docs
scripting
Show me a Unity C# example demonstrating `Light.range`.
t range ; Description The range of each point of the light. Since area lights have a light emitting surface instead of a single point, the cumulative range of the light is larger than this property. This larger range can be read from the Light.dilatedRange property. For non-area lights, Light.range and Light.d...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5fa1b893eccc
unity_docs
ui
Show me a Unity code example for 'Capture events'.
capture events, and capturing and releasing pointers. To see the example in action, do the following: Under Assets > Scripts > Editor , create a new C# file called CaptureEventsTestWindow.cs Copy the example into the C# script. From the Editor Toolbar, select Window > UI Toolkit > Capture Events Test Window . Click on ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cb6dcc00f946
unity_docs
editor
What is `IMGUI.Controls.PrimitiveBoundsHandle.axes` in Unity? Explain its purpose and usage.
PrimitiveBoundsHandle.axes public IMGUI.Controls.PrimitiveBoundsHandle.Axes axes ; Description Flags specifying which axes should display control handles. By default, all axes are enabled. You can use bitwise operations to enable or disable individual axes. Disabled axes are flattened out. ```csharp using Un...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ea881a5fe63f
unity_docs
editor
What are the parameters of `QualitySettings.GetActiveQualityLevelsForPlatform` in Unity?
Returns int[] The array with the Quality Level indexes that are selected for the given platform. Description [Editor Only] Obtains an array with the Quality Level indexes that are selected for the given platform. ```csharp public int[] GetActiveQualityLevelsForPlatform(BuildTarget platform) { var activeBuildTargetG...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_e850a641932f
github
scripting
Write a Unity C# UI script for Console UI
```csharp using System; using TMPro; using UnityEngine; using UnityEngine.EventSystems; public class ConsoleUI : MonoBehaviour, IDragHandler { [SerializeField] RectTransform _rectTransform; [SerializeField] TMP_Text HeaderText; void Awake() { HeaderText.text = "[o2 Console v1.O] //...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_90783d347518
unity_docs
scripting
What is `Screen.width` in Unity? Explain its purpose and usage.
Screen.width public static int width ; Description The current width of the screen window in pixels (Read Only). This is the actual width of the Player window. In full-screen mode, it also reflects the current resolution. Note : When accessed from the Editor events, such as ContextMenu methods, inspector enab...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c9d736d26bb1
unity_docs
ui
What is `UIElements.RadioButton.inputUssClassName` in Unity? Explain its purpose and usage.
RadioButton.inputUssClassName public static string inputUssClassName ; Description USS class name of input elements in RadioButton elements. Unity adds this USS class to the input sub-element of the RadioButton . The input sub-element provides responses to the manipulator.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_970598624280
unity_docs
rendering
In Unity's 'Material Inspector window reference', what is 'Settings' and how does it work?
Click Material Controls to open the selected Material’s Settings menu. Setting Function Select Shader Move focus to this shader asset in the Project window . This can aid navigation in a Project with many Assets. Edit Shader Open the source file for the shader asset that this Material uses. Select Material Move focus t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_61873ea470ec
unity_docs
rendering
What is `TextureFormat.BGRA32` in Unity? Explain its purpose and usage.
TextureFormat.BGRA32 Description Color with alpha texture format, 8-bits per channel. BGRA32 format is used by WebCamTexture on some platforms. Each of RGBA color channels is stored as an 8-bit value in [0..1] range. In memory, the channel data is ordered this way: B, G, R, A bytes one after another. Additional r...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_72c55d2f5c01
unity_docs
rendering
In Unity's 'Mesh asset Inspector window reference', what is 'Mesh information' and how does it work?
The Mesh Inspector displays information about how the mesh asset stores its data, but not the values in the data itself. For example, the Inspector shows that Unity stores the value for Position as a set of three Float32 values for each vertex, but it doesn’t show the Position value of a specific vertex. Property Descr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d14c0256c345
unity_docs
editor
Explain 'AI' in Unity.
com.unity.modules.ai ## Description The AI module implements the path finding features in Unity. ## Version information Built-in packages are fixed to a single version matching the Editor version.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b7aee9dfc156
unity_docs
scripting
What is `PrefabUtility.IsPartOfImmutablePrefab` in Unity? Explain its purpose and usage.
PrefabUtility.IsPartOfImmutablePrefab Declaration public static bool IsPartOfImmutablePrefab ( Object componentOrGameObject ); Parameters Parameter Description componentOrGameObject The object to check. Must be a component or GameObject. Returns bool True if the object is part of a Prefab that cannot be...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_55d56bf17638
unity_docs
ui
Show me a Unity C# example demonstrating `GUILayout.FlexibleSpace`.
GUILayout.FlexibleSpace Declaration public static void FlexibleSpace (); Description Insert a flexible space element. Flexible spaces use up any leftover space in a layout. Note: This will override the GUILayout.ExpandWidth and GUILayout.ExpandHeight Flexible Space in a GUILayout Area. ```csharp using Uni...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_98c58b3d2bf8
unity_docs
editor
What is `RuntimeInitializeLoadType` in Unity? Explain its purpose and usage.
RuntimeInitializeLoadType enumeration Description Specifies when to get a callback during the startup of the runtime or when entering play mode in the Editor. Used with RuntimeInitializeOnLoadMethodAttribute . See the RuntimeInitializeOnLoadMethodAttribute documentation for the execution order between the vario...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_13781ecdc50e
unity_docs
physics
Explain 'Time' in Unity.
The Time settings (menu: Edit > Project Settings , then the Time category) lets you set a number of properties that control timing within your game. ## Properties Property Description Fixed Timestep A frame rate independent interval that dictates when physics calculations and FixedUpdate events are performed. Maximum...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4addc67811b1
unity_docs
scripting
What is `GUILayout.TextField` in Unity? Explain its purpose and usage.
GUILayout.TextField Declaration public static string TextField (string text , params GUILayoutOption[] options ); Declaration public static string TextField (string text , int maxLength , params GUILayoutOption[] options ); Declaration public static string TextField (string text , GUIStyle style , p...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_658728a421c3
unity_docs
editor
Show me a Unity C# example demonstrating `EditorGUI.DropShadowLabel`.
ition , string text , GUIStyle style ); Declaration public static void DropShadowLabel ( Rect position , GUIContent content , GUIStyle style ); Parameters Parameter Description position Where to show the label. content Text to show @style style to use. Description Draws a label with a drop sh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_54bd5c23093a
unity_docs
scripting
In Unity's 'Structure of a Unity Xcode project', what is 'Classes folder' and how does it work?
The Classes folder contains code that integrates the Unity runtime and Objective-C. Unity stores the entry points of the application in the main.mm and UnityAppController.mm/h files inside this folder. You can create your own AppDelegate derived from UnityAppController , or, if any of your plug-ins include AppControlle...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b01244c056ba
unity_docs
rendering
In Unity's 'Set the depth clip mode in a shader', what is 'Example' and how does it work?
This example code demonstrates the syntax for using this command in a Pass block. ``` Shader "Examples/CommandExample" { SubShader { // The rest of the code that defines the SubShader goes here. Pass { // Sets the GPU's depth clip mode to clamp for this Pass // You would typically do this if you are rendering ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9f9c25db76a0
unity_docs
ui
What are the parameters of `UIElements.TreeView.ctor` in Unity?
Description Creates a TreeView with specified factory methods. Use BaseTreeView.SetRootItems_1 to add content. Declaration public TreeView (int itemHeight , Func<VisualElement> makeItem , Action<VisualElement,int> bindItem ); Parameters Parameter Description itemHeight The item height to use in FixedHeight virtualizati...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_9e709232c7eb
github
scripting
Write a Unity Editor script for FB Display Refresh Rate
```csharp // SPDX-FileCopyrightText: 2024 Michael Nisbet <me@mikesky.dev> // SPDX-License-Identifier: MIT using System; using System.Runtime.InteropServices; using UnityEngine.XR.OpenXR.Features; using UnityEngine; using AOT; using UnityEngine.XR.OpenXR; #if UNITY_EDITOR using UnityEditor; using UnityEditor.XR.OpenX...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_b43fdd4a4df7
unity_docs
scripting
What is `ReflectionProbe.UpdateCachedState` in Unity? Explain its purpose and usage.
ReflectionProbe.UpdateCachedState Declaration public static void UpdateCachedState (); Description Updates the culling system with the ReflectionProbe's current state. This ensures that Unity correctly culls the ReflectionProbe during rendering if you implement your own runtime reflection system. By default, U...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6967333e511b
unity_docs
scripting
Explain 'JAR plug-ins' in Unity.
You can use Java Archive (JAR) plug-ins to interact with the Android OS or to call methods written in Java from C# scripts . Java Archive (JAR) plug-ins contain Java code that you can call from C# scripts. They’re useful if you want to interact with the Android operating system, or just call Java code from C#. This typ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f411c8d48f56
unity_docs
editor
Show me a Unity C# example demonstrating `SerializedProperty.GetFixedBufferElementAtIndex`.
SerializedProperty.GetFixedBufferElementAtIndex Declaration public SerializedProperty GetFixedBufferElementAtIndex (int index ); Description Returns the element at the specified index in the fixed buffer. Additional resources: isFixedBuffer , fixedBufferSize . ```csharp using UnityEngine; using UnityEdito...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dc3e15856195
unity_docs
scripting
Show me a Unity C# example demonstrating `Caching.AddCache`.
Caching.AddCache Declaration public static Cache AddCache (string cachePath ); Parameters Parameter Description cachePath Path to the cache folder. Description Add a cache with the given path. This allows you to add a new cache to the cache list. A reference to a Cache will be returned. ```csharp using...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_863b7cfbadec
unity_docs
scripting
Explain 'Import an Android Archive plug-in' in Unity.
This page describes how to import an Android Archive (AAR) plug-in into your Unity Project. Copy the AAR file to your Unity Project’s Assets folder. Select the AAR in Unity and view it in the Inspector . In the Select platforms for plugin section, select Android . Select Apply .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c6fe461d4ff9
unity_docs
rendering
In Unity's 'Model tab Import Settings reference', what is 'Meshes' and how does it work?
Property Description Mesh Compression Set the level of compression ratio to reduce the file size of the mesh. Increase the compression ratio to lower the precision of the mesh. Unity uses the mesh bounds and a lower bit depth per component to compress the mesh data. This is useful for optimizing game size . The followi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ca7df415b62f
unity_docs
scripting
In Unity's 'ColorField', what is 'Example' and how does it work?
The following UXML example creates a ColorField: ``` <UXML xmlns="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements"> <uie:ColorField label="UXML Field" name="the-uxml-field" /> </UXML> ``` The following C# example illustrates some of the customizable functionalities of the ColorField: ``` /// <sample> // Get ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_83314ab224d5
unity_docs
scripting
What is `GlobalObjectId.TryParse` in Unity? Explain its purpose and usage.
GlobalObjectId.TryParse Declaration public static bool TryParse (string stringValue , out GlobalObjectId id ); Parameters Parameter Description stringValue The string representation of a GlobalObjectId . The following is an example of the string representation: GlobalObjectId_V1-2-74c253e3f16be4776bb2d...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_f967ea1ce9c9
github
scripting
Write a Unity C# MonoBehaviour script called Observable Update Trigger
```csharp using System; // require keep for Windows Universal App using UnityEngine; namespace UniRx.Triggers { [DisallowMultipleComponent] public class ObservableUpdateTrigger : ObservableTriggerBase { Subject<Unit> update; /// <summary>Update is called every frame, if the MonoBehaviour ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_66304c194f0b
unity_docs
scripting
What is `UIElements.TemplateContainer` in Unity? Explain its purpose and usage.
TemplateContainer class in UnityEngine.UIElements / Inherits from: UIElements.BindableElement / Implemented in: UnityEngine.UIElementsModule Description Represents the root VisualElement of UXML file. A TemplateContainer instance is created by Unity to represent the root of the UXML file and acts as the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1ef3164e8e8c
unity_docs
math
Give me an overview of the `Color32` class in Unity.
Color32 struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description Representation of RGBA colors in 32 bit format. Each color component is a byte value with a range from 0 to 255. Components ( r , g , b ) define a color in RGB color space. Alpha component ( a ) defines transparency - alpha of 25...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e143c86cae24
unity_docs
rendering
In Unity's 'Custom Data module reference', what is 'X, Y, Z, and W component dropdown' and how does it work?
Property Description Constant Uses a fixed value throughout the particle’s lifetime. Curve Uses a single curve to change the value over the particle’s lifetime. Random Between Two Constants Uses a random fixed value between two constants throughout the particle’s lifetime. Random Between Two Curves Uses a random curve ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bf2e154a110b
unity_docs
physics
Show me a Unity C# example demonstrating `PhysicsShapeGroup2D.SetShapeAdjacentVertices`.
ty of the selected shape. adjacentStart Sets the PhysicsShape2D.adjacentStart property of the selected shape. adjacentEnd Sets the PhysicsShape2D.adjacentEnd property of the selected shape. Description Sets the adjacent vertices of a shape. NOTE : Calling this on a PhysicsShape2D that does not have a shap...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_67d869053da6
unity_docs
rendering
Give me an overview of the `LightmapsMode` class in Unity.
LightmapsMode enumeration Description Lightmap (and lighting) configuration mode, controls how lightmaps interact with lighting and what kind of information they store. Properties Property Description NonDirectional Light intensity (no directional information), encoded as 1 lightmap. CombinedDirectional Direct...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3db9eeb11f08
unity_docs
scripting
What is `SceneManagement.SceneManager.sceneLoaded` in Unity? Explain its purpose and usage.
SceneManager.sceneLoaded Parameters Parameter Description value A method with the signature MyMethod( Scene , LoadSceneMode ). Description Assign a custom callback to this event to get notifications when a Scene has loaded. Create a custom callback method to receive the notification and assign it to the Scen...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_70adca6ac6aa
unity_docs
performance
What is `LowLevel.PlayerLoopSystem.type` in Unity? Explain its purpose and usage.
PlayerLoopSystem.type public Type type ; Description A System.Type used to identify a Player loop system and label it in the Profiler. Use the type property to identify and retrieve a particular default PlayerLoopSystem when iterating over the default or current Player loop. Custom Player loop systems must...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_78d1d3e76c1b
unity_docs
rendering
What is `LightingSettings.denoiserTypeIndirect` in Unity? Explain its purpose and usage.
LightingSettings.denoiserTypeIndirect public LightingSettings.DenoiserType denoiserTypeIndirect ; Description Determines the denoiser that the Progressive Lightmapper applies to indirect lighting. (Editor only). Use denoising to remove visual noise from your lightmaps. Denoising can reduce the number of samp...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_e770e4ea46ee_doc_10
github
scripting
What does `GetCurrentSDKFolderName` do in this Unity script? Explain its purpose and signature.
Gets current SDK folder name based on the SDK path Signature: ```csharp private static string GetCurrentSDKFolderName() ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_74698f3317d2
unity_docs
physics
What is `JointSuspension2D.angle` in Unity? Explain its purpose and usage.
JointSuspension2D.angle public float angle ; Description The world angle (in degrees) along which the suspension will move. This provides 2D constrained motion similar to a SliderJoint2D. This is typically how suspension works in the real world. Additional resources: Rigidbody2D .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5c2887e81608
unity_docs
animation
What is `AnimationCurve.Constant` in Unity? Explain its purpose and usage.
AnimationCurve.Constant Declaration public static AnimationCurve Constant (float timeStart , float timeEnd , float value ); Parameters Parameter Description timeStart The start time for the constant curve. timeEnd The end time for the constant curve. value The value for the constant curve. Returns ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8fcc45e63991
unity_docs
scripting
Show me a Unity C# example demonstrating `ParticleSystem.NoiseModule.octaveCount`.
ParticleSystem.NoiseModule.octaveCount public int octaveCount ; Description Layers of noise that combine to produce final noise. Please note that adding octaves substantially decreases performance. ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(ParticleSystem))] public class Ex...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0671a441cce6
unity_docs
scripting
Show me a Unity C# example demonstrating `Component.CompareTag`.
Component.CompareTag Declaration public bool CompareTag (string tag ); Parameters Parameter Description tag The tag to compare. Returns bool Returns true if GameObject has same tag. Returns false otherwise. Description Checks the GameObject's tag against the defined tag . ```csharp // Immediate dea...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a4398da3fcc0
unity_docs
performance
What is `Unity.Collections.NativeArray_1.Dispose` in Unity? Explain its purpose and usage.
NativeArray<T0>.Dispose Declaration public void Dispose (); Description Disposes a NativeArray<T0> . This methods disposes the memory owned by a NativeArray<T0> . The behavior of this methods depends on the Allocator used when the NativeArray was created. Declaration public Unity.Jobs.JobHandle Dispose...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a7fe02bc244c
unity_docs
scripting
Explain 'GameObjects' in Unity.
GameObjects are the essential building blocks of any Unity project. Everything you interact with in a Unity scene is a GameObject , from characters and environments, to cameras and lights. GameObjects are simple containers that you add components to, to transform them into the elements of your application. Topic Descri...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_13d91e8e62a1
unity_docs
physics
In Unity's 'Optimizing arrays', what is 'Pass arrays as parameters to methods' and how does it work?
Sometimes it might be convenient to write a method that creates a new array, fills the array with values and then returns it. However, if this method is called repeatedly, then new memory gets allocated each time. The following example code shows an example of a method which creates an array every time it’s called: ```...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c763835a6a38
unity_docs
rendering
Explain 'New in Unity 2023.2' in Unity.
## Release Notes To find out more about the new features, changes, and improvements to this Unity version, refer to the 2023.2 Release Notes . To find the release notes for other releases, refer to the Unity download archive . ## Upgrade Guide If you are upgrading existing projects from 2023.1, read the Upgrade Guid...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_34d86ef50e64
unity_docs
ui
In Unity's 'Screen configuration', what is 'Multi-window mode' and how does it work?
Android’s multi-window mode supports Unity applications. Users can resize the windows that will contain your Unity applications so it’s best practice to make your user interface scale to non-standard aspect ratios and resolutions.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_56dc39dce009
unity_docs
xr
What is `Unity.IO.LowLevel.Unsafe.AsyncReadManagerRequestMetric` in Unity? Explain its purpose and usage.
AsyncReadManagerRequestMetric struct in Unity.IO.LowLevel.Unsafe / Implemented in: UnityEngine.CoreModule Description Metrics for an individual read request. Get metrics records by calling AsyncReadManager.GetMetrics. Properties Property Description AssetName The name of the asset being read. AssetTypeId T...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6d15b054c2cb
unity_docs
editor
What is `MouseCursor.SlideArrow` in Unity? Explain its purpose and usage.
MouseCursor.SlideArrow Description Arrow with small arrows for indicating sliding at number fields. ```csharp //Create a folder and name it “Editor” if this doesn’t already exist //Put this script in the folder//This script creates a new menu (“Examples”) and a menu item (“Mouse Cursor”). Click on this option. This...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f7c9adaf8704
unity_docs
math
Show me a Unity code example for 'Create a Culling Group'.
There are no components or visual tools for working with CullingGroups; they are purely accessible via script. A CullingGroup can be constructed using the ‘new’ operator: ``` CullingGroup group = new CullingGroup(); ``` To have the CullingGroup perform visibility and/or distance calculations, specify the camera it shou...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1b7922456047
unity_docs
scripting
What is `Help.ShowHelpPage` in Unity? Explain its purpose and usage.
Help.ShowHelpPage Declaration public static void ShowHelpPage (string page ); Description Show a help page. page should be the URL of the help page, usually beginning with file:// . If page starts with file:///unity/ , then it points to Unity help. Additional resources: Help.ShowHelpForObject .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_74e3fe7a9c92
unity_docs
editor
What are the parameters of `Profiling.RawFrameDataView.GetSampleMarkerId` in Unity?
Returns int Returns Profiler marker indentifier. Returns invalidMarkerId for invalid index. Description Gets Profiler marker indentifier which uniquely identifies sample name. The Profiler uses unique identifier for each marker created during profiling session. Marker can generate many samples which can be retrieved by...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1ae37092fd03
unity_docs
rendering
What is `Experimental.GlobalIllumination.LightDataGI.range` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. LightDataGI.range public float range ; Description The range of the light. Unused for directional lights.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2e3f56a327b8
unity_docs
editor
Show me a Unity C# example demonstrating `AssemblyReloadEvents`.
AssemblyReloadEvents class in UnityEditor Description This class has event dispatchers for assembly reload events. ```csharp using UnityEditor; using UnityEngine;public class MyWindow : EditorWindow { [MenuItem("Test/Show My Window")] static void Init() { GetWindow<MyWindow>(); } void OnEnable() { Assembly...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a79c60f046b9
unity_docs
math
What is `Rendering.SphericalHarmonicsL2.Evaluate` in Unity? Explain its purpose and usage.
SphericalHarmonicsL2.Evaluate Declaration public void Evaluate (Vector3[] directions , Color[] results ); Parameters Parameter Description directions Array of normalized directions in which to evaluate the spherical harmonics. results Output array for the evaluated values. The order of the results is the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_bafa970747ba
unity_docs
editor
Explain 'Creating AssetBundles' in Unity.
Organize assets into AssetBundles to improve build times and reduce application size. Topic Description Organizing assets into AssetBundles Organizational strategies for managing assets in AssetBundles. Assign assets to an AssetBundle Assign assets to AssetBundles in the Editor or through scripts . Build assets into an...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fc7bc6596cd2
unity_docs
rendering
What is `Rendering.CommandBuffer` in Unity? Explain its purpose and usage.
CommandBuffer class in UnityEngine.Rendering / Implemented in: UnityEngine.CoreModule Description List of graphics commands to execute. Command buffers hold list of rendering commands ("set render target, draw mesh, ..."). They can be set to execute at various points during camera rendering (see Camera.AddComm...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6c9ca53a921e
unity_docs
performance
Explain 'Custom NativeContainer example' in Unity.
The following is a complete example of a custom NativeContainer as an append-only list. It demonstrates basic protection of read and write operations, as well as creating and invalidating aliasing views. For another example, see the NativeContainerAttribute API documentation. ```csharp using System; using System.Runtim...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_9849baf53609
github
scripting
Write a Unity C# ScriptableObject for Heightmap Generator Panel
```csharp /* * HeightmapGeneratorPanel.cs * Created by Arian - GameDevBox * YouTube Channel: https://www.youtube.com/@GameDevBox * * 🎮 Want more Unity tips, tools, and advanced systems? * 🧠 Learn from practical examples and well-explained logic. * 📦 Subscribe to GameDevBox for more game dev content! ...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_197d0d64e965
unity_docs
rendering
What is `LightingSettings.filteringGaussianRadiusAO` in Unity? Explain its purpose and usage.
LightingSettings.filteringGaussianRadiusAO public float filteringGaussianRadiusAO ; Description Specifies the radius the Progressive Lightmapper uses to filter the direct lighting component of the lightmap when you use the Gaussian filter. (Editor only). The default value is 1. The value range is 0.0 to 5.0. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6549e8c973f1
unity_docs
math
What is `Font.GetOSInstalledFontNames` in Unity? Explain its purpose and usage.
Font.GetOSInstalledFontNames Declaration public static string[] GetOSInstalledFontNames (); Returns string[] An array of the names of all fonts installed on the machine. Description Get names of fonts installed on the machine. GetOSInstalledFontNames lets you get the names of all the fonts installed on th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8709ec666016
unity_docs
math
What is `Rendering.BatchCullingOutputDrawCommands.drawRangeCount` in Unity? Explain its purpose and usage.
BatchCullingOutputDrawCommands.drawRangeCount public int drawRangeCount ; Description The number of elements in the BatchCullingOutputDrawCommands.drawRanges array. You must set this in the OnPerformCulling callback.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_75d1c020420c
unity_docs
performance
What is `Unity.Jobs.LowLevel.Unsafe.JobsUtility` in Unity? Explain its purpose and usage.
JobsUtility class in Unity.Jobs.LowLevel.Unsafe / Implemented in: UnityEngine.CoreModule Description Provides methods for creating, running, and debugging jobs. Static Properties Property Description CacheLineSize The size of a cache line. IsExecutingJob Checks if this is in a job. JobCompilerEnabled Set w...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c59ccd07a7a6
unity_docs
rendering
Show me a Unity C# example demonstrating `Rendering.FilteringSettings.ctor`.
exclude all objects. If you call this constructor with one or more parameters, Unity sets any unspecified values to the default. The default value for each property performs no filtering. To create a FilteringSettings struct with all default values, use FilteringSettings.defaultValue . This example demonstrates the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e683157e7e11
unity_docs
physics
What is `CharacterJoint.projectionAngle` in Unity? Explain its purpose and usage.
CharacterJoint.projectionAngle public float projectionAngle ; Description Set the angular tolerance threshold (in degrees) for projection. If the joint deviates by more than this angle around its locked angular degrees of freedom, the solver will move the bodies to close the angle. Setting a very small toleran...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4582b1011076
unity_docs
physics
What is `ArticulationBody.GetJointForces` in Unity? Explain its purpose and usage.
ArticulationBody.GetJointForces Declaration public int GetJointForces (List<float> forces ); Parameters Parameter Description forces Supplied list of floats to read back and store the joint forces data. Returns int Total degrees of freedom for the entire hierarchy of articulation bodies. Description...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_21cff185a79c
unity_docs
editor
What is `iOS.Xcode.PlistElementDict` in Unity? Explain its purpose and usage.
PlistElementDict class in UnityEditor.iOS.Xcode / Inherits from: iOS.Xcode.PlistElement Description Represents a dictionary element in plist document. ```csharp using System; using UnityEditor; using UnityEditor.Callbacks; using UnityEditor.iOS.Xcode;public class PlistDocumentExample { [PostProcessBuild] publ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_21632ce9b91c
unity_docs
rendering
Explain 'Particle movement patterns' in Unity.
Use the Noise module to add turbulence to particle movement. Adding noise to your particles is a simple and effective way to create interesting patterns and effects. For example, imagine how embers from a fire move around, or how smoke swirls as it moves. Strong, high frequency noise could be used to simulate the fire ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ab8a5b071602
unity_docs
scripting
What is `PlayerSettings.preserveFramebufferAlpha` in Unity? Explain its purpose and usage.
PlayerSettings.preserveFramebufferAlpha public static bool preserveFramebufferAlpha ; Description When enabled, preserves the alpha value in the framebuffer to support rendering over native UI. Applies to Android, iOS, Embedded Linux, tvOS, and visionOS platforms.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_97fdb54fd8a5
unity_docs
rendering
In Unity's 'Post-processing effect availability reference', what is 'Post-processing effects and pipeline support' and how does it work?
Effect Name Description Available in URP integrated solution? Available in HDRP integrated solution? Available in PPv2 package? Ambient Occlusion The Ambient Occlusion effect darkens the areas in your scene that are not exposed to ambient lighting. Yes See Universal Render Pipeline: Ambient Occlusion You can also apply...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b1a2af181830
unity_docs
editor
What is `Callbacks.PostProcessBuildAttribute` in Unity? Explain its purpose and usage.
PostProcessBuildAttribute class in UnityEditor.Callbacks / Inherits from: CallbackOrderAttribute Description Add this attribute to a method to get a notification just after building the player. ```csharp // C# example: using UnityEngine; using UnityEditor; using UnityEditor.Callbacks;public class MyBuildPostpro...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_302f3baf999f
unity_docs
editor
What is `AssetDatabase.ReleaseCachedFileHandles` in Unity? Explain its purpose and usage.
AssetDatabase.ReleaseCachedFileHandles Declaration public static void ReleaseCachedFileHandles (); Description Calling this function will release file handles internally cached by Unity. This allows modifying asset or meta files safely thus avoiding potential file sharing IO errors. ```csharp using System.IO; u...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_dd50352e8572
unity_docs
xr
In Unity's 'USS data types', what is 'Syntax' and how does it work?
USS properties use the same syntax as W3C CSS documents: Keyword values appear as is. For example: auto , baseline . Basic data types appear between angle brackets ( < and > ). For example: <length> and <color> . Non-terminals that share the same name as a property appear between angle brackets and single straight quot...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5a275f31315e
unity_docs
scripting
What is `Build.Player.TypeDB.GetObjectData` in Unity? Explain its purpose and usage.
TypeDB.GetObjectData Declaration public void GetObjectData ( Build.Content.SerializationInfo info , StreamingContext context ); Description ISerializable method for serialization support outside of Unity's internal serialization system. Internal use only. See TypeDB .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3bc639361878
unity_docs
scripting
What is `Unity.Properties.PropertyPathPart.ctor` in Unity? Explain its purpose and usage.
PropertyPathPart Constructor Declaration public PropertyPathPart (string name ); Parameters Parameter Description name The name of the part. Description Initializes a new PropertyPathPart with the specified name. Declaration public PropertyPathPart (int index ); Parameters Parameter Descriptio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2622734c84cd
unity_docs
rendering
What is `SceneTemplate.SceneTemplateAsset.badge` in Unity? Explain its purpose and usage.
SceneTemplateAsset.badge public Texture2D badge ; Description The Scene template's badge. A badge is an additional icon that is located in the upper left portion of the thumbnail. It provides a visual representation of the category of the template. For example, a 3D or 2D scene would have a 3D or 2D badge.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_09bd49a2a7fe
unity_docs
physics
Show me a Unity C# example demonstrating `HingeJoint.motor`.
e motor will brake. A negative targetVelocity will make the motor spin in the opposite direction. The force is the maximum torque the motor can exert. If it is zero the motor is disabled. The motor will brake when it is spinning faster than targetVelocity only, if JointMotor.freeSpin is false. If freeSpin is ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2198c5ebc866
unity_docs
editor
What are the parameters of `UIElements.Clickable.ctor` in Unity?
Description Constructor. ```csharp using UnityEditor; using UnityEngine; using UnityEngine.UIElements;public class ClickableEditorWindow : EditorWindow { [MenuItem("Window/UI Toolkit/Clickable Example")] public static void ShowWindow() { var window = GetWindow<ClickableEditorWindow>(); windo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4bb4eadaa8f7
unity_docs
scripting
What is `ModifiableContactPair.SetBounciness` in Unity? Explain its purpose and usage.
ModifiableContactPair.SetBounciness Declaration public void SetBounciness (int i , float bounciness ); Parameters Parameter Description i Index of the contact point. bounciness Bounciness value for the specified contact point. Description Set the restitution value for the specified contact point in this...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4eaf41f40a68
unity_docs
rendering
Explain 'Mesh index data' in Unity.
The index array contains integers that refer to elements in the vertex positions array. These integers are called indices. Unity uses the indices to connect the vertex positions into faces. The number of indices that make up each face depends on the topology of the mesh . In the Mesh class, you can get this data with M...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9117696ea56a
unity_docs
scripting
Show me a Unity C# example demonstrating `Camera.main`.
t with the "MainCamera" tag, this property is null. Internally, Unity caches all GameObjects with the "MainCamera" tag. When you access this property, Unity returns the first valid result from its cache. Accessing this property has a small CPU overhead, comparable to calling GameObject.GetComponent . Where CPU perform...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4abdec9630ba
unity_docs
scripting
What are the parameters of `GameObject.Find` in Unity?
Description Finds and returns a GameObject with the specified name or hierarchy path. Only returns active GameObjects. Returns null if no GameObject with name exists. If name contains a / character, it is treated as a path to the GameObject in the Hierarchy window. If there are multiple GameObjects with the same name, ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ca59bb772c6d
unity_docs
editor
In Unity's 'Wrap content inside a scroll view', what is 'Create the scroll view' and how does it work?
Define the basic scroll view structure in the UI Document (UXML file), style the visual elements in the USS file, and add 15 buttons inside the second scroll view in the C# script. Replace the content of ScrollViewExample.uxml with the following: ``` <ui:UXML xmlns:ui="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIE...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_214dd7d82187
unity_docs
networking
What is `Android.ProcessImportance` in Unity? Explain its purpose and usage.
ProcessImportance enumeration Description Indicates the relative importance level that the system assigns to the process. These levels are represented by constants. The constants are numbered in such a way that more important values are always smaller than the less important values. Properties Property Descripti...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.