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_50390a29cff1
unity_docs
editor
In Unity's 'Wrap content inside a scroll view', what is 'Create the custom Editor window' and how does it work?
To try the example, first create a custom Editor window with some default content. Create a Unity project with any template. Right-click in the Project window, and then select Create > UI Toolkit > Editor Window . In the C# box of the UI Toolkit Editor Window Creator window, enter ScrollViewExample . Select Confirm . T...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3e951c64c589
unity_docs
audio
Show me a Unity C# example demonstrating `AudioClip.PCMReaderCallback`.
s maximum amount of samples, Unity calls the delegate multiple times so the engine can get all the clip's samples. Streamed clips call this delegate continuously, and takes various samples at varied intervals. When you use AudioClip.Create to create a clip, you can use this delegate as a parameter and define what hap...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_25f40739b5de_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
A base class for pooling objects of type T. This class manages the object pool, handles object creation,retrieval, release, and destruction, and supports initialization of a set of default objects.The type of objects that can be pooled. Must implement the IPoolable interface. Signature: ```csharp public abstract class...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
gh_e770e4ea46ee_doc_13
github
scripting
What does `FindSDKPath` do in this Unity script? Explain its purpose and signature.
Finds the SDK path based on the default install location and newest added folder Signature: ```csharp private static string FindSDKPath() ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_00f39f41ba43
unity_docs
physics
What is `Collision.transform` in Unity? Explain its purpose and usage.
Collision.transform public Transform transform ; Description The Transform of the object we hit (Read Only). If we collided against a collider with a Rigidbody , the transform will be the transform attached to the rigidbody. If we collided against a collider without a rigidbody, the transform will be the t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e64997091c8b
unity_docs
ui
What is `GUILayout.VerticalSlider` in Unity? Explain its purpose and usage.
GUILayout.VerticalSlider Declaration public static float VerticalSlider (float value , float leftValue , float rightValue , params GUILayoutOption[] options ); Declaration public static float VerticalSlider (float value , float leftValue , float rightValue , GUIStyle slider , GUIStyle thumb , params...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0bc72fe8e3c4
unity_docs
rendering
What is `MaterialEditor.PropertiesGUI` in Unity? Explain its purpose and usage.
MaterialEditor.PropertiesGUI Declaration public bool PropertiesGUI (); Returns bool Returns true if any value was changed. Description Render the standard material properties. This method will either render properties using a ShaderGUI instance if found otherwise it uses PropertiesDefaultGUI .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_28a1cc6a9b77
unity_docs
scripting
What is `iOS.Xcode.PBXSourceTree` in Unity? Explain its purpose and usage.
PBXSourceTree enumeration Description Specifies source trees for files. Properties Property Description Absolute The file path is absolute path. Source The file path is relative to the project path. Group The file path is relative to the group the file is in. Build The file path is relative to build products...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d13bb14a4dcd
unity_docs
scripting
What is `Experimental.GraphView.GraphElement.capabilities` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphElement.capabilities public Experimental.GraphView.Capabilities capabilities ; Description The GraphElement's capabilities.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_57d7c4359864
unity_docs
input
In Unity's 'IntegerField', what is 'Customize the input text selection' and how does it work?
Input text is selectable by default. You can customize the selection behaviors such as selectAllOnMouseUP and selectAllOnFocus . In C#, set them through textSelection : ``` myElement.textSelection.selectAllOnMouseUp = false; myElement.textSelection.selectAllOnFocus = false; ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_efaec1ef6b4c
unity_docs
editor
What is `PlayerSettings.Android.splitApplicationBinary` in Unity? Explain its purpose and usage.
PlayerSettings.Android.splitApplicationBinary public static bool splitApplicationBinary ; Description Split application binary into modules. When enabled, Unity splits up the player executable and data into modules: APK : Generates an APK that consists only of the executable (Java and Native) code (~10MB), and...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1500d8dadc6f
unity_docs
rendering
What is `MaterialPropertyBlock.GetFloatArray` in Unity? Explain its purpose and usage.
MaterialPropertyBlock.GetFloatArray Declaration public float[] GetFloatArray (string name ); Declaration public float[] GetFloatArray (int nameID ); Parameters Parameter Description nameID The name ID of the property retrieved by Shader.PropertyToID . name The name of the property. Description Get ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5f53cd01c7e8
unity_docs
scripting
Show me a Unity C# example demonstrating `Transform.TransformPoint`.
ith direction vectors. You can perform the opposite conversion, from world to local space using Transform.InverseTransformPoint . If you need to transform many points at once consider using Transform.TransformPoints instead as it is much faster than repeatedly calling this function. Additional resources: Transform....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_35ae48ae587d
github
scripting
Write a Unity C# script called Editable Entry{T Key,T Value}
```csharp // Copyright (c) Rotorz Limited. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root. using UnityEngine; namespace Rotorz.Games.Collections { /// <summary> /// A class with a <see cref="OrderedDictionary{TOrderedDictionary}"/> field that can /// be used ...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_man_34e1db45cf23
unity_docs
input
Explain 'Android mobile scripting' in Unity.
For cross-platform Projects, use the UNITY_ANDROID define directive to conditionally compile Android-specific C# code. For more information, refer to Platform dependent compilation . ## Access device-specific features and properties Applications can access most features of an Android device through the Input and Hand...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_accdb3bf0698
unity_docs
scripting
What is `Progress.Priority` in Unity? Explain its purpose and usage.
Priority enumeration Description An enumeration that defines task priorities. Progress indicators are sorted by priority, from highest to lowest. Priorities also determine the visual behavior of progress indicators. Each item in this enumeration defines the threshold value for each priority level. For example, Lo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3615ab719c22
unity_docs
scripting
What is `Experimental.GraphView.EdgeDragHelper_1.draggedPort` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. EdgeDragHelper<T0>.draggedPort public Experimental.GraphView.Port draggedPort ; Description The port the edge is being dragged from.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2ff054cfc9bb
unity_docs
rendering
What is `Unity.Content.ContentNamespace.GetAll` in Unity? Explain its purpose and usage.
ContentNamespace.GetAll Declaration public static ContentNamespace[] GetAll (); Returns ContentNamespace[] Returns all existing ContentNamespace objects. Description Retrieves all existing ContentNamespace objects. Using or deleting another system's namespaces can cause unexpected behavior. This method is...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0b3e6811a08a
unity_docs
scripting
What is `Profiling.HierarchyFrameDataView.GetRootItemID` in Unity? Explain its purpose and usage.
HierarchyFrameDataView.GetRootItemID Declaration public int GetRootItemID (); Description Gets the identifier for the root tree item. Use root identifier as a starting point when traversing a hierarchical frame data.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_25fe3f264795
unity_docs
scripting
What is `Search.SearchExpression.innerText` in Unity? Explain its purpose and usage.
SearchExpression.innerText public stringView innerText ; Description This is the inner text of the expression. This means the text without any special delimiters. Ex: the expression [1, 2, 3] which is a set expression would have an innerText of 1,2,3.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1e1ed92ee93e
unity_docs
scripting
What is `XR.Hand.TryGetRootBone` in Unity? Explain its purpose and usage.
Hand.TryGetRootBone Declaration public bool TryGetRootBone (out XR.Bone boneOut ); Parameters Parameter Description boneOut A Bone struct to receive the root bone. Returns bool true if hand can be queried for the root bone; otherwise false. Description Gets the root bone for this hand.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8558779c5c32
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormat.R5G6B5_UNormPack16` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormat.R5G6B5_UNormPack16 Description A three-component, 16-bit packed unsigned normalized format that has a 5-bit R component in bits 11..15, a 6-bit G component in bits 5..10, and a 5-bit B component in bits 0..4.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f3e9a6c501a9
unity_docs
math
What is `AndroidJNI.ToIntArray` in Unity? Explain its purpose and usage.
AndroidJNI.ToIntArray Declaration public static IntPtr ToIntArray (int[] array ); Description Converts a managed array of System.Int32 to a Java array of int . Additional resources: AndroidJNI.NewIntArray , AndroidJNI.SetIntArrayElement .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4772cfc5857b
unity_docs
editor
Show me a Unity C# example demonstrating `EditorGUI.indentLevel`.
static int indentLevel ; Description The indent level of the field labels. EditorGUILayout.LabelField will display the string given as an argument. This string can be displayed at a horizontal position, and the position changed by indentLevel . As indentLevel increases the labels will move right. Decreasing ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6e3eeff946ca
unity_docs
rendering
What is `Rendering.RayTracingInstanceMaterialConfig.renderQueueLowerBound` in Unity? Explain its purpose and usage.
RayTracingInstanceMaterialConfig.renderQueueLowerBound public int renderQueueLowerBound ; Description The lower limit of a render queue interval. Together with the RayTracingInstanceMaterialConfig.renderQueueUpperBound value, this value is used to determine the Material type. Additional resources: RayTracing...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9a5d940d2b65
unity_docs
scripting
What is `TerrainCallbacks` in Unity? Explain its purpose and usage.
TerrainCallbacks class in UnityEngine / Implemented in: UnityEngine.TerrainModule Description This static class provides events that Unity triggers when Terrain data changes. Events Event Description heightmapChanged This event is triggered after there are changes to Terrain height data. textureChanged This...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_eecd9120b520
unity_docs
scripting
Show me a Unity code example for 'Call C/C++/C# functions from Unity C# scripts'.
into your Unity project. Place your JavaScript plug-in files in any folder, such as Assets/JSPlugins . ## Example C++ code that you can use in Unity If you use C++ (.cpp) to implement the plug-in, you must declare the functions with C linkage ( extern “C” ) to avoid name mangling issues. The following code is an exam...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_bd5969e828d3_doc_12
github
scripting
What does `SetCustomRenderCamera` do in this Unity script? Explain its purpose and signature.
By default, the WRLD SDK maintains an internal representation of a rendering camera.The CameraApi uses this to control a UnityEngine.Camera instance supplied via SetControlledCamera.This allows methods such as CameraApi.MoveTo and CameraApi.AnimateTo to manipulate the map viewpoint.However, you may want to use your own...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e4a10df87ccb
unity_docs
math
What is `Plane.ClosestPointOnPlane` in Unity? Explain its purpose and usage.
Plane.ClosestPointOnPlane Declaration public Vector3 ClosestPointOnPlane ( Vector3 point ); Parameters Parameter Description point The point to project onto the plane. Returns Vector3 A point on the plane that is closest to point . Description For a given point returns the closest point on the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b5f9679011e4
unity_docs
animation
What is `Animations.TransformStreamHandle.GetLocalScale` in Unity? Explain its purpose and usage.
TransformStreamHandle.GetLocalScale Declaration public Vector3 GetLocalScale ( Animations.AnimationStream stream ); Parameters Parameter Description stream The AnimationStream that holds the animated values. Returns Vector3 The scale of the transform relative to the parent. Description Gets the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_384b3b24f695
github
scripting
Write a Unity C# MonoBehaviour script called Weapon Consumer
```csharp using System; using InterfaceField; using InterfaceField.Samples; using UnityEngine; using Object = UnityEngine.Object; namespace InterfaceField.Samples { public class WeaponConsumer : MonoBehaviour { [SerializeReference, Proxy(typeof(IWeapon.Proxy))] private IWeapon _weapon; private void Update() ...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_d9c636ea60d1
unity_docs
editor
What is `EditorApplication.update` in Unity? Explain its purpose and usage.
EditorApplication.update public static EditorApplication.CallbackFunction update ; Description Delegate for generic updates. Add your functions to this delegate to get an update. This delegate is not called at a fixed rate. Rather, it is called at least once, but usually multiple times per seconds. Additional...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ebee7e86b9fc
unity_docs
math
What is `AndroidJNI.CallBooleanMethod` in Unity? Explain its purpose and usage.
AndroidJNI.CallBooleanMethod Declaration public static bool CallBooleanMethod (IntPtr obj , IntPtr methodID , jvalue[] args ); Description Calls a Java instance method defined by methodID , optionally passing an array of arguments ( args ) to the method. Additional resources: Java Native Interface Specific...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1cda2480eac6
unity_docs
scripting
What is `Vector2.operator_add` in Unity? Explain its purpose and usage.
Vector2.operator + public static Vector2 operator + ( Vector2 a , Vector2 b ); Description Adds two vectors. Adds corresponding components together. ```csharp using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { void Start() { print(new Vector2(1, 2) + new Vector2(2...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2625b0ef8cdc
unity_docs
scripting
What is `ReflectionProbe.clearFlags` in Unity? Explain its purpose and usage.
ReflectionProbe.clearFlags public Rendering.ReflectionProbeClearFlags clearFlags ; Description How the reflection probe clears the background. Can be ReflectionProbeClearFlags.Skybox or ReflectionProbeClearFlags.SolidColor . ```csharp using UnityEngine; using System.Collections; public class ExampleScrip...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ee7196c52eea
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormat.A10R10G10B10_XRSRGBPack32` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormat.A10R10G10B10_XRSRGBPack32 Description A four-component, 64-bit packed unsigned normalized format that has a 10-bit A component in bits 30..39, a 10-bit R component in bits 20..29, a 10-bit G component in bits 10..1...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4f0f236bda11
unity_docs
rendering
What is `AssetImporters.ThreeDSMaterialDescriptionPreprocessor` in Unity? Explain its purpose and usage.
ThreeDSMaterialDescriptionPreprocessor class in UnityEditor.AssetImporters / Inherits from: AssetPostprocessor Description This is a default implementation for AssetPostProcessor.OnPreprocessMaterialDescription, this implementation converts material descriptions imported from .3DS assets into materials for the i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_807014176e81
unity_docs
scripting
Show me a Unity C# example demonstrating `Android.AndroidApplication.unityPlayer`.
tivity or a service. You can access this property from Unity's main thread which means you can use it in Start() , Awake() , or in methods with RuntimeInitializeOnLoadMethodAttribute . However, you cannot access it from constructors or field initializers as these are called on the loader thread. Note: This object ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_9601e4877346
github
scripting
Write a Unity C# UI script for Tele Type
```csharp using UnityEngine; using System.Collections; namespace TMPro.Examples { public class TeleType : MonoBehaviour { //[Range(0, 100)] //public int RevealSpeed = 50; private string label01 = "Example <sprite=2> of using <sprite=7> <#ffa000>Graphics Inline</color> <sprite=5> wi...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_man_5cc9c0abe241
unity_docs
audio
In Unity's 'Introduction to audio files', what is 'Use audio files in your scripts' and how does it work?
Any audio file imported into Unity is available from scripts as an AudioClip instance. This provides a way for the game runtime of the audio system to access the encoded audio data. The game might access meta-information about the audio data via the AudioClip even before the actual audio data loads. The import process ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_405d0f1bb2e2
unity_docs
scripting
What is `GameObject.InstantiateGameObjects` in Unity? Explain its purpose and usage.
GameObject.InstantiateGameObjects Declaration public static void InstantiateGameObjects (int sourceInstanceID , int count , NativeArray<int> newInstanceIDs , NativeArray<int> newTransformInstanceIDs , SceneManagement.Scene destinationScene ); Parameters Parameter Description sourceInstanceID The insta...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dd0af9d3c127
unity_docs
rendering
What is `Rendering.PassType` in Unity? Explain its purpose and usage.
PassType enumeration Description Shader pass type for Unity's lighting pipeline. This corresponds to "LightMode" tag in the shader pass, see Pass tags . Properties Property Description Normal Regular shader pass that does not interact with lighting. Vertex Legacy vertex-lit shader pass. VertexLM Legacy vert...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_16e616188efc
unity_docs
scripting
What is `ParticleSystem.MainModule.startColor` in Unity? Explain its purpose and usage.
ParticleSystem.MainModule.startColor public ParticleSystem.MinMaxGradient startColor ; Description The initial color of particles when the Particle System first spawns them. Additional resources: MinMaxGradient . ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(ParticleSystem)...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4c97998c2228
unity_docs
rendering
What is `Profiling.Profiler.GetRuntimeMemorySizeLong` in Unity? Explain its purpose and usage.
Profiler.GetRuntimeMemorySizeLong Declaration public static long GetRuntimeMemorySizeLong ( Object o ); Parameters Parameter Description o The target Unity object. Returns long The amount of native-memory used by a Unity object. This returns 0 if the Profiler is not available. Description Gathers th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_141854204ea4
unity_docs
scripting
What is `Unity.Collections.LowLevel.Unsafe.AtomicSafetyHandle.Create` in Unity? Explain its purpose and usage.
AtomicSafetyHandle.Create Declaration public static Unity.Collections.LowLevel.Unsafe.AtomicSafetyHandle Create (); Returns AtomicSafetyHandle The newly created AtomicSafetyHandle. Description Creates a new AtomicSafetyHandle. If the memory associated with this NativeContainer is allocated using Alloca...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c08e4350abbe
unity_docs
scripting
What is `Unity.Collections.LowLevel.Unsafe.AtomicSafetyHandle.GetTempUnsafePtrSliceHandle` in Unity? Explain its purpose and usage.
AtomicSafetyHandle.GetTempUnsafePtrSliceHandle Declaration public static Unity.Collections.LowLevel.Unsafe.AtomicSafetyHandle GetTempUnsafePtrSliceHandle (); Returns AtomicSafetyHandle A shared AtomicSafetyHandle. Description Gets a single shared AtomicSafetyHandle. For example, a shared AtomicSafetyHan...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_00068f05ea21
unity_docs
xr
Show me a Unity code example for 'USS data types'.
are supported for some built-in properties. Keywords give a descriptive name instead of a number. For example: position:absolute . All properties support the initial global keyword which resets the default value of a property to an element. In the following example, although you set the color of all the labels to red, ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_feba3b851aa4
unity_docs
rendering
Explain 'Mesh asset Inspector window reference' in Unity.
A Mesh asset represents a mesh in your Unity project. Unity creates mesh assets by default when it imports models . You can also create mesh assets directly in Unity, for example, by creating a mesh with code and saving the results as an asset. Select a mesh asset in the Project window to open the Mesh Inspector . This...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ed3d0d4246e2
unity_docs
scripting
Explain 'Video Player' in Unity.
Use the Video Player component to attach video files to GameObjects , and play them on the texture of a GameObject at runtime. Topic Description Video Player component targets Learn about the targets the Video Player component can play video content on. Video Player component reference Learn more about the settings of ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9e99f561a039
unity_docs
physics
What is `Joint.OnJointBreak` in Unity? Explain its purpose and usage.
Joint.OnJointBreak(float) Description Called when a joint attached to the same game object broke. When a force that is higher than the breakForce of the joint, the joint will break off. When the joint breaks off, OnJointBreak will be called and the break force applied to the joint will be passed in. After OnJointBr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_414c88ebb060
unity_docs
ui
What is `UIElements.VisualElement.visible` in Unity? Explain its purpose and usage.
VisualElement.visible public bool visible ; Description Indicates whether or not this element should be rendered. The value of this property reflects the value of IResolvedStyle.visibility for this element. The value is true for Visibility.Visible and false for Visibility.Hidden . Writing to this pro...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_34e59b2fd437
unity_docs
xr
What is `Search.SearchFlags.Sorted` in Unity? Explain its purpose and usage.
SearchFlags.Sorted Description Fetched items are sorted by the search service. ```csharp using System; using System.Collections; using System.Collections.Generic; using UnityEditor; using UnityEditor.Search; using UnityEngine; public class SearchFlags_Sorted { [MenuItem("Examples/SearchFlags/Sorted")] public sta...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f26fdb9246ed
unity_docs
math
What is `Rendering.VertexAttribute.Normal` in Unity? Explain its purpose and usage.
VertexAttribute.Normal Description Vertex normal. Normals usually use Vector3 format. Vector3 uses three 32-bit floats; 12 bytes in total. This vertex attribute maps to NORMAL Semantic in the HLSL shading language. Additional resources: Mesh.HasVertexAttribute , Mesh.SetNormals .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f698b5af2ef8
unity_docs
physics
Show me a Unity C# example demonstrating `MonoBehaviour.OnParticleUpdateJobScheduled`.
MonoBehaviour.OnParticleUpdateJobScheduled() Description OnParticleUpdateJobScheduled is called when a Particle System's built-in update job has been scheduled. This can be used to attach custom managed jobs to run after the default particle update. ```csharp using UnityEngine; using UnityEngine.ParticleSystemJob...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_91df6e5de2c3
unity_docs
rendering
What is `Rendering.ReflectionProbeTimeSlicingMode` in Unity? Explain its purpose and usage.
ReflectionProbeTimeSlicingMode enumeration Description When a probe's ReflectionProbe.refreshMode is set to ReflectionProbeRefreshMode.EveryFrame , this enum specify whether or not Unity should update the probe's cubemap over several frames or update the whole cubemap in one frame. Updating a probe's cubemap is ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0aa3b738886a
unity_docs
animation
What is `Animations.AnimatorControllerPlayable.GetCurrentAnimatorClipInfo` in Unity? Explain its purpose and usage.
AnimatorControllerPlayable.GetCurrentAnimatorClipInfo Declaration public AnimatorClipInfo[] GetCurrentAnimatorClipInfo (int layerIndex ); Parameters Parameter Description layerIndex The layer index. Returns AnimatorClipInfo[] An array of all the AnimatorClipInfo in the current state. Description Re...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a517f37374d5
unity_docs
editor
Explain 'Player Accounts' in Unity.
com.unity.services.playeraccounts ## Description The Player Accounts package: Provides functionality to integrate Unity Player Accounts with Unity Gaming Services. ## Compatible for Unity Package version 1.0.0-pre.2 is compatible for Unity Editor version 6000.0.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ee4006c1b5cf
unity_docs
scripting
What is `Android.AndroidApplication` in Unity? Explain its purpose and usage.
AndroidApplication class in UnityEngine.Android / Implemented in: UnityEngine.AndroidJNIModule Description Use this class to access the runtime data of your Android application. Static Properties Property Description currentActivity Indicates the Java instance of the current activity. currentConfiguration P...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_423318aa9d8e
unity_docs
scripting
Show me a Unity C# example demonstrating `SystemLanguage.Korean`.
SystemLanguage.Korean Description Korean. ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() { //This checks if your computer's operating system is in the Korean language if (Application.systemLanguage == SystemLanguage.Korean) { //Outputs into console that the system is Korean D...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_47831adddeb7
unity_docs
audio
What is `AudioHighPassFilter.cutoffFrequency` in Unity? Explain its purpose and usage.
AudioHighPassFilter.cutoffFrequency public float cutoffFrequency ; Description Highpass cutoff frequency in hz. 10.0 to 22000.0. Default = 5000.0. ```csharp using UnityEngine;[RequireComponent(typeof(AudioSource))] [RequireComponent(typeof(AudioHighPassFilter))] public class Example : MonoBehaviour { // Moves...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_7528f79a6bed_doc_2
github
scripting
What does `OnAwake` do in this Unity script? Explain its purpose and signature.
is called when the script instance is being loaded during the event after the function has finished. is called either when an active that contains the script is initialized when a Scene loads,or when a previously inactive is set active, or after a created with is initialized.Unity calls only once during the lifet...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_02cb86f7b00c
unity_docs
performance
What is `Jobs.TransformAccessArray.Add` in Unity? Explain its purpose and usage.
TransformAccessArray.Add Declaration public void Add ( Transform transform ); Declaration public void Add (int instanceId ); Parameters Parameter Description transform Transform or instance ID of a transform. Description Add.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ebb101d9a687
unity_docs
scripting
What are the parameters of `AssetBundle.LoadFromStream` in Unity?
Returns AssetBundle The loaded AssetBundle object or null when the object fails to load. Description Synchronously loads an AssetBundle from a managed Stream. The function supports bundles of any compression type. lzma compressed data is decompressed to memory, while uncompressed and chunk-compressed bundles are read d...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_068218c240b9
unity_docs
scripting
In Unity's 'Configuring global particle properties', what is 'Non-uniform particle scaling' and how does it work?
The 3D Start Size property allows you to specify a particle’s width, height and depth independently. In the Particle System Main module, check the 3D Start Size checkbox, and enter the values for the initial x (width), y (height) and z (depth) of the particle. Note that z (depth) only applies to 3D Mesh particles. You ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d946e69b23ed
unity_docs
scripting
Show me a Unity C# example demonstrating `Gyroscope.attitude`.
Gyroscope.attitude public Quaternion attitude ; Description Returns the attitude (ie, orientation in space) of the device. ```csharp using UnityEngine;public class Example : MonoBehaviour { // Rotate the object to match the device's orientation // in space. void Update() { transform.rotation = Input.gyro...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_be81f69c5812
unity_docs
editor
What are the parameters of `EditorPrefs.GetInt` in Unity?
Returns int The value stored in the preference file. Description Returns the value corresponding to key in the preference file if it exists. If the value doesn't already exist in the preference file the function will return defaultValue . Additional resources: SetInt . ```csharp // A small editor window that allows an ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3ae04bb79faf
unity_docs
editor
What is `EditorGUI.RectField` in Unity? Explain its purpose and usage.
EditorGUI.RectField Declaration public static Rect RectField ( Rect position , Rect value ); Declaration public static Rect RectField ( Rect position , string label , Rect value ); Declaration public static Rect RectField ( Rect position , GUIContent label , Rect value ); Paramete...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fedadfe87b99
unity_docs
physics
What are the parameters of `Rigidbody.AddRelativeTorque` in Unity?
Description Adds a torque to the rigidbody relative to its coordinate system. Force can be applied only to an active rigidbody. If a GameObject is inactive, AddRelativeTorque has no effect. Wakes up the Rigidbody by default. If the torque size is zero then the Rigidbody will not be woken up. For more information on how...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_26607bc68540
unity_docs
rendering
Give me an overview of the `ComputeBufferType` class in Unity.
ComputeBufferType enumeration Description ComputeBuffer type. Different types of compute buffers map to different usage and declarations in HLSL shaders. Default type is "structured buffer" ( StructuredBuffer<T> or RWStructuredBuffer<T> ). Additional resources: ComputeBuffer , ComputeShader , Material.SetBuf...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7084d038707f
unity_docs
math
What is `HandleUtility.PlaceObjectDelegate` in Unity? Explain its purpose and usage.
HandleUtility.PlaceObjectDelegate Declaration public delegate bool PlaceObjectDelegate ( Vector2 guiPosition , out Vector3 position , out Vector3 normal ); Parameters Parameter Description guiPosition The GUI position in the SceneView . You can pass Event.current.mousePosition to this parameter in mo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2f5bfd744e88
unity_docs
editor
What are the parameters of `Handles.DrawBezier` in Unity?
Description Draw textured bezier line through start and end points with the given tangents. To get an anti-aliased effect use a texture that is 1x2 pixels with one transparent white pixel and one opaque white pixel. The bezier curve will be swept using this texture. Note: Use HandleUtility.GetHandleSize where you migh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e1852dcf5a79
unity_docs
scripting
What is `Rendering.GraphicsDeviceType` in Unity? Explain its purpose and usage.
GraphicsDeviceType enumeration Description Graphics device API type. Many different low-level graphics APIs can be used by Unity. If for some reason you need to know whether Direct3D 9 or 11 is being used, or Vulkan or OpenGL ES 3, you can use SystemInfo.graphicsDeviceType to check for that. Additional resources...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_f14dfa5f3879
github
scripting
Write a Unity Editor script for Setting
```csharp using System; using UnityEngine; #if UNITY_EDITOR using UnityEditor; #endif namespace DebugMenu { internal class Setting : ISetting { public string Key { get; } public string DisplayName { get; } public string Tooltip { get; } public GUIContent GetGuiContent() => ne...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_b31aa726e238
unity_docs
rendering
What is `AndroidBlitType` in Unity? Explain its purpose and usage.
AndroidBlitType enumeration Description Describes the method for how content is displayed on the screen. Options are as follows: Use Always to render offscreen and blit to the backbuffer. Use Never to render directly to the backbuffer. Use Auto or automatically choose the most appropriate option. Depending o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_025e7a10a8b7
unity_docs
rendering
What is `TextureImporterSwizzle.OneMinusR` in Unity? Explain its purpose and usage.
TextureImporterSwizzle.OneMinusR Description Use the inverted red color channel. Additional resources: TextureImporter.swizzleR , TextureImporter.swizzleG , TextureImporter.swizzleB , TextureImporter.swizzleA .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_178c8fbd5731
unity_docs
rendering
In Unity's 'Position an overlay', what is 'Dock overlays' and how does it work?
Overlays can dock to the top, bottom, sides, and corners of the Scene view. You can dock more than one overlay to the same edge or corner of the Scene view. However, multiple overlays docked to the same edge or corner are not connected with each other. If you move a docked overlay, other overlays docked to the same loc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0b913ebe2a79
unity_docs
physics
What is `Rigidbody2D.simulated` in Unity? Explain its purpose and usage.
Rigidbody2D.simulated public bool simulated ; Description Indicates whether the rigid body should be simulated or not by the physics system. When not simulated, any attached Collider2D or Joint2D also do not participate in the physics simulation.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c7222c2ea069
unity_docs
rendering
In Unity's 'Quality settings tab reference', what is 'Rendering' and how does it work?
Property Description Render Pipeline Sets the Render Pipeline Asset to use at this quality level. Pixel Light Count Sets the maximum number of per-pixel lights if you use a forward rendering path . For more information, refer to Per-pixel and per-vertex lights . Anti Aliasing Smooths edges using multisample anti-aliasi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f2c2c02b435c
unity_docs
performance
What is `Profiling.FrameDataView` in Unity? Explain its purpose and usage.
FrameDataView class in UnityEditor.Profiling Description Base funtionality for accessing the Profiler data. Provides base access to the Profiler data for a specific frame and thread. Additional resources: RawFrameDataView , HierarchyFrameDataView . Static Properties Property Description invalidMarkerId Iden...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_52f7054cc45c
unity_docs
scripting
Show me a Unity C# example demonstrating `CharacterController.velocity`.
ero vector. Note: The velocity returned is simply the difference in distance for the current timestep before and after a call to CharacterController.Move or CharacterController.SimpleMove . The velocity is relative because it won't track movements to the transform that happen outside of the CharacterController (e.g....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_160f27a10cc2
unity_docs
input
What is `Experimental.GraphView.EdgeControl.interceptWidth` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. EdgeControl.interceptWidth public float interceptWidth ; Description Width that will be used for mouse hit detection.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1bee128a7e71
unity_docs
physics
Show me a Unity C# example demonstrating `MonoBehaviour.OnMouseEnter`.
to the Collider . This function is not called on objects that belong to Ignore Raycast layer. This function is called on Colliders and 2D Colliders marked as trigger when the following properties are set to true: For 3D physics: Physics.queriesHitTriggers For 2D physics: Physics2D.queriesHitTriggers OnMouseEnter...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3fa85c446b8a
unity_docs
physics
What is `WheelCollider.suspensionExpansionLimited` in Unity? Explain its purpose and usage.
WheelCollider.suspensionExpansionLimited(bool) Parameters Parameter Description active Turns on/off the property Description Limits the expansion velocity of the Wheel Collider's suspension. If you set this property on a Rigidbody that has several Wheel Colliders, such as a vehicle, then it affects all other W...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_02f4374c8df3
unity_docs
scripting
Explain 'Fundamental Unity types' in Unity.
Unity has some fundamental built-in classes that are particularly important for scripting. These are classes which your own custom types can inherit from to integrate with Editor and Engine functionality. It’s helpful to understand these types, their behavior, and why you should inherit from or use them. For a complete...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_900ccdda4ab5
unity_docs
physics
What is `Physics2D.OverlapArea` in Unity? Explain its purpose and usage.
Physics2D.OverlapArea Declaration public static Collider2D OverlapArea ( Vector2 pointA , Vector2 pointB , int layerMask = DefaultRaycastLayers, float minDepth = -Mathf.Infinity, float maxDepth = Mathf.Infinity); Parameters Parameter Description pointA One corner of the rectangle. pointB Diagon...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_6aee16a441ae_doc_0
github
scripting
What does `SetPipelineShaders` do in this Unity script? Explain its purpose and signature.
Applies the appropriate shader to the materials based on the current render pipeline. Signature: ```csharp public void SetPipelineShaders() ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bb6fc18fb39c
unity_docs
editor
Show me a Unity C# example demonstrating `Unity.Profiling.LowLevel.Unsafe.ProfilerRecorderHandle.GetDescription`.
ProfilerRecorderHandle.GetDescription Declaration public static Unity.Profiling.LowLevel.Unsafe.ProfilerRecorderDescription GetDescription ( Unity.Profiling.LowLevel.Unsafe.ProfilerRecorderHandle handle ); Description Gets description of Profiler marker or counter handle. ```csharp using System.Collections....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f4761cc86978
unity_docs
math
What is `PluginImporter.DefineConstraints` in Unity? Explain its purpose and usage.
PluginImporter.DefineConstraints public string[] DefineConstraints ; Description Allows you to specify a list of #define directives which controls whether your plug-in should be included. You can set this property on each plug-in to control whether it should or shouldn't be included in your build according to t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f77158659bd4
unity_docs
rendering
What is `Rendering.GraphicsSettings.GetCustomShader` in Unity? Explain its purpose and usage.
GraphicsSettings.GetCustomShader Declaration public static Shader GetCustomShader ( Rendering.BuiltinShaderType type ); Parameters Parameter Description type Built-in shader type to query custom shader for. Returns Shader The shader used. Description Get custom shader used instead of a built-in sh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2bd6b244e12a
unity_docs
rendering
In Unity's 'Add ambient occlusion in the Built-In Render Pipeline', what is 'Baked Ambient Occlusion' and how does it work?
If Baked Global Illumination is enabled in your Scene , Unity can bake ambient occlusion into the lightmaps . This is known as Baked Ambient Occlusion . To enable baked ambient occlusion in your Scene: Open the Lighting window (menu: Window > Rendering > Lighting ) Navigate to the Mixed Lighting section Enable Baked Gl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_42a6189f9421
unity_docs
editor
What is `EditorBuildSettings.scenes` in Unity? Explain its purpose and usage.
EditorBuildSettings.scenes public static EditorBuildSettingsScene[] scenes ; Description The list of scenes in the active platform profile or build profile to be included in the build. When the active profile is a platform profile, this property reflects the global scenes. When the active profile is a build pro...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3c1bdc57533e
unity_docs
scripting
What is `Animator.GetCurrentAnimatorStateInfo` in Unity? Explain its purpose and usage.
Animator.GetCurrentAnimatorStateInfo Declaration public AnimatorStateInfo GetCurrentAnimatorStateInfo (int layerIndex ); Parameters Parameter Description layerIndex The layer index. Returns AnimatorStateInfo An AnimatorStateInfo with the information on the current state. Description Returns an ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fe6e274d50b1
unity_docs
rendering
What is `RenderSettings.ambientGroundColor` in Unity? Explain its purpose and usage.
RenderSettings.ambientGroundColor public static Color ambientGroundColor ; Description Ambient lighting coming from below. Trilight ambient lighing mode uses this color to affect downwards-facing object parts. Additional resources: ambientMode , ambientSkyColor , ambientEquatorColor .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b3892b2293a6
unity_docs
scripting
What is `ColorUtility.ToHtmlStringRGBA` in Unity? Explain its purpose and usage.
ColorUtility.ToHtmlStringRGBA Declaration public static string ToHtmlStringRGBA ( Color color ); Parameters Parameter Description color The color to be converted. Returns string Hexadecimal string representing the color. Description Returns the color as a hexadecimal string in the format "RRGGBBAA"....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_20855b655235
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormat.RGBA_DXT1_SRGB` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormat.RGBA_DXT1_SRGB Description A three-component, block-compressed format (also known as BC1). Each 64-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGB texel data with sRGB nonlinear encodi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6aa32aed7fd8
unity_docs
editor
What is `SearchService.ProjectSearchEngineAttribute` in Unity? Explain its purpose and usage.
ProjectSearchEngineAttribute class in UnityEditor.SearchService Description A class attribute that registers Project search engines automatically. Search engines with this attribute must implement the IProjectSearchEngine interface.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_dcd025c62afb_doc_8
github
scripting
What does `DrawDictionaryListControl` do in this Unity script? Explain its purpose and signature.
Draws the using the . Signature: ```csharp protected virtual void DrawDictionaryListControl(Rect position) ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_396b3f84f436
unity_docs
ui
What is `UnityEngine.TextRenderingModule` in Unity? Explain its purpose and usage.
UnityEngine.TextRenderingModule Description The TextRendering module provides access to Unity's text rendering system. Classes Class Description Font Script interface for font assets. TextGenerator Class that can be used to generate text for rendering. TextMesh A script interface for the text mesh component. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c06f89d424b4
unity_docs
performance
Show me a Unity C# example demonstrating `Profiling.HierarchyFrameDataView`.
ew Description Provides access to the Profiler data for a specific frame and thread. Use HierarchyFrameDataView to retrieve Profiler samples structured as a hierarchy. This is used in the Hierachy mode of the CPU Usage Profiler , for example. The HierarchyFrameDataView aggregates the data with time and memo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a217ccb1b1be
unity_docs
scripting
What is `Experimental.GraphView.EdgeConnector_1.OnPointerUp` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. EdgeConnector<T0>.OnPointerUp Declaration protected void OnPointerUp ( UIElements.PointerUpEvent e ); Parameters Parameter Description e The pointer up event. Description Called when a pointer up event occurs on the ta...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.